@gibme/asterisk-gateway-interface 4.0.3 → 5.0.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016-2024 Brandon Lehmann
+Copyright (c) 2016-2025 Brandon Lehmann
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/channel.d.ts

@@ -1,10 +1,32 @@
-import { Socket } from '@gibme/tcp-server';
 import { EventEmitter } from 'events';
-import { ChannelDriver, ChannelState, DialStatus, IResponse, PlaybackStatus } from './types';
+import type { Socket } from '@gibme/tcp-server';
+import { ResponseArguments } from './response_arguments';
+export { ResponseArguments };
+/**
+ * The current context state
+ */
+export declare enum ContextState {
+    INIT = 0,
+    WAITING = 2
+}
+/**
+ * Represents the channel driver type
+ */
+export declare enum Driver {
+    DHAHDI = "DHAHDI",
+    SIP = "SIP",
+    PJSIP = "PJSIP",
+    IAX2 = "IAX2",
+    LOCAL = "Local",
+    SCCP = "SCCP",
+    OSS = "OSS",
+    MOTIF = "Motif",
+    UNKNOWN = ""
+}
 /**
  * Represents an AGI Channel
  */
-export default class Channel extends EventEmitter {
+export declare class Channel extends EventEmitter {
     private readonly _connection;
     private _state;
     private _message;
@@ -14,6 +36,11 @@ export default class Channel extends EventEmitter {
      * @param connection the AGI socket connection
      */
     constructor(connection: Socket);
+    private _outgoingHeaders;
+    /**
+     * Headers that have been set for **outgoing** requests
+     */
+    get outgoingHeaders(): Record<string, string>;
     private _network;
     /**
      * Whether this AGI request is over the network
@@ -22,7 +49,7 @@ export default class Channel extends EventEmitter {
     private _network_script;
     /**
      * The network path included in the AGI request
-     * ie. agi://127.0.0.1:3000/test
+     * e.g. agi://127.0.0.1:3000/test
      * This value would return 'test'
      */
     get network_script(): string;
@@ -46,7 +73,7 @@ export default class Channel extends EventEmitter {
     /**
      * The originating channel type (e.g. “SIP” or “ZAP”)
      */
-    get type(): ChannelDriver;
+    get type(): Driver;
     private _uniqueid;
     /**
      * A unique ID for the call
@@ -182,7 +209,7 @@ export default class Channel extends EventEmitter {
      * @param event
      * @param listener
      */
-    on(event: 'response', listener: (response: IResponse) => void): this;
+    on(event: 'response', listener: (response: Channel.Response) => void): this;
     /**
      * Event that is emitted when data is sent to the Asterisk server
      * @param event
@@ -202,7 +229,7 @@ export default class Channel extends EventEmitter {
      * Returns status of the connected channel.
      * @param channel
      */
-    channelStatus(channel?: string): Promise<ChannelState>;
+    channelStatus(channel?: string): Promise<Channel.State>;
     /**
      * Sends audio file on channel and allows the listener to control the stream.
      * @param filename
@@ -214,7 +241,7 @@ export default class Channel extends EventEmitter {
      */
     controlStreamFile(filename: string, escapeDigits?: string, skipms?: number, fastForwardCharacter?: string, rewindCharacter?: string, pauseCharacter?: string): Promise<{
         digit: string;
-        playbackStatus: PlaybackStatus;
+        playbackStatus: Channel.Playback.Status;
         playbackOffset: number;
     }>;
     /**
@@ -228,9 +255,13 @@ export default class Channel extends EventEmitter {
         params: string;
         hangupOnComplete: boolean;
     }>): Promise<{
-        status: DialStatus;
+        status: Channel.Dial.Status;
         dialed_time: number;
         answered_time: number;
+        peer_name: string;
+        peer_number: string;
+        ring_time: number;
+        progress_time: number;
     }>;
     /**
      * Deletes an entry in the Asterisk database for a given family and key.
@@ -259,7 +290,7 @@ export default class Channel extends EventEmitter {
     databasePut(family: string, key: string, value: string): Promise<string>;
     /**
      * Executes application with given options
-     * @param application.
+     * @param application
      * @param args
      */
     exec(application: string, ...args: string[]): Promise<number>;
@@ -278,8 +309,9 @@ export default class Channel extends EventEmitter {
      * Understands complex variable names and builtin variables, unlike GET VARIABLE.
      * @param key
      * @param channel
+     * @param keyToUpper
      */
-    getFullVariable(key: string, channel?: string): Promise<string>;
+    getFullVariable(key: string, channel?: string, keyToUpper?: boolean): Promise<string>;
     /**
      * Stream file, prompt for DTMF, with timeout.
      * Behaves similar to STREAM FILE but used with a timeout option.
@@ -294,8 +326,9 @@ export default class Channel extends EventEmitter {
     /**
      * Gets a channel variable.
      * @param key
+     * @param keyToUpper whether to force the key to uppercase
      */
-    getVariable(key: string): Promise<string>;
+    getVariable(key: string, keyToUpper?: boolean): Promise<string>;
     /**
      * Cause the channel to execute the specified dialplan subroutine.
      * @param context
@@ -304,11 +337,33 @@ export default class Channel extends EventEmitter {
      * @param argument
      */
     goSub(context: string, extension: string, priority: number, argument?: string): Promise<void>;
+    /**
+     * Indicates busy to the calling channel
+     *
+     * @param timeout if specified, the calling channel will be hung up after the specified number of seconds.
+     * Otherwise, this application will wait until the calling channel hangs up
+     */
+    busy(timeout?: number): Promise<number>;
+    /**
+     * Indicates congestion to the calling channel
+     *
+     * @param timeout if specified, the calling channel will be hung up after the specified number of seconds.
+     * Otherwise, this application will wait until the calling channel hangs up
+     */
+    congestion(timeout?: number): Promise<number>;
     /**
      * Hangs up the specified channel. If no channel name is given, hangs up the current channel
      * @param channel
      */
     hangup(channel?: string): Promise<void>;
+    /**
+     * Requests that in-band progress information be provided to the calling channel
+     */
+    progress(): Promise<number>;
+    /**
+     * Requests that the channel indicate a ringing tone to the user
+     */
+    ringing(): Promise<number>;
     /**
      * Does nothing
      */
@@ -433,14 +488,14 @@ export default class Channel extends EventEmitter {
      * @param value
      */
     setVariable(key: string, value: string): Promise<void>;
-    speechActivateGrammar(grammar: string): Promise<IResponse>;
-    speechCreate(engine: string): Promise<IResponse>;
-    speechDeactivateGrammar(grammar: string): Promise<IResponse>;
-    speechDestroy(): Promise<IResponse>;
-    speechLoadGrammar(grammar: string, path: string): Promise<IResponse>;
-    speechRecognize(soundFile: string, timeout: number | undefined, offset: number): Promise<IResponse>;
-    speechSet(key: string, value: string): Promise<IResponse>;
-    speedUnloadGrammar(grammar: string): Promise<IResponse>;
+    speechActivateGrammar(grammar: string): Promise<Channel.Response>;
+    speechCreate(engine: string): Promise<Channel.Response>;
+    speechDeactivateGrammar(grammar: string): Promise<Channel.Response>;
+    speechDestroy(): Promise<Channel.Response>;
+    speechLoadGrammar(grammar: string, path: string): Promise<Channel.Response>;
+    speechRecognize(soundFile: string, timeout: number | undefined, offset: number): Promise<Channel.Response>;
+    speechSet(key: string, value: string): Promise<Channel.Response>;
+    speedUnloadGrammar(grammar: string): Promise<Channel.Response>;
     /**
      * Sends audio file on channel.
      * @param filename
@@ -468,21 +523,28 @@ export default class Channel extends EventEmitter {
      */
     waitForDigit(timeout?: number): Promise<string>;
     /**
-     * Adds a SIP header to the outbound call
+     * Attempts to retrieve the inbound header specified from the channel
+     *
+     * Note: This method can only read headers on the **incoming** request. It can not
+     * read headers set on an **outbound** SIP request.
+     *
+     * @param key
+     */
+    getHeader(key: string): Promise<string | undefined>;
+    /**
+     * Adds a header to the **outgoing** request
      *
      * @param key
      * @param value
      */
     addHeader(key: string, value: string): Promise<void>;
     /**
-     * Allows you to remove headers which were previously added with PJSIPAddHeader().
-     * If no parameter is supplied, all previously added headers will be removed.
-     * If a parameter is supplied, only the matching headers will be removed
+     * Allows you to remove a header from the **outgoing** request as long as you
+     * have added it via the `addHeader()` method.
      *
      * @param key
-     * @param wildcard
      */
-    removeHeader(key?: string, wildcard?: boolean): Promise<void>;
+    removeHeader(key: string): Promise<void>;
     /**
      * Evaluates a channel expression
      * Understands complex variable names and builtin variables, unlike GET VARIABLE.
@@ -502,7 +564,6 @@ export default class Channel extends EventEmitter {
      *
      * @param key
      * @param value
-     * @constructor
      * @private
      */
     private IAX2AddHeader;
@@ -510,7 +571,6 @@ export default class Channel extends EventEmitter {
      * Removes an IAX2 'header' from the outbound call
      *
      * @param key
-     * @constructor
      * @private
      */
     private IAX2RemoveHeader;
@@ -519,17 +579,13 @@ export default class Channel extends EventEmitter {
      *
      * @param key
      * @param value
-     * @constructor
      * @private
      */
     private PJSIPAddHeader;
     /**
      * Allows you to remove headers which were previously added with PJSIPAddHeader().
-     * If no parameter is supplied, all previously added headers will be removed.
-     * If a parameter is supplied, only the matching headers will be removed
      *
      * @param key
-     * @param wildcard
      * @private
      */
     private PJSIPRemoveHeader;
@@ -542,12 +598,8 @@ export default class Channel extends EventEmitter {
     private SIPAddHeader;
     /**
      * SIPRemoveHeader() allows you to remove headers which were previously added with SIPAddHeader().
-     * If no parameter is supplied, all previously added headers will be removed.
-     * If a parameter is supplied, only the matching headers will be removed.
      *
      * @param key
-     * @param wildcard
-     * @constructor
      */
     private SIPRemoveHeader;
     /**
@@ -607,3 +659,55 @@ export default class Channel extends EventEmitter {
      */
     private sendCommand;
 }
+export declare namespace Channel {
+    /**
+     * The Current Channel State
+     */
+    enum State {
+        DOWN_AVAILABLE = 0,
+        DOWN_RESERVED = 1,
+        OFF_HOOK = 2,
+        DIGITS_DIALED = 3,
+        RINGING = 4,
+        REMOTE_RINGING = 5,
+        UP = 6,
+        BUSY = 7
+    }
+    namespace Dial {
+        /**
+         * Represents the result of a Dial() attempt
+         */
+        enum Status {
+            ANSWER = 0,
+            BUSY = 1,
+            NOANSWER = 2,
+            CANCEL = 3,
+            CONGESTION = 4,
+            CHANUNAVAIL = 5,
+            DONTCALL = 6,
+            TORTURE = 7,
+            INVALIDARGS = 8,
+            UNKNOWN = 9999
+        }
+    }
+    namespace Playback {
+        /**
+         * Represents the playback status
+         */
+        enum Status {
+            SUCCESS = 0,
+            USER_STOPPED = 1,
+            REMOTE_STOPPED = 2,
+            ERROR = 3
+        }
+    }
+    /**
+     * Responses a response to a channel command
+     */
+    type Response = {
+        code: number;
+        result: number;
+        arguments: ResponseArguments;
+    };
+}
+export default Channel;