@promptbook/legacy-documents 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/legacy-documents",
-    "version": "0.72.0-32",
+    "version": "0.72.0-34",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -52,7 +52,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/legacy-documents.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.72.0-32"
+        "@promptbook/core": "0.72.0-34"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -15,7 +15,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
 
     /*! *****************************************************************************
@@ -515,22 +515,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 {
             /*
@@ -546,6 +550,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))
@@ -567,16 +572,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`
      */
@@ -586,7 +596,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 () {
@@ -599,24 +609,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());
                     }
                 });
@@ -627,7 +639,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')));
                         }
                     }
@@ -646,7 +660,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')));
                     }
                 });