mirror of https://github.com/vercel/chat.git synced 2026-09-14 18:32:29 +08:00

Files

T

History

Ben Sabic bce1c32158 merge main and resolve conflicts

Keep both callbackUrl (PR) and actionType (main) features on buttons.
Fix chat.ts handleActionEvent to use PR's rawEvent param name with
main's added options parameter. Regenerate lockfile.

2026-04-14 13:58:12 +10:00

src

merge main and resolve conflicts

2026-04-14 13:58:12 +10:00

CHANGELOG.md

Version Packages (#368 )

2026-04-13 22:08:02 -04:00

package.json

merge main and resolve conflicts

2026-04-14 13:58:12 +10:00

README.md

docs: mention PostgreSQL state adapter across remaining docs (#201 )

2026-03-08 12:43:33 -07:00

tsconfig.json

Fix JSX issues (#161 )

2026-03-05 16:13:33 -08:00

tsup.config.ts

fix: disable source maps in published packages (#337 )

2026-04-07 09:02:36 +10:00

vitest.config.ts

Upgrade Biome configuration to use Ultracite preset (#81 )

2026-02-20 22:01:10 -08:00

README.md

chat

Core SDK for building multi-platform chat bots. Provides the Chat class, event handlers, JSX card runtime, emoji helpers, and type-safe message formatting.

Installation

npm install chat

Usage

import { Chat } from "chat";
import { createSlackAdapter } from "@chat-adapter/slack";
import { createRedisState } from "@chat-adapter/state-redis";

const bot = new Chat({
  userName: "mybot",
  adapters: {
    slack: createSlackAdapter({
      botToken: process.env.SLACK_BOT_TOKEN!,
      signingSecret: process.env.SLACK_SIGNING_SECRET!,
    }),
  },
  state: createRedisState({ url: process.env.REDIS_URL! }),
  dedupeTtlMs: 600_000, // 10 minutes (default: 5 min)
});

bot.onNewMention(async (thread) => {
  await thread.subscribe();
  await thread.post("Hello! I'm listening to this thread.");
});

bot.onSubscribedMessage(async (thread, message) => {
  await thread.post(`You said: ${message.text}`);
});

Tip: PostgreSQL and ioredis adapters are also available for production. See State Adapters for all options.

Configuration

Option	Type	Default	Description
`userName`	`string`	required	Default bot username across all adapters
`adapters`	`Record<string, Adapter>`	required	Map of adapter name to adapter instance
`state`	`StateAdapter`	required	State adapter for subscriptions, locking, and dedup
`logger`	`Logger \| LogLevel`	`"info"`	Logger instance or log level (`"silent"` to disable)
`streamingUpdateIntervalMs`	`number`	`500`	Update interval for fallback streaming (post + edit) in ms
`dedupeTtlMs`	`number`	`300000`	TTL for message deduplication entries in ms. Increase if webhook cold starts cause platform retries (e.g., Slack's `http_timeout` retry) that arrive after the default window

AI coding agent support

If you use an AI coding agent like Claude Code, you can teach it about Chat SDK:

npx skills add vercel/chat

Documentation

Full documentation is available at chat-sdk.dev/docs.

Usage — event handlers, threads, messages, channels
Chat API — full Chat class reference
Cards — JSX-based interactive cards
Streaming — AI SDK integration
Emoji — cross-platform emoji helpers

License

MIT