@socket-mesh/client 17.1.1

package/README.md

@@ -0,0 +1,230 @@
+SocketCluster JavaScript client
+======
+
+Client module for SocketCluster.
+
+## Setting up
+
+You will need to install both ```socketcluster-client``` and ```socketcluster-server``` (https://github.com/SocketCluster/socketcluster-server).
+
+To install this module:
+```bash
+npm install socketcluster-client
+```
+
+## How to use
+
+The socketcluster-client script is called `socketcluster-client.js` (located in the main socketcluster-client directory).
+Embed it in your HTML page like this:
+```html
+<script type="text/javascript" src="/socketcluster-client.js"></script>
+```
+\* Note that the src attribute may be different depending on how you setup your HTTP server.
+
+Once you have embedded the client `socketcluster-client.js` into your page, you will gain access to a global `socketClusterClient` object.
+You may also use CommonJS `require` or ES6 module imports.
+
+### Connect to a server
+
+```js
+let socket = socketClusterClient.create({
+  hostname: 'localhost',
+  port: 8000
+});
+```
+
+### Transmit data
+
+```js
+// Transmit some data to the server.
+// It does not expect a response from the server.
+// From the server socket, it can be handled using either:
+// - for await (let data of socket.receiver('foo')) {}
+// - let data = await socket.receiver('foo').once()
+socket.transmit('foo', 123);
+```
+
+### Invoke an RPC
+
+```js
+(async () => {
+
+  // Invoke an RPC on the server.
+  // It expects a response from the server.
+  // From the server socket, it can be handled using either:
+  // - for await (let req of socket.procedure('myProc')) {}
+  // - let req = await socket.procedure('myProc').once()
+  let result = await socket.invoke('myProc', 123);
+
+})();
+```
+
+### Subscribe to a channel
+
+```js
+(async () => {
+
+  // Subscribe to a channel.
+  let myChannel = socket.subscribe('myChannel');
+
+  await myChannel.listener('subscribe').once();
+  // myChannel.state is now 'subscribed'.
+
+})();
+```
+
+### Get a channel without subscribing
+
+```js
+(async () => {
+
+  let myChannel = socket.channel('myChannel');
+
+  // Can subscribe to the channel later as a separate step.
+  myChannel.subscribe();
+  await myChannel.listener('subscribe').once();
+  // myChannel.state is now 'subscribed'.
+
+})();
+```
+
+### Publish data to a channel
+
+```js
+// Publish data to the channel.
+myChannel.transmitPublish('This is a message');
+
+// Publish data to the channel from the socket.
+socket.transmitPublish('myChannel', 'This is a message');
+
+(async () => {
+  // Publish data to the channel and await for the message
+  // to reach the server.
+  try {
+    await myChannel.invokePublish('This is a message');
+  } catch (error) {
+    // Handle error.
+  }
+
+  // Publish data to the channel from the socket and await for
+  // the message to reach the server.
+  try {
+    await socket.invokePublish('myChannel', 'This is a message');
+  } catch (error) {
+    // Handle error.
+  }
+})();
+```
+
+### Consume data from a channel
+
+```js
+(async () => {
+
+  for await (let data of myChannel) {
+    // ...
+  }
+
+})();
+```
+
+### Connect over HTTPS:
+
+```js
+let options = {
+  hostname: 'securedomain.com',
+  secure: true,
+  port: 443,
+  rejectUnauthorized: false // Only necessary during debug if using a self-signed certificate
+};
+// Initiate the connection to the server
+let socket = socketClusterClient.create(options);
+```
+
+For more detailed examples of how to use SocketCluster, see `test/integration.js`.
+Also, see tests from the `socketcluster-server` module.
+
+### Connect Options
+
+See all available options: https://socketcluster.io/
+
+```js
+let options = {
+  path: '/socketcluster/',
+  port: 8000,
+  hostname: '127.0.0.1',
+  autoConnect: true,
+  secure: false,
+  rejectUnauthorized: false,
+  connectTimeout: 10000, //milliseconds
+  ackTimeout: 10000, //milliseconds
+  channelPrefix: null,
+  disconnectOnUnload: true,
+  autoReconnectOptions: {
+    initialDelay: 10000, //milliseconds
+    randomness: 10000, //milliseconds
+    multiplier: 1.5, //decimal
+    maxDelay: 60000 //milliseconds
+  },
+  authEngine: null,
+  codecEngine: null,
+  subscriptionRetryOptions: {},
+  query: {
+    yourparam: 'hello'
+  }
+};
+```
+
+## Running the tests
+
+- Clone this repo: `git clone git@github.com:SocketCluster/socketcluster-client.git`
+- Navigate to project directory: `cd socketcluster-client`
+- Install all dependencies: `npm install`
+- Run the tests: `npm test`
+
+## Compatibility mode
+
+For compatibility with an existing SocketCluster server, set the `protocolVersion` to `1` and make sure that the `path` matches your old server path:
+
+```js
+let socket = socketClusterClient.create({
+  protocolVersion: 1,
+  path: '/socketcluster/'
+});
+```
+
+## Developing
+
+### Install all dependencies
+
+```bash
+cd socketcluster-client
+
+npm install -g gulp gulp-cli browserify uglify-es
+
+npm install
+```
+
+### Building
+
+To build the SocketCluster client:
+
+```bash
+npm run build
+```
+
+## Change log
+
+See the 'releases' section for changes: https://github.com/SocketCluster/socketcluster-client/releases
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2013-2023 SocketCluster.io
+
+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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/auth.d.ts

@@ -0,0 +1,21 @@
+import { AuthState, AuthToken, SignedAuthToken } from "@socket-mesh/auth";
+export interface AuthStatus {
+    isAuthenticated?: AuthState;
+    authError: any;
+}
+export interface AuthEngine {
+    saveToken(name: string, token: SignedAuthToken, options?: {
+        [key: string]: any;
+    }): Promise<SignedAuthToken>;
+    removeToken(name: string): Promise<AuthToken | SignedAuthToken | null>;
+    loadToken(name: string): Promise<SignedAuthToken | null>;
+}
+export declare class LocalStorageAuthEngine implements AuthEngine {
+    private readonly _internalStorage;
+    readonly isLocalStorageEnabled: boolean;
+    constructor();
+    private _checkLocalStorageEnabled;
+    saveToken(name: string, token: string): Promise<SignedAuthToken>;
+    removeToken(name: string): Promise<SignedAuthToken>;
+    loadToken(name: string): Promise<SignedAuthToken>;
+}

package/auth.js

@@ -0,0 +1,66 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+export class LocalStorageAuthEngine {
+    constructor() {
+        this._internalStorage = {};
+        this.isLocalStorageEnabled = this._checkLocalStorageEnabled();
+    }
+    _checkLocalStorageEnabled() {
+        let err;
+        try {
+            // Some browsers will throw an error here if localStorage is disabled.
+            global.localStorage;
+            // Safari, in Private Browsing Mode, looks like it supports localStorage but all calls to setItem
+            // throw QuotaExceededError. We're going to detect this and avoid hard to debug edge cases.
+            global.localStorage.setItem('__scLocalStorageTest', "1");
+            global.localStorage.removeItem('__scLocalStorageTest');
+        }
+        catch (e) {
+            err = e;
+        }
+        return !err;
+    }
+    saveToken(name, token) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.isLocalStorageEnabled && global.localStorage) {
+                global.localStorage.setItem(name, token);
+            }
+            else {
+                this._internalStorage[name] = token;
+            }
+            return token;
+        });
+    }
+    removeToken(name) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let loadPromise = this.loadToken(name);
+            if (this.isLocalStorageEnabled && global.localStorage) {
+                global.localStorage.removeItem(name);
+            }
+            else {
+                delete this._internalStorage[name];
+            }
+            return loadPromise;
+        });
+    }
+    loadToken(name) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let token;
+            if (this.isLocalStorageEnabled && global.localStorage) {
+                token = global.localStorage.getItem(name);
+            }
+            else {
+                token = this._internalStorage[name] || null;
+            }
+            return token;
+        });
+    }
+}
+//# sourceMappingURL=auth.js.map

