@promptbook/node 0.114.0-1 → 0.114.0-3

package/umd/index.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('path'), require('fs/promises'), require('spacetrim'), require('colors'), require('child_process'), require('@openai/agents'), require('url'), require('@mozilla/readability'), require('jsdom'), require('crypto-js'), require('crypto-js/enc-hex'), require('showdown'), require('jszip'), require('waitasecond'), require('dotenv'), require('crypto-js/sha256'), require('rxjs'), require('crypto'), require('moment'), require('mime-types'), require('papaparse'), require('bottleneck'), require('openai')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'path', 'fs/promises', 'spacetrim', 'colors', 'child_process', '@openai/agents', 'url', '@mozilla/readability', 'jsdom', 'crypto-js', 'crypto-js/enc-hex', 'showdown', 'jszip', 'waitasecond', 'dotenv', 'crypto-js/sha256', 'rxjs', 'crypto', 'moment', 'mime-types', 'papaparse', 'bottleneck', 'openai'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-node"] = {}, global.path, global.promises, global._spaceTrim, global.colors, global.child_process, global.agents, global.url, global.readability, global.jsdom, global.CryptoJS, global.hexEncoder, global.showdown, global.JSZip, global.waitasecond, global.dotenv, global.sha256, global.rxjs, null, global.moment, global.mimeTypes, global.papaparse, global.Bottleneck, global.OpenAI));
-})(this, (function (exports, path, promises, _spaceTrim, colors, child_process, agents, url, readability, jsdom, CryptoJS, hexEncoder, showdown, JSZip, waitasecond, dotenv, sha256, rxjs, crypto, moment, mimeTypes, papaparse, Bottleneck, OpenAI) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('path'), require('fs/promises'), require('spacetrim'), require('colors'), require('child_process'), require('url'), require('crypto-js'), require('crypto-js/enc-hex'), require('showdown'), require('waitasecond'), require('dotenv'), require('crypto-js/sha256'), require('rxjs'), require('crypto'), require('moment'), require('mime-types'), require('papaparse'), require('bottleneck')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'path', 'fs/promises', 'spacetrim', 'colors', 'child_process', 'url', 'crypto-js', 'crypto-js/enc-hex', 'showdown', 'waitasecond', 'dotenv', 'crypto-js/sha256', 'rxjs', 'crypto', 'moment', 'mime-types', 'papaparse', 'bottleneck'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-node"] = {}, global.path, global.promises, global._spaceTrim, global.colors, global.child_process, global.url, global.CryptoJS, global.hexEncoder, global.showdown, global.waitasecond, global.dotenv, global.sha256, global.rxjs, null, global.moment, global.mimeTypes, global.papaparse, global.Bottleneck));
+})(this, (function (exports, path, promises, _spaceTrim, colors, child_process, url, CryptoJS, hexEncoder, showdown, waitasecond, dotenv, sha256, rxjs, crypto, moment, mimeTypes, papaparse, Bottleneck) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -29,13 +29,11 @@
     var CryptoJS__default = /*#__PURE__*/_interopDefaultLegacy(CryptoJS);
     var hexEncoder__default = /*#__PURE__*/_interopDefaultLegacy(hexEncoder);
     var showdown__default = /*#__PURE__*/_interopDefaultLegacy(showdown);
-    var JSZip__default = /*#__PURE__*/_interopDefaultLegacy(JSZip);
     var dotenv__namespace = /*#__PURE__*/_interopNamespace(dotenv);
     var sha256__default = /*#__PURE__*/_interopDefaultLegacy(sha256);
     var moment__default = /*#__PURE__*/_interopDefaultLegacy(moment);
     var papaparse__default = /*#__PURE__*/_interopDefaultLegacy(papaparse);
     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
     /**
@@ -51,7 +49,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.114.0-1';
+    const PROMPTBOOK_ENGINE_VERSION = '0.114.0-3';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2951,6 +2949,13 @@
      * Environment variable read by the shell wrapper to tee live output into the temporary runtime log file.
      */
     const PTBK_CODER_LOG_FILE_ENV_NAME = 'PTBK_CODER_LOG_FILE';
+    /**
+     * Log line which separates the raw script input from the raw script output of one execution section.
+     *
+     * Readers of a runtime log split on this marker to look only at what the harness really produced,
+     * without the generated script and the prompt it embeds.
+     */
+    const SCRIPT_EXECUTION_LOG_RAW_OUTPUT_MARKER = '--- raw output ---';
     /**
      * Small bash wrapper that preserves stdout/stderr streams while teeing both into the runtime log file.
      */
@@ -2986,7 +2991,7 @@
             --- raw input ---
             ${block(normalizedInput)}
 
-            --- raw output ---
+            ${SCRIPT_EXECUTION_LOG_RAW_OUTPUT_MARKER}
         `);
         await promises.appendFile(logPath, `${logSection}\n`, 'utf-8');
     }
@@ -4329,6 +4334,7 @@
             `    -c model_reasoning_effort="${thinkingLevel}" \\`,
             `    --ask-for-approval ${options.askForApproval} \\`,
             `    exec --model ${options.model} \\`,
+            ...(options.isMachineReadableProgressEnabled ? ['    --json \\'] : []),
             '    --local-provider none \\',
             `    --sandbox ${options.sandbox} \\`,
             `    -C ${projectPath} \\`,
@@ -4645,6 +4651,10 @@
      * Output line that marks finished Codex usage summary.
      */
     const CODEX_COMPLETION_LINE = /^\s*tokens used\b/i;
+    /**
+     * Output line that marks the completed Codex turn in JSONL output mode.
+     */
+    const CODEX_JSON_COMPLETION_LINE = /^\s*\{"type":"turn\.(?:completed|failed)"/u;
     /**
      * Idle timeout after completion marker to capture trailing output.
      */
@@ -4721,6 +4731,7 @@
                 sandbox: this.options.sandbox,
                 askForApproval: this.options.askForApproval,
                 allowCredits: this.options.allowCredits,
+                isMachineReadableProgressEnabled: this.options.isMachineReadableProgressEnabled,
                 codexCommand: this.options.codexCommand,
             });
             for (let retryIndex = 0;; retryIndex++) {
@@ -4735,7 +4746,9 @@
                     const output = await $runGoScriptUntilMarkerIdle({
                         scriptPath: options.scriptPath,
                         scriptContent,
-                        completionLineMatcher: CODEX_COMPLETION_LINE,
+                        completionLineMatcher: this.options.isMachineReadableProgressEnabled
+                            ? CODEX_JSON_COMPLETION_LINE
+                            : CODEX_COMPLETION_LINE,
                         idleTimeoutMs: CODEX_COMPLETION_IDLE_MS,
                         logPath: options.logPath,
                         shouldPrintLiveOutput: options.shouldPrintLiveOutput,
@@ -4985,6 +4998,7 @@
             sandbox: 'danger-full-access',
             askForApproval: 'never',
             allowCredits: options.allowCredits,
+            isMachineReadableProgressEnabled: options.isMachineReadableProgressEnabled,
         });
         if (!options.allowCredits && options.isVerbose === true) {
             console.info(colors__default["default"].gray('OpenAI Codex credit spending is disabled. Use `--allow-credits` to explicitly opt in.'));
@@ -32909,6 +32923,41 @@
     `;
     }
 
+    /**
+     * 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 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.
      */
@@ -32962,11 +33011,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;
@@ -32974,11 +33024,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),
@@ -33185,12 +33235,13 @@
         /**
          * Creates the native Agent SDK tool used for `USE DEEPSEARCH`.
          */
