@promptbook/components 0.104.0-13 → 0.104.0-14

package/esm/index.es.js

@@ -35,7 +35,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.104.0-13';
+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
@@ -2236,8 +2236,8 @@ for (let i = 0; i < defaultDiacriticsRemovalMap.length; i++) {
  */
 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;
     });
 }
 /**
@@ -2765,7 +2765,7 @@ async function forEachAsync(array, options, callbackfunction) {
         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);
@@ -3469,7 +3469,7 @@ function serializeToPromptbookJavascript(value) {
     if (serializedValue === undefined) {
         throw new UnexpectedError(`Serialization resulted in undefined value`);
     }
-    const uniqueImports = Array.from(new Set(imports)).filter((imp) => !!imp && imp.trim().length > 0);
+    const uniqueImports = Array.from(new Set(imports)).filter((importStatement) => !!importStatement && importStatement.trim().length > 0);
     return { imports: uniqueImports, value: serializedValue };
 }
 /**
@@ -3631,8 +3631,8 @@ function createDefaultAgentName(agentSource) {
  */
 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('|');
@@ -3654,8 +3654,8 @@ function createCommitmentRegex(commitment, aliases = [], requiresContent = true)
  */
 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('|');
@@ -7309,8 +7309,8 @@ function parseParameters(text) {
         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;
 }
