@promptbook/markdown-utils 0.101.0-9 → 0.102.0-0

package/esm/typings/src/utils/markdown/promptbookifyAiText.d.ts

@@ -2,11 +2,11 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Function `promptbookifyAiText` will slightly modify the text so we know it was processed by Promptbook
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/markdown-utils`
  */
 export declare function promptbookifyAiText(text: string_markdown): string_markdown;
 /**
- * TODO: !!!!! Make the function idempotent and add "Note: [🔂] This function is idempotent."
- * TODO: [🅾️]!!! Use this across the project where AI text is involved
  * TODO: [🧠][✌️] Make some Promptbook-native token system
  */

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.101.0-8`).
+ * It follows semantic versioning (e.g., `0.101.0`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.101.0-9",
+    "version": "0.102.0-0",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.101.0-9';
+    const PROMPTBOOK_ENGINE_VERSION = '0.102.0-0';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2627,75 +2627,32 @@
      */
 
     /**
-     * Predefined profiles for LLM providers to maintain consistency across the application
-     * These profiles represent each provider as a virtual persona in chat interfaces
+     * Takes an item or an array of items and returns an array of items
+     *
+     * 1) Any item except array and undefined returns array with that one item (also null)
+     * 2) Undefined returns empty array
+     * 3) Array returns itself
      *
-     * @private !!!!
+     * @private internal utility
      */
-    const LLM_PROVIDER_PROFILES = {
-        OPENAI: {
-            name: 'OPENAI',
-            fullname: 'OpenAI GPT',
-            color: '#10a37f', // OpenAI's signature green
-            // Note: avatarSrc could be added when we have provider logos available
-        },
-        ANTHROPIC: {
-            name: 'ANTHROPIC',
-            fullname: 'Anthropic Claude',
-            color: '#d97706', // Anthropic's orange/amber color
-        },
-        AZURE_OPENAI: {
-            name: 'AZURE_OPENAI',
-            fullname: 'Azure OpenAI',
-            color: '#0078d4', // Microsoft Azure blue
-        },
-        GOOGLE: {
-            name: 'GOOGLE',
-            fullname: 'Google Gemini',
-            color: '#4285f4', // Google blue
-        },
-        DEEPSEEK: {
-            name: 'DEEPSEEK',
-            fullname: 'DeepSeek',
-            color: '#7c3aed', // Purple color for DeepSeek
-        },
-        OLLAMA: {
-            name: 'OLLAMA',
-            fullname: 'Ollama',
-            color: '#059669', // Emerald green for local models
-        },
-        REMOTE: {
-            name: 'REMOTE',
-            fullname: 'Remote Server',
-            color: '#6b7280', // Gray for remote/proxy connections
-        },
-        MOCKED_ECHO: {
-            name: 'MOCKED_ECHO',
-            fullname: 'Echo (Test)',
-            color: '#8b5cf6', // Purple for test/mock tools
-        },
-        MOCKED_FAKE: {
-            name: 'MOCKED_FAKE',
-            fullname: 'Fake LLM (Test)',
-            color: '#ec4899', // Pink for fake/test tools
-        },
-        VERCEL: {
-            name: 'VERCEL',
-            fullname: 'Vercel AI',
-            color: '#000000', // Vercel's black
-        },
-        MULTIPLE: {
-            name: 'MULTIPLE',
-            fullname: 'Multiple Providers',
-            color: '#6366f1', // Indigo for combined/multiple providers
-        },
-    };
+    function arrayableToArray(input) {
+        if (input === undefined) {
+            return [];
+        }
+        if (input instanceof Array) {
+            return input;
+        }
+        return [input];
+    }
+
     /**
-     * TODO: Refactor this - each profile must be alongside the provider definition
-     * TODO: [🕛] Unite `AgentBasicInformation`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`
-     * Note: [💞] Ignore a discrepancy between file name and entity name
+     * Profile for Multiple providers aggregation
      */
-
+    const MULTIPLE_PROVIDER_PROFILE = {
+        name: 'MULTIPLE',
+        fullname: 'Multiple Providers',
+        color: '#6366f1',
+    };
     /**
      * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
      *
@@ -2706,12 +2663,10 @@
         /**
          * Gets array of execution tools in order of priority
          */
-        constructor(...llmExecutionTools) {
+        constructor(title, ...llmExecutionTools) {
+            this.title = title;
             this.llmExecutionTools = llmExecutionTools;
         }
-        get title() {
-            return 'Multiple LLM Providers';
-        }
         get description() {
             const innerModelsTitlesAndDescriptions = this.llmExecutionTools
                 .map(({ title, description }, index) => {
@@ -2733,7 +2688,7 @@
             `);
         }
         get profile() {
-            return LLM_PROVIDER_PROFILES.MULTIPLE;
+            return MULTIPLE_PROVIDER_PROFILE;
         }
         /**
          * Check the configuration of all execution tools
@@ -2797,7 +2752,7 @@
                             return await llmExecutionTools.callEmbeddingModel(prompt);
                         // <- case [🤖]:
                         default:
-                            throw new UnexpectedError(`Unknown model variant "${prompt.modelRequirements.modelVariant}"`);
+                            throw new UnexpectedError(`Unknown model variant "${prompt.modelRequirements.modelVariant}" in ${llmExecutionTools.title}`);
                     }
                 }
                 catch (error) {
@@ -2818,7 +2773,7 @@
                 //     2) AnthropicClaude throw PipelineExecutionError: Parameter `{knowledge}` is not defined
                 //     3) ...
                 spaceTrim__default["default"]((block) => `
-                          All execution tools failed:
+                          All execution tools of ${this.title} failed:
 
                           ${block(errors
                 .map(({ error, llmExecutionTools }, i) => `${i + 1}) **${llmExecutionTools.title}** thrown **${error.name || 'Error'}:** ${error.message}`)
@@ -2827,11 +2782,11 @@
                     `));
             }
             else if (this.llmExecutionTools.length === 0) {
-                throw new PipelineExecutionError(`You have not provided any \`LlmExecutionTools\``);
+                throw new PipelineExecutionError(`You have not provided any \`LlmExecutionTools\` into ${this.title}`);
             }
             else {
                 throw new PipelineExecutionError(spaceTrim__default["default"]((block) => `
-                          You have not provided any \`LlmExecutionTools\` that support model variant "${prompt.modelRequirements.modelVariant}"
+                          You have not provided any \`LlmExecutionTools\` that support model variant "${prompt.modelRequirements.modelVariant}" into ${this.title}
 
                           Available \`LlmExecutionTools\`:
                           ${block(this.description)}
@@ -2861,7 +2816,7 @@
      *
      * @public exported from `@promptbook/core`
      */
-    function joinLlmExecutionTools(...llmExecutionTools) {
+    function joinLlmExecutionTools(title, ...llmExecutionTools) {
         if (llmExecutionTools.length === 0) {
             const warningMessage = spaceTrim__default["default"](`
             You have not provided any \`LlmExecutionTools\`
@@ -2893,30 +2848,27 @@
             };
             */
         }
-        return new MultipleLlmExecutionTools(...llmExecutionTools);
+        return new MultipleLlmExecutionTools(title || 'Multiple LLM Providers joined by `joinLlmExecutionTools`', ...llmExecutionTools);
     }
     /**
      * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
      */
 
     /**
-     * Takes an item or an array of items and returns an array of items
-     *
-     * 1) Any item except array and undefined returns array with that one item (also null)
-     * 2) Undefined returns empty array
-     * 3) Array returns itself
+     * Just returns the given `LlmExecutionTools` or joins multiple into one
      *
-     * @private internal utility
+     * @public exported from `@promptbook/core`
      */
-    function arrayableToArray(input) {
-        if (input === undefined) {
-            return [];
-        }
-        if (input instanceof Array) {
-            return input;
-        }
-        return [input];
+    function getSingleLlmExecutionTools(oneOrMoreLlmExecutionTools) {
+        const _llms = arrayableToArray(oneOrMoreLlmExecutionTools);
+        const llmTools = _llms.length === 1
+            ? _llms[0]
+            : joinLlmExecutionTools('Multiple LLM Providers joined by `getSingleLlmExecutionTools`', ..._llms);
+        return llmTools;
     }
+    /**
+     * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+     */
 
     /**
      * Prepares the persona for the pipeline
@@ -2935,8 +2887,7 @@
             pipeline: await collection.getPipelineByUrl('https://promptbook.studio/promptbook/prepare-persona.book'),
             tools,
         });
-        const _llms = arrayableToArray(tools.llm);
-        const llmTools = _llms.length === 1 ? _llms[0] : joinLlmExecutionTools(..._llms);
+        const llmTools = getSingleLlmExecutionTools(tools.llm);
         const availableModels = (await llmTools.listModels())
             .filter(({ modelVariant }) => modelVariant === 'CHAT')
             .map(({ modelName, modelDescription }) => ({
@@ -2980,6 +2931,7 @@
         };
     }
     /**
+     * TODO: [😩] DRY `preparePersona` and `selectBestModelFromAvailable`
      * TODO: [🔃][main] If the persona was prepared with different version or different set of models, prepare it once again
      * TODO: [🏢] Check validity of `modelName` in pipeline
      * TODO: [🏢] Check validity of `systemMessage` in pipeline
@@ -4098,9 +4050,7 @@
         if (tools === undefined || tools.llm === undefined) {
             throw new MissingToolsError('LLM tools are required for preparing the pipeline');
         }
-        // TODO: [🚐] Make arrayable LLMs -> single LLM DRY
-        const _llms = arrayableToArray(tools.llm);
-        const llmTools = _llms.length === 1 ? _llms[0] : joinLlmExecutionTools(..._llms);
+        const llmTools = getSingleLlmExecutionTools(tools.llm);
         const llmToolsWithUsage = countUsage(llmTools);
         //    <- TODO: [🌯]
         /*
@@ -5141,9 +5091,7 @@
             $scriptPipelineExecutionErrors: [],
             $failedResults: [], // Track all failed attempts
         };
-        // TODO: [🚐] Make arrayable LLMs -> single LLM DRY
-        const _llms = arrayableToArray(tools.llm);
-        const llmTools = _llms.length === 1 ? _llms[0] : joinLlmExecutionTools(..._llms);
+        const llmTools = getSingleLlmExecutionTools(tools.llm);
         attempts: for (let attemptIndex = -jokerParameterNames.length; attemptIndex < maxAttempts; attemptIndex++) {
             const isJokerAttempt = attemptIndex < 0;
             const jokerParameterName = jokerParameterNames[jokerParameterNames.length + attemptIndex];
@@ -5663,9 +5611,7 @@
             return ''; // <- Note: Np knowledge present, return empty string
         }
         try {
-            // TODO: [🚐] Make arrayable LLMs -> single LLM DRY
-            const _llms = arrayableToArray(tools.llm);
-            const llmTools = _llms.length === 1 ? _llms[0] : joinLlmExecutionTools(..._llms);
+            const llmTools = getSingleLlmExecutionTools(tools.llm);
             const taskEmbeddingPrompt = {
                 title: 'Knowledge Search',
                 modelRequirements: {
@@ -6266,13 +6212,13 @@
                         // 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((p) => !p.isInput).length;
                         let resolvedParameters = 0;
                         let currentTaskTitle = '';
                         // Get the resolved parameters from output parameters
                         if (cv === null || cv === void 0 ? void 0 : cv.outputParameters) {
                             // Count how many output parameters have non-empty values
-                            resolvedParameters = Object.values(cv.outputParameters).filter(value => value !== undefined && value !== null && String(value).trim() !== '').length;
+                            resolvedParameters = Object.values(cv.outputParameters).filter((value) => value !== undefined && value !== null && String(value).trim() !== '').length;
                         }
                         // Try to determine current task from execution report
                         if (((_a = cv === null || cv === void 0 ? void 0 : cv.executionReport) === null || _a === void 0 ? void 0 : _a.promptExecutions) && cv.executionReport.promptExecutions.length > 0) {
@@ -6382,9 +6328,7 @@
                 throw new MissingToolsError('LLM tools are required for scraping external files');
                 // <- Note: This scraper is used in all other scrapers, so saying "external files" not "markdown files"
             }
-            // TODO: [🚐] Make arrayable LLMs -> single LLM DRY
-            const _llms = arrayableToArray(llm);
-            const llmTools = _llms.length === 1 ? _llms[0] : joinLlmExecutionTools(..._llms);
+            const llmTools = getSingleLlmExecutionTools(llm);
             // TODO: [🌼] In future use `ptbk make` and made getPipelineCollection
             const collection = createCollectionFromJson(...PipelineCollection);
             const prepareKnowledgeFromMarkdownExecutor = createPipelineExecutor({
@@ -6887,27 +6831,57 @@
     }
     /**
      * TODO: [🧠] Maybe this should be exported from `@promptbook/utils` not `@promptbook/markdown-utils`
-     * TODO: [🅾️] !!! Use this across the project where AI text is involved
      */
 
+    /**
+     * @private
+     */
+    const PROMPTBOOK_PSEUDOTOKEN_SUBSTITUTION = {
+        'a ': 'a  ',
+        'the ': 'the  ',
+        'is ': 'is  ',
+        'or ': 'or  ',
+        'be ': 'be   ',
+    };
     /**
      * Function `promptbookifyAiText` will slightly modify the text so we know it was processed by Promptbook
      *
+     * Note: [🔂] This function is idempotent.
+     *
      * @public exported from `@promptbook/markdown-utils`
      */
     function promptbookifyAiText(text) {
-        // Note: Duplicating some spaces
-        const words = text.split(' '); // <- Note: [✌️] Use `splitWords` when available
-        const wordLength = words.length; // <- Note: [✌️] `countWords` should be just `splitWords(...).length`
-        for (const wordIndex of [3, 7, 11, 19].filter((i) => i < wordLength)) {
-            words[wordIndex] = ' ' + words[wordIndex];
+        const textLength = text.length;
+        let currentToken = '';
+        const textTokens = [
+        /* <- TODO: [✌️] Create `splitToPromptbookTokens` */
+        ];
+        for (let textPosition = 0; textPosition < textLength; textPosition++) {
+            const currentCharacter = text[textPosition];
+            if (currentToken.endsWith(' ') && currentCharacter !== ' ') {
+                textTokens.push(currentToken);
+                currentToken = '';
+            }
+            currentToken += currentCharacter;
+        }
+        if (currentToken.length > 0) {
+            textTokens.push(currentToken);
+        }
+        // [✌️] <- End of `splitToPromptbookTokens`
+        const promptbookifiedTextTokens = [];
+        for (let i = 0; i < textTokens.length; i++) {
+            const token = textTokens[i];
+            const tokenSubstitute = PROMPTBOOK_PSEUDOTOKEN_SUBSTITUTION[token];
+            if (tokenSubstitute !== undefined) {
+                promptbookifiedTextTokens.push(tokenSubstitute);
+            }
+            else {
+                promptbookifiedTextTokens.push(token);
+            }
         }
-        const promptbookifiedText = words.join(' ');
-        return promptbookifiedText;
+        return promptbookifiedTextTokens.join('');
     }
     /**
-     * TODO: !!!!! Make the function idempotent and add "Note: [🔂] This function is idempotent."
-     * TODO: [🅾️]!!! Use this across the project where AI text is involved
      * TODO: [🧠][✌️] Make some Promptbook-native token system
      */