@rc-ex/ws 1.2.0 → 1.2.2

package/src/rest.js

@@ -0,0 +1,55 @@
+"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/src/RestException"));
+const hyperid_1 = __importDefault(require("hyperid"));
+const http_status_codes_1 = require("http-status-codes");
+const utils_1 = __importDefault(require("./utils"));
+const version = "0.16";
+const uuid = (0, hyperid_1.default)();
+async function request(method, endpoint, content, queryParams, config) {
+    var _a;
+    const newConfig = {
+        method,
+        baseURL: (_a = this.wsToken) === null || _a === void 0 ? void 0 : _a.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_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);
+}
+//# sourceMappingURL=rest.js.map

package/src/rest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest.js","sourceRoot":"","sources":["rest.ts"],"names":[],"mappings":";;;;;AAgBA,0BAsDC;AAjED,kFAA0D;AAC1D,sDAA8B;AAC9B,yDAAoD;AAEpD,oDAA4B;AAG5B,MAAM,OAAO,GAAG,MAAM,CAAC;AAEvB,MAAM,IAAI,GAAG,IAAA,iBAAO,GAAE,CAAC;AAEhB,KAAK,UAAU,OAAO,CAE3B,MAAkB,EAClB,QAAgB,EAChB,OAAY,EACZ,WAAgB,EAChB,MAA0B;;IAE1B,MAAM,SAAS,GAAsB;QACnC,MAAM;QACN,OAAO,EAAE,MAAA,IAAI,CAAC,OAAO,0CAAE,GAAG;QAC1B,GAAG,EAAE,QAAQ;QACb,IAAI,EAAE,OAAO;QACb,MAAM,EAAE,WAAW;QACnB,GAAG,MAAM;KACV,CAAC;IACF,SAAS,CAAC,OAAO,GAAG;QAClB,GAAG,SAAS,CAAC,OAAO;QACpB,cAAc,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC,IAAK,CAAC,OAAO,IACtC,IAAI,CAAC,EAAE,CAAC,IAAK,CAAC,UAChB,8BAA8B,OAAO,EAAE;KACjC,CAAC;IACT,MAAM,SAAS,GAAG,IAAI,EAAE,CAAC;IACzB,MAAM,WAAW,GAAG;QAClB;YACE,IAAI,EAAE,eAAe;YACrB,SAAS;YACT,MAAM,EAAE,SAAS,CAAC,MAAM;YACxB,IAAI,EAAE,SAAS,CAAC,GAAG;YACnB,OAAO,EAAE,SAAS,CAAC,OAAO;YAC1B,KAAK,EAAE,SAAS,CAAC,MAAM;SACxB;KACF,CAAC;IACF,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;QACnB,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IACD,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;IAChD,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,MAAM,eAAK,CAAC,uBAAuB,CACtD,IAAI,CAAC,EAAE,EACP,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CACzC,CAAC;IACF,MAAM,QAAQ,GAAiB;QAC7B,IAAI,EAAE,IAAS;QACf,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,UAAU,EAAE,IAAA,mCAAe,EAAC,IAAI,CAAC,MAAM,CAAC;QACxC,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,MAAM,EAAE,SAAgB;KACzB,CAAC;IACF,IACE,IAAI,CAAC,IAAI,KAAK,eAAe,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,MAAM,GAAG,GAAG,EACxE,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,IAAI,uBAAa,CAAC,QAAQ,CAAC,CAAC;AACpC,CAAC"}

package/src/rest.ts

@@ -1,16 +1,19 @@
-import type { RestMethod, RestRequestConfig, RestResponse } from '@rc-ex/core/lib/types';
-import RestException from '@rc-ex/core/lib/RestException';
-import hyperid from 'hyperid';
-import { getReasonPhrase } from 'http-status-codes';
+import type {
+  RestMethod,
+  RestRequestConfig,
+  RestResponse,
+} from "@rc-ex/core/src/types";
+import RestException from "@rc-ex/core/src/RestException";
+import hyperid from "hyperid";
+import { getReasonPhrase } from "http-status-codes";
 
-import Utils from './utils';
-import type { WebSocketExtensionInterface } from './types';
+import Utils from "./utils";
+import type { WebSocketExtensionInterface } from "./types";
 
-const version = '0.16';
+const version = "0.16";
 
 const uuid = hyperid();
 
