@promptbook/node 0.84.0-21 → 0.84.0

package/esm/typings/src/cli/cli-commands/about.d.ts

@@ -8,6 +8,7 @@ import type { Command as Program } from 'commander';
  */
 export declare function $initializeAboutCommand(program: Program): void;
 /**
+ * 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`

package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts

@@ -1,4 +1,13 @@
+import type { string_filename } from '../../../types/typeAliases';
 import type { string_markdown } from '../../../types/typeAliases';
+/**
+ * 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`
+ */
+export declare function $setUsedEnvFilename(filepath: string_filename): void;
 /**
  * Creates a message with all registered LLM tools
  *

package/esm/typings/src/utils/environment/$isRunningInBrowser.d.ts

@@ -6,3 +6,6 @@
  * @public exported from `@promptbook/utils`
  */
 export declare const $isRunningInBrowser: Function;
+/**
+ * TODO: [☑]
+ */ 

package/esm/typings/src/utils/environment/$isRunningInJest.d.ts

@@ -6,3 +6,6 @@
  * @public exported from `@promptbook/utils`
  */
 export declare const $isRunningInJest: Function;
+/**
+ * TODO: [☑]
+ */ 

package/esm/typings/src/utils/environment/$isRunningInNode.d.ts

@@ -6,3 +6,6 @@
  * @public exported from `@promptbook/utils`
  */
 export declare const $isRunningInNode: Function;
+/**
+ * TODO: [☑]
+ */ 

package/esm/typings/src/utils/environment/$isRunningInWebWorker.d.ts

@@ -6,3 +6,6 @@
  * @public exported from `@promptbook/utils`
  */
 export declare const $isRunningInWebWorker: Function;
+/**
+ * TODO: [☑]
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/node",
-    "version": "0.84.0-21",
+    "version": "0.84.0",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -38,7 +38,7 @@
         "anthropic",
         "LLMOps"
     ],
-    "license": "UNLICENSED",
+    "license": "BUSL-1.1",
     "bugs": {
         "url": "https://github.com/webgptorg/promptbook/issues"
     },
@@ -47,7 +47,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/node.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.84.0-21"
+        "@promptbook/core": "0.84.0"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -45,7 +45,7 @@
      * @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
@@ -9572,6 +9572,9 @@
      * @public exported from `@promptbook/utils`
      */
     var $isRunningInNode = new Function("\n    try {\n        return this === global;\n    } catch (e) {\n        return false;\n    }\n");
+    /**
+     * TODO: [☑]
+     */
 
     /**
      * Normalize options for `execCommand` and `execCommands`
@@ -10078,107 +10081,6 @@
      * 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 = path.join(rootDirname, pattern);
-                        return [4 /*yield*/, isFileExisting(envFilename, $provideFilesystemForNode())];
-                    case 4:
-                        if (_b.sent()) {
-                            dotenv__namespace.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 = path.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 */
-
     /**
      * @@@
      *
@@ -10191,6 +10093,22 @@
      * 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
      *
@@ -10269,10 +10187,11 @@
             // <- 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__default["default"](function (block) { return "\n                No LLM providers are available.\n\n                ".concat(block(usedEnvMessage), "\n          "); });
         }
-        return spaceTrim__default["default"](function (block) { return "\n            Relevant environment variables:\n            ".concat(block(Object.keys(env)
+        return spaceTrim__default["default"](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;
@@ -10337,6 +10256,108 @@
      * 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 = path.join(rootDirname, pattern);
+                        return [4 /*yield*/, isFileExisting(envFilename, $provideFilesystemForNode())];
+                    case 4:
+                        if (_b.sent()) {
+                            $setUsedEnvFilename(envFilename);
+                            dotenv__namespace.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 = path.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 */
+
     /**
      * @@@
      *
@@ -10490,6 +10511,9 @@
      * @public exported from `@promptbook/utils`
      */
     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
@@ -10499,6 +10523,9 @@
      * @public exported from `@promptbook/utils`
      */
     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
@@ -10508,6 +10535,9 @@
      * @public exported from `@promptbook/utils`
      */
     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: [☑]
+     */
 
     /**
      * Makes first letter of a string uppercase