@nmtjs/ws-client 0.15.0-beta.37 → 0.15.0-beta.38

package/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2024 Denis Ilchyshyn
+Copyright (c) 2025 Denys Ilchyshyn
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/README.md

@@ -6,4 +6,4 @@
 - binary data streaming and event subscriptions
 - contract-based API
 - end-to-end type safety
-- CPU-intensive task execution on separate workers
+- CPU-intensive task execution on separate workers

package/dist/index.d.ts

@@ -1,30 +1,31 @@
-import type { Protocol, ProtocolBaseClientCallOptions, ProtocolBaseTransformer } from '@nmtjs/protocol/client';
-import { ClientMessageType } from '@nmtjs/protocol';
-import { ProtocolTransport } from '@nmtjs/protocol/client';
-export type WebSocketClientTransportOptions = {
+import type { ClientCallOptions, ClientTransportFactory, ClientTransportStartParams } from '@nmtjs/client';
+import type { ProtocolVersion } from '@nmtjs/protocol';
+import type { BaseClientFormat } from '@nmtjs/protocol/client';
+import { ConnectionType } from '@nmtjs/protocol';
+export type WsClientTransportOptions = {
     /**
      * The origin of the server
-     * @example 'http://localhost:3000'
+     * @example 'ws://localhost:3000'
      */
-    origin: string;
+    url: string;
+    debug?: boolean;
     /**
      * Custom WebSocket class
      * @default globalThis.WebSocket
      */
-    wsFactory?: (url: URL) => WebSocket;
-    debug?: boolean;
+    WebSocket?: typeof WebSocket;
 };
-export declare class WebSocketClientTransport extends ProtocolTransport<WebSocketClientTransportOptions> {
-    protected readonly protocol: Protocol;
+export declare class WsTransportClient {
+    protected readonly format: BaseClientFormat;
+    protected readonly protocol: ProtocolVersion;
+    protected options: WsClientTransportOptions;
+    type: ConnectionType.Bidirectional;
     protected webSocket: WebSocket | null;
     protected connecting: Promise<void> | null;
-    protected options: WebSocketClientTransportOptions;
-    constructor(protocol: Protocol, options: WebSocketClientTransportOptions);
-    connect(auth: any, transformer: ProtocolBaseTransformer): Promise<void>;
+    constructor(format: BaseClientFormat, protocol: ProtocolVersion, options: WsClientTransportOptions);
+    connect(params: ClientTransportStartParams): Promise<void>;
     disconnect(): Promise<void>;
-    call(procedure: string, payload: any, options: ProtocolBaseClientCallOptions, transformer: ProtocolBaseTransformer): Promise<import("@nmtjs/common").InteractivePromise<unknown> & {
-        procedure: string;
-        signal: AbortSignal;
-    }>;
-    send(messageType: ClientMessageType, buffer: ArrayBuffer): Promise<void>;
+    send(message: ArrayBufferView, options: ClientCallOptions): Promise<void>;
 }
+export type WsTransportFactory = ClientTransportFactory<ConnectionType.Bidirectional, WsClientTransportOptions, WsTransportClient>;
+export declare const WsTransportFactory: WsTransportFactory;

package/dist/index.js

@@ -1,71 +1,67 @@
-import { ClientMessageType, concat, encodeNumber } from '@nmtjs/protocol';
-import { ProtocolTransport, ProtocolTransportStatus, } from '@nmtjs/protocol/client';
-export class WebSocketClientTransport extends ProtocolTransport {
+import { once } from '@nmtjs/common';
+import { ConnectionType } from '@nmtjs/protocol';
+export class WsTransportClient {
+    format;
     protocol;
+    options;
+    type = ConnectionType.Bidirectional;
     webSocket = null;
     connecting = null;
-    options;
-    constructor(protocol, options) {
-        super();
+    constructor(format, protocol, options) {
+        this.format = format;
         this.protocol = protocol;
+        this.options = options;
         this.options = { debug: false, ...options };
     }
-    connect(auth, transformer) {
-        // this.auth = auth
-        const wsUrl = new URL('/api', this.options.origin);
-        if (this.protocol.contentType) {
-            wsUrl.searchParams.set('content-type', this.protocol.contentType);
-            wsUrl.searchParams.set('accept', this.protocol.contentType);
+    async connect(params) {
+        const url = new URL(params.application ? `/${params.application}` : '/', this.options.url);
+        const secure = url.protocol === 'wss:' || url.protocol === 'https:';
+        url.protocol = secure ? 'wss:' : 'ws:';
+        url.searchParams.set('content-type', this.format.contentType);
+        url.searchParams.set('accept', this.format.contentType);
+        if (params.auth) {
+            url.searchParams.set('auth', params.auth);
         }
-        if (auth)
-            wsUrl.searchParams.set('auth', auth);
-        const ws = this.options.wsFactory?.(wsUrl) ?? new WebSocket(wsUrl.toString());
+        const ws = this.options.WebSocket
+            ? new this.options.WebSocket(url)
+            : new WebSocket(url.toString());
         ws.binaryType = 'arraybuffer';
-        this.status = ProtocolTransportStatus.CONNECTING;
-        ws.addEventListener('message', ({ data }) => {
-            this.protocol.handleServerMessage(data, this, transformer);
-        });
-        ws.addEventListener('close', (event) => {
-            this.status = ProtocolTransportStatus.DISCONNECTED;
-            this.emit('disconnected', event.code === 1000
-                ? event.reason === 'client'
-                    ? 'client'
-                    : 'server'
-                : 'error');
-            this.webSocket = null;
-        }, { once: true });
-        this.webSocket = ws;
         this.connecting = new Promise((resolve, reject) => {
             ws.addEventListener('open', () => {
-                this.status = ProtocolTransportStatus.CONNECTED;
-                this.emit('connected');
+                this.connecting = null;
+                params.onConnect();
                 resolve();
-            }, { once: true });
+            });
+            ws.addEventListener('message', (event) => {
+                params.onMessage(new Uint8Array(event.data));
+            });
             ws.addEventListener('error', (event) => {
-                reject(new Error('WebSocket error', { cause: event }));
-            }, { once: true });
+                this.connecting = null;
+                reject(new Error('WebSocket error', { cause: event.error }));
+            });
+            ws.addEventListener('close', (event) => {
+                this.webSocket = null;
+                this.connecting = null;
+                params.onDisconnect('server');
+            });
         });
+        this.webSocket = ws;
         return this.connecting;
     }
     async disconnect() {
         if (this.webSocket === null)
             return;
+        const closing = once(this.webSocket, 'close');
         this.webSocket.close(1000, 'client');
-        return _once(this.webSocket, 'close');
-    }
-    async call(procedure, payload, options, transformer) {
-        const { call, buffer } = this.protocol.createRpc(procedure, payload, options, transformer);
-        await this.send(ClientMessageType.Rpc, buffer);
-        return call;
+        return closing;
     }
-    async send(messageType, buffer) {
-        if (this.connecting)
-            await this.connecting;
-        this.webSocket.send(concat(encodeNumber(messageType, 'Uint8'), buffer));
+    async send(message, options) {
+        if (this.webSocket === null)
+            throw new Error('WebSocket is not connected');
+        await this.connecting;
+        if (!options.signal?.aborted)
+            this.webSocket.send(message);
     }
 }
-function _once(target, event) {
-    return new Promise((resolve) => {
-        target.addEventListener(event, () => resolve(), { once: true });
-    });
-}
+export const WsTransportFactory = (params, options) => new WsTransportClient(params.format, params.protocol, options);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAiBhD,MAAM,OAAO,iBAAiB;IAOP,MAAM;IACN,QAAQ;IACjB,OAAO;IARnB,IAAI,GAAiC,cAAc,CAAC,aAAa,CAAA;IAEvD,SAAS,GAAqB,IAAI,CAAA;IAClC,UAAU,GAAyB,IAAI,CAAA;IAEjD,YACqB,MAAwB,EACxB,QAAyB,EAClC,OAAiC,EAC3C;sBAHmB,MAAM;wBACN,QAAQ;uBACjB,OAAO;QAEjB,IAAI,CAAC,OAAO,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAA;IAAA,CAC5C;IAED,KAAK,CAAC,OAAO,CAAC,MAAkC,EAAE;QAChD,MAAM,GAAG,GAAG,IAAI,GAAG,CACjB,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,GAAG,EACnD,IAAI,CAAC,OAAO,CAAC,GAAG,CACjB,CAAA;QAED,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,KAAK,MAAM,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAA;QAEnE,GAAG,CAAC,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAA;QACtC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;QAC7D,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;QAEvD,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAChB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;QAC3C,CAAC;QAED,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS;YAC/B,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC;YACjC,CAAC,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAA;QAEjC,EAAE,CAAC,UAAU,GAAG,aAAa,CAAA;QAE7B,IAAI,CAAC,UAAU,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC;YACjD,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC;gBAChC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;gBACtB,MAAM,CAAC,SAAS,EAAE,CAAA;gBAClB,OAAO,EAAE,CAAA;YAAA,CACV,CAAC,CAAA;YACF,EAAE,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;gBACxC,MAAM,CAAC,SAAS,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,IAAmB,CAAC,CAAC,CAAA;YAAA,CAC5D,CAAC,CAAA;YACF,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;gBACtC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;gBACtB,MAAM,CACJ,IAAI,KAAK,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAG,KAAoB,CAAC,KAAK,EAAE,CAAC,CACrE,CAAA;YAAA,CACF,CAAC,CAAA;YACF,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;gBACtC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;gBACrB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;gBACtB,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;YAAA,CAC9B,CAAC,CAAA;QAAA,CACH,CAAC,CAAA;QAEF,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA;QAEnB,OAAO,IAAI,CAAC,UAAU,CAAA;IAAA,CACvB;IAED,KAAK,CAAC,UAAU,GAAG;QACjB,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI;YAAE,OAAM;QACnC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;QAC7C,IAAI,CAAC,SAAU,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QACrC,OAAO,OAAO,CAAA;IAAA,CACf;IAED,KAAK,CAAC,IAAI,CAAC,OAAwB,EAAE,OAA0B,EAAE;QAC/D,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;QAC1E,MAAM,IAAI,CAAC,UAAU,CAAA;QACrB,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO;YAAE,IAAI,CAAC,SAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAAA,CAC5D;CACF;AAQD,MAAM,CAAC,MAAM,kBAAkB,GAAuB,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CACxE,IAAI,iBAAiB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA"}

package/package.json

@@ -2,30 +2,28 @@
   "name": "@nmtjs/ws-client",
   "type": "module",
   "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "module-sync": "./dist/index.js"
-    }
+    ".": "./dist/index.js"
   },
   "dependencies": {
-    "@nmtjs/client": "0.15.0-beta.37",
-    "@nmtjs/protocol": "0.15.0-beta.37",
-    "@nmtjs/common": "0.15.0-beta.37"
+    "@nmtjs/client": "0.15.0-beta.38",
+    "@nmtjs/common": "0.15.0-beta.38"
+  },
+  "devDependencies": {
+    "@nmtjs/protocol": "0.15.0-beta.38"
   },
   "peerDependencies": {
-    "@nmtjs/common": "0.15.0-beta.37",
-    "@nmtjs/client": "0.15.0-beta.37",
-    "@nmtjs/protocol": "0.15.0-beta.37"
+    "@nmtjs/client": "0.15.0-beta.38",
+    "@nmtjs/common": "0.15.0-beta.38",
+    "@nmtjs/protocol": "0.15.0-beta.38"
   },
   "files": [
     "dist",
+    "src",
     "LICENSE.md",
     "README.md"
   ],
-  "version": "0.15.0-beta.37",
+  "version": "0.15.0-beta.38",
   "scripts": {
-    "build": "tsc",
-    "type-check": "tsc --noEmit"
+    "clean-build": "rm -rf ./dist"
   }
 }