-// eslint-disable-next-line max-params
 export async function request<T>(
   this: WebSocketExtensionInterface,
   method: RestMethod,
@@ -29,12 +32,14 @@ export async function request<T>(
   };
   newConfig.headers = {
     ...newConfig.headers,
-    'X-User-Agent': `${this.rc.rest!.appName}/${this.rc.rest!.appVersion} ringcentral-extensible/ws/${version}`,
+    "X-User-Agent": `${this.rc.rest!.appName}/${
+      this.rc.rest!.appVersion
+    } ringcentral-extensible/ws/${version}`,
   } as any;
   const messageId = uuid();
   const requestBody = [
     {
-      type: 'ClientRequest',
+      type: "ClientRequest",
       messageId,
       method: newConfig.method,
       path: newConfig.url,
@@ -46,7 +51,10 @@ export async function request<T>(
     requestBody.push(newConfig.data);
   }
   await this.ws.send(JSON.stringify(requestBody));
-  const [meta, body] = await Utils.waitForWebSocketMessage(this.ws, (_meta) => _meta.messageId === messageId);
+  const [meta, body] = await Utils.waitForWebSocketMessage(
+    this.ws,
+    (_meta) => _meta.messageId === messageId,
+  );
   const response: RestResponse = {
     data: body as T,
     status: meta.status,
@@ -54,7 +62,9 @@ export async function request<T>(
     headers: meta.headers,
     config: newConfig as any,
   };
-  if (meta.type === 'ClientRequest' && meta.status >= 200 && meta.status < 300) {
+  if (
+    meta.type === "ClientRequest" && meta.status >= 200 && meta.status < 300
+  ) {
     return response;
   }
   throw new RestException(response);

package/src/subscription.d.ts

@@ -0,0 +1,20 @@
+import type CreateSubscriptionRequest from "@rc-ex/core/src/definitions/CreateSubscriptionRequest";
+import type SubscriptionInfo from "@rc-ex/core/src/definitions/SubscriptionInfo";
+import type { MessageEvent } from "ws";
+import type { WebSocketExtensionInterface } from "./types";
+declare class Subscription {
+    subscriptionInfo?: SubscriptionInfo;
+    wse: WebSocketExtensionInterface;
+    eventFilters: string[];
+    eventListener: (event: MessageEvent) => void;
+    timeout?: NodeJS.Timeout;
+    enabled: boolean;
+    constructor(wse: WebSocketExtensionInterface, eventFilters: string[], callback: (event: {}) => void);
+    setupWsEventListener(): void;
+    get requestBody(): CreateSubscriptionRequest;
+    subscribe(): Promise<void>;
+    refresh(): Promise<void>;
+    revoke(): Promise<void>;
+    remove(): void;
+}
+export default Subscription;

package/src/subscription.js

@@ -0,0 +1,91 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = __importDefault(require("./utils"));
+class Subscription {
+    constructor(wse, eventFilters, callback) {
+        this.enabled = true;
+        this.wse = wse;
+        this.eventFilters = eventFilters;
+        this.eventListener = (mEvent) => {
+            const event = mEvent;
+            const [meta, body] = utils_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;
+//# sourceMappingURL=subscription.js.map

package/src/subscription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription.js","sourceRoot":"","sources":["subscription.ts"],"names":[],"mappings":";;;;;AAMA,oDAA4B;AAE5B,MAAM,YAAY;IAahB,YACE,GAAgC,EAChC,YAAsB,EACtB,QAA6B;QALxB,YAAO,GAAG,IAAI,CAAC;QAOpB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,aAAa,GAAG,CAAC,MAAoB,EAAE,EAAE;YAC5C,MAAM,KAAK,GAAG,MAAkB,CAAC;YACjC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAA0C,eAAK;iBAC9D,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC5B,IACE,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,KAAK,oBAAoB;gBAClD,IAAI,CAAC,cAAc,KAAK,IAAI,CAAC,gBAAiB,CAAC,EAAE,EACjD,CAAC;gBACD,QAAQ,CAAC,IAAI,CAAC,CAAC;YACjB,CAAC;QACH,CAAC,CAAC;QACF,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAEM,oBAAoB;QACzB,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IAC9D,CAAC;IAED,IAAW,WAAW;QACpB,OAAO;YACL,YAAY,EAAE,EAAE,aAAa,EAAE,WAAkB,EAAE,EAAE,mCAAmC;YACxF,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,SAAS;QACpB,IAAI,CAAC,gBAAgB,GAAG,CACtB,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CACpB,MAAM,EACN,4BAA4B,EAC5B,IAAI,CAAC,WAAW,CACjB,CACF,CAAC,IAAI,CAAC;IACT,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC3B,OAAO;QACT,CAAC;QACD,IAAI,CAAC;YACH,IAAI,CAAC,gBAAgB,GAAG,CACtB,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CACpB,KAAK,EACL,8BAA8B,IAAI,CAAC,gBAAiB,CAAC,EAAE,EAAE,EACzD,IAAI,CAAC,WAAW,CACjB,CACF,CAAC,IAAI,CAAC;QACT,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,EAAE,GAAG,CAA+B,CAAC;YAC3C,IAAI,EAAE,CAAC,QAAQ,IAAI,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC9C,uBAAuB;gBACvB,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACzB,CAAC;QACH,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,MAAM;QACjB,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC3B,OAAO;QACT,CAAC;QACD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CACpB,QAAQ,EACR,8BAA8B,IAAI,CAAC,gBAAiB,CAAC,EAAE,EAAE,CAC1D,CAAC;QACJ,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,EAAE,GAAG,CAA+B,CAAC;YAC3C,IAAI,EAAE,CAAC,QAAQ,IAAI,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC9C,SAAS;gBACT,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;oBAC/B,OAAO,CAAC,KAAK,CACX,gBACE,IAAI,CAAC,gBAAiB,CAAC,EACzB,+BAA+B,CAChC,CAAC;gBACJ,CAAC;YACH,CAAC;iBAAM,IAAI,EAAE,CAAC,QAAQ,IAAI,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACrD,SAAS;gBACT,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;oBAC/B,OAAO,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAC;gBACpE,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,CAAC;YACV,CAAC;QACH,CAAC;QACD,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAEM,MAAM;QACX,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAClC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;QAC3B,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;QAClC,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YAChB,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,SAAS,CAAC;IACpC,CAAC;CACF;AAED,kBAAe,YAAY,CAAC"}

package/src/subscription.ts

@@ -1,11 +1,10 @@
-/* eslint-disable no-console */
-import type CreateSubscriptionRequest from '@rc-ex/core/lib/definitions/CreateSubscriptionRequest';
-import type SubscriptionInfo from '@rc-ex/core/lib/definitions/SubscriptionInfo';
-import type { RestResponse } from '@rc-ex/core/lib/types';
-import type { MessageEvent } from 'ws';
+import type CreateSubscriptionRequest from "@rc-ex/core/src/definitions/CreateSubscriptionRequest";
+import type SubscriptionInfo from "@rc-ex/core/src/definitions/SubscriptionInfo";
+import type { RestResponse } from "@rc-ex/core/src/types";
+import type { MessageEvent } from "ws";
 
-import type { WsgEvent, WsgMeta, WebSocketExtensionInterface } from './types';
-import Utils from './utils';
+import type { WebSocketExtensionInterface, WsgEvent, WsgMeta } from "./types";
+import Utils from "./utils";
 
 class Subscription {
   public subscriptionInfo?: SubscriptionInfo;
@@ -20,13 +19,21 @@ class Subscription {
 
   public enabled = true;
 
-  public constructor(wse: WebSocketExtensionInterface, eventFilters: string[], callback: (event: {}) => void) {
+  public constructor(
+    wse: WebSocketExtensionInterface,
+    eventFilters: string[],
+    callback: (event: {}) => void,
+  ) {
     this.wse = wse;
     this.eventFilters = eventFilters;
     this.eventListener = (mEvent: MessageEvent) => {
       const event = mEvent as WsgEvent;
-      const [meta, body]: [WsgMeta, { subscriptionId: string }] = Utils.splitWsgData(event.data);
-      if (this.enabled && meta.type === 'ServerNotification' && body.subscriptionId === this.subscriptionInfo!.id) {
+      const [meta, body]: [WsgMeta, { subscriptionId: string }] = Utils
+        .splitWsgData(event.data);
+      if (
+        this.enabled && meta.type === "ServerNotification" &&
+        body.subscriptionId === this.subscriptionInfo!.id
+      ) {
         callback(body);
       }
     };
@@ -34,19 +41,23 @@ class Subscription {
   }
 
   public setupWsEventListener() {
-    this.wse.ws.addEventListener('message', this.eventListener);
+    this.wse.ws.addEventListener("message", this.eventListener);
   }
 
   public get requestBody(): CreateSubscriptionRequest {
     return {
-      deliveryMode: { transportType: 'WebSocket' as any }, // because WebSocket is not in spec
+      deliveryMode: { transportType: "WebSocket" as any }, // because WebSocket is not in spec
       eventFilters: this.eventFilters,
     };
   }
 
   public async subscribe() {
     this.subscriptionInfo = (
-      await this.wse.request<SubscriptionInfo>('POST', '/restapi/v1.0/subscription', this.requestBody)
+      await this.wse.request<SubscriptionInfo>(
+        "POST",
+        "/restapi/v1.0/subscription",
+        this.requestBody,
+      )
     ).data;
   }
 
@@ -57,7 +68,7 @@ class Subscription {
     try {
       this.subscriptionInfo = (
         await this.wse.request<SubscriptionInfo>(
-          'PUT',
+          "PUT",
           `/restapi/v1.0/subscription/${this.subscriptionInfo!.id}`,
           this.requestBody,
         )
@@ -76,18 +87,25 @@ class Subscription {
       return;
     }
     try {
-      await this.wse.request<SubscriptionInfo>('DELETE', `/restapi/v1.0/subscription/${this.subscriptionInfo!.id}`);
+      await this.wse.request<SubscriptionInfo>(
+        "DELETE",
+        `/restapi/v1.0/subscription/${this.subscriptionInfo!.id}`,
+      );
     } catch (e) {
       const re = e as { response: RestResponse };
       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`);
+          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');
+          console.debug("Token invalid when trying to revoke subscription");
         }
       } else {
         throw e;
@@ -104,7 +122,7 @@ class Subscription {
     this.enabled = false;
     this.subscriptionInfo = undefined;
     if (this.wse.ws) {
-      this.wse.ws.removeEventListener('message', this.eventListener);
+      this.wse.ws.removeEventListener("message", this.eventListener);
     }
     this.wse.subscription = undefined;
   }

package/src/types.d.ts

@@ -0,0 +1,61 @@
+import type RingCentral from "@rc-ex/core";
+import type { RestMethod, RestRequestConfig, RestResponse } from "@rc-ex/core/src/types";
+import type WS from "isomorphic-ws";
+export interface WsToken {
+    uri: string;
+    ws_access_token: string;
+    expires_in: number;
+}
+export type CheckInterval = (retriesAttempted: number) => number;
+export interface WebSocketOptions {
+    restOverWebSocket?: boolean;
+    debugMode?: boolean;
+    autoRecover?: {
+        enabled: boolean;
+        checkInterval?: CheckInterval;
+        pingServerInterval?: number;
+    };
+    wscToken?: string;
+}
+export interface WsgEvent {
+    data: string;
+}
+export interface Wsc {
+    token: string;
+    sequence: number;
+}
+export interface WsgMeta {
+    type: "ClientRequest" | "ServerNotification" | "Error" | "ConnectionDetails" | "Heartbeat";
+    messageId: string;
+    status: number;
+    headers: {
+        [key: string]: string;
+    };
+    wsc?: Wsc;
+}
+export interface WsgError {
+    errorCode: string;
+    message: string;
+}
+export interface ConnectionDetails {
+    creationTime: string;
+    maxConnectionsPerSession: number;
+    recoveryBufferSize: number;
+    recoveryTimeout: number;
+    idleTimeout: number;
+    absoluteTimeout: number;
+    maxActiveRequests: number;
+    recoveryState?: "Successful" | "Failed";
+    recoveryErrorCode?: string;
+}
+export interface WebSocketExtensionInterface {
+    options: WebSocketOptions;
+    subscription?: SubscriptionInterface;
+    ws: WS;
+    wsToken?: WsToken;
+    rc: RingCentral;
+    request: <T>(method: RestMethod, endpoint: string, content?: {}, queryParams?: {}, config?: RestRequestConfig) => Promise<RestResponse<T>>;
+}
+export interface SubscriptionInterface {
+    eventFilters: string[];
+}

package/src/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/src/types.js.map

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

package/src/types.ts

@@ -1,6 +1,10 @@
-import type RingCentral from '@rc-ex/core';
-import type { RestMethod, RestRequestConfig, RestResponse } from '@rc-ex/core/lib/types';
-import type WS from 'isomorphic-ws';
+import type RingCentral from "@rc-ex/core";
+import type {
+  RestMethod,
+  RestRequestConfig,
+  RestResponse,
+} from "@rc-ex/core/src/types";
+import type WS from "isomorphic-ws";
 
 export interface WsToken {
   uri: string;
@@ -30,7 +34,12 @@ export interface Wsc {
 }
 
 export interface WsgMeta {
-  type: 'ClientRequest' | 'ServerNotification' | 'Error' | 'ConnectionDetails' | 'Heartbeat';
+  type:
+    | "ClientRequest"
+    | "ServerNotification"
+    | "Error"
+    | "ConnectionDetails"
+    | "Heartbeat";
   messageId: string;
   status: number;
   headers: {
@@ -52,7 +61,7 @@ export interface ConnectionDetails {
   idleTimeout: number;
   absoluteTimeout: number;
   maxActiveRequests: number;
-  recoveryState?: 'Successful' | 'Failed';
+  recoveryState?: "Successful" | "Failed";
   recoveryErrorCode?: string;
 }
 

package/src/utils.d.ts

@@ -0,0 +1,8 @@
+import type WS from "isomorphic-ws";
+import type { WsgEvent, WsgMeta } from "./types";
+declare class Utils {
+    static splitWsgData(wsgData: string): [WsgMeta, any];
+    static debugWebSocket(_ws: WS): void;
+    static waitForWebSocketMessage(ws: WS, matchCondition: (meta: WsgMeta) => boolean, timeout?: number): Promise<[WsgMeta, any, WsgEvent]>;
+}
+export default Utils;

package/src/utils.js

@@ -0,0 +1,72 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ClosedException_1 = __importDefault(require("./exceptions/ClosedException"));
+const TimeoutException_1 = __importDefault(require("./exceptions/TimeoutException"));
+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_1.default());
+                }
+            }, 1000);
+            const timeoutHandle = setTimeout(() => {
+                ws.removeEventListener("message", handler);
+                clearInterval(checkHandle);
+                reject(new TimeoutException_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;
+//# sourceMappingURL=utils.js.map

package/src/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["utils.ts"],"names":[],"mappings":";;;;;AAIA,mFAA2D;AAC3D,qFAA6D;AAE7D,MAAM,KAAK;IACF,MAAM,CAAC,YAAY,CAAC,OAAe;QACxC,IAAI,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YACpC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;YAC7C,OAAO;gBACL,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBACvC,OAAO,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;aACjD,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAEM,MAAM,CAAC,cAAc,CAAC,GAAO;QAClC,MAAM,EAAE,GAAG,GAAG,CAAC;QACf,MAAM,IAAI,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC9B,EAAE,CAAC,IAAI,GAAG,KAAK,EAAE,GAAW,EAAE,EAAE;YAC9B,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC;YAChB,OAAO,CAAC,KAAK,CACX;EACN,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;OACnC,CACA,CAAC;QACJ,CAAC,CAAC;QACF,EAAE,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,MAAoB,EAAE,EAAE;YACtD,MAAM,KAAK,GAAG,MAAkB,CAAC;YACjC,OAAO,CAAC,KAAK,CACX;EACN,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;OAC1C,CACA,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;YACpC,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACrC,OAAO,CAAC,KAAK,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACrC,OAAO,CAAC,KAAK,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,uBAAuB,CACnC,EAAM,EACN,cAA0C,EAC1C,OAAO,GAAG,KAAK;QAEf,OAAO,IAAI,OAAO,CAA2B,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC/D,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,EAAE;gBACnC,IAAI,EAAE,CAAC,UAAU,KAAK,EAAE,CAAC,MAAM,EAAE,CAAC;oBAChC,aAAa,CAAC,WAAW,CAAC,CAAC;oBAC3B,MAAM,CAAC,IAAI,yBAAe,EAAE,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC,EAAE,IAAI,CAAC,CAAC;YACT,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,EAAE;gBACpC,EAAE,CAAC,mBAAmB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;gBAC3C,aAAa,CAAC,WAAW,CAAC,CAAC;gBAC3B,MAAM,CAAC,IAAI,0BAAgB,EAAE,CAAC,CAAC;YACjC,CAAC,EAAE,OAAO,CAAC,CAAC;YACZ,MAAM,OAAO,GAAG,CAAC,MAAoB,EAAE,EAAE;gBACvC,MAAM,KAAK,GAAG,MAAkB,CAAC;gBACjC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACpD,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;oBACzB,EAAE,CAAC,mBAAmB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;oBAC3C,aAAa,CAAC,WAAW,CAAC,CAAC;oBAC3B,YAAY,CAAC,aAAa,CAAC,CAAC;oBAC5B,OAAO,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;gBAC/B,CAAC;YACH,CAAC,CAAC;YACF,EAAE,CAAC,gBAAgB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,kBAAe,KAAK,CAAC"}

package/src/utils.ts

@@ -1,17 +1,18 @@
-/* eslint-disable no-console */
-import type { MessageEvent } from 'isomorphic-ws';
-import type WS from 'isomorphic-ws';
+import type { MessageEvent } from "isomorphic-ws";
+import type WS from "isomorphic-ws";
 
-import type { WsgMeta, WsgEvent } from './types';
-import ClosedException from './exceptions/ClosedException';
-import TimeoutException from './exceptions/TimeoutException';
+import type { WsgEvent, WsgMeta } from "./types";
+import ClosedException from "./exceptions/ClosedException";
+import TimeoutException from "./exceptions/TimeoutException";
 
 class Utils {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   public static splitWsgData(wsgData: string): [WsgMeta, any] {
-    if (wsgData.includes(',--Boundary')) {
-      const index = wsgData.indexOf(',--Boundary');
-      return [JSON.parse(wsgData.substring(1, index)), wsgData.substring(index + 1, wsgData.length - 1)];
+    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);
   }
@@ -27,7 +28,7 @@ ${JSON.stringify(JSON.parse(str), null, 2)}
 ******`,
       );
     };
-    ws.addEventListener('message', (mEvent: MessageEvent) => {
+    ws.addEventListener("message", (mEvent: MessageEvent) => {
       const event = mEvent as WsgEvent;
       console.debug(
         `*** WebSocket incoming message: ***
@@ -35,19 +36,22 @@ ${JSON.stringify(JSON.parse(event.data), null, 2)}
 ******`,
       );
     });
-    ws.addEventListener('open', (event) => {
-      console.debug('WebSocket open event:', event);
+    ws.addEventListener("open", (event) => {
+      console.debug("WebSocket open event:", event);
     });
-    ws.addEventListener('error', (event) => {
-      console.debug('WebSocket error event:', event);
+    ws.addEventListener("error", (event) => {
+      console.debug("WebSocket error event:", event);
     });
-    ws.addEventListener('close', (event) => {
-      console.debug('WebSocket close event:', event);
+    ws.addEventListener("close", (event) => {
+      console.debug("WebSocket close event:", event);
     });
   }
 
-  public static waitForWebSocketMessage(ws: WS, matchCondition: (meta: WsgMeta) => boolean, timeout = 60000) {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  public static waitForWebSocketMessage(
+    ws: WS,
+    matchCondition: (meta: WsgMeta) => boolean,
+    timeout = 60000,
+  ) {
     return new Promise<[WsgMeta, any, WsgEvent]>((resolve, reject) => {
       const checkHandle = setInterval(() => {
         if (ws.readyState === ws.CLOSED) {
@@ -56,8 +60,7 @@ ${JSON.stringify(JSON.parse(event.data), null, 2)}
         }
       }, 1000);
       const timeoutHandle = setTimeout(() => {
-        // eslint-disable-next-line @typescript-eslint/no-use-before-define
-        ws.removeEventListener('message', handler);
+        ws.removeEventListener("message", handler);
         clearInterval(checkHandle);
         reject(new TimeoutException());
       }, timeout);
@@ -65,13 +68,13 @@ ${JSON.stringify(JSON.parse(event.data), null, 2)}
         const event = mEvent as WsgEvent;
         const [meta, body] = Utils.splitWsgData(event.data);
         if (matchCondition(meta)) {
-          ws.removeEventListener('message', handler);
+          ws.removeEventListener("message", handler);
           clearInterval(checkHandle);
           clearTimeout(timeoutHandle);
           resolve([meta, body, event]);
         }
       };
-      ws.addEventListener('message', handler);
+      ws.addEventListener("message", handler);
     });
   }
 }

package/tsconfig.json

@@ -1,7 +1,4 @@
 {
   "extends": "../../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "lib"
-  },
   "include": ["src"]
 }