@fonoster/ctl 0.3.2 → 0.3.6-alpha.10

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

@@ -0,0 +1,6 @@
+import "../../config";
+import { Command } from "@oclif/command";
+export default class CreateCommand extends Command {
+    static description: string;
+    run(): Promise<void>;
+}

package/dist/commands/apps/create.js

@@ -0,0 +1,186 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("../../config");
+const errors_1 = require("@oclif/errors");
+const command_1 = require("@oclif/command");
+const core_1 = require("@oclif/core");
+const config_1 = require("../../config");
+const project_guard_1 = require("../../decorators/project_guard");
+const voices_1 = require("../../data/voices");
+const Apps = require("@fonoster/apps");
+const Secrets = require("@fonoster/secrets");
+const inquirer = require("inquirer");
+const validator = (value, message = "This field is required") => Boolean(value?.trim()?.length) || message;
+class CreateCommand extends command_1.Command {
+    async run() {
+        console.log("This utility will help you create a new Fonoster App");
+        console.log("Press ^C at any time to quit.\n");
+        try {
+            const { secrets: response } = await new Secrets((0, config_1.getProjectConfig)()).listSecrets({
+                pageSize: 25,
+                pageToken: "1"
+            });
+            const secrets = response.map(({ name }) => name) || [];
+            if (secrets.length === 0) {
+                throw new errors_1.CLIError("Before adding a App you must create a Secret");
+            }
+            const answers = await inquirer.prompt([
+                {
+                    name: "name",
+                    message: "Application Name",
+                    type: "input",
+                    validate: (value) => validator(value, "You must enter a name for your Application, try something friendly.")
+                },
+                {
+                    name: "speechConfig.voice",
+                    message: "Voice name",
+                    type: "list",
+                    choices: voices_1.voices,
+                    validate: (value) => validator(value, "You must select a voice")
+                },
+                {
+                    name: "speechConfig.secretName",
+                    message: "Speech Config Secret",
+                    type: "list",
+                    choices: secrets,
+                    validate: (value) => validator(value, "You must select a secret")
+                },
+                {
+                    name: "intentsEngineConfig.welcomeIntentId",
+                    message: "Type the welcome intent ID (e.g. WELCOME)",
+                    type: "input"
+                },
+                {
+                    name: "engine",
+                    message: "Select Intents Engine Type",
+                    type: "list",
+                    choices: ["DialogflowES"],
+                    validate: (value) => validator(value, "You must select a engine")
+                },
+                {
+                    name: "intentsEngineConfig.projectId",
+                    message: "Type a project ID",
+                    type: "input",
+                    validate: (value) => validator(value, "You must enter a project ID for your Application.")
+                },
+                {
+                    name: "intentsEngineConfig.secretName",
+                    message: "Intents Engine Secret",
+                    type: "list",
+                    choices: secrets,
+                    validate: (value) => validator(value, "You must select a secret")
+                },
+                {
+                    name: "intentsEngineConfig.agent",
+                    message: "Type a agent",
+                    type: "input",
+                    when: (answers) => answers.engine === "DialogflowES",
+                    validate: (value) => validator(value, "You must enter a agent for your Application.")
+                },
+                {
+                    name: "intentsEngineConfig.location",
+                    message: "Type a location",
+                    type: "input",
+                    when: (answers) => answers.engine === "DialogflowES",
+                    validate: (value) => validator(value, "You must enter a location for your Application.")
+                },
+                {
+                    name: "showAdvanceOptions",
+                    message: "Show advance options?",
+                    type: "confirm"
+                },
+                {
+                    name: "initialDtmf",
+                    message: "Initial DTMF (optional)",
+                    type: "input",
+                    when: (answers) => answers.showAdvanceOptions,
+                    validate: (value) => {
+                        const regex = /^[0-9*#]*$/;
+                        if (value && !regex.test(value)) {
+                            return "You must enter a valid DTMF. It’s a string that allows 1234567890#*";
+                        }
+                        return true;
+                    }
+                },
+                {
+                    name: "activationIntentId",
+                    message: "Type the activation intent ID (optional)",
+                    type: "input",
+                    when: (answers) => answers.showAdvanceOptions
+                },
+                {
+                    name: "activationTimeout",
+                    message: "Type the activation timeout (e.g. 15000)",
+                    type: "input",
+                    when: (answers) => answers.showAdvanceOptions,
+                    validate: (value) => {
+                        const regex = /^[0-9]*$/;
+                        if (value && !regex.test(value)) {
+                            return "You must enter a valid timeout. It’s a number in milliseconds";
+                        }
+                        return true;
+                    }
+                },
+                {
+                    name: "interactionTimeout",
+                    message: "Type the interaction timeout (e.g. 10000)",
+                    type: "input",
+                    when: (answers) => answers.showAdvanceOptions,
+                    validate: (value) => {
+                        const regex = /^[0-9]*$/;
+                        if (value && !regex.test(value)) {
+                            return "You must enter a valid timeout. It’s a number in milliseconds";
+                        }
+                        return true;
+                    }
+                },
+                {
+                    name: "transferConfig.message",
+                    message: "Type a transfer message (e.g. Please wait while we transfer you)",
+                    type: "input",
+                    when: (answers) => answers.showAdvanceOptions
+                },
+                {
+                    name: "intentsEngineConfig.emulateTelephonyPlatform",
+                    message: "Emulate Telephony Platform",
+                    type: "confirm",
+                    when: (answers) => answers.showAdvanceOptions
+                }
+            ]);
+            const confirmPrompt = await inquirer.prompt([
+                {
+                    name: "confirm",
+                    message: "Ready to create your App?",
+                    type: "confirm"
+                }
+            ]);
+            if (!confirmPrompt.confirm)
+                return console.log("Aborted");
+            core_1.CliUx.ux.action.start(`Creating App ${answers.name}`);
+            const apps = new Apps((0, config_1.getProjectConfig)());
+            delete answers.showAdvanceOptions;
+            delete answers.engine;
+            const result = await apps.createApp(answers);
+            await core_1.CliUx.ux.wait(1000);
+            core_1.CliUx.ux.action.stop(result.ref);
+        }
+        catch (e) {
+            core_1.CliUx.ux.action.stop();
+            throw new errors_1.CLIError(e.code === 9 ? "This App already exist" : e.message);
+        }
+    }
+}
+CreateCommand.description = `create a new Fonoster App
+  ...
+  Create a new Fonoster App
+  `;
+__decorate([
+    (0, project_guard_1.ProjectGuard)()
+], CreateCommand.prototype, "run", null);
+exports.default = CreateCommand;

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

@@ -0,0 +1,9 @@
+import Command from "../../base/delete";
+export default class DeleteCommand extends Command {
+    static description: string;
+    static args: {
+        name: string;
+    }[];
+    static aliases: string[];
+    run(): Promise<void>;
+}

package/dist/commands/apps/delete.js

@@ -0,0 +1,36 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const delete_1 = __importDefault(require("../../base/delete"));
+const errors_1 = require("@oclif/errors");
+const config_1 = require("../../config");
+const project_guard_1 = require("../../decorators/project_guard");
+const Apps = require("@fonoster/apps");
+class DeleteCommand extends delete_1.default {
+    async run() {
+        try {
+            await super.deleteResource(new Apps((0, config_1.getProjectConfig)()), "deleteApp");
+        }
+        catch (e) {
+            const message = e.code === 9
+                ? "unable to delete: please ensure no Resource is using this Fonoster Application"
+                : e.message;
+            throw new errors_1.CLIError(message);
+        }
+    }
+}
+DeleteCommand.description = "delete a Fonoster Application";
+DeleteCommand.args = [{ name: "ref" }];
+DeleteCommand.aliases = ["apps:del", "apps:rm"];
+__decorate([
+    (0, project_guard_1.ProjectGuard)()
+], DeleteCommand.prototype, "run", null);
+exports.default = DeleteCommand;

package/dist/commands/apps/list.d.ts

@@ -0,0 +1,10 @@
+import "../../config";
+import { Command } from "@oclif/command";
+export default class ListCommand extends Command {
+    static description: string;
+    static flags: {
+        size: import("@oclif/parser/lib/flags").IOptionFlag<number>;
+    };
+    static aliases: string[];
+    run(): Promise<void>;
+}

package/dist/commands/apps/list.js

@@ -0,0 +1,89 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("../../config");
+const domains_1 = require("@fonoster/domains");
+const errors_1 = require("@oclif/errors");
+const command_1 = require("@oclif/command");
+const core_1 = require("@oclif/core");
+const config_1 = require("../../config");
+const project_guard_1 = require("../../decorators/project_guard");
+const Apps = require("@fonoster/apps");
+class ListCommand extends command_1.Command {
+    async run() {
+        const { flags } = this.parse(ListCommand);
+        try {
+            const apps = new Apps((0, config_1.getProjectConfig)());
+            let firstBatch = true;
+            let pageToken = "1";
+            const pageSize = flags.size;
+            const view = domains_1.CommonPB.View.BASIC;
+            // while (true) {
+            // Get a list
+            const result = await apps.listApps({ pageSize, pageToken, view });
+            const list = result.apps;
+            pageToken = result.nextPageToken;
+            /**
+               * @todo Uncomment when pagination is applied in backend.
+               *
+               *  if (list.length > 0 && !firstBatch) {
+                    const answer: any = await inquirer.prompt([
+                      {name: "q", message: "More", type: "confirm"}
+                    ]);
+      
+                    if (!answer.q) break;
+                  }
+               */
+            // if (list.length < 1) break;
+            const showTable = (showHeader, data) => {
+                core_1.CliUx.ux.table(data, {
+                    ref: { minWidth: 15 },
+                    name: { header: "Name", minWidth: 15 },
+                    projectId: {
+                        header: "Project ID",
+                        minWidth: 15,
+                        get: (row) => row.intentsEngineConfig?.projectId || "N/A"
+                    },
+                    voice: {
+                        header: "Voice",
+                        minWidth: 20,
+                        get: (row) => row.speechConfig?.voice || "N/A"
+                    },
+                    welcomeIntentId: {
+                        header: "Welcome Intent ID",
+                        minWidth: 15,
+                        get: (row) => row.intentsEngineConfig?.welcomeIntentId || "N/A"
+                    }
+                }, { "no-header": !showHeader });
+            };
+            showTable(firstBatch, list);
+            firstBatch = false;
+            // if (!pageToken) break;
+            // }
+        }
+        catch (e) {
+            throw new errors_1.CLIError(e.message);
+        }
+    }
+}
+ListCommand.description = `list all Fonoster Apps you have access to
+  ...
+  List all Fonoster Apps you have access to
+  `;
+ListCommand.flags = {
+    size: command_1.flags.integer({
+        char: "s",
+        default: 25,
+        description: "number of result per page"
+    })
+};
+ListCommand.aliases = ["apps:ls"];
+__decorate([
+    (0, project_guard_1.ProjectGuard)()
+], ListCommand.prototype, "run", null);
+exports.default = ListCommand;

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

@@ -0,0 +1,9 @@
+import "../../config";
+import { Command } from "@oclif/command";
+export default class UpdateCommand extends Command {
+    static args: {
+        name: string;
+    }[];
+    static description: string;
+    run(): Promise<void>;
+}

package/dist/commands/apps/update.js

@@ -0,0 +1,205 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("../../config");
+const errors_1 = require("@oclif/errors");
+const command_1 = require("@oclif/command");
+const core_1 = require("@oclif/core");
+const config_1 = require("../../config");
+const project_guard_1 = require("../../decorators/project_guard");
+const voices_1 = require("../../data/voices");
+const Apps = require("@fonoster/apps");
+const Secrets = require("@fonoster/secrets");
+const inquirer = require("inquirer");
+const validator = (value, message = "This field is required") => Boolean(value?.trim()?.length) || message;
+class UpdateCommand extends command_1.Command {
+    async run() {
+        try {
+            const { args } = this.parse(UpdateCommand);
+            if (!args.ref)
+                throw new errors_1.CLIError("Please provide the reference of your Fonoster Application");
+            const { secrets: response } = await new Secrets((0, config_1.getProjectConfig)()).listSecrets({
+                pageSize: 25,
+                pageToken: "1"
+            });
+            const secrets = response.map(({ name }) => name) || [];
+            const appsManager = new Apps((0, config_1.getProjectConfig)());
+            const app = await appsManager.getApp(args.ref);
+            if (!app)
+                throw new errors_1.CLIError("App not found");
+            const answers = await inquirer.prompt([
+                {
+                    name: "name",
+                    message: "Application Name",
+                    type: "input",
+                    default: app.name,
+                    validate: (value) => validator(value, "You must enter a name for your Application, try something friendly.")
+                },
+                {
+                    name: "speechConfig.voice",
+                    message: "Voice name",
+                    type: "list",
+                    default: app.speechConfig.voice,
+                    choices: voices_1.voices,
+                    validate: (value) => validator(value, "You must select a voice")
+                },
+                {
+                    name: "speechConfig.secretName",
+                    message: "Speech Config Secret",
+                    type: "list",
+                    choices: secrets,
+                    default: app.speechConfig.secretName,
+                    validate: (value) => validator(value, "You must select a secret")
+                },
+                {
+                    name: "intentsEngineConfig.welcomeIntentId",
+                    message: "Type the welcome intent ID (e.g. WELCOME)",
+                    type: "input",
+                    default: app.intentsEngineConfig.welcomeIntentId
+                },
+                {
+                    name: "engine",
+                    message: "Select Intents Engine Type",
+                    type: "list",
+                    choices: ["DialogflowES"],
+                    validate: (value) => validator(value, "You must select a engine")
+                },
+                {
+                    name: "intentsEngineConfig.projectId",
+                    message: "Type a project ID",
+                    type: "input",
+                    default: app.intentsEngineConfig.projectId,
+                    validate: (value) => validator(value, "You must enter a project ID for your Application.")
+                },
+                {
+                    name: "intentsEngineConfig.secretName",
+                    message: "Intents Engine Secret",
+                    type: "list",
+                    choices: secrets,
+                    default: app.intentsEngineConfig.secretName,
+                    validate: (value) => validator(value, "You must select a secret")
+                },
+                {
+                    name: "intentsEngineConfig.agent",
+                    message: "Type a agent",
+                    type: "input",
+                    default: app.intentsEngineConfig.agent,
+                    when: (answers) => answers.engine === "DialogflowES",
+                    validate: (value) => validator(value, "You must enter a agent for your Application.")
+                },
+                {
+                    name: "intentsEngineConfig.location",
+                    message: "Type a location",
+                    type: "input",
+                    default: app.intentsEngineConfig.location,
+                    when: (answers) => answers.engine === "DialogflowES",
+                    validate: (value) => validator(value, "You must enter a location for your Application.")
+                },
+                {
+                    name: "showAdvanceOptions",
+                    message: "Show advance options?",
+                    type: "confirm",
+                    default: true
+                },
+                {
+                    name: "initialDtmf",
+                    message: "Initial DTMF (optional)",
+                    type: "input",
+                    default: app.initialDtmf,
+                    when: (answers) => answers.showAdvanceOptions,
+                    validate: (value) => {
+                        const regex = /^[0-9*#]*$/;
+                        if (value && !regex.test(value)) {
+                            return "You must enter a valid DTMF. It’s a string that allows 1234567890#*";
+                        }
+                        return true;
+                    }
+                },
+                {
+                    name: "activationIntentId",
+                    message: "Type the activation intent ID (optional)",
+                    type: "input",
+                    default: app.activationIntentId,
+                    when: (answers) => answers.showAdvanceOptions
+                },
+                {
+                    name: "activationTimeout",
+                    message: "Type the activation timeout (e.g. 15000)",
+                    type: "input",
+                    default: app.activationTimeout,
+                    when: (answers) => answers.showAdvanceOptions,
+                    validate: (value) => {
+                        const regex = /^[0-9]*$/;
+                        if (value && !regex.test(value)) {
+                            return "You must enter a valid timeout. It’s a number in milliseconds";
+                        }
+                        return true;
+                    }
+                },
+                {
+                    name: "interactionTimeout",
+                    message: "Type the interaction timeout (e.g. 10000)",
+                    type: "input",
+                    default: app.interactionTimeout,
+                    when: (answers) => answers.showAdvanceOptions,
+                    validate: (value) => {
+                        const regex = /^[0-9]*$/;
+                        if (value && !regex.test(value)) {
+                            return "You must enter a valid timeout. It’s a number in milliseconds";
+                        }
+                        return true;
+                    }
+                },
+                {
+                    name: "transferConfig.message",
+                    message: "Type a transfer message (e.g. Please wait while we transfer you)",
+                    type: "input",
+                    default: app.transferConfig.message,
+                    when: (answers) => answers.showAdvanceOptions
+                },
+                {
+                    name: "intentsEngineConfig.emulateTelephonyPlatform",
+                    message: "Emulate Telephony Platform",
+                    type: "confirm",
+                    default: app.intentsEngineConfig.emulateTelephonyPlatform,
+                    when: (answers) => answers.showAdvanceOptions
+                }
+            ]);
+            const confirmPrompt = await inquirer.prompt([
+                {
+                    name: "confirm",
+                    message: "Ready to update your App?",
+                    type: "confirm"
+                }
+            ]);
+            if (!confirmPrompt.confirm)
+                return console.log("Aborted");
+            core_1.CliUx.ux.action.start(`Updating App ${answers.name}`);
+            const apps = new Apps((0, config_1.getProjectConfig)());
+            delete answers.showAdvanceOptions;
+            delete answers.engine;
+            answers.ref = args.ref;
+            const result = await apps.updateApp(answers);
+            await core_1.CliUx.ux.wait(1000);
+            core_1.CliUx.ux.action.stop(`App ${result.ref} updated`);
+        }
+        catch (e) {
+            core_1.CliUx.ux.action.stop();
+            throw new errors_1.CLIError(e.code === 9 ? "This App already exist" : e.message);
+        }
+    }
+}
+UpdateCommand.args = [{ name: "ref" }];
+UpdateCommand.description = `update a new Fonoster App
+  ...
+  Update a new Fonoster App
+  `;
+__decorate([
+    (0, project_guard_1.ProjectGuard)()
+], UpdateCommand.prototype, "run", null);
+exports.default = UpdateCommand;

package/dist/commands/auth/login.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 require("../../config");
 const errors_1 = require("@oclif/errors");
 const command_1 = require("@oclif/command");
-const cli_ux_1 = require("cli-ux");
+const core_1 = require("@oclif/core");
 const config_1 = require("../../config");
 const Projects = require("@fonoster/projects");
 const inquirer = require("inquirer");
@@ -40,23 +40,23 @@ class default_1 extends command_1.Command {
         }
         else {
             try {
-                cli_ux_1.cli.action.start(`Accessing endpoint ${answers.endpoint}`);
+                core_1.CliUx.ux.action.start(`Accessing endpoint ${answers.endpoint}`);
                 try {
                     const projects = new Projects(answers);
                     await projects.listProjects();
                     answers.confirm = void 0;
                     (0, config_1.setConfig)(answers);
-                    await cli_ux_1.cli.wait(1000);
-                    cli_ux_1.cli.action.stop("Done");
+                    await core_1.CliUx.ux.wait(1000);
+                    core_1.CliUx.ux.action.stop("Done");
                 }
                 catch (e) {
-                    console.log(e);
-                    await cli_ux_1.cli.wait(1000);
-                    cli_ux_1.cli.action.stop("Invalid credentials or endpoint");
+                    console.error(e.message);
+                    await core_1.CliUx.ux.wait(1000);
+                    core_1.CliUx.ux.action.stop("Invalid credentials or endpoint");
                 }
             }
             catch (e) {
-                cli_ux_1.cli.action.stop();
+                core_1.CliUx.ux.action.stop();
                 throw new errors_1.CLIError(e.message);
             }
         }

package/dist/commands/auth/logout.js

@@ -3,21 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 require("../../config");
 const errors_1 = require("@oclif/errors");
 const command_1 = require("@oclif/command");
-const cli_ux_1 = require("cli-ux");
+const core_1 = require("@oclif/core");
 const path_1 = require("path");
 const os_1 = require("os");
 const BASE_DIR = (0, path_1.join)((0, os_1.homedir)(), ".fonoster");
 const fs = require("fs");
 class default_1 extends command_1.Command {
     async run() {
-        cli_ux_1.cli.action.start(`Login out`);
+        core_1.CliUx.ux.action.start(`Login out`);
         try {
             fs.rmSync(BASE_DIR, { recursive: true });
-            await cli_ux_1.cli.wait(1000);
-            cli_ux_1.cli.action.stop("Done");
+            await core_1.CliUx.ux.wait(1000);
+            core_1.CliUx.ux.action.stop("Done");
         }
         catch (e) {
-            cli_ux_1.cli.action.stop();
+            core_1.CliUx.ux.action.stop();
             throw new errors_1.CLIError(e.message);
         }
     }

package/dist/commands/bug.js

@@ -1,14 +1,11 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 require("../config");
-const cli_ux_1 = __importDefault(require("cli-ux"));
+const core_1 = require("@oclif/core");
 const command_1 = require("@oclif/command");
 class default_1 extends command_1.Command {
     async run() {
-        await cli_ux_1.default.open("https://github.com/fonoster/fonoster/issues/new?assignees=&labels=&template=bug_report.md&title=");
+        await core_1.CliUx.ux.open("https://github.com/fonoster/fonoster/issues/new?assignees=&labels=&template=bug_report.md&title=");
     }
 }
 exports.default = default_1;