@routr/ctl 2.0.8-alpha.23 → 2.0.8-alpha.25

package/dist/commands/domains/create.js

@@ -58,105 +58,105 @@ class CreateCommand extends base_1.BaseCommand {
     async run() {
         const { flags } = await this.parse(CreateCommand);
         const { endpoint, insecure } = flags;
-        this.log("This utility will help you create a new Domain.");
-        this.log("Press ^C at any time to quit.");
-        // 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",
-                validate: validators_1.nameValidator
-            },
-            {
-                name: "domainUri",
-                message: "SIP URI",
-                type: "input",
-                validate: validators_1.domainUriValidator
-            },
-            {
-                name: "accessControlListRef",
-                message: "IP Access Control List",
-                type: "list",
-                choices: [{ name: "None", value: undefined }, ...aclChoices]
-            },
-            {
-                name: "addEgressRule",
-                message: "Add an Egress Rule?",
-                type: "confirm",
-                default: false,
-                when: numberChoices.length > 0
-            }
-        ]);
-        const group2Questions = [
-            {
-                name: "numberRef",
-                message: "Number",
-                type: "list",
-                choices: [{ name: "None", value: undefined }, ...numberChoices],
-                when: numberChoices.length > 0
-            },
-            {
-                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
-                });
+        try {
+            // 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
+                };
+            });
+            this.log("This utility will help you create a new Domain.");
+            this.log("Press ^C at any time to quit.");
+            const group1 = await inquirer_1.default.prompt([
+                {
+                    name: "name",
+                    message: "Friendly Name",
+                    type: "input",
+                    validate: validators_1.nameValidator
+                },
+                {
+                    name: "domainUri",
+                    message: "SIP URI",
+                    type: "input",
+                    validate: validators_1.domainUriValidator
+                },
+                {
+                    name: "accessControlListRef",
+                    message: "IP Access Control List",
+                    type: "list",
+                    choices: [{ name: "None", value: undefined }, ...aclChoices]
+                },
+                {
+                    name: "addEgressRule",
+                    message: "Add an Egress Rule?",
+                    type: "confirm",
+                    default: false,
+                    when: numberChoices.length > 0
+                }
+            ]);
+            const group2Questions = [
+                {
+                    name: "numberRef",
+                    message: "Number",
+                    type: "list",
+                    choices: [{ name: "None", value: undefined }, ...numberChoices],
+                    when: numberChoices.length > 0
+                },
+                {
+                    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;
             }
-            addEgressRule = group2.addEgressRule;
-        }
-        const group3 = await inquirer_1.default.prompt([
-            {
-                name: "confirm",
-                message: "Ready?",
-                type: "confirm"
+            const group3 = await inquirer_1.default.prompt([
+                {
+                    name: "confirm",
+                    message: "Ready?",
+                    type: "confirm"
+                }
+            ]);
+            if (!group3.confirm) {
+                this.warn("Aborted");
             }
-        ]);
-        if (!group3.confirm) {
-            this.warn("Aborted");
-        }
-        else {
-            try {
+            else {
                 core_1.CliUx.ux.action.start(`Creating Domain ${group1.name}`);
                 const api = new sdk_1.default.Domains({ endpoint, insecure });
                 const domains = await api.createDomain({
@@ -166,14 +166,14 @@ class CreateCommand extends base_1.BaseCommand {
                 await core_1.CliUx.ux.wait(1000);
                 core_1.CliUx.ux.action.stop(domains.ref);
             }
-            catch (e) {
-                core_1.CliUx.ux.action.stop();
-                if (e.code === grpc.status.ALREADY_EXISTS) {
-                    throw new errors_1.CLIError("This Domain already exist");
-                }
-                else {
-                    throw new errors_1.CLIError(e.message);
-                }
+        }
+        catch (e) {
+            core_1.CliUx.ux.action.stop();
+            if (e.code === grpc.status.ALREADY_EXISTS) {
+                throw new errors_1.CLIError("This Domain already exist");
+            }
+            else {
+                throw new errors_1.CLIError(e.message);
             }
         }
     }

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

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

package/dist/commands/domains/describe.js

@@ -0,0 +1,78 @@
+"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 base_1 = require("../../base");
+const errors_1 = require("@oclif/core/lib/errors");
+const prettyjson_1 = require("prettyjson");
+const sdk_1 = __importDefault(require("@routr/sdk"));
+const moment_1 = __importDefault(require("moment"));
+class DescribeCommand extends base_1.BaseCommand {
+    async run() {
+        const { args, flags } = await this.parse(DescribeCommand);
+        const { endpoint, insecure } = flags;
+        const api = new sdk_1.default.Domains({ endpoint, insecure });
+        try {
+            const domain = await api.getDomain(args.ref);
+            const jsonObj = {
+                Ref: domain.ref,
+                APIVersion: domain.apiVersion,
+                Name: domain.name,
+                URI: domain.domainUri,
+                "Access Control List": domain.accessControlList
+                    ? {
+                        Ref: domain.accessControlList.ref,
+                        Name: domain.accessControlList.name,
+                        Deny: domain.accessControlList.deny.join(","),
+                        Allow: domain.accessControlList.allow.join(",")
+                    }
+                    : "None",
+                // TODO: Extend to show the Tel Url
+                "Egress Policies": domain.egressPolicies.length > 0
+                    ? domain.egressPolicies.map((p) => {
+                        return {
+                            Rule: p.rule,
+                            "Number Ref": p.numberRef
+                        };
+                    })
+                    : "None",
+                Extended: domain.extended,
+                Created: (0, moment_1.default)(new Date(domain.createdAt * 1000)).toISOString(),
+                Updated: (0, moment_1.default)(new Date(domain.updatedAt * 1000)).toISOString()
+            };
+            this.log((0, prettyjson_1.render)(jsonObj, { noColor: true }));
+        }
+        catch (e) {
+            throw new errors_1.CLIError(e.message);
+        }
+    }
+}
+exports.default = DescribeCommand;
+DescribeCommand.description = "show details of a Domain";
+DescribeCommand.args = [
+    {
+        name: "ref",
+        required: false,
+        description: "reference to the Domain"
+    }
+];

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

@@ -5,6 +5,7 @@ export default class GetDomainsCommand extends BaseCommand {
     static examples: string[];
     static flags: {
         size: import("@oclif/core/lib/interfaces").OptionFlag<number>;
+        extended: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
     static args: {
         name: string;

package/dist/commands/domains/get.js

@@ -64,36 +64,12 @@ class GetDomainsCommand extends base_1.BaseCommand {
                 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,
@@ -131,6 +107,10 @@ GetDomainsCommand.flags = {
         char: "s",
         description: "the number of items to return",
         default: 50
+    }),
+    extended: core_1.Flags.boolean({
+        char: "x",
+        description: "extended output format"
     })
 };
 GetDomainsCommand.args = [

package/dist/commands/domains/update.js

@@ -34,103 +34,103 @@ 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
+        try {
+            const api = new sdk_1.default.Domains({ endpoint, insecure });
+            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
+                };
+            });
+            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 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 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
+            const group3 = await inquirer_1.default.prompt([
+                {
+                    name: "confirm",
+                    message: "Ready?",
+                    type: "confirm"
+                }
+            ]);
+            if (!group3.confirm) {
+                this.warn("Aborted");
             }
-        ];
-        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 {
+            else {
                 core_1.CliUx.ux.action.start(`Updating Domain ${group1.name}`);
                 const domain = await api.updateDomain({
                     ref: domainFromDB.ref,
@@ -140,10 +140,10 @@ class UpdateCommand extends base_1.BaseCommand {
                 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);
-            }
+        }
+        catch (e) {
+            core_1.CliUx.ux.action.stop();
+            throw new errors_1.CLIError(e.message);
         }
     }
 }