@promptbook/markdown-utils 0.75.0-0 → 0.75.0-1

package/esm/index.es.js

@@ -20,7 +20,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  *
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.74.0-13';
+var PROMPTBOOK_ENGINE_VERSION = '0.75.0-0';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  */
@@ -910,6 +910,7 @@ var IS_PIPELINE_LOGIC_VALIDATED = just(
 // Note: In normal situations, we check the pipeline logic:
 true);
 /**
+ * TODO: Extract `constants.ts` from `config.ts`
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
  */
 
@@ -1152,18 +1153,18 @@ function validatePipelineCore(pipeline) {
     }
     var _loop_1 = function (parameter) {
         if (parameter.isInput && parameter.isOutput) {
-            throw new PipelineLogicError(spaceTrim$1(function (block) { return "\n\n                        Parameter {".concat(parameter.name, "} can not be both input and output\n\n                        ").concat(block(pipelineIdentification), "\n                    "); }));
+            throw new PipelineLogicError(spaceTrim$1(function (block) { return "\n\n                        Parameter `{".concat(parameter.name, "}` can not be both input and output\n\n                        ").concat(block(pipelineIdentification), "\n                    "); }));
         }
         // Note: Testing that parameter is either intermediate or output BUT not created and unused
         if (!parameter.isInput &&
             !parameter.isOutput &&
             !pipeline.templates.some(function (template) { return template.dependentParameterNames.includes(parameter.name); })) {
-            throw new PipelineLogicError(spaceTrim$1(function (block) { return "\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                        ").concat(block(pipelineIdentification), "\n\n                    "); }));
+            throw new PipelineLogicError(spaceTrim$1(function (block) { return "\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                        ").concat(block(pipelineIdentification), "\n\n                    "); }));
         }
         // Note: Testing that parameter is either input or result of some template
         if (!parameter.isInput &&
             !pipeline.templates.some(function (template) { return template.resultingParameterName === parameter.name; })) {
-            throw new PipelineLogicError(spaceTrim$1(function (block) { return "\n                        Parameter {".concat(parameter.name, "} is declared but not defined\n\n                        You can do one of these:\n                        1) Remove declaration of {").concat(parameter.name, "}\n                        2) Add template that results in -> {").concat(parameter.name, "}\n\n                        ").concat(block(pipelineIdentification), "\n                    "); }));
+            throw new PipelineLogicError(spaceTrim$1(function (block) { return "\n                        Parameter `{".concat(parameter.name, "}` is declared but not defined\n\n                        You can do one of these:\n                        1) Remove declaration of `{").concat(parameter.name, "}`\n                        2) Add template that results in `-> {").concat(parameter.name, "}`\n\n                        ").concat(block(pipelineIdentification), "\n                    "); }));
         }
     };
     try {
@@ -1191,7 +1192,7 @@ function validatePipelineCore(pipeline) {
     var _loop_2 = function (template) {
         var e_4, _h, e_5, _j;
         if (definedParameters.has(template.resultingParameterName)) {
-            throw new PipelineLogicError(spaceTrim$1(function (block) { return "\n                        Parameter {".concat(template.resultingParameterName, "} is defined multiple times\n\n                        ").concat(block(pipelineIdentification), "\n                    "); }));
+            throw new PipelineLogicError(spaceTrim$1(function (block) { return "\n                        Parameter `{".concat(template.resultingParameterName, "}` is defined multiple times\n\n                        ").concat(block(pipelineIdentification), "\n                    "); }));
         }
         if (RESERVED_PARAMETER_NAMES.includes(template.resultingParameterName)) {
             throw new PipelineLogicError(spaceTrim$1(function (block) { return "\n                        Parameter name {".concat(template.resultingParameterName, "} is reserved, please use different name\n\n                        ").concat(block(pipelineIdentification), "\n                    "); }));
@@ -1204,7 +1205,7 @@ function validatePipelineCore(pipeline) {
             }
             var _loop_4 = function (joker) {
                 if (!template.dependentParameterNames.includes(joker)) {
-                    throw new PipelineLogicError(spaceTrim$1(function (block) { return "\n                                Parameter {".concat(joker, "} is used for {").concat(template.resultingParameterName, "} as joker but not in `dependentParameterNames`\n\n                                ").concat(block(pipelineIdentification), "\n                            "); }));
+                    throw new PipelineLogicError(spaceTrim$1(function (block) { return "\n                                Parameter `{".concat(joker, "}` is used for {").concat(template.resultingParameterName, "} as joker but not in `dependentParameterNames`\n\n                                ").concat(block(pipelineIdentification), "\n                            "); }));
                 }
             };
             try {
@@ -1299,14 +1300,24 @@ function validatePipelineCore(pipeline) {
         if (currentlyResovedTemplates.length === 0) {
             throw new PipelineLogicError(
             // TODO: [🐎] DRY
-            spaceTrim$1(function (block) { return "\n\n                        Can not resolve some parameters:\n                        Either you are using a parameter that is not defined, or there are some circular dependencies.\n\n                        ".concat(block(pipelineIdentification), "\n\n                        Can not resolve:\n                        ").concat(block(unresovedTemplates
+            spaceTrim$1(function (block) { return "\n\n                        Can not resolve some parameters:\n                        Either you are using a parameter that is not defined, or there are some circular dependencies.\n\n                        ".concat(block(pipelineIdentification), "\n\n                        **Can not resolve:**\n                        ").concat(block(unresovedTemplates
                 .map(function (_a) {
                 var resultingParameterName = _a.resultingParameterName, dependentParameterNames = _a.dependentParameterNames;
-                return "- Parameter {".concat(resultingParameterName, "} which depends on ").concat(dependentParameterNames
-                    .map(function (dependentParameterName) { return "{".concat(dependentParameterName, "}"); })
+                return "- Parameter `{".concat(resultingParameterName, "}` which depends on ").concat(dependentParameterNames
+                    .map(function (dependentParameterName) { return "`{".concat(dependentParameterName, "}`"); })
                     .join(' and '));
             })
-                .join('\n')), "\n\n                        Resolved:\n                        ").concat(block(resovedParameters.map(function (name) { return "- Parameter {".concat(name, "}"); }).join('\n')), "\n\n\n                    "); }));
+                .join('\n')), "\n\n                        **Resolved:**\n                        ").concat(block(resovedParameters
+                .filter(function (name) {
+                return !RESERVED_PARAMETER_NAMES.includes(name);
+            })
+                .map(function (name) { return "- Parameter `{".concat(name, "}`"); })
+                .join('\n')), "\n\n\n                        **Reserved (which are available):**\n                        ").concat(block(resovedParameters
+                .filter(function (name) {
+                return RESERVED_PARAMETER_NAMES.includes(name);
+            })
+                .map(function (name) { return "- Parameter `{".concat(name, "}`"); })
+                .join('\n')), "\n\n\n                    "); }));
         }
         resovedParameters = __spreadArray(__spreadArray([], __read(resovedParameters), false), __read(currentlyResovedTemplates.map(function (_a) {
             var resultingParameterName = _a.resultingParameterName;
@@ -1317,6 +1328,7 @@ function validatePipelineCore(pipeline) {
     while (unresovedTemplates.length > 0) {
         _loop_3();
     }
+    // TODO: !!!!!! Test that pipeline interface implements declared formfactor interface
 }
 /**
  * TODO: !! [🧞‍♀️] Do not allow joker + foreach
@@ -2672,8 +2684,8 @@ var MultipleLlmExecutionTools = /** @class */ (function () {
                         else if (errors.length > 1) {
                             throw new PipelineExecutionError(
                             // TODO: Tell which execution tools failed like
-                            //     1) OpenAI throw PipelineExecutionError: Parameter {knowledge} is not defined
-                            //     2) AnthropicClaude throw PipelineExecutionError: Parameter {knowledge} is not defined
+                            //     1) OpenAI throw PipelineExecutionError: Parameter `{knowledge}` is not defined
+                            //     2) AnthropicClaude throw PipelineExecutionError: Parameter `{knowledge}` is not defined
                             //     3) ...
                             spaceTrim(function (block) { return "\n                          All execution tools failed:\n\n                          ".concat(block(errors
                                 .map(function (error, i) { return "".concat(i + 1, ") **").concat(error.name || 'Error', ":** ").concat(error.message); })
@@ -4194,11 +4206,11 @@ function replaceParameters(template, parameters) {
         for (var _b = __values(Object.entries(parameters)), _c = _b.next(); !_c.done; _c = _b.next()) {
             var _d = __read(_c.value, 2), parameterName = _d[0], parameterValue = _d[1];
             if (parameterValue === RESERVED_PARAMETER_MISSING_VALUE) {
-                throw new UnexpectedError("Parameter {".concat(parameterName, "} has missing value"));
+                throw new UnexpectedError("Parameter `{".concat(parameterName, "}` has missing value"));
             }
             else if (parameterValue === RESERVED_PARAMETER_RESTRICTED) {
                 // TODO: [🍵]
-                throw new UnexpectedError("Parameter {".concat(parameterName, "} is restricted to use"));
+                throw new UnexpectedError("Parameter `{".concat(parameterName, "}` is restricted to use"));
             }
         }
     }
@@ -4225,11 +4237,11 @@ function replaceParameters(template, parameters) {
             throw new PipelineExecutionError('Parameter is already opened or not closed');
         }
         if (parameters[parameterName] === undefined) {
-            throw new PipelineExecutionError("Parameter {".concat(parameterName, "} is not defined"));
+            throw new PipelineExecutionError("Parameter `{".concat(parameterName, "}` is not defined"));
         }
         var parameterValue = parameters[parameterName];
         if (parameterValue === undefined) {
-            throw new PipelineExecutionError("Parameter {".concat(parameterName, "} is not defined"));
+            throw new PipelineExecutionError("Parameter `{".concat(parameterName, "}` is not defined"));
         }
         parameterValue = parameterValue.toString();
         if (parameterValue.includes('\n') && /^\s*\W{0,3}\s*$/.test(precol)) {
@@ -4285,6 +4297,9 @@ var CHARACTERS_PER_STANDARD_LINE = 63;
  * @public exported from `@promptbook/utils`
  */
 var LINES_PER_STANDARD_PAGE = 44;
+/**
+ * TODO: [🧠] Should be this `constants.ts` or `config.ts`?
+ */
 
 /**
  * Counts number of lines in the text
@@ -5016,7 +5031,7 @@ function executeTemplate(options) {
                         else if (!definedParameterNames.has(parameterName) && usedParameterNames.has(parameterName)) {
                             // Houston, we have a problem
                             // Note: Checking part is also done in `validatePipeline`, but it’s good to doublecheck
-                            throw new UnexpectedError(spaceTrim$1(function (block) { return "\n                        Parameter {".concat(parameterName, "} is NOT defined\n                        BUT used in template \"").concat(currentTemplate.title || currentTemplate.name, "\"\n\n                        This should be catched in `validatePipeline`\n\n                        ").concat(block(pipelineIdentification), "\n\n                    "); }));
+                            throw new UnexpectedError(spaceTrim$1(function (block) { return "\n                        Parameter `{".concat(parameterName, "}` is NOT defined\n                        BUT used in template \"").concat(currentTemplate.title || currentTemplate.name, "\"\n\n                        This should be catched in `validatePipeline`\n\n                        ").concat(block(pipelineIdentification), "\n\n                    "); }));
                         }
                     };
                     try {
@@ -5095,7 +5110,7 @@ function filterJustOutputParameters(options) {
     var _loop_1 = function (parameter) {
         if (parametersToPass[parameter.name] === undefined) {
             // [4]
-            $warnings.push(new PipelineExecutionError(spaceTrim$1(function (block) { return "\n                            Parameter {".concat(parameter.name, "} should be an output parameter, but it was not generated during pipeline execution\n\n                            ").concat(block(pipelineIdentification), "\n                        "); })));
+            $warnings.push(new PipelineExecutionError(spaceTrim$1(function (block) { return "\n                            Parameter `{".concat(parameter.name, "}` should be an output parameter, but it was not generated during pipeline execution\n\n                            ").concat(block(pipelineIdentification), "\n                        "); })));
             return "continue";
         }
         outputParameters[parameter.name] = parametersToPass[parameter.name] || '';
@@ -5182,7 +5197,7 @@ function executePipeline(options) {
                 case 6: return [2 /*return*/, $asDeeplyFrozenSerializableJson("Unuccessful PipelineExecutorResult (with missing parameter {".concat(parameter.name, "}) PipelineExecutorResult"), {
                         isSuccessful: false,
                         errors: __spreadArray([
-                            new PipelineExecutionError("Parameter {".concat(parameter.name, "} is required as an input parameter"))
+                            new PipelineExecutionError("Parameter `{".concat(parameter.name, "}` is required as an input parameter"))
                         ], __read(errors), false).map(serializeError),
                         warnings: [],
                         executionReport: executionReport,
@@ -5230,7 +5245,7 @@ function executePipeline(options) {
                                 case 3: return [2 /*return*/, { value: $asDeeplyFrozenSerializableJson(spaceTrim$1(function (block) { return "\n                        Unuccessful PipelineExecutorResult (with extra parameter {".concat(parameter.name, "}) PipelineExecutorResult\n\n                        ").concat(block(pipelineIdentification), "\n                    "); }), {
                                             isSuccessful: false,
                                             errors: __spreadArray([
-                                                new PipelineExecutionError(spaceTrim$1(function (block) { return "\n                                    Parameter {".concat(parameter.name, "} is passed as input parameter but it is not input\n\n                                    ").concat(block(pipelineIdentification), "\n                                "); }))
+                                                new PipelineExecutionError(spaceTrim$1(function (block) { return "\n                                    Parameter `{".concat(parameter.name, "}` is passed as input parameter but it is not input\n\n                                    ").concat(block(pipelineIdentification), "\n                                "); }))
                                             ], __read(errors), false).map(serializeError),
                                             warnings: warnings.map(serializeError),
                                             executionReport: executionReport,
@@ -5304,14 +5319,24 @@ function executePipeline(options) {
                                     if (!(!currentTemplate && resolving_1.length === 0)) return [3 /*break*/, 1];
                                     throw new UnexpectedError(
                                     // TODO: [🐎] DRY
-                                    spaceTrim$1(function (block) { return "\n                            Can not resolve some parameters:\n\n                            ".concat(block(pipelineIdentification), "\n\n                            Can not resolve:\n                            ").concat(block(unresovedTemplates_1
+                                    spaceTrim$1(function (block) { return "\n                            Can not resolve some parameters:\n\n                            ".concat(block(pipelineIdentification), "\n\n                            **Can not resolve:**\n                            ").concat(block(unresovedTemplates_1
                                         .map(function (_a) {
                                         var resultingParameterName = _a.resultingParameterName, dependentParameterNames = _a.dependentParameterNames;
-                                        return "- Parameter {".concat(resultingParameterName, "} which depends on ").concat(dependentParameterNames
-                                            .map(function (dependentParameterName) { return "{".concat(dependentParameterName, "}"); })
+                                        return "- Parameter `{".concat(resultingParameterName, "}` which depends on ").concat(dependentParameterNames
+                                            .map(function (dependentParameterName) { return "`{".concat(dependentParameterName, "}`"); })
                                             .join(' and '));
                                     })
-                                        .join('\n')), "\n\n                            Resolved:\n                            ").concat(block(resovedParameterNames_1.map(function (name) { return "- Parameter {".concat(name, "}"); }).join('\n')), "\n\n                            Note: This should be catched in `validatePipeline`\n                        "); }));
+                                        .join('\n')), "\n\n                            **Resolved:**\n                            ").concat(block(resovedParameterNames_1
+                                        .filter(function (name) {
+                                        return !RESERVED_PARAMETER_NAMES.includes(name);
+                                    })
+                                        .map(function (name) { return "- Parameter `{".concat(name, "}`"); })
+                                        .join('\n')), "\n\n                            **Reserved (which are available):**\n                            ").concat(block(resovedParameterNames_1
+                                        .filter(function (name) {
+                                        return RESERVED_PARAMETER_NAMES.includes(name);
+                                    })
+                                        .map(function (name) { return "- Parameter `{".concat(name, "}`"); })
+                                        .join('\n')), "\n\n                            *Note: This should be catched in `validatePipeline`*\n                        "); }));
                                 case 1:
                                     if (!!currentTemplate) return [3 /*break*/, 3];
                                     /* [🤹‍♂️] */ return [4 /*yield*/, Promise.race(resolving_1)];