@routr/ctl 2.0.8-alpha.21

package/dist/commands/peers/get.js

@@ -0,0 +1,159 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of Routr.
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/* eslint-disable require-jsdoc */
+const 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);
+        const showTable = (request) => {
+            const { showHeader, data, self, flags } = request;
+            core_1.CliUx.ux.table(data, {
+                ref: {
+                    minWidth: 7,
+                    extended: true
+                },
+                name: {
+                    minWidth: 7
+                },
+                username: {
+                    header: "Username"
+                },
+                aor: {
+                    header: "AOR"
+                },
+                balancingAlgorithm: {
+                    header: "Balancing Algorithm"
+                },
+                withSessionAffinity: {
+                    header: "Session Affinity",
+                    get: (row) => row.withSessionAffinity ? "Yes" : "No"
+                },
+                contactAddr: {
+                    header: "Contact Address",
+                    extended: true
+                },
+                enabled: {
+                    header: "Enabled",
+                    get: (row) => (row.enabled ? "Yes" : "No"),
+                    extended: true
+                },
+                accessControlList: {
+                    header: "IP Access Control List",
+                    get: (row) => { var _a; return ((_a = row.accessControlList) === null || _a === void 0 ? void 0 : _a.name) || "None"; },
+                    extended: true
+                },
+                credentials: {
+                    header: "Credentials Name",
+                    get: (row) => { var _a; return ((_a = row.credentials) === null || _a === void 0 ? void 0 : _a.name) || "None"; },
+                    extended: true
+                },
+                createdAt: {
+                    header: "Created",
+                    get: (row) => new Date(row.createdAt * 1000),
+                    extended: true
+                },
+                updatedAt: {
+                    header: "Updated",
+                    get: (row) => new Date(row.updatedAt * 1000),
+                    extended: true
+                },
+                extended: {
+                    header: "Extended",
+                    get: (row) => row.extended || {},
+                    extended: true
+                },
+                apiVersion: {
+                    header: "API",
+                    extended: true
+                }
+            }, {
+                "no-header": !showHeader,
+                printLine: self.log.bind(self),
+                ...flags // parsed flags
+            });
+        };
+        await (0, utils_1.showPaginatedList)({
+            showTable,
+            args,
+            flags,
+            kind: common_1.CommonConnect.Kind.PEER,
+            self: this
+        });
+    }
+    async catch(error) {
+        // To be handled globally
+        if ("code" in error && error.code === grpc.status.NOT_FOUND) {
+            const { args } = await this.parse(GetCommand);
+            throw new errors_1.CLIError("the Peer you are looking for does not exist: " + args.ref);
+        }
+        throw new errors_1.CLIError(error.message);
+    }
+}
+exports.default = GetCommand;
+GetCommand.description = "Shows a list of paginated Peers or a single Peer if ref is provided";
+GetCommand.examples = [
+    `<%= config.bin %> <%= command.id %>
+Ref                                  Name                Username   AOR                Balancing Algorithm Session Affinity 
+6f941c63-880c-419a-a72a-4a107cbaf5c5 Asterisk Conference conference backend:conference ROUND_ROBIN         Yes 
+`
+];
+GetCommand.flags = {
+    size: core_1.Flags.integer({
+        char: "s",
+        description: "the number of items to return",
+        default: 50
+    })
+};
+GetCommand.args = [
+    {
+        name: "ref",
+        required: false,
+        description: "optional reference to a Peer"
+    }
+];

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

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

package/dist/commands/peers/update.js

