@promptbook/wizard 0.104.0-1 → 0.104.0-11

package/esm/index.es.js

@@ -36,7 +36,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.104.0-1';
+const PROMPTBOOK_ENGINE_VERSION = '0.104.0-11';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -46,6 +46,8 @@ const PROMPTBOOK_ENGINE_VERSION = '0.104.0-1';
  * Core Promptbook server configuration.
  *
  * This server is also used for auto-federation in the Agents Server.
+ *
+ * @public exported from `@promptbook/core`
  */
 const CORE_SERVER = {
     title: 'Promptbook Core',
@@ -2526,6 +2528,7 @@ class RemoteLlmExecutionTools {
     }
 }
 /**
+ * TODO: !!!! Deprecate pipeline server and all of its components
  * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
  * TODO: [🍓] Allow to list compatible models with each variant
@@ -4699,13 +4702,15 @@ const _AzureOpenAiRegistration = $llmToolsRegister.register(createAzureOpenAiExe
  *
  * @public exported from `@promptbook/utils`
  */
-const $isRunningInJest = new Function(`
+function $isRunningInJest() {
+    var _a;
     try {
-        return process.env.JEST_WORKER_ID !== undefined;
-    } catch (e) {
+        return typeof process !== 'undefined' && ((_a = process.env) === null || _a === void 0 ? void 0 : _a.JEST_WORKER_ID) !== undefined;
+    }
+    catch (e) {
         return false;
     }
-`);
+}
 /**
  * TODO: [🎺]
  */
