@gibme/asterisk-gateway-interface 1.0.1

package/dist/response_arguments.d.ts

@@ -0,0 +1,41 @@
+export interface IResponseArguments {
+    key: string;
+    value: string | number | boolean;
+}
+/**
+ * Represents a set of AGI response arguments
+ * @ignore
+ */
+export default class ResponseArguments {
+    private m_args;
+    /**
+     * Adds a new argument to the set
+     * @param key
+     * @param value
+     */
+    addArgument(key: string, value: string | number | boolean): void;
+    /**
+     * Retrieves the requested key as a string
+     * @param key
+     */
+    string(key: string): string;
+    /**
+     * Retrieves the requested key as a number
+     * @param key
+     */
+    number(key: string): number;
+    /**
+     * Retrieves the request key as a boolean
+     * @param key
+     */
+    boolean(key: string): boolean;
+    /**
+     * Retrieves the requested key from a character code
+     * @param key
+     */
+    char(key: string): string;
+    /**
+     * Retrieves the value from the arguments that has no key, if it exists
+     */
+    nokey(): string;
+}

package/dist/response_arguments.js

@@ -0,0 +1,78 @@
+"use strict";
+// Copyright (c) 2016-2022 Brandon Lehmann
+//
+// Please see the included LICENSE file for more information.
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Represents a set of AGI response arguments
+ * @ignore
+ */
+class ResponseArguments {
+    constructor() {
+        this.m_args = [];
+    }
+    /**
+     * Adds a new argument to the set
+     * @param key
+     * @param value
+     */
+    addArgument(key, value) {
+        this.m_args.push({ key, value });
+    }
+    /**
+     * Retrieves the requested key as a string
+     * @param key
+     */
+    string(key) {
+        for (const arg of this.m_args) {
+            if (arg.key === key) {
+                return arg.value;
+            }
+        }
+        return '';
+    }
+    /**
+     * Retrieves the requested key as a number
+     * @param key
+     */
+    number(key) {
+        for (const arg of this.m_args) {
+            if (arg.key === key) {
+                return parseInt(arg.value, 10);
+            }
+        }
+        return 0;
+    }
+    /**
+     * Retrieves the request key as a boolean
+     * @param key
+     */
+    boolean(key) {
+        for (const arg of this.m_args) {
+            if (arg.key === key) {
+                return arg.value;
+            }
+        }
+        return false;
+    }
+    /**
+     * Retrieves the requested key from a character code
+     * @param key
+     */
+    char(key) {
+        const num = this.number(key);
+        return (num !== 0) ? String.fromCharCode(num) : '';
+    }
+    /**
+     * Retrieves the value from the arguments that has no key, if it exists
+     */
+    nokey() {
+        for (const arg of this.m_args) {
+            if (arg.key !== 'result' && arg.value) {
+                return arg.key;
+            }
+        }
+        return '';
+    }
+}
+exports.default = ResponseArguments;

package/dist/types.d.ts

@@ -0,0 +1,51 @@
+import ResponseArguments from './response_arguments';
+/**
+ * The Current Context State
+ */
+export declare enum ContextState {
+    INIT = 0,
+    WAITING = 2
+}
+/**
+ * The Current Channel State
+ */
+export declare enum ChannelState {
+    DOWN_AVAILABLE = 0,
+    DOWN_RESERVED = 1,
+    OFF_HOOK = 2,
+    DIGITS_DIALED = 3,
+    RINGING = 4,
+    REMOTE_RINGING = 5,
+    UP = 6,
+    BUSY = 7
+}
+/**
+ * Represents the result of a Dial() attempt
+ */
+export declare enum DialStatus {
+    ANSWER = 0,
+    BUSY = 1,
+    NOANSWER = 2,
+    CANCEL = 3,
+    CONGESTION = 4,
+    CHANUNAVAIL = 5,
+    DONTCALL = 6,
+    TORTURE = 7,
+    INVALIDARGS = 8
+}
+/**
+ * Represents the playback status
+ */
+export declare enum PlaybackStatus {
+    SUCCESS = 0,
+    USER_STOPPED = 1,
+    REMOTE_STOPPED = 2,
+    ERROR = 3
+}
+/** @ignore */
+export interface IResponse {
+    code: number;
+    result: number;
+    arguments: ResponseArguments;
+}
+export { ResponseArguments };

package/dist/types.js

