@promptbook/cli 0.84.0-21 → 0.84.0

package/README.md

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

package/esm/index.es.js

@@ -38,7 +38,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.84.0-20';
+var PROMPTBOOK_ENGINE_VERSION = '0.84.0-21';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -445,6 +445,45 @@ var EnvironmentMismatchError = /** @class */ (function (_super) {
  * @public exported from `@promptbook/utils`
  */
 var $isRunningInNode = new Function("\n    try {\n        return this === global;\n    } catch (e) {\n        return false;\n    }\n");
+/**
+ * TODO: [☑]
+ */
+
+/**
+ * Detects if the code is running in a browser environment in main thread (Not in a web worker)
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
+ *
+ * @public exported from `@promptbook/utils`
+ */
+var $isRunningInBrowser = new Function("\n    try {\n        return this === window;\n    } catch (e) {\n        return false;\n    }\n");
+/**
+ * TODO: [☑]
+ */
+
+/**
+ * Detects if the code is running in jest environment
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
+ *
+ * @public exported from `@promptbook/utils`
+ */
+var $isRunningInJest = new Function("\n    try {\n        return process.env.JEST_WORKER_ID !== undefined;\n    } catch (e) {\n        return false;\n    }\n");
+/**
+ * TODO: [☑]
+ */
+
+/**
+ * Detects if the code is running in a web worker
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
+ *
+ * @public exported from `@promptbook/utils`
+ */
+var $isRunningInWebWorker = new Function("\n    try {\n        if (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) {\n            return true;\n        } else {\n            return false;\n        }\n    } catch (e) {\n        return false;\n    }\n");
+/**
+ * TODO: [☑]
+ */
 
 /**
  * Initializes `about` command for Promptbook CLI utilities
@@ -459,16 +498,37 @@ function $initializeAboutCommand(program) {
     makeCommand.description(spaceTrim("\n            Tells about Promptbook CLI and its abilities\n      "));
     makeCommand.action(function () { return __awaiter(_this, void 0, void 0, function () {
         return __generator(this, function (_a) {
-            console.info(colors.bold(colors.cyan("Promptbook: ".concat(CLAIM))));
+            console.info(colors.bold(colors.blue("Promptbook: ".concat(CLAIM))));
             console.info(colors.cyan("Book language version: ".concat(BOOK_LANGUAGE_VERSION)));
             console.info(colors.cyan("Promptbook engine version: ".concat(PROMPTBOOK_ENGINE_VERSION)));
-            console.info(colors.cyan("https://github.com/webgptorg/promptbook"));
-            console.info(colors.cyan("https://ptbk.io"));
+            if ($isRunningInNode()) {
+                console.info(colors.cyan("Environment: Node.js"));
+                console.info(colors.cyan("Node.js version: ".concat(process.version)));
+                // <- TODO: [🧠][☑] Make robust system to check platform requirements like browser/node environment, version of node, available memory, disk space, ...
+                console.info(colors.cyan("Platform type: ".concat(process.platform)));
+                console.info(colors.cyan("Platform architecture: ".concat(process.arch)));
+                // console.info(colors.cyan(`Available memory: ${process.availableMemory()}`));
+                // <- TODO: [🧠] Should we show available memory / disk / ...
+            }
+            else if ($isRunningInJest()) {
+                console.info(colors.cyan("Environment: Jest (testing)"));
+            }
+            else if ($isRunningInBrowser()) {
+                // <- Note: This is unreliable because CLI itself is not running in browser but for future use
+                console.info(colors.cyan("Environment: Browser"));
+            }
+            else if ($isRunningInWebWorker()) {
+                // <- Note: This is unreliable because CLI itself is not running in browser but for future use
+                console.info(colors.cyan("Environment: Web Worker"));
+            }
+            console.info(colors.gray("https://github.com/webgptorg/promptbook"));
+            console.info(colors.gray("https://ptbk.io"));
             return [2 /*return*/, process.exit(0)];
         });
     }); });
 }
 /**
+ * TODO: !!! Test this in `deno`
  * TODO: [🗽] Unite branding and make single place for it
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
@@ -2118,107 +2178,6 @@ function isRootPath(value) {
  * TODO: [🍏] Make for MacOS paths
  */
 
