@ipcom/asterisk-ari 0.0.139 → 0.0.140

package/dist/types/ari-client/resources/playbacks.d.ts

@@ -1,83 +1,156 @@
 import type { AriClient } from "../ariClient";
 import type { BaseClient } from "../baseClient.js";
 import type { Playback, WebSocketEvent } from "../interfaces";
+/**
+ * Represents a playback instance that provides methods for controlling media playback,
+ * managing event listeners, and handling playback state.
+ */
 export declare class PlaybackInstance {
-    private client;
-    private baseClient;
-    private playbackId;
-    private eventEmitter;
+    private readonly client;
+    private readonly baseClient;
+    private readonly playbackId;
+    private readonly eventEmitter;
     private playbackData;
-    id: string;
+    readonly id: string;
+    /**
+     * Creates a new PlaybackInstance.
+     *
+     * @param {AriClient} client - ARI client for communication
+     * @param {BaseClient} baseClient - Base client for HTTP requests
+     * @param {string} [playbackId] - Optional playback ID, generates timestamp-based ID if not provided
+     */
     constructor(client: AriClient, baseClient: BaseClient, playbackId?: string);
     /**
-     * Registra um listener para eventos específicos deste playback.
+     * Registers an event listener for a specific WebSocket event type.
+     *
+     * @param {T} event - Event type to listen for
+     * @param {Function} listener - Callback function for the event
      */
     on<T extends WebSocketEvent["type"]>(event: T, listener: (data: Extract<WebSocketEvent, {
         type: T;
     }>) => void): void;
     /**
-     * Registra um listener único para eventos específicos deste playback.
+     * Registers a one-time event listener for a specific WebSocket event type.
+     *
+     * @param {T} event - Event type to listen for
+     * @param {Function} listener - Callback function for the event
      */
     once<T extends WebSocketEvent["type"]>(event: T, listener: (data: Extract<WebSocketEvent, {
         type: T;
     }>) => void): void;
     /**
-     * Remove um listener para eventos específicos deste playback.
+     * Removes event listener(s) for a specific WebSocket event type.
+     *
+     * @param {T} event - Event type to remove listener(s) for
+     * @param {Function} [listener] - Optional specific listener to remove
      */
     off<T extends WebSocketEvent["type"]>(event: T, listener?: (data: Extract<WebSocketEvent, {
         type: T;
     }>) => void): void;
     /**
-     * Emite eventos internamente para o playback.
+     * Emits a WebSocket event if it matches the current playback instance.
+     *
+     * @param {WebSocketEvent} event - Event to emit
      */
     emitEvent(event: WebSocketEvent): void;
     /**
-     * Obtém os detalhes do playback.
+     * Retrieves current playback data.
+     *
+     * @returns {Promise<Playback>} Current playback data
+     * @throws {Error} If playback is not properly initialized
      */
     get(): Promise<Playback>;
     /**
-     * Controla o playback.
+     * Controls playback with specified operation.
+     *
+     * @param {"pause" | "unpause" | "reverse" | "forward"} operation - Control operation to perform
+     * @throws {Error} If playback is not properly initialized or operation fails
      */
     control(operation: "pause" | "unpause" | "reverse" | "forward"): Promise<void>;
     /**
-     * Encerra o playback.
+     * Stops the current playback.
+     *
+     * @throws {Error} If playback is not properly initialized or stop operation fails
      */
     stop(): Promise<void>;
     /**
-     * Remove todos os listeners para este playback.
+     * Removes all event listeners from this playback instance.
      */
     removeAllListeners(): void;
+    /**
+     * Checks if the playback instance has any listeners for a specific event.
+     *
+     * @param {string} event - Event type to check
+     * @returns {boolean} True if there are listeners for the event
+     */
+    hasListeners(event: string): boolean;
+    /**
+     * Gets the current playback data without making an API call.
+     *
+     * @returns {Playback | null} Current playback data or null if not available
+     */
+    getCurrentData(): Playback | null;
 }
