@promptbook/core 0.104.0-12 → 0.104.0-14

package/umd/index.umd.js

@@ -28,7 +28,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.104.0-12';
+    const PROMPTBOOK_ENGINE_VERSION = '0.104.0-14';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -3629,7 +3629,7 @@
             tasks.push(task);
             runningTasks.push(task);
             /* not await */ Promise.resolve(task).then(() => {
-                runningTasks = runningTasks.filter((t) => t !== task);
+                runningTasks = runningTasks.filter((runningTask) => runningTask !== task);
             });
             if (maxParallelCount < runningTasks.length) {
                 await Promise.race(runningTasks);
@@ -3686,10 +3686,14 @@
     }
 
     /**
-     * Intercepts LLM tools and counts total usage of the tools
+     * Intercepts LLM tools and counts total usage of the tools.
      *
-     * @param llmTools LLM tools to be intercepted with usage counting
-     * @returns LLM tools with same functionality with added total cost counting
+     * This function wraps the provided `LlmExecutionTools` with a proxy that tracks the cumulative
+     * usage (tokens, cost, etc.) across all model calls. It provides a way to monitor spending
+     * in real-time through an observable.
+     *
+     * @param llmTools - The LLM tools to be intercepted and tracked
+     * @returns An augmented version of the tools that includes usage tracking capabilities
      * @public exported from `@promptbook/core`
      */
     function countUsage(llmTools) {
@@ -3954,17 +3958,21 @@
      */
 
     /**
-     * Joins multiple LLM Execution Tools into one
+     * Joins multiple LLM Execution Tools into one.
      *
-     * @returns {LlmExecutionTools} Single wrapper for multiple LlmExecutionTools
+     * This function takes a list of `LlmExecutionTools` and returns a single unified
+     * `MultipleLlmExecutionTools` object. It provides failover and aggregation logic:
      *
-     * 0) If there is no LlmExecutionTools, it warns and returns valid but empty LlmExecutionTools
-     * 1) If there is only one LlmExecutionTools, it returns it wrapped in a proxy object
-     * 2) If there are multiple LlmExecutionTools, first will be used first, second will be used if the first hasn`t defined model variant or fails, etc.
-     * 3) When all LlmExecutionTools fail, it throws an error with a list of all errors merged into one
+     * 1.  **Failover**: When a model call is made, it tries providers in the order they were provided.
+     *     If the first provider doesn't support the requested model or fails, it tries the next one.
+     * 2.  **Aggregation**: `listModels` returns a combined list of all models available from all providers.
+     * 3.  **Empty case**: If no tools are provided, it logs a warning (as Promptbook requires LLMs to function).
      *
+     * @param title - A descriptive title for this collection of joined tools
+     * @param llmExecutionTools - An array of execution tools to be joined
+     * @returns A single unified execution tool wrapper
      *
-     * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`
+     * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`.
      *
      * @public exported from `@promptbook/core`
      */
@@ -4529,8 +4537,8 @@
      */
     function removeDiacritics(input) {
         /*eslint no-control-regex: "off"*/
-        return input.replace(/[^\u0000-\u007E]/g, (a) => {
-            return DIACRITIC_VARIANTS_LETTERS[a] || a;
+        return input.replace(/[^\u0000-\u007E]/g, (character) => {
+            return DIACRITIC_VARIANTS_LETTERS[character] || character;
         });
     }
     /**
@@ -6789,7 +6797,7 @@
             const taskEmbeddingResult = await llmTools.callEmbeddingModel(taskEmbeddingPrompt);
             const knowledgePiecesWithRelevance = preparedPipeline.knowledgePieces.map((knowledgePiece) => {
                 const { index } = knowledgePiece;
-                const knowledgePieceIndex = index.find((i) => i.modelName === firstKnowledgeIndex.modelName);
+                const knowledgePieceIndex = index.find((knowledgePieceIndex) => knowledgePieceIndex.modelName === firstKnowledgeIndex.modelName);
                 // <- TODO: Do not use just first knowledge piece and first index to determine embedding model
                 if (knowledgePieceIndex === undefined) {
                     return {
@@ -7237,7 +7245,7 @@
                         resovedParameterNames = [...resovedParameterNames, currentTask.resultingParameterName];
                     })
                         .then(() => {
-                        resolving = resolving.filter((w) => w !== work);
+                        resolving = resolving.filter((workItem) => workItem !== work);
                     });
                     // <- Note: Errors are catched here [3]
                     //    TODO: BUT if in multiple tasks are errors, only the first one is catched so maybe we should catch errors here and save them to errors array here
@@ -7403,7 +7411,7 @@
                         // Calculate and update tldr based on pipeline progress
                         const cv = newOngoingResult;
                         // Calculate progress based on parameters resolved vs total parameters
-                        const totalParameters = pipeline.parameters.filter((p) => !p.isInput).length;
+                        const totalParameters = pipeline.parameters.filter((parameter) => !parameter.isInput).length;
                         let resolvedParameters = 0;
                         let currentTaskTitle = '';
                         // Get the resolved parameters from output parameters
@@ -7541,8 +7549,8 @@
      */
     function createCommitmentRegex(commitment, aliases = [], requiresContent = true) {
         const allCommitments = [commitment, ...aliases];
-        const patterns = allCommitments.map((c) => {
-            const escapedCommitment = c.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+        const patterns = allCommitments.map((commitment) => {
+            const escapedCommitment = commitment.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
             return escapedCommitment.split(/\s+/).join('\\s+');
         });
         const keywordPattern = patterns.join('|');
@@ -7564,8 +7572,8 @@
      */
     function createCommitmentTypeRegex(commitment, aliases = []) {
         const allCommitments = [commitment, ...aliases];
-        const patterns = allCommitments.map((c) => {
-            const escapedCommitment = c.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+        const patterns = allCommitments.map((commitment) => {
+            const escapedCommitment = commitment.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
             return escapedCommitment.split(/\s+/).join('\\s+');
         });
         const keywordPattern = patterns.join('|');
@@ -8075,9 +8083,7 @@
             // 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;
+            const mergedDictionary = existingDictionary ? `${existingDictionary}\n${trimmedContent}` : trimmedContent;
             // Store the merged dictionary in metadata for debugging and inspection
             const updatedMetadata = {
                 ...requirements.metadata,
@@ -11296,8 +11302,8 @@
             return match;
         });
         // Remove duplicates based on name (keep the first occurrence)
-        const uniqueParameters = parameters.filter((param, index, array) => {
-            return array.findIndex((p) => p.name === param.name) === index;
+        const uniqueParameters = parameters.filter((parameter, index, array) => {
+            return array.findIndex((parameterItem) => parameterItem.name === parameter.name) === index;
         });
         return uniqueParameters;
     }
@@ -11344,7 +11350,7 @@
                 commitment.type === 'DISCARD' ||
                 commitment.type === 'REMOVE') {
                 const targets = parseParameters(commitment.content)
-                    .map((p) => p.name.trim().toLowerCase())
+                    .map((parameter) => parameter.name.trim().toLowerCase())
                     .filter(Boolean);
                 if (targets.length === 0) {
                     // Ignore DELETE with no targets; also don't pass the DELETE further
@@ -11353,8 +11359,8 @@
                 // Drop prior kept commitments that contain any of the targeted tags
                 for (let i = filteredCommitments.length - 1; i >= 0; i--) {
                     const prev = filteredCommitments[i];
-                    const prevParams = parseParameters(prev.content).map((p) => p.name.trim().toLowerCase());
-                    const hasIntersection = prevParams.some((n) => targets.includes(n));
+                    const prevParams = parseParameters(prev.content).map((parameter) => parameter.name.trim().toLowerCase());
+                    const hasIntersection = prevParams.some((parameterName) => targets.includes(parameterName));
                     if (hasIntersection) {
                         filteredCommitments.splice(i, 1);
                     }
@@ -12277,18 +12283,20 @@
     // import { getTableName } from '../../../../../apps/agents-server/src/database/getTableName';
     // <- TODO: [🐱‍🚀] Prevent imports from `/apps` -> `/src`
     /**
-     * Agent collection stored in Supabase table
+     * Agent collection stored in a Supabase table.
      *
-     * Note: This object can work both from Node.js and browser environment depending on the Supabase client provided
+     * This class provides a way to manage a collection of agents (pipelines) using Supabase
+     * as the storage backend. It supports listing, creating, updating, and soft-deleting agents.
+     *
+     * Note: This object can work both from Node.js and browser environment depending on the Supabase client provided.
      *
      * @public exported from `@promptbook/core`
      * <- TODO: [🐱‍🚀] Move to `@promptbook/supabase` package
      */
     class AgentCollectionInSupabase /* TODO: [🐱‍🚀] implements Agent */ {
         /**
-         * @param rootPath - path to the directory with agents
-         * @param tools - Execution tools to be used in [🐱‍🚀] `Agent` itself and listing the agents
-         * @param options - Options for the collection creation
+         * @param supabaseClient - The initialized Supabase client
+         * @param options - Configuration options for the collection (e.g., table prefix, verbosity)
          */
         constructor(supabaseClient, 
         /// TODO: [🐱‍🚀] Remove> private readonly tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>,
@@ -14176,7 +14184,12 @@
      * @see {@link ModelVariant}
      * @public exported from `@promptbook/core`
      */
-    const MODEL_VARIANTS = ['COMPLETION', 'CHAT', 'IMAGE_GENERATION', 'EMBEDDING' /* <- TODO [🏳] */ /* <- [🤖] */];
+    const MODEL_VARIANTS = [
+        'COMPLETION',
+        'CHAT',
+        'IMAGE_GENERATION',
+        'EMBEDDING' /* <- TODO [🏳] */ /* <- [🤖] */,
+    ];
 
     /**
      * Parses the model command
@@ -19742,7 +19755,7 @@
             const modelRequirements = await this.getAgentModelRequirements();
             if (modelRequirements.samples) {
                 const normalizedPrompt = normalizeMessageText(prompt.content);
-                const sample = modelRequirements.samples.find((s) => normalizeMessageText(s.question) === normalizedPrompt);
+                const sample = modelRequirements.samples.find((sample) => normalizeMessageText(sample.question) === normalizedPrompt);
                 if (sample) {
                     const now = new Date().toISOString();
                     const result = {
@@ -21300,6 +21313,10 @@
     /**
      * Generates a random agent persona description.
      *
+     * This function selects a random personality profile from a predefined pool
+     * of common AI agent characteristics (e.g., friendly, professional, creative).
+     *
+     * @returns A string describing the agent's persona
      * @private internal helper function
      */
     function $randomAgentPersona() {