@promptbook/javascript 0.111.0-7 → 0.112.0-12

package/esm/src/commitments/WALLET/getWalletCommitmentDocumentation.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Gets markdown documentation for WALLET commitment.
+ *
+ * @private function of WalletCommitmentDefinition
+ */
+export declare function getWalletCommitmentDocumentation(type: 'WALLET' | 'WALLETS'): string;

package/esm/src/commitments/WALLET/getWalletToolRuntimeAdapterOrDisabledResult.d.ts

@@ -0,0 +1,16 @@
+import type { WalletDisabledToolResult, WalletRuntimeToolAction, WalletToolRuntimeAdapter, WalletToolRuntimeContext } from './WalletToolRuntimeAdapter';
+/**
+ * Resolves disabled message for wallet runtime context.
+ *
+ * @private function of WalletCommitmentDefinition
+ */
+export declare function resolveWalletDisabledMessage(runtimeContext: WalletToolRuntimeContext): string | null;
+/**
+ * Resolves runtime adapter for wallet tools or returns disabled payload when unavailable.
+ *
+ * @private function of WalletCommitmentDefinition
+ */
+export declare function getWalletToolRuntimeAdapterOrDisabledResult(action: WalletRuntimeToolAction, runtimeContext: WalletToolRuntimeContext): {
+    adapter: WalletToolRuntimeAdapter | null;
+    disabledResult?: WalletDisabledToolResult;
+};

package/esm/src/commitments/WALLET/getWalletToolTitles.d.ts

@@ -0,0 +1,7 @@
+import type { string_javascript_name } from '../../_packages/types.index';
+/**
+ * Gets human-readable titles for WALLET tool functions.
+ *
+ * @private function of WalletCommitmentDefinition
+ */
+export declare function getWalletToolTitles(): Record<string_javascript_name, string>;

package/esm/src/commitments/WALLET/parseWalletToolArgs.d.ts

@@ -0,0 +1,51 @@
+import type { DeleteWalletRecordToolArgs, RequestWalletRecordToolArgs, RetrieveWalletRecordsToolArgs, StoreWalletRecordToolArgs, UpdateWalletRecordToolArgs, WalletRecordType, WalletRequestRecord, WalletToolRecord } from './WalletToolRuntimeAdapter';
+/**
+ * Parsed payload for retrieving wallet records.
+ *
+ * @private type of WalletCommitmentDefinition
+ */
+type ParsedRetrieveWalletRecordsArgs = {
+    query?: string;
+    recordType?: WalletRecordType;
+    service?: string;
+    key?: string;
+    limit?: number;
+};
+/**
+ * Parsed payload for updating an existing wallet record.
+ *
+ * @private type of WalletCommitmentDefinition
+ */
+type ParsedUpdateWalletRecordArgs = WalletToolRecord & {
+    walletId: string;
+};
+/**
+ * Collection of WALLET tool argument parsers.
+ *
+ * @private function of WalletCommitmentDefinition
+ */
+export declare const parseWalletToolArgs: {
+    /**
+     * Parses retrieve arguments.
+     */
+    retrieve(args: RetrieveWalletRecordsToolArgs): ParsedRetrieveWalletRecordsArgs;
+    /**
+     * Parses store payload.
+     */
+    store(args: StoreWalletRecordToolArgs): WalletToolRecord;
+    /**
+     * Parses update payload.
+     */
+    update(args: UpdateWalletRecordToolArgs): ParsedUpdateWalletRecordArgs;
+    /**
+     * Parses delete payload.
+     */
+    delete(args: DeleteWalletRecordToolArgs): {
+        walletId: string;
+    };
+    /**
+     * Parses request payload for user wallet input prompt.
+     */
+    request(args: RequestWalletRecordToolArgs): WalletRequestRecord;
+};
+export {};

package/esm/src/commitments/WALLET/resolveWalletRuntimeContext.d.ts

@@ -0,0 +1,8 @@
+import type { TODO_any } from '../../_packages/types.index';
+import type { WalletToolRuntimeContext } from './WalletToolRuntimeAdapter';
+/**
+ * Resolves runtime context from hidden tool arguments.
+ *
+ * @private function of WalletCommitmentDefinition
+ */
+export declare function resolveWalletRuntimeContext(args: Record<string, TODO_any>): WalletToolRuntimeContext;

