@promptbook/core 0.36.3 → 0.37.0

package/umd/index.umd.js

@@ -430,7 +430,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.36.2';
+    var PROMPTBOOK_VERSION = '0.36.4';
 
     /**
      * Execution type describes the way how the block is executed
@@ -643,12 +643,14 @@
             if (parameterDescription && parameterDescription.match(/\{(?<parameterName>[a-z0-9_]+)\}/im)) {
                 throw new Error(spaceTrim__default["default"]("\n                        Parameter {".concat(parameterName, "} can not contain another parameter in description:\n\n                        - ").concat(listItem, "\n                    ")));
             }
-            var isInputParameter = type.startsWith('INPUT');
+            var isInput = type.startsWith('INPUT');
+            var isOutput = type.startsWith('OUTPUT');
             return {
                 type: 'PARAMETER',
                 parameterName: parameterName,
                 parameterDescription: parameterDescription.trim() || null,
-                isInputParameter: isInputParameter,
+                isInput: isInput,
+                isOutput: isOutput,
             };
         }
         else if (type.startsWith('JOKER')) {
@@ -780,7 +782,7 @@
         // =============================================================
         ///Note: 2️⃣ Function for adding parameters
         var addParam = function (parameterCommand) {
-            var parameterName = parameterCommand.parameterName, parameterDescription = parameterCommand.parameterDescription, isInputParameter = parameterCommand.isInputParameter;
+            var parameterName = parameterCommand.parameterName, parameterDescription = parameterCommand.parameterDescription, isInput = parameterCommand.isInput, isOutput = parameterCommand.isOutput;
             var existingParameter = promptbookJson.parameters.find(function (parameter) { return parameter.name === parameterName; });
             if (existingParameter &&
                 existingParameter.description &&
@@ -797,7 +799,8 @@
                 promptbookJson.parameters.push({
                     name: parameterName,
                     description: parameterDescription || undefined,
-                    isInput: isInputParameter,
+                    isInput: isInput,
+                    isOutput: isOutput,
                 });
             }
         };
@@ -1044,7 +1047,7 @@
      * @throws {Error} if invalid
      */
     function validatePromptbookJson(promptbook) {
-        var e_1, _a, e_2, _b, e_3, _c;
+        var e_1, _a, e_2, _b, e_3, _c, e_4, _d;
         var definedParameters = new Set(promptbook.parameters.filter(function (_a) {
             var isInput = _a.isInput;
             return isInput;
@@ -1052,10 +1055,40 @@
             var name = _a.name;
             return name;
         }));
+        var _loop_1 = function (parameter) {
+            if (parameter.isInput && parameter.isOutput) {
+                throw new Error("Parameter {".concat(parameter.name, "} can not be both input and output"));
+            }
+            // Note: Testing that parameter is either intermediate or output BUT not created and unused
+            if (!parameter.isInput &&
+                !parameter.isOutput &&
+                !promptbook.promptTemplates.some(function (template) { return template.dependentParameterNames.includes(parameter.name); })) {
+                throw new Error(spaceTrim__default["default"]("\n                    Parameter {".concat(parameter.name, "} is created but not used\n\n                    You can declare {").concat(parameter.name, "} as output parameter by adding in the header:\n                    - OUTPUT PARAMETER `{").concat(parameter.name, "}` ").concat(parameter.description || '', "\n\n                ")));
+            }
+            // Note: Testing that parameter is either input or result of some template
+            if (!parameter.isInput &&
+                !promptbook.promptTemplates.some(function (template) { return template.resultingParameterName === parameter.name; })) {
+                throw new Error(spaceTrim__default["default"]("\n                    Parameter {".concat(parameter.name, "} is declared but not defined\n\n                    You can do one of these:\n                    - Remove declaration of {").concat(parameter.name, "}\n                    - Add prompt template that results in -> {").concat(parameter.name, "}\n\n                ")));
+            }
+        };
+        try {
+            // Note: Check each parameter individually
+            for (var _e = __values(promptbook.parameters), _f = _e.next(); !_f.done; _f = _e.next()) {
+                var parameter = _f.value;
+                _loop_1(parameter);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_f && !_f.done && (_a = _e.return)) _a.call(_e);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
         try {
             // Note: Check each template individually
-            for (var _d = __values(promptbook.promptTemplates), _e = _d.next(); !_e.done; _e = _d.next()) {
-                var template = _e.value;
+            for (var _g = __values(promptbook.promptTemplates), _h = _g.next(); !_h.done; _h = _g.next()) {
+                var template = _h.value;
                 if (definedParameters.has(template.resultingParameterName)) {
                     throw new Error("Parameter {".concat(template.resultingParameterName, "} is defined multiple times"));
                 }
@@ -1070,25 +1103,25 @@
                         throw new Error("Joker parameters are used but no expectations are defined");
                     }
                     try {
-                        for (var _f = (e_2 = void 0, __values(template.jokers)), _g = _f.next(); !_g.done; _g = _f.next()) {
-                            var joker = _g.value;
+                        for (var _j = (e_3 = void 0, __values(template.jokers)), _k = _j.next(); !_k.done; _k = _j.next()) {
+                            var joker = _k.value;
                             if (!template.dependentParameterNames.includes(joker)) {
                                 throw new Error("Parameter {".concat(joker, "} is used as joker but not in dependentParameterNames"));
                             }
                         }
                     }
-                    catch (e_2_1) { e_2 = { error: e_2_1 }; }
+                    catch (e_3_1) { e_3 = { error: e_3_1 }; }
                     finally {
                         try {
-                            if (_g && !_g.done && (_b = _f.return)) _b.call(_f);
+                            if (_k && !_k.done && (_c = _j.return)) _c.call(_j);
                         }
-                        finally { if (e_2) throw e_2.error; }
+                        finally { if (e_3) throw e_3.error; }
                     }
                 }
                 if (template.expectAmount) {
                     try {
-                        for (var _h = (e_3 = void 0, __values(Object.entries(template.expectAmount))), _j = _h.next(); !_j.done; _j = _h.next()) {
-                            var _k = __read(_j.value, 2), unit = _k[0], _l = _k[1], min = _l.min, max = _l.max;
+                        for (var _l = (e_4 = void 0, __values(Object.entries(template.expectAmount))), _m = _l.next(); !_m.done; _m = _l.next()) {
+                            var _o = __read(_m.value, 2), unit = _o[0], _p = _o[1], min = _p.min, max = _p.max;
                             if (min !== undefined && max !== undefined && min > max) {
                                 throw new Error("Min expectation (=".concat(min, ") of ").concat(unit, " is higher than max expectation (=").concat(max, ")"));
                             }
@@ -1100,23 +1133,23 @@
                             }
                         }
                     }
-                    catch (e_3_1) { e_3 = { error: e_3_1 }; }
+                    catch (e_4_1) { e_4 = { error: e_4_1 }; }
                     finally {
                         try {
-                            if (_j && !_j.done && (_c = _h.return)) _c.call(_h);
+                            if (_m && !_m.done && (_d = _l.return)) _d.call(_l);
                         }
-                        finally { if (e_3) throw e_3.error; }
+                        finally { if (e_4) throw e_4.error; }
                     }
                 }
                 definedParameters.add(template.resultingParameterName);
             }
         }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        catch (e_2_1) { e_2 = { error: e_2_1 }; }
         finally {
             try {
-                if (_e && !_e.done && (_a = _d.return)) _a.call(_d);
+                if (_h && !_h.done && (_b = _g.return)) _b.call(_g);
             }
-            finally { if (e_1) throw e_1.error; }
+            finally { if (e_2) throw e_2.error; }
         }
         // Note: Detect circular dependencies
         var resovedParameters = promptbook.parameters
@@ -1129,7 +1162,7 @@
             return name;
         });
         var unresovedTemplates = __spreadArray([], __read(promptbook.promptTemplates), false);