package/src/index.ts

@@ -0,0 +1,110 @@
+import type {
+  ClientCallOptions,
+  ClientTransportFactory,
+  ClientTransportStartParams,
+} from '@nmtjs/client'
+import type { ProtocolVersion } from '@nmtjs/protocol'
+import type { BaseClientFormat } from '@nmtjs/protocol/client'
+import { once } from '@nmtjs/common'
+import { ConnectionType } from '@nmtjs/protocol'
+
+export type WsClientTransportOptions = {
+  /**
+   * The origin of the server
+   * @example 'ws://localhost:3000'
+   */
+  url: string
+  debug?: boolean
+
+  /**
+   * Custom WebSocket class
+   * @default globalThis.WebSocket
+   */
+  WebSocket?: typeof WebSocket
+}
+
+export class WsTransportClient {
+  type: ConnectionType.Bidirectional = ConnectionType.Bidirectional
+
+  protected webSocket: WebSocket | null = null
+  protected connecting: Promise<void> | null = null
+
+  constructor(
+    protected readonly format: BaseClientFormat,
+    protected readonly protocol: ProtocolVersion,
+    protected options: WsClientTransportOptions,
+  ) {
+    this.options = { debug: false, ...options }
+  }
+
+  async connect(params: ClientTransportStartParams) {
+    const url = new URL(
+      params.application ? `/${params.application}` : '/',
+      this.options.url,
+    )
+
+    const secure = url.protocol === 'wss:' || url.protocol === 'https:'
+
+    url.protocol = secure ? 'wss:' : 'ws:'
+    url.searchParams.set('content-type', this.format.contentType)
+    url.searchParams.set('accept', this.format.contentType)
+
+    if (params.auth) {
+      url.searchParams.set('auth', params.auth)
+    }
+
+    const ws = this.options.WebSocket
+      ? new this.options.WebSocket(url)
+      : new WebSocket(url.toString())
+
+    ws.binaryType = 'arraybuffer'
+
+    this.connecting = new Promise((resolve, reject) => {
+      ws.addEventListener('open', () => {
+        this.connecting = null
+        params.onConnect()
+        resolve()
+      })
+      ws.addEventListener('message', (event) => {
+        params.onMessage(new Uint8Array(event.data as ArrayBuffer))
+      })
+      ws.addEventListener('error', (event) => {
+        this.connecting = null
+        reject(
+          new Error('WebSocket error', { cause: (event as ErrorEvent).error }),
+        )
+      })
+      ws.addEventListener('close', (event) => {
+        this.webSocket = null
+        this.connecting = null
+        params.onDisconnect('server')
+      })
+    })
+
+    this.webSocket = ws
+
+    return this.connecting
+  }
+
+  async disconnect() {
+    if (this.webSocket === null) return
+    const closing = once(this.webSocket, 'close')
+    this.webSocket!.close(1000, 'client')
+    return closing
+  }
+
+  async send(message: ArrayBufferView, options: ClientCallOptions) {
+    if (this.webSocket === null) throw new Error('WebSocket is not connected')
+    await this.connecting
+    if (!options.signal?.aborted) this.webSocket!.send(message)
+  }
+}
+
+export type WsTransportFactory = ClientTransportFactory<
+  ConnectionType.Bidirectional,
+  WsClientTransportOptions,
+  WsTransportClient
+>
+
+export const WsTransportFactory: WsTransportFactory = (params, options) =>
+  new WsTransportClient(params.format, params.protocol, options)