@botpress/cli 2.1.0 → 2.1.2

package/templates/empty-plugin/.botpress/implementation/typings/actions/index.ts

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

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

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

package/templates/empty-plugin/.botpress/implementation/typings/events/index.ts

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

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

@@ -0,0 +1,26 @@
+/* eslint-disable */
+/* tslint:disable */
+// This file is generated. Do not edit it manually.
+
+import * as integrations from './integrations/index'
+import * as interfaces from './interfaces/index'
+import * as configuration from './configuration/index'
+import * as events from './events'
+import * as states from './states'
+import * as actions from './actions'
+
+export * as integrations from './integrations/index'
+export * as interfaces from './interfaces/index'
+export * as configuration from './configuration/index'
+export * as events from './events/index'
+export * as states from './states/index'
+export * as actions from './actions'
+
+export type TPlugin = {
+  integrations: integrations.Integrations
+  interfaces: interfaces.Interfaces
+  configuration: configuration.Configuration
+  events: events.Events
+  states: states.States
+  actions: actions.Actions
+}

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

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

package/templates/empty-plugin/.botpress/implementation/typings/interfaces/index.ts

@@ -0,0 +1,6 @@
+/* eslint-disable */
+/* tslint:disable */
+// This file is generated. Do not edit it manually.
+
+export type Interfaces = {
+}

package/templates/empty-plugin/.botpress/implementation/typings/states/index.ts

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

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

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

package/templates/empty-plugin/package.json

