@promptbook/javascript 0.114.0-1 → 0.114.0-10

package/umd/src/cli/cli-commands/common/promptbook-cli/$updatePromptbookCliInstallation.d.ts

@@ -0,0 +1,10 @@
+import type { PromptbookCliInstallationStatus } from './PromptbookCliInstallationStatus';
+/**
+ * Updates one Promptbook CLI package in its existing local or global location.
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it installs an npm package
+ *
+ * @returns `true` when the package update succeeds, `false` when it fails
+ * @private internal utility of `promptbookCli`
+ */
+export declare function $updatePromptbookCliInstallation(status: PromptbookCliInstallationStatus): Promise<boolean>;

package/umd/src/cli/cli-commands/common/promptbook-cli/$updatePromptbookCliInstallation.test.d.ts

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

package/umd/src/cli/cli-commands/common/promptbook-cli/PromptbookCliInstallation.d.ts

@@ -0,0 +1,66 @@
+import type { NpmPackageInstallationLocation } from '../npm/buildNpmPackageInstallCommand';
+/**
+ * Npm packages which directly provide the `ptbk` executable.
+ *
+ * `ptbk` is the preferred package and forwards to `@promptbook/cli`; the latter can also be installed directly.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export declare const PROMPTBOOK_CLI_NPM_PACKAGE_NAMES: readonly ["ptbk", "@promptbook/cli"];
+/**
+ * Npm package which directly provides the `ptbk` executable.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export type PromptbookCliNpmPackageName = (typeof PROMPTBOOK_CLI_NPM_PACKAGE_NAMES)[number];
+/**
+ * Place where one Promptbook CLI package is installed.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export type PromptbookCliInstallationLocation = NpmPackageInstallationLocation;
+/**
+ * Fields shared by local and global Promptbook CLI installations.
+ *
+ * @private internal utility of `PromptbookCliInstallation`
+ */
+type PromptbookCliInstallationBase = {
+    /**
+     * Npm package that provides the CLI.
+     */
+    readonly npmPackageName: PromptbookCliNpmPackageName;
+    /**
+     * Version from the installed package's `package.json`.
+     */
+    readonly installedVersion: string;
+};
+/**
+ * One directly declared local Promptbook CLI installation.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export type LocalPromptbookCliInstallation = PromptbookCliInstallationBase & {
+    /**
+     * Local manifest section containing the package.
+     */
+    readonly installationLocation: Exclude<PromptbookCliInstallationLocation, 'global'>;
+    /**
+     * Project directory containing the `package.json` which declares the package.
+     */
+    readonly projectPath: string;
+};
+/**
+ * One directly installed global Promptbook CLI package.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export type GlobalPromptbookCliInstallation = PromptbookCliInstallationBase & {
+    readonly installationLocation: 'global';
+};
+/**
+ * One local or global Promptbook CLI package that can be updated.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export type PromptbookCliInstallation = LocalPromptbookCliInstallation | GlobalPromptbookCliInstallation;
+export {};

package/umd/src/cli/cli-commands/common/promptbook-cli/PromptbookCliInstallationStatus.d.ts

@@ -0,0 +1,26 @@
+import type { PromptbookCliInstallation } from './PromptbookCliInstallation';
+/**
+ * Result of comparing one installed Promptbook CLI package with the newest published version.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export type PromptbookCliInstallationState = 'up-to-date' | 'outdated' | 'unknown';
+/**
+ * Version status of one Promptbook CLI installation.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export type PromptbookCliInstallationStatus = {
+    /**
+     * Installed CLI package being checked.
+     */
+    readonly installation: PromptbookCliInstallation;
+    /**
+     * Result of comparing the installed version with the newest published version.
+     */
+    readonly installationState: PromptbookCliInstallationState;
+    /**
+     * Newest published package version, or `null` when npm could not be reached.
+     */
+    readonly latestVersion: string | null;
+};

package/umd/src/cli/cli-commands/common/promptbook-cli/buildPromptbookCliInstallCommand.d.ts

