@promptbook/markitdown 0.103.0-55 → 0.103.0-66

package/esm/index.es.js

@@ -1,5 +1,5 @@
 import { mkdir, rm, readFile } from 'fs/promises';
-import spaceTrim, { spaceTrim as spaceTrim$1 } from 'spacetrim';
+import spaceTrim$2, { spaceTrim as spaceTrim$1 } from 'spacetrim';
 import { SHA256 } from 'crypto-js';
 import hexEncoder from 'crypto-js/enc-hex';
 import { basename, join, dirname, isAbsolute } from 'path';
@@ -24,7 +24,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.103.0-55';
+const PROMPTBOOK_ENGINE_VERSION = '0.103.0-66';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -47,6 +47,17 @@ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-55';
 function keepUnused(...valuesToKeep) {
 }
 
+/**
+ * Trims string from all 4 sides
+ *
+ * Note: This is a re-exported function from the `spacetrim` package which is
+ *       Developed by same author @hejny as this package
+ *
+ * @public exported from `@promptbook/utils`
+ * @see https://github.com/hejny/spacetrim#usage
+ */
+const spaceTrim = spaceTrim$1;
+
 /**
  * @private util of `@promptbook/color`
  * @de
@@ -95,6 +106,7 @@ function take(initialValue) {
  * @public exported from `@promptbook/color`
  */
 const CSS_COLORS = {
+    promptbook: '#79EAFD',
     transparent: 'rgba(0,0,0,0)',
     aliceblue: '#f0f8ff',
     antiquewhite: '#faebd7',
@@ -295,21 +307,61 @@ class Color {
      * @param color
      * @returns Color object
      */
-    static from(color) {
-        if (color instanceof Color) {
+    static from(color, _isSingleValue = false) {
+        if (color === '') {
+            throw new Error(`Can not create color from empty string`);
+        }
+        else if (color instanceof Color) {
             return take(color);
         }
         else if (Color.isColor(color)) {
             return take(color);
         }
         else if (typeof color === 'string') {
-            return Color.fromString(color);
+            try {
+                return Color.fromString(color);
+            }
+            catch (error) {
+                // <- Note: Can not use `assertsError(error)` here because it causes circular dependency
+                if (_isSingleValue) {
+                    throw error;
+                }
+                const parts = color.split(/[\s+,;|]/);
+                if (parts.length > 0) {
+                    return Color.from(parts[0].trim(), true);
+                }
+                else {
+                    throw new Error(`Can not create color from given string "${color}"`);
+                }
+            }
         }
         else {
             console.error({ color });
             throw new Error(`Can not create color from given object`);
         }
     }
+    /**
+     * Creates a new Color instance from miscellaneous formats
+     * It just does not throw error when it fails, it returns PROMPTBOOK_COLOR instead
+     *
+     * @param color
+     * @returns Color object
+     */
+    static fromSafe(color) {
+        try {
+            return Color.from(color);
+        }
+        catch (error) {
+            // <- Note: Can not use `assertsError(error)` here because it causes circular dependency
+            console.warn(spaceTrim((block) => `
+                        Color.fromSafe error:
+                        ${block(error.message)}
+
+                        Returning default PROMPTBOOK_COLOR.
+                    `));
+            return Color.fromString('promptbook');
+        }
+    }
     /**
      * Creates a new Color instance from miscellaneous string formats
      *
@@ -919,7 +971,7 @@ const ADMIN_GITHUB_NAME = 'hejny';
  *
  * @public exported from `@promptbook/core`
  */
-const PROMPTBOOK_COLOR = Color.fromHex('#79EAFD');
+const PROMPTBOOK_COLOR = Color.fromString('promptbook');
 // <- TODO: [🧠][🈵] Using `Color` here increases the package size approx 3kb, maybe remove it
 /**
  * Colors for syntax highlighting in the `<BookEditor/>`
@@ -1143,7 +1195,7 @@ class KnowledgeScrapeError extends Error {
 function getErrorReportUrl(error) {
     const report = {
         title: `🐜 Error report from ${NAME}`,
-        body: spaceTrim((block) => `
+        body: spaceTrim$2((block) => `
 
 
             \`${error.name || 'Error'}\` has occurred in the [${NAME}], please look into it @${ADMIN_GITHUB_NAME}.
@@ -2040,7 +2092,7 @@ function pipelineJsonToString(pipelineJson) {
         pipelineString += '\n\n';
         pipelineString += '```' + contentLanguage;
         pipelineString += '\n';
-        pipelineString += spaceTrim(content);
+        pipelineString += spaceTrim$2(content);
         //                   <- TODO: [main] !!3 Escape
         //                   <- TODO: [🧠] Some clear strategy how to spaceTrim the blocks
         pipelineString += '\n';
@@ -2161,7 +2213,7 @@ function checkSerializableAsJson(options) {
     }
     else if (typeof value === 'object') {
         if (value instanceof Date) {
-            throw new UnexpectedError(spaceTrim((block) => `
+            throw new UnexpectedError(spaceTrim$2((block) => `
                         \`${name}\` is Date
 
                         Use \`string_date_iso8601\` instead
@@ -2180,7 +2232,7 @@ function checkSerializableAsJson(options) {
             throw new UnexpectedError(`${name} is RegExp`);
         }
         else if (value instanceof Error) {
-            throw new UnexpectedError(spaceTrim((block) => `
+            throw new UnexpectedError(spaceTrim$2((block) => `
                         \`${name}\` is unserialized Error
 
                         Use function \`serializeError\`
@@ -2203,7 +2255,7 @@ function checkSerializableAsJson(options) {
             }
             catch (error) {
                 assertsError(error);
-                throw new UnexpectedError(spaceTrim((block) => `
+                throw new UnexpectedError(spaceTrim$2((block) => `
                             \`${name}\` is not serializable
 
                             ${block(error.stack || error.message)}
@@ -2235,7 +2287,7 @@ function checkSerializableAsJson(options) {
         }
     }
     else {
-        throw new UnexpectedError(spaceTrim((block) => `
+        throw new UnexpectedError(spaceTrim$2((block) => `
                     \`${name}\` is unknown type
 
                     Additional message for \`${name}\`:
@@ -3266,7 +3318,7 @@ function serializeError(error) {
     const { name, message, stack } = error;
     const { id } = error;
     if (!Object.keys(ALL_ERRORS).includes(name)) {
-        console.error(spaceTrim((block) => `
+        console.error(spaceTrim$2((block) => `
 
                     Cannot serialize error with name "${name}"
 
@@ -3299,7 +3351,7 @@ function jsonParse(value) {
     }
     else if (typeof value !== 'string') {
         console.error('Can not parse JSON from non-string value.', { text: value });
-        throw new Error(spaceTrim(`
+        throw new Error(spaceTrim$2(`
                     Can not parse JSON from non-string value.
 
                     The value type: ${typeof value}
@@ -3313,7 +3365,7 @@ function jsonParse(value) {
         if (!(error instanceof Error)) {
             throw error;
         }
-        throw new Error(spaceTrim((block) => `
+        throw new Error(spaceTrim$2((block) => `
                     ${block(error.message)}
 
                     The expected JSON text:
@@ -3366,7 +3418,7 @@ function deserializeError(error) {
         message = `${name}: ${message}`;
     }
     if (stack !== undefined && stack !== '') {
-        message = spaceTrim((block) => `
+        message = spaceTrim$2((block) => `
                 ${block(message)}
 
                 Original stack trace:
@@ -3878,14 +3930,14 @@ class MultipleLlmExecutionTools {
             if (description === undefined) {
                 return headLine;
             }
-            return spaceTrim((block) => `
+            return spaceTrim$2((block) => `
                         ${headLine}
 
                           ${ /* <- Note: Indenting the description: */block(description)}
                     `);
         })
             .join('\n\n');
-        return spaceTrim((block) => `
+        return spaceTrim$2((block) => `
                 Multiple LLM Providers:
 
                 ${block(innerModelsTitlesAndDescriptions)}
@@ -3976,7 +4028,7 @@ class MultipleLlmExecutionTools {
             //     1) OpenAI throw PipelineExecutionError: Parameter `{knowledge}` is not defined
             //     2) AnthropicClaude throw PipelineExecutionError: Parameter `{knowledge}` is not defined
             //     3) ...
-            spaceTrim((block) => `
+            spaceTrim$2((block) => `
                           All execution tools of ${this.title} failed:
 
                           ${block(errors
@@ -3989,7 +4041,7 @@ class MultipleLlmExecutionTools {
             throw new PipelineExecutionError(`You have not provided any \`LlmExecutionTools\` into ${this.title}`);
         }
         else {
-            throw new PipelineExecutionError(spaceTrim((block) => `
+            throw new PipelineExecutionError(spaceTrim$2((block) => `
                           You have not provided any \`LlmExecutionTools\` that support model variant "${prompt.modelRequirements.modelVariant}" into ${this.title}
 
                           Available \`LlmExecutionTools\`:
@@ -4022,7 +4074,7 @@ class MultipleLlmExecutionTools {
  */
 function joinLlmExecutionTools(title, ...llmExecutionTools) {
     if (llmExecutionTools.length === 0) {
-        const warningMessage = spaceTrim(`
+        const warningMessage = spaceTrim$2(`
             You have not provided any \`LlmExecutionTools\`
             This means that you won't be able to execute any prompts that require large language models like GPT-4 or Anthropic's Claude.
 
@@ -4339,14 +4391,14 @@ function $registeredScrapersMessage(availableScrapers) {
         return { ...metadata, isMetadataAviailable, isInstalled, isAvailableInTools };
     });
     if (metadata.length === 0) {
-        return spaceTrim(`
+        return spaceTrim$2(`
             **No scrapers are available**
 
             This is a unexpected behavior, you are probably using some broken version of Promptbook
             At least there should be available the metadata of the scrapers
         `);
     }
-    return spaceTrim((block) => `
+    return spaceTrim$2((block) => `
             Available scrapers are:
             ${block(metadata
         .map(({ packageName, className, isMetadataAviailable, isInstalled, mimeTypes, isAvailableInBrowser, isAvailableInTools, }, i) => {
@@ -4457,7 +4509,7 @@ const promptbookFetch = async (urlOrRequest, init) => {
         else if (urlOrRequest instanceof Request) {
             url = urlOrRequest.url;
         }
-        throw new PromptbookFetchError(spaceTrim((block) => `
+        throw new PromptbookFetchError(spaceTrim$2((block) => `
                     Can not fetch "${url}"
 
                     Fetch error:
@@ -4618,7 +4670,7 @@ async function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
         const fileExtension = getFileExtension(filename);
         const mimeType = extensionToMimeType(fileExtension || '');
         if (!(await isFileExisting(filename, tools.fs))) {
-            throw new NotFoundError(spaceTrim((block) => `
+            throw new NotFoundError(spaceTrim$2((block) => `
                           Can not make source handler for file which does not exist:
 
                           File:
@@ -4711,7 +4763,7 @@ async function prepareKnowledgePieces(knowledgeSources, tools, options) {
                     // <- TODO: [🪓] Here should be no need for spreading new array, just `partialPieces = partialPiecesUnchecked`
                     break;
                 }
-                console.warn(spaceTrim((block) => `
+                console.warn(spaceTrim$2((block) => `
                             Cannot scrape knowledge from source despite the scraper \`${scraper.metadata.className}\` supports the mime type "${sourceHandler.mimeType}".
 
                             The source:
@@ -4727,7 +4779,7 @@ async function prepareKnowledgePieces(knowledgeSources, tools, options) {
                 // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
             }
             if (partialPieces === null) {
-                throw new KnowledgeScrapeError(spaceTrim((block) => `
+                throw new KnowledgeScrapeError(spaceTrim$2((block) => `
                             Cannot scrape knowledge
 
                             The source:
@@ -5302,7 +5354,7 @@ const CsvFormatParser = {
                 const { value, outputParameterName, settings, mapCallback, onProgress } = options;
                 const csv = csvParse(value, settings);
                 if (csv.errors.length !== 0) {
-                    throw new CsvFormatError(spaceTrim((block) => `
+                    throw new CsvFormatError(spaceTrim$2((block) => `
                                 CSV parsing error
 
                                 Error(s) from CSV parsing:
@@ -5347,7 +5399,7 @@ const CsvFormatParser = {
                 const { value, settings, mapCallback, onProgress } = options;
                 const csv = csvParse(value, settings);
                 if (csv.errors.length !== 0) {
-                    throw new CsvFormatError(spaceTrim((block) => `
+                    throw new CsvFormatError(spaceTrim$2((block) => `
                                 CSV parsing error
 
                                 Error(s) from CSV parsing:
@@ -5557,7 +5609,7 @@ function mapAvailableToExpectedParameters(options) {
     }
     // Phase 2️⃣: Non-matching mapping
     if (expectedParameterNames.size !== availableParametersNames.size) {
-        throw new PipelineExecutionError(spaceTrim((block) => `
+        throw new PipelineExecutionError(spaceTrim$2((block) => `
                     Can not map available parameters to expected parameters
 
                     Mapped parameters:
@@ -6342,7 +6394,7 @@ async function executeFormatSubvalues(options) {
         return /* not await */ executeAttempts({ ...options, logLlmCall });
     }
     if (jokerParameterNames.length !== 0) {
-        throw new UnexpectedError(spaceTrim((block) => `
+        throw new UnexpectedError(spaceTrim$2((block) => `
                     JOKER parameters are not supported together with FOREACH command
 
                     [🧞‍♀️] This should be prevented in \`validatePipeline\`
@@ -6355,7 +6407,7 @@ async function executeFormatSubvalues(options) {
     if (formatDefinition === undefined) {
         throw new UnexpectedError(
         // <- TODO: [🧠][🧐] Should be formats fixed per promptbook version or behave as plugins (=> change UnexpectedError)
-        spaceTrim((block) => `
+        spaceTrim$2((block) => `
                     Unsupported format "${task.foreach.formatName}"
 
                     Available formats:
@@ -6372,7 +6424,7 @@ async function executeFormatSubvalues(options) {
     if (subvalueParser === undefined) {
         throw new UnexpectedError(
         // <- TODO: [🧠][🧐] Should be formats fixed per promptbook version or behave as plugins (=> change UnexpectedError)
-        spaceTrim((block) => `
+        spaceTrim$2((block) => `
                     Unsupported subformat name "${task.foreach.subformatName}" for format "${task.foreach.formatName}"
 
                     Available subformat names for format "${formatDefinition.formatName}":
@@ -6412,7 +6464,7 @@ async function executeFormatSubvalues(options) {
                 if (!(error instanceof PipelineExecutionError)) {
                     throw error;
                 }
-                const highLevelError = new PipelineExecutionError(spaceTrim((block) => `
+                const highLevelError = new PipelineExecutionError(spaceTrim$2((block) => `
                             ${error.message}
 
                             This is error in FOREACH command when mapping ${formatDefinition.formatName} ${subvalueParser.subvalueName} data (${index + 1}/${length})
@@ -6436,7 +6488,7 @@ async function executeFormatSubvalues(options) {
                     ...options,
                     priority: priority + index,
                     parameters: allSubparameters,
-                    pipelineIdentification: spaceTrim((block) => `
+                    pipelineIdentification: spaceTrim$2((block) => `
                             ${block(pipelineIdentification)}
                             Subparameter index: ${index}
                         `),
@@ -6445,7 +6497,7 @@ async function executeFormatSubvalues(options) {
             }
             catch (error) {
                 if (length > BIG_DATASET_TRESHOLD) {
-                    console.error(spaceTrim((block) => `
+                    console.error(spaceTrim$2((block) => `
                               ${error.message}
 
                               This is error in FOREACH command when processing ${formatDefinition.formatName} ${subvalueParser.subvalueName} data (${index + 1}/${length})
@@ -7317,8 +7369,8 @@ class MarkdownScraper {
         knowledgeTextPieces.map(async (knowledgeTextPiece, i) => {
             // Note: These are just default values, they will be overwritten by the actual values:
             let name = `piece-${i}`;
-            let title = spaceTrim(knowledgeTextPiece.substring(0, 100));
-            const knowledgePieceContent = spaceTrim(knowledgeTextPiece);
+            let title = spaceTrim$2(knowledgeTextPiece.substring(0, 100));
+            const knowledgePieceContent = spaceTrim$2(knowledgeTextPiece);
             let keywords = [];
             const index = [];
             /*
@@ -7331,7 +7383,7 @@ class MarkdownScraper {
                     isCrashedOnError: true,
                 });
                 const { title: titleRaw = 'Untitled' } = titleResult.outputParameters;
-                title = spaceTrim(titleRaw) /* <- TODO: Maybe do in pipeline */;
+                title = spaceTrim$2(titleRaw) /* <- TODO: Maybe do in pipeline */;
                 name = titleToName(title);
                 // --- Keywords
                 const keywordsResult = await prepareKeywordsExecutor({ knowledgePieceContent }).asPromise({