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

package/dist/commands/peers/create.js

@@ -60,110 +60,119 @@ class CreateCommand extends base_1.BaseCommand {
         var _a, _b;
         const { flags } = await this.parse(CreateCommand);
         const { endpoint, insecure } = flags;
-        this.log("This utility will help you create a new Peer.");
-        this.log("Press ^C at any time to quit.");
-        // TODO: Fix hardcoded pageSize
-        const acls = await new sdk_1.default.ACL({ endpoint, insecure }).listACLs({
-            pageSize: 25,
-            pageToken: ""
-        });
-        // 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",
-                validate: validators_1.nameValidator
-            },
-            {
-                name: "username",
-                message: "Username",
-                type: "input",
-                validate: validators_1.usernameValidator
-            },
-            {
-                name: "aor",
-                message: "Adress of Record",
-                type: "input",
-                validate: validators_1.aorValidator
-            },
-            {
-                name: "contactAddr",
-                message: "Contact Address",
-                type: "input",
-                validate: validators_1.contactAddrValidator
-            },
-            {
-                name: "accessControlListRef",
-                message: "IP Access Control List",
-                choices: [{ name: "None", value: undefined }, ...aclList],
-                type: "list"
-            },
-            {
-                name: "credentialsRef",
-                message: "Credentials Name",
-                choices: [{ name: "None", value: undefined }, ...credentialsList],
-                type: "list"
-            },
-            {
-                name: "withSessionAffinity",
-                message: "Enable Session Affinity?",
-                type: "confirm",
-                default: false,
-                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: common_1.CommonTypes.LoadBalancingAlgorithm.ROUND_ROBIN,
-                when: (answers) => answers.aor.startsWith("backend:")
-            },
-            {
-                name: "confirm",
-                message: "Ready?",
-                type: "confirm"
+        try {
+            // 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 };
+            })) || [];
+            this.log("This utility will help you create a new Peer.");
+            this.log("Press ^C at any time to quit.");
+            const answers = await inquirer_1.default.prompt([
+                {
+                    name: "name",
+                    message: "Friendly Name",
+                    type: "input",
+                    validate: validators_1.nameValidator
+                },
+                {
+                    name: "username",
+                    message: "Username",
+                    type: "input",
+                    validate: validators_1.usernameValidator
+                },
+                {
+                    name: "aor",
+                    message: "Adress of Record",
+                    type: "input",
+                    validate: validators_1.aorValidator
+                },
+                {
+                    name: "contactAddr",
+                    message: "Contact Address",
+                    type: "input",
+                    validate: validators_1.contactAddrValidator
+                },
+                {
+                    name: "accessControlListRef",
+                    message: "IP Access Control List",
+                    choices: [{ name: "None", value: undefined }, ...aclList],
+                    type: "list"
+                },
+                {
+                    name: "credentialsRef",
+                    message: "Credentials Name",
+                    choices: [{ name: "None", value: undefined }, ...credentialsList],
+                    type: "list"
+                },
+                {
+                    name: "withSessionAffinity",
+                    message: "Enable Session Affinity?",
+                    type: "confirm",
+                    default: false,
+                    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: common_1.CommonTypes.LoadBalancingAlgorithm.ROUND_ROBIN,
+                    when: (answers) => answers.aor.startsWith("backend:")
+                },
+                {
+                    name: "enabled",
+                    message: "Enabled?",
+                    type: "confirm",
+                    default: true
+                },
+                {
+                    name: "confirm",
+                    message: "Ready?",
+                    type: "confirm"
+                }
+            ]);
+            if (!answers.confirm) {
+                this.warn("Aborted");
             }
-        ]);
-        if (!answers.confirm) {
-            this.warn("Aborted");
-        }
-        else {
-            try {
+            else {
                 core_1.CliUx.ux.action.start(`Creating Peer ${answers.name}`);
                 const api = new sdk_1.default.Peers({ endpoint, insecure });
                 const peer = await api.createPeer(answers);
                 await core_1.CliUx.ux.wait(1000);
                 core_1.CliUx.ux.action.stop(peer.ref);
             }
-            catch (e) {
-                core_1.CliUx.ux.action.stop();
-                if (e.code === grpc.status.ALREADY_EXISTS) {
-                    throw new errors_1.CLIError("This Peer already exist");
-                }
-                else {
-                    throw new errors_1.CLIError(e.message);
-                }
+        }
+        catch (e) {
+            core_1.CliUx.ux.action.stop();
+            if (e.code === grpc.status.ALREADY_EXISTS) {
+                throw new errors_1.CLIError("This Peer already exist");
+            }
+            else {
+                throw new errors_1.CLIError(e.message);
             }
         }
     }

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

@@ -0,0 +1,80 @@
+"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.Peers({ endpoint, insecure });
+        try {
+            const peer = await api.getPeer(args.ref);
+            const jsonObj = {
+                Ref: peer.ref,
+                APIVersion: peer.apiVersion,
+                Name: peer.name,
+                Username: peer.username,
+                AOR: peer.aor,
+                "Balancing Algorithm": peer.balancingAlgorithm,
+                "Session Affinity?": peer.withSessionAffinity ? "Yes" : "No",
+                "Contact Address": peer.contactAddr,
+                Enabled: peer.enabled ? "Yes" : "No",
+                "Access Control List": peer.accessControlList
+                    ? {
+                        Ref: peer.accessControlList.ref,
+                        Name: peer.accessControlList.name,
+                        Deny: peer.accessControlList.deny.join(","),
+                        Allow: peer.accessControlList.allow.join(",")
+                    }
+                    : "None",
+                Credentials: peer.credentials
+                    ? {
+                        Ref: peer.credentials.ref,
+                        Username: peer.credentials.username
+                    }
+                    : "None",
+                Extended: peer.extended,
+                Created: (0, moment_1.default)(new Date(peer.createdAt * 1000)).toISOString(),
+                Updated: (0, moment_1.default)(new Date(peer.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 Peer";
+DescribeCommand.args = [
+    {
+        name: "ref",
+        required: false,
+        description: "reference to the Peer"
+    }
+];

package/dist/commands/peers/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/peers/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);
@@ -67,50 +67,9 @@ class GetCommand extends base_1.BaseCommand {
                 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
+                    get: (row) => (row.enabled ? "Yes" : "No")
                 }
             }, {
                 "no-header": !showHeader,
@@ -148,6 +107,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/peers/update.js

@@ -37,106 +37,115 @@ class UpdatePeerCommand extends base_1.BaseCommand {
         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"
+        try {
+            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 };
+            })) || [];
+            this.log("This utility will help you update an existing Peer.");
+            this.log("Press ^C at any time to quit.");
+            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: "enabled",
+                    message: "Enabled?",
+                    type: "confirm",
+                    default: peerFromDB.enabled
+                },
+                {
+                    name: "confirm",
+                    message: "Ready?",
+                    type: "confirm"
+                }
+            ]);
+            answers.ref = args.ref;
+            if (!answers.confirm) {
+                this.warn("Aborted");
             }
-        ]);
-        answers.ref = args.ref;
-        if (!answers.confirm) {
-            this.warn("Aborted");
-        }
-        else {
-            try {
+            else {
                 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);
-            }
+        }
+        catch (e) {
+            core_1.CliUx.ux.action.stop();
+            throw new errors_1.CLIError(e.message);
         }
     }
 }