chat 4.13.0 → 4.13.2

package/dist/{jsx-runtime-COVsDskT.d.ts → jsx-runtime-Bdt1Dwzf.d.ts}

@@ -4,77 +4,77 @@
 
 type ModalChild = TextInputElement | SelectElement | RadioSelectElement | TextElement | FieldsElement;
 interface ModalElement {
-    type: "modal";
     callbackId: string;
-    title: string;
-    submitLabel?: string;
+    children: ModalChild[];
     closeLabel?: string;
     notifyOnClose?: boolean;
     /** Arbitrary string passed through the modal lifecycle (e.g., JSON context). */
     privateMetadata?: string;
-    children: ModalChild[];
+    submitLabel?: string;
+    title: string;
+    type: "modal";
 }
 interface TextInputElement {
-    type: "text_input";
     id: string;
-    label: string;
-    placeholder?: string;
     initialValue?: string;
+    label: string;
+    maxLength?: number;
     multiline?: boolean;
     optional?: boolean;
-    maxLength?: number;
+    placeholder?: string;
+    type: "text_input";
 }
 interface SelectElement {
-    type: "select";
     id: string;
-    label: string;
-    placeholder?: string;
-    options: SelectOptionElement[];
     initialOption?: string;
+    label: string;
     optional?: boolean;
+    options: SelectOptionElement[];
+    placeholder?: string;
+    type: "select";
 }
 interface SelectOptionElement {
+    description?: string;
     label: string;
     value: string;
-    description?: string;
 }
 interface RadioSelectElement {
-    type: "radio_select";
     id: string;
-    label: string;
-    options: SelectOptionElement[];
     initialOption?: string;
+    label: string;
     optional?: boolean;
+    options: SelectOptionElement[];
+    type: "radio_select";
 }
 declare function isModalElement(value: unknown): value is ModalElement;
 interface ModalOptions {
     callbackId: string;
-    title: string;
-    submitLabel?: string;
+    children?: ModalChild[];
     closeLabel?: string;
     notifyOnClose?: boolean;
     /** Arbitrary string passed through the modal lifecycle (e.g., JSON context). */
     privateMetadata?: string;
-    children?: ModalChild[];
+    submitLabel?: string;
+    title: string;
 }
 declare function Modal(options: ModalOptions): ModalElement;
 interface TextInputOptions {
     id: string;
-    label: string;
-    placeholder?: string;
     initialValue?: string;
+    label: string;
+    maxLength?: number;
     multiline?: boolean;
     optional?: boolean;
-    maxLength?: number;
+    placeholder?: string;
 }
 declare function TextInput(options: TextInputOptions): TextInputElement;
 interface SelectOptions {
     id: string;
-    label: string;
-    placeholder?: string;
-    options: SelectOptionElement[];
     initialOption?: string;
+    label: string;
     optional?: boolean;
+    options: SelectOptionElement[];
+    placeholder?: string;
 }
 declare function Select(options: SelectOptions): SelectElement;
 declare function SelectOption(options: {
@@ -84,10 +84,10 @@ declare function SelectOption(options: {
 }): SelectOptionElement;
 interface RadioSelectOptions {
     id: string;
-    label: string;
-    options: SelectOptionElement[];
     initialOption?: string;
+    label: string;
     optional?: boolean;
+    options: SelectOptionElement[];
 }
 declare function RadioSelect(options: RadioSelectOptions): RadioSelectElement;
 type AnyModalElement = ModalElement | ModalChild | SelectOptionElement;
@@ -145,41 +145,41 @@ type ButtonStyle = "primary" | "danger" | "default";
 type TextStyle = "plain" | "bold" | "muted";
 /** Button element for interactive actions */
 interface ButtonElement {
-    type: "button";
     /** Unique action ID for callback routing */
     id: string;
     /** Button label text */
     label: string;
     /** Visual style */
     style?: ButtonStyle;
+    type: "button";
     /** Optional payload value sent with action callback */
     value?: string;
 }
 /** Link button element that opens a URL */
 interface LinkButtonElement {
-    type: "link-button";
-    /** URL to open when clicked */
-    url: string;
     /** Button label text */
     label: string;
     /** Visual style */
     style?: ButtonStyle;
+    type: "link-button";
+    /** URL to open when clicked */
+    url: string;
 }
 /** Text content element */
 interface TextElement {
-    type: "text";
     /** Text content (supports markdown in some platforms) */
     content: string;
     /** Text style */
     style?: TextStyle;
+    type: "text";
 }
 /** Image element */
 interface ImageElement {
+    /** Alt text for accessibility */
+    alt?: string;
     type: "image";
     /** Image URL */
     url: string;
-    /** Alt text for accessibility */
-    alt?: string;
 }
 /** Visual divider/separator */
 interface DividerElement {
@@ -187,29 +187,29 @@ interface DividerElement {
 }
 /** Container for action buttons and selects */
 interface ActionsElement {
-    type: "actions";
     /** Button, link button, select, and radio select elements */
     children: (ButtonElement | LinkButtonElement | SelectElement | RadioSelectElement)[];
+    type: "actions";
 }
 /** Section container for grouping elements */
 interface SectionElement {
-    type: "section";
     /** Section children */
     children: CardChild[];
+    type: "section";
 }
 /** Field for key-value display */
 interface FieldElement {
-    type: "field";
     /** Field label */
     label: string;
+    type: "field";
     /** Field value */
     value: string;
 }
 /** Fields container for multi-column layout */
 interface FieldsElement {
-    type: "fields";
     /** Field elements */
     children: FieldElement[];
+    type: "fields";
 }
 /** Union of all card child element types */
 type CardChild = TextElement | ImageElement | DividerElement | ActionsElement | SectionElement | FieldsElement;
@@ -217,24 +217,24 @@ type CardChild = TextElement | ImageElement | DividerElement | ActionsElement |
 type AnyCardElement = CardChild | CardElement | ButtonElement | LinkButtonElement | FieldElement | SelectElement | RadioSelectElement;
 /** Root card element */
 interface CardElement {
-    type: "card";
-    /** Card title */
-    title?: string;
-    /** Card subtitle */
-    subtitle?: string;
-    /** Header image URL */
-    imageUrl?: string;
     /** Card content */
     children: CardChild[];
+    /** Header image URL */
+    imageUrl?: string;
+    /** Card subtitle */
+    subtitle?: string;
+    /** Card title */
+    title?: string;
+    type: "card";
 }
 /** Type guard for CardElement */
 declare function isCardElement(value: unknown): value is CardElement;
 /** Options for Card */
 interface CardOptions {
-    title?: string;
-    subtitle?: string;
-    imageUrl?: string;
     children?: CardChild[];
+    imageUrl?: string;
+    subtitle?: string;
+    title?: string;
 }
 /**
  * Create a Card element.
@@ -331,12 +331,12 @@ interface ButtonOptions {
 declare function Button(options: ButtonOptions): ButtonElement;
 /** Options for LinkButton */
 interface LinkButtonOptions {
-    /** URL to open when clicked */
-    url: string;
     /** Button label text */
     label: string;
     /** Visual style */
     style?: ButtonStyle;
+    /** URL to open when clicked */
+    url: string;
 }
 /**
  * Create a LinkButton element that opens a URL when clicked.
@@ -427,35 +427,35 @@ declare function fromReactElement(element: unknown): AnyCardElement | null;
 declare const JSX_ELEMENT: unique symbol;
 /** Props for Card component in JSX */
 interface CardProps {
-    title?: string;
-    subtitle?: string;
-    imageUrl?: string;
     children?: unknown;
+    imageUrl?: string;
+    subtitle?: string;
+    title?: string;
 }
 /** Props for Text component in JSX */
 interface TextProps {
-    style?: TextStyle;
     children?: string | number;
+    style?: TextStyle;
 }
 /** Props for Button component in JSX */
 interface ButtonProps {
+    children?: string | number;
     id: string;
     label?: string;
     style?: ButtonStyle;
     value?: string;
-    children?: string | number;
 }
 /** Props for LinkButton component in JSX */
 interface LinkButtonProps {
-    url: string;
+    children?: string | number;
     label?: string;
     style?: ButtonStyle;
-    children?: string | number;
+    url: string;
 }
 /** Props for Image component in JSX */
 interface ImageProps {
-    url: string;
     alt?: string;
+    url: string;
 }
 /** Props for Field component in JSX */
 interface FieldProps {
@@ -471,37 +471,37 @@ type DividerProps = Record<string, never>;
 /** Props for Modal component in JSX */
 interface ModalProps {
     callbackId: string;
-    title: string;
-    submitLabel?: string;
+    children?: unknown;
     closeLabel?: string;
     notifyOnClose?: boolean;
     privateMetadata?: string;
-    children?: unknown;
+    submitLabel?: string;
+    title: string;
 }
 /** Props for TextInput component in JSX */
 interface TextInputProps {
     id: string;
-    label: string;
-    placeholder?: string;
     initialValue?: string;
+    label: string;
+    maxLength?: number;
     multiline?: boolean;
     optional?: boolean;
-    maxLength?: number;
+    placeholder?: string;
 }
 /** Props for Select component in JSX */
 interface SelectProps {
+    children?: unknown;
     id: string;
-    label: string;
-    placeholder?: string;
     initialOption?: string;
+    label: string;
     optional?: boolean;
-    children?: unknown;
+    placeholder?: string;
 }
 /** Props for SelectOption component in JSX */
 interface SelectOptionProps {
+    description?: string;
     label: string;
     value: string;
-    description?: string;
 }
 /** Union of all valid JSX props */
 type CardJSXProps = CardProps | TextProps | ButtonProps | LinkButtonProps | ImageProps | FieldProps | ContainerProps | DividerProps | ModalProps | TextInputProps | SelectProps | SelectOptionProps;
@@ -513,9 +513,9 @@ type CardComponentFunction = typeof Card | typeof Text | typeof Button | typeof
  */
 interface CardJSXElement<P extends CardJSXProps = CardJSXProps> {
     $$typeof: typeof JSX_ELEMENT;
-    type: CardComponentFunction;
-    props: P;
     children: unknown[];
+    props: P;
+    type: CardComponentFunction;
 }
 type JSXElement = CardJSXElement;
 /**
@@ -560,4 +560,4 @@ declare namespace JSX {
     }
 }
 
-export { type SelectElement as $, Actions as A, Button as B, type CardElement as C, Divider as D, type ButtonOptions as E, Field as F, type ButtonStyle as G, type CardOptions as H, Image as I, type DividerElement as J, type FieldElement as K, LinkButton as L, type ModalElement as M, type FieldsElement as N, type ImageElement as O, type LinkButtonElement as P, type LinkButtonOptions as Q, RadioSelect as R, Section as S, Text as T, type SectionElement as U, type TextElement as V, type TextStyle as W, type ModalChild as X, type ModalOptions as Y, type RadioSelectElement as Z, type RadioSelectOptions as _, type CardJSXElement as a, type SelectOptionElement as a0, type SelectOptions as a1, type TextInputElement as a2, type TextInputOptions as a3, type ModalProps as a4, type TextInputProps as a5, type SelectProps as a6, type SelectOptionProps as a7, jsx as a8, jsxs as a9, jsxDEV as aa, Fragment as ab, JSX as ac, type CardChild as b, Card as c, Fields as d, isJSX as e, fromReactElement as f, toModalElement as g, fromReactModalElement as h, isCardElement as i, isModalElement as j, Modal as k, Select as l, SelectOption as m, TextInput as n, type ButtonProps as o, type CardJSXProps as p, type CardProps as q, type ContainerProps as r, type DividerProps as s, toCardElement as t, type FieldProps as u, type ImageProps as v, type LinkButtonProps as w, type TextProps as x, type ActionsElement as y, type ButtonElement as z };
+export { type SelectElement as $, Actions as A, Button as B, type CardElement as C, Divider as D, type SectionElement as E, Field as F, type TextElement as G, type TextStyle as H, Image as I, type ButtonProps as J, type CardJSXProps as K, LinkButton as L, type ModalElement as M, type CardProps as N, type ContainerProps as O, type DividerProps as P, type FieldProps as Q, RadioSelect as R, Section as S, Text as T, type ImageProps as U, type LinkButtonProps as V, type TextProps as W, type ModalChild as X, type ModalOptions as Y, type RadioSelectElement as Z, type RadioSelectOptions as _, type CardJSXElement as a, type SelectOptionElement as a0, type SelectOptions as a1, type TextInputElement as a2, type TextInputOptions as a3, type ModalProps as a4, type TextInputProps as a5, type SelectProps as a6, type SelectOptionProps as a7, jsx as a8, jsxs as a9, jsxDEV as aa, Fragment as ab, JSX as ac, type CardChild as b, Card as c, Fields as d, isJSX as e, fromReactElement as f, toModalElement as g, fromReactModalElement as h, isCardElement as i, isModalElement as j, Modal as k, Select as l, SelectOption as m, TextInput as n, type ActionsElement as o, type ButtonElement as p, type ButtonOptions as q, type ButtonStyle as r, type CardOptions as s, toCardElement as t, type DividerElement as u, type FieldElement as v, type FieldsElement as w, type ImageElement as x, type LinkButtonElement as y, type LinkButtonOptions as z };

package/dist/jsx-runtime.d.ts

@@ -1 +1 @@
-export { o as ButtonProps, a as CardJSXElement, p as CardJSXProps, q as CardProps, r as ContainerProps, s as DividerProps, u as FieldProps, ab as Fragment, v as ImageProps, ac as JSX, w as LinkButtonProps, a4 as ModalProps, a7 as SelectOptionProps, a6 as SelectProps, a5 as TextInputProps, x as TextProps, e as isJSX, a8 as jsx, aa as jsxDEV, a9 as jsxs, t as toCardElement, g as toModalElement } from './jsx-runtime-COVsDskT.js';
+export { J as ButtonProps, a as CardJSXElement, K as CardJSXProps, N as CardProps, O as ContainerProps, P as DividerProps, Q as FieldProps, ab as Fragment, U as ImageProps, ac as JSX, V as LinkButtonProps, a4 as ModalProps, a7 as SelectOptionProps, a6 as SelectProps, a5 as TextInputProps, W as TextProps, e as isJSX, a8 as jsx, aa as jsxDEV, a9 as jsxs, t as toCardElement, g as toModalElement } from './jsx-runtime-Bdt1Dwzf.js';

package/dist/jsx-runtime.js

@@ -6,7 +6,7 @@ import {
   jsxs,
   toCardElement,
   toModalElement
-} from "./chunk-WKJEG4FE.js";
+} from "./chunk-THM4ACIE.js";
 export {
   Fragment,
   isJSX,

package/docs/actions.mdx

@@ -0,0 +1,98 @@
+---
+title: Actions
+description: Handle button clicks and interactive card events across platforms.
+type: guide
+prerequisites:
+  - /docs/cards
+related:
+  - /docs/modals
+---
+
+Actions let you handle button clicks, dropdown selections, and other interactive events from [cards](/docs/cards). Register handlers with `onAction` to respond when users interact with your cards.
+
+## Handle a specific action
+
+```typescript title="lib/bot.ts" lineNumbers
+bot.onAction("approve", async (event) => {
+  await event.thread.post(`Order approved by ${event.user.fullName}!`);
+});
+```
+
+## Handle multiple actions
+
+```typescript title="lib/bot.ts" lineNumbers
+bot.onAction(["approve", "reject"], async (event) => {
+  const action = event.actionId === "approve" ? "approved" : "rejected";
+  await event.thread.post(`Order ${action} by ${event.user.fullName}`);
+});
+```
+
+## Catch-all handler
+
+Register a handler without an action ID to catch all actions:
+
+```typescript title="lib/bot.ts" lineNumbers
+bot.onAction(async (event) => {
+  console.log(`Action: ${event.actionId}, Value: ${event.value}`);
+});
+```
+
+## ActionEvent
+
+The `event` object passed to action handlers:
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `actionId` | `string` | The `id` from the Button or Select component |
+| `value` | `string` (optional) | The `value` from the Button or selected option |
+| `user` | `Author` | The user who clicked |
+| `thread` | `Thread` | The thread containing the card |
+| `messageId` | `string` | The message containing the card |
+| `threadId` | `string` | Thread ID |
+| `adapter` | `Adapter` | The platform adapter |
+| `triggerId` | `string` (optional) | Platform trigger ID (used for opening modals) |
+| `openModal` | `(modal) => Promise<void>` | Open a modal dialog |
+| `raw` | `unknown` | Platform-specific event payload |
+
+## Pass data with buttons
+
+Use the `value` prop on buttons to pass extra context to your handler:
+
+```tsx title="lib/bot.tsx"
+<Button id="report" value="bug">Report Bug</Button>
+<Button id="report" value="feature">Request Feature</Button>
+```
+
+```typescript title="lib/bot.ts" lineNumbers
+bot.onAction("report", async (event) => {
+  if (event.value === "bug") {
+    // Open bug report flow
+  } else if (event.value === "feature") {
+    // Open feature request flow
+  }
+});
+```
+
+## Open a modal from an action
+
+Use `event.openModal()` to open a [modal](/docs/modals) in response to a button click:
+
+```tsx title="lib/bot.tsx" lineNumbers
+import { Modal, TextInput, Select, SelectOption } from "chat";
+
+bot.onAction("feedback", async (event) => {
+  await event.openModal(
+    <Modal callbackId="feedback_form" title="Send Feedback" submitLabel="Send">
+      <TextInput id="message" label="Your Feedback" multiline />
+      <Select id="category" label="Category">
+        <SelectOption label="Bug" value="bug" />
+        <SelectOption label="Feature" value="feature" />
+      </Select>
+    </Modal>
+  );
+});
+```
+
+<Callout type="info">
+Modals are currently supported on Slack. Other platforms will receive a no-op or fallback behavior.
+</Callout>

package/docs/adapters/discord.mdx

@@ -0,0 +1,217 @@
+---
+title: Discord
+description: Configure the Discord adapter with HTTP Interactions and Gateway WebSocket support.
+type: integration
+prerequisites:
+  - /docs/getting-started
+---
+
+## Installation
+
+```sh title="Terminal"
+pnpm add @chat-adapter/discord
+```
+
+## Usage
+
+```typescript title="lib/bot.ts" lineNumbers
+import { Chat } from "chat";
+import { createDiscordAdapter } from "@chat-adapter/discord";
+
+const bot = new Chat({
+  userName: "mybot",
+  adapters: {
+    discord: createDiscordAdapter({
+      botToken: process.env.DISCORD_BOT_TOKEN!,
+      publicKey: process.env.DISCORD_PUBLIC_KEY!,
+      applicationId: process.env.DISCORD_APPLICATION_ID!,
+      mentionRoleIds: process.env.DISCORD_MENTION_ROLE_IDS?.split(","),
+    }),
+  },
+});
+
+bot.onNewMention(async (thread, message) => {
+  await thread.post("Hello from Discord!");
+});
+```
+
+## Discord application setup
+
+### 1. Create application
+
+1. Go to the [Discord Developer Portal](https://discord.com/developers/applications)
+2. Click **New Application** and give it a name
+3. Note the **Application ID** from the General Information page
+4. Copy the **Public Key** from the General Information page
+
+### 2. Create bot
+
+1. Go to the **Bot** section in the left sidebar
+2. Click **Reset Token** to generate a new bot token
+3. Copy and save the token (you won't see it again)
+4. Enable these **Privileged Gateway Intents**:
+   - Message Content Intent
+   - Server Members Intent (if needed)
+
+### 3. Configure interactions endpoint
+
+1. Go to **General Information**
+2. Set **Interactions Endpoint URL** to `https://your-domain.com/api/webhooks/discord`
+3. Discord sends a PING to verify the endpoint
+
+### 4. Add bot to server
+
+1. Go to **OAuth2** then **URL Generator**
+2. Select scopes: `bot`, `applications.commands`
+3. Select bot permissions: Send Messages, Send Messages in Threads, Create Public Threads, Read Message History, Add Reactions, Attach Files
+4. Copy the generated URL and open it to invite the bot to your server
+
+## Architecture: HTTP Interactions vs Gateway
+
+Discord has two ways to receive events:
+
+**HTTP Interactions (default):**
+- Receives button clicks, slash commands, and verification pings
+- Works out of the box with serverless
+- Does **not** receive regular messages
+
+**Gateway WebSocket (required for messages):**
+- Receives regular messages and reactions
+- Requires a persistent connection
+- In serverless environments, use a cron job to maintain the connection
+
+## Gateway setup for serverless
+
+### 1. Create Gateway route
+
+```typescript title="app/api/discord/gateway/route.ts"
+import { after } from "next/server";
+import { bot } from "@/lib/bot";
+
+export const maxDuration = 800;
+
+export async function GET(request: Request): Promise<Response> {
+  const cronSecret = process.env.CRON_SECRET;
+  if (!cronSecret) {
+    return new Response("CRON_SECRET not configured", { status: 500 });
+  }
+
+  const authHeader = request.headers.get("authorization");
+  if (authHeader !== `Bearer ${cronSecret}`) {
+    return new Response("Unauthorized", { status: 401 });
+  }
+
+  const durationMs = 600 * 1000;
+  const webhookUrl = `https://${process.env.VERCEL_URL}/api/webhooks/discord`;
+
+  return bot.adapters.discord.startGatewayListener(
+    { waitUntil: (task) => after(() => task) },
+    durationMs,
+    undefined,
+    webhookUrl
+  );
+}
+```
+
+### 2. Configure Vercel Cron
+
+```json title="vercel.json"
+{
+  "crons": [
+    {
+      "path": "/api/discord/gateway",
+      "schedule": "*/9 * * * *"
+    }
+  ]
+}
+```
+
+This runs every 9 minutes, ensuring overlap with the 10-minute listener duration.
+
+### 3. Add environment variables
+
+Add `CRON_SECRET` to your Vercel project settings.
+
+## Role mentions
+
+By default, only direct user mentions (`@BotName`) trigger `onNewMention` handlers. To also trigger on role mentions (e.g., `@AI`):
+
+1. Create a role in your Discord server (e.g., "AI")
+2. Assign the role to your bot
+3. Copy the role ID (right-click role in server settings with Developer Mode enabled)
+4. Add to `mentionRoleIds`:
+
+```typescript title="lib/bot.ts" lineNumbers
+createDiscordAdapter({
+  botToken: process.env.DISCORD_BOT_TOKEN!,
+  publicKey: process.env.DISCORD_PUBLIC_KEY!,
+  applicationId: process.env.DISCORD_APPLICATION_ID!,
+  mentionRoleIds: ["1457473602180878604"],
+});
+```
+
+Or set `DISCORD_MENTION_ROLE_IDS` as a comma-separated string.
+
+## Configuration
+
+| Option | Required | Description |
+|--------|----------|-------------|
+| `botToken` | Yes | Discord bot token |
+| `publicKey` | Yes | Application public key (for webhook signature verification) |
+| `applicationId` | Yes | Discord application ID |
+| `mentionRoleIds` | No | Array of role IDs that trigger mention handlers |
+
+## Environment variables
+
+```bash title=".env.local"
+DISCORD_BOT_TOKEN=your-bot-token
+DISCORD_PUBLIC_KEY=your-application-public-key
+DISCORD_APPLICATION_ID=your-application-id
+DISCORD_MENTION_ROLE_IDS=1234567890,0987654321  # Optional
+CRON_SECRET=your-random-secret                   # For Gateway cron
+```
+
+## Features
+
+| Feature | Supported |
+|---------|-----------|
+| Mentions | Yes |
+| Reactions (add/remove) | Yes |
+| Cards (Embeds) | Yes |
+| Modals | No |
+| Streaming | Post+Edit fallback |
+| DMs | Yes |
+| Ephemeral messages | No (DM fallback) |
+| File uploads | Yes |
+| Typing indicator | Yes |
+| Message history | Yes |
+
+## Testing
+
+Run a local tunnel (e.g., ngrok) to test webhooks locally:
+
+```sh title="Terminal"
+ngrok http 3000
+```
+
+Update the Interactions Endpoint URL in the Discord Developer Portal to your ngrok URL.
+
+## Troubleshooting
+
+### Bot not responding to messages
+
+1. **Check Gateway connection**: Messages require the Gateway WebSocket, not just HTTP interactions
+2. **Verify Message Content Intent**: Enable this in the Bot settings
+3. **Check bot permissions**: Ensure the bot can read messages in the channel
+
+### Role mentions not triggering
+
+1. **Verify role ID**: Enable Developer Mode in Discord settings, then right-click the role
+2. **Check `mentionRoleIds` config**: Ensure the role ID is in the array
+3. **Confirm bot has the role**: The bot must have the role assigned
+
+### Signature verification failing
+
+1. **Check public key format**: Should be a 64-character hex string (lowercase)
+2. **Verify endpoint URL**: Must exactly match what's configured in Discord Developer Portal
+3. **Check for body parsing**: Don't parse the request body before verification