@ipcom/asterisk-ari 0.0.153 → 0.0.154

package/dist/types/ari-client/websocketClient.d.ts

@@ -14,56 +14,109 @@ export declare class WebSocketClient extends EventEmitter {
     private ws?;
     private isReconnecting;
     private readonly maxReconnectAttempts;
+    private reconnectionAttempts;
+    private lastWsUrl;
     private readonly backOffOptions;
     /**
-     * Creates a new WebSocket client instance.
+     * Creates a new WebSocketClient instance.
      *
-     * @param {BaseClient} baseClient - The base client containing connection details
-     * @param {string[]} apps - List of applications to connect to
-     * @param {WebSocketEventType[]} [subscribedEvents] - Optional list of events to subscribe to
-     * @param {AriClient} [ariClient] - Optional ARI client for handling channel and playback events
+     * This constructor initializes a WebSocketClient with the necessary dependencies and configuration.
+     * It ensures that at least one application name is provided.
+     *
+     * @param baseClient - The BaseClient instance used for basic ARI operations and authentication.
+     * @param apps - An array of application names to connect to via the WebSocket.
+     * @param subscribedEvents - Optional. An array of WebSocketEventTypes to subscribe to. If not provided, all events will be subscribed.
+     * @param ariClient - Optional. The AriClient instance, used for creating Channel and Playback instances when processing events.
+     *
+     * @throws {Error} Throws an error if the apps array is empty.
      */
     constructor(baseClient: BaseClient, apps: string[], subscribedEvents?: WebSocketEventType[] | undefined, ariClient?: AriClient | undefined);
     /**
-     * Establishes a WebSocket connection.
+     * Establishes a WebSocket connection to the Asterisk server.
      *
-     * @returns {Promise<void>} Resolves when connection is established
-     * @throws {Error} If connection fails
+     * This method constructs the WebSocket URL using the base URL, credentials,
+     * application names, and subscribed events. It then initiates the connection
+     * using the constructed URL.
+     *
+     * @returns A Promise that resolves when the WebSocket connection is successfully established.
+     * @throws Will throw an error if the connection cannot be established.
      */
     connect(): Promise<void>;
     /**
-     * Initializes WebSocket connection with reconnection logic.
+     * Initializes a WebSocket connection with exponential backoff retry mechanism.
+     *
+     * This method attempts to establish a WebSocket connection to the specified URL.
+     * It sets up event listeners for the WebSocket's 'open', 'message', 'close', and 'error' events.
+     * If the connection is successful, it emits a 'connected' event. If it's a reconnection,
+     * it also emits a 'reconnected' event with the current apps and subscribed events.
+     * In case of connection failure, it uses an exponential backoff strategy to retry.
      *
-     * @param {string} wsUrl - The WebSocket URL to connect to
-     * @returns {Promise<void>} Resolves when connection is established
+     * @param wsUrl - The WebSocket URL to connect to.
+     * @returns A Promise that resolves when the connection is successfully established,
+     *          or rejects if an error occurs during the connection process.
+     * @throws Will throw an error if the WebSocket connection cannot be established
+     *         after the maximum number of retry attempts.
      */
     private initializeWebSocket;
     /**
-     * Processes incoming WebSocket messages.
+     * Handles incoming WebSocket messages by parsing and processing events.
      *
-     * @param {string} rawMessage - The raw message received from WebSocket
+     * This method parses the raw message into a WebSocketEvent, filters it based on
+     * subscribed events (if any), processes channel and playback events, and emits
+     * the event to listeners. It also handles any errors that occur during processing.
+     *
+     * @param rawMessage - The raw message string received from the WebSocket connection.
+     * @returns void This method doesn't return a value but emits events.
+     *
+     * @throws Will emit an 'error' event if the message cannot be parsed or processed.
      */
     private handleMessage;
     /**
-     * Attempts to reconnect to the WebSocket.
+     * Attempts to reconnect to the WebSocket server using an exponential backoff strategy.
+     *
+     * This method is called when the WebSocket connection is closed unexpectedly.
+     * It increments the reconnection attempt counter, logs the attempt, and uses
+     * the backOff utility to retry the connection with exponential delays between attempts.
      *
-     * @param {string} wsUrl - The WebSocket URL to reconnect to
+     * @param wsUrl - The WebSocket URL to reconnect to.
+     * @returns void - This method doesn't return a value.
+     *
+     * @emits reconnectFailed - Emitted if all reconnection attempts fail.
      */
     private reconnect;
     /**
-     * Manually closes the WebSocket connection.
+     * Closes the WebSocket connection if it exists.
+     *
+     * This method attempts to gracefully close the WebSocket connection
+     * and sets the WebSocket instance to undefined. If an error occurs
+     * during the closing process, it will be caught and logged.
+     *
+     * @throws {Error} Logs an error message if closing the WebSocket fails.
      */
     close(): void;
     /**
-     * Checks if the WebSocket is currently connected.
+     * Checks if the WebSocket connection is currently open and active.
      *
-     * @returns {boolean} True if connected, false otherwise
+     * This method provides a way to determine the current state of the WebSocket connection.
+     * It checks if the WebSocket's readyState property is equal to WebSocket.OPEN,
+     * which indicates an active connection.
+     *
+     * @returns {boolean} True if the WebSocket connection is open and active, false otherwise.
      */
     isConnected(): boolean;
     /**
-     * Gets the current connection state.
+     * Retrieves the current state of the WebSocket connection.
+     *
+     * This method provides a way to check the current state of the WebSocket connection.
+     * It returns a number corresponding to one of the WebSocket readyState values:
+     * - 0 (CONNECTING): The connection is not yet open.
+     * - 1 (OPEN): The connection is open and ready to communicate.
+     * - 2 (CLOSING): The connection is in the process of closing.
+     * - 3 (CLOSED): The connection is closed or couldn't be opened.
+     *
+     * If the WebSocket instance doesn't exist, it returns WebSocket.CLOSED (3).
      *
-     * @returns {number} The WebSocket ready state
+     * @returns {number} A number representing the current state of the WebSocket connection.
      */
     getState(): number;
 }