package/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":";;;;;;;;;AAmBA,MAAM,OAAO,sBAAsB;IAIlC;QACC,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,yBAAyB,EAAE,CAAC;IAC/D,CAAC;IAEO,yBAAyB;QAChC,IAAI,GAAG,CAAC;QAER,IAAI;YACH,sEAAsE;YACtE,MAAM,CAAC,YAAY,CAAC;YAEpB,iGAAiG;YACjG,2FAA2F;YAC3F,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAC;YACzD,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC;SACvD;QAAC,OAAO,CAAC,EAAE;YACX,GAAG,GAAG,CAAC,CAAC;SACR;QAED,OAAO,CAAC,GAAG,CAAC;IACb,CAAC;IAEK,SAAS,CAAC,IAAY,EAAE,KAAa;;YAC1C,IAAI,IAAI,CAAC,qBAAqB,IAAI,MAAM,CAAC,YAAY,EAAE;gBACtD,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;aACzC;iBAAM;gBACN,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;aACpC;YACD,OAAO,KAAK,CAAC;QACd,CAAC;KAAA;IAEK,WAAW,CAAC,IAAY;;YAC7B,IAAI,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAEvC,IAAI,IAAI,CAAC,qBAAqB,IAAI,MAAM,CAAC,YAAY,EAAE;gBACtD,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;aACrC;iBAAM;gBACN,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;aACnC;YAED,OAAO,WAAW,CAAC;QACpB,CAAC;KAAA;IAEK,SAAS,CAAC,IAAY;;YAC3B,IAAI,KAAK,CAAC;YAEV,IAAI,IAAI,CAAC,qBAAqB,IAAI,MAAM,CAAC,YAAY,EAAE;gBACtD,KAAK,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aAC1C;iBAAM;gBACN,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;aAC5C;YAED,OAAO,KAAK,CAAC;QACd,CAAC;KAAA;CACD"}

