@promptbook/openai 0.114.0-2 → 0.114.0-21

package/umd/index.umd.js

@@ -1,15 +1,14 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('spacetrim'), require('crypto-js'), require('colors'), require('bottleneck'), require('openai'), require('socket.io-client'), require('@openai/agents')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'spacetrim', 'crypto-js', 'colors', 'bottleneck', 'openai', 'socket.io-client', '@openai/agents'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-openai"] = {}, global.spacetrim, global.CryptoJS, global.colors, global.Bottleneck, global.OpenAI, global.socket_ioClient, global.agents));
-})(this, (function (exports, spacetrim, CryptoJS, colors, Bottleneck, OpenAI, socket_ioClient, agents) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('spacetrim'), require('crypto-js'), require('colors'), require('bottleneck')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'spacetrim', 'crypto-js', 'colors', 'bottleneck'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-openai"] = {}, global.spacetrim, global.CryptoJS, global.colors, global.Bottleneck));
+})(this, (function (exports, spacetrim, CryptoJS, colors, Bottleneck) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
     var CryptoJS__default = /*#__PURE__*/_interopDefaultLegacy(CryptoJS);
     var colors__default = /*#__PURE__*/_interopDefaultLegacy(colors);
     var Bottleneck__default = /*#__PURE__*/_interopDefaultLegacy(Bottleneck);
-    var OpenAI__default = /*#__PURE__*/_interopDefaultLegacy(OpenAI);
 
     // ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
     /**
@@ -25,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.114.0-2';
+    const PROMPTBOOK_ENGINE_VERSION = '0.114.0-21';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2791,28 +2790,28 @@
      */
     function buildToolInvocationScript(options) {
         const { functionName, functionArgsExpression } = options;
-        return `
-        const args = ${functionArgsExpression};
-        const runtimeContextRaw =
-            typeof ${TOOL_RUNTIME_CONTEXT_PARAMETER} === 'undefined'
-                ? undefined
-                : ${TOOL_RUNTIME_CONTEXT_PARAMETER};
+        return spacetrim.spaceTrim((block) => `
+            const args = ${block(functionArgsExpression)};
+            const runtimeContextRaw =
+                typeof ${TOOL_RUNTIME_CONTEXT_PARAMETER} === 'undefined'
+                    ? undefined
+                    : ${TOOL_RUNTIME_CONTEXT_PARAMETER};
 
-        if (runtimeContextRaw !== undefined && args && typeof args === 'object' && !Array.isArray(args)) {
-            args.${TOOL_RUNTIME_CONTEXT_ARGUMENT} = runtimeContextRaw;
-        }
+            if (runtimeContextRaw !== undefined && args && typeof args === 'object' && !Array.isArray(args)) {
+                args.${TOOL_RUNTIME_CONTEXT_ARGUMENT} = runtimeContextRaw;
+            }
 
-        const toolProgressTokenRaw =
-            typeof ${TOOL_PROGRESS_TOKEN_PARAMETER} === 'undefined'
-                ? undefined
-                : ${TOOL_PROGRESS_TOKEN_PARAMETER};
+            const toolProgressTokenRaw =
+                typeof ${TOOL_PROGRESS_TOKEN_PARAMETER} === 'undefined'
+                    ? undefined
+                    : ${TOOL_PROGRESS_TOKEN_PARAMETER};
 
-        if (toolProgressTokenRaw !== undefined && args && typeof args === 'object' && !Array.isArray(args)) {
-            args.${TOOL_PROGRESS_TOKEN_ARGUMENT} = toolProgressTokenRaw;
-        }
+            if (toolProgressTokenRaw !== undefined && args && typeof args === 'object' && !Array.isArray(args)) {
+                args.${TOOL_PROGRESS_TOKEN_ARGUMENT} = toolProgressTokenRaw;
+            }
 
-        return await ${functionName}(args);
-    `;
+            return await ${functionName}(args);
+        `);
     }
 
     /**
@@ -4825,6 +4824,39 @@
         }
     }
 
+    /**
+     * 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
+     */
+    function createLazyModuleLoader(importModule) {
+        let importedModulePromise = null;
+        return function loadModule() {
+            if (importedModulePromise === null) {
+                importedModulePromise = importModule();
+            }
+            return importedModulePromise;
+        };
+    }
+    // Note: [🐌] Do not convert the lazy `import(...)` calls back to static `import` statements, it would bring back the
+    //       slow startup of the `ptbk` CLI utility
+
+    /**
+     * Loads the OpenAI SDK (`openai`) on demand
+     *
+     * Note: [🐌] Loaded lazily to keep the startup of the `ptbk` CLI utility fast
+     *
+     * @private internal utility of `OpenAiCompatibleRequestManager`
+     */
+    const loadOpenAiModule = createLazyModuleLoader(() => import('openai'));
     /**
      * Manages OpenAI-compatible client creation plus shared retry and rate-limit behavior.
      *
@@ -4851,7 +4883,8 @@
                     timeout: API_REQUEST_TIMEOUT,
                     maxRetries: CONNECTION_RETRIES_LIMIT,
                 };
-                this.client = new OpenAI__default["default"](enhancedOptions);
+                const { default: OpenAI } = await loadOpenAiModule();
+                this.client = new OpenAI(enhancedOptions);
             }
             return this.client;
         }
@@ -7450,6 +7483,14 @@
         }
     }
 
+    /**
+     * Loads the Socket.io client (`socket.io-client`) on demand
+     *
+     * Note: [🐌] Loaded lazily to keep the startup of the `ptbk` CLI utility fast
+     *
+     * @private internal utility of `createRemoteClient`
+     */
+    const loadSocketIoClientModule = createLazyModuleLoader(() => import('socket.io-client'));
     /**
      * Creates a connection to the remote proxy server.
      *
@@ -7478,8 +7519,9 @@
 
                     `));
         }
+        const { io } = await loadSocketIoClientModule();
         return new Promise((resolve, reject) => {
-            const socket = socket_ioClient.io(remoteServerUrl, {
+            const socket = io(remoteServerUrl, {
                 retries: CONNECTION_RETRIES_LIMIT,
                 timeout: CONNECTION_TIMEOUT_MS,
                 path: '/socket.io',
@@ -8131,12 +8173,22 @@
         }
     }
 
+    /**
+     * 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`
+     */
+    const loadOpenAiAgentsModule = createLazyModuleLoader(() => import('@openai/agents'));
+
     /**
      * Constant for default model used for nested DeepSearch tool invocations.
      */
     const DEFAULT_DEEP_SEARCH_MODEL_NAME = 'o4-mini-deep-research';
     /**
-     * Tool name used by the Book commitment-backed DeepSearch capability.
+     * Tool name used by the DeepSearch capability.
      */
     const DEEP_SEARCH_TOOL_NAME = 'deep_search';
     /**
@@ -8184,11 +8236,12 @@
         /**
          * Builds the tool list for AgentKit, including hosted file search when applicable.
          */
-        buildAgentKitTools(options) {
+        async buildAgentKitTools(options) {
             const { tools, vectorStoreId } = options;
+            const { fileSearchTool, tool: agentKitTool } = await loadOpenAiAgentsModule();
             const agentKitTools = [];
             if (vectorStoreId) {
-                agentKitTools.push(agents.fileSearchTool(vectorStoreId));
+                agentKitTools.push(fileSearchTool(vectorStoreId));
             }
             if (!tools || tools.length === 0) {
                 return agentKitTools;
@@ -8196,11 +8249,11 @@
             let scriptTools = null;
             for (const toolDefinition of tools) {
                 if (this.isDeepSearchToolDefinition(toolDefinition)) {
-                    agentKitTools.push(this.createDeepSearchAgentKitTool(toolDefinition));
+                    agentKitTools.push(await this.createDeepSearchAgentKitTool(toolDefinition));
                     continue;
                 }
                 scriptTools !== null && scriptTools !== void 0 ? scriptTools : (scriptTools = this.resolveScriptTools());
-                agentKitTools.push(agents.tool({
+                agentKitTools.push(agentKitTool({
                     name: toolDefinition.name,
                     description: toolDefinition.description,
                     parameters: this.normalizeAgentKitToolParameters(toolDefinition.parameters),
@@ -8405,14 +8458,15 @@
             };
         }
         /**
-         * Creates the native Agent SDK tool used for `USE DEEPSEARCH`.
+         * Creates the native Agent SDK tool used for the DeepSearch capability.
          */
-        createDeepSearchAgentKitTool(toolDefinition) {
-            const deepSearchAgent = new agents.Agent({
+        async createDeepSearchAgentKitTool(toolDefinition) {
+            const { Agent: AgentFromKit, webSearchTool } = await loadOpenAiAgentsModule();
+            const deepSearchAgent = new AgentFromKit({
                 name: 'DeepSearch',
                 model: DEFAULT_DEEP_SEARCH_MODEL_NAME,
                 instructions: this.createDeepSearchAgentInstructions(toolDefinition.description),
-                tools: [agents.webSearchTool({ searchContextSize: 'high' })],
+                tools: [webSearchTool({ searchContextSize: 'high' })],
             });
             return deepSearchAgent.asTool({
                 toolName: toolDefinition.name,
@@ -8621,8 +8675,9 @@
                     vectorStoreId,
                 });
             }
-            const agentKitTools = this.buildAgentKitTools({ tools, vectorStoreId });
-            const openAiAgentKitAgent = new agents.Agent({
+            const { Agent: AgentFromKit } = await loadOpenAiAgentsModule();
+            const agentKitTools = await this.buildAgentKitTools({ tools, vectorStoreId });
+            const openAiAgentKitAgent = new AgentFromKit({
                 name,
                 model: this.agentKitModelName,
                 instructions: instructions || 'You are a helpful assistant.',
@@ -8667,7 +8722,8 @@
                 agentName: agentForRun.name,
                 input: inputItems,
             };
-            const streamResult = await agents.run(agentForRun, inputItems, {
+            const { run } = await loadOpenAiAgentsModule();
+            const streamResult = await run(agentForRun, inputItems, {
                 stream: true,
                 maxTurns: 200,
                 context: {
@@ -8809,11 +8865,12 @@
          * Ensures the AgentKit SDK is wired to the OpenAI client and API key.
          */
         async ensureAgentKitDefaults() {
+            const { setDefaultOpenAIClient, setDefaultOpenAIKey } = await loadOpenAiAgentsModule();
             const client = await this.getClient();
-            agents.setDefaultOpenAIClient(client);
+            setDefaultOpenAIClient(client);
             const apiKey = this.agentKitOptions.apiKey;
             if (apiKey && typeof apiKey === 'string') {
-                agents.setDefaultOpenAIKey(apiKey);
+                setDefaultOpenAIKey(apiKey);
             }
         }
         /**