-/**
- * @@@
- *
- * @@@ .env
- *
- * It looks for environment variables:
- * - `process.env.OPENAI_API_KEY`
- * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
- * - ...
- *
- * @returns @@@
- * @public exported from `@promptbook/node`
- */
-function $provideLlmToolsConfigurationFromEnv() {
-    return __awaiter(this, void 0, void 0, function () {
-        var envFilePatterns, rootDirname, i, envFilePatterns_1, envFilePatterns_1_1, pattern, envFilename, e_1_1, llmToolsConfiguration;
-        var e_1, _a;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
-                case 0:
-                    if (!$isRunningInNode()) {
-                        throw new EnvironmentMismatchError('Function `$provideLlmToolsFromEnv` works only in Node.js environment');
-                    }
-                    envFilePatterns = [
-                        '.env',
-                        '.env.test',
-                        '.env.local',
-                        '.env.development.local',
-                        '.env.development',
-                        '.env.production.local',
-                        '.env.production',
-                        '.env.prod.local',
-                        '.env.prod',
-                        // <- TODO: Maybe add more patterns
-                    ];
-                    rootDirname = process.cwd();
-                    i = 0;
-                    _b.label = 1;
-                case 1:
-                    if (!(i < LOOP_LIMIT)) return [3 /*break*/, 11];
-                    _b.label = 2;
-                case 2:
-                    _b.trys.push([2, 7, 8, 9]);
-                    envFilePatterns_1 = (e_1 = void 0, __values(envFilePatterns)), envFilePatterns_1_1 = envFilePatterns_1.next();
-                    _b.label = 3;
-                case 3:
-                    if (!!envFilePatterns_1_1.done) return [3 /*break*/, 6];
-                    pattern = envFilePatterns_1_1.value;
-                    envFilename = join(rootDirname, pattern);
-                    return [4 /*yield*/, isFileExisting(envFilename, $provideFilesystemForNode())];
-                case 4:
-                    if (_b.sent()) {
-                        dotenv.config({ path: envFilename });
-                        return [3 /*break*/, 11];
-                    }
-                    _b.label = 5;
-                case 5:
-                    envFilePatterns_1_1 = envFilePatterns_1.next();
-                    return [3 /*break*/, 3];
-                case 6: return [3 /*break*/, 9];
-                case 7:
-                    e_1_1 = _b.sent();
-                    e_1 = { error: e_1_1 };
-                    return [3 /*break*/, 9];
-                case 8:
-                    try {
-                        if (envFilePatterns_1_1 && !envFilePatterns_1_1.done && (_a = envFilePatterns_1.return)) _a.call(envFilePatterns_1);
-                    }
-                    finally { if (e_1) throw e_1.error; }
-                    return [7 /*endfinally*/];
-                case 9:
-                    if (isRootPath(rootDirname)) {
-                        return [3 /*break*/, 11];
-                    }
-                    // Note: If the directory does not exist, try the parent directory
-                    rootDirname = join(rootDirname, '..');
-                    _b.label = 10;
-                case 10:
-                    i++;
-                    return [3 /*break*/, 1];
-                case 11:
-                    llmToolsConfiguration = $llmToolsMetadataRegister
-                        .list()
-                        .map(function (metadata) { return metadata.createConfigurationFromEnv(process.env); })
-                        .filter(function (configuration) { return configuration !== null; });
-                    return [2 /*return*/, llmToolsConfiguration];
-            }
-        });
-    });
-}
-/**
- * TODO: [🧠][🪁] Maybe do allow to do auto-install if package not registered and not found
- * TODO: Add Azure OpenAI
- * TODO: [🧠][🍛]
- * TODO: [🧠] Is there some meaningfull way how to test this util
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
- * TODO: This should be maybe not under `_common` but under `utils`
- * TODO: [🧠][⚛] Maybe pass env as argument
- * TODO: [®] DRY Register logic */
-
 /**
  * @@@
  *
@@ -2231,6 +2190,22 @@ var $llmToolsRegister = new $Register('llm_execution_tools_constructors');
  * TODO: [®] DRY Register logic
  */
 
