@routr/ctl 2.0.8-alpha.21

package/dist/commands/domains/get.js

@@ -0,0 +1,142 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of Routr.
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/* eslint-disable require-jsdoc */
+const grpc = __importStar(require("@grpc/grpc-js"));
+const core_1 = require("@oclif/core");
+const base_1 = require("../../base");
+const utils_1 = require("../../utils");
+const common_1 = require("@routr/common");
+const errors_1 = require("@oclif/core/lib/errors");
+class GetDomainsCommand extends base_1.BaseCommand {
+    async run() {
+        const { args, flags } = await this.parse(GetDomainsCommand);
+        const showTable = (request) => {
+            const { showHeader, data, self, flags } = request;
+            core_1.CliUx.ux.table(data, {
+                ref: {
+                    minWidth: 7,
+                    extended: true
+                },
+                name: {
+                    minWidth: 7
+                },
+                domainUri: {
+                    header: "URI"
+                },
+                accessControlListRef: {
+                    header: "IP Access Control List",
+                    get: (row) => { var _a; return ((_a = row.accessControlList) === null || _a === void 0 ? void 0 : _a.name) || "None"; },
+                    extended: true
+                },
+                egressPolicies: {
+                    header: "Egress Policies",
+                    get: (row) => row.egressPolicies
+                        .map((p) => `${p.rule}/${p.number.telUrl.split("tel:")[1]}`)
+                        .join(", "),
+                    extended: true
+                },
+                createdAt: {
+                    header: "Created",
+                    get: (row) => new Date(row.createdAt * 1000),
+                    extended: true
+                },
+                updatedAt: {
+                    header: "Updated",
+                    get: (row) => new Date(row.updatedAt * 1000),
+                    extended: true
+                },
+                extended: {
+                    header: "Extended",
+                    get: (row) => row.extended || {},
+                    extended: true
+                },
+                apiVersion: {
+                    header: "API",
+                    extended: true
+                }
+            }, {
+                "no-header": !showHeader,
+                printLine: self.log.bind(self),
+                ...flags // parsed flags
+            });
+        };
+        await (0, utils_1.showPaginatedList)({
+            showTable,
+            args,
+            flags,
+            kind: common_1.CommonConnect.Kind.DOMAIN,
+            self: this
+        });
+    }
+    async catch(error) {
+        // To be handled globally
+        if ("code" in error && error.code === grpc.status.NOT_FOUND) {
+            const { args } = await this.parse(GetDomainsCommand);
+            throw new errors_1.CLIError("the Domain you are looking for does not exist: " + args.ref);
+        }
+        throw new errors_1.CLIError(error.message);
+    }
+}
+exports.default = GetDomainsCommand;
+GetDomainsCommand.description = "Shows a list of paginated Domains or a single Domain if ref is provided";
+GetDomainsCommand.examples = [
+    `<%= config.bin %> <%= command.id %>
+Ref                                  Name         URI            
+ab2b6959-f497-4b14-903b-85a7c464b564 Local Domain sip.local
+`
+];
+GetDomainsCommand.flags = {
+    size: core_1.Flags.integer({
+        char: "s",
+        description: "the number of items to return",
+        default: 50
+    })
+};
+GetDomainsCommand.args = [
+    {
+        name: "ref",
+        required: false,
+        description: "optional reference to a Domain"
+    }
+];

package/dist/commands/domains/update.d.ts

@@ -0,0 +1,11 @@
+import { BaseCommand } from "../../base";
+export default class UpdateCommand extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static args: {
+        name: string;
+        required: boolean;
+        description: string;
+    }[];
+    run(): Promise<void>;
+}

package/dist/commands/domains/update.js