+/**
+ * Manages playback instances and their related operations in the Asterisk REST Interface.
+ * This class provides functionality to create, control, and manage playback instances,
+ * as well as handle WebSocket events related to playbacks.
+ */
 export declare class Playbacks {
     private baseClient;
     private client;
     private playbackInstances;
     constructor(baseClient: BaseClient, client: AriClient);
     /**
-     * Gerencia instâncias de playback.
+     * Gets or creates a playback instance
+     * @param {Object} params - Parameters for getting/creating a playback instance
+     * @param {string} [params.id] - Optional ID of an existing playback
+     * @returns {PlaybackInstance} The requested or new playback instance
      */
     Playback({ id }: {
         id?: string;
     }): PlaybackInstance;
     /**
-     * Remove uma instância de playback.
+     * Removes a playback instance and cleans up its resources
+     * @param {string} playbackId - ID of the playback instance to remove
+     * @throws {Error} If the playback instance doesn't exist
      */
     removePlaybackInstance(playbackId: string): void;
     /**
-     * Propaga eventos do WebSocket para o playback correspondente.
+     * Propagates WebSocket events to the corresponding playback instance
+     * @param {WebSocketEvent} event - The WebSocket event to propagate
      */
     propagateEventToPlayback(event: WebSocketEvent): void;
     /**
-     * Obtém detalhes de um playback específico.
+     * Retrieves details of a specific playback
+     * @param {string} playbackId - ID of the playback to get details for
+     * @returns {Promise<Playback>} Promise resolving to playback details
+     * @throws {Error} If the playback ID is invalid or the request fails
      */
     getDetails(playbackId: string): Promise<Playback>;
     /**
-     * Controla um playback específico.
+     * Controls a specific playback instance
+     * @param {string} playbackId - ID of the playback to control
+     * @param {"pause" | "unpause" | "reverse" | "forward"} operation - Operation to perform
+     * @throws {Error} If the playback ID is invalid or the operation fails
      */
     control(playbackId: string, operation: "pause" | "unpause" | "reverse" | "forward"): Promise<void>;
     /**
-     * Encerra um playback específico.
+     * Stops a specific playback instance
+     * @param {string} playbackId - ID of the playback to stop
+     * @throws {Error} If the playback ID is invalid or the stop operation fails
      */
     stop(playbackId: string): Promise<void>;
+    /**
+     * Gets the count of active playback instances
+     * @returns {number} Number of active playback instances
+     */
+    getInstanceCount(): number;
+    /**
+     * Checks if a playback instance exists
+     * @param {string} playbackId - ID of the playback to check
+     * @returns {boolean} True if the playback instance exists
+     */
+    hasInstance(playbackId: string): boolean;
 }
 //# sourceMappingURL=playbacks.d.ts.map

