@promptbook/javascript 0.114.0-3 → 0.114.0-5

package/umd/src/commitments/MEMORY/parseMemoryToolArgs.d.ts

@@ -1,61 +0,0 @@
-import type { DeleteMemoryToolArgs, RetrieveMemoryToolArgs, StoreMemoryToolArgs, UpdateMemoryToolArgs } from './MemoryToolRuntimeAdapter';
-/**
- * Parsed retrieve memory arguments.
- *
- * @private type of MemoryCommitmentDefinition
- */
-type ParsedRetrieveMemoryArgs = {
-    query?: string;
-    limit?: number;
-};
-/**
- * Parsed store memory arguments.
- *
- * @private type of MemoryCommitmentDefinition
- */
-type ParsedStoreMemoryArgs = {
-    content: string;
-    isGlobal: boolean;
-};
-/**
- * Parsed update memory arguments.
- *
- * @private type of MemoryCommitmentDefinition
- */
-type ParsedUpdateMemoryArgs = {
-    memoryId: string;
-    content: string;
-    isGlobal?: boolean;
-};
-/**
- * Parsed delete memory arguments.
- *
- * @private type of MemoryCommitmentDefinition
- */
-type ParsedDeleteMemoryArgs = {
-    memoryId: string;
-};
-/**
- * Collection of MEMORY tool argument parsers.
- *
- * @private function of MemoryCommitmentDefinition
- */
-export declare const parseMemoryToolArgs: {
-    /**
-     * Parses retrieve memory arguments.
-     */
-    retrieve(args: RetrieveMemoryToolArgs): ParsedRetrieveMemoryArgs;
-    /**
-     * Parses store memory arguments.
-     */
-    store(args: StoreMemoryToolArgs): ParsedStoreMemoryArgs;
-    /**
-     * Parses update memory arguments.
-     */
-    update(args: UpdateMemoryToolArgs): ParsedUpdateMemoryArgs;
-    /**
-     * Parses delete memory arguments.
-     */
-    delete(args: DeleteMemoryToolArgs): ParsedDeleteMemoryArgs;
-};
-export {};

package/umd/src/commitments/MEMORY/resolveMemoryRuntimeContext.d.ts

@@ -1,8 +0,0 @@
-import type { TODO_any } from '../../utils/organization/TODO_any';
-import type { MemoryToolRuntimeContext } from './MemoryToolRuntimeAdapter';
-/**
- * Resolves runtime context from hidden tool arguments.
- *
- * @private function of MemoryCommitmentDefinition
- */
-export declare function resolveMemoryRuntimeContext(args: Record<string, TODO_any>): MemoryToolRuntimeContext;

package/umd/src/commitments/MEMORY/setMemoryToolRuntimeAdapter.d.ts

@@ -1,13 +0,0 @@
-import type { MemoryToolRuntimeAdapter } from './MemoryToolRuntimeAdapter';
-/**
- * Sets runtime adapter used by MEMORY commitment tools.
- *
- * @private function of MemoryCommitmentDefinition
- */
-export declare function setMemoryToolRuntimeAdapter(adapter: MemoryToolRuntimeAdapter | null): void;
-/**
- * Gets runtime adapter used by MEMORY commitment tools.
- *
- * @private function of MemoryCommitmentDefinition
- */
-export declare function getMemoryToolRuntimeAdapter(): MemoryToolRuntimeAdapter | null;

package/umd/src/commitments/META/META.d.ts