@@ -5565,13 +5570,14 @@ const _OllamaMetadataRegistration = $llmToolsMetadataRegister.register({
  *
  * @public exported from `@promptbook/utils`
  */
-const $isRunningInBrowser = new Function(`
+function $isRunningInBrowser() {
     try {
-        return this === window;
-    } catch (e) {
+        return typeof window !== 'undefined' && typeof window.document !== 'undefined';
+    }
+    catch (e) {
         return false;
     }
-`);
+}
 /**
  * TODO: [🎺]
  */
@@ -5583,17 +5589,17 @@ const $isRunningInBrowser = new Function(`
  *
  * @public exported from `@promptbook/utils`
  */
-const $isRunningInWebWorker = new Function(`
+function $isRunningInWebWorker() {
     try {
-        if (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) {
-            return true;
-        } else {
-            return false;
-        }
-    } catch (e) {
+        // Note: Check for importScripts which is specific to workers
+        //       and not available in the main browser thread
+        return (typeof self !== 'undefined' &&
+            typeof self.importScripts === 'function');
+    }
+    catch (e) {
         return false;
     }
-`);
+}
 /**
  * TODO: [🎺]
  */
@@ -5825,7 +5831,7 @@ class OpenAiCompatibleExecutionTools {
         let threadMessages = [];
         if ('thread' in prompt && Array.isArray(prompt.thread)) {
             threadMessages = prompt.thread.map((msg) => ({
-                role: msg.role === 'assistant' ? 'assistant' : 'user',
+                role: msg.sender === 'assistant' ? 'assistant' : 'user',
                 content: msg.content,
             }));
         }
@@ -6238,13 +6244,14 @@ class OpenAiCompatibleExecutionTools {
         const modelName = currentModelRequirements.modelName || this.getDefaultImageGenerationModel().modelName;
         const modelSettings = {
             model: modelName,
-            // size: currentModelRequirements.size,
-            // quality: currentModelRequirements.quality,
-            // style: currentModelRequirements.style,
+            size: currentModelRequirements.size,
+            quality: currentModelRequirements.quality,
+            style: currentModelRequirements.style,
         };
         const rawPromptContent = templateParameters(content, { ...parameters, modelName });
         const rawRequest = {
             ...modelSettings,
+            size: modelSettings.size || '1024x1024',
             prompt: rawPromptContent,
             user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString(),
             response_format: 'url', // TODO: [🧠] Maybe allow b64_json
@@ -6781,10 +6788,10 @@ class OllamaExecutionTools extends OpenAiCompatibleExecutionTools {
         // <- TODO: [🛄]
     }
     /**
-     * Default model for image generation variant.
+     * Default model for completion variant.
      */
     getDefaultImageGenerationModel() {
-        return this.getDefaultModel('!!!'); // <- TODO: [🧠] Pick the best default model
+        return this.getDefaultModel('dall-e-3');
         // <- TODO: [🛄]
     }
 }
@@ -7599,11 +7606,10 @@ class HardcodedOpenAiCompatibleExecutionTools extends OpenAiCompatibleExecutionT
         throw new PipelineExecutionError(`${this.title} does not support EMBEDDING model variant`);
     }
     /**
-     * Default model for image generation variant.
+     * Default model for completion variant.
      */
     getDefaultImageGenerationModel() {
-        return this.getDefaultModel('!!!'); // <- TODO: [🧠] Pick the best default model
-        // <- TODO: [🛄]
+        throw new PipelineExecutionError(`${this.title} does not support IMAGE_GENERATION model variant`);
     }
 }
 /**
@@ -7695,13 +7701,14 @@ const $scrapersRegister = new $Register('scraper_constructors');
  *
  * @public exported from `@promptbook/utils`
  */
-const $isRunningInNode = new Function(`
+function $isRunningInNode() {
     try {
-        return this === global;
-    } catch (e) {
+        return typeof process !== 'undefined' && process.versions != null && process.versions.node != null;
+    }
+    catch (e) {
         return false;
     }
-`);
+}
 /**
  * TODO: [🎺]
  */
@@ -9414,6 +9421,15 @@ function countUsage(llmTools) {
             return promptResult;
         };
     }
+    if (llmTools.callImageGenerationModel !== undefined) {
+        proxyTools.callImageGenerationModel = async (prompt) => {
+            // console.info('[🚕] callImageGenerationModel through countTotalUsage');
+            const promptResult = await llmTools.callImageGenerationModel(prompt);
+            totalUsage = addUsage(totalUsage, promptResult.usage);
+            spending.next(promptResult.usage);
+            return promptResult;
+        };
+    }
     // <- Note: [🤖]
     return proxyTools;
 }
@@ -9422,7 +9438,7 @@ function countUsage(llmTools) {
  * TODO: [🧠] Is there some meaningfull way how to test this util
  * TODO: [🧠][🌯] Maybe a way how to hide ability to `get totalUsage`
  *     > const [llmToolsWithUsage,getUsage] = countTotalUsage(llmTools);
- * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ * TODO: [👷‍♂️] Write a comprehensive manual explaining the construction and usage of LLM tools in the Promptbook ecosystem
  */
 
 /**
@@ -9523,6 +9539,12 @@ class MultipleLlmExecutionTools {
     callEmbeddingModel(prompt) {
         return this.callCommonModel(prompt);
     }
+    /**
+     * Calls the best available embedding model
+     */
+    callImageGenerationModel(prompt) {
+        return this.callCommonModel(prompt);
+    }
     // <- Note: [🤖]
     /**
      * Calls the best available model
@@ -9549,6 +9571,11 @@ class MultipleLlmExecutionTools {
                             continue llm;
                         }
                         return await llmExecutionTools.callEmbeddingModel(prompt);
+                    case 'IMAGE_GENERATION':
+                        if (llmExecutionTools.callImageGenerationModel === undefined) {
+                            continue llm;
+                        }
+                        return await llmExecutionTools.callImageGenerationModel(prompt);
                     // <- case [🤖]:
                     default:
                         throw new UnexpectedError(`Unknown model variant "${prompt.modelRequirements.modelVariant}" in ${llmExecutionTools.title}`);
@@ -11252,8 +11279,9 @@ async function executeAttempts(options) {
                                     $ongoingTaskResult.$resultString = $ongoingTaskResult.$completionResult.content;
                                     break variant;
                                 case 'EMBEDDING':
+                                case 'IMAGE_GENERATION':
                                     throw new PipelineExecutionError(spaceTrim$1((block) => `
-                                                Embedding model can not be used in pipeline
+                                                ${modelRequirements.modelVariant} model can not be used in pipeline
 
                                                 This should be catched during parsing
 
@@ -14121,6 +14149,114 @@ class DeleteCommitmentDefinition extends BaseCommitmentDefinition {
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
+/**
+ * DICTIONARY commitment definition
+ *
+ * The DICTIONARY commitment defines specific terms and their meanings that the agent should use correctly
+ * in its reasoning and responses. This ensures consistent terminology usage.
+ *
+ * Key features:
+ * - Multiple DICTIONARY commitments are automatically merged into one
+ * - Content is placed in a dedicated section of the system message
+ * - Terms and definitions are stored in metadata.DICTIONARY for debugging
+ * - Agent should use the defined terms correctly in responses
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * Legal Assistant
+ *
+ * PERSONA You are a knowledgeable legal assistant
+ * DICTIONARY Misdemeanor is a minor wrongdoing or criminal offense
+ * DICTIONARY Felony is a serious crime usually punishable by imprisonment for more than one year
+ * DICTIONARY Tort is a civil wrong that causes harm or loss to another person, leading to legal liability
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+class DictionaryCommitmentDefinition extends BaseCommitmentDefinition {
+    constructor() {
+        super('DICTIONARY');
+    }
+    /**
+     * Short one-line description of DICTIONARY.
+     */
+    get description() {
+        return 'Define terms and their meanings for consistent terminology usage.';
+    }
+    /**
+     * Icon for this commitment.
+     */
+    get icon() {
+        return '📚';
+    }
+    /**
+     * Markdown documentation for DICTIONARY commitment.
+     */
+    get documentation() {
+        return spaceTrim$1(`
+            # DICTIONARY
+
+            Defines specific terms and their meanings that the agent should use correctly in reasoning and responses.
+
+            ## Key aspects
+
+            - Multiple \`DICTIONARY\` commitments are merged together.
+            - Terms are defined in the format: "Term is definition"
+            - The agent should use these terms consistently in responses.
+            - Definitions help ensure accurate and consistent terminology.
+
+            ## Examples
+
+            \`\`\`book
+            Legal Assistant
+
+            PERSONA You are a knowledgeable legal assistant specializing in criminal law
+            DICTIONARY Misdemeanor is a minor wrongdoing or criminal offense
+            DICTIONARY Felony is a serious crime usually punishable by imprisonment for more than one year
+            DICTIONARY Tort is a civil wrong that causes harm or loss to another person, leading to legal liability
+            \`\`\`
+
+            \`\`\`book
+            Medical Assistant
+
+            PERSONA You are a helpful medical assistant
+            DICTIONARY Hypertension is persistently high blood pressure
+            DICTIONARY Diabetes is a chronic condition that affects how the body processes blood sugar
+            DICTIONARY Vaccine is a biological preparation that provides active immunity to a particular disease
+            \`\`\`
+        `);
+    }
+    applyToAgentModelRequirements(requirements, content) {
+        var _a;
+        const trimmedContent = content.trim();
+        if (!trimmedContent) {
+            return requirements;
+        }
+        // Get existing dictionary entries from metadata
+        const existingDictionary = ((_a = requirements.metadata) === null || _a === void 0 ? void 0 : _a.DICTIONARY) || '';
+        // Merge the new dictionary entry with existing entries
+        const mergedDictionary = existingDictionary
+            ? `${existingDictionary}\n${trimmedContent}`
+            : trimmedContent;
+        // Store the merged dictionary in metadata for debugging and inspection
+        const updatedMetadata = {
+            ...requirements.metadata,
+            DICTIONARY: mergedDictionary,
+        };
+        // Create the dictionary section for the system message
+        // Format: "# DICTIONARY\nTerm: definition\nTerm: definition..."
+        const dictionarySection = `# DICTIONARY\n${mergedDictionary}`;
+        return {
+            ...this.appendToSystemMessage(requirements, dictionarySection),
+            metadata: updatedMetadata,
+        };
+    }
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */
+
 /**
  * FORMAT commitment definition
  *
@@ -16941,6 +17077,7 @@ const COMMITMENT_REGISTRY = [
     new DeleteCommitmentDefinition('CANCEL'),
     new DeleteCommitmentDefinition('DISCARD'),
     new DeleteCommitmentDefinition('REMOVE'),
+    new DictionaryCommitmentDefinition(),
     new OpenCommitmentDefinition(),
     new ClosedCommitmentDefinition(),
     new UseBrowserCommitmentDefinition(),
@@ -17025,17 +17162,64 @@ function parseAgentSourceWithCommitments(agentSource) {
         };
     }
     const lines = agentSource.split('\n');
-    const agentName = (((_a = lines[0]) === null || _a === void 0 ? void 0 : _a.trim()) || null);
+    let agentName = null;
+    let agentNameLineIndex = -1;
+    // Find the agent name: first non-empty line that is not a commitment and not a horizontal line
+    for (let i = 0; i < lines.length; i++) {
+        const line = lines[i];
+        if (line === undefined) {
+            continue;
+        }
+        const trimmed = line.trim();
+        if (!trimmed) {
+            continue;
+        }
+        const isHorizontal = HORIZONTAL_LINE_PATTERN.test(line);
+        if (isHorizontal) {
+            continue;
+        }
+        let isCommitment = false;
+        for (const definition of COMMITMENT_REGISTRY) {
+            const typeRegex = definition.createTypeRegex();
+            const match = typeRegex.exec(trimmed);
+            if (match && ((_a = match.groups) === null || _a === void 0 ? void 0 : _a.type)) {
+                isCommitment = true;
+                break;
+            }
+        }
+        if (!isCommitment) {
+            agentName = trimmed;
+            agentNameLineIndex = i;
+            break;
+        }
+    }
     const commitments = [];
     const nonCommitmentLines = [];
-    // Always add the first line (agent name) to non-commitment lines
-    if (lines[0] !== undefined) {
-        nonCommitmentLines.push(lines[0]);
+    // Add lines before agentName that are horizontal lines (they are non-commitment)
+    for (let i = 0; i < agentNameLineIndex; i++) {
+        const line = lines[i];
+        if (line === undefined) {
+            continue;
+        }
+        const trimmed = line.trim();
+        if (!trimmed) {
+            continue;
+        }
+        const isHorizontal = HORIZONTAL_LINE_PATTERN.test(line);
+        if (isHorizontal) {
+            nonCommitmentLines.push(line);
+        }
+        // Note: Commitments before agentName are not added to nonCommitmentLines
+    }
+    // Add the agent name line to non-commitment lines
+    if (agentNameLineIndex >= 0) {
+        nonCommitmentLines.push(lines[agentNameLineIndex]);
     }
     // Parse commitments with multiline support
     let currentCommitment = null;
-    // Process lines starting from the second line (skip agent name)
-    for (let i = 1; i < lines.length; i++) {
+    // Process lines starting from after the agent name line
+    const startIndex = agentNameLineIndex >= 0 ? agentNameLineIndex + 1 : 0;
+    for (let i = startIndex; i < lines.length; i++) {
         const line = lines[i];
         if (line === undefined) {
             continue;
@@ -17255,7 +17439,12 @@ async function createAgentModelRequirementsWithCommitments(agentSource, modelNam
         };
     }
     // Apply each commitment in order using reduce-like pattern
-    for (const commitment of filteredCommitments) {
+    for (let i = 0; i < filteredCommitments.length; i++) {
+        const commitment = filteredCommitments[i];
+        // CLOSED commitment should work only if its the last commitment in the book
+        if (commitment.type === 'CLOSED' && i !== filteredCommitments.length - 1) {
+            continue;
+        }
         const definition = getCommitmentDefinition(commitment.type);
         if (definition) {
             try {
@@ -17350,44 +17539,6 @@ function normalizeTo_camelCase(text, _isFirstLetterCapital = false) {
  * TODO: [🌺] Use some intermediate util splitWords
  */
 
-/**
- * Generates a gravatar URL based on agent name for fallback avatar
- *
- * @param agentName The agent name to generate avatar for
- * @returns Gravatar URL
- *
- * @private - [🤹] The fact that profile image is Gravatar is just implementation detail which should be hidden for consumer
- */
-function generateGravatarUrl(agentName) {
-    // Use a default name if none provided
-    const safeName = agentName || 'Anonymous Agent';
-    // Create a simple hash from the name for consistent avatar
-    let hash = 0;
-    for (let i = 0; i < safeName.length; i++) {
-        const char = safeName.charCodeAt(i);
-        hash = (hash << 5) - hash + char;
-        hash = hash & hash; // Convert to 32bit integer
-    }
-    const avatarId = Math.abs(hash).toString();
-    return `https://www.gravatar.com/avatar/${avatarId}?default=robohash&size=200&rating=x`;
-}
-
-/**
- * Generates an image for the agent to use as profile image
- *
- * @param agentName The agent name to generate avatar for
- * @returns The placeholder profile image URL for the agent
- *
- * @public exported from `@promptbook/core`
- */
-function generatePlaceholderAgentProfileImageUrl(agentName) {
-    // Note: [🤹] The fact that profile image is Gravatar is just implementation detail which should be hidden for consumer
-    return generateGravatarUrl(agentName);
-}
-/**
- * TODO: [🤹] Figure out best placeholder image generator https://i.pravatar.cc/1000?u=568
- */
-
 /**
  * Computes SHA-256 hash of the given object
  *
@@ -17782,7 +17933,57 @@ function parseAgentSource(agentSource) {
     }
     const meta = {};
     const links = [];
+    const capabilities = [];
     for (const commitment of parseResult.commitments) {
+        if (commitment.type === 'USE BROWSER') {
+            capabilities.push({
+                type: 'browser',
+                label: 'Browser',
+                iconName: 'Globe',
+            });
+            continue;
+        }
+        if (commitment.type === 'USE SEARCH ENGINE') {
+            capabilities.push({
+                type: 'search-engine',
+                label: 'Search Internet',
+                iconName: 'Search',
+            });
+            continue;
+        }
+        if (commitment.type === 'KNOWLEDGE') {
+            const content = spaceTrim$2(commitment.content).split('\n')[0] || '';
+            let label = content;
+            let iconName = 'Book';
+            if (content.startsWith('http://') || content.startsWith('https://')) {
+                try {
+                    const url = new URL(content);
+                    if (url.pathname.endsWith('.pdf')) {
+                        label = url.pathname.split('/').pop() || 'Document.pdf';
+                        iconName = 'FileText';
+                    }
+                    else {
+                        label = url.hostname.replace(/^www\./, '');
+                    }
+                }
+                catch (e) {
+                    // Invalid URL, treat as text
+                }
+            }
+            else {
+                // Text content - take first few words
+                const words = content.split(/\s+/);
+                if (words.length > 4) {
+                    label = words.slice(0, 4).join(' ') + '...';
+                }
+            }
+            capabilities.push({
+                type: 'knowledge',
+                label,
+                iconName,
+            });
+            continue;
+        }
         if (commitment.type === 'META LINK') {
             const linkValue = spaceTrim$2(commitment.content);
             links.push(linkValue);
@@ -17812,10 +18013,6 @@ function parseAgentSource(agentSource) {
         const metaType = normalizeTo_camelCase(metaTypeRaw);
         meta[metaType] = spaceTrim$2(commitment.content.substring(metaTypeRaw.length));
     }
-    // Generate gravatar fallback if no meta image specified
-    if (!meta.image) {
-        meta.image = generatePlaceholderAgentProfileImageUrl(parseResult.agentName || '!!');
-    }
     // Generate fullname fallback if no meta fullname specified
     if (!meta.fullname) {
         meta.fullname = parseResult.agentName || createDefaultAgentName(agentSource);
@@ -17827,11 +18024,13 @@ function parseAgentSource(agentSource) {
     return {
         agentName: normalizeAgentName(parseResult.agentName || createDefaultAgentName(agentSource)),
         agentHash,
+        permanentId: meta.id,
         personaDescription,
         initialMessage,
         meta,
         links,
         parameters,
+        capabilities,
     };
 }
 /**
@@ -18552,7 +18751,7 @@ function $registeredLlmToolsMessage() {
                                 ${i + 1}) **${title}** \`${className}\` from \`${packageName}\`
                                     ${morePieces.join('; ')}
                             `);
-        if ($isRunningInNode) {
+        if ($isRunningInNode()) {
             if (isInstalled && isFullyConfigured) {
                 providerMessage = colors.green(providerMessage);
             }
@@ -18949,6 +19148,9 @@ function cacheLlmTools(llmTools, options = {}) {
             case 'EMBEDDING':
                 promptResult = await llmTools.callEmbeddingModel(prompt);
                 break variant;
+            case 'IMAGE_GENERATION':
+                promptResult = await llmTools.callImageGenerationModel(prompt);
+                break variant;
             // <- case [🤖]:
             default:
                 throw new PipelineExecutionError(`Unknown model variant "${prompt.modelRequirements.modelVariant}"`);
@@ -18985,12 +19187,13 @@ function cacheLlmTools(llmTools, options = {}) {
                 }
             }
             catch (error) {
+                assertsError(error);
                 // If validation throws an unexpected error, don't cache
                 shouldCache = false;
                 if (isVerbose) {
                     console.info('Not caching result due to validation error for key:', key, {
                         content: promptResult.content,
-                        validationError: error instanceof Error ? error.message : String(error),
+                        validationError: serializeError(error),
                     });
                 }
             }
@@ -19036,6 +19239,11 @@ function cacheLlmTools(llmTools, options = {}) {
             return /* not await */ callCommonModel(prompt);
         };
     }
+    if (llmTools.callImageGenerationModel !== undefined) {
+        proxyTools.callImageGenerationModel = async (prompt) => {
+            return /* not await */ callCommonModel(prompt);
+        };
+    }
     // <- Note: [🤖]
     return proxyTools;
 }
@@ -21165,11 +21373,7 @@ const modelCommandParser = {
         // TODO: [🚜] DRY
         if ($taskJson.modelRequirements[command.key] !== undefined) {
             if ($taskJson.modelRequirements[command.key] === command.value) {
-                console.warn(`Multiple commands \`MODEL ${{
-                    modelName: 'NAME',
-                    modelVariant: 'VARIANT',
-                    maxTokens: '???',
-                }[command.key]} ${command.value}\` in the task "${$taskJson.title || $taskJson.name}"`);
+                console.warn(`Multiple commands \`MODEL ${command.key} ${command.value}\` in the task "${$taskJson.title || $taskJson.name}"`);
                 // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
             }
             else {