@routr/ctl 2.15.4 → 2.17.0

package/dist/commands/peers/create.js

@@ -55,10 +55,10 @@ 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 wait_1 = require("../../lib/wait");
+const grpc = __importStar(require("@grpc/grpc-js"));
 const base_1 = require("../../base");
-const errors_1 = require("@oclif/core/lib/errors");
 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:
@@ -178,22 +178,22 @@ class CreateCommand extends base_1.BaseCommand {
                 this.warn("Aborted");
             }
             else {
-                core_1.CliUx.ux.action.start(`Creating Peer ${answers.name}`);
+                core_1.ux.action.start(`Creating Peer ${answers.name}`);
                 const api = new sdk_1.default.Peers({ endpoint, insecure, cacert });
                 answers.maxContacts = answers.maxContacts
                     ? parseInt(answers.maxContacts)
                     : -1;
                 const peer = await api.createPeer(answers);
-                await core_1.CliUx.ux.wait(1000);
-                core_1.CliUx.ux.action.stop(peer.ref);
+                await (0, wait_1.wait)(1000);
+                core_1.ux.action.stop(peer.ref);
             }
         }
         catch (e) {
             if (e.code === grpc.status.ALREADY_EXISTS) {
-                throw new errors_1.CLIError("This Peer already exist");
+                throw new core_1.Errors.CLIError("This Peer already exist");
             }
             else {
-                throw new errors_1.CLIError(e.message);
+                throw new core_1.Errors.CLIError(e.message);
             }
         }
     }

package/dist/commands/peers/delete.js

@@ -26,7 +26,7 @@ const delete_1 = __importDefault(require("../../delete"));
 const sdk_1 = __importDefault(require("@routr/sdk"));
 class DeletePeerCommand extends delete_1.default {
     async run() {
-        const { flags } = await this.parse(DeletePeerCommand);
+        const { flags } = await this.parse(delete_1.default);
         const { endpoint, insecure, cacert } = flags;
         await super.deleteResource(new sdk_1.default.Peers({ endpoint, insecure, cacert }), "deletePeer");
     }

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

@@ -2,9 +2,7 @@ import { BaseCommand } from "../../base";
 export default class DescribeCommand extends BaseCommand {
     static readonly description = "shows details for a Peer";
     static readonly args: {
-        name: string;
-        required: boolean;
-        description: string;
-    }[];
+        ref: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
     run(): Promise<void>;
 }

package/dist/commands/peers/describe.js

@@ -22,8 +22,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * 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 prettyjson_1 = require("prettyjson");
 const utils_1 = require("../../utils");
 const sdk_1 = __importDefault(require("@routr/sdk"));
@@ -67,16 +67,12 @@ class DescribeCommand extends base_1.BaseCommand {
             this.log((0, prettyjson_1.render)(jsonObj, { noColor: true }));
         }
         catch (e) {
-            throw new errors_1.CLIError(e.message);
+            throw new core_1.Errors.CLIError(e.message);
         }
     }
 }
 DescribeCommand.description = "shows details for a Peer";
-DescribeCommand.args = [
-    {
-        name: "ref",
-        required: false,
-        description: "reference to the Peer"
-    }
-];
+DescribeCommand.args = {
+    ref: core_1.Args.string({ required: false, description: "reference to the Peer" })
+};
 exports.default = DescribeCommand;

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

@@ -1,20 +1,18 @@
+import { Interfaces } from "@oclif/core";
 import { BaseCommand } from "../../base";
-import { CommandError } from "@oclif/core/lib/interfaces";
 export default class GetCommand extends BaseCommand {
     static readonly description = "Shows a list of paginated Peers or a single Peer if ref is provided";
     static readonly examples: string[];
     static readonly flags: {
-        size: import("@oclif/core/lib/interfaces").OptionFlag<number>;
-        extended: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        size: Interfaces.OptionFlag<number, Interfaces.CustomOptions>;
+        extended: Interfaces.BooleanFlag<boolean>;
     };
     static args: {
-        name: string;
-        required: boolean;
-        description: string;
-    }[];
+        ref: Interfaces.Arg<string, Record<string, unknown>>;
+    };
     run(): Promise<void>;
     catch(error: {
         code: number;
         message: string;
-    } | CommandError): Promise<void>;
+    } | Interfaces.CommandError): Promise<void>;
 }

