@promptbook/types 0.105.0-21 → 0.105.0-26

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

@@ -1,4 +1,5 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { getAllCommitmentsToolFunctionsForBrowser } from '../commitments/_common/getAllCommitmentsToolFunctionsForBrowser';
 import { SimplePromptInterfaceTools } from '../dialogs/simple-prompt/SimplePromptInterfaceTools';
 import { $provideScrapersForBrowser } from '../scrapers/_common/register/$provideScrapersForBrowser';
 import { BrowserSpeechRecognition } from '../speech-recognition/BrowserSpeechRecognition';
@@ -9,6 +10,7 @@ import { $induceBookDownload } from '../utils/files/$induceBookDownload';
 import { $induceFileDownload } from '../utils/files/$induceFileDownload';
 import { ObjectUrl } from '../utils/files/ObjectUrl';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export { getAllCommitmentsToolFunctionsForBrowser };
 export { SimplePromptInterfaceTools };
 export { $provideScrapersForBrowser };
 export { BrowserSpeechRecognition };

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,6 +9,8 @@ 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';
@@ -18,14 +20,18 @@ import type { ChatEffectsSystemProps } from '../book-components/Chat/effects/typ
 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';
@@ -66,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';
@@ -398,6 +403,8 @@ 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 };
@@ -407,14 +414,18 @@ 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 };
@@ -455,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/_packages/utils.index.d.ts

@@ -9,6 +9,7 @@ import { isValidCsvString } from '../formats/csv/utils/isValidCsvString';
 import { isValidJsonString } from '../formats/json/utils/isValidJsonString';
 import { jsonParse } from '../formats/json/utils/jsonParse';
 import { isValidXmlString } from '../formats/xml/utils/isValidXmlString';
+import { PromptString } from '../pipeline/prompt-notation';
 import { prompt } from '../pipeline/prompt-notation';
 import { promptTemplate } from '../pipeline/prompt-notation';
 import { $detectRuntimeEnvironment } from '../utils/environment/$detectRuntimeEnvironment';
@@ -99,6 +100,7 @@ export { isValidCsvString };
 export { isValidJsonString };
 export { jsonParse };
 export { isValidXmlString };
+export { PromptString };
 export { prompt };
 export { promptTemplate };
 export { $detectRuntimeEnvironment };

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,11 +39,33 @@ 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?: TeammatesMap;
     /**
      * 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;
 };
+/**
+ * Metadata for a teammate agent tool.
+ */
+type TeammateMetadata = {
+    url: string;
+    label?: string;
+    instructions?: string;
+    toolName: string;
+};
+/**
+ * Lookup map of teammate metadata by tool name.
+ */
+type TeammatesMap = Record<string, TeammateMetadata>;
 /**
  * Renders a single chat message item with avatar, content, buttons, and rating.
  *

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

@@ -169,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.

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/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

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

@@ -0,0 +1,12 @@
+/**
+ * Builds a TEAM tool name from a teammate agent URL.
+ *
+ * @private utility of chat components
+ */
+export declare function createTeamToolNameFromUrl(url: string): string;
+/**
+ * Checks whether a tool name belongs to a TEAM tool.
+ *
+ * @private utility of chat components
+ */
+export declare function isTeamToolName(name: string): boolean;

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

@@ -1,7 +1,21 @@
 import type { ToolCall } from '../../../types/ToolCall';
+import type { AgentChipData } from '../AgentChip';
 /**
  * Utility to format tool call information for user-friendly display.
  */
+/**
+ * Tool call chiplet information including agent data for team tools
+ */
+export type ToolCallChipletInfo = {
+    /**
+     * Display text for the chiplet
+     */
+    text: string;
+    /**
+     * Agent data for team tools (if applicable)
+     */
+    agentData?: AgentChipData;
+};
 /**
  * Technical to user-friendly tool names and emojis
  *
@@ -14,6 +28,13 @@ export declare const TOOL_TITLES: Record<string, {
 /**
  * Gets the user-friendly text for a tool call chiplet.
  *
+ * @deprecated Use getToolCallChipletInfo instead which returns both text and agent data
  * @private [🧠] Maybe public?
  */
 export declare function getToolCallChipletText(toolCall: ToolCall): string;
