@promptbook/utils 0.72.0-0 → 0.72.0-2

package/README.md

@@ -16,6 +16,10 @@ Supercharge your use of large language models
 
 
 
+## ✨ New Features
+
+-   ✨ **Support of [OpenAI o1 model](https://openai.com/o1/)**
+
 ## 📦 Package `@promptbook/utils`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -28,7 +32,7 @@ To install this package, run:
 npm i ptbk
 
 # Install just this package to save space
-npm i @promptbook/utils
+npm install @promptbook/utils
 ```
 
 Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
@@ -159,10 +163,6 @@ See also the documentation for all the functions in the `@promptbook/utils` pack
 
 Rest of the documentation is common for **entire promptbook ecosystem**:
 
-# ✨ New Features
-
--   ✨ **Support [OpenAI o1 model](https://openai.com/o1/)**
-
 ## 🤍 The Promptbook Whitepaper
 
 
@@ -209,7 +209,6 @@ File `write-website-content.ptbk.md`:
 > Instructions for creating web page content.
 >
 > -   PIPELINE URL https://promptbook.studio/webgpt/write-website-content.ptbk.md
-> -   PROMPTBOOK VERSION 0.0.1
 > -   INPUT  PARAM `{rawTitle}` Automatically suggested a site name or empty text
 > -   INPUT  PARAM `{rawAssigment}` Automatically generated site entry from image recognition
 > -   OUTPUT PARAM `{websiteContent}` Web content

package/esm/index.es.js

@@ -4,7 +4,7 @@ import spaceTrim$1, { spaceTrim } from 'spacetrim';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.68.5';
+var PROMPTBOOK_VERSION = '0.72.0-1';
 // TODO:[main] !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
@@ -625,6 +625,9 @@ function renderPromptbookMermaid(pipelineJson, options) {
     return promptbookMermaid;
 }
 /**
+ * TODO: !!!!! FOREACH in mermaid graph
+ * TODO: !!!!! Knowledge in mermaid graph
+ * TODO: !!!!! Personas in mermaid graph
  * TODO: Maybe use some Mermaid package instead of string templating
  * TODO: [🕌] When more than 2 functionalities, split into separate functions
  */
@@ -734,52 +737,72 @@ function extractVariables(script) {
  * @public exported from `@promptbook/utils`
  */
 function extractParameterNamesFromTemplate(template) {
-    var e_1, _a, e_2, _b, e_3, _c;
-    var title = template.title, description = template.description, templateType = template.templateType, content = template.content, preparedContent = template.preparedContent, jokerParameterNames = template.jokerParameterNames;
+    var e_1, _a, e_2, _b, e_3, _c, e_4, _d;
+    var title = template.title, description = template.description, templateType = template.templateType, content = template.content, preparedContent = template.preparedContent, jokerParameterNames = template.jokerParameterNames, foreach = template.foreach;
     var parameterNames = new Set();
     try {
-        for (var _d = __values(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read(extractParameterNames(title)), false), __read(extractParameterNames(description || '')), false), __read(extractParameterNames(content)), false), __read(extractParameterNames(preparedContent || '')), false)), _e = _d.next(); !_e.done; _e = _d.next()) {
-            var parameterName = _e.value;
+        for (var _e = __values(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read(extractParameterNames(title)), false), __read(extractParameterNames(description || '')), false), __read(extractParameterNames(content)), false), __read(extractParameterNames(preparedContent || '')), false)), _f = _e.next(); !_f.done; _f = _e.next()) {
+            var parameterName = _f.value;
             parameterNames.add(parameterName);
         }
     }
     catch (e_1_1) { e_1 = { error: e_1_1 }; }
     finally {
         try {
-            if (_e && !_e.done && (_a = _d.return)) _a.call(_d);
+            if (_f && !_f.done && (_a = _e.return)) _a.call(_e);
         }
         finally { if (e_1) throw e_1.error; }
     }
     if (templateType === 'SCRIPT_TEMPLATE') {
         try {
-            for (var _f = __values(extractVariables(content)), _g = _f.next(); !_g.done; _g = _f.next()) {
-                var parameterName = _g.value;
+            for (var _g = __values(extractVariables(content)), _h = _g.next(); !_h.done; _h = _g.next()) {
+                var parameterName = _h.value;
                 parameterNames.add(parameterName);
             }
         }
         catch (e_2_1) { e_2 = { error: e_2_1 }; }
         finally {
             try {
-                if (_g && !_g.done && (_b = _f.return)) _b.call(_f);
+                if (_h && !_h.done && (_b = _g.return)) _b.call(_g);
             }
             finally { if (e_2) throw e_2.error; }
         }
     }
     try {
-        for (var _h = __values(jokerParameterNames || []), _j = _h.next(); !_j.done; _j = _h.next()) {
-            var jokerName = _j.value;
+        for (var _j = __values(jokerParameterNames || []), _k = _j.next(); !_k.done; _k = _j.next()) {
+            var jokerName = _k.value;
             parameterNames.add(jokerName);
         }
     }
     catch (e_3_1) { e_3 = { error: e_3_1 }; }
     finally {
         try {
-            if (_j && !_j.done && (_c = _h.return)) _c.call(_h);
+            if (_k && !_k.done && (_c = _j.return)) _c.call(_j);
         }
         finally { if (e_3) throw e_3.error; }
     }
     parameterNames.delete('content');
     //                      <- Note {websiteContent} is used in `preparedContent`
+    // Note: [🍭] Fixing dependent subparameterName from FOREACH command
+    if (foreach !== undefined) {
+        try {
+            for (var _l = __values(foreach.subparameterNames), _m = _l.next(); !_m.done; _m = _l.next()) {
+                var subparameterName = _m.value;
+                if (parameterNames.has(subparameterName)) {
+                    parameterNames.delete(subparameterName);
+                    parameterNames.add(foreach.parameterName);
+                    // <- TODO: [🚎] Warn/logic error when `subparameterName` not used
+                }
+            }
+        }
+        catch (e_4_1) { e_4 = { error: e_4_1 }; }
+        finally {
+            try {
+                if (_m && !_m.done && (_d = _l.return)) _d.call(_l);
+            }
+            finally { if (e_4) throw e_4.error; }
+        }
+    }
     return parameterNames;
 }
 /**
@@ -1264,6 +1287,9 @@ var CountUtils = {
     LINES: countLines,
     PAGES: countPages,
 };
+/**
+ * TODO: [🧠][🤠] This should be probbably as part of `TextFormatDefinition`
+ */
 
 /**
  * Makes first letter of a string uppercase
@@ -1518,108 +1544,6 @@ function searchKeywords(haystack, needle) {
     return true;
 }
 
-/**
- * Function parseNumber will parse number from string
- *
- * 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) {
-    var 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('-')) {
-        var 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('/')) {
-        var _a = __read(value.split('/'), 2), numerator_ = _a[0], denominator_ = _a[1];
-        var numerator = parseNumber(numerator_);
-        var denominator = parseNumber(denominator_);
-        if (denominator === 0) {
-            throw new ParseError("Unable to parse number from \"".concat(originalValue, "\" because denominator is zero"));
-        }
-        return numerator / denominator;
-    }
-    if (/^(NAN|NULL|NONE|UNDEFINED|ZERO|NO.*)$/.test(value)) {
-        return 0;
-    }
-    if (value.includes('E')) {
-        var _b = __read(value.split('E'), 2), significand = _b[0], exponent = _b[1];
-        return parseNumber(significand) * Math.pow(10, parseNumber(exponent));
-    }
-    if (!/^[0-9.]+$/.test(value) || value.split('.').length > 2) {
-        throw new ParseError("Unable to parse number from \"".concat(originalValue, "\""));
-    }
-    var num = parseFloat(value);
-    if (isNaN(num)) {
-        throw new ParseError("Unexpected NaN when parsing number from \"".concat(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`
- */
-
-/**
- * Generates random seed
- *
- * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
- * Warning: This function is not cryptographically secure (it uses Math.random internally)
- * @public exported from `@promptbook/utils`
- */
-function $randomSeed() {
-    return Math.random();
-}
-
-/**
- * Removes quotes from a string
- *
- * Tip: This is very usefull 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 simmilar 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;
-}
-
 /**
  * @@@
  *
@@ -1822,6 +1746,7 @@ $asDeeplyFrozenSerializableJson('RESERVED_PARAMETER_NAMES', [
     'samples',
     'modelName',
     'currentDate',
+    // <- TODO: !!!!! list here all command names
     // <- TODO: Add more like 'date', 'modelName',...
     // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
 ]);
@@ -1837,6 +1762,18 @@ var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
  * @private within the repository
  */
 var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
+// <- TODO: [🧜‍♂️]
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+Object.freeze({
+    delimiter: ',',
+    quoteChar: '"',
+    newline: '\n',
+    skipEmptyLines: true,
+});
 /**
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
  */
@@ -1920,6 +1857,108 @@ function replaceParameters(template, parameters) {
     return replacedTemplate;
 }
 
+/**
+ * Function parseNumber will parse number from string
+ *
+ * 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) {
+    var 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('-')) {
+        var 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('/')) {
+        var _a = __read(value.split('/'), 2), numerator_ = _a[0], denominator_ = _a[1];
+        var numerator = parseNumber(numerator_);
+        var denominator = parseNumber(denominator_);
+        if (denominator === 0) {
+            throw new ParseError("Unable to parse number from \"".concat(originalValue, "\" because denominator is zero"));
+        }
+        return numerator / denominator;
+    }
+    if (/^(NAN|NULL|NONE|UNDEFINED|ZERO|NO.*)$/.test(value)) {
+        return 0;
+    }
+    if (value.includes('E')) {
+        var _b = __read(value.split('E'), 2), significand = _b[0], exponent = _b[1];
+        return parseNumber(significand) * Math.pow(10, parseNumber(exponent));
+    }
+    if (!/^[0-9.]+$/.test(value) || value.split('.').length > 2) {
+        throw new ParseError("Unable to parse number from \"".concat(originalValue, "\""));
+    }
+    var num = parseFloat(value);
+    if (isNaN(num)) {
+        throw new ParseError("Unexpected NaN when parsing number from \"".concat(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`
+ */
+
+/**
+ * Generates random seed
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
+ * Warning: This function is not cryptographically secure (it uses Math.random internally)
+ * @public exported from `@promptbook/utils`
+ */
+function $randomSeed() {
+    return Math.random();
+}
+
+/**
+ * Removes quotes from a string
+ *
+ * Tip: This is very usefull 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 simmilar 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;
+}
+
 /**
  * @@@
  *