@promptbook/utils 0.69.0-7 → 0.69.0

package/esm/typings/src/prepare/prepareTemplates.d.ts

@@ -23,7 +23,7 @@ export {};
 /**
  * TODO: [🧠] Add context to each template (if missing)
  * TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
- * TODO: [♨] !!! Prepare index the samples and maybe templates
+ * TODO: [♨][main] !!! Prepare index the samples and maybe templates
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time

package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts

@@ -33,7 +33,7 @@ export type ParameterJson = {
     readonly sampleValues?: Array<string_parameter_value>;
 };
 /**
- * TODO: [🧠] !!!!!! Should be here registered subparameter from foreach or not?
+ * TODO: [🧠] Should be here registered subparameters from foreach or not?
  * TODO: [♈] Probbably move expectations from templates to parameters
  * TODO: [🍙] Make some standard order of json properties
  */

package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts

@@ -42,7 +42,7 @@ export type PipelineJson = {
     /**
      * Version of the .ptbk.json file
      */
-    readonly promptbookVersion: string_semantic_version;
+    readonly promptbookVersion?: string_semantic_version;
     /**
      * Description of the promptbook
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure

package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts

@@ -39,6 +39,3 @@ export type ExecutionReportJson = {
      */
     readonly promptExecutions: Array<ExecutionPromptReportJson>;
 };
-/**
- * TODO: !!!!!! FOREACH in report
- */ 

package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts

@@ -1,3 +1,4 @@
+import type { ReadonlyDeep } from 'type-fest';
 import type { ExecutionReportJson } from './ExecutionReportJson';
 import type { ExecutionReportString } from './ExecutionReportString';
 import type { ExecutionReportStringOptions } from './ExecutionReportStringOptions';
@@ -6,7 +7,7 @@ import type { ExecutionReportStringOptions } from './ExecutionReportStringOption
  *
  * @public exported from `@promptbook/core`
  */
