@promptbook/utils 0.44.0-4 → 0.44.0-5

package/esm/index.es.js

@@ -402,7 +402,7 @@ function removeContentComments(content) {
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.44.0-3';
+var PROMPTBOOK_VERSION = '0.44.0-4';
 
 /**
  * Parses the given script and returns the list of all used variables that are not defined in the script
@@ -470,6 +470,7 @@ var ExecutionTypes = [
  */
 var EXPECTATION_UNITS = ['CHARACTERS', 'WORDS', 'SENTENCES', 'PARAGRAPHS', 'LINES', 'PAGES'];
 /**
+ * TODO: [💝] Unite object for expecting amount and format - remove expectFormat
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
  */
 
@@ -1228,464 +1229,73 @@ function assertsExecutionSuccessful(executionResult) {
  */
 
 /**
- * This error occurs during the parameter replacement in the template
+ * This error occurs when some expectation is not met in the execution of the pipeline
  *
- * Note: This is a kindof subtype of PromptbookExecutionError because it occurs during the execution of the pipeline
+ * @private Always catched and rethrown as `PromptbookExecutionError`
+ * Note: This is a kindof subtype of PromptbookExecutionError
  */
-var TemplateError = /** @class */ (function (_super) {
-    __extends(TemplateError, _super);
-    function TemplateError(message) {
+var ExpectError = /** @class */ (function (_super) {
+    __extends(ExpectError, _super);
+    function ExpectError(message) {
         var _this = _super.call(this, message) || this;
-        _this.name = 'TemplateError';
-        Object.setPrototypeOf(_this, TemplateError.prototype);
+        _this.name = 'ExpectError';
+        Object.setPrototypeOf(_this, ExpectError.prototype);
         return _this;
     }
-    return TemplateError;
+    return ExpectError;
 }(Error));
 
 /**
- * Replaces parameters in template with values from parameters object
- *
- * @param template the template with parameters in {curly} braces
- * @param parameters the object with parameters
- * @returns the template with replaced parameters
- * @throws {TemplateError} if parameter is not defined, not closed, or not opened
- *
- * @private within the createPromptbookExecutor
- */
-function replaceParameters(template, parameters) {
-    var replacedTemplate = template;
-    var match;
-    var loopLimit = LOOP_LIMIT;
-    var _loop_1 = function () {
-        if (loopLimit-- < 0) {
-            throw new UnexpectedError('Loop limit reached during parameters replacement in `replaceParameters`');
-        }
-        var precol = match.groups.precol;
-        var parameterName = match.groups.parameterName;
-        if (parameterName === '') {
-            return "continue";
-        }
-        if (parameterName.indexOf('{') !== -1 || parameterName.indexOf('}') !== -1) {
-            throw new TemplateError('Parameter is already opened or not closed');
-        }
-        if (parameters[parameterName] === undefined) {
-            throw new TemplateError("Parameter {".concat(parameterName, "} is not defined"));
-        }
-        var parameterValue = parameters[parameterName];
-        if (parameterValue === undefined) {
-            throw new TemplateError("Parameter {".concat(parameterName, "} is not defined"));
-        }
-        parameterValue = parameterValue.toString();
-        if (parameterValue.includes('\n') && /^\s*\W{0,3}\s*$/.test(precol)) {
-            parameterValue = parameterValue
-                .split('\n')
-                .map(function (line, index) { return (index === 0 ? line : "".concat(precol).concat(line)); })
-                .join('\n');
-        }
-        replacedTemplate =
-            replacedTemplate.substring(0, match.index + precol.length) +
-                parameterValue +
-                replacedTemplate.substring(match.index + precol.length + parameterName.length + 2);
-    };
-    while ((match = /^(?<precol>.*){(?<parameterName>\w+)}(.*)/m /* <- Not global */
-        .exec(replacedTemplate))) {
-        _loop_1();
-    }
-    // [💫] Check if there are parameters that are not closed properly
-    if (/{\w+$/.test(replacedTemplate)) {
-        throw new TemplateError('Parameter is not closed');
-    }
-    // [💫] Check if there are parameters that are not opened properly
-    if (/^\w+}/.test(replacedTemplate)) {
-        throw new TemplateError('Parameter is not opened');
-    }
-    return replacedTemplate;
-}
-
-/**
- * Format either small or big number
- *
- * @private within the library
- */
-function formatNumber(value) {
-    if (value === 0) {
-        return '0';
-    }
-    for (var exponent = 0; exponent < 15; exponent++) {
-        var factor = Math.pow(10, exponent);
-        var valueRounded = Math.round(value * factor) / factor;
-        if (Math.abs(value - valueRounded) / value <
-            0.001 /* <- TODO: Pass as option, pass to executionReportJsonToString as option */) {
-            return valueRounded.toFixed(exponent);
-        }
-    }
-    return value.toString();
-}
-
-/**
- * Returns the same value that is passed as argument.
- * No side effects.
- *
- * Note: It can be usefull for leveling indentation
- *
- * @param value any values
- * @returns the same values
- */
-function just(value) {
-    if (value === undefined) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        return undefined;
-    }
-    return value;
-}
-
-/**
- * Removes emojis from a string and fix whitespaces
- *
- * @param text with emojis
- * @returns text without emojis
+ * Counts number of characters in the text
  */
-function removeEmojis(text) {
+function countCharacters(text) {
+    // Remove null characters
+    text = text.replace(/\0/g, '');
     // 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;
-}
-
-/**
- * Create a markdown table from a 2D array of strings
- *
- * @private within the library
- */
-function createMarkdownTable(table) {
-    var columnWidths = table.reduce(function (widths, row) {
-        row.forEach(function (cell, columnIndex) {
-            var cellLength = cell.length;
-            if (!widths[columnIndex] || cellLength > widths[columnIndex]) {
-                widths[columnIndex] = cellLength;
-            }
-        });
-        return widths;
-    }, []);
-    var header = "| ".concat(table[0]
-        .map(function (cell, columnIndex) { return cell.padEnd(columnWidths[columnIndex]); })
-        .join(' | '), " |");
-    var separator = "|".concat(columnWidths.map(function (width) { return '-'.repeat(width + 2); }).join('|'), "|");
-    var rows = table.slice(1).map(function (row) {
-        var paddedRow = row.map(function (cell, columnIndex) {
-            return cell.padEnd(columnWidths[columnIndex]);
-        });
-        return "| ".concat(paddedRow.join(' | '), " |");
-    });
-    return __spreadArray([header, separator], __read(rows), false).join('\n');
+    text = text.replace(/\p{Extended_Pictographic}(\u{200D}\p{Extended_Pictographic})*/gu, '-');
+    return text.length;
 }
 
 /**
- * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
- *
- * @private within the library
+ * Counts number of lines in the text
  */
-function createMarkdownChart(options) {
-    var e_1, _a;
-    var nameHeader = options.nameHeader, valueHeader = options.valueHeader, items = options.items, width = options.width, unitName = options.unitName;
-    var from = Math.min.apply(Math, __spreadArray([], __read(items.map(function (item) { return item.from; })), false));
-    var to = Math.max.apply(Math, __spreadArray([], __read(items.map(function (item) { return item.to; })), false));
-    var scale = width / (to - from);
-    var table = [[nameHeader, valueHeader]];
-    try {
-        for (var items_1 = __values(items), items_1_1 = items_1.next(); !items_1_1.done; items_1_1 = items_1.next()) {
-            var item = items_1_1.value;
-            var before = Math.round((item.from - from) * scale);
-            var during = Math.round((item.to - item.from) * scale);
-            var after = width - before - during;
-            table.push([removeEmojis(item.title).trim(), '░'.repeat(before) + '█'.repeat(during) + '░'.repeat(after)]);
-        }
-    }
-    catch (e_1_1) { e_1 = { error: e_1_1 }; }
-    finally {
-        try {
-            if (items_1_1 && !items_1_1.done && (_a = items_1.return)) _a.call(items_1);
-        }
-        finally { if (e_1) throw e_1.error; }
+function countLines(text) {
+    if (text === '') {
+        return 0;
     }
-    var legend = "_Note: Each \u2588 represents ".concat(formatNumber(1 / scale), " ").concat(unitName, ", width of ").concat(valueHeader.toLowerCase(), " is ").concat(formatNumber(to - from), " ").concat(unitName, " = ").concat(width, " squares_");
-    return createMarkdownTable(table) + '\n\n' + legend;
+    return text.split('\n').length;
 }
-/**
- * TODO: Maybe use Mermain Gant Diagrams
- *       @see https://jojozhuang.github.io/tutorial/mermaid-cheat-sheet/
- */
 
 /**
- * Function escapeMarkdownBlock will escape markdown block if needed
- * It is useful when you want have block in block
+ * Counts number of pages in the text
  */
-function escapeMarkdownBlock(value) {
-    return value.replace(/```/g, '\\`\\`\\`');
+function countPages(text) {
+    var sentencesPerPage = 5; // Assuming each page has 5 sentences
+    var sentences = text.split(/[.!?]+/).filter(function (sentence) { return sentence.trim() !== ''; });
+    var pageCount = Math.ceil(sentences.length / sentencesPerPage);
+    return pageCount;
 }
 
 /**
- * Default options for generating an execution report string
+ * Counts number of paragraphs in the text
  */
-var ExecutionReportStringOptionsDefaults = {
-    taxRate: 0,
-    chartsWidth: 36,
-};
+function countParagraphs(text) {
+    return text.split(/\n\s*\n/).filter(function (paragraph) { return paragraph.trim() !== ''; }).length;
+}
 
 /**
- * The thresholds for the relative time in the `moment` library.
- *
- * @see https://momentjscom.readthedocs.io/en/latest/moment/07-customization/13-relative-time-threshold/
+ * Split text into sentences
  */
-var MOMENT_ARG_THRESHOLDS = {
-    ss: 3, // <- least number of seconds to be counted in seconds, minus 1. Must be set after setting the `s` unit or without setting the `s` unit.
-};
-
+function splitIntoSentences(text) {
+    return text.split(/[.!?]+/).filter(function (sentence) { return sentence.trim() !== ''; });
+}
 /**
- * Count the duration of working time
- *
- * @private within the library
+ * Counts number of sentences in the text
  */
-function countWorkingDuration(items) {
-    var e_1, _a;
-    var steps = Array.from(new Set(items.flatMap(function (item) { return [item.from, item.to]; })));
-    steps.sort(function (a, b) { return a - b; });
-    var intervals = steps.map(function (step, index) { return [step, steps[index + 1] || 0]; }).slice(0, -1);
-    var duration = 0;
-    var _loop_1 = function (interval) {
-        var _b = __read(interval, 2), from = _b[0], to = _b[1];
-        if (items.some(function (item) { return item.from < to && item.to > from; })) {
-            duration += to - from;
-        }
-    };
-    try {
-        for (var intervals_1 = __values(intervals), intervals_1_1 = intervals_1.next(); !intervals_1_1.done; intervals_1_1 = intervals_1.next()) {
-            var interval = intervals_1_1.value;
-            _loop_1(interval);
-        }
-    }
-    catch (e_1_1) { e_1 = { error: e_1_1 }; }
-    finally {
-        try {
-            if (intervals_1_1 && !intervals_1_1.done && (_a = intervals_1.return)) _a.call(intervals_1);
-        }
-        finally { if (e_1) throw e_1.error; }
-    }
-    return duration;
-}
-
-/**
- * Converts execution report from JSON to string format
- */
-function executionReportJsonToString(executionReportJson, options) {
-    var e_1, _a;
-    var _b, _c, _d, _e, _f, _g;
-    var _h = __assign(__assign({}, ExecutionReportStringOptionsDefaults), (options || {})), taxRate = _h.taxRate, chartsWidth = _h.chartsWidth;
-    var executionReportString = spaceTrim(function (block) { return "\n            # ".concat(executionReportJson.title || 'Execution report', "\n\n            ").concat(block(executionReportJson.description || ''), "\n          "); });
-    var headerList = [];
-    if (executionReportJson.promptbookUrl) {
-        headerList.push("PROMPTBOOK URL ".concat(executionReportJson.promptbookUrl));
-    }
-    headerList.push("PROMPTBOOK VERSION ".concat(executionReportJson.promptbookUsedVersion) +
-        (!executionReportJson.promptbookRequestedVersion
-            ? ''
-            : " *(requested ".concat(executionReportJson.promptbookRequestedVersion, ")*")));
-    if (executionReportJson.promptExecutions.length !== 0) {
-        // TODO: What if startedAt OR/AND completedAt is not defined?
-        var startedAt = moment(Math.min.apply(Math, __spreadArray([], __read(executionReportJson.promptExecutions
-            .filter(function (promptExecution) { var _a, _b; return (_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.timing) === null || _b === void 0 ? void 0 : _b.start; })
-            .map(function (promptExecution) { return moment(promptExecution.result.timing.start).valueOf(); })), false)));
-        var completedAt = moment(Math.max.apply(Math, __spreadArray([], __read(executionReportJson.promptExecutions
-            .filter(function (promptExecution) { var _a, _b; return (_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.timing) === null || _b === void 0 ? void 0 : _b.complete; })
-            .map(function (promptExecution) { return moment(promptExecution.result.timing.complete).valueOf(); })), false)));
-        var timingItems = executionReportJson.promptExecutions.map(function (promptExecution) {
-            var _a, _b, _c, _d;
-            return ({
-                title: promptExecution.prompt.title,
-                from: moment((_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.timing) === null || _b === void 0 ? void 0 : _b.start).valueOf() / 1000,
-                to: moment((_d = (_c = promptExecution.result) === null || _c === void 0 ? void 0 : _c.timing) === null || _d === void 0 ? void 0 : _d.complete).valueOf() / 1000,
-            });
-        });
-        var costItems = executionReportJson.promptExecutions
-            .filter(function (promptExecution) { var _a, _b; return typeof ((_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.usage) === null || _b === void 0 ? void 0 : _b.price) === 'number'; })
-            .map(function (promptExecution) {
-            var _a, _b;
-            return ({
-                title: promptExecution.prompt.title,
-                from: 0,
-                to: ((_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.usage) === null || _b === void 0 ? void 0 : _b.price) * (1 + taxRate),
-            });
-        });
-        var duration = moment.duration(completedAt.diff(startedAt));
-        var naturalDuration = moment.duration(countWorkingDuration(timingItems) * 1000);
-        var executionsWithKnownCost = executionReportJson.promptExecutions.filter(function (promptExecution) { var _a, _b; return (((_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.usage) === null || _b === void 0 ? void 0 : _b.price) || 'UNKNOWN') !== 'UNKNOWN'; });
-        var cost = executionsWithKnownCost.reduce(function (cost, promptExecution) { return cost + (promptExecution.result.usage.price || 0); }, 0);
-        headerList.push("STARTED AT ".concat(moment(startedAt).format("YYYY-MM-DD HH:mm:ss")));
-        headerList.push("COMPLETED AT ".concat(moment(completedAt).format("YYYY-MM-DD HH:mm:ss")));
-        headerList.push("TOTAL DURATION ".concat(duration.humanize(MOMENT_ARG_THRESHOLDS)));
-        headerList.push("TOTAL NATURAL DURATION ".concat(naturalDuration.humanize(MOMENT_ARG_THRESHOLDS)));
-        headerList.push("TOTAL COST $".concat(formatNumber(cost * (1 + taxRate))) +
-            (executionsWithKnownCost.length === executionReportJson.promptExecutions.length
-                ? ''
-                : " *(Some cost is unknown)*") +
-            (taxRate !== 0 ? " *(with tax ".concat(taxRate * 100, "%)*") : ''));
-        executionReportString += '\n\n' + headerList.map(function (header) { return "- ".concat(header); }).join('\n');
-        executionReportString +=
-            '\n\n' +
-                '## 🗃 Index' +
-                '\n\n' +
-                executionReportJson.promptExecutions
-                    .map(function (promptExecution) {
-                    // TODO: Make some better system to convert hedings to links
-                    var hash = normalizeToKebabCase(promptExecution.prompt.title);
-                    if (/^\s*\p{Extended_Pictographic}/u.test(promptExecution.prompt.title)) {
-                        hash = '-' + hash;
-                    }
-                    // TODO: Make working hash link for the template in md + pdf
-                    return "- [".concat(promptExecution.prompt.title, "](#").concat(hash, ")");
-                })
-                    .join('\n');
-        executionReportString +=
-            '\n\n' +
-                '## ⌚ Time chart' +
-                '\n\n' +
-                createMarkdownChart({
-                    nameHeader: 'Template',
-                    valueHeader: 'Timeline',
-                    items: timingItems,
-                    width: chartsWidth,
-                    unitName: 'seconds',
-                });
-        executionReportString +=
-            '\n\n' +
-                '## 💸 Cost chart' +
-                '\n\n' +
-                createMarkdownChart({
-                    nameHeader: 'Template',
-                    valueHeader: 'Cost',
-                    items: costItems,
-                    width: chartsWidth,
-                    unitName: 'USD',
-                });
-    }
-    else {
-        headerList.push("TOTAL COST $0 *(Nothing executed)*");
-    }
-    var _loop_1 = function (promptExecution) {
-        executionReportString += '\n\n\n\n' + "## ".concat(promptExecution.prompt.title);
-        var templateList = [];
-        // TODO: What if startedAt OR/AND completedAt is not defined?
-        var startedAt = moment((_c = (_b = promptExecution.result) === null || _b === void 0 ? void 0 : _b.timing) === null || _c === void 0 ? void 0 : _c.start);
-        var completedAt = moment((_e = (_d = promptExecution.result) === null || _d === void 0 ? void 0 : _d.timing) === null || _e === void 0 ? void 0 : _e.complete);
-        var duration = moment.duration(completedAt.diff(startedAt));
-        // Not need here:
-        // > templateList.push(`STARTED AT ${moment(startedAt).calendar()}`);
-        templateList.push("DURATION ".concat(duration.humanize(MOMENT_ARG_THRESHOLDS)));
-        if (typeof ((_g = (_f = promptExecution.result) === null || _f === void 0 ? void 0 : _f.usage) === null || _g === void 0 ? void 0 : _g.price) === 'number') {
-            templateList.push("COST $".concat(formatNumber(promptExecution.result.usage.price * (1 + taxRate))) +
-                (taxRate !== 0 ? " *(with tax ".concat(taxRate * 100, "%)*") : ''));
-        }
-        else {
-            templateList.push("COST UNKNOWN");
-        }
-        executionReportString += '\n\n' + templateList.map(function (header) { return "- ".concat(header); }).join('\n');
-        /*
-          -   MODEL VARIANT ${promptExecution.prompt.modelRequirements.modelVariant}
-                -   MODEL NAME \`${promptExecution.result?.model}\` (requested \`${
-                    promptExecution.prompt.modelRequirements.modelName
-
-        */
-        if (just(true)) {
-            executionReportString +=
-                '\n\n\n\n' +
-                    spaceTrim(function (block) { return "\n\n                        ### Prompt\n\n                        ```\n                        ".concat(block(escapeMarkdownBlock(promptExecution.prompt.content)), "\n                        ```\n\n                    "); });
-        }
-        if (promptExecution.result && promptExecution.result.content) {
-            executionReportString +=
-                '\n\n\n\n' +
-                    spaceTrim(function (block) { return "\n\n                        ### Result\n\n                        ```\n                        ".concat(block(escapeMarkdownBlock(promptExecution.result.content)), "\n                        ```\n                    "); });
-        }
-        if (promptExecution.error && promptExecution.error.message) {
-            executionReportString +=
-                '\n\n\n\n' +
-                    spaceTrim(function (block) { return "\n\n                        ### Error\n\n                        ```\n                        ".concat(block(escapeMarkdownBlock(promptExecution.error.message)), "\n                        ```\n\n                    "); });
-        }
-    };
-    try {
-        for (var _j = __values(executionReportJson.promptExecutions), _k = _j.next(); !_k.done; _k = _j.next()) {
-            var promptExecution = _k.value;
-            _loop_1(promptExecution);
-        }
-    }
-    catch (e_1_1) { e_1 = { error: e_1_1 }; }
-    finally {
-        try {
-            if (_k && !_k.done && (_a = _j.return)) _a.call(_j);
-        }
-        finally { if (e_1) throw e_1.error; }
-    }
-    executionReportString = prettifyMarkdown(executionReportString);
-    return executionReportString;
-}
-/**
- * TODO: Add mermaid chart for every report
- * TODO: [🧠] Allow to filter out some parts of the report by options
- */
-
-/**
- * Counts number of characters in the text
- */
-function countCharacters(text) {
-    // Remove null characters
-    text = text.replace(/\0/g, '');
-    // 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, '-');
-    return text.length;
-}
-
-/**
- * Counts number of lines in the text
- */
-function countLines(text) {
-    if (text === '') {
-        return 0;
-    }
-    return text.split('\n').length;
-}
-
-/**
- * Counts number of pages in the text
- */
-function countPages(text) {
-    var sentencesPerPage = 5; // Assuming each page has 5 sentences
-    var sentences = text.split(/[.!?]+/).filter(function (sentence) { return sentence.trim() !== ''; });
-    var pageCount = Math.ceil(sentences.length / sentencesPerPage);
-    return pageCount;
-}
-
-/**
- * Counts number of paragraphs in the text
- */
-function countParagraphs(text) {
-    return text.split(/\n\s*\n/).filter(function (paragraph) { return paragraph.trim() !== ''; }).length;
-}
-
-/**
- * Split text into sentences
- */
-function splitIntoSentences(text) {
-    return text.split(/[.!?]+/).filter(function (sentence) { return sentence.trim() !== ''; });
-}
-/**
- * Counts number of sentences in the text
- */
-function countSentences(text) {
-    return splitIntoSentences(text).length;
+function countSentences(text) {
+    return splitIntoSentences(text).length;
 }
 
 var defaultDiacriticsRemovalMap = [
@@ -1962,6 +1572,471 @@ var CountUtils = {
     PAGES: countPages,
 };
 
+/**
+ * Function checkExpectations will check if the expectations on given value are met
+ *
+ * Note: There are two simmilar functions:
+ * - `checkExpectations` which throws an error if the expectations are not met
+ * - `isPassingExpectations` which returns a boolean
+ *
+ * @throws {ExpectError} if the expectations are not met
+ * @returns {void} Nothing
+ */
+function checkExpectations(expectations, value) {
+    var e_1, _a;
+    try {
+        for (var _b = __values(Object.entries(expectations)), _c = _b.next(); !_c.done; _c = _b.next()) {
+            var _d = __read(_c.value, 2), unit = _d[0], _e = _d[1], max = _e.max, min = _e.min;
+            var amount = CountUtils[unit.toUpperCase()](value);
+            if (min && amount < min) {
+                throw new ExpectError("Expected at least ".concat(min, " ").concat(unit, " but got ").concat(amount));
+            } /* not else */
+            if (max && amount > max) {
+                throw new ExpectError("Expected at most ".concat(max, " ").concat(unit, " but got ").concat(amount));
+            }
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+}
+/**
+ * Function checkExpectations will check if the expectations on given value are met
+ *
+ * Note: There are two simmilar functions:
+ * - `checkExpectations` which throws an error if the expectations are not met
+ * - `isPassingExpectations` which returns a boolean
+ *
+ * @returns {boolean} True if the expectations are met
+ */
+function isPassingExpectations(expectations, value) {
+    try {
+        checkExpectations(expectations, value);
+        return true;
+    }
+    catch (error) {
+        if (!(error instanceof ExpectError)) {
+            throw error;
+        }
+        return false;
+    }
+}
+/**
+ * TODO: [💝] Unite object for expecting amount and format
+ */
+
+/**
+ * This error occurs during the parameter replacement in the template
+ *
+ * Note: This is a kindof subtype of PromptbookExecutionError because it occurs during the execution of the pipeline
+ */
+var TemplateError = /** @class */ (function (_super) {
+    __extends(TemplateError, _super);
+    function TemplateError(message) {
+        var _this = _super.call(this, message) || this;
+        _this.name = 'TemplateError';
+        Object.setPrototypeOf(_this, TemplateError.prototype);
+        return _this;
+    }
+    return TemplateError;
+}(Error));
+
+/**
+ * Replaces parameters in template with values from parameters object
+ *
+ * @param template the template with parameters in {curly} braces
+ * @param parameters the object with parameters
+ * @returns the template with replaced parameters
+ * @throws {TemplateError} if parameter is not defined, not closed, or not opened
+ *
+ * @private within the createPromptbookExecutor
+ */
+function replaceParameters(template, parameters) {
+    var replacedTemplate = template;
+    var match;
+    var loopLimit = LOOP_LIMIT;
+    var _loop_1 = function () {
+        if (loopLimit-- < 0) {
+            throw new UnexpectedError('Loop limit reached during parameters replacement in `replaceParameters`');
+        }
+        var precol = match.groups.precol;
+        var parameterName = match.groups.parameterName;
+        if (parameterName === '') {
+            return "continue";
+        }
+        if (parameterName.indexOf('{') !== -1 || parameterName.indexOf('}') !== -1) {
+            throw new TemplateError('Parameter is already opened or not closed');
+        }
+        if (parameters[parameterName] === undefined) {
+            throw new TemplateError("Parameter {".concat(parameterName, "} is not defined"));
+        }
+        var parameterValue = parameters[parameterName];
+        if (parameterValue === undefined) {
+            throw new TemplateError("Parameter {".concat(parameterName, "} is not defined"));
+        }
+        parameterValue = parameterValue.toString();
+        if (parameterValue.includes('\n') && /^\s*\W{0,3}\s*$/.test(precol)) {
+            parameterValue = parameterValue
+                .split('\n')
+                .map(function (line, index) { return (index === 0 ? line : "".concat(precol).concat(line)); })
+                .join('\n');
+        }
+        replacedTemplate =
+            replacedTemplate.substring(0, match.index + precol.length) +
+                parameterValue +
+                replacedTemplate.substring(match.index + precol.length + parameterName.length + 2);
+    };
+    while ((match = /^(?<precol>.*){(?<parameterName>\w+)}(.*)/m /* <- Not global */
+        .exec(replacedTemplate))) {
+        _loop_1();
+    }
+    // [💫] Check if there are parameters that are not closed properly
+    if (/{\w+$/.test(replacedTemplate)) {
+        throw new TemplateError('Parameter is not closed');
+    }
+    // [💫] Check if there are parameters that are not opened properly
+    if (/^\w+}/.test(replacedTemplate)) {
+        throw new TemplateError('Parameter is not opened');
+    }
+    return replacedTemplate;
+}
+
+/**
+ * Format either small or big number
+ *
+ * @private within the library
+ */
+function formatNumber(value) {
+    if (value === 0) {
+        return '0';
+    }
+    for (var exponent = 0; exponent < 15; exponent++) {
+        var factor = Math.pow(10, exponent);
+        var valueRounded = Math.round(value * factor) / factor;
+        if (Math.abs(value - valueRounded) / value <
+            0.001 /* <- TODO: Pass as option, pass to executionReportJsonToString as option */) {
+            return valueRounded.toFixed(exponent);
+        }
+    }
+    return value.toString();
+}
+
+/**
+ * Returns the same value that is passed as argument.
+ * No side effects.
+ *
+ * Note: It can be usefull for leveling indentation
+ *
+ * @param value any values
+ * @returns the same values
+ */
+function just(value) {
+    if (value === undefined) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return undefined;
+    }
+    return value;
+}
+
+/**
+ * Removes emojis from a string and fix whitespaces
+ *
+ * @param text with emojis
+ * @returns text without emojis
+ */
+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;
+}
+
+/**
+ * Create a markdown table from a 2D array of strings
+ *
+ * @private within the library
+ */
+function createMarkdownTable(table) {
+    var columnWidths = table.reduce(function (widths, row) {
+        row.forEach(function (cell, columnIndex) {
+            var cellLength = cell.length;
+            if (!widths[columnIndex] || cellLength > widths[columnIndex]) {
+                widths[columnIndex] = cellLength;
+            }
+        });
+        return widths;
+    }, []);
+    var header = "| ".concat(table[0]
+        .map(function (cell, columnIndex) { return cell.padEnd(columnWidths[columnIndex]); })
+        .join(' | '), " |");
+    var separator = "|".concat(columnWidths.map(function (width) { return '-'.repeat(width + 2); }).join('|'), "|");
+    var rows = table.slice(1).map(function (row) {
+        var paddedRow = row.map(function (cell, columnIndex) {
+            return cell.padEnd(columnWidths[columnIndex]);
+        });
+        return "| ".concat(paddedRow.join(' | '), " |");
+    });
+    return __spreadArray([header, separator], __read(rows), false).join('\n');
+}
+
+/**
+ * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
+ *
+ * @private within the library
+ */
+function createMarkdownChart(options) {
+    var e_1, _a;
+    var nameHeader = options.nameHeader, valueHeader = options.valueHeader, items = options.items, width = options.width, unitName = options.unitName;
+    var from = Math.min.apply(Math, __spreadArray([], __read(items.map(function (item) { return item.from; })), false));
+    var to = Math.max.apply(Math, __spreadArray([], __read(items.map(function (item) { return item.to; })), false));
+    var scale = width / (to - from);
+    var table = [[nameHeader, valueHeader]];
+    try {
+        for (var items_1 = __values(items), items_1_1 = items_1.next(); !items_1_1.done; items_1_1 = items_1.next()) {
+            var item = items_1_1.value;
+            var before = Math.round((item.from - from) * scale);
+            var during = Math.round((item.to - item.from) * scale);
+            var after = width - before - during;
+            table.push([removeEmojis(item.title).trim(), '░'.repeat(before) + '█'.repeat(during) + '░'.repeat(after)]);
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (items_1_1 && !items_1_1.done && (_a = items_1.return)) _a.call(items_1);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    var legend = "_Note: Each \u2588 represents ".concat(formatNumber(1 / scale), " ").concat(unitName, ", width of ").concat(valueHeader.toLowerCase(), " is ").concat(formatNumber(to - from), " ").concat(unitName, " = ").concat(width, " squares_");
+    return createMarkdownTable(table) + '\n\n' + legend;
+}
+/**
+ * TODO: Maybe use Mermain Gant Diagrams
+ *       @see https://jojozhuang.github.io/tutorial/mermaid-cheat-sheet/
+ */
+
+/**
+ * Function escapeMarkdownBlock will escape markdown block if needed
+ * It is useful when you want have block in block
+ */
+function escapeMarkdownBlock(value) {
+    return value.replace(/```/g, '\\`\\`\\`');
+}
+
+/**
+ * Default options for generating an execution report string
+ */
+var ExecutionReportStringOptionsDefaults = {
+    taxRate: 0,
+    chartsWidth: 36,
+};
+
+/**
+ * The thresholds for the relative time in the `moment` library.
+ *
+ * @see https://momentjscom.readthedocs.io/en/latest/moment/07-customization/13-relative-time-threshold/
+ */
+var MOMENT_ARG_THRESHOLDS = {
+    ss: 3, // <- least number of seconds to be counted in seconds, minus 1. Must be set after setting the `s` unit or without setting the `s` unit.
+};
+
+/**
+ * Count the duration of working time
+ *
+ * @private within the library
+ */
+function countWorkingDuration(items) {
+    var e_1, _a;
+    var steps = Array.from(new Set(items.flatMap(function (item) { return [item.from, item.to]; })));
+    steps.sort(function (a, b) { return a - b; });
+    var intervals = steps.map(function (step, index) { return [step, steps[index + 1] || 0]; }).slice(0, -1);
+    var duration = 0;
+    var _loop_1 = function (interval) {
+        var _b = __read(interval, 2), from = _b[0], to = _b[1];
+        if (items.some(function (item) { return item.from < to && item.to > from; })) {
+            duration += to - from;
+        }
+    };
+    try {
+        for (var intervals_1 = __values(intervals), intervals_1_1 = intervals_1.next(); !intervals_1_1.done; intervals_1_1 = intervals_1.next()) {
+            var interval = intervals_1_1.value;
+            _loop_1(interval);
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (intervals_1_1 && !intervals_1_1.done && (_a = intervals_1.return)) _a.call(intervals_1);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    return duration;
+}
+
+/**
+ * Converts execution report from JSON to string format
+ */
+function executionReportJsonToString(executionReportJson, options) {
+    var e_1, _a;
+    var _b, _c, _d, _e, _f, _g;
+    var _h = __assign(__assign({}, ExecutionReportStringOptionsDefaults), (options || {})), taxRate = _h.taxRate, chartsWidth = _h.chartsWidth;
+    var executionReportString = spaceTrim(function (block) { return "\n            # ".concat(executionReportJson.title || 'Execution report', "\n\n            ").concat(block(executionReportJson.description || ''), "\n          "); });
+    var headerList = [];
+    if (executionReportJson.promptbookUrl) {
+        headerList.push("PROMPTBOOK URL ".concat(executionReportJson.promptbookUrl));
+    }
+    headerList.push("PROMPTBOOK VERSION ".concat(executionReportJson.promptbookUsedVersion) +
+        (!executionReportJson.promptbookRequestedVersion
+            ? ''
+            : " *(requested ".concat(executionReportJson.promptbookRequestedVersion, ")*")));
+    if (executionReportJson.promptExecutions.length !== 0) {
+        // TODO: What if startedAt OR/AND completedAt is not defined?
+        var startedAt = moment(Math.min.apply(Math, __spreadArray([], __read(executionReportJson.promptExecutions
+            .filter(function (promptExecution) { var _a, _b; return (_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.timing) === null || _b === void 0 ? void 0 : _b.start; })
+            .map(function (promptExecution) { return moment(promptExecution.result.timing.start).valueOf(); })), false)));
+        var completedAt = moment(Math.max.apply(Math, __spreadArray([], __read(executionReportJson.promptExecutions
+            .filter(function (promptExecution) { var _a, _b; return (_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.timing) === null || _b === void 0 ? void 0 : _b.complete; })
+            .map(function (promptExecution) { return moment(promptExecution.result.timing.complete).valueOf(); })), false)));
+        var timingItems = executionReportJson.promptExecutions.map(function (promptExecution) {
+            var _a, _b, _c, _d;
+            return ({
+                title: promptExecution.prompt.title,
+                from: moment((_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.timing) === null || _b === void 0 ? void 0 : _b.start).valueOf() / 1000,
+                to: moment((_d = (_c = promptExecution.result) === null || _c === void 0 ? void 0 : _c.timing) === null || _d === void 0 ? void 0 : _d.complete).valueOf() / 1000,
+            });
+        });
+        var costItems = executionReportJson.promptExecutions
+            .filter(function (promptExecution) { var _a, _b; return typeof ((_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.usage) === null || _b === void 0 ? void 0 : _b.price) === 'number'; })
+            .map(function (promptExecution) {
+            var _a, _b;
+            return ({
+                title: promptExecution.prompt.title,
+                from: 0,
+                to: ((_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.usage) === null || _b === void 0 ? void 0 : _b.price) * (1 + taxRate),
+            });
+        });
+        var duration = moment.duration(completedAt.diff(startedAt));
+        var naturalDuration = moment.duration(countWorkingDuration(timingItems) * 1000);
+        var executionsWithKnownCost = executionReportJson.promptExecutions.filter(function (promptExecution) { var _a, _b; return (((_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.usage) === null || _b === void 0 ? void 0 : _b.price) || 'UNKNOWN') !== 'UNKNOWN'; });
+        var cost = executionsWithKnownCost.reduce(function (cost, promptExecution) { return cost + (promptExecution.result.usage.price || 0); }, 0);
+        headerList.push("STARTED AT ".concat(moment(startedAt).format("YYYY-MM-DD HH:mm:ss")));
+        headerList.push("COMPLETED AT ".concat(moment(completedAt).format("YYYY-MM-DD HH:mm:ss")));
+        headerList.push("TOTAL DURATION ".concat(duration.humanize(MOMENT_ARG_THRESHOLDS)));
+        headerList.push("TOTAL NATURAL DURATION ".concat(naturalDuration.humanize(MOMENT_ARG_THRESHOLDS)));
+        headerList.push("TOTAL COST $".concat(formatNumber(cost * (1 + taxRate))) +
+            (executionsWithKnownCost.length === executionReportJson.promptExecutions.length
+                ? ''
+                : " *(Some cost is unknown)*") +
+            (taxRate !== 0 ? " *(with tax ".concat(taxRate * 100, "%)*") : ''));
+        executionReportString += '\n\n' + headerList.map(function (header) { return "- ".concat(header); }).join('\n');
+        executionReportString +=
+            '\n\n' +
+                '## 🗃 Index' +
+                '\n\n' +
+                executionReportJson.promptExecutions
+                    .map(function (promptExecution) {
+                    // TODO: Make some better system to convert hedings to links
+                    var hash = normalizeToKebabCase(promptExecution.prompt.title);
+                    if (/^\s*\p{Extended_Pictographic}/u.test(promptExecution.prompt.title)) {
+                        hash = '-' + hash;
+                    }
+                    // TODO: Make working hash link for the template in md + pdf
+                    return "- [".concat(promptExecution.prompt.title, "](#").concat(hash, ")");
+                })
+                    .join('\n');
+        executionReportString +=
+            '\n\n' +
+                '## ⌚ Time chart' +
+                '\n\n' +
+                createMarkdownChart({
+                    nameHeader: 'Template',
+                    valueHeader: 'Timeline',
+                    items: timingItems,
+                    width: chartsWidth,
+                    unitName: 'seconds',
+                });
+        executionReportString +=
+            '\n\n' +
+                '## 💸 Cost chart' +
+                '\n\n' +
+                createMarkdownChart({
+                    nameHeader: 'Template',
+                    valueHeader: 'Cost',
+                    items: costItems,
+                    width: chartsWidth,
+                    unitName: 'USD',
+                });
+    }
+    else {
+        headerList.push("TOTAL COST $0 *(Nothing executed)*");
+    }
+    var _loop_1 = function (promptExecution) {
+        executionReportString += '\n\n\n\n' + "## ".concat(promptExecution.prompt.title);
+        var templateList = [];
+        // TODO: What if startedAt OR/AND completedAt is not defined?
+        var startedAt = moment((_c = (_b = promptExecution.result) === null || _b === void 0 ? void 0 : _b.timing) === null || _c === void 0 ? void 0 : _c.start);
+        var completedAt = moment((_e = (_d = promptExecution.result) === null || _d === void 0 ? void 0 : _d.timing) === null || _e === void 0 ? void 0 : _e.complete);
+        var duration = moment.duration(completedAt.diff(startedAt));
+        // Not need here:
+        // > templateList.push(`STARTED AT ${moment(startedAt).calendar()}`);
+        templateList.push("DURATION ".concat(duration.humanize(MOMENT_ARG_THRESHOLDS)));
+        if (typeof ((_g = (_f = promptExecution.result) === null || _f === void 0 ? void 0 : _f.usage) === null || _g === void 0 ? void 0 : _g.price) === 'number') {
+            templateList.push("COST $".concat(formatNumber(promptExecution.result.usage.price * (1 + taxRate))) +
+                (taxRate !== 0 ? " *(with tax ".concat(taxRate * 100, "%)*") : ''));
+        }
+        else {
+            templateList.push("COST UNKNOWN");
+        }
+        executionReportString += '\n\n' + templateList.map(function (header) { return "- ".concat(header); }).join('\n');
+        /*
+          -   MODEL VARIANT ${promptExecution.prompt.modelRequirements.modelVariant}
+                -   MODEL NAME \`${promptExecution.result?.model}\` (requested \`${
+                    promptExecution.prompt.modelRequirements.modelName
+
+        */
+        if (just(true)) {
+            executionReportString +=
+                '\n\n\n\n' +
+                    spaceTrim(function (block) { return "\n\n                        ### Prompt\n\n                        ```\n                        ".concat(block(escapeMarkdownBlock(promptExecution.prompt.content)), "\n                        ```\n\n                    "); });
+        }
+        if (promptExecution.result && promptExecution.result.content) {
+            executionReportString +=
+                '\n\n\n\n' +
+                    spaceTrim(function (block) { return "\n\n                        ### Result\n\n                        ```\n                        ".concat(block(escapeMarkdownBlock(promptExecution.result.content)), "\n                        ```\n                    "); });
+        }
+        if (promptExecution.error && promptExecution.error.message) {
+            executionReportString +=
+                '\n\n\n\n' +
+                    spaceTrim(function (block) { return "\n\n                        ### Error\n\n                        ```\n                        ".concat(block(escapeMarkdownBlock(promptExecution.error.message)), "\n                        ```\n\n                    "); });
+        }
+    };
+    try {
+        for (var _j = __values(executionReportJson.promptExecutions), _k = _j.next(); !_k.done; _k = _j.next()) {
+            var promptExecution = _k.value;
+            _loop_1(promptExecution);
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (_k && !_k.done && (_a = _j.return)) _a.call(_j);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    executionReportString = prettifyMarkdown(executionReportString);
+    return executionReportString;
+}
+/**
+ * TODO: Add mermaid chart for every report
+ * TODO: [🧠] Allow to filter out some parts of the report by options
+ */
+
 /**
  * Function isValidJsonString will tell you if the string is valid JSON or not
  */
@@ -2439,5 +2514,5 @@ var normalizeTo = {
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
  */
 
-export { CountUtils, DIACRITIC_VARIANTS_LETTERS, ExecutionReportStringOptionsDefaults, assertsExecutionSuccessful, capitalize, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, decapitalize, executionReportJsonToString, extractAllBlocksFromMarkdown, extractAllListItemsFromMarkdown, extractBlock, extractOneBlockFromMarkdown, isValidJsonString, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo, normalizeToKebabCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_camelCase, normalizeTo_snake_case, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, parseNumber, prettifyPromptbookString, removeContentComments, removeDiacritics, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, searchKeywords, splitIntoSentences, trimCodeBlock, trimEndOfCodeBlock, unwrapResult };
+export { CountUtils, DIACRITIC_VARIANTS_LETTERS, ExecutionReportStringOptionsDefaults, assertsExecutionSuccessful, capitalize, checkExpectations, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, decapitalize, executionReportJsonToString, extractAllBlocksFromMarkdown, extractAllListItemsFromMarkdown, extractBlock, extractOneBlockFromMarkdown, isPassingExpectations, isValidJsonString, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo, normalizeToKebabCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_camelCase, normalizeTo_snake_case, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, parseNumber, prettifyPromptbookString, removeContentComments, removeDiacritics, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, searchKeywords, splitIntoSentences, trimCodeBlock, trimEndOfCodeBlock, unwrapResult };
 //# sourceMappingURL=index.es.js.map