@promptbook/cli 0.72.0-32 → 0.72.0-34

package/esm/typings/src/executables/apps/locateLibreoffice.d.ts

@@ -4,7 +4,7 @@ import type { string_executable_path } from '../../types/typeAliases';
  *
  * @private within the repository
  */
-export declare function locateLibreoffice(): Promise<string_executable_path>;
+export declare function locateLibreoffice(): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/legacy-documents`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/executables/apps/locatePandoc.d.ts

@@ -4,7 +4,7 @@ import type { string_executable_path } from '../../types/typeAliases';
  *
  * @private within the repository
  */
-export declare function locatePandoc(): Promise<string_executable_path>;
+export declare function locatePandoc(): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/documents`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/executables/locateApp.d.ts

@@ -26,7 +26,7 @@ export interface LocateAppOptions {
  *
  * @private within the repository
  */
-export declare function locateApp(options: RequireAtLeastOne<LocateAppOptions, 'linuxWhich' | 'windowsSuffix' | 'macOsName'>): Promise<string_executable_path>;
+export declare function locateApp(options: RequireAtLeastOne<LocateAppOptions, 'linuxWhich' | 'windowsSuffix' | 'macOsName'>): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts

@@ -1,11 +1,11 @@
-import type { LocateAppOptions } from '../locateApp';
 import type { string_executable_path } from '../../types/typeAliases';
+import type { LocateAppOptions } from '../locateApp';
 /**
  * @@@
  *
  * @private within the repository
  */
-export declare function locateAppOnLinux({ appName, linuxWhich, }: Pick<Required<LocateAppOptions>, 'appName' | 'linuxWhich'>): Promise<string_executable_path>;
+export declare function locateAppOnLinux({ appName, linuxWhich, }: Pick<Required<LocateAppOptions>, 'appName' | 'linuxWhich'>): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts

@@ -5,7 +5,7 @@ import type { LocateAppOptions } from '../locateApp';
  *
  * @private within the repository
  */
-export declare function locateAppOnMacOs({ appName, macOsName, }: Pick<Required<LocateAppOptions>, 'appName' | 'macOsName'>): Promise<string_executable_path>;
+export declare function locateAppOnMacOs({ appName, macOsName, }: Pick<Required<LocateAppOptions>, 'appName' | 'macOsName'>): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts

@@ -5,7 +5,7 @@ import type { LocateAppOptions } from '../locateApp';
  *
  * @private within the repository
  */
-export declare function locateAppOnWindows({ appName, windowsSuffix, }: Pick<Required<LocateAppOptions>, 'appName' | 'windowsSuffix'>): Promise<string_executable_path>;
+export declare function locateAppOnWindows({ appName, windowsSuffix, }: Pick<Required<LocateAppOptions>, 'appName' | 'windowsSuffix'>): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/utils/execCommand/$execCommand.d.ts

@@ -2,9 +2,11 @@ import type { ExecCommandOptions } from './ExecCommandOptions';
 /**
  * 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`
  */

package/esm/typings/src/utils/execCommand/{execCommandNormalizeOptions.d.ts → $execCommandNormalizeOptions.d.ts}

@@ -3,8 +3,10 @@ import type { ExecCommandOptionsAdvanced } from './ExecCommandOptions';
 /**
  * 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`
  */
-export declare function execCommandNormalizeOptions(options: ExecCommandOptions): Pick<ExecCommandOptionsAdvanced, 'command' | 'args' | 'cwd' | 'crashOnError' | 'timeout'> & {
+export declare function $execCommandNormalizeOptions(options: ExecCommandOptions): Pick<ExecCommandOptionsAdvanced, 'command' | 'args' | 'cwd' | 'crashOnError' | 'timeout' | 'isVerbose'> & {
     humanReadableCommand: string;
 };

package/esm/typings/src/utils/execCommand/$execCommands.d.ts

@@ -4,6 +4,7 @@
  * 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 commands in a shell
  *
  * @public exported from `@promptbook/node`
  */

package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts

@@ -5,15 +5,41 @@ type RequiredAndOptional<TBase, TRequired extends keyof TBase, TOptional extends
 /**
  * Simple options for `execCommand`
  */
-export type ExecCommandOptions = string | RequiredAndOptional<ExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout'>;
+export type ExecCommandOptions = string | RequiredAndOptional<ExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout' | 'isVerbose'>;
 /**
  * Advanced options for `execCommand`
  */
 export type ExecCommandOptionsAdvanced = {
+    /**
+     * Command to run
+     */
     readonly command: string;
+    /**
+     * Arguments for the command
+     */
     readonly args: string[];
+    /**
+     * Current working directory
+     *
+     * @default process.cwd()
+     */
     readonly cwd: string;
+    /**
+     * If `true` then the command will throw an error if the return code is not `0`
+     */
     readonly crashOnError: boolean;
+    /**
+     * Timeout in milliseconds
+     */
     readonly timeout: number;
+    /**
+     * If `true` then the command and entire CLI output will be logged to the console
+     *
+     * @default false
+     */
+    readonly isVerbose?: boolean;
 };
 export {};
+/**
+ * TODO: [⏳] Make DEFAULT_TIMEOUT_MS as global constant
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/cli",
-    "version": "0.72.0-32",
+    "version": "0.72.0-34",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -39,7 +39,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.72.0-31';
+    var PROMPTBOOK_VERSION = '0.72.0-33';
     // TODO: [main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
@@ -433,6 +433,7 @@
      * @private within the repository - too low-level in comparison with other `MAX_...`
      */
     var CONNECTION_TIMEOUT_MS = 7 * 1000;
+    // <- TODO: [⏳] Standartize timeouts, Make DEFAULT_TIMEOUT_MS as global constant
     /**
      * How many times to retry the connections
      *
@@ -8392,16 +8393,25 @@
     function locateAppOnLinux(_a) {
         var appName = _a.appName, linuxWhich = _a.linuxWhich;
         return __awaiter(this, void 0, void 0, function () {
-            var _b, stderr, stdout;
+            var _b, stderr, stdout, error_1;
             return __generator(this, function (_c) {
                 switch (_c.label) {
-                    case 0: return [4 /*yield*/, exec$1("which ".concat(linuxWhich))];
+                    case 0:
+                        _c.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, exec$1("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));
+                    case 2:
+                        error_1 = _c.sent();
+                        if (!(error_1 instanceof Error)) {
+                            throw error_1;
+                        }
+                        return [2 /*return*/, null];
+                    case 3: return [2 /*return*/];
                 }
             });
         });
