@promptbook/cli 0.114.0-3 → 0.114.0-4

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

@@ -1,21 +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';
-export { setWalletToolRuntimeAdapter } from './setWalletToolRuntimeAdapter';
-export type { WalletRecordType, WalletToolRecord, WalletToolRuntimeAdapter, WalletToolRuntimeContext, } from './WalletToolRuntimeAdapter';
-/**
- * WALLET commitment definition.
- *
- * @private [🪔] Maybe export the commitments through some package
- */
-export declare class WalletCommitmentDefinition extends BaseCommitmentDefinition<'WALLET' | 'WALLETS'> {
-    constructor(type?: 'WALLET' | 'WALLETS');
-    get requiresContent(): boolean;
-    get description(): string;
-    get icon(): string;
-    get documentation(): string;
-    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
-    getToolTitles(): Record<string_javascript_name, string>;
-    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
-}

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

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

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

@@ -1,12 +0,0 @@
-/**
- * Names of tools used by the WALLET commitment.
- *
- * @private constant of WalletCommitmentDefinition
- */
-export declare const WalletToolNames: {
-    readonly retrieve: string;
-    readonly store: string;
-    readonly update: string;
-    readonly delete: string;
-    readonly request: string;
-};

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

@@ -1,163 +0,0 @@
-import type { TODO_any } from '../../utils/organization/TODO_any';
-/**
- * Supported wallet record types.
- *
- * @private type of WalletCommitmentDefinition
- */
-export type WalletRecordType = 'USERNAME_PASSWORD' | 'SESSION_COOKIE' | 'ACCESS_TOKEN';
-/**
- * Normalized wallet record payload used by runtime adapters.
- *
- * @private type of WalletCommitmentDefinition
- */
-export type WalletToolRecord = {
-    id?: string;
-    recordType: WalletRecordType;
-    service: string;
-    key: string;
-    username?: string | null;
-    password?: string | null;
-    secret?: string | null;
-    cookies?: string | null;
-    isUserScoped: boolean;
-    isGlobal: boolean;
-    createdAt?: string;
-    updatedAt?: string;
-};
-/**
- * Runtime context for wallet operations.
- *
- * @private type of WalletCommitmentDefinition
- */
-export type WalletToolRuntimeContext = {
-    readonly enabled: boolean;
-    readonly userId?: number;
-    readonly username?: string;
-    readonly agentId?: string;
-    readonly agentName?: string;
-    readonly isTeamConversation: boolean;
-    readonly isPrivateMode: boolean;
-};
-/**
- * Runtime adapter interface used by wallet tools.
- *
- * @private type of WalletCommitmentDefinition
- */
-export type WalletToolRuntimeAdapter = {
-    retrieveWalletRecords(args: {
-        query?: string;
-        recordType?: WalletRecordType;
-        service?: string;
-        key?: string;
-        limit?: number;
-    }, runtimeContext: WalletToolRuntimeContext): Promise<WalletToolRecord[]>;
-    storeWalletRecord(args: WalletToolRecord & {
-        username?: string | null;
-        password?: string | null;
-        secret?: string | null;
-        cookies?: string | null;
-    }, runtimeContext: WalletToolRuntimeContext): Promise<WalletToolRecord>;
-    updateWalletRecord(args: WalletToolRecord & {
-        walletId: string;
-        username?: string | null;
-        password?: string | null;
-        secret?: string | null;
-        cookies?: string | null;
-    }, runtimeContext: WalletToolRuntimeContext): Promise<WalletToolRecord>;
-    deleteWalletRecord(args: {
-        walletId: string;
-    }, runtimeContext: WalletToolRuntimeContext): Promise<{
-        id?: string;
-    }>;
-};
-/**
- * Arguments accepted by `retrieve_wallet_records`.
- *
- * @private type of WalletCommitmentDefinition
- */
-export type RetrieveWalletRecordsToolArgs = {
-    query?: string;
-    recordType?: WalletRecordType;
-    service?: string;
-    key?: string;
-    limit?: number;
-    [key: string]: TODO_any;
-};
-/**
- * Arguments accepted by `store_wallet_record`.
- *
- * @private type of WalletCommitmentDefinition
- */
-export type StoreWalletRecordToolArgs = {
-    recordType?: WalletRecordType;
-    service?: string;
-    key?: string;
-    username?: string;
-    password?: string;
-    secret?: string;
-    cookies?: string;
-    isUserScoped?: boolean;
-    isGlobal?: boolean;
-    [key: string]: TODO_any;
-};
-/**
- * Arguments accepted by `update_wallet_record`.
- *
- * @private type of WalletCommitmentDefinition
- */
-export type UpdateWalletRecordToolArgs = StoreWalletRecordToolArgs & {
-    walletId?: string;
-};
-/**
- * Arguments accepted by `delete_wallet_record`.
- *
- * @private type of WalletCommitmentDefinition
- */
-export type DeleteWalletRecordToolArgs = {
-    walletId?: string;
-    [key: string]: TODO_any;
-};
-/**
- * Arguments accepted by `request_wallet_record`.
- *
- * @private type of WalletCommitmentDefinition
- */
-export type RequestWalletRecordToolArgs = {
-    recordType?: WalletRecordType;
-    service?: string;
-    key?: string;
-    message?: string;
-    isUserScoped?: boolean;
-    isGlobal?: boolean;
-    [key: string]: TODO_any;
-};
-/**
- * Parsed request payload for `request_wallet_record`.
- *
- * @private type of WalletCommitmentDefinition
- */
-export type WalletRequestRecord = {
-    recordType: WalletRecordType;
-    service: string;
-    key: string;
-    message?: string;
-    isUserScoped: boolean;
-    isGlobal: boolean;
-};
-/**
- * Runtime wallet-tool action name.
- *
- * @private type of WalletCommitmentDefinition
- */
-export type WalletRuntimeToolAction = 'retrieve' | 'store' | 'update' | 'delete';
-/**
- * Result payload returned when a runtime wallet action is disabled.
- *
- * @private type of WalletCommitmentDefinition
- */
-export type WalletDisabledToolResult = {
-    action: WalletRuntimeToolAction;
-    status: 'disabled';
-    records?: Array<never>;
-    message: string;
-};

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

