@promptbook/components 0.114.0-2 → 0.114.0-3

package/esm/index.es.js

@@ -21,10 +21,8 @@ import 'moment/locale/cs';
 import { forTime } from 'waitasecond';
 import sha256 from 'crypto-js/sha256';
 import papaparse from 'papaparse';
-import { fileSearchTool, tool, Agent as Agent$1, webSearchTool, run, setDefaultOpenAIClient, setDefaultOpenAIKey } from '@openai/agents';
 import colors from 'colors';
 import Bottleneck from 'bottleneck';
-import OpenAI from 'openai';
 import QRCode from 'qrcode';
 
 // ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
@@ -41,7 +39,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.114.0-2';
+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
@@ -27753,6 +27751,81 @@ function parseMessageButtons(content) {
     };
 }
 
+/**
+ * This error type indicates that you try to use a feature that is not available in the current environment
+ *
+ * @public exported from `@promptbook/core`
+ */
+class EnvironmentMismatchError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'EnvironmentMismatchError';
+        Object.setPrototypeOf(this, EnvironmentMismatchError.prototype);
+    }
+}
+
+/**
+ * Shared DOM window reused by every render which happens outside of a browser
+ *
+ * @private utility of `$provideServerDomWindow`
+ */
+let serverDomWindow = null;
+/**
+ * Provides a DOM `window` for runtimes which do not have one, for example Node.js during server-side rendering
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it creates and caches one shared DOM window
+ *
+ * @returns DOM window which can back a DOM-dependent library like `DOMPurify`
+ * @throws {EnvironmentMismatchError} When the current runtime can not create a DOM window
+ * @private utility of `renderMarkdown`
+ */
+function $provideServerDomWindow() {
+    if (serverDomWindow === null) {
+        const { JSDOM } = requireServerDomLibrary();
+        serverDomWindow = new JSDOM('').window;
+    }
+    return serverDomWindow;
+}
+/**
+ * Loads `jsdom` which backs the DOM window outside of a browser
+ *
+ * Note: [😷] `jsdom` reaches for Node.js built-ins like `fs`, `child_process` and `net`, so browser bundlers must
+ *       never follow the `require` below - even though it is unreachable in a browser, bundlers resolve it statically.
+ *       They are told to replace `jsdom` with an empty module by the `browser` field of the generated package
+ *       manifests, which is written by `applyBrowserUnsupportedDependencyStubs` during the package generation.
+ *
+ * @returns The `jsdom` library
+ * @throws {EnvironmentMismatchError} When `jsdom` can not be loaded in the current runtime
+ * @private utility of `$provideServerDomWindow`
+ */
+function requireServerDomLibrary() {
+    let serverDomLibrary = null;
+    let serverDomLibraryError = null;
+    try {
+        // Note: [😷] Keep `'jsdom'` written as a literal, bundlers do not replace a computed module name
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        serverDomLibrary = require('jsdom');
+    }
+    catch (error) {
+        assertsError(error);
+        serverDomLibraryError = error;
+    }
+    if (typeof (serverDomLibrary === null || serverDomLibrary === void 0 ? void 0 : serverDomLibrary.JSDOM) !== 'function') {
+        throw new EnvironmentMismatchError(spaceTrim$1((block) => `
+                    Markdown can not be rendered because there is no DOM in the current runtime.
+
+                    Rendered markdown is sanitized through \`DOMPurify\`, which needs a DOM - the DOM of the browser
+                    when the code runs in a browser and \`jsdom\` in every other runtime, for example during
+                    server-side rendering in **Node.js**.
+
+                    ${block(serverDomLibraryError === null
+            ? 'The `jsdom` module was resolved but it does not export `JSDOM`, which happens when a bundler replaces `jsdom` with an empty module in a build which is neither a browser build nor a Node.js build.'
+            : `${serverDomLibraryError.name}: ${serverDomLibraryError.message}`)}
+                `));
+    }
+    return serverDomLibrary;
+}
+
 /**
  * Default citation identifier used for simplified citation markers without an explicit position.
  *
@@ -28049,12 +28122,6 @@ let browserMarkdownSanitizer = null;
  * @private utility of `renderMarkdown`
  */
 let serverMarkdownSanitizer = null;
-/**
- * Shared JSDOM window backing the server-side DOMPurify instance.
- *
- * @private utility of `renderMarkdown`
- */
-let serverMarkdownSanitizerWindow = null;
 /**
  * Pattern matching CODE FENCE.
  */
@@ -28190,19 +28257,6 @@ function createMarkdownSanitizer(sanitizerWindow) {
     registerMarkdownSanitizerHooks(markdownSanitizer);
     return markdownSanitizer;
 }
