@rc-ex/ws 1.4.2 → 1.5.0

package/dist/cjs/index.js

@@ -1,333 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Events = void 0;
-const SdkExtension_1 = __importDefault(require("@rc-ex/core/SdkExtension"));
-const isomorphic_ws_1 = __importDefault(require("isomorphic-ws"));
-const hyperid_1 = __importDefault(require("hyperid"));
-const events_1 = require("events");
-const wait_for_async_1 = __importDefault(require("wait-for-async"));
-const RestException_1 = __importDefault(require("@rc-ex/core/RestException"));
-const rest_js_1 = require("./rest.js");
-const subscription_js_1 = __importDefault(require("./subscription.js"));
-const ConnectionException_js_1 = __importDefault(require("./exceptions/ConnectionException.js"));
-const utils_js_1 = __importDefault(require("./utils.js"));
-const CONNECTING = 0;
-const OPEN = 1;
-const uuid = (0, hyperid_1.default)();
-var Events;
-(function (Events) {
-    Events["autoRecoverSuccess"] = "autoRecoverSuccess";
-    Events["autoRecoverFailed"] = "autoRecoverFailed";
-    Events["autoRecoverError"] = "autoRecoverError";
-    Events["newWebSocketObject"] = "newWebSocketObject";
-    Events["newWsc"] = "newWsc";
-    Events["connectionReady"] = "connectionReady";
-})(Events || (exports.Events = Events = {}));
-class WebSocketExtension extends SdkExtension_1.default {
-    eventEmitter = new events_1.EventEmitter();
-    options;
-    rc;
-    wsToken;
-    wsTokenExpiresAt = 0;
-    ws;
-    connectionDetails;
-    wsc;
-    subscription;
-    // for auto recover
-    intervalHandle;
-    recoverTimestamp;
-    pingServerHandle;
-    _recoverPromise;
-    _connectPromise;
-    request = rest_js_1.request; // request method was moved to another file to keep this file short
-    constructor(options = {}) {
-        super();
-        this.options = options;
-        this.options.restOverWebSocket ??= false;
-        this.options.debugMode ??= false;
-        this.options.autoRecover ??= {
-            enabled: true,
-        };
-        this.options.autoRecover.checkInterval ??= (retriesAttempted) => {
-            const interval = 2000 + 2000 * retriesAttempted;
-            return Math.min(8000, interval);
-        };
-        this.options.autoRecover.pingServerInterval ??= 60000;
-    }
-    disable() {
-        super.disable();
-        if (this.subscription) {
-            this.subscription.enabled = false;
-        }
-    }
-    async install(rc) {
-        this.rc = rc;
-        if (this.options.restOverWebSocket) {
-            const request = rc.request.bind(rc);
-            rc.request = async (method, endpoint, content, queryParams, config) => {
-                if (!this.enabled || !this.options.restOverWebSocket) {
-                    return request(method, endpoint, content, queryParams, config);
-                }
-                if (
-                // the following cannot be done with WebSocket
-                config?.headers?.getContentType?.toString()?.includes("multipart/form-data") ||
-                    config?.responseType === "arraybuffer" ||
-                    endpoint.startsWith("/restapi/oauth/") // token, revoke, wstoken
-                ) {
-                    return request(method, endpoint, content, queryParams, config);
-                }
-                return this.request(method, endpoint, content, queryParams, config);
-            };
-        }
-        // should recover if this.options.wscToken
-        let connectMethod = this.connect.bind(this);
-        if (this.options.wscToken) {
-            this.wsc = {
-                token: this.options.wscToken,
-                sequence: 0,
-            };
-            connectMethod = this.recover.bind(this);
-        }
-        if (!this.options.autoRecover.enabled) {
-            await connectMethod();
-            return;
-        }
-        // code after is for auto recover
-        try {
-            await connectMethod();
-        }
-        catch (e) {
-            if (e instanceof RestException_1.default) {
-                throw e; // such as InsufficientPermissions
-            }
-            if (this.options.debugMode) {
-                console.debug("Initial connect failed:", e);
-            }
-        }
-        let retriesAttempted = 0;
-        let checking = false;
-        const check = async () => {
-            if (!this.enabled) {
-                return;
-            }
-            if (this.options.autoRecover?.enabled !== true) {
-                return;
-            }
-            if (checking) {
-                return;
-            }
-            checking = true;
-            if (this.ws?.readyState !== OPEN && this.ws?.readyState !== CONNECTING) {
-                clearInterval(this.intervalHandle);
-                try {
-                    await this.recover();
-                    retriesAttempted = 0;
-                    if (this.options.debugMode) {
-                        console.debug(`Auto recover done, recoveryState: ${this.connectionDetails.recoveryState}`);
-                    }
-                    this.eventEmitter.emit(this.connectionDetails.recoveryState === "Successful"
-                        ? Events.autoRecoverSuccess
-                        : Events.autoRecoverFailed, this.ws);
-                }
-                catch (e) {
-                    if (e instanceof RestException_1.default) {
-                        throw e; // such as InsufficientPermissions
-                    }
-                    retriesAttempted += 1;
-                    if (this.options.debugMode) {
-                        console.debug("Auto recover error:", e);
-                    }
-                    this.eventEmitter.emit(Events.autoRecoverError, e);
-                }
-                this.intervalHandle = setInterval(check, this.options.autoRecover.checkInterval(retriesAttempted));
-            }
-            checking = false;
-        };
-        this.intervalHandle = setInterval(check, this.options.autoRecover.checkInterval(retriesAttempted));
-        // browser only code start
-        if (typeof globalThis.window !== "undefined" &&
-            globalThis.window.addEventListener) {
-            globalThis.window.addEventListener("offline", () => {
-                if (this.pingServerHandle) {
-                    clearTimeout(this.pingServerHandle);
-                }
-                this.ws?.close();
-            });
-            globalThis.window.addEventListener("online", () => {
-                check();
-            });
-        }
-        // browser only code end
-    }
-    async recover() {
-        if (this._recoverPromise) {
-            return this._recoverPromise;
-        }
-        this._recoverPromise = this._recover();
-        try {
-            await this._recoverPromise;
-        }
-        finally {
-            this._recoverPromise = undefined;
-        }
-        return undefined;
-    }
-    async _recover() {
-        if (this.ws?.readyState === OPEN || this.ws?.readyState === CONNECTING) {
-            return;
-        }
-        if (!this.wsc || !this.wsc.token) {
-            await this.connect(false); // connect to WSG but do not recover
-            return;
-        }
-        if (this.recoverTimestamp === undefined) {
-            this.recoverTimestamp = Date.now();
-        }
-        if (this.connectionDetails !== undefined &&
-            Date.now() - this.recoverTimestamp >
-                this.connectionDetails.recoveryTimeout * 1000) {
-            if (this.options.debugMode) {
-                console.debug("connect to WSG but do not recover");
-            }
-            await this.connect(false); // connect to WSG but do not recover
-        }
-        else {
-            if (this.options.debugMode) {
-                console.debug("connect to WSG and recover");
-            }
-            await this.connect(true); // connect to WSG and recover
-        }
-        this.recoverTimestamp = undefined;
-        this.enable();
-    }
-    async pingServer() {
-        if (this.options.autoRecover?.enabled !== true) {
-            return;
-        }
-        if (this.ws?.readyState !== OPEN) {
-            return;
-        }
-        try {
-            await this.ws.send(JSON.stringify([
-                {
-                    type: "Heartbeat",
-                    messageId: uuid(),
-                },
-            ]));
-        }
-        catch (e) {
-            this.ws.close(); // Explicitly mark WS as closed
-        }
-    }
-    async connect(recoverSession) {
-        if (this._connectPromise) {
-            return this._connectPromise;
-        }
-        this._connectPromise = this._connect(recoverSession);
-        try {
-            await this._connectPromise;
-        }
-        finally {
-            this._connectPromise = undefined;
-        }
-        return undefined;
-    }
-    async _connect(recoverSession = false) {
-        if (!this.wsToken || Date.now() > this.wsTokenExpiresAt) {
-            const r = await this.rc.post("/restapi/oauth/wstoken");
-            this.wsToken = r.data;
-            // `expires_in` default value is 600 seconds. That's why we `* 0.8`
-            this.wsTokenExpiresAt = Date.now() + this.wsToken.expires_in * 0.8 * 1000;
-        }
-        let wsUri = `${this.wsToken.uri}?access_token=${this.wsToken.ws_access_token}`;
-        if (recoverSession && this.wsc) {
-            wsUri += `&wsc=${this.wsc.token}`;
-        }
-        this.ws = new isomorphic_ws_1.default(wsUri);
-        this.eventEmitter.emit(Events.newWebSocketObject, this.ws);
-        // override send method to wait for connecting
-        const send = this.ws.send.bind(this.ws);
-        this.ws.send = async (s) => {
-            if (this.ws.readyState === CONNECTING) {
-                await (0, wait_for_async_1.default)({
-                    interval: 100,
-                    condition: () => this.ws.readyState !== CONNECTING,
-                });
-            }
-            await send(s);
-        };
-        if (this.options.autoRecover?.enabled) {
-            this.ws.addEventListener("message", () => {
-                if (this.pingServerHandle) {
-                    clearTimeout(this.pingServerHandle);
-                }
-                this.pingServerHandle = setTimeout(() => this.pingServer(), this.options.autoRecover.pingServerInterval);
-            });
-        }
-        // debug mode to print all WebSocket traffic
-        if (this.options.debugMode) {
-            utils_js_1.default.debugWebSocket(this.ws);
-        }
-        // listen for new wsc data
-        this.ws.addEventListener("message", (mEvent) => {
-            const event = mEvent;
-            const [meta, body] = utils_js_1.default.splitWsgData(event.data);
-            if (meta.wsc &&
-                (!this.wsc ||
-                    (meta.type === "ConnectionDetails" && body.recoveryState) ||
-                    this.wsc.sequence < meta.wsc.sequence)) {
-                this.wsc = meta.wsc;
-                this.eventEmitter.emit(Events.newWsc, this.wsc);
-            }
-        });
-        // get initial ConnectionDetails data
-        const [meta, body, event] = await utils_js_1.default.waitForWebSocketMessage(this.ws, (meta) => meta.type === "ConnectionDetails" || meta.type === "Error");
-        if (meta.type === "Error") {
-            throw new ConnectionException_js_1.default(event);
-        }
-        this.connectionDetails = body;
-        // fired when ws connection is ready for creating subscription
-        this.eventEmitter.emit(Events.connectionReady, this.ws);
-        // recover the subscription, if it exists and enabled
-        if (this.subscription && this.subscription.enabled) {
-            // because we have a new ws object
-            this.subscription.setupWsEventListener();
-            if (!recoverSession || this.connectionDetails.recoveryState === "Failed") {
-                // create new subscription if don't recover existing one
-                await this.subscription.subscribe();
-            }
-        }
-    }
-    // keepInterval means we do not clear the interval
-    async revoke(keepInterval = false) {
-        await this.subscription?.revoke();
-        this.subscription = undefined;
-        if (!keepInterval && this.intervalHandle) {
-            clearInterval(this.intervalHandle);
-        }
-        if (this.pingServerHandle) {
-            clearTimeout(this.pingServerHandle);
-        }
-        this.ws?.close();
-        this.wsc = undefined;
-        this.wsToken = undefined;
-        this.wsTokenExpiresAt = 0;
-        this.disable();
-    }
-    async subscribe(eventFilters, callback, cache = undefined) {
-        const subscription = new subscription_js_1.default(this, eventFilters, callback);
-        if (cache === undefined || cache === null) {
-            await subscription.subscribe();
-        }
-        else {
-            subscription.subscriptionInfo = cache;
-            await subscription.refresh();
-        }
-        this.subscription = subscription;
-        return subscription;
-    }
-}
-exports.default = WebSocketExtension;

