@socket-mesh/client 18.0.8 → 18.1.0

package/dist/plugins/offline-plugin.d.ts

@@ -0,0 +1,13 @@
+import { EmptySocketMap, Plugin, SendRequestPluginArgs, SocketMap } from "@socket-mesh/core";
+export declare class OfflinePlugin<T extends SocketMap = EmptySocketMap> implements Plugin<T> {
+    private _isReady;
+    private _requests;
+    private _continue;
+    constructor();
+    type: "offline";
+    sendRequest({ requests, cont }: SendRequestPluginArgs<T>): void;
+    onReady(): void;
+    onClose(): void;
+    onDisconnected(): void;
+    private flush;
+}

package/dist/plugins/offline-plugin.js

@@ -0,0 +1,47 @@
+const SYSTEM_METHODS = ['#handshake', '#removeAuthToken'];
+export class OfflinePlugin {
+    constructor() {
+        this.type = 'offline';
+        this._isReady = false;
+        this._requests = [];
+        this._continue = null;
+    }
+    sendRequest({ requests, cont }) {
+        if (this._isReady) {
+            cont(requests);
+            return;
+        }
+        const systemRequests = requests.filter(item => SYSTEM_METHODS.indexOf(String(item.method)) > -1);
+        let otherRequests = requests;
+        if (systemRequests.length) {
+            otherRequests = (systemRequests.length === requests.length) ? [] : requests.filter(item => SYSTEM_METHODS.indexOf(String(item.method)) < 0);
+        }
+        if (otherRequests.length) {
+            this._continue = cont;
+            this._requests.push(otherRequests);
+        }
+        if (systemRequests.length) {
+            cont(systemRequests);
+        }
+    }
+    onReady() {
+        this._isReady = true;
+        this.flush();
+    }
+    onClose() {
+        this._isReady = false;
+    }
+    onDisconnected() {
+        this._requests = [];
+        this._continue = null;
+    }
+    flush() {
+        if (this._requests.length) {
+            for (const reqs of this._requests) {
+                this._continue(reqs);
+            }
+            this._requests = [];
+            this._continue = null;
+        }
+    }
+}

package/package.json

@@ -1,62 +1,58 @@
 {
-  "name": "@socket-mesh/client",
-  "description": "SocketMesh JavaScript client",
-  "version": "18.0.8",
-	"type": "module",
-  "homepage": "https://socketmesh.io/",
-	"main": "index.js",
-  "contributors": [
-    "Greg Kimmy",
-    {
-      "name": "Jonathan Gros-Dubois",
-      "email": "grosjona@yahoo.com.au"
-    }
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/socket-mesh/client.git"
-  },
-  "scripts": {
-    "build": "node ./scripts/build.mjs && tsc",
-    "deploy": "cd dist && npm publish --access public",
-    "test": "cross-env node --test --loader ts-node/esm test/test.ts"
-  },
-  "keywords": [
-    "websocket",
-    "realtime",
-    "client",
-    "socketcluster",
-    "socketMesh"
-  ],
-  "dependencies": {
-		"@socket-mesh/auth": "^2.1.6",
-    "@socket-mesh/async-stream-emitter": "^7.0.6",
-    "@socket-mesh/channel": "^6.0.29",
-		"@socket-mesh/consumable-stream": "3.2.1",
-    "@socket-mesh/errors": "^3.0.8",
-    "@socket-mesh/formatter": "^4.0.5",
-    "@socket-mesh/request": "^2.0.9",
-    "@socket-mesh/stream-demux": "^10.0.4",
-    "buffer": "^6.0.3",
-    "clone-deep": "^4.0.1",
-    "linked-list": "^3.1.0",
-    "uuid": "^9.0.1",
-    "vinyl-buffer": "^1.0.1",
-    "ws": "^8.14.2"
-  },
+	"name": "@socket-mesh/client",
+	"description": "A TCP socket pair for easily transmitting full messages without worrying about request size limits.",
+	"version": "18.1.0",
+  "type": "module",
+  "main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"files": ["./dist"],
   "browser": {
     "ws": "./lib/ws-browser.js"
-  },
-  "readmeFilename": "README.md",
-  "license": "MIT",
-  "devDependencies": {
-    "@types/clone-deep": "^4.0.4",
-    "@types/uuid": "^9.0.7",
-    "@types/ws": "^8.5.10",
-		"cross-env": "^7.0.3",
-		"ts-node": "^10.9.1",
-		"typescript": "^5.3.2",
-    "@socket-mesh/local-storage": "^1.0.2",
-    "@socket-mesh/server": "^18.0.5"
-  }
+  },	
+	"author": {
+		"name": "Greg Kimmy"
+	},
+	"scripts": {
+    "build": "node ../../scripts/build.mjs && tsc --project tsconfig.build.json",
+		"bundle": "rollup --config ./rollup.config.js",
+    "deploy": "npm run build && node ../../scripts/publish.mjs",
+		"test": "cross-env node --test --import=./run-test.js test/client-test.ts"
+	},
+	"devDependencies": {
+		"@rollup/plugin-alias": "^5.1.0",
+		"@rollup/plugin-commonjs": "^26.0.1",
+		"@rollup/plugin-node-resolve": "^15.2.3",
+		"@rollup/plugin-terser": "^0.4.4",
+		"@rollup/plugin-typescript": "^11.1.6",
+		"@socket-mesh/server": "*",
+		"@socket-mesh/local-storage": "^1.0.2",
+		"@types/clone-deep": "^4.0.4",
+		"@types/jsonwebtoken": "^9.0.6",
+		"@types/ws": "^8.5.10",
+		"jsonwebtoken": "^9.0.2",
+		"rollup": "^4.18.1",
+		"tslib": "^2.6.3"
+	},
+	"dependencies": {
+		"@socket-mesh/async-stream-emitter": "^7.1.2",
+		"@socket-mesh/auth": "^2.2.0",
+		"@socket-mesh/channels": "^6.1.0",
+		"@socket-mesh/core": "^1.0.0",
+		"@socket-mesh/errors": "^3.2.0",
+		"@socket-mesh/formatter": "^4.1.0",
+    "buffer": "^5.2.1",
+		"events": "^3.3.0",
+		"isomorphic-ws": "^5.0.0",
+		"ws": "^8.18.0"
+	},
+	"keywords": [
+		"ncom",
+		"tcp",
+		"simple",
+		"socket",
+		"messages"
+	],
+	"engines": {
+		"node": ">= 0.8.0"
+	}
 }