@@ -0,0 +1,156 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of Routr.
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/* eslint-disable require-jsdoc */
+const core_1 = require("@oclif/core");
+const base_1 = require("../../base");
+const errors_1 = require("@oclif/core/lib/errors");
+const common_1 = require("@routr/common");
+const validators_1 = require("../../validators");
+const sdk_1 = __importDefault(require("@routr/sdk"));
+// NOTE: Newer versions of inquirer have a bug that causes the following error:
+// (node:75345) [ERR_REQUIRE_ESM] Error Plugin: @routr/ctl [ERR_REQUIRE_ESM]: require() of ES Module
+const inquirer_1 = __importDefault(require("inquirer"));
+class UpdatePeerCommand extends base_1.BaseCommand {
+    async run() {
+        var _a, _b;
+        const { args, flags } = await this.parse(UpdatePeerCommand);
+        const { endpoint, insecure } = flags;
+        const api = new sdk_1.default.Peers({ endpoint, insecure });
+        this.log("This utility will help you update an existing Peer.");
+        this.log("Press ^C at any time to quit.");
+        const peerFromDB = await api.getPeer(args.ref);
+        // TODO: Fix hardcoded pageSize
+        const acls = await new sdk_1.default.ACL({ endpoint, insecure }).listACLs({
+            pageSize: 25,
+            pageToken: ""
+        });
+        // TODO: Fix hardcoded pageSize
+        const credentials = await new sdk_1.default.Credentials({
+            endpoint,
+            insecure
+        }).listCredentials({
+            pageSize: 25,
+            pageToken: ""
+        });
+        const aclList = ((_a = acls.items) === null || _a === void 0 ? void 0 : _a.map((acl) => {
+            return { name: acl.name, value: acl.ref };
+        })) || [];
+        const credentialsList = ((_b = credentials.items) === null || _b === void 0 ? void 0 : _b.map((credential) => {
+            return { name: credential.name, value: credential.ref };
+        })) || [];
+        const answers = await inquirer_1.default.prompt([
+            {
+                name: "name",
+                message: "Friendly Name",
+                type: "input",
+                default: peerFromDB.name,
+                validate: validators_1.nameValidator
+            },
+            {
+                name: "aor",
+                message: "Adress of Record",
+                type: "input",
+                default: peerFromDB.aor,
+                validate: validators_1.aorValidator
+            },
+            {
+                name: "contactAddr",
+                message: "Contact Address",
+                type: "input",
+                default: peerFromDB.contactAddr || undefined,
+                validate: validators_1.contactAddrValidator
+            },
+            {
+                name: "accessControlListRef",
+                message: "IP Access Control List",
+                choices: [{ name: "None", value: undefined }, ...aclList],
+                type: "list",
+                default: peerFromDB.accessControlListRef
+            },
+            {
+                name: "credentialsRef",
+                message: "Credentials Name",
+                choices: [{ name: "None", value: undefined }, ...credentialsList],
+                type: "list",
+                default: peerFromDB.credentialsRef
+            },
+            {
+                name: "withSessionAffinity",
+                message: "Enable Session Affinity?",
+                type: "confirm",
+                default: peerFromDB.withSessionAffinity,
+                when: (answers) => answers.aor.startsWith("backend:")
+            },
+            {
+                name: "balancingAlgorithm",
+                message: "Balancing Algorithm",
+                choices: [
+                    { name: "Round Robin", value: common_1.CommonTypes.LoadBalancingAlgorithm.ROUND_ROBIN },
+                    {
+                        name: "Least Sessions",
+                        value: common_1.CommonTypes.LoadBalancingAlgorithm.LEAST_SESSIONS
+                    }
+                ],
+                type: "list",
+                default: peerFromDB.balancingAlgorithm,
+                when: (answers) => answers.aor.startsWith("backend:")
+            },
+            {
+                name: "confirm",
+                message: "Ready?",
+                type: "confirm"
+            }
+        ]);
+        answers.ref = args.ref;
+        if (!answers.confirm) {
+            this.warn("Aborted");
+        }
+        else {
+            try {
+                core_1.CliUx.ux.action.start(`Updating Peer ${answers.name}`);
+                const acl = await api.updatePeer(answers);
+                await core_1.CliUx.ux.wait(1000);
+                core_1.CliUx.ux.action.stop(acl.ref);
+            }
+            catch (e) {
+                core_1.CliUx.ux.action.stop();
+                throw new errors_1.CLIError(e.message);
+            }
+        }
+    }
+}
+exports.default = UpdatePeerCommand;
+UpdatePeerCommand.description = "Updates an existing Peer";
+UpdatePeerCommand.examples = [
+    `<%= config.bin %> <%= command.id %>
+Updating Peer Asterisk Conf... 80181ca6-d4aa-4575-9375-8f72b07d5555
+`
+];
+UpdatePeerCommand.args = [
+    {
+        name: "ref",
+        required: true,
+        description: "reference to an existing Peer"
+    }
+];

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

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

package/dist/commands/trunks/create.js

