@promptbook/fake-llm 0.105.0-20 → 0.105.0-23

package/esm/typings/src/_packages/core.index.d.ts

@@ -21,14 +21,12 @@ import { pipelineCollectionToJson } from '../collection/pipeline-collection/pipe
 import { createEmptyAgentModelRequirements } from '../commitments/_base/createEmptyAgentModelRequirements';
 import { createBasicAgentModelRequirements } from '../commitments/_base/createEmptyAgentModelRequirements';
 import { NotYetImplementedCommitmentDefinition } from '../commitments/_base/NotYetImplementedCommitmentDefinition';
-import { getCommitmentDefinition } from '../commitments/index';
-import { getAllCommitmentDefinitions } from '../commitments/index';
-import { getAllCommitmentTypes } from '../commitments/index';
-import { isCommitmentSupported } from '../commitments/index';
-import type { GroupedCommitmentDefinition } from '../commitments/index';
-import { getGroupedCommitmentDefinitions } from '../commitments/index';
-import { getAllCommitmentsToolFunctions } from '../commitments/index';
-import { getAllCommitmentsToolTitles } from '../commitments/index';
+import { getAllCommitmentDefinitions } from '../commitments/_common/getAllCommitmentDefinitions';
+import { getAllCommitmentsToolTitles } from '../commitments/_common/getAllCommitmentsToolTitles';
+import { getAllCommitmentTypes } from '../commitments/_common/getAllCommitmentTypes';
+import { getCommitmentDefinition } from '../commitments/_common/getCommitmentDefinition';
+import { getGroupedCommitmentDefinitions } from '../commitments/_common/getGroupedCommitmentDefinitions';
+import { isCommitmentSupported } from '../commitments/_common/isCommitmentSupported';
 import { NAME } from '../config';
 import { ADMIN_EMAIL } from '../config';
 import { PROMPTBOOK_LEGAL_ENTITY } from '../config';
@@ -226,14 +224,12 @@ export { pipelineCollectionToJson };
 export { createEmptyAgentModelRequirements };
 export { createBasicAgentModelRequirements };
 export { NotYetImplementedCommitmentDefinition };
-export { getCommitmentDefinition };
 export { getAllCommitmentDefinitions };
+export { getAllCommitmentsToolTitles };
 export { getAllCommitmentTypes };
-export { isCommitmentSupported };
-export type { GroupedCommitmentDefinition };
+export { getCommitmentDefinition };
 export { getGroupedCommitmentDefinitions };
-export { getAllCommitmentsToolFunctions };
-export { getAllCommitmentsToolTitles };
+export { isCommitmentSupported };
 export { NAME };
 export { ADMIN_EMAIL };
 export { PROMPTBOOK_LEGAL_ENTITY };

package/esm/typings/src/_packages/node.index.d.ts

@@ -1,5 +1,6 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { createPipelineCollectionFromDirectory } from '../collection/pipeline-collection/constructors/createPipelineCollectionFromDirectory';
+import { getAllCommitmentsToolFunctionsForNode } from '../commitments/_common/getAllCommitmentsToolFunctionsForNode';
 import { $provideExecutablesForNode } from '../executables/$provideExecutablesForNode';
 import { $provideExecutionToolsForNode } from '../execution/utils/$provideExecutionToolsForNode';
 import { $provideLlmToolsConfigurationFromEnv } from '../llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv';
@@ -12,6 +13,7 @@ import { $execCommand } from '../utils/execCommand/$execCommand';
 import { $execCommands } from '../utils/execCommand/$execCommands';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { createPipelineCollectionFromDirectory };
+export { getAllCommitmentsToolFunctionsForNode };
 export { $provideExecutablesForNode };
 export { $provideExecutionToolsForNode };
 export { $provideLlmToolsConfigurationFromEnv };

package/esm/typings/src/_packages/types.index.d.ts

@@ -9,17 +9,29 @@ import type { AvatarProfileProps } from '../book-components/AvatarProfile/Avatar
 import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
 import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
 import type { AgentChatProps } from '../book-components/Chat/AgentChat/AgentChatProps';
+import type { AgentChipData } from '../book-components/Chat/AgentChip/AgentChip';
+import type { AgentChipProps } from '../book-components/Chat/AgentChip/AgentChip';
+import type { ChatSoundSystem } from '../book-components/Chat/Chat/ChatProps';
 import type { ChatProps } from '../book-components/Chat/Chat/ChatProps';