package/auth.d.ts

@@ -1,21 +0,0 @@
-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

@@ -1,49 +0,0 @@
-export class LocalStorageAuthEngine {
-    constructor() {
-        this._internalStorage = {};
-        this.isLocalStorageEnabled = this._checkLocalStorageEnabled();
-    }
-    _checkLocalStorageEnabled() {
-        let err;
-        try {
-            // 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.
-            localStorage.setItem('__scLocalStorageTest', "1");
-            localStorage.removeItem('__scLocalStorageTest');
-        }
-        catch (e) {
-            err = e;
-        }
-        return !err;
-    }
-    async saveToken(name, token) {
-        if (this.isLocalStorageEnabled) {
-            localStorage.setItem(name, token);
-        }
-        else {
-            this._internalStorage[name] = token;
-        }
-        return token;
-    }
-    async removeToken(name) {
-        let loadPromise = this.loadToken(name);
-        if (this.isLocalStorageEnabled) {
-            localStorage.removeItem(name);
-        }
-        else {
-            delete this._internalStorage[name];
-        }
-        return loadPromise;
-    }
-    async loadToken(name) {
-        let token;
-        if (this.isLocalStorageEnabled) {
-            token = localStorage.getItem(name);
-        }
-        else {
-            token = this._internalStorage[name] || null;
-        }
-        return token;
-    }
-}
-//# sourceMappingURL=auth.js.map

package/auth.js.map

@@ -1 +0,0 @@
-{"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,CAAC;YACJ,iGAAiG;YACjG,2FAA2F;YAC3F,YAAY,CAAC,OAAO,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAC;YAClD,YAAY,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC;QACjD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,GAAG,GAAG,CAAC,CAAC;QACT,CAAC;QAED,OAAO,CAAC,GAAG,CAAC;IACb,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,IAAY,EAAE,KAAa;QAC1C,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAChC,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACnC,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QACrC,CAAC;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAY;QAC7B,IAAI,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAEvC,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAChC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;aAAM,CAAC;YACP,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,WAAW,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,IAAY;QAC3B,IAAI,KAAK,CAAC;QAEV,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAChC,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YACP,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;QAC7C,CAAC;QAED,OAAO,KAAK,CAAC;IACd,CAAC;CACD"}

package/client-options.d.ts

@@ -1,53 +0,0 @@
-import { AuthEngine } from "./auth.js";
-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;
-    usabilityMode?: boolean;
-    port?: number;
-    path?: string;
-    protocolScheme?: string;
-    query?: string | {
-        [key: string]: string | string[];
-    };
-    ackTimeout?: number;
-    connectTimeout?: number;
-    autoConnect?: boolean;
-    autoReconnect?: boolean;
-    autoReconnectOptions?: AutoReconnectOptions;
-    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

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

package/client-options.js.map

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

package/clientsocket.d.ts

@@ -1,135 +0,0 @@
-import { ClientOptions, ProtocolVersions } from "./client-options.js";
-import { DemuxedConsumableStream, StreamDemuxWrapper } from "@socket-mesh/stream-demux";
-import { AuthEngine, AuthStatus } from "./auth.js";
-import { AuthState, AuthToken, SignedAuthToken } from "@socket-mesh/auth";
-import { CodecEngine } from "@socket-mesh/formatter";
-import { Transport } from "./transport.js";
-import * as ws from "ws";
-import { Client, ChannelDetails } from "@socket-mesh/channel";
-import { SocketState } from "./socket-state.js";
-import { AuthStateChanged, AuthTokenRemoved, Authenticated, Closed, Connected, Connecting, Deauthenticated, ErrorOccured, KickedOut, MessageReceived, SubscribeFailed, SubscribeStateChanged, Subscribed, Unsubscribed } from "./events.js";
-import { RemoteProcedure } from "./remote-procedure.js";
-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;
-    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: RemoteProcedure;
-    private _cid;
-    private _batchingIntervalId;
-    private _receiverDemux;
-    private _procedureDemux;
-    private _reconnectTimeoutRef?;
-    private readonly _outboundBuffer;
-    constructor(socketOptions?: ClientOptions);
-    uri(): string;
-    getBackpressure(): number;
-    private _setAuthToken;
-    private _removeAuthToken;
-    getState(): SocketState;
-    getBytesReceived(): unknown;
-    deauthenticate(): Promise<void>;
-    connect(socketOptions?: ClientOptions): 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>;
-    listen(eventName: 'message'): DemuxedConsumableStream<MessageReceived>;
-    private _triggerChannelUnsubscribe;
-    protected _tryUnsubscribe(channel: ChannelDetails): void;
-    processPendingSubscriptions(): void;
-    get isBufferingBatch(): boolean;
-}