Files
vercel__chat/packages/adapter-shared
github-actions[bot] caab5c3843 chore(release): version packages (#805)
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/discord@4.38.0

### Minor Changes

- a0cba02: Add Vercel Connect credential resolvers and custom webhook
verification to the Discord adapter, with `create-chat-sdk --connect`
scaffolding for Discord bots.

### Patch Changes

- a94995e: Restore attachment downloads across Discord inbound message
paths.
- 4bdf721: Preserve content and attachments from forwarded Discord
message snapshots.
- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
  - @chat-adapter/shared@4.38.0
## @chat-adapter/messenger@4.38.0

### Minor Changes

- 18d4a23: Add a shared thread API for marking messages as read across
WhatsApp, Messenger, and XChat.

Note for anyone calling `XchatAdapter.markAsRead()` directly: it now
rejects when a receipt fails instead of logging a warning and resolving.
Automatic read receipts are unaffected, since the adapter still catches
and logs those internally. If you call the method yourself without
awaiting it, add a `.catch()` so a failed receipt does not surface as an
unhandled rejection.

### Patch Changes

- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
  - @chat-adapter/shared@4.38.0
## @chat-adapter/notion@4.38.0

### Minor Changes

- 06b04ac: Add outbound-only Vercel Connect authentication for Notion
while retaining native webhook verification and scaffolding.

### Patch Changes

- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
  - @chat-adapter/shared@4.38.0
## @chat-adapter/telegram@4.38.0

### Minor Changes

- 0f24cc3: Preserve normalized replied-to message context and populate
it from Telegram replies.
- 7a1150c: Add outbound-only Vercel Connect authentication for Telegram
while retaining native webhook verification or polling.
- 3bbf3ff: Use post-and-edit streaming by default and make native
Telegram drafts opt-in. Streams now render the same way in every chat
type; set the new `nativeStreaming: true` config option to restore draft
previews in private chats.

The adapter now owns the post-and-edit loop so edits stay under
Telegram's per-chat rate limit. Edits are throttled to a 1100ms floor,
configurable with the new `streamingEditIntervalMs` option, and a
rate-limited final edit is retried once instead of failing the post.

### Patch Changes

- 1d2b78d: Deduplicate repeated Telegram webhook updates by their update
ID using the configured state adapter.
- 745fdf5: respect Telegram streaming rate limits and target XChat read
receipts exactly
- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
  - @chat-adapter/shared@4.38.0
## @chat-adapter/whatsapp@4.38.0

### Minor Changes

- 83ede7e: add native message replies with WhatsApp contextual reply
support
- 18d4a23: Add a shared thread API for marking messages as read across
WhatsApp, Messenger, and XChat.

Note for anyone calling `XchatAdapter.markAsRead()` directly: it now
rejects when a receipt fails instead of logging a warning and resolving.
Automatic read receipts are unaffected, since the adapter still catches
and logs those internally. If you call the method yourself without
awaiting it, add a `.catch()` so a failed receipt does not surface as an
unhandled rejection.

### Patch Changes

- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
  - @chat-adapter/shared@4.38.0
## @chat-adapter/x@4.38.0

### Minor Changes

- 18d4a23: Add a shared thread API for marking messages as read across
WhatsApp, Messenger, and XChat.

Note for anyone calling `XchatAdapter.markAsRead()` directly: it now
rejects when a receipt fails instead of logging a warning and resolving.
Automatic read receipts are unaffected, since the adapter still catches
and logs those internally. If you call the method yourself without
awaiting it, add a `.catch()` so a failed receipt does not surface as an
unhandled rejection.

### Patch Changes

- 745fdf5: respect Telegram streaming rate limits and target XChat read
receipts exactly
- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
  - @chat-adapter/shared@4.38.0
## chat@4.38.0

### Minor Changes

- 0f24cc3: Preserve normalized replied-to message context and populate
it from Telegram replies.
- bdeb2bf: Add a workflow-safe `chat/serialization` entrypoint and
isolate automatic Chat class serializers from Node-only runtime
dependencies.
- a0cba02: Add Vercel Connect credential resolvers and custom webhook
verification to the Discord adapter, with `create-chat-sdk --connect`
scaffolding for Discord bots.
- 83ede7e: add native message replies with WhatsApp contextual reply
support
- 18d4a23: Add a shared thread API for marking messages as read across
WhatsApp, Messenger, and XChat.

Note for anyone calling `XchatAdapter.markAsRead()` directly: it now
rejects when a receipt fails instead of logging a warning and resolving.
Automatic read receipts are unaffected, since the adapter still catches
and logs those internally. If you call the method yourself without
awaiting it, add a `.catch()` so a failed receipt does not surface as an
unhandled rejection.
## create-chat-sdk@0.4.0

### Minor Changes

- a0cba02: Add Vercel Connect credential resolvers and custom webhook
verification to the Discord adapter, with `create-chat-sdk --connect`
scaffolding for Discord bots.
- 06b04ac: Add outbound-only Vercel Connect authentication for Notion
while retaining native webhook verification and scaffolding.
- 7a1150c: Add outbound-only Vercel Connect authentication for Telegram
while retaining native webhook verification or polling.
## @chat-adapter/gchat@4.38.0

### Patch Changes

- 2f40a32: Fix attachment downloads failing with a 400 when
`attachmentDataRef` is present

`fetchAttachmentData` called the Chat media endpoint without
`alt=media`, so it
returned resource metadata rather than file bytes and rejected the
arraybuffer
request with a bare 400. Every download by `resourceName` failed, which
is the
  path taken for any file uploaded directly to Chat.

The download path is also hardened: when `media.download` fails and the
attachment carries a `downloadUri`, the adapter now falls back to
fetching that
URL instead of rejecting, and failures with no fallback are routed
through the
shared error handling so a 429 surfaces as `AdapterRateLimitError` like
every
  other Chat API call.

- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
  - @chat-adapter/shared@4.38.0
## @chat-adapter/github@4.38.0

### Patch Changes

- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
  - @chat-adapter/shared@4.38.0
## @chat-adapter/instagram@4.38.0

### Patch Changes

- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
  - @chat-adapter/shared@4.38.0
## @chat-adapter/linear@4.38.0

### Patch Changes

- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
  - @chat-adapter/shared@4.38.0
## @chat-adapter/shared@4.38.0

### Patch Changes

- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
## @chat-adapter/slack@4.38.0

### Patch Changes

- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
  - @chat-adapter/shared@4.38.0
## @chat-adapter/teams@4.38.0

### Patch Changes

- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
  - @chat-adapter/shared@4.38.0
## @chat-adapter/twilio@4.38.0

### Patch Changes

- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
  - @chat-adapter/shared@4.38.0
## @chat-adapter/web@4.38.0

### Patch Changes

- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
  - @chat-adapter/shared@4.38.0
## @chat-adapter/state-ioredis@4.38.0

### Patch Changes

- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
## @chat-adapter/state-memory@4.38.0

### Patch Changes

- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
## @chat-adapter/state-pg@4.38.0

### Patch Changes

- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
## @chat-adapter/state-redis@4.38.0

### Patch Changes

- Updated dependencies [0f24cc3]
- Updated dependencies [bdeb2bf]
- Updated dependencies [a0cba02]
- Updated dependencies [83ede7e]
- Updated dependencies [18d4a23]
  - chat@4.38.0
## @chat-adapter/tests@4.38.0

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-08-14 20:28:19 +01:00
..
2026-02-27 09:58:28 -08:00

@chat-adapter/shared

npm package: @chat-adapter/shared

Agent Stack MIT License

Shared utilities for Chat SDK adapters. Provides common helpers used across adapter implementations.

Documentation: chat-sdk.dev/docs/contributing/building · Guides: vercel.com/kb/chat-sdk

Installation

pnpm add @chat-adapter/shared

Utilities

Adapter helpers

  • extractCard(message) - extract a CardElement from an AdapterPostableMessage
  • extractFiles(message) - extract FileUpload[] from an AdapterPostableMessage
  • extractPostableAttachments(message) - extract Attachment[] from an AdapterPostableMessage

Buffer conversion

  • toBuffer(input) - convert various inputs (Buffer, Blob, string, URL) to Buffer
  • toBufferSync(input) - synchronous version of toBuffer
  • bufferToDataUri(buffer, mimeType) - convert a Buffer to a data URI string

Card conversion

  • cardToFallbackText(card) - render a CardElement as plain text for platforms that don't support cards
  • createEmojiConverter(platform) - create a function that converts emoji placeholders to platform format
  • mapButtonStyle(style) - map generic button styles to platform-specific variants
  • renderGfmTable(headers, rows) - render a GitHub Flavored Markdown table
  • escapeTableCell(text) - escape pipe characters in table cells

Token encryption

AES-256-GCM helpers for encrypting OAuth tokens at rest before writing them to a state adapter. Used by @chat-adapter/slack and @chat-adapter/linear; available to any adapter that persists credentials.

  • encryptToken(plaintext, key) - encrypt a string and return an EncryptedTokenData envelope (random 12-byte IV per call)
  • decryptToken(data, key) - decrypt an envelope back to the original string
  • decodeKey(encoded) - decode a hex-64 or base64-44 encoded 32-byte key; throws on wrong length
  • isEncryptedTokenData(value) - type guard for distinguishing envelopes from legacy plaintext records
  • EncryptedTokenData - the envelope type ({ data, iv, tag }, all base64)

Error classes

Standardized errors for adapter implementations:

  • AdapterError - base error class
  • AdapterRateLimitError - platform rate limit (includes retryAfter)
  • AuthenticationError - expired or invalid tokens
  • NetworkError - connection failures
  • PermissionError - missing scopes or permissions
  • ResourceNotFoundError - missing channel/thread/message
  • ValidationError - invalid config or input

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).

License

MIT