@@ -1,65 +0,0 @@
-import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
-import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
-/**
- * META commitment definition
- *
- * The META commitment handles all meta-information about the agent such as:
- * - META AVATAR / META VISUAL: Sets the agent's built-in default avatar visual
- * - META IMAGE: Sets the agent's avatar/profile image URL
- * - META LINK: Provides profile/source links for the person the agent models
- * - META DOMAIN: Sets the canonical custom domain/host of the agent
- * - META TITLE: Sets the agent's display title
- * - META DESCRIPTION: Sets the agent's description
- * - META INPUT PLACEHOLDER: Sets chat input placeholder text
- * - META THINKING MESSAGE: Adds custom thinking placeholder variants
- * - META [ANYTHING]: Any other meta information in uppercase format
- *
- * These commitments are special because they don't affect the system message,
- * but are handled separately in the parsing logic for profile display.
- *
- * Example usage in agent source:
- *
- * ```book
- * META VISUAL pixel-art
- * META IMAGE https://example.com/avatar.jpg
- * META LINK https://twitter.com/username
- * META DOMAIN my-agent.com
- * META TITLE Professional Assistant
- * META DESCRIPTION An AI assistant specialized in business tasks
- * META INPUT PLACEHOLDER Write a message...
- * META THINKING MESSAGE Thinking...
- * META AUTHOR John Doe
- * META VERSION 1.0
- * ```
- *
- * @private [🪔] Maybe export the commitments through some package
- */
-export declare class MetaCommitmentDefinition extends BaseCommitmentDefinition<`META${string}`> {
-    constructor();
-    /**
-     * Short one-line description of META commitments.
-     */
-    get description(): string;
-    /**
-     * Icon for this commitment.
-     */
-    get icon(): string;
-    /**
-     * Markdown documentation for META commitment.
-     */
-    get documentation(): string;
-    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
-    /**
-     * Extracts meta information from the content based on the meta type
-     * This is used by the parsing logic
-     */
-    extractMetaValue(metaType: string, content: string): string | null;
-    /**
-     * Validates if the provided content is a valid URL (for IMAGE and LINK types)
-     */
-    isValidUrl(content: string): boolean;
-    /**
-     * Checks if this is a known meta type
-     */
-    isKnownMetaType(metaType: string): boolean;
-}

package/umd/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts

@@ -1,32 +0,0 @@
-import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
-import type { ParsedCommitment } from '../_base/ParsedCommitment';
-/**
- * `USE` commitment types whose system-message sections are aggregated after the
- * commitment-by-commitment application step.
- *
- * @private internal utility of `createAgentModelRequirementsWithCommitments`
- */
-type AggregatedUseCommitmentType = 'USE BROWSER' | 'USE DEEPSEARCH' | 'USE SEARCH ENGINE' | 'USE TIME';
-/**
- * Adds the placeholder for an aggregated `USE` system-message section only once, preserving the section position from the first occurrence.
- *
- * @param requirements - Current model requirements.
- * @param type - Aggregated `USE` commitment type being applied.
- * @returns Requirements with the placeholder inserted when it was not already present.
- *
- * @private internal utility of `USE` commitments
- */
-export declare function appendAggregatedUseCommitmentPlaceholder(requirements: AgentModelRequirements, type: AggregatedUseCommitmentType): AgentModelRequirements;
-/**
- * Replaces temporary `USE` placeholders with one aggregated system-message block per commitment type.
- *
- * Distinct additional-instruction blocks are merged in stable source order while the hard-coded section is emitted only once.
- *
- * @param requirements - Model requirements produced by commitment-by-commitment application.
- * @param commitments - Filtered commitments in their original source order.
- * @returns Requirements with aggregated `USE` system-message sections.
- *
- * @private internal utility of `createAgentModelRequirementsWithCommitments`
- */
-export declare function aggregateUseCommitmentSystemMessages(requirements: AgentModelRequirements, commitments: ReadonlyArray<ParsedCommitment>): AgentModelRequirements;
-export {};

package/umd/src/commitments/USE_BROWSER/USE_BROWSER.d.ts

@@ -1,58 +0,0 @@
-import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
-import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
-import type { string_javascript_name } from '../../types/string_person_fullname';
-import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
-/**
- * USE BROWSER commitment definition
- *
- * 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, form filling, etc.
- *
- * The content following `USE BROWSER` is an arbitrary text that the agent should know
- * (e.g. browsing scope or preferred sources).
- *
- * Example usage in agent source:
- *
- * ```book
- * USE BROWSER
- * USE BROWSER Prefer official documentation and source websites.
- * ```
- *
- * @private [🪔] Maybe export the commitments through some package
- */
-export declare class UseBrowserCommitmentDefinition extends BaseCommitmentDefinition<'USE BROWSER'> {
-    constructor();
-    /**
-     * The `USE BROWSER` commitment is standalone.
-     */
-    get requiresContent(): boolean;
-    /**
-     * Short one-line description of USE BROWSER.
-     */
-    get description(): string;
-    /**
-     * Icon for this commitment.
-     */
-    get icon(): string;
-    /**
-     * Markdown documentation for USE BROWSER commitment.
-     */
-    get documentation(): string;
-    /**
-     * Gets human-readable titles for tool functions provided by this commitment.
-     */
-    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>;
-}

