@routr/ctl 2.0.8-alpha.21

package/dist/delete.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * 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");
+class DeleteCommand extends base_1.BaseCommand {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async deleteResource(API, funcName) {
+        const { args } = await this.parse(DeleteCommand);
+        if (!args.ref) {
+            core_1.CliUx.ux.action.stop();
+            throw new errors_1.CLIError("You must provide a resource ref before continuing");
+        }
+        core_1.CliUx.ux.action.start(`Deleting item ${args.ref}`);
+        await API[funcName](args.ref);
+        await core_1.CliUx.ux.wait(1000);
+        core_1.CliUx.ux.action.stop("Done");
+    }
+    async catch(err) {
+        return super.catch(err);
+    }
+    async finally(err) {
+        return super.finally(err);
+    }
+}
+exports.default = DeleteCommand;
+DeleteCommand.args = [{ name: "ref" }];

package/dist/help.d.ts

@@ -0,0 +1,6 @@
+import { Help } from "@oclif/core";
+export default class MyHelpClass extends Help {
+    protected showRootHelp(): Promise<void>;
+    private showLogo;
+    private get customCommands();
+}

package/dist/help.js

@@ -0,0 +1,84 @@
+"use strict";
+/*
+ * 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 */
+// import { Help } from "@oclif/plugin-help"
+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 });
+const core_1 = require("@oclif/core");
+const figlet = __importStar(require("figlet"));
+class MyHelpClass extends core_1.Help {
+    async showRootHelp() {
+        this.showLogo();
+        this.log(this.formatRoot());
+        this.log();
+        this.log(this.formatCommands(this.customCommands));
+        this.log();
+    }
+    showLogo() {
+        this.log("\x1b[32m");
+        this.log(figlet.textSync("Routr", {
+            horizontalLayout: "default",
+            verticalLayout: "default",
+            width: 60,
+            whitespaceBreak: true
+        }));
+        this.log("\x1b[0m");
+    }
+    get customCommands() {
+        const removeLastDot = (s) => {
+            const str = s.split("\n")[0].trim();
+            return str.endsWith(".") ? str.slice(0, str.length - 1) : s;
+        };
+        const lowercaseFirstLetter = (s) => s.charAt(0).toLowerCase() + s.slice(1);
+        return this.sortedCommands
+            .filter((c) => c.id)
+            .sort((a, b) => (a.id.includes(":") ? 1 : b.id.includes(":") ? -1 : 0))
+            .map((c) => {
+            const { description } = c;
+            return {
+                ...c,
+                description: removeLastDot(lowercaseFirstLetter(description))
+            };
+        });
+    }
+}
+exports.default = MyHelpClass;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from "@oclif/core";

package/dist/index.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+/*
+ * 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.
+ */
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });

package/dist/utils.d.ts

@@ -0,0 +1,22 @@
+import { Command } from "@oclif/core";
+import { CommonConnect as CC } from "@routr/common";
+export declare const capitalize: (s: string) => string;
+export declare const stringToACL: (aclRule: string) => string[];
+export type ShowTable = (request: {
+    showHeader: boolean;
+    data: Record<string, unknown>[];
+    self: Command;
+    flags: Record<string, unknown>;
+}) => void;
+export declare function showPaginatedList(request: {
+    showTable: ShowTable;
+    args: Record<string, string>;
+    flags: Record<string, unknown>;
+    kind: CC.Kind;
+    self: Command;
+}): Promise<void>;
+export declare function toPascalCase(s: string): string;
+export declare function stringToHeaders(headers: string): {
+    name: string;
+    value: string;
+}[];

package/dist/utils.js

