@promptbook/node 0.75.6 → 0.75.9

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.75.5';
+var PROMPTBOOK_ENGINE_VERSION = '0.75.8';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -389,6 +389,12 @@ var IMMEDIATE_TIME = 10;
  * @public exported from `@promptbook/core`
  */
 var MAX_FILENAME_LENGTH = 30;
+/**
+ * Strategy for caching the intermediate results for knowledge sources
+ *
+ * @public exported from `@promptbook/core`
+ */
+var DEFAULT_INTERMEDIATE_FILES_STRATEGY = 'HIDE_AND_KEEP';
 //                                                     <- TODO: [😡] Change to 'VISIBLE'
 /**
  * The maximum number of (LLM) tasks running in parallel
@@ -402,6 +408,14 @@ var DEFAULT_MAX_PARALLEL_COUNT = 5; // <- TODO: [🤹‍♂️]
  * @public exported from `@promptbook/core`
  */
 var DEFAULT_MAX_EXECUTION_ATTEMPTS = 3; // <- TODO: [🤹‍♂️]
+/**
+ * Where to store the scrape cache
+ *
+ * Note: When the folder does not exist, it is created recursively
+ *
+ * @public exported from `@promptbook/core`
+ */
+var DEFAULT_SCRAPE_CACHE_DIRNAME = './.promptbook/scrape-cache';
 /**
  * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
  *
@@ -460,6 +474,12 @@ var DEFAULT_CSV_SETTINGS = Object.freeze({
  * @public exported from `@promptbook/core`
  */
 var DEFAULT_IS_VERBOSE = false;
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+var DEFAULT_IS_AUTO_INSTALLED = false;
 /**
  * @@@
  *
@@ -3990,12 +4010,12 @@ function getReservedParametersForTask(options) {
  */
 function executeTask(options) {
     return __awaiter(this, void 0, void 0, function () {
-        var currentTask, preparedPipeline, parametersToPass, tools, onProgress, $executionReport, pipelineIdentification, _a, maxExecutionAttempts, name, title, priority, usedParameterNames, dependentParameterNames, definedParameters, _b, _c, _d, definedParameterNames, parameters, _loop_1, _e, _f, parameterName, maxAttempts, jokerParameterNames, preparedContent, resultString;
-        var e_1, _g, _h;
-        return __generator(this, function (_j) {
-            switch (_j.label) {
+        var currentTask, preparedPipeline, parametersToPass, tools, onProgress, $executionReport, pipelineIdentification, maxExecutionAttempts, maxParallelCount, csvSettings, isVerbose, rootDirname, cacheDirname, intermediateFilesStrategy, isAutoInstalled, isNotPreparedWarningSupressed, name, title, priority, usedParameterNames, dependentParameterNames, definedParameters, _a, _b, _c, definedParameterNames, parameters, _loop_1, _d, _e, parameterName, maxAttempts, jokerParameterNames, preparedContent, resultString;
+        var e_1, _f, _g;
+        return __generator(this, function (_h) {
+            switch (_h.label) {
                 case 0:
-                    currentTask = options.currentTask, preparedPipeline = options.preparedPipeline, parametersToPass = options.parametersToPass, tools = options.tools, onProgress = options.onProgress, $executionReport = options.$executionReport, pipelineIdentification = options.pipelineIdentification, _a = options.maxExecutionAttempts, maxExecutionAttempts = _a === void 0 ? DEFAULT_MAX_EXECUTION_ATTEMPTS : _a;
+                    currentTask = options.currentTask, preparedPipeline = options.preparedPipeline, parametersToPass = options.parametersToPass, tools = options.tools, onProgress = options.onProgress, $executionReport = options.$executionReport, pipelineIdentification = options.pipelineIdentification, maxExecutionAttempts = options.maxExecutionAttempts, maxParallelCount = options.maxParallelCount, csvSettings = options.csvSettings, isVerbose = options.isVerbose, rootDirname = options.rootDirname, cacheDirname = options.cacheDirname, intermediateFilesStrategy = options.intermediateFilesStrategy, isAutoInstalled = options.isAutoInstalled, isNotPreparedWarningSupressed = options.isNotPreparedWarningSupressed;
                     name = "pipeline-executor-frame-".concat(currentTask.name);
                     title = currentTask.title;
                     priority = preparedPipeline.tasks.length - preparedPipeline.tasks.indexOf(currentTask);
@@ -4010,7 +4030,7 @@ function executeTask(options) {
                             // <- [🍸]
                         })];
                 case 1:
-                    _j.sent();
+                    _h.sent();
                     usedParameterNames = extractParameterNamesFromTask(currentTask);
                     dependentParameterNames = new Set(currentTask.dependentParameterNames);
                     // TODO: [👩🏾‍🤝‍👩🏻] Use here `mapAvailableToExpectedParameters`
@@ -4021,15 +4041,15 @@ function executeTask(options) {
                             .map(function (name) { return "{".concat(name, "}"); })
                             .join(', '), "\n\n                    ").concat(block(pipelineIdentification), "\n\n                "); }));
                     }
-                    _c = (_b = Object).freeze;
-                    _d = [{}];
+                    _b = (_a = Object).freeze;
+                    _c = [{}];
                     return [4 /*yield*/, getReservedParametersForTask({
                             preparedPipeline: preparedPipeline,
                             task: currentTask,
                             pipelineIdentification: pipelineIdentification,
                         })];
                 case 2:
-                    definedParameters = _c.apply(_b, [__assign.apply(void 0, [__assign.apply(void 0, _d.concat([(_j.sent())])), parametersToPass])]);
+                    definedParameters = _b.apply(_a, [__assign.apply(void 0, [__assign.apply(void 0, _c.concat([(_h.sent())])), parametersToPass])]);
                     definedParameterNames = new Set(Object.keys(definedParameters));
                     parameters = {};
                     _loop_1 = function (parameterName) {
@@ -4049,15 +4069,15 @@ function executeTask(options) {
                     try {
                         // Note: [2] Check that all used parameters are defined and removing unused parameters for this task
                         // TODO: [👩🏾‍🤝‍👩🏻] Use here `mapAvailableToExpectedParameters`
-                        for (_e = __values(Array.from(union(definedParameterNames, usedParameterNames, dependentParameterNames))), _f = _e.next(); !_f.done; _f = _e.next()) {
-                            parameterName = _f.value;
+                        for (_d = __values(Array.from(union(definedParameterNames, usedParameterNames, dependentParameterNames))), _e = _d.next(); !_e.done; _e = _d.next()) {
+                            parameterName = _e.value;
                             _loop_1(parameterName);
                         }
                     }
                     catch (e_1_1) { e_1 = { error: e_1_1 }; }
                     finally {
                         try {
-                            if (_f && !_f.done && (_g = _e.return)) _g.call(_e);
+                            if (_e && !_e.done && (_f = _d.return)) _f.call(_d);
                         }
                         finally { if (e_1) throw e_1.error; }
                     }
@@ -4077,9 +4097,18 @@ function executeTask(options) {
                             tools: tools,
                             $executionReport: $executionReport,
                             pipelineIdentification: pipelineIdentification,
+                            maxExecutionAttempts: maxExecutionAttempts,
+                            maxParallelCount: maxParallelCount,
+                            csvSettings: csvSettings,
+                            isVerbose: isVerbose,
+                            rootDirname: rootDirname,
+                            cacheDirname: cacheDirname,
+                            intermediateFilesStrategy: intermediateFilesStrategy,
+                            isAutoInstalled: isAutoInstalled,
+                            isNotPreparedWarningSupressed: isNotPreparedWarningSupressed,
                         })];
                 case 3:
-                    resultString = _j.sent();
+                    resultString = _h.sent();
                     return [4 /*yield*/, onProgress({
                             name: name,
                             title: title,
@@ -4091,12 +4120,12 @@ function executeTask(options) {
                             // <- [🍸]
                         })];
                 case 4:
-                    _j.sent();
-                    return [2 /*return*/, Object.freeze((_h = {},
-                            _h[currentTask.resultingParameterName] = 
+                    _h.sent();
+                    return [2 /*return*/, Object.freeze((_g = {},
+                            _g[currentTask.resultingParameterName] = 
                             // <- Note: [👩‍👩‍👧] No need to detect parameter collision here because pipeline checks logic consistency during construction
                             resultString,
-                            _h))];
+                            _g))];
             }
         });
     });
