@promptbook/core 0.44.0-4 → 0.44.0-5

package/esm/index.es.js

@@ -243,86 +243,22 @@ var PromptbookExecutionError = /** @class */ (function (_super) {
 }(Error));
 
 /**
- * The maximum number of iterations for a loops
- */
-var LOOP_LIMIT = 1000;
-
-/**
- * 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;
-}
-
 /**
  * Counts number of characters in the text
  */
@@ -650,6 +586,144 @@ 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
+ */
+
+/**
+ * The maximum number of iterations for a loops
+ */
+var LOOP_LIMIT = 1000;
+
+/**
+ * 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;
+}
+
 /**
  * Function isValidJsonString will tell you if the string is valid JSON or not
  */
@@ -1083,7 +1157,7 @@ function parsingMarkdownStructureToMarkdownStructure(parsingMarkdownStructure) {
 /**
  * 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
@@ -1151,6 +1225,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
  */
 
@@ -1891,23 +1966,6 @@ function validatePromptbookJson(promptbook) {
  *     >  ex port function validatePromptbookJson(promptbook: unknown): asserts promptbook is PromptbookJson {
  */
 
-/**
- * This error occurs when some expectation is not met in the execution of the pipeline
- *
- * @private Always catched and rethrown as `PromptbookExecutionError`
- * Note: This is a kindof subtype of PromptbookExecutionError
- */
-var ExpectError = /** @class */ (function (_super) {
-    __extends(ExpectError, _super);
-    function ExpectError(message) {
-        var _this = _super.call(this, message) || this;
-        _this.name = 'ExpectError';
-        Object.setPrototypeOf(_this, ExpectError.prototype);
-        return _this;
-    }
-    return ExpectError;
-}(Error));
-
 /**
  * Creates executor function from promptbook and execution tools.
  *
@@ -1922,10 +1980,10 @@ function createPromptbookExecutor(options) {
     var promptbookExecutor = function (inputParameters, onProgress) { return __awaiter(_this, void 0, void 0, function () {
         function executeSingleTemplate(currentTemplate) {
             return __awaiter(this, void 0, void 0, function () {
-                var name, title, priority, prompt, chatThread, completionResult, result, resultString, expectError, scriptExecutionErrors, maxAttempts, jokers, attempt, isJokerAttempt, joker, _a, _b, _c, _d, scriptTools, error_2, e_2_1, _e, _f, functionName, postprocessingError, _g, _h, scriptTools, error_3, e_3_1, e_4_1, _j, _k, _l, unit, _m, max, min, amount, error_4;
-                var e_2, _o, e_4, _p, e_3, _q, e_5, _r, _s;
-                return __generator(this, function (_t) {
-                    switch (_t.label) {
+                var name, title, priority, prompt, chatThread, completionResult, result, resultString, expectError, scriptExecutionErrors, maxAttempts, jokers, attempt, isJokerAttempt, joker, _a, _b, _c, _d, scriptTools, error_2, e_2_1, _e, _f, functionName, postprocessingError, _g, _h, scriptTools, error_3, e_3_1, e_4_1, error_4;
+                var e_2, _j, e_4, _k, e_3, _l, _m;
+                return __generator(this, function (_o) {
+                    switch (_o.label) {
                         case 0:
                             name = "promptbook-executor-frame-".concat(currentTemplate.name);
                             title = currentTemplate.title;
@@ -1942,8 +2000,8 @@ function createPromptbookExecutor(options) {
                                     // <- [3]
                                 })];
                         case 1:
-                            _t.sent();
-                            _t.label = 2;
+                            _o.sent();
+                            _o.label = 2;
                         case 2:
                             result = null;
                             resultString = null;
@@ -1951,7 +2009,7 @@ function createPromptbookExecutor(options) {
                             maxAttempts = currentTemplate.executionType === 'PROMPT_DIALOG' ? Infinity : maxExecutionAttempts;
                             jokers = currentTemplate.jokers || [];
                             attempt = -jokers.length;
-                            _t.label = 3;
+                            _o.label = 3;
                         case 3:
                             if (!(attempt < maxAttempts)) return [3 /*break*/, 49];
                             isJokerAttempt = attempt < 0;
@@ -1968,9 +2026,9 @@ function createPromptbookExecutor(options) {
                                 }
                                 resultString = parametersToPass[joker];
                             }
-                            _t.label = 4;
+                            _o.label = 4;
                         case 4:
-                            _t.trys.push([4, 45, 46, 47]);
+                            _o.trys.push([4, 45, 46, 47]);
                             if (!!isJokerAttempt) return [3 /*break*/, 27];
                             _a = currentTemplate.executionType;
                             switch (_a) {
@@ -2002,14 +2060,14 @@ function createPromptbookExecutor(options) {
                             return [3 /*break*/, 11];
                         case 7: return [4 /*yield*/, tools.natural.gptChat(prompt)];
                         case 8:
-                            chatThread = _t.sent();
+                            chatThread = _o.sent();
                             // TODO: [🍬] Destroy chatThread
                             result = chatThread;
                             resultString = chatThread.content;
                             return [3 /*break*/, 12];
                         case 9: return [4 /*yield*/, tools.natural.gptComplete(prompt)];
                         case 10:
-                            completionResult = _t.sent();
+                            completionResult = _o.sent();
                             result = completionResult;
                             resultString = completionResult.content;
                             return [3 /*break*/, 12];
@@ -2024,27 +2082,27 @@ function createPromptbookExecutor(options) {
                             }
                             // TODO: DRY [1]
                             scriptExecutionErrors = [];
-                            _t.label = 14;
+                            _o.label = 14;
                         case 14:
-                            _t.trys.push([14, 21, 22, 23]);
+                            _o.trys.push([14, 21, 22, 23]);
                             _c = (e_2 = void 0, __values(tools.script)), _d = _c.next();
-                            _t.label = 15;
+                            _o.label = 15;
                         case 15:
                             if (!!_d.done) return [3 /*break*/, 20];
                             scriptTools = _d.value;
-                            _t.label = 16;
+                            _o.label = 16;
                         case 16:
-                            _t.trys.push([16, 18, , 19]);
+                            _o.trys.push([16, 18, , 19]);
                             return [4 /*yield*/, scriptTools.execute({
                                     scriptLanguage: currentTemplate.contentLanguage,
                                     script: currentTemplate.content,
                                     parameters: parametersToPass,
                                 })];
                         case 17:
-                            resultString = _t.sent();
+                            resultString = _o.sent();
                             return [3 /*break*/, 20];
                         case 18:
-                            error_2 = _t.sent();
+                            error_2 = _o.sent();
                             if (!(error_2 instanceof Error)) {
                                 throw error_2;
                             }
@@ -2055,12 +2113,12 @@ function createPromptbookExecutor(options) {
                             return [3 /*break*/, 15];
                         case 20: return [3 /*break*/, 23];
                         case 21:
-                            e_2_1 = _t.sent();
+                            e_2_1 = _o.sent();
                             e_2 = { error: e_2_1 };
                             return [3 /*break*/, 23];
                         case 22:
                             try {
-                                if (_d && !_d.done && (_o = _c.return)) _o.call(_c);
+                                if (_d && !_d.done && (_j = _c.return)) _j.call(_c);
                             }
                             finally { if (e_2) throw e_2.error; }
                             return [7 /*endfinally*/];
@@ -2086,46 +2144,46 @@ function createPromptbookExecutor(options) {
                             })];
                         case 25:
                             // TODO: [🌹] When making next attempt for `PROMPT DIALOG`, preserve the previous user input
-                            resultString = _t.sent();
+                            resultString = _o.sent();
                             return [3 /*break*/, 27];
                         case 26: throw new PromptbookExecutionError(
                         // eslint-disable-next-line @typescript-eslint/no-explicit-any
                         "Unknown execution type \"".concat(currentTemplate.executionType, "\""));
                         case 27:
                             if (!(!isJokerAttempt && currentTemplate.postprocessing)) return [3 /*break*/, 44];
-                            _t.label = 28;
+                            _o.label = 28;
                         case 28:
-                            _t.trys.push([28, 42, 43, 44]);
+                            _o.trys.push([28, 42, 43, 44]);
                             _e = (e_4 = void 0, __values(currentTemplate.postprocessing)), _f = _e.next();
-                            _t.label = 29;
+                            _o.label = 29;
                         case 29:
                             if (!!_f.done) return [3 /*break*/, 41];
                             functionName = _f.value;
                             // TODO: DRY [1]
                             scriptExecutionErrors = [];
                             postprocessingError = null;
-                            _t.label = 30;
+                            _o.label = 30;
                         case 30:
-                            _t.trys.push([30, 37, 38, 39]);
+                            _o.trys.push([30, 37, 38, 39]);
                             _g = (e_3 = void 0, __values(tools.script)), _h = _g.next();
-                            _t.label = 31;
+                            _o.label = 31;
                         case 31:
                             if (!!_h.done) return [3 /*break*/, 36];
                             scriptTools = _h.value;
-                            _t.label = 32;
+                            _o.label = 32;
                         case 32:
-                            _t.trys.push([32, 34, , 35]);
+                            _o.trys.push([32, 34, , 35]);
                             return [4 /*yield*/, scriptTools.execute({
                                     scriptLanguage: "javascript" /* <- TODO: Try it in each languages; In future allow postprocessing with arbitrary combination of languages to combine */,
                                     script: "".concat(functionName, "(resultString)"),
                                     parameters: __assign(__assign({}, parametersToPass), { resultString: resultString || '' }),
                                 })];
                         case 33:
-                            resultString = _t.sent();
+                            resultString = _o.sent();
                             postprocessingError = null;
                             return [3 /*break*/, 36];
                         case 34:
-                            error_3 = _t.sent();
+                            error_3 = _o.sent();
                             if (!(error_3 instanceof Error)) {
                                 throw error_3;
                             }
@@ -2137,12 +2195,12 @@ function createPromptbookExecutor(options) {
                             return [3 /*break*/, 31];
                         case 36: return [3 /*break*/, 39];
                         case 37:
-                            e_3_1 = _t.sent();
+                            e_3_1 = _o.sent();
                             e_3 = { error: e_3_1 };
                             return [3 /*break*/, 39];
                         case 38:
                             try {
-                                if (_h && !_h.done && (_q = _g.return)) _q.call(_g);
+                                if (_h && !_h.done && (_l = _g.return)) _l.call(_g);
                             }
                             finally { if (e_3) throw e_3.error; }
                             return [7 /*endfinally*/];
@@ -2150,22 +2208,23 @@ function createPromptbookExecutor(options) {
                             if (postprocessingError) {
                                 throw postprocessingError;
                             }
-                            _t.label = 40;
+                            _o.label = 40;
                         case 40:
                             _f = _e.next();
                             return [3 /*break*/, 29];
                         case 41: return [3 /*break*/, 44];
                         case 42:
-                            e_4_1 = _t.sent();
+                            e_4_1 = _o.sent();
                             e_4 = { error: e_4_1 };
                             return [3 /*break*/, 44];
                         case 43:
                             try {
-                                if (_f && !_f.done && (_p = _e.return)) _p.call(_e);
+                                if (_f && !_f.done && (_k = _e.return)) _k.call(_e);
                             }
                             finally { if (e_4) throw e_4.error; }
                             return [7 /*endfinally*/];
                         case 44:
+                            // TODO: [💝] Unite object for expecting amount and format
                             if (currentTemplate.expectFormat) {
                                 if (currentTemplate.expectFormat === 'JSON') {
                                     if (!isValidJsonString(resultString || '')) {
@@ -2173,30 +2232,13 @@ function createPromptbookExecutor(options) {
                                     }
                                 }
                             }
+                            // TODO: [💝] Unite object for expecting amount and format
                             if (currentTemplate.expectations) {
-                                try {
-                                    for (_j = (e_5 = void 0, __values(Object.entries(currentTemplate.expectations))), _k = _j.next(); !_k.done; _k = _j.next()) {
-                                        _l = __read(_k.value, 2), unit = _l[0], _m = _l[1], max = _m.max, min = _m.min;
-                                        amount = CountUtils[unit.toUpperCase()](resultString || '');
-                                        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_5_1) { e_5 = { error: e_5_1 }; }
-                                finally {
-                                    try {
-                                        if (_k && !_k.done && (_r = _j.return)) _r.call(_j);
-                                    }
-                                    finally { if (e_5) throw e_5.error; }
-                                }
+                                checkExpectations(currentTemplate.expectations, resultString || '');
                             }
                             return [3 /*break*/, 49];
                         case 45:
-                            error_4 = _t.sent();
+                            error_4 = _o.sent();
                             if (!(error_4 instanceof ExpectError)) {
                                 throw error_4;
                             }
@@ -2227,7 +2269,7 @@ function createPromptbookExecutor(options) {
                             if (expectError !== null && attempt === maxAttempts - 1) {
                                 throw new PromptbookExecutionError(spaceTrim(function (block) { return "\n                              Natural execution failed ".concat(maxExecutionAttempts, "x\n\n                              ").concat(block((expectError === null || expectError === void 0 ? void 0 : expectError.message) || ''), "\n                          "); }));
                             }
-                            _t.label = 48;
+                            _o.label = 48;
                         case 48:
                             attempt++;
                             return [3 /*break*/, 3];
@@ -2247,7 +2289,7 @@ function createPromptbookExecutor(options) {
                                     // <- [3]
                                 });
                             }
-                            parametersToPass = __assign(__assign({}, parametersToPass), (_s = {}, _s[currentTemplate.resultingParameterName] = resultString /* <- Note: Not need to detect parameter collision here because Promptbook checks logic consistency during construction */, _s));
+                            parametersToPass = __assign(__assign({}, parametersToPass), (_m = {}, _m[currentTemplate.resultingParameterName] = resultString /* <- Note: Not need to detect parameter collision here because Promptbook checks logic consistency during construction */, _m));
                             return [2 /*return*/];
                     }
                 });
@@ -2460,19 +2502,26 @@ var MockedEchoNaturalExecutionTools = /** @class */ (function () {
  * @private internal util for MockedFackedNaturalExecutionTools
  */
 function $fakeTextToExpectations(expectations) {
-    var lorem = new LoremIpsum({
-        sentencesPerParagraph: {
-            max: 8,
-            min: 4,
-        },
-        wordsPerSentence: {
-            max: 16,
-            min: 4,
-        },
-    });
-    // TODO: !!! Really use the expectations to generate the text
-    return lorem.generateSentences(5);
+    var lorem = new LoremIpsum({});
+    var loremText = '';
+    var text = '';
+    for (var loopLimit = LOOP_LIMIT; loopLimit-- > 0;) {
+        if (isPassingExpectations(expectations, text)) {
+            return text;
+        }
+        if (loremText === '') {
+            loremText = lorem.generateParagraphs(2);
+        }
+        text += loremText.substring(0, 1);
+        loremText = loremText.substring(1);
+        console.log(text);
+    }
+    throw new Error('Can not generate fake text to met the expectations; Loop limit reached');
 }
+/**
+ * TODO: Implement better
+ * TODO: [💝] Unite object for expecting amount and format - use here also a format
+ */
 
 /**
  * Mocked execution Tools for just faking expected responses for testing purposes