@botpress/adk 1.13.10 → 1.13.12

package/dist/index.d.ts

@@ -28,6 +28,6 @@ export { FileWatcher } from './file-watcher/index.js';
 export type { WatchChangeType, FileChange, FileChangeEvent as FileWatcherChangeEvent, FileWatcherOptions, } from './file-watcher/index.js';
 export { PreflightChecker, PreflightFormatter } from './preflight/index.js';
 export type { PreflightCheckResult, PendingPreflightResult } from './preflight/index.js';
-export { ScriptRunner, runScript } from './runner/index.js';
-export type { ScriptRunnerOptions, RunScriptOptions } from './runner/index.js';
+export { ScriptRunner, runScript, setupTestRuntime } from './runner/index.js';
+export type { ScriptRunnerOptions, RunScriptOptions, TestRuntimeResult, SetupTestRuntimeOptions } from './runner/index.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACzE,YAAY,EAAE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAG9F,cAAc,qBAAqB,CAAA;AAEnC,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EACL,kBAAkB,EAClB,SAAS,EACT,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,GACpB,MAAM,0BAA0B,CAAA;AAGjC,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAGvF,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAChG,YAAY,EACV,WAAW,EACX,YAAY,EACZ,SAAS,EACT,WAAW,EACX,gBAAgB,EAChB,eAAe,EACf,WAAW,EACX,UAAU,EACV,cAAc,EACd,eAAe,EACf,cAAc,EACd,YAAY,EACZ,WAAW,EACX,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,0BAA0B,CAAA;AAGjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAA;AAG7D,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,qBAAqB,EACrB,kBAAkB,EAClB,sBAAsB,EACtB,QAAQ,GACT,MAAM,yBAAyB,CAAA;AAChC,YAAY,EACV,cAAc,EACd,qBAAqB,EACrB,iBAAiB,EACjB,2BAA2B,EAC3B,sBAAsB,EACtB,wBAAwB,EACxB,6BAA6B,EAC7B,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,wBAAwB,EACxB,sBAAsB,EACtB,aAAa,EACb,YAAY,EACZ,WAAW,GACZ,MAAM,yBAAyB,CAAA;AAGhC,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AACtH,YAAY,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAA;AAGpH,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,YAAY,EACV,SAAS,EACT,cAAc,EACd,aAAa,EACb,eAAe,EACf,aAAa,EACb,kBAAkB,EAClB,gBAAgB,EAChB,WAAW,GACZ,MAAM,mBAAmB,CAAA;AAG1B,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAC/F,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAA;AAG5E,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAE1G,YAAY,EAAE,mBAAmB,EAAE,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AAG9G,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,YAAY,EACV,mBAAmB,EACnB,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,UAAU,EACV,WAAW,GACZ,MAAM,mBAAmB,CAAA;AAG1B,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACzF,YAAY,EACV,uBAAuB,EACvB,UAAU,EACV,YAAY,EACZ,aAAa,EACb,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAChB,WAAW,GACZ,MAAM,sBAAsB,CAAA;AAG7B,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AACrD,YAAY,EACV,eAAe,EACf,UAAU,EACV,eAAe,IAAI,sBAAsB,EACzC,kBAAkB,GACnB,MAAM,yBAAyB,CAAA;AAGhC,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAC3E,YAAY,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAGxF,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC3D,YAAY,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACzE,YAAY,EAAE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAG9F,cAAc,qBAAqB,CAAA;AAEnC,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EACL,kBAAkB,EAClB,SAAS,EACT,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,GACpB,MAAM,0BAA0B,CAAA;AAGjC,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAGvF,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAChG,YAAY,EACV,WAAW,EACX,YAAY,EACZ,SAAS,EACT,WAAW,EACX,gBAAgB,EAChB,eAAe,EACf,WAAW,EACX,UAAU,EACV,cAAc,EACd,eAAe,EACf,cAAc,EACd,YAAY,EACZ,WAAW,EACX,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,0BAA0B,CAAA;AAGjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAA;AAG7D,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,qBAAqB,EACrB,kBAAkB,EAClB,sBAAsB,EACtB,QAAQ,GACT,MAAM,yBAAyB,CAAA;AAChC,YAAY,EACV,cAAc,EACd,qBAAqB,EACrB,iBAAiB,EACjB,2BAA2B,EAC3B,sBAAsB,EACtB,wBAAwB,EACxB,6BAA6B,EAC7B,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,wBAAwB,EACxB,sBAAsB,EACtB,aAAa,EACb,YAAY,EACZ,WAAW,GACZ,MAAM,yBAAyB,CAAA;AAGhC,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AACtH,YAAY,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAA;AAGpH,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,YAAY,EACV,SAAS,EACT,cAAc,EACd,aAAa,EACb,eAAe,EACf,aAAa,EACb,kBAAkB,EAClB,gBAAgB,EAChB,WAAW,GACZ,MAAM,mBAAmB,CAAA;AAG1B,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAC/F,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAA;AAG5E,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAE1G,YAAY,EAAE,mBAAmB,EAAE,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AAG9G,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,YAAY,EACV,mBAAmB,EACnB,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,UAAU,EACV,WAAW,GACZ,MAAM,mBAAmB,CAAA;AAG1B,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACzF,YAAY,EACV,uBAAuB,EACvB,UAAU,EACV,YAAY,EACZ,aAAa,EACb,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAChB,WAAW,GACZ,MAAM,sBAAsB,CAAA;AAG7B,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AACrD,YAAY,EACV,eAAe,EACf,UAAU,EACV,eAAe,IAAI,sBAAsB,EACzC,kBAAkB,GACnB,MAAM,yBAAyB,CAAA;AAGhC,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAC3E,YAAY,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAGxF,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAC7E,YAAY,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAA"}

