@promptbook/utils 0.102.0-4 → 0.102.0-6

package/esm/index.es.js

@@ -16,7 +16,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.102.0-4';
+const PROMPTBOOK_ENGINE_VERSION = '0.102.0-6';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -546,24 +546,6 @@ function normalizeTo_camelCase(text, _isFirstLetterCapital = false) {
  * TODO: [🌺] Use some intermediate util splitWords
  */
 
-/**
- * Removes emojis from a string and fix whitespaces
- *
- * Note: [🔂] This function is idempotent.
- *
- * @param text with emojis
- * @returns text without emojis
- * @public exported from `@promptbook/utils`
- */
-function removeEmojis(text) {
-    // Replace emojis (and also ZWJ sequence) with hyphens
-    text = text.replace(/(\p{Extended_Pictographic})\p{Modifier_Symbol}/gu, '$1');
-    text = text.replace(/(\p{Extended_Pictographic})[\u{FE00}-\u{FE0F}]/gu, '$1');
-    text = text.replace(/(\p{Extended_Pictographic})(\u{200D}\p{Extended_Pictographic})*/gu, '$1');
-    text = text.replace(/\p{Extended_Pictographic}/gu, '');
-    return text;
-}
-
 /**
  * Tests if given string is valid file path.
  *
@@ -964,6 +946,24 @@ function normalizeToKebabCase(text) {
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
+/**
+ * Removes emojis from a string and fix whitespaces
+ *
+ * Note: [🔂] This function is idempotent.
+ *
+ * @param text with emojis
+ * @returns text without emojis
+ * @public exported from `@promptbook/utils`
+ */
+function removeEmojis(text) {
+    // Replace emojis (and also ZWJ sequence) with hyphens
+    text = text.replace(/(\p{Extended_Pictographic})\p{Modifier_Symbol}/gu, '$1');
+    text = text.replace(/(\p{Extended_Pictographic})[\u{FE00}-\u{FE0F}]/gu, '$1');
+    text = text.replace(/(\p{Extended_Pictographic})(\u{200D}\p{Extended_Pictographic})*/gu, '$1');
+    text = text.replace(/\p{Extended_Pictographic}/gu, '');
+    return text;
+}
+
 /**
  * Converts a title string into a normalized name.
  *
@@ -1819,18 +1819,6 @@ const promptTemplate = prompt;
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
-/**
- * Simple wrapper `new Date().toISOString()`
- *
- * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic because it depends on the current time
- *
- * @returns string_date branded type
- * @public exported from `@promptbook/utils`
- */
-function $getCurrentDate() {
-    return new Date().toISOString();
-}
-
 /**
  * Detects if the code is running in a browser environment in main thread (Not in a web worker)
  *
@@ -2046,6 +2034,99 @@ const CountUtils = {
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
+/**
+ * Simple wrapper `new Date().toISOString()`
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic because it depends on the current time
+ *
+ * @returns string_date branded type
+ * @public exported from `@promptbook/utils`
+ */
+function $getCurrentDate() {
+    return new Date().toISOString();
+}
+
+/**
+ * @public exported from `@promptbook/utils`
+ */
+function debounce(fn, delay) {
+    let timeout = null;
+    return (...args) => {
+        if (timeout)
+            clearTimeout(timeout);
+        timeout = setTimeout(() => fn(...args), delay);
+    };
+}
+
+/**
+ * Function parseNumber will parse number from string
+ *
+ * Note: [🔂] This function is idempotent.
+ * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
+ * Note: it also works only with decimal numbers
+ *
+ * @returns parsed number
+ * @throws {ParseError} if the value is not a number
+ *
+ * @public exported from `@promptbook/utils`
+ */
+function parseNumber(value) {
+    const originalValue = value;
+    if (typeof value === 'number') {
+        value = value.toString(); // <- TODO: Maybe more efficient way to do this
+    }
+    if (typeof value !== 'string') {
+        return 0;
+    }
+    value = value.trim();
+    if (value.startsWith('+')) {
+        return parseNumber(value.substring(1));
+    }
+    if (value.startsWith('-')) {
+        const number = parseNumber(value.substring(1));
+        if (number === 0) {
+            return 0; // <- Note: To prevent -0
+        }
+        return -number;
+    }
+    value = value.replace(/,/g, '.');
+    value = value.toUpperCase();
+    if (value === '') {
+        return 0;
+    }
+    if (value === '♾' || value.startsWith('INF')) {
+        return Infinity;
+    }
+    if (value.includes('/')) {
+        const [numerator_, denominator_] = value.split('/');
+        const numerator = parseNumber(numerator_);
+        const denominator = parseNumber(denominator_);
+        if (denominator === 0) {
+            throw new ParseError(`Unable to parse number from "${originalValue}" because denominator is zero`);
+        }
+        return numerator / denominator;
+    }
+    if (/^(NAN|NULL|NONE|UNDEFINED|ZERO|NO.*)$/.test(value)) {
+        return 0;
+    }
+    if (value.includes('E')) {
+        const [significand, exponent] = value.split('E');
+        return parseNumber(significand) * 10 ** parseNumber(exponent);
+    }
+    if (!/^[0-9.]+$/.test(value) || value.split('.').length > 2) {
+        throw new ParseError(`Unable to parse number from "${originalValue}"`);
+    }
+    const num = parseFloat(value);
+    if (isNaN(num)) {
+        throw new ParseError(`Unexpected NaN when parsing number from "${originalValue}"`);
+    }
+    return num;
+}
+/**
+ * TODO: Maybe use sth. like safe-eval in fraction/calculation case @see https://www.npmjs.com/package/safe-eval
+ * TODO: [🧠][🌻] Maybe export through `@promptbook/markdown-utils` not `@promptbook/utils`
+ */
+
 /**
  * Makes first letter of a string uppercase
  *
@@ -2261,6 +2342,30 @@ function parseKeywords(input) {
  * TODO: [🌺] Use some intermediate util splitWords
  */
 
+/**
+ * Removes quotes from a string
+ *
+ * Note: [🔂] This function is idempotent.
+ * Tip: This is very useful for post-processing of the result of the LLM model
+ * Note: This function removes only the same quotes from the beginning and the end of the string
+ * Note: There are two similar functions:
+ * - `removeQuotes` which removes only bounding quotes
+ * - `unwrapResult` which removes whole introduce sentence
+ *
+ * @param text optionally quoted text
+ * @returns text without quotes
+ * @public exported from `@promptbook/utils`
+ */
+function removeQuotes(text) {
+    if (text.startsWith('"') && text.endsWith('"')) {
+        return text.slice(1, -1);
+    }
+    if (text.startsWith("'") && text.endsWith("'")) {
+        return text.slice(1, -1);
+    }
+    return text;
+}
+
 /**
  * Searches set of keywords for a specific keyword
  *
@@ -2292,6 +2397,77 @@ function suffixUrl(value, suffix) {
     return (baseUrl + normalizedSuffix);
 }
 
+/**
+ * Removes quotes and optional introduce text from a string
+ *
+ * Tip: This is very useful for post-processing of the result of the LLM model
+ * Note: This function trims the text and removes whole introduce sentence if it is present
+ * Note: There are two similar functions:
+ * - `removeQuotes` which removes only bounding quotes
+ * - `unwrapResult` which removes whole introduce sentence
+ *
+ * @param text optionally quoted text
+ * @returns text without quotes
+ * @public exported from `@promptbook/utils`
+ */
+function unwrapResult(text, options) {
+    const { isTrimmed = true, isIntroduceSentenceRemoved = true } = options || {};
+    let trimmedText = text;
+    // Remove leading and trailing spaces and newlines
+    if (isTrimmed) {
+        trimmedText = spaceTrim$2(trimmedText);
+    }
+    let processedText = trimmedText;
+    if (isIntroduceSentenceRemoved) {
+        const introduceSentenceRegex = /^[a-zěščřžýáíéúů:\s]*:\s*/i;
+        if (introduceSentenceRegex.test(text)) {
+            // Remove the introduce sentence and quotes by replacing it with an empty string
+            processedText = processedText.replace(introduceSentenceRegex, '');
+        }
+        processedText = spaceTrim$2(processedText);
+    }
+    if (processedText.length < 3) {
+        return trimmedText;
+    }
+    if (processedText.includes('\n')) {
+        return trimmedText;
+    }
+    // Remove the quotes by extracting the substring without the first and last characters
+    const unquotedText = processedText.slice(1, -1);
+    // Check if the text starts and ends with quotes
+    if ([
+        ['"', '"'],
+        ["'", "'"],
+        ['`', '`'],
+        ['*', '*'],
+        ['_', '_'],
+        ['„', '“'],
+        ['«', '»'] /* <- QUOTES to config */,
+    ].some(([startQuote, endQuote]) => {
+        if (!processedText.startsWith(startQuote)) {
+            return false;
+        }
+        if (!processedText.endsWith(endQuote)) {
+            return false;
+        }
+        if (unquotedText.includes(startQuote) && !unquotedText.includes(endQuote)) {
+            return false;
+        }
+        if (!unquotedText.includes(startQuote) && unquotedText.includes(endQuote)) {
+            return false;
+        }
+        return true;
+    })) {
+        return unwrapResult(unquotedText, { isTrimmed: false, isIntroduceSentenceRemoved: false });
+    }
+    else {
+        return processedText;
+    }
+}
+/**
+ * TODO: [🧠] Should this also unwrap the (parenthesis)
+ */
+
 /**
  * Trims string from all 4 sides
  *
@@ -2320,99 +2496,6 @@ function extractParameterNames(template) {
     return parameterNames;
 }
 
-/**
- * Function parseNumber will parse number from string
- *
- * Note: [🔂] This function is idempotent.
- * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
- * Note: it also works only with decimal numbers
- *
- * @returns parsed number
- * @throws {ParseError} if the value is not a number
- *
- * @public exported from `@promptbook/utils`
- */
-function parseNumber(value) {
-    const originalValue = value;
-    if (typeof value === 'number') {
-        value = value.toString(); // <- TODO: Maybe more efficient way to do this
-    }
-    if (typeof value !== 'string') {
-        return 0;
-    }
-    value = value.trim();
-    if (value.startsWith('+')) {
-        return parseNumber(value.substring(1));
-    }
-    if (value.startsWith('-')) {
-        const number = parseNumber(value.substring(1));
-        if (number === 0) {
-            return 0; // <- Note: To prevent -0
-        }
-        return -number;
-    }
-    value = value.replace(/,/g, '.');
-    value = value.toUpperCase();
-    if (value === '') {
-        return 0;
-    }
-    if (value === '♾' || value.startsWith('INF')) {
-        return Infinity;
-    }
-    if (value.includes('/')) {
-        const [numerator_, denominator_] = value.split('/');
-        const numerator = parseNumber(numerator_);
-        const denominator = parseNumber(denominator_);
-        if (denominator === 0) {
-            throw new ParseError(`Unable to parse number from "${originalValue}" because denominator is zero`);
-        }
-        return numerator / denominator;
-    }
-    if (/^(NAN|NULL|NONE|UNDEFINED|ZERO|NO.*)$/.test(value)) {
-        return 0;
-    }
-    if (value.includes('E')) {
-        const [significand, exponent] = value.split('E');
-        return parseNumber(significand) * 10 ** parseNumber(exponent);
-    }
-    if (!/^[0-9.]+$/.test(value) || value.split('.').length > 2) {
-        throw new ParseError(`Unable to parse number from "${originalValue}"`);
-    }
-    const num = parseFloat(value);
-    if (isNaN(num)) {
-        throw new ParseError(`Unexpected NaN when parsing number from "${originalValue}"`);
-    }
-    return num;
-}
-/**
- * TODO: Maybe use sth. like safe-eval in fraction/calculation case @see https://www.npmjs.com/package/safe-eval
- * TODO: [🧠][🌻] Maybe export through `@promptbook/markdown-utils` not `@promptbook/utils`
- */
-
-/**
- * Removes quotes from a string
- *
- * Note: [🔂] This function is idempotent.
- * Tip: This is very useful for post-processing of the result of the LLM model
- * Note: This function removes only the same quotes from the beginning and the end of the string
- * Note: There are two similar functions:
- * - `removeQuotes` which removes only bounding quotes
- * - `unwrapResult` which removes whole introduce sentence
- *
- * @param text optionally quoted text
- * @returns text without quotes
- * @public exported from `@promptbook/utils`
- */
-function removeQuotes(text) {
-    if (text.startsWith('"') && text.endsWith('"')) {
-        return text.slice(1, -1);
-    }
-    if (text.startsWith("'") && text.endsWith("'")) {
-        return text.slice(1, -1);
-    }
-    return text;
-}
-
 /**
  * Creates a deep clone of a PipelineJson object, copying all properties explicitly.
  *
@@ -2569,112 +2652,6 @@ function union(...sets) {
     return union;
 }
 
-/**
- * Function trimCodeBlock will trim starting and ending code block from the string if it is present.
- *
- * Note: [🔂] This function is idempotent.
- * Note: This is useful for post-processing of the result of the chat LLM model
- *       when the model wraps the result in the (markdown) code block.
- *
- * @public exported from `@promptbook/utils`
- */
-function trimCodeBlock(value) {
-    value = spaceTrim$2(value);
-    if (!/^```[a-z]*(.*)```$/is.test(value)) {
-        return value;
-    }
-    value = value.replace(/^```[a-z]*/i, '');
-    value = value.replace(/```$/i, '');
-    value = spaceTrim$2(value);
-    return value;
-}
-
-/**
- * Function trimEndOfCodeBlock will remove ending code block from the string if it is present.
- *
- * Note: This is useful for post-processing of the result of the completion LLM model
- *       if you want to start code block in the prompt but you don't want to end it in the result.
- *
- * @public exported from `@promptbook/utils`
- */
-function trimEndOfCodeBlock(value) {
-    value = spaceTrim$2(value);
-    value = value.replace(/```$/g, '');
-    value = spaceTrim$2(value);
-    return value;
-}
-
-/**
- * Removes quotes and optional introduce text from a string
- *
- * Tip: This is very useful for post-processing of the result of the LLM model
- * Note: This function trims the text and removes whole introduce sentence if it is present
- * Note: There are two similar functions:
- * - `removeQuotes` which removes only bounding quotes
- * - `unwrapResult` which removes whole introduce sentence
- *
- * @param text optionally quoted text
- * @returns text without quotes
- * @public exported from `@promptbook/utils`
- */
-function unwrapResult(text, options) {
-    const { isTrimmed = true, isIntroduceSentenceRemoved = true } = options || {};
-    let trimmedText = text;
-    // Remove leading and trailing spaces and newlines
-    if (isTrimmed) {
-        trimmedText = spaceTrim$2(trimmedText);
-    }
-    let processedText = trimmedText;
-    if (isIntroduceSentenceRemoved) {
-        const introduceSentenceRegex = /^[a-zěščřžýáíéúů:\s]*:\s*/i;
-        if (introduceSentenceRegex.test(text)) {
-            // Remove the introduce sentence and quotes by replacing it with an empty string
-            processedText = processedText.replace(introduceSentenceRegex, '');
-        }
-        processedText = spaceTrim$2(processedText);
-    }
-    if (processedText.length < 3) {
-        return trimmedText;
-    }
-    if (processedText.includes('\n')) {
-        return trimmedText;
-    }
-    // Remove the quotes by extracting the substring without the first and last characters
-    const unquotedText = processedText.slice(1, -1);
-    // Check if the text starts and ends with quotes
-    if ([
-        ['"', '"'],
-        ["'", "'"],
-        ['`', '`'],
-        ['*', '*'],
-        ['_', '_'],
-        ['„', '“'],
-        ['«', '»'] /* <- QUOTES to config */,
-    ].some(([startQuote, endQuote]) => {
-        if (!processedText.startsWith(startQuote)) {
-            return false;
-        }
-        if (!processedText.endsWith(endQuote)) {
-            return false;
-        }
-        if (unquotedText.includes(startQuote) && !unquotedText.includes(endQuote)) {
-            return false;
-        }
-        if (!unquotedText.includes(startQuote) && unquotedText.includes(endQuote)) {
-            return false;
-        }
-        return true;
-    })) {
-        return unwrapResult(unquotedText, { isTrimmed: false, isIntroduceSentenceRemoved: false });
-    }
-    else {
-        return processedText;
-    }
-}
-/**
- * TODO: [🧠] Should this also unwrap the (parenthesis)
- */
-
 /**
  * Checks if value is valid email
  *
@@ -2862,5 +2839,5 @@ function isValidUuid(value) {
     return /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/i.test(value);
 }
 
-export { $deepFreeze, $getCurrentDate, $isRunningInBrowser, $isRunningInJest, $isRunningInNode, $isRunningInWebWorker, BOOK_LANGUAGE_VERSION, CHARACTERS_PER_STANDARD_LINE, CountUtils, DIACRITIC_VARIANTS_LETTERS, LINES_PER_STANDARD_PAGE, PROMPTBOOK_ENGINE_VERSION, SMALL_NUMBER, VALUE_STRINGS, capitalize, checkSerializableAsJson, clonePipeline, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, decapitalize, deepClone, deserializeError, difference, exportJson, extractParameterNames, forEachAsync, intersection, isHostnameOnPrivateNetwork, isRootPath, isSerializableAsJson, isUrlOnPrivateNetwork, isValidCsvString, isValidEmail, isValidFilePath, isValidJavascriptName, isValidJsonString, isValidKeyword, isValidPipelineUrl, isValidPromptbookVersion, isValidSemanticVersion, isValidUrl, isValidUuid, isValidXmlString, jsonParse, jsonStringsToJsons, nameToUriPart, nameToUriParts, normalizeToKebabCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_camelCase, normalizeTo_snake_case, normalizeWhitespaces, numberToString, orderJson, parseKeywords, parseKeywordsFromString, parseNumber, prompt, promptTemplate, removeDiacritics, removeEmojis, removeQuotes, renderPromptbookMermaid, searchKeywords, serializeError, spaceTrim, splitIntoSentences, suffixUrl, templateParameters, titleToName, trimCodeBlock, trimEndOfCodeBlock, union, unwrapResult, valueToString };
+export { $deepFreeze, $getCurrentDate, $isRunningInBrowser, $isRunningInJest, $isRunningInNode, $isRunningInWebWorker, BOOK_LANGUAGE_VERSION, CHARACTERS_PER_STANDARD_LINE, CountUtils, DIACRITIC_VARIANTS_LETTERS, LINES_PER_STANDARD_PAGE, PROMPTBOOK_ENGINE_VERSION, SMALL_NUMBER, VALUE_STRINGS, capitalize, checkSerializableAsJson, clonePipeline, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, debounce, decapitalize, deepClone, deserializeError, difference, exportJson, extractParameterNames, forEachAsync, intersection, isHostnameOnPrivateNetwork, isRootPath, isSerializableAsJson, isUrlOnPrivateNetwork, isValidCsvString, isValidEmail, isValidFilePath, isValidJavascriptName, isValidJsonString, isValidKeyword, isValidPipelineUrl, isValidPromptbookVersion, isValidSemanticVersion, isValidUrl, isValidUuid, isValidXmlString, jsonParse, jsonStringsToJsons, nameToUriPart, nameToUriParts, normalizeToKebabCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_camelCase, normalizeTo_snake_case, normalizeWhitespaces, numberToString, orderJson, parseKeywords, parseKeywordsFromString, parseNumber, prompt, promptTemplate, removeDiacritics, removeEmojis, removeQuotes, renderPromptbookMermaid, searchKeywords, serializeError, spaceTrim, splitIntoSentences, suffixUrl, templateParameters, titleToName, union, unwrapResult, valueToString };
 //# sourceMappingURL=index.es.js.map