@ipcom/asterisk-ari 0.0.24 → 0.0.26

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

@@ -1,17 +1,68 @@
-import type { WebSocketEvent } from "./interfaces/events.types";
-export declare class WebSocketClient {
+import { EventEmitter } from "events";
+import type { WebSocketEvent } from "./interfaces";
+/**
+ * WebSocketClient class for managing WebSocket connections.
+ * Extends EventEmitter to provide event-based communication.
+ */
+export declare class WebSocketClient extends EventEmitter {
     private url;
     private ws;
     private isClosedManually;
     private isReconnecting;
+    /**
+     * Creates a new WebSocketClient instance.
+     * @param url - The WebSocket server URL to connect to.
+     */
     constructor(url: string);
+    /**
+     * Establishes a connection to the WebSocket server.
+     * @returns A Promise that resolves when the connection is established, or rejects if an error occurs.
+     * @throws Will throw an error if the connection fails.
+     */
     connect(): Promise<void>;
-    reconnect(): Promise<void>;
+    /**
+     * Checks if the WebSocket connection is currently open.
+     * @returns True if the connection is open, false otherwise.
+     */
     isConnected(): boolean;
-    on<T extends WebSocketEvent["type"]>(event: "message" | "open" | "error" | "close", callback: (data: Extract<WebSocketEvent, {
+    /**
+     * Adds a listener for WebSocket events.
+     * @param event - The event type to listen for.
+     * @param callback - The function to call when the event occurs.
+     * @returns The WebSocketClient instance for chaining.
+     */
+    on<T extends WebSocketEvent["type"]>(event: T, callback: (data: Extract<WebSocketEvent, {
         type: T;
-    }>) => void): void;
+    }>) => void): this;
+    /**
+     * Removes a specific listener from a WebSocket event.
+     * @param event - The event type to remove the listener from.
+     * @param callback - The function to remove from the event listeners.
+     * @returns The WebSocketClient instance for chaining.
+     */
+    off<T extends WebSocketEvent["type"]>(event: T, callback: (data: Extract<WebSocketEvent, {
+        type: T;
+    }>) => void): this;
+    /**
+     * Removes all listeners for a specific event, or all events if no event is specified.
+     * @param event - Optional. The event to remove all listeners from.
+     * @returns The WebSocketClient instance for chaining.
+     */
+    removeAllListeners(event?: string | symbol): this;
+    /**
+     * Handles incoming WebSocket messages.
+     * @param rawData - The raw data received from the WebSocket.
+     */
+    private handleMessage;
+    /**
+     * Sends data through the WebSocket connection.
+     * @param data - The data to send.
+     * @throws Will throw an error if the WebSocket is not connected.
+     */
     send(data: any): void;
+    /**
+     * Closes the WebSocket connection manually.
+     */
     close(): void;
 }
 //# sourceMappingURL=websocketClient.d.ts.map

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":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAEhE,qBAAa,eAAe;IAKd,OAAO,CAAC,GAAG;IAJvB,OAAO,CAAC,EAAE,CAA0B;IACpC,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,cAAc,CAAS;gBAEX,GAAG,EAAE,MAAM;IAEzB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAyBxB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAehC,WAAW,IAAI,OAAO;IAItB,EAAE,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,EACjC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,EAC7C,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,IAAI,GAC7D,IAAI;IAwBP,IAAI,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAYrB,KAAK,IAAI,IAAI;CAOd"}
+{"version":3,"file":"websocketClient.d.ts","sourceRoot":"","sources":["../../../src/ari-client/websocketClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAEnD;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,YAAY;IASnC,OAAO,CAAC,GAAG;IARvB,OAAO,CAAC,EAAE,CAA0B;IACpC,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,cAAc,CAAS;IAE/B;;;OAGG;gBACiB,GAAG,EAAE,MAAM;IAI/B;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA8B9B;;;OAGG;IACH,WAAW,IAAI,OAAO;IAItB;;;;;OAKG;IACH,EAAE,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,EACjC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,IAAI,GAC7D,IAAI;IAKP;;;;;OAKG;IACH,GAAG,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,EAClC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,IAAI,GAC7D,IAAI;IAKP;;;;OAIG;IACH,kBAAkB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAKjD;;;OAGG;IACH,OAAO,CAAC,aAAa;IAarB;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAYrB;;OAEG;IACH,KAAK,IAAI,IAAI;CAOd"}

package/dist/types/index.d.ts

@@ -5,5 +5,6 @@ export { Applications } from "./ari-client/resources/applications.js";
 export { Sounds } from "./ari-client/resources/sounds.js";
 export { Playbacks } from "./ari-client/resources/playbacks.js";
 export { Asterisk } from "./ari-client/resources/asterisk.js";
-export type { AriClientConfig, Channel, Endpoint, Playback, Application, Sound, AsteriskInfo, Module, Logging, Variable, WebSocketEvent, WebSocketEventType, OriginateRequest, PlaybackOptions, RTPStats, RecordingOptions, SnoopOptions, ExternalMediaOptions, ChannelPlayback, ChannelVar, ChannelDialplan, AriApplication, EndpointDetails, PlaybackControlRequest, ApplicationDetails, SoundListRequest, } from "./ari-client/interfaces/index.js";
+export { Bridges } from "./ari-client/resources/bridges.js";
+export type { AriClientConfig, Channel, Endpoint, Playback, Application, Sound, AsteriskInfo, Module, Logging, Variable, WebSocketEvent, WebSocketEventType, OriginateRequest, PlaybackOptions, RTPStats, RecordingOptions, SnoopOptions, ExternalMediaOptions, ChannelPlayback, ChannelVar, ChannelDialplan, AriApplication, EndpointDetails, PlaybackControlRequest, ApplicationDetails, SoundListRequest, PlayMediaRequest, Bridge, BridgePlayback, CreateBridgeRequest, RemoveChannelRequest, AddChannelRequest, } from "./ari-client/interfaces/index.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAGtD,OAAO,EAAE,QAAQ,EAAE,MAAM,oCAAoC,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,oCAAoC,CAAC;AAG9D,YAAY,EACV,eAAe,EACf,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,KAAK,EACL,YAAY,EACZ,MAAM,EACN,OAAO,EACP,QAAQ,EACR,cAAc,EACd,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EACf,QAAQ,EACR,gBAAgB,EAChB,YAAY,EACZ,oBAAoB,EACpB,eAAe,EACf,UAAU,EACV,eAAe,EACf,cAAc,EACd,eAAe,EACf,sBAAsB,EACtB,kBAAkB,EAClB,gBAAgB,GACjB,MAAM,kCAAkC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAGtD,OAAO,EAAE,QAAQ,EAAE,MAAM,oCAAoC,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,oCAAoC,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC;AAG5D,YAAY,EACV,eAAe,EACf,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,KAAK,EACL,YAAY,EACZ,MAAM,EACN,OAAO,EACP,QAAQ,EACR,cAAc,EACd,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EACf,QAAQ,EACR,gBAAgB,EAChB,YAAY,EACZ,oBAAoB,EACpB,eAAe,EACf,UAAU,EACV,eAAe,EACf,cAAc,EACd,eAAe,EACf,sBAAsB,EACtB,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EAChB,MAAM,EACN,cAAc,EACd,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,GAClB,MAAM,kCAAkC,CAAC"}

package/package.json

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