+import type { ChatSoundToggleProps } from '../book-components/Chat/Chat/ChatSoundToggle';
+import type { ChatEffect } from '../book-components/Chat/effects/types/ChatEffect';
+import type { ChatEffectConfig } from '../book-components/Chat/effects/types/ChatEffectConfig';
+import type { ChatEffectsSystemProps } from '../book-components/Chat/effects/types/ChatEffectsSystemProps';
+import type { ChatEffectType } from '../book-components/Chat/effects/types/ChatEffectType';
 import type { ChatAutoScrollConfig } from '../book-components/Chat/hooks/useChatAutoScroll';
 import type { SendMessageToLlmChatFunction } from '../book-components/Chat/hooks/useSendMessageToLlmChat';
+import type { FriendlyErrorMessage } from '../book-components/Chat/LlmChat/FriendlyErrorMessage';
 import type { LlmChatProps } from '../book-components/Chat/LlmChat/LlmChatProps';
 import type { MockedChatDelayConfig } from '../book-components/Chat/MockedChat/MockedChat';
 import type { MockedChatProps } from '../book-components/Chat/MockedChat/MockedChat';
 import type { ChatSaveFormatDefinition } from '../book-components/Chat/save/_common/ChatSaveFormatDefinition';
 import type { string_chat_format_name } from '../book-components/Chat/save/_common/string_chat_format_name';
+import type { SourceChipProps } from '../book-components/Chat/SourceChip/SourceChip';
 import type { ChatToolCall } from '../book-components/Chat/types/ChatMessage';
 import type { ChatMessage } from '../book-components/Chat/types/ChatMessage';
 import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
+import type { ToolCallChipletInfo } from '../book-components/Chat/utils/getToolCallChipletText';
+import type { ParsedCitation } from '../book-components/Chat/utils/parseCitationsFromContent';
 import type { MessageButton } from '../book-components/Chat/utils/parseMessageButtons';
 import type { TeamToolResult } from '../book-components/Chat/utils/toolCallParsing';
 import type { QrCodeOptions } from '../book-components/Qr/useQrCode';
@@ -60,7 +72,6 @@ import type { InstrumentCommand } from '../commands/X_INSTRUMENT/InstrumentComma
 import type { BookCommitment } from '../commitments/_base/BookCommitment';
 import type { CommitmentDefinition } from '../commitments/_base/CommitmentDefinition';
 import type { ParsedCommitment } from '../commitments/_base/ParsedCommitment';
-import type { GroupedCommitmentDefinition } from '../commitments/index';
 import type { PrettifyOptions } from '../conversion/prettify/PrettifyOptions';
 import type { renderPipelineMermaidOptions } from '../conversion/prettify/renderPipelineMermaidOptions';
 import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';
@@ -392,17 +403,29 @@ export type { AvatarProfileProps };
 export type { AvatarProfileFromSourceProps };
 export type { BookEditorProps };
 export type { AgentChatProps };
+export type { AgentChipData };
+export type { AgentChipProps };
+export type { ChatSoundSystem };
 export type { ChatProps };
+export type { ChatSoundToggleProps };
+export type { ChatEffect };
+export type { ChatEffectConfig };
+export type { ChatEffectsSystemProps };
+export type { ChatEffectType };
 export type { ChatAutoScrollConfig };
 export type { SendMessageToLlmChatFunction };
+export type { FriendlyErrorMessage };
 export type { LlmChatProps };
 export type { MockedChatDelayConfig };
 export type { MockedChatProps };
 export type { ChatSaveFormatDefinition };
 export type { string_chat_format_name };
+export type { SourceChipProps };
 export type { ChatToolCall };
 export type { ChatMessage };
 export type { ChatParticipant };
+export type { ToolCallChipletInfo };
+export type { ParsedCitation };
 export type { MessageButton };
 export type { TeamToolResult };
 export type { QrCodeOptions };
@@ -443,7 +466,6 @@ export type { InstrumentCommand };
 export type { BookCommitment };
 export type { CommitmentDefinition };
 export type { ParsedCommitment };
-export type { GroupedCommitmentDefinition };
 export type { PrettifyOptions };
 export type { renderPipelineMermaidOptions };
 export type { CallbackInterfaceToolsOptions };

