@botpress/cli 0.8.11 → 0.8.13

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

@@ -46,26 +46,54 @@ 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") {
-      await this._copy({ srcDir: this.globalPaths.abs.echoBotTemplate, destDir: workDir, name });
-      this.logger.success(`Bot project initialized in ${import_chalk.default.bold(workDir)}`);
+      await this._initBot({ workDir });
       return;
     }
-    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)}`);
+    await this._initIntegration({ workDir });
     return;
   }
+  _initBot = async (args) => {
+    const { workDir } = args;
+    const name = await this._getName("bot", consts.echoBotDirName);
+    await this._copy({ srcDir: this.globalPaths.abs.echoBotTemplate, destDir: workDir, name });
+    this.logger.success(`Bot project initialized in ${import_chalk.default.bold(workDir)}`);
+  };
+  _initIntegration = async (args) => {
+    const { workDir } = args;
+    const template = await this.prompt.select("Which template do you want to use?", {
+      choices: [
+        { title: "Empty Integration", value: consts.emptyIntegrationDirName },
+        { title: "Hello World", value: consts.helloWorldIntegrationDirName },
+        { title: "Webhook Message", value: consts.webhookMessageIntegrationDirName }
+      ],
+      default: consts.emptyIntegrationDirName
+    });
+    let srcDirPath;
+    if (template === consts.helloWorldIntegrationDirName) {
+      srcDirPath = this.globalPaths.abs.helloWorldIntegrationTemplate;
+    } else if (template === consts.webhookMessageIntegrationDirName) {
+      srcDirPath = this.globalPaths.abs.webhookMessageIntegrationTemplate;
+    } else {
+      srcDirPath = this.globalPaths.abs.emptyIntegrationTemplate;
+    }
+    const name = await this._getName("integration", template ?? consts.emptyIntegrationDirName);
+    await this._copy({ srcDir: srcDirPath, destDir: workDir, name });
+    this.logger.success(`Integration project initialized in ${import_chalk.default.bold(this.argv.workDir)}`);
+    return;
+  };
+  _getName = async (projectType, defaultName) => {
+    if (this.argv.name) {
+      return this.argv.name;
+    }
+    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");
+    }
+    return promptedName;
+  };
   _copy = async (props) => {
     const { srcDir, destDir, name } = props;
     const dirName = utils.casing.to.kebabCase(name);

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/command-implementations/init-command.ts"],
-  "sourcesContent": ["import chalk from 'chalk'\nimport * as fs from 'fs'\nimport * as pathlib from 'path'\nimport type commandDefinitions from '../command-definitions'\nimport * as consts from '../consts'\nimport * as errors from '../errors'\nimport * as utils from '../utils'\nimport { GlobalCommand } from './global-command'\n\nexport type InitCommandDefinition = typeof commandDefinitions.init\nexport class InitCommand extends GlobalCommand<InitCommandDefinition> {\n  public async run(): Promise<void> {\n    let { type: projectType } = this.argv\n\n    if (!projectType) {\n      const promptedType = await this.prompt.select('What type of project do you wish to initialize?', {\n        choices: (['bot', 'integration'] as const).map((t) => ({ title: t, value: t })),\n      })\n\n      if (!promptedType) {\n        throw new errors.ParamRequiredError('Project Type')\n      }\n\n      projectType = promptedType\n    }\n\n    let name = this.argv.name\n    if (!name) {\n      const defaultName = projectType === 'bot' ? consts.echoBotDirName : consts.emptyIntegrationDirName\n      const promptMessage = `What is the name of your ${projectType}?`\n      const promptedName = await this.prompt.text(promptMessage, { initial: defaultName })\n      if (!promptedName) {\n        throw new errors.ParamRequiredError('Project Name')\n      }\n      name = promptedName\n    }\n\n    const workDir = utils.path.absoluteFrom(utils.path.cwd(), this.argv.workDir)\n\n    if (projectType === 'bot') {\n      await this._copy({ srcDir: this.globalPaths.abs.echoBotTemplate, destDir: workDir, name })\n      this.logger.success(`Bot project initialized in ${chalk.bold(workDir)}`)\n      return\n    }\n\n    await this._copy({ srcDir: this.globalPaths.abs.emptyIntegrationTemplate, destDir: workDir, name })\n    this.logger.success(`Integration project initialized in ${chalk.bold(this.argv.workDir)}`)\n    return\n  }\n\n  private _copy = async (props: { srcDir: string; destDir: string; name: string }) => {\n    const { srcDir, destDir, name } = props\n\n    const dirName = utils.casing.to.kebabCase(name)\n    const destination = pathlib.join(destDir, dirName)\n\n    const exist = await this._checkIfDestinationExists(destination)\n    if (exist) {\n      return\n    }\n\n    await fs.promises.cp(srcDir, destination, { recursive: true })\n\n    const pkgJsonPath = pathlib.join(destination, 'package.json')\n    const strContent = await fs.promises.readFile(pkgJsonPath, 'utf-8')\n    const { name: _, integrationName: __, ...json } = JSON.parse(strContent)\n\n    const pkgJsonName = utils.casing.to.snakeCase(name)\n    const updatedJson = { name: pkgJsonName, integrationName: name, ...json }\n    await fs.promises.writeFile(pkgJsonPath, JSON.stringify(updatedJson, null, 2))\n  }\n\n  private _checkIfDestinationExists = async (destination: string) => {\n    if (fs.existsSync(destination)) {\n      const override = await this.prompt.confirm(\n        `Directory ${chalk.bold(destination)} already exists. Do you want to overwrite it?`\n      )\n      if (!override) {\n        this.logger.log('Aborting')\n        return true\n      }\n    }\n    return false\n  }\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAkB;AAClB,SAAoB;AACpB,cAAyB;AAEzB,aAAwB;AACxB,aAAwB;AACxB,YAAuB;AACvB,4BAA8B;AAGvB,MAAM,oBAAoB,oCAAqC;AAAA,EACpE,MAAa,MAAqB;AAChC,QAAI,EAAE,MAAM,YAAY,IAAI,KAAK;AAEjC,QAAI,CAAC,aAAa;AAChB,YAAM,eAAe,MAAM,KAAK,OAAO,OAAO,mDAAmD;AAAA,QAC/F,SAAU,CAAC,OAAO,aAAa,EAAY,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,EAAE,EAAE;AAAA,MAChF,CAAC;AAED,UAAI,CAAC,cAAc;AACjB,cAAM,IAAI,OAAO,mBAAmB,cAAc;AAAA,MACpD;AAEA,oBAAc;AAAA,IAChB;AAEA,QAAI,OAAO,KAAK,KAAK;AACrB,QAAI,CAAC,MAAM;AACT,YAAM,cAAc,gBAAgB,QAAQ,OAAO,iBAAiB,OAAO;AAC3E,YAAM,gBAAgB,4BAA4B;AAClD,YAAM,eAAe,MAAM,KAAK,OAAO,KAAK,eAAe,EAAE,SAAS,YAAY,CAAC;AACnF,UAAI,CAAC,cAAc;AACjB,cAAM,IAAI,OAAO,mBAAmB,cAAc;AAAA,MACpD;AACA,aAAO;AAAA,IACT;AAEA,UAAM,UAAU,MAAM,KAAK,aAAa,MAAM,KAAK,IAAI,GAAG,KAAK,KAAK,OAAO;AAE3E,QAAI,gBAAgB,OAAO;AACzB,YAAM,KAAK,MAAM,EAAE,QAAQ,KAAK,YAAY,IAAI,iBAAiB,SAAS,SAAS,KAAK,CAAC;AACzF,WAAK,OAAO,QAAQ,8BAA8B,aAAAA,QAAM,KAAK,OAAO,GAAG;AACvE;AAAA,IACF;AAEA,UAAM,KAAK,MAAM,EAAE,QAAQ,KAAK,YAAY,IAAI,0BAA0B,SAAS,SAAS,KAAK,CAAC;AAClG,SAAK,OAAO,QAAQ,sCAAsC,aAAAA,QAAM,KAAK,KAAK,KAAK,OAAO,GAAG;AACzF;AAAA,EACF;AAAA,EAEQ,QAAQ,OAAO,UAA6D;AAClF,UAAM,EAAE,QAAQ,SAAS,KAAK,IAAI;AAElC,UAAM,UAAU,MAAM,OAAO,GAAG,UAAU,IAAI;AAC9C,UAAM,cAAc,QAAQ,KAAK,SAAS,OAAO;AAEjD,UAAM,QAAQ,MAAM,KAAK,0BAA0B,WAAW;AAC9D,QAAI,OAAO;AACT;AAAA,IACF;AAEA,UAAM,GAAG,SAAS,GAAG,QAAQ,aAAa,EAAE,WAAW,KAAK,CAAC;AAE7D,UAAM,cAAc,QAAQ,KAAK,aAAa,cAAc;AAC5D,UAAM,aAAa,MAAM,GAAG,SAAS,SAAS,aAAa,OAAO;AAClE,UAAM,EAAE,MAAM,GAAG,iBAAiB,OAAO,KAAK,IAAI,KAAK,MAAM,UAAU;AAEvE,UAAM,cAAc,MAAM,OAAO,GAAG,UAAU,IAAI;AAClD,UAAM,cAAc,EAAE,MAAM,aAAa,iBAAiB,MAAM,GAAG,KAAK;AACxE,UAAM,GAAG,SAAS,UAAU,aAAa,KAAK,UAAU,aAAa,MAAM,CAAC,CAAC;AAAA,EAC/E;AAAA,EAEQ,4BAA4B,OAAO,gBAAwB;AACjE,QAAI,GAAG,WAAW,WAAW,GAAG;AAC9B,YAAM,WAAW,MAAM,KAAK,OAAO;AAAA,QACjC,aAAa,aAAAA,QAAM,KAAK,WAAW;AAAA,MACrC;AACA,UAAI,CAAC,UAAU;AACb,aAAK,OAAO,IAAI,UAAU;AAC1B,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;",
+  "sourcesContent": ["import chalk from 'chalk'\nimport * as fs from 'fs'\nimport * as pathlib from 'path'\nimport type commandDefinitions from '../command-definitions'\nimport * as consts from '../consts'\nimport * as errors from '../errors'\nimport * as utils from '../utils'\nimport { GlobalCommand } from './global-command'\n\ntype ProjectType = 'bot' | 'integration'\n\nexport type InitCommandDefinition = typeof commandDefinitions.init\nexport class InitCommand extends GlobalCommand<InitCommandDefinition> {\n  public async run(): Promise<void> {\n    let { type: projectType } = this.argv\n\n    if (!projectType) {\n      const promptedType = await this.prompt.select('What type of project do you wish to initialize?', {\n        choices: (['bot', 'integration'] as const).map((t) => ({ title: t, value: t })),\n      })\n\n      if (!promptedType) {\n        throw new errors.ParamRequiredError('Project Type')\n      }\n\n      projectType = promptedType\n    }\n\n    const workDir = utils.path.absoluteFrom(utils.path.cwd(), this.argv.workDir)\n\n    if (projectType === 'bot') {\n      await this._initBot({ workDir })\n      return\n    }\n\n    await this._initIntegration({ workDir })\n    return\n  }\n\n  private _initBot = async (args: { workDir: string }) => {\n    const { workDir } = args\n    const name = await this._getName('bot', consts.echoBotDirName)\n    await this._copy({ srcDir: this.globalPaths.abs.echoBotTemplate, destDir: workDir, name })\n    this.logger.success(`Bot project initialized in ${chalk.bold(workDir)}`)\n  }\n\n  private _initIntegration = async (args: { workDir: string }) => {\n    const { workDir } = args\n\n    const template = await this.prompt.select('Which template do you want to use?', {\n      choices: [\n        { title: 'Empty Integration', value: consts.emptyIntegrationDirName },\n        { title: 'Hello World', value: consts.helloWorldIntegrationDirName },\n        { title: 'Webhook Message', value: consts.webhookMessageIntegrationDirName },\n      ],\n      default: consts.emptyIntegrationDirName,\n    })\n\n    let srcDirPath: string\n    if (template === consts.helloWorldIntegrationDirName) {\n      srcDirPath = this.globalPaths.abs.helloWorldIntegrationTemplate\n    } else if (template === consts.webhookMessageIntegrationDirName) {\n      srcDirPath = this.globalPaths.abs.webhookMessageIntegrationTemplate\n    } else {\n      srcDirPath = this.globalPaths.abs.emptyIntegrationTemplate\n    }\n\n    const name = await this._getName('integration', template ?? consts.emptyIntegrationDirName)\n\n    await this._copy({ srcDir: srcDirPath, destDir: workDir, name })\n    this.logger.success(`Integration project initialized in ${chalk.bold(this.argv.workDir)}`)\n    return\n  }\n\n  private _getName = async (projectType: ProjectType, defaultName: string): Promise<string> => {\n    if (this.argv.name) {\n      return this.argv.name\n    }\n    const promptMessage = `What is the name of your ${projectType}?`\n    const promptedName = await this.prompt.text(promptMessage, { initial: defaultName })\n    if (!promptedName) {\n      throw new errors.ParamRequiredError('Project Name')\n    }\n    return promptedName\n  }\n\n  private _copy = async (props: { srcDir: string; destDir: string; name: string }) => {\n    const { srcDir, destDir, name } = props\n\n    const dirName = utils.casing.to.kebabCase(name)\n    const destination = pathlib.join(destDir, dirName)\n\n    const exist = await this._checkIfDestinationExists(destination)\n    if (exist) {\n      return\n    }\n\n    await fs.promises.cp(srcDir, destination, { recursive: true })\n\n    const pkgJsonPath = pathlib.join(destination, 'package.json')\n    const strContent = await fs.promises.readFile(pkgJsonPath, 'utf-8')\n    const { name: _, integrationName: __, ...json } = JSON.parse(strContent)\n\n    const pkgJsonName = utils.casing.to.snakeCase(name)\n    const updatedJson = { name: pkgJsonName, integrationName: name, ...json }\n    await fs.promises.writeFile(pkgJsonPath, JSON.stringify(updatedJson, null, 2))\n  }\n\n  private _checkIfDestinationExists = async (destination: string) => {\n    if (fs.existsSync(destination)) {\n      const override = await this.prompt.confirm(\n        `Directory ${chalk.bold(destination)} already exists. Do you want to overwrite it?`\n      )\n      if (!override) {\n        this.logger.log('Aborting')\n        return true\n      }\n    }\n    return false\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAkB;AAClB,SAAoB;AACpB,cAAyB;AAEzB,aAAwB;AACxB,aAAwB;AACxB,YAAuB;AACvB,4BAA8B;AAKvB,MAAM,oBAAoB,oCAAqC;AAAA,EACpE,MAAa,MAAqB;AAChC,QAAI,EAAE,MAAM,YAAY,IAAI,KAAK;AAEjC,QAAI,CAAC,aAAa;AAChB,YAAM,eAAe,MAAM,KAAK,OAAO,OAAO,mDAAmD;AAAA,QAC/F,SAAU,CAAC,OAAO,aAAa,EAAY,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,EAAE,EAAE;AAAA,MAChF,CAAC;AAED,UAAI,CAAC,cAAc;AACjB,cAAM,IAAI,OAAO,mBAAmB,cAAc;AAAA,MACpD;AAEA,oBAAc;AAAA,IAChB;AAEA,UAAM,UAAU,MAAM,KAAK,aAAa,MAAM,KAAK,IAAI,GAAG,KAAK,KAAK,OAAO;AAE3E,QAAI,gBAAgB,OAAO;AACzB,YAAM,KAAK,SAAS,EAAE,QAAQ,CAAC;AAC/B;AAAA,IACF;AAEA,UAAM,KAAK,iBAAiB,EAAE,QAAQ,CAAC;AACvC;AAAA,EACF;AAAA,EAEQ,WAAW,OAAO,SAA8B;AACtD,UAAM,EAAE,QAAQ,IAAI;AACpB,UAAM,OAAO,MAAM,KAAK,SAAS,OAAO,OAAO,cAAc;AAC7D,UAAM,KAAK,MAAM,EAAE,QAAQ,KAAK,YAAY,IAAI,iBAAiB,SAAS,SAAS,KAAK,CAAC;AACzF,SAAK,OAAO,QAAQ,8BAA8B,aAAAA,QAAM,KAAK,OAAO,GAAG;AAAA,EACzE;AAAA,EAEQ,mBAAmB,OAAO,SAA8B;AAC9D,UAAM,EAAE,QAAQ,IAAI;AAEpB,UAAM,WAAW,MAAM,KAAK,OAAO,OAAO,sCAAsC;AAAA,MAC9E,SAAS;AAAA,QACP,EAAE,OAAO,qBAAqB,OAAO,OAAO,wBAAwB;AAAA,QACpE,EAAE,OAAO,eAAe,OAAO,OAAO,6BAA6B;AAAA,QACnE,EAAE,OAAO,mBAAmB,OAAO,OAAO,iCAAiC;AAAA,MAC7E;AAAA,MACA,SAAS,OAAO;AAAA,IAClB,CAAC;AAED,QAAI;AACJ,QAAI,aAAa,OAAO,8BAA8B;AACpD,mBAAa,KAAK,YAAY,IAAI;AAAA,IACpC,WAAW,aAAa,OAAO,kCAAkC;AAC/D,mBAAa,KAAK,YAAY,IAAI;AAAA,IACpC,OAAO;AACL,mBAAa,KAAK,YAAY,IAAI;AAAA,IACpC;AAEA,UAAM,OAAO,MAAM,KAAK,SAAS,eAAe,YAAY,OAAO,uBAAuB;AAE1F,UAAM,KAAK,MAAM,EAAE,QAAQ,YAAY,SAAS,SAAS,KAAK,CAAC;AAC/D,SAAK,OAAO,QAAQ,sCAAsC,aAAAA,QAAM,KAAK,KAAK,KAAK,OAAO,GAAG;AACzF;AAAA,EACF;AAAA,EAEQ,WAAW,OAAO,aAA0B,gBAAyC;AAC3F,QAAI,KAAK,KAAK,MAAM;AAClB,aAAO,KAAK,KAAK;AAAA,IACnB;AACA,UAAM,gBAAgB,4BAA4B;AAClD,UAAM,eAAe,MAAM,KAAK,OAAO,KAAK,eAAe,EAAE,SAAS,YAAY,CAAC;AACnF,QAAI,CAAC,cAAc;AACjB,YAAM,IAAI,OAAO,mBAAmB,cAAc;AAAA,IACpD;AACA,WAAO;AAAA,EACT;AAAA,EAEQ,QAAQ,OAAO,UAA6D;AAClF,UAAM,EAAE,QAAQ,SAAS,KAAK,IAAI;AAElC,UAAM,UAAU,MAAM,OAAO,GAAG,UAAU,IAAI;AAC9C,UAAM,cAAc,QAAQ,KAAK,SAAS,OAAO;AAEjD,UAAM,QAAQ,MAAM,KAAK,0BAA0B,WAAW;AAC9D,QAAI,OAAO;AACT;AAAA,IACF;AAEA,UAAM,GAAG,SAAS,GAAG,QAAQ,aAAa,EAAE,WAAW,KAAK,CAAC;AAE7D,UAAM,cAAc,QAAQ,KAAK,aAAa,cAAc;AAC5D,UAAM,aAAa,MAAM,GAAG,SAAS,SAAS,aAAa,OAAO;AAClE,UAAM,EAAE,MAAM,GAAG,iBAAiB,OAAO,KAAK,IAAI,KAAK,MAAM,UAAU;AAEvE,UAAM,cAAc,MAAM,OAAO,GAAG,UAAU,IAAI;AAClD,UAAM,cAAc,EAAE,MAAM,aAAa,iBAAiB,MAAM,GAAG,KAAK;AACxE,UAAM,GAAG,SAAS,UAAU,aAAa,KAAK,UAAU,aAAa,MAAM,CAAC,CAAC;AAAA,EAC/E;AAAA,EAEQ,4BAA4B,OAAO,gBAAwB;AACjE,QAAI,GAAG,WAAW,WAAW,GAAG;AAC9B,YAAM,WAAW,MAAM,KAAK,OAAO;AAAA,QACjC,aAAa,aAAAA,QAAM,KAAK,WAAW;AAAA,MACrC;AACA,UAAI,CAAC,UAAU;AACb,aAAK,OAAO,IAAI,UAAU;AAC1B,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;",
   "names": ["chalk"]
 }

package/dist/consts.js

@@ -36,7 +36,9 @@ __export(consts_exports, {
   fromCliRootDir: () => fromCliRootDir,
   fromHomeDir: () => fromHomeDir,
   fromOutDir: () => fromOutDir,
-  fromWorkDir: () => fromWorkDir
+  fromWorkDir: () => fromWorkDir,
+  helloWorldIntegrationDirName: () => helloWorldIntegrationDirName,
+  webhookMessageIntegrationDirName: () => webhookMessageIntegrationDirName
 });
 module.exports = __toCommonJS(consts_exports);
 var import_os = __toESM(require("os"));
@@ -51,9 +53,13 @@ const defaultTunnelUrl = "https://tunnel.botpress.cloud";
 const cliRootDir = import_root.CLI_ROOT_DIR;
 const echoBotDirName = "echo-bot";
 const emptyIntegrationDirName = "empty-integration";
+const helloWorldIntegrationDirName = "hello-world";
+const webhookMessageIntegrationDirName = "webhook-message";
 const fromCliRootDir = {
   echoBotTemplate: import_path.default.join("templates", echoBotDirName),
-  emptyIntegrationTemplate: import_path.default.join("templates", emptyIntegrationDirName)
+  emptyIntegrationTemplate: import_path.default.join("templates", emptyIntegrationDirName),
+  helloWorldIntegrationTemplate: import_path.default.join("templates", helloWorldIntegrationDirName),
+  webhookMessageIntegrationTemplate: import_path.default.join("templates", webhookMessageIntegrationDirName)
 };
 const fromHomeDir = {
   globalCacheFile: "global.cache.json"
@@ -83,6 +89,8 @@ const fromOutDir = {
   fromCliRootDir,
   fromHomeDir,
   fromOutDir,
-  fromWorkDir
+  fromWorkDir,
+  helloWorldIntegrationDirName,
+  webhookMessageIntegrationDirName
 });
 //# sourceMappingURL=consts.js.map

package/dist/consts.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/consts.ts"],
-  "sourcesContent": ["import os from 'os'\nimport pathlib from 'path'\nimport { CLI_ROOT_DIR } from './root'\n\n// configurable\n\nexport const defaultBotpressHome = pathlib.join(os.homedir(), '.botpress')\n\nexport const defaultOutputFolder = '.botpress'\nexport const defaultEntrypoint = pathlib.join('src', 'index.ts')\nexport const defaultBotpressApiUrl = 'https://api.botpress.cloud'\nexport const defaultBotpressAppUrl = 'https://app.botpress.cloud'\nexport const defaultTunnelUrl = 'https://tunnel.botpress.cloud'\n\n// not configurable\n\nexport const cliRootDir = CLI_ROOT_DIR\n\nexport const echoBotDirName = 'echo-bot'\nexport const emptyIntegrationDirName = 'empty-integration'\n\nexport const fromCliRootDir = {\n  echoBotTemplate: pathlib.join('templates', echoBotDirName),\n  emptyIntegrationTemplate: pathlib.join('templates', emptyIntegrationDirName),\n}\n\nexport const fromHomeDir = {\n  globalCacheFile: 'global.cache.json',\n}\n\nexport const fromWorkDir = {\n  definition: 'integration.definition.ts',\n}\n\nexport const fromOutDir = {\n  distDir: 'dist',\n  outFile: pathlib.join('dist', 'index.js'),\n  installDir: 'installations',\n  implementationDir: 'implementation',\n  secretsDir: 'secrets',\n  projectCacheFile: 'project.cache.json',\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,gBAAe;AACf,kBAAoB;AACpB,kBAA6B;AAItB,MAAM,sBAAsB,YAAAA,QAAQ,KAAK,UAAAC,QAAG,QAAQ,GAAG,WAAW;AAElE,MAAM,sBAAsB;AAC5B,MAAM,oBAAoB,YAAAD,QAAQ,KAAK,OAAO,UAAU;AACxD,MAAM,wBAAwB;AAC9B,MAAM,wBAAwB;AAC9B,MAAM,mBAAmB;AAIzB,MAAM,aAAa;AAEnB,MAAM,iBAAiB;AACvB,MAAM,0BAA0B;AAEhC,MAAM,iBAAiB;AAAA,EAC5B,iBAAiB,YAAAA,QAAQ,KAAK,aAAa,cAAc;AAAA,EACzD,0BAA0B,YAAAA,QAAQ,KAAK,aAAa,uBAAuB;AAC7E;AAEO,MAAM,cAAc;AAAA,EACzB,iBAAiB;AACnB;AAEO,MAAM,cAAc;AAAA,EACzB,YAAY;AACd;AAEO,MAAM,aAAa;AAAA,EACxB,SAAS;AAAA,EACT,SAAS,YAAAA,QAAQ,KAAK,QAAQ,UAAU;AAAA,EACxC,YAAY;AAAA,EACZ,mBAAmB;AAAA,EACnB,YAAY;AAAA,EACZ,kBAAkB;AACpB;",
+  "sourcesContent": ["import os from 'os'\nimport pathlib from 'path'\nimport { CLI_ROOT_DIR } from './root'\n\n// configurable\n\nexport const defaultBotpressHome = pathlib.join(os.homedir(), '.botpress')\n\nexport const defaultOutputFolder = '.botpress'\nexport const defaultEntrypoint = pathlib.join('src', 'index.ts')\nexport const defaultBotpressApiUrl = 'https://api.botpress.cloud'\nexport const defaultBotpressAppUrl = 'https://app.botpress.cloud'\nexport const defaultTunnelUrl = 'https://tunnel.botpress.cloud'\n\n// not configurable\n\nexport const cliRootDir = CLI_ROOT_DIR\n\nexport const echoBotDirName = 'echo-bot'\nexport const emptyIntegrationDirName = 'empty-integration'\nexport const helloWorldIntegrationDirName = 'hello-world'\nexport const webhookMessageIntegrationDirName = 'webhook-message'\n\nexport const fromCliRootDir = {\n  echoBotTemplate: pathlib.join('templates', echoBotDirName),\n  emptyIntegrationTemplate: pathlib.join('templates', emptyIntegrationDirName),\n  helloWorldIntegrationTemplate: pathlib.join('templates', helloWorldIntegrationDirName),\n  webhookMessageIntegrationTemplate: pathlib.join('templates', webhookMessageIntegrationDirName),\n}\n\nexport const fromHomeDir = {\n  globalCacheFile: 'global.cache.json',\n}\n\nexport const fromWorkDir = {\n  definition: 'integration.definition.ts',\n}\n\nexport const fromOutDir = {\n  distDir: 'dist',\n  outFile: pathlib.join('dist', 'index.js'),\n  installDir: 'installations',\n  implementationDir: 'implementation',\n  secretsDir: 'secrets',\n  projectCacheFile: 'project.cache.json',\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,gBAAe;AACf,kBAAoB;AACpB,kBAA6B;AAItB,MAAM,sBAAsB,YAAAA,QAAQ,KAAK,UAAAC,QAAG,QAAQ,GAAG,WAAW;AAElE,MAAM,sBAAsB;AAC5B,MAAM,oBAAoB,YAAAD,QAAQ,KAAK,OAAO,UAAU;AACxD,MAAM,wBAAwB;AAC9B,MAAM,wBAAwB;AAC9B,MAAM,mBAAmB;AAIzB,MAAM,aAAa;AAEnB,MAAM,iBAAiB;AACvB,MAAM,0BAA0B;AAChC,MAAM,+BAA+B;AACrC,MAAM,mCAAmC;AAEzC,MAAM,iBAAiB;AAAA,EAC5B,iBAAiB,YAAAA,QAAQ,KAAK,aAAa,cAAc;AAAA,EACzD,0BAA0B,YAAAA,QAAQ,KAAK,aAAa,uBAAuB;AAAA,EAC3E,+BAA+B,YAAAA,QAAQ,KAAK,aAAa,4BAA4B;AAAA,EACrF,mCAAmC,YAAAA,QAAQ,KAAK,aAAa,gCAAgC;AAC/F;AAEO,MAAM,cAAc;AAAA,EACzB,iBAAiB;AACnB;AAEO,MAAM,cAAc;AAAA,EACzB,YAAY;AACd;AAEO,MAAM,aAAa;AAAA,EACxB,SAAS;AAAA,EACT,SAAS,YAAAA,QAAQ,KAAK,QAAQ,UAAU;AAAA,EACxC,YAAY;AAAA,EACZ,mBAAmB;AAAA,EACnB,YAAY;AAAA,EACZ,kBAAkB;AACpB;",
   "names": ["pathlib", "os"]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/cli",
-  "version": "0.8.11",
+  "version": "0.8.13",
   "description": "Botpress CLI",
   "scripts": {
     "build": "pnpm run bundle && pnpm run template:gen",
@@ -8,7 +8,7 @@
     "start": "node dist/index.js",
     "type:check": "tsc --noEmit",
     "bundle": "ts-node -T build.ts",
-    "template:gen": "pnpm -r --stream -F echo-bot -F empty-integration exec bp gen",
+    "template:gen": "pnpm -r --stream -F @bp-templates/* exec bp gen",
     "e2e:test": "ts-node -T ./e2e",
     "unit:test": "pnpm vitest --run"
   },
@@ -20,8 +20,8 @@
   },
   "main": "dist/index.js",
   "dependencies": {
-    "@botpress/client": "0.16.1",
-    "@botpress/sdk": "0.8.8",
+    "@botpress/client": "0.16.2",
+    "@botpress/sdk": "0.8.9",
     "@bpinternal/const": "^0.0.20",
     "@bpinternal/tunnel": "^0.1.1",
     "@bpinternal/yargs-extra": "^0.0.3",

package/templates/echo-bot/package.json

@@ -1,15 +1,12 @@
 {
-  "name": "echo-bot",
+  "name": "@bp-templates/echo-bot",
   "scripts": {
     "type:check": "tsc --noEmit"
   },
-  "keywords": [],
   "private": true,
-  "author": "",
-  "license": "MIT",
   "dependencies": {
-    "@botpress/client": "0.16.1",
-    "@botpress/sdk": "0.8.8"
+    "@botpress/client": "0.16.2",
+    "@botpress/sdk": "0.8.9"
   },
   "devDependencies": {
     "@types/node": "^18.11.17",

package/templates/echo-bot/src/index.ts

@@ -1,5 +1,5 @@
 import { Bot, z } from '@botpress/sdk'
-// import * as botpress from '.botpress' /** uncomment to get generated code */
+// import * as bp from '.botpress' /** uncomment to get generated code */
 
 const bot = new Bot({
   integrations: {},

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

@@ -1,9 +1,6 @@
 /* tslint:disable */
 // This file is generated
 // Do not edit this file
-import * as channel from "./channel/index";
-export * as channel from "./channel/index";
 
 export type Channels = {
-  channel: channel.ChannelChannel;
 }

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

@@ -20,7 +20,7 @@ export * as states from "./states/index"
 
 type TIntegration = {
   name: "empty-integration"
-  version: "0.2.0"
+  version: "0.0.1"
   configuration: configuration.Configuration
   actions: actions.Actions
   channels: channels.Channels

package/templates/empty-integration/hub.md

@@ -0,0 +1 @@
+# Empty Integration

package/templates/empty-integration/icon.svg

@@ -0,0 +1,8 @@
+<svg width="241" height="241" viewBox="0 0 241 241" fill="none" xmlns="http://www.w3.org/2000/svg">
+<rect width="241" height="241" rx="34" fill="#AAAAAA"/>
+<path d="M102 112L130.5 95.5L127.5 86L98 103L102 112Z" fill="white"/>
+<path d="M133 157.5L98.5 137.5L101 128.5L136 148.5L133 157.5Z" fill="white"/>
+<path d="M172.014 179.812L155.014 189.672C152.532 191.112 149.468 191.112 146.986 189.672L129.986 179.812C127.519 178.381 126 175.744 126 172.892V152.608C126 149.756 127.519 147.119 129.986 145.688L146.986 135.828C149.468 134.388 152.532 134.388 155.014 135.828L172.014 145.688C174.481 147.119 176 149.756 176 152.608V172.892C176 175.744 174.481 178.381 172.014 179.812Z" fill="white"/>
+<path d="M103 110.108V130.392C103 133.244 101.481 135.881 99.0137 137.312L98.5698 137.57L83.5 129L92 141.38L82.0137 147.172C79.5316 148.612 76.4684 148.612 73.9863 147.172L56.9863 137.312C54.5188 135.881 53 133.244 53 130.392V110.108C53 107.256 54.5188 104.619 56.9863 103.188L73.9863 93.328C76.4684 91.8883 79.5316 91.8883 82.0137 93.328L99.0137 103.188C101.481 104.619 103 107.256 103 110.108Z" fill="white"/>
+<path d="M172.014 95.312L155.014 105.172C152.532 106.612 149.468 106.612 146.986 105.172L137.789 99.8376L147.5 85.5L130.425 95.5666L129.986 95.312C127.519 93.8809 126 91.2442 126 88.3918V68.1082C126 65.2558 127.519 62.6191 129.986 61.188L146.986 51.328C149.468 49.8883 152.532 49.8883 155.014 51.328L172.014 61.188C174.481 62.6191 176 65.2558 176 68.1082V88.3918C176 91.2442 174.481 93.8809 172.014 95.312Z" fill="white"/>
+</svg>

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

@@ -1,12 +1,9 @@
-import { IntegrationDefinition, messages } from '@botpress/sdk'
-import { name, integrationName } from './package.json'
+import { IntegrationDefinition } from '@botpress/sdk'
+import { integrationName } from './package.json'
 
 export default new IntegrationDefinition({
-  name: integrationName ?? name,
-  version: '0.2.0',
-  channels: {
-    channel: {
-      messages: { ...messages.defaults },
-    },
-  },
+  name: integrationName,
+  version: '0.0.1',
+  readme: 'hub.md',
+  icon: 'icon.svg',
 })

package/templates/empty-integration/package.json

@@ -1,16 +1,13 @@
 {
-  "name": "empty-integration",
-  "integrationName": null,
+  "name": "@bp-templates/empty-integration",
+  "integrationName": "empty-integration",
   "scripts": {
     "type:check": "tsc --noEmit"
   },
-  "keywords": [],
   "private": true,
-  "author": "",
-  "license": "MIT",
   "dependencies": {
-    "@botpress/client": "0.16.1",
-    "@botpress/sdk": "0.8.8"
+    "@botpress/client": "0.16.2",
+    "@botpress/sdk": "0.8.9"
   },
   "devDependencies": {
     "@types/node": "^18.11.17",

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

@@ -1,70 +1,22 @@
-import * as botpress from '.botpress'
+import * as sdk from '@botpress/sdk'
+import * as bp from '.botpress'
 
-console.info('starting integration')
-
-class NotImplementedError extends Error {
-  constructor() {
-    super('Not implemented')
-  }
-}
-
-export default new botpress.Integration({
+export default new bp.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.
      */
+    throw new sdk.RuntimeError('Invalid configuration') // replace this with your own validation logic
   },
   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.
      */
+    throw new sdk.RuntimeError('Invalid configuration') // replace this with your own validation logic
   },
   actions: {},
-  channels: {
-    channel: {
-      messages: {
-        text: async () => {
-          throw new NotImplementedError()
-        },
-        image: async () => {
-          throw new NotImplementedError()
-        },
-        markdown: async () => {
-          throw new NotImplementedError()
-        },
-        audio: async () => {
-          throw new NotImplementedError()
-        },
-        video: async () => {
-          throw new NotImplementedError()
-        },
-        file: async () => {
-          throw new NotImplementedError()
-        },
-        location: async () => {
-          throw new NotImplementedError()
-        },
-        carousel: async () => {
-          throw new NotImplementedError()
-        },
-        card: async () => {
-          throw new NotImplementedError()
-        },
-        choice: async () => {
-          throw new NotImplementedError()
-        },
-        dropdown: async () => {
-          throw new NotImplementedError()
-        },
-        bloc: async () => {
-          throw new NotImplementedError()
-        },
-      },
-    },
-  },
-  handler: async () => {
-    throw new NotImplementedError()
-  },
+  channels: {},
+  handler: async () => {},
 })

package/templates/hello-world/.botpress/implementation/actions/helloWorld/index.ts

@@ -0,0 +1,12 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+import * as input from "./input";
+export * as input from "./input";
+import * as output from "./output";
+export * as output from "./output";
+
+export type ActionHelloWorld = {
+  input: input.Input;
+  output: output.Output;
+}

package/templates/{empty-integration/.botpress/implementation/channels/channel/messages/video.ts → hello-world/.botpress/implementation/actions/helloWorld/input.ts}

@@ -5,6 +5,6 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export interface Video {
-  videoUrl: string;
+export interface Input {
+  name?: string;
 }

package/templates/{empty-integration/.botpress/implementation/channels/channel/messages/audio.ts → hello-world/.botpress/implementation/actions/helloWorld/output.ts}

@@ -5,6 +5,6 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export interface Audio {
-  audioUrl: string;
+export interface Output {
+  message: string;
 }

package/templates/hello-world/.botpress/implementation/actions/index.ts

@@ -0,0 +1,9 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+import * as helloWorld from "./helloWorld/index";
+export * as helloWorld from "./helloWorld/index";
+
+export type Actions = {
+  helloWorld: helloWorld.ActionHelloWorld;
+}

package/templates/hello-world/.botpress/implementation/channels/index.ts

@@ -0,0 +1,6 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+export type Channels = {
+}

package/templates/{empty-integration/.botpress/implementation/channels/channel/messages/markdown.ts → hello-world/.botpress/implementation/configuration/index.ts}

@@ -5,6 +5,6 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export interface Markdown {
-  markdown: string;
+export interface Configuration {
+  [k: string]: any;
 }

package/templates/hello-world/.botpress/implementation/events/index.ts

@@ -0,0 +1,6 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+export type Events = {
+}

package/templates/hello-world/.botpress/implementation/index.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+import * as sdk from "@botpress/sdk"
+
+import type * as configuration from "./configuration/index"
+import type * as actions from "./actions/index"
+import type * as channels from "./channels/index"
+import type * as events from "./events/index"
+import type * as states from "./states/index"
+export * as configuration from "./configuration/index"
+export * as actions from "./actions/index"
+export * as channels from "./channels/index"
+export * as events from "./events/index"
+export * as states from "./states/index"
+
+type TIntegration = {
+  name: "hello-world"
+  version: "0.0.1"
+  configuration: configuration.Configuration
+  actions: actions.Actions
+  channels: channels.Channels
+  events: events.Events
+  states: states.States
+  user: { "tags": {}, "creation": { "enabled": false, "requiredTags": [] } }
+}
+
+export type IntegrationProps = sdk.IntegrationProps<TIntegration>
+
+export class Integration extends sdk.Integration<TIntegration> {}
+
+export type Client = sdk.IntegrationSpecificClient<TIntegration>

package/templates/hello-world/.botpress/implementation/states/index.ts

@@ -0,0 +1,6 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+export type States = {
+}

package/templates/hello-world/.botpress/index.ts

@@ -0,0 +1,2 @@
+export * from './implementation'
+export * from './secrets'

package/templates/hello-world/.botpress/secrets/index.ts

@@ -0,0 +1,6 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+class Secrets {
+}
+export const secrets = new Secrets()

package/templates/hello-world/hub.md

@@ -0,0 +1 @@
+# Hello World

package/templates/hello-world/icon.svg

@@ -0,0 +1,8 @@
+<svg width="241" height="241" viewBox="0 0 241 241" fill="none" xmlns="http://www.w3.org/2000/svg">
+<rect width="241" height="241" rx="34" fill="#AAAAAA"/>
+<path d="M102 112L130.5 95.5L127.5 86L98 103L102 112Z" fill="white"/>
+<path d="M133 157.5L98.5 137.5L101 128.5L136 148.5L133 157.5Z" fill="white"/>
+<path d="M172.014 179.812L155.014 189.672C152.532 191.112 149.468 191.112 146.986 189.672L129.986 179.812C127.519 178.381 126 175.744 126 172.892V152.608C126 149.756 127.519 147.119 129.986 145.688L146.986 135.828C149.468 134.388 152.532 134.388 155.014 135.828L172.014 145.688C174.481 147.119 176 149.756 176 152.608V172.892C176 175.744 174.481 178.381 172.014 179.812Z" fill="white"/>
+<path d="M103 110.108V130.392C103 133.244 101.481 135.881 99.0137 137.312L98.5698 137.57L83.5 129L92 141.38L82.0137 147.172C79.5316 148.612 76.4684 148.612 73.9863 147.172L56.9863 137.312C54.5188 135.881 53 133.244 53 130.392V110.108C53 107.256 54.5188 104.619 56.9863 103.188L73.9863 93.328C76.4684 91.8883 79.5316 91.8883 82.0137 93.328L99.0137 103.188C101.481 104.619 103 107.256 103 110.108Z" fill="white"/>
+<path d="M172.014 95.312L155.014 105.172C152.532 106.612 149.468 106.612 146.986 105.172L137.789 99.8376L147.5 85.5L130.425 95.5666L129.986 95.312C127.519 93.8809 126 91.2442 126 88.3918V68.1082C126 65.2558 127.519 62.6191 129.986 61.188L146.986 51.328C149.468 49.8883 152.532 49.8883 155.014 51.328L172.014 61.188C174.481 62.6191 176 65.2558 176 68.1082V88.3918C176 91.2442 174.481 93.8809 172.014 95.312Z" fill="white"/>
+</svg>

package/templates/hello-world/integration.definition.ts

@@ -0,0 +1,25 @@
+import { z, IntegrationDefinition } from '@botpress/sdk'
+import { integrationName } from './package.json'
+
+export default new IntegrationDefinition({
+  name: integrationName,
+  version: '0.0.1',
+  readme: 'hub.md',
+  icon: 'icon.svg',
+  actions: {
+    helloWorld: {
+      title: 'Hello World',
+      description: 'A simple hello world action',
+      input: {
+        schema: z.object({
+          name: z.string().optional(),
+        }),
+      },
+      output: {
+        schema: z.object({
+          message: z.string(),
+        }),
+      },
+    },
+  },
+})

package/templates/hello-world/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@bp-templates/hello-world",
+  "integrationName": "hello-world",
+  "scripts": {
+    "type:check": "tsc --noEmit"
+  },
+  "private": true,
+  "dependencies": {
+    "@botpress/client": "0.16.2",
+    "@botpress/sdk": "0.8.9"
+  },
+  "devDependencies": {
+    "@types/node": "^18.11.17",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.4"
+  }
+}

package/templates/hello-world/src/index.ts

@@ -0,0 +1,33 @@
+import * as sdk from '@botpress/sdk'
+import * as bp from '.botpress'
+
+export default new bp.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.
+     */
+    throw new sdk.RuntimeError('Invalid configuration') // replace this with your own validation logic
+  },
+  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.
+     */
+    throw new sdk.RuntimeError('Invalid configuration') // replace this with your own validation logic
+  },
+  actions: {
+    helloWorld: async (props) => {
+      /**
+       * This is called when a bot calls the action `helloWorld`.
+       */
+      props.logger.forBot().info('Hello World!') // this log will be visible by the bots that use this integration
+
+      let { name } = props.input
+      name = name || 'World'
+      return { message: `Hello "${name}"! Nice to meet you ;)` }
+    },
+  },
+  channels: {},
+  handler: async () => {},
+})

package/templates/hello-world/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "lib": ["es2022"],
+    "module": "commonjs",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "allowUnusedLabels": false,
+    "allowUnreachableCode": false,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedParameters": true,
+    "target": "es2017",
+    "baseUrl": ".",
+    "outDir": "dist",
+    "checkJs": false,
+    "incremental": true,
+    "exactOptionalPropertyTypes": false,
+    "resolveJsonModule": true,
+    "noPropertyAccessFromIndexSignature": false,
+    "noUnusedLocals": false
+  },
+  "include": [".botpress/**/*", "src/**/*", "./*.ts", "./*.json"]
+}

package/templates/webhook-message/.botpress/implementation/actions/index.ts

@@ -0,0 +1,6 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+export type Actions = {
+}

package/templates/webhook-message/.botpress/implementation/channels/index.ts

@@ -0,0 +1,9 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+import * as webhook from "./webhook/index";
+export * as webhook from "./webhook/index";
+
+export type Channels = {
+  webhook: webhook.ChannelWebhook;
+}

package/templates/webhook-message/.botpress/implementation/channels/webhook/index.ts

@@ -0,0 +1,12 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+import { Messages } from './messages/index'
+export * from './messages/index'
+
+export type ChannelWebhook = {
+  messages: Messages
+  message: { "tags": {} }
+  conversation: { "tags": { "id": { "title": "Conversation ID", "description": "The ID of the conversation" } }, "creation": { "enabled": false, "requiredTags": [] } }
+}

package/templates/webhook-message/.botpress/implementation/channels/webhook/messages/index.ts

@@ -0,0 +1,9 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+import * as text from "./text";
+export * as text from "./text";
+
+export type Messages = {
+  text: text.Text;
+}

package/templates/{empty-integration/.botpress/implementation/channels/channel/messages/choice.ts → webhook-message/.botpress/implementation/configuration/index.ts}

@@ -5,10 +5,9 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export interface Choice {
-  text: string;
-  options: {
-    label: string;
-    value: string;
-  }[];
+export interface Configuration {
+  /**
+   * The url to post the bot answers to.
+   */
+  webhookUrl: string;
 }

package/templates/webhook-message/.botpress/implementation/events/index.ts

@@ -0,0 +1,6 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+export type Events = {
+}

package/templates/webhook-message/.botpress/implementation/index.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+import * as sdk from "@botpress/sdk"
+
+import type * as configuration from "./configuration/index"
+import type * as actions from "./actions/index"
+import type * as channels from "./channels/index"
+import type * as events from "./events/index"
+import type * as states from "./states/index"
+export * as configuration from "./configuration/index"
+export * as actions from "./actions/index"
+export * as channels from "./channels/index"
+export * as events from "./events/index"
+export * as states from "./states/index"
+
+type TIntegration = {
+  name: "webhook-message"
+  version: "0.0.1"
+  configuration: configuration.Configuration
+  actions: actions.Actions
+  channels: channels.Channels
+  events: events.Events
+  states: states.States
+  user: { "tags": { "id": { "title": "User ID", "description": "The ID of the user" } }, "creation": { "enabled": false, "requiredTags": [] } }
+}
+
+export type IntegrationProps = sdk.IntegrationProps<TIntegration>
+
+export class Integration extends sdk.Integration<TIntegration> {}
+
+export type Client = sdk.IntegrationSpecificClient<TIntegration>

package/templates/webhook-message/.botpress/implementation/states/index.ts

@@ -0,0 +1,6 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+export type States = {
+}

package/templates/webhook-message/.botpress/index.ts

@@ -0,0 +1,2 @@
+export * from './implementation'
+export * from './secrets'

package/templates/webhook-message/.botpress/secrets/index.ts

@@ -0,0 +1,6 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+class Secrets {
+}
+export const secrets = new Secrets()

package/templates/webhook-message/hub.md

@@ -0,0 +1 @@
+# Webhook Message

package/templates/webhook-message/icon.svg

@@ -0,0 +1,8 @@
+<svg width="241" height="241" viewBox="0 0 241 241" fill="none" xmlns="http://www.w3.org/2000/svg">
+<rect width="241" height="241" rx="34" fill="#AAAAAA"/>
+<path d="M102 112L130.5 95.5L127.5 86L98 103L102 112Z" fill="white"/>
+<path d="M133 157.5L98.5 137.5L101 128.5L136 148.5L133 157.5Z" fill="white"/>
+<path d="M172.014 179.812L155.014 189.672C152.532 191.112 149.468 191.112 146.986 189.672L129.986 179.812C127.519 178.381 126 175.744 126 172.892V152.608C126 149.756 127.519 147.119 129.986 145.688L146.986 135.828C149.468 134.388 152.532 134.388 155.014 135.828L172.014 145.688C174.481 147.119 176 149.756 176 152.608V172.892C176 175.744 174.481 178.381 172.014 179.812Z" fill="white"/>
+<path d="M103 110.108V130.392C103 133.244 101.481 135.881 99.0137 137.312L98.5698 137.57L83.5 129L92 141.38L82.0137 147.172C79.5316 148.612 76.4684 148.612 73.9863 147.172L56.9863 137.312C54.5188 135.881 53 133.244 53 130.392V110.108C53 107.256 54.5188 104.619 56.9863 103.188L73.9863 93.328C76.4684 91.8883 79.5316 91.8883 82.0137 93.328L99.0137 103.188C101.481 104.619 103 107.256 103 110.108Z" fill="white"/>
+<path d="M172.014 95.312L155.014 105.172C152.532 106.612 149.468 106.612 146.986 105.172L137.789 99.8376L147.5 85.5L130.425 95.5666L129.986 95.312C127.519 93.8809 126 91.2442 126 88.3918V68.1082C126 65.2558 127.519 62.6191 129.986 61.188L146.986 51.328C149.468 49.8883 152.532 49.8883 155.014 51.328L172.014 61.188C174.481 62.6191 176 65.2558 176 68.1082V88.3918C176 91.2442 174.481 93.8809 172.014 95.312Z" fill="white"/>
+</svg>

package/templates/webhook-message/integration.definition.ts

@@ -0,0 +1,36 @@
+import { z, IntegrationDefinition } from '@botpress/sdk'
+import { integrationName } from './package.json'
+
+export default new IntegrationDefinition({
+  name: integrationName,
+  version: '0.0.1',
+  readme: 'hub.md',
+  icon: 'icon.svg',
+  configuration: {
+    schema: z.object({
+      webhookUrl: z.string().describe('The url to post the bot answers to.'),
+    }),
+  },
+  channels: {
+    webhook: {
+      conversation: {
+        tags: {
+          id: { title: 'Conversation ID', description: 'The ID of the conversation' },
+        },
+      },
+      messages: {
+        // this channel only supports text messages
+        text: {
+          schema: z.object({
+            text: z.string(),
+          }),
+        },
+      },
+    },
+  },
+  user: {
+    tags: {
+      id: { title: 'User ID', description: 'The ID of the user' },
+    },
+  },
+})

package/templates/webhook-message/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@bp-templates/webhook-message",
+  "integrationName": "webhook-message",
+  "scripts": {
+    "type:check": "tsc --noEmit"
+  },
+  "private": true,
+  "dependencies": {
+    "@botpress/client": "0.16.2",
+    "@botpress/sdk": "0.8.9",
+    "axios": "^1.6.8"
+  },
+  "devDependencies": {
+    "@types/node": "^18.11.17",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.4"
+  }
+}

package/templates/webhook-message/src/index.ts

@@ -0,0 +1,122 @@
+import * as sdk from '@botpress/sdk'
+import axios from 'axios'
+import * as bp from '.botpress'
+
+const reqBodySchema = sdk.z.object({
+  userId: sdk.z.string(),
+  conversationId: sdk.z.string(),
+  text: sdk.z.string(),
+})
+
+export default new bp.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.
+     */
+    throw new sdk.RuntimeError('Invalid configuration') // replace this with your own validation logic
+  },
+  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.
+     */
+    throw new sdk.RuntimeError('Invalid configuration') // replace this with your own validation logic
+  },
+  actions: {},
+  channels: {
+    webhook: {
+      messages: {
+        text: async (props) => {
+          /**
+           * This is the outgoing message handler. It is called when a bot sends a message to the user.
+           */
+          const {
+            ctx: {
+              configuration: { webhookUrl },
+            },
+            conversation: { id: conversationId },
+            user: { id: userId },
+            payload: { text },
+          } = props
+
+          const requestBody = {
+            userId,
+            conversationId,
+            text,
+          }
+
+          await axios.post(webhookUrl, requestBody)
+        },
+      },
+    },
+  },
+  handler: async (props) => {
+    /**
+     * This is the incoming request handler. It is called by the external service you are integrating with.
+     */
+    const {
+      client,
+      req: { body },
+    } = props
+
+    if (!body) {
+      return {
+        status: 400,
+        body: JSON.stringify({ error: 'No body' }),
+      }
+    }
+
+    let parsedBody: unknown
+    try {
+      parsedBody = JSON.parse(body)
+    } catch (thrown) {
+      return {
+        status: 400,
+        body: JSON.stringify({ error: 'Invalid JSON Body' }),
+      }
+    }
+
+    const parseResult = reqBodySchema.safeParse(parsedBody)
+    if (!parseResult.success) {
+      return {
+        status: 400,
+        body: JSON.stringify({ error: 'Invalid body' }),
+      }
+    }
+
+    const { userId, conversationId, text } = parseResult.data
+
+    const { conversation } = await client.getOrCreateConversation({
+      channel: 'webhook',
+      tags: {
+        id: conversationId,
+      },
+    })
+
+    const { user } = await client.getOrCreateUser({
+      tags: {
+        id: userId,
+      },
+    })
+
+    const { message } = await client.createMessage({
+      type: 'text',
+      conversationId: conversation.id,
+      userId: user.id,
+      payload: {
+        text,
+      },
+      tags: {},
+    })
+
+    const response = {
+      message,
+    }
+
+    return {
+      status: 200,
+      body: JSON.stringify(response),
+    }
+  },
+})

package/templates/webhook-message/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "lib": ["es2022"],
+    "module": "commonjs",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "allowUnusedLabels": false,
+    "allowUnreachableCode": false,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedParameters": true,
+    "target": "es2017",
+    "baseUrl": ".",
+    "outDir": "dist",
+    "checkJs": false,
+    "incremental": true,
+    "exactOptionalPropertyTypes": false,
+    "resolveJsonModule": true,
+    "noPropertyAccessFromIndexSignature": false,
+    "noUnusedLocals": false
+  },
+  "include": [".botpress/**/*", "src/**/*", "./*.ts", "./*.json"]
+}

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

@@ -1,12 +0,0 @@
-/* tslint:disable */
-// This file is generated
-// Do not edit this file
-
-import { Messages } from './messages/index'
-export * from './messages/index'
-
-export type ChannelChannel = {
-  messages: Messages
-  message: { "tags": {} }
-  conversation: { "tags": {}, "creation": { "enabled": false, "requiredTags": [] } }
-}

package/templates/empty-integration/.botpress/implementation/channels/channel/messages/bloc.ts

@@ -1,57 +0,0 @@
-/* tslint:disable */
-/**
- * This file was automatically generated by json-schema-to-typescript.
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and run json-schema-to-typescript to regenerate this file.
- */
-
-export interface Bloc {
-  items: (
-    | {
-        type: "text";
-        payload: {
-          text: string;
-        };
-      }
-    | {
-        type: "markdown";
-        payload: {
-          markdown: string;
-        };
-      }
-    | {
-        type: "image";
-        payload: {
-          imageUrl: string;
-        };
-      }
-    | {
-        type: "audio";
-        payload: {
-          audioUrl: string;
-        };
-      }
-    | {
-        type: "video";
-        payload: {
-          videoUrl: string;
-        };
-      }
-    | {
-        type: "file";
-        payload: {
-          fileUrl: string;
-          title?: string;
-        };
-      }
-    | {
-        type: "location";
-        payload: {
-          latitude: number;
-          longitude: number;
-          address?: string;
-          title?: string;
-        };
-      }
-  )[];
-}

package/templates/empty-integration/.botpress/implementation/channels/channel/messages/card.ts

@@ -1,17 +0,0 @@
-/* tslint:disable */
-/**
- * This file was automatically generated by json-schema-to-typescript.
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and run json-schema-to-typescript to regenerate this file.
- */
-
-export interface Card {
-  title: string;
-  subtitle?: string;
-  imageUrl?: string;
-  actions: {
-    action: "postback" | "url" | "say";
-    label: string;
-    value: string;
-  }[];
-}

package/templates/empty-integration/.botpress/implementation/channels/channel/messages/carousel.ts

@@ -1,19 +0,0 @@
-/* tslint:disable */
-/**
- * This file was automatically generated by json-schema-to-typescript.
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and run json-schema-to-typescript to regenerate this file.
- */
-
-export interface Carousel {
-  items: {
-    title: string;
-    subtitle?: string;
-    imageUrl?: string;
-    actions: {
-      action: "postback" | "url" | "say";
-      label: string;
-      value: string;
-    }[];
-  }[];
-}

package/templates/empty-integration/.botpress/implementation/channels/channel/messages/dropdown.ts

@@ -1,14 +0,0 @@
-/* tslint:disable */
-/**
- * This file was automatically generated by json-schema-to-typescript.
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and run json-schema-to-typescript to regenerate this file.
- */
-
-export interface Dropdown {
-  text: string;
-  options: {
-    label: string;
-    value: string;
-  }[];
-}

package/templates/empty-integration/.botpress/implementation/channels/channel/messages/file.ts

@@ -1,11 +0,0 @@
-/* tslint:disable */
-/**
- * This file was automatically generated by json-schema-to-typescript.
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and run json-schema-to-typescript to regenerate this file.
- */
-
-export interface File {
-  fileUrl: string;
-  title?: string;
-}

package/templates/empty-integration/.botpress/implementation/channels/channel/messages/image.ts

@@ -1,10 +0,0 @@
-/* tslint:disable */
-/**
- * This file was automatically generated by json-schema-to-typescript.
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and run json-schema-to-typescript to regenerate this file.
- */
-
-export interface Image {
-  imageUrl: string;
-}

package/templates/empty-integration/.botpress/implementation/channels/channel/messages/index.ts

@@ -1,42 +0,0 @@
-/* tslint:disable */
-// This file is generated
-// Do not edit this file
-import * as text from "./text";
-export * as text from "./text";
-import * as markdown from "./markdown";
-export * as markdown from "./markdown";
-import * as image from "./image";
-export * as image from "./image";
-import * as audio from "./audio";
-export * as audio from "./audio";
-import * as video from "./video";
-export * as video from "./video";
-import * as file from "./file";
-export * as file from "./file";
-import * as location from "./location";
-export * as location from "./location";
-import * as carousel from "./carousel";
-export * as carousel from "./carousel";
-import * as card from "./card";
-export * as card from "./card";
-import * as dropdown from "./dropdown";
-export * as dropdown from "./dropdown";
-import * as choice from "./choice";
-export * as choice from "./choice";
-import * as bloc from "./bloc";
-export * as bloc from "./bloc";
-
-export type Messages = {
-  text: text.Text;
-  markdown: markdown.Markdown;
-  image: image.Image;
-  audio: audio.Audio;
-  video: video.Video;
-  file: file.File;
-  location: location.Location;
-  carousel: carousel.Carousel;
-  card: card.Card;
-  dropdown: dropdown.Dropdown;
-  choice: choice.Choice;
-  bloc: bloc.Bloc;
-}

package/templates/empty-integration/.botpress/implementation/channels/channel/messages/location.ts

@@ -1,13 +0,0 @@
-/* tslint:disable */
-/**
- * This file was automatically generated by json-schema-to-typescript.
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and run json-schema-to-typescript to regenerate this file.
- */
-
-export interface Location {
-  latitude: number;
-  longitude: number;
-  address?: string;
-  title?: string;
-}