package/dist/commands/peers/get.js

@@ -52,18 +52,18 @@ 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 table_1 = require("../../lib/table");
+const grpc = __importStar(require("@grpc/grpc-js"));
 const base_1 = require("../../base");
 const utils_1 = require("../../utils");
 const common_1 = require("@routr/common");
-const errors_1 = require("@oclif/core/lib/errors");
 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, {
+            (0, table_1.printTable)(data, {
                 ref: {
                     minWidth: 7,
                     extended: true
@@ -107,9 +107,9 @@ class GetCommand extends base_1.BaseCommand {
         // 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 core_1.Errors.CLIError("the Peer you are looking for does not exist: " + args.ref);
         }
-        throw new errors_1.CLIError(error.message);
+        throw new core_1.Errors.CLIError(error.message);
     }
 }
 GetCommand.description = "Shows a list of paginated Peers or a single Peer if ref is provided";
@@ -130,11 +130,10 @@ GetCommand.flags = {
         description: "extended output format"
     })
 };
-GetCommand.args = [
-    {
-        name: "ref",
+GetCommand.args = {
+    ref: core_1.Args.string({
         required: false,
         description: "optional reference to a Peer"
-    }
-];
+    })
+};
 exports.default = GetCommand;

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

@@ -3,9 +3,7 @@ export default class UpdatePeerCommand extends BaseCommand {
     static readonly description = "Updates an existing Peer";
     static readonly examples: string[];
     static readonly args: {
-        name: string;
-        required: boolean;
-        description: string;
-    }[];
+        ref: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
     run(): Promise<void>;
 }

package/dist/commands/peers/update.js

@@ -23,8 +23,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 /* eslint-disable require-jsdoc */
 const core_1 = require("@oclif/core");
+const wait_1 = require("../../lib/wait");
 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"));
@@ -93,14 +93,14 @@ class UpdatePeerCommand extends base_1.BaseCommand {
                 {
                     name: "accessControlListRef",
                     message: "IP Access Control List",
-                    choices: [{ name: "None", value: undefined }, ...aclList],
+                    choices: [{ name: "None", value: "" }, ...aclList],
                     type: "list",
                     default: peerFromDB.accessControlListRef
                 },
                 {
                     name: "credentialsRef",
                     message: "Credentials Name",
-                    choices: [{ name: "None", value: undefined }, ...credentialsList],
+                    choices: [{ name: "None", value: "" }, ...credentialsList],
                     type: "list",
                     default: peerFromDB.credentialsRef
                 },
@@ -143,17 +143,17 @@ class UpdatePeerCommand extends base_1.BaseCommand {
                 this.warn("Aborted");
             }
             else {
-                core_1.CliUx.ux.action.start(`Updating Peer ${answers.name}`);
+                core_1.ux.action.start(`Updating Peer ${answers.name}`);
                 answers.maxContacts = answers.maxContacts
                     ? parseInt(answers.maxContacts)
                     : -1;
                 const acl = await api.updatePeer(answers);
-                await core_1.CliUx.ux.wait(1000);
-                core_1.CliUx.ux.action.stop(acl.ref);
+                await (0, wait_1.wait)(1000);
+                core_1.ux.action.stop(acl.ref);
             }
         }
         catch (e) {
-            throw new errors_1.CLIError(e.message);
+            throw new core_1.Errors.CLIError(e.message);
         }
     }
 }