package/dist/cjs/rest.js

@@ -1,53 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.request = request;
-const RestException_1 = __importDefault(require("@rc-ex/core/RestException"));
-const hyperid_1 = __importDefault(require("hyperid"));
-const http_status_codes_1 = require("http-status-codes");
-const utils_js_1 = __importDefault(require("./utils.js"));
-const version = "0.16";
-const uuid = (0, hyperid_1.default)();
-async function request(method, endpoint, content, queryParams, config) {
-    const newConfig = {
-        method,
-        baseURL: this.wsToken?.uri,
-        url: endpoint,
-        data: content,
-        params: queryParams,
-        ...config,
-    };
-    newConfig.headers = {
-        ...newConfig.headers,
-        "X-User-Agent": `${this.rc.rest.appName}/${this.rc.rest.appVersion} ringcentral-extensible/ws/${version}`,
-    };
-    const messageId = uuid();
-    const requestBody = [
-        {
-            type: "ClientRequest",
-            messageId,
-            method: newConfig.method,
-            path: newConfig.url,
-            headers: newConfig.headers,
-            query: newConfig.params,
-        },
-    ];
-    if (newConfig.data) {
-        requestBody.push(newConfig.data);
-    }
-    await this.ws.send(JSON.stringify(requestBody));
-    const [meta, body] = await utils_js_1.default.waitForWebSocketMessage(this.ws, (_meta) => _meta.messageId === messageId);
-    const response = {
-        data: body,
-        status: meta.status,
-        statusText: (0, http_status_codes_1.getReasonPhrase)(meta.status),
-        headers: meta.headers,
-        config: newConfig,
-    };
-    if (meta.type === "ClientRequest" && meta.status >= 200 && meta.status < 300) {
-        return response;
-    }
-    throw new RestException_1.default(response);
-}