@@ -8477,10 +8487,11 @@
     function locateAppOnMacOs(_a) {
         var appName = _a.appName, macOsName = _a.macOsName;
         return __awaiter(this, void 0, void 0, function () {
-            var toExec, regPath, altPath, _b, stderr, stdout;
+            var toExec, regPath, altPath, _b, stderr, stdout, error_1;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
+                        _c.trys.push([0, 6, , 7]);
                         toExec = "/Contents/MacOS/".concat(macOsName);
                         regPath = "/Applications/".concat(macOsName, ".app") + toExec;
                         altPath = userhome(regPath.slice(1));
@@ -8501,6 +8512,13 @@
                             return [2 /*return*/, stdout.trim() + toExec];
                         }
                         throw new Error("Can not locate app ".concat(appName, " on macOS.\n ").concat(stderr));
+                    case 6:
+                        error_1 = _c.sent();
+                        if (!(error_1 instanceof Error)) {
+                            throw error_1;
+                        }
+                        return [2 /*return*/, null];
+                    case 7: return [2 /*return*/];
                 }
             });
         });
@@ -8518,11 +8536,12 @@
     function locateAppOnWindows(_a) {
         var appName = _a.appName, windowsSuffix = _a.windowsSuffix;
         return __awaiter(this, void 0, void 0, function () {
-            var prefixes, prefixes_1, prefixes_1_1, prefix, path$1, e_1_1;
+            var prefixes, prefixes_1, prefixes_1_1, prefix, path$1, e_1_1, error_1;
             var e_1, _b;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
+                        _c.trys.push([0, 9, , 10]);
                         prefixes = [
                             process.env.LOCALAPPDATA,
                             path.join(process.env.LOCALAPPDATA || '', 'Programs'),
@@ -8559,6 +8578,13 @@
                         finally { if (e_1) throw e_1.error; }
                         return [7 /*endfinally*/];
                     case 8: throw new Error("Can not locate app ".concat(appName, " on Windows."));
+                    case 9:
+                        error_1 = _c.sent();
+                        if (!(error_1 instanceof Error)) {
+                            throw error_1;
+                        }
+                        return [2 /*return*/, null];
+                    case 10: return [2 /*return*/];
                 }
             });
         });
