@routr/ctl 2.0.8-alpha.21

package/bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({project})
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/run

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+/*
+ * 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.
+ */
+const oclif = require("@oclif/core")
+
+oclif
+  .run()
+  .then(require("@oclif/core/flush"))
+  .catch(require("@oclif/core/handle"))

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/dist/base.d.ts

@@ -0,0 +1,8 @@
+import { Command } from "@oclif/core";
+export declare abstract class BaseCommand extends Command {
+    static globalFlags: {
+        extended: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        insecure: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        endpoint: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+    };
+}

package/dist/base.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseCommand = 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 core_1 = require("@oclif/core");
+class BaseCommand extends core_1.Command {
+}
+exports.BaseCommand = BaseCommand;
+BaseCommand.globalFlags = {
+    extended: core_1.Flags.boolean({
+        char: "x",
+        description: "extended output format"
+    }),
+    insecure: core_1.Flags.boolean({
+        char: "i",
+        description: "allow insecure connections to the routr server",
+        default: false
+    }),
+    endpoint: core_1.Flags.string({
+        char: "e",
+        description: "endpoint to connect to the routr server",
+        default: "localhost:51907"
+    })
+};

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

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

package/dist/commands/acl/create.js

@@ -0,0 +1,122 @@
+"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 validators_1 = require("../../validators");
+const utils_1 = require("../../utils");
+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 CreateCommand extends base_1.BaseCommand {
+    async run() {
+        const { flags } = await this.parse(CreateCommand);
+        const { endpoint, insecure } = flags;
+        this.log("This utility will help you create a new ACL");
+        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: "deny",
+                message: "Deny CIDR Networks",
+                type: "input",
+                default: "0.0.0.0/0",
+                validate: validators_1.aclRuleValidator
+            },
+            {
+                name: "allow",
+                message: "Allow CIDR Networks",
+                type: "input",
+                validate: validators_1.aclRuleValidator
+            },
+            {
+                name: "confirm",
+                message: "Ready?",
+                type: "confirm"
+            }
+        ]);
+        // Re-assign allow and deny rules as arrays
+        answers.allow = (0, utils_1.stringToACL)(answers.allow);
+        answers.deny = (0, utils_1.stringToACL)(answers.deny);
+        if (!answers.confirm) {
+            this.warn("Aborted");
+        }
+        else {
+            try {
+                core_1.CliUx.ux.action.start(`Creating ACL ${answers.name}`);
+                const api = new sdk_1.default.ACL({ endpoint, insecure });
+                const acl = await api.createACL(answers);
+                await core_1.CliUx.ux.wait(1000);
+                core_1.CliUx.ux.action.stop(acl.ref);
+            }
+            catch (e) {
+                core_1.CliUx.ux.action.stop();
+                if (e.code === grpc.status.ALREADY_EXISTS) {
+                    throw new errors_1.CLIError("This ACL already exist");
+                }
+                else {
+                    throw new errors_1.CLIError(e.message);
+                }
+            }
+        }
+    }
+}
+exports.default = CreateCommand;
+CreateCommand.description = "Creates a new ACL";
+CreateCommand.examples = [
+    `<%= config.bin %> <%= command.id %>
+Creating ACL US Eeast... b148b4b4-6884-4c06-bb7e-bd098f5fe793
+`
+];

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

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

package/dist/commands/acl/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 CreateCommand extends delete_1.default {
+    async run() {
+        const { flags } = await this.parse(CreateCommand);
+        const { endpoint, insecure } = flags;
+        await super.deleteResource(new sdk_1.default.ACL({ endpoint, insecure }), "deleteACL");
+    }
+}
+exports.default = CreateCommand;
+CreateCommand.description = "Deletes an Access Control List";
+CreateCommand.examples = [
+    `<%= config.bin %> <%= command.id %>
+Deleting item 80181ca6-d4aa-4575-9375-8f72b071111... Done
+`
+];

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