-        var _loop_1 = function () {
+        var _loop_2 = function () {
             var currentlyResovedTemplates = unresovedTemplates.filter(function (template) {
                 return template.dependentParameterNames.every(function (name) { return resovedParameters.includes(name); });
             });
@@ -1150,7 +1183,7 @@
             unresovedTemplates = unresovedTemplates.filter(function (template) { return !currentlyResovedTemplates.includes(template); });
         };
         while (unresovedTemplates.length > 0) {
-            _loop_1();
+            _loop_2();
         }
     }
     /**
@@ -1331,15 +1364,15 @@
         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_1_1, _e, _f, functionName, postprocessingError, _g, _h, scriptTools, error_3, e_2_1, e_3_1, _j, _k, _l, unit, _m, max, min, amount, error_4;
-                    var e_1, _o, e_3, _p, e_2, _q, e_4, _r, _s;
+                    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) {
                             case 0:
                                 name = "promptbook-executor-frame-".concat(currentTemplate.name);
                                 title = currentTemplate.title;
                                 priority = promptbook.promptTemplates.length - promptbook.promptTemplates.indexOf(currentTemplate);
-                                if (!onProgress) return [3 /*break*/, 2];
+                                if (!onProgress /* <- [3] */) return [3 /*break*/, 2]; /* <- [3] */
                                 return [4 /*yield*/, onProgress({
                                         name: name,
                                         title: title,
@@ -1348,6 +1381,7 @@
                                         executionType: currentTemplate.executionType,
                                         parameterName: currentTemplate.resultingParameterName,
                                         parameterValue: null,
+                                        // <- [3]
                                     })];
                             case 1:
                                 _t.sent();