@@ -0,0 +1,7 @@
+import type { PromptbookCliInstallation } from './PromptbookCliInstallation';
+/**
+ * Builds the npm command that updates one existing Promptbook CLI installation.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export declare function buildPromptbookCliInstallCommand(installation: PromptbookCliInstallation): string;

package/umd/src/cli/cli-commands/common/promptbook-cli/formatPromptbookCliInstallationWarning.d.ts

@@ -0,0 +1,7 @@
+import type { PromptbookCliInstallationStatus } from './PromptbookCliInstallationStatus';
+/**
+ * Formats the warning shown when one or more Promptbook CLI installations are outdated.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export declare function formatPromptbookCliInstallationWarning(statuses: ReadonlyArray<PromptbookCliInstallationStatus>): string;

package/umd/src/cli/common/loadPromptsModule.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="prompts" />
+/**
+ * Loads the interactive terminal prompt library (`prompts`) on demand
+ *
+ * Note: [🐌] Loaded lazily to keep the startup of the `ptbk` CLI utility fast - most commands never ask the user
+ *       anything interactively
+ *
+ * @private internal utility of Promptbook CLI
+ */
+export declare const loadPromptsModule: () => Promise<{
+    default: typeof import("prompts");
+    inject: typeof import("prompts").inject;
+    override: typeof import("prompts").override;
+    prompt: any;
+    prompts: typeof import("prompts").prompts;
+}>;

package/umd/src/commitments/{COMPONENT/COMPONENT.d.ts → META_FULLNAME/META_FULLNAME.d.ts}

@@ -1,16 +1,19 @@
 import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
- * COMPONENT commitment definition
+ * META FULLNAME commitment definition
  *
