@promptbook/core 0.28.0-7 → 0.28.0

package/esm/typings/execution/UserInterfaceTools.d.ts

@@ -1,3 +1,4 @@
+import { number_integer, number_positive } from '../types/typeAliases';
 /**
  * Represents all the tools needed to interact with the user.
  *
@@ -13,12 +14,20 @@ export interface UserInterfaceTools {
     promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
 }
 export interface UserInterfaceToolsPromptDialogOptions {
+    /**
+     * Prompt title
+     *
+     * Note: This is not a prompt to language model but a prompt to the user
+     * @example "Your name"
+     */
+    promptTitle: string;
     /**
      * Prompt message
      *
      * Note: This is not a prompt to language model but a prompt to the user
+     * @example "Please enter your name, including your last name, title, etc."
      */
-    prompt: string;
+    promptMessage: string;
     /**
      * Default value for the input/textarea
      */
@@ -27,4 +36,10 @@ export interface UserInterfaceToolsPromptDialogOptions {
      * Placeholder for the input/textarea
      */
     placeholder?: string;
+    /**
+     * Priority of the prompt
+     *
+     * Note: This would be reflected for example into the UI z-index of the prompt modal
+     */
+    priority: number_integer & number_positive;
 }

package/esm/typings/execution/plugins/natural-execution-tools/mocked/joker.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPtpExecutor.test.ts"
+ */

package/esm/typings/types/Command.d.ts

@@ -6,7 +6,7 @@ import type { ExpectationAmount, ExpectationUnit } from './PromptTemplatePipelin
  * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
  * It is parsed from the markdown from ul/ol items - one command per one item.
  */
-export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
+export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
 /**
  * PtpVersion command tells which version is .ptp file using
  *
@@ -43,6 +43,13 @@ export interface ModelCommand {
     readonly key: keyof ModelRequirements;
     readonly value: any;
 }
+/**
+ * Joker parameter is used instead of executing the prompt template if it meet the expectations requirements
+ */
+export interface JokerCommand {
+    readonly type: 'JOKER';
+    readonly parameterName: string_name;
+}
 /**
  * Parameter command describes one parameter of the prompt template
  *

package/esm/typings/types/PromptTemplatePipelineJson/PromptTemplateJson.d.ts

@@ -75,6 +75,10 @@ interface PromptTemplateJsonCommon {
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
     readonly description?: string;
+    /**
+     * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
+     */
+    readonly jokers?: Array<string>;
     /**
      * Type of the execution
      * This determines if the prompt template is send to LLM, user or some scripting evaluation

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

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [💥] Some system to automatically generate tests for all the templates in the folder
- */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.28.0-7",
+    "version": "0.28.0",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -574,6 +574,21 @@
                 isInputParameter: isInputParameter,
             };
         }
