@promptbook/cli 0.74.0-6 → 0.74.0-8

package/bin/promptbook-cli.js

@@ -1,4 +1,6 @@
-#!/usr/bin/env node
+#!/usr/bin/env node --no-warnings
+
+//                     <- TODO: !!!!!! Is this try to get rid of deprecation warnings in node v23.2.0 working?
 
 const { _CLI /* <- Note: [🥠] */ } = require('../umd/index.umd.js');
 

package/esm/index.es.js

@@ -1,6 +1,6 @@
+import colors from 'colors';
 import commander from 'commander';
 import spaceTrim$1, { spaceTrim } from 'spacetrim';
-import colors from 'colors';
 import { forTime } from 'waitasecond';
 import { stat, access, constants, readFile, writeFile, readdir, mkdir, unlink, rm, rmdir, rename } from 'fs/promises';
 import { join, basename, dirname } from 'path';
@@ -37,7 +37,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  *
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.74.0-5';
+var PROMPTBOOK_ENGINE_VERSION = '0.74.0-7';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  */
@@ -3199,10 +3199,12 @@ function countLines(text) {
  * @public exported from `@promptbook/utils`
  */
 function countPages(text) {
-    var sentencesPerPage = 5; // Assuming each page has 5 sentences
-    var sentences = text.split(/[.!?]+/).filter(function (sentence) { return sentence.trim() !== ''; });
-    var pageCount = Math.ceil(sentences.length / sentencesPerPage);
-    return pageCount;
+    if (text === '') {
+        return 0;
+    }
+    var pagesByLinesCount = Math.ceil(countLines(text) / 44);
+    var pagesByCharactersCount = Math.ceil(countCharacters(text) / 2772);
+    return Math.max(pagesByLinesCount, pagesByCharactersCount);
 }
 
 /**
@@ -7926,7 +7928,7 @@ function titleToName(value) {
  * @public exported from `@promptbook/core`
  */
 function pipelineStringToJsonSync(pipelineString) {
-    var e_1, _a, e_2, _b;
+    var e_1, _a, e_2, _b, e_3, _c, e_4, _d;
     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 */,
@@ -7953,11 +7955,18 @@ function pipelineStringToJsonSync(pipelineString) {
     }
     // =============================================================
     // Note: 1️⃣ Parsing of the markdown into object
+    if (pipelineString.startsWith('#!')) {
+        var _e = __read(pipelineString.split('\n')), shebangLine_1 = _e[0], restLines = _e.slice(1);
+        if (!(shebangLine_1 || '').includes('ptbk')) {
+            throw new ParseError(spaceTrim(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                    "); }));
+        }
+        pipelineString = restLines.join('\n');
+    }
     pipelineString = removeContentComments(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 _c = __read(splitMarkdownIntoSections(pipelineString).map(parseMarkdownSection)), pipelineHead = _c[0], pipelineSections = _c.slice(1); /* <- Note: [🥞] */
+    var _f = __read(splitMarkdownIntoSections(pipelineString).map(parseMarkdownSection)), pipelineHead = _f[0], pipelineSections = _f.slice(1); /* <- Note: [🥞] */
     if (pipelineHead === undefined) {
         throw new UnexpectedError(spaceTrim(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                "); }));
     }
@@ -7985,6 +7994,8 @@ function pipelineStringToJsonSync(pipelineString) {
             if (parameterDescription) {
                 existingParameter.description = parameterDescription;
             }
+            existingParameter.isInput = existingParameter.isInput || isInput;
+            existingParameter.isOutput = existingParameter.isOutput || isOutput;
         }
         else {
             $pipelineJson.parameters.push({
@@ -8047,10 +8058,10 @@ function pipelineStringToJsonSync(pipelineString) {
         finally { if (e_1) throw e_1.error; }
     }
     var _loop_2 = function (section) {
-        var e_3, _d;
+        var e_5, _l, e_6, _m;
         // TODO: Parse template description (the content out of the codeblock and lists)
         var listItems_2 = extractAllListItemsFromMarkdown(section.content);
-        var _e = extractOneBlockFromMarkdown(section.content), language = _e.language, content = _e.content;
+        var _o = extractOneBlockFromMarkdown(section.content), language = _o.language, content = _o.content;
         // TODO: [🎾][1] DRY description
         var description_1 = section.content;
         // Note: Remove codeblocks - TODO: [🎾]
@@ -8091,7 +8102,7 @@ function pipelineStringToJsonSync(pipelineString) {
         }) === false) {
             templateCommandParser.$applyToTemplateJson({ type: 'TEMPLATE', templateType: 'PROMPT_TEMPLATE' }, $templateJson, $pipelineJson);
         }
-        var _loop_3 = function (listItem, command) {
+        var _loop_4 = function (listItem, command) {
             var commandParser = getParserForCommand(command);
             if (commandParser.isUsedInPipelineTemplate !== true /* <- Note: [🦦][4] */) {
                 throw new ParseError(spaceTrim(function (block) { return "\n                            Command ".concat(command.type, " is not allowed in the template of the promptbook ONLY at the pipeline head\n\n                            ").concat(block(getPipelineIdentification()), "\n                        "); })); // <- TODO: [🚞]
@@ -8114,17 +8125,17 @@ function pipelineStringToJsonSync(pipelineString) {
         };
         try {
             // TODO [♓️] List commands and before apply order them to achieve order-agnostic commands
-            for (var commands_1 = (e_3 = void 0, __values(commands)), commands_1_1 = commands_1.next(); !commands_1_1.done; commands_1_1 = commands_1.next()) {
-                var _f = commands_1_1.value, listItem = _f.listItem, command = _f.command;
-                _loop_3(listItem, command);
+            for (var commands_1 = (e_5 = void 0, __values(commands)), commands_1_1 = commands_1.next(); !commands_1_1.done; commands_1_1 = commands_1.next()) {
+                var _p = commands_1_1.value, listItem = _p.listItem, command = _p.command;
+                _loop_4(listItem, command);
             }
         }
-        catch (e_3_1) { e_3 = { error: e_3_1 }; }
+        catch (e_5_1) { e_5 = { error: e_5_1 }; }
         finally {
             try {
-                if (commands_1_1 && !commands_1_1.done && (_d = commands_1.return)) _d.call(commands_1);
+                if (commands_1_1 && !commands_1_1.done && (_l = commands_1.return)) _l.call(commands_1);
             }
-            finally { if (e_3) throw e_3.error; }
+            finally { if (e_5) throw e_5.error; }
         }
         // TODO: [🍧] Should be done in TEMPLATE command
         if ($templateJson.templateType === 'SCRIPT_TEMPLATE') {
@@ -8138,6 +8149,26 @@ function pipelineStringToJsonSync(pipelineString) {
                 language;
         }
         $templateJson.dependentParameterNames = Array.from(extractParameterNamesFromTemplate($templateJson));
+        try {
+            for (var _q = (e_6 = void 0, __values($templateJson.dependentParameterNames)), _r = _q.next(); !_r.done; _r = _q.next()) {
+                var parameterName = _r.value;
+                // TODO: [🧠] This definition should be made first in the template
+                defineParam({
+                    parameterName: parameterName,
+                    parameterDescription: null,
+                    isInput: false,
+                    isOutput: false,
+                    // <- Note: In this case null+false+false means that we do not know yet if it is input or output and we will set it later
+                });
+            }
+        }
+        catch (e_6_1) { e_6 = { error: e_6_1 }; }
+        finally {
+            try {
+                if (_r && !_r.done && (_m = _q.return)) _m.call(_q);
+            }
+            finally { if (e_6) throw e_6.error; }
+        }
         /*
         // TODO: [🍧] This should be checked in `MODEL` command + better error message
         if ($templateJson.templateType !== 'PROMPT_TEMPLATE' && $templateJson.modelRequirements !== undefined) {
@@ -8179,9 +8210,51 @@ function pipelineStringToJsonSync(pipelineString) {
         finally { if (e_2) throw e_2.error; }
     }
     // =============================================================
-    // Note: 5️⃣ Cleanup of undefined values
+    // Note: 5️⃣ Mark parameters as INPUT if not explicitly set
+    if ($pipelineJson.parameters.every(function (parameter) { return !parameter.isInput; })) {
+        var _loop_3 = function (parameter) {
+            var isThisParameterResulting = $pipelineJson.templates.some(function (template) { return template.resultingParameterName === parameter.name; });
+            if (!isThisParameterResulting) {
+                parameter.isInput = true;
+            }
+        };
+        try {
+            for (var _g = __values($pipelineJson.parameters), _h = _g.next(); !_h.done; _h = _g.next()) {
+                var parameter = _h.value;
+                _loop_3(parameter);
+            }
+        }
+        catch (e_3_1) { e_3 = { error: e_3_1 }; }
+        finally {
+            try {
+                if (_h && !_h.done && (_c = _g.return)) _c.call(_g);
+            }
+            finally { if (e_3) throw e_3.error; }
+        }
+    }
+    // =============================================================
+    // Note: 6️⃣ 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 _j = __values($pipelineJson.parameters), _k = _j.next(); !_k.done; _k = _j.next()) {
+                var parameter = _k.value;
+                if (!parameter.isInput) {
+                    parameter.isOutput = true;
+                }
+            }
+        }
+        catch (e_4_1) { e_4 = { error: e_4_1 }; }
+        finally {
+            try {
+                if (_k && !_k.done && (_d = _j.return)) _d.call(_j);
+            }
+            finally { if (e_4) throw e_4.error; }
+        }
+    }
+    // =============================================================
+    // Note: 7️⃣ Cleanup of undefined values
     $pipelineJson.templates.forEach(function (templates) {
-        var e_4, _a;
+        var e_7, _a;
         try {
             for (var _b = __values(Object.entries(templates)), _c = _b.next(); !_c.done; _c = _b.next()) {
                 var _d = __read(_c.value, 2), key = _d[0], value = _d[1];
@@ -8190,16 +8263,16 @@ function pipelineStringToJsonSync(pipelineString) {
                 }
             }
         }
-        catch (e_4_1) { e_4 = { error: e_4_1 }; }
+        catch (e_7_1) { e_7 = { error: e_7_1 }; }
         finally {
             try {
                 if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
             }
-            finally { if (e_4) throw e_4.error; }
+            finally { if (e_7) throw e_7.error; }
         }
     });
     $pipelineJson.parameters.forEach(function (parameter) {
-        var e_5, _a;
+        var e_8, _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];
@@ -8208,12 +8281,12 @@ function pipelineStringToJsonSync(pipelineString) {
                 }
             }
         }
-        catch (e_5_1) { e_5 = { error: e_5_1 }; }
+        catch (e_8_1) { e_8 = { error: e_8_1 }; }
         finally {
             try {
                 if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
             }
-            finally { if (e_5) throw e_5.error; }
+            finally { if (e_8) throw e_8.error; }
         }
     });
     // =============================================================
@@ -10974,10 +11047,10 @@ function initializeRunCommand(program) {
     runCommand.option('-v, --verbose', "Is output verbose", false);
     runCommand.option('--no-interactive', "Input is not interactive", false);
     runCommand.option('-s, --save-report <path>', "Save report to file");
-    // TODO: !!!!!! Interactive mode
+    // TODO: !!!!!! Implement non-interactive mode - allow to pass input parameters as JSON
     // TODO: !!!!!! JSON output
     runCommand.action(function (filePathRaw, options) { return __awaiter(_this, void 0, void 0, function () {
-        var isCacheReloaded, isVerbose, saveReport, prepareAndScrapeOptions, fs, filePath, filePathCandidates, filePathCandidates_1, filePathCandidates_1_1, filePathCandidate, e_1_1, llm, executables, tools, pipelineString, pipeline, pipelineExecutor, questions, response, inputParameters, result, isSuccessful, errors, warnings, outputParameters, executionReport, executionReportString, _a, _b, error, _c, _d, warning, _e, _f, key, value, separator;
+        var isCacheReloaded, isVerbose, saveReport, prepareAndScrapeOptions, fs, filePath, filePathCandidates, filePathCandidates_1, filePathCandidates_1_1, filePathCandidate, e_1_1, llm, executables, tools, pipelineString, pipeline, error_1, pipelineExecutor, questions, response, inputParameters, result, isSuccessful, errors, warnings, outputParameters, executionReport, executionReportString, _a, _b, error, _c, _d, warning, _e, _f, key, value, separator;
         var e_1, _g, _h, e_2, _j, e_3, _k, e_4, _l;
         return __generator(this, function (_m) {
             switch (_m.label) {
@@ -11076,12 +11149,25 @@ function initializeRunCommand(program) {
                     if (isVerbose) {
                         console.info(colors.gray('--- Preparing pipeline ---'));
                     }
-                    return [4 /*yield*/, pipelineStringToJson(pipelineString, tools)];
+                    _m.label = 12;
                 case 12:
+                    _m.trys.push([12, 14, , 15]);
+                    return [4 /*yield*/, pipelineStringToJson(pipelineString, tools)];
+                case 13:
                     pipeline = _m.sent();
+                    return [3 /*break*/, 15];
+                case 14:
+                    error_1 = _m.sent();
+                    if (!(error_1 instanceof ParseError)) {
+                        throw error_1;
+                    }
+                    console.error(colors.red(spaceTrim$1(function (block) { return "\n                            ".concat(block(error_1.message), "\n\n                            in ").concat(filePath, "\n                        "); })));
+                    return [2 /*return*/, process.exit(1)];
+                case 15:
                     if (isVerbose) {
                         console.info(colors.gray('--- Validating pipeline ---'));
                     }
+                    // TODO: !!!!!! Same try-catch for LogicError
                     validatePipeline(pipeline);
                     if (isVerbose) {
                         console.info(colors.gray('--- Creating executor ---'));
@@ -11103,16 +11189,26 @@ function initializeRunCommand(program) {
                         return isInput;
                     })
                         .map(function (_a) {
-                        var name = _a.name;
-                        return ({
+                        var name = _a.name, exampleValues = _a.exampleValues;
+                        var message = name;
+                        var initial = '';
+                        if (exampleValues && exampleValues.length > 0) {
+                            var exampleValuesFiltered = exampleValues.filter(function (exampleValue) { return countLines(exampleValue) <= 1 && countCharacters(exampleValue) <= 30; });
+                            if (exampleValuesFiltered.length !== 0) {
+                                message += " (e.g. ".concat(exampleValuesFiltered.join(', '), ")");
+                            }
+                            initial = exampleValues[0] || '';
+                        }
+                        return {
                             type: 'text',
                             name: name,
-                            message: name,
+                            message: message,
+                            initial: initial,
                             // TODO: Maybe use> validate: value => value < 18 ? `Forbidden` : true
-                        });
+                        };
                     });
                     return [4 /*yield*/, prompts(questions)];
-                case 13:
+                case 16:
                     response = _m.sent();
                     inputParameters = response;
                     if (isVerbose) {
@@ -11124,26 +11220,26 @@ function initializeRunCommand(program) {
                                 console.info(taskProgress);
                             }
                         })];
-                case 14:
+                case 17:
                     result = _m.sent();
                     isSuccessful = result.isSuccessful, errors = result.errors, warnings = result.warnings, outputParameters = result.outputParameters, executionReport = result.executionReport;
                     if (isVerbose) {
                         console.info(colors.gray('--- Detailed Result ---'));
                         console.info({ isSuccessful: isSuccessful, errors: errors, warnings: warnings, outputParameters: outputParameters, executionReport: executionReport });
                     }
-                    if (!(saveReport && saveReport.endsWith('.json'))) return [3 /*break*/, 16];
+                    if (!(saveReport && saveReport.endsWith('.json'))) return [3 /*break*/, 19];
                     return [4 /*yield*/, writeFile(saveReport, JSON.stringify(executionReport, null, 4) + '\n', 'utf-8')];
-                case 15:
+                case 18:
                     _m.sent();
-                    return [3 /*break*/, 18];
-                case 16:
-                    if (!(saveReport && saveReport.endsWith('.md'))) return [3 /*break*/, 18];
+                    return [3 /*break*/, 21];
+                case 19:
+                    if (!(saveReport && saveReport.endsWith('.md'))) return [3 /*break*/, 21];
                     executionReportString = executionReportJsonToString(executionReport);
                     return [4 /*yield*/, writeFile(saveReport, executionReportString, 'utf-8')];
-                case 17:
+                case 20:
                     _m.sent();
-                    _m.label = 18;
-                case 18:
+                    _m.label = 21;
+                case 21:
                     if (saveReport && isVerbose) {
                         console.info(colors.green("Report saved to ".concat(saveReport)));
                     }
@@ -11337,11 +11433,16 @@ function initializeTestCommand(program) {
  */
 function promptbookCli() {
     return __awaiter(this, void 0, void 0, function () {
-        var program;
+        var isVerbose, program;
         return __generator(this, function (_a) {
             if (!$isRunningInNode()) {
                 throw new EnvironmentMismatchError(spaceTrim("\n                Function promptbookCli is initiator of CLI script and should be run in Node.js environment.\n\n                - In browser use function exported from `@promptbook/utils` or  `@promptbook/core` directly, for example `prettifyPipelineString`.\n\n            "));
             }
+            isVerbose = process.argv.some(function (arg) { return arg === '--verbose' || arg === '-v'; });
+            //     <- TODO: Can be this be done with commander before the commander commands are initialized?
+            if (isVerbose) {
+                console.info(colors.gray("Promptbook CLI version ".concat(PROMPTBOOK_ENGINE_VERSION, " in ").concat(__filename.split('\\').join('/'))));
+            }
             program = new commander.Command();
             program.name('promptbook');
             program.alias('ptbk');
@@ -13675,12 +13776,9 @@ function $execCommandNormalizeOptions(options) {
     })
         .filter(function (arg) { return arg !== ''; });
     if (_.length > 1) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         _a = __read(_), command = _a[0], args = _a.slice(1);
     }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     if (options.args) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         args = __spreadArray(__spreadArray([], __read(args), false), __read(options.args), false);
     }
     var humanReadableCommand = !['npx', 'npm'].includes(command) ? command : args[0];