package/dist/index.js

@@ -666,7 +666,7 @@ var PRETTIER_CONFIG, formatCode = async (code, filepath) => {
 `));
     return code;
   }
-}, ADK_VERSION = "1.13.10", relative2 = (from, to) => {
+}, ADK_VERSION = "1.13.12", relative2 = (from, to) => {
   const fromDir = path10.dirname(from);
   const relative3 = path10.relative(fromDir, to);
   return relative3.startsWith(".") ? relative3 : `./${relative3}`;
@@ -809,7 +809,7 @@ var init_integration_action_types = __esm(() => {
 var require_package = __commonJS((exports, module) => {
   module.exports = {
     name: "@botpress/adk",
-    version: "1.13.10",
+    version: "1.13.12",
     description: "Core ADK library for building AI agents on Botpress",
     type: "module",
     main: "dist/index.js",
@@ -856,7 +856,7 @@ var require_package = __commonJS((exports, module) => {
       "@botpress/cli": "^5.1.1",
       "@botpress/client": "^1.28.0",
       "@botpress/cognitive": "^0.3.3",
-      "@botpress/runtime": "^1.13.10",
+      "@botpress/runtime": "^1.13.12",
       "@botpress/sdk": "^5.0.2",
       "@bpinternal/jex": "^1.2.4",
       "@bpinternal/yargs-extra": "^0.0.21",
@@ -6226,6 +6226,73 @@ name: "userdataTable"
 4. **Test in dev mode** with hot reloading (\`adk dev\`)
 5. **Follow TypeScript types** - They're auto-generated from integrations
 
+## Running Tests
+
+The ADK provides \`setupTestRuntime()\` to initialize the full ADK runtime within your test process. This sets up all environment variables, generates types, and imports the runtime so your tests can use actions, tools, workflows, etc.
+
+### Bun Test
+
+\`\`\`toml
+# bunfig.toml
+[test]
+preload = ["./test-setup.ts"]
+\`\`\`
+
+\`\`\`typescript
+// test-setup.ts
+import { beforeAll } from "bun:test";
+import { setupTestRuntime } from "@botpress/adk";
+
+beforeAll(async () => {
+  const runtime = await setupTestRuntime();
+  await runtime.initialize();
+});
+\`\`\`
+
+### Vitest
+
+\`\`\`typescript
+// vitest.setup.ts
+import { beforeAll } from "vitest";
+import { setupTestRuntime } from "@botpress/adk";
+
+beforeAll(async () => {
+  const runtime = await setupTestRuntime();
+  await runtime.initialize();
+});
+\`\`\`
+
+\`\`\`typescript
+// vitest.config.ts
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    setupFiles: ["./vitest.setup.ts"],
+  },
+});
+\`\`\`
+
+### Options
+
+\`setupTestRuntime()\` auto-detects project path and credentials, but you can override:
+
+\`\`\`typescript
+const runtime = await setupTestRuntime({
+  projectPath: "/path/to/agent", // defaults to auto-detect from CWD
+  credentials: { token: "...", apiUrl: "..." }, // defaults to ~/.adk/credentials
+  prod: true, // use production bot instead of dev bot
+  forceRegenerate: true, // force regenerate bot project
+  env: { CUSTOM_VAR: "value" }, // additional env vars
+});
+\`\`\`
+
+### Prerequisites
+
+- Must have \`@botpress/adk\` installed as a dev dependency (\`bun add -d @botpress/adk\`)
+- Must have run \`adk dev\` at least once (to create the dev bot)
+- Must be logged in (\`adk login\`) or provide credentials explicitly
+
 ## Resources
 
 - [ADK Overview](https://botpress.com/docs/for-developers/adk/overview)
@@ -6280,7 +6347,7 @@ class AgentProjectGenerator {
         deploy: "adk deploy"
       },
       dependencies: {
-        "@botpress/runtime": `^${"1.13.10"}`
+        "@botpress/runtime": `^${"1.13.12"}`
       },
       devDependencies: {
         typescript: "^5.9.3"
@@ -10984,6 +11051,21 @@ import fs18 from "fs/promises";
 import path36 from "path";
 import { spawn } from "child_process";
 init_utils();
+init_credentials();
+async function findAgentRoot(startPath) {
+  let currentPath = path36.resolve(startPath);
+  const root = path36.parse(currentPath).root;
+  while (currentPath !== root) {
+    try {
+      await fs18.access(path36.join(currentPath, "agent.config.ts"));
+      return currentPath;
+    } catch {
+      currentPath = path36.dirname(currentPath);
+    }
+  }
+  return null;
+}
+
 class ScriptRunner {
   projectPath;
   forceRegenerate;
@@ -11035,6 +11117,11 @@ class ScriptRunner {
        */
       import * as bp from '.botpress'
       import { setupAdkRuntime } from './adk-runtime'
+      import { context, agentRegistry } from '@botpress/runtime/runtime'
+      import { Autonomous } from '@botpress/runtime'
+      import { Client } from '@botpress/client'
+      import { BotSpecificClient, BotLogger } from '@botpress/sdk'
+      import { Cognitive } from '@botpress/cognitive'
 
       // Create a minimal bot instance for runtime initialization
       const bot = new bp.Bot({
@@ -11044,6 +11131,33 @@ class ScriptRunner {
       // Initialize the ADK runtime
       setupAdkRuntime(bot)
 
+      // Set up default context for script execution (outside of request handlers)
+      const botId = process.env.ADK_BOT_ID!
+      const token = process.env.ADK_TOKEN!
+      const apiUrl = process.env.ADK_API_URL || 'https://api.botpress.cloud'
+      const configuration = process.env.ADK_CONFIGURATION ? JSON.parse(process.env.ADK_CONFIGURATION) : {}
+
+      const vanillaClient = new Client({ token, apiUrl, botId })
+      const client = new BotSpecificClient(vanillaClient as any)
+      const cognitive = new Cognitive({ client: client as any, __experimental_beta: true })
+      const logger = new BotLogger({})
+
+      context.setDefaultContext({
+        executionId: 'script-execution',
+        executionFinished: false,
+        botId,
+        client: client as any,
+        cognitive: cognitive as any,
+        citations: new Autonomous.CitationsManager(),
+        logger: logger as any,
+        configuration,
+        integrations: agentRegistry.integrations,
+        interfaces: agentRegistry.interfaces,
+        states: [],
+        tags: [],
+        scheduledHeavyImports: new Set<string>(),
+      })
+
       // Export runtime utilities for scripts to use
       export { bot }
 
@@ -11088,6 +11202,81 @@ class ScriptRunner {
     `;
     await fs18.writeFile(path36.join(botPath, "src", "script-runner.ts"), await formatCode(content), "utf-8");
   }