+/**
+ * Gets the chiplet information including text and agent data (for team tools).
+ *
+ * @private [🧠] Maybe public?
+ */
+export declare function getToolCallChipletInfo(toolCall: ToolCall): ToolCallChipletInfo;

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

@@ -0,0 +1,69 @@
+import type { string_url, string_url_image } from '../../../types/typeAliases';
+/**
+ * Input data for resolving agent profiles.
+ * @private
+ */
+export type AgentProfileInput = {
+    url: string_url;
+    label?: string;
+    imageUrl?: string_url_image;
+    publicUrl?: string_url;
+};
+/**
+ * Resolved agent profile data for UI usage.
+ * @private
+ */
+export type AgentProfileData = {
+    label: string;
+    imageUrl: string_url_image | null;
+};
+/**
+ * Extracts agent name from URL.
+ * @private
+ */
+export declare function extractAgentNameFromUrl(url: string): string;
+/**
+ * Determines whether a label looks like an autogenerated identifier.
+ * @private
+ */
+export declare function isLikelyGeneratedId(label: string): boolean;
+/**
+ * Resolves the initial label for an agent without exposing generated IDs.
+ * @private
+ */
+export declare function resolveInitialAgentLabel(agent: AgentProfileInput): string;
+/**
+ * Picks the best available label from profile data without exposing IDs.
+ * @private
+ */
+export declare function resolvePreferredAgentLabel(candidates: Array<string | undefined>, fallback: string): string;
+/**
+ * Resolves the agents server base URL from the agent URL or provided public URL.
+ * @private
+ */
+export declare function resolveAgentsServerUrl(agentUrl: string, publicUrl?: string_url): string | null;
+/**
+ * Resolves the profile image URL, handling relative URLs when needed.
+ * @private
+ */
+export declare function resolveProfileImageUrl(profileImageUrl: string_url_image | undefined, agentUrl: string_url, publicUrl?: string_url): string_url_image | null;
+/**
+ * Builds a placeholder image URL for the agent when no profile image is available.
+ * @private
+ */
+export declare function resolvePlaceholderImageUrl(agent: AgentProfileInput): string_url_image | null;
+/**
+ * Returns true when a profile fetch would likely improve the label or image.
+ * @private
+ */
+export declare function shouldFetchAgentProfile(agent: AgentProfileInput): boolean;
+/**
+ * Resolves fallback profile data without fetching remote metadata.
+ * @private
+ */
+export declare function resolveAgentProfileFallback(agent: AgentProfileInput): AgentProfileData;
+/**
+ * Loads agent profile data from the agent profile endpoint when needed.
+ * @private
+ */
+export declare function loadAgentProfile(agent: AgentProfileInput): Promise<AgentProfileData>;

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