@@ -6,7 +6,7 @@
   },
   "private": true,
   "dependencies": {
-    "@botpress/sdk": "2.0.3"
+    "@botpress/sdk": "2.0.4"
   },
   "devDependencies": {
     "@types/node": "^18.19.67",

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

@@ -0,0 +1,57 @@
+/* eslint-disable */
+/* tslint:disable */
+// This file is generated. Do not edit it manually.
+
+import * as sdk from "@botpress/sdk"
+import * as typings from "./typings/index"
+export * from "./typings/index"
+
+type TIntegration = sdk.DefaultIntegration<typings.TIntegration>
+
+export type IntegrationProps = sdk.IntegrationProps<TIntegration>
+
+export class Integration extends sdk.Integration<TIntegration> {}
+
+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 = {
+  [K in keyof IntegrationProps['actions']]: Parameters<IntegrationProps['actions'][K]>[0]
+}
+export type AnyActionProps = ValueOf<ActionProps>
+
+export type MessageProps = {
+  [TChannel in keyof IntegrationProps['channels']]: {
+    [TMessage in keyof IntegrationProps['channels'][TChannel]['messages']]: Parameters<
+      IntegrationProps['channels'][TChannel]['messages'][TMessage]
+    >[0]
+  }
+}
+export type AnyMessageProps = ValueOf<ValueOf<MessageProps>>
+
+export type Context = HandlerProps['ctx']
+export type Logger = HandlerProps['logger']
+
+export type AckFunctions = {
+  [TChannel in keyof MessageProps]: {
+    [TMessage in keyof MessageProps[TChannel]]: Cast<MessageProps[TChannel][TMessage], AnyMessageProps>['ack']
+  }
+}
+export type AnyAckFunction = ValueOf<ValueOf<AckFunctions>>
+
+export type ClientOperation = ValueOf<{
+  [K in keyof Client as Client[K] extends AsyncFunction ? K : never]: K
+}>
+export type ClientRequests = {
+  [K in ClientOperation]: Parameters<Client[K]>[0]
+}
+export type ClientResponses = {
+  [K in ClientOperation]: Awaited<ReturnType<Client[K]>>
+}

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

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

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

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

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

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

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

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

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

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

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/configurations/index.ts

@@ -0,0 +1,6 @@
+/* eslint-disable */
+/* tslint:disable */
+// This file is generated. Do not edit it manually.
+
+export type Configurations = {
+}

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

@@ -0,0 +1,6 @@
+/* eslint-disable */
+/* tslint:disable */
+// This file is generated. Do not edit it manually.
+
+export type Entities = {
+}

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

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

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

@@ -0,0 +1,31 @@
+/* eslint-disable */
+/* tslint:disable */
+// This file is generated. Do not edit it manually.
+
+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/.botpress/implementation/typings/states/index.ts

@@ -0,0 +1,6 @@
+/* eslint-disable */
+/* tslint:disable */
+// This file is generated. Do not edit it manually.
+
+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 @@
+/* eslint-disable */
+/* tslint:disable */
+// This file is generated. Do not edit it manually.
+class Secrets {
+}
+export const secrets = new Secrets()

package/templates/hello-world/package.json

@@ -6,8 +6,8 @@
   },
   "private": true,
   "dependencies": {
-    "@botpress/client": "0.37.1",
-    "@botpress/sdk": "2.0.3"
+    "@botpress/client": "0.38.0",
+    "@botpress/sdk": "2.0.4"
   },
   "devDependencies": {
     "@types/node": "^18.19.67",

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

@@ -0,0 +1,57 @@
+/* eslint-disable */
+/* tslint:disable */
+// This file is generated. Do not edit it manually.
+
+import * as sdk from "@botpress/sdk"
+import * as typings from "./typings/index"
+export * from "./typings/index"
+
+type TIntegration = sdk.DefaultIntegration<typings.TIntegration>
+
+export type IntegrationProps = sdk.IntegrationProps<TIntegration>
+
+export class Integration extends sdk.Integration<TIntegration> {}
+
+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 = {
+  [K in keyof IntegrationProps['actions']]: Parameters<IntegrationProps['actions'][K]>[0]
+}
+export type AnyActionProps = ValueOf<ActionProps>
+
+export type MessageProps = {
+  [TChannel in keyof IntegrationProps['channels']]: {
+    [TMessage in keyof IntegrationProps['channels'][TChannel]['messages']]: Parameters<
+      IntegrationProps['channels'][TChannel]['messages'][TMessage]
+    >[0]
+  }
+}
+export type AnyMessageProps = ValueOf<ValueOf<MessageProps>>
+
+export type Context = HandlerProps['ctx']
+export type Logger = HandlerProps['logger']
+
+export type AckFunctions = {
+  [TChannel in keyof MessageProps]: {
+    [TMessage in keyof MessageProps[TChannel]]: Cast<MessageProps[TChannel][TMessage], AnyMessageProps>['ack']
+  }
+}
+export type AnyAckFunction = ValueOf<ValueOf<AckFunctions>>
+
+export type ClientOperation = ValueOf<{
+  [K in keyof Client as Client[K] extends AsyncFunction ? K : never]: K
+}>
+export type ClientRequests = {
+  [K in ClientOperation]: Parameters<Client[K]>[0]
+}
+export type ClientResponses = {
+  [K in ClientOperation]: Awaited<ReturnType<Client[K]>>
+}

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

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

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

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

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

@@ -0,0 +1,12 @@
+/* eslint-disable */
+/* tslint:disable */
+// This file is generated. Do not edit it manually.
+
+import { Messages } from './messages/index'
+export * from './messages/index'
+
+export type Webhook = {
+  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/typings/channels/webhook/messages/index.ts

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

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

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

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

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

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

@@ -0,0 +1,6 @@
+/* eslint-disable */
+/* tslint:disable */
+// This file is generated. Do not edit it manually.
+
+export type Configurations = {
+}

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

@@ -0,0 +1,6 @@
+/* eslint-disable */
+/* tslint:disable */
+// This file is generated. Do not edit it manually.
+
+export type Entities = {
+}

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

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

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

@@ -0,0 +1,31 @@
+/* eslint-disable */
+/* tslint:disable */
+// This file is generated. Do not edit it manually.
+
+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 @@
+/* eslint-disable */
+/* tslint:disable */
+// This file is generated. Do not edit it manually.
+
+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 @@
+/* eslint-disable */
+/* tslint:disable */
+// This file is generated. Do not edit it manually.
+class Secrets {
+}
+export const secrets = new Secrets()

package/templates/webhook-message/package.json

@@ -6,8 +6,8 @@
   },
   "private": true,
   "dependencies": {
-    "@botpress/client": "0.37.1",
-    "@botpress/sdk": "2.0.3",
+    "@botpress/client": "0.38.0",
+    "@botpress/sdk": "2.0.4",
     "axios": "^1.6.8"
   },
   "devDependencies": {

package/e2e/api.ts

@@ -1,25 +0,0 @@
-import { Client } from '@botpress/client'
-
-export type ApiBot = Awaited<ReturnType<Client['listBots']>>['bots'][0]
-export const fetchAllBots = async (client: Client): Promise<ApiBot[]> => {
-  let allBots: ApiBot[] = []
-  let nextToken: string | undefined
-  do {
-    const { bots, meta } = await client.listBots({ nextToken })
-    allBots = [...allBots, ...bots]
-    nextToken = meta.nextToken
-  } while (nextToken)
-  return allBots
-}
-
-export type ApiIntegration = Awaited<ReturnType<Client['listIntegrations']>>['integrations'][0]
-export const fetchAllIntegrations = async (client: Client): Promise<ApiIntegration[]> => {
-  let allIntegrations: ApiIntegration[] = []
-  let nextToken: string | undefined
-  do {
-    const { integrations, meta } = await client.listIntegrations({ nextToken })
-    allIntegrations = [...allIntegrations, ...integrations]
-    nextToken = meta.nextToken
-  } while (nextToken)
-  return allIntegrations
-}

package/e2e/defaults.ts

@@ -1,20 +0,0 @@
-const noBuild = false
-const secrets = [] satisfies string[]
-const sourceMap = false
-const verbose = false
-const confirm = true
-const json = false
-const allowDeprecated = false
-const isPublic = false
-const minify = true
-export default {
-  minify,
-  noBuild,
-  secrets,
-  sourceMap,
-  verbose,
-  confirm,
-  json,
-  allowDeprecated,
-  public: isPublic,
-}

package/e2e/index.ts

@@ -1,118 +0,0 @@
-import { Logger } from '@bpinternal/log4bot'
-import yargs, { YargsConfig, YargsSchema } from '@bpinternal/yargs-extra'
-import * as consts from '../src/consts'
-import { createDeployBot } from './tests/create-deploy-bot'
-import { createDeployIntegration } from './tests/create-deploy-integration'
-import { devBot } from './tests/dev-bot'
-import { installAllInterfaces } from './tests/install-interfaces'
-import { addIntegration } from './tests/install-package'
-import { requiredSecrets } from './tests/integration-secrets'
-import { prependWorkspaceHandle, enforceWorkspaceHandle } from './tests/manage-workspace-handle'
-import { Test } from './typings'
-import { sleep, TmpDirectory } from './utils'
-
-const tests: Test[] = [
-  createDeployBot,
-  createDeployIntegration,
-  devBot,
-  requiredSecrets,
-  prependWorkspaceHandle,
-  enforceWorkspaceHandle,
-  addIntegration,
-  installAllInterfaces,
-]
-
-const timeout = (ms: number) =>
-  sleep(ms).then(() => {
-    throw new Error(`Timeout after ${ms}ms`)
-  })
-
-const TIMEOUT = 45_000
-
-const configSchema = {
-  timeout: {
-    type: 'number',
-    default: TIMEOUT,
-  },
-  verbose: {
-    type: 'boolean',
-    default: false,
-    alias: 'v',
-  },
-  filter: {
-    type: 'string',
-  },
-  workspaceId: {
-    type: 'string',
-    demandOption: true,
-  },
-  workspaceHandle: {
-    type: 'string',
-    demandOption: true,
-  },
-  token: {
-    type: 'string',
-    demandOption: true,
-  },
-  apiUrl: {
-    type: 'string',
-    default: consts.defaultBotpressApiUrl,
-  },
-  tunnelUrl: {
-    type: 'string',
-    default: consts.defaultTunnelUrl,
-  },
-  sdkPath: {
-    type: 'string',
-    description: 'Path to the Botpress SDK to install; Allows using a version not released on NPM yet.',
-  },
-  clientPath: {
-    type: 'string',
-    description: 'Path to the Botpress Client to install; Allows using a version not released on NPM yet.',
-  },
-} satisfies YargsSchema
-
-const main = async (argv: YargsConfig<typeof configSchema>): Promise<never> => {
-  const logger = new Logger('e2e', { level: argv.verbose ? 'debug' : 'info' })
-
-  const filterRegex = argv.filter ? new RegExp(argv.filter) : null
-  const filteredTests = tests.filter(({ name }) => (filterRegex ? filterRegex.test(name) : true))
-  logger.info(`Running ${filteredTests.length} / ${tests.length} tests`)
-
-  const dependencies = { '@botpress/sdk': argv.sdkPath, '@botpress/client': argv.clientPath } satisfies Record<
-    string,
-    string | undefined
-  >
-
-  for (const { name, handler } of filteredTests) {
-    const logLine = `### Running test: "${name}" ###`
-    const logPad = '#'.repeat(logLine.length)
-    logger.info(logPad)
-    logger.info(logLine)
-    logger.info(logPad + '\n')
-
-    const loggerNamespace = name.replace(/ /g, '_').replace(/[^a-zA-Z0-9_]/g, '')
-
-    const tmpDir = TmpDirectory.create()
-    try {
-      const t0 = Date.now()
-      await Promise.race([
-        handler({ tmpDir: tmpDir.path, dependencies, logger: logger.sub(loggerNamespace), ...argv }),
-        timeout(argv.timeout),
-      ])
-      const t1 = Date.now()
-      logger.info(`SUCCESS: "${name}" (${t1 - t0}ms)`)
-    } catch (thrown) {
-      const err = thrown instanceof Error ? thrown : new Error(`${thrown}`)
-      logger.attachError(err).error(`FAILURE: "${name}"`)
-      process.exit(1)
-    } finally {
-      tmpDir.cleanup()
-    }
-  }
-
-  logger.info('All tests passed')
-  process.exit(0)
-}
-
-void yargs.command('$0', 'Run E2E Tests', configSchema, main).parse()