@@ -8665,9 +8691,9 @@
                         _d = {};
                         return [4 /*yield*/, locatePandoc()];
                     case 1:
-                        _d.pandocPath = _e.sent();
+                        _d.pandocPath = (_e.sent()) || undefined;
                         return [4 /*yield*/, locateLibreoffice()];
-                    case 2: return [2 /*return*/, (_d.libreOfficePath = _e.sent(),
+                    case 2: return [2 /*return*/, (_d.libreOfficePath = (_e.sent()) || undefined,
                             _d)];
                 }
             });
@@ -12987,11 +13013,11 @@
                                 assistant_id: this.assistantId,
                                 thread: {
                                     messages: [
-                                        // TODO:  [🗯] !!!!!! Allow threads to be passed
+                                        // TODO:  [🗯] !! Allow threads to be passed
                                         { role: 'user', content: rawPromptContent },
                                     ],
                                 },
-                                // !!!!!! user: this.options.user,
+                                // <- TODO: Add user identification here> user: this.options.user,
                             };
                             start = getCurrentIsoDate();
                             if (this.options.isVerbose) {
@@ -13042,7 +13068,7 @@
                                 throw new PipelineExecutionError("There is NOT 'text' BUT ".concat((_b = rawResponse[0].content[0]) === null || _b === void 0 ? void 0 : _b.type, " finalMessages content type from OpenAI"));
                             }
                             resultContent = (_c = rawResponse[0].content[0]) === null || _c === void 0 ? void 0 : _c.text.value;
-                            //                                                     <- TODO: !!!!!! There are also annotations, maybe use them
+                            //                                                     <- TODO: [🧠] There are also annotations, maybe use them
                             // eslint-disable-next-line prefer-const
                             complete = getCurrentIsoDate();
                             usage = UNCERTAIN_USAGE;
@@ -13144,22 +13170,26 @@
     /**
      * 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) {
+    function $execCommandNormalizeOptions(options) {
         var _a;
-        var _b, _c, _d;
+        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;
+            timeout = Infinity; // <- TODO: [⏳]
+            isVerbose = DEFAULT_IS_VERBOSE;
         }
         else {
             /*
@@ -13175,6 +13205,7 @@
             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))
@@ -13196,16 +13227,21 @@
         if (['ts-node'].includes(humanReadableCommand)) {
             humanReadableCommand += " ".concat(args[1]);
         }
-        return { command: command, humanReadableCommand: humanReadableCommand, args: args, cwd: cwd, crashOnError: crashOnError, timeout: timeout };
+        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`
      */
@@ -13215,7 +13251,7 @@
         }
         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;
+            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()
                 waitasecond.forTime(timeout).then(function () {
@@ -13228,24 +13264,26 @@
                     }
                 });
             }
