@botpress/cli 0.11.6 → 1.0.0

package/e2e/utils.ts

@@ -41,14 +41,37 @@ export class TmpDirectory {
   }
 }
 
-export const npmInstall = async ({ workDir }: { workDir: string }) => {
-  const { status } = childprocess.spawnSync('pnpm', ['install'], {
+export type RunCommandOptions = {
+  workDir: string
+}
+
+export type RunCommandOutput = {
+  exitCode: number
+}
+
+export const runCommand = async (cmd: string, { workDir }: RunCommandOptions): Promise<RunCommandOutput> => {
+  const [program, ...args] = cmd.split(' ')
+  if (!program) {
+    throw new Error('Cannot run empty command')
+  }
+  const { error, status } = childprocess.spawnSync(program, args, {
     cwd: workDir,
     stdio: 'inherit',
   })
+  if (error) {
+    throw error
+  }
   return { exitCode: status ?? 0 }
 }
 
+export const npmInstall = ({ workDir }: RunCommandOptions): Promise<RunCommandOutput> => {
+  return runCommand('pnpm install', { workDir })
+}
+
+export const tscCheck = ({ workDir }: RunCommandOptions): Promise<RunCommandOutput> => {
+  return runCommand('tsc --noEmit', { workDir })
+}
+
 export const fixBotpressDependencies = async ({
   workDir,
   target,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/cli",
-  "version": "0.11.6",
+  "version": "1.0.0",
   "description": "Botpress CLI",
   "scripts": {
     "build": "pnpm run bundle && pnpm run template:gen",
@@ -22,7 +22,7 @@
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^11.7.0",
     "@botpress/client": "0.33.0",
-    "@botpress/sdk": "0.11.8",
+    "@botpress/sdk": "1.0.0",
     "@bpinternal/const": "^0.0.20",
     "@bpinternal/tunnel": "^0.1.1",
     "@bpinternal/yargs-extra": "^0.0.3",
@@ -40,9 +40,10 @@
     "chokidar": "^3.5.3",
     "dotenv": "^16.4.4",
     "esbuild": "^0.15.18",
-    "json-schema-to-typescript": "^11.0.2",
+    "handlebars": "^4.7.8",
     "latest-version": "5.1.0",
     "lodash": "^4.17.21",
+    "prettier": "2.8.8",
     "prompts": "^2.4.2",
     "radash": "^9.5.0",
     "semver": "^7.3.8",
@@ -54,7 +55,7 @@
   "devDependencies": {
     "@bpinternal/log4bot": "^0.0.4",
     "@types/bluebird": "^3.5.38",
-    "@types/json-schema": "^7.0.11",
+    "@types/json-schema": "^7.0.12",
     "@types/prompts": "^2.0.14",
     "@types/semver": "^7.3.11",
     "@types/tmp": "^0.2.3",

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

@@ -0,0 +1,41 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+import * as sdk from "@botpress/sdk"
+import * as typings from "./typings/index"
+export * from "./typings/index"
+
+type TBot = typings.TBot
+
+export class Bot extends sdk.Bot<TBot> {}
+
+// extra types
+
+type AsyncFunction = (...args: any[]) => Promise<any>
+export type EventHandler = Parameters<Bot['event']>[0]
+export type EventHandlerProps = Parameters<EventHandler>[0]
+export type MessageHandler = Parameters<Bot['message']>[0]
+export type MessageHandlerProps = Parameters<MessageHandler>[0]
+export type Client = EventHandlerProps['client']
+export type ClientOperation = keyof {
+  [K in keyof Client as Client[K] extends AsyncFunction ? K : never]: null
+}
+export type ClientInputs = {
+  [K in ClientOperation]: Parameters<Client[K]>[0]
+}
+export type ClientOutputs = {
+  [K in ClientOperation]: Awaited<ReturnType<Client[K]>>
+}
+// @deprecated
+export type BotEvent = EventHandlerProps['event']
+// @deprecated
+export type BotEvents = {
+  [K in BotEvent['type']]: Extract<BotEvent, { type: K }>
+}
+// @deprecated
+export type BotState = ClientOutputs['getState']['state']
+// @deprecated
+export type BotStates = {
+  [K in BotState['name']]: Extract<BotState, { type: K }>['payload']
+}

package/templates/empty-bot/.botpress/implementation/typings/index.ts

@@ -0,0 +1,17 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+import * as integrations from './integrations/index'
+import * as events from './events'
+import * as states from './states'
+
+export * as integrations from './integrations/index'
+export * as events from './events/index'
+export * as states from './states/index'
+
+export type TBot = {
+  integrations: integrations.Integrations
+  events: events.Events
+  states: states.States
+}

package/templates/empty-bot/.botpress/implementation/typings/integrations/index.ts

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

package/templates/empty-bot/.botpress/index.ts

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

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

@@ -0,0 +1,2 @@
+import { BotDefinition } from '@botpress/sdk'
+export default new BotDefinition({})

package/templates/{echo-bot → empty-bot}/package.json

@@ -1,12 +1,12 @@
 {
-  "name": "@bp-templates/echo-bot",
+  "name": "@bp-templates/empty-bot",
   "scripts": {
     "check:type": "tsc --noEmit"
   },
   "private": true,
   "dependencies": {
     "@botpress/client": "0.33.0",
-    "@botpress/sdk": "0.11.8"
+    "@botpress/sdk": "1.0.0"
   },
   "devDependencies": {
     "@types/node": "^18.11.17",

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

@@ -0,0 +1,5 @@
+import * as bp from '.botpress'
+
+const bot = new bp.Bot({})
+
+export default bot

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

@@ -1,44 +1,12 @@
 /* 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 * as typings from "./typings/index"
+export * from "./typings/index"
 
-import type * as configuration from "./configuration/index"
-import type * as configurations from "./configurations/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"
-import type * as entities from "./entities/index"
-export * as configuration from "./configuration/index"
-export * as configurations from "./configurations/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"
-export * as entities from "./entities/index"
-
-// type utils
-type Cast<X, Y> = X extends Y ? X : Y
-type ValueOf<T> = T[keyof T]
-type AsyncFunction = (...args: any[]) => Promise<any>
-
-type TIntegration = {
-  name: "empty-integration"
-  version: "0.0.1"
-  configuration: configuration.Configuration
-  configurations: configurations.Configurations
-  actions: actions.Actions
-  channels: channels.Channels
-  events: events.Events
-  states: states.States
-  user: { "tags": {}, "creation": { "enabled": false, "requiredTags": [] } }
-  entities: entities.Entities
-}
+type TIntegration = typings.TIntegration
 
 export type IntegrationProps = sdk.IntegrationProps<TIntegration>
 
@@ -48,6 +16,10 @@ export type Client = sdk.IntegrationSpecificClient<TIntegration>
 
 // extra types
 
+type Cast<X, Y> = X extends Y ? X : Y
+type ValueOf<T> = T[keyof T]
+type AsyncFunction = (...args: any[]) => Promise<any>
+
 export type HandlerProps = Parameters<IntegrationProps['handler']>[0]
 
 export type ActionProps = {

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

@@ -0,0 +1,2 @@
+/** Default Configuration of the Integration */
+export type Configuration = Record<string, never>;

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

@@ -0,0 +1,31 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+import * as configuration from "./configuration/index"
+import * as configurations from "./configurations/index"
+import * as actions from "./actions/index"
+import * as channels from "./channels/index"
+import * as events from "./events/index"
+import * as states from "./states/index"
+import * as entities from "./entities/index"
+export * as configuration from "./configuration/index"
+export * as configurations from "./configurations/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"
+export * as entities from "./entities/index"
+
+export type TIntegration = {
+  name: "empty-integration"
+  version: "0.0.1"
+  user: { "tags": {}, "creation": { "enabled": false, "requiredTags": [] } }
+  configuration: configuration.Configuration
+  configurations: configurations.Configurations
+  actions: actions.Actions
+  channels: channels.Channels
+  events: events.Events
+  states: states.States
+  entities: entities.Entities
+}

package/templates/empty-integration/package.json

@@ -7,7 +7,7 @@
   "private": true,
   "dependencies": {
     "@botpress/client": "0.33.0",
-    "@botpress/sdk": "0.11.8"
+    "@botpress/sdk": "1.0.0"
   },
   "devDependencies": {
     "@types/node": "^18.11.17",

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

@@ -1,44 +1,12 @@
 /* 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 * as typings from "./typings/index"
+export * from "./typings/index"
 
-import type * as configuration from "./configuration/index"
-import type * as configurations from "./configurations/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"
-import type * as entities from "./entities/index"
-export * as configuration from "./configuration/index"
-export * as configurations from "./configurations/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"
-export * as entities from "./entities/index"
-
-// type utils
-type Cast<X, Y> = X extends Y ? X : Y
-type ValueOf<T> = T[keyof T]
-type AsyncFunction = (...args: any[]) => Promise<any>
-
-type TIntegration = {
-  name: "hello-world"
-  version: "0.0.1"
-  configuration: configuration.Configuration
-  configurations: configurations.Configurations
-  actions: actions.Actions
-  channels: channels.Channels
-  events: events.Events
-  states: states.States
-  user: { "tags": {}, "creation": { "enabled": false, "requiredTags": [] } }
-  entities: entities.Entities
-}
+type TIntegration = typings.TIntegration
 
 export type IntegrationProps = sdk.IntegrationProps<TIntegration>
 
@@ -48,6 +16,10 @@ export type Client = sdk.IntegrationSpecificClient<TIntegration>
 
 // extra types
 
+type Cast<X, Y> = X extends Y ? X : Y
+type ValueOf<T> = T[keyof T]
+type AsyncFunction = (...args: any[]) => Promise<any>
+
 export type HandlerProps = Parameters<IntegrationProps['handler']>[0]
 
 export type ActionProps = {

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

@@ -0,0 +1,5 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+export type Input = { name?: string };

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

@@ -0,0 +1,5 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+export type Output = { message: string };

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

@@ -0,0 +1,2 @@
+/** Default Configuration of the Integration */
+export type Configuration = Record<string, never>;

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

@@ -0,0 +1,31 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+import * as configuration from "./configuration/index"
+import * as configurations from "./configurations/index"
+import * as actions from "./actions/index"
+import * as channels from "./channels/index"
+import * as events from "./events/index"
+import * as states from "./states/index"
+import * as entities from "./entities/index"
+export * as configuration from "./configuration/index"
+export * as configurations from "./configurations/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"
+export * as entities from "./entities/index"
+
+export type TIntegration = {
+  name: "hello-world"
+  version: "0.0.1"
+  user: { "tags": {}, "creation": { "enabled": false, "requiredTags": [] } }
+  configuration: configuration.Configuration
+  configurations: configurations.Configurations
+  actions: actions.Actions
+  channels: channels.Channels
+  events: events.Events
+  states: states.States
+  entities: entities.Entities
+}

package/templates/hello-world/package.json

@@ -7,7 +7,7 @@
   "private": true,
   "dependencies": {
     "@botpress/client": "0.33.0",
-    "@botpress/sdk": "0.11.8"
+    "@botpress/sdk": "1.0.0"
   },
   "devDependencies": {
     "@types/node": "^18.11.17",

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

@@ -1,44 +1,12 @@
 /* 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 * as typings from "./typings/index"
+export * from "./typings/index"
 
-import type * as configuration from "./configuration/index"
-import type * as configurations from "./configurations/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"
-import type * as entities from "./entities/index"
-export * as configuration from "./configuration/index"
-export * as configurations from "./configurations/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"
-export * as entities from "./entities/index"
-
-// type utils
-type Cast<X, Y> = X extends Y ? X : Y
-type ValueOf<T> = T[keyof T]
-type AsyncFunction = (...args: any[]) => Promise<any>
-
-type TIntegration = {
-  name: "webhook-message"
-  version: "0.0.1"
-  configuration: configuration.Configuration
-  configurations: configurations.Configurations
-  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": [] } }
-  entities: entities.Entities
-}
+type TIntegration = typings.TIntegration
 
 export type IntegrationProps = sdk.IntegrationProps<TIntegration>
 
@@ -48,6 +16,10 @@ export type Client = sdk.IntegrationSpecificClient<TIntegration>
 
 // extra types
 
+type Cast<X, Y> = X extends Y ? X : Y
+type ValueOf<T> = T[keyof T]
+type AsyncFunction = (...args: any[]) => Promise<any>
+
 export type HandlerProps = Parameters<IntegrationProps['handler']>[0]
 
 export type ActionProps = {

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

@@ -0,0 +1,5 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+export type Text = { text: string };

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

@@ -0,0 +1,8 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+export type Configuration = {
+  /** The url to post the bot answers to. */
+  webhookUrl: string;
+};

package/templates/webhook-message/.botpress/implementation/typings/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/typings/index.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+import * as configuration from "./configuration/index"
+import * as configurations from "./configurations/index"
+import * as actions from "./actions/index"
+import * as channels from "./channels/index"
+import * as events from "./events/index"
+import * as states from "./states/index"
+import * as entities from "./entities/index"
+export * as configuration from "./configuration/index"
+export * as configurations from "./configurations/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"
+export * as entities from "./entities/index"
+
+export type TIntegration = {
+  name: "webhook-message"
+  version: "0.0.1"
+  user: { "tags": { "id": { "title": "User ID", "description": "The ID of the user" } }, "creation": { "enabled": false, "requiredTags": [] } }
+  configuration: configuration.Configuration
+  configurations: configurations.Configurations
+  actions: actions.Actions
+  channels: channels.Channels
+  events: events.Events
+  states: states.States
+  entities: entities.Entities
+}

package/templates/webhook-message/.botpress/implementation/typings/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/package.json

@@ -7,7 +7,7 @@
   "private": true,
   "dependencies": {
     "@botpress/client": "0.33.0",
-    "@botpress/sdk": "0.11.8",
+    "@botpress/sdk": "1.0.0",
     "axios": "^1.6.8"
   },
   "devDependencies": {

package/dist/code-generation/const.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../src/code-generation/const.ts"],
-  "sourcesContent": ["export const GENERATED_HEADER = '/* tslint:disable */\\n// This file is generated\\n// Do not edit this file\\n'\nexport const INDEX_FILE = 'index.ts'\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAO,MAAM,mBAAmB;AACzB,MAAM,aAAa;",
-  "names": []
-}