@@ -1435,7 +1469,7 @@
                                 _t.label = 14;
                             case 14:
                                 _t.trys.push([14, 21, 22, 23]);
-                                _c = (e_1 = void 0, __values(tools.script)), _d = _c.next();
+                                _c = (e_2 = void 0, __values(tools.script)), _d = _c.next();
                                 _t.label = 15;
                             case 15:
                                 if (!!_d.done) return [3 /*break*/, 20];
@@ -1463,14 +1497,14 @@
                                 return [3 /*break*/, 15];
                             case 20: return [3 /*break*/, 23];
                             case 21:
-                                e_1_1 = _t.sent();
-                                e_1 = { error: e_1_1 };
+                                e_2_1 = _t.sent();
+                                e_2 = { error: e_2_1 };
                                 return [3 /*break*/, 23];
                             case 22:
                                 try {
                                     if (_d && !_d.done && (_o = _c.return)) _o.call(_c);
                                 }
-                                finally { if (e_1) throw e_1.error; }
+                                finally { if (e_2) throw e_2.error; }
                                 return [7 /*endfinally*/];
                             case 23:
                                 if (resultString) {
@@ -1504,7 +1538,7 @@
                                 _t.label = 28;
                             case 28:
                                 _t.trys.push([28, 42, 43, 44]);
-                                _e = (e_3 = void 0, __values(currentTemplate.postprocessing)), _f = _e.next();
+                                _e = (e_4 = void 0, __values(currentTemplate.postprocessing)), _f = _e.next();
                                 _t.label = 29;
                             case 29:
                                 if (!!_f.done) return [3 /*break*/, 41];
@@ -1515,7 +1549,7 @@
                                 _t.label = 30;
                             case 30:
                                 _t.trys.push([30, 37, 38, 39]);
-                                _g = (e_2 = void 0, __values(tools.script)), _h = _g.next();
+                                _g = (e_3 = void 0, __values(tools.script)), _h = _g.next();
                                 _t.label = 31;
                             case 31:
                                 if (!!_h.done) return [3 /*break*/, 36];
@@ -1545,14 +1579,14 @@
                                 return [3 /*break*/, 31];
                             case 36: return [3 /*break*/, 39];
                             case 37:
-                                e_2_1 = _t.sent();
-                                e_2 = { error: e_2_1 };
+                                e_3_1 = _t.sent();
+                                e_3 = { error: e_3_1 };
                                 return [3 /*break*/, 39];
                             case 38:
                                 try {
                                     if (_h && !_h.done && (_q = _g.return)) _q.call(_g);
                                 }
-                                finally { if (e_2) throw e_2.error; }
+                                finally { if (e_3) throw e_3.error; }
                                 return [7 /*endfinally*/];
                             case 39:
                                 if (postprocessingError) {
@@ -1564,14 +1598,14 @@
                                 return [3 /*break*/, 29];
                             case 41: return [3 /*break*/, 44];
                             case 42:
-                                e_3_1 = _t.sent();
-                                e_3 = { error: e_3_1 };
+                                e_4_1 = _t.sent();
+                                e_4 = { error: e_4_1 };
                                 return [3 /*break*/, 44];
                             case 43:
                                 try {
                                     if (_f && !_f.done && (_p = _e.return)) _p.call(_e);
                                 }
-                                finally { if (e_3) throw e_3.error; }
+                                finally { if (e_4) throw e_4.error; }
                                 return [7 /*endfinally*/];
                             case 44:
                                 if (currentTemplate.expectFormat) {
@@ -1583,7 +1617,7 @@
                                 }
                                 if (currentTemplate.expectAmount) {
                                     try {
-                                        for (_j = (e_4 = void 0, __values(Object.entries(currentTemplate.expectAmount))), _k = _j.next(); !_k.done; _k = _j.next()) {
+                                        for (_j = (e_5 = void 0, __values(Object.entries(currentTemplate.expectAmount))), _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) {
@@ -1594,12 +1628,12 @@
                                             }
                                         }
                                     }
-                                    catch (e_4_1) { e_4 = { error: e_4_1 }; }
+                                    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_4) throw e_4.error; }
+                                        finally { if (e_5) throw e_5.error; }
                                     }
                                 }
                                 return [3 /*break*/, 49];
@@ -1643,7 +1677,7 @@
                                     //              <- TODO: [🥨] Make some NeverShouldHappenError
                                     throw new Error('Something went wrong and prompt result is null');
                                 }
-                                if (onProgress) {
+                                if (onProgress /* <- [3] */) {
                                     onProgress({
                                         name: name,
                                         title: title,
@@ -1652,6 +1686,7 @@
                                         executionType: currentTemplate.executionType,
                                         parameterName: currentTemplate.resultingParameterName,
                                         parameterValue: resultString,
+                                        // <- [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));
@@ -1660,9 +1695,10 @@
                     });
                 });
             }