@@ -0,0 +1,53 @@
+import type { ChatMessage } from '../types/ChatMessage';
+/**
+ * Type representing a parsed citation from RAG sources
+ */
+export type ParsedCitation = {
+    /**
+     * 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;
+};
+/**
+ * Parses OpenAI Assistant-style citations from message content
+ * Matches patterns like: 【5:13†document.pdf】
+ *
+ * @param content - The markdown content that may contain citations
+ * @returns Array of parsed citations
+ *
+ * @private utility for internal use
+ */
+export declare function parseCitationsFromContent(content: string): ParsedCitation[];
+/**
+ * Removes citation markers from content and returns clean text
+ *
+ * @param content - The markdown content with citations
+ * @returns Content with citation markers removed
+ *
+ * @private utility for internal use
+ */
+export declare function stripCitationsFromContent(content: string): string;
+/**
+ * Extracts citations from a chat message if not already present
+ *
+ * @param message - The chat message to extract citations from
+ * @returns The message with citations array populated
+ *
+ * @private utility for internal use
+ */
+export declare function extractCitationsFromMessage(message: ChatMessage): ChatMessage;
+/**
+ * TODO: Maybe spread into multiple files
+ */

package/esm/typings/src/book-components/icons/EmailIcon.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Props for the EmailIcon component.
+ */
+type EmailIconProps = {
+    size?: number;
+    color?: string;
+};
+/**
+ * Renders an email/envelope icon.
+ *
+ * @param props - SVG properties augmented with an optional `size`
+ * @private internal subcomponent used by various components
+ */
+export declare function EmailIcon({ size, color }: EmailIconProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/esm/typings/src/commitments/TEMPLATE/TEMPLATE.d.ts

@@ -0,0 +1,44 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * TEMPLATE commitment definition
+ *
+ * The TEMPLATE commitment enforces a specific response structure or template
+ * that the agent must follow when generating responses. This helps ensure
+ * consistent message formatting across all agent interactions.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * TEMPLATE Always structure your response with: 1) Summary, 2) Details, 3) Next steps
+ * TEMPLATE Use the following format: **Question:** [user question] | **Answer:** [your answer]
+ * ```
+ *
+ * When used without content, it enables template mode which instructs the agent
+ * to follow any template patterns defined in other commitments or context.
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class TemplateCommitmentDefinition extends BaseCommitmentDefinition<'TEMPLATE' | 'TEMPLATES'> {
+    constructor(type?: 'TEMPLATE' | 'TEMPLATES');
+    /**
+     * Short one-line description of TEMPLATE.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for TEMPLATE commitment.
+     */
+    get documentation(): string;
+    /**
+     * TEMPLATE can be used with or without content.
+     */
+    get requiresContent(): boolean;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/TEMPLATE/TEMPLATE.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/commitments/USE_BROWSER/USE_BROWSER.d.ts

@@ -1,11 +1,17 @@
+import { string_javascript_name } from '../../_packages/types.index';
 import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * USE BROWSER commitment definition
  *
- * The `USE BROWSER` commitment indicates that the agent should utilize a web browser tool
+ * The `USE BROWSER` commitment indicates that the agent should utilize browser tools
  * to access and retrieve up-to-date information from the internet when necessary.
  *
+ * This commitment provides two levels of browser access:
+ * 1. One-shot URL fetching: Simple function to fetch and scrape URL content
+ * 2. Running browser: For complex tasks like scrolling, clicking, etc. (prepared but not active yet)
+ *
  * The content following `USE BROWSER` is ignored (similar to NOTE).
  *
  * Example usage in agent source:
@@ -38,8 +44,16 @@ export declare class UseBrowserCommitmentDefinition extends BaseCommitmentDefini
     /**
      * Gets human-readable titles for tool functions provided by this commitment.
      */
-    getToolTitles(): Record<string, string>;
+    getToolTitles(): Record<string_javascript_name, string>;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Gets the browser tool function implementations.
+     *
+     * This method automatically detects the environment and uses:
+     * - Server-side: Direct scraping via fetchUrlContent (Node.js)
+     * - Browser: Proxy through Agents Server API via fetchUrlContentViaBrowser
+     */
+    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/commitments/USE_BROWSER/fetchUrlContent.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Fetches and scrapes content from a URL (SERVER-SIDE ONLY)
+ *
+ * This function:
+ * 1. Fetches the URL content using promptbookFetch
+ * 2. Determines the content type (HTML, PDF, etc.)
+ * 3. Uses the appropriate scraper to convert to markdown
+ * 4. Returns the scraped markdown content
+ *
+ * @param url The URL to fetch and scrape
+ * @returns Markdown content from the URL
+ *
+ * @private internal utility for USE BROWSER commitment
+ *
+ * WARNING: This function should NOT be used directly in browser environments.
+ * For browser environments, use fetchUrlContentViaBrowser which proxies through
+ * the Agents Server API endpoint at /api/scrape
+ */
+export declare function fetchUrlContent(url: string): Promise<string>;
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/commitments/USE_BROWSER/fetchUrlContentViaBrowser.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Client-side safe wrapper for fetching URL content
+ *
+ * This function proxies requests to the Agents Server API endpoint for scraping,
+ * making it safe to use in browser environments.
+ *
+ * @param url The URL to fetch and scrape
+ * @param agentsServerUrl The base URL of the agents server (defaults to current origin)
+ * @returns Markdown content from the URL
+ *
+ * @private internal utility for USE BROWSER commitment
+ */
+export declare function fetchUrlContentViaBrowser(url: string, agentsServerUrl?: string): Promise<string>;

package/esm/typings/src/commitments/USE_EMAIL/USE_EMAIL.d.ts

@@ -0,0 +1,48 @@
+import { string_javascript_name } from '../../_packages/types.index';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * USE EMAIL commitment definition
+ *
+ * The `USE EMAIL` commitment enables the agent to send emails.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE EMAIL
+ * USE EMAIL Write always formal and polite emails, always greet.
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class UseEmailCommitmentDefinition extends BaseCommitmentDefinition<'USE EMAIL'> {
+    constructor();
+    get requiresContent(): boolean;
+    /**
+     * Short one-line description of USE EMAIL.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USE EMAIL commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Gets human-readable titles for tool functions provided by this commitment.
+     */
+    getToolTitles(): Record<string_javascript_name, string>;
+    /**
+     * Gets the `send_email` tool function implementation.
+     *
+     * Note: [??] This function has implementation both for browser and node, this is the proxied one for browser.
+     */
+    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/USE_EMAIL/resolveSendEmailToolForNode.d.ts

@@ -0,0 +1,11 @@
+import type { ToolFunction } from '../../_packages/types.index';
+/**
+ * Resolves the server-side implementation of the send_email tool for Node.js environments.
+ *
+ * This uses a lazy require so the core package can still load even if the Agents Server
+ * module is unavailable. When the server tool cannot be resolved, a fallback implementation
+ * throws a helpful error message.
+ *
+ * @private internal utility for USE EMAIL commitment
+ */
+export declare function resolveSendEmailToolForNode(): ToolFunction;

package/esm/typings/src/commitments/USE_EMAIL/sendEmailViaBrowser.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Client-side safe wrapper for sending emails.
+ *
+ * This function proxies requests to the Agents Server API endpoint for email queuing,
+ * making it safe to use in browser environments.
+ *
+ * @param args Email payload containing recipients, subject, and body
+ * @param agentsServerUrl The base URL of the agents server (defaults to current origin)
+ * @returns Result string from the server-side send_email tool
+ *
+ * @private internal utility for USE EMAIL commitment
+ */
+export declare function sendEmailViaBrowser(args: {
+    to: string[];
+    cc?: string[];
+    subject: string;
+    body: string;
+}, agentsServerUrl?: string): Promise<string>;

package/esm/typings/src/commitments/_common/commitmentToolFunctions.d.ts

@@ -0,0 +1,26 @@
+import { ToolFunction } from '../../_packages/types.index';
+import { string_javascript_name } from '../../types/typeAliases';
+/**
+ * Map of tool functions keyed by function name.
+ *
+ * @private internal helper for commitment tool registry
+ */
+export type CommitmentToolFunctions = Record<string_javascript_name, ToolFunction>;
+/**
+ * Collects tool functions from all commitment definitions.
+ *
+ * @returns Map of tool function implementations.
+ * @private internal helper for commitment tool registry
+ */
+export declare function collectCommitmentToolFunctions(): CommitmentToolFunctions;
+/**
+ * Creates a proxy that resolves tool functions on demand.
+ *
+ * @param getFunctions - Provider of current tool functions.
+ * @returns Proxy exposing tool functions as properties.
+ * @private internal helper for commitment tool registry
+ */
+export declare function createToolFunctionsProxy(getFunctions: () => CommitmentToolFunctions): CommitmentToolFunctions;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/_common/getAllCommitmentDefinitions.d.ts

@@ -0,0 +1,8 @@
+import type { CommitmentDefinition } from '../_base/CommitmentDefinition';
+/**
+ * Gets all available commitment definitions
+ * @returns Array of all commitment definitions
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getAllCommitmentDefinitions(): ReadonlyArray<CommitmentDefinition>;

package/esm/typings/src/commitments/_common/getAllCommitmentTypes.d.ts

@@ -0,0 +1,8 @@
+import type { BookCommitment } from '../_base/BookCommitment';
+/**
+ * Gets all available commitment types
+ * @returns Array of all commitment types
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getAllCommitmentTypes(): ReadonlyArray<BookCommitment>;

package/esm/typings/src/commitments/_common/getAllCommitmentsToolFunctionsForBrowser.d.ts

@@ -0,0 +1,9 @@
+import type { CommitmentToolFunctions } from './commitmentToolFunctions';
+/**
+ * Gets all function implementations provided by all commitments
+ *
+ * Note: This function is intended for browser use, there is also equivalent `getAllCommitmentsToolFunctionsForNode` for server use
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare function getAllCommitmentsToolFunctionsForBrowser(): CommitmentToolFunctions;

package/esm/typings/src/commitments/_common/getAllCommitmentsToolFunctionsForNode.d.ts

@@ -0,0 +1,13 @@
+import { type CommitmentToolFunctions } from './commitmentToolFunctions';
+/**
+ * Gets all function implementations provided by all commitments
+ *
+ * Note: This function is intended for server use, there is also equivalent `getAllCommitmentsToolFunctionsForBrowser` for browser use
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function getAllCommitmentsToolFunctionsForNode(): CommitmentToolFunctions;
+/**
+ * Note: [??] Code in this file should never be never released in packages that could be imported into browser environment
+ * TODO: [??] Unite `xxxForServer` and `xxxForNode` naming
+ */

package/esm/typings/src/commitments/_common/getAllCommitmentsToolTitles.d.ts

@@ -0,0 +1,7 @@
+import { string_javascript_name } from '../../types/typeAliases';
+/**
+ * Gets all tool titles provided by all commitments
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getAllCommitmentsToolTitles(): Record<string_javascript_name, string>;

package/esm/typings/src/commitments/_common/getCommitmentDefinition.d.ts

@@ -0,0 +1,10 @@
+import type { BookCommitment } from '../_base/BookCommitment';
+import type { CommitmentDefinition } from '../_base/CommitmentDefinition';
+/**
+ * Gets a commitment definition by its type
+ * @param type The commitment type to look up
+ * @returns The commitment definition or null if not found
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getCommitmentDefinition(type: BookCommitment): CommitmentDefinition | null;

package/esm/typings/src/commitments/_common/getGroupedCommitmentDefinitions.d.ts

@@ -0,0 +1,17 @@
+import { CommitmentDefinition } from '../_base/CommitmentDefinition';
+/**
+ * Grouped commitment definition
+ */
+type GroupedCommitmentDefinition = {
+    primary: CommitmentDefinition;
+    aliases: string[];
+};
+/**
+ * Gets all commitment definitions grouped by their aliases
+ *
+ * @returns Array of grouped commitment definitions
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getGroupedCommitmentDefinitions(): ReadonlyArray<GroupedCommitmentDefinition>;
+export {};

package/esm/typings/src/commitments/_common/isCommitmentSupported.d.ts

@@ -0,0 +1,9 @@
+import type { BookCommitment } from '../_base/BookCommitment';
+/**
+ * Checks if a commitment type is supported
+ * @param type The commitment type to check
+ * @returns True if the commitment type is supported
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function isCommitmentSupported(type: BookCommitment): boolean;

package/esm/typings/src/commitments/index.d.ts

@@ -1,7 +1,3 @@
-import type { BookCommitment } from './_base/BookCommitment';
-import type { CommitmentDefinition } from './_base/CommitmentDefinition';
-import { ToolFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
-import { string_javascript_name } from '../types/typeAliases';
 import { ActionCommitmentDefinition } from './ACTION/ACTION';
 import { ClosedCommitmentDefinition } from './CLOSED/CLOSED';
 import { ComponentCommitmentDefinition } from './COMPONENT/COMPONENT';
@@ -32,8 +28,10 @@ import { SampleCommitmentDefinition } from './SAMPLE/SAMPLE';
 import { ScenarioCommitmentDefinition } from './SCENARIO/SCENARIO';
 import { StyleCommitmentDefinition } from './STYLE/STYLE';
 import { TeamCommitmentDefinition } from './TEAM/TEAM';
+import { TemplateCommitmentDefinition } from './TEMPLATE/TEMPLATE';
 import { UseCommitmentDefinition } from './USE/USE';
 import { UseBrowserCommitmentDefinition } from './USE_BROWSER/USE_BROWSER';
+import { UseEmailCommitmentDefinition } from './USE_EMAIL/USE_EMAIL';
 import { UseImageGeneratorCommitmentDefinition } from './USE_IMAGE_GENERATOR/USE_IMAGE_GENERATOR';
 import { UseMcpCommitmentDefinition } from './USE_MCP/USE_MCP';
 import { UseSearchEngineCommitmentDefinition } from './USE_SEARCH_ENGINE/USE_SEARCH_ENGINE';
@@ -46,66 +44,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
  *
  * @private Use functions to access commitments instead of this array directly
  */
-export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, TeamCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseTimeCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
-/**
- * Gets a commitment definition by its type
- * @param type The commitment type to look up
- * @returns The commitment definition or null if not found
- *
- * @public exported from `@promptbook/core`
- */
-export declare function getCommitmentDefinition(type: BookCommitment): CommitmentDefinition | null;
-/**
- * Gets all available commitment definitions
- * @returns Array of all commitment definitions
- *
- * @public exported from `@promptbook/core`
- */
-export declare function getAllCommitmentDefinitions(): ReadonlyArray<CommitmentDefinition>;
-/**
- * Gets all available commitment types
- * @returns Array of all commitment types
- *
- * @public exported from `@promptbook/core`
- */
-export declare function getAllCommitmentTypes(): ReadonlyArray<BookCommitment>;
-/**
- * Checks if a commitment type is supported
- * @param type The commitment type to check
- * @returns True if the commitment type is supported
- *
- * @public exported from `@promptbook/core`
- */
-export declare function isCommitmentSupported(type: BookCommitment): boolean;
-/**
- * Grouped commitment definition
- *
- * @public exported from `@promptbook/core`
- */
-export type GroupedCommitmentDefinition = {
-    primary: CommitmentDefinition;
-    aliases: string[];
-};
-/**
- * Gets all commitment definitions grouped by their aliases
- *
- * @returns Array of grouped commitment definitions
- *
- * @public exported from `@promptbook/core`
- */
-export declare function getGroupedCommitmentDefinitions(): ReadonlyArray<GroupedCommitmentDefinition>;
-/**
- * Gets all function implementations provided by all commitments
- *
- * @public exported from `@promptbook/core`
- */
-export declare function getAllCommitmentsToolFunctions(): Record<string_javascript_name, ToolFunction>;
-/**
- * Gets all tool titles provided by all commitments
- *
- * @public exported from `@promptbook/core`
- */
-export declare function getAllCommitmentsToolTitles(): Record<string_javascript_name, string>;
+export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, TeamCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseTimeCommitmentDefinition, UseEmailCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
 /**
  * TODO: [🧠] Maybe create through standardized $register
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/constants.d.ts

@@ -116,6 +116,10 @@ export declare const LIMITS: {
  * @public exported from `@promptbook/core`
  */
 export declare const TIME_INTERVALS: {
+    /**
+         * Hundred milliseconds
+         */
+    readonly HUNDRED_MILLISECONDS: 100;
     /**
      * One second in milliseconds
      */

package/esm/typings/src/executables/$provideExecutablesForNode.d.ts

@@ -9,4 +9,5 @@ export declare function $provideExecutablesForNode(options?: PrepareAndScrapeOpt
 /**
  * TODO: [🧠] Allow to override the executables without need to call `locatePandoc` / `locateLibreoffice` in case of provided
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
  */

package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts

@@ -10,4 +10,5 @@ import type { ExecutionTools } from '../ExecutionTools';
 export declare function $provideExecutionToolsForNode(options?: PrepareAndScrapeOptions): Promise<ExecutionTools>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
  */

package/esm/typings/src/pipeline/prompt-notation.d.ts

@@ -1,4 +1,28 @@
 import type { string_prompt } from '../types/typeAliases';
+import type { really_unknown } from '../utils/organization/really_unknown';
+/**
+ * Prompt string wrapper to retain prompt context across interpolations.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare class PromptString extends String {
+    /**
+     * @param value Prompt content.
+     */
+    constructor(value: string_prompt);
+    /**
+     * Returns the prompt as a primitive string.
+     */
+    toString(): string_prompt;
+    /**
+     * Returns the prompt as a primitive string for implicit coercion.
+     */
+    valueOf(): string_prompt;
+    /**
+     * Ensures template literal coercion returns the raw string.
+     */
+    [Symbol.toPrimitive](): string_prompt;
+}
 /**
  * Tag function for notating a prompt as template literal
  *
@@ -9,10 +33,10 @@ import type { string_prompt } from '../types/typeAliases';
  *
  * @param strings
  * @param values
- * @returns the prompt string
+ * @returns prompt content wrapped as a PromptString
  * @public exported from `@promptbook/utils`
  */
-export declare function prompt(strings: TemplateStringsArray, ...values: Array<string>): string_prompt;
+export declare function prompt(strings: TemplateStringsArray, ...values: Array<really_unknown>): PromptString;
 /**
  * Tag function for notating a prompt as template literal
  *
@@ -26,6 +50,7 @@ export declare function prompt(strings: TemplateStringsArray, ...values: Array<s
  */
 export declare const promptTemplate: typeof prompt;
 /**
+ * TODO: Maybe split into multiple files
  * TODO: [🧠][🈴] Where is the best location for this file
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/pipeline/prompt-notation.test.d.ts

@@ -1,4 +1,4 @@
 export {};
 /**
- * TODO: [🧠][🈴] Where is the best location for this file
+ * TODO: [??][??] Where is the best location for this file
  */

package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts

@@ -9,4 +9,5 @@ import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeO
 export declare function $provideFilesystemForNode(options?: Pick<PrepareAndScrapeOptions, 'isVerbose'>): FilesystemTools;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
  */

package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts

@@ -10,4 +10,5 @@ import type { Scraper } from '../Scraper';
 export declare function $provideScrapersForNode(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<Scraper>>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
  */

package/esm/typings/src/scrapers/_common/register/$provideScriptingForNode.d.ts

@@ -8,4 +8,5 @@ import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeO
 export declare function $provideScriptingForNode(options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<ScriptExecutionTools>>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
  */

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.105.0-20`).
+ * It follows semantic versioning (e.g., `0.105.0-25`).
  *
  * @generated
  */

package/esm/typings/src/wizard/wizard.d.ts

@@ -2,10 +2,7 @@ import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { PipelineExecutorResult } from '../execution/PipelineExecutorResult';
 import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 import type { PipelineString } from '../pipeline/PipelineString';
-import type { InputParameters } from '../types/typeAliases';
-import type { string_filename } from '../types/typeAliases';
-import type { string_parameter_value } from '../types/typeAliases';
-import type { string_pipeline_url } from '../types/typeAliases';
+import type { InputParameters, string_filename, string_parameter_value, string_pipeline_url } from '../types/typeAliases';
 /**
  * Options for wizard methods
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.105.0-21",
+    "version": "0.105.0-26",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -92,6 +92,6 @@
     },
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.105.0-21"
+        "@promptbook/core": "0.105.0-26"
     }
 }