package/dist/cjs/subscription.js

@@ -1,95 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_js_1 = __importDefault(require("./utils.js"));
-class Subscription {
-    subscriptionInfo;
-    wse;
-    eventFilters;
-    eventListener;
-    timeout;
-    enabled = true;
-    constructor(wse, eventFilters, callback) {
-        this.wse = wse;
-        this.eventFilters = eventFilters;
-        this.eventListener = (mEvent) => {
-            const event = mEvent;
-            const [meta, body] = utils_js_1.default
-                .splitWsgData(event.data);
-            if (this.enabled && meta.type === "ServerNotification" &&
-                body.subscriptionId === this.subscriptionInfo.id) {
-                callback(body);
-            }
-        };
-        this.setupWsEventListener();
-    }
-    setupWsEventListener() {
-        this.wse.ws.addEventListener("message", this.eventListener);
-    }
-    get requestBody() {
-        return {
-            deliveryMode: { transportType: "WebSocket" }, // because WebSocket is not in spec
-            eventFilters: this.eventFilters,
-        };
-    }
-    async subscribe() {
-        this.subscriptionInfo = (await this.wse.request("POST", "/restapi/v1.0/subscription", this.requestBody)).data;
-    }
-    async refresh() {
-        if (!this.subscriptionInfo) {
-            return;
-        }
-        try {
-            this.subscriptionInfo = (await this.wse.request("PUT", `/restapi/v1.0/subscription/${this.subscriptionInfo.id}`, this.requestBody)).data;
-        }
-        catch (e) {
-            const re = e;
-            if (re.response && re.response.status === 404) {
-                // subscription expired
-                await this.subscribe();
-            }
-        }
-    }
-    async revoke() {
-        if (!this.subscriptionInfo) {
-            return;
-        }
-        try {
-            await this.wse.request("DELETE", `/restapi/v1.0/subscription/${this.subscriptionInfo.id}`);
-        }
-        catch (e) {
-            const re = e;
-            if (re.response && re.response.status === 404) {
-                // ignore
-                if (this.wse.options.debugMode) {
-                    console.debug(`Subscription ${this.subscriptionInfo.id} doesn't exist on server side`);
-                }
-            }
-            else if (re.response && re.response.status === 401) {
-                // ignore
-                if (this.wse.options.debugMode) {
-                    console.debug("Token invalid when trying to revoke subscription");
-                }
-            }
-            else {
-                throw e;
-            }
-        }
-        this.remove();
-    }
-    remove() {
-        if (this.timeout) {
-            global.clearTimeout(this.timeout);
-            this.timeout = undefined;
-        }
-        this.enabled = false;
-        this.subscriptionInfo = undefined;
-        if (this.wse.ws) {
-            this.wse.ws.removeEventListener("message", this.eventListener);
-        }
-        this.wse.subscription = undefined;
-    }
-}
-exports.default = Subscription;

