@promptbook/javascript 0.112.0-32 → 0.112.0-35

package/umd/src/book-components/Chat/Chat/chatCssClassNames.d.ts

@@ -36,6 +36,7 @@ export declare const chatCssClassDescriptions: Record<keyof typeof chatCssClassN
  *
  * @param suffix - Legacy chat class suffix.
  * @returns Legacy global class name prefixed with `chat-`.
+ *
  * @private Internal helper for backward-compatible chat selectors.
  */
 export declare function getChatCssClassName(suffix: string): string;

package/umd/src/book-components/Chat/Chat/constants.d.ts

@@ -1,5 +1,8 @@
 /**
+ * Constant for loading interactive image.
+ *
  * @deprecated use `isComplete` instead
+ *
  * @private util of `<Chat />`
  */
 export declare const LOADING_INTERACTIVE_IMAGE = "Loading...";
@@ -7,9 +10,7 @@ export declare const LOADING_INTERACTIVE_IMAGE = "Loading...";
  * [🚉] Avatar dimensions constant to prevent layout jumps and maintain DRY principle
  *
  * @deprecated use `isComplete` instead
+ *
  * @private util of `<Chat />`
  */
 export declare const AVATAR_SIZE = 40;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/book-components/Chat/Chat/createChatMessageToolCallRenderModel.d.ts

@@ -0,0 +1,76 @@
+import type { ToolCall } from '../../../types/ToolCall';
+import type { AgentChipData } from '../AgentChip';
+import type { ChatMessage } from '../types/ChatMessage';
+import { type TransitiveCitation } from '../utils/collectTeamToolCallSummary';
+import type { ChatProps } from './ChatProps';
+/**
+ * Status variants for tool call chips.
+ *
+ * @private internal helper of `<ChatMessageItem/>`
+ */
+export type ToolCallChipStatus = 'ongoing' | 'done' | 'error';
+/**
+ * Metadata rendered inside a single tool call chip.
+ *
+ * @private internal helper of `<ChatMessageItem/>`
+ */
+export type ToolCallChipEntry = {
+    /**
+     * Stable key for React rendering.
+     */
+    key: string;
+    /**
+     * Tool call represented by this chip.
+     */
+    toolCall: ToolCall;
+    /**
+     * Chip label text.
+     */
+    label: string;
+    /**
+     * Current status of the tool call.
+     */
+    status: ToolCallChipStatus;
+    /**
+     * Optional agent metadata for TEAM or transitive tool calls.
+     */
+    teamAgentData: AgentChipData | null;
+    /**
+     * Marks entries built for transitive tool calls.
+     */
+    isTransitive: boolean;
+};
+/**
+ * Precomputed tool-call UI data consumed by `<ChatMessageItem/>`.
+ *
+ * @private internal helper of `<ChatMessageItem/>`
+ */
+export type ChatMessageToolCallRenderModel = {
+    /**
+     * Tool call chips rendered below the message body.
+     */
+    readonly toolCallChips: ReadonlyArray<ToolCallChipEntry>;
+    /**
+     * Citations surfaced from nested teammate responses.
+     */
+    readonly transitiveCitations: ReadonlyArray<TransitiveCitation>;
+};
+/**
+ * Inputs used to derive the tool-call UI model for one chat message.
+ *
+ * @private internal helper of `<ChatMessageItem/>`
+ */
+export type CreateChatMessageToolCallRenderModelOptions = {
+    readonly message: ChatMessage;
+    readonly teammates?: ChatProps['teammates'];
+    readonly teamAgentProfiles?: ChatProps['teamAgentProfiles'];
+    readonly locale?: string;
+    readonly toolTitles?: ChatProps['toolTitles'];
+    readonly chatUiTranslations?: ChatProps['chatUiTranslations'];
+};
+/**
+ * Builds the tool-call render model used by `<ChatMessageItem/>`.
+ *
+ * @private internal helper of `<ChatMessageItem/>`
+ */
+export declare function createChatMessageToolCallRenderModel(options: CreateChatMessageToolCallRenderModelOptions): ChatMessageToolCallRenderModel;

package/umd/src/book-components/Chat/Chat/createProgressCardChecklistMarkdown.d.ts