package/esm/src/commitments/WALLET/setWalletToolRuntimeAdapter.d.ts

@@ -0,0 +1,13 @@
+import type { WalletToolRuntimeAdapter } from './WalletToolRuntimeAdapter';
+/**
+ * Sets runtime adapter used by WALLET tools.
+ *
+ * @private function of WalletCommitmentDefinition
+ */
+export declare function setWalletToolRuntimeAdapter(adapter: WalletToolRuntimeAdapter | null): void;
+/**
+ * Gets runtime adapter used by WALLET tools.
+ *
+ * @private function of WalletCommitmentDefinition
+ */
+export declare function getWalletToolRuntimeAdapter(): WalletToolRuntimeAdapter | null;

package/esm/src/commitments/WRITING_RULES/WRITING_RULES.d.ts

@@ -0,0 +1,29 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * `WRITING RULES` commitment definition.
+ *
+ * It adds constraints that apply strictly to writing style and presentation
+ * rather than task-solving behavior.
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class WritingRulesCommitmentDefinition extends BaseCommitmentDefinition<'WRITING RULES'> {
+    constructor();
+    /**
+     * Short one-line description of `WRITING RULES`.
+     */
+    get description(): string;
+    /**
+     * Icon for `WRITING RULES`.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for `WRITING RULES`.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/src/commitments/WRITING_SAMPLE/WRITING_SAMPLE.d.ts

@@ -0,0 +1,29 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * `WRITING SAMPLE` commitment definition.
+ *
+ * It provides explicit sample-only text that demonstrates how the agent should
+ * sound, without adding meta commentary or behavioral rules.
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class WritingSampleCommitmentDefinition extends BaseCommitmentDefinition<'WRITING SAMPLE'> {
+    constructor();
+    /**
+     * Short one-line description of `WRITING SAMPLE`.
+     */
+    get description(): string;
+    /**
+     * Icon for `WRITING SAMPLE`.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for `WRITING SAMPLE`.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -33,6 +33,10 @@ export declare abstract class BaseCommitmentDefinition<TBookCommitment extends s
      * Must be implemented by each concrete commitment.
      */
     abstract get documentation(): string;
+    /**
+     * Optional UI/docs-only deprecation metadata.
+     */
+    get deprecation(): CommitmentDefinition['deprecation'];
     /**
      * Creates a regex pattern to match this commitment in agent source
      * Uses the existing createCommitmentRegex function as internal helper
@@ -57,6 +61,14 @@ export declare abstract class BaseCommitmentDefinition<TBookCommitment extends s
      * Helper method to append content to the system message
      */
     protected appendToSystemMessage(requirements: AgentModelRequirements, content: string, separator?: string): AgentModelRequirements;
+    /**
+     * Helper method to format one system-message section with an H2 heading.
+     *
+     * @param title - Section title without markdown prefix.
+     * @param content - Section body content.
+     * @returns Formatted section text using `##` heading.
+     */
+    protected createSystemMessageSection(title: string, content: string): string;
     /**
      * Helper method to create a new requirements object with updated prompt suffix
      */

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

@@ -1,6 +1,21 @@
 import { string_javascript_name } from '../../_packages/types.index';
 import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
+/**
+ * Optional UI/docs-only deprecation metadata for one commitment keyword.
+ *
+ * @private internal type of `CommitmentDefinition`
+ */
+type CommitmentDeprecation = {
+    /**
+     * Human-readable deprecation note shown in editors and documentation.
+     */
+    readonly message: string;
+    /**
+     * Preferred replacement commitments, when applicable.
+     */
+    readonly replacedBy?: ReadonlyArray<string>;
+};
 /**
  * Definition of a commitment that can be applied to agent model requirements
  *
@@ -29,6 +44,13 @@ export type CommitmentDefinition = {
      * This is available at runtime for UIs, docs, and tooling.
      */
     readonly documentation: string;
+    /**
+     * Optional deprecation metadata for backward-compatible commitment aliases.
+     *
+     * This is intentionally UI/docs metadata only. It must not change runtime
+     * model requirements on its own.
+     */
+    readonly deprecation?: CommitmentDeprecation;
     /**
      * Creates a regex pattern to match this commitment in agent source
      * This regex should capture the commitment content in a 'contents' named group
@@ -65,3 +87,4 @@ export type CommitmentDefinition = {
      */
     getToolTitles(): Record<string_javascript_name, string>;
 };