package/dist/types/ari-client/websocketClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"websocketClient.d.ts","sourceRoot":"","sources":["../../../src/ari-client/websocketClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAkB,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAMvE;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,YAAY;IA8B7C,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAClC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC;IAhC7B,OAAO,CAAC,EAAE,CAAC,CAAY;IACvB,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAkC;IAEvE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAc7B;IAEF;;;;;;;OAOG;gBAEgB,UAAU,EAAE,UAAU,EACtB,IAAI,EAAE,MAAM,EAAE,EACd,gBAAgB,CAAC,EAAE,kBAAkB,EAAE,YAAA,EACvC,SAAS,CAAC,EAAE,SAAS,YAAA;IASxC;;;;;OAKG;IACU,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA8BrC;;;;;OAKG;YACW,mBAAmB;IAsCjC;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAoCrB;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAgBjB;;OAEG;IACI,KAAK,IAAI,IAAI;IAepB;;;;OAIG;IACI,WAAW,IAAI,OAAO;IAI7B;;;;OAIG;IACI,QAAQ,IAAI,MAAM;CAG1B"}
+{"version":3,"file":"websocketClient.d.ts","sourceRoot":"","sources":["../../../src/ari-client/websocketClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAkB,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAMvE;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,YAAY;IAqC7C,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAClC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC;IAvC7B,OAAO,CAAC,EAAE,CAAC,CAAY;IACvB,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAkC;IACvE,OAAO,CAAC,oBAAoB,CAAK;IACjC,OAAO,CAAC,SAAS,CAAc;IAE/B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAc7B;IAEF;;;;;;;;;;;;OAYG;gBAEgB,UAAU,EAAE,UAAU,EACtB,IAAI,EAAE,MAAM,EAAE,EACd,gBAAgB,CAAC,EAAE,kBAAkB,EAAE,YAAA,EACvC,SAAS,CAAC,EAAE,SAAS,YAAA;IASxC;;;;;;;;;OASG;IACU,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAyBrC;;;;;;;;;;;;;;OAcG;YACW,mBAAmB;IA6CjC;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,aAAa;IAiCrB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,SAAS;IAkBjB;;;;;;;;OAQG;IACI,KAAK,IAAI,IAAI;IAepB;;;;;;;;OAQG;IACI,WAAW,IAAI,OAAO;IAI7B;;;;;;;;;;;;;OAaG;IACI,QAAQ,IAAI,MAAM;CAG1B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ipcom/asterisk-ari",
-  "version": "0.0.153",
+  "version": "0.0.154",
   "type": "module",
   "description": "JavaScript client for Asterisk REST Interface.",
   "homepage": "https://github.com/fabiotheo/ipcom-asterisk-ari",