-/**
- * Lazily creates the JSDOM window used by server-side markdown sanitization.
- *
- * @private utility of `renderMarkdown`
- */
-function getServerMarkdownSanitizerWindow() {
-    if (!serverMarkdownSanitizerWindow) {
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
-        const { JSDOM } = require('jsdom');
-        serverMarkdownSanitizerWindow = new JSDOM('').window;
-    }
-    return serverMarkdownSanitizerWindow;
-}
 /**
  * Returns the shared DOMPurify instance appropriate for the current runtime.
  *
@@ -28213,7 +28267,7 @@ function getMarkdownSanitizer() {
         browserMarkdownSanitizer !== null && browserMarkdownSanitizer !== void 0 ? browserMarkdownSanitizer : (browserMarkdownSanitizer = createMarkdownSanitizer(window));
         return browserMarkdownSanitizer;
     }
-    serverMarkdownSanitizer !== null && serverMarkdownSanitizer !== void 0 ? serverMarkdownSanitizer : (serverMarkdownSanitizer = createMarkdownSanitizer(getServerMarkdownSanitizerWindow()));
+    serverMarkdownSanitizer !== null && serverMarkdownSanitizer !== void 0 ? serverMarkdownSanitizer : (serverMarkdownSanitizer = createMarkdownSanitizer($provideServerDomWindow()));
     return serverMarkdownSanitizer;
 }
 /**
@@ -47808,19 +47862,6 @@ class DatabaseError extends Error {
 }
 // TODO: [🐱‍🚀] Explain that NotFoundError ([🐱‍🚀] and other specific errors) has priority over DatabaseError in some contexts
 
-/**
- * This error type indicates that you try to use a feature that is not available in the current environment
- *
- * @public exported from `@promptbook/core`
- */
-class EnvironmentMismatchError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = 'EnvironmentMismatchError';
-        Object.setPrototypeOf(this, EnvironmentMismatchError.prototype);
-    }
-}
-
 /**
  * This error occurs when some expectation is not met in the execution of the pipeline
  *
@@ -53260,6 +53301,41 @@ function buildToolInvocationScript(options) {
     `;
 }
 
+/**
+ * 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.
  */
@@ -53313,8 +53389,9 @@ class OpenAiAgentKitExecutionToolsToolBuilder {
     /**
      * 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(fileSearchTool(vectorStoreId));
@@ -53325,11 +53402,11 @@ class OpenAiAgentKitExecutionToolsToolBuilder {
         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(tool({
+            agentKitTools.push(agentKitTool({
                 name: toolDefinition.name,
                 description: toolDefinition.description,
                 parameters: this.normalizeAgentKitToolParameters(toolDefinition.parameters),
@@ -53536,8 +53613,9 @@ class OpenAiAgentKitExecutionToolsToolBuilder {
     /**
      * Creates the native Agent SDK tool used for `USE DEEPSEARCH`.
      */
-    createDeepSearchAgentKitTool(toolDefinition) {
-        const deepSearchAgent = new Agent$1({
+    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),
@@ -54863,6 +54941,14 @@ class OpenAiCompatibleNonChatPromptCaller {
     }
 }
 
+/**
+ * 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.
  *
@@ -54889,6 +54975,7 @@ class OpenAiCompatibleRequestManager {
                 timeout: API_REQUEST_TIMEOUT,
                 maxRetries: CONNECTION_RETRIES_LIMIT,
             };
+            const { default: OpenAI } = await loadOpenAiModule();
             this.client = new OpenAI(enhancedOptions);
         }
         return this.client;
@@ -57036,8 +57123,9 @@ class OpenAiAgentKitExecutionTools extends OpenAiVectorStoreHandler {
                 vectorStoreId,
             });
         }
-        const agentKitTools = this.buildAgentKitTools({ tools, vectorStoreId });
-        const openAiAgentKitAgent = new Agent$1({
+        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.',
@@ -57082,6 +57170,7 @@ class OpenAiAgentKitExecutionTools extends OpenAiVectorStoreHandler {
             agentName: agentForRun.name,
             input: inputItems,
         };
+        const { run } = await loadOpenAiAgentsModule();
         const streamResult = await run(agentForRun, inputItems, {
             stream: true,
             maxTurns: 200,
@@ -57224,6 +57313,7 @@ class OpenAiAgentKitExecutionTools extends OpenAiVectorStoreHandler {
      * 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();
         setDefaultOpenAIClient(client);
         const apiKey = this.agentKitOptions.apiKey;