+export {};

package/esm/src/commitments/_common/createWritingCommitmentSections.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Creates the canonical system-message body for one writing-sample commitment.
+ *
+ * @param content - Explicit 1:1 sample text.
+ * @returns Writing-sample guidance ready for one system-message section.
+ * @private internal utility of writing commitments
+ */
+export declare function createWritingSampleSection(content: string): string;
+/**
+ * Creates the canonical system-message body for one writing-rules commitment.
+ *
+ * @param content - Writing-only instructions.
+ * @returns Writing-rules guidance ready for one system-message section.
+ * @private internal utility of writing commitments
+ */
+export declare function createWritingRulesSection(content: string): string;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/src/commitments/_common/getGroupedCommitmentDefinitions.writing.test.d.ts

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

package/esm/src/commitments/_common/toolExecutionEnvelope.d.ts

@@ -0,0 +1,22 @@
+import type { TODO_any } from '../../_packages/types.index';
+/**
+ * Creates one serialized tool-execution envelope.
+ *
+ * @private internal tool-execution transport
+ */
+export declare function createToolExecutionEnvelope(options: {
+    readonly assistantMessage: string;
+    readonly toolResult: TODO_any;
+}): string;
+/**
+ * Parses one serialized tool-execution envelope when present.
+ *
+ * @private internal tool-execution transport
+ */
+export declare function parseToolExecutionEnvelope(rawValue: unknown): {
+    assistantMessage: string;
+    toolResult: TODO_any;
+} | null;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/src/commitments/_common/toolRuntimeContext.d.ts

@@ -1,4 +1,6 @@
 import { TODO_any } from '../../_packages/types.index';
+import type { ToolCallLogEntry, ToolCallState } from '../../types/ToolCall';
+import type { ChatAttachment } from '../../utils/chat/chatAttachments';
 /**
  * Prompt parameter key used to pass hidden runtime context to tool execution.
  *
@@ -11,6 +13,39 @@ export declare const TOOL_RUNTIME_CONTEXT_PARAMETER = "promptbookToolRuntimeCont
  * @private internal runtime wiring for commitment tools
  */
 export declare const TOOL_RUNTIME_CONTEXT_ARGUMENT = "__promptbookToolRuntimeContext";
+/**
+ * Prompt parameter key used to pass a hidden tool-progress listener token into script execution.
+ *
+ * @private internal runtime wiring for commitment tools
+ */
+export declare const TOOL_PROGRESS_TOKEN_PARAMETER = "promptbookToolProgressToken";
+/**
+ * Hidden argument key used to pass a tool-progress listener token into individual tool calls.
+ *
+ * @private internal runtime wiring for commitment tools
+ */
+export declare const TOOL_PROGRESS_TOKEN_ARGUMENT = "__promptbookToolProgressToken";
+/**
+ * Incremental tool execution update emitted from long-running tools.
+ *
+ * @private internal runtime wiring for commitment tools
+ */
+export type ToolCallProgressUpdate = {
+    /**
+     * Optional state override associated with this update.
+     */
+    readonly state?: ToolCallState;
+    /**
+     * Optional incremental log entry appended to the tool-call stream.
+     */
+    readonly log?: ToolCallLogEntry;
+};
+/**
+ * Listener notified when one long-running tool emits a progress update.
+ *
+ * @private internal runtime wiring for commitment tools
+ */
+type ToolCallProgressListener = (update: ToolCallProgressUpdate) => void;
 /**
  * User geolocation payload shared with tools through hidden runtime context.
  *
@@ -42,6 +77,36 @@ export type ToolRuntimeContext = {
         isPrivateMode?: boolean;
     };
     userLocation?: UserLocationRuntimeContext;
+    projects?: {
+        githubToken?: string;
+        repositories?: string[];
+    };
+    email?: {
+        smtpCredential?: string;
+        fromAddress?: string;
+    };
+    calendars?: {
+        googleAccessToken?: string;
+        connections?: Array<{
+            provider: string;
+            url: string;
+            calendarId: string;
+            scopes?: string[];
+        }>;
+    };
+    spawn?: {
+        depth?: number;
+        parentRunId?: string;
+        parentAgentId?: string;
+    };
+    chat?: {
+        chatId?: string;
+        userId?: number;
+        agentId?: string;
+        agentName?: string;
+        parameters?: Record<string, string>;
+        attachments?: ReadonlyArray<ChatAttachment>;
+    };
 };
 /**
  * Parses unknown runtime context payload into a normalized object.
@@ -55,12 +120,46 @@ export declare function parseToolRuntimeContext(rawValue: unknown): ToolRuntimeC
  * @private internal runtime wiring for commitment tools
  */
 export declare function readToolRuntimeContextFromToolArgs(args: Record<string, TODO_any>): ToolRuntimeContext | null;
