@promptbook/types 0.105.0-0 → 0.105.0-10

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

@@ -1,4 +1,6 @@
+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 SEARCH ENGINE commitment definition
@@ -32,6 +34,14 @@ export declare class UseSearchEngineCommitmentDefinition extends BaseCommitmentD
      */
     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 `web_search` tool function implementation.
+     */
+    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name

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

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

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

@@ -0,0 +1,44 @@
+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 TIME commitment definition
+ *
+ * The `USE TIME` commitment indicates that the agent should be able to determine the current date and time.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE TIME
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class UseTimeCommitmentDefinition extends BaseCommitmentDefinition<'USE TIME'> {
+    constructor();
+    /**
+     * Short one-line description of USE TIME.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USE TIME 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 `get_current_time` tool function implementation.
+     */
+    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

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

package/esm/typings/src/commitments/_base/BaseCommitmentDefinition.d.ts

@@ -1,4 +1,6 @@
 import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
+import { string_javascript_name } from '../../types/typeAliases';
 import type { CommitmentDefinition } from './CommitmentDefinition';
 /**
  * Base implementation of CommitmentDefinition that provides common functionality
@@ -61,4 +63,16 @@ export declare abstract class BaseCommitmentDefinition<TBookCommitment extends s
      * but can be useful for organizing and structuring the message during processing
      */
     protected addCommentSection(requirements: AgentModelRequirements, commentTitle: string, content: string, position?: 'beginning' | 'end'): AgentModelRequirements;
+    /**
+     * Gets tool function implementations provided by this commitment
+     *
+     * When the `applyToAgentModelRequirements` adds tools to the requirements, this method should return the corresponding function definitions.
+     */
+    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
+    /**
+     * Gets human-readable titles for tool functions provided by this commitment
+     *
+     * This is used in the UI to show a user-friendly name instead of the technical function name.
+     */
+    getToolTitles(): Record<string_javascript_name, string>;
 }

package/esm/typings/src/commitments/_base/CommitmentDefinition.d.ts

@@ -1,4 +1,6 @@
+import { string_javascript_name } from '../../_packages/types.index';
 import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
 /**
  * Definition of a commitment that can be applied to agent model requirements
  *
@@ -50,4 +52,16 @@ export type CommitmentDefinition = {
      * @returns Updated agent model requirements
      */
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Gets tool function implementations provided by this commitment
+     *
+     * When the `applyToAgentModelRequirements` adds tools to the requirements, this method should return the corresponding function definitions.
+     */
+    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
+    /**
+     * Gets human-readable titles for tool functions provided by this commitment
+     *
+     * This is used in the UI to show a user-friendly name instead of the technical function name.
+     */
+    getToolTitles(): Record<string_javascript_name, string>;
 };

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

@@ -1,5 +1,7 @@
 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';
@@ -7,8 +9,8 @@ import { DeleteCommitmentDefinition } from './DELETE/DELETE';
 import { DictionaryCommitmentDefinition } from './DICTIONARY/DICTIONARY';
 import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
 import { FromCommitmentDefinition } from './FROM/FROM';
-import { ImportCommitmentDefinition } from './IMPORT/IMPORT';
 import { GoalCommitmentDefinition } from './GOAL/GOAL';
+import { ImportCommitmentDefinition } from './IMPORT/IMPORT';
 import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
 import { LanguageCommitmentDefinition } from './LANGUAGE/LANGUAGE';
 import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
@@ -33,6 +35,7 @@ import { UseCommitmentDefinition } from './USE/USE';
 import { UseBrowserCommitmentDefinition } from './USE_BROWSER/USE_BROWSER';
 import { UseMcpCommitmentDefinition } from './USE_MCP/USE_MCP';
 import { UseSearchEngineCommitmentDefinition } from './USE_SEARCH_ENGINE/USE_SEARCH_ENGINE';
+import { UseTimeCommitmentDefinition } from './USE_TIME/USE_TIME';
 import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
 /**
  * Registry of all available commitment definitions
@@ -41,7 +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, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
+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, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseTimeCommitmentDefinition, 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
@@ -89,6 +92,18 @@ export type GroupedCommitmentDefinition = {
  * @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>;
 /**
  * TODO: [🧠] Maybe create through standardized $register
  * Note: [💞] Ignore a discrepancy between file name and entity name

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

@@ -63,6 +63,7 @@ export declare const PROMPTBOOK_SYNTAX_COLORS: {
     readonly SEPARATOR: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
     readonly COMMITMENT: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
     readonly PARAMETER: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+    readonly CODE_BLOCK: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
 };
 /**
  * Chat color of the Promptbook (in chat)

package/esm/typings/src/execution/LlmExecutionTools.d.ts

@@ -56,7 +56,9 @@ export type LlmExecutionTools = {
     /**
      * Calls a chat model with streaming
      */