@@ -0,0 +1,97 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringToHeaders = exports.toPascalCase = exports.showPaginatedList = exports.stringToACL = exports.capitalize = void 0;
+const common_1 = require("@routr/common");
+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 capitalize = (s) => s.charAt(0).toUpperCase() + s.slice(1);
+exports.capitalize = capitalize;
+const stringToACL = (aclRule) => aclRule.split(",").map((rule) => rule.trim());
+exports.stringToACL = stringToACL;
+function getFunctionMapping(kind) {
+    switch (kind) {
+        case common_1.CommonConnect.Kind.ACL:
+            return { api: "ACL", get: "getACL", list: "listACLs" };
+        case common_1.CommonConnect.Kind.CREDENTIALS:
+            return {
+                api: "Credentials",
+                get: "getCredentials",
+                list: "listCredentials"
+            };
+        case common_1.CommonConnect.Kind.DOMAIN:
+        case common_1.CommonConnect.Kind.AGENT:
+        case common_1.CommonConnect.Kind.PEER:
+        case common_1.CommonConnect.Kind.TRUNK:
+        case common_1.CommonConnect.Kind.NUMBER:
+            return {
+                api: `${(0, exports.capitalize)(kind)}s`,
+                get: `get${(0, exports.capitalize)(kind)}`,
+                list: `list${(0, exports.capitalize)(kind)}s`
+            };
+    }
+}
+async function showPaginatedList(request) {
+    const { showTable, args, flags, kind, self } = request;
+    const api = new sdk_1.default[getFunctionMapping(kind).api]({
+        endpoint: flags.endpoint,
+        insecure: flags.insecure
+    });
+    // Show single item
+    if (args.ref) {
+        const result = [
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            await api[getFunctionMapping(kind).get](args.ref)
+        ];
+        showTable({ showHeader: true, data: result, self, flags });
+        return;
+    }
+    let firstBatch = true;
+    let pageToken = "";
+    const pageSize = flags.size;
+    // eslint-disable-next-line no-loops/no-loops, no-constant-condition
+    while (true) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const result = await api[getFunctionMapping(kind).list]({
+            pageSize: pageSize,
+            pageToken
+        });
+        const list = result.items;
+        pageToken = result.nextPageToken;
+        // Dont ask this if is the first time or empty data
+        if (list.length > 0 && !firstBatch) {
+            const answer = await inquirer_1.default.prompt([
+                { name: "q", message: "More", type: "confirm" }
+            ]);
+            if (!answer.q)
+                break;
+        }
+        if (list.length < 1)
+            break;
+        showTable({ showHeader: firstBatch, data: list, self, flags });
+        firstBatch = false;
+        if (!pageToken)
+            break;
+    }
+}
+exports.showPaginatedList = showPaginatedList;
+function toPascalCase(s) {
+    return s.replace(/(\w)(\w*)/g, function (g0, g1, g2) {
+        return g1.toUpperCase() + g2.toLowerCase();
+    });
+}
+exports.toPascalCase = toPascalCase;
+function stringToHeaders(headers) {
+    return headers
+        .split(",")
+        .filter((header) => header)
+        .map((header) => {
+        const [name, value] = header.split(":");
+        return { name, value };
+    });
+}
+exports.stringToHeaders = stringToHeaders;

package/dist/validators.d.ts

@@ -0,0 +1,16 @@
+export declare function nameValidator(value: string): string | true;
+export declare function aclRuleValidator(value: string): string | true;
+export declare function usernameValidator(value: string): string | true;
+export declare function optionalUsernameValidator(value: string): string | true;
+export declare function sessionAffinityHeaderValidator(value: string): string | true;
+export declare function headersValidator(value: string): string | true;
+export declare function aorValidator(value: string): string | true;
+export declare function aorLinkValidator(value: string): string | true;
+export declare function telUrlValidator(value: string): string | true;
+export declare function inboundUriValidator(value: string): string | true;
+export declare function contactAddrValidator(value: string): string | true;
+export declare function hostValidator(value: string): string | true;
+export declare function portValidator(value: string): string | true;
+export declare function weightValidator(value: string): string | true;
+export declare function priorityValidator(value: string): string | true;
+export declare function domainUriValidator(value: string): string | true;

package/dist/validators.js

