@promptbook/vercel 0.112.0-32 → 0.112.0-35

package/README.md

@@ -411,6 +411,24 @@ You can install all of them at once:
 npm i ptbk
 ```
 
+Promptbook also ships coding-agent CLI utilities through `ptbk coder`.
+For full `coder run` options and runner-specific examples, see [`scripts/run-codex-prompts/README.md`](./scripts/run-codex-prompts/README.md).
+
+#### `ptbk coder`
+
+Locally in this repository:
+
+```bash
+npx ts-node ./src/cli/test/ptbk.ts coder run --dry-run
+```
+
+In another project with `ptbk` installed:
+
+```bash
+npm install ptbk
+npx ptbk coder run --dry-run
+```
+
 Or you can install them separately:
 
 > ⭐ Marked packages are worth to try first

package/esm/index.es.js

@@ -16,7 +16,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.112.0-32';
+const PROMPTBOOK_ENGINE_VERSION = '0.112.0-35';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -28,16 +28,15 @@ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-32';
  * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
  * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
  *
- * @private internal helper function
  * @returns secure random token
+ *
+ * @private internal helper function
  */
 function $randomToken(randomness) {
     return randomBytes(randomness).toString('hex');
 }
-/**
- * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
- * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
- */
+// TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
+// TODO: Maybe use nanoid instead https://github.com/ai/nanoid
 
 /**
  * This error indicates errors during the execution of the pipeline
@@ -54,9 +53,7 @@ class PipelineExecutionError extends Error {
         Object.setPrototypeOf(this, PipelineExecutionError.prototype);
     }
 }
-/**
- * TODO: [🧠][🌂] Add id to all errors
- */
+// TODO: [🧠][🌂] Add id to all errors
 
 /**
  * Counts number of characters in the text
@@ -72,10 +69,8 @@ function countCharacters(text) {
     text = text.replace(/\p{Extended_Pictographic}(\u{200D}\p{Extended_Pictographic})*/gu, '-');
     return text.length;
 }
-/**
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
- * TODO: [🧠][✌️] Make some Promptbook-native token system
- */
+// TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+// TODO: [🧠][✌️] Make some Promptbook-native token system
 
 /**
  * Number of characters per standard line with 11pt Arial font size.
@@ -89,10 +84,8 @@ const CHARACTERS_PER_STANDARD_LINE = 63;
  * @public exported from `@promptbook/utils`
  */
 const LINES_PER_STANDARD_PAGE = 44;
-/**
- * TODO: [🧠] Should be this `constants.ts` or `config.ts`?
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */
+// TODO: [🧠] Should be this `constants.ts` or `config.ts`?
+// Note: [💞] Ignore a discrepancy between file name and entity name
 
 /**
  * Counts number of lines in the text
@@ -110,10 +103,8 @@ function countLines(text) {
     const lines = text.split(/\r?\n/);
     return lines.reduce((count, line) => count + Math.max(Math.ceil(line.length / CHARACTERS_PER_STANDARD_LINE), 1), 0);
 }
-/**
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
- * TODO: [🧠][✌️] Make some Promptbook-native token system
- */
+// TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+// TODO: [🧠][✌️] Make some Promptbook-native token system
 
 /**
  * Counts number of pages in the text
@@ -125,10 +116,8 @@ function countLines(text) {
 function countPages(text) {
     return Math.ceil(countLines(text) / LINES_PER_STANDARD_PAGE);
 }
-/**
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
- * TODO: [🧠][✌️] Make some Promptbook-native token system
- */
+// TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+// TODO: [🧠][✌️] Make some Promptbook-native token system
 
 /**
  * Counts number of paragraphs in the text
@@ -138,10 +127,8 @@ function countPages(text) {
 function countParagraphs(text) {
     return text.split(/\n\s*\n/).filter((paragraph) => paragraph.trim() !== '').length;
 }
-/**
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
- * TODO: [🧠][✌️] Make some Promptbook-native token system
- */
+// TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+// TODO: [🧠][✌️] Make some Promptbook-native token system
 
 /**
  * Split text into sentences
@@ -159,11 +146,12 @@ function splitIntoSentences(text) {
 function countSentences(text) {
     return splitIntoSentences(text).length;
 }
+// TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+// TODO: [🧠][✌️] Make some Promptbook-native token system
+
 /**
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
- * TODO: [🧠][✌️] Make some Promptbook-native token system
+ * Collection of default diacritics removal map.
  */
-
 const defaultDiacriticsRemovalMap = [
     {
         base: 'A',
@@ -415,6 +403,7 @@ for (let i = 0; i < defaultDiacriticsRemovalMap.length; i++) {
  *
  * @param input The string containing diacritics to be normalized.
  * @returns The string with diacritics removed or normalized.
+ *
  * @public exported from `@promptbook/utils`
  */
 function removeDiacritics(input) {
@@ -423,9 +412,7 @@ function removeDiacritics(input) {
         return DIACRITIC_VARIANTS_LETTERS[character] || character;
     });
 }
-/**
- * TODO: [Ж] Variant for cyrillic (and in general non-latin) letters
- */
+// TODO: [Ж] Variant for cyrillic (and in general non-latin) letters
 
 /**
  * Counts number of words in the text
@@ -439,11 +426,9 @@ function countWords(text) {
     text = text.replace(/([a-z])([A-Z])/g, '$1 $2');
     return text.split(/[^a-zа-я0-9]+/i).filter((word) => word.length > 0).length;
 }
-/**
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
- * TODO: [🧠][✌️] Make some Promptbook-native token system
- * TODO: [✌️] `countWords` should be just `splitWords(...).length`, and all other counters should use this pattern as well
- */
+// TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+// TODO: [🧠][✌️] Make some Promptbook-native token system
+// TODO: [✌️] `countWords` should be just `splitWords(...).length`, and all other counters should use this pattern as well
 
 /**
  * Helper of usage compute
@@ -471,6 +456,7 @@ function computeUsageCounts(content) {
  * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
  *
  * @returns The same object as the input, but deeply frozen
+ *
  * @public exported from `@promptbook/utils`
  */
 function $deepFreeze(objectValue) {
@@ -487,9 +473,7 @@ function $deepFreeze(objectValue) {
     Object.freeze(objectValue);
     return objectValue;
 }
-/**
- * TODO: [🧠] Is there a way how to meaningfully test this utility
- */
+// TODO: [🧠] Is there a way how to meaningfully test this utility
 
 /**
  * Represents the uncertain value
@@ -557,9 +541,7 @@ $deepFreeze({
         pagesCount: UNCERTAIN_ZERO_VALUE,
     },
 });
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */
+// Note: [💞] Ignore a discrepancy between file name and entity name
 
 /**
  * Make UncertainNumber
@@ -585,6 +567,7 @@ function uncertainNumber(value, isUncertain) {
  * 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() {
@@ -595,16 +578,20 @@ function $getCurrentDate() {
  * 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
+ * Developed by same author @hejny as this package
  *
- * @public exported from `@promptbook/utils`
  * @see https://github.com/hejny/spacetrim#usage
+ *
+ * @public exported from `@promptbook/utils`
  */
 const spaceTrim = spaceTrim$1;
 
 /**
- * @private util of `@promptbook/color`
+ * Class implementing take chain.
+ *
  * @de
+ *
+ * @private util of `@promptbook/color`
  */
 class TakeChain {
     constructor(value) {
@@ -621,9 +608,9 @@ class TakeChain {
  *
  * @param {*} initialValue - The initial value.
  * @returns {Proxy<WithTake<TValue>>} - A proxy object with a `take` method.
+ * @deprecated [🤡] Use some better functional library instead of `TakeChain`
  *
  * @private util of `@promptbook/color`
- * @deprecated [🤡] Use some better functional library instead of `TakeChain`
  */
 function take(initialValue) {
     if (initialValue instanceof TakeChain) {
@@ -801,9 +788,7 @@ const CSS_COLORS = {
     yellow: '#ffff00',
     yellowgreen: '#9acd32',
 };
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */
+// Note: [💞] Ignore a discrepancy between file name and entity name
 
 /**
  * Validates that a channel value is a valid number within the range of 0 to 255.
@@ -833,7 +818,13 @@ function checkChannelValue(channelName, value) {
     }
 }
 
+/**
+ * Constant for short hex lengths.
+ */
 const SHORT_HEX_LENGTHS = new Set([3, 4]);
+/**
+ * Constant for long hex lengths.
+ */
 const LONG_HEX_LENGTHS = new Set([6, 8]);
 /**
  * Parses a hex string into RGBA channel values.
@@ -866,6 +857,9 @@ function parseHexColor(hex) {
     }
     return throwInvalidHex();
 }
+/**
+ * Parses short hex channel.
+ */
 function parseShortHexChannel(char, onError) {
     if (!char) {
         return onError();
@@ -876,6 +870,9 @@ function parseShortHexChannel(char, onError) {
     }
     return parsed * 16;
 }
+/**
+ * Parses long hex channel.
+ */
 function parseLongHexChannel(hex, start, onError) {
     const segment = hex.substr(start, 2);
     if (segment.length < 2) {
@@ -888,6 +885,9 @@ function parseLongHexChannel(hex, start, onError) {
     return parsed;
 }
 
+/**
+ * Pattern matching hsl.
+ */
 const HSL_REGEX = /^hsl\(\s*([0-9.]+)\s*,\s*([0-9.]+)%\s*,\s*([0-9.]+)%\s*\)$/;
 /**
  * Parses an HSL string into RGBA channel values.
@@ -913,6 +913,9 @@ function parseHslColor(hsl) {
         alpha: 255,
     };
 }
+/**
+ * Handles convert hsl to Rgb.
+ */
 function convertHslToRgb(h, s, l) {
     const c = (1 - Math.abs(2 * l - 1)) * s;
     const x = c * (1 - Math.abs(((h / 60) % 2) - 1));
@@ -951,7 +954,13 @@ function convertHslToRgb(h, s, l) {
     };
 }
 
+/**
+ * Pattern matching RGB.
+ */
 const RGB_REGEX = /^rgb\(\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*\)$/;
+/**
+ * Pattern matching rgba.
+ */
 const RGBA_REGEX = /^rgba\(\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*\)$/;
 /**
  * Parses an RGB string into RGBA channel values.
@@ -993,6 +1002,9 @@ function parseRgbaColor(rgba) {
         alpha: parseAlphaValue(match[4]),
     };
 }
+/**
+ * Parses channel value.
+ */
 function parseChannelValue(value) {
     if (value.endsWith('%')) {
         const percent = parseFloat(value);
@@ -1000,6 +1012,9 @@ function parseChannelValue(value) {
     }
     return Math.round(parseFloat(value));
 }
+/**
+ * Parses alpha value.
+ */
 function parseAlphaValue(value) {
     if (value.endsWith('%')) {
         const percent = parseFloat(value);
@@ -1012,8 +1027,17 @@ function parseAlphaValue(value) {
     return Math.round(parsed);
 }
 
+/**
+ * Pattern matching hsl regex.
+ */
 const HSL_REGEX_PATTERN = /^hsl\(\s*([0-9.]+)\s*,\s*([0-9.]+)%\s*,\s*([0-9.]+)%\s*\)$/;
+/**
+ * Pattern matching RGB regex.
+ */
 const RGB_REGEX_PATTERN = /^rgb\(\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*\)$/;
+/**
+ * Pattern matching rgba regex.
+ */
 const RGBA_REGEX_PATTERN = /^rgba\(\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*\)$/;
 /**
  * Color object represents an RGB color with alpha channel
@@ -1379,9 +1403,7 @@ function hslToRgb(hue, saturation, lightness) {
     }
     return [Math.round(red * 255), Math.round(green * 255), Math.round(blue * 255)];
 }
-/**
- * TODO: Properly name all used internal variables
- */
+// TODO: Properly name all used internal variables
 
 /**
  * Converts RGB values to HSL values
@@ -1427,9 +1449,7 @@ function rgbToHsl(red, green, blue) {
     }
     return [hue, saturation, lightness];
 }
-/**
- * TODO: Properly name all used internal variables
- */
+// TODO: Properly name all used internal variables
 
 /**
  * Makes color transformer which lighten the given color
@@ -1447,9 +1467,7 @@ function lighten(amount) {
         return Color.fromValues(r, g, b, alpha);
     };
 }
-/**
- * TODO: Maybe implement by mix+hsl
- */
+// TODO: Maybe implement by mix+hsl
 
 /**
  * Makes color transformer which saturate the given color
@@ -1467,9 +1485,7 @@ function saturate(amount) {
         return Color.fromValues(r, g, b, alpha);
     };
 }
-/**
- * TODO: Maybe implement by mix+hsl
- */
+// TODO: Maybe implement by mix+hsl
 
 /**
  * Name for the Promptbook
@@ -1593,6 +1609,7 @@ parseInt(process.env.API_REQUEST_TIMEOUT || '90000');
  * Orders JSON object by keys
  *
  * @returns The same type of object as the input re-ordered
+ *
  * @public exported from `@promptbook/utils`
  */
 function orderJson(options) {
@@ -1738,6 +1755,7 @@ function assertsError(whatWasThrown) {
  * - And much more...
  *
  * @throws UnexpectedError if the value is not serializable as JSON
+ *
  * @public exported from `@promptbook/utils`
  */
 function checkSerializableAsJson(options) {
@@ -1852,11 +1870,9 @@ function checkSerializableAsJson(options) {
                 `));
     }
 }
