@mqarty/plugin-dev-phone 1.0.0-beta.6

package/dist/serverless/functions/incoming-call-handler.js

@@ -0,0 +1,8 @@
+"use strict";
+// Incoming call from PTSN to the dev phone browser
+exports.handler = function (context, event, callback) {
+    let twiml = new Twilio.twiml.VoiceResponse();
+    const dial = twiml.dial({ answerOnBridge: true });
+    dial.client(context.DEV_PHONE_NAME);
+    return callback(null, twiml);
+};

package/dist/serverless/functions/incoming-message-handler.js

@@ -0,0 +1,41 @@
+"use strict";
+// Incoming Message Handler
+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());
+    });
+};
+exports.handler = function (context, event, callback) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // receive an SMS and put into a conversation
+        const client = context.getTwilioClient({
+            userAgentExtension: [
+                `@mqarty/plugin-dev-phone/${context.DEV_PHONE_VERSION}`,
+                `@mqarty/plugin-dev-phone/serverless`,
+                'serverless-functions'
+            ]
+        });
+        yield client.conversations
+            .services(context.CONVERSATION_SERVICE_SID)
+            .conversations(context.CONVERSATION_SID)
+            .messages
+            .create({
+            author: event.From,
+            body: event.Body,
+            attributes: {
+                fromCity: event.FromCity,
+                fromCountry: event.FromCountry,
+                messageSid: event.MessageSid,
+                numMedia: event.NumMedia
+            }
+        })
+            .then(message => console.log(message));
+        // Answer with an empty response
+        let twiml = new Twilio.twiml.MessagingResponse();
+        return callback(null, twiml);
+    });
+};

package/dist/serverless/functions/outbound-call-handler.js

@@ -0,0 +1,17 @@
+"use strict";
+// Create an outbound PTSN voip call
+// params: from, to, identity
+exports.handler = function (context, event, callback) {
+    let twiml = new Twilio.twiml.VoiceResponse();
+    if (!event.from || !event.to) {
+        return callback('You need to provide From and To params', null);
+    }
+    const dial = twiml.dial({
+        callerId: event.from,
+    });
+    dial.number({
+        statusCallback: `https://${context.DOMAIN_NAME}/sync-call-history`,
+        statusCallbackEvent: 'initiated ringing answered completed'
+    }, event.to);
+    return callback(null, twiml);
+};

package/dist/serverless/functions/sync-call-history.js

@@ -0,0 +1,62 @@
+"use strict";
+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());
+    });
+};
+function updateCallStatusFromEvent(context, callSid, data) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const client = context.getTwilioClient({
+            userAgentExtension: [
+                `@mqarty/plugin-dev-phone/${context.DEV_PHONE_VERSION}`,
+                `@mqarty/plugin-dev-phone/serverless`,
+                'serverless-functions'
+            ]
+        });
+        try {
+            return yield client.sync
+                .services(context.SYNC_SERVICE_SID)
+                .syncMaps(context.CALL_LOG_MAP_NAME)
+                .syncMapItems(callSid)
+                .update({
+                data,
+            });
+        }
+        catch (err) {
+            return yield client.sync
+                .services(context.SYNC_SERVICE_SID)
+                .syncMaps(context.CALL_LOG_MAP_NAME)
+                .syncMapItems
+                .create({
+                key: callSid,
+                data,
+            });
+        }
+    });
+}
+exports.handler = function (context, event, callback) {
+    return __awaiter(this, void 0, void 0, function* () {
+        console.log(`Call: ${event.CallSid} status: ${event.CallStatus}`);
+        try {
+            const data = {
+                Sid: event.CallSid,
+                Status: event.CallStatus,
+                Duration: event.CallDuration,
+                Direction: event.CallDirection,
+                From: event.From,
+                To: event.To,
+                Timestamp: event.Timestamp,
+            };
+            const item = yield updateCallStatusFromEvent(context, event.CallSid, data);
+        }
+        catch (err) {
+            console.error(err);
+            return callback(err);
+        }
+        return callback(null, {});
+    });
+};

package/dist/utils/create-serverless-util.js