@@ -8066,8 +8066,12 @@ function AboutPromptbookInformation(props) {
 }
 
 /**
- * Renders an about icon
+ * Renders an information/about icon.
  *
+ * This icon is typically used in UI elements that provide additional information
+ * or "about" details to the user.
+ *
+ * @param props - SVG properties augmented with an optional `size`
  * @private internal subcomponent used by various components
  */
 function AboutIcon(props) {
@@ -8076,26 +8080,38 @@ function AboutIcon(props) {
 }
 
 /**
- * Renders an attachment icon
+ * Renders an attachment icon.
  *
- * @public exported from `@promptbook/components`
+ * This icon is typically used in chat interfaces to indicate the ability to
+ * upload or view files associated with a message.
+ *
+ * @param props - SVG properties augmented with an optional `size`
+ * @private internal subcomponent used by various components
  */
 function AttachmentIcon({ size = 24, color = 'currentColor' }) {
     return (jsx("svg", { width: size, height: size, viewBox: "0 0 24 24", fill: "none", xmlns: "http://www.w3.org/2000/svg", children: jsx("path", { d: "M21.44 11.05l-9.19 9.19a6 6 0 01-8.49-8.49l9.19-9.19a4 4 0 015.66 5.66L9.64 16.2a2 2 0 01-2.83-2.83l8.49-8.49", stroke: color, strokeWidth: "2", strokeLinecap: "round", strokeLinejoin: "round" }) }));
 }
 
 /**
- * Renders a camera icon
+ * Renders a camera icon.
  *
- * @public exported from `@promptbook/components`
+ * This icon is typically used in buttons or inputs that trigger image capture
+ * or selection.
+ *
+ * @param props - SVG properties augmented with an optional `size`
+ * @private internal subcomponent used by various components
  */
 function CameraIcon({ size = 24, color = 'currentColor' }) {
     return (jsxs("svg", { width: size, height: size, viewBox: "0 0 24 24", fill: "none", xmlns: "http://www.w3.org/2000/svg", children: [jsx("path", { d: "M23 19C23 19.5304 22.7893 20.0391 22.4142 20.4142C22.0391 20.7893 21.5304 21 21 21H3C2.46957 21 1.96086 20.7893 1.58579 20.4142C1.21071 20.0391 1 19.5304 1 19V8C1 7.46957 1.21071 6.96086 1.58579 6.58579C1.96086 6.21071 2.46957 6 3 6H7L9 3H15L17 6H21C21.5304 6 22.0391 6.21071 22.4142 6.58579C22.7893 6.96086 23 7.46957 23 8V19Z", stroke: color, strokeWidth: "2", strokeLinecap: "round", strokeLinejoin: "round" }), jsx("path", { d: "M12 17C14.2091 17 16 15.2091 16 13C16 10.7909 14.2091 9 12 9C9.79086 9 8 10.7909 8 13C8 15.2091 9.79086 17 12 17Z", stroke: color, strokeWidth: "2", strokeLinecap: "round", strokeLinejoin: "round" })] }));
 }
 
 /**
- * Renders a download icon
+ * Renders a download icon.
  *
+ * This icon is typically used in buttons or links that trigger the downloading
+ * of files or assets.
+ *
+ * @param props - SVG properties augmented with an optional `size`
  * @private internal subcomponent used by various components
  */
 function DownloadIcon(props) {
@@ -8190,6 +8206,10 @@ styleInject(css_248z$5);
 /**
  * An animated hamburger menu button component.
  *
+ * This component renders a 3-bar hamburger icon that animates into an "X" when
+ * the menu is open.
+ *
+ * @param props - Contains the open state, an optional click handler, and optional className
  * @private Internal component
  */
 function HamburgerMenu({ isOpen, onClick, className }) {
@@ -8201,8 +8221,12 @@ var styles$3 = {"dropdown":"Dropdown-module_dropdown__ZShv1","button":"Dropdown-
 styleInject(css_248z$4);
 
 /**
- * A dropdown menu component that displays a list of actions triggered by a hamburger menu button.
+ * A dropdown menu component that displays a list of actions.
  *
+ * The menu is toggled by a hamburger menu button. When an action is selected,
+ * the menu automatically closes.
+ *
+ * @param props - Contains an array of actions with icons, names, and click handlers
  * @private internal subcomponent used by various components
  */
 function Dropdown({ actions }) {
@@ -8836,7 +8860,7 @@ function colorDistanceSquared(color1, color2) {
  */
 function nearest(...colors) {
     return (color) => {
-        const distances = colors.map((c) => colorDistanceSquared(c, color));
+        const distances = colors.map((currentColor) => colorDistanceSquared(currentColor, color));
         const minDistance = Math.min(...distances);
         const minIndex = distances.indexOf(minDistance);
         const nearestColor = colors[minIndex];
@@ -9124,9 +9148,13 @@ const MicIcon = ({ size }) => (jsxs("svg", { width: size, height: size, viewBox:
 const ResetIcon = () => (jsx("svg", { width: "16", height: "16", viewBox: "0 0 24 24", fill: "currentColor", children: jsx("path", { d: "M17.65,6.35C16.2,4.9 14.21,4 12,4c-4.42,0 -7.99,3.58 -7.99,8s3.57,8 7.99,8c3.73,0 6.84,-2.55 7.73,-6h-2.08c-0.82,2.33 -3.04,4 -5.65,4 -3.31,0 -6,-2.69 -6,-6s2.69,-6 6,-6c1.66,0 3.14,0.69 4.22,1.78L13,11h7V4L17.65,6.35z" }) }));
 
 /**
- * Renders a save icon
+ * Renders a save icon.
  *
- * @public exported from `@promptbook/components`
+ * This icon is typically used in buttons that trigger the saving of data,
+ * configurations, or agent sources.
+ *
+ * @param props - SVG properties augmented with an optional `size`
+ * @private internal subcomponent used by various components
  */
 function SaveIcon({ size = 20, color = 'currentColor', ...props }) {
     return (jsxs("svg", { width: size, height: size, viewBox: "0 0 24 24", fill: "none", stroke: color, strokeWidth: "1.5", strokeLinecap: "round", strokeLinejoin: "round", ...props, children: [jsx("path", { d: "M4 17V7a3 3 0 0 1 3-3h10a3 3 0 0 1 3 3v7a3 3 0 0 1-3 3H7l-3 3z", fill: color, fillOpacity: "0.08", stroke: color }), jsx("path", { d: "M12 9v5", stroke: color }), jsx("path", { d: "M9.5 12.5L12 15l2.5-2.5", stroke: color })] }));
@@ -11427,17 +11455,21 @@ class MultipleLlmExecutionTools {
  */
 
 /**
- * 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`
  */
@@ -12488,10 +12520,14 @@ function addUsage(...usageItems) {
 }
 
 /**
- * Intercepts LLM tools and counts total usage of the tools
+ * Intercepts LLM tools and counts total usage of the tools.
+ *
+ * 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 LLM tools to be intercepted with usage counting
- * @returns LLM tools with same functionality with added total cost counting
+ * @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) {
@@ -14563,7 +14599,7 @@ async function getKnowledgeForTask(options) {
         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 {
@@ -15011,7 +15047,7 @@ async function executePipeline(options) {
                     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
@@ -15177,7 +15213,7 @@ function createPipelineExecutor(options) {
                     // 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
@@ -15381,7 +15417,7 @@ async function createAgentModelRequirementsWithCommitments(agentSource, modelNam
             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
@@ -15390,8 +15426,8 @@ async function createAgentModelRequirementsWithCommitments(agentSource, modelNam
             // 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);
                 }
@@ -17935,7 +17971,7 @@ class Agent extends AgentLlmExecutionTools {
         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 = {
@@ -18629,5 +18665,5 @@ function injectCssModuleIntoShadowRoot(options) {
     }
 }
 
-export { AboutPromptbookInformation, AgentChat, ArrowIcon, AttachmentIcon, AvatarChip, AvatarChipFromSource, AvatarProfile, AvatarProfileFromSource, BLOCKY_FLOW, BOOK_LANGUAGE_VERSION, BookEditor, BrandedQrCode, CHAT_SAVE_FORMATS, CameraIcon, Chat, DEFAULT_BOOK_EDITOR_HEIGHT, FAST_FLOW, GenericQrCode, LlmChat, MOCKED_CHAT_DELAY_CONFIGS, MarkdownContent, MicIcon, MockedChat, NORMAL_FLOW, PROMPTBOOK_ENGINE_VERSION, PauseIcon, PlayIcon, PromptbookAgentIntegration, PromptbookQrCode, RANDOM_FLOW, ResetIcon, SLOW_FLOW, SaveIcon, SendIcon, TemplateIcon, getChatSaveFormatDefinitions, htmlSaveFormatDefinition, injectCssModuleIntoShadowRoot, jsonSaveFormatDefinition, mdSaveFormatDefinition, parseMessageButtons, pdfSaveFormatDefinition, reactSaveFormatDefinition, txtSaveFormatDefinition, useChatAutoScroll, useSendMessageToLlmChat };
+export { AboutPromptbookInformation, AgentChat, ArrowIcon, AvatarChip, AvatarChipFromSource, AvatarProfile, AvatarProfileFromSource, BLOCKY_FLOW, BOOK_LANGUAGE_VERSION, BookEditor, BrandedQrCode, CHAT_SAVE_FORMATS, Chat, DEFAULT_BOOK_EDITOR_HEIGHT, FAST_FLOW, GenericQrCode, LlmChat, MOCKED_CHAT_DELAY_CONFIGS, MarkdownContent, MicIcon, MockedChat, NORMAL_FLOW, PROMPTBOOK_ENGINE_VERSION, PauseIcon, PlayIcon, PromptbookAgentIntegration, PromptbookQrCode, RANDOM_FLOW, ResetIcon, SLOW_FLOW, SendIcon, TemplateIcon, getChatSaveFormatDefinitions, htmlSaveFormatDefinition, injectCssModuleIntoShadowRoot, jsonSaveFormatDefinition, mdSaveFormatDefinition, parseMessageButtons, pdfSaveFormatDefinition, reactSaveFormatDefinition, txtSaveFormatDefinition, useChatAutoScroll, useSendMessageToLlmChat };
 //# sourceMappingURL=index.es.js.map