-            var parametersToPass, executionReport, resovedParameters_1, unresovedTemplates, resolving_1, _loop_1, error_1;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var parametersToPass, executionReport, resovedParameters_1, unresovedTemplates, resolving_1, _loop_1, error_1, _a, _b, parameter;
+            var e_1, _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
                     case 0:
                         parametersToPass = inputParameters;
                         executionReport = {
@@ -1673,9 +1709,9 @@
                             description: promptbook.description,
                             promptExecutions: [],
                         };
-                        _a.label = 1;
+                        _d.label = 1;
                     case 1:
-                        _a.trys.push([1, 6, , 7]);
+                        _d.trys.push([1, 6, , 7]);
                         resovedParameters_1 = promptbook.parameters
                             .filter(function (_a) {
                             var isInput = _a.isInput;
@@ -1689,8 +1725,8 @@
                         resolving_1 = [];
                         _loop_1 = function () {
                             var currentTemplate, work_1;
-                            return __generator(this, function (_b) {
-                                switch (_b.label) {
+                            return __generator(this, function (_e) {
+                                switch (_e.label) {
                                     case 0:
                                         currentTemplate = unresovedTemplates.find(function (template) {
                                             return template.dependentParameterNames.every(function (name) { return resovedParameters_1.includes(name); });
@@ -1701,7 +1737,7 @@
                                         if (!!currentTemplate) return [3 /*break*/, 3];
                                         /* [5] */ return [4 /*yield*/, Promise.race(resolving_1)];
                                     case 2:
-                                        /* [5] */ _b.sent();
+                                        /* [5] */ _e.sent();
                                         return [3 /*break*/, 4];
                                     case 3:
                                         unresovedTemplates = unresovedTemplates.filter(function (template) { return template !== currentTemplate; });
@@ -1713,24 +1749,24 @@
                                             resolving_1 = resolving_1.filter(function (w) { return w !== work_1; });
                                         });
                                         resolving_1.push(work_1);
-                                        _b.label = 4;
+                                        _e.label = 4;
                                     case 4: return [2 /*return*/];
                                 }
                             });
                         };
-                        _a.label = 2;
+                        _d.label = 2;
                     case 2:
                         if (!(unresovedTemplates.length > 0)) return [3 /*break*/, 4];
                         return [5 /*yield**/, _loop_1()];
                     case 3:
-                        _a.sent();
+                        _d.sent();
                         return [3 /*break*/, 2];
                     case 4: return [4 /*yield*/, Promise.all(resolving_1)];
                     case 5:
-                        _a.sent();
+                        _d.sent();
                         return [3 /*break*/, 7];
                     case 6:
-                        error_1 = _a.sent();
+                        error_1 = _d.sent();
                         if (!(error_1 instanceof Error)) {
                             throw error_1;
                         }
@@ -1740,12 +1776,30 @@
                                 executionReport: executionReport,
                                 outputParameters: parametersToPass,
                             }];
-                    case 7: return [2 /*return*/, {
-                            isSuccessful: true,
-                            errors: [],
-                            executionReport: executionReport,
-                            outputParameters: parametersToPass,
-                        }];
+                    case 7:
+                        try {
+                            // Note: Filter ONLY output parameters
+                            for (_a = __values(promptbook.parameters), _b = _a.next(); !_b.done; _b = _a.next()) {
+                                parameter = _b.value;
+                                if (parameter.isOutput) {
+                                    continue;
+                                }
+                                delete parametersToPass[parameter.name];
+                            }
+                        }
+                        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                        finally {
+                            try {
+                                if (_b && !_b.done && (_c = _a.return)) _c.call(_a);
+                            }
+                            finally { if (e_1) throw e_1.error; }
+                        }
+                        return [2 /*return*/, {
+                                isSuccessful: true,
+                                errors: [],
+                                executionReport: executionReport,
+                                outputParameters: parametersToPass,
+                            }];
                 }
             });
         }); };
@@ -1755,6 +1809,7 @@
      * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
      * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
      * Note: CreatePromptbookExecutorOptions are just connected to PromptbookExecutor so do not extract to types folder
+     * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
      */
 
     /**
@@ -1769,7 +1824,7 @@
     var PromptbookLibrary = /** @class */ (function () {
         function PromptbookLibrary(options) {
             this.options = options;
-            //                       <- Note: Options can not be private
+            //                       <- Note: Options can not be private or protected because of the following error:
             //                              > Type 'import("node_modules/@promptbook/core/esm/typings/classes/PromptbookLibrary").PromptbookLibrary' is not assignable
             //                              > to type 'import("node_modules/@promptbook/remote-server/esm/typings/classes/PromptbookLibrary").PromptbookLibrary'.
             //                              > Types have separate declarations of a private property 'options'.ts(2322)