package/umd/src/commitments/USE_BROWSER/USE_BROWSER.test.d.ts

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

package/umd/src/commitments/USE_BROWSER/fetchUrlContentViaBrowser.d.ts

@@ -1,13 +0,0 @@
-/**
- * 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/umd/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.d.ts

@@ -1,10 +0,0 @@
-import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
-/**
- * Resolves the server-side implementation of the `run_browser` tool for Node.js environments.
- *
- * This uses fully lazy resolution to keep CLI startup independent from optional browser tooling.
- * When the server tool cannot be resolved, the fallback implementation throws a helpful error.
- *
- * @private internal utility for USE BROWSER commitment
- */
-export declare function resolveRunBrowserToolForNode(): ToolFunction;

package/umd/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.test.d.ts

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

package/umd/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.d.ts

@@ -1,47 +0,0 @@
-import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
-import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
-import type { string_javascript_name } from '../../types/string_person_fullname';
-import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
-/**
- * USE DEEPSEARCH commitment definition
- *
- * The `USE DEEPSEARCH` commitment indicates that the agent should use a deeper research-oriented
- * search workflow instead of lightweight web search when it needs fresh information from the internet.
- *
- * The content following `USE DEEPSEARCH` is an arbitrary text that the agent should know
- * (e.g. search scope or research instructions).
- *
- * Example usage in agent source:
- *
- * ```book
- * USE DEEPSEARCH
- * USE DEEPSEARCH Compare official vendor documentation with independent benchmarks.
- * ```
- *
- * @private [🪔] Maybe export the commitments through some package
- */
-export declare class UseDeepSearchCommitmentDefinition extends BaseCommitmentDefinition<'USE DEEPSEARCH'> {
-    constructor();
-    get requiresContent(): boolean;
-    /**
-     * Short one-line description of USE DEEPSEARCH.
-     */
-    get description(): string;
-    /**
-     * Icon for this commitment.
-     */
-    get icon(): string;
-    /**
-     * Markdown documentation for USE DEEPSEARCH 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 local fallback implementation for the `deep_search` tool.
-     */
-    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
-}

package/umd/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.test.d.ts

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

package/umd/src/commitments/USE_EMAIL/USE_EMAIL.d.ts

@@ -1,38 +0,0 @@
-import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
-import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
-import type { string_javascript_name } from '../../types/string_person_fullname';
-import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
-/**
- * USE EMAIL commitment definition.
- *
- * The `USE EMAIL` commitment enables outbound email sending through the `send_email` tool.
- *
- * @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 browser-safe `send_email` implementation.
-     *
-     * Node.js runtime overrides this via `getAllCommitmentsToolFunctionsForNode`.
-     */
-    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
-}

package/umd/src/commitments/USE_EMAIL/USE_EMAIL.test.d.ts

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

package/umd/src/commitments/USE_EMAIL/parseUseEmailCommitmentContent.d.ts

@@ -1,21 +0,0 @@
-/**
- * Parsed payload of one `USE EMAIL` commitment.
- *
- * @private internal USE EMAIL type
- */
-export type ParsedUseEmailCommitmentContent = {
-    senderEmail: string | null;
-    senderEmailRaw: string | null;
-    instructions: string;
-};
-/**
- * Parses `USE EMAIL` commitment content into optional sender email + additional instructions.
- *
- * Examples:
- * - `agent@example.com`
- * - `agent@example.com Keep emails concise`
- * - `Keep emails concise`
- *
- * @private internal utility of USE EMAIL commitment
- */
-export declare function parseUseEmailCommitmentContent(content: string): ParsedUseEmailCommitmentContent;

package/umd/src/commitments/USE_EMAIL/parseUseEmailCommitmentContent.test.d.ts

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

package/umd/src/commitments/USE_EMAIL/resolveSendEmailToolForNode.d.ts