-    callChatModelStream?(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
+    callChatModelStream?(prompt: Prompt, onProgress: (chunk: ChatPromptResult & {
+        isFinished?: boolean;
+    }) => void): Promise<ChatPromptResult>;
     /**
      * Calls a voice chat model
      */

package/esm/typings/src/import-plugins/$fileImportPlugins.d.ts

@@ -0,0 +1,7 @@
+import type { FileImportPlugin } from './FileImportPlugin';
+/**
+ * All available file import plugins
+ *
+ * @private [🥝] Maybe export the import plugins through some package
+ */
+export declare const $fileImportPlugins: ReadonlyArray<FileImportPlugin>;

package/esm/typings/src/import-plugins/AgentFileImportPlugin.d.ts

@@ -0,0 +1,7 @@
+import type { FileImportPlugin } from './FileImportPlugin';
+/**
+ * Plugin for importing agent books *(`.book` files)*
+ *
+ * @private [🥝] Maybe export the import plugins through some package
+ */
+export declare const AgentFileImportPlugin: FileImportPlugin;

package/esm/typings/src/import-plugins/FileImportPlugin.d.ts

@@ -0,0 +1,24 @@
+import type { string_mime_type } from '../types/typeAliases';
+/**
+ * Type for file import plugins
+ *
+ * Each plugin handles a specific set of MIME types or file extensions.
+ */
+export type FileImportPlugin = {
+    /**
+     * Unique name of the plugin
+     */
+    readonly name: string;
+    /**
+     * Checks if the plugin can handle the given MIME type or file extension
+     */
+    canImport(mimeType: string_mime_type): boolean;
+    /**
+     * Processes the file content and returns the string to be placed in the agent book
+     *
+     * @param content - The raw content of the file
+     * @param mimeType - The MIME type of the file
+     * @returns The processed content (e.g. wrapped in code block)
+     */
+    import(content: string, mimeType: string_mime_type): string | Promise<string>;
+};

package/esm/typings/src/import-plugins/JsonFileImportPlugin.d.ts

@@ -0,0 +1,7 @@
+import type { FileImportPlugin } from './FileImportPlugin';
+/**
+ * Plugin for importing JSON files
+ *
+ * @private [🥝] Maybe export the import plugins through some package
+ */
+export declare const JsonFileImportPlugin: FileImportPlugin;

package/esm/typings/src/import-plugins/TextFileImportPlugin.d.ts

@@ -0,0 +1,7 @@
+import type { FileImportPlugin } from './FileImportPlugin';
+/**
+ * Plugin for importing generic text files
+ *
+ * @private [🥝] Maybe export the import plugins through some package
+ */
+export declare const TextFileImportPlugin: FileImportPlugin;

package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts

@@ -4,9 +4,10 @@ import type { CacheLlmToolsOptions } from './CacheLlmToolsOptions';
  * Intercepts LLM tools and counts total usage of the tools
  *
  * Note: It can take extended `LlmExecutionTools` and cache the
+ * Note: Returns full proxy of all LLM tool properties and methods
  *
  * @param llmTools LLM tools to be intercepted with usage counting, it can contain extra methods like `totalUsage`
- * @returns LLM tools with same functionality with added total cost counting
+ * @returns Full proxy of LLM tools with same functionality with added caching
  * @public exported from `@promptbook/core`
  */
 export declare function cacheLlmTools<TLlmTools extends LlmExecutionTools>(llmTools: TLlmTools, options?: Partial<CacheLlmToolsOptions>): TLlmTools;

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/countUsage.d.ts

@@ -8,10 +8,10 @@ import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTot
  * in real-time through an observable.
  *
  * @param llmTools - The LLM tools to be intercepted and tracked
- * @returns An augmented version of the tools that includes usage tracking capabilities
+ * @returns Full proxy of the tools with added usage tracking capabilities
  * @public exported from `@promptbook/core`
  */
-export declare function countUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalUsage;
+export declare function countUsage<TLlmTools extends LlmExecutionTools>(llmTools: TLlmTools): TLlmTools & LlmExecutionToolsWithTotalUsage;
 /**
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
  * TODO: [🧠] Is there some meaningfull way how to test this util

package/esm/typings/src/llm-providers/agent/Agent.d.ts

@@ -42,7 +42,14 @@ export declare class Agent extends AgentLlmExecutionTools implements LlmExecutio
      * Capabilities of the agent
      * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
      */
-    capabilities: AgentCapability[];
+    capabilities: Array<AgentCapability>;
+    /**
+     * List of sample conversations (question/answer pairs)
+     */
+    samples: Array<{
+        question: string | null;
+        answer: string;
+    }>;
     /**
      * Computed hash of the agent source for integrity verification
      */
@@ -60,11 +67,16 @@ export declare class Agent extends AgentLlmExecutionTools implements LlmExecutio
         description?: string;
         [key: string]: string | undefined;
     };
