@promptbook/documents 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/documents`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -250,6 +254,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

@@ -23,7 +23,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
@@ -3499,6 +3499,30 @@ function extensionToMimeType(value) {
     return lookup(value) || 'application/octet-stream';
 }
 
+/**
+ * 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$1(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*/];
+        }
+    });
+}); };
+
 /**
  * @@@
  *
@@ -3507,13 +3531,14 @@ function extensionToMimeType(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);
                     }
@@ -3521,7 +3546,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,
@@ -3578,7 +3603,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$1(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`)
@@ -4615,7 +4640,7 @@ function extractJsonBlock(markdown) {
  * @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()) {
@@ -4641,7 +4666,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;
@@ -4893,7 +4918,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 || {}));
@@ -5016,8 +5041,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,
@@ -5141,7 +5166,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