@promptbook/cli 0.80.0 → 0.81.0-5

package/README.md

@@ -23,6 +23,10 @@
 
 
 
+<blockquote style="color: #ff8811">
+    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
+</blockquote>
+
 ## 📦 Package `@promptbook/cli`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -304,6 +308,8 @@ Or you can install them separately:
 -   **[@promptbook/documents](https://www.npmjs.com/package/@promptbook/documents)** - Read knowledge from documents like `.docx`, `.odt`,…
 -   **[@promptbook/legacy-documents](https://www.npmjs.com/package/@promptbook/legacy-documents)** - Read knowledge from legacy documents like `.doc`, `.rtf`,…
 -   **[@promptbook/website-crawler](https://www.npmjs.com/package/@promptbook/website-crawler)** - Crawl knowledge from the web
+-   **[@promptbook/editable](https://www.npmjs.com/package/@promptbook/editable)** - Editable book as native javascript object with imperative object API
+-   **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Usefull templates and examples of books which can be used as a starting point
 -   **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
 -   **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
 

package/esm/index.es.js

@@ -37,7 +37,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  *
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.80.0-1';
+var PROMPTBOOK_ENGINE_VERSION = '0.81.0-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
@@ -488,6 +488,40 @@ function $provideFilesystemForNode(options) {
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */
 
+/**
+ * Make error report URL for the given error
+ *
+ * @private !!!!!!
+ */
+function getErrorReportUrl(error) {
+    var report = {
+        title: "\uD83D\uDC1C Error report from ".concat(NAME),
+        body: spaceTrim(function (block) { return "\n\n\n            `".concat(error.name || 'Error', "` has occurred in the [").concat(NAME, "], please look into it @").concat(ADMIN_GITHUB_NAME, ".\n\n            ```\n            ").concat(block(error.message || '(no error message)'), "\n            ```\n\n\n            ## More info:\n\n            - **Promptbook engine version:** ").concat(PROMPTBOOK_ENGINE_VERSION, "\n            - **Book language version:** ").concat(BOOK_LANGUAGE_VERSION, "\n            - **Time:** ").concat(new Date().toISOString(), "\n\n            <details>\n            <summary>Stack trace:</summary>\n\n            ## Stack trace:\n\n            ```stacktrace\n            ").concat(block(error.stack || '(empty)'), "\n            ```\n            </details>\n\n        "); }),
+    };
+    var reportUrl = new URL("https://github.com/webgptorg/promptbook/issues/new");
+    reportUrl.searchParams.set('labels', 'bug');
+    reportUrl.searchParams.set('assignees', ADMIN_GITHUB_NAME);
+    reportUrl.searchParams.set('title', report.title);
+    reportUrl.searchParams.set('body', report.body);
+    return reportUrl;
+}
+
+/**
+ * This error type indicates that the error should not happen and its last check before crashing with some other error
+ *
+ * @public exported from `@promptbook/core`
+ */
+var UnexpectedError = /** @class */ (function (_super) {
+    __extends(UnexpectedError, _super);
+    function UnexpectedError(message) {
+        var _this = _super.call(this, spaceTrim$1(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This error should not happen.\n                    It's probbably a bug in the pipeline collection\n\n                    Please report issue:\n                    ").concat(block(getErrorReportUrl(new Error(message)).href), "\n\n                    Or contact us on ").concat(ADMIN_EMAIL, "\n\n                "); })) || this;
+        _this.name = 'UnexpectedError';
+        Object.setPrototypeOf(_this, UnexpectedError.prototype);
+        return _this;
+    }
+    return UnexpectedError;
+}(Error));
+
 /**
  * Orders JSON object by keys
  *
@@ -538,40 +572,6 @@ function $deepFreeze(objectValue) {
  * TODO: [🧠] Is there a way how to meaningfully test this utility
  */
 
-/**
- * Make error report URL for the given error
- *
- * @private !!!!!!
- */
-function getErrorReportUrl(error) {
-    var report = {
-        title: "\uD83D\uDC1C Error report from ".concat(NAME),
-        body: spaceTrim(function (block) { return "\n\n\n            `".concat(error.name || 'Error', "` has occurred in the [").concat(NAME, "], please look into it @").concat(ADMIN_GITHUB_NAME, ".\n\n            ```\n            ").concat(block(error.message || '(no error message)'), "\n            ```\n\n\n            ## More info:\n\n            - **Promptbook engine version:** ").concat(PROMPTBOOK_ENGINE_VERSION, "\n            - **Book language version:** ").concat(BOOK_LANGUAGE_VERSION, "\n            - **Time:** ").concat(new Date().toISOString(), "\n\n            <details>\n            <summary>Stack trace:</summary>\n\n            ## Stack trace:\n\n            ```stacktrace\n            ").concat(block(error.stack || '(empty)'), "\n            ```\n            </details>\n\n        "); }),
-    };
-    var reportUrl = new URL("https://github.com/webgptorg/promptbook/issues/new");
-    reportUrl.searchParams.set('labels', 'bug');
-    reportUrl.searchParams.set('assignees', ADMIN_GITHUB_NAME);
-    reportUrl.searchParams.set('title', report.title);
-    reportUrl.searchParams.set('body', report.body);
-    return reportUrl;
-}
-
-/**
- * This error type indicates that the error should not happen and its last check before crashing with some other error
- *
- * @public exported from `@promptbook/core`
- */
-var UnexpectedError = /** @class */ (function (_super) {
-    __extends(UnexpectedError, _super);
-    function UnexpectedError(message) {
-        var _this = _super.call(this, spaceTrim$1(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This error should not happen.\n                    It's probbably a bug in the pipeline collection\n\n                    Please report issue:\n                    ").concat(block(getErrorReportUrl(new Error(message)).href), "\n\n                    Or contact us on ").concat(ADMIN_EMAIL, "\n\n                "); })) || this;
-        _this.name = 'UnexpectedError';
-        Object.setPrototypeOf(_this, UnexpectedError.prototype);
-        return _this;
-    }
-    return UnexpectedError;
-}(Error));
-
 /**
  * Checks if the value is [🚉] serializable as JSON
  * If not, throws an UnexpectedError with a rich error message and tracking
@@ -854,7 +854,7 @@ function isSerializableAsJson(value) {
  * Note: [0] It can be used for more JSON types like whole collection of pipelines, single knowledge piece, etc.
  * Note: In contrast to JSON.stringify, this function ensures that **embedding index** is on single line
  *
- * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/editable`
  */
 function stringifyPipelineJson(pipeline) {
     if (!isSerializableAsJson(pipeline)) {
@@ -4590,7 +4590,7 @@ function arrayableToArray(input) {
  * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
  * @public exported from `@promptbook/utils`
  */
-function replaceParameters(template, parameters) {
+function templateParameters(template, parameters) {
     var e_1, _a;
     try {
         for (var _b = __values(Object.entries(parameters)), _c = _b.next(); !_c.done; _c = _b.next()) {
@@ -4616,7 +4616,7 @@ function replaceParameters(template, parameters) {
     var loopLimit = LOOP_LIMIT;
     var _loop_1 = function () {
         if (loopLimit-- < 0) {
-            throw new LimitReachedError('Loop limit reached during parameters replacement in `replaceParameters`');
+            throw new LimitReachedError('Loop limit reached during parameters replacement in `templateParameters`');
         }
         var precol = match.groups.precol;
         var parameterName = match.groups.parameterName;
@@ -4868,7 +4868,7 @@ function executeAttempts(options) {
                                     }
                                     return [3 /*break*/, 24];
                                 case 2:
-                                    $ongoingTaskResult.$resultString = replaceParameters(preparedContent, parameters);
+                                    $ongoingTaskResult.$resultString = templateParameters(preparedContent, parameters);
                                     return [3 /*break*/, 25];
                                 case 3:
                                     modelRequirements = __assign(__assign({ modelVariant: 'CHAT' }, (preparedPipeline.defaultModelRequirements || {})), (task.modelRequirements || {}));
@@ -4991,8 +4991,8 @@ function executeAttempts(options) {
                                     _j = $ongoingTaskResult;
                                     return [4 /*yield*/, tools.userInterface.promptDialog($deepFreeze({
                                             promptTitle: task.title,
-                                            promptMessage: replaceParameters(task.description || '', parameters),
-                                            defaultValue: replaceParameters(preparedContent, parameters),
+                                            promptMessage: templateParameters(task.description || '', parameters),
+                                            defaultValue: templateParameters(preparedContent, parameters),
                                             // TODO: [🧠] !! Figure out how to define placeholder in .book.md file
                                             placeholder: undefined,
                                             priority: priority,
@@ -5116,7 +5116,7 @@ function executeAttempts(options) {
                                     if (!isJokerAttempt &&
                                         task.taskType === 'PROMPT_TASK' &&
                                         $ongoingTaskResult.$prompt
-                                    //    <- Note:  [2] When some expected parameter is not defined, error will occur in replaceParameters
+                                    //    <- Note:  [2] When some expected parameter is not defined, error will occur in templateParameters
                                     //              In that case we don’t want to make a report about it because it’s not a llm execution error
                                     ) {
                                         // TODO: [🧠] Maybe put other taskTypes into report
@@ -6180,6 +6180,30 @@ function getFileExtension(value) {
     return match ? match[1].toLowerCase() : null;
 }
 
+/**
+ * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
+ *
+ * @private as default `fetch` function used in Promptbook scrapers
+ */
+var scraperFetch = function (url, init) { return __awaiter(void 0, void 0, void 0, function () {
+    var error_1;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                _a.trys.push([0, 2, , 3]);
+                return [4 /*yield*/, fetch(url, init)];
+            case 1: return [2 /*return*/, _a.sent()];
+            case 2:
+                error_1 = _a.sent();
+                if (!(error_1 instanceof Error)) {
+                    throw error_1;
+                }
+                throw new KnowledgeScrapeError(spaceTrim(function (block) { return "\n                    Can not fetch \"".concat(url, "\"\n\n                    Fetch error:\n                    ").concat(block(error_1.message), "\n\n                "); }));
+            case 3: return [2 /*return*/];
+        }
+    });
+}); };
+
 /**
  * @@@
  *
@@ -6188,13 +6212,14 @@ function getFileExtension(value) {
 function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
     var _a;
     return __awaiter(this, void 0, void 0, function () {
-        var sourceContent, name, _b, _c, rootDirname, url, response_1, mimeType, filename_1, fileExtension, mimeType;
-        return __generator(this, function (_e) {
-            switch (_e.label) {
+        var _b, fetch, sourceContent, name, _c, _d, rootDirname, url, response_1, mimeType, filename_1, fileExtension, mimeType;
+        return __generator(this, function (_f) {
+            switch (_f.label) {
                 case 0:
+                    _b = tools.fetch, fetch = _b === void 0 ? scraperFetch : _b;
                     sourceContent = knowledgeSource.sourceContent;
                     name = knowledgeSource.name;
-                    _b = options || {}, _c = _b.rootDirname, rootDirname = _c === void 0 ? null : _c, _b.isVerbose;
+                    _c = options || {}, _d = _c.rootDirname, rootDirname = _d === void 0 ? null : _d, _c.isVerbose;
                     if (!name) {
                         name = sourceContentToName(sourceContent);
                     }
@@ -6202,7 +6227,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
                     url = sourceContent;
                     return [4 /*yield*/, fetch(url)];
                 case 1:
-                    response_1 = _e.sent();
+                    response_1 = _f.sent();
                     mimeType = ((_a = response_1.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.split(';')[0]) || 'text/html';
                     return [2 /*return*/, {
                             source: name,
@@ -6259,7 +6284,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
                     mimeType = extensionToMimeType(fileExtension || '');
                     return [4 /*yield*/, isFileExisting(filename_1, tools.fs)];
                 case 3:
-                    if (!(_e.sent())) {
+                    if (!(_f.sent())) {
                         throw new NotFoundError(spaceTrim(function (block) { return "\n                          Can not make source handler for file which does not exist:\n\n                          File:\n                          ".concat(block(filename_1), "\n                      "); }));
                     }
                     // TODO: [🧠][😿] Test security file - file is scoped to the project (BUT maybe do this in `filesystemTools`)
@@ -13186,7 +13211,7 @@ var AnthropicClaudeExecutionTools = /** @class */ (function () {
                             throw new PipelineExecutionError('Use callChatModel only for CHAT variant');
                         }
                         modelName = modelRequirements.modelName || this.getDefaultChatModel().modelName;
-                        rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
+                        rawPromptContent = templateParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
                         rawRequest = {
                             model: modelRequirements.modelName || this.getDefaultChatModel().modelName,
                             max_tokens: modelRequirements.maxTokens || 4096,
@@ -13992,7 +14017,7 @@ var AzureOpenAiExecutionTools = /** @class */ (function () {
                             // <- TODO: [🈁] Use `seed` here AND/OR use is `isDeterministic` for entire execution tools
                             // <- Note: [🧆]
                         };
-                        rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
+                        rawPromptContent = templateParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
                         messages = __spreadArray(__spreadArray([], __read((modelRequirements.systemMessage === undefined
                             ? []
                             : [
@@ -14107,7 +14132,7 @@ var AzureOpenAiExecutionTools = /** @class */ (function () {
                             console.info(colors.bgWhite('content'), JSON.stringify(content, null, 4));
                             console.info(colors.bgWhite('parameters'), JSON.stringify(parameters, null, 4));
                         }
-                        rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
+                        rawPromptContent = templateParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
                         rawRequest = [
                             modelName,
                             [rawPromptContent],
@@ -14375,7 +14400,7 @@ function createExecutionToolsFromVercelProvider(options) {
                             return [4 /*yield*/, vercelProvider.chat(modelName, __assign({ user: (userId === null || userId === void 0 ? void 0 : userId.toString()) || undefined }, additionalChatSettings))];
                         case 1:
                             model = _b.sent();
-                            rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
+                            rawPromptContent = templateParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
                             rawRequest = {
                                 // <- TODO: [☂]
                                 inputFormat: 'messages',
@@ -14772,7 +14797,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
                                 type: 'json_object',
                             };
                         }
-                        rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
+                        rawPromptContent = templateParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
                         rawRequest = __assign(__assign({}, modelSettings), { messages: __spreadArray(__spreadArray([], __read((modelRequirements.systemMessage === undefined
                                 ? []
                                 : [
@@ -14868,7 +14893,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
                             // <- TODO: [🈁] Use `seed` here AND/OR use is `isDeterministic` for entire execution tools
                             // <- Note: [🧆]
                         };
-                        rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
+                        rawPromptContent = templateParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
                         rawRequest = __assign(__assign({}, modelSettings), { prompt: rawPromptContent, user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString() });
                         start = $getCurrentDate();
                         if (this.options.isVerbose) {
@@ -14940,7 +14965,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
                             throw new PipelineExecutionError('Use embed only for EMBEDDING variant');
                         }
                         modelName = modelRequirements.modelName || this.getDefaultEmbeddingModel().modelName;
-                        rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
+                        rawPromptContent = templateParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
                         rawRequest = {
                             input: rawPromptContent,
                             model: modelName,
@@ -15110,7 +15135,7 @@ var OpenAiAssistantExecutionTools = /** @class */ (function (_super) {
                             }
                             finally { if (e_1) throw e_1.error; }
                         }
-                        rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: 'assistant' }));
+                        rawPromptContent = templateParameters(content, __assign(__assign({}, parameters), { modelName: 'assistant' }));
                         rawRequest = {
                             // TODO: [👨‍👨‍👧‍👧] ...modelSettings,
                             // TODO: [👨‍👨‍👧‍👧][🧠] What about system message for assistants, does it make sence - combination of OpenAI assistants with Promptbook Personas