package/esm/typings/src/book-2.0/agent-source/AgentBasicInformation.d.ts

@@ -31,7 +31,7 @@ export type AgentCapability = {
     /**
      * The type of the capability
      */
-    type: 'browser' | 'search-engine' | 'knowledge' | 'time' | 'inheritance' | 'import' | 'image-generator' | 'team';
+    type: 'browser' | 'search-engine' | 'knowledge' | 'time' | 'inheritance' | 'import' | 'image-generator' | 'team' | 'email';
     /**
      * The label to display for this capability
      */

package/esm/typings/src/book-components/Chat/AgentChip/AgentChip.d.ts

@@ -0,0 +1,67 @@
+/// <reference types="react" />
+import type { string_url } from '../../../types/typeAliases';
+/**
+ * Agent profile information for chip display
+ */
+export type AgentChipData = {
+    /**
+     * Agent URL (required)
+     */
+    url: string_url;
+    /**
+     * Agent display name/label
+     */
+    label?: string;
+    /**
+     * Agent profile image URL
+     */
+    imageUrl?: string_url;
+    /**
+     * Public URL of the agents server (for generating placeholder images)
+     */
+    publicUrl?: string_url;
+};
+/**
+ * Props for AgentChip component
+ */
+export type AgentChipProps = {
+    /**
+     * Agent data to display
+     */
+    agent: AgentChipData;
+    /**
+     * Whether this is an ongoing interaction (shows spinner)
+     */
+    isOngoing?: boolean;
+    /**
+     * Whether this is clickable (completed state)
+     */
+    isClickable?: boolean;
+    /**
+     * Click handler
+     */
+    onClick?: (event?: React.MouseEvent) => void;
+    /**
+     * Additional CSS class name
+     */
+    className?: string;
+};
+/**
+ * AgentChip component - displays a chip with agent avatar and name
+ *
+ * This component is used to display agent interactions in chat messages.
+ * It fetches the agent profile if needed and displays the agent's avatar and name.
+ *
+ * @example
+ * ```tsx
+ * <AgentChip
+ *   agent={{ url: 'https://agents.example.com/joe', label: 'Joe' }}
+ *   isOngoing={false}
+ *   isClickable={true}
+ *   onClick={() => console.log('clicked')}
+ * />
+ * ```
+ *
+ * @private utility of `ChatMessageItem` component
+ */
+export declare function AgentChip({ agent, isOngoing, isClickable, onClick, className }: AgentChipProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/Chat/AgentChip/index.d.ts

@@ -0,0 +1,2 @@
+export { AgentChip } from './AgentChip';
+export type { AgentChipData, AgentChipProps } from './AgentChip';

package/esm/typings/src/book-components/Chat/Chat/ChatMessageItem.d.ts

@@ -2,6 +2,7 @@
 import type { id } from '../../../types/typeAliases';
 import type { ChatMessage } from '../types/ChatMessage';
 import type { ChatParticipant } from '../types/ChatParticipant';
+import { type ParsedCitation } from '../utils/parseCitationsFromContent';
 import type { ChatProps } from './ChatProps';
 /**
  * Props for the `ChatMessageItem` component
@@ -38,10 +39,24 @@ type ChatMessageItemProps = Pick<ChatProps, 'onMessage' | 'participants'> & {
      * e.g., { "web_search": "Searching the web..." }
      */
     toolTitles?: Record<string, string>;
+    /**
+     * Optional metadata about teammates for team tool calls
+     * Maps tool name to agent information
+     */
+    teammates?: Record<string, {
+        url: string;
+        label?: string;
+        instructions?: string;
+        toolName: string;
+    }>;
     /**
      * Called when a tool call chiplet is clicked.
      */
     onToolCallClick?: (toolCall: NonNullable<ChatMessage['toolCalls']>[number]) => void;
+    /**
+     * Called when a source citation chip is clicked.
+     */
+    onCitationClick?: (citation: ParsedCitation) => void;
 };
 /**
  * Renders a single chat message item with avatar, content, buttons, and rating.

package/esm/typings/src/book-components/Chat/Chat/ChatProps.d.ts

@@ -6,6 +6,21 @@ import { string_color } from '../../../types/typeAliases';
 import type { string_chat_format_name } from '../save/_common/string_chat_format_name';
 import type { ChatMessage } from '../types/ChatMessage';
 import type { ChatParticipant } from '../types/ChatParticipant';
+/**
+ * Interface for sound system that can be passed to Chat component
+ * This allows the chat to trigger sounds without tight coupling
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type ChatSoundSystem = {
+    /**
+     * @@@
+     */
+    play(event: string): Promise<void>;
+    isEnabled(): boolean;
+    setEnabled(enabled: boolean): void;
+    toggle(): boolean;
+};
 /**
  * @public exported from `@promptbook/components`
  */