package/dist/types/ari-client/resources/playbacks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"playbacks.d.ts","sourceRoot":"","sources":["../../../../src/ari-client/resources/playbacks.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE9D,qBAAa,gBAAgB;IAMzB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,UAAU;IAClB,OAAO,CAAC,UAAU;IAPpB,OAAO,CAAC,YAAY,CAAsB;IAC1C,OAAO,CAAC,YAAY,CAAyB;IACtC,EAAE,EAAE,MAAM,CAAC;gBAGR,MAAM,EAAE,SAAS,EACjB,UAAU,EAAE,UAAU,EACtB,UAAU,GAAE,MAAiC;IAKvD;;OAEG;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;IASP;;OAEG;IACH,IAAI,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,EACnC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,IAAI,GAC7D,IAAI;IASP;;OAEG;IACH,GAAG,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,EAClC,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,IAAI,GAC9D,IAAI;IAQP;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAMtC;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC;IAW9B;;OAEG;IACG,OAAO,CACX,SAAS,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GACrD,OAAO,CAAC,IAAI,CAAC;IAUhB;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ3B;;OAEG;IACH,kBAAkB,IAAI,IAAI;CAG3B;AAED,qBAAa,SAAS;IAIlB,OAAO,CAAC,UAAU;IAClB,OAAO,CAAC,MAAM;IAJhB,OAAO,CAAC,iBAAiB,CAAuC;gBAGtD,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,SAAS;IAG3B;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,EAAE,EAAE;QAAE,EAAE,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,gBAAgB;IAgBnD;;OAEG;IACH,sBAAsB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAQhD;;OAEG;IACH,wBAAwB,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IASrD;;OAEG;IACG,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIvD;;OAEG;IACG,OAAO,CACX,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GACrD,OAAO,CAAC,IAAI,CAAC;IAKhB;;OAEG;IACG,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAI9C"}
+{"version":3,"file":"playbacks.d.ts","sourceRoot":"","sources":["../../../../src/ari-client/resources/playbacks.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAkB9D;;;GAGG;AACH,qBAAa,gBAAgB;IAavB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAd/B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsB;IACnD,OAAO,CAAC,YAAY,CAAyB;IAC7C,SAAgB,EAAE,EAAE,MAAM,CAAC;IAE3B;;;;;;OAMG;gBAEkB,MAAM,EAAE,SAAS,EACjB,UAAU,EAAE,UAAU,EACtB,UAAU,GAAE,MAAiC;IAMlE;;;;;OAKG;IACH,EAAE,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,EAC/B,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,IAAI,GAC/D,IAAI;IAcP;;;;;OAKG;IACH,IAAI,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,GAC/D,IAAI;IAcP;;;;;OAKG;IACH,GAAG,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,EAChC,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,IAAI,GAChE,IAAI;IAcP;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAYtC;;;;;OAKG;IACG,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC;IAkB9B;;;;;OAKG;IACG,OAAO,CACT,SAAS,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GACvD,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAe3B;;OAEG;IACH,kBAAkB,IAAI,IAAI;IAK1B;;;;;OAKG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAIpC;;;;OAIG;IACH,cAAc,IAAI,QAAQ,GAAG,IAAI;CAGlC;AAED;;;;GAIG;AACH,qBAAa,SAAS;IAIhB,OAAO,CAAC,UAAU;IAClB,OAAO,CAAC,MAAM;IAJlB,OAAO,CAAC,iBAAiB,CAAuC;gBAGpD,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,SAAS;IAG7B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,EAAE,EAAE,EAAE;QAAE,EAAE,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,gBAAgB;IAyBnD;;;;OAIG;IACH,sBAAsB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAehD;;;OAGG;IACH,wBAAwB,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAiBrD;;;;;OAKG;IACG,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAcvD;;;;;OAKG;IACG,OAAO,CACT,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GACvD,OAAO,CAAC,IAAI,CAAC;IAgBhB;;;;OAIG;IACG,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB7C;;;OAGG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;;;OAIG;IACH,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;CAGzC"}

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

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/ari-client/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAY,cAAc,EAAE,MAAM,cAAc,CAAC;AAEtE,wBAAgB,aAAa,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,MAAM,CAMnD;AAED,wBAAgB,eAAe,CAC7B,KAAK,EAAE,cAAc,EACrB,UAAU,CAAC,EAAE,MAAM,GAClB,KAAK,IAAI,OAAO,CAAC,cAAc,EAAE;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC,CAG1D;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,cAAc,EACrB,SAAS,CAAC,EAAE,MAAM,GACjB,KAAK,IAAI,OAAO,CAAC,cAAc,EAAE;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC,CAKxD;AAED,eAAO,MAAM,aAAa,UAgBzB,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/ari-client/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE5D,wBAAgB,aAAa,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,MAAM,CAMnD;AAED,wBAAgB,eAAe,CAC7B,KAAK,EAAE,cAAc,EACrB,UAAU,CAAC,EAAE,MAAM,GAClB,KAAK,IAAI,OAAO,CAAC,cAAc,EAAE;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC,CAG1D;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,cAAc,EACrB,SAAS,CAAC,EAAE,MAAM,GACjB,KAAK,IAAI,OAAO,CAAC,cAAc,EAAE;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC,CAKxD;AAED,eAAO,MAAM,aAAa,UAgBzB,CAAC"}

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

@@ -2,38 +2,69 @@ import { EventEmitter } from "events";
 import type { AriClient } from "./ariClient";
 import type { BaseClient } from "./baseClient.js";
 import type { WebSocketEventType } from "./interfaces";
+/**
+ * WebSocketClient handles real-time communication with the Asterisk server.
+ * Extends EventEmitter to provide event-based communication patterns.
+ */
 export declare class WebSocketClient extends EventEmitter {
-    private baseClient;
-    private apps;
-    private subscribedEvents?;
-    private ariClient?;
+    private readonly baseClient;
+    private readonly apps;
+    private readonly subscribedEvents?;
+    private readonly ariClient?;
     private ws?;
     private isReconnecting;
     private readonly maxReconnectAttempts;
     private readonly backOffOptions;
-    constructor(baseClient: BaseClient, // BaseClient contém baseUrl, username, e password
-    apps: string[], // Lista de aplicativos a serem conectados
-    subscribedEvents?: WebSocketEventType[] | undefined, // Lista de eventos a serem assinados
-    ariClient?: AriClient | undefined);
     /**
-     * Conecta ao WebSocket.
+     * Creates a new WebSocket client 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
+     */
+    constructor(baseClient: BaseClient, apps: string[], subscribedEvents?: WebSocketEventType[] | undefined, ariClient?: AriClient | undefined);
+    /**
+     * Establishes a WebSocket connection.
+     *
+     * @returns {Promise<void>} Resolves when connection is established
+     * @throws {Error} If connection fails
      */
     connect(): Promise<void>;
     /**
-     * Inicializa a conexão WebSocket com lógica de reconexão.
+     * Initializes WebSocket connection with reconnection logic.
+     *
+     * @param {string} wsUrl - The WebSocket URL to connect to
+     * @returns {Promise<void>} Resolves when connection is established
      */
     private initializeWebSocket;
     /**
-     * Processa as mensagens recebidas do WebSocket.
+     * Processes incoming WebSocket messages.
+     *
+     * @param {string} rawMessage - The raw message received from WebSocket
      */
     private handleMessage;
     /**
-     * Tenta reconectar ao WebSocket.
+     * Attempts to reconnect to the WebSocket.
+     *
+     * @param {string} wsUrl - The WebSocket URL to reconnect to
      */
     private reconnect;
     /**
-     * Fecha o WebSocket manualmente.
+     * Manually closes the WebSocket connection.
      */
     close(): void;
+    /**
+     * Checks if the WebSocket is currently connected.
+     *
+     * @returns {boolean} True if connected, false otherwise
+     */
+    isConnected(): boolean;
+    /**
+     * Gets the current connection state.
+     *
+     * @returns {number} The WebSocket ready state
+     */
+    getState(): number;
 }
 //# 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":"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;AAEvE,qBAAa,eAAgB,SAAQ,YAAY;IAuB7C,OAAO,CAAC,UAAU;IAClB,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,gBAAgB,CAAC;IACzB,OAAO,CAAC,SAAS,CAAC;IAzBpB,OAAO,CAAC,EAAE,CAAC,CAAY;IACvB,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAM;IAE3C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAe7B;gBAGQ,UAAU,EAAE,UAAU,EAAE,kDAAkD;IAC1E,IAAI,EAAE,MAAM,EAAE,EAAE,0CAA0C;IAC1D,gBAAgB,CAAC,EAAE,kBAAkB,EAAE,YAAA,EAAE,qCAAqC;IAC9E,SAAS,CAAC,EAAE,SAAS,YAAA;IAK/B;;OAEG;IACU,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA+BrC;;OAEG;YACW,mBAAmB;IAkCjC;;OAEG;IACH,OAAO,CAAC,aAAa;IAwCrB;;OAEG;IACH,OAAO,CAAC,SAAS;IAcjB;;OAEG;IACI,KAAK,IAAI,IAAI;CAIrB"}
+{"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;IA8B3C,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;IAhC/B,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;gBAEkB,UAAU,EAAE,UAAU,EACtB,IAAI,EAAE,MAAM,EAAE,EACd,gBAAgB,CAAC,EAAE,kBAAkB,EAAE,YAAA,EACvC,SAAS,CAAC,EAAE,SAAS,YAAA;IAS1C;;;;;OAKG;IACU,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA8BrC;;;;;OAKG;YACW,mBAAmB;IAsCjC;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAkCrB;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAejB;;OAEG;IACI,KAAK,IAAI,IAAI;IAcpB;;;;OAIG;IACI,WAAW,IAAI,OAAO;IAI7B;;;;OAIG;IACI,QAAQ,IAAI,MAAM;CAG1B"}

package/dist/types/index.d.ts

@@ -1,10 +1,34 @@
+/**
+ * @file Main entry point for the Asterisk REST Interface (ARI) client package
+ * @description This file exports all the necessary classes, types and interfaces for interacting with the ARI
+ */
+/**
+ * Main client class for interacting with Asterisk REST Interface
+ * @packageDocumentation
+ */
 export { AriClient } from "./ari-client/ariClient.js";
-export { Channels, ChannelInstance } from "./ari-client/resources/channels.js";
+/**
+ * Resource Classes
+ * These classes provide direct access to ARI resources
+ */
+export { Channels, ChannelInstance, } from "./ari-client/resources/channels.js";
 export { Endpoints } from "./ari-client/resources/endpoints.js";
 export { Applications } from "./ari-client/resources/applications.js";
 export { Sounds } from "./ari-client/resources/sounds.js";
 export { Playbacks, PlaybackInstance, } from "./ari-client/resources/playbacks.js";
 export { Asterisk } from "./ari-client/resources/asterisk.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, ChannelEvent, PlaybackEvent, AsteriskPing, } from "./ari-client/interfaces/index.js";
+/**
+ * Type Definitions
+ * These types and interfaces define the shape of data structures used throughout the API
+ */
+export type { AriClientConfig, AriApplication, } from "./ari-client/interfaces/index.js";
+export type { Channel, ChannelEvent, ChannelPlayback, ChannelVar, ChannelDialplan, OriginateRequest, RecordingOptions, SnoopOptions, ExternalMediaOptions, RTPStats, } from "./ari-client/interfaces/index.js";
+export type { Playback, PlaybackEvent, PlaybackOptions, PlaybackControlRequest, PlayMediaRequest, } from "./ari-client/interfaces/index.js";
+export type { Bridge, BridgePlayback, CreateBridgeRequest, RemoveChannelRequest, AddChannelRequest, } from "./ari-client/interfaces/index.js";
+export type { Endpoint, EndpointDetails, } from "./ari-client/interfaces/index.js";
+export type { Application, ApplicationDetails, } from "./ari-client/interfaces/index.js";
+export type { Sound, SoundListRequest, } from "./ari-client/interfaces/index.js";
+export type { AsteriskInfo, Module, Logging, Variable, AsteriskPing, } from "./ari-client/interfaces/index.js";
+export type { WebSocketEvent, WebSocketEventType, } 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,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAC/E,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,EACL,SAAS,EACT,gBAAgB,GACjB,MAAM,qCAAqC,CAAC;AAC7C,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,EACjB,YAAY,EACZ,aAAa,EACb,YAAY,GACb,MAAM,kCAAkC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAEtD;;;GAGG;AACH,OAAO,EACL,QAAQ,EACR,eAAe,GAChB,MAAM,oCAAoC,CAAC;AAE5C,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,EACL,SAAS,EACT,gBAAgB,GACjB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,oCAAoC,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC;AAE5D;;;GAGG;AAGH,YAAY,EACV,eAAe,EACf,cAAc,GACf,MAAM,kCAAkC,CAAC;AAG1C,YAAY,EACV,OAAO,EACP,YAAY,EACZ,eAAe,EACf,UAAU,EACV,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,EACZ,oBAAoB,EACpB,QAAQ,GACT,MAAM,kCAAkC,CAAC;AAG1C,YAAY,EACV,QAAQ,EACR,aAAa,EACb,eAAe,EACf,sBAAsB,EACtB,gBAAgB,GACjB,MAAM,kCAAkC,CAAC;AAG1C,YAAY,EACV,MAAM,EACN,cAAc,EACd,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,GAClB,MAAM,kCAAkC,CAAC;AAG1C,YAAY,EACV,QAAQ,EACR,eAAe,GAChB,MAAM,kCAAkC,CAAC;AAG1C,YAAY,EACV,WAAW,EACX,kBAAkB,GACnB,MAAM,kCAAkC,CAAC;AAG1C,YAAY,EACV,KAAK,EACL,gBAAgB,GACjB,MAAM,kCAAkC,CAAC;AAG1C,YAAY,EACV,YAAY,EACZ,MAAM,EACN,OAAO,EACP,QAAQ,EACR,YAAY,GACb,MAAM,kCAAkC,CAAC;AAG1C,YAAY,EACV,cAAc,EACd,kBAAkB,GACnB,MAAM,kCAAkC,CAAC"}

package/package.json

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