package/dist/cjs/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/utils.js

@@ -1,71 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const ClosedException_js_1 = __importDefault(require("./exceptions/ClosedException.js"));
-const TimeoutException_js_1 = __importDefault(require("./exceptions/TimeoutException.js"));
-class Utils {
-    static splitWsgData(wsgData) {
-        if (wsgData.includes(",--Boundary")) {
-            const index = wsgData.indexOf(",--Boundary");
-            return [
-                JSON.parse(wsgData.substring(1, index)),
-                wsgData.substring(index + 1, wsgData.length - 1),
-            ];
-        }
-        return JSON.parse(wsgData);
-    }
-    static debugWebSocket(_ws) {
-        const ws = _ws;
-        const send = ws.send.bind(ws);
-        ws.send = async (str) => {
-            await send(str);
-            console.debug(`*** WebSocket outgoing message: ***
-${JSON.stringify(JSON.parse(str), null, 2)}
-******`);
-        };
-        ws.addEventListener("message", (mEvent) => {
-            const event = mEvent;
-            console.debug(`*** WebSocket incoming message: ***
-${JSON.stringify(JSON.parse(event.data), null, 2)}
-******`);
-        });
-        ws.addEventListener("open", (event) => {
-            console.debug("WebSocket open event:", event);
-        });
-        ws.addEventListener("error", (event) => {
-            console.debug("WebSocket error event:", event);
-        });
-        ws.addEventListener("close", (event) => {
-            console.debug("WebSocket close event:", event);
-        });
-    }
-    static waitForWebSocketMessage(ws, matchCondition, timeout = 60000) {
-        return new Promise((resolve, reject) => {
-            const checkHandle = setInterval(() => {
-                if (ws.readyState === ws.CLOSED) {
-                    clearInterval(checkHandle);
-                    reject(new ClosedException_js_1.default());
-                }
-            }, 1000);
-            const timeoutHandle = setTimeout(() => {
-                ws.removeEventListener("message", handler);
-                clearInterval(checkHandle);
-                reject(new TimeoutException_js_1.default());
-            }, timeout);
-            const handler = (mEvent) => {
-                const event = mEvent;
-                const [meta, body] = Utils.splitWsgData(event.data);
-                if (matchCondition(meta)) {
-                    ws.removeEventListener("message", handler);
-                    clearInterval(checkHandle);
-                    clearTimeout(timeoutHandle);
-                    resolve([meta, body, event]);
-                }
-            };
-            ws.addEventListener("message", handler);
-        });
-    }
-}
-exports.default = Utils;