+  async setupTestRuntime(options = {}) {
+    const { botPath, project } = await this.prepare();
+    const botId = this.prod ? project.agentInfo?.botId : project.agentInfo?.devId || project.agentInfo?.botId;
+    const workspaceId = project.agentInfo?.workspaceId || "";
+    if (!botId) {
+      const idType = this.prod ? "botId" : "devId";
+      throw new Error(`No ${idType} found in agent.json. ` + (this.prod ? 'Please deploy your agent first with "adk deploy".' : 'Please run "adk dev" first to create a development bot, or use --prod to use the production bot.'));
+    }
+    let configuration;
+    try {
+      const manager3 = new ConfigManager(botId);
+      configuration = await manager3.getAll();
+    } catch {}
+    const envVars = {
+      ADK_PROJECT_PATH: this.projectPath,
+      ADK_BOT_PATH: botPath,
+      ADK_BOT_ID: botId,
+      ADK_WORKSPACE_ID: workspaceId,
+      ADK_IS_PROD: this.prod ? "true" : "false",
+      BP_DISABLE_WORKER_MODE: "true",
+      ADK_SCRIPT_MODE: "true",
+      ADK_TOKEN: this.credentials.token,
+      ADK_API_URL: this.credentials.apiUrl,
+      ...configuration && { ADK_CONFIGURATION: JSON.stringify(configuration) },
+      ...options.env
+    };
+    for (const [key, value] of Object.entries(envVars)) {
+      process.env[key] = value;
+    }
+    const runtimePath = path36.join(botPath, "src", "index.ts");
+    return {
+      botPath,
+      runtimePath,
+      botId,
+      workspaceId,
+      isProd: this.prod,
+      project,
+      initialize: async () => {
+        const botModule = await import(runtimePath);
+        const runtimeModule = await import("@botpress/runtime/runtime");
+        const { Autonomous } = await import("@botpress/runtime");
+        const { context, agentRegistry } = runtimeModule;
+        const { Client: Client16 } = await import("@botpress/client");
+        const { BotSpecificClient, BotLogger } = await import("@botpress/sdk");
+        const { Cognitive } = await import("@botpress/cognitive");
+        const vanillaClient = new Client16({
+          token: this.credentials.token,
+          apiUrl: this.credentials.apiUrl,
+          botId
+        });
+        const client = new BotSpecificClient(vanillaClient);
+        const cognitive = new Cognitive({
+          client,
+          __experimental_beta: true
+        });
+        const logger = new BotLogger({});
+        context.setDefaultContext({
+          executionId: "test-execution",
+          executionFinished: false,
+          botId,
+          client,
+          cognitive,
+          citations: new Autonomous.CitationsManager,
+          logger,
+          configuration: configuration ?? {},
+          integrations: agentRegistry.integrations,
+          interfaces: agentRegistry.interfaces,
+          states: [],
+          tags: [],
+          scheduledHeavyImports: new Set
+        });
+        return botModule.default;
+      }
+    };
+  }
   async run(scriptPath, options = {}) {
     const { botPath, runnerPath, project } = await this.prepare();
     const absoluteScriptPath = path36.isAbsolute(scriptPath) ? scriptPath : path36.resolve(this.projectPath, scriptPath);
@@ -11149,9 +11338,40 @@ async function runScript(options) {
     inheritStdio: options.inheritStdio
   });
 }
