@promptbook/node 0.78.3 → 0.79.0

package/README.md

@@ -1,6 +1,6 @@
 <!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->
 
-# ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook
+# ❄ Promptbook
 
 
 
@@ -14,7 +14,7 @@
 
 
 
-## ✨ New Features
+## ❄ New Features
 
 -   💙 Working [the **Book** language v1.0.0](https://github.com/webgptorg/book)
 -   🖤 Run books from CLI - `npx ptbk run path/to/your/book`

package/esm/index.es.js

@@ -26,7 +26,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  *
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.78.2';
+var PROMPTBOOK_ENGINE_VERSION = '0.78.4';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -675,6 +675,9 @@ function forEachAsync(array, options, callbackfunction) {
  */
 function $deepFreeze(objectValue) {
     var e_1, _a;
+    if (Array.isArray(objectValue)) {
+        return Object.freeze(objectValue.map(function (item) { return $deepFreeze(item); }));
+    }
     var propertyNames = Object.getOwnPropertyNames(objectValue);
     try {
         for (var propertyNames_1 = __values(propertyNames), propertyNames_1_1 = propertyNames_1.next(); !propertyNames_1_1.done; propertyNames_1_1 = propertyNames_1.next()) {
@@ -5603,6 +5606,133 @@ function preparePipeline(pipeline, tools, options) {
  *       @see https://docs.anthropic.com/en/docs/test-and-evaluate/strengthen-guardrails/increase-consistency#specify-the-desired-output-format
  */
 
+/**
+ * @@@
+ *
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
+ * @public exported from `@promptbook/core`
+ */
+function getPipelineInterface(pipeline) {
+    var e_1, _a, e_2, _b;
+    var pipelineInterface = {
+        inputParameters: [],
+        outputParameters: [],
+    };
+    try {
+        for (var _c = __values(pipeline.parameters), _d = _c.next(); !_d.done; _d = _c.next()) {
+            var parameter = _d.value;
+            var isInput = parameter.isInput, isOutput = parameter.isOutput;
+            if (isInput) {
+                pipelineInterface.inputParameters.push(deepClone(parameter));
+            }
+            if (isOutput) {
+                pipelineInterface.outputParameters.push(deepClone(parameter));
+            }
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    try {
+        for (var _e = __values(['inputParameters', 'outputParameters']), _f = _e.next(); !_f.done; _f = _e.next()) {
+            var key = _f.value;
+            pipelineInterface[key].sort(function (_a, _b) {
+                var name1 = _a.name;
+                var name2 = _b.name;
+                return name1.localeCompare(name2);
+            });
+        }
+    }
+    catch (e_2_1) { e_2 = { error: e_2_1 }; }
+    finally {
+        try {
+            if (_f && !_f.done && (_b = _e.return)) _b.call(_e);
+        }
+        finally { if (e_2) throw e_2.error; }
+    }
+    return $deepFreeze(pipelineInterface);
+}
+
+/**
+ * @@@
+ *
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
+ * @public exported from `@promptbook/core`
+ */
+function isPipelineInterfacesEqual(pipelineInterface1, pipelineInterface2) {
+    var e_1, _a, e_2, _b;
+    try {
+        for (var _c = __values(['inputParameters', 'outputParameters']), _d = _c.next(); !_d.done; _d = _c.next()) {
+            var whichParameters = _d.value;
+            var parameters1 = pipelineInterface1[whichParameters]; // <- Note: `isPipelineInterfacesEqual` is just temporary solution, no need to fix this
+            var parameters2 = pipelineInterface2[whichParameters];
+            if (parameters1.length !== parameters2.length) {
+                return false;
+            }
+            var _loop_1 = function (parameter) {
+                var matchingParameter = parameters2.find(function (_a) {
+                    var name = _a.name;
+                    return name === parameter.name;
+                });
+                if (!matchingParameter) {
+                    return { value: false };
+                }
+                // Note: Do not compare description, it is not relevant for compatibility
+                if (matchingParameter.isInput !== parameter.isInput) {
+                    return { value: false };
+                }
+                if (matchingParameter.isOutput !== parameter.isOutput) {
+                    return { value: false };
+                }
+            };
+            try {
+                for (var parameters1_1 = (e_2 = void 0, __values(parameters1)), parameters1_1_1 = parameters1_1.next(); !parameters1_1_1.done; parameters1_1_1 = parameters1_1.next()) {
+                    var parameter = parameters1_1_1.value;
+                    var state_1 = _loop_1(parameter);
+                    if (typeof state_1 === "object")
+                        return state_1.value;
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (parameters1_1_1 && !parameters1_1_1.done && (_b = parameters1_1.return)) _b.call(parameters1_1);
+                }
+                finally { if (e_2) throw e_2.error; }
+            }
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    return true;
+}
+
+/**
+ * @@@
+ *
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
+ * @public exported from `@promptbook/core`
+ */
+function isPipelineImplementingInterface(options) {
+    var pipeline = options.pipeline, pipelineInterface = options.pipelineInterface;
+    return isPipelineInterfacesEqual(getPipelineInterface(pipeline), pipelineInterface);
+}
+
 /**
  * All available task types
  *
@@ -6762,7 +6892,13 @@ var GeneratorFormfactorDefinition = {
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184",
     pipelineInterface: {
         inputParameters: [
-        /* @@@ */
+            /* @@@ */
+            {
+                name: 'nonce',
+                description: 'Just to prevent GENERATOR to be set as implicit formfactor',
+                isInput: true,
+                isOutput: false,
+            },
         ],
         outputParameters: [
         /* @@@ */
@@ -6808,7 +6944,13 @@ var MatcherFormfactorDefinition = {
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/177",
     pipelineInterface: {
         inputParameters: [
-        /* @@@ */
+            /* @@@ */
+            {
+                name: 'nonce',
+                description: 'Just to prevent EXPERIMENTAL_MATCHER to be set as implicit formfactor',
+                isInput: true,
+                isOutput: false,
+            },
         ],
         outputParameters: [
         /* @@@ */
@@ -6957,6 +7099,9 @@ var formfactorCommandParser = {
      * Note: `$` is used to indicate that this function mutates given `pipelineJson`
      */
     $applyToPipelineJson: function (command, $pipelineJson) {
+        if ($pipelineJson.formfactorName !== undefined && $pipelineJson.formfactorName !== command.formfactorName) {
+            throw new ParseError(spaceTrim("\n                    Redefinition of `FORMFACTOR` in the pipeline head\n\n                    You have used:\n                    1) FORMFACTOR `".concat($pipelineJson.formfactorName, "`\n                    2) FORMFACTOR `").concat(command.formfactorName, "`\n                ")));
+        }
         $pipelineJson.formfactorName = command.formfactorName;
     },
     /**
@@ -7144,7 +7289,7 @@ var modelCommandParser = {
                 // <- TODO: [🚎][💩] Some better way how to get warnings from pipeline parsing / logic
             }
             else {
-                throw new ParseError(spaceTrim("\n                        Redefinition of MODEL `".concat(command.key, "` in the pipeline head\n\n                        You have used:\n                        - MODEL ").concat(command.key, " ").concat($pipelineJson.defaultModelRequirements[command.key], "\n                        - MODEL ").concat(command.key, " ").concat(command.value, "\n                    ")));
+                throw new ParseError(spaceTrim("\n                        Redefinition of `MODEL ".concat(command.key, "` in the pipeline head\n\n                        You have used:\n                        1) `MODEL ").concat(command.key, " ").concat($pipelineJson.defaultModelRequirements[command.key], "`\n                        2) `MODEL ").concat(command.key, " ").concat(command.value, "`\n                    ")));
             }
         }
         $pipelineJson.defaultModelRequirements[command.key] = command.value;
@@ -8237,20 +8382,15 @@ function titleToName(value) {
  * @public exported from `@promptbook/core`
  */
 function pipelineStringToJsonSync(pipelineString) {
-    var e_1, _a, e_2, _b, e_3, _c, e_4, _d, e_5, _e;
+    var e_1, _a, e_2, _b, e_3, _c, e_4, _d, e_5, _e, e_6, _f;
     var $pipelineJson = {
-        title: undefined /* <- Note: [🍙] Putting here placeholder to keep `title` on top at final JSON */,
-        pipelineUrl: undefined /* <- Note: Putting here placeholder to keep `pipelineUrl` on top at final JSON */,
-        bookVersion: undefined /* <- Note: By default no explicit version */,
-        description: undefined /* <- Note: [🍙] Putting here placeholder to keep `description` on top at final JSON */,
-        formfactorName: 'GENERIC',
+        title: DEFAULT_TITLE,
         parameters: [],
         tasks: [],
         knowledgeSources: [],
         knowledgePieces: [],
         personas: [],
         preparations: [],
-        // <- TODO: [🍙] Some standard order of properties
     };
     function getPipelineIdentification() {
         // Note: This is a 😐 implementation of [🚞]
@@ -8266,7 +8406,7 @@ function pipelineStringToJsonSync(pipelineString) {
     // =============================================================
     // Note: 1️⃣ Parsing of the markdown into object
     if (pipelineString.startsWith('#!')) {
-        var _f = __read(pipelineString.split('\n')), shebangLine_1 = _f[0], restLines = _f.slice(1);
+        var _g = __read(pipelineString.split('\n')), shebangLine_1 = _g[0], restLines = _g.slice(1);
         if (!(shebangLine_1 || '').includes('ptbk')) {
             throw new ParseError(spaceTrim$1(function (block) { return "\n                        It seems that you try to parse a book file which has non-standard shebang line for book files:\n                        Shebang line must contain 'ptbk'\n\n                        You have:\n                        ".concat(block(shebangLine_1 || '(empty line)'), "\n\n                        It should look like this:\n                        #!/usr/bin/env ptbk\n\n                        ").concat(block(getPipelineIdentification()), "\n                    "); }));
         }
@@ -8276,7 +8416,7 @@ function pipelineStringToJsonSync(pipelineString) {
     pipelineString = flattenMarkdown(pipelineString) /* <- Note: [🥞] */;
     pipelineString = pipelineString.replaceAll(/`\{(?<parameterName>[a-z0-9_]+)\}`/gi, '{$<parameterName>}');
     pipelineString = pipelineString.replaceAll(/`->\s+\{(?<parameterName>[a-z0-9_]+)\}`/gi, '-> {$<parameterName>}');
-    var _g = __read(splitMarkdownIntoSections(pipelineString).map(parseMarkdownSection)), pipelineHead = _g[0], pipelineSections = _g.slice(1); /* <- Note: [🥞] */
+    var _h = __read(splitMarkdownIntoSections(pipelineString).map(parseMarkdownSection)), pipelineHead = _h[0], pipelineSections = _h.slice(1); /* <- Note: [🥞] */
     if (pipelineHead === undefined) {
         throw new UnexpectedError(spaceTrim$1(function (block) { return "\n                    Pipeline head is not defined\n\n                    ".concat(block(getPipelineIdentification()), "\n\n                    This should never happen, because the pipeline already flattened\n                "); }));
     }
@@ -8398,10 +8538,10 @@ function pipelineStringToJsonSync(pipelineString) {
         return nameWithSuffix;
     };
     var _loop_2 = function (section) {
-        var e_6, _m, e_7, _o;
+        var e_7, _o, e_8, _p;
         // TODO: Parse section's description (the content out of the codeblock and lists)
         var listItems_2 = extractAllListItemsFromMarkdown(section.content);
-        var _p = extractOneBlockFromMarkdown(section.content), language = _p.language, content = _p.content;
+        var _q = extractOneBlockFromMarkdown(section.content), language = _q.language, content = _q.content;
         // TODO: [🎾][1] DRY description
         var description_1 = section.content;
         // Note: Remove codeblocks - TODO: [🎾]
@@ -8465,17 +8605,17 @@ function pipelineStringToJsonSync(pipelineString) {
         };
         try {
             // TODO [♓️] List commands and before apply order them to achieve order-agnostic commands
-            for (var commands_1 = (e_6 = void 0, __values(commands)), commands_1_1 = commands_1.next(); !commands_1_1.done; commands_1_1 = commands_1.next()) {
-                var _q = commands_1_1.value, listItem = _q.listItem, command = _q.command;
+            for (var commands_1 = (e_7 = void 0, __values(commands)), commands_1_1 = commands_1.next(); !commands_1_1.done; commands_1_1 = commands_1.next()) {
+                var _r = commands_1_1.value, listItem = _r.listItem, command = _r.command;
                 _loop_4(listItem, command);
             }
         }
-        catch (e_6_1) { e_6 = { error: e_6_1 }; }
+        catch (e_7_1) { e_7 = { error: e_7_1 }; }
         finally {
             try {
-                if (commands_1_1 && !commands_1_1.done && (_m = commands_1.return)) _m.call(commands_1);
+                if (commands_1_1 && !commands_1_1.done && (_o = commands_1.return)) _o.call(commands_1);
             }
-            finally { if (e_6) throw e_6.error; }
+            finally { if (e_7) throw e_7.error; }
         }
         // TODO: [🍧] Should be done in SECTION command
         if ($taskJson.taskType === 'SCRIPT_TASK') {
@@ -8489,8 +8629,8 @@ function pipelineStringToJsonSync(pipelineString) {
         }
         $taskJson.dependentParameterNames = Array.from(extractParameterNamesFromTask($taskJson));
         try {
-            for (var _r = (e_7 = void 0, __values($taskJson.dependentParameterNames)), _s = _r.next(); !_s.done; _s = _r.next()) {
-                var parameterName = _s.value;
+            for (var _s = (e_8 = void 0, __values($taskJson.dependentParameterNames)), _t = _s.next(); !_t.done; _t = _s.next()) {
+                var parameterName = _t.value;
                 // TODO: [🧠] This definition should be made first in the task
                 defineParam({
                     parameterName: parameterName,
@@ -8501,12 +8641,12 @@ function pipelineStringToJsonSync(pipelineString) {
                 });
             }
         }
-        catch (e_7_1) { e_7 = { error: e_7_1 }; }
+        catch (e_8_1) { e_8 = { error: e_8_1 }; }
         finally {
             try {
-                if (_s && !_s.done && (_o = _r.return)) _o.call(_r);
+                if (_t && !_t.done && (_p = _s.return)) _p.call(_s);
             }
-            finally { if (e_7) throw e_7.error; }
+            finally { if (e_8) throw e_8.error; }
         }
         /*
         // TODO: [🍧] This should be checked in `MODEL` command + better error message
@@ -8555,18 +8695,22 @@ function pipelineStringToJsonSync(pipelineString) {
             var isThisParameterResulting = $pipelineJson.tasks.some(function (task) { return task.resultingParameterName === parameter.name; });
             if (!isThisParameterResulting) {
                 parameter.isInput = true;
+                // <- TODO: [💔] Why this is making typescript error in vscode but not in cli
+                //        > Type 'true' is not assignable to type 'false'.ts(2322)
+                //        > (property) isInput: false
+                //        > The parameter is input of the pipeline The parameter is NOT input of the pipeline
             }
         };
         try {
-            for (var _h = __values($pipelineJson.parameters), _j = _h.next(); !_j.done; _j = _h.next()) {
-                var parameter = _j.value;
+            for (var _j = __values($pipelineJson.parameters), _k = _j.next(); !_k.done; _k = _j.next()) {
+                var parameter = _k.value;
                 _loop_3(parameter);
             }
         }
         catch (e_4_1) { e_4 = { error: e_4_1 }; }
         finally {
             try {
-                if (_j && !_j.done && (_d = _h.return)) _d.call(_h);
+                if (_k && !_k.done && (_d = _j.return)) _d.call(_j);
             }
             finally { if (e_4) throw e_4.error; }
         }
@@ -8575,17 +8719,18 @@ function pipelineStringToJsonSync(pipelineString) {
     // Note: 7️⃣ Mark all non-INPUT parameters as OUTPUT if any OUTPUT is not set
     if ($pipelineJson.parameters.every(function (parameter) { return !parameter.isOutput; })) {
         try {
-            for (var _k = __values($pipelineJson.parameters), _l = _k.next(); !_l.done; _l = _k.next()) {
-                var parameter = _l.value;
+            for (var _l = __values($pipelineJson.parameters), _m = _l.next(); !_m.done; _m = _l.next()) {
+                var parameter = _m.value;
                 if (!parameter.isInput) {
                     parameter.isOutput = true;
+                    // <- TODO: [💔]
                 }
             }
         }
         catch (e_5_1) { e_5 = { error: e_5_1 }; }
         finally {
             try {
-                if (_l && !_l.done && (_e = _k.return)) _e.call(_k);
+                if (_m && !_m.done && (_e = _l.return)) _e.call(_l);
             }
             finally { if (e_5) throw e_5.error; }
         }
@@ -8593,7 +8738,7 @@ function pipelineStringToJsonSync(pipelineString) {
     // =============================================================
     // Note: 8️⃣ Cleanup of undefined values
     $pipelineJson.tasks.forEach(function (tasks) {
-        var e_8, _a;
+        var e_9, _a;
         try {
             for (var _b = __values(Object.entries(tasks)), _c = _b.next(); !_c.done; _c = _b.next()) {
                 var _d = __read(_c.value, 2), key = _d[0], value = _d[1];
@@ -8602,16 +8747,16 @@ function pipelineStringToJsonSync(pipelineString) {
                 }
             }
         }
-        catch (e_8_1) { e_8 = { error: e_8_1 }; }
+        catch (e_9_1) { e_9 = { error: e_9_1 }; }
         finally {
             try {
                 if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
             }
-            finally { if (e_8) throw e_8.error; }
+            finally { if (e_9) throw e_9.error; }
         }
     });
     $pipelineJson.parameters.forEach(function (parameter) {
-        var e_9, _a;
+        var e_10, _a;
         try {
             for (var _b = __values(Object.entries(parameter)), _c = _b.next(); !_c.done; _c = _b.next()) {
                 var _d = __read(_c.value, 2), key = _d[0], value = _d[1];
@@ -8620,17 +8765,61 @@ function pipelineStringToJsonSync(pipelineString) {
                 }
             }
         }
-        catch (e_9_1) { e_9 = { error: e_9_1 }; }
+        catch (e_10_1) { e_10 = { error: e_10_1 }; }
         finally {
             try {
                 if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
             }
-            finally { if (e_9) throw e_9.error; }
+            finally { if (e_10) throw e_10.error; }
         }
     });
+    try {
+        // =============================================================
+        // Note: 9️⃣ Implicit and default formfactor
+        for (var FORMFACTOR_DEFINITIONS_1 = __values(FORMFACTOR_DEFINITIONS), FORMFACTOR_DEFINITIONS_1_1 = FORMFACTOR_DEFINITIONS_1.next(); !FORMFACTOR_DEFINITIONS_1_1.done; FORMFACTOR_DEFINITIONS_1_1 = FORMFACTOR_DEFINITIONS_1.next()) {
+            var formfactorDefinition = FORMFACTOR_DEFINITIONS_1_1.value;
+            // <- Note: [♓️][💩] This is the order of the formfactors, make some explicit priority
+            var name_2 = formfactorDefinition.name, pipelineInterface = formfactorDefinition.pipelineInterface;
+            // Note: Skip GENERIC formfactor, it will be used as a fallback if no other formfactor is compatible
+            if (name_2 === 'GENERIC') {
+                continue;
+            }
+            var isCompatible = isPipelineImplementingInterface({
+                pipeline: __assign({ formfactorName: name_2 }, $pipelineJson),
+                pipelineInterface: pipelineInterface,
+            });
+            /*/
+            console.log({
+                subject: `${$pipelineJson.title} implements ${name}`,
+                pipelineTitle: $pipelineJson.title,
+                formfactorName: name,
+                isCompatible,
+                formfactorInterface: pipelineInterface,
+                pipelineInterface: getPipelineInterface($pipelineJson as PipelineJson),
+            });
+            /**/
+            if (isCompatible) {
+                $pipelineJson.formfactorName = name_2;
+                break;
+            }
+        }
+    }
+    catch (e_6_1) { e_6 = { error: e_6_1 }; }
+    finally {
+        try {
+            if (FORMFACTOR_DEFINITIONS_1_1 && !FORMFACTOR_DEFINITIONS_1_1.done && (_f = FORMFACTOR_DEFINITIONS_1.return)) _f.call(FORMFACTOR_DEFINITIONS_1);
+        }
+        finally { if (e_6) throw e_6.error; }
+    }
+    // Note: [🔆] If formfactor is still not set, set it to 'GENERIC'
+    if ($pipelineJson.formfactorName === undefined) {
+        $pipelineJson.formfactorName = 'GENERIC';
+    }
     // =============================================================
     // TODO: [🍙] Maybe do reorder of `$pipelineJson` here
-    return $asDeeplyFrozenSerializableJson('pipelineJson', $pipelineJson);
+    return $asDeeplyFrozenSerializableJson('pipelineJson', __assign({ title: DEFAULT_TITLE, pipelineUrl: undefined, bookVersion: undefined, description: undefined, formfactorName: 'GENERIC', 
+        // <- Note: [🔆] Setting `formfactorName` is redundant to satisfy the typescript
+        parameters: [], tasks: [], knowledgeSources: [], knowledgePieces: [], personas: [], preparations: [] }, $pipelineJson));
 }
 /**
  * TODO: [main] !!!! Warn if used only sync version
@@ -10133,7 +10322,7 @@ function createCollectionFromDirectory(path, tools, options) {
                                                     return [3 /*break*/, 7];
                                                 case 6:
                                                     if (isVerbose) {
-                                                        console.info(colors.gray("Skipped file ".concat(fileName.split('\\').join('/'), " \u2013\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060 Not a pipeline")));
+                                                        console.info(colors.gray("Skipped file ".concat(fileName.split('\\').join('/'), " \u2013\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060\u2060 Not a book")));
                                                     }
                                                     _e.label = 7;
                                                 case 7:
@@ -10180,7 +10369,7 @@ function createCollectionFromDirectory(path, tools, options) {
                                                     if (!(error_1 instanceof Error)) {
                                                         throw error_1;
                                                     }
-                                                    wrappedErrorMessage = spaceTrim(function (block) { return "\n                        ".concat(error_1.name, " in pipeline ").concat(fileName.split('\\').join('/'), "\u2060:\n\n                        ").concat(block(error_1.message), "\n\n                    "); });
+                                                    wrappedErrorMessage = spaceTrim(function (block) { return "\n                        ".concat(error_1.name, " in pipeline ").concat(fileName.split('\\').join('/'), "\u2060:\n\n                        Original error message:\n                        ").concat(block(error_1.message), "\n\n                        Original stack trace:\n                        ").concat(block(error_1.stack || ''), "\n\n                        ---\n\n                    "); }) + '\n';
                                                     if (isCrashedOnError) {
                                                         throw new CollectionError(wrappedErrorMessage);
                                                     }