@@ -0,0 +1,16 @@
+import type { ChatMessage } from '../types/ChatMessage';
+/**
+ * Converts one structured progress card payload into markdown checklist content.
+ *
+ * @param progressCard Structured progress card payload.
+ * @returns Markdown checklist rendered through the normal message markdown pipeline.
+ *
+ * @private internal helper of `<ChatMessageItem/>`
+ */
+export declare function createProgressCardChecklistMarkdown(progressCard: NonNullable<ChatMessage['progressCard']>): string;
+/**
+ * Returns true when one progress card should currently be rendered.
+ *
+ * @private internal helper of `<ChatMessageItem/>`
+ */
+export declare function isProgressCardVisible(progressCard: ChatMessage['progressCard']): progressCard is NonNullable<ChatMessage['progressCard']>;

package/umd/src/book-components/Chat/Chat/insertDictationChunk.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Produces insertion metadata for one dictated chunk.
+ *
+ * @private function of `useChatInputAreaDictation`
+ */
+export declare function insertDictationChunk(params: {
+    readonly currentValue: string;
+    readonly dictatedText: string;
+    readonly selectionStart: number;
+    readonly selectionEnd: number;
+    readonly shouldReplaceSelection: boolean;
+}): {
+    nextValue: string;
+    start: number;
+    caret: number;
+};

package/umd/src/book-components/Chat/Chat/learnDictationDictionary.d.ts

@@ -0,0 +1,7 @@
+import type { DictationDictionary } from './refineFinalDictationChunk';
+/**
+ * Learns correction pairs from one user-edited transcript chunk.
+ *
+ * @private function of `useChatInputAreaDictation`
+ */
+export declare function learnDictationDictionary(previousChunk: string, correctedChunk: string, previousDictionary: DictationDictionary): DictationDictionary;

package/umd/src/book-components/Chat/Chat/refineFinalDictationChunk.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Voice settings available for lightweight transcript refinement.
+ *
+ * @private function of `useChatInputAreaDictation`
+ */
+export type DictationRefinementSettings = {
+    readonly autoPunctuation: boolean;
+    readonly autoCapitalization: boolean;
+    readonly removeFillerWords: boolean;
+    readonly formatLists: boolean;
+    readonly whisperMode: boolean;
+};
+/**
+ * Dictionary map of corrected lower-case token to preferred token.
+ *
+ * @private function of `useChatInputAreaDictation`
+ */
+export type DictationDictionary = Readonly<Record<string, string>>;
+/**
+ * Fallback refinement settings when user has no saved preferences.
+ *
+ * @private function of `useChatInputAreaDictation`
+ */
+export declare const DEFAULT_DICTATION_SETTINGS: DictationRefinementSettings;
+/**
+ * Normalizes free-form transcript whitespace.
+ *
+ * @private function of `useChatInputAreaDictation`
+ */
+export declare function normalizeDictationWhitespace(text: string): string;
+/**
+ * Applies refinement settings and dictionary corrections to one final chunk.
+ *
+ * @private function of `useChatInputAreaDictation`
+ */
+export declare function refineFinalDictationChunk(rawChunk: string, settings: DictationRefinementSettings, dictionary: DictationDictionary): string;

package/umd/src/book-components/Chat/Chat/renderAdvancedToolCallDetails.d.ts