+    /**
+     * Human-readable titles for tool functions
+     */
+    toolTitles: Record<string, string>;
     /**
      * Not used in Agent, always returns empty array
      */
-    get parameters(): BookParameter[];
+    get parameters(): Array<BookParameter>;
     readonly agentSource: BehaviorSubject<string_book>;
+    private readonly teacherAgent;
     constructor(options: AgentOptions);
     /**
      * Calls the chat model with agent-specific system prompt and requirements with streaming

package/esm/typings/src/llm-providers/agent/AgentLlmExecutionTools.d.ts

@@ -54,8 +54,10 @@ export declare class AgentLlmExecutionTools implements LlmExecutionTools {
     private getAgentInfo;
     /**
      * Get cached or create agent model requirements
+     *
+     * Note: [🐤] This is names `getModelRequirements` *(not `getAgentModelRequirements`)* because in future these two will be united
      */
-    protected getAgentModelRequirements(): Promise<AgentModelRequirements>;
+    getModelRequirements(): Promise<AgentModelRequirements>;
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     get profile(): ChatParticipant | undefined;

package/esm/typings/src/llm-providers/agent/AgentOptions.d.ts

@@ -2,6 +2,7 @@ import type { string_book } from '../../book-2.0/agent-source/string_book';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { Updatable } from '../../types/Updatable';
+import { Agent } from './Agent';
 /**
  * Options for creating an Agent
  */
@@ -16,4 +17,10 @@ export type AgentOptions = CommonToolsOptions & {
      * The source of the agent
      */
     agentSource: Updatable<string_book>;
+    /**
+     * Teacher agent for self-learning
+     *
+     * Note: If provided, the agent can do full self-learning from the teacher agent during its operation.
+     */
+    teacherAgent: Agent | null;
 };

package/esm/typings/src/llm-providers/agent/RemoteAgent.d.ts