package/client-options.d.ts

@@ -0,0 +1,53 @@
+import { AuthEngine } from "./auth";
+import { CodecEngine } from "@socket-mesh/formatter";
+import * as ws from "ws";
+export type ProtocolVersions = 1 | 2;
+export type CallIdGenerator = () => number;
+export interface AutoReconnectOptions {
+    initialDelay?: number;
+    randomness?: number;
+    multiplier?: number;
+    maxDelay?: number;
+}
+export interface ClientOptions {
+    socketPath?: string;
+    host?: string;
+    hostname?: string;
+    secure?: boolean;
+    port?: number;
+    path?: string;
+    protocolScheme?: string;
+    query?: string | {
+        [key: string]: string | string[];
+    };
+    ackTimeout?: number;
+    connectTimeout?: number;
+    autoConnect?: boolean;
+    autoReconnect?: boolean;
+    autoReconnectOptions?: AutoReconnectOptions;
+    disconnectOnUnload?: boolean;
+    timestampRequests?: boolean;
+    timestampParam?: string;
+    authEngine?: AuthEngine | null;
+    authTokenName?: string;
+    binaryType?: "nodebuffer" | "arraybuffer" | "fragments";
+    cloneData?: boolean;
+    autoSubscribeOnConnect?: boolean;
+    codecEngine?: CodecEngine | null;
+    channelPrefix?: string | null;
+    subscriptionRetryOptions?: object | null;
+    batchOnHandshake?: boolean;
+    batchOnHandshakeDuration?: number;
+    batchInterval?: number;
+    /**
+    * @deprecated The "protocol" option does not affect socketcluster-client - If you want to utilize SSL/TLS, use "secure" option instead
+    */
+    protocol?: string;
+    protocolVersion?: ProtocolVersions;
+    wsOptions?: ws.ClientOptions;
+    version?: string;
+    clientId?: string;
+    pingTimeout?: number;
+    pingTimeoutDisabled?: boolean;
+    callIdGenerator?: CallIdGenerator;
+}