@@ -163,11 +163,10 @@ UpdatePeerCommand.examples = [
 Updating Peer Asterisk Conf... 80181ca6-d4aa-4575-9375-8f72b07d5555
 `
 ];
-UpdatePeerCommand.args = [
-    {
-        name: "ref",
+UpdatePeerCommand.args = {
+    ref: core_1.Args.string({
         required: true,
         description: "reference to an existing Peer"
-    }
-];
+    })
+};
 exports.default = UpdatePeerCommand;

package/dist/commands/trunks/create.js

@@ -55,10 +55,10 @@ 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 wait_1 = require("../../lib/wait");
+const grpc = __importStar(require("@grpc/grpc-js"));
 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"));
@@ -216,22 +216,22 @@ class CreateTrunkCommand extends base_1.BaseCommand {
                 this.warn("Aborted");
             }
             else {
-                core_1.CliUx.ux.action.start(`Creating Trunk ${group1.name}`);
+                core_1.ux.action.start(`Creating Trunk ${group1.name}`);
                 const api = new sdk_1.default.Trunks({ endpoint, insecure, cacert });
                 const trunk = await api.createTrunk({
                     ...group1,
                     uris
                 });
-                await core_1.CliUx.ux.wait(1000);
-                core_1.CliUx.ux.action.stop(trunk.ref);
+                await (0, wait_1.wait)(1000);
+                core_1.ux.action.stop(trunk.ref);
             }
         }
         catch (e) {
             if (e.code === grpc.status.ALREADY_EXISTS) {
-                throw new errors_1.CLIError("This Trunk already exist");
+                throw new core_1.Errors.CLIError("This Trunk already exist");
             }
             else {
-                throw new errors_1.CLIError(e.message);
+                throw new core_1.Errors.CLIError(e.message);
             }
         }
     }

package/dist/commands/trunks/delete.js

@@ -26,7 +26,7 @@ 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 { flags } = await this.parse(delete_1.default);
         const { endpoint, insecure, cacert } = flags;
         await super.deleteResource(new sdk_1.default.Trunks({ endpoint, insecure, cacert }), "deleteTrunk");
     }

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

@@ -2,9 +2,7 @@ import { BaseCommand } from "../../base";
 export default class DescribeCommand extends BaseCommand {
     static description: string;
     static args: {
-        name: string;
-        required: boolean;
-        description: string;
-    }[];
+        ref: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
     run(): Promise<void>;
 }

package/dist/commands/trunks/describe.js

@@ -22,8 +22,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * 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 prettyjson_1 = require("prettyjson");
 const sdk_1 = __importDefault(require("@routr/sdk"));
 const moment_1 = __importDefault(require("moment"));
@@ -70,16 +70,12 @@ class DescribeCommand extends base_1.BaseCommand {
             this.log((0, prettyjson_1.render)(jsonObj, { noColor: true }));
         }
         catch (e) {
-            throw new errors_1.CLIError(e.message);
+            throw new core_1.Errors.CLIError(e.message);
         }
     }
 }
 DescribeCommand.description = "shows details for a Trunk";
-DescribeCommand.args = [
-    {
-        name: "ref",
-        required: false,
-        description: "reference to the Trunk"
-    }
-];
+DescribeCommand.args = {
+    ref: core_1.Args.string({ required: false, description: "reference to the Trunk" })
+};
 exports.default = DescribeCommand;

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

@@ -1,20 +1,18 @@
+import { Interfaces } from "@oclif/core";
 import { BaseCommand } from "../../base";
-import { CommandError } from "@oclif/core/lib/interfaces";
 export default class GetTrunksCommand extends BaseCommand {
     static readonly description = "Shows a list of paginated Trunks or a single Trunk if ref is provided";
     static readonly examples: string[];
     static readonly flags: {
-        size: import("@oclif/core/lib/interfaces").OptionFlag<number>;
-        extended: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        size: Interfaces.OptionFlag<number, Interfaces.CustomOptions>;
+        extended: Interfaces.BooleanFlag<boolean>;
     };
     static args: {
-        name: string;
-        required: boolean;
-        description: string;
-    }[];
+        ref: Interfaces.Arg<string, Record<string, unknown>>;
+    };
     run(): Promise<void>;
     catch(error: {
         code: number;
         message: string;
-    } | CommandError): Promise<void>;
+    } | Interfaces.CommandError): Promise<void>;
 }

package/dist/commands/trunks/get.js

@@ -52,18 +52,18 @@ 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 table_1 = require("../../lib/table");
+const grpc = __importStar(require("@grpc/grpc-js"));
 const base_1 = require("../../base");
 const utils_1 = require("../../utils");
 const common_1 = require("@routr/common");
-const errors_1 = require("@oclif/core/lib/errors");
 class GetTrunksCommand extends base_1.BaseCommand {
     async run() {
         const { args, flags } = await this.parse(GetTrunksCommand);
         const showTable = (request) => {
             const { showHeader, data, self, flags } = request;
-            core_1.CliUx.ux.table(data, {
+            (0, table_1.printTable)(data, {
                 ref: {
                     minWidth: 7,
                     extended: true
@@ -95,9 +95,9 @@ class GetTrunksCommand extends base_1.BaseCommand {
         // To be handled globally
         if ("code" in error && error.code === grpc.status.NOT_FOUND) {
             const { args } = await this.parse(GetTrunksCommand);
-            throw new errors_1.CLIError("the Trunk you are looking for does not exist: " + args.ref);
+            throw new core_1.Errors.CLIError("the Trunk you are looking for does not exist: " + args.ref);
         }
-        throw new errors_1.CLIError(error.message);
+        throw new core_1.Errors.CLIError(error.message);
     }
 }
 GetTrunksCommand.description = "Shows a list of paginated Trunks or a single Trunk if ref is provided";
@@ -118,11 +118,10 @@ GetTrunksCommand.flags = {
         description: "extended output format"
     })
 };
-GetTrunksCommand.args = [
-    {
-        name: "ref",
+GetTrunksCommand.args = {
+    ref: core_1.Args.string({
         required: false,
         description: "optional reference to a Trunk"
-    }
-];
+    })
+};
 exports.default = GetTrunksCommand;

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

@@ -3,9 +3,7 @@ export default class UpdateCommand extends BaseCommand {
     static readonly description = "Updates an existing Trunk";
     static readonly examples: string[];
     static readonly args: {
-        name: string;
-        required: boolean;
-        description: string;
-    }[];
+        ref: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
     run(): Promise<void>;
 }

package/dist/commands/trunks/update.js

@@ -23,8 +23,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 /* eslint-disable require-jsdoc */
 const core_1 = require("@oclif/core");
+const wait_1 = require("../../lib/wait");
 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"));
@@ -86,21 +86,21 @@ class UpdateCommand extends base_1.BaseCommand {
                     message: "IP Access Control List",
                     type: "list",
                     default: trunkFromDB.accessControlListRef,
-                    choices: [{ name: "None", value: undefined }, ...aclChoices]
+                    choices: [{ name: "None", value: "" }, ...aclChoices]
                 },
                 {
                     name: "inboundCredentialsRef",
                     message: "Inbound Credentials",
                     type: "list",
                     default: trunkFromDB.inboundCredentialsRef,
-                    choices: [{ name: "None", value: undefined }, ...credentialsChoice]
+                    choices: [{ name: "None", value: "" }, ...credentialsChoice]
                 },
                 {
                     name: "outboundCredentialsRef",
                     message: "Outbound Credentials",
                     type: "list",
                     default: trunkFromDB.outboundCredentialsRef,
-                    choices: [{ name: "None", value: undefined }, ...credentialsChoice]
+                    choices: [{ name: "None", value: "" }, ...credentialsChoice]
                 },
                 {
                     name: "sendRegister",
@@ -190,18 +190,18 @@ class UpdateCommand extends base_1.BaseCommand {
                 this.warn("Aborted");
             }
             else {
-                core_1.CliUx.ux.action.start(`Updating Trunk ${group1.name}`);
+                core_1.ux.action.start(`Updating Trunk ${group1.name}`);
                 const trunk = await api.updateTrunk({
                     ref: trunkFromDB.ref,
                     ...group1,
                     uris
                 });
-                await core_1.CliUx.ux.wait(1000);
-                core_1.CliUx.ux.action.stop(trunk.ref);
+                await (0, wait_1.wait)(1000);
+                core_1.ux.action.stop(trunk.ref);
             }
         }
         catch (e) {
-            throw new errors_1.CLIError(e.message);
+            throw new core_1.Errors.CLIError(e.message);
         }
     }
 }
@@ -211,11 +211,10 @@ UpdateCommand.examples = [
 Updating Trunk T01... 80181ca6-d4aa-4575-9375-8f72b07d5555
 `
 ];