@@ -23,6 +23,7 @@ type AdvancedToolCallDetailsOptions = {
  * Renders a technical view with raw tool input/output payloads.
  *
  * @param options - Rendering options for advanced mode.
+ *
  * @private function of ChatToolCallModal
  */
 export declare function renderAdvancedToolCallDetails(options: AdvancedToolCallDetailsOptions): ReactElement;
@@ -34,6 +35,7 @@ export declare function renderAdvancedToolCallDetails(options: AdvancedToolCallD
  *
  * @param options - Rendering options for advanced mode.
  * @returns Markdown report content.
+ *
  * @private function of ChatToolCallModal
  */
 export declare function createAdvancedToolCallReportMarkdown(options: AdvancedToolCallDetailsOptions): string;
@@ -42,6 +44,7 @@ export declare function createAdvancedToolCallReportMarkdown(options: AdvancedTo
  *
  * @param toolCall - Tool call currently selected in the modal.
  * @returns Safe markdown filename.
+ *
  * @private function of ChatToolCallModal
  */
 export declare function createAdvancedToolCallReportFilename(toolCall: NonNullable<ChatMessage['toolCalls']>[number]): string;

package/umd/src/book-components/Chat/Chat/renderEmailToolCallDetails.d.ts

@@ -0,0 +1,27 @@
+import { type ReactElement } from 'react';
+import type { TODO_any } from '../../../utils/organization/TODO_any';
+/**
+ * Rendering options for email tool calls.
+ *
+ * @private function of ChatToolCallModal
+ */
+type RenderEmailToolCallDetailsOptions = {
+    /**
+     * Parsed tool call arguments.
+     */
+    args: Record<string, TODO_any>;
+    /**
+     * Parsed tool result payload.
+     */
+    resultRaw: TODO_any;
+};
+/**
+ * Renders the email-specific tool call detail view.
+ *
+ * @param options - Email tool call data.
+ * @returns Email preview UI.
+ *
+ * @private function of ChatToolCallModal
+ */
+export declare function renderEmailToolCallDetails(options: RenderEmailToolCallDetailsOptions): ReactElement;
+export {};

package/umd/src/book-components/Chat/Chat/renderMemoryToolCallDetails.d.ts

@@ -0,0 +1,32 @@
+import { type ReactElement } from 'react';
+import type { TODO_any } from '../../../utils/organization/TODO_any';
+import type { ChatMessage } from '../types/ChatMessage';
+/**
+ * Rendering options for the memory-specific tool call view.
+ *
+ * @private function of ChatToolCallModal
+ */
+type RenderMemoryToolCallDetailsOptions = {
+    /**
+     * Raw tool call payload.
+     */
+    toolCall: NonNullable<ChatMessage['toolCalls']>[number];
+    /**
+     * Resolved tool call arguments.
+     */
+    args: Record<string, TODO_any>;
+    /**
+     * Parsed tool call result.
+     */
+    resultRaw: TODO_any;
+};
+/**
+ * Renders a friendly memory summary screen when a MEMORY tool call is selected.
+ *
+ * @param options - View fragments required to render the memory modal.
+ * @returns Memory-specific modal JSX or `null` when the tool is unrelated.
+ *
+ * @private function of ChatToolCallModal
+ */
+export declare function renderMemoryToolCallDetails(options: RenderMemoryToolCallDetailsOptions): ReactElement | null;
+export {};

package/umd/src/book-components/Chat/Chat/renderPopupToolCallDetails.d.ts

@@ -0,0 +1,33 @@
+import { type ReactElement } from 'react';
+import type { TODO_any } from '../../../utils/organization/TODO_any';
+import type { WithTake } from '../../../utils/take/interfaces/ITakeChain';
+import { Color } from '../../../utils/color/Color';
+/**
+ * Rendering options for popup tool calls.
+ *
+ * @private function of ChatToolCallModal
+ */
+type RenderPopupToolCallDetailsOptions = {
+    /**
+     * Parsed tool call arguments.
+     */
+    args: Record<string, TODO_any>;
+    /**
+     * Parsed tool result payload.
+     */
+    resultRaw: TODO_any;
+    /**
+     * Chat button color used for the CTA.
+     */
+    buttonColor: WithTake<Color>;
+};
+/**
+ * Renders the popup-specific tool call detail view.
+ *
+ * @param options - Popup tool call data.
+ * @returns Popup preview UI.
+ *
+ * @private function of ChatToolCallModal
+ */
+export declare function renderPopupToolCallDetails(options: RenderPopupToolCallDetailsOptions): ReactElement;
+export {};

package/umd/src/book-components/Chat/Chat/renderRunBrowserToolCallDetails.d.ts

@@ -0,0 +1,32 @@
+import { type ReactElement } from 'react';
+import type { TODO_any } from '../../../utils/organization/TODO_any';
+import type { ChatMessage } from '../types/ChatMessage';
+/**
+ * Rendering options for the browser replay view.
+ *
+ * @private function of ChatToolCallModal
+ */
+type RenderRunBrowserToolCallDetailsOptions = {
+    /**
+     * Tool call being rendered.
+     */
+    toolCall: NonNullable<ChatMessage['toolCalls']>[number];
+    /**
+     * Parsed tool call arguments.
+     */
+    args: Record<string, TODO_any>;
+    /**
+     * Parsed tool result payload.
+     */
+    resultRaw: TODO_any;
+};
+/**
+ * Renders a visual replay view for `run_browser` tool calls.
+ *
+ * @param options - Parsed browser tool details needed by the modal.
+ * @returns Visual browser replay content.
+ *
+ * @private function of ChatToolCallModal
+ */
+export declare function renderRunBrowserToolCallDetails(options: RenderRunBrowserToolCallDetailsOptions): ReactElement;
+export {};

package/umd/src/book-components/Chat/Chat/renderSearchToolCallDetails.d.ts

@@ -0,0 +1,32 @@
+import { type ReactElement } from 'react';
+import type { TODO_any } from '../../../utils/organization/TODO_any';
+import type { ChatMessage } from '../types/ChatMessage';
+/**
+ * Rendering options for search tool calls.
+ *
+ * @private function of ChatToolCallModal
+ */
+type RenderSearchToolCallDetailsOptions = {
+    /**
+     * Tool call being rendered.
+     */
+    toolCall: NonNullable<ChatMessage['toolCalls']>[number];
+    /**
+     * Parsed tool call arguments.
+     */
+    args: Record<string, TODO_any>;
+    /**
+     * Parsed tool result payload.
+     */
+    resultRaw: TODO_any;
+};
+/**
+ * Renders the search-specific tool call detail view.
+ *
+ * @param options - Search tool call data.
+ * @returns Search results or pending state UI.
+ *
+ * @private function of ChatToolCallModal
+ */
+export declare function renderSearchToolCallDetails(options: RenderSearchToolCallDetailsOptions): ReactElement;
+export {};

package/umd/src/book-components/Chat/Chat/renderSelfLearningToolCallDetails.d.ts

@@ -0,0 +1,39 @@
+import { type ReactElement } from 'react';
+import { Color } from '../../../utils/color/Color';
+import type { TODO_any } from '../../../utils/organization/TODO_any';
+import type { WithTake } from '../../../utils/take/interfaces/ITakeChain';
+import type { ChatParticipant } from '../types/ChatParticipant';
+import type { ChatMessage } from '../types/ChatMessage';
+/**
+ * Rendering options for self-learning tool calls.
+ *
+ * @private function of ChatToolCallModal
+ */
+type RenderSelfLearningToolCallDetailsOptions = {
+    /**
+     * Tool call being rendered.
+     */
+    toolCall: NonNullable<ChatMessage['toolCalls']>[number];
+    /**
+     * Parsed tool result payload.
+     */
+    resultRaw: TODO_any;
+    /**
+     * Optional agent metadata used for the header avatars.
+     */
+    agentParticipant?: ChatParticipant;
+    /**
+     * Fallback color used when participant metadata is incomplete.
+     */
+    buttonColor: WithTake<Color>;
+};
+/**
+ * Renders the self-learning-specific tool call detail view.
+ *
+ * @param options - Self-learning tool call data.
+ * @returns Self-learning summary UI.
+ *
+ * @private function of ChatToolCallModal
+ */
+export declare function renderSelfLearningToolCallDetails(options: RenderSelfLearningToolCallDetailsOptions): ReactElement;
+export {};

package/umd/src/book-components/Chat/Chat/renderTimeToolCallDetails.d.ts

@@ -0,0 +1,39 @@
+import { type ReactElement } from 'react';
+import type { TODO_any } from '../../../utils/organization/TODO_any';
+/**
+ * Rendering options for time tool calls.
+ *
+ * @private function of ChatToolCallModal
+ */
+type RenderTimeToolCallDetailsOptions = {
+    /**
+     * Parsed tool call arguments.
+     */
+    args: Record<string, TODO_any>;
+    /**
+     * Parsed tool result payload.
+     */
+    resultRaw: TODO_any;
+    /**
+     * Timestamp of the tool call itself.
+     */
+    toolCallDate: Date | null;
+    /**
+     * Optional locale override used for date formatting.
+     */
+    locale?: string;
+    /**
+     * Optional translation overrides.
+     */
+    chatUiTranslations?: import('./ChatProps').ChatUiTranslations;
+};
+/**
+ * Renders the time-specific tool call detail view.
+ *
+ * @param options - Time tool call data.
+ * @returns Time visualization UI.
+ *
+ * @private function of ChatToolCallModal
+ */
+export declare function renderTimeToolCallDetails(options: RenderTimeToolCallDetailsOptions): ReactElement;
+export {};

package/umd/src/book-components/Chat/Chat/renderTimeoutToolCallDetails.d.ts

@@ -0,0 +1,47 @@
+import { type ReactElement } from 'react';
+import type { TODO_any } from '../../../utils/organization/TODO_any';
+/**
+ * Rendering options for timeout tool calls.
+ *
+ * @private function of ChatToolCallModal
+ */
+type RenderTimeoutToolCallDetailsOptions = {
+    /**
+     * Tool name used to resolve timeout presentation details.
+     */
+    toolCallName: string;
+    /**
+     * Parsed tool call arguments.
+     */
+    args: Record<string, TODO_any>;
+    /**
+     * Parsed tool result payload.
+     */
+    resultRaw: TODO_any;
+    /**
+     * Timestamp of the tool call itself.
+     */
+    toolCallDate: Date | null;
+    /**
+     * Optional callback for switching to advanced mode.
+     */
+    onRequestAdvancedView?: () => void;
+    /**
+     * Optional locale override used for date formatting.
+     */
+    locale?: string;
+    /**
+     * Optional translation overrides.
+     */
+    chatUiTranslations?: import('./ChatProps').ChatUiTranslations;
+};
+/**
+ * Renders the timeout-specific tool call detail view.
+ *
+ * @param options - Timeout tool call data.
+ * @returns Timeout visualization UI.
+ *
+ * @private function of ChatToolCallModal
+ */
+export declare function renderTimeoutToolCallDetails(options: RenderTimeoutToolCallDetailsOptions): ReactElement;
+export {};

package/umd/src/book-components/Chat/Chat/renderToolCallClockPanel.d.ts

@@ -0,0 +1,34 @@
+import { type ReactElement } from 'react';
+/**
+ * Configuration for the shared clock panel used by time and timeout popups.
+ *
+ * @private function of ChatToolCallModal
+ */
+type RenderToolCallClockPanelOptions = {
+    /**
+     * Date rendered by the analog clock and local labels.
+     */
+    date: Date;
+    /**
+     * Optional relative label.
+     */
+    relativeLabel?: string | null;
+    /**
+     * Optional timezone label shown below the date.
+     */
+    timezoneLabel?: string | null;
+    /**
+     * Optional BCP-47 locale string used to format the local time display.
+     */
+    locale?: string;
+};
+/**
+ * Renders a shared analog-clock panel used by time and timeout tool views.
+ *
+ * @param options - Clock panel rendering options.
+ * @returns Clock section with local date/time labels.
+ *
+ * @private function of ChatToolCallModal
+ */
+export declare function renderToolCallClockPanel(options: RenderToolCallClockPanelOptions): ReactElement;
+export {};

package/umd/src/book-components/Chat/Chat/renderToolCallDetails.d.ts

@@ -1,8 +1,8 @@
 import { type ReactElement } from 'react';
-import { Color } from '../../../utils/color/Color';
 import type { WithTake } from '../../../utils/take/interfaces/ITakeChain';
 import type { ChatMessage } from '../types/ChatMessage';
 import type { ChatParticipant } from '../types/ChatParticipant';
+import { Color } from '../../../utils/color/Color';
 /**
  * Options for rendering a tool call detail view.
  *
@@ -31,7 +31,6 @@ type ToolCallDetailsOptions = {
     onRequestAdvancedView?: () => void;
     /**
      * Optional BCP-47 locale string used to format time labels.
-     * When omitted the browser/OS default locale is used.
      */
     locale?: string;
     /**
@@ -43,6 +42,8 @@ type ToolCallDetailsOptions = {
  * Renders the detail view for a single tool call.
  *
  * @param options - Rendering options for the tool call.
+ * @returns Simple tool-call detail JSX.
+ *
  * @private function of ChatToolCallModal
  */
 export declare function renderToolCallDetails(options: ToolCallDetailsOptions): ReactElement;

package/umd/src/book-components/Chat/Chat/renderToolCallProgressPlaceholder.d.ts

@@ -0,0 +1,30 @@
+import { type ReactElement } from 'react';
+/**
+ * Rendering options for the shared pending-state placeholder card.
+ *
+ * @private function of ChatToolCallModal
+ */
+type RenderToolCallProgressPlaceholderOptions = {
+    /**
+     * Title displayed at the top of the placeholder.
+     */
+    title: string;
+    /**
+     * Supporting message explaining the current state.
+     */
+    message: string;
+    /**
+     * Optional badge label shown in the header.
+     */
+    badgeLabel?: string;
+};
+/**
+ * Renders a shared placeholder card for pending and partial tool-call details.
+ *
+ * @param options - Placeholder copy and optional badge label.
+ * @returns Placeholder JSX.
+ *
+ * @private function of ChatToolCallModal
+ */
+export declare function renderToolCallProgressPlaceholder(options: RenderToolCallProgressPlaceholderOptions): ReactElement;
+export {};

package/umd/src/book-components/Chat/Chat/renderWalletCredentialToolCallDetails.d.ts

@@ -0,0 +1,27 @@
+import { type ReactElement } from 'react';
+import type { WalletCredentialToolCallResult } from '../utils/walletCredentialToolCall';
+/**
+ * Rendering options for wallet credential tool calls.
+ *
+ * @private function of ChatToolCallModal
+ */
+type RenderWalletCredentialToolCallDetailsOptions = {
+    /**
+     * Safe credential usage metadata.
+     */
+    credential: WalletCredentialToolCallResult;
+    /**
+     * Optional timestamp of the action.
+     */
+    toolCallDate: Date | null;
+};
+/**
+ * Renders a friendly wallet-credential usage summary for non-technical users.
+ *
+ * @param options - Credential payload and optional timestamp.
+ * @returns Credential details section for the tool modal.
+ *
+ * @private function of ChatToolCallModal
+ */
+export declare function renderWalletCredentialToolCallDetails(options: RenderWalletCredentialToolCallDetailsOptions): ReactElement;
+export {};

package/umd/src/book-components/Chat/Chat/resolveSpeechRecognitionUiDescriptor.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Runtime voice UI states shown on the primary microphone control.
+ *
+ * @private function of `useChatInputAreaDictation`
+ */
+export type DictationUiState = 'idle' | 'listening' | 'processing' | 'error' | 'disabled';
+/**
+ * Visual tone used by the floating speech-status bubble.
+ *
+ * @private function of `useChatInputAreaDictation`
+ */
+export type SpeechStatusBubbleTone = 'neutral' | 'recording' | 'processing' | 'error';
+/**
+ * UI metadata derived from the current speech-recognition state.
+ *
+ * @private function of `useChatInputAreaDictation`
+ */
+export type SpeechRecognitionUiDescriptor = {
+    readonly buttonTitle: string;
+    readonly bubbleText?: string;
+    readonly bubbleTone?: SpeechStatusBubbleTone;
+    readonly isButtonActive: boolean;
+    readonly isButtonDisabled: boolean;
+};
+/**
+ * Resolves voice-button and floating-bubble UI from a speech-recognition state.
+ *
+ * @private function of `useChatInputAreaDictation`
+ */
+export declare function resolveSpeechRecognitionUiDescriptor(state: DictationUiState): SpeechRecognitionUiDescriptor;

package/umd/src/book-components/Chat/Chat/resolveToolCallProgressMessage.d.ts

@@ -0,0 +1,10 @@
+import type { ChatMessage } from '../types/ChatMessage';
+/**
+ * Maps tool-call state into friendly running copy used by simple modal sections.
+ *
+ * @param toolCall - Tool call currently rendered in the modal.
+ * @returns Friendly progress message for the current tool state.
+ *
+ * @private function of ChatToolCallModal
+ */
+export declare function resolveToolCallProgressMessage(toolCall: NonNullable<ChatMessage['toolCalls']>[number]): string;