@gibme/asterisk-gateway-interface 1.0.2 → 1.0.3

package/LICENSE

@@ -1,19 +1,19 @@
-Copyright (c) 2016-2022 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
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+Copyright (c) 2016-2022 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,19 +1,25 @@
-# Simple [Asterisk Gateway Interface](https://wiki.asterisk.org/wiki/pages/viewpage.action?pageId=32375589) Helper
-
-```typescript
-import AGI, { Channel } from '@gibme/asterisk-gateway-interface';
-
-(async () => {
-    const agi = new AMI({
-        port: 3000
-    });
-    
-    agi.on('channel', async (channel: Channel) => {
-        await channel.answer();
-        await channel.sayNumber(12345);
-        await channel.hangup();
-    });
-    
-    await agi.start();
-})()
-```
+# [Asterisk Gateway Interface](https://wiki.asterisk.org/wiki/pages/viewpage.action?pageId=32375589) Server
+
+## Documentation
+
+[https://gibme-npm.github.io/asterisk-gateway-interface/](https://gibme-npm.github.io/asterisk-gateway-interface/)
+
+## Sample Code
+
+```typescript
+import AGI, { Channel } from '@gibme/asterisk-gateway-interface';
+
+(async () => {
+    const agi = new AMI({
+        port: 3000
+    });
+    
+    agi.on('channel', async (channel: Channel) => {
+        await channel.answer();
+        await channel.sayNumber(12345);
+        await channel.hangup();
+    });
+    
+    await agi.start();
+})()
+```

package/dist/asterisk-gateway-interface.d.ts

@@ -1,46 +1,47 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
-import Channel from './channel';
-export { Channel };
-export { ChannelState, DialStatus, PlaybackStatus } from './types';
-/**
- * Represents an AGI server instance
- */
-export default class AsteriskGatewayInterface extends EventEmitter {
-    readonly port: number;
-    readonly ip: string;
-    private readonly server;
-    /**
-     * Constructs a new instance of the object
-     * @param port
-     * @param ip
-     * @param maximumListeners
-     */
-    constructor(port?: number, ip?: string, maximumListeners?: number);
-    /**
-     * Event that is emitted when a new AGI channel has been established and is ready for interation
-     * @param event
-     * @param listener
-     */
-    on(event: 'channel', listener: (channel: Channel) => void): this;
-    /**
-     * Event that is emitted when the server encounters and error
-     * @param event
-     * @param listener
-     */
-    on(event: 'error', listener: (error: any) => void): this;
-    /**
-     * Event that emitted when the server is closed and stopped
-     * @param event
-     * @param listener
-     */
-    on(event: 'close', listener: () => void): this;
-    /**
-     * Starts the AGI server
-     */
-    start(): Promise<void>;
-    /**
-     * Stops the AGI server
-     */
-    stop(): Promise<void>;
-}
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import Channel from './channel';
+export { Channel };
+export { ChannelState, DialStatus, PlaybackStatus, IResponse, ResponseArguments, IResponseArguments } from './types';
+/**
+ * Represents an AGI server instance
+ */
+export default class AsteriskGatewayInterface extends EventEmitter {
+    readonly port: number;
+    readonly ip: string;
+    private readonly server;
+    /**
+     * Constructs a new instance of the object
+     * @param port
+     * @param ip
+     * @param maximumListeners
+     */
+    constructor(port?: number, ip?: string, maximumListeners?: number);
+    /**
+     * Event that is emitted when a new AGI channel has been established and is ready for interation
+     * @param event
+     * @param listener
+     */
+    on(event: 'channel', listener: (channel: Channel) => void): this;
+    /**
+     * Event that is emitted when the server encounters and error
+     * @param event
+     * @param listener
+     */
+    on(event: 'error', listener: (error: any) => void): this;
+    /**
+     * Event that emitted when the server is closed and stopped
+     * @param event
+     * @param listener
+     */
+    on(event: 'close', listener: () => void): this;
+    /**
+     * Starts the AGI server
+     */
+    start(): Promise<void>;
+    /**
+     * Stops the AGI server
+     */
+    stop(): Promise<void>;
+}
+export { AsteriskGatewayInterface };

package/dist/asterisk-gateway-interface.js

@@ -1,70 +1,89 @@
-"use strict";
-// Copyright (c) 2016-2022 Brandon Lehmann
-//
-// Please see the included LICENSE file for more information.
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PlaybackStatus = exports.DialStatus = exports.ChannelState = exports.Channel = void 0;
-const tcp_server_1 = require("@gibme/tcp-server");
-const events_1 = require("events");
-const channel_1 = __importDefault(require("./channel"));
-exports.Channel = channel_1.default;
-var types_1 = require("./types");
-Object.defineProperty(exports, "ChannelState", { enumerable: true, get: function () { return types_1.ChannelState; } });
-Object.defineProperty(exports, "DialStatus", { enumerable: true, get: function () { return types_1.DialStatus; } });
-Object.defineProperty(exports, "PlaybackStatus", { enumerable: true, get: function () { return types_1.PlaybackStatus; } });
-/**
- * Represents an AGI server instance
- */
-class AsteriskGatewayInterface extends events_1.EventEmitter {
-    /**
-     * Constructs a new instance of the object
-     * @param port
-     * @param ip
-     * @param maximumListeners
-     */
-    constructor(port = 3000, ip = '0.0.0.0', maximumListeners = 20) {
-        super();
-        this.port = port;
-        this.ip = ip;
-        this.server = (0, tcp_server_1.createServer)();
-        this.setMaxListeners(maximumListeners);
-        this.server.on('connection', (socket) => {
-            const channel = new channel_1.default(socket);
-            channel.on('ready', () => this.emit('channel', channel));
-        });
-        this.server.on('error', error => this.emit('error', error));
-        this.server.on('close', () => this.emit('close'));
-    }
-    on(event, listener) {
-        return super.on(event, listener);
-    }
-    /**
-     * Starts the AGI server
-     */
-    start() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.server.start(this.port, this.ip);
-        });
-    }
-    /**
-     * Stops the AGI server
-     */
-    stop() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.server.stop();
-        });
-    }
-}
-exports.default = AsteriskGatewayInterface;
+"use strict";
+// Copyright (c) 2016-2022, Brandon Lehmann <brandonlehmann@gmail.com>
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AsteriskGatewayInterface = exports.ResponseArguments = exports.PlaybackStatus = exports.DialStatus = exports.ChannelState = exports.Channel = void 0;
+const tcp_server_1 = require("@gibme/tcp-server");
+const events_1 = require("events");
+const channel_1 = __importDefault(require("./channel"));
+exports.Channel = channel_1.default;
+var types_1 = require("./types");
+Object.defineProperty(exports, "ChannelState", { enumerable: true, get: function () { return types_1.ChannelState; } });
+Object.defineProperty(exports, "DialStatus", { enumerable: true, get: function () { return types_1.DialStatus; } });
+Object.defineProperty(exports, "PlaybackStatus", { enumerable: true, get: function () { return types_1.PlaybackStatus; } });
+Object.defineProperty(exports, "ResponseArguments", { enumerable: true, get: function () { return types_1.ResponseArguments; } });
+/**
+ * Represents an AGI server instance
+ */
+class AsteriskGatewayInterface extends events_1.EventEmitter {
+    /**
+     * Constructs a new instance of the object
+     * @param port
+     * @param ip
+     * @param maximumListeners
+     */
+    constructor(port = 3000, ip = '0.0.0.0', maximumListeners = 20) {
+        super();
+        this.port = port;
+        this.ip = ip;
+        this.server = (0, tcp_server_1.createServer)();
+        this.setMaxListeners(maximumListeners);
+        this.server.on('connection', (socket) => {
+            const channel = new channel_1.default(socket);
+            channel.on('ready', () => this.emit('channel', channel));
+        });
+        this.server.on('error', error => this.emit('error', error));
+        this.server.on('close', () => this.emit('close'));
+    }
+    on(event, listener) {
+        return super.on(event, listener);
+    }
+    /**
+     * Starts the AGI server
+     */
+    start() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.server.start(this.port, this.ip);
+        });
+    }
+    /**
+     * Stops the AGI server
+     */
+    stop() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.server.stop();
+        });
+    }
+}
+exports.default = AsteriskGatewayInterface;
+exports.AsteriskGatewayInterface = AsteriskGatewayInterface;
+//# sourceMappingURL=asterisk-gateway-interface.js.map

