Chat SDK

Slack、Teams、Google Chat、Discord、Telegram、GitHub、Linear、WhatsApp 全体でチャットボットを構築するための統合 TypeScript SDK。ボットロジックを一度書いて、すべてのプラットフォームにデプロイしてください。

公開ソースから始める

Chat SDK がユーザープロジェクトにインストールされると、node_modules に含まれる公開ファイルを確認します:

node_modules/chat/docs/                    # バンドルドキュメント
node_modules/chat/dist/index.d.ts          # コア API タイプ
node_modules/chat/dist/jsx-runtime.d.ts    # JSX ランタイムタイプ
node_modules/chat/docs/contributing/       # アダプタオーサリングドキュメント
node_modules/chat/docs/guides/             # フレームワーク/プラットフォームガイド

以下のパスの1つが存在しない場合、そのパッケージはまだプロジェクトにインストールされていません。

コードを書く前に以下をお読みください:

• node_modules/chat/docs/getting-started.mdx — インストールとセットアップ
• node_modules/chat/docs/usage.mdx — Chat 設定とライフサイクル
• node_modules/chat/docs/handling-events.mdx — イベントルーティングとハンドラ
• node_modules/chat/docs/threads-messages-channels.mdx — スレッド/チャネル/メッセージモデル
• node_modules/chat/docs/posting-messages.mdx — 投稿、編集、削除、スケジュール
• node_modules/chat/docs/streaming.mdx — AI SDK 統合とストリーミングセマンティクス
• node_modules/chat/docs/cards.mdx — JSX カード
• node_modules/chat/docs/actions.mdx — ボタン/選択インタラクション
• node_modules/chat/docs/modals.mdx — モーダル送信/閉じるフロー
• node_modules/chat/docs/slash-commands.mdx — スラッシュコマンドルーティング
• node_modules/chat/docs/direct-messages.mdx — DM 動作と openDM()
• node_modules/chat/docs/files.mdx — 添付ファイル/アップロード
• node_modules/chat/docs/state.mdx — 永続化、ロック、重複排除
• node_modules/chat/docs/adapters.mdx — クロスプラットフォーム機能マトリックス
• node_modules/chat/docs/api/chat.mdx — 正確な Chat API
• node_modules/chat/docs/api/thread.mdx — 正確な Thread API
• node_modules/chat/docs/api/message.mdx — 正確な Message API
• node_modules/chat/docs/api/modals.mdx — モーダル要素とイベント詳細

使用している特定のアダプタまたはステートパッケージについては、node_modules にインストールされたそのパッケージの dist/index.d.ts エクスポート サーフェスを確認してください。