@@ -0,0 +1,58 @@
+"use strict";
+// Copyright (c) 2016-2022 Brandon Lehmann
+//
+// Please see the included LICENSE file for more information.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseArguments = exports.PlaybackStatus = exports.DialStatus = exports.ChannelState = exports.ContextState = void 0;
+const response_arguments_1 = __importDefault(require("./response_arguments"));
+exports.ResponseArguments = response_arguments_1.default;
+/**
+ * The Current Context State
+ */
+var ContextState;
+(function (ContextState) {
+    ContextState[ContextState["INIT"] = 0] = "INIT";
+    ContextState[ContextState["WAITING"] = 2] = "WAITING";
+})(ContextState = exports.ContextState || (exports.ContextState = {}));
+/**
+ * The Current Channel State
+ */
+var ChannelState;
+(function (ChannelState) {
+    ChannelState[ChannelState["DOWN_AVAILABLE"] = 0] = "DOWN_AVAILABLE";
+    ChannelState[ChannelState["DOWN_RESERVED"] = 1] = "DOWN_RESERVED";
+    ChannelState[ChannelState["OFF_HOOK"] = 2] = "OFF_HOOK";
+    ChannelState[ChannelState["DIGITS_DIALED"] = 3] = "DIGITS_DIALED";
+    ChannelState[ChannelState["RINGING"] = 4] = "RINGING";
+    ChannelState[ChannelState["REMOTE_RINGING"] = 5] = "REMOTE_RINGING";
+    ChannelState[ChannelState["UP"] = 6] = "UP";
+    ChannelState[ChannelState["BUSY"] = 7] = "BUSY";
+})(ChannelState = exports.ChannelState || (exports.ChannelState = {}));
+/**
+ * Represents the result of a Dial() attempt
+ */
+var DialStatus;
+(function (DialStatus) {
+    DialStatus[DialStatus["ANSWER"] = 0] = "ANSWER";
+    DialStatus[DialStatus["BUSY"] = 1] = "BUSY";
+    DialStatus[DialStatus["NOANSWER"] = 2] = "NOANSWER";
+    DialStatus[DialStatus["CANCEL"] = 3] = "CANCEL";
+    DialStatus[DialStatus["CONGESTION"] = 4] = "CONGESTION";
+    DialStatus[DialStatus["CHANUNAVAIL"] = 5] = "CHANUNAVAIL";
+    DialStatus[DialStatus["DONTCALL"] = 6] = "DONTCALL";
+    DialStatus[DialStatus["TORTURE"] = 7] = "TORTURE";
+    DialStatus[DialStatus["INVALIDARGS"] = 8] = "INVALIDARGS";
+})(DialStatus = exports.DialStatus || (exports.DialStatus = {}));
+/**
+ * Represents the playback status
+ */
+var PlaybackStatus;
+(function (PlaybackStatus) {
+    PlaybackStatus[PlaybackStatus["SUCCESS"] = 0] = "SUCCESS";
+    PlaybackStatus[PlaybackStatus["USER_STOPPED"] = 1] = "USER_STOPPED";
+    PlaybackStatus[PlaybackStatus["REMOTE_STOPPED"] = 2] = "REMOTE_STOPPED";
+    PlaybackStatus[PlaybackStatus["ERROR"] = 3] = "ERROR";
+})(PlaybackStatus = exports.PlaybackStatus || (exports.PlaybackStatus = {}));

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@gibme/asterisk-gateway-interface",
+  "version": "1.0.1",
+  "description": "Simple Asterisk Gateway Interface Helper",
+  "main": "dist/asterisk-gateway-interface.js",
+  "types": "dist/asterisk-gateway-interface.d.ts",
+  "files": [
+    "dist/*"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "build": "./node_modules/.bin/tsc",
+    "test": "yarn style",
+    "style": "./node_modules/.bin/eslint src/**/*.ts",
+    "fix-style": "./node_modules/.bin/eslint --fix src/**/*.ts",
+    "fix:style": "yarn fix-style",
+    "prepublishOnly": "yarn build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gibme-npm/asterisk-gateway-interface.git"
+  },
+  "bugs": {
+    "url": "https://github.com/gibme-npm/asterisk-gateway-interface/issues"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "engineStrict": true,
+  "author": {
+    "name": "Brandon Lehmann",
+    "email": "brandonlehmann@gmail.com"
+  },
+  "dependencies": {
+    "@gibme/timer": "^1.0.0",
+    "@types/uuid": "^8.3.4",
+    "dotenv": "^16.0.3",
+    "uuid": "^9.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^18.11.9",
+    "@typescript-eslint/eslint-plugin": "^5.42.0",
+    "@typescript-eslint/parser": "^5.42.0",
+    "eslint": "^8.26.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-n": "^15.4.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.4"
+  }
+}