@@ -0,0 +1,86 @@
+"use strict";
+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.deployServerless = exports.constants = void 0;
+const serverless_api_1 = require("@twilio-labs/serverless-api");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+exports.constants = {
+    SYNC_CALL_HISTORY: 'sync-call-history',
+    INCOMING_CALL_HANDLER: 'incoming-call-handler',
+    OUTBOUND_CALL_HANDLER: 'outbound-call-handler',
+    INCOMING_MESSAGE_HANDLER: 'incoming-message-handler'
+};
+function deployServerless(context) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const config = {
+            username: context.username,
+            password: context.password,
+            env: context.env,
+            pkgJson: {
+                "dependencies": {
+                    "twilio": "^3.71.3"
+                }
+            },
+            serviceName: context.env.DEV_PHONE_NAME,
+            overrideExistingService: true,
+            functionsEnv: '',
+            functions: [
+                {
+                    name: 'Sync Call History',
+                    path: `/${exports.constants.SYNC_CALL_HISTORY}`,
+                    content: fs_1.default.readFileSync(path_1.default.join(__dirname, `../serverless/functions/${exports.constants.SYNC_CALL_HISTORY}.js`)),
+                    access: 'protected',
+                },
+                {
+                    name: 'Incoming Call Handler',
+                    path: `/${exports.constants.INCOMING_CALL_HANDLER}`,
+                    content: fs_1.default.readFileSync(path_1.default.join(__dirname, `../serverless/functions/${exports.constants.INCOMING_CALL_HANDLER}.js`)),
+                    access: 'protected',
+                },
+                {
+                    name: 'Incoming Message Handler',
+                    path: `/${exports.constants.INCOMING_MESSAGE_HANDLER}`,
+                    content: fs_1.default.readFileSync(path_1.default.join(__dirname, `../serverless/functions/${exports.constants.INCOMING_MESSAGE_HANDLER}.js`)),
+                    access: 'protected',
+                },
+                {
+                    name: 'Outbound Call Handler',
+                    path: `/${exports.constants.OUTBOUND_CALL_HANDLER}`,
+                    content: fs_1.default.readFileSync(path_1.default.join(__dirname, `../serverless/functions/${exports.constants.OUTBOUND_CALL_HANDLER}.js`)),
+                    access: 'protected',
+                },
+            ],
+            assets: []
+        };
+        try {
+            const client = new serverless_api_1.TwilioServerlessApiClient(config);
+            if (context.onUpdate) {
+                const onUpdate = context.onUpdate;
+                //@ts-ignore
+                client.on('status-update', (evt) => {
+                    onUpdate(evt);
+                });
+            }
+            //@ts-ignore
+            const result = yield client.deployProject(config);
+            return result;
+        }
+        catch (err) {
+            console.log(err);
+            throw new Error('Issue deploying functions. Try again later');
+        }
+    });
+}
+exports.deployServerless = deployServerless;

package/dist/utils/helpers.js

@@ -0,0 +1,28 @@
+"use strict";
+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.getAvailablePort = exports.isValidPort = void 0;
+const get_port_1 = __importDefault(require("get-port"));
+function isValidPort(port) {
+    const portRegex = /^((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0-9]{1,4}))$/gi;
+    return portRegex.test(port);
+}
+exports.isValidPort = isValidPort;
+function getAvailablePort() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const availablePort = yield (0, get_port_1.default)({ port: [1337, 3000, 3001, 8000, 8080] });
+        return availablePort;
+    });
+}
+exports.getAvailablePort = getAvailablePort;

package/dist/utils/phone-number-utils.js