クイックスタート

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(),
  },
  state: createRedisState(),
  dedupeTtlMs: 600_000,
});

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}`);
});

コアコンセプト

• Chat — メインエントリポイント。アダプタ、ルーティング、ロック、ステートを調整
• Adapters — Slack、Teams、Google Chat、Discord、Telegram、GitHub、Linear、WhatsApp 用のプラットフォーム固有統合
• ステートアダプタ — 購読、ロック、重複排除、スレッドステートの永続化
• Thread — post()、stream()、subscribe()、setState()、startTyping() 付きの会話コンテキスト
• Message — text、formatted、添付ファイル、作者情報、プラットフォーム raw を備えた正規化されたコンテンツ
• Channel — スレッドとトップレベルの投稿用コンテナ

イベントハンドラ

ハンドラ	トリガー
onNewMention	未購読スレッドでボットが @メンション
onDirectMessage	未購読 DM スレッドで新規 DM
onSubscribedMessage	購読スレッド内のメッセージ
onNewMessage(regex)	未購読スレッド内の正規表現マッチ
onReaction(emojis?)	絵文字追加または削除
onAction(actionIds?)	ボタンクリックと選択/ラジオインタラクション
onModalSubmit(callbackId?)	モーダルフォーム送信
onModalClose(callbackId?)	モーダル閉じる/キャンセル
onSlashCommand(commands?)	スラッシュコマンド呼び出し
onAssistantThreadStarted	Slack アシスタントスレッド開始
onAssistantContextChanged	Slack アシスタントコンテキスト変更
onAppHomeOpened	Slack App Home 開始
onMemberJoinedChannel	Slack メンバーチャネル参加イベント

ハンドラを接続する前に node_modules/chat/docs/handling-events.mdx、node_modules/chat/docs/actions.mdx、node_modules/chat/docs/modals.mdx、node_modules/chat/docs/slash-commands.mdx をお読みください。onDirectMessage の動作は node_modules/chat/docs/direct-messages.mdx に記載されています。

ストリーミング

任意の AsyncIterable<string> を thread.post() に渡します。AI SDK の場合、ステップ境界を保持するために、利用可能な場合は result.textStream より result.fullStream を優先してください。

import { ToolLoopAgent } from "ai";

const agent = new ToolLoopAgent({ model: "anthropic/claude-4.5-sonnet" });

bot.onNewMention(async (thread, message) => {
  const result = await agent.stream({ prompt: message.text });
  await thread.post(result.fullStream);
});

主要な詳細:

• streamingUpdateIntervalMs は投稿+編集フォールバックのキャデンスを制御
• fallbackStreamingPlaceholderText はデフォルト "..."。無効にするには null を設定
• 構造化 StreamChunk サポートは Slack のみ。他のアダプタはテキスト以外のチャンクを無視

カードとモーダル (JSX)

tsconfig.json で jsxImportSource: "chat" を設定します。

カードコンポーネント:

• Card、CardText、Section、Fields、Field、Button、CardLink、LinkButton、Actions、Select、SelectOption、RadioSelect、Table、Image、Divider

モーダルコンポーネント:

• Modal、TextInput、Select、SelectOption、RadioSelect

Button と Modal は callbackUrl プロップを受け入れます。トリガーされると、SDK は onAction / onModalSubmit ハンドラを発火することに加えて、そのアクションペイロードをそのURLに POST します。これを webhook ベースのワークフローフロー用に使用してください。node_modules/chat/docs/actions.mdx と node_modules/chat/docs/modals.mdx を参照してください。

await thread.post(
  <Card title="Order #1234">
    <CardText>Your order has been received.</CardText>
    <Actions>
      <Button id="approve" style="primary">Approve</Button>
      <Button id="reject" style="danger">Reject</Button>
    </Actions>
  </Card>
);

アダプタインベントリ

公式プラットフォームアダプタ

プラットフォーム	パッケージ	ファクトリ
Slack	@chat-adapter/slack	createSlackAdapter
Microsoft Teams	@chat-adapter/teams	createTeamsAdapter
Google Chat	@chat-adapter/gchat	createGoogleChatAdapter
Discord	@chat-adapter/discord	createDiscordAdapter
GitHub	@chat-adapter/github	createGitHubAdapter
Linear	@chat-adapter/linear	createLinearAdapter
Telegram	@chat-adapter/telegram	createTelegramAdapter
WhatsApp Business Cloud	@chat-adapter/whatsapp	createWhatsAppAdapter

公式ステートアダプタ

ステートバックエンド	パッケージ	ファクトリ
Redis	@chat-adapter/state-redis	createRedisState
ioredis	@chat-adapter/state-ioredis	createIoRedisState
PostgreSQL	@chat-adapter/state-pg	createPostgresState
Memory	@chat-adapter/state-memory	createMemoryState

コミュニティアダプタ

• chat-state-cloudflare-do
• @beeper/chat-adapter-matrix
• chat-adapter-imessage
• @bitbasti/chat-adapter-webex
• @resend/chat-sdk-adapter
• @zernio/chat-sdk-adapter
• chat-adapter-baileys
• @liveblocks/chat-sdk-adapter
• chat-adapter-sendblue
• chat-adapter-zalo
• chat-adapter-mattermost

近日公開予定のプラットフォーム

• Instagram
• Signal
• X
• Messenger

カスタムアダプタの構築

最初に以下の公開ドキュメントをお読みください:

• node_modules/chat/docs/contributing/building.mdx
• node_modules/chat/docs/contributing/testing.mdx
• node_modules/chat/docs/contributing/publishing.mdx

また確認してください:

• node_modules/chat/dist/index.d.ts — Adapter および関連インターフェース
• node_modules/@chat-adapter/shared/dist/index.d.ts — 共有エラーとユーティリティ
• インストール済み公式アダプタ dist/index.d.ts ファイル — 設定と API の参考実装

カスタムアダプタはリクエスト検証、webhook 解析、メッセージ/スレッド/チャネル操作、ID エンコーディング/デコーディング、フォーマットコンバータが必要です。chat から BaseFormatConverter を使用し、@chat-adapter/shared から共有ユーティリティを使用してください。

Webhook セットアップ

登録された各アダプタは bot.webhooks.<name> を公開します。それらを HTTP フレームワークルートに直接接続してください。フレームワーク固有のルートパターンについては node_modules/chat/docs/guides/slack-nextjs.mdx と node_modules/chat/docs/guides/discord-nuxt.mdx を参照してください。