@@ -0,0 +1,163 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of Routr.
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/* eslint-disable require-jsdoc */
+const core_1 = require("@oclif/core");
+const base_1 = require("../../base");
+const errors_1 = require("@oclif/core/lib/errors");
+const validators_1 = require("../../validators");
+const sdk_1 = __importDefault(require("@routr/sdk"));
+// NOTE: Newer versions of inquirer have a bug that causes the following error:
+// (node:75345) [ERR_REQUIRE_ESM] Error Plugin: @routr/ctl [ERR_REQUIRE_ESM]: require() of ES Module
+const inquirer_1 = __importDefault(require("inquirer"));
+class UpdateCommand extends base_1.BaseCommand {
+    async run() {
+        const { args, flags } = await this.parse(UpdateCommand);
+        const { endpoint, insecure } = flags;
+        const api = new sdk_1.default.Domains({ endpoint, insecure });
+        this.log("This utility will help you update an existing Domain.");
+        this.log("Press ^C at any time to quit.");
+        this.warn("Adding Egress Policies will delete existing ones.");
+        const domainFromDB = await api.getDomain(args.ref);
+        // TODO: Fix hardcoded pageSize
+        const acls = await new sdk_1.default.ACL({ endpoint, insecure }).listACLs({
+            pageSize: 25,
+            pageToken: ""
+        });
+        const aclChoices = acls.items.map((acl) => {
+            return {
+                name: acl.name,
+                value: acl.ref
+            };
+        });
+        // TODO: Fix hardcoded pageSize
+        const numbers = await new sdk_1.default.Numbers({ endpoint, insecure }).listNumbers({
+            pageSize: 25,
+            pageToken: ""
+        });
+        const numberChoices = numbers.items.map((number) => {
+            return {
+                name: number.name,
+                value: number.ref
+            };
+        });
+        const group1 = await inquirer_1.default.prompt([
+            {
+                name: "name",
+                message: "Friendly Name",
+                type: "input",
+                default: domainFromDB.name,
+                validate: validators_1.nameValidator
+            },
+            {
+                name: "accessControlListRef",
+                message: "IP Access Control List",
+                type: "list",
+                choices: [{ name: "None", value: undefined }, ...aclChoices],
+                default: domainFromDB.accessControlListRef
+            },
+            {
+                name: "addEgressRule",
+                message: "Add an Egress Rule?",
+                type: "confirm",
+                default: false,
+                when: aclChoices.length > 0
+            }
+        ]);
+        const group2Questions = [
+            {
+                name: "numberRef",
+                message: "Number",
+                type: "list",
+                choices: [{ name: "None", value: undefined }, ...numberChoices]
+            },
+            {
+                name: "rule",
+                message: "Rule",
+                type: "input",
+                default: ".*",
+                when: (answers) => answers.numberRef
+            },
+            {
+                name: "addEgressRule",
+                message: "Add another Egress Rule?",
+                type: "confirm",
+                default: false,
+                when: (answers) => answers.numberRef
+            }
+        ];
+        let addEgressRule = group1.addEgressRule;
+        const egressPolicies = [];
+        // eslint-disable-next-line no-loops/no-loops
+        while (addEgressRule) {
+            const group2 = await inquirer_1.default.prompt(group2Questions);
+            if (group2.numberRef) {
+                egressPolicies.push({
+                    numberRef: group2.numberRef,
+                    rule: group2.rule
+                });
+            }
+            addEgressRule = group2.addEgressRule;
+        }
+        const group3 = await inquirer_1.default.prompt([
+            {
+                name: "confirm",
+                message: "Ready?",
+                type: "confirm"
+            }
+        ]);
+        if (!group3.confirm) {
+            this.warn("Aborted");
+        }
+        else {
+            try {
+                core_1.CliUx.ux.action.start(`Updating Domain ${group1.name}`);
+                const domain = await api.updateDomain({
+                    ref: domainFromDB.ref,
+                    ...group1,
+                    egressPolicies
+                });
+                await core_1.CliUx.ux.wait(1000);
+                core_1.CliUx.ux.action.stop(domain.ref);
+            }
+            catch (e) {
+                core_1.CliUx.ux.action.stop();
+                throw new errors_1.CLIError(e.message);
+            }
+        }
+    }
+}
+exports.default = UpdateCommand;
+UpdateCommand.description = "Updates an existing Domain";
+UpdateCommand.examples = [
+    `<%= config.bin %> <%= command.id %>
+Updating Domain Local... 80181ca6-d4aa-4575-9375-8f72b07d5555
+`
+];
+UpdateCommand.args = [
+    {
+        name: "ref",
+        required: true,
+        description: "reference to an existing Domain"
+    }
+];

package/dist/commands/numbers/create.d.ts

@@ -0,0 +1,6 @@
+import { BaseCommand } from "../../base";
+export default class CreateNumberCommand extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

package/dist/commands/numbers/create.js