-/**
- * TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
- * TODO: [🧠][main] !!3 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
- */
+// TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
+// TODO: [🧠][main] !!3 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
 
 /**
  * Creates a deep clone of the given object
@@ -1866,6 +1882,7 @@ function checkSerializableAsJson(options) {
  *
  * @param objectValue The object to clone.
  * @returns A deep, writable clone of the input object.
+ *
  * @public exported from `@promptbook/utils`
  */
 function deepClone(objectValue) {
@@ -1882,9 +1899,7 @@ function deepClone(objectValue) {
     > return Object.assign({}, objectValue);
     */
 }
-/**
- * TODO: [🧠] Is there a way how to meaningfully test this utility
- */
+// TODO: [🧠] Is there a way how to meaningfully test this utility
 
 /**
  * Utility to export a JSON object from a function
@@ -1897,6 +1912,7 @@ function deepClone(objectValue) {
  * Note: This function does not mutates the given object
  *
  * @returns The same type of object as the input but read-only and re-ordered
+ *
  * @public exported from `@promptbook/utils`
  */
 function exportJson(options) {
@@ -1916,9 +1932,7 @@ function exportJson(options) {
     $deepFreeze(orderedValue);
     return orderedValue;
 }
-/**
- * TODO: [🧠] Is there a way how to meaningfully test this utility
- */
+// TODO: [🧠] Is there a way how to meaningfully test this utility
 
 /**
  * Nonce which is used for replacing things in strings
@@ -1958,9 +1972,7 @@ exportJson({
         // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
     ],
 });
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */
+// Note: [💞] Ignore a discrepancy between file name and entity name
 
 /**
  * This error type indicates that some limit was reached
@@ -2008,8 +2020,8 @@ function numberToString(value) {
  * This is useful and used in the `templateParameters` function
  *
  * Note: This function is not just calling `toString` method
- *       It's more complex and can handle this conversion specifically for LLM models
- *       See `VALUE_STRINGS`
+ * It's more complex and can handle this conversion specifically for LLM models
+ * See `VALUE_STRINGS`
  *
  * Note: There are 2 similar functions
  * - `valueToString` converts value to string for LLM models as human-readable string
@@ -2060,12 +2072,13 @@ function valueToString(value) {
  * Replaces parameters in template with values from parameters object
  *
  * Note: This function is not places strings into string,
- *       It's more complex and can handle this operation specifically for LLM models
+ * It's more complex and can handle this operation specifically for LLM models
  *
  * @param template the template with parameters in {curly} braces
  * @param parameters the object with parameters
  * @returns the template with replaced parameters
  * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
+ *
  * @public exported from `@promptbook/utils`
  */
 function templateParameters(template, parameters) {