@@ -4155,12 +4184,12 @@ function filterJustOutputParameters(options) {
  */
 function executePipeline(options) {
     return __awaiter(this, void 0, void 0, function () {
-        var inputParameters, tools, onProgress, pipeline, setPreparedPipeline, pipelineIdentification, maxParallelCount, rootDirname, _a, isVerbose, preparedPipeline, errors, warnings, executionReport, isReturned, _b, _c, parameter, e_1_1, _loop_1, _d, _e, parameterName, state_1, e_2_1, parametersToPass, resovedParameterNames_1, unresovedTasks_1, resolving_1, loopLimit, _loop_2, error_1, usage_1, outputParameters_1, usage, outputParameters;
-        var e_1, _f, e_2, _g;
-        return __generator(this, function (_h) {
-            switch (_h.label) {
+        var inputParameters, tools, onProgress, pipeline, setPreparedPipeline, pipelineIdentification, maxParallelCount, rootDirname, isVerbose, preparedPipeline, errors, warnings, executionReport, isReturned, _a, _b, parameter, e_1_1, _loop_1, _c, _d, parameterName, state_1, e_2_1, parametersToPass, resovedParameterNames_1, unresovedTasks_1, resolving_1, loopLimit, _loop_2, error_1, usage_1, outputParameters_1, usage, outputParameters;
+        var e_1, _e, e_2, _f;
+        return __generator(this, function (_g) {
+            switch (_g.label) {
                 case 0:
-                    inputParameters = options.inputParameters, tools = options.tools, onProgress = options.onProgress, pipeline = options.pipeline, setPreparedPipeline = options.setPreparedPipeline, pipelineIdentification = options.pipelineIdentification, maxParallelCount = options.maxParallelCount, rootDirname = options.rootDirname, _a = options.isVerbose, isVerbose = _a === void 0 ? DEFAULT_IS_VERBOSE : _a;
+                    inputParameters = options.inputParameters, tools = options.tools, onProgress = options.onProgress, pipeline = options.pipeline, setPreparedPipeline = options.setPreparedPipeline, pipelineIdentification = options.pipelineIdentification, maxParallelCount = options.maxParallelCount, rootDirname = options.rootDirname, isVerbose = options.isVerbose;
                     preparedPipeline = options.preparedPipeline;
                     if (!(preparedPipeline === undefined)) return [3 /*break*/, 2];
                     return [4 /*yield*/, preparePipeline(pipeline, tools, {
@@ -4169,9 +4198,9 @@ function executePipeline(options) {
                             maxParallelCount: maxParallelCount,
                         })];
                 case 1:
-                    preparedPipeline = _h.sent();
+                    preparedPipeline = _g.sent();
                     setPreparedPipeline(preparedPipeline);
-                    _h.label = 2;
+                    _g.label = 2;
                 case 2:
                     errors = [];
                     warnings = [];
@@ -4184,17 +4213,17 @@ function executePipeline(options) {
                         promptExecutions: [],
                     };
                     isReturned = false;
-                    _h.label = 3;
+                    _g.label = 3;
                 case 3:
-                    _h.trys.push([3, 9, 10, 11]);
-                    _b = __values(preparedPipeline.parameters.filter(function (_a) {
+                    _g.trys.push([3, 9, 10, 11]);
+                    _a = __values(preparedPipeline.parameters.filter(function (_a) {
                         var isInput = _a.isInput;
                         return isInput;
-                    })), _c = _b.next();
-                    _h.label = 4;
+                    })), _b = _a.next();
+                    _g.label = 4;
                 case 4:
-                    if (!!_c.done) return [3 /*break*/, 8];
-                    parameter = _c.value;
+                    if (!!_b.done) return [3 /*break*/, 8];
+                    parameter = _b.value;
                     if (!(inputParameters[parameter.name] === undefined)) return [3 /*break*/, 7];
                     isReturned = true;
                     if (!(onProgress !== undefined)) return [3 /*break*/, 6];
@@ -4202,8 +4231,8 @@ function executePipeline(options) {
                     return [4 /*yield*/, forTime(IMMEDIATE_TIME)];
                 case 5:
                     // Note: Wait a short time to prevent race conditions
-                    _h.sent();
-                    _h.label = 6;
+                    _g.sent();
+                    _g.label = 6;
                 case 6: return [2 /*return*/, $asDeeplyFrozenSerializableJson("Unuccessful PipelineExecutorResult (with missing parameter {".concat(parameter.name, "}) PipelineExecutorResult"), {
                         isSuccessful: false,
                         errors: __spreadArray([
@@ -4216,24 +4245,24 @@ function executePipeline(options) {
                         preparedPipeline: preparedPipeline,
                     })];
                 case 7:
-                    _c = _b.next();
+                    _b = _a.next();
                     return [3 /*break*/, 4];
                 case 8: return [3 /*break*/, 11];
                 case 9:
-                    e_1_1 = _h.sent();
+                    e_1_1 = _g.sent();
                     e_1 = { error: e_1_1 };
                     return [3 /*break*/, 11];
                 case 10:
                     try {
-                        if (_c && !_c.done && (_f = _b.return)) _f.call(_b);
+                        if (_b && !_b.done && (_e = _a.return)) _e.call(_a);
                     }
                     finally { if (e_1) throw e_1.error; }
                     return [7 /*endfinally*/];
                 case 11:
                     _loop_1 = function (parameterName) {
                         var parameter;
-                        return __generator(this, function (_j) {
-                            switch (_j.label) {
+                        return __generator(this, function (_h) {
+                            switch (_h.label) {
                                 case 0:
                                     parameter = preparedPipeline.parameters.find(function (_a) {
                                         var name = _a.name;
@@ -4250,8 +4279,8 @@ function executePipeline(options) {
                                     return [4 /*yield*/, forTime(IMMEDIATE_TIME)];
                                 case 2:
                                     // Note: Wait a short time to prevent race conditions
-                                    _j.sent();
-                                    _j.label = 3;
+                                    _h.sent();
+                                    _h.label = 3;
                                 case 3: return [2 /*return*/, { value: $asDeeplyFrozenSerializableJson(spaceTrim(function (block) { return "\n                        Unuccessful PipelineExecutorResult (with extra parameter {".concat(parameter.name, "}) PipelineExecutorResult\n\n                        ").concat(block(pipelineIdentification), "\n                    "); }), {
                                             isSuccessful: false,
                                             errors: __spreadArray([
@@ -4267,39 +4296,39 @@ function executePipeline(options) {
                             }
                         });
                     };
-                    _h.label = 12;
+                    _g.label = 12;
                 case 12:
-                    _h.trys.push([12, 17, 18, 19]);
-                    _d = __values(Object.keys(inputParameters)), _e = _d.next();
-                    _h.label = 13;
+                    _g.trys.push([12, 17, 18, 19]);
+                    _c = __values(Object.keys(inputParameters)), _d = _c.next();
+                    _g.label = 13;
                 case 13:
-                    if (!!_e.done) return [3 /*break*/, 16];
-                    parameterName = _e.value;
+                    if (!!_d.done) return [3 /*break*/, 16];
+                    parameterName = _d.value;
                     return [5 /*yield**/, _loop_1(parameterName)];
                 case 14:
-                    state_1 = _h.sent();
+                    state_1 = _g.sent();
                     if (typeof state_1 === "object")
                         return [2 /*return*/, state_1.value];
-                    _h.label = 15;
+                    _g.label = 15;
                 case 15:
-                    _e = _d.next();
+                    _d = _c.next();
                     return [3 /*break*/, 13];
                 case 16: return [3 /*break*/, 19];
                 case 17:
-                    e_2_1 = _h.sent();
+                    e_2_1 = _g.sent();
                     e_2 = { error: e_2_1 };
                     return [3 /*break*/, 19];
                 case 18:
                     try {
-                        if (_e && !_e.done && (_g = _d.return)) _g.call(_d);
+                        if (_d && !_d.done && (_f = _c.return)) _f.call(_c);
                     }
                     finally { if (e_2) throw e_2.error; }
                     return [7 /*endfinally*/];
                 case 19:
                     parametersToPass = inputParameters;
-                    _h.label = 20;
+                    _g.label = 20;
                 case 20:
-                    _h.trys.push([20, 25, , 28]);
+                    _g.trys.push([20, 25, , 28]);
                     resovedParameterNames_1 = preparedPipeline.parameters
                         .filter(function (_a) {
                         var isInput = _a.isInput;
@@ -4314,8 +4343,8 @@ function executePipeline(options) {
                     loopLimit = LOOP_LIMIT;
                     _loop_2 = function () {
                         var currentTask, work_1;
-                        return __generator(this, function (_k) {
-                            switch (_k.label) {
+                        return __generator(this, function (_j) {
+                            switch (_j.label) {
                                 case 0:
                                     if (loopLimit-- < 0) {
                                         // Note: Really UnexpectedError not LimitReachedError - this should be catched during validatePipeline
@@ -4351,7 +4380,7 @@ function executePipeline(options) {
                                     if (!!currentTask) return [3 /*break*/, 3];
                                     /* [🤹‍♂️] */ return [4 /*yield*/, Promise.race(resolving_1)];
                                 case 2:
-                                    /* [🤹‍♂️] */ _k.sent();
+                                    /* [🤹‍♂️] */ _j.sent();
                                     return [3 /*break*/, 4];
                                 case 3:
                                     unresovedTasks_1 = unresovedTasks_1.filter(function (task) { return task !== currentTask; });
@@ -4376,24 +4405,24 @@ function executePipeline(options) {
                                     // <- Note: Errors are catched here [3]
                                     //    TODO: BUT if in multiple tasks are errors, only the first one is catched so maybe we should catch errors here and save them to errors array here
                                     resolving_1.push(work_1);
-                                    _k.label = 4;
+                                    _j.label = 4;
                                 case 4: return [2 /*return*/];
                             }
                         });
                     };
-                    _h.label = 21;
+                    _g.label = 21;
                 case 21:
                     if (!(unresovedTasks_1.length > 0)) return [3 /*break*/, 23];
                     return [5 /*yield**/, _loop_2()];
                 case 22:
-                    _h.sent();
+                    _g.sent();
                     return [3 /*break*/, 21];
                 case 23: return [4 /*yield*/, Promise.all(resolving_1)];
                 case 24:
-                    _h.sent();
+                    _g.sent();
                     return [3 /*break*/, 28];
                 case 25:
-                    error_1 = _h.sent();
+                    error_1 = _g.sent();
                     if (!(error_1 instanceof Error)) {
                         throw error_1;
                     }
@@ -4413,8 +4442,8 @@ function executePipeline(options) {
                     return [4 /*yield*/, forTime(IMMEDIATE_TIME)];
                 case 26:
                     // Note: Wait a short time to prevent race conditions
-                    _h.sent();
-                    _h.label = 27;
+                    _g.sent();
+                    _g.label = 27;
                 case 27: return [2 /*return*/, $asDeeplyFrozenSerializableJson('Unuccessful PipelineExecutorResult (with misc errors) PipelineExecutorResult', {
                         isSuccessful: false,
                         errors: __spreadArray([error_1], __read(errors), false).map(serializeError),
@@ -4441,8 +4470,8 @@ function executePipeline(options) {
                     return [4 /*yield*/, forTime(IMMEDIATE_TIME)];
                 case 29:
                     // Note: Wait a short time to prevent race conditions
-                    _h.sent();
-                    _h.label = 30;
+                    _g.sent();
+                    _g.label = 30;
                 case 30: return [2 /*return*/, $asDeeplyFrozenSerializableJson('Successful PipelineExecutorResult', {
                         isSuccessful: true,
                         errors: errors.map(serializeError),
@@ -4469,7 +4498,7 @@ function executePipeline(options) {
  */
 function createPipelineExecutor(options) {
     var _this = this;
-    var pipeline = options.pipeline, tools = options.tools, _a = options.maxExecutionAttempts, maxExecutionAttempts = _a === void 0 ? DEFAULT_MAX_EXECUTION_ATTEMPTS : _a, _b = options.maxParallelCount, maxParallelCount = _b === void 0 ? DEFAULT_MAX_PARALLEL_COUNT : _b, _c = options.csvSettings, csvSettings = _c === void 0 ? DEFAULT_CSV_SETTINGS : _c, _d = options.isVerbose, isVerbose = _d === void 0 ? DEFAULT_IS_VERBOSE : _d, _e = options.isNotPreparedWarningSupressed, isNotPreparedWarningSupressed = _e === void 0 ? false : _e, _f = options.rootDirname, rootDirname = _f === void 0 ? null : _f;
+    var pipeline = options.pipeline, tools = options.tools, _a = options.maxExecutionAttempts, maxExecutionAttempts = _a === void 0 ? DEFAULT_MAX_EXECUTION_ATTEMPTS : _a, _b = options.maxParallelCount, maxParallelCount = _b === void 0 ? DEFAULT_MAX_PARALLEL_COUNT : _b, _c = options.csvSettings, csvSettings = _c === void 0 ? DEFAULT_CSV_SETTINGS : _c, _d = options.isVerbose, isVerbose = _d === void 0 ? DEFAULT_IS_VERBOSE : _d, _e = options.isNotPreparedWarningSupressed, isNotPreparedWarningSupressed = _e === void 0 ? false : _e, _f = options.cacheDirname, cacheDirname = _f === void 0 ? DEFAULT_SCRAPE_CACHE_DIRNAME : _f, _g = options.intermediateFilesStrategy, intermediateFilesStrategy = _g === void 0 ? DEFAULT_INTERMEDIATE_FILES_STRATEGY : _g, _h = options.isAutoInstalled, isAutoInstalled = _h === void 0 ? DEFAULT_IS_AUTO_INSTALLED : _h, _j = options.rootDirname, rootDirname = _j === void 0 ? null : _j;
     validatePipeline(pipeline);
     var pipelineIdentification = (function () {
         // Note: This is a 😐 implementation of [🚞]
@@ -4509,6 +4538,9 @@ function createPipelineExecutor(options) {
                     isVerbose: isVerbose,
                     isNotPreparedWarningSupressed: isNotPreparedWarningSupressed,
                     rootDirname: rootDirname,
+                    cacheDirname: cacheDirname,
+                    intermediateFilesStrategy: intermediateFilesStrategy,
+                    isAutoInstalled: isAutoInstalled,
                 })];
         });
     }); };