@promptbook/node 0.114.0-2 → 0.114.0-4

package/umd/src/llm-providers/openai/utils/loadOpenAiAgentsModule.d.ts

@@ -0,0 +1,203 @@
+/// <reference types="node" />
+/**
+ * Loads the OpenAI AgentKit SDK (`@openai/agents`) on demand
+ *
+ * Note: [🐌] The AgentKit SDK is one of the heaviest dependencies of Promptbook, loading it eagerly would slow down
+ *       every single run of the `ptbk` CLI utility even when no AgentKit agent is used
+ *
+ * @private internal utility of `@promptbook/openai`
+ */
+export declare const loadOpenAiAgentsModule: () => Promise<{
+    default: typeof import("@openai/agents");
+    applyPatchTool: typeof import("@openai/agents").applyPatchTool;
+    shellTool: typeof import("@openai/agents").shellTool;
+    realtime: typeof import("@openai/agents-realtime");
+    RuntimeEventEmitter: typeof import("events");
+    Agent: typeof import("@openai/agents").Agent;
+    AgentsError: typeof import("@openai/agents").AgentsError;
+    GuardrailExecutionError: typeof import("@openai/agents").GuardrailExecutionError;
+    InputGuardrailTripwireTriggered: typeof import("@openai/agents").InputGuardrailTripwireTriggered;
+    MaxTurnsExceededError: typeof import("@openai/agents").MaxTurnsExceededError;
+    ModelBehaviorError: typeof import("@openai/agents").ModelBehaviorError;
+    OutputGuardrailTripwireTriggered: typeof import("@openai/agents").OutputGuardrailTripwireTriggered;
+    ToolInputGuardrailTripwireTriggered: typeof import("@openai/agents").ToolInputGuardrailTripwireTriggered;
+    ToolOutputGuardrailTripwireTriggered: typeof import("@openai/agents").ToolOutputGuardrailTripwireTriggered;
+    ToolCallError: typeof import("@openai/agents").ToolCallError;
+    ToolTimeoutError: typeof import("@openai/agents").ToolTimeoutError;
+    UserError: typeof import("@openai/agents").UserError;
+    SystemError: typeof import("@openai/agents").SystemError;
+    RunAgentUpdatedStreamEvent: typeof import("@openai/agents").RunAgentUpdatedStreamEvent;
+    RunRawModelStreamEvent: typeof import("@openai/agents").RunRawModelStreamEvent;
+    RunItemStreamEvent: typeof import("@openai/agents").RunItemStreamEvent;
+    defineOutputGuardrail: typeof import("@openai/agents").defineOutputGuardrail;
+    ToolGuardrailFunctionOutputFactory: {
+        allow(outputInfo?: any): import("@openai/agents").ToolGuardrailFunctionOutput;
+        rejectContent(message: string, outputInfo?: any): import("@openai/agents").ToolGuardrailFunctionOutput;
+        throwException(outputInfo?: any): import("@openai/agents").ToolGuardrailFunctionOutput;
+    };
+    defineToolInputGuardrail: typeof import("@openai/agents").defineToolInputGuardrail;
+    defineToolOutputGuardrail: typeof import("@openai/agents").defineToolOutputGuardrail;
+    resolveToolInputGuardrails: typeof import("@openai/agents").resolveToolInputGuardrails;
+    resolveToolOutputGuardrails: typeof import("@openai/agents").resolveToolOutputGuardrails;
+    getHandoff: typeof import("@openai/agents").getHandoff;
+    getTransferMessage: typeof import("@openai/agents").getTransferMessage;
+    Handoff: typeof import("@openai/agents").Handoff;
+    handoff: typeof import("@openai/agents").handoff;
+    assistant: typeof import("@openai/agents").assistant;
+    system: typeof import("@openai/agents").system;
+    user: typeof import("@openai/agents").user;
+    extractAllTextOutput: typeof import("@openai/agents").extractAllTextOutput;
+    RunHandoffCallItem: typeof import("@openai/agents").RunHandoffCallItem;
+    RunHandoffOutputItem: typeof import("@openai/agents").RunHandoffOutputItem;
+    RunMessageOutputItem: typeof import("@openai/agents").RunMessageOutputItem;
+    RunReasoningItem: typeof import("@openai/agents").RunReasoningItem;
+    RunToolApprovalItem: typeof import("@openai/agents").RunToolApprovalItem;
+    RunToolCallItem: typeof import("@openai/agents").RunToolCallItem;
+    RunToolCallOutputItem: typeof import("@openai/agents").RunToolCallOutputItem;
+    AgentHooks: typeof import("@openai/agents").AgentHooks;
+    getLogger: typeof import("@openai/agents").getLogger;
+    applyDiff: typeof import("@openai/agents").applyDiff;
+    getAllMcpTools: typeof import("@openai/agents").getAllMcpTools;
+    invalidateServerToolsCache: typeof import("@openai/agents").invalidateServerToolsCache;
+    mcpToFunctionTool: typeof import("@openai/agents").mcpToFunctionTool;
+    MCPServerStdio: typeof import("@openai/agents").MCPServerStdio;
+    MCPServerStreamableHttp: typeof import("@openai/agents").MCPServerStreamableHttp;
+    MCPServerSSE: typeof import("@openai/agents").MCPServerSSE;
+    MCPServers: typeof import("@openai/agents").MCPServers;
+    connectMcpServers: typeof import("@openai/agents").connectMcpServers;
+    createMCPToolStaticFilter: typeof import("@openai/agents").createMCPToolStaticFilter;
+    OPENAI_DEFAULT_MODEL_ENV_VARIABLE_NAME: "OPENAI_DEFAULT_MODEL";
+    gpt5ReasoningSettingsRequired: typeof import("@openai/agents").gpt5ReasoningSettingsRequired;
+    getDefaultModel: typeof import("@openai/agents").getDefaultModel;
+    getDefaultModelSettings: typeof import("@openai/agents").getDefaultModelSettings;
+    isGpt5Default: typeof import("@openai/agents").isGpt5Default;
+    setDefaultModelProvider: typeof import("@openai/agents").setDefaultModelProvider;
+    RunResult: typeof import("@openai/agents").RunResult;
+    StreamedRunResult: typeof import("@openai/agents").StreamedRunResult;
+    run: typeof import("@openai/agents").run;
+    Runner: typeof import("@openai/agents").Runner;
+    RunContext: typeof import("@openai/agents").RunContext;
+    RunState: typeof import("@openai/agents").RunState;
+    computerTool: typeof import("@openai/agents").computerTool;
+    hostedMcpTool: typeof import("@openai/agents").hostedMcpTool;
+    tool: typeof import("@openai/agents").tool;
+    invokeFunctionTool: typeof import("@openai/agents").invokeFunctionTool;
+    getGlobalTraceProvider: typeof import("@openai/agents").getGlobalTraceProvider;
+    TraceProvider: typeof import("@openai/agents").TraceProvider;
+    runToolInputGuardrails: typeof import("@openai/agents").runToolInputGuardrails;
+    runToolOutputGuardrails: typeof import("@openai/agents").runToolOutputGuardrails;
+    RequestUsage: typeof import("@openai/agents").RequestUsage;
+    Usage: typeof import("@openai/agents").Usage;
+    isOpenAIResponsesCompactionAwareSession: typeof import("@openai/agents").isOpenAIResponsesCompactionAwareSession;
+    MemorySession: typeof import("@openai/agents").MemorySession;
+    protocol: typeof import("@openai/agents-core/dist/types/protocol");
+    addTraceProcessor(processor: import("@openai/agents").TracingProcessor): void;
+    setTraceProcessors(processors: import("@openai/agents").TracingProcessor[]): void;
+    setTracingDisabled(disabled: boolean): void;
+    startTraceExportLoop(): void;
+    getCurrentSpan: typeof import("@openai/agents").getCurrentSpan;
+    getCurrentTrace: typeof import("@openai/agents").getCurrentTrace;
+    getOrCreateTrace: typeof import("@openai/agents").getOrCreateTrace;
+    resetCurrentSpan: typeof import("@openai/agents").resetCurrentSpan;
+    setCurrentSpan: typeof import("@openai/agents").setCurrentSpan;
+    withTrace: typeof import("@openai/agents").withTrace;
+    BatchTraceProcessor: typeof import("@openai/agents").BatchTraceProcessor;
+    ConsoleSpanExporter: typeof import("@openai/agents").ConsoleSpanExporter;
+    NoopSpan: typeof import("@openai/agents").NoopSpan;
+    Span: typeof import("@openai/agents").Span;
+    NoopTrace: typeof import("@openai/agents").NoopTrace;
+    Trace: typeof import("@openai/agents").Trace;
+    generateGroupId: typeof import("@openai/agents").generateGroupId;
+    generateSpanId: typeof import("@openai/agents").generateSpanId;
+    generateTraceId: typeof import("@openai/agents").generateTraceId;
+    createResponseSpan(options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").ResponseSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").ResponseSpanData>;
+    createAgentSpan(options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").AgentSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").AgentSpanData>;
+    createFunctionSpan(options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").FunctionSpanData>> & {
+        data: {
+            name: string;
+        };
+    }, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").FunctionSpanData>;
+    createHandoffSpan(options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").HandoffSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").HandoffSpanData>;
+    createGenerationSpan(options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").GenerationSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").GenerationSpanData>;
+    createCustomSpan(options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").CustomSpanData>> & {
+        data: {
+            name: string;
+        };
+    }, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").CustomSpanData>;
+    createGuardrailSpan(options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").GuardrailSpanData>> & {
+        data: {
+            name: string;
+        };
+    }, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").GuardrailSpanData>;
+    createTranscriptionSpan(options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").TranscriptionSpanData>> & {
+        data: {
+            input: {
+                data: string;
+                format: (string & {}) | "pcm";
+            };
+        };
+    }, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").TranscriptionSpanData>;
+    createSpeechSpan(options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").SpeechSpanData>> & {
+        data: {
+            output: {
+                data: string;
+                format: (string & {}) | "pcm";
+            };
+        };
+    }, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").SpeechSpanData>;
+    createSpeechGroupSpan(options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").SpeechGroupSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").SpeechGroupSpanData>;
+    createMCPListToolsSpan(options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").MCPListToolsSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined): import("@openai/agents").Span<import("@openai/agents").MCPListToolsSpanData>;
+    withResponseSpan: <TOutput>(fn: (span: import("@openai/agents").Span<import("@openai/agents").ResponseSpanData>) => Promise<TOutput>, options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").ResponseSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput>;
+    withAgentSpan: <TOutput_1>(fn: (span: import("@openai/agents").Span<import("@openai/agents").AgentSpanData>) => Promise<TOutput_1>, options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").AgentSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_1>;
+    withFunctionSpan: <TOutput_2>(fn: (span: import("@openai/agents").Span<import("@openai/agents").FunctionSpanData>) => Promise<TOutput_2>, options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").FunctionSpanData>> & {
+        data: {
+            name: string;
+        };
+    }, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_2>;
+    withHandoffSpan: <TOutput_3>(fn: (span: import("@openai/agents").Span<import("@openai/agents").HandoffSpanData>) => Promise<TOutput_3>, options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").HandoffSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_3>;
+    withGenerationSpan: <TOutput_4>(fn: (span: import("@openai/agents").Span<import("@openai/agents").GenerationSpanData>) => Promise<TOutput_4>, options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").GenerationSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_4>;
+    withCustomSpan: <TOutput_5>(fn: (span: import("@openai/agents").Span<import("@openai/agents").CustomSpanData>) => Promise<TOutput_5>, options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").CustomSpanData>> & {
+        data: {
+            name: string;
+        };
+    }, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_5>;
+    withGuardrailSpan: <TOutput_6>(fn: (span: import("@openai/agents").Span<import("@openai/agents").GuardrailSpanData>) => Promise<TOutput_6>, options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").GuardrailSpanData>> & {
+        data: {
+            name: string;
+        };
+    }, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_6>;
+    withTranscriptionSpan: <TOutput_7>(fn: (span: import("@openai/agents").Span<import("@openai/agents").TranscriptionSpanData>) => Promise<TOutput_7>, options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").TranscriptionSpanData>> & {
+        data: {
+            input: {
+                data: string;
+                format: (string & {}) | "pcm";
+            };
+        };
+    }, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_7>;
+    withSpeechSpan: <TOutput_8>(fn: (span: import("@openai/agents").Span<import("@openai/agents").SpeechSpanData>) => Promise<TOutput_8>, options: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").SpeechSpanData>> & {
+        data: {
+            output: {
+                data: string;
+                format: (string & {}) | "pcm";
+            };
+        };
+    }, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_8>;
+    withSpeechGroupSpan: <TOutput_9>(fn: (span: import("@openai/agents").Span<import("@openai/agents").SpeechGroupSpanData>) => Promise<TOutput_9>, options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").SpeechGroupSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_9>;
+    withMCPListToolsSpan: <TOutput_10>(fn: (span: import("@openai/agents").Span<import("@openai/agents").MCPListToolsSpanData>) => Promise<TOutput_10>, options?: import("@openai/agents-core/types").DeepPartial<import("@openai/agents-core/dist/tracing/provider").CreateSpanOptions<import("@openai/agents").MCPListToolsSpanData>> | undefined, parent?: import("@openai/agents").Trace | import("@openai/agents").Span<any> | undefined) => Promise<TOutput_10>;
+    OpenAIProvider: typeof import("@openai/agents").OpenAIProvider;
+    OpenAIResponsesModel: typeof import("@openai/agents").OpenAIResponsesModel;
+    OpenAIChatCompletionsModel: typeof import("@openai/agents").OpenAIChatCompletionsModel;
+    setDefaultOpenAIClient: typeof import("@openai/agents").setDefaultOpenAIClient;
+    setOpenAIAPI: typeof import("@openai/agents").setOpenAIAPI;
+    setDefaultOpenAIKey: typeof import("@openai/agents").setDefaultOpenAIKey;
+    setTracingExportApiKey: typeof import("@openai/agents").setTracingExportApiKey;
+    setDefaultOpenAITracingExporter: typeof import("@openai/agents").setDefaultOpenAITracingExporter;
+    OpenAITracingExporter: typeof import("@openai/agents").OpenAITracingExporter;
+    webSearchTool: typeof import("@openai/agents").webSearchTool;
+    fileSearchTool: typeof import("@openai/agents").fileSearchTool;
+    codeInterpreterTool: typeof import("@openai/agents").codeInterpreterTool;
+    imageGenerationTool: typeof import("@openai/agents").imageGenerationTool;
+    OpenAIConversationsSession: typeof import("@openai/agents").OpenAIConversationsSession;
+    startOpenAIConversationsSession: typeof import("@openai/agents").startOpenAIConversationsSession;
+    OpenAIResponsesCompactionSession: typeof import("@openai/agents").OpenAIResponsesCompactionSession;
+}>;

package/umd/src/llm-providers/openai/utils/uploadFilesToOpenAi.d.ts

@@ -1,4 +1,4 @@
-import OpenAI from 'openai';
+import type OpenAI from 'openai';
 /**
  * Uploads files to OpenAI and returns their IDs
  *

package/umd/src/{commitments/USE_BROWSER → scrapers/_common/utils}/fetchUrlContent.d.ts

@@ -8,12 +8,11 @@
  * 4. Returns the scraped markdown content
  *
  * WARNING: This function should NOT be used directly in browser environments.
- * For browser environments, use fetchUrlContentViaBrowser which proxies through
- * the Agents Server API endpoint at /api/scrape
+ * For browser environments, proxy the request through the Agents Server API endpoint at /api/scrape
  *
  * @param url The URL to fetch and scrape
  * @returns Markdown content from the URL
  *
- * @private internal utility for USE BROWSER commitment
+ * @private internal scraping utility
  */
 export declare function fetchUrlContent(url: string): Promise<string>;

package/umd/src/utils/misc/createLazyModuleLoader.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Creates a loader which imports one module on the first call and reuses the very same module afterwards
+ *
+ * Note: [🐌] Heavy third-party dependencies are imported lazily to keep the startup of the Promptbook CLI fast.
+ *       A statically imported dependency is loaded every single time the bundle is loaded, even when the running
+ *       command never touches it. A lazily imported dependency is loaded only when the feature is really used.
+ *
+ * @example
+ * const loadJsdomModule = createLazyModuleLoader(() => import('jsdom'));
+ * const { JSDOM } = await loadJsdomModule();
+ *
+ * @private internal utility of Promptbook
+ */
+export declare function createLazyModuleLoader<TModule>(importModule: () => Promise<TModule>): () => Promise<TModule>;

package/umd/src/version.d.ts

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

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

@@ -1,48 +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 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 declare class MemoryCommitmentDefinition extends BaseCommitmentDefinition<'MEMORY' | 'MEMORIES'> {
-    constructor(type?: 'MEMORY' | 'MEMORIES');
-    get requiresContent(): boolean;
-    /**
-     * Short one-line description of MEMORY.
-     */
-    get description(): string;
-    /**
-     * Icon for this commitment.
-     */
-    get icon(): string;
-    /**
-     * Markdown documentation for MEMORY commitment.
-     */
-    get documentation(): string;
-    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
-    /**
-     * Gets human-readable titles for MEMORY tool functions.
-     */
-    getToolTitles(): Record<string_javascript_name, string>;
-    /**
-     * Gets MEMORY tool function implementations.
-     */
-    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
-}

package/esm/src/commitments/MEMORY/MemoryToolNames.d.ts

@@ -1,11 +0,0 @@
-/**
- * Names of tools used by the MEMORY commitment.
- *
- * @private function of MemoryCommitmentDefinition
- */
-export declare const MemoryToolNames: {
-    readonly retrieve: string;
-    readonly store: string;
-    readonly update: string;
-    readonly delete: string;
-};

package/esm/src/commitments/MEMORY/MemoryToolRuntimeAdapter.d.ts

@@ -1,149 +0,0 @@
-import type { TODO_any } from '../../utils/organization/TODO_any';
-/**
- * Tool arguments for retrieving memory.
- *
- * @private type of MemoryCommitmentDefinition
- */
-export type RetrieveMemoryToolArgs = {
-    query?: string;
-    limit?: number;
-    [key: string]: TODO_any;
-};
-/**
- * Tool arguments for storing memory.
- *
- * @private type of MemoryCommitmentDefinition
- */
-export type StoreMemoryToolArgs = {
-    content?: string;
-    isGlobal?: boolean;
-    [key: string]: TODO_any;
-};
-/**
- * Tool arguments for updating memory.
- *
- * @private type of MemoryCommitmentDefinition
- */
-export type UpdateMemoryToolArgs = {
-    memoryId?: string;
-    content?: string;
-    isGlobal?: boolean;
-    [key: string]: TODO_any;
-};
-/**
- * Tool arguments for deleting memory.
- *
- * @private type of MemoryCommitmentDefinition
- */
-export type DeleteMemoryToolArgs = {
-    memoryId?: string;
-    [key: string]: TODO_any;
-};
-/**
- * Memory record returned by runtime adapters.
- *
- * @private type of MemoryCommitmentDefinition
- */
-export type MemoryToolRecord = {
-    id?: string;
-    content: string;
-    isGlobal: boolean;
-    createdAt?: string;
-    updatedAt?: string;
-};
-/**
- * Runtime context for MEMORY tools resolved from hidden tool arguments.
- *
- * @private type of MemoryCommitmentDefinition
- */
-export type MemoryToolRuntimeContext = {
-    readonly enabled: boolean;
-    readonly userId?: number;
-    readonly username?: string;
-    readonly agentId?: string;
-    readonly agentName?: string;
-    readonly isTeamConversation: boolean;
-    readonly isPrivateMode: boolean;
-};
-/**
- * Result payload returned by retrieve memory tool.
- *
- * @private type of MemoryCommitmentDefinition
- */
-export type RetrieveMemoryToolResult = {
-    action: 'retrieve';
-    status: 'ok' | 'disabled' | 'error';
-    query?: string;
-    memories: MemoryToolRecord[];
-    message?: string;
-};
-/**
- * Result payload returned by store memory tool.
- *
- * @private type of MemoryCommitmentDefinition
- */
-export type StoreMemoryToolResult = {
-    action: 'store';
-    status: 'stored' | 'disabled' | 'error';
-    memory?: MemoryToolRecord;
-    message?: string;
-};
-/**
- * Result payload returned by update memory tool.
- *
- * @private type of MemoryCommitmentDefinition
- */
-export type UpdateMemoryToolResult = {
-    action: 'update';
-    status: 'updated' | 'disabled' | 'error';
-    memory?: MemoryToolRecord;
-    message?: string;
-};
-/**
- * Result payload returned by delete memory tool.
- *
- * @private type of MemoryCommitmentDefinition
- */
-export type DeleteMemoryToolResult = {
-    action: 'delete';
-    status: 'deleted' | 'disabled' | 'error';
-    memoryId?: string;
-    message?: string;
-};
-/**
- * Union of all MEMORY tool actions.
- *
- * @private type of MemoryCommitmentDefinition
- */
-export type MemoryToolAction = RetrieveMemoryToolResult['action'] | StoreMemoryToolResult['action'] | UpdateMemoryToolResult['action'] | DeleteMemoryToolResult['action'];
-/**
- * Union of all MEMORY tool result payloads.
- *
- * @private type of MemoryCommitmentDefinition
- */
-export type MemoryToolResult = RetrieveMemoryToolResult | StoreMemoryToolResult | UpdateMemoryToolResult | DeleteMemoryToolResult;
-/**
- * Runtime adapter interface used by MEMORY tools.
- *
- * @private type of MemoryCommitmentDefinition
- */
-export type MemoryToolRuntimeAdapter = {
-    retrieveMemories(args: {
-        query?: string;
-        limit?: number;
-    }, runtimeContext: MemoryToolRuntimeContext): Promise<MemoryToolRecord[]>;
-    storeMemory(args: {
-        content: string;
-        isGlobal: boolean;
-    }, runtimeContext: MemoryToolRuntimeContext): Promise<MemoryToolRecord>;
-    updateMemory(args: {
-        memoryId: string;
-        content: string;
-        isGlobal?: boolean;
-    }, runtimeContext: MemoryToolRuntimeContext): Promise<MemoryToolRecord>;
-    deleteMemory(args: {
-        memoryId: string;
-    }, runtimeContext: MemoryToolRuntimeContext): Promise<{
-        id?: string;
-    }>;
-};

package/esm/src/commitments/MEMORY/createMemorySystemMessage.d.ts

@@ -1,6 +0,0 @@
-/**
- * Builds the MEMORY instruction block appended to the system message.
- *
- * @private function of MemoryCommitmentDefinition
- */
-export declare function createMemorySystemMessage(extraInstructions: string): string;

package/esm/src/commitments/MEMORY/createMemoryToolFunctions.d.ts

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

package/esm/src/commitments/MEMORY/createMemoryTools.d.ts

@@ -1,14 +0,0 @@
-import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
-/**
- * Concrete type of tool definitions in `AgentModelRequirements`.
- *
- * @private type of MemoryCommitmentDefinition
- */
-type AgentModelTools = NonNullable<AgentModelRequirements['tools']>;
-/**
- * Creates MEMORY tool definitions while preserving already-registered tools.
- *
- * @private function of MemoryCommitmentDefinition
- */
-export declare function createMemoryTools(existingTools: AgentModelRequirements['tools']): AgentModelTools;
-export {};

package/esm/src/commitments/MEMORY/getMemoryCommitmentDocumentation.d.ts

@@ -1,6 +0,0 @@
-/**
- * Markdown documentation for MEMORY commitment.
- *
- * @private function of MemoryCommitmentDefinition
- */
-export declare function getMemoryCommitmentDocumentation(type: 'MEMORY' | 'MEMORIES'): string;

package/esm/src/commitments/MEMORY/getMemoryToolRuntimeAdapterOrDisabledResult.d.ts

@@ -1,17 +0,0 @@
-import type { DeleteMemoryToolResult, MemoryToolAction, MemoryToolRuntimeAdapter, MemoryToolRuntimeContext, RetrieveMemoryToolResult, StoreMemoryToolResult, UpdateMemoryToolResult } from './MemoryToolRuntimeAdapter';
-/**
- * Return type of MEMORY adapter resolution helper.
- *
- * @private type of MemoryCommitmentDefinition
- */
-type MemoryToolRuntimeAdapterResolution = {
-    adapter: MemoryToolRuntimeAdapter | null;
-    disabledResult: RetrieveMemoryToolResult | StoreMemoryToolResult | UpdateMemoryToolResult | DeleteMemoryToolResult | null;
-};
-/**
- * Gets the runtime adapter and returns a disabled result when unavailable.
- *
- * @private function of MemoryCommitmentDefinition
- */
-export declare function getMemoryToolRuntimeAdapterOrDisabledResult(action: MemoryToolAction, runtimeContext: MemoryToolRuntimeContext): MemoryToolRuntimeAdapterResolution;
-export {};

package/esm/src/commitments/MEMORY/getMemoryToolTitles.d.ts

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

package/esm/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/esm/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/esm/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;