mirror of
https://github.com/vercel/chat.git
synced 2026-09-14 18:32:29 +08:00
github-actions[bot]
470b6af94b
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @chat-adapter/slack@4.36.0 ### Minor Changes -0153a39: Add `DateInput` and `NumberInput` modal children. The Slack adapter renders them as a `datepicker` and a `number_input`, the Teams adapter as `Input.Date` and `Input.Number`, and both submitted values arrive in `event.values` as strings. Teams submit values that arrive as JSON numbers are now stringified into `event.values` instead of being dropped. This fixes `Input.Number`, but applies to any numeric value a Teams dialog submits — a key that was previously absent from `event.values` will now be present as a string. ### Patch Changes - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 - @chat-adapter/shared@4.36.0 ## @chat-adapter/teams@4.36.0 ### Minor Changes -0153a39: Add `DateInput` and `NumberInput` modal children. The Slack adapter renders them as a `datepicker` and a `number_input`, the Teams adapter as `Input.Date` and `Input.Number`, and both submitted values arrive in `event.values` as strings. Teams submit values that arrive as JSON numbers are now stringified into `event.values` instead of being dropped. This fixes `Input.Number`, but applies to any numeric value a Teams dialog submits — a key that was previously absent from `event.values` will now be present as a string. ### Patch Changes -257a32d: Route Teams personal and group conversations using their explicit conversation type so group chats use buffered fallback even when their IDs resemble direct messages. -3c37cfb: Authenticate connector-hosted inline attachments and parse Teams file download cards. - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 - @chat-adapter/shared@4.36.0 ## @chat-adapter/x@4.36.0 ### Minor Changes -caa6325: Add XChat support to `@chat-adapter/x`, shipped from the new `@chat-adapter/x/chat` subpath so it sits alongside the existing X adapter. The XChat crypto stack (`@xdevplatform/chat-xdk`, `@xdevplatform/xdk`, `juicebox-sdk`) is an optional peer dependency, so existing `@chat-adapter/x` users are unaffected. All cryptography is handled inside the adapter via `@xdevplatform/chat-xdk` (wasm) and all REST goes through the typed `@xdevplatform/xdk` client. Only a bot token and a Juicebox PIN are required: the bot's identity (user id and @handle) is resolved from `GET /2/users/me` at startup. - Encrypted send/receive in DMs and groups (webhook push + polling), signature verification on by default; undecryptable or unverified events are dropped - Webhook POSTs must carry a valid `x-twitter-webhooks-signature`, which X sends on every delivery. Set `consumerSecret` (or `X_CONSUMER_SECRET`) to receive webhooks, or `disableWebhookVerification` when an upstream layer already verifies them. Polling deployments are unaffected - Mention detection from structured mention entities, swipe-replies to the bot, and a plain-text `@handle` fallback; group replies sent as quoted replies - `openDM(userId)` starts (or reuses) an encrypted 1:1, running a full key exchange when needed so the bot can message first - Media both ways: inbound attachments with lazy download+decrypt, outbound encrypted uploads - Edit and delete of the bot's own messages; the first edit of a fresh message is age-gated by `editSafetyDelayMs` (default 5000ms) so receiving clients have stored the original - Reactions in and out, read receipts (`sendReadReceipts`, default on), typing keep-alive, configurable group welcome message - Cards degrade to text with tappable URL/mention entities plus a URL preview attachment - Requests carry a `chat-sdk-xchat/<version>` User-Agent product token so Chat SDK traffic is identifiable in X API request logs (a User-Agent set via `apiHeaders` takes precedence) - Registered in the `chat/adapters` catalog and the `create-chat-sdk` CLI scaffold, with a new optional `importPath` catalog field for adapters that ship on a subpath ### Patch Changes - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 - @chat-adapter/shared@4.36.0 ## chat@4.36.0 ### Minor Changes -c5d86b1: confine built-in agent read tools to the conversation being handled, with an optional scope override -0153a39: Add `DateInput` and `NumberInput` modal children. The Slack adapter renders them as a `datepicker` and a `number_input`, the Teams adapter as `Input.Date` and `Input.Number`, and both submitted values arrive in `event.values` as strings. Teams submit values that arrive as JSON numbers are now stringified into `event.values` instead of being dropped. This fixes `Input.Number`, but applies to any numeric value a Teams dialog submits — a key that was previously absent from `event.values` will now be present as a string. ### Patch Changes -257a32d: Route Teams personal and group conversations using their explicit conversation type so group chats use buffered fallback even when their IDs resemble direct messages. -b547f45: Stop treating email addresses as bot mentions. A message containing `jane@acme.com` no longer triggers a bot named `acme`, because the `@` in `detectMention` must not follow a word character. Real mentions are unaffected, including at the start of a message, after punctuation, and suffixed names such as GitHub's `mybot[bot]`. -caa6325: Add XChat support to `@chat-adapter/x`, shipped from the new `@chat-adapter/x/chat` subpath so it sits alongside the existing X adapter. The XChat crypto stack (`@xdevplatform/chat-xdk`, `@xdevplatform/xdk`, `juicebox-sdk`) is an optional peer dependency, so existing `@chat-adapter/x` users are unaffected. All cryptography is handled inside the adapter via `@xdevplatform/chat-xdk` (wasm) and all REST goes through the typed `@xdevplatform/xdk` client. Only a bot token and a Juicebox PIN are required: the bot's identity (user id and @handle) is resolved from `GET /2/users/me` at startup. - Encrypted send/receive in DMs and groups (webhook push + polling), signature verification on by default; undecryptable or unverified events are dropped - Webhook POSTs must carry a valid `x-twitter-webhooks-signature`, which X sends on every delivery. Set `consumerSecret` (or `X_CONSUMER_SECRET`) to receive webhooks, or `disableWebhookVerification` when an upstream layer already verifies them. Polling deployments are unaffected - Mention detection from structured mention entities, swipe-replies to the bot, and a plain-text `@handle` fallback; group replies sent as quoted replies - `openDM(userId)` starts (or reuses) an encrypted 1:1, running a full key exchange when needed so the bot can message first - Media both ways: inbound attachments with lazy download+decrypt, outbound encrypted uploads - Edit and delete of the bot's own messages; the first edit of a fresh message is age-gated by `editSafetyDelayMs` (default 5000ms) so receiving clients have stored the original - Reactions in and out, read receipts (`sendReadReceipts`, default on), typing keep-alive, configurable group welcome message - Cards degrade to text with tappable URL/mention entities plus a URL preview attachment - Requests carry a `chat-sdk-xchat/<version>` User-Agent product token so Chat SDK traffic is identifiable in X API request logs (a User-Agent set via `apiHeaders` takes precedence) - Registered in the `chat/adapters` catalog and the `create-chat-sdk` CLI scaffold, with a new optional `importPath` catalog field for adapters that ship on a subpath ## @chat-adapter/discord@4.36.0 ### Patch Changes - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 - @chat-adapter/shared@4.36.0 ## @chat-adapter/gchat@4.36.0 ### Patch Changes - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 - @chat-adapter/shared@4.36.0 ## @chat-adapter/github@4.36.0 ### Patch Changes - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 - @chat-adapter/shared@4.36.0 ## @chat-adapter/linear@4.36.0 ### Patch Changes - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 - @chat-adapter/shared@4.36.0 ## @chat-adapter/messenger@4.36.0 ### Patch Changes - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 - @chat-adapter/shared@4.36.0 ## @chat-adapter/shared@4.36.0 ### Patch Changes - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 ## @chat-adapter/telegram@4.36.0 ### Patch Changes -53bf73d: Preserve Telegram stable media identifiers in normalized attachment metadata and report photo attachments as JPEG. - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 - @chat-adapter/shared@4.36.0 ## @chat-adapter/twilio@4.36.0 ### Patch Changes - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 - @chat-adapter/shared@4.36.0 ## @chat-adapter/web@4.36.0 ### Patch Changes - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 - @chat-adapter/shared@4.36.0 ## @chat-adapter/whatsapp@4.36.0 ### Patch Changes - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 - @chat-adapter/shared@4.36.0 ## create-chat-sdk@0.2.1 ### Patch Changes -caa6325: Add XChat support to `@chat-adapter/x`, shipped from the new `@chat-adapter/x/chat` subpath so it sits alongside the existing X adapter. The XChat crypto stack (`@xdevplatform/chat-xdk`, `@xdevplatform/xdk`, `juicebox-sdk`) is an optional peer dependency, so existing `@chat-adapter/x` users are unaffected. All cryptography is handled inside the adapter via `@xdevplatform/chat-xdk` (wasm) and all REST goes through the typed `@xdevplatform/xdk` client. Only a bot token and a Juicebox PIN are required: the bot's identity (user id and @handle) is resolved from `GET /2/users/me` at startup. - Encrypted send/receive in DMs and groups (webhook push + polling), signature verification on by default; undecryptable or unverified events are dropped - Webhook POSTs must carry a valid `x-twitter-webhooks-signature`, which X sends on every delivery. Set `consumerSecret` (or `X_CONSUMER_SECRET`) to receive webhooks, or `disableWebhookVerification` when an upstream layer already verifies them. Polling deployments are unaffected - Mention detection from structured mention entities, swipe-replies to the bot, and a plain-text `@handle` fallback; group replies sent as quoted replies - `openDM(userId)` starts (or reuses) an encrypted 1:1, running a full key exchange when needed so the bot can message first - Media both ways: inbound attachments with lazy download+decrypt, outbound encrypted uploads - Edit and delete of the bot's own messages; the first edit of a fresh message is age-gated by `editSafetyDelayMs` (default 5000ms) so receiving clients have stored the original - Reactions in and out, read receipts (`sendReadReceipts`, default on), typing keep-alive, configurable group welcome message - Cards degrade to text with tappable URL/mention entities plus a URL preview attachment - Requests carry a `chat-sdk-xchat/<version>` User-Agent product token so Chat SDK traffic is identifiable in X API request logs (a User-Agent set via `apiHeaders` takes precedence) - Registered in the `chat/adapters` catalog and the `create-chat-sdk` CLI scaffold, with a new optional `importPath` catalog field for adapters that ship on a subpath ## @chat-adapter/state-ioredis@4.36.0 ### Patch Changes - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 ## @chat-adapter/state-memory@4.36.0 ### Patch Changes - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 ## @chat-adapter/state-pg@4.36.0 ### Patch Changes - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 ## @chat-adapter/state-redis@4.36.0 ### Patch Changes - Updated dependencies [257a32d] - Updated dependencies [c5d86b1] - Updated dependencies [0153a39] - Updated dependencies [b547f45] - Updated dependencies [caa6325] - chat@4.36.0 ## @chat-adapter/tests@4.36.0 Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
create-chat-sdk
npm package:
create-chat-sdk
Scaffold a webhook-only Chat SDK bot project from the command line.
Documentation: chat-sdk.dev/docs/create-chat-sdk · Guides: vercel.com/kb/chat-sdk
Usage
npm create chat-sdk@latest my-bot
With another package manager:
pnpm create chat-sdk@latest my-bot
yarn create chat-sdk my-bot
bunx create-chat-sdk@latest my-bot
Non-interactive mode
Pass platform and state adapters with --adapter:
npm create chat-sdk@latest -- my-bot --adapter slack redis -y
With npm, the -- separator is required — npm consumes flags before it instead of forwarding them to the CLI. pnpm create and yarn create forward flags without it.
Adapter values come from the chat/adapters catalog. The default interactive prompt lists official adapters. Pass --vendor to list vendor-official adapters instead. For automation and coding agents, pass official or vendor adapter slugs directly with --adapter. Community adapters are not scaffolded.
When the CLI detects a coding agent environment, it announces the detection and automatically runs in non-interactive mode. Pass at least one platform adapter with --adapter; the state adapter defaults to memory. If no project name is provided, the default name is my-bot. Pass --interactive to force prompts.
Vercel Connect
The Slack, GitHub, and Linear adapters can authenticate with Vercel Connect instead of stored provider secrets. Pass --connect, or choose Vercel Connect at the interactive auth-mode prompt:
npm create chat-sdk@latest -- my-bot --adapter slack --connect -y
The generated bot spreads the matching helper from @vercel/connect/chat into the adapter factory, adds @vercel/connect to dependencies, and lists each connector UID (such as SLACK_CONNECTOR) in .env.example instead of native secrets.
Options
Usage: create-chat-sdk [options] [name]
Arguments:
name name of the project
Options:
-d, --description <text> project description
--adapter <values...> platform or state adapters to include
--vendor list vendor-official adapters in the interactive
prompt
--connect authenticate Slack, GitHub, and Linear adapters
with Vercel Connect
--pm <manager> package manager to use (npm, yarn, pnpm, bun)
-y, --yes skip prompts and accept defaults
--interactive always prompt, even when a coding agent
environment is detected
-f, --force overwrite generated files in an existing directory
-s, --skip-install skip dependency installation
--no-git skip git repository initialization
-q, --quiet suppress non-essential output
-h, --help display help for command
Color output follows the NO_COLOR standard — set NO_COLOR=1 to disable colors.
Generated project
The generated project is a minimal Next.js API app:
src/lib/bot.ts— generated Chat SDK bot configurationsrc/app/api/webhooks/[platform]/route.ts— dynamic webhook routesrc/app/api/chat/route.ts— generated only when the Web adapter is selected.env.example— generated from selected adapter env specsnext.config.ts— generated server config and externalspackage.json— generated adapter, peer, and extra dependencies.chat-sdk.json— generated file ownership used by safe--forcereruns
The template does not include pages, layouts, or a client UI.
Development
pnpm --filter create-chat-sdk build
pnpm --filter create-chat-sdk typecheck
pnpm --filter create-chat-sdk test
AI Coding Agents
If you use an AI coding agent such as OpenAI Codex, Claude Code, or Cursor, install the Chat SDK skill so it knows the SDK APIs, adapter patterns, and project conventions before writing code.
npx skills add vercel/chat
The skill references bundled documentation in node_modules/chat/docs, plus adapter guides and starter templates in the published package.
You can also install the Vercel Plugin for a broader agent toolkit — it includes the Chat SDK skill alongside specialist agents, agent slash commands, and more:
npx plugins add vercel/vercel-plugin
The plugin is optional; the skill alone is enough to build with Chat SDK.
For agent-readable documentation, see chat-sdk.dev/llms.txt (page index) or chat-sdk.dev/llms-full.txt (full text).
Documentation
Full documentation is available at chat-sdk.dev/docs/create-chat-sdk.
- Getting Started — first steps with Chat SDK
- Platform Adapters — supported platform adapters
- State Adapters — persistence, locking, and dedupe options
- Adapters — full adapter catalog
License
MIT