@@ -0,0 +1,180 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.domainUriValidator = exports.priorityValidator = exports.weightValidator = exports.portValidator = exports.hostValidator = exports.contactAddrValidator = exports.inboundUriValidator = exports.telUrlValidator = exports.aorLinkValidator = exports.aorValidator = exports.headersValidator = exports.sessionAffinityHeaderValidator = exports.optionalUsernameValidator = exports.usernameValidator = exports.aclRuleValidator = exports.nameValidator = void 0;
+/*
+ * 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 common_1 = require("@routr/common");
+const utils_1 = require("./utils");
+function nameValidator(value) {
+    const hasName = common_1.CommonConnect.hasName(value);
+    const isValidName = common_1.CommonConnect.isValidName(value);
+    if (hasName instanceof Error) {
+        return hasName.message;
+    }
+    else if (isValidName instanceof Error) {
+        return isValidName.message;
+    }
+    return true;
+}
+exports.nameValidator = nameValidator;
+function aclRuleValidator(value) {
+    const hasValidACLRules = common_1.CommonConnect.isValidACLRule((0, utils_1.stringToACL)(value));
+    if ((0, utils_1.stringToACL)(value).length === 0) {
+        return "acl rules are required";
+    }
+    else if (hasValidACLRules instanceof Error) {
+        return hasValidACLRules.message;
+    }
+    return true;
+}
+exports.aclRuleValidator = aclRuleValidator;
+function usernameValidator(value) {
+    const hasUsername = common_1.CommonConnect.hasUsername(value);
+    const isValidUsername = common_1.CommonConnect.isValidUsername(value);
+    if (hasUsername instanceof Error) {
+        return hasUsername.message;
+    }
+    else if (isValidUsername instanceof Error) {
+        return isValidUsername.message;
+    }
+    return true;
+}
+exports.usernameValidator = usernameValidator;
+function optionalUsernameValidator(value) {
+    const isValidUsername = common_1.CommonConnect.isValidUsername(value);
+    if (isValidUsername instanceof Error) {
+        return isValidUsername.message;
+    }
+    return true;
+}
+exports.optionalUsernameValidator = optionalUsernameValidator;
+function sessionAffinityHeaderValidator(value) {
+    const isValidSessionAffinityHeader = common_1.CommonConnect.isValidSessionAffinityHeader(value);
+    if (isValidSessionAffinityHeader instanceof Error) {
+        return isValidSessionAffinityHeader.message;
+    }
+    return true;
+}
+exports.sessionAffinityHeaderValidator = sessionAffinityHeaderValidator;
+function headersValidator(value) {
+    const headers = (0, utils_1.stringToHeaders)(value);
+    const hasValidHeaders = common_1.CommonConnect.hasValidHeaders(headers);
+    if (hasValidHeaders instanceof Error) {
+        return hasValidHeaders.message;
+    }
+    return true;
+}
+exports.headersValidator = headersValidator;
+function aorValidator(value) {
+    const hasAOR = common_1.CommonConnect.hasAOR(value);
+    const isValidAOR = common_1.CommonConnect.isValidAOR(value);
+    if (hasAOR instanceof Error) {
+        return hasAOR.message;
+    }
+    else if (isValidAOR instanceof Error) {
+        return isValidAOR.message;
+    }
+    return true;
+}
+exports.aorValidator = aorValidator;
+function aorLinkValidator(value) {
+    const isValidAORLink = common_1.CommonConnect.isValidAORLink(value);
+    if (isValidAORLink instanceof Error) {
+        return isValidAORLink.message;
+    }
+    return true;
+}
+exports.aorLinkValidator = aorLinkValidator;
+function telUrlValidator(value) {
+    const hasTelUrl = common_1.CommonConnect.hasTelUrl(value);
+    if (hasTelUrl instanceof Error) {
+        return hasTelUrl.message;
+    }
+    return true;
+}
+exports.telUrlValidator = telUrlValidator;
+function inboundUriValidator(value) {
+    const hasInboundUri = common_1.CommonConnect.hasInboundUri(value);
+    const isValidInboundUri = common_1.CommonConnect.isValidInboundUri(value);
+    if (hasInboundUri instanceof Error) {
+        return hasInboundUri.message;
+    }
+    else if (isValidInboundUri instanceof Error) {
+        return isValidInboundUri.message;
+    }
+    return true;
+}
+exports.inboundUriValidator = inboundUriValidator;
+function contactAddrValidator(value) {
+    const isValidContactAddress = common_1.CommonConnect.isValidContactAddress(value);
+    if (isValidContactAddress instanceof Error) {
+        return isValidContactAddress.message;
+    }
+    return true;
+}
+exports.contactAddrValidator = contactAddrValidator;
+function hostValidator(value) {
+    const hasHost = common_1.CommonConnect.hasHost(value);
+    const isValidHost = common_1.CommonConnect.isValidHost(value);
+    if (hasHost instanceof Error) {
+        return hasHost.message;
+    }
+    else if (isValidHost instanceof Error) {
+        return isValidHost.message;
+    }
+    return true;
+}
+exports.hostValidator = hostValidator;
+function portValidator(value) {
+    const isValidPort = common_1.CommonConnect.isValidPort(value);
+    if (isValidPort instanceof Error) {
+        return isValidPort.message;
+    }
+    return true;
+}
+exports.portValidator = portValidator;
+function weightValidator(value) {
+    const isValidWeight = common_1.CommonConnect.isValidWeight(value);
+    if (isValidWeight instanceof Error) {
+        return isValidWeight.message;
+    }
+    return true;
+}
+exports.weightValidator = weightValidator;
+function priorityValidator(value) {
+    const isValidPriority = common_1.CommonConnect.isValidPriority(value);
+    if (isValidPriority instanceof Error) {
+        return isValidPriority.message;
+    }
+    return true;
+}
+exports.priorityValidator = priorityValidator;
+function domainUriValidator(value) {
+    const hasDomainUri = common_1.CommonConnect.hasDomainUri(value);
+    const isValidDomainUri = common_1.CommonConnect.isValidDomainUri(value);
+    if (hasDomainUri instanceof Error) {
+        return hasDomainUri.message;
+    }
+    else if (isValidDomainUri instanceof Error) {
+        return isValidDomainUri.message;
+    }
+    return true;
+}
+exports.domainUriValidator = domainUriValidator;

package/oclif.manifest.json

@@ -0,0 +1 @@
+{"version":"2.0.8-alpha.21","commands":{"acl:create":{"id":"acl:create","description":"Creates a new ACL","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nCreating ACL US Eeast... b148b4b4-6884-4c06-bb7e-bd098f5fe793\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[]},"acl:delete":{"id":"acl:delete","description":"Deletes an Access Control List","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nDeleting item 80181ca6-d4aa-4575-9375-8f72b071111... Done\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[{"name":"ref"}]},"acl:get":{"id":"acl:get","description":"Shows a list of paginated ACLs or a single ACL if a ref is provided","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nRef                                  Name              Deny List Allow List\n9e7a88f0-8390-42f5-a2cb-689583ba9f4f Local Network ACL 0.0.0.0/0 10.0.0.28 \n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"},"size":{"name":"size","type":"option","char":"s","description":"the number of items to return","multiple":false,"default":50}},"args":[{"name":"ref","description":"optional reference to an ACL","required":false}]},"acl:update":{"id":"acl:update","description":"Updates an existing ACL","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nUpdating ACL US East... 80181ca6-d4aa-4575-9375-8f72b07d5555\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[{"name":"ref","description":"reference to an ACL","required":true}]},"agents:create":{"id":"agents:create","description":"Creates a new Agent","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nCreating Agent Jhon Doe... b148b4b4-6884-4c06-bb7e-bd098f5fe793\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[]},"agents:delete":{"id":"agents:delete","description":"Deletes an Agent","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nDeleting item 80181ca6-d4aa-4575-9375-8f72b071111... Done\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[{"name":"ref"}]},"agents:get":{"id":"agents:get","description":"Shows a list of paginated Agents or a single Agent if ref is provided","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nRef                                  Name     Username Domain    Privacy Enabled\nd31f5fb8-e367-42f7-9884-1a7999f53fe8 John Doe jdoe     sip.local PRIVATE Yes\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"},"size":{"name":"size","type":"option","char":"s","description":"The number of items to return","multiple":false,"default":50}},"args":[{"name":"ref","description":"Optional Agents reference","required":false}]},"agents:update":{"id":"agents:update","description":"Updates an existing Agent","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nUpdating Agent John Doe... 80181ca6-d4aa-4575-9375-8f72b07d5555\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[{"name":"ref","description":"reference to an existing Agent","required":true}]},"credentials:create":{"id":"credentials:create","description":"Creates a new set of Credentials","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nCreating Credentials JDoe Access... b148b4b4-6884-4c06-bb7e-bd098f5fe793\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[]},"credentials:delete":{"id":"credentials:delete","description":"Deletes a set of Credentials","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nDeleting item 80181ca6-d4aa-4575-9375-8f72b071111... Done\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[{"name":"ref"}]},"credentials:get":{"id":"credentials:get","description":"Shows a list of paginated Credentials or a single set if ref is provided","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nRef                                  Name       Deny List Allow List\n80181ca6-d4aa-4575-9375-8f72b07d6666 Europe ACL 0.0.0.0/0 10.0.0.25  \n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"},"size":{"name":"size","type":"option","char":"s","description":"the number of items to return","multiple":false,"default":50}},"args":[{"name":"ref","description":"optional reference to a set of Credentials","required":false}]},"credentials:update":{"id":"credentials:update","description":"Updates an existing set of Credentials","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nUpdating Credentials JDoe Credentials... 80181ca6-d4aa-4575-9375-8f72b07d5555\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[{"name":"ref","description":"reference to an existing set of Credentials","required":true}]},"domains:create":{"id":"domains:create","description":"Creates a new set Domain","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nCreating Domain Local Domain... b148b4b4-6884-4c06-bb7e-bd098f5fe793\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[]},"domains:delete":{"id":"domains:delete","description":"Deletes a Domain","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nDeleting item 80181ca6-d4aa-4575-9375-8f72b071111... Done\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[{"name":"ref"}]},"domains:get":{"id":"domains:get","description":"Shows a list of paginated Domains or a single Domain if ref is provided","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nRef                                  Name         URI            \nab2b6959-f497-4b14-903b-85a7c464b564 Local Domain sip.local\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"},"size":{"name":"size","type":"option","char":"s","description":"the number of items to return","multiple":false,"default":50}},"args":[{"name":"ref","description":"optional reference to a Domain","required":false}]},"domains:update":{"id":"domains:update","description":"Updates an existing Domain","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nUpdating Domain Local... 80181ca6-d4aa-4575-9375-8f72b07d5555\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[{"name":"ref","description":"reference to an existing Domain","required":true}]},"numbers:create":{"id":"numbers:create","description":"Creates a new Number","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nCreating Number (784) 317-8170... a134487f-a668-4509-9ddd-dcbc98175468\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[]},"numbers:delete":{"id":"numbers:delete","description":"Deletes a Number","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nDeleting item 80181ca6-d4aa-4575-9375-8f72b071111... Done\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[{"name":"ref"}]},"numbers:get":{"id":"numbers:get","description":"Shows a list of paginated Numbers or a single Number if ref is provided","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nRef                                  Name           Telephony URL      AOR Link           Geo              \na134487f-a668-4509-9ddd-dcbc98175468 (785) 317-8070 +17853178070       sip:1001@sip.local Cameron, USA (US)\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"},"size":{"name":"size","type":"option","char":"s","description":"the number of items to return","multiple":false,"default":50}},"args":[{"name":"ref","description":"optional reference to a Number","required":false}]},"numbers:update":{"id":"numbers:update","description":"Updates an existing set of Credentials","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nUpdating Number (785) 317-8070... 80181ca6-d4aa-4575-9375-8f72b07d5555\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[{"name":"ref","description":"reference to an existing Number","required":true}]},"peers:create":{"id":"peers:create","description":"Creates a new Peer","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nCreating Peer Asterisk Conference... b148b4b4-6884-4c06-bb7e-bd098f5fe793\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[]},"peers:delete":{"id":"peers:delete","description":"Deletes a Peer","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nDeleting item 80181ca6-d4aa-4575-9375-8f72b071111... Done\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[{"name":"ref"}]},"peers:get":{"id":"peers:get","description":"Shows a list of paginated Peers or a single Peer if ref is provided","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nRef                                  Name                Username   AOR                Balancing Algorithm Session Affinity \n6f941c63-880c-419a-a72a-4a107cbaf5c5 Asterisk Conference conference backend:conference ROUND_ROBIN         Yes \n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"},"size":{"name":"size","type":"option","char":"s","description":"the number of items to return","multiple":false,"default":50}},"args":[{"name":"ref","description":"optional reference to a Peer","required":false}]},"peers:update":{"id":"peers:update","description":"Updates an existing Peer","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nUpdating Peer Asterisk Conf... 80181ca6-d4aa-4575-9375-8f72b07d5555\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[{"name":"ref","description":"reference to an existing Peer","required":true}]},"trunks:create":{"id":"trunks:create","description":"Creates a new Trunk","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nCreating Trunk T01... b148b4b4-6884-4c06-bb7e-bd098f5fe793\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[]},"trunks:delete":{"id":"trunks:delete","description":"Deletes a Trunk","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nDeleting item 80181ca6-d4aa-4575-9375-8f72b071111... Done\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[{"name":"ref"}]},"trunks:get":{"id":"trunks:get","description":"Shows a list of paginated Trunks or a single Trunk if ref is provided","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nRef                                  Name   Inbound SIP URI \n8cde8ea9-3c58-4dbe-b2cf-23c4413dd4cc Local  sip.t01.provider.net\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"},"size":{"name":"size","type":"option","char":"s","description":"the number of items to return","multiple":false,"default":50}},"args":[{"name":"ref","description":"optional reference to a Trunk","required":false}]},"trunks:update":{"id":"trunks:update","description":"Updates an existing Trunk","strict":true,"pluginName":"@routr/ctl","pluginAlias":"@routr/ctl","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %>\nUpdating Trunk T01... 80181ca6-d4aa-4575-9375-8f72b07d5555\n"],"flags":{"extended":{"name":"extended","type":"boolean","char":"x","description":"extended output format","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"i","description":"allow insecure connections to the routr server","allowNo":false},"endpoint":{"name":"endpoint","type":"option","char":"e","description":"endpoint to connect to the routr server","multiple":false,"default":"localhost:51907"}},"args":[{"name":"ref","description":"reference to an existing Trunk","required":true}]}}}

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@routr/ctl",
+  "version": "2.0.8-alpha.21",
+  "description": "Routr Command-Line Tool",
+  "author": "Pedro Sanders <psanders@fonoster.com>",
+  "bin": {
+    "rctl": "./bin/run"
+  },
+  "homepage": "https://github.com/fonoster/routr#readme",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "repository": "https://github.com/fonoster/routr",
+  "files": [
+    "/bin",
+    "/dist",
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@oclif/core": "^1.24.0",
+    "@oclif/plugin-autocomplete": "^1.3.10",
+    "@oclif/plugin-help": "^5",
+    "@oclif/plugin-plugins": "^2.1.12",
+    "@oclif/plugin-warn-if-update-available": "^2.0.19",
+    "@routr/common": "^2.0.8-alpha.21",
+    "@routr/sdk": "^2.0.8-alpha.21",
+    "figlet": "^1.5.2",
+    "fuzzy-search": "^3.2.1",
+    "inquirer": "^8.2.5",
+    "inquirer-autocomplete-prompt": "^2.0.0"
+  },
+  "devDependencies": {
+    "@oclif/test": "^2.2.20",
+    "@types/chai": "^4.2.11",
+    "@types/figlet": "^1.5.5",
+    "@types/fuzzy-search": "^2.1.2",
+    "@types/inquirer": "^9.0.3",
+    "@types/inquirer-autocomplete-prompt": "^3.0.0",
+    "@types/mocha": "^8.2.3",
+    "@types/node": "^18.11.9",
+    "chai": "^4",
+    "mocha": "^9.2.2",
+    "oclif": "^3",
+    "shx": "^0.3.3",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.4.1",
+    "typescript": "^4.9.4"
+  },
+  "oclif": {
+    "bin": "rctl",
+    "dirname": "rctl",
+    "commands": "./dist/commands",
+    "helpClass": "./dist/help",
+    "plugins": [
+      "@oclif/plugin-plugins",
+      "@oclif/plugin-warn-if-update-available",
+      "@oclif/plugin-autocomplete"
+    ],
+    "warn-if-update-available": {
+      "timeoutInDays": 1,
+      "message": "<%= config.name %> update available from <%= chalk.greenBright(config.version) %> to <%= chalk.greenBright(latest) %>."
+    },
+    "topicSeparator": " ",
+    "topics": {
+      "hello": {
+        "description": "Say hello to the world and others"
+      }
+    }
+  },
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b --force",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "prepack": "yarn build && oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "bugs": "https://github.com/https://github.com/fonoster/routr/https://github.com/fonoster/routr/issues",
+  "keywords": [
+    "oclif"
+  ],
+  "types": "dist/index.d.ts",
+  "gitHead": "1841d2d8d51bebfdc3af7e81435064e81b176449"
+}