@@ -154,6 +169,16 @@ export type ChatProps = {
      * e.g., { "web_search": "Searching the web..." }
      */
     readonly toolTitles?: Record<string, string>;
+    /**
+     * Optional metadata about teammates for team tool calls
+     * Maps tool name to agent information
+     */
+    readonly teammates?: Record<string, {
+        url: string;
+        label?: string;
+        instructions?: string;
+        toolName: string;
+    }>;
     /**
      * Optional callback to create a new agent from the template.
      * If provided, renders the [Create Agent] button for book code blocks.
@@ -202,6 +227,49 @@ export type ChatProps = {
      * Visual style of the chat component
      */
     readonly visual: 'STANDALONE' | 'FULL_PAGE';
+    /**
+     * Optional array of effect configurations for chat animations
+     * When provided, enables visual effects (confetti, hearts, etc.) based on emojis in messages
+     *
+     * Example:
+     * ```typescript
+     * [
+     *   { trigger: '🎉', effectType: 'CONFETTI' },
+     *   { trigger: /❤️|💙|💚/, effectType: 'HEARTS' }
+     * ]
+     * ```
+     */
+    readonly effectConfigs?: ReadonlyArray<{
+        trigger: string | RegExp;
+        effectType: string;
+    }>;
+    /**
+     * Optional sound system for playing chat sounds
+     * When provided, enables sound effects for message events, button clicks, and visual effects
+     *
+     * The sound system should implement the ChatSoundSystem interface:
+     * - play(event: string): Plays a sound for the given event
+     * - isEnabled(): Returns whether sounds are enabled
+     * - setEnabled(enabled: boolean): Enables or disables sounds
+     * - toggle(): Toggles sound on/off and returns the new state
+     *
+     * Supported events:
+     * - 'message_send': When user sends a message
+     * - 'message_receive': When agent sends a message
+     * - 'message_typing': When agent is typing/thinking
+     * - 'button_click': When any button is clicked
+     * - 'effect_confetti': When confetti effect is triggered
+     * - 'effect_hearts': When hearts effect is triggered
+     *
+     * @example
+     * ```typescript
+     * import { createDefaultSoundSystem } from '@/utils/sound/createDefaultSoundSystem';
+     *
+     * const soundSystem = createDefaultSoundSystem();
+     * <Chat soundSystem={soundSystem} ... />
+     * ```
+     */
+    readonly soundSystem?: ChatSoundSystem;
 };
 /**
  * TODO: [☁️] Export component prop types only to `@promptbook/components` (not `@promptbook/types`)

package/esm/typings/src/book-components/Chat/Chat/ChatSoundToggle.d.ts

@@ -0,0 +1,23 @@
+import type { ChatSoundSystem } from './ChatProps';
+/**
+ * Props for the ChatSoundToggle component
+ */
+export type ChatSoundToggleProps = {
+    /**
+     * The sound system instance
+     */
+    soundSystem: ChatSoundSystem;
+    /**
+     * Optional CSS class name
+     */
+    className?: string;
+};
+/**
+ * ChatSoundToggle component
+ *
+ * Renders a toggle button/checkbox to enable/disable chat sounds.
+ * The state is persisted in localStorage via the SoundSystem.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function ChatSoundToggle(props: ChatSoundToggleProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/Chat/LlmChat/FriendlyErrorMessage.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Error types for LlmChat component
+ *
+ * This is a minimal type definition for use in the Promptbook Engine component.
+ * The full implementation is in the Agent Server.
+ */
+export type FriendlyErrorMessage = {
+    /**
+     * @@@
+     */
+    title: string;
+    /**
+     * @@@
+     */
+    message: string;
+    /**
+     * @@@
+     */
+    canRetry: boolean;
+};

package/esm/typings/src/book-components/Chat/LlmChat/LlmChatProps.d.ts