@@ -1,6 +0,0 @@
-/**
- * Creates WALLET system-message instructions.
- *
- * @private function of WalletCommitmentDefinition
- */
-export declare function createWalletSystemMessage(extraInstructions: string): string;

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

@@ -1,8 +0,0 @@
-import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
-import type { string_javascript_name } from '../../types/string_person_fullname';
-/**
- * Creates runtime wallet tool function implementations.
- *
- * @private function of WalletCommitmentDefinition
- */
-export declare function createWalletToolFunctions(): Record<string_javascript_name, ToolFunction>;

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

@@ -1,7 +0,0 @@
-import type { LlmToolDefinition } from '../../types/LlmToolDefinition';
-/**
- * Creates tool definitions required by WALLET commitment.
- *
- * @private function of WalletCommitmentDefinition
- */
-export declare function createWalletTools(existingTools: ReadonlyArray<LlmToolDefinition> | undefined): LlmToolDefinition[];

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

@@ -1,6 +0,0 @@
-/**
- * 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

@@ -1,16 +0,0 @@
-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

@@ -1,7 +0,0 @@
-import type { string_javascript_name } from '../../types/string_person_fullname';
-/**
- * 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

@@ -1,51 +0,0 @@
-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

@@ -1,8 +0,0 @@
-import type { TODO_any } from '../../utils/organization/TODO_any';
-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

@@ -1,13 +0,0 @@
-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/_common/createSerpSearchToolFunction.d.ts

@@ -1,12 +0,0 @@
-import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
-import type { string_javascript_name } from '../../types/string_person_fullname';
-/**
- * Creates one SERP-backed tool function used as a local fallback for search-like commitments.
- *
- * @param toolName - Technical tool name used for validation messages.
- * @param resultLabel - Human-readable label used in formatted results.
- * @returns Async tool function compatible with commitment tool registration.
- *
- * @private internal helper for search-like commitments
- */
-export declare function createSerpSearchToolFunction(toolName: string_javascript_name, resultLabel: string): ToolFunction;

package/src/commitments/COMPONENT/COMPONENT.ts

