@botpress/adk-cli 1.19.0-beta.3 → 1.19.0-beta.5

package/dist/integrations-k5ss07f4.md

@@ -0,0 +1,266 @@
+# Integration Management
+
+Integrations connect your agent to external platforms and services. Manage them entirely through the CLI — never hand-edit lock files.
+
+## CLI Commands
+
+All integration management uses the `adk integrations` subcommand family. Every mutation command supports `--target <env>` (dev or prod, default: dev) and `--format <format>` (text or json).
+
+> **Deprecated aliases:** The old flat commands (`adk add`, `adk remove`, `adk search`, `adk list`, `adk info`, `adk upgrade`) still work as shims but emit deprecation warnings. Use the `adk integrations` subcommands instead.
+
+### Discovery
+
+| Command | Description | Key Flags |
+|---------|-------------|-----------|
+| `adk integrations search <query>` | Search by keyword | `--format json`, `--limit <n>` (default: 20) |
+| `adk integrations list --available` | Browse all Hub integrations | `--format json`, `--limit <n>` (default: 50) |
+| `adk integrations list` | Show installed dependencies | `--format json`, `--verbose` |
+| `adk integrations info <name>` | Full integration details | `--actions`, `--channels`, `--events`, `--full`, `--format json` |
+
+Use `--format json` for programmatic inspection of config schemas, action shapes, and event payloads.
+
+### Mutations
+
+| Command | Description | Key Flags |
+|---------|-------------|-----------|
+| `adk integrations add <name>@<version>` | Install an integration | `--alias <name>`, `--target <env>`, `--config key=value` |
+| `adk integrations remove <alias>` | Uninstall an integration | `--target <env>` |
+| `adk integrations upgrade <alias>` | Upgrade to latest (or specific) version | `--to <version>`, `--target <env>` |
+| `adk integrations enable <alias>` | Enable a disabled integration | `--target <env>` |
+| `adk integrations disable <alias>` | Disable without removing | `--target <env>` |
+| `adk integrations configure <alias>` | Set or unset config values | `--set key=value`, `--unset key`, `--target <env>` |
+
+### State Management
+
+| Command | Description | Key Flags |
+|---------|-------------|-----------|
+| `adk integrations pull-lock` | Pull cloud state into lock file | `--target <env>`, `--dry-run` |
+| `adk integrations push-lock` | Push lock file to cloud | `--target <env>`, `--dry-run`, `--yes` |
+| `adk integrations copy` | Copy integration state between environments | `--from <env>`, `--to <env>` |
+| `adk integrations diff` | Show differences between lock file and cloud | `--target <env>` |
+
+## Lock File System
+
+Integration state lives in per-environment lock files at the project root:
+
+- `dependencies.dev.lock.json` — development environment
+- `dependencies.prod.lock.json` — production environment
+
+```json
+{
+  "version": 1,
+  "env": "dev",
+  "integrations": {
+    "slack": {
+      "name": "slack",
+      "version": "3.0.0",
+      "enabled": true,
+      "config": {
+        "replyBehaviour": "start-conversation",
+        "apiSecret": "${env:SLACK_SECRET}"
+      }
+    },
+    "browser": {
+      "name": "browser",
+      "version": "0.8.6",
+      "enabled": true,
+      "config": {}
+    }
+  },
+  "plugins": {}
+}
+```
+
+**Key principles:**
+- Cloud is the source of truth. The lock file is a local reflection refreshed after every mutation.
+- Never edit lock files by hand — use `adk integrations` commands.
+- The `--target` flag controls which environment (dev/prod) a command operates on.
+- Config values support env substitution: `${env:API_KEY}` resolves to `process.env.API_KEY` at apply time.
+
+**Migration from agent.config.ts:** Projects with a legacy `dependencies` block in `agent.config.ts` are auto-migrated to lock files on the first CLI command. The migration is one-shot and skipped if lock files already exist.
+
+## Integration Lifecycle
+
+### 1. Discover
+
+```bash
+adk integrations search slack
+adk integrations list --available
+adk integrations info slack --format json
+```
+
+### 2. Add
+
+```bash
+adk integrations add slack@3.0.0
+adk integrations add openai@1.0.0 --alias ai
+adk integrations add agi/linear@2.0.0
+```
+
+Always pin to a specific version. Without `--alias`, the integration name becomes the alias.
+
+What happens: the integration is resolved, an entry is written to the lock file, and the integration starts **disabled** with status `registration_pending`.
+
+### 3. Configure
+
+```bash
+adk integrations configure slack --set replyBehaviour=start-conversation
+adk integrations configure slack --set apiSecret='${env:SLACK_SECRET}'
+adk integrations configure slack --unset optionalField
+```
+
+For OAuth integrations, complete the authorization flow in the Botpress Dev Console (`localhost:3001` during dev).
+
+### 4. Enable
+
+```bash
+adk integrations enable slack
+```
+
+After enabling, the integration registers with Botpress Cloud:
+
+```
+registration_pending → registered       (success)
+                     → registration_failed  (error)
+```
+
+Check status with `adk integrations list`.
+
+### 5. Use in Code
+
+```typescript
+import { actions } from '@botpress/runtime'
+
+await actions.slack.sendMessage({ channel: '#general', text: 'Hello!' })
+await actions.browser.webSearch({ query: 'Botpress ADK' })
+```
+
+The alias determines the accessor: `actions.<alias>.<actionName>()`. See **[Integration Actions](./integration-actions.md)** for the full API reference.
+
+### 6. Remove / Upgrade
+
+```bash
+adk integrations remove slack
+adk integrations upgrade slack
+```
+
+After upgrading, check for breaking changes in the new version, then re-deploy with `adk deploy`.
+
+## Configuration Types
+
+Use `adk integrations info <name> --format json` to inspect an integration's configuration schema.
+
+### No Config
+
+Zero configuration properties. Just enable it.
+
+**Example:** `browser` — add, enable, done.
+
+### Optional Config Only
+
+Has configuration properties but none are required. Works out of the box.
+
+**Examples:**
+- `chat` — optional `encryptionKey`, `webhookUrl`, `webhookSecret`
+- `webchat` — ~38 optional theming/behavior props (`primaryColor`, `fontFamily`, `allowFileUpload`, etc.)
+- `webhook` — optional `secret` and `allowedOrigins`
+
+### OAuth (Link-Based)
+
+Default configuration includes an `identifier` with a `linkTemplateScript`. User clicks a generated URL in the Dev Console to authorize.
+
+**Examples:** `whatsapp` (default config), `linear` (default config)
+
+### OAuth + Required Fields
+
+OAuth authorization plus required configuration fields.
+
+**Example:** `slack` — requires `replyBehaviour` in addition to OAuth. Alternative configs: `manifestAppCredentials`, `refreshToken`.
+
+### API Key / Manual
+
+Configuration schema has required string fields, often marked `x-zui.secret: true`. User enters values in the Dev Console or via `adk integrations configure --set`.
+
+**Examples:** `linear` (apiKey config), `whatsapp` (manual config)
+
+### Sandbox
+
+Testing mode using a shared Botpress account. The integration provides a sandbox configuration with a VRL script.
+
+**Example:** `whatsapp` sandbox config (shared test phone number: +1-581-701-9840)
+
+### Detecting Config Type from CLI
+
+Inspect `adk integrations info <name> --format json`:
+
+| JSON Key | What It Tells You |
+|----------|-------------------|
+| `configuration.schema` | Default config schema (properties, required fields) |
+| `configuration.identifier` | Whether OAuth/link-based auth is used |
+| `configurations` | Alternative configuration types (if any) |
+
+If `configuration.schema.properties` is empty or all optional → no manual config needed.
+If `configuration.identifier.linkTemplateScript` exists → OAuth.
+If `configurations` has multiple entries → multiple modes available.
+
+## Common Integrations Quick Reference
+
+### chat
+
+**Config:** Optional only (none required)
+**Actions:** 1 (sendEvent) | **Channels:** 1 | **Events:** 1 (custom)
+
+Used internally by `adk chat` CLI command. Good default for basic messaging during development.
+
+### webchat
+
+**Config:** Optional only (~38 theming/behavior props, none required)
+**Actions:** 9 (configWebchat, showWebchat, hideWebchat, etc.) | **Channels:** 1 | **Events:** 2
+
+Embeddable web chat widget. Works out of the box.
+
+### browser
+
+**Config:** None (zero properties)
+**Actions:** 5 (browsePages, webSearch, discoverUrls, captureScreenshot, getWebsiteLogo) | **Channels:** 0 | **Events:** 0
+
+Most commonly used for RAG, web search, and page scraping. No configuration needed.
+
+### slack
+
+**Config:** OAuth + required `replyBehaviour`
+**Actions:** Multiple | **Channels:** 3 (channel, dm, thread) | **Events:** 6
+
+After adding: enable in Dev Console, set `replyBehaviour`, complete OAuth. Alternative configs: `manifestAppCredentials`, `refreshToken`.
+
+### whatsapp
+
+**Config:** 3 modes (OAuth, sandbox, manual)
+**Actions:** Multiple | **Channels:** 1 | **Events:** Multiple
+
+Sandbox mode is useful for quick testing without a WhatsApp Business account.
+
+### linear
+
+**Name:** `agi/linear` (private, workspace-scoped) | **Config:** OAuth or API key
+**Actions:** Multiple | **Channels:** Multiple | **Events:** Multiple
+
+Use full name when searching: `adk integrations info agi/linear`.
+
+### webhook
+
+**Config:** Optional only (none required)
+**Actions:** 0 | **Channels:** 0 | **Events:** 1
+
+Receives external HTTP webhooks. Only fires events when a payload arrives.
+
+## Name Resolution
+
+| Format | Example | Meaning |
+|--------|---------|---------|
+| Plain name | `slack` | Official/public integration, latest version |
+| `name@version` | `slack@3.0.0` | Specific version |
+| `workspace/name` | `agi/linear` | Private (workspace-scoped) integration |
+| `intver_<ULID>` | `intver_01KM6EB027NRCST3M696XT0GTW` | Exact integration version ID |
+
+Official integrations use just the name. Private integrations are prefixed with the workspace slug and are only visible to workspace members.