@@ -0,0 +1,19 @@
+import { BaseCommand } from "../../base";
+import { CommandError } from "@oclif/core/lib/interfaces";
+export default class GetCommand 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>;
+}

package/dist/commands/acl/get.js

@@ -0,0 +1,135 @@
+"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
+                },
+                deny: {
+                    header: "Deny CIDR Networks",
+                    get: (row) => row.deny.join(", ")
+                },
+                allow: {
+                    header: "Allow CIDR Networks",
+                    get: (row) => row.allow.join(", ")
+                },
+                createdAt: {
+                    header: "Created",
+                    get: (row) => new Date(row.createdAt * 1000),
+                    extended: true
+                },
+                updatedAt: {
+                    header: "Updated",
+                    get: (row) => new Date(row.updatedAt * 1000),
+                    extended: true
+                },
+                extended: {
+                    header: "Extended",
+                    get: (row) => row.extended || {},
+                    extended: true
+                },
+                apiVersion: {
+                    header: "API",
+                    extended: true
+                }
+            }, {
+                "no-header": !showHeader,
+                printLine: self.log.bind(self),
+                ...flags // parsed flags
+            });
+        };
+        await (0, utils_1.showPaginatedList)({
+            showTable,
+            args,
+            flags,
+            kind: common_1.CommonConnect.Kind.ACL,
+            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 ACL 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 ACLs or a single ACL if a ref is provided";
+GetCommand.examples = [
+    `<%= config.bin %> <%= command.id %>
+Ref                                  Name              Deny List Allow List
+9e7a88f0-8390-42f5-a2cb-689583ba9f4f Local Network ACL 0.0.0.0/0 10.0.0.28 
+`
+];
+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 an ACL"
+    }
+];

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

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

package/dist/commands/acl/update.js

@@ -0,0 +1,100 @@
+"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 validators_1 = require("../../validators");
+const utils_1 = require("../../utils");
+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 UpdateCommand extends base_1.BaseCommand {
+    async run() {
+        const { args, flags } = await this.parse(UpdateCommand);
+        const { endpoint, insecure } = flags;
+        const api = new sdk_1.default.ACL({ endpoint, insecure });
+        this.log("This utility will help you update an existing ACL.");
+        this.log("Press ^C at any time to quit.");
+        const aclFromDB = await api.getACL(args.ref);
+        const answers = await inquirer_1.default.prompt([
+            {
+                name: "name",
+                message: "Friendly Name",
+                type: "input",
+                default: aclFromDB.name,
+                validate: validators_1.nameValidator
+            },
+            {
+                name: "deny",
+                message: "Deny CIDR Networks",
+                type: "input",
+                default: aclFromDB.deny.join(","),
+                validate: validators_1.aclRuleValidator
+            },
+            {
+                name: "allow",
+                message: "Allow CIDR Networks",
+                type: "input",
+                default: aclFromDB.allow.join(","),
+                validate: validators_1.aclRuleValidator
+            },
+            {
+                name: "confirm",
+                message: "Ready?",
+                type: "confirm"
+            }
+        ]);
+        answers.ref = args.ref;
+        // Re-assign allow and deny rules as arrays
+        answers.allow = (0, utils_1.stringToACL)(answers.allow);
+        answers.deny = (0, utils_1.stringToACL)(answers.deny);
+        if (!answers.confirm) {
+            this.warn("Aborted");
+        }
+        else {
+            try {
+                core_1.CliUx.ux.action.start(`Updating ACL ${answers.name}`);
+                const acl = await api.updateACL(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 = UpdateCommand;
+UpdateCommand.description = "Updates an existing ACL";
+UpdateCommand.examples = [
+    `<%= config.bin %> <%= command.id %>
+Updating ACL US East... 80181ca6-d4aa-4575-9375-8f72b07d5555
+`
+];
+UpdateCommand.args = [
+    { name: "ref", required: true, description: "reference to an ACL" }
+];

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

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