@@ -1,70 +0,0 @@
-import { spaceTrim } from 'spacetrim';
-import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
-import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
-
-/**
- * COMPONENT commitment definition
- *
- * The COMPONENT commitment defines a UI component that the agent can render in the chat.
- *
- * @private [🪔] Maybe export the commitments through some package
- */
-export class ComponentCommitmentDefinition extends BaseCommitmentDefinition<'COMPONENT'> {
-    public constructor() {
-        super('COMPONENT');
-    }
-
-    /**
-     * Short one-line description of COMPONENT.
-     */
-    get description(): string {
-        return 'Define a UI component that the agent can render in the chat.';
-    }
-
-    /**
-     * Icon for this commitment.
-     */
-    get icon(): string {
-        return '🧩';
-    }
-
-    /**
-     * Markdown documentation for COMPONENT commitment.
-     */
-    get documentation(): string {
-        return spaceTrim(`
-            # COMPONENT
-
-            Defines a UI component that the agent can render in the chat.
-
-            ## Key aspects
-
-            - Tells the agent that a specific component is available.
-            - Provides syntax for using the component.
-
-            ## Example
-
-            \`\`\`book
-            COMPONENT Arrow
-            The agent should render an arrow component in the chat UI.
-            Syntax:
-            <Arrow direction="up" color="red" />
-            \`\`\`
-        `);
-    }
-
-    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements {
-        const trimmedContent = content.trim();
-
-        if (!trimmedContent) {
-            return requirements;
-        }
-
-        // Add component capability to the system message
-        const componentSection = `Component: ${trimmedContent}`;
-
-        return this.appendToSystemMessage(requirements, componentSection, '\n\n');
-    }
-}
-
-// Note: [💞] Ignore a discrepancy between file name and entity name

package/src/commitments/MEMORY/MEMORY.ts

@@ -1,94 +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';
-import { formatOptionalInstructionBlock } from '../_base/formatOptionalInstructionBlock';
-import { createMemorySystemMessage } from './createMemorySystemMessage';
-import { createMemoryToolFunctions } from './createMemoryToolFunctions';
-import { createMemoryTools } from './createMemoryTools';
-import { getMemoryCommitmentDocumentation } from './getMemoryCommitmentDocumentation';
-import { getMemoryToolTitles } from './getMemoryToolTitles';
-
-export type { MemoryToolRecord, MemoryToolRuntimeAdapter, MemoryToolRuntimeContext } from './MemoryToolRuntimeAdapter';
-export { setMemoryToolRuntimeAdapter } from './setMemoryToolRuntimeAdapter';
-
-/**
- * MEMORY commitment definition
- *
- * The MEMORY commitment is similar to KNOWLEDGE but has a focus on remembering past
- * interactions and user preferences. It helps the agent maintain context about the
- * user's history, preferences, and previous conversations.
- *
- * Example usage in agent source:
- *
- * ```book
- * MEMORY User prefers detailed technical explanations
- * MEMORY Previously worked on React projects
- * MEMORY Timezone: UTC-5 (Eastern Time)
- * ```
- *
- * @private [🪔] Maybe export the commitments through some package
- */
-export class MemoryCommitmentDefinition extends BaseCommitmentDefinition<'MEMORY' | 'MEMORIES'> {
-    public constructor(type: 'MEMORY' | 'MEMORIES' = 'MEMORY') {
-        super(type);
-    }
-
-    override get requiresContent(): boolean {
-        return false;
-    }
-
-    /**
-     * Short one-line description of MEMORY.
-     */
-    get description(): string {
-        return 'Remember past interactions and user **preferences** for personalized responses.';
-    }
-
-    /**
-     * Icon for this commitment.
-     */
-    get icon(): string {
-        return '🧠';
-    }
-
-    /**
-     * Markdown documentation for MEMORY commitment.
-     */
-    get documentation(): string {
-        return getMemoryCommitmentDocumentation(this.type);
-    }
-
-    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements {
-        const extraInstructions = formatOptionalInstructionBlock('Memory instructions', content);
-        const tools = createMemoryTools(requirements.tools);
-
-        return this.appendToSystemMessage(
-            {
-                ...requirements,
-                tools,
-                _metadata: {
-                    ...requirements._metadata,
-                    useMemory: content || true,
-                },
-            },
-            createMemorySystemMessage(extraInstructions),
-        );
-    }
-
-    /**
-     * Gets human-readable titles for MEMORY tool functions.
-     */
-    getToolTitles(): Record<string_javascript_name, string> {
-        return getMemoryToolTitles();
-    }
-
-    /**
-     * Gets MEMORY tool function implementations.
-     */
-    getToolFunctions(): Record<string_javascript_name, ToolFunction> {
-        return createMemoryToolFunctions();
-    }
-}
-
-// Note: [💞] Ignore a discrepancy between file name and entity name

package/src/commitments/MEMORY/MemoryToolNames.ts

@@ -1,13 +0,0 @@
-import type { string_javascript_name } from '../../types/string_person_fullname';
-
-/**
- * Names of tools used by the MEMORY commitment.
- *
- * @private function of MemoryCommitmentDefinition
- */
-export const MemoryToolNames = {
-    retrieve: 'retrieve_user_memory' as string_javascript_name,
-    store: 'store_user_memory' as string_javascript_name,
-    update: 'update_user_memory' as string_javascript_name,
-    delete: 'delete_user_memory' as string_javascript_name,
-} as const;