+/**
+ * Path to the `.env` file which was used to configure LLM tools
+ *
+ * Note: `$` is used to indicate that this variable is changed by side effect in `$provideLlmToolsConfigurationFromEnv` through `$setUsedEnvFilename`
+ */
+var $usedEnvFilename = null;
+/**
+ * Pass the `.env` file which was used to configure LLM tools
+ *
+ * Note: `$` is used to indicate that this variable is making side effect
+ *
+ * @private internal log of `$provideLlmToolsConfigurationFromEnv` and `$registeredLlmToolsMessage`
+ */
+function $setUsedEnvFilename(filepath) {
+    $usedEnvFilename = filepath;
+}
 /**
  * Creates a message with all registered LLM tools
  *
@@ -2309,10 +2284,11 @@ function $registeredLlmToolsMessage() {
         // <- Note: [🗨]
         return __assign(__assign({}, metadata), { isMetadataAviailable: isMetadataAviailable, isInstalled: isInstalled, isFullyConfigured: isFullyConfigured, isPartiallyConfigured: isPartiallyConfigured });
     });
+    var usedEnvMessage = $usedEnvFilename === null ? "Unknown `.env` file" : "Used `.env` file:\n".concat($usedEnvFilename);
     if (metadata.length === 0) {
-        return "No LLM providers are available.";
+        return spaceTrim(function (block) { return "\n                No LLM providers are available.\n\n                ".concat(block(usedEnvMessage), "\n          "); });
     }
-    return spaceTrim(function (block) { return "\n            Relevant environment variables:\n            ".concat(block(Object.keys(env)
+    return spaceTrim(function (block) { return "\n\n            ".concat(block(usedEnvMessage), "\n\n            Relevant environment variables:\n            ").concat(block(Object.keys(env)
         .filter(function (envVariableName) {
         return metadata.some(function (_a) {
             var envVariables = _a.envVariables;
@@ -2377,6 +2353,108 @@ function $registeredLlmToolsMessage() {
  * TODO: [🧠][⚛] Maybe pass env as argument
  */
 
