@magnaflow/ws-client

WebSocket client primitives with queueing, heartbeat, reconnection, and push-message handling.

What It Provides

• WebSocketService as the high-level client
• WebSocketCore for low-level connection lifecycle
• MessageManager for request/response matching
• TasksService for scheduled maintenance tasks
• PushMessageService for typed push-message registration

Install

npm install @magnaflow/ws-client

Key Exports

• WebSocketService
• WebSocketCore
• MessageManager
• TasksService
• PushMessageService
• EventEmitter
• generateUniqueId
• WEBSOCKET_EVENTS
• HEARTBEAT_CONFIG
• RECONNECTION_CONFIG
• MESSAGE_CONFIG
• TASK_CONFIG
• ERROR_MESSAGES
• LOG_MESSAGES

Example

import { WebSocketService, WEBSOCKET_EVENTS } from '@magnaflow/ws-client';

const ws = new WebSocketService({
  reconnect: {
    maxAttempts: 5,
    baseDelay: 1000,
    maxDelay: 30000,
  },
});

await ws.connectAsync('wss://example.com/ws');
ws.on(WEBSOCKET_EVENTS.CONNECT, () => {
  console.log('connected');
});

Notes

• This package assumes a browser-like WebSocket runtime.
• Request/response matching is based on nonce values managed by MessageManager.

Development

bunx nx run ws-client:lint
bunx nx run ws-client:test
bunx nx run ws-client:build

License

This package is part of the merchant-v2-sdk monorepo and is covered by the root MIT license.

See ../../LICENSE for details.