+async function setupTestRuntime(options = {}) {
+  let projectPath = options.projectPath;
+  if (!projectPath) {
+    const detected = await findAgentRoot(process.cwd());
+    if (!detected) {
+      throw new Error(`Could not find ADK agent project. No agent.config.ts found in current directory or parents.
+Either run from within an agent project directory, or provide projectPath explicitly.`);
+    }
+    projectPath = detected;
+  }
+  let credentials = options.credentials;
+  if (!credentials) {
+    const credentialsManager = new CredentialsManager;
+    const loadedCredentials = await credentialsManager.getCredentials();
+    if (!loadedCredentials) {
+      throw new Error('No credentials found. Please run "adk login" first, or provide credentials explicitly.');
+    }
+    credentials = {
+      token: loadedCredentials.token,
+      apiUrl: loadedCredentials.apiUrl
+    };
+  }
+  const runner = new ScriptRunner({
+    projectPath,
+    forceRegenerate: options.forceRegenerate,
+    prod: options.prod,
+    credentials
+  });
+  return runner.setupTestRuntime({ env: options.env });
+}
 export {
   workspaceCache,
   stringifyWithOrder,
+  setupTestRuntime,
   runScript,
   orderKeys,
   integrationKeyOrder,
@@ -11208,4 +11428,4 @@ export {
   AgentProject
 };
 
-//# debugId=34DC1EC72B61FDE964756E2164756E21
+//# debugId=04935BA1B40451BA64756E2164756E21