+/**
+ * @@@
+ *
+ * @@@ .env
+ *
+ * It looks for environment variables:
+ * - `process.env.OPENAI_API_KEY`
+ * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
+ * - ...
+ *
+ * @returns @@@
+ * @public exported from `@promptbook/node`
+ */
+function $provideLlmToolsConfigurationFromEnv() {
+    return __awaiter(this, void 0, void 0, function () {
+        var envFilePatterns, rootDirname, i, envFilePatterns_1, envFilePatterns_1_1, pattern, envFilename, e_1_1, llmToolsConfiguration;
+        var e_1, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    if (!$isRunningInNode()) {
+                        throw new EnvironmentMismatchError('Function `$provideLlmToolsFromEnv` works only in Node.js environment');
+                    }
+                    envFilePatterns = [
+                        '.env',
+                        '.env.test',
+                        '.env.local',
+                        '.env.development.local',
+                        '.env.development',
+                        '.env.production.local',
+                        '.env.production',
+                        '.env.prod.local',
+                        '.env.prod',
+                        // <- TODO: Maybe add more patterns
+                    ];
+                    rootDirname = process.cwd();
+                    i = 0;
+                    _b.label = 1;
+                case 1:
+                    if (!(i < LOOP_LIMIT)) return [3 /*break*/, 11];
+                    _b.label = 2;
+                case 2:
+                    _b.trys.push([2, 7, 8, 9]);
+                    envFilePatterns_1 = (e_1 = void 0, __values(envFilePatterns)), envFilePatterns_1_1 = envFilePatterns_1.next();
+                    _b.label = 3;
+                case 3:
+                    if (!!envFilePatterns_1_1.done) return [3 /*break*/, 6];
+                    pattern = envFilePatterns_1_1.value;
+                    envFilename = join(rootDirname, pattern);
+                    return [4 /*yield*/, isFileExisting(envFilename, $provideFilesystemForNode())];
+                case 4:
+                    if (_b.sent()) {
+                        $setUsedEnvFilename(envFilename);
+                        dotenv.config({ path: envFilename });
+                        return [3 /*break*/, 11];
+                    }
+                    _b.label = 5;
+                case 5:
+                    envFilePatterns_1_1 = envFilePatterns_1.next();
+                    return [3 /*break*/, 3];
+                case 6: return [3 /*break*/, 9];
+                case 7:
+                    e_1_1 = _b.sent();
+                    e_1 = { error: e_1_1 };
+                    return [3 /*break*/, 9];
+                case 8:
+                    try {
+                        if (envFilePatterns_1_1 && !envFilePatterns_1_1.done && (_a = envFilePatterns_1.return)) _a.call(envFilePatterns_1);
+                    }
+                    finally { if (e_1) throw e_1.error; }
+                    return [7 /*endfinally*/];
+                case 9:
+                    if (isRootPath(rootDirname)) {
+                        return [3 /*break*/, 11];
+                    }
+                    // Note: If the directory does not exist, try the parent directory
+                    rootDirname = join(rootDirname, '..');
+                    _b.label = 10;
+                case 10:
+                    i++;
+                    return [3 /*break*/, 1];
+                case 11:
+                    llmToolsConfiguration = $llmToolsMetadataRegister
+                        .list()
+                        .map(function (metadata) { return metadata.createConfigurationFromEnv(process.env); })
+                        .filter(function (configuration) { return configuration !== null; });
+                    return [2 /*return*/, llmToolsConfiguration];
+            }
+        });
+    });
+}
+/**
+ * TODO: [🧠][🪁] Maybe do allow to do auto-install if package not registered and not found
+ * TODO: Add Azure OpenAI
+ * TODO: [🧠][🍛]
+ * TODO: [🧠] Is there some meaningfull way how to test this util
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ * TODO: This should be maybe not under `_common` but under `utils`
+ * TODO: [🧠][⚛] Maybe pass env as argument
+ * TODO: [®] DRY Register logic */
+
 /**
  * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
  *
@@ -11204,33 +11282,6 @@ function renderPromptbookMermaid(pipelineJson, options) {
  * TODO: [🕌] When more than 2 functionalities, split into separate functions
  */
 
-/**
- * Detects if the code is running in a browser environment in main thread (Not in a web worker)
- *
- * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
- *
- * @public exported from `@promptbook/utils`
- */
-var $isRunningInBrowser = new Function("\n    try {\n        return this === window;\n    } catch (e) {\n        return false;\n    }\n");
-
-/**
- * Detects if the code is running in jest environment
- *
- * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
- *
- * @public exported from `@promptbook/utils`
- */
-var $isRunningInJest = new Function("\n    try {\n        return process.env.JEST_WORKER_ID !== undefined;\n    } catch (e) {\n        return false;\n    }\n");
-
-/**
- * Detects if the code is running in a web worker
- *
- * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
- *
- * @public exported from `@promptbook/utils`
- */
-var $isRunningInWebWorker = new Function("\n    try {\n        if (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) {\n            return true;\n        } else {\n            return false;\n        }\n    } catch (e) {\n        return false;\n    }\n");
-
 /**
  * Makes first letter of a string uppercase
  *