@routr/ctl 2.0.8-alpha.24 → 2.0.8-alpha.27

package/dist/commands/acl/get.js

@@ -68,25 +68,6 @@ class GetCommand extends base_1.BaseCommand {
                 allow: {
                     header: "Allow CIDR Networks",
                     get: (row) => row.allow.join(", ")
-                },
-                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,
@@ -124,6 +105,10 @@ GetCommand.flags = {
         char: "s",
         description: "the number of items to return",
         default: 50
+    }),
+    extended: core_1.Flags.boolean({
+        char: "x",
+        description: "extended output format"
     })
 };
 GetCommand.args = [

package/dist/commands/agents/create.js

@@ -51,7 +51,6 @@ const base_1 = require("../../base");
 const errors_1 = require("@oclif/core/lib/errors");
 const common_1 = require("@routr/common");
 const validators_1 = require("../../validators");
-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
@@ -86,9 +85,6 @@ class CreateAgentCommand extends base_1.BaseCommand {
             const credentialsList = credentials.items.map((credential) => {
                 return { name: credential.name, value: credential.ref };
             });
-            const searcher = new fuzzy_search_1.default(domainsList, ["name", "value", "description"], {
-                caseSensitive: false
-            });
             this.log("This utility will help you create a new Agent.");
             this.log("Press ^C at any time to quit.");
             const answers = await inquirer_1.default.prompt([
@@ -99,11 +95,10 @@ class CreateAgentCommand extends base_1.BaseCommand {
                     validate: validators_1.nameValidator
                 },
                 {
-                    type: "autocomplete",
                     name: "domainRef",
                     message: "Select a Domain",
-                    source: (_, input) => searcher.search(input),
-                    when: () => domains.items.length > 0
+                    choices: [{ name: "None", value: undefined }, ...domainsList],
+                    type: "list"
                 },
                 {
                     name: "username",
@@ -135,7 +130,7 @@ class CreateAgentCommand extends base_1.BaseCommand {
                 },
                 {
                     name: "enabled",
-                    message: "Enabled",
+                    message: "Enabled?",
                     type: "confirm",
                     default: true
                 },

package/dist/commands/agents/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/agents/describe.js

@@ -0,0 +1,72 @@
+"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 utils_1 = require("../../utils");
+const sdk_1 = __importDefault(require("@routr/sdk"));
+const moment_1 = __importDefault(require("moment"));
+class DescribeCommand extends base_1.BaseCommand {
+    async run() {
+        var _a;
+        const { args, flags } = await this.parse(DescribeCommand);
+        const { endpoint, insecure } = flags;
+        const api = new sdk_1.default.Agents({ endpoint, insecure });
+        try {
+            const agent = await api.getAgent(args.ref);
+            const jsonObj = {
+                Ref: agent.ref,
+                APIVersion: agent.apiVersion,
+                Name: agent.name,
+                Username: agent.username,
+                Domain: ((_a = agent.domain) === null || _a === void 0 ? void 0 : _a.domainUri) || "None",
+                Privacy: (0, utils_1.capitalize)(agent.privacy),
+                Credentials: agent.credentials
+                    ? {
+                        Ref: agent.credentials.ref,
+                        Username: agent.credentials.username
+                    }
+                    : "None",
+                Enabled: agent.enabled ? "Yes" : "No",
+                Extended: agent.extended,
+                Created: (0, moment_1.default)(new Date(agent.createdAt * 1000)).toISOString(),
+                Updated: (0, moment_1.default)(new Date(agent.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 = "shows details of an Agent";
+DescribeCommand.args = [
+    {
+        name: "ref",
+        required: false,
+        description: "reference to the Agent"
+    }
+];

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

@@ -5,6 +5,7 @@ export default class GetAgentsCommand 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/agents/get.js

@@ -72,35 +72,9 @@ class GetAgentsCommand extends base_1.BaseCommand {
                     header: "Privacy",
                     get: (row) => (0, utils_1.capitalize)(row.privacy)
                 },
-                credentials: {
-                    header: "Credentials Name",
-                    get: (row) => row.credentials
-                        ? `${row.credentials.name} (${row.credentials.username})`
-                        : "None",
-                    extended: true
-                },
                 enabled: {
                     header: "Enabled",
                     get: (row) => (row.enabled ? "Yes" : "No")
-                },
-                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,
@@ -138,6 +112,10 @@ GetAgentsCommand.flags = {
         char: "s",
         description: "The number of items to return",
         default: 50
+    }),
+    extended: core_1.Flags.boolean({
+        char: "x",
+        description: "extended output format"
     })
 };
 GetAgentsCommand.args = [

package/dist/commands/agents/update.js

@@ -26,12 +26,11 @@ const core_1 = require("@oclif/core");
 const base_1 = require("../../base");
 const errors_1 = require("@oclif/core/lib/errors");
 const common_1 = require("@routr/common");
-const fuzzy_search_1 = __importDefault(require("fuzzy-search"));
+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"));
-const validators_1 = require("../../validators");
 class UpdateCommand extends base_1.BaseCommand {
     async run() {
         var _a, _b;
@@ -59,9 +58,6 @@ class UpdateCommand extends base_1.BaseCommand {
             const credentialsList = (_b = credentials.items) === null || _b === void 0 ? void 0 : _b.map((credential) => {
                 return { name: credential.name, value: credential.ref };
             });
-            const searcher = new fuzzy_search_1.default(domainsList, ["name", "value", "description"], {
-                caseSensitive: false
-            });
             this.log("This utility will help you update an existing Agent.");
             this.log("Press ^C at any time to quit.");
             const answers = await inquirer_1.default.prompt([
@@ -73,11 +69,10 @@ class UpdateCommand extends base_1.BaseCommand {
                     validate: validators_1.nameValidator
                 },
                 {
-                    type: "autocomplete",
                     name: "domainRef",
                     message: "Select a Domain",
-                    source: (_, input) => searcher.search(input),
-                    when: () => domains.items.length > 0
+                    choices: [{ name: "None", value: undefined }, ...domainsList],
+                    type: "list"
                 },
                 {
                     name: "credentialsRef",
@@ -104,7 +99,7 @@ class UpdateCommand extends base_1.BaseCommand {
                 },
                 {
                     name: "enabled",
-                    message: "Enabled",
+                    message: "Enabled?",
                     type: "confirm",
                     default: agentFromDB.enabled
                 },

package/dist/commands/credentials/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/credentials/describe.js

@@ -0,0 +1,61 @@
+"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.Credentials({ endpoint, insecure });
+        try {
+            const credentials = await api.getCredentials(args.ref);
+            const jsonObj = {
+                Ref: credentials.ref,
+                APIVersion: credentials.apiVersion,
+                Name: credentials.name,
+                Username: credentials.username,
+                Extended: credentials.extended,
+                Created: (0, moment_1.default)(new Date(credentials.createdAt * 1000)).toISOString(),
+                Updated: (0, moment_1.default)(new Date(credentials.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 = "shows details for a set of Credentials";
+DescribeCommand.args = [
+    {
+        name: "ref",
+        required: false,
+        description: "reference to the set of Credentials"
+    }
+];

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

@@ -5,6 +5,7 @@ export default class GetCommand 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/credentials/get.js

@@ -42,12 +42,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * 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");
-const grpc = __importStar(require("@grpc/grpc-js"));
 class GetCommand extends base_1.BaseCommand {
     async run() {
         const { args, flags } = await this.parse(GetCommand);
@@ -63,25 +63,6 @@ class GetCommand extends base_1.BaseCommand {
                 },
                 username: {
                     header: "Username"
-                },
-                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,
@@ -119,6 +100,10 @@ GetCommand.flags = {
         char: "s",
         description: "the number of items to return",
         default: 50
+    }),
+    extended: core_1.Flags.boolean({
+        char: "x",
+        description: "extended output format"
     })
 };
 GetCommand.args = [

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/numbers/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/numbers/describe.js

@@ -0,0 +1,72 @@
+"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.Numbers({ endpoint, insecure });
+        try {
+            const number = await api.getNumber(args.ref);
+            const jsonObj = {
+                Ref: number.ref,
+                APIVersion: number.apiVersion,
+                Name: number.name,
+                "Tel URL": number.telUrl,
+                "AOR Link": number.aorLink,
+                "Trunk Ref": number.trunkRef,
+                "Geo Info": {
+                    City: number.city,
+                    "Country Name": number.country,
+                    "Country Code": number.countryIsoCode
+                },
+                "Session Affinity Header": number.sessionAffinityHeader,
+                "Extra Headers": number.extraHeaders
+                    ? number.extraHeaders.join(",")
+                    : "None",
+                Extended: number.extended,
+                Created: (0, moment_1.default)(new Date(number.createdAt * 1000)).toISOString(),
+                Updated: (0, moment_1.default)(new Date(number.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 = "shows details for a Number";
+DescribeCommand.args = [
+    {
+        name: "ref",
+        required: false,
+        description: "reference to the Number"
+    }
+];

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

@@ -5,6 +5,7 @@ export default class GetNumbersCommand 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;