@@ -23,6 +23,7 @@ export declare class RemoteAgent extends Agent {
     private agentUrl;
     private _remoteAgentName;
     private _remoteAgentHash;
+    toolTitles: Record<string, string>;
     private _isVoiceCallingEnabled;
     private constructor();
     get agentName(): string_agent_name;

package/esm/typings/src/llm-providers/agent/RemoteAgentOptions.d.ts

@@ -3,7 +3,7 @@ import type { string_agent_url } from '../../types/typeAliases';
 /**
  * Options for creating a Remote Agent
  */
-export type RemoteAgentOptions = CommonToolsOptions & {
+export type RemoteAgentOptions = Omit<CommonToolsOptions, 'teacherAgent'> & {
     /**
      * Url of the remote agent
      */

package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts

@@ -1,5 +1,6 @@
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
+import type { ModelRequirements } from '../../types/ModelRequirements';
 import type { Prompt } from '../../types/Prompt';
 import type { string_markdown, string_markdown_text, string_title, string_token } from '../../types/typeAliases';
 import type { OpenAiAssistantExecutionToolsOptions } from './OpenAiAssistantExecutionToolsOptions';
@@ -54,6 +55,10 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
          * Optional list of knowledge source links (URLs or file paths) to attach to the assistant via vector store
          */
         readonly knowledgeSources?: ReadonlyArray<string>;
+        /**
+         * Optional list of tools to attach to the assistant
+         */
+        readonly tools?: ModelRequirements['tools'];
     }): Promise<OpenAiAssistantExecutionTools>;
     updateAssistant(options: {
         /**
@@ -72,6 +77,10 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
          * Optional list of knowledge source links (URLs or file paths) to attach to the assistant via vector store
          */
         readonly knowledgeSources?: ReadonlyArray<string>;
+        /**
+         * Optional list of tools to attach to the assistant
+         */
+        readonly tools?: ModelRequirements['tools'];
     }): Promise<OpenAiAssistantExecutionTools>;
     /**
      * Discriminant for type guards
@@ -85,6 +94,7 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
     static isOpenAiAssistantExecutionTools(llmExecutionTools: LlmExecutionTools): llmExecutionTools is OpenAiAssistantExecutionTools;
 }
 /**
+ * TODO: [🙎] In `OpenAiAssistantExecutionTools` Allow to create abstract assistants with `isCreatingNewAssistantsAllowed`
  * TODO: [🧠][🧙‍♂️] Maybe there can be some wizard for those who want to use just OpenAI
  * TODO: Maybe make custom OpenAiError
  * TODO: [🧠][🈁] Maybe use `isDeterministic` from options

package/esm/typings/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts

@@ -39,10 +39,17 @@ export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecu
      * List all available OpenAI compatible models that can be used
      */
     listModels(): Promise<ReadonlyArray<AvailableModel>>;
+    /**
+     * Calls OpenAI compatible API to use a chat model.
+     */
     /**
      * Calls OpenAI compatible API to use a chat model.
      */
     callChatModel(prompt: Prompt): Promise<ChatPromptResult>;
+    /**
+     * Calls OpenAI compatible API to use a chat model with streaming.
+     */
+    callChatModelStream(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
     /**
      * Internal method that handles parameter retry for chat model calls
      */

package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts

@@ -46,7 +46,7 @@ export declare class RemoteLlmExecutionTools<TCustomOptions = undefined> impleme
     private callCommonModel;
 }
 /**
- * TODO: !!!! Deprecate pipeline server and all of its components
+ * TODO: [🕴] Deprecate pipeline server and all of its components
  * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
  * TODO: [🍓] Allow to list compatible models with each variant

package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts

@@ -1,4 +1,5 @@
 import type { Promisable } from 'type-fest';
+import { TODO_any } from '../../_packages/types.index';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { string_postprocessing_function_name } from '../../types/typeAliases';
 /**
@@ -15,12 +16,16 @@ export type JavascriptExecutionToolsOptions = CommonToolsOptions & {
      * Note: There are also some built-in functions available:
      *      @see ./JavascriptEvalExecutionTools.ts
      */
-    functions?: Record<string_postprocessing_function_name, PostprocessingFunction>;
+    functions?: Record<string_postprocessing_function_name, PostprocessingFunction | ToolFunction>;
 };
 /**
  * Function that can be used to postprocess the output of the LLM
  */
 export type PostprocessingFunction = ((value: string) => Promisable<string>) | Function;
+/**
+ * Function that can be used as tool for AI model
+ */
+export type ToolFunction = (args: TODO_any) => Promise<TODO_any>;
 /**
  * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
  */

package/esm/typings/src/search-engines/SearchEngine.d.ts

@@ -5,5 +5,5 @@ export type SearchEngine = {
     readonly title: string_title & string_markdown_text;
     readonly description?: string_markdown;
     checkConfiguration(): Promisable<void>;
-    search(query: string): Promise<SearchResult[]>;
+    search(query: string, options?: Record<string, unknown>): Promise<SearchResult[]>;
 };

package/esm/typings/src/search-engines/_index.d.ts

@@ -0,0 +1,6 @@
+export * from './bing/BingSearchEngine';
+export * from './dummy/DummySearchEngine';
+export * from './google/GoogleSearchEngine';
+export * from './SearchEngine';
+export * from './SearchResult';
+export * from './serp/SerpSearchEngine';

package/esm/typings/src/search-engines/bing/BingSearchEngine.d.ts

@@ -11,5 +11,5 @@ export declare class BingSearchEngine implements SearchEngine {
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     checkConfiguration(): Promisable<void>;
-    search(query: string): Promise<SearchResult[]>;
+    search(query: string, options?: Record<string, unknown>): Promise<SearchResult[]>;
 }

package/esm/typings/src/search-engines/dummy/DummySearchEngine.d.ts

@@ -11,5 +11,5 @@ export declare class DummySearchEngine implements SearchEngine {
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     checkConfiguration(): Promisable<void>;
-    search(query: string): Promise<SearchResult[]>;
+    search(query: string, options?: Record<string, unknown>): Promise<SearchResult[]>;
 }

package/esm/typings/src/search-engines/google/GoogleSearchEngine.d.ts

