@cap-js-community/websocket - npm Package Versions

Version 1.6.0 - 2025-02-03

Fixed

• Check authorization and service path before websocket upgrade
• Reject connection to non-websocket protocol paths
• Support unauthenticated requests via option cds.requires.auth.restrict_all_services: false
• Support privileged user, e.g. via dummy auth strategy
• Fix call to wsDisconnect operation without reason parameter
• Cast reason parameter for wsDisconnect operation to string
• Fill baseUrl for websocket requests (necessary for request context specific model in toggle/extensibility scenario)
• Clean websocket context from internal read-only attributes
• Normalize client identifier on upgrade request request.id
• Return 404 when url cannot be associated with a service in upgrade request
• Parse string values according to operation parameter type in custom formats (e.g. pcp)

Added

• reset all contexts via wsContext flag reset: true
• Support multiple contexts in wsContext with array value for context
• Document usage of srv.tx(req).emit for tenant and user propagation in WS broadcasting
• Document usage of wsContext for format pcp and cloudevents

Version 1.5.2 - 2025-01-10

Fixed

• Fix fallback to redis configuration cds.requires.redis
• Check for authenticated user during websocket connection (no anonymous)
• Improve start log using websocket including adapter information
• Improve server shutdown redis client handling

Version 1.5.1 - 2025-01-09

Fixed

• Improve redis connection check
• Improve connection error handling (e.g. unauthorized)
• Consolidate dependencies

Version 1.5.0 - 2025-01-08

Fixed

• Redis lookup for websocket via CDS env cds.requires.redis-websocket
• Reworked redis client connection logic
• Document options

Version 1.4.1 - 2024-12-02

Fixed

• Redis adapter error handling

Version 1.4.0 - 2024-11-04

Changed

• Socket.IO implementation does not use server path option anymore, in alignment with kind ws
• Use io("/ws/chat") instead of io("/chat", { path: "/ws" })

Fixed

• Support for http conform headers (x-ws and x-websocket)
• Revise error handling for websocket events
• Fix for operations without parameters
• Fix support for absolute service paths
• Update documentation

Version 1.3.0 - 2024-10-07

Added

• Provide event headers to formatter
• Support exclusion of event contexts
• Include or exclude defined list of users
• Add support for Cloud Events with format cloudevent resp. cloudevents
• Overrule path of websocket event via @websocket.path or @ws.path for non-websocket services
• Overrule format of websocket event via @websocket.format or @ws.format for non-websocket services
• Ignore event elements or operation parameters with @websocket.ignore or @ws.ignore

Fixed

• Improve documentation and examples
• Allow empty PCP message in event definition
• Optimization of client determination for kind ws
• Ignore not modeled PCP fields in payload serialization
• Fix annotations value derivation for non-websocket service events
• Fix annotations wsCurrentUserInclude, currentUserInclude, wsCurrentUserExclude, currentUserExclude

Version 1.2.0 - 2024-09-04

Added

• Support SAP Push Channel Protocol (PCP)
• Option to include or exclude identifiers
• Option to include or exclude current user
• Better CDS context handling
• CDS 8.2 compatibility

Version 1.1.1 - 2024-08-01

Fixed

• CDS 8.1 compatibility

Version 1.1.0 - 2024-07-16

Added

• CDS 8 compatibility
• CI Matrix Test Node 22