+/**
+ * Reads the hidden tool-progress token from tool arguments.
+ *
+ * @private internal runtime wiring for commitment tools
+ */
+export declare function readToolProgressTokenFromToolArgs(args: Record<string, TODO_any>): string | null;
 /**
  * Serializes runtime context for prompt parameters.
  *
  * @private internal runtime wiring for commitment tools
  */
 export declare function serializeToolRuntimeContext(context: ToolRuntimeContext): string;
+/**
+ * Registers one in-memory listener that receives progress updates emitted by a running tool.
+ *
+ * The returned token is passed into script execution as a hidden argument so tool implementations
+ * can stream progress without exposing extra parameters to the model.
+ *
+ * @param listener - Listener notified about tool progress.
+ * @returns Hidden token used to route progress updates.
+ * @private internal runtime wiring for commitment tools
+ */
+export declare function registerToolCallProgressListener(listener: ToolCallProgressListener): string;
+/**
+ * Unregisters one in-memory progress listener.
+ *
+ * @param token - Token previously created by `registerToolCallProgressListener`.
+ * @private internal runtime wiring for commitment tools
+ */
+export declare function unregisterToolCallProgressListener(token: string): void;
+/**
+ * Emits one tool progress update using a hidden token carried in tool arguments.
+ *
+ * @param args - Raw tool arguments including hidden runtime keys.
+ * @param update - Incremental progress update.
+ * @returns `true` when a listener was found and notified.
+ * @private internal runtime wiring for commitment tools
+ */
+export declare function emitToolCallProgressFromToolArgs(args: Record<string, TODO_any>, update: ToolCallProgressUpdate): boolean;
+export {};
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -12,15 +12,19 @@ import { LanguageCommitmentDefinition } from './LANGUAGE/LANGUAGE';
 import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
 import { AgentMessageCommitmentDefinition } from './MESSAGE/AgentMessageCommitmentDefinition';
 import { InitialMessageCommitmentDefinition } from './MESSAGE/InitialMessageCommitmentDefinition';
+import { InternalMessageCommitmentDefinition } from './MESSAGE/InternalMessageCommitmentDefinition';
 import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
 import { UserMessageCommitmentDefinition } from './MESSAGE/UserMessageCommitmentDefinition';
 import { MessageSuffixCommitmentDefinition } from './MESSAGE_SUFFIX/MESSAGE_SUFFIX';
 import { MetaCommitmentDefinition } from './META/META';
 import { MetaColorCommitmentDefinition } from './META_COLOR/META_COLOR';
+import { MetaDomainCommitmentDefinition } from './META_DOMAIN/META_DOMAIN';
 import { MetaDisclaimerCommitmentDefinition } from './META_DISCLAIMER/META_DISCLAIMER';
 import { MetaFontCommitmentDefinition } from './META_FONT/META_FONT';
 import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
+import { MetaInputPlaceholderCommitmentDefinition } from './META_INPUT_PLACEHOLDER/META_INPUT_PLACEHOLDER';
 import { MetaLinkCommitmentDefinition } from './META_LINK/META_LINK';