-export declare function executionReportJsonToString(executionReportJson: ExecutionReportJson, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
+export declare function executionReportJsonToString(executionReportJson: ReadonlyDeep<ExecutionReportJson>, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
 /**
  * TODO: Add mermaid chart for every report
  * TODO: [🧠] Allow to filter out some parts of the report by options

package/esm/typings/src/types/typeAliases.d.ts

@@ -592,7 +592,7 @@ export type number_megabytes = number_positive;
 export type number_gigabytes = number_positive;
 export type number_terabytes = number_positive;
 /**.
- * TODO: !!! Change "For example" to @example
+ * TODO: [main] !!! Change "For example" to @example
  * TODO: !! Change to branded types
  * TODO: Delete type aliases that are not exported or used internally
  */

package/esm/typings/src/utils/expectation-counters/index.d.ts

@@ -6,3 +6,6 @@ import type { ExpectationUnit } from '../../types/PipelineJson/Expectations';
  * @public exported from `@promptbook/utils`
  */
 export declare const CountUtils: Record<ExpectationUnit, (text: string) => ExpectationAmount>;
+/**
+ * TODO: [🧠][🤠] This should be probbably as part of `TextFormatDefinition`
+ */

package/esm/typings/src/utils/organization/{f.d.ts → empty_object.d.ts}

@@ -1,6 +1,10 @@
 /**
  * Organizational helper to better mark the place where to really use empty object `{}`
  *
+ * Note: There are 2 similar types>
+ * - `empty_object` @@@
+ * - `just_empty_object` @@@
+ *
  * @private within the repository
  */
-export type really_empty_object = Record<string, never>;
+export type empty_object = {};

package/esm/typings/src/utils/organization/just_empty_object.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Organizational helper to better @@@@
+ *
+ * Note: There are 2 similar types>
+ * - `empty_object` @@@
+ * - `just_empty_object` @@@
+ *
+ * Note: In most cases, you should use `empty_object`
+ *
+ * @private within the repository
+ */
+export type just_empty_object = Record<string, never>;

package/esm/typings/src/utils/{extractParameterNames.d.ts → parameters/extractParameterNames.d.ts}

@@ -1,5 +1,5 @@
-import type { string_parameter_name } from '../types/typeAliases';
-import type { string_template } from '../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { string_template } from '../../types/typeAliases';
 /**
  * Parses the template and returns the list of all parameter names
  *

package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts

@@ -0,0 +1,27 @@
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * @@@
+ */
+type MakeapAvailableToExpectedParametersOptions = {
+    /**
+     * @@@
+     */
+    readonly expectedParameters: Readonly<Record<string_parameter_name, null>>;
+    /**
+     * @@@
+     */
+    readonly availableParameters: Readonly<Record<string_parameter_name, string_parameter_value>>;
+};
+/**
+ * Maps available parameters to expected parameters
+ *
+ * The strategy is:
+ * 1) @@@
+ * 2) @@@
+ *
+ * @throws {PipelineExecutionError} @@@
+ * @private within the repository used in `createPipelineExecutor`
+ */
+export declare function mapAvailableToExpectedParameters(options: MakeapAvailableToExpectedParametersOptions): Readonly<Record<string_parameter_name, string_parameter_value>>;
+export {};

package/esm/typings/src/utils/{replaceParameters.d.ts → parameters/replaceParameters.d.ts}

@@ -1,5 +1,5 @@
-import type { Parameters } from '../types/typeAliases';
-import type { string_template } from '../types/typeAliases';
+import type { Parameters } from '../../types/typeAliases';
+import type { string_template } from '../../types/typeAliases';
 /**
  * Replaces parameters in template with values from parameters object
  *

package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts

@@ -22,6 +22,6 @@ import type { string_name } from '../../types/typeAliases';
 export declare function checkSerializableAsJson(name: string_name, value: unknown): void;
 /**
  * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
- * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
  * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
  */

package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts

@@ -19,6 +19,6 @@
  */
 export declare function isSerializableAsJson(value: unknown): boolean;
 /**
- * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
  * TODO: [🧠][💺] Can be done this on type-level?
  */

package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts

@@ -0,0 +1,10 @@
+import type { string_parameter_name } from '../../../types/typeAliases';
+/**
+ * Function `validateParameterName` will @@@
+ *
+ * @param parameterName @@@
+ * @returns @@@
+ * @throws {ParseError} @@@
+ * @private within the repository
+ */
+export declare function validateParameterName(parameterName: string): string_parameter_name;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/utils",
-    "version": "0.69.0-7",
+    "version": "0.69.0",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -12,21 +12,25 @@
         "Pavol Hejný <me@pavolhejny.com> (https://www.pavolhejny.com/)"
     ],
     "keywords": [
-        "autogpt",
-        "openai",
-        "gpt-3",
-        "gpt-4",
-        "chatgpt",
         "ai",
+        "llm",
+        "prompt",
+        "template",
+        "language-model",
+        "chatgpt",
+        "autogpt",
         "machine-learning",
         "natural-language-processing",
         "nlp",
-        "prompt",
-        "template",
-        "pipeline",
-        "automation",
-        "text-generation",
-        "language-model"
+        "openai",
+        "gpt-3",
+        "gpt-4",
+        "gpt-4o",
+        "gpt-4o-mini",
+        "o1",
+        "o1-mini",
+        "o1-preview",
+        "anthropic"
     ],
     "license": "CC-BY-4.0",
     "bugs": {

package/umd/index.umd.js

@@ -12,8 +12,8 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.69.0-6';
-    // TODO: !!!! List here all the versions and annotate + put into script
+    var PROMPTBOOK_VERSION = '0.69.0-21';
+    // TODO: [main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
     Copyright (c) Microsoft Corporation.
@@ -633,9 +633,9 @@
         return promptbookMermaid;
     }
     /**
-     * TODO: !!!!!! FOREACH in mermaid graph
-     * TODO: !!!!!! Knowledge in mermaid graph
-     * TODO: !!!!!! Personas in mermaid graph
+     * 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
      */
@@ -745,47 +745,47 @@
      * @public exported from `@promptbook/utils`
      */
     function extractParameterNamesFromTemplate(template) {
-        var e_1, _a, e_2, _b, e_3, _c;
+        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; }
         }
@@ -793,10 +793,22 @@
         //                      <- Note {websiteContent} is used in `preparedContent`
         // Note: [🍭] Fixing dependent subparameterName from FOREACH command
         if (foreach !== undefined) {
-            if (parameterNames.has(foreach.subparameterName)) {
-                parameterNames.delete(foreach.subparameterName);
-                parameterNames.add(foreach.parameterName);
-                // <- TODO: [🚎] Warn/logic error when `subparameterName` not used
+            try {
+                for (var _l = __values(foreach.inputSubparameterNames), _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;
@@ -1283,6 +1295,9 @@
         LINES: countLines,
         PAGES: countPages,
     };
+    /**
+     * TODO: [🧠][🤠] This should be probbably as part of `TextFormatDefinition`
+     */
 
     /**
      * Makes first letter of a string uppercase
@@ -1537,108 +1552,6 @@
         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;
-    }
-
     /**
      * @@@
      *
@@ -1792,7 +1705,7 @@
     }
     /**
      * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
-     * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+     * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
      * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
      */
 
@@ -1857,6 +1770,18 @@
      * @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
      */
@@ -1940,6 +1865,108 @@
         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;
+    }
+
     /**
      * @@@
      *
@@ -2021,7 +2048,7 @@
         }
     }
     /**
-     * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+     * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
      * TODO: [🧠][💺] Can be done this on type-level?
      */
 
@@ -2336,7 +2363,7 @@
         if ( /* version === '1.0.0' || */version === '2.0.0' || version === '3.0.0') {
             return false;
         }
-        // <- TODO: !!! Check isValidPromptbookVersion against PROMPTBOOK_VERSIONS
+        // <- TODO: [main] !!! Check isValidPromptbookVersion against PROMPTBOOK_VERSIONS
         return true;
     }