-            if (/^win/.test(process.platform) && ['npm', 'npx'].includes(command)) {
-                command = "".concat(command, ".cmd");
+            if (isVerbose) {
+                console.info(colors__default["default"].yellow(cwd) + ' ' + colors__default["default"].green(command) + ' ' + colors__default["default"].blue(args.join(' ')));
             }
-            // !!!!!! Verbose mode - to all consoles
-            console.info(colors__default["default"].yellow(cwd) + ' ' + colors__default["default"].green(command) + ' ' + colors__default["default"].blue(args.join(' ')));
             try {
                 var commandProcess = child_process.spawn(command, args, { cwd: cwd, shell: true });
-                commandProcess.on('message', function (message) {
-                    console.info({ message: message });
-                });
+                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());
-                    console.info(stdout.toString());
+                    if (isVerbose) {
+                        console.info(stdout.toString());
+                    }
                 });
                 commandProcess.stderr.on('data', function (stderr) {
                     output_1.push(stderr.toString());
-                    if (stderr.toString().trim()) {
+                    if (isVerbose && stderr.toString().trim()) {
                         console.warn(stderr.toString());
                     }
                 });
@@ -13256,7 +13294,9 @@
                                 "Command \"".concat(humanReadableCommand, "\" exited with code ").concat(code)));
                         }
                         else {
-                            console.warn("Command \"".concat(humanReadableCommand, "\" exited with code ").concat(code));
+                            if (isVerbose) {
+                                console.warn("Command \"".concat(humanReadableCommand, "\" exited with code ").concat(code));
+                            }
                             resolve(spaceTrim.spaceTrim(output_1.join('\n')));
                         }
                     }
@@ -13275,7 +13315,9 @@
                         reject(new Error("Command \"".concat(humanReadableCommand, "\" failed: \n").concat(error.message)));
                     }
                     else {
-                        console.warn(error);
+                        if (isVerbose) {
+                            console.warn(error);
+                        }
                         resolve(spaceTrim.spaceTrim(output_1.join('\n')));
                     }
                 });
@@ -14134,25 +14176,6 @@
             this.options = options;
             this.markdownScraper = new MarkdownScraper(tools, options);
             this.showdownConverter = createShowdownConverter();
-            /**/
-            // TODO:  [🏄] !!!!!! Remove or describe why it is here
-            TODO_USE(readability.Readability);
-            TODO_USE(showdown.Converter);
-            TODO_USE(jsdom.JSDOM);
-            TODO_USE(createShowdownConverter);
-            /**/
-            /**/
-            var jsdom$1 = new jsdom.JSDOM();
-            var reader = new readability.Readability(jsdom$1.window.document);
-            keepUnused(reader);
-            /**/
-            /**/
-            keepUnused(DEFAULT_INTERMEDIATE_FILES_STRATEGY, DEFAULT_IS_VERBOSE, DEFAULT_SCRAPE_CACHE_DIRNAME);
-            keepUnused(EnvironmentMismatchError);
-            keepUnused(KnowledgeScrapeError);
-            keepUnused(getScraperIntermediateSource);
-            keepUnused();
-            /**/
         }
         Object.defineProperty(WebsiteScraper.prototype, "metadata", {
             /**
@@ -14178,8 +14201,6 @@
                     switch (_g.label) {
                         case 0:
                             _a = this.options, _b = _a.rootDirname, rootDirname = _b === void 0 ? process.cwd() : _b, _c = _a.cacheDirname, cacheDirname = _c === void 0 ? DEFAULT_SCRAPE_CACHE_DIRNAME : _c, _d = _a.intermediateFilesStrategy, intermediateFilesStrategy = _d === void 0 ? DEFAULT_INTERMEDIATE_FILES_STRATEGY : _d, _e = _a.isVerbose, isVerbose = _e === void 0 ? DEFAULT_IS_VERBOSE : _e;
-                            // [🏄] !!!!!!!
-                            keepUnused(rootDirname, cacheDirname, intermediateFilesStrategy, isVerbose);
                             if (source.url === null) {
                                 throw new KnowledgeScrapeError('Website scraper requires URL');
                             }
@@ -14190,11 +14211,8 @@
                             return [4 /*yield*/, source.asText()];
                         case 1:
                             jsdom$1 = new (_f.apply(jsdom.JSDOM, [void 0, _g.sent(), {
-                                    // <- TODO: !!!!!!! Problem with build is probbably in `new JSDOM();`
                                     url: source.url,
                                 }]))();
-                            // [🏄] !!!!!!!
-                            keepUnused(jsdom$1);
                             reader = new readability.Readability(jsdom$1.window.document);
                             article = reader.parse();
                             html = (article === null || article === void 0 ? void 0 : article.content) || (article === null || article === void 0 ? void 0 : article.textContent) || jsdom$1.window.document.body.innerHTML;