@@ -0,0 +1,171 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of Routr.
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/* eslint-disable require-jsdoc */
+const grpc = __importStar(require("@grpc/grpc-js"));
+const core_1 = require("@oclif/core");
+const base_1 = require("../../base");
+const errors_1 = require("@oclif/core/lib/errors");
+const countries_1 = require("../../countries");
+const validators_1 = require("../../validators");
+const utils_1 = require("../../utils");
+const fuzzy_search_1 = __importDefault(require("fuzzy-search"));
+const sdk_1 = __importDefault(require("@routr/sdk"));
+// NOTE: Newer versions of inquirer have a bug that causes the following error:
+// (node:75345) [ERR_REQUIRE_ESM] Error Plugin: @routr/ctl [ERR_REQUIRE_ESM]: require() of ES Module
+const inquirer_1 = __importDefault(require("inquirer"));
+class CreateNumberCommand extends base_1.BaseCommand {
+    async run() {
+        const { flags } = await this.parse(CreateNumberCommand);
+        const { endpoint, insecure } = flags;
+        this.log("This utility will help you create a new Number.");
+        this.log("Press ^C at any time to quit.");
+        const searcher = new fuzzy_search_1.default(countries_1.countries, ["name"], {
+            caseSensitive: false
+        });
+        const trunks = await new sdk_1.default.Trunks({ endpoint, insecure }).listTrunks({
+            pageSize: 25,
+            pageToken: ""
+        });
+        const trunksChoices = trunks.items.map((trunk) => {
+            return {
+                name: trunk.name,
+                value: trunk.ref
+            };
+        });
+        const answers = await inquirer_1.default.prompt([
+            {
+                name: "name",
+                message: "Friendly Name",
+                type: "input",
+                validate: validators_1.nameValidator
+            },
+            {
+                name: "telUrl",
+                message: "Telephony URL",
+                type: "input",
+                validate: validators_1.telUrlValidator
+            },
+            {
+                name: "aorLink",
+                message: "AOR Link",
+                type: "input",
+                validate: validators_1.aorLinkValidator
+            },
+            {
+                name: "trunkRef",
+                message: "Trunk",
+                type: "list",
+                choices: [{ name: "None", value: undefined }, ...trunksChoices]
+            },
+            {
+                name: "city",
+                message: "City",
+                type: "input",
+                validate: (input) => {
+                    if (input.length === 0) {
+                        return "the city is required";
+                    }
+                    return true;
+                }
+            },
+            {
+                type: "autocomplete",
+                name: "countryISOCode",
+                message: "Select a Country",
+                source: (_, input) => searcher.search(input)
+            },
+            {
+                name: "sessionAffinityHeader",
+                message: "Session Affinity Header",
+                type: "input",
+                validate: validators_1.sessionAffinityHeaderValidator
+            },
+            {
+                name: "extraHeaders",
+                message: "Extra Headers",
+                type: "input",
+                validate: validators_1.headersValidator
+            },
+            {
+                name: "confirm",
+                message: "Ready?",
+                type: "confirm"
+            }
+        ]);
+        // Re-write extraHeaders
+        answers.extraHeaders = (0, utils_1.stringToHeaders)(answers.extraHeaders);
+        answers.country = countries_1.countries.find((country) => country.value === answers.countryISOCode).name;
+        if (!answers.confirm) {
+            this.warn("Aborted");
+        }
+        else {
+            try {
+                core_1.CliUx.ux.action.start(`Creating Number ${answers.name}`);
+                const api = new sdk_1.default.Numbers({ endpoint, insecure });
+                const number = await api.createNumber(answers);
+                await core_1.CliUx.ux.wait(1000);
+                core_1.CliUx.ux.action.stop(number.ref);
+            }
+            catch (e) {
+                core_1.CliUx.ux.action.stop();
+                if (e.code === grpc.status.ALREADY_EXISTS) {
+                    throw new errors_1.CLIError("This Number already exist");
+                }
+                else {
+                    throw new errors_1.CLIError(e.message);
+                }
+            }
+        }
+    }
+}
+exports.default = CreateNumberCommand;
+CreateNumberCommand.description = "Creates a new Number";
+CreateNumberCommand.examples = [
+    `<%= config.bin %> <%= command.id %>
+Creating Number (784) 317-8170... a134487f-a668-4509-9ddd-dcbc98175468
+`
+];

package/dist/commands/numbers/delete.d.ts

@@ -0,0 +1,6 @@
+import DeleteCommand from "../../delete";
+export default class DeleteNumberCommand extends DeleteCommand {
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

package/dist/commands/numbers/delete.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of Routr.
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/* eslint-disable require-jsdoc */
+const delete_1 = __importDefault(require("../../delete"));
+const sdk_1 = __importDefault(require("@routr/sdk"));
+class DeleteNumberCommand extends delete_1.default {
+    async run() {
+        const { flags } = await this.parse(DeleteNumberCommand);
+        const { endpoint, insecure } = flags;
+        await super.deleteResource(new sdk_1.default.Numbers({ endpoint, insecure }), "deleteNumber");
+    }
+}
+exports.default = DeleteNumberCommand;
+DeleteNumberCommand.description = "Deletes a Number";
+DeleteNumberCommand.examples = [
+    `<%= config.bin %> <%= command.id %>
+Deleting item 80181ca6-d4aa-4575-9375-8f72b071111... Done
+`
+];

package/dist/commands/numbers/get.d.ts

@@ -0,0 +1,19 @@
+import { BaseCommand } from "../../base";
+import { CommandError } from "@oclif/core/lib/interfaces";
+export default class GetNumbersCommand extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        size: import("@oclif/core/lib/interfaces").OptionFlag<number>;
+    };
+    static args: {
+        name: string;
+        required: boolean;
+        description: string;
+    }[];
+    run(): Promise<void>;
+    catch(error: {
+        code: number;
+        message: string;
+    } | CommandError): Promise<void>;
+}