-        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,
@@ -33754,6 +33805,14 @@
         }
     }
 
+    /**
+     * 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.
      *
@@ -33780,7 +33839,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;
         }
@@ -36126,7 +36186,23 @@
         });
     }
 
-    // TODO: [🏳‍🌈] Finally take pick of .json vs .ts
+    /**
+     * Loads `jsdom` on demand
+     *
+     * Note: [🐌] `jsdom` is by far the heaviest dependency of Promptbook, loading it eagerly would slow down every single
+     *       run of the `ptbk` CLI utility even when no website is scraped
+     *
+     * @private internal utility of `WebsiteScraper`
+     */
+    const loadJsdomModule = createLazyModuleLoader(() => import('jsdom'));
+    /**
+     * Loads `@mozilla/readability` on demand
+     *
+     * Note: [🐌] Loaded lazily to keep the startup of the `ptbk` CLI utility fast
+     *
+     * @private internal utility of `WebsiteScraper`
+     */
+    const loadReadabilityModule = createLazyModuleLoader(() => import('@mozilla/readability'));
     /**
      * Scraper for websites
      *
@@ -36162,14 +36238,15 @@
             if (this.tools.fs === undefined) {
                 throw new EnvironmentMismatchError('Can not scrape websites without filesystem tools');
             }
-            const jsdom$1 = new jsdom.JSDOM(await source.asText(), {
+            const [{ JSDOM }, { Readability }] = await Promise.all([loadJsdomModule(), loadReadabilityModule()]);
+            const jsdom = new JSDOM(await source.asText(), {
                 url: source.url,
             });
-            const reader = new readability.Readability(jsdom$1.window.document);
+            const reader = new Readability(jsdom.window.document);
             const article = reader.parse();
             // console.log(article);
             // await forTime(10000);
-            let html = (article === null || article === void 0 ? void 0 : article.content) || (article === null || article === void 0 ? void 0 : article.textContent) || jsdom$1.window.document.body.innerHTML;
+            let html = (article === null || article === void 0 ? void 0 : article.content) || (article === null || article === void 0 ? void 0 : article.textContent) || jsdom.window.document.body.innerHTML;
             // Note: Unwrap html such as it is convertable by `markdownConverter`
             for (let i = 0; i < 2; i++) {
                 html = html.replace(/<div\s*(?:id="readability-page-\d+"\s+class="page")?>(.*)<\/div>/is, '$1');
@@ -36202,7 +36279,7 @@
                     throw error;
                 }
             }
-            const markdown = this.showdownConverter.makeMarkdown(html, jsdom$1.window.document);
+            const markdown = this.showdownConverter.makeMarkdown(html, jsdom.window.document);
             return { ...cacheFilehandler, markdown };
         }
         /**
@@ -39425,7 +39502,8 @@
             }
             const preparedAgent = await this.prepareAgent();
             (_a = preparedAgent.toolBuilder) === null || _a === void 0 ? void 0 : _a.clearRunState();
-            const result = await agents.run(preparedAgent.agent, createLiteAgentPromptText(normalizedMessage, options.context, preparedAgent.modelRequirements.promptSuffix), options.signal ? { signal: options.signal } : undefined);
+            const { run } = await loadOpenAiAgentsModule();
+            const result = await run(preparedAgent.agent, createLiteAgentPromptText(normalizedMessage, options.context, preparedAgent.modelRequirements.promptSuffix), options.signal ? { signal: options.signal } : undefined);
             return formatLiteAgentOutput(result.finalOutput);
         }
         /**
@@ -39464,9 +39542,10 @@
                 userId: this.options.userId,
             });
             const client = await runtime.getClient();
-            agents.setDefaultOpenAIClient(client);
+            const { Agent: AgentFromKit, fileSearchTool, setDefaultOpenAIClient, setDefaultOpenAIKey, } = await loadOpenAiAgentsModule();
+            setDefaultOpenAIClient(client);
             if (this.options.apiKey) {
-                agents.setDefaultOpenAIKey(this.options.apiKey);
+                setDefaultOpenAIKey(this.options.apiKey);
             }
             const toolBuilder = modelRequirements.tools && modelRequirements.tools.length > 0
                 ? new OpenAiAgentKitExecutionToolsToolBuilder({
@@ -39484,19 +39563,19 @@
                     agentKitModelName: resolvedModelName,
                 })
                 : null;
-            const agentTools = (toolBuilder === null || toolBuilder === void 0 ? void 0 : toolBuilder.buildAgentKitTools({
+            const agentTools = (await (toolBuilder === null || toolBuilder === void 0 ? void 0 : toolBuilder.buildAgentKitTools({
                 tools: modelRequirements.tools ? [...modelRequirements.tools] : undefined,
-            })) || [];
+            }))) || [];
             const normalizedKnowledgeSources = await normalizeLiteAgentKnowledgeSources(modelRequirements.knowledgeSources || [], resolvedSource.sourceDirectoryPath);
             if (normalizedKnowledgeSources.length > 0) {
                 const vectorStore = await runtime.createHostedKnowledgeVectorStore({
                     knowledgeSources: normalizedKnowledgeSources,
                     name: resolvedSource.agentName,
                 });
-                agentTools.unshift(agents.fileSearchTool(vectorStore.vectorStoreId));
+                agentTools.unshift(fileSearchTool(vectorStore.vectorStoreId));
             }
             return {
-                agent: new agents.Agent({
+                agent: new AgentFromKit({
                     name: resolvedSource.agentName,
                     model: resolvedModelName,
                     instructions: modelRequirements.systemMessage || 'You are a helpful assistant.',
@@ -39705,6 +39784,15 @@
         }
     }
 
+    /**
+     * Loads the ZIP archive library (`jszip`) on demand
+     *
+     * Note: [🐌] Loaded lazily to keep the startup of the `ptbk` CLI utility fast
+     *
+     * @private internal utility of `loadArchive` and `saveArchive`
+     */
+    const loadJsZipModule = createLazyModuleLoader(() => import('jszip'));
+
     /**
      * Loads the books from the archive file with `.bookc` extension
      *
@@ -39719,7 +39807,8 @@
             throw new UnexpectedError(`Archive file must have '.bookc' extension`);
         }
         const data = await fs.readFile(filePath);
-        const archive = await JSZip__default["default"].loadAsync(data);
+        const { default: JSZip } = await loadJsZipModule();
+        const archive = await JSZip.loadAsync(data);
         const indexFile = archive.file('index.book.json');
         if (!indexFile) {
             throw new UnexpectedError(`Archive does not contain 'index.book.json' file`);
@@ -46091,8 +46180,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.',
@@ -46137,7 +46227,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: {
@@ -46279,11 +46370,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);
             }
         }
         /**