@@ -0,0 +1,66 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removePhoneWebhooks = exports.updatePhoneWebhooks = exports.isVoiceUrlSet = exports.isSmsUrlSet = void 0;
+function isSmsUrlSet(smsUrl) {
+    // consider it "unset" if it is blank, or at the default value
+    return smsUrl && smsUrl !== "" && smsUrl !== 'https://demo.twilio.com/welcome/sms/reply';
+}
+exports.isSmsUrlSet = isSmsUrlSet;
+function isVoiceUrlSet(voiceUrl) {
+    // consider it "unset" if it is blank, or at the default value
+    return voiceUrl && voiceUrl !== "" && voiceUrl !== 'https://demo.twilio.com/welcome/voice/';
+}
+exports.isVoiceUrlSet = isVoiceUrlSet;
+function updatePhoneWebhooks(selectedNumber, incomingPhoneNumbersApi, properties) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!selectedNumber)
+            return;
+        console.log(`💻 Updating Voice and SMS webhooks for ${selectedNumber.phoneNumber}...`);
+        selectedNumber.voiceUrl = properties.voiceUrl;
+        selectedNumber.smsUrl = properties.smsUrl;
+        selectedNumber.statusCallback = properties.statusCallback;
+        try {
+            const updated = yield incomingPhoneNumbersApi(selectedNumber.sid)
+                .update({
+                voiceUrl: properties.voiceUrl,
+                smsUrl: properties.smsUrl,
+                statusCallback: properties.statusCallback,
+            });
+            console.log('✅ Webhooks updated\n');
+            return updated;
+        }
+        catch (err) {
+            console.error(err);
+        }
+    });
+}
+exports.updatePhoneWebhooks = updatePhoneWebhooks;
+function removePhoneWebhooks(activeNumber, incomingPhoneNumbersApi) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!activeNumber)
+            return;
+        console.log(`🚮 Removing incoming Voice and SMS webhooks for ${activeNumber.phoneNumber}`);
+        try {
+            const updated = yield incomingPhoneNumbersApi(activeNumber.sid)
+                .update({
+                voiceUrl: "",
+                smsUrl: "",
+                statusCallback: "",
+            });
+            return updated;
+        }
+        catch (err) {
+            console.error(err);
+        }
+    });
+}
+exports.removePhoneWebhooks = removePhoneWebhooks;

package/oclif.manifest.json

