@promptbook/node 0.84.0-0 → 0.84.0-10

package/README.md

@@ -273,6 +273,7 @@ Or you can install them separately:
 -   **[@promptbook/remote-client](https://www.npmjs.com/package/@promptbook/remote-client)** - Remote client for remote execution of promptbooks
 -   **[@promptbook/remote-server](https://www.npmjs.com/package/@promptbook/remote-server)** - Remote server for remote execution of promptbooks
 -   **[@promptbook/pdf](https://www.npmjs.com/package/@promptbook/pdf)** - Read knowledge from `.pdf` documents
+-   **[@promptbook/documents](https://www.npmjs.com/package/@promptbook/markitdown)** - Integration of [Markitdown by Microsoft](https://github.com/microsoft/markitdown)
 -   **[@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

package/esm/index.es.js

@@ -9,8 +9,7 @@ import { unparse, parse } from 'papaparse';
 import { SHA256 } from 'crypto-js';
 import hexEncoder from 'crypto-js/enc-hex';
 import { lookup } from 'mime-types';
-import { exec as exec$2, spawn } from 'child_process';
-import { promisify } from 'util';
+import { spawn } from 'child_process';
 import * as dotenv from 'dotenv';
 import sha256 from 'crypto-js/sha256';
 
@@ -28,7 +27,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.83.0';
+var PROMPTBOOK_ENGINE_VERSION = '0.84.0-9';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -186,7 +185,7 @@ var NAME = "Promptbook";
  *
  * @public exported from `@promptbook/core`
  */
-var ADMIN_EMAIL = 'me@pavolhejny.com';
+var ADMIN_EMAIL = 'pavol@ptbk.io';
 /**
  * Name of the responsible person for the Promptbook on GitHub
  *
@@ -917,7 +916,7 @@ var ORDER_OF_PIPELINE_JSON = [
  *
  * @private within the repository
  */
-var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
+var REPLACING_NONCE = 'ptbkauk42kV2dzao34faw7FudQUHYPtW';
 /**
  * @@@
  *
@@ -1760,7 +1759,7 @@ var LimitReachedError = /** @class */ (function (_super) {
 var NotYetImplementedError = /** @class */ (function (_super) {
     __extends(NotYetImplementedError, _super);
     function NotYetImplementedError(message) {
-        var _this = _super.call(this, spaceTrim$1(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This feature is not implemented yet but it will be soon.\n\n                    If you want speed up the implementation or just read more, look here:\n                    https://github.com/webgptorg/promptbook\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
+        var _this = _super.call(this, spaceTrim$1(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This feature is not implemented yet but it will be soon.\n\n                    If you want speed up the implementation or just read more, look here:\n                    https://github.com/webgptorg/promptbook\n\n                    Or contact us on pavol@ptbk.io\n\n                "); })) || this;
         _this.name = 'NotYetImplementedError';
         Object.setPrototypeOf(_this, NotYetImplementedError.prototype);
         return _this;
@@ -9427,30 +9426,187 @@ function compilePipeline(pipelineString, tools, options) {
  */
 var $isRunningInNode = new Function("\n    try {\n        return this === global;\n    } catch (e) {\n        return false;\n    }\n");
 
-// Note: We want to use the `exec` as async function
-var exec$1 = promisify(exec$2);
+/**
+ * Normalize options for `execCommand` and `execCommands`
+ *
+ * Note: `$` is used to indicate that this function behaves differently according to `process.platform`
+ *
+ * @private internal utility of `execCommand` and `execCommands`
+ */
+function $execCommandNormalizeOptions(options) {
+    var _a;
+    var _b, _c, _d, _e;
+    var command;
+    var cwd;
+    var crashOnError;
+    var args = [];
+    var timeout;
+    var isVerbose;
+    if (typeof options === 'string') {
+        // TODO: [1] DRY default values
+        command = options;
+        cwd = process.cwd();
+        crashOnError = true;
+        timeout = Infinity; // <- TODO: [⏳]
+        isVerbose = DEFAULT_IS_VERBOSE;
+    }
+    else {
+        /*
+        TODO:
+        if ((options as any).commands !== undefined) {
+            commands = (options as any).commands;
+        } else {
+            commands = [(options as any).command];
+        }
+        */
+        // TODO: [1] DRY default values
+        command = options.command;
+        cwd = (_b = options.cwd) !== null && _b !== void 0 ? _b : process.cwd();
+        crashOnError = (_c = options.crashOnError) !== null && _c !== void 0 ? _c : true;
+        timeout = (_d = options.timeout) !== null && _d !== void 0 ? _d : Infinity;
+        isVerbose = (_e = options.isVerbose) !== null && _e !== void 0 ? _e : DEFAULT_IS_VERBOSE;
+    }
+    // TODO: /(-[a-zA-Z0-9-]+\s+[^\s]*)|[^\s]*/g
+    var _ = Array.from(command.matchAll(/(".*")|([^\s]*)/g))
+        .map(function (_a) {
+        var _b = __read(_a, 1), match = _b[0];
+        return match;
+    })
+        .filter(function (arg) { return arg !== ''; });
+    if (_.length > 1) {
+        _a = __read(_), command = _a[0], args = _a.slice(1);
+    }
+    if (options.args) {
+        args = __spreadArray(__spreadArray([], __read(args), false), __read(options.args), false);
+    }
+    var humanReadableCommand = !['npx', 'npm'].includes(command) ? command : args[0];
+    if (['ts-node'].includes(humanReadableCommand)) {
+        humanReadableCommand += " ".concat(args[1]);
+    }
+    if (/^win/.test(process.platform) && ['npm', 'npx'].includes(command)) {
+        command = "".concat(command, ".cmd");
+    }
+    return { command: command, humanReadableCommand: humanReadableCommand, args: args, cwd: cwd, crashOnError: crashOnError, timeout: timeout, isVerbose: isVerbose };
+}
+// TODO: This should show type error> execCommandNormalizeOptions({ command: '', commands: [''] });
+
+/**
+ * Run one command in a shell
+ *
+ *
+ * Note: There are 2 similar functions in the codebase:
+ * - `$execCommand` which runs a single command
+ * - `$execCommands` which runs multiple commands
+ * Note: `$` is used to indicate that this function is not a pure function - it runs a command in a shell
+ *
+ * @public exported from `@promptbook/node`
+ */
+function $execCommand(options) {
+    if (!$isRunningInNode()) {
+        throw new EnvironmentMismatchError('Function `$execCommand` can run only in Node environment.js');
+    }
+    return new Promise(function (resolve, reject) {
+        // eslint-disable-next-line prefer-const
+        var _a = $execCommandNormalizeOptions(options), command = _a.command, humanReadableCommand = _a.humanReadableCommand, args = _a.args, cwd = _a.cwd, crashOnError = _a.crashOnError, timeout = _a.timeout, _b = _a.isVerbose, isVerbose = _b === void 0 ? DEFAULT_IS_VERBOSE : _b;
+        if (timeout !== Infinity) {
+            // TODO: In waitasecond forTime(Infinity) should be equivalent to forEver()
+            forTime(timeout).then(function () {
+                if (crashOnError) {
+                    reject(new Error("Command \"".concat(humanReadableCommand, "\" exceeded time limit of ").concat(timeout, "ms")));
+                }
+                else {
+                    console.warn("Command \"".concat(humanReadableCommand, "\" exceeded time limit of ").concat(timeout, "ms but continues running"));
+                    resolve('Command exceeded time limit');
+                }
+            });
+        }
+        if (isVerbose) {
+            console.info(colors.yellow(cwd) + ' ' + colors.green(command) + ' ' + colors.blue(args.join(' ')));
+        }
+        try {
+            var commandProcess = spawn(command, args, { cwd: cwd, shell: true });
+            if (isVerbose) {
+                commandProcess.on('message', function (message) {
+                    console.info({ message: message });
+                });
+            }
+            var output_1 = [];
+            commandProcess.stdout.on('data', function (stdout) {
+                output_1.push(stdout.toString());
+                if (isVerbose) {
+                    console.info(stdout.toString());
+                }
+            });
+            commandProcess.stderr.on('data', function (stderr) {
+                output_1.push(stderr.toString());
+                if (isVerbose && stderr.toString().trim()) {
+                    console.warn(stderr.toString());
+                }
+            });
+            var finishWithCode = function (code) {
+                if (code !== 0) {
+                    if (crashOnError) {
+                        reject(new Error(output_1.join('\n').trim() ||
+                            "Command \"".concat(humanReadableCommand, "\" exited with code ").concat(code)));
+                    }
+                    else {
+                        if (isVerbose) {
+                            console.warn("Command \"".concat(humanReadableCommand, "\" exited with code ").concat(code));
+                        }
+                        resolve(spaceTrim$1(output_1.join('\n')));
+                    }
+                }
+                else {
+                    resolve(spaceTrim$1(output_1.join('\n')));
+                }
+            };
+            commandProcess.on('close', finishWithCode);
+            commandProcess.on('exit', finishWithCode);
+            commandProcess.on('disconnect', function () {
+                // Note: Unexpected disconnection should always result in rejection
+                reject(new Error("Command \"".concat(humanReadableCommand, "\" disconnected")));
+            });
+            commandProcess.on('error', function (error) {
+                if (crashOnError) {
+                    reject(new Error("Command \"".concat(humanReadableCommand, "\" failed: \n").concat(error.message)));
+                }
+                else {
+                    if (isVerbose) {
+                        console.warn(error);
+                    }
+                    resolve(spaceTrim$1(output_1.join('\n')));
+                }
+            });
+        }
+        catch (error) {
+            // Note: Unexpected error in sync code should always result in rejection
+            reject(error);
+        }
+    });
+}
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */
+
 /**
  * @@@
  *
  * @private within the repository
  */
 function locateAppOnLinux(_a) {
-    var appName = _a.appName, linuxWhich = _a.linuxWhich;
+    var linuxWhich = _a.linuxWhich;
     return __awaiter(this, void 0, void 0, function () {
-        var _b, stderr, stdout, error_1;
-        return __generator(this, function (_c) {
-            switch (_c.label) {
+        var result, error_1;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
                 case 0:
-                    _c.trys.push([0, 2, , 3]);
-                    return [4 /*yield*/, exec$1("which ".concat(linuxWhich))];
+                    _b.trys.push([0, 2, , 3]);
+                    return [4 /*yield*/, $execCommand({ crashOnError: true, command: "which ".concat(linuxWhich) })];
                 case 1:
-                    _b = _c.sent(), stderr = _b.stderr, stdout = _b.stdout;
-                    if (!stderr && stdout) {
-                        return [2 /*return*/, stdout.trim()];
-                    }
-                    throw new Error("Can not locate app ".concat(appName, " on Linux.\n ").concat(stderr));
+                    result = _b.sent();
+                    return [2 /*return*/, result.trim()];
                 case 2:
-                    error_1 = _c.sent();
+                    error_1 = _b.sent();
                     if (!(error_1 instanceof Error)) {
                         throw error_1;
                     }
@@ -9520,43 +9676,41 @@ function isExecutable(path, fs) {
 //       @see https://stackoverflow.com/questions/37000981/how-to-import-node-module-in-typescript-without-type-definitions
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 var userhome = require('userhome');
-// Note: We want to use the `exec` as async function
-var exec = promisify(exec$2);
 /**
  * @@@
  *
  * @private within the repository
  */
 function locateAppOnMacOs(_a) {
-    var appName = _a.appName, macOsName = _a.macOsName;
+    var macOsName = _a.macOsName;
     return __awaiter(this, void 0, void 0, function () {
-        var toExec, regPath, altPath, _b, stderr, stdout, error_1;
-        return __generator(this, function (_c) {
-            switch (_c.label) {
+        var toExec, regPath, altPath, result, error_1;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
                 case 0:
-                    _c.trys.push([0, 6, , 7]);
+                    _b.trys.push([0, 6, , 7]);
                     toExec = "/Contents/MacOS/".concat(macOsName);
                     regPath = "/Applications/".concat(macOsName, ".app") + toExec;
                     altPath = userhome(regPath.slice(1));
                     return [4 /*yield*/, isExecutable(regPath, $provideFilesystemForNode())];
                 case 1:
-                    if (!_c.sent()) return [3 /*break*/, 2];
+                    if (!_b.sent()) return [3 /*break*/, 2];
                     return [2 /*return*/, regPath];
                 case 2: return [4 /*yield*/, isExecutable(altPath, $provideFilesystemForNode())];
                 case 3:
-                    if (_c.sent()) {
+                    if (_b.sent()) {
                         return [2 /*return*/, altPath];
                     }
-                    _c.label = 4;
-                case 4: return [4 /*yield*/, exec("mdfind 'kMDItemDisplayName == \"".concat(macOsName, "\" && kMDItemKind == Application'"))];
+                    _b.label = 4;
+                case 4: return [4 /*yield*/, $execCommand({
+                        crashOnError: true,
+                        command: "mdfind 'kMDItemDisplayName == \"".concat(macOsName, "\" && kMDItemKind == Application'"),
+                    })];
                 case 5:
-                    _b = _c.sent(), stderr = _b.stderr, stdout = _b.stdout;
-                    if (!stderr && stdout) {
-                        return [2 /*return*/, stdout.trim() + toExec];
-                    }
-                    throw new Error("Can not locate app ".concat(appName, " on macOS.\n ").concat(stderr));
+                    result = _b.sent();
+                    return [2 /*return*/, result.trim() + toExec];
                 case 6:
-                    error_1 = _c.sent();
+                    error_1 = _b.sent();
                     if (!(error_1 instanceof Error)) {
                         throw error_1;
                     }
@@ -9657,7 +9811,7 @@ function locateApp(options) {
     }
     else if (process.platform === 'darwin') {
         if (macOsName) {
-            return locateAppOnMacOs({ appName: appName, macOsName: macOsName });
+            return locateAppOnMacOs({ macOsName: macOsName });
         }
         else {
             throw new Error("".concat(appName, " is not available on macOS."));
@@ -9665,7 +9819,7 @@ function locateApp(options) {
     }
     else {
         if (linuxWhich) {
-            return locateAppOnLinux({ appName: appName, linuxWhich: linuxWhich });
+            return locateAppOnLinux({ linuxWhich: linuxWhich });
         }
         else {
             throw new Error("".concat(appName, " is not available on Linux."));
@@ -11211,168 +11365,6 @@ var FileCacheStorage = /** @class */ (function () {
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */
 
-/**
- * Normalize options for `execCommand` and `execCommands`
- *
- * Note: `$` is used to indicate that this function behaves differently according to `process.platform`
- *
- * @private internal utility of `execCommand` and `execCommands`
- */
-function $execCommandNormalizeOptions(options) {
-    var _a;
-    var _b, _c, _d, _e;
-    var command;
-    var cwd;
-    var crashOnError;
-    var args = [];
-    var timeout;
-    var isVerbose;
-    if (typeof options === 'string') {
-        // TODO: [1] DRY default values
-        command = options;
-        cwd = process.cwd();
-        crashOnError = true;
-        timeout = Infinity; // <- TODO: [⏳]
-        isVerbose = DEFAULT_IS_VERBOSE;
-    }
-    else {
-        /*
-        TODO:
-        if ((options as any).commands !== undefined) {
-            commands = (options as any).commands;
-        } else {
-            commands = [(options as any).command];
-        }
-        */
-        // TODO: [1] DRY default values
-        command = options.command;
-        cwd = (_b = options.cwd) !== null && _b !== void 0 ? _b : process.cwd();
-        crashOnError = (_c = options.crashOnError) !== null && _c !== void 0 ? _c : true;
-        timeout = (_d = options.timeout) !== null && _d !== void 0 ? _d : Infinity;
-        isVerbose = (_e = options.isVerbose) !== null && _e !== void 0 ? _e : DEFAULT_IS_VERBOSE;
-    }
-    // TODO: /(-[a-zA-Z0-9-]+\s+[^\s]*)|[^\s]*/g
-    var _ = Array.from(command.matchAll(/(".*")|([^\s]*)/g))
-        .map(function (_a) {
-        var _b = __read(_a, 1), match = _b[0];
-        return match;
-    })
-        .filter(function (arg) { return arg !== ''; });
-    if (_.length > 1) {
-        _a = __read(_), command = _a[0], args = _a.slice(1);
-    }
-    if (options.args) {
-        args = __spreadArray(__spreadArray([], __read(args), false), __read(options.args), false);
-    }
-    var humanReadableCommand = !['npx', 'npm'].includes(command) ? command : args[0];
-    if (['ts-node'].includes(humanReadableCommand)) {
-        humanReadableCommand += " ".concat(args[1]);
-    }
-    if (/^win/.test(process.platform) && ['npm', 'npx'].includes(command)) {
-        command = "".concat(command, ".cmd");
-    }
-    return { command: command, humanReadableCommand: humanReadableCommand, args: args, cwd: cwd, crashOnError: crashOnError, timeout: timeout, isVerbose: isVerbose };
-}
-// TODO: This should show type error> execCommandNormalizeOptions({ command: '', commands: [''] });
-
-/**
- * Run one command in a shell
- *
- *
- * Note: There are 2 similar functions in the codebase:
- * - `$execCommand` which runs a single command
- * - `$execCommands` which runs multiple commands
- * Note: `$` is used to indicate that this function is not a pure function - it runs a command in a shell
- *
- * @public exported from `@promptbook/node`
- */
-function $execCommand(options) {
-    if (!$isRunningInNode()) {
-        throw new EnvironmentMismatchError('Function `$execCommand` can run only in Node environment.js');
-    }
-    return new Promise(function (resolve, reject) {
-        // eslint-disable-next-line prefer-const
-        var _a = $execCommandNormalizeOptions(options), command = _a.command, humanReadableCommand = _a.humanReadableCommand, args = _a.args, cwd = _a.cwd, crashOnError = _a.crashOnError, timeout = _a.timeout, _b = _a.isVerbose, isVerbose = _b === void 0 ? DEFAULT_IS_VERBOSE : _b;
-        if (timeout !== Infinity) {
-            // TODO: In waitasecond forTime(Infinity) should be equivalent to forEver()
-            forTime(timeout).then(function () {
-                if (crashOnError) {
-                    reject(new Error("Command \"".concat(humanReadableCommand, "\" exceeded time limit of ").concat(timeout, "ms")));
-                }
-                else {
-                    console.warn("Command \"".concat(humanReadableCommand, "\" exceeded time limit of ").concat(timeout, "ms but continues running"));
-                    resolve('Command exceeded time limit');
-                }
-            });
-        }
-        if (isVerbose) {
-            console.info(colors.yellow(cwd) + ' ' + colors.green(command) + ' ' + colors.blue(args.join(' ')));
-        }
-        try {
-            var commandProcess = spawn(command, args, { cwd: cwd, shell: true });
-            if (isVerbose) {
-                commandProcess.on('message', function (message) {
-                    console.info({ message: message });
-                });
-            }
-            var output_1 = [];
-            commandProcess.stdout.on('data', function (stdout) {
-                output_1.push(stdout.toString());
-                if (isVerbose) {
-                    console.info(stdout.toString());
-                }
-            });
-            commandProcess.stderr.on('data', function (stderr) {
-                output_1.push(stderr.toString());
-                if (isVerbose && stderr.toString().trim()) {
-                    console.warn(stderr.toString());
-                }
-            });
-            var finishWithCode = function (code) {
-                if (code !== 0) {
-                    if (crashOnError) {
-                        reject(new Error(output_1.join('\n').trim() ||
-                            "Command \"".concat(humanReadableCommand, "\" exited with code ").concat(code)));
-                    }
-                    else {
-                        if (isVerbose) {
-                            console.warn("Command \"".concat(humanReadableCommand, "\" exited with code ").concat(code));
-                        }
-                        resolve(spaceTrim$1(output_1.join('\n')));
-                    }
-                }
-                else {
-                    resolve(spaceTrim$1(output_1.join('\n')));
-                }
-            };
-            commandProcess.on('close', finishWithCode);
-            commandProcess.on('exit', finishWithCode);
-            commandProcess.on('disconnect', function () {
-                // Note: Unexpected disconnection should always result in rejection
-                reject(new Error("Command \"".concat(humanReadableCommand, "\" disconnected")));
-            });
-            commandProcess.on('error', function (error) {
-                if (crashOnError) {
-                    reject(new Error("Command \"".concat(humanReadableCommand, "\" failed: \n").concat(error.message)));
-                }
-                else {
-                    if (isVerbose) {
-                        console.warn(error);
-                    }
-                    resolve(spaceTrim$1(output_1.join('\n')));
-                }
-            });
-        }
-        catch (error) {
-            // Note: Unexpected error in sync code should always result in rejection
-            reject(error);
-        }
-    });
-}
-/**
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- */
-
 /**
  * Run multiple commands in a shell in sequence
  *