@rc-ex/ws 1.2.0 → 1.2.2

package/lib/subscription.ts

@@ -0,0 +1,131 @@
+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 { WebSocketExtensionInterface, WsgEvent, WsgMeta } from "./types";
+import Utils from "./utils";
+
+class Subscription {
+  public subscriptionInfo?: SubscriptionInfo;
+
+  public wse: WebSocketExtensionInterface;
+
+  public eventFilters: string[];
+
+  public eventListener: (event: MessageEvent) => void;
+
+  public timeout?: NodeJS.Timeout;
+
+  public enabled = true;
+
+  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
+      ) {
+        callback(body);
+      }
+    };
+    this.setupWsEventListener();
+  }
+
+  public setupWsEventListener() {
+    this.wse.ws.addEventListener("message", this.eventListener);
+  }
+
+  public get requestBody(): CreateSubscriptionRequest {
+    return {
+      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,
+      )
+    ).data;
+  }
+
+  public async refresh() {
+    if (!this.subscriptionInfo) {
+      return;
+    }
+    try {
+      this.subscriptionInfo = (
+        await this.wse.request<SubscriptionInfo>(
+          "PUT",
+          `/restapi/v1.0/subscription/${this.subscriptionInfo!.id}`,
+          this.requestBody,
+        )
+      ).data;
+    } catch (e) {
+      const re = e as { response: RestResponse };
+      if (re.response && re.response.status === 404) {
+        // subscription expired
+        await this.subscribe();
+      }
+    }
+  }
+
+  public async revoke() {
+    if (!this.subscriptionInfo) {
+      return;
+    }
+    try {
+      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`,
+          );
+        }
+      } 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();
+  }
+
+  public 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;
+  }
+}
+
+export default Subscription;

package/lib/types.d.ts

@@ -1,6 +1,6 @@
-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;
     ws_access_token: string;
@@ -25,7 +25,7 @@ export interface Wsc {
     sequence: number;
 }
 export interface WsgMeta {
-    type: 'ClientRequest' | 'ServerNotification' | 'Error' | 'ConnectionDetails' | 'Heartbeat';
+    type: "ClientRequest" | "ServerNotification" | "Error" | "ConnectionDetails" | "Heartbeat";
     messageId: string;
     status: number;
     headers: {
@@ -45,7 +45,7 @@ export interface ConnectionDetails {
     idleTimeout: number;
     absoluteTimeout: number;
     maxActiveRequests: number;
-    recoveryState?: 'Successful' | 'Failed';
+    recoveryState?: "Successful" | "Failed";
     recoveryErrorCode?: string;
 }
 export interface WebSocketExtensionInterface {

package/lib/types.js.map

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

package/lib/types.ts

@@ -0,0 +1,85 @@
+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/lib/utils.d.ts

@@ -1,5 +1,5 @@
-import type WS from 'isomorphic-ws';
-import type { WsgMeta, WsgEvent } from './types';
+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;

package/lib/utils.js

@@ -6,11 +6,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ClosedException_1 = __importDefault(require("./exceptions/ClosedException"));
 const TimeoutException_1 = __importDefault(require("./exceptions/TimeoutException"));
 class Utils {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     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)];
+        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);
     }
@@ -23,24 +25,23 @@ class Utils {
 ${JSON.stringify(JSON.parse(str), null, 2)}
 ******`);
         };
-        ws.addEventListener('message', (mEvent) => {
+        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("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);
         });
     }
     static waitForWebSocketMessage(ws, matchCondition, timeout = 60000) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         return new Promise((resolve, reject) => {
             const checkHandle = setInterval(() => {
                 if (ws.readyState === ws.CLOSED) {
@@ -49,8 +50,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_1.default());
             }, timeout);
@@ -58,13 +58,13 @@ ${JSON.stringify(JSON.parse(event.data), null, 2)}
                 const event = mEvent;
                 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/lib/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;AAKA,mFAA2D;AAC3D,qFAA6D;AAE7D,MAAM,KAAK;IACT,8DAA8D;IACvD,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,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QACrG,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,CAAC,EAAM,EAAE,cAA0C,EAAE,OAAO,GAAG,KAAK;QACvG,8DAA8D;QAC9D,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,mEAAmE;gBACnE,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"}
+{"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/lib/utils.ts

@@ -0,0 +1,82 @@
+import type { MessageEvent } from "isomorphic-ws";
+import type WS from "isomorphic-ws";
+
+import type { WsgEvent, WsgMeta } from "./types";
+import ClosedException from "./exceptions/ClosedException";
+import TimeoutException from "./exceptions/TimeoutException";
+
+class Utils {
+  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),
+      ];
+    }
+    return JSON.parse(wsgData);
+  }
+
+  public static debugWebSocket(_ws: WS) {
+    const ws = _ws;
+    const send = ws.send.bind(ws);
+    ws.send = async (str: string) => {
+      await send(str);
+      console.debug(
+        `*** WebSocket outgoing message: ***
+${JSON.stringify(JSON.parse(str), null, 2)}
+******`,
+      );
+    };
+    ws.addEventListener("message", (mEvent: MessageEvent) => {
+      const event = mEvent as WsgEvent;
+      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);
+    });
+  }
+
+  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) {
+          clearInterval(checkHandle);
+          reject(new ClosedException());
+        }
+      }, 1000);
+      const timeoutHandle = setTimeout(() => {
+        ws.removeEventListener("message", handler);
+        clearInterval(checkHandle);
+        reject(new TimeoutException());
+      }, timeout);
+      const handler = (mEvent: MessageEvent) => {
+        const event = mEvent as WsgEvent;
+        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);
+    });
+  }
+}
+
+export default Utils;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@rc-ex/ws",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "WebSocket extension for ringcentral-extensible project",
   "author": "Tyler Liu <tyler.liu@ringcentral.com>",
   "homepage": "https://github.com/ringcentral/ringcentral-extensible/tree/master/packages/extensions/ws",
   "license": "MIT",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ringcentral/ringcentral-extensible.git"