@@ -1,11 +0,0 @@
-import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
-/**
- * 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/umd/src/commitments/USE_EMAIL/sendEmailViaBrowser.d.ts

@@ -1,13 +0,0 @@
-/**
- * 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 forwarded to the server-side `send_email` tool
- * @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: Record<string, unknown>, agentsServerUrl?: string): Promise<string>;

package/umd/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts

@@ -1,46 +0,0 @@
-import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
-import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
-import type { string_javascript_name } from '../../types/string_person_fullname';
-import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
-/**
- * USE SEARCH ENGINE commitment definition
- *
- * The `USE SEARCH ENGINE` commitment indicates that the agent should utilize a search engine tool
- * to access and retrieve up-to-date information from the internet when necessary.
- *
- * The content following `USE SEARCH ENGINE` is an arbitrary text that the agent should know (e.g. search scope or instructions).
- *
- * Example usage in agent source:
- *
- * ```book
- * USE SEARCH ENGINE
- * USE SEARCH ENGINE Hledej informace o Přemyslovcích
- * ```
- *
- * @private [🪔] Maybe export the commitments through some package
- */
-export declare class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition<'USE SEARCH ENGINE'> {
-    constructor();
-    get requiresContent(): boolean;
-    /**
-     * Short one-line description of USE SEARCH ENGINE.
-     */
-    get description(): string;
-    /**
-     * Icon for this commitment.
-     */
-    get icon(): string;
-    /**
-     * Markdown documentation for USE SEARCH ENGINE 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 `web_search` tool function implementation.
-     */
-    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
-}

package/umd/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.test.d.ts

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

package/umd/src/commitments/USE_SPAWN/USE_SPAWN.d.ts

@@ -1,38 +0,0 @@
-import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
-import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
-import type { string_javascript_name } from '../../types/string_person_fullname';
-import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
-/**
- * USE SPAWN commitment definition.
- *
- * The `USE SPAWN` commitment enables creating new persistent child agents through one tool call.
- *
- * @private [🪔] Maybe export the commitments through some package
- */
-export declare class UseSpawnCommitmentDefinition extends BaseCommitmentDefinition<'USE SPAWN'> {
-    constructor();
-    get requiresContent(): boolean;
-    /**
-     * Short one-line description of USE SPAWN.
-     */
-    get description(): string;
-    /**
-     * Icon for this commitment.
-     */
-    get icon(): string;
-    /**
-     * Markdown documentation for USE SPAWN 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 browser-safe `spawn_agent` implementation.
-     *
-     * Node.js runtime overrides this through `getAllCommitmentsToolFunctionsForNode`.
-     */
-    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
-}

package/umd/src/commitments/USE_SPAWN/USE_SPAWN.test.d.ts

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

package/umd/src/commitments/USE_SPAWN/resolveSpawnAgentToolForNode.d.ts

@@ -1,9 +0,0 @@
-import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
-/**
- * Resolves the server-side `spawn_agent` tool for Node.js runtimes.
- *
- * Uses lazy require so core package can load outside Agents Server.
- *
- * @private internal utility for USE SPAWN commitment
- */
-export declare function resolveSpawnAgentToolForNode(): ToolFunction;

package/umd/src/commitments/USE_SPAWN/spawnAgentViaBrowser.d.ts

@@ -1,12 +0,0 @@
-/**
- * Browser-safe wrapper for spawning one persisted Agents Server agent.
- *
- * This function proxies requests to the Agents Server `/api/spawn-agent` endpoint.
- *
- * @param args Tool payload forwarded to server-side `spawn_agent` tool.
- * @param agentsServerUrl Optional explicit agents server base URL.
- * @returns JSON string with structured spawn result.
- *
- * @private internal utility for USE SPAWN commitment
- */
-export declare function spawnAgentViaBrowser(args: Record<string, unknown>, agentsServerUrl?: string): Promise<string>;

package/umd/src/commitments/USE_TIME/USE_TIME.d.ts

@@ -1,43 +0,0 @@
-import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
-import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
-import type { string_javascript_name } from '../../types/string_person_fullname';
-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
- * USE TIME Prefer the user's local timezone.
- * ```
- *
- * @private [🪔] Maybe export the commitments through some package
- */
-export declare class UseTimeCommitmentDefinition extends BaseCommitmentDefinition<'USE TIME'> {
-    constructor();
-    get requiresContent(): boolean;
-    /**
-     * 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>;
-}

package/umd/src/commitments/USE_TIME/USE_TIME.test.d.ts

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

package/umd/src/commitments/USE_TIMEOUT/TimeoutToolNames.d.ts

@@ -1,11 +0,0 @@
-/**
- * Tool names provided by the `USE TIMEOUT` commitment.
- *
- * @private internal USE TIMEOUT constant
- */
-export declare const TimeoutToolNames: {
-    readonly set: string;
-    readonly cancel: string;
-    readonly list: string;
-    readonly update: string;
-};