@@ -0,0 +1,231 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of Routr.
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/* eslint-disable require-jsdoc */
+const grpc = __importStar(require("@grpc/grpc-js"));
+const core_1 = require("@oclif/core");
+const base_1 = require("../../base");
+const errors_1 = require("@oclif/core/lib/errors");
+const common_1 = require("@routr/common");
+const validators_1 = require("../../validators");
+const sdk_1 = __importDefault(require("@routr/sdk"));
+// NOTE: Newer versions of inquirer have a bug that causes the following error:
+// (node:75345) [ERR_REQUIRE_ESM] Error Plugin: @routr/ctl [ERR_REQUIRE_ESM]: require() of ES Module
+const inquirer_1 = __importDefault(require("inquirer"));
+class CreateTrunkCommand extends base_1.BaseCommand {
+    async run() {
+        const { flags } = await this.parse(CreateTrunkCommand);
+        const { endpoint, insecure } = flags;
+        this.log("This utility will help you create a new Trunk.");
+        this.log("Press ^C at any time to quit.");
+        // TODO: Add support for pagination
+        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
+            };
+        });
+        const credentials = await new sdk_1.default.Credentials({
+            endpoint,
+            insecure
+        }).listCredentials({
+            pageSize: 25,
+            pageToken: ""
+        });
+        const credentialsChoice = credentials.items.map((acl) => {
+            return {
+                name: acl.name,
+                value: acl.ref
+            };
+        });
+        const group1 = await inquirer_1.default.prompt([
+            {
+                name: "name",
+                message: "Friendly Name",
+                type: "input",
+                validate: validators_1.nameValidator
+            },
+            {
+                name: "inboundUri",
+                message: "Inbound SIP URI",
+                type: "input",
+                validate: validators_1.inboundUriValidator
+            },
+            {
+                name: "accessControlListRef",
+                message: "IP Access Control List",
+                type: "list",
+                choices: [{ name: "None", value: undefined }, ...aclChoices]
+            },
+            {
+                name: "inboundCredentialsRef",
+                message: "Inbound Credentials",
+                type: "list",
+                choices: [{ name: "None", value: undefined }, ...credentialsChoice]
+            },
+            {
+                name: "outboundCredentialsRef",
+                message: "Outbound Credentials",
+                type: "list",
+                choices: [{ name: "None", value: undefined }, ...credentialsChoice]
+            },
+            {
+                name: "addOutboundUri",
+                message: "Add an Outbound SIP URI?",
+                type: "confirm",
+                default: false
+            }
+        ]);
+        const group2Questions = [
+            {
+                name: "host",
+                message: "Host",
+                type: "input",
+                validate: validators_1.hostValidator
+            },
+            {
+                name: "port",
+                message: "Post",
+                type: "input",
+                default: "5060",
+                validate: validators_1.portValidator
+            },
+            {
+                name: "transport",
+                message: "Transport",
+                type: "list",
+                choices: [common_1.CommonTypes.Transport.UDP, common_1.CommonTypes.Transport.TCP, common_1.CommonTypes.Transport.TLS],
+                default: common_1.CommonTypes.Transport.UDP
+            },
+            {
+                name: "user",
+                message: "User Part",
+                type: "input",
+                validate: validators_1.optionalUsernameValidator
+            },
+            {
+                name: "priority",
+                message: "Priority",
+                type: "input",
+                default: "10",
+                validate: validators_1.priorityValidator
+            },
+            {
+                name: "weight",
+                message: "Weight",
+                type: "input",
+                default: "10",
+                validate: validators_1.weightValidator
+            },
+            {
+                name: "addOutboundUri",
+                message: "Add another Outbound SIP URI?",
+                type: "confirm",
+                default: false
+            }
+        ];
+        let addOutboundUri = group1.addOutboundUri;
+        const uris = [];
+        // eslint-disable-next-line no-loops/no-loops
+        while (addOutboundUri) {
+            const group2 = await inquirer_1.default.prompt(group2Questions);
+            if (group2.numberRef) {
+                uris.push({
+                    host: group2.host,
+                    port: group2.port,
+                    transport: group2.transport,
+                    user: group2.user,
+                    priority: group2.priority,
+                    weight: group2.weight,
+                    enabled: true
+                });
+            }
+            addOutboundUri = group2.addOutboundUri;
+        }
+        const group3 = await inquirer_1.default.prompt([
+            {
+                name: "confirm",
+                message: "Ready?",
+                type: "confirm"
+            }
+        ]);
+        if (!group3.confirm) {
+            this.warn("Aborted");
+        }
+        else {
+            try {
+                core_1.CliUx.ux.action.start(`Creating Trunk ${group1.name}`);
+                const api = new sdk_1.default.Trunks({ endpoint, insecure });
+                const trunk = await api.createTrunk({
+                    ...group1,
+                    uris
+                });
+                await core_1.CliUx.ux.wait(1000);
+                core_1.CliUx.ux.action.stop(trunk.ref);
+            }
+            catch (e) {
+                core_1.CliUx.ux.action.stop();
+                if (e.code === grpc.status.ALREADY_EXISTS) {
+                    throw new errors_1.CLIError("This Trunk already exist");
+                }
+                else {
+                    throw new errors_1.CLIError(e.message);
+                }
+            }
+        }
+    }
+}
+exports.default = CreateTrunkCommand;
+CreateTrunkCommand.description = "Creates a new Trunk";
+CreateTrunkCommand.examples = [
+    `<%= config.bin %> <%= command.id %>
+Creating Trunk T01... b148b4b4-6884-4c06-bb7e-bd098f5fe793
+`
+];

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

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

package/dist/commands/trunks/delete.js

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

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

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