@botpress/cli 0.0.11 → 0.0.13

package/dist/code-generation/integration-impl.js

@@ -28,7 +28,6 @@ __export(integration_impl_exports, {
 });
 module.exports = __toCommonJS(integration_impl_exports);
 var import_bluebird = __toESM(require("bluebird"));
-var import_utils = require("../utils");
 var import_action = require("./action");
 var import_channel = require("./channel");
 var import_configuration = require("./configuration");
@@ -74,7 +73,7 @@ class IntegrationImplementationIndexModule extends import_module.Module {
   get content() {
     let content = import_const.GENERATED_HEADER;
     const { configModule, actionsModule, channelsModule, eventsModule } = this;
-    content += 'import { Integration } from "@botpress/sdk";\n\n';
+    content += 'import * as sdk from "@botpress/sdk";\n\n';
     const configImport = configModule.import(this);
     const actionsImport = actionsModule.import(this);
     const channelsImport = channelsModule.import(this);
@@ -96,10 +95,8 @@ class IntegrationImplementationIndexModule extends import_module.Module {
     content += `export * as ${eventsModule.name} from "./${eventsImport}";
 `;
     content += "\n";
-    const { name } = this.integrationID;
-    const className = import_utils.strings.pascalCase(name);
-    content += `export class Integration${className}
-      extends Integration<${configModule.name}.${configModule.exports}, ${actionsModule.name}.${actionsModule.exports}, ${channelsModule.name}.${channelsModule.exports}, ${eventsModule.name}.${eventsModule.exports}> {}
+    content += `export class Integration
+      extends sdk.Integration<${configModule.name}.${configModule.exports}, ${actionsModule.name}.${actionsModule.exports}, ${channelsModule.name}.${channelsModule.exports}, ${eventsModule.name}.${eventsModule.exports}> {}
 `;
     return content;
   }

package/dist/command-implementations/init-command.js

@@ -46,26 +46,41 @@ class InitCommand extends import_global_command.GlobalCommand {
       }
       projectType = promptedType;
     }
+    let name = this.argv.name;
+    if (!name) {
+      const defaultName = projectType === "bot" ? consts.echoBotDirName : consts.emptyIntegrationDirName;
+      const promptMessage = `What is the name of your ${projectType}?`;
+      const promptedName = await this.prompt.text(promptMessage, { initial: defaultName });
+      if (!promptedName) {
+        throw new errors.ParamRequiredError("Project Name");
+      }
+      name = promptedName;
+    }
     const workDir = utils.path.absoluteFrom(utils.path.cwd(), this.argv.workDir);
     if (projectType === "bot") {
-      const destination2 = pathlib.join(workDir, this.argv.name ?? consts.echoBotName);
-      const exist2 = await this._checkIfDestinationExists(destination2);
-      if (exist2) {
-        return;
-      }
-      await fs.promises.cp(this.globalPaths.abs.echoBotTemplate, destination2, { recursive: true });
+      await this._copy({ srcDir: this.globalPaths.abs.echoBotTemplate, destDir: workDir, name });
       this.logger.success(`Bot project initialized in ${import_chalk.default.bold(workDir)}`);
       return;
     }
-    const destination = pathlib.join(workDir, this.argv.name ?? consts.emptyIntegrationName);
+    await this._copy({ srcDir: this.globalPaths.abs.emptyIntegrationTemplate, destDir: workDir, name });
+    this.logger.success(`Integration project initialized in ${import_chalk.default.bold(this.argv.workDir)}`);
+    return;
+  }
+  _copy = async (props) => {
+    const { srcDir, destDir, name } = props;
+    const destination = pathlib.join(destDir, props.name);
     const exist = await this._checkIfDestinationExists(destination);
     if (exist) {
       return;
     }
-    await fs.promises.cp(this.globalPaths.abs.emptyIntegrationTemplate, destination, { recursive: true });
-    this.logger.success(`Integration project initialized in ${import_chalk.default.bold(this.argv.workDir)}`);
-    return;
-  }
+    await fs.promises.cp(srcDir, destination, { recursive: true });
+    const pkgJsonPath = pathlib.join(destination, "package.json");
+    const strContent = await fs.promises.readFile(pkgJsonPath, "utf-8");
+    const { name: _, ...json } = JSON.parse(strContent);
+    const pkgJsonName = utils.strings.snakeCase(name);
+    const updatedJson = { name: pkgJsonName, ...json };
+    await fs.promises.writeFile(pkgJsonPath, JSON.stringify(updatedJson, null, 2));
+  };
   _checkIfDestinationExists = async (destination) => {
     if (fs.existsSync(destination)) {
       const override = await this.prompt.confirm(

package/dist/consts.js

@@ -29,8 +29,8 @@ __export(consts_exports, {
   defaultBotpressHome: () => defaultBotpressHome,
   defaultEntrypoint: () => defaultEntrypoint,
   defaultOutputFolder: () => defaultOutputFolder,
-  echoBotName: () => echoBotName,
-  emptyIntegrationName: () => emptyIntegrationName,
+  echoBotDirName: () => echoBotDirName,
+  emptyIntegrationDirName: () => emptyIntegrationDirName,
   fromCliRootDir: () => fromCliRootDir,
   fromHomeDir: () => fromHomeDir,
   fromOutDir: () => fromOutDir,
@@ -44,12 +44,12 @@ const defaultOutputFolder = ".botpress";
 const defaultEntrypoint = import_path.default.join("src", "index.ts");
 const defaultBotpressApi = "https://api.botpress.cloud";
 const defaultBotpressApp = "https://app.botpress.cloud";
-const echoBotName = "echo-bot";
-const emptyIntegrationName = "empty-integration";
+const echoBotDirName = "echo-bot";
+const emptyIntegrationDirName = "empty-integration";
 const fromCliRootDir = {
   packageJson: "package.json",
-  echoBotTemplate: import_path.default.join("templates", echoBotName),
-  emptyIntegrationTemplate: import_path.default.join("templates", emptyIntegrationName)
+  echoBotTemplate: import_path.default.join("templates", echoBotDirName),
+  emptyIntegrationTemplate: import_path.default.join("templates", emptyIntegrationDirName)
 };
 const fromHomeDir = {
   globalCacheFile: "global.cache.json"
@@ -71,8 +71,8 @@ const fromOutDir = {
   defaultBotpressHome,
   defaultEntrypoint,
   defaultOutputFolder,
-  echoBotName,
-  emptyIntegrationName,
+  echoBotDirName,
+  emptyIntegrationDirName,
   fromCliRootDir,
   fromHomeDir,
   fromOutDir,

package/dist/utils/prompt-utils.js

@@ -68,6 +68,15 @@ class CLIPrompt {
     });
     return prompted ? prompted : void 0;
   }
+  async text(message, opts) {
+    const { prompted } = await (0, import_prompts.default)({
+      type: "text",
+      name: "prompted",
+      message,
+      initial: opts?.initial
+    });
+    return prompted ? prompted : void 0;
+  }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/utils/string-utils.js

@@ -18,21 +18,40 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var string_utils_exports = {};
 __export(string_utils_exports, {
+  camelCase: () => camelCase,
   kebabCase: () => kebabCase,
-  pascalCase: () => pascalCase
+  pascalCase: () => pascalCase,
+  snakeCase: () => snakeCase
 });
 module.exports = __toCommonJS(string_utils_exports);
-const capitalizeFirstLetter = (string) => string.charAt(0).toUpperCase() + string.slice(1);
-const pascalCase = (string) => {
-  const words = string.split(/[-_]/);
+const capitalizeFirstLetter = (text) => text.charAt(0).toUpperCase() + text.slice(1);
+const splitHyphens = (tokens) => tokens.flatMap((token) => token.split("-"));
+const splitUnderscores = (tokens) => tokens.flatMap((token) => token.split("_"));
+const splitCaseChange = (tokens) => tokens.flatMap((token) => token.split(/(?<=[a-z])(?=[A-Z])/));
+const split = (tokens) => {
+  const steps = [splitHyphens, splitUnderscores, splitCaseChange];
+  return steps.reduce((acc, step) => step(acc), tokens);
+};
+const pascalCase = (text) => {
+  const words = split([text]);
   return words.map(capitalizeFirstLetter).join("");
 };
-const kebabCase = (string) => {
-  const words = string.split(/(?<=[a-z])(?=[A-Z])/);
+const kebabCase = (text) => {
+  const words = split([text]);
   return words.map((word) => word.toLowerCase()).join("-");
 };
+const snakeCase = (text) => {
+  const words = split([text]);
+  return words.map((word) => word.toLowerCase()).join("_");
+};
+const camelCase = (text) => {
+  const [first, ...words] = split([text]);
+  return [first.toLowerCase(), ...words.map(capitalizeFirstLetter)].join("");
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  camelCase,
   kebabCase,
-  pascalCase
+  pascalCase,
+  snakeCase
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/cli",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "description": "Botpress CLI",
   "scripts": {
     "build": "pnpm run type-check && pnpm run bundle && pnpm run template:gen && pnpm run template:type-check",

package/templates/echo-bot/package.json

@@ -1,7 +1,6 @@
 {
-  "name": "@botpresshub/echo-bot",
+  "name": "echo-bot",
   "version": "0.1.0",
-  "description": "Bot that answers with the received message",
   "scripts": {
     "type-check": "tsc --noEmit"
   },
@@ -17,6 +16,7 @@
   "devDependencies": {
     "@types/node": "^18.11.17",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.4"
+    "typescript": "^4.9.4",
+    "@tsconfig/node18-strictest": "^1.0.0"
   }
 }

package/templates/empty-integration/.botpress/implementation/index.ts

@@ -2,7 +2,7 @@
 // This file is generated
 // Do not edit this file
 
-import { Integration } from "@botpress/sdk";
+import * as sdk from "@botpress/sdk";
 
 import type * as configuration from "./configuration";
 import type * as actions from "./actions/index";
@@ -13,5 +13,5 @@ export * as actions from "./actions/index";
 export * as channels from "./channels/index";
 export * as events from "./events/index";
 
-export class IntegrationEmpty
-      extends Integration<configuration.Configuration, actions.Actions, channels.Channels, events.Events> {}
+export class Integration
+      extends sdk.Integration<configuration.Configuration, actions.Actions, channels.Channels, events.Events> {}

package/templates/empty-integration/integration.definition.ts

@@ -1,10 +1,10 @@
 import { IntegrationDefinition, messages } from '@botpress/sdk'
-import { version } from './package.json'
+import { version, name } from './package.json'
 
 export default new IntegrationDefinition({
-  name: 'empty',
+  name,
   version,
-  public: true,
+  public: false,
   channels: {
     channel: {
       messages: { ...messages.defaults },

package/templates/empty-integration/package.json

@@ -1,7 +1,6 @@
 {
-  "name": "@botpresshub/empty-integration",
+  "name": "empty-integration",
   "version": "0.1.0",
-  "description": "Integration with no content",
   "scripts": {
     "type-check": "tsc --noEmit"
   },
@@ -17,6 +16,7 @@
   "devDependencies": {
     "@types/node": "^18.11.17",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.4"
+    "typescript": "^4.9.4",
+    "@tsconfig/node18-strictest": "^1.0.0"
   }
 }

package/templates/empty-integration/src/index.ts

@@ -9,9 +9,19 @@ class NotImplementedError extends Error {
   }
 }
 
-export default new botpress.IntegrationEmpty({
-  register: async () => {},
-  unregister: async () => {},
+export default new botpress.Integration({
+  register: async () => {
+    /**
+     * This is called when a bot installs the integration.
+     * You should use this handler to instanciate ressources in the external service and ensure that the configuration is valid.
+     */
+  },
+  unregister: async () => {
+    /**
+     * This is called when a bot removes the integration.
+     * You should use this handler to instanciate ressources in the external service and ensure that the configuration is valid.
+     */
+  },
   actions: {},
   channels: {
     channel: {

package/templates/echo-bot/readme.md

@@ -1,5 +0,0 @@
-# Echo Bot
-
-## Description
-
-Bot that answers with the received message.

package/templates/empty-integration/readme.md

@@ -1,5 +0,0 @@
-# Empty Integration
-
-## Description
-
-Integration with no content.