-UpdateCommand.args = [
-    {
-        name: "ref",
+UpdateCommand.args = {
+    ref: core_1.Args.string({
         required: true,
         description: "reference to an existing Trunk"
-    }
-];
+    })
+};
 exports.default = UpdateCommand;

package/dist/delete.d.ts

@@ -1,8 +1,8 @@
 import { BaseCommand } from "./base";
 export default abstract class DeleteCommand extends BaseCommand {
     static readonly args: {
-        name: string;
-    }[];
+        ref: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
     deleteResource(API: any, funcName: string): Promise<void>;
     catch(err: Error): Promise<any>;
     finally(err: Error): Promise<any>;

package/dist/delete.js

@@ -21,23 +21,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable require-jsdoc */
 const core_1 = require("@oclif/core");
 const base_1 = require("./base");
-const errors_1 = require("@oclif/core/lib/errors");
+const wait_1 = require("./lib/wait");
 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.ux.action.stop();
+            throw new core_1.Errors.CLIError("You must provide a resource ref before continuing");
         }
-        core_1.CliUx.ux.action.start(`Deleting item ${args.ref}`);
+        core_1.ux.action.start(`Deleting item ${args.ref}`);
         try {
             await API[funcName](args.ref);
-            await core_1.CliUx.ux.wait(1000);
-            core_1.CliUx.ux.action.stop("Done");
+            await (0, wait_1.wait)(1000);
+            core_1.ux.action.stop("Done");
         }
         catch (e) {
-            throw new errors_1.CLIError(e.message);
+            throw new core_1.Errors.CLIError(e.message);
         }
     }
     async catch(err) {
@@ -47,5 +47,7 @@ class DeleteCommand extends base_1.BaseCommand {
         return super.finally(err);
     }
 }
-DeleteCommand.args = [{ name: "ref" }];
+DeleteCommand.args = {
+    ref: core_1.Args.string({ required: false })
+};
 exports.default = DeleteCommand;

package/dist/help.js

@@ -82,7 +82,8 @@ class MyHelpClass extends core_1.Help {
             .filter((c) => c.id)
             .sort((a, b) => (a.id.includes(":") ? 1 : b.id.includes(":") ? -1 : 0))
             .map((c) => {
-            const { description } = c;
+            var _a;
+            const description = (_a = c.description) !== null && _a !== void 0 ? _a : "";
             return {
                 ...c,
                 description: removeLastDot(lowercaseFirstLetter(description))

package/dist/lib/table.d.ts

@@ -0,0 +1,15 @@
+export type TableRow = Record<string, any>;
+export interface TableColumn {
+    header?: string;
+    minWidth?: number;
+    extended?: boolean;
+    get?: (row: TableRow) => unknown;
+}
+export type TableColumns = Record<string, TableColumn>;
+export interface TableOptions {
+    "no-header"?: boolean;
+    extended?: boolean;
+    printLine?: (line: string) => void;
+    [key: string]: unknown;
+}
+export declare function printTable(data: TableRow[], columns: TableColumns, options?: TableOptions): void;