@@ -0,0 +1,18 @@
+import type { Promisable } from 'type-fest';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
+import type { SearchEngine } from '../SearchEngine';
+import type { SearchResult } from '../SearchResult';
+/**
+ * A search engine implementation that uses the Google Custom Search JSON API.
+ *
+ * @private <- TODO: !!!! Export via some package
+ */
+export declare class GoogleSearchEngine implements SearchEngine {
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * @see https://developers.google.com/custom-search/v1/overview
+     */
+    checkConfiguration(): Promisable<void>;
+    search(query: string, options?: Record<string, unknown>): Promise<SearchResult[]>;
+}

package/esm/typings/src/search-engines/serp/SerpSearchEngine.d.ts

@@ -0,0 +1,15 @@
+import type { Promisable } from 'type-fest';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
+import type { SearchEngine } from '../SearchEngine';
+import type { SearchResult } from '../SearchResult';
+/**
+ * A search engine implementation that uses the SerpApi to fetch Google search results.
+ *
+ * @private <- TODO: !!!! Export via some package
+ */
+export declare class SerpSearchEngine implements SearchEngine {
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    checkConfiguration(): Promisable<void>;
+    search(query: string, options?: Record<string, unknown>): Promise<SearchResult[]>;
+}

package/esm/typings/src/speech-recognition/BrowserSpeechRecognition.d.ts

@@ -0,0 +1,21 @@
+import type { SpeechRecognition, SpeechRecognitionEvent, SpeechRecognitionStartOptions, SpeechRecognitionState } from '../types/SpeechRecognition';
+/**
+ * Speech recognition using Web Speech API `SpeechRecognition` available in modern browsers
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare class BrowserSpeechRecognition implements SpeechRecognition {
+    private recognition;
+    private callbacks;
+    private _state;
+    get state(): SpeechRecognitionState;
+    constructor();
+    $start(options?: SpeechRecognitionStartOptions): void;
+    $stop(): void;
+    subscribe(callback: (event: SpeechRecognitionEvent) => void): () => void;
+    private emit;
+}
+/**
+ * TODO: !!!! Search ACRY for `window` and put -> [🔵]
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

package/esm/typings/src/speech-recognition/OpenAiSpeechRecognition.d.ts

@@ -0,0 +1,32 @@
+import type { SpeechRecognition, SpeechRecognitionEvent, SpeechRecognitionStartOptions, SpeechRecognitionState } from '../types/SpeechRecognition';
+/**
+ * Options for OpenAiSpeechRecognition
+ */
+export type OpenAiSpeechRecognitionOptions = {
+    /**
+     * OpenAI API base URL or proxy endpoint
+     * @default '/api/openai/v1'
+     */
+    readonly baseUrl?: string;
+};
+/**
+ * Speech recognition using OpenAI Whisper API to transcribe audio into text
+ *
+ * @private because it requires server-client communication with a proxy endpoint
+ *
+ * Note: This implementation uses a server-side proxy to avoid exposing the OpenAI API key on the client.
+ */
+export declare class OpenAiSpeechRecognition implements SpeechRecognition {
+    private readonly options;
+    private mediaRecorder;
+    private audioChunks;
+    private callbacks;
+    private _state;
+    get state(): SpeechRecognitionState;
+    constructor(options?: OpenAiSpeechRecognitionOptions);
+    $start(options?: SpeechRecognitionStartOptions): Promise<void>;
+    $stop(): void;
+    private transcribe;
+    subscribe(callback: (event: SpeechRecognitionEvent) => void): () => void;
+    private emit;
+}

package/esm/typings/src/types/ModelRequirements.d.ts

@@ -29,12 +29,6 @@ export type CompletionModelRequirements = CommonModelRequirements & {
      * Maximum number of tokens that can be generated by the model
      */
     readonly maxTokens?: number;
-    /**
-     * Tools available for the model
-     *
-     * Note: [🚉] This is fully serializable as JSON
-     */
-    readonly tools?: LlmToolDefinition[];
 };
 /**
  * Model requirements for the chat variant
@@ -60,12 +54,6 @@ export type ChatModelRequirements = CommonModelRequirements & {
      * Maximum number of tokens that can be generated by the model
      */
     readonly maxTokens?: number;
-    /**
-     * Tools available for the model
-     *
-     * Note: [🚉] This is fully serializable as JSON
-     */
-    readonly tools?: LlmToolDefinition[];
 };
 /**
  * Model requirements for the image generation variant
@@ -135,6 +123,12 @@ export type CommonModelRequirements = {
      * Seed for the model
      */
     readonly seed?: number_seed;
+    /**
+     * Tools available for the model
+     *
+     * Note: [🚉] This is fully serializable as JSON
+     */
+    readonly tools?: LlmToolDefinition[];
 };
 /**
  * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (similar that `user` identification is not here)