+import { MetaVoiceCommitmentDefinition } from './META_VOICE/META_VOICE';
 import { ModelCommitmentDefinition } from './MODEL/MODEL';
 import { NoteCommitmentDefinition } from './NOTE/NOTE';
 import { OpenCommitmentDefinition } from './OPEN/OPEN';
@@ -33,12 +37,20 @@ import { TeamCommitmentDefinition } from './TEAM/TEAM';
 import { TemplateCommitmentDefinition } from './TEMPLATE/TEMPLATE';
 import { UseCommitmentDefinition } from './USE/USE';
 import { UseBrowserCommitmentDefinition } from './USE_BROWSER/USE_BROWSER';
+import { UseCalendarCommitmentDefinition } from './USE_CALENDAR/USE_CALENDAR';
 import { UseEmailCommitmentDefinition } from './USE_EMAIL/USE_EMAIL';
 import { UseImageGeneratorCommitmentDefinition } from './USE_IMAGE_GENERATOR/USE_IMAGE_GENERATOR';
 import { UseMcpCommitmentDefinition } from './USE_MCP/USE_MCP';
+import { UsePopupCommitmentDefinition } from './USE_POPUP/USE_POPUP';
+import { UsePrivacyCommitmentDefinition } from './USE_PRIVACY/USE_PRIVACY';
+import { UseProjectCommitmentDefinition } from './USE_PROJECT/USE_PROJECT';
 import { UseSearchEngineCommitmentDefinition } from './USE_SEARCH_ENGINE/USE_SEARCH_ENGINE';
+import { UseSpawnCommitmentDefinition } from './USE_SPAWN/USE_SPAWN';
+import { UseTimeoutCommitmentDefinition } from './USE_TIMEOUT/USE_TIMEOUT';
 import { UseTimeCommitmentDefinition } from './USE_TIME/USE_TIME';
 import { UseUserLocationCommitmentDefinition } from './USE_USER_LOCATION/USE_USER_LOCATION';
+import { WritingRulesCommitmentDefinition } from './WRITING_RULES/WRITING_RULES';
+import { WritingSampleCommitmentDefinition } from './WRITING_SAMPLE/WRITING_SAMPLE';
 import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
 /**
  * Registry of all available commitment definitions
@@ -47,7 +59,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, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageSuffixCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, TeamCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseTimeCommitmentDefinition, UseUserLocationCommitmentDefinition, UseEmailCommitmentDefinition, UseImageGeneratorCommitmentDefinition, 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, WritingSampleCommitmentDefinition, WritingRulesCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDomainCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaInputPlaceholderCommitmentDefinition, MetaCommitmentDefinition, MetaVoiceCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, InternalMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageSuffixCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, TeamCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseSpawnCommitmentDefinition, UseTimeoutCommitmentDefinition, UseTimeCommitmentDefinition, UseUserLocationCommitmentDefinition, UseCalendarCommitmentDefinition, UseEmailCommitmentDefinition, UsePopupCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UsePrivacyCommitmentDefinition, UseProjectCommitmentDefinition, 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/src/config.d.ts

@@ -62,6 +62,9 @@ export declare const PROMPTBOOK_SYNTAX_COLORS: {
     readonly LINE: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
     readonly SEPARATOR: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
     readonly COMMITMENT: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+    readonly NOTE_COMMITMENT: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+    readonly TODO_COMMITMENT_TEXT: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+    readonly TODO_COMMITMENT_BACKGROUND: 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>;
 };

package/esm/src/errors/0-index.d.ts

@@ -2,6 +2,7 @@ import { CsvFormatError } from '../formats/csv/CsvFormatError';
 import { AbstractFormatError } from './AbstractFormatError';
 import { AuthenticationError } from './AuthenticationError';
 import { CollectionError } from './CollectionError';
+import { ConflictError } from './ConflictError';
 import { DatabaseError } from './DatabaseError';
 import { EnvironmentMismatchError } from './EnvironmentMismatchError';
 import { ExpectError } from './ExpectError';
@@ -44,6 +45,7 @@ export declare const PROMPTBOOK_ERRORS: {
     readonly WrappedError: typeof WrappedError;
     readonly NotAllowed: typeof NotAllowed;
     readonly DatabaseError: typeof DatabaseError;
+    readonly ConflictError: typeof ConflictError;
 };
 /**
  * Index of all javascript errors
@@ -94,6 +96,7 @@ export declare const ALL_ERRORS: {
     readonly WrappedError: typeof WrappedError;
     readonly NotAllowed: typeof NotAllowed;
     readonly DatabaseError: typeof DatabaseError;
+    readonly ConflictError: typeof ConflictError;
 };
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/src/errors/ConflictError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Signals that the requested operation could not be completed because the target already exists.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class ConflictError extends Error {
+    readonly name = "ConflictError";
+    constructor(message: string);
+}

package/esm/src/executables/apps/locateVscode.d.ts

@@ -0,0 +1,7 @@
+import type { string_executable_path } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locateVscode(): Promise<string_executable_path | null>;

package/esm/src/executables/apps/locateVscode.test.d.ts

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

package/esm/src/executables/browsers/locateBrowser.d.ts

@@ -0,0 +1,10 @@
+import type { string_executable_path } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @param browser It can be "default", "chrome", "firefox", "safari", "ie", "msie", "edge" or "msedge" or executable path to the browser
+ * @returns executable path to browser
+ *
+ * @private within the repository
+ */
+export declare function locateBrowser(browser: string): Promise<string_executable_path | null>;