package/client-options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=client-options.js.map

package/client-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-options.js","sourceRoot":"","sources":["../src/client-options.ts"],"names":[],"mappings":""}

package/clientsocket.d.ts

@@ -0,0 +1,134 @@
+import { ClientOptions, ProtocolVersions } from "./client-options";
+import { DemuxedConsumableStream, StreamDemuxWrapper } from "@socket-mesh/stream-demux";
+import { AuthEngine, AuthStatus } from "./auth";
+import { AuthState, AuthToken, SignedAuthToken } from "@socket-mesh/auth";
+import { CodecEngine } from "@socket-mesh/formatter";
+import { Transport } from "./transport";
+import * as ws from "ws";
+import { Client, ChannelDetails } from "@socket-mesh/channel";
+import { SocketState } from "./socket-state";
+import { AuthStateChanged, AuthTokenRemoved, Authenticated, Closed, Connected, Connecting, Deauthenticated, ErrorOccured, KickedOut, SubscribeFailed, SubscribeStateChanged, Subscribed, Unsubscribed } from "./events";
+export declare class ClientSocket extends Client<any> {
+    auth: AuthEngine;
+    authTokenName?: string;
+    authToken?: AuthToken | null;
+    authState: AuthState;
+    codec: CodecEngine;
+    transport: Transport;
+    isBatching: boolean;
+    batchOnHandshake: boolean;
+    batchOnHandshakeDuration: number;
+    clientId?: string;
+    id: string | null;
+    disconnectOnUnload: boolean;
+    pendingReconnect: boolean;
+    pendingReconnectTimeout: number;
+    preparingPendingSubscriptions: boolean;
+    protocolVersion: ProtocolVersions;
+    channelPrefix: string | null;
+    connectAttempts: number;
+    options: ClientOptions;
+    connectTimeout: number;
+    ackTimeout: number;
+    pingTimeout: number;
+    pingTimeoutDisabled: boolean;
+    state: SocketState;
+    signedAuthToken: SignedAuthToken | null;
+    wsOptions?: ws.ClientOptions;
+    version?: string | null;
+    readonly receiver: StreamDemuxWrapper<any>;
+    readonly procedure: StreamDemuxWrapper<any>;
+    private _cid;
+    private _batchingIntervalId;
+    private _receiverDemux;
+    private _procedureDemux;
+    private _reconnectTimeoutRef?;
+    private readonly _outboundBuffer;
+    constructor(socketOptions: ClientOptions);
+    getBackpressure(): number;
+    private _handleBrowserUnload;
+    private _setAuthToken;
+    private _removeAuthToken;
+    getState(): SocketState;
+    getBytesReceived(): unknown;
+    deauthenticate(): Promise<void>;
+    connect(): void;
+    reconnect(code?: number, reason?: string): void;
+    disconnect(code?: number, reason?: string): void;
+    private _changeToUnauthenticatedStateAndClearTokens;
+    private _changeToAuthenticatedState;
+    decodeBase64(encodedString: string): string;
+    encodeBase64(decodedString: string): string;
+    private _extractAuthTokenData;
+    getAuthToken(): AuthToken;
+    getSignedAuthToken(): SignedAuthToken;
+    authenticate(signedAuthToken: SignedAuthToken): Promise<AuthStatus>;
+    private _tryReconnect;
+    private _onOpen;
+    private _onError;
+    private _suspendSubscriptions;
+    private _abortAllPendingEventsDueToBadConnection;
+    private _destroy;
+    private _onInboundTransmit;
+    private _onInboundInvoke;
+    decode(message: any): any;
+    encode(object: any): string;
+    private _flushOutboundBuffer;
+    private _handleEventAckTimeout;
+    private _processOutboundEvent;
+    send(data: string): void;
+    transmit(event: string, data?: any, options?: {
+        ackTimeout?: number;
+    }): Promise<void>;
+    invoke<T>(event: string, data: any, options?: {
+        ackTimeout?: number;
+    }): Promise<T>;
+    transmitPublish(channelName: string, data: any): Promise<void>;
+    invokePublish<T>(channelName: string, data: any): Promise<T>;
+    private _triggerChannelSubscribe;
+    private _triggerChannelSubscribeFail;
+    private _cancelPendingSubscribeCallback;
+    private _decorateChannelName;
+    private _undecorateChannelName;
+    startBatch(): void;
+    flushBatch(): void;
+    cancelBatch(): void;
+    private _startBatching;
+    startBatching(): void;
+    private _stopBatching;
+    stopBatching(): void;
+    private _cancelBatching;
+    cancelBatching(): void;
+    protected _trySubscribe(channel: ChannelDetails): void;
+    emit(eventName: 'removeAuthToken', data: AuthTokenRemoved): void;
+    emit(eventName: 'connect', data: Connected): void;
+    emit(eventName: 'connecting', data: Connecting): void;
+    emit(eventName: 'authStateChange', data: AuthStateChanged): void;
+    emit(eventName: 'authenticate', data: Authenticated): void;
+    emit(eventName: 'deauthenticate', data: Deauthenticated): void;
+    emit(eventName: 'error', data: ErrorOccured): void;
+    emit(eventName: 'connectAbort' | 'disconnect' | 'close', data: Closed): void;
+    emit(eventName: 'subscribeStateChange', data: SubscribeStateChanged): void;
+    emit(eventName: 'subscribe' | 'subscribeRequest', data: Subscribed): void;
+    emit(eventName: 'subscribeFail', data: SubscribeFailed): void;
+    emit(eventName: 'unsubscribe', data: Unsubscribed): void;
+    emit(eventName: 'kickOut', data: KickedOut): void;
+    emit(eventName: string, data: any): void;
+    listen(eventName: 'removeAuthToken'): DemuxedConsumableStream<AuthTokenRemoved>;
+    listen(eventName: 'connect'): DemuxedConsumableStream<Connected>;
+    listen(eventName: 'connecting'): DemuxedConsumableStream<Connecting>;
+    listen(eventName: 'authStateChange'): DemuxedConsumableStream<AuthStateChanged>;
+    listen(eventName: 'authenticate'): DemuxedConsumableStream<Authenticated>;
+    listen(eventName: 'deauthenticate'): DemuxedConsumableStream<Deauthenticated>;
+    listen(eventName: 'error'): DemuxedConsumableStream<ErrorOccured>;
+    listen(eventName: 'connectAbort' | 'disconnect' | 'close'): DemuxedConsumableStream<Closed>;
+    listen(eventName: 'subscribeStateChange'): DemuxedConsumableStream<SubscribeStateChanged>;
+    listen(eventName: 'subscribe' | 'subscribeRequest'): DemuxedConsumableStream<Subscribed>;
+    listen(eventName: 'subscribeFail'): DemuxedConsumableStream<SubscribeFailed>;
+    listen(eventName: 'unsubscribe'): DemuxedConsumableStream<Unsubscribed>;
+    listen(eventName: 'kickOut'): DemuxedConsumableStream<KickedOut>;
+    private _triggerChannelUnsubscribe;
+    protected _tryUnsubscribe(channel: ChannelDetails): void;
+    processPendingSubscriptions(): void;
+    get isBufferingBatch(): boolean;
+}