@botpress/cli 0.2.5 → 0.2.7

package/e2e/index.ts

@@ -45,6 +45,14 @@ const configSchema = {
     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> => {
@@ -54,6 +62,11 @@ const main = async (argv: YargsConfig<typeof configSchema>): Promise<never> => {
   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)
@@ -64,7 +77,7 @@ const main = async (argv: YargsConfig<typeof configSchema>): Promise<never> => {
     const tmpDir = TmpDirectory.create()
     try {
       const t0 = Date.now()
-      await Promise.race([handler({ tmpDir: tmpDir.path, ...argv }), timeout(argv.timeout)])
+      await Promise.race([handler({ tmpDir: tmpDir.path, dependencies, ...argv }), timeout(argv.timeout)])
       const t1 = Date.now()
       logger.info(`SUCCESS: "${name}" (${t1 - t0}ms)`)
     } catch (thrown) {

package/e2e/tests/create-deploy-bot.ts

@@ -14,7 +14,7 @@ const fetchBot = async (client: Client, botName: string): Promise<ApiBot | undef
 
 export const createDeployBot: Test = {
   name: 'cli should allow creating, building, deploying and mannaging a bot',
-  handler: async ({ tmpDir, ...creds }) => {
+  handler: async ({ tmpDir, dependencies, ...creds }) => {
     const botpressHomeDir = pathlib.join(tmpDir, '.botpresshome')
     const baseDir = pathlib.join(tmpDir, 'bots')
     const botName = uuid.v4()
@@ -30,6 +30,7 @@ export const createDeployBot: Test = {
     const client = new Client({ host: creds.apiUrl, token: creds.token, workspaceId: creds.workspaceId })
 
     await impl.init({ ...argv, workDir: baseDir, name: botName, type: 'bot' }).then(utils.handleExitCode)
+    await utils.fixBotpressDependencies({ workDir: botDir, target: dependencies })
     await utils.npmInstall({ workDir: botDir }).then(utils.handleExitCode)
     await impl.build({ ...argv, workDir: botDir }).then(utils.handleExitCode)
     await impl.login({ ...argv }).then(utils.handleExitCode)

package/e2e/tests/create-deploy-integration.ts

@@ -15,7 +15,7 @@ const fetchIntegration = async (client: Client, integrationName: string): Promis
 
 export const createDeployIntegration: Test = {
   name: 'cli should allow creating, building, deploying and mannaging an integration',
-  handler: async ({ tmpDir, ...creds }) => {
+  handler: async ({ tmpDir, dependencies, ...creds }) => {
     const botpressHomeDir = pathlib.join(tmpDir, '.botpresshome')
     const baseDir = pathlib.join(tmpDir, 'integrations')
     const integrationName = `myintegration-${uuid.v4()}`.replace(/-/g, '')
@@ -33,6 +33,7 @@ export const createDeployIntegration: Test = {
     await impl
       .init({ ...argv, workDir: baseDir, name: integrationName, type: 'integration' })
       .then(utils.handleExitCode)
+    await utils.fixBotpressDependencies({ workDir: integrationDir, target: dependencies })
     await utils.npmInstall({ workDir: integrationDir }).then(utils.handleExitCode)
     await impl.build({ ...argv, workDir: integrationDir }).then(utils.handleExitCode)
     await impl.login({ ...argv }).then(utils.handleExitCode)

package/e2e/tests/dev-bot.ts

@@ -16,7 +16,7 @@ const PORT = 8075
 
 export const devBot: Test = {
   name: 'cli should allow creating and running a bot locally',
-  handler: async ({ tmpDir, tunnelUrl, ...creds }) => {
+  handler: async ({ tmpDir, tunnelUrl, dependencies, ...creds }) => {
     const botpressHomeDir = pathlib.join(tmpDir, '.botpresshome')
     const baseDir = pathlib.join(tmpDir, 'bots')
     const botName = uuid.v4()
@@ -30,6 +30,7 @@ export const devBot: Test = {
     }
 
     await impl.init({ ...argv, workDir: baseDir, name: botName, type: 'bot' }).then(handleExitCode)
+    await utils.fixBotpressDependencies({ workDir: botDir, target: dependencies })
     await utils.npmInstall({ workDir: botDir }).then(handleExitCode)
     await impl.login({ ...argv }).then(handleExitCode)
 

package/e2e/typings.ts

@@ -4,6 +4,7 @@ export type TestProps = {
   token: string
   apiUrl: string
   tunnelUrl: string
+  dependencies: Record<string, string | undefined>
 }
 
 export type Test = {

package/e2e/utils.ts

@@ -1,6 +1,19 @@
 import childprocess from 'child_process'
+import fs from 'fs'
+import _ from 'lodash'
+import pathlib from 'path'
 import tmp from 'tmp'
 
+type PackageJson = {
+  name: string
+  version?: string
+  description?: string
+  scripts?: Record<string, string>
+  dependencies?: Record<string, string>
+  devDependencies?: Record<string, string>
+  peerDependencies?: Record<string, string>
+}
+
 export const sleep = (ms: number) => new Promise<void>((resolve) => setTimeout(resolve, ms))
 
 export class TmpDirectory {
@@ -35,6 +48,24 @@ export const npmInstall = async ({ workDir }: { workDir: string }) => {
   return { exitCode: status ?? 0 }
 }
 
+export const fixBotpressDependencies = async ({
+  workDir,
+  target,
+}: {
+  workDir: string
+  target: Record<string, string | undefined>
+}) => {
+  const packageJsonPath = pathlib.join(workDir, 'package.json')
+  const originalPackageJson: PackageJson = require(packageJsonPath)
+
+  const newPackageJson = {
+    ...originalPackageJson,
+    dependencies: _.mapValues(originalPackageJson.dependencies ?? {}, (version, name) => target[name] ?? version),
+  }
+
+  fs.writeFileSync(packageJsonPath, JSON.stringify(newPackageJson, null, 2))
+}
+
 export const handleExitCode = ({ exitCode }: { exitCode: number }) => {
   if (exitCode !== 0) {
     throw new Error(`Command exited with code ${exitCode}`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/cli",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "description": "Botpress CLI",
   "scripts": {
     "build": "pnpm run bundle && pnpm run template:gen",
@@ -20,7 +20,7 @@
   },
   "main": "dist/index.js",
   "dependencies": {
-    "@botpress/client": "0.2.0",
+    "@botpress/client": "0.3.0",
     "@bpinternal/tunnel": "^0.1.0",
     "@bpinternal/yargs-extra": "^0.0.3",
     "@parcel/watcher": "^2.1.0",
@@ -47,7 +47,7 @@
     "zod-to-json-schema": "^3.20.1"
   },
   "devDependencies": {
-    "@botpress/sdk": "0.1.6",
+    "@botpress/sdk": "0.2.1",
     "@bpinternal/log4bot": "^0.0.4",
     "@types/bluebird": "^3.5.38",
     "@types/prompts": "^2.0.14",

package/templates/echo-bot/package.json

@@ -8,8 +8,8 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@botpress/client": "0.2.0",
-    "@botpress/sdk": "0.1.6",
+    "@botpress/client": "0.3.0",
+    "@botpress/sdk": "0.2.1",
     "zod": "^3.20.6"
   },
   "devDependencies": {

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

@@ -25,7 +25,7 @@ const bot = new Bot({
   recurringEvents: {},
 })
 
-bot.message('', async ({ message, client, ctx }) => {
+bot.message(async ({ message, client, ctx }) => {
   logger.info('Received message', message)
 
   await client.createMessage({

package/templates/empty-integration/package.json

@@ -8,8 +8,8 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@botpress/client": "0.2.0",
-    "@botpress/sdk": "0.1.6",
+    "@botpress/client": "0.3.0",
+    "@botpress/sdk": "0.2.1",
     "zod": "^3.20.6"
   },
   "devDependencies": {