chat 4.2.0 → 4.4.0

package/dist/index.d.ts

@@ -1,12 +1,11 @@
-import { C as CardElement, a as CardJSXElement, b as CardChild, A as Actions$1, B as Button$1, c as Card$1, T as Text$1, D as Divider$1, F as Field$1, d as Fields$1, f as fromReactElement$1, I as Image$1, i as isCardElement$1, e as isJSX$1, S as Section$1, t as toCardElement$1 } from './jsx-runtime-D7zHSnXe.js';
-export { g as ActionsElement, h as ButtonElement, j as ButtonOptions, k as ButtonStyle, l as CardOptions, m as DividerElement, n as FieldElement, o as FieldsElement, p as ImageElement, q as SectionElement, r as TextElement, s as TextStyle } from './jsx-runtime-D7zHSnXe.js';
-import { Root, Content, Blockquote, Code, Emphasis, InlineCode, Link, Paragraph, Delete, Strong, Text } from 'mdast';
+import { C as CardElement, a as CardJSXElement, M as ModalElement, b as CardChild, A as Actions$1, B as Button$1, c as Card$1, T as Text$1, D as Divider$1, F as Field$1, d as Fields$1, f as fromReactElement$1, I as Image$1, i as isCardElement$1, e as isJSX$1, S as Section$1, t as toCardElement$1, g as toModalElement$1, h as fromReactModalElement$1, j as isModalElement$1, k as Modal$1, l as Select$1, m as SelectOption$1, n as TextInput$1 } from './jsx-runtime-CFK57xOl.js';
+export { x as ActionsElement, y as ButtonElement, z as ButtonOptions, o as ButtonProps, E as ButtonStyle, p as CardJSXProps, G as CardOptions, q as CardProps, r as ContainerProps, H as DividerElement, s as DividerProps, J as FieldElement, u as FieldProps, K as FieldsElement, L as ImageElement, v as ImageProps, Q as ModalChild, R as ModalOptions, N as SectionElement, U as SelectElement, V as SelectOptionElement, W as SelectOptions, O as TextElement, X as TextInputElement, Y as TextInputOptions, w as TextProps, P as TextStyle } from './jsx-runtime-CFK57xOl.js';
+import { Root, Content, Blockquote, Code, Emphasis, InlineCode, Delete, Link, ListItem, List, Paragraph, Strong, Text } from 'mdast';
 export { Blockquote, Code, Content, Delete, Emphasis, InlineCode, Link, List, ListItem, Paragraph, Root, Strong, Text } from 'mdast';
 
 /**
- * Core types for chat-sdk
+ * Logger types and implementations for chat-sdk
  */
