@promptbook/cli 0.72.0-32 → 0.72.0-34

package/README.md

@@ -109,15 +109,15 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 
 
-If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 2, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.
+If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 3, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.
 
-But often you will struggle with the limitations of LLMs, such as hallucinations, off-topic responses, poor quality output, language drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd responses. When this happens, you generally have three options:
+But often you will struggle with the **limitations of LLMs**, such as **hallucinations, off-topic responses, poor quality output, language and prompt drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd responses**. When this happens, you generally have three options:
 
 1. **Fine-tune** the model to your specifications or even train your own.
 2. **Prompt-engineer** the prompt to the best shape you can achieve.
 3. Orchestrate **multiple prompts** in a [pipeline](https://github.com/webgptorg/promptbook/discussions/64) to get the best result.
 
-In all of these situations, but especially in 3., the Promptbook library can make your life easier.
+In all of these situations, but especially in 3., the **✨ Promptbook can make your life waaaaaaaaaay easier**.
 
 -   [**Separates concerns**](https://github.com/webgptorg/promptbook/discussions/32) between prompt-engineer and programmer, between code files and prompt files, and between prompts and their execution logic.
 -   Establishes a [**common format `.ptbk.md`**](https://github.com/webgptorg/promptbook/discussions/85) that can be used to describe your prompt business logic without having to write code or deal with the technicalities of LLMs.

package/esm/index.es.js

@@ -27,7 +27,7 @@ import { Converter } from 'showdown';
 /**
  * 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
 
 /*! *****************************************************************************
@@ -421,6 +421,7 @@ var LOOP_LIMIT = 1000;
  * @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
  *
@@ -8380,16 +8381,25 @@ var exec$1 = promisify(exec$2);
 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*/];
             }
         });
     });
@@ -8465,10 +8475,11 @@ var exec = promisify(exec$2);
 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));
@@ -8489,6 +8500,13 @@ function locateAppOnMacOs(_a) {
                         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*/];
             }
         });
     });
@@ -8506,11 +8524,12 @@ function locateAppOnMacOs(_a) {
 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, e_1_1;
+        var prefixes, prefixes_1, prefixes_1_1, prefix, path, 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,
                         join(process.env.LOCALAPPDATA || '', 'Programs'),
@@ -8547,6 +8566,13 @@ function locateAppOnWindows(_a) {
                     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*/];
             }
         });
     });
@@ -8653,9 +8679,9 @@ function $provideExecutablesForNode(options) {
                     _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)];
             }
         });
@@ -12975,11 +13001,11 @@ var OpenAiAssistantExecutionTools = /** @class */ (function (_super) {
                             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) {
@@ -13030,7 +13056,7 @@ var OpenAiAssistantExecutionTools = /** @class */ (function (_super) {
                             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;
@@ -13132,22 +13158,26 @@ var _OpenAiAssistantRegistration = $llmToolsRegister.register(createOpenAiAssist
 /**
  * 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 {
         /*
@@ -13163,6 +13193,7 @@ function execCommandNormalizeOptions(options) {
         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))
@@ -13184,16 +13215,21 @@ function execCommandNormalizeOptions(options) {
     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`
  */
@@ -13203,7 +13239,7 @@ function $execCommand(options) {
     }
     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()
             forTime(timeout).then(function () {
@@ -13216,24 +13252,26 @@ function $execCommand(options) {
                 }
             });
         }
-        if (/^win/.test(process.platform) && ['npm', 'npx'].includes(command)) {
-            command = "".concat(command, ".cmd");
+        if (isVerbose) {
+            console.info(colors.yellow(cwd) + ' ' + colors.green(command) + ' ' + colors.blue(args.join(' ')));
         }
-        // !!!!!! Verbose mode - to all consoles
-        console.info(colors.yellow(cwd) + ' ' + colors.green(command) + ' ' + colors.blue(args.join(' ')));
         try {
             var commandProcess = 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());
                 }
             });
@@ -13244,7 +13282,9 @@ function $execCommand(options) {
                             "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(output_1.join('\n')));
                     }
                 }
@@ -13263,7 +13303,9 @@ function $execCommand(options) {
                     reject(new Error("Command \"".concat(humanReadableCommand, "\" failed: \n").concat(error.message)));
                 }
                 else {
-                    console.warn(error);
+                    if (isVerbose) {
+                        console.warn(error);
+                    }
                     resolve(spaceTrim(output_1.join('\n')));
                 }
             });
@@ -14122,25 +14164,6 @@ var WebsiteScraper = /** @class */ (function () {
         this.options = options;
         this.markdownScraper = new MarkdownScraper(tools, options);
         this.showdownConverter = createShowdownConverter();
-        /**/
-        // TODO:  [🏄] !!!!!! Remove or describe why it is here
-        TODO_USE(Readability);
-        TODO_USE(Converter);
-        TODO_USE(JSDOM);
-        TODO_USE(createShowdownConverter);
-        /**/
-        /**/
-        var jsdom = new JSDOM();
-        var reader = new Readability(jsdom.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", {
         /**
@@ -14166,8 +14189,6 @@ var WebsiteScraper = /** @class */ (function () {
                 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');
                         }
@@ -14178,11 +14199,8 @@ var WebsiteScraper = /** @class */ (function () {
                         return [4 /*yield*/, source.asText()];
                     case 1:
                         jsdom = new (_f.apply(JSDOM, [void 0, _g.sent(), {
-                                // <- TODO: !!!!!!! Problem with build is probbably in `new JSDOM();`
                                 url: source.url,
                             }]))();
-                        // [🏄] !!!!!!!
-                        keepUnused(jsdom);
                         reader = new Readability(jsdom.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.window.document.body.innerHTML;