- * The COMPONENT commitment defines a UI component that the agent can render in the chat.
+ * The `META FULLNAME` commitment sets the full display name of the agent, which can differ
+ * from the agent name on the first line of the agent source, for example when the agent
+ * should be presented with academic titles.
+ * This commitment is metadata-only and does not modify model requirements.
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class ComponentCommitmentDefinition extends BaseCommitmentDefinition<'COMPONENT'> {
+export declare class MetaFullnameCommitmentDefinition extends BaseCommitmentDefinition<'META FULLNAME'> {
     constructor();
     /**
-     * Short one-line description of COMPONENT.
+     * Short one-line description of META FULLNAME.
      */
     get description(): string;
     /**
@@ -18,7 +21,7 @@ export declare class ComponentCommitmentDefinition extends BaseCommitmentDefinit
      */
     get icon(): string;
     /**
-     * Markdown documentation for COMPONENT commitment.
+     * Markdown documentation for META FULLNAME commitment.
      */
     get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;

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

@@ -0,0 +1,32 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * META ID commitment definition
+ *
+ * The `META ID` commitment carries the permanent id of the agent when an agent source is moved
+ * between systems. It is a low-level commitment which is normally written and stripped by the
+ * persistence layer instead of being written by hand.
+ * This commitment is metadata-only and does not modify model requirements.
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class MetaIdCommitmentDefinition extends BaseCommitmentDefinition<'META ID'> {
+    constructor();
+    /**
+     * Short one-line description of META ID.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * `META ID` is written by the persistence layer, not by agent authors.
+     */
+    get isLowLevel(): boolean;
+    /**
+     * Markdown documentation for META ID commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}

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

@@ -1,6 +1,5 @@
 import { ActionCommitmentDefinition } from './ACTION/ACTION';
 import { ClosedCommitmentDefinition } from './CLOSED/CLOSED';
-import { ComponentCommitmentDefinition } from './COMPONENT/COMPONENT';
 import { DeleteCommitmentDefinition } from './DELETE/DELETE';
 import { DictionaryCommitmentDefinition } from './DICTIONARY/DICTIONARY';
 import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
@@ -9,19 +8,20 @@ import { GoalCommitmentDefinition } from './GOAL/GOAL';
 import { ImportCommitmentDefinition } from './IMPORT/IMPORT';
 import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
 import { LanguageCommitmentDefinition } from './LANGUAGE/LANGUAGE';
-import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
 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 { MetaAvatarCommitmentDefinition } from './META_AVATAR/META_AVATAR';
 import { MetaColorCommitmentDefinition } from './META_COLOR/META_COLOR';
+import { MetaDescriptionCommitmentDefinition } from './META_DESCRIPTION/META_DESCRIPTION';
 import { MetaDomainCommitmentDefinition } from './META_DOMAIN/META_DOMAIN';
 import { MetaDisclaimerCommitmentDefinition } from './META_DISCLAIMER/META_DISCLAIMER';
 import { MetaFontCommitmentDefinition } from './META_FONT/META_FONT';
+import { MetaFullnameCommitmentDefinition } from './META_FULLNAME/META_FULLNAME';
+import { MetaIdCommitmentDefinition } from './META_ID/META_ID';
 import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
 import { MetaInputPlaceholderCommitmentDefinition } from './META_INPUT_PLACEHOLDER/META_INPUT_PLACEHOLDER';
 import { MetaLinkCommitmentDefinition } from './META_LINK/META_LINK';
@@ -38,21 +38,13 @@ import { ScenarioCommitmentDefinition } from './SCENARIO/SCENARIO';
 import { StyleCommitmentDefinition } from './STYLE/STYLE';
 import { TeamCommitmentDefinition } from './TEAM/TEAM';
 import { TemplateCommitmentDefinition } from './TEMPLATE/TEMPLATE';
-import { UseBrowserCommitmentDefinition } from './USE_BROWSER/USE_BROWSER';
 import { UseCalendarCommitmentDefinition } from './USE_CALENDAR/USE_CALENDAR';
-import { UseDeepSearchCommitmentDefinition } from './USE_DEEPSEARCH/USE_DEEPSEARCH';
-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 { WalletCommitmentDefinition } from './WALLET/WALLET';
 import { WritingRulesCommitmentDefinition } from './WRITING_RULES/WRITING_RULES';
 import { WritingSampleCommitmentDefinition } from './WRITING_SAMPLE/WRITING_SAMPLE';
 import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
@@ -63,4 +55,4 @@ 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, WritingSampleCommitmentDefinition, WritingRulesCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaAvatarCommitmentDefinition, MetaAvatarCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDomainCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaInputPlaceholderCommitmentDefinition, MetaThinkingMessageCommitmentDefinition, MetaVisibilityCommitmentDefinition, MetaCommitmentDefinition, MetaVoiceCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, InternalMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageSuffixCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, WalletCommitmentDefinition, WalletCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, TeamCommitmentDefinition, UseBrowserCommitmentDefinition, UseDeepSearchCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseSpawnCommitmentDefinition, UseTimeoutCommitmentDefinition, UseTimeCommitmentDefinition, UseUserLocationCommitmentDefinition, UseCalendarCommitmentDefinition, UseEmailCommitmentDefinition, UsePopupCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UsePrivacyCommitmentDefinition, UseProjectCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
+export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, WritingSampleCommitmentDefinition, WritingRulesCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, MetaAvatarCommitmentDefinition, MetaAvatarCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDomainCommitmentDefinition, MetaDescriptionCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaFullnameCommitmentDefinition, MetaIdCommitmentDefinition, MetaInputPlaceholderCommitmentDefinition, MetaThinkingMessageCommitmentDefinition, MetaVisibilityCommitmentDefinition, 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, UseUserLocationCommitmentDefinition, UseCalendarCommitmentDefinition, UsePopupCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UsePrivacyCommitmentDefinition, UseProjectCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];

package/umd/src/llm-providers/agent/Agent.d.ts

@@ -45,7 +45,7 @@ export declare class Agent extends AgentLlmExecutionTools implements LlmExecutio
     links: Array<string_agent_url>;
     /**
      * Capabilities of the agent
-     * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
+     * This is parsed from commitments like USE CALENDAR, USE PROJECT, KNOWLEDGE, etc.
      */
     capabilities: Array<AgentCapability>;
     /**

package/umd/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -1,4 +1,4 @@
-import Anthropic from '@anthropic-ai/sdk';
+import type Anthropic from '@anthropic-ai/sdk';
 import type { ChatParticipant } from '../../book-components/Chat/types/ChatParticipant';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';

package/umd/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts

@@ -1,4 +1,4 @@
-import { OpenAIClient } from '@azure/openai';
+import type { OpenAIClient } from '@azure/openai';
 import type { ChatParticipant } from '../../book-components/Chat/types/ChatParticipant';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';

package/umd/src/llm-providers/openai/OpenAiAgentKitExecutionTools.d.ts

@@ -1,4 +1,4 @@
-import { Agent as AgentFromKit } from '@openai/agents';
+import type { Agent as AgentFromKit } from '@openai/agents';
 import type { CallChatModelStreamOptions, LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
 import type { ModelRequirements } from '../../types/ModelRequirements';

package/umd/src/llm-providers/openai/OpenAiAgentKitExecutionToolsToolBuilder.d.ts

@@ -38,7 +38,7 @@ export declare class OpenAiAgentKitExecutionToolsToolBuilder {
     buildAgentKitTools(options: {
         readonly tools?: ModelRequirements['tools'];
         readonly vectorStoreId?: string;
-    }): Array<AgentKitTool>;
+    }): Promise<Array<AgentKitTool>>;
     /**
      * Resolves the stored Promptbook tool result for one AgentKit tool call.
      */
@@ -73,7 +73,7 @@ export declare class OpenAiAgentKitExecutionToolsToolBuilder {
      */
     private normalizeAgentKitToolParameters;
     /**
-     * Creates the native Agent SDK tool used for `USE DEEPSEARCH`.
+     * Creates the native Agent SDK tool used for the DeepSearch capability.
      */
     private createDeepSearchAgentKitTool;
     /**

package/umd/src/llm-providers/openai/OpenAiAssistantExecutionToolsStreamRunner.d.ts

@@ -1,4 +1,4 @@
-import OpenAI from 'openai';
+import type OpenAI from 'openai';
 import type { ChatPromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
 import type { string_date_iso8601, string_token } from '../../types/string_token';

package/umd/src/llm-providers/openai/OpenAiAssistantExecutionToolsToolRunner.d.ts

@@ -1,4 +1,4 @@
-import OpenAI from 'openai';
+import type OpenAI from 'openai';
 import type { ChatPromptResult } from '../../execution/PromptResult';
 import type { ScriptExecutionTools } from '../../execution/ScriptExecutionTools';
 import type { Prompt } from '../../types/Prompt';

package/umd/src/llm-providers/openai/OpenAiCompatibleNonChatPromptCaller.d.ts

@@ -1,4 +1,4 @@
-import OpenAI from 'openai';
+import type OpenAI from 'openai';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { CompletionPromptResult, EmbeddingPromptResult, ImagePromptResult } from '../../execution/PromptResult';
 import type { Usage } from '../../execution/Usage';

package/umd/src/llm-providers/openai/OpenAiCompatibleRequestManager.d.ts

@@ -1,4 +1,4 @@
-import OpenAI from 'openai';
+import type OpenAI from 'openai';
 import type { OpenAiCompatibleExecutionToolsNonProxiedOptions } from './OpenAiCompatibleExecutionToolsOptions';
 /**
  * Manages OpenAI-compatible client creation plus shared retry and rate-limit behavior.

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

@@ -1,4 +1,4 @@
-import OpenAI from 'openai';
+import type OpenAI from 'openai';
 import type { AvailableModel } from '../../../execution/AvailableModel';
 import type { ChatPromptResult } from '../../../execution/PromptResult';
 import type { Usage } from '../../../execution/Usage';

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/agent-message-runtime/resolveAgentMessageRuntimeActivity.d.ts

@@ -5,9 +5,9 @@
  * Claude Code `--output-format stream-json`) into a live runtime log file next to the queued
  * message. This helper extracts the most recent natural-language assistant narration so the
  * durable chat can show what the agent is doing right now instead of a generic thinking
- * placeholder. Only plain assistant text is surfaced; raw tool payloads, JSON envelopes and
- * other technical details are intentionally ignored, and harnesses that do not stream
- * structured text simply resolve to `null` so the caller keeps its existing behavior.
+ * placeholder. Only concrete, safe activity is surfaced; raw tool payloads, JSON envelopes,
+ * and private reasoning are intentionally ignored. When no concrete activity is known, this
+ * resolves to `null` so the caller keeps the browser's rotating generic thinking state.
  *
  * @param logText - Raw runtime log content.
  * @returns Latest human-readable activity snippet, or `null` when none can be resolved.