@@ -18,7 +18,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@types/ws": "^8.5.13",
+    "@types/ws": "^8.5.14",
     "http-status-codes": "^2.3.0",
     "hyperid": "^3.3.0",
     "isomorphic-ws": "^5.0.0",
@@ -26,7 +26,7 @@
     "ws": "^8.18.0"
   },
   "devDependencies": {
-    "@rc-ex/core": "^1.5.0"
+    "@rc-ex/core": "^1.5.2"
   },
-  "gitHead": "03fab0f9fc3d924054df16abd6854a5063e19829"
+  "gitHead": "a0e465fd1f5d4b0758e6c3641635d5d2ee6c9a3a"
 }

package/src/exceptions/ClosedException.d.ts

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

package/src/exceptions/ClosedException.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ClosedException extends Error {
+    constructor(message) {
+        super(message !== null && message !== void 0 ? message : "WebSocket has been closed");
+    }
+}
+exports.default = ClosedException;
+//# sourceMappingURL=ClosedException.js.map

package/src/exceptions/ClosedException.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClosedException.js","sourceRoot":"","sources":["ClosedException.ts"],"names":[],"mappings":";;AAAA,MAAM,eAAgB,SAAQ,KAAK;IACjC,YAAmB,OAAgB;QACjC,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,2BAA2B,CAAC,CAAC;IAChD,CAAC;CACF;AAED,kBAAe,eAAe,CAAC"}

package/src/exceptions/ClosedException.ts

@@ -1,6 +1,6 @@
 class ClosedException extends Error {
   public constructor(message?: string) {
-    super(message ?? 'WebSocket has been closed');
+    super(message ?? "WebSocket has been closed");
   }
 }
 

package/src/exceptions/ConnectionException.d.ts

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

package/src/exceptions/ConnectionException.js

@@ -0,0 +1,16 @@
+"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 ConnectionException extends Error {
+    constructor(wsgEvent) {
+        const [, wsgError] = utils_1.default.splitWsgData(wsgEvent.data);
+        super(JSON.stringify(wsgError, null, 2));
+        this.wsgEvent = wsgEvent;
+        this.wsgError = wsgError;
+    }
+}
+exports.default = ConnectionException;
+//# sourceMappingURL=ConnectionException.js.map

package/src/exceptions/ConnectionException.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectionException.js","sourceRoot":"","sources":["ConnectionException.ts"],"names":[],"mappings":";;;;;AACA,qDAA6B;AAE7B,MAAM,mBAAoB,SAAQ,KAAK;IAKrC,YAAmB,QAAkB;QACnC,MAAM,CAAC,EAAE,QAAQ,CAAC,GAAwB,eAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC5E,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAED,kBAAe,mBAAmB,CAAC"}

package/src/exceptions/ConnectionException.ts

@@ -1,5 +1,5 @@
-import type { WsgError, WsgEvent, WsgMeta } from '../types';
-import Utils from '../utils';
+import type { WsgError, WsgEvent, WsgMeta } from "../types";
+import Utils from "../utils";
 
 class ConnectionException extends Error {
   public wsgEvent: WsgEvent;

package/src/exceptions/TimeoutException.d.ts

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

package/src/exceptions/TimeoutException.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class TimeoutException extends Error {
+    constructor(message) {
+        super(message !== null && message !== void 0 ? message : "Failed to receive expected WebSocket message in time.");
+    }
+}
+exports.default = TimeoutException;
+//# sourceMappingURL=TimeoutException.js.map

package/src/exceptions/TimeoutException.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimeoutException.js","sourceRoot":"","sources":["TimeoutException.ts"],"names":[],"mappings":";;AAAA,MAAM,gBAAiB,SAAQ,KAAK;IAClC,YAAmB,OAAgB;QACjC,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,uDAAuD,CAAC,CAAC;IAC5E,CAAC;CACF;AAED,kBAAe,gBAAgB,CAAC"}

package/src/exceptions/TimeoutException.ts

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

package/src/index.d.ts

@@ -0,0 +1,44 @@
+import type RingCentral from "@rc-ex/core";
+import SdkExtension from "@rc-ex/core/src/SdkExtension";
+import WS from "isomorphic-ws";
+import { EventEmitter } from "events";
+import type SubscriptionInfo from "@rc-ex/core/src/definitions/SubscriptionInfo";
+import { request } from "./rest";
+import type { ConnectionDetails, WebSocketOptions, Wsc, WsToken } from "./types";
+import Subscription from "./subscription";
+export declare enum Events {
+    autoRecoverSuccess = "autoRecoverSuccess",
+    autoRecoverFailed = "autoRecoverFailed",
+    autoRecoverError = "autoRecoverError",
+    newWebSocketObject = "newWebSocketObject",
+    newWsc = "newWsc",
+    connectionReady = "connectionReady"
+}
+declare class WebSocketExtension extends SdkExtension {
+    eventEmitter: EventEmitter<[never]>;
+    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;