package/dist/asterisk-gateway-interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asterisk-gateway-interface.js","sourceRoot":"","sources":["../src/asterisk-gateway-interface.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,EAAE;AACF,+EAA+E;AAC/E,gFAAgF;AAChF,+EAA+E;AAC/E,4EAA4E;AAC5E,wEAAwE;AACxE,2DAA2D;AAC3D,EAAE;AACF,iFAAiF;AACjF,kDAAkD;AAClD,EAAE;AACF,6EAA6E;AAC7E,2EAA2E;AAC3E,8EAA8E;AAC9E,yEAAyE;AACzE,gFAAgF;AAChF,gFAAgF;AAChF,YAAY;;;;;;;;;;;;;;;AAEZ,kDAA4D;AAE5D,mCAAsC;AACtC,wDAAgC;AACvB,kBADF,iBAAO,CACE;AAChB,iCAOiB;AANb,qGAAA,YAAY,OAAA;AACZ,mGAAA,UAAU,OAAA;AACV,uGAAA,cAAc,OAAA;AAEd,0GAAA,iBAAiB,OAAA;AAIrB;;GAEG;AACH,MAAqB,wBAAyB,SAAQ,qBAAY;IAG9D;;;;;OAKG;IACH,YACoB,OAAe,IAAI,EACnB,KAAa,SAAS,EACtC,gBAAgB,GAAG,EAAE;QAErB,KAAK,EAAE,CAAC;QAJQ,SAAI,GAAJ,IAAI,CAAe;QACnB,OAAE,GAAF,EAAE,CAAoB;QAVzB,WAAM,GAAc,IAAA,yBAAY,GAAE,CAAC;QAehD,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;QAEvC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAc,EAAE,EAAE;YAC5C,MAAM,OAAO,GAAG,IAAI,iBAAO,CAAC,MAAM,CAAC,CAAC;YAEpC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QAE5D,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACtD,CAAC;IAuBM,EAAE,CAAE,KAAU,EAAE,QAAkC;QACrD,OAAO,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACU,KAAK;;YACd,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QACjD,CAAC;KAAA;IAED;;OAEG;IACU,IAAI;;YACb,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAC9B,CAAC;KAAA;CACJ;AAnED,2CAmEC;AAEQ,4DAAwB"}