package/dist/esm/exceptions/ClosedException.d.ts

@@ -1,4 +0,0 @@
-declare class ClosedException extends Error {
-    constructor(message?: string);
-}
-export default ClosedException;

package/dist/esm/exceptions/ClosedException.js

@@ -1,6 +0,0 @@
-class ClosedException extends Error {
-    constructor(message) {
-        super(message ?? "WebSocket has been closed");
-    }
-}
-export default ClosedException;

package/dist/esm/exceptions/ConnectionException.d.ts

@@ -1,7 +0,0 @@
-import type { WsgError, WsgEvent } from "../types.js";
-declare class ConnectionException extends Error {
-    wsgEvent: WsgEvent;
-    wsgError: WsgError;
-    constructor(wsgEvent: WsgEvent);
-}
-export default ConnectionException;

package/dist/esm/exceptions/ConnectionException.js

@@ -1,12 +0,0 @@
-import Utils from "../utils.js";
-class ConnectionException extends Error {
-    wsgEvent;
-    wsgError;
-    constructor(wsgEvent) {
-        const [, wsgError] = Utils.splitWsgData(wsgEvent.data);
-        super(JSON.stringify(wsgError, null, 2));
-        this.wsgEvent = wsgEvent;
-        this.wsgError = wsgError;
-    }
-}
-export default ConnectionException;

