@promptbook/utils 0.102.0-5 → 0.102.0-7

package/esm/typings/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts

@@ -0,0 +1,20 @@
+import type { string_css_class } from '../../types/typeAliases';
+export type InjectCssModuleIntoShadowRootOptions = {
+    /**
+     * The shadow root where the styles should be injected
+     */
+    shadowRoot: ShadowRoot;
+    /**
+     * The imported CSS module styles object
+     */
+    styles: Record<string_css_class, string_css_class>;
+};
+/**
+ * Inject the CSS module rules (derived from imported `styles`) into the provided shadow root.
+ * This allows CSS modules (which are normally emitted into the document head) to be
+ * available inside the component's shadow DOM.
+ *
+ * @public exported from `@promptbook/components`
+ *         <- TODO: [🧠] Make `@promptbook/components-utils`
+ */
+export declare function injectCssModuleIntoShadowRoot(options: InjectCssModuleIntoShadowRootOptions): void;

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.102.0-4`).
+ * It follows semantic versioning (e.g., `0.102.0-6`).
  *
  * @generated
  */

package/package.json

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

package/umd/index.umd.js

@@ -22,7 +22,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.102.0-5';
+    const PROMPTBOOK_ENGINE_VERSION = '0.102.0-7';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -552,24 +552,6 @@
      * 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.
      *
@@ -970,6 +952,24 @@
      * 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.
      *
@@ -1825,18 +1825,6 @@
      * 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)
      *
@@ -2052,6 +2040,99 @@
      * 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
      *
@@ -2267,6 +2348,30 @@
      * 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
      *
@@ -2298,6 +2403,77 @@
         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$1.spaceTrim(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$1.spaceTrim(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
      *
@@ -2326,99 +2502,6 @@
         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.
      *
@@ -2575,112 +2658,6 @@
         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$1.spaceTrim(value);
-        if (!/^```[a-z]*(.*)```$/is.test(value)) {
-            return value;
-        }
-        value = value.replace(/^```[a-z]*/i, '');
-        value = value.replace(/```$/i, '');
-        value = spaceTrim$1.spaceTrim(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$1.spaceTrim(value);
-        value = value.replace(/```$/g, '');
-        value = spaceTrim$1.spaceTrim(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$1.spaceTrim(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$1.spaceTrim(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
      *
@@ -2891,6 +2868,7 @@
     exports.countParagraphs = countParagraphs;
     exports.countSentences = countSentences;
     exports.countWords = countWords;
+    exports.debounce = debounce;
     exports.decapitalize = decapitalize;
     exports.deepClone = deepClone;
     exports.deserializeError = deserializeError;
@@ -2943,8 +2921,6 @@
     exports.suffixUrl = suffixUrl;
     exports.templateParameters = templateParameters;
     exports.titleToName = titleToName;
-    exports.trimCodeBlock = trimCodeBlock;
-    exports.trimEndOfCodeBlock = trimEndOfCodeBlock;
     exports.union = union;
     exports.unwrapResult = unwrapResult;
     exports.valueToString = valueToString;