package/dist/interfaces-6t0bpxs4.md

@@ -0,0 +1,97 @@
+# Interfaces
+
+Interfaces are an abstraction layer over integrations. They define a standard contract (a set of actions) that multiple integrations can implement. The ADK uses interfaces to call the same logical action across different integrations without writing integration-specific code.
+
+## Key Concepts
+
+- **Interfaces are built-in.** The ADK automatically includes a fixed set of interfaces in every project. Interfaces are provided by the ADK — they are resolved automatically based on installed integrations.
+- **Interfaces map to integration actions.** At build time, the ADK discovers which installed integrations implement each interface and generates a mapping from interface actions to concrete integration actions.
+- **The runtime resolves calls automatically.** When code calls an interface action (e.g., `startTypingIndicator`), the runtime looks up the correct integration action for the current conversation's integration.
+
+## Built-in Interfaces
+
+Every ADK project includes these interfaces (defined in `@botpress/adk` constants):
+
+| Interface | Version | Purpose |
+|-----------|---------|---------|
+| `typing-indicator` | `0.0.3` | Start/stop typing indicators across messaging integrations |
+| `llm` | `9.0.0` | Standard LLM operations |
+| `listable` | `0.0.2` | List operations on integration resources |
+
+These are hard-coded in the ADK and synced automatically during `adk dev` and `adk build`. Users cannot modify this list.
+
+> **Naming:** Interface package names use kebab-case (`typing-indicator`), but the runtime uses camelCase (`typingIndicator`). The ADK handles this translation automatically.
+
+## What Interfaces Enable
+
+### Typing Indicators in Conversation Handlers
+
+The `typing-indicator` interface powers `conversation.startTyping()` and `conversation.stopTyping()`. These work automatically for any integration that implements the interface (webchat, Slack, etc.) with no integration-specific code needed:
+
+```typescript
+import { Conversation } from "@botpress/runtime";
+
+export const Chat = new Conversation({
+  channel: "webchat.channel",
+
+  async handler({ conversation, execute }) {
+    await conversation.startTyping();
+
+    // Do work...
+
+    await execute({
+      instructions: "Help the user",
+    });
+    // Typing stops automatically when a message is sent
+  }
+});
+```
+
+If the conversation's integration does not implement `typing-indicator`, the calls silently no-op (errors are caught and swallowed).
+
+### CLI Commands
+
+```bash
+# List built-in interfaces
+adk interfaces list
+
+# Show details about a specific interface
+adk interfaces info llm
+
+# Both commands support --format json
+adk interfaces list --format json
+```
+
+### Generated Type Files
+
+The ADK generates interface types in `.adk/interfaces/`. Each interface gets:
+
+- `<interface_name>/index.ts` - Type and const exports
+- `<interface_name>/actions.ts` - Per-integration action types and mapping constants
+
+These are aggregated in:
+- `.adk/interfaces.d.ts` - Global `Interfaces` type declaration
+- `.adk/interfaces.ts` - Runtime `Interfaces` const (the mapping object)
+
+## Relationship to Integrations
+
+Interfaces and integrations are complementary. See **[integrations.md](./integrations.md)** for integration management.
+
+- **Integrations** are concrete connections to external services (Slack, webchat, Linear). You add them with `adk add`.
+- **Interfaces** are abstract contracts. An integration *implements* an interface by declaring compatible actions with matching schemas.
+- When you add an integration that implements an interface, the ADK automatically detects this and generates the mapping. No user action is required.
+
+## Scope and Limitations
+
+- Interfaces are **not user-configurable** in the current ADK. The set of built-in interfaces is fixed.
+- Users cannot define custom interfaces or map integrations to interfaces manually.
+- Interface resolution is **per-integration** at the conversation level. The runtime determines which integration a conversation belongs to and resolves interface actions accordingly.
+- If no installed integration implements an interface, the generated mapping for that interface will be empty (no actions).
+- The `llm` and `listable` interfaces may have empty mappings if no installed integration declares support for them.
+- Plugins can depend on interfaces for runtime resolution. See [plugins.md](./plugins.md) for how plugin interface dependencies are wired.
+
+## See Also
+
+- [Integrations](./integrations.md) — Integration management overview
+- [Integration Actions](./integration-actions.md) — Calling integration actions from code
+- [Plugins](./plugins.md) — Plugins that depend on interfaces for runtime resolution