-
 type LogLevel = "debug" | "info" | "warn" | "error" | "silent";
 interface Logger {
     debug(message: string, ...args: unknown[]): void;
@@ -30,6 +29,27 @@ declare class ConsoleLogger implements Logger {
     warn(message: string, ...args: unknown[]): void;
     error(message: string, ...args: unknown[]): void;
 }
+
+/**
+ * Error types for chat-sdk
+ */
+declare class ChatError extends Error {
+    readonly code: string;
+    readonly cause?: unknown | undefined;
+    constructor(message: string, code: string, cause?: unknown | undefined);
+}
+declare class RateLimitError extends ChatError {
+    readonly retryAfterMs?: number | undefined;
+    constructor(message: string, retryAfterMs?: number | undefined, cause?: unknown);
+}
+declare class LockError extends ChatError {
+    constructor(message: string, cause?: unknown);
+}
+declare class NotImplementedError extends ChatError {
+    readonly feature?: string | undefined;
+    constructor(message: string, feature?: string | undefined, cause?: unknown);
+}
+
 /**
  * Chat configuration with type-safe adapter inference.
  * @template TAdapters - Record of adapter name to adapter instance
@@ -42,10 +62,10 @@ interface ChatConfig<TAdapters extends Record<string, Adapter> = Record<string,
     /** State adapter for subscriptions and locking */
     state: StateAdapter;
     /**
-     * Logger instance or log level. Defaults to "info".
+     * Logger instance or log level.
      * Pass "silent" to disable all logging.
      */
-    logger?: Logger | LogLevel;
+    logger: Logger | LogLevel;
     /**
      * Update interval for fallback streaming (post + edit) in milliseconds.
      * Defaults to 500ms. Lower values provide smoother updates but may hit rate limits.
@@ -169,6 +189,16 @@ interface Adapter<TThreadId = unknown, TRawMessage = unknown> {
      * @returns True if the thread is a DM, false otherwise
      */
     isDM?(threadId: string): boolean;
+    /**
+     * Open a modal/dialog form.
+     *
+     * @param triggerId - Platform-specific trigger ID from the action event
+     * @param modal - The modal element to display
+     * @returns The view/dialog ID
+     */
+    openModal?(triggerId: string, modal: ModalElement): Promise<{
+        viewId: string;
+    }>;
     /**
      * Stream a message using platform-native streaming APIs.
      *
@@ -227,9 +257,11 @@ interface ChatInstance {
      * @param event - The action event (without thread field, will be added)
      * @param options - Webhook options including waitUntil
      */
-    processAction(event: Omit<ActionEvent, "thread"> & {
+    processAction(event: Omit<ActionEvent, "thread" | "openModal"> & {
         adapter: Adapter;
     }, options?: WebhookOptions): void;
+    processModalSubmit(event: Omit<ModalSubmitEvent, "thread">, options?: WebhookOptions): Promise<ModalResponse | undefined>;
+    processModalClose(event: Omit<ModalCloseEvent, "thread">, options?: WebhookOptions): void;
     getState(): StateAdapter;
     getUserName(): string;
     /** Get the configured logger, optionally with a child prefix */
@@ -854,6 +886,17 @@ interface ActionEvent<TRawMessage = unknown> {
     adapter: Adapter;
     /** Platform-specific raw event data */
     raw: unknown;
+    /** Trigger ID for opening modals (required by some platforms, may expire quickly) */
+    triggerId?: string;
+    /**
+     * Open a modal/dialog form in response to this action.
+     *
+     * @param modal - The modal element to display (JSX or ModalElement)
+     * @returns The view/dialog ID, or undefined if modals are not supported
+     */
+    openModal(modal: ModalElement | CardJSXElement): Promise<{
+        viewId: string;
+    } | undefined>;
 }
 /**
  * Handler for action events (button clicks in cards).
@@ -879,22 +922,40 @@ interface ActionEvent<TRawMessage = unknown> {
  * ```
  */
 type ActionHandler = (event: ActionEvent) => Promise<void>;
-declare class ChatError extends Error {
-    readonly code: string;
-    readonly cause?: unknown | undefined;
-    constructor(message: string, code: string, cause?: unknown | undefined);
-}
-declare class RateLimitError extends ChatError {
-    readonly retryAfterMs?: number | undefined;
-    constructor(message: string, retryAfterMs?: number | undefined, cause?: unknown);
-}
-declare class LockError extends ChatError {
-    constructor(message: string, cause?: unknown);
+interface ModalSubmitEvent {
+    callbackId: string;
+    viewId: string;
+    values: Record<string, string>;
+    privateMetadata?: string;
+    user: Author;
+    adapter: Adapter;
+    raw: unknown;
 }
-declare class NotImplementedError extends ChatError {
-    readonly feature?: string | undefined;
-    constructor(message: string, feature?: string | undefined, cause?: unknown);
+interface ModalCloseEvent {
+    callbackId: string;
+    viewId: string;
+    user: Author;
+    adapter: Adapter;
+    raw: unknown;
 }
+type ModalErrorsResponse = {
+    action: "errors";
+    errors: Record<string, string>;
+};
+type ModalUpdateResponse = {
+    action: "update";
+    modal: ModalElement;
+};
+type ModalPushResponse = {
+    action: "push";
+    modal: ModalElement;
+};
+type ModalCloseResponse = {
+    action: "close";
+};
+type ModalResponse = ModalCloseResponse | ModalErrorsResponse | ModalUpdateResponse | ModalPushResponse;
+type ModalSubmitHandler = (event: ModalSubmitEvent) => Promise<ModalResponse | undefined>;
+type ModalCloseHandler = (event: ModalCloseEvent) => Promise<void>;
 
 /** Filter can be EmojiValue objects, emoji names, or raw emoji formats */
 type EmojiFilter = EmojiValue | string;
@@ -947,6 +1008,8 @@ declare class Chat<TAdapters extends Record<string, Adapter> = Record<string, Ad
     private subscribedMessageHandlers;
     private reactionHandlers;
     private actionHandlers;
+    private modalSubmitHandlers;
+    private modalCloseHandlers;
     /** Initialization state */
     private initPromise;
     private initialized;
@@ -972,6 +1035,12 @@ declare class Chat<TAdapters extends Record<string, Adapter> = Record<string, Ad
      * Gracefully shut down the chat instance.
      */
     shutdown(): Promise<void>;
+    /**
+     * Initialize the chat instance and all adapters.
+     * This is called automatically when handling webhooks, but can be called
+     * manually for non-webhook use cases (e.g., Gateway listeners).
+     */
+    initialize(): Promise<void>;
     /**
      * Register a handler for new @-mentions of the bot.
      *
@@ -1092,6 +1161,12 @@ declare class Chat<TAdapters extends Record<string, Adapter> = Record<string, Ad
     onAction(handler: ActionHandler): void;
     onAction(actionId: string, handler: ActionHandler): void;
     onAction(actionIds: string[], handler: ActionHandler): void;
+    onModalSubmit(handler: ModalSubmitHandler): void;
+    onModalSubmit(callbackId: string, handler: ModalSubmitHandler): void;
+    onModalSubmit(callbackIds: string[], handler: ModalSubmitHandler): void;
+    onModalClose(handler: ModalCloseHandler): void;
+    onModalClose(callbackId: string, handler: ModalCloseHandler): void;
+    onModalClose(callbackIds: string[], handler: ModalCloseHandler): void;
     /**
      * Get an adapter by name with type safety.
      */
@@ -1113,9 +1188,11 @@ declare class Chat<TAdapters extends Record<string, Adapter> = Record<string, Ad
      * Process an incoming action event (button click) from an adapter.
      * Handles waitUntil registration and error catching internally.
      */
-    processAction(event: Omit<ActionEvent, "thread"> & {
+    processAction(event: Omit<ActionEvent, "thread" | "openModal"> & {
         adapter: Adapter;
     }, options?: WebhookOptions): void;
+    processModalSubmit(event: Omit<ModalSubmitEvent, "thread">, _options?: WebhookOptions): Promise<ModalResponse | undefined>;
+    processModalClose(event: Omit<ModalCloseEvent, "thread">, options?: WebhookOptions): void;
     /**
      * Handle an action event internally.
      */
@@ -1136,6 +1213,7 @@ declare class Chat<TAdapters extends Record<string, Adapter> = Record<string, Ad
      * - Slack: `U...` (e.g., "U03STHCA1JM")
      * - Teams: `29:...` (e.g., "29:198PbJuw...")
      * - Google Chat: `users/...` (e.g., "users/117994873354375860089")
+     * - Discord: numeric snowflake (e.g., "1033044521375764530")
      *
      * @param user - Platform-specific user ID string, or an Author object
      * @returns A Thread that can be used to post messages
@@ -1298,6 +1376,11 @@ declare class EmojiResolver {
      * Returns the first GChat format if multiple exist.
      */
     toGChat(emoji: EmojiValue | string): string;
+    /**
+     * Convert a normalized emoji (or EmojiValue) to Discord format (unicode).
+     * Discord uses unicode emoji, same as Google Chat.
+     */
+    toDiscord(emoji: EmojiValue | string): string;
     /**
      * Check if an emoji (in any format) matches a normalized emoji name or EmojiValue.
      */
@@ -1323,7 +1406,7 @@ declare const defaultEmojiResolver: EmojiResolver;
  * // Returns: "Thanks! 👍"
  * ```
  */
-declare function convertEmojiPlaceholders(text: string, platform: "slack" | "gchat" | "teams", resolver?: EmojiResolver): string;
+declare function convertEmojiPlaceholders(text: string, platform: "slack" | "gchat" | "teams" | "discord", resolver?: EmojiResolver): string;
 /** Base emoji object with well-known emoji as EmojiValue singletons */
 type BaseEmojiHelper = {
     [K in WellKnownEmoji]: EmojiValue;
@@ -1411,6 +1494,61 @@ declare const emoji: ExtendedEmojiHelper;
 
 type PostableMessageInput = AdapterPostableMessage;
 
+/**
+ * Type guard for text nodes.
+ */
+declare function isTextNode(node: Content): node is Text;
+/**
+ * Type guard for paragraph nodes.
+ */
+declare function isParagraphNode(node: Content): node is Paragraph;
+/**
+ * Type guard for strong (bold) nodes.
+ */
+declare function isStrongNode(node: Content): node is Strong;
+/**
+ * Type guard for emphasis (italic) nodes.
+ */
+declare function isEmphasisNode(node: Content): node is Emphasis;
+/**
+ * Type guard for delete (strikethrough) nodes.
+ */
+declare function isDeleteNode(node: Content): node is Delete;
+/**
+ * Type guard for inline code nodes.
+ */
+declare function isInlineCodeNode(node: Content): node is InlineCode;
+/**
+ * Type guard for code block nodes.
+ */
+declare function isCodeNode(node: Content): node is Code;
+/**
+ * Type guard for link nodes.
+ */
+declare function isLinkNode(node: Content): node is Link;
+/**
+ * Type guard for blockquote nodes.
+ */
+declare function isBlockquoteNode(node: Content): node is Blockquote;
+/**
+ * Type guard for list nodes.
+ */
+declare function isListNode(node: Content): node is List;
+/**
+ * Type guard for list item nodes.
+ */
+declare function isListItemNode(node: Content): node is ListItem;
+/**
+ * Get children from a content node that has children.
+ * Returns empty array for nodes without children.
+ * This eliminates the need for `as Content` casts in adapter converters.
+ */
+declare function getNodeChildren(node: Content): Content[];
+/**
+ * Get value from a content node that has a value property.
+ * Returns empty string for nodes without value.
+ */
+declare function getNodeValue(node: Content): string;
 /**
  * Parse markdown string into an AST.
  * Supports GFM (GitHub Flavored Markdown) for strikethrough, tables, etc.
@@ -1514,6 +1652,16 @@ interface MarkdownConverter extends FormatConverter {
 declare abstract class BaseFormatConverter implements FormatConverter {
     abstract fromAst(ast: Root): string;
     abstract toAst(platformText: string): Root;
+    /**
+     * Template method for implementing fromAst with a node converter.
+     * Iterates through AST children and converts each using the provided function.
+     * Joins results with double newlines (standard paragraph separation).
+     *
+     * @param ast - The AST to convert
+     * @param nodeConverter - Function to convert each Content node to string
+     * @returns Platform-formatted string
+     */
+    protected fromAstWithNodeConverter(ast: Root, nodeConverter: (node: Content) => string): string;
     extractPlainText(platformText: string): string;
     fromMarkdown(markdown: string): string;
     toMarkdown(platformText: string): string;
@@ -1556,5 +1704,13 @@ declare const isCardElement: typeof isCardElement$1;
 declare const isJSX: typeof isJSX$1;
 declare const Section: typeof Section$1;
 declare const toCardElement: typeof toCardElement$1;
+declare const toModalElement: typeof toModalElement$1;
+
+declare const fromReactModalElement: typeof fromReactModalElement$1;
+declare const isModalElement: typeof isModalElement$1;
+declare const Modal: typeof Modal$1;
+declare const Select: typeof Select$1;
+declare const SelectOption: typeof SelectOption$1;
+declare const TextInput: typeof TextInput$1;
 
-export { type ActionEvent, type ActionHandler, Actions, type Adapter, type AdapterPostableMessage, type Attachment, type Author, BaseFormatConverter, Button, Card, CardChild, CardElement, CardJSXElement, CardText, Chat, type ChatConfig, ChatError, type ChatInstance, ConsoleLogger, type CustomEmojiMap, DEFAULT_EMOJI_MAP, Divider, type Emoji, type EmojiFormats, type EmojiMapConfig, EmojiResolver, type EmojiValue, type FetchDirection, type FetchOptions, type FetchResult, Field, Fields, type FileUpload, type FormatConverter, type FormattedContent, Image, type Lock, LockError, type LogLevel, type Logger, type MarkdownConverter, type MentionHandler, type Message, type MessageHandler, type MessageMetadata, NotImplementedError, type PostableAst, type PostableCard, type PostableMarkdown, type PostableMessage, type PostableRaw, RateLimitError, type RawMessage, type ReactionEvent, type ReactionHandler, Section, type SentMessage, type StateAdapter, type StreamOptions, type SubscribedMessageHandler, THREAD_STATE_TTL_MS, type Thread, ThreadImpl, type ThreadInfo, type WebhookOptions, type WellKnownEmoji, blockquote, codeBlock, convertEmojiPlaceholders, createEmoji, defaultEmojiResolver, emoji, emphasis, fromReactElement, getEmoji, inlineCode, isCardElement, isJSX, link, markdownToPlainText, paragraph, parseMarkdown, root, strikethrough, stringifyMarkdown, strong, text, toCardElement, toPlainText, walkAst };
+export { type ActionEvent, type ActionHandler, Actions, type Adapter, type AdapterPostableMessage, type Attachment, type Author, BaseFormatConverter, Button, Card, CardChild, CardElement, CardJSXElement, CardText, Chat, type ChatConfig, ChatError, type ChatInstance, ConsoleLogger, type CustomEmojiMap, DEFAULT_EMOJI_MAP, Divider, type Emoji, type EmojiFormats, type EmojiMapConfig, EmojiResolver, type EmojiValue, type FetchDirection, type FetchOptions, type FetchResult, Field, Fields, type FileUpload, type FormatConverter, type FormattedContent, Image, type Lock, LockError, type LogLevel, type Logger, type MarkdownConverter, type MentionHandler, type Message, type MessageHandler, type MessageMetadata, Modal, type ModalCloseEvent, type ModalCloseHandler, type ModalCloseResponse, ModalElement, type ModalErrorsResponse, type ModalPushResponse, type ModalResponse, type ModalSubmitEvent, type ModalSubmitHandler, type ModalUpdateResponse, NotImplementedError, type PostableAst, type PostableCard, type PostableMarkdown, type PostableMessage, type PostableRaw, RateLimitError, type RawMessage, type ReactionEvent, type ReactionHandler, Section, Select, SelectOption, type SentMessage, type StateAdapter, type StreamOptions, type SubscribedMessageHandler, THREAD_STATE_TTL_MS, TextInput, type Thread, ThreadImpl, type ThreadInfo, type WebhookOptions, type WellKnownEmoji, blockquote, codeBlock, convertEmojiPlaceholders, createEmoji, defaultEmojiResolver, emoji, emphasis, fromReactElement, fromReactModalElement, getEmoji, getNodeChildren, getNodeValue, inlineCode, isBlockquoteNode, isCardElement, isCodeNode, isDeleteNode, isEmphasisNode, isInlineCodeNode, isJSX, isLinkNode, isListItemNode, isListNode, isModalElement, isParagraphNode, isStrongNode, isTextNode, link, markdownToPlainText, paragraph, parseMarkdown, root, strikethrough, stringifyMarkdown, strong, text, toCardElement, toModalElement, toPlainText, walkAst };