@botpress/cli 0.0.10 → 0.0.11

package/dist/config.js

@@ -6,8 +6,8 @@ var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
-  for (var name2 in all)
-    __defProp(target, name2, { get: all[name2], enumerable: true });
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
 };
 var __copyProps = (to, from, except, desc) => {
   if (from && typeof from === "object" || typeof from === "function") {
@@ -24,86 +24,19 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var config_exports = {};
 __export(config_exports, {
-  addSchema: () => addSchema,
-  botRef: () => botRef,
-  buildSchema: () => buildSchema,
-  bundleSchema: () => bundleSchema,
-  createBotSchema: () => createBotSchema,
-  deleteBotSchema: () => deleteBotSchema,
-  deleteIntegrationSchema: () => deleteIntegrationSchema,
-  deploySchema: () => deploySchema,
-  devSchema: () => devSchema,
-  generateSchema: () => generateSchema,
-  globalSchema: () => globalSchema,
-  initSchema: () => initSchema,
-  integrationRef: () => integrationRef,
-  listBotsSchema: () => listBotsSchema,
-  listIntegrationsSchema: () => listIntegrationsSchema,
-  loggedInSchema: () => loggedInSchema,
-  loginSchema: () => loginSchema,
-  logoutSchema: () => logoutSchema,
-  projectSchema: () => projectSchema,
-  readBotSchema: () => readBotSchema,
-  readIntegrationSchema: () => readIntegrationSchema,
-  serveSchema: () => serveSchema
+  schemas: () => schemas
 });
 module.exports = __toCommonJS(config_exports);
 var consts = __toESM(require("./consts"));
-const botpressHome = {
-  type: "string",
-  description: "The path to the Botpress home directory",
-  default: consts.defaultBotpressHome
-};
-const verbose = {
-  type: "boolean",
-  description: "Enable verbose logging",
-  alias: "v",
-  default: false
-};
-const json = {
-  type: "boolean",
-  description: "Prevent logging anything else than raw json. Useful for piping output to other tools",
-  alias: "j",
-  default: false
-};
-const confirm = {
-  type: "boolean",
-  description: "Confirm all prompts",
-  alias: "y",
-  default: false
-};
 const port = {
   type: "number",
   description: "The port to use"
 };
-const entryPoint = {
-  type: "string",
-  description: "The entry point of the project",
-  default: consts.defaultEntrypoint
-};
-const outDir = {
-  type: "string",
-  description: "The output directory",
-  default: consts.defaultOutputFolder
-};
 const workDir = {
   type: "string",
   description: "The path to the project",
   default: process.cwd()
 };
-const botId = {
-  type: "string",
-  description: "The bot ID to deploy. Only used when deploying a bot"
-};
-const createNewBot = {
-  type: "boolean",
-  description: "Create a new bot when deploying. Only used when deploying a bot"
-};
-const url = {
-  type: "string",
-  description: "The publicly available URL of the bot or integration (often using ngrok)",
-  demandOption: true
-};
 const noBuild = {
   type: "boolean",
   description: "Skip the build step",
@@ -121,37 +54,51 @@ const workspaceId = {
   type: "string",
   description: "The Workspace Id to deploy to"
 };
-const type = {
-  type: "string",
-  choices: ["bot", "integration"]
-};
-const name = {
-  type: "string",
-  description: "The name of the project"
-};
 const botRef = {
   type: "string",
   description: "The bot ID. Bot Name is not supported.",
-  demandOption: true
+  demandOption: true,
+  positional: true,
+  idx: 0
 };
 const integrationRef = {
   type: "string",
   description: "The integration ID or name with optionnal version. Ex: teams or teams@0.2.0",
-  demandOption: true
+  demandOption: true,
+  positional: true,
+  idx: 0
 };
 const globalSchema = {
-  verbose,
-  confirm,
-  json,
-  botpressHome
+  verbose: {
+    type: "boolean",
+    description: "Enable verbose logging",
+    alias: "v",
+    default: false
+  },
+  confirm: {
+    type: "boolean",
+    description: "Confirm all prompts",
+    alias: "y",
+    default: false
+  },
+  json: {
+    type: "boolean",
+    description: "Prevent logging anything else than raw json in stdout. Useful for piping output to other tools",
+    default: false
+  },
+  botpressHome: {
+    type: "string",
+    description: "The path to the Botpress home directory",
+    default: consts.defaultBotpressHome
+  }
 };
 const projectSchema = {
   ...globalSchema,
-  entryPoint,
-  outDir,
+  entryPoint: { type: "string", description: "The entry point of the project", default: consts.defaultEntrypoint },
+  outDir: { type: "string", description: "The output directory", default: consts.defaultOutputFolder },
   workDir
 };
-const loggedInSchema = {
+const credentialsSchema = {
   host,
   workspaceId,
   token
@@ -171,21 +118,26 @@ const serveSchema = {
 };
 const deploySchema = {
   ...projectSchema,
-  ...loggedInSchema,
-  botId,
+  ...credentialsSchema,
+  botId: { type: "string", description: "The bot ID to deploy. Only used when deploying a bot" },
   noBuild,
-  createNewBot
+  createNewBot: { type: "boolean", description: "Create a new bot when deploying. Only used when deploying a bot" }
 };
 const devSchema = {
   ...projectSchema,
-  ...loggedInSchema,
-  url,
+  ...credentialsSchema,
+  url: {
+    type: "string",
+    description: "The publicly available URL of the bot or integration (often using ngrok)",
+    demandOption: true
+  },
   port,
   noBuild
 };
 const addSchema = {
   ...projectSchema,
-  ...loggedInSchema
+  ...credentialsSchema,
+  integrationRef
 };
 const loginSchema = {
   ...globalSchema,
@@ -198,63 +150,68 @@ const logoutSchema = {
 };
 const createBotSchema = {
   ...globalSchema,
-  ...loggedInSchema,
+  ...credentialsSchema,
   name: { type: "string", description: "The name of the bot to create" }
 };
-const readBotSchema = {
+const getBotSchema = {
   ...globalSchema,
-  ...loggedInSchema
+  ...credentialsSchema,
+  botRef
 };
 const deleteBotSchema = {
   ...globalSchema,
-  ...loggedInSchema
+  ...credentialsSchema,
+  botRef
 };
 const listBotsSchema = {
   ...globalSchema,
-  ...loggedInSchema
+  ...credentialsSchema
 };
-const readIntegrationSchema = {
+const getIntegrationSchema = {
   ...globalSchema,
-  ...loggedInSchema
+  ...credentialsSchema,
+  integrationRef
 };
 const listIntegrationsSchema = {
   ...globalSchema,
-  ...loggedInSchema,
+  ...credentialsSchema,
   name: { type: "string", description: "The name filter when listing integrations" },
   version: { type: "string", description: "The version filter when listing integrations" }
 };
 const deleteIntegrationSchema = {
   ...globalSchema,
-  ...loggedInSchema
+  ...credentialsSchema,
+  integrationRef
 };
 const initSchema = {
   ...globalSchema,
   workDir,
-  type,
-  name
+  type: { type: "string", choices: ["bot", "integration"] },
+  name: { type: "string", description: "The name of the project" }
+};
+const schemas = {
+  global: globalSchema,
+  project: projectSchema,
+  credentials: credentialsSchema,
+  login: loginSchema,
+  logout: logoutSchema,
+  createBot: createBotSchema,
+  getBot: getBotSchema,
+  deleteBot: deleteBotSchema,
+  listBots: listBotsSchema,
+  getIntegration: getIntegrationSchema,
+  listIntegrations: listIntegrationsSchema,
+  deleteIntegration: deleteIntegrationSchema,
+  init: initSchema,
+  generate: generateSchema,
+  bundle: bundleSchema,
+  build: buildSchema,
+  serve: serveSchema,
+  deploy: deploySchema,
+  add: addSchema,
+  dev: devSchema
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  addSchema,
-  botRef,
-  buildSchema,
-  bundleSchema,
-  createBotSchema,
-  deleteBotSchema,
-  deleteIntegrationSchema,
-  deploySchema,
-  devSchema,
-  generateSchema,
-  globalSchema,
-  initSchema,
-  integrationRef,
-  listBotsSchema,
-  listIntegrationsSchema,
-  loggedInSchema,
-  loginSchema,
-  logoutSchema,
-  projectSchema,
-  readBotSchema,
-  readIntegrationSchema,
-  serveSchema
+  schemas
 });

package/dist/consts.js

@@ -52,7 +52,7 @@ const fromCliRootDir = {
   emptyIntegrationTemplate: import_path.default.join("templates", emptyIntegrationName)
 };
 const fromHomeDir = {
-  userCacheFile: "user.cache.json"
+  globalCacheFile: "global.cache.json"
 };
 const fromWorkDir = {
   definition: "integration.definition.ts"

package/dist/index.js

@@ -18,273 +18,30 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   mod
 ));
 var import_yargs_extra = __toESM(require("@bpinternal/yargs-extra"));
-var import_process = require("process");
-var app = __toESM(require("./app"));
-var config = __toESM(require("./config"));
+var import_command_definitions = __toESM(require("./command-definitions"));
+var import_command_implementations = __toESM(require("./command-implementations"));
+var tree = __toESM(require("./command-tree"));
+var errors = __toESM(require("./errors"));
 var import_logger = require("./logger");
-var pathutils = __toESM(require("./path-utils"));
-const CLI_ROOT_DIR = pathutils.join(__dirname, "..");
+var import_register_yargs = require("./register-yargs");
+var utils = __toESM(require("./utils"));
+const CLI_ROOT_DIR = utils.path.join(__dirname, "..");
 const logError = (thrown) => {
-  const error = app.errors.BotpressCLIError.map(thrown);
+  const error = errors.BotpressCLIError.map(thrown);
   new import_logger.Logger().error(error.message);
 };
 const onError = (thrown) => {
   logError(thrown);
-  (0, import_process.exit)(1);
+  process.exit(1);
 };
 const yargsFail = (msg) => {
   logError(`${msg}
 `);
   import_yargs_extra.default.showHelp();
-  (0, import_process.exit)(1);
+  process.exit(1);
 };
 process.on("uncaughtException", (thrown) => onError(thrown));
 process.on("unhandledRejection", (thrown) => onError(thrown));
-const parseArguments = (schema, argv) => {
-  const yargsEnv = (0, import_yargs_extra.parseEnv)(schema, "BP");
-  return (0, import_yargs_extra.cleanupConfig)(schema, { ...argv, ...yargsEnv });
-};
-import_yargs_extra.default.command(
-  "login",
-  "Login to Botpress Cloud",
-  () => import_yargs_extra.default.options(config.loginSchema),
-  async (argv) => {
-    try {
-      const parsed = parseArguments(config.loginSchema, argv);
-      const commands = await app.forUser({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-      await commands.login(parsed);
-      commands.teardown();
-    } catch (e) {
-      onError(e);
-    }
-  }
-).command(
-  "logout",
-  "Logout of Botpress Cloud",
-  () => import_yargs_extra.default.options(config.logoutSchema),
-  async (argv) => {
-    try {
-      const parsed = parseArguments(config.logoutSchema, argv);
-      const commands = await app.forUser({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-      await commands.logout();
-      commands.teardown();
-    } catch (e) {
-      onError(e);
-    }
-  }
-).command("bots", "bots related commands", (yargz) => {
-  yargz.command(
-    ["create", "new"],
-    "Create new bot",
-    () => yargz.options({ ...config.createBotSchema }),
-    async (argv) => {
-      try {
-        const parsed = parseArguments(config.createBotSchema, argv);
-        const commands = await app.forUser({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-        await commands.createBot(parsed);
-        commands.teardown();
-      } catch (e) {
-        onError(e);
-      }
-    }
-  ).command(
-    ["list", "ls"],
-    "List bots",
-    () => yargz.options({ ...config.listBotsSchema }),
-    async (argv) => {
-      try {
-        const parsed = parseArguments(config.listBotsSchema, argv);
-        const commands = await app.forUser({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-        await commands.listBots(parsed);
-        commands.teardown();
-      } catch (e) {
-        onError(e);
-      }
-    }
-  ).command(
-    "get <botRef>",
-    "Get bot",
-    () => yargz.positional("botRef", config.botRef).options({ ...config.readBotSchema }),
-    async (argv) => {
-      try {
-        const parsed = parseArguments(config.readBotSchema, argv);
-        const commands = await app.forUser({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-        await commands.getBot(argv.botRef, parsed);
-        commands.teardown();
-      } catch (e) {
-        onError(e);
-      }
-    }
-  ).command(
-    ["delete <botRef>", "rm <botRef>"],
-    "Delete bot",
-    () => yargz.positional("botRef", config.botRef).options({ ...config.deleteBotSchema }),
-    async (argv) => {
-      try {
-        const parsed = parseArguments(config.deleteBotSchema, argv);
-        const commands = await app.forUser({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-        await commands.deleteBot(argv.botRef, parsed);
-        commands.teardown();
-      } catch (e) {
-        onError(e);
-      }
-    }
-  );
-}).command("integrations", "integrations related commands", (yargz) => {
-  yargz.command(
-    ["list", "ls"],
-    "List integrations",
-    () => yargz.options({ ...config.listIntegrationsSchema }),
-    async (argv) => {
-      try {
-        const parsed = parseArguments(config.listIntegrationsSchema, argv);
-        const commands = await app.forUser({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-        await commands.listIntegrations(parsed);
-        commands.teardown();
-      } catch (e) {
-        onError(e);
-      }
-    }
-  ).command(
-    "get <integrationRef>",
-    "Get integration",
-    () => yargz.positional("integrationRef", config.integrationRef).options({ ...config.readIntegrationSchema }),
-    async (argv) => {
-      try {
-        const parsed = parseArguments(config.readIntegrationSchema, argv);
-        const commands = await app.forUser({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-        await commands.getIntegration(argv.integrationRef, parsed);
-        commands.teardown();
-      } catch (e) {
-        onError(e);
-      }
-    }
-  ).command(
-    ["delete <integrationRef>", "rm <integrationRef>"],
-    "Delete integration",
-    () => yargz.positional("integrationRef", config.integrationRef).options({ ...config.deleteIntegrationSchema }),
-    async (argv) => {
-      try {
-        const parsed = parseArguments(config.readIntegrationSchema, argv);
-        const commands = await app.forUser({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-        await commands.deleteIntegration(argv.integrationRef, parsed);
-        commands.teardown();
-      } catch (e) {
-        onError(e);
-      }
-    }
-  );
-}).command(
-  "init",
-  "Initialize a new project",
-  () => import_yargs_extra.default.options(config.initSchema),
-  async (argv) => {
-    try {
-      const parsed = parseArguments(config.initSchema, argv);
-      const commands = await app.forUser({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-      await commands.initProject(parsed);
-      commands.teardown();
-    } catch (e) {
-      onError(e);
-    }
-  }
-).command(
-  "bundle",
-  "Bundle a botpress project",
-  () => import_yargs_extra.default.options(config.bundleSchema),
-  async (argv) => {
-    try {
-      const parsed = parseArguments(config.bundleSchema, argv);
-      const commands = await app.forProject({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-      await commands.bundleProject(parsed);
-      commands.teardown();
-    } catch (e) {
-      onError(e);
-    }
-  }
-).command(
-  "gen",
-  "Generate typings for intellisense during development",
-  () => import_yargs_extra.default.options(config.generateSchema),
-  async (argv) => {
-    try {
-      const parsed = parseArguments(config.generateSchema, argv);
-      const commands = await app.forProject({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-      await commands.generateTypings(parsed);
-      commands.teardown();
-    } catch (e) {
-      onError(e);
-    }
-  }
-).command(
-  "build",
-  "Generate typings and bundle a botpress project",
-  () => import_yargs_extra.default.options(config.buildSchema),
-  async (argv) => {
-    try {
-      const parsed = parseArguments(config.buildSchema, argv);
-      const commands = await app.forProject({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-      await commands.buildProject(parsed);
-      commands.teardown();
-    } catch (e) {
-      onError(e);
-    }
-  }
-).command(
-  "serve",
-  "Serve your project locally",
-  () => import_yargs_extra.default.options(config.serveSchema),
-  async (argv) => {
-    try {
-      const parsed = parseArguments(config.serveSchema, argv);
-      const commands = await app.forProject({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-      await commands.serveProject(parsed);
-      commands.teardown();
-    } catch (e) {
-      onError(e);
-    }
-  }
-).command(
-  "deploy",
-  "Deploy your project",
-  () => import_yargs_extra.default.options(config.deploySchema),
-  async (argv) => {
-    try {
-      const parsed = parseArguments(config.deploySchema, argv);
-      const commands = await app.forProject({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-      await commands.deployProject(parsed);
-      commands.teardown();
-    } catch (e) {
-      onError(e);
-    }
-  }
-).command(
-  "dev",
-  "Run your project in dev mode",
-  () => import_yargs_extra.default.options(config.devSchema),
-  async (argv) => {
-    try {
-      const parsed = parseArguments(config.devSchema, argv);
-      const commands = await app.forProject({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-      await commands.devProject(parsed);
-      commands.teardown();
-    } catch (e) {
-      onError(e);
-    }
-  }
-).command(
-  "add <integrationRef>",
-  "Install an integration in your bot",
-  (yargz) => yargz.positional("integrationRef", config.integrationRef).options(config.addSchema),
-  async (argv) => {
-    try {
-      const parsed = parseArguments(config.addSchema, argv);
-      const commands = await app.forProject({ ...parsed, cliRootPath: CLI_ROOT_DIR });
-      await commands.installIntegration(argv.integrationRef, parsed);
-      commands.teardown();
-    } catch (e) {
-      onError(e);
-    }
-  }
-);
+const commands = tree.zipTree(import_command_definitions.default, import_command_implementations.default);
+(0, import_register_yargs.registerYargs)(import_yargs_extra.default, commands, { cliRootDir: CLI_ROOT_DIR });
 void import_yargs_extra.default.version(false).scriptName("bp").demandCommand(1, "You didn't provide any command. Use the --help flag to see the list of available commands.").recommendCommands().strict().help().fail(yargsFail).parse();

package/dist/logger/base-logger.js

@@ -89,7 +89,7 @@ class BaseLogger {
     this.opts = { ...DEFAULT_OPTIONS, ...opts };
   }
   log(message, props = {}) {
-    if (this.opts.json) {
+    if (this.opts.json && !props.stderr) {
       return;
     }
     const prefix = this._resolvePrefix(props.prefix);
@@ -102,44 +102,29 @@ class BaseLogger {
     }
     const { depth } = opts;
     const msg = import_util.default.inspect(data, { colors: true, depth });
-    this.print(msg);
+    this.log(msg);
   }
   debug(message, metadata) {
-    if (!this.opts.verbose || this.opts.json) {
+    if (!this.opts.verbose) {
       return;
     }
     this.log(import_chalk.default.grey(message), { metadata, prefix: { symbol: "\u25CF", fg: "blue" } });
   }
   started(message, metadata) {
-    if (this.opts.json) {
-      return;
-    }
     this.log(message, { metadata, prefix: { symbol: "\u25CB", fg: "purple" } });
   }
   success(message, metadata) {
-    if (this.opts.json) {
-      return;
-    }
     this.log(message, { metadata, prefix: { symbol: "\u2713", fg: "green" } });
   }
   warn(message, metadata) {
-    if (this.opts.json) {
-      return;
-    }
     this.log(message, { metadata, prefix: { symbol: "\u26A0", fg: "yellow" } });
   }
   error(message, metadata) {
-    if (this.opts.json) {
-      return;
-    }
-    this.log(message, { metadata, prefix: { symbol: "\xD7", fg: "red" } });
+    this.log(message, { metadata, prefix: { symbol: "\xD7", fg: "red" }, stderr: true });
   }
   box(message) {
-    if (this.opts.json) {
-      return;
-    }
     const box = (0, import_boxen.default)(message, BOX_OPTIONS);
-    this.print(box);
+    this.log(box);
   }
   _resolvePrefix(prefix) {
     if (!prefix) {

package/dist/logger/index.js

@@ -27,12 +27,13 @@ class Logger extends import_base_logger.BaseLogger {
   static _previousLine;
   print(message, props = {}) {
     this.cleanup();
+    const log = props.stderr ? console.error : console.info;
     const { metadata, prefix } = props;
     if (prefix) {
-      console.log(prefix, message, metadata ?? "");
+      log(prefix, message, metadata ?? "");
       return;
     }
-    console.log(message, metadata ?? "");
+    log(message, metadata ?? "");
   }
   line() {
     this.cleanup();

package/dist/worker/child-entrypoint.js

@@ -27,7 +27,7 @@ __export(child_entrypoint_exports, {
   ENTRY_POINT: () => ENTRY_POINT
 });
 module.exports = __toCommonJS(child_entrypoint_exports);
-var requireutils = __toESM(require("../require-utils"));
+var utils = __toESM(require("../utils"));
 var import_config = require("./config");
 var import_is_child = require("./is-child");
 const ENTRY_POINT = __filename;
@@ -38,10 +38,10 @@ const childProcessEntrypoint = async (_props) => {
   }
   const config = import_config.configSchema.parse(JSON.parse(rawConfig));
   if (config.type === "code") {
-    requireutils.requireJsCode(config.code);
+    utils.require.requireJsCode(config.code);
   }
   if (config.type === "file") {
-    requireutils.requireJsFile(config.file);
+    utils.require.requireJsFile(config.file);
   }
 };
 if (import_is_child.processProps.type === "child") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/cli",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "description": "Botpress CLI",
   "scripts": {
     "build": "pnpm run type-check && pnpm run bundle && pnpm run template:gen && pnpm run template:type-check",
@@ -19,7 +19,7 @@
   },
   "main": "dist/index.js",
   "dependencies": {
-    "@botpress/client": "0.0.10",
+    "@botpress/client": "0.0.11",
     "@bpinternal/yargs-extra": "^0.0.2",
     "@parcel/watcher": "^2.1.0",
     "@types/lodash": "^4.14.191",
@@ -45,7 +45,7 @@
     "zod-to-json-schema": "^3.20.1"
   },
   "devDependencies": {
-    "@botpress/sdk": "0.0.8",
+    "@botpress/sdk": "0.0.9",
     "@types/bluebird": "^3.5.38",
     "@types/prompts": "^2.0.14",
     "@types/semver": "^7.3.11",

package/templates/echo-bot/package.json

@@ -10,8 +10,8 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@botpress/client": "0.0.10",
-    "@botpress/sdk": "0.0.8",
+    "@botpress/client": "0.0.11",
+    "@botpress/sdk": "0.0.9",
     "zod": "^3.20.6"
   },
   "devDependencies": {

package/templates/empty-integration/package.json

@@ -10,8 +10,8 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@botpress/client": "0.0.10",
-    "@botpress/sdk": "0.0.8",
+    "@botpress/client": "0.0.11",
+    "@botpress/sdk": "0.0.9",
     "zod": "^3.20.6"
   },
   "devDependencies": {