@@ -62,4 +62,12 @@ export type LlmChatProps = Omit<ChatProps, 'messages' | 'onMessage' | 'onChange'
      * e.g., { "web_search": "Searching the web..." }
      */
     readonly toolTitles?: Record<string, string>;
+    /**
+     * Optional custom error handler that will be called when an error occurs during chat.
+     * If not provided, errors will be displayed as messages in the chat.
+     *
+     * @param error - The error that occurred
+     * @param retry - Function to retry the last failed message
+     */
+    onError?(error: unknown, retry: () => void): void;
 };

package/esm/typings/src/book-components/Chat/SourceChip/SourceChip.d.ts

@@ -0,0 +1,35 @@
+import type { ParsedCitation } from '../utils/parseCitationsFromContent';
+/**
+ * Props for SourceChip component
+ */
+export type SourceChipProps = {
+    /**
+     * Citation data to display
+     */
+    citation: ParsedCitation;
+    /**
+     * Click handler
+     */
+    onClick?: (citation: ParsedCitation) => void;
+    /**
+     * Additional CSS class name
+     */
+    className?: string;
+};
+/**
+ * SourceChip component - displays a chip with source document information
+ *
+ * This component is used to display RAG source citations in chat messages.
+ * It displays the source document name and citation ID.
+ *
+ * @example
+ * ```tsx
+ * <SourceChip
+ *   citation={{ id: '5:13', source: 'document.pdf' }}
+ *   onClick={(citation) => console.log('clicked', citation)}
+ * />
+ * ```
+ *
+ * @private utility of `ChatMessageItem` component
+ */
+export declare function SourceChip({ citation, onClick, className }: SourceChipProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/Chat/SourceChip/index.d.ts

@@ -0,0 +1,2 @@
+export { SourceChip } from './SourceChip';
+export type { SourceChipProps } from './SourceChip';

package/esm/typings/src/book-components/Chat/effects/ChatEffectsSystem.d.ts

@@ -0,0 +1,14 @@
+import type { ChatEffectsSystemProps } from './types/ChatEffectsSystemProps';
+/**
+ * ChatEffectsSystem component
+ * Monitors chat messages and triggers visual effects based on emoji content
+ *
+ * This component:
+ * - Tracks which messages have already been processed
+ * - Detects emojis in new agent messages
+ * - Triggers appropriate effects (confetti, hearts, etc.)
+ * - Handles effect lifecycle (creation, completion, cleanup)
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function ChatEffectsSystem(props: ChatEffectsSystemProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/Chat/effects/components/ConfettiEffect.d.ts

@@ -0,0 +1,18 @@
+type ConfettiEffectProps = {
+    /**
+     * Unique identifier for this effect instance
+     */
+    effectId: string;
+    /**
+     * Callback when the effect completes
+     */
+    onComplete?: () => void;
+};
+/**
+ * Confetti effect component
+ * Renders falling confetti particles from the top of the screen
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function ConfettiEffect(props: ConfettiEffectProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/esm/typings/src/book-components/Chat/effects/components/HeartsEffect.d.ts

@@ -0,0 +1,18 @@
+type HeartsEffectProps = {
+    /**
+     * Unique identifier for this effect instance
+     */
+    effectId: string;
+    /**
+     * Callback when the effect completes
+     */
+    onComplete?: () => void;
+};
+/**
+ * Hearts effect component
+ * Renders floating hearts that rise from the bottom of the screen
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function HeartsEffect(props: HeartsEffectProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/esm/typings/src/book-components/Chat/effects/configs/defaultEffectConfigs.d.ts

@@ -0,0 +1,7 @@
+import type { ChatEffectConfig } from '../types/ChatEffectConfig';
+/**
+ * Default effect configurations for common chat emojis
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const defaultEffectConfigs: ReadonlyArray<ChatEffectConfig>;

package/esm/typings/src/book-components/Chat/effects/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Chat effects system exports
+ *
+ * @packageDocumentation
+ */
+export { ChatEffectsSystem } from './ChatEffectsSystem';
+export { ConfettiEffect } from './components/ConfettiEffect';
+export { HeartsEffect } from './components/HeartsEffect';
+export { defaultEffectConfigs } from './configs/defaultEffectConfigs';
+export type { ChatEffect } from './types/ChatEffect';
+export type { ChatEffectConfig } from './types/ChatEffectConfig';
+export type { ChatEffectsSystemProps } from './types/ChatEffectsSystemProps';
+export type { ChatEffectType } from './types/ChatEffectType';
+export { detectEffects } from './utils/detectEffects';
+/**
+ * TODO: !!!!! To rules: Do not create index files that re-ex-port from multiple files, import directly instead or use full register
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-components/Chat/effects/types/ChatEffect.d.ts

@@ -0,0 +1,20 @@
+import type { ChatEffectType } from './ChatEffectType';
+/**
+ * Represents a chat effect instance
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type ChatEffect = {
+    /**
+     * Unique identifier for this effect instance
+     */
+    id: string;
+    /**
+     * Type of effect
+     */
+    type: ChatEffectType;
+    /**
+     * Timestamp when the effect was triggered
+     */
+    timestamp: number;
+};