+        else if (type.startsWith('JOKER')) {
+            if (listItemParts.length !== 2) {
+                throw new Error(spaceTrim__default["default"]("\n                Invalid JOKER command:\n\n                - ".concat(listItem, "\n            ")));
+            }
+            var parametersMatch = (listItemParts.pop() || '').match(/^\{(?<parameterName>[a-z0-9_]+)\}$/im);
+            if (!parametersMatch || !parametersMatch.groups || !parametersMatch.groups.parameterName) {
+                throw new Error(spaceTrim__default["default"]("\n                      Invalid parameter in command:\n\n                      - ".concat(listItem, "\n                  ")));
+            }
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            var parameterName = parametersMatch.groups.parameterName;
+            return {
+                type: 'JOKER',
+                parameterName: parameterName,
+            };
+        }
         else if (type.startsWith('POSTPROCESS') || type.startsWith('POST_PROCESS')) {
             if (listItemParts.length !== 2) {
                 throw new Error(spaceTrim__default["default"]("\n                Invalid POSTPROCESSING command:\n\n                - ".concat(listItem, "\n            ")));
@@ -765,6 +780,7 @@
             var templateModelRequirements = __assign({}, defaultModelRequirements);
             var listItems_3 = extractAllListItemsFromMarkdown(section.content);
             var executionType = 'PROMPT_TEMPLATE';
+            var jokers = [];
             var postprocessing = [];
             var expectAmount = {};
             var expectFormat = undefined;
@@ -774,6 +790,9 @@
                     var listItem = listItems_2_1.value;
                     var command = parseCommand(listItem);
                     switch (command.type) {
+                        case 'JOKER':
+                            jokers.push(command.parameterName);
+                            break;
                         case 'EXECUTE':
                             if (isExecutionTypeChanged) {
                                 throw new Error('Execution type is already defined in the prompt template. It can be defined only once.');
@@ -856,6 +875,9 @@
             if (description_1 === '') {
                 description_1 = undefined;
             }
+            if (Object.keys(jokers).length === 0) {
+                jokers = undefined;
+            }
             if (Object.keys(expectAmount).length === 0) {
                 expectAmount = undefined;
             }
@@ -867,6 +889,7 @@
                 title: section.title,
                 description: description_1,
                 executionType: executionType,
+                jokers: jokers,
                 postprocessing: postprocessing,
                 expectAmount: expectAmount,
                 expectFormat: expectFormat,
@@ -912,7 +935,7 @@
      * @throws {Error} if invalid
      */
     function validatePromptTemplatePipelineJson(ptp) {
-        var e_1, _a, e_2, _b;
+        var e_1, _a, e_2, _b, e_3, _c, e_4, _d;
         var definedParameters = new Set(ptp.parameters.filter(function (_a) {
             var isInput = _a.isInput;
             return isInput;
@@ -921,11 +944,11 @@
             return name;
         }));
         try {
-            for (var _c = __values(ptp.promptTemplates), _d = _c.next(); !_d.done; _d = _c.next()) {
-                var template = _d.value;
+            for (var _e = __values(ptp.promptTemplates), _f = _e.next(); !_f.done; _f = _e.next()) {
+                var template = _f.value;
                 try {
-                    for (var _e = (e_2 = void 0, __values(Array.from(template.content.matchAll(/\{(?<parameterName>[a-z0-9_]+)\}/gi)))), _f = _e.next(); !_f.done; _f = _e.next()) {
-                        var match = _f.value;
+                    for (var _g = (e_2 = void 0, __values(Array.from(template.content.matchAll(/\{(?<parameterName>[a-z0-9_]+)\}/gi)))), _h = _g.next(); !_h.done; _h = _g.next()) {
+                        var match = _h.value;
                         var parameterName = match.groups.parameterName;
                         if (!definedParameters.has(parameterName)) {
                             throw new Error("Parameter {".concat(parameterName, "} used before defined"));
@@ -935,20 +958,64 @@
                 catch (e_2_1) { e_2 = { error: e_2_1 }; }
                 finally {
                     try {
-                        if (_f && !_f.done && (_b = _e.return)) _b.call(_e);
+                        if (_h && !_h.done && (_b = _g.return)) _b.call(_g);
                     }
                     finally { if (e_2) throw e_2.error; }
                 }
                 if (definedParameters.has(template.resultingParameterName)) {
                     throw new Error("Parameter {".concat(template.resultingParameterName, "} is defined multiple times"));
                 }
+                if (template.jokers && template.jokers.length > 0) {
+                    try {
+                        for (var _j = (e_3 = void 0, __values(template.jokers)), _k = _j.next(); !_k.done; _k = _j.next()) {
+                            var joker = _k.value;
+                            if (!definedParameters.has(joker)) {
+                                throw new Error("Joker parameter {".concat(joker, "} used before defined"));
+                            }
+                        }
+                    }
+                    catch (e_3_1) { e_3 = { error: e_3_1 }; }
+                    finally {
+                        try {
+                            if (_k && !_k.done && (_c = _j.return)) _c.call(_j);
+                        }
+                        finally { if (e_3) throw e_3.error; }
+                    }
+                    if (!template.expectFormat &&
+                        !template.expectAmount /* <- TODO: Require at least 1 -> min <- expectation to use jokers */) {
+                        throw new Error("Joker parameters are used but no expectations are defined");
+                    }
+                }
+                if (template.expectAmount) {
+                    try {
+                        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, ")"));
+                            }
+                            if (min !== undefined && min < 0) {
+                                throw new Error("Min expectation of ".concat(unit, " must be zero or positive"));
+                            }
+                            if (max !== undefined && max <= 0) {
+                                throw new Error("Max expectation of ".concat(unit, " must be positive"));
+                            }
+                        }
+                    }
+                    catch (e_4_1) { e_4 = { error: e_4_1 }; }
+                    finally {
+                        try {
+                            if (_m && !_m.done && (_d = _l.return)) _d.call(_l);
+                        }
+                        finally { if (e_4) throw e_4.error; }
+                    }
+                }
                 definedParameters.add(template.resultingParameterName);
             }
         }
         catch (e_1_1) { e_1 = { error: e_1_1 }; }
         finally {
             try {
-                if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
+                if (_f && !_f.done && (_a = _e.return)) _a.call(_e);
             }
             finally { if (e_1) throw e_1.error; }
         }
@@ -1313,7 +1380,7 @@
         var ptp = options.ptp, tools = options.tools, _a = options.settings, settings = _a === void 0 ? {} : _a;
         var _b = settings.maxExecutionAttempts, maxExecutionAttempts = _b === void 0 ? 3 : _b;
         var ptpExecutor = function (inputParameters, onProgress) { return __awaiter(_this, void 0, void 0, function () {
-            var parametersToPass, currentTemplate, executionReport, _loop_1, error_1;
+            var parametersToPass, currentTemplate, executionReport, priority, _loop_1, error_1;
             var _a;
             return __generator(this, function (_b) {
                 switch (_b.label) {
@@ -1328,15 +1395,17 @@
                             description: ptp.description || undefined,
                             promptExecutions: [],
                         };
+                        priority = ptp.promptTemplates.length;
                         _b.label = 1;
                     case 1:
                         _b.trys.push([1, 5, , 6]);
                         _loop_1 = function () {
-                            var resultingParameter, name_1, title, prompt_1, chatThread, completionResult, result, resultString, expectError, scriptExecutionErrors, maxAttempts, attempt, _c, _d, _e, _f, scriptTools, error_2, e_1_1, _g, _h, functionName, _j, _k, scriptTools, error_3, e_2_1, e_3_1, _l, _m, _o, unit, _p, max, min, amount, error_4;
+                            var resultingParameter, name_1, title, prompt_1, chatThread, completionResult, result, resultString, expectError, scriptExecutionErrors, maxAttempts, jokers, attempt, isJokerAttempt, joker, _c, _d, _e, _f, scriptTools, error_2, e_1_1, _g, _h, functionName, _j, _k, scriptTools, error_3, e_2_1, e_3_1, _l, _m, _o, unit, _p, max, min, amount, error_4;
                             var e_1, _q, e_3, _r, e_2, _s, e_4, _t, _u;
                             return __generator(this, function (_v) {
                                 switch (_v.label) {
                                     case 0:
+                                        priority--;
                                         resultingParameter = ptp.getResultingParameter(currentTemplate.name);
                                         name_1 = "ptp-executor-frame-".concat(currentTemplate.name);
                                         title = removeEmojis(removeMarkdownFormatting(currentTemplate.title));
@@ -1361,16 +1430,30 @@
                                         resultString = null;
                                         expectError = null;
                                         maxAttempts = currentTemplate.executionType === 'PROMPT_DIALOG' ? Infinity : maxExecutionAttempts;
-                                        attempt = 0;
+                                        jokers = currentTemplate.jokers || [];
+                                        attempt = -jokers.length;
                                         _v.label = 3;
                                     case 3:
                                         if (!(attempt < maxAttempts)) return [3 /*break*/, 48];
+                                        isJokerAttempt = attempt < 0;
+                                        joker = jokers[jokers.length + attempt];
+                                        if (isJokerAttempt && !joker) {
+                                            throw new Error("Joker not found in attempt ".concat(attempt));
+                                            //              <- TODO: [🥨] Make some NeverShouldHappenError
+                                        }
                                         result = null;
                                         resultString = null;
                                         expectError = null;
+                                        if (isJokerAttempt) {
+                                            if (typeof parametersToPass[joker] === 'undefined') {
+                                                throw new Error("Joker parameter {".concat(joker, "} not defined"));
+                                            }
+                                            resultString = parametersToPass[joker];
+                                        }
                                         _v.label = 4;
                                     case 4:
                                         _v.trys.push([4, 44, 45, 46]);
+                                        if (!!isJokerAttempt) return [3 /*break*/, 27];
                                         _c = currentTemplate.executionType;
                                         switch (_c) {
                                             case 'SIMPLE_TEMPLATE': return [3 /*break*/, 5];
@@ -1470,22 +1553,27 @@
                                             throw scriptExecutionErrors[0];
                                         }
                                         else {
-                                            throw new Error(spaceTrim__default["default"](function (block) { return "\n                                        Script execution failed ".concat(scriptExecutionErrors.length, " times\n\n                                        ").concat(block(scriptExecutionErrors.map(function (error) { return '- ' + error.message; }).join('\n\n')), "\n                                    "); }));
+                                            throw new Error(spaceTrim__default["default"](function (block) { return "\n                                                    Script execution failed ".concat(scriptExecutionErrors.length, " times\n\n                                                    ").concat(block(scriptExecutionErrors
+                                                .map(function (error) { return '- ' + error.message; })
+                                                .join('\n\n')), "\n                                                "); }));
                                         }
                                     case 24: return [4 /*yield*/, tools.userInterface.promptDialog({
-                                            prompt: replaceParameters(currentTemplate.description || '', parametersToPass),
+                                            promptTitle: currentTemplate.title,
+                                            promptMessage: replaceParameters(currentTemplate.description || '', parametersToPass),
                                             defaultValue: replaceParameters(currentTemplate.content, parametersToPass),
                                             // TODO: [🧠] !! Figure out how to define placeholder in .ptbk.md file
                                             placeholder: undefined,
+                                            priority: priority /* <- TODO: !!!! Is it ending with 0 */,
                                         })];
                                     case 25:
+                                        // TODO: !!!! When making next attempt for `PROMPT DIALOG`, preserve the previous user input
                                         resultString = _v.sent();
                                         return [3 /*break*/, 27];
-                                    case 26: 
+                                    case 26: throw new Error(
                                     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                                    throw new Error("Unknown execution type \"".concat(currentTemplate.executionType, "\""));
+                                    "Unknown execution type \"".concat(currentTemplate.executionType, "\""));
                                     case 27:
-                                        if (!currentTemplate.postprocessing) return [3 /*break*/, 43];
+                                        if (!(!isJokerAttempt && currentTemplate.postprocessing)) return [3 /*break*/, 43];
                                         _v.label = 28;
                                     case 28:
                                         _v.trys.push([28, 41, 42, 43]);
@@ -1510,7 +1598,7 @@
                                         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 }),
+                                                parameters: __assign(__assign({}, parametersToPass), { resultString: resultString || '' }),
                                             })];
                                     case 33:
                                         resultString = _v.sent();
@@ -1553,7 +1641,7 @@
                                     case 43:
                                         if (currentTemplate.expectFormat) {
                                             if (currentTemplate.expectFormat === 'JSON') {
-                                                if (!isValidJsonString(resultString)) {
+                                                if (!isValidJsonString(resultString || '')) {
                                                     throw new ExpectError('Expected valid JSON string');
                                                 }
                                             }
@@ -1562,7 +1650,7 @@
                                             try {
                                                 for (_l = (e_4 = void 0, __values(Object.entries(currentTemplate.expectAmount))), _m = _l.next(); !_m.done; _m = _l.next()) {
                                                     _o = __read(_m.value, 2), unit = _o[0], _p = _o[1], max = _p.max, min = _p.min;
-                                                    amount = CountUtils[unit.toUpperCase()](resultString);
+                                                    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 */
@@ -1588,7 +1676,8 @@
                                         expectError = error_4;
                                         return [3 /*break*/, 46];
                                     case 45:
-                                        if (currentTemplate.executionType === 'PROMPT_TEMPLATE' &&
+                                        if (!isJokerAttempt &&
+                                            currentTemplate.executionType === 'PROMPT_TEMPLATE' &&
                                             prompt_1
                                         //    <- Note:  [2] When some expected parameter is not defined, error will occur in replaceParameters
                                         //              In that case we don’t want to make a report about it because it’s not a natural execution error
@@ -1826,7 +1915,7 @@
                         case 1:
                             answer = _a.sent();
                             if (this.options.isVerbose) {
-                                console.info(spaceTrim__default["default"](function (block) { return "\n                        \uD83D\uDCD6 ".concat(block(options.prompt), "\n                        \uD83D\uDC64 ").concat(block(answer), "\n                    "); }));
+                                console.info(spaceTrim__default["default"](function (block) { return "\n                        \uD83D\uDCD6 ".concat(block(options.promptTitle), "\n                        \uD83D\uDC64 ").concat(block(answer), "\n                    "); }));
                             }
                             return [2 /*return*/, answer];
                     }
@@ -1853,9 +1942,9 @@
             return __awaiter(this, void 0, void 0, function () {
                 var answer;
                 return __generator(this, function (_a) {
-                    answer = window.prompt(options.prompt);
+                    answer = window.prompt(spaceTrim__default["default"](function (block) { return "\n                    ".concat(block(options.promptTitle), "\n                    \n                    ").concat(block(options.promptMessage), "\n                "); }));
                     if (this.options.isVerbose) {
-                        console.info(spaceTrim__default["default"](function (block) { return "\n                        \uD83D\uDCD6 ".concat(block(options.prompt), "\n                        \uD83D\uDC64 ").concat(block(answer || '🚫 User cancelled prompt'), "\n                    "); }));
+                        console.info(spaceTrim__default["default"](function (block) { return "\n                        \uD83D\uDCD6 ".concat(block(options.promptTitle), "\n                        \uD83D\uDC64 ").concat(block(answer || '🚫 User cancelled prompt'), "\n                    "); }));
                     }
                     if (answer === null) {
                         throw new Error('User cancelled prompt');