package/dist/esm/exceptions/TimeoutException.d.ts

@@ -1,4 +0,0 @@
-declare class TimeoutException extends Error {
-    constructor(message?: string);
-}
-export default TimeoutException;

package/dist/esm/exceptions/TimeoutException.js

@@ -1,6 +0,0 @@
-class TimeoutException extends Error {
-    constructor(message) {
-        super(message ?? "Failed to receive expected WebSocket message in time.");
-    }
-}
-export default TimeoutException;

package/dist/esm/index.d.ts

@@ -1,44 +0,0 @@
-import type RingCentral from "@rc-ex/core";
-import SdkExtension from "@rc-ex/core/SdkExtension";
-import WS from "isomorphic-ws";
-import { EventEmitter } from "events";
-import type SubscriptionInfo from "@rc-ex/core/definitions/SubscriptionInfo";
-import { request } from "./rest.js";
-import type { ConnectionDetails, WebSocketOptions, Wsc, WsToken } from "./types.js";
-import Subscription from "./subscription.js";
-export declare enum Events {
-    autoRecoverSuccess = "autoRecoverSuccess",
-    autoRecoverFailed = "autoRecoverFailed",
-    autoRecoverError = "autoRecoverError",
-    newWebSocketObject = "newWebSocketObject",
-    newWsc = "newWsc",
-    connectionReady = "connectionReady"
-}
-declare class WebSocketExtension extends SdkExtension {
-    eventEmitter: EventEmitter<any>;
-    options: WebSocketOptions;
-    rc: RingCentral;
-    wsToken?: WsToken;
-    wsTokenExpiresAt: number;
-    ws: WS;
-    connectionDetails: ConnectionDetails;
-    wsc?: Wsc;
-    subscription?: Subscription;
-    intervalHandle?: NodeJS.Timeout;
-    recoverTimestamp?: number;
-    pingServerHandle?: NodeJS.Timeout;
-    _recoverPromise?: Promise<void>;
-    _connectPromise?: Promise<void>;
-    request: typeof request;
-    constructor(options?: WebSocketOptions);
-    disable(): void;
-    install(rc: RingCentral): Promise<void>;
-    recover(): Promise<void>;
-    _recover(): Promise<void>;
-    pingServer(): Promise<void>;
-    connect(recoverSession?: boolean): Promise<void>;
-    _connect(recoverSession?: boolean): Promise<void>;
-    revoke(keepInterval?: boolean): Promise<void>;
-    subscribe(eventFilters: string[], callback: (event: {}) => void, cache?: SubscriptionInfo | undefined | null): Promise<Subscription>;
-}
-export default WebSocketExtension;