package/esm/typings/src/book-components/Chat/effects/types/ChatEffectConfig.d.ts

@@ -0,0 +1,21 @@
+import type { ChatEffectType } from './ChatEffectType';
+/**
+ * Configuration for a chat effect trigger
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type ChatEffectConfig = {
+    /**
+     * Emoji or pattern that triggers this effect
+     */
+    trigger: string | RegExp;
+    /**
+     * Type of effect to trigger
+     */
+    effectType: ChatEffectType;
+    /**
+     * Whether to match all heart emojis (❤️, 💙, 💚, etc.)
+     * Only relevant for heart effects
+     */
+    matchAllHeartEmojis?: boolean;
+};

package/esm/typings/src/book-components/Chat/effects/types/ChatEffectType.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Types of chat effects that can be triggered
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type ChatEffectType = 'CONFETTI' | 'HEARTS';

package/esm/typings/src/book-components/Chat/effects/types/ChatEffectsSystemProps.d.ts

@@ -0,0 +1,32 @@
+import type { ChatSoundSystem } from '../../Chat/ChatProps';
+import type { ChatMessage } from '../../types/ChatMessage';
+import type { ChatEffectConfig } from './ChatEffectConfig';
+/**
+ * Props for the ChatEffectsSystem component
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type ChatEffectsSystemProps = {
+    /**
+     * Array of chat messages to monitor for effect triggers
+     */
+    messages: ReadonlyArray<ChatMessage>;
+    /**
+     * Array of effect configurations
+     * Defines which emojis/patterns trigger which effects
+     */
+    effectConfigs: ReadonlyArray<ChatEffectConfig>;
+    /**
+     * Optional filter function to determine if a message should trigger effects
+     * By default, only agent messages trigger effects
+     */
+    shouldTriggerEffect?: (message: ChatMessage) => boolean;
+    /**
+     * CSS class name for the effects container
+     */
+    className?: string;
+    /**
+     * Optional sound system to play sounds when effects are triggered
+     */
+    soundSystem?: ChatSoundSystem;
+};

package/esm/typings/src/book-components/Chat/effects/utils/detectEffects.d.ts

@@ -0,0 +1,12 @@
+import type { ChatMessage } from '../../types/ChatMessage';
+import type { ChatEffectConfig } from '../types/ChatEffectConfig';
+import type { ChatEffectType } from '../types/ChatEffectType';
+/**
+ * Detects which effects should be triggered based on message content
+ *
+ * @param message - The chat message to analyze
+ * @param effectConfigs - Array of effect configurations
+ * @returns Array of unique effect types to trigger
+ * @private utility function of Effects system
+ */
+export declare function detectEffects(message: ChatMessage, effectConfigs: ReadonlyArray<ChatEffectConfig>): ChatEffectType[];

package/esm/typings/src/book-components/Chat/types/ChatMessage.d.ts

@@ -66,6 +66,27 @@ export type ChatMessage = Omit<Message<id>, 'direction' | 'recipients' | 'thread
          */
         url: string;
     }>;
+    /**
+     * Optional source citations/annotations (from RAG systems like OpenAI Assistants)
+     */
+    readonly citations?: ReadonlyArray<{
+        /**
+         * The unique identifier for the citation (e.g., "5:13")
+         */
+        id: string;
+        /**
+         * The source document name (e.g., "document.pdf")
+         */
+        source: string;
+        /**
+         * Optional URL to the source document
+         */
+        url?: string;
+        /**
+         * Optional preview/excerpt from the source
+         */
+        excerpt?: string;
+    }>;
 };
 /**
  * TODO: Make all fields readonly