package/esm/src/executables/browsers/locateBrowser.test.d.ts

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

package/esm/src/executables/browsers/locateChrome.d.ts

@@ -0,0 +1,7 @@
+import type { string_executable_path } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locateChrome(): Promise<string_executable_path | null>;

package/esm/src/executables/browsers/locateChrome.test.d.ts

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

package/esm/src/executables/browsers/locateDefaultSystemBrowser.d.ts

@@ -0,0 +1,10 @@
+import type { string_executable_path } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @param browser It can be "default", "chrome", "firefox", "safari", "ie", "msie", "edge" or "msedge" or executable path to the browser
+ * @returns executable path to browser
+ *
+ * @private within the repository
+ */
+export declare function locateDefaultSystemBrowser(): Promise<string_executable_path | null>;

package/esm/src/executables/browsers/locateDefaultSystemBrowser.test.d.ts

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

package/esm/src/executables/browsers/locateEdge.d.ts

@@ -0,0 +1,7 @@
+import type { string_executable_path } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locateEdge(): Promise<string_executable_path | null>;

package/esm/src/executables/browsers/locateEdge.test.d.ts

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

package/esm/src/executables/browsers/locateFirefox.d.ts

@@ -0,0 +1,7 @@
+import type { string_executable_path } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locateFirefox(): Promise<string_executable_path | null>;

package/esm/src/executables/browsers/locateFirefox.test.d.ts

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

package/esm/src/executables/browsers/locateInternetExplorer.d.ts

@@ -0,0 +1,7 @@
+import type { string_executable_path } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locateInternetExplorer(): Promise<string_executable_path | null>;

package/esm/src/executables/browsers/locateInternetExplorer.test.d.ts

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

package/esm/src/executables/browsers/locateSafari.d.ts

@@ -0,0 +1,7 @@
+import type { string_executable_path } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locateSafari(): Promise<string_executable_path | null>;

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

@@ -19,6 +19,17 @@ import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult, I
  *
  * @see https://github.com/webgptorg/promptbook#llm-execution-tools
  */
+/**
+ * Options that fine-tune streaming execution.
+ *
+ * @private internal helper for streaming helpers
+ */
+export type CallChatModelStreamOptions = {
+    /**
+     * Optional signal that can cancel the streaming request.
+     */
+    readonly signal?: AbortSignal;
+};
 export type LlmExecutionTools = {
     /**
      * Title of the model provider
@@ -59,7 +70,7 @@ export type LlmExecutionTools = {
      */
     callChatModelStream?(prompt: Prompt, onProgress: (chunk: ChatPromptResult & {
         isFinished?: boolean;
-    }) => void): Promise<ChatPromptResult>;
+    }) => void, options?: CallChatModelStreamOptions): Promise<ChatPromptResult>;
     /**
      * Calls a voice chat model
      */