@@ -0,0 +1,229 @@
+{
+  "commands": {
+    "dev-phone": {
+      "aliases": [],
+      "args": {},
+      "description": "Dev Phone local express server",
+      "flags": {
+        "cli-log-level": {
+          "char": "l",
+          "description": "Level of logging messages.",
+          "helpLabel": "-l",
+          "name": "cli-log-level",
+          "default": "info",
+          "hasDynamicHelp": false,
+          "helpValue": "(debug|info|warn|error|none)",
+          "multiple": false,
+          "options": [
+            "debug",
+            "info",
+            "warn",
+            "error",
+            "none"
+          ],
+          "type": "option"
+        },
+        "cli-output-format": {
+          "char": "o",
+          "description": "Format of command output.",
+          "helpLabel": "-o",
+          "name": "cli-output-format",
+          "default": "columns",
+          "hasDynamicHelp": false,
+          "helpValue": "(columns|json|tsv|none)",
+          "multiple": false,
+          "options": [
+            "columns",
+            "json",
+            "tsv",
+            "none"
+          ],
+          "type": "option"
+        },
+        "silent": {
+          "description": "Suppress  output and logs. This is a shorthand for \"-l none -o none\".",
+          "name": "silent",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "profile": {
+          "char": "p",
+          "description": "Shorthand identifier for your profile.",
+          "name": "profile",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "phone-number": {
+          "description": "Optional. Associates the Dev Phone with a phone number. Takes a number from the active profile on the Twilio CLI as the parameter.",
+          "name": "phone-number",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "force": {
+          "char": "f",
+          "dependsOn": [
+            "phone-number"
+          ],
+          "description": "Optional. Forces an overwrite of the phone number configuration.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "headless": {
+          "description": "Optional. Prevents the UI from automatically opening in the browser.",
+          "name": "headless",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "clear": {
+          "description": "Optional. Remove all dev-phone resources from your account before starting the dev-phone.",
+          "name": "clear",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "port": {
+          "description": "Optional. Configures the port of the Dev Phone UI. Takes a valid port as a parameter.",
+          "name": "port",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "dev-phone",
+      "pluginAlias": "@mqarty/plugin-dev-phone",
+      "pluginName": "@mqarty/plugin-dev-phone",
+      "pluginType": "core",
+      "strict": true,
+      "parse": true,
+      "parserOptions": {},
+      "accountSidFlag": {
+        "account-sid": {
+          "description": "Access resources for the specified account.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "limitFlags": {
+        "limit": {
+          "description": "The maximum number of resources to return. Use '--no-limit' to disable.",
+          "default": 50,
+          "exclusive": [
+            "no-limit"
+          ],
+          "input": [],
+          "multiple": false,
+          "type": "option"
+        },
+        "no-limit": {
+          "default": false,
+          "hidden": true,
+          "exclusive": [
+            "limit"
+          ],
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "noHeader": {
+        "no-header": {
+          "description": "Skip including of headers while listing the data.",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "PropertyFlags": {
+        "phone-number": {
+          "description": "Optional. Associates the Dev Phone with a phone number. Takes a number from the active profile on the Twilio CLI as the parameter.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
+        },
+        "force": {
+          "char": "f",
+          "description": "Optional. Forces an overwrite of the phone number configuration.",
+          "dependsOn": [
+            "phone-number"
+          ],
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "headless": {
+          "description": "Optional. Prevents the UI from automatically opening in the browser.",
+          "default": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "clear": {
+          "description": "Optional. Remove all dev-phone resources from your account before starting the dev-phone.",
+          "default": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "port": {
+          "description": "Optional. Configures the port of the Dev Phone UI. Takes a valid port as a parameter.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
+        },
+        "cli-log-level": {
+          "helpValue": "(debug|info|warn|error|none)",
+          "char": "l",
+          "helpLabel": "-l",
+          "default": "info",
+          "options": [
+            "debug",
+            "info",
+            "warn",
+            "error",
+            "none"
+          ],
+          "description": "Level of logging messages.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
+        },
+        "cli-output-format": {
+          "helpValue": "(columns|json|tsv|none)",
+          "char": "o",
+          "helpLabel": "-o",
+          "default": "columns",
+          "options": [
+            "columns",
+            "json",
+            "tsv",
+            "none"
+          ],
+          "description": "Format of command output.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
+        },
+        "silent": {
+          "description": "Suppress  output and logs. This is a shorthand for \"-l none -o none\".",
+          "default": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "profile": {
+          "char": "p",
+          "description": "Shorthand identifier for your profile.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "dev-phone.js"
+      ]
+    }
+  },
+  "version": "1.0.0-beta.6"
+}

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@mqarty/plugin-dev-phone",
+  "description": "Twilio Dev Phone",
+  "version": "1.0.0-beta.6",
+  "author": "mqarty",
+  "bugs": {
+    "url": "https://github.com/mqarty/dev-phone/issues"
+  },
+  "dependencies": {
+    "@inquirer/confirm": "^5.1.8",
+    "@oclif/core": "^1.13.6",
+    "@mqarty/dev-phone-ui": "^1.0.0-beta.3",
+    "@twilio-labs/serverless-api": "^5.4.0",
+    "@twilio/cli-core": "^7.0.0",
+    "express": "^4.17.1",
+    "get-port": "^5.1.1",
+    "open": "^8.4.0"
+  },
+  "devDependencies": {
+    "@oclif/test": "^1.2.5",
+    "@twilio/cli-test": "^2.1.0",
+    "@types/express": "^4.17.13",
+    "@types/open": "^6.2.1",
+    "chai": "^4.2.0",
+    "eslint": "^8.3.0",
+    "eslint-config-oclif": "^3.1.0",
+    "eslint-plugin-mocha": "^9.0.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-unicorn": "^39.0.0",
+    "globby": "^11.0.0",
+    "mocha": "^9.1.3",
+    "nyc": "^15.0.1",
+    "typescript": "^4.6.2"
+  },
+  "engines": {
+    "node": ">=10.0.0"
+  },
+  "files": [
+    "/oclif.manifest.json",
+    "/dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/mqarty/dev-phone/packages/dev-phone",
+  "keywords": [
+    "oclif-plugin"
+  ],
+  "license": "MIT",
+  "oclif": {
+    "name": "dev-phone",
+    "commands": "./dist/commands",
+    "bin": "twilio",
+    "repositoryPrefix": "<%- repo %>/blob/<%- version %>/<%- commandPath %>",
+    "devPlugins": [
+      "@oclif/plugin-help"
+    ],
+    "topics": {
+      "dev-phone": {
+        "description": "Twilio Dev Phone plugin"
+      }
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mqarty/dev-phone.git"
+  },
+  "scripts": {
+    "build": "tsc",
+    "postpack": "rm -f oclif.manifest.json",
+    "XX-posttest": "eslint --ignore-path .gitignore . && npm audit",
+    "prepack": "npx oclif manifest && npx oclif readme",
+    "test": "nyc --check-coverage --lines 90 --reporter=html --reporter=text mocha --forbid-only \"test/**/*.test.js\"",
+    "version": "npx oclif readme && git add README.md"
+  },
+  "directories": {
+    "test": "test"
+  }
+}