@botpress/cli 4.17.10 → 4.17.12

package/.turbo/turbo-build.log

@@ -1,32 +1,32 @@
 
-> @botpress/cli@4.17.10 build /home/runner/work/botpress/botpress/packages/cli
+> @botpress/cli@4.17.12 build /home/runner/work/botpress/botpress/packages/cli
 > pnpm run bundle && pnpm run template:gen
 
 
-> @botpress/cli@4.17.10 bundle /home/runner/work/botpress/botpress/packages/cli
+> @botpress/cli@4.17.12 bundle /home/runner/work/botpress/botpress/packages/cli
 > ts-node -T build.ts
 
 
-> @botpress/cli@4.17.10 template:gen /home/runner/work/botpress/botpress/packages/cli
+> @botpress/cli@4.17.12 template:gen /home/runner/work/botpress/botpress/packages/cli
 > pnpm -r --stream -F @bp-templates/* exec bp gen
 
-🤖 Botpress CLI v4.17.10
-🤖 Botpress CLI v4.17.10
-🤖 Botpress CLI v4.17.10
-🤖 Botpress CLI v4.17.10
-○ Generating typings for integration hello-world...
-○ Generating typings for integration empty-integration...
+🤖 Botpress CLI v4.17.12
+🤖 Botpress CLI v4.17.12
+🤖 Botpress CLI v4.17.12
+🤖 Botpress CLI v4.17.12
+○ Generating typings for bot...
 ✓ Typings available at .botpress
 
+○ Generating typings for integration hello-world...
+○ Generating typings for plugin empty-plugin...
 ✓ Typings available at .botpress
 
-○ Generating typings for plugin empty-plugin...
-○ Generating typings for bot...
 ✓ Typings available at .botpress
 
+○ Generating typings for integration empty-integration...
 ✓ Typings available at .botpress
 
-🤖 Botpress CLI v4.17.10
+🤖 Botpress CLI v4.17.12
 ○ Generating typings for integration webhook-message...
 ✓ Typings available at .botpress
 

package/dist/utils/tunnel-utils.js

@@ -117,6 +117,9 @@ class TunnelSupervisor {
     });
     tunnel.events.on("close", ({ code, reason, target, type, wasClean }) => {
       this._logger.error(`Tunnel closed: ${code} ${reason}`);
+      if (code === import_tunnel.errors.CLOSE_CODES.TUNNEL_ID_CONFLICT) {
+        throw new Error("Cannot start: Tunnel Id is already used, choose a different tunnel id.");
+      }
       this._reconnectSync({ type: "close", ev: { code, reason, target, type, wasClean } });
     });
   }

package/dist/utils/tunnel-utils.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/utils/tunnel-utils.ts"],
-  "sourcesContent": ["import { TunnelTail, ClientCloseEvent, ClientErrorEvent } from '@bpinternal/tunnel'\nimport { Logger } from '../logger'\nimport { EventEmitter } from './event-emitter'\n\nexport type ReconnectionTriggerEvent =\n  | {\n      type: 'init'\n      ev: null\n    }\n  | {\n      type: 'error'\n      ev: ClientErrorEvent\n    }\n  | {\n      type: 'close'\n      ev: ClientCloseEvent\n    }\n\nexport type ReconnectedEvent = {\n  tunnel: TunnelTail\n  ev: ReconnectionTriggerEvent\n}\n\nexport class ReconnectionFailedError extends Error {\n  public constructor(public readonly event: ReconnectionTriggerEvent) {\n    const reason = ReconnectionFailedError._reason(event)\n    super(`Reconnection failed: ${reason}`)\n  }\n\n  private static _reason(event: ReconnectionTriggerEvent): string {\n    if (event.type === 'error') {\n      return 'error'\n    }\n\n    if (event.type === 'close') {\n      return `${event.ev.code} ${event.ev.reason}`\n    }\n\n    return 'init'\n  }\n}\n\nexport class TunnelSupervisor {\n  private _tunnel?: TunnelTail\n  private _closed = false\n  private _started = false\n\n  public readonly events = new EventEmitter<{\n    connectionFailed: ReconnectionTriggerEvent\n    manuallyClosed: null\n    connected: {\n      tunnel: TunnelTail\n      ev: ReconnectionTriggerEvent\n    }\n  }>()\n\n  public constructor(\n    private _tunnelUrl: string,\n    private _tunnelId: string,\n    private _logger: Logger\n  ) {}\n\n  public async start(): Promise<void> {\n    if (this._closed) {\n      throw new Error('Cannot start: Tunnel is closed')\n    }\n    if (this._started) {\n      throw new Error('Cannot start: Tunnel is already started')\n    }\n\n    this._started = true\n    const tunnel = await this._reconnect({ type: 'init', ev: null })\n    this._tunnel = tunnel\n  }\n\n  public get closed(): boolean {\n    return this._closed\n  }\n\n  /**\n   * @returns Promise that rejects when a reconnection attempt fails and resolves when the tunnel is closed manually\n   */\n  public async wait(): Promise<void> {\n    if (this._closed) {\n      throw new Error('Cannot wait: Tunnel is closed')\n    }\n\n    return new Promise((resolve, reject) => {\n      this.events.on('connectionFailed', (ev) => {\n        reject(new ReconnectionFailedError(ev))\n      })\n\n      this.events.on('manuallyClosed', () => {\n        resolve()\n      })\n    })\n  }\n\n  public close(): void {\n    if (this._closed) {\n      return\n    }\n\n    this._closed = true\n    this._tunnel?.close()\n    this.events.emit('manuallyClosed', null)\n  }\n\n  private _reconnectSync(ev: ReconnectionTriggerEvent): void {\n    void this._reconnect(ev)\n      .then((t) => {\n        this._tunnel = t\n      })\n      .catch(() => this.events.emit('connectionFailed', ev))\n  }\n\n  private async _reconnect(ev: ReconnectionTriggerEvent): Promise<TunnelTail> {\n    const newTunnel = async () => {\n      const tunnel = await TunnelTail.new(this._tunnelUrl, this._tunnelId)\n      this._registerListeners(tunnel)\n      this.events.emit('connected', { tunnel, ev })\n      return tunnel\n    }\n\n    if (ev.type === 'init') {\n      // skip logging on the first connection attempt\n      return newTunnel()\n    }\n\n    const line = this._logger.line()\n    line.started('Reconnecting tunnel...')\n    const tunnel = await newTunnel()\n    line.success('Reconnected')\n    line.commit()\n    return tunnel\n  }\n\n  private _registerListeners(tunnel: TunnelTail) {\n    tunnel.events.on('error', ({ target, type }) => {\n      this._logger.error(`Tunnel error: ${type}`)\n      this._reconnectSync({ type: 'error', ev: { target, type } })\n    })\n    tunnel.events.on('close', ({ code, reason, target, type, wasClean }) => {\n      this._logger.error(`Tunnel closed: ${code} ${reason}`)\n      this._reconnectSync({ type: 'close', ev: { code, reason, target, type, wasClean } })\n    })\n  }\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAA+D;AAE/D,2BAA6B;AAqBtB,MAAM,gCAAgC,MAAM;AAAA,EAC1C,YAA4B,OAAiC;AAClE,UAAM,SAAS,wBAAwB,QAAQ,KAAK;AACpD,UAAM,wBAAwB,QAAQ;AAFL;AAAA,EAGnC;AAAA,EAEA,OAAe,QAAQ,OAAyC;AAC9D,QAAI,MAAM,SAAS,SAAS;AAC1B,aAAO;AAAA,IACT;AAEA,QAAI,MAAM,SAAS,SAAS;AAC1B,aAAO,GAAG,MAAM,GAAG,QAAQ,MAAM,GAAG;AAAA,IACtC;AAEA,WAAO;AAAA,EACT;AACF;AAEO,MAAM,iBAAiB;AAAA,EAcrB,YACG,YACA,WACA,SACR;AAHQ;AACA;AACA;AAAA,EACP;AAAA,EAjBK;AAAA,EACA,UAAU;AAAA,EACV,WAAW;AAAA,EAEH,SAAS,IAAI,kCAO1B;AAAA,EAQH,MAAa,QAAuB;AAClC,QAAI,KAAK,SAAS;AAChB,YAAM,IAAI,MAAM,gCAAgC;AAAA,IAClD;AACA,QAAI,KAAK,UAAU;AACjB,YAAM,IAAI,MAAM,yCAAyC;AAAA,IAC3D;AAEA,SAAK,WAAW;AAChB,UAAM,SAAS,MAAM,KAAK,WAAW,EAAE,MAAM,QAAQ,IAAI,KAAK,CAAC;AAC/D,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,IAAW,SAAkB;AAC3B,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAKA,MAAa,OAAsB;AACjC,QAAI,KAAK,SAAS;AAChB,YAAM,IAAI,MAAM,+BAA+B;AAAA,IACjD;AAEA,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,WAAK,OAAO,GAAG,oBAAoB,CAAC,OAAO;AACzC,eAAO,IAAI,wBAAwB,EAAE,CAAC;AAAA,MACxC,CAAC;AAED,WAAK,OAAO,GAAG,kBAAkB,MAAM;AACrC,gBAAQ;AAAA,MACV,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA,EAEO,QAAc;AACnB,QAAI,KAAK,SAAS;AAChB;AAAA,IACF;AAEA,SAAK,UAAU;AACf,SAAK,SAAS,MAAM;AACpB,SAAK,OAAO,KAAK,kBAAkB,IAAI;AAAA,EACzC;AAAA,EAEQ,eAAe,IAAoC;AACzD,SAAK,KAAK,WAAW,EAAE,EACpB,KAAK,CAAC,MAAM;AACX,WAAK,UAAU;AAAA,IACjB,CAAC,EACA,MAAM,MAAM,KAAK,OAAO,KAAK,oBAAoB,EAAE,CAAC;AAAA,EACzD;AAAA,EAEA,MAAc,WAAW,IAAmD;AAC1E,UAAM,YAAY,YAAY;AAC5B,YAAMA,UAAS,MAAM,yBAAW,IAAI,KAAK,YAAY,KAAK,SAAS;AACnE,WAAK,mBAAmBA,OAAM;AAC9B,WAAK,OAAO,KAAK,aAAa,EAAE,QAAAA,SAAQ,GAAG,CAAC;AAC5C,aAAOA;AAAA,IACT;AAEA,QAAI,GAAG,SAAS,QAAQ;AAEtB,aAAO,UAAU;AAAA,IACnB;AAEA,UAAM,OAAO,KAAK,QAAQ,KAAK;AAC/B,SAAK,QAAQ,wBAAwB;AACrC,UAAM,SAAS,MAAM,UAAU;AAC/B,SAAK,QAAQ,aAAa;AAC1B,SAAK,OAAO;AACZ,WAAO;AAAA,EACT;AAAA,EAEQ,mBAAmB,QAAoB;AAC7C,WAAO,OAAO,GAAG,SAAS,CAAC,EAAE,QAAQ,KAAK,MAAM;AAC9C,WAAK,QAAQ,MAAM,iBAAiB,MAAM;AAC1C,WAAK,eAAe,EAAE,MAAM,SAAS,IAAI,EAAE,QAAQ,KAAK,EAAE,CAAC;AAAA,IAC7D,CAAC;AACD,WAAO,OAAO,GAAG,SAAS,CAAC,EAAE,MAAM,QAAQ,QAAQ,MAAM,SAAS,MAAM;AACtE,WAAK,QAAQ,MAAM,kBAAkB,QAAQ,QAAQ;AACrD,WAAK,eAAe,EAAE,MAAM,SAAS,IAAI,EAAE,MAAM,QAAQ,QAAQ,MAAM,SAAS,EAAE,CAAC;AAAA,IACrF,CAAC;AAAA,EACH;AACF;",
+  "sourcesContent": ["import { TunnelTail, ClientCloseEvent, ClientErrorEvent, errors } from '@bpinternal/tunnel'\nimport { Logger } from '../logger'\nimport { EventEmitter } from './event-emitter'\n\nexport type ReconnectionTriggerEvent =\n  | {\n      type: 'init'\n      ev: null\n    }\n  | {\n      type: 'error'\n      ev: ClientErrorEvent\n    }\n  | {\n      type: 'close'\n      ev: ClientCloseEvent\n    }\n\nexport type ReconnectedEvent = {\n  tunnel: TunnelTail\n  ev: ReconnectionTriggerEvent\n}\n\nexport class ReconnectionFailedError extends Error {\n  public constructor(public readonly event: ReconnectionTriggerEvent) {\n    const reason = ReconnectionFailedError._reason(event)\n    super(`Reconnection failed: ${reason}`)\n  }\n\n  private static _reason(event: ReconnectionTriggerEvent): string {\n    if (event.type === 'error') {\n      return 'error'\n    }\n\n    if (event.type === 'close') {\n      return `${event.ev.code} ${event.ev.reason}`\n    }\n\n    return 'init'\n  }\n}\n\nexport class TunnelSupervisor {\n  private _tunnel?: TunnelTail\n  private _closed = false\n  private _started = false\n\n  public readonly events = new EventEmitter<{\n    connectionFailed: ReconnectionTriggerEvent\n    manuallyClosed: null\n    connected: {\n      tunnel: TunnelTail\n      ev: ReconnectionTriggerEvent\n    }\n  }>()\n\n  public constructor(\n    private _tunnelUrl: string,\n    private _tunnelId: string,\n    private _logger: Logger\n  ) {}\n\n  public async start(): Promise<void> {\n    if (this._closed) {\n      throw new Error('Cannot start: Tunnel is closed')\n    }\n    if (this._started) {\n      throw new Error('Cannot start: Tunnel is already started')\n    }\n\n    this._started = true\n    const tunnel = await this._reconnect({ type: 'init', ev: null })\n    this._tunnel = tunnel\n  }\n\n  public get closed(): boolean {\n    return this._closed\n  }\n\n  /**\n   * @returns Promise that rejects when a reconnection attempt fails and resolves when the tunnel is closed manually\n   */\n  public async wait(): Promise<void> {\n    if (this._closed) {\n      throw new Error('Cannot wait: Tunnel is closed')\n    }\n\n    return new Promise((resolve, reject) => {\n      this.events.on('connectionFailed', (ev) => {\n        reject(new ReconnectionFailedError(ev))\n      })\n\n      this.events.on('manuallyClosed', () => {\n        resolve()\n      })\n    })\n  }\n\n  public close(): void {\n    if (this._closed) {\n      return\n    }\n\n    this._closed = true\n    this._tunnel?.close()\n    this.events.emit('manuallyClosed', null)\n  }\n\n  private _reconnectSync(ev: ReconnectionTriggerEvent): void {\n    void this._reconnect(ev)\n      .then((t) => {\n        this._tunnel = t\n      })\n      .catch(() => this.events.emit('connectionFailed', ev))\n  }\n\n  private async _reconnect(ev: ReconnectionTriggerEvent): Promise<TunnelTail> {\n    const newTunnel = async () => {\n      const tunnel = await TunnelTail.new(this._tunnelUrl, this._tunnelId)\n      this._registerListeners(tunnel)\n      this.events.emit('connected', { tunnel, ev })\n      return tunnel\n    }\n\n    if (ev.type === 'init') {\n      // skip logging on the first connection attempt\n      return newTunnel()\n    }\n\n    const line = this._logger.line()\n    line.started('Reconnecting tunnel...')\n    const tunnel = await newTunnel()\n    line.success('Reconnected')\n    line.commit()\n    return tunnel\n  }\n\n  private _registerListeners(tunnel: TunnelTail) {\n    tunnel.events.on('error', ({ target, type }) => {\n      this._logger.error(`Tunnel error: ${type}`)\n      this._reconnectSync({ type: 'error', ev: { target, type } })\n    })\n    tunnel.events.on('close', ({ code, reason, target, type, wasClean }) => {\n      this._logger.error(`Tunnel closed: ${code} ${reason}`)\n\n      if (code === errors.CLOSE_CODES.TUNNEL_ID_CONFLICT) {\n        throw new Error('Cannot start: Tunnel Id is already used, choose a different tunnel id.')\n      }\n\n      this._reconnectSync({ type: 'close', ev: { code, reason, target, type, wasClean } })\n    })\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAAuE;AAEvE,2BAA6B;AAqBtB,MAAM,gCAAgC,MAAM;AAAA,EAC1C,YAA4B,OAAiC;AAClE,UAAM,SAAS,wBAAwB,QAAQ,KAAK;AACpD,UAAM,wBAAwB,QAAQ;AAFL;AAAA,EAGnC;AAAA,EAEA,OAAe,QAAQ,OAAyC;AAC9D,QAAI,MAAM,SAAS,SAAS;AAC1B,aAAO;AAAA,IACT;AAEA,QAAI,MAAM,SAAS,SAAS;AAC1B,aAAO,GAAG,MAAM,GAAG,QAAQ,MAAM,GAAG;AAAA,IACtC;AAEA,WAAO;AAAA,EACT;AACF;AAEO,MAAM,iBAAiB;AAAA,EAcrB,YACG,YACA,WACA,SACR;AAHQ;AACA;AACA;AAAA,EACP;AAAA,EAjBK;AAAA,EACA,UAAU;AAAA,EACV,WAAW;AAAA,EAEH,SAAS,IAAI,kCAO1B;AAAA,EAQH,MAAa,QAAuB;AAClC,QAAI,KAAK,SAAS;AAChB,YAAM,IAAI,MAAM,gCAAgC;AAAA,IAClD;AACA,QAAI,KAAK,UAAU;AACjB,YAAM,IAAI,MAAM,yCAAyC;AAAA,IAC3D;AAEA,SAAK,WAAW;AAChB,UAAM,SAAS,MAAM,KAAK,WAAW,EAAE,MAAM,QAAQ,IAAI,KAAK,CAAC;AAC/D,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,IAAW,SAAkB;AAC3B,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAKA,MAAa,OAAsB;AACjC,QAAI,KAAK,SAAS;AAChB,YAAM,IAAI,MAAM,+BAA+B;AAAA,IACjD;AAEA,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,WAAK,OAAO,GAAG,oBAAoB,CAAC,OAAO;AACzC,eAAO,IAAI,wBAAwB,EAAE,CAAC;AAAA,MACxC,CAAC;AAED,WAAK,OAAO,GAAG,kBAAkB,MAAM;AACrC,gBAAQ;AAAA,MACV,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA,EAEO,QAAc;AACnB,QAAI,KAAK,SAAS;AAChB;AAAA,IACF;AAEA,SAAK,UAAU;AACf,SAAK,SAAS,MAAM;AACpB,SAAK,OAAO,KAAK,kBAAkB,IAAI;AAAA,EACzC;AAAA,EAEQ,eAAe,IAAoC;AACzD,SAAK,KAAK,WAAW,EAAE,EACpB,KAAK,CAAC,MAAM;AACX,WAAK,UAAU;AAAA,IACjB,CAAC,EACA,MAAM,MAAM,KAAK,OAAO,KAAK,oBAAoB,EAAE,CAAC;AAAA,EACzD;AAAA,EAEA,MAAc,WAAW,IAAmD;AAC1E,UAAM,YAAY,YAAY;AAC5B,YAAMA,UAAS,MAAM,yBAAW,IAAI,KAAK,YAAY,KAAK,SAAS;AACnE,WAAK,mBAAmBA,OAAM;AAC9B,WAAK,OAAO,KAAK,aAAa,EAAE,QAAAA,SAAQ,GAAG,CAAC;AAC5C,aAAOA;AAAA,IACT;AAEA,QAAI,GAAG,SAAS,QAAQ;AAEtB,aAAO,UAAU;AAAA,IACnB;AAEA,UAAM,OAAO,KAAK,QAAQ,KAAK;AAC/B,SAAK,QAAQ,wBAAwB;AACrC,UAAM,SAAS,MAAM,UAAU;AAC/B,SAAK,QAAQ,aAAa;AAC1B,SAAK,OAAO;AACZ,WAAO;AAAA,EACT;AAAA,EAEQ,mBAAmB,QAAoB;AAC7C,WAAO,OAAO,GAAG,SAAS,CAAC,EAAE,QAAQ,KAAK,MAAM;AAC9C,WAAK,QAAQ,MAAM,iBAAiB,MAAM;AAC1C,WAAK,eAAe,EAAE,MAAM,SAAS,IAAI,EAAE,QAAQ,KAAK,EAAE,CAAC;AAAA,IAC7D,CAAC;AACD,WAAO,OAAO,GAAG,SAAS,CAAC,EAAE,MAAM,QAAQ,QAAQ,MAAM,SAAS,MAAM;AACtE,WAAK,QAAQ,MAAM,kBAAkB,QAAQ,QAAQ;AAErD,UAAI,SAAS,qBAAO,YAAY,oBAAoB;AAClD,cAAM,IAAI,MAAM,wEAAwE;AAAA,MAC1F;AAEA,WAAK,eAAe,EAAE,MAAM,SAAS,IAAI,EAAE,MAAM,QAAQ,QAAQ,MAAM,SAAS,EAAE,CAAC;AAAA,IACrF,CAAC;AAAA,EACH;AACF;",
   "names": ["tunnel"]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/cli",
-  "version": "4.17.10",
+  "version": "4.17.12",
   "description": "Botpress CLI",
   "scripts": {
     "build": "pnpm run bundle && pnpm run template:gen",
@@ -22,7 +22,7 @@
     "@apidevtools/json-schema-ref-parser": "^11.7.0",
     "@botpress/chat": "0.5.1",
     "@botpress/client": "1.24.2",
-    "@botpress/sdk": "4.15.7",
+    "@botpress/sdk": "4.15.8",
     "@bpinternal/const": "^0.1.0",
     "@bpinternal/tunnel": "^0.1.1",
     "@bpinternal/yargs-extra": "^0.0.3",

package/templates/empty-bot/package.json

@@ -6,7 +6,7 @@
   "private": true,
   "dependencies": {
     "@botpress/client": "1.24.2",
-    "@botpress/sdk": "4.15.7"
+    "@botpress/sdk": "4.15.8"
   },
   "devDependencies": {
     "@types/node": "^22.16.4",

package/templates/empty-integration/hub.md

@@ -1 +1,33 @@
-# Empty Integration
+# Integration Title
+
+> Describe the integration's purpose.
+
+## Configuration
+
+> Explain how to configure your integration and list prerequisites `ex: accounts, etc.`.
+> You might also want to add configuration details for specific use cases.
+
+## Usage
+
+> Explain how to use your integration.
+> You might also want to include an example if there is a specific use case.
+
+## Limitations
+
+> List the known bugs.
+> List known limits `ex: rate-limiting, payload sizes, etc.`
+> List unsupported use cases.
+
+## Changelog
+
+> If some versions of your integration introduce changes worth mentionning (breaking changes, bug fixes), describe them here. This will help users to know what to expect when updating the integration.
+
+### Integration publication checklist
+
+- [ ] The register handler is implemented and validates the configuration.
+- [ ] Title and descriptions for all schemas are present in `integration.definition.ts`.
+- [ ] Events store `conversationId`, `userId` and `messageId` when available.
+- [ ] Implement events & actions that are related to `channels`, `entities`, `user`, `conversations` and `messages`.
+- [ ] Events related to messages are implemented as messages.
+- [ ] When an action is required by the bot developer, a `RuntimeError` is thrown with instructions to fix the problem.
+- [ ] Bot name and bot avatar URL fields are available in the integration configuration.

package/templates/empty-integration/package.json

@@ -7,7 +7,7 @@
   "private": true,
   "dependencies": {
     "@botpress/client": "1.24.2",
-    "@botpress/sdk": "4.15.7"
+    "@botpress/sdk": "4.15.8"
   },
   "devDependencies": {
     "@types/node": "^22.16.4",

package/templates/empty-plugin/hub.md

@@ -0,0 +1,33 @@
+# Plugin Title
+
+> Describe the plugin's purpose.
+
+## Configuration
+
+> Explain how to configure your plugin and list prerequisites `ex: accounts, etc.`.
+> You might also want to add configuration details for specific use cases.
+
+## Usage
+
+> Explain how to use your plugin.
+> You might also want to include an example if there is a specific use case.
+
+## Limitations
+
+> List the known bugs.
+> List known limits `ex: rate-limiting, payload sizes, etc.`
+> List unsupported use cases.
+
+## Changelog
+
+> If some versions of your plugin introduce changes worth mentionning (breaking changes, bug fixes), describe them here. This will help users to know what to expect when updating the plugin.
+
+### Plugin publication checklist
+
+- [ ] The register handler is implemented and validates the configuration.
+- [ ] Title and descriptions for all schemas are present in `plugin.definition.ts`.
+- [ ] Events store `conversationId`, `userId` and `messageId` when available.
+- [ ] Implement events & actions that are related to `channels`, `entities`, `user`, `conversations` and `messages`.
+- [ ] Events related to messages are implemented as messages.
+- [ ] When an action is required by the bot developer, a `RuntimeError` is thrown with instructions to fix the problem.
+- [ ] Bot name and bot avatar URL fields are available in the plugin configuration.

package/templates/empty-plugin/package.json

@@ -6,7 +6,7 @@
   },
   "private": true,
   "dependencies": {
-    "@botpress/sdk": "4.15.7"
+    "@botpress/sdk": "4.15.8"
   },
   "devDependencies": {
     "@types/node": "^22.16.4",

package/templates/hello-world/hub.md

@@ -1 +1,43 @@
 # Hello World
+
+This integration is a template with a single action.
+
+> Describe the integration's purpose.
+
+## Configuration
+
+This integration does not need a configuration.
+
+> Explain how to configure your integration and list prerequisites `ex: accounts, etc.`.
+> You might also want to add configuration details for specific use cases.
+
+## Usage
+
+To use, call the action `helloWorld`. This action will greet the user.
+
+> Explain how to use your integration.
+> You might also want to include an example if there is a specific use case.
+
+## Limitations
+
+The `helloWorld` action has a max name size limit of 2^28 - 16 characters (the max javascript string size).
+
+> List the known bugs.
+> List known limits `ex: rate-limiting, payload sizes, etc.`
+> List unsupported use cases.
+
+## Changelog
+
+- 0.1.0: Implemented `helloWorld` action.
+
+> If some versions of your integration introduce changes worth mentionning (breaking changes, bug fixes), describe them here. This will help users to know what to expect when updating the integration.
+
+### Integration publication checklist
+
+- [ ] The register handler is implemented and validates the configuration.
+- [ ] Title and descriptions for all schemas are present in `integration.definition.ts`.
+- [ ] Events store `conversationId`, `userId` and `messageId` when available.
+- [ ] Implement events & actions that are related to `channels`, `entities`, `user`, `conversations` and `messages`.
+- [ ] Events related to messages are implemented as messages.
+- [ ] When an action is required by the bot developer, a `RuntimeError` is thrown with instructions to fix the problem.
+- [ ] Bot name and bot avatar URL fields are available in the integration configuration.

package/templates/hello-world/package.json

@@ -7,7 +7,7 @@
   "private": true,
   "dependencies": {
     "@botpress/client": "1.24.2",
-    "@botpress/sdk": "4.15.7"
+    "@botpress/sdk": "4.15.8"
   },
   "devDependencies": {
     "@types/node": "^22.16.4",

package/templates/webhook-message/hub.md

@@ -1 +1,51 @@
 # Webhook Message
+
+This integration serves as a template for receiving events through a webhook and creating messages for them, as well as sending messages through an external API.
+
+> Describe the integration's purpose.
+
+## Configuration
+
+To use this integration, you will need to manually subscribe your integration to an external service webhook.
+You will also have to provide a webhookUrl configuration to send outgoing messages to.
+
+> Explain how to configure your integration and list prerequisites `ex: accounts, etc.`.
+> You might also want to add configuration details for specific use cases.
+
+## Usage
+
+Send messages through the `webhook` channel to send them through the external webhookUrl you configured.
+Receive messages through the integration's incoming webhook handler. Received messages have to contain:
+
+```typescript
+userId: string
+conversationId: string
+text: string
+```
+
+> Explain how to use your integration.
+> You might also want to include an example if there is a specific use case.
+
+## Limitations
+
+Only text messages are supported for outgoing messages.
+
+> List the known bugs.
+> List known limits `ex: rate-limiting, payload sizes, etc.`
+> List unsupported use cases.
+
+## Changelog
+
+- 0.1.0: Incoming webhook and outgoing channel.
+
+> If some versions of your integration introduce changes worth mentionning (breaking changes, bug fixes), describe them here. This will help users to know what to expect when updating the integration.
+
+### Integration publication checklist
+
+- [ ] The register handler is implemented and validates the configuration.
+- [ ] Title and descriptions for all schemas are present in `integration.definition.ts`.
+- [ ] Events store `conversationId`, `userId` and `messageId` when available.
+- [ ] Implement events & actions that are related to `channels`, `entities`, `user`, `conversations` and `messages`.
+- [ ] Events related to messages are implemented as messages.
+- [ ] When an action is required by the bot developer, a `RuntimeError` is thrown with instructions to fix the problem.
+- [ ] Bot name and bot avatar URL fields are available in the integration configuration.

package/templates/webhook-message/package.json

@@ -7,7 +7,7 @@
   "private": true,
   "dependencies": {
     "@botpress/client": "1.24.2",
-    "@botpress/sdk": "4.15.7",
+    "@botpress/sdk": "4.15.8",
     "axios": "^1.6.8"
   },
   "devDependencies": {