@promptbook/core 0.77.0-5 → 0.77.0-6

package/esm/index.es.js

@@ -8,6 +8,7 @@ import { SHA256 } from 'crypto-js';
 import hexEncoder from 'crypto-js/enc-hex';
 import { lookup } from 'mime-types';
 import moment from 'moment';
+import colors from 'colors';
 import sha256 from 'crypto-js/sha256';
 
 // ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
@@ -22,7 +23,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  *
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.77.0-4';
+var PROMPTBOOK_ENGINE_VERSION = '0.77.0-5';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -9606,6 +9607,15 @@ var $llmToolsRegister = new $Register('llm_execution_tools_constructors');
  * TODO: [®] DRY Register logic
  */
 
+/**
+ * Detects if the code is running in a Node.js 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 $isRunningInNode = new Function("\n    try {\n        return this === global;\n    } catch (e) {\n        return false;\n    }\n");
+
 /**
  * Creates a message with all registered LLM tools
  *
@@ -9615,20 +9625,21 @@ var $llmToolsRegister = new $Register('llm_execution_tools_constructors');
  */
 function $registeredLlmToolsMessage() {
     var e_1, _a, e_2, _b;
+    var env = process.env;
     /**
      * Mixes registered LLM tools from $llmToolsMetadataRegister and $llmToolsRegister
      */
     var all = [];
-    var _loop_1 = function (packageName, className, envVariables) {
+    var _loop_1 = function (title, packageName, className, envVariables) {
         if (all.some(function (item) { return item.packageName === packageName && item.className === className; })) {
             return "continue";
         }
-        all.push({ packageName: packageName, className: className, envVariables: envVariables });
+        all.push({ title: title, packageName: packageName, className: className, envVariables: envVariables });
     };
     try {
         for (var _c = __values($llmToolsMetadataRegister.list()), _d = _c.next(); !_d.done; _d = _c.next()) {
-            var _e = _d.value, packageName = _e.packageName, className = _e.className, envVariables = _e.envVariables;
-            _loop_1(packageName, className, envVariables);
+            var _e = _d.value, title = _e.title, packageName = _e.packageName, className = _e.className, envVariables = _e.envVariables;
+            _loop_1(title, packageName, className, envVariables);
         }
     }
     catch (e_1_1) { e_1 = { error: e_1_1 }; }
@@ -9658,6 +9669,7 @@ function $registeredLlmToolsMessage() {
         finally { if (e_2) throw e_2.error; }
     }
     var metadata = all.map(function (metadata) {
+        var _a, _b;
         var isMetadataAviailable = $llmToolsMetadataRegister
             .list()
             .find(function (_a) {
@@ -9670,46 +9682,77 @@ function $registeredLlmToolsMessage() {
             var packageName = _a.packageName, className = _a.className;
             return metadata.packageName === packageName && metadata.className === className;
         });
-        return __assign(__assign({}, metadata), { isMetadataAviailable: isMetadataAviailable, isInstalled: isInstalled });
+        var isFullyConfigured = ((_a = metadata.envVariables) === null || _a === void 0 ? void 0 : _a.every(function (envVariableName) { return env[envVariableName] !== undefined; })) || false;
+        var isPartiallyConfigured = ((_b = metadata.envVariables) === null || _b === void 0 ? void 0 : _b.some(function (envVariableName) { return env[envVariableName] !== undefined; })) || false;
+        // <- Note: [🗨]
+        return __assign(__assign({}, metadata), { isMetadataAviailable: isMetadataAviailable, isInstalled: isInstalled, isFullyConfigured: isFullyConfigured, isPartiallyConfigured: isPartiallyConfigured });
     });
     if (metadata.length === 0) {
         return "No LLM providers are available.";
     }
-    return spaceTrim(function (block) { return "\n            Available LLM providers are:\n            ".concat(block(metadata
+    return spaceTrim(function (block) { return "\n            Relevant environment variables:\n            ".concat(block(Object.keys(env)
+        .filter(function (envVariableName) {
+        return metadata.some(function (_a) {
+            var envVariables = _a.envVariables;
+            return envVariables === null || envVariables === void 0 ? void 0 : envVariables.includes(envVariableName);
+        });
+    })
+        .map(function (envVariableName) { return "- `".concat(envVariableName, "`"); })
+        .join('\n')), "\n\n            Available LLM providers are:\n            ").concat(block(metadata
         .map(function (_a, i) {
-        var packageName = _a.packageName, className = _a.className, envVariables = _a.envVariables, isMetadataAviailable = _a.isMetadataAviailable, isInstalled = _a.isInstalled;
-        var more;
-        if (just(false)) {
-            more = '';
-        }
+        var title = _a.title, packageName = _a.packageName, className = _a.className, envVariables = _a.envVariables, isMetadataAviailable = _a.isMetadataAviailable, isInstalled = _a.isInstalled, isFullyConfigured = _a.isFullyConfigured, isPartiallyConfigured = _a.isPartiallyConfigured;
+        var morePieces = [];
+        if (just(false)) ;
         else if (!isMetadataAviailable && !isInstalled) {
             // TODO: [�][�] Maybe do allow to do auto-install if package not registered and not found
-            more = "(not installed and no metadata, looks like a unexpected behavior)";
+            morePieces.push("Not installed and no metadata, looks like a unexpected behavior");
         }
         else if (isMetadataAviailable && !isInstalled) {
             // TODO: [�][�]
-            more = "(not installed)";
+            morePieces.push("Not installed");
         }
         else if (!isMetadataAviailable && isInstalled) {
-            more = "(no metadata, looks like a unexpected behavior)";
+            morePieces.push("No metadata but installed, looks like a unexpected behavior");
         }
         else if (isMetadataAviailable && isInstalled) {
-            more = "(installed)";
+            morePieces.push("Installed");
+        }
+        else {
+            morePieces.push("unknown state, looks like a unexpected behavior");
+        } /* not else */
+        if (isFullyConfigured) {
+            morePieces.push("Configured");
+        }
+        else if (isPartiallyConfigured) {
+            morePieces.push("Partially confugured, missing ".concat(envVariables === null || envVariables === void 0 ? void 0 : envVariables.filter(function (envVariable) { return env[envVariable] === undefined; }).join(' + ')));
         }
         else {
-            more = "(unknown state, looks like a unexpected behavior)";
+            if (envVariables !== null) {
+                morePieces.push("Not configured, to configure set env ".concat(envVariables === null || envVariables === void 0 ? void 0 : envVariables.join(' + ')));
+            }
+            else {
+                morePieces.push("Not configured"); // <- Note: Can not be configured via environment variables
+            }
         }
-        var envVariablesMessage = '';
-        if (envVariables) {
-            envVariablesMessage = 'Configured by ' + envVariables.join(' + ');
+        var providerMessage = spaceTrim("\n                                ".concat(i + 1, ") **").concat(title, "** `").concat(className, "` from `").concat(packageName, "`\n                                    ").concat(morePieces.join('; '), "\n                            "));
+        if ($isRunningInNode) {
+            if (isInstalled && isFullyConfigured) {
+                providerMessage = colors.green(providerMessage);
+            }
+            else if (isInstalled && isPartiallyConfigured) {
+                providerMessage = colors.yellow(providerMessage);
+            }
+            else {
+                providerMessage = colors.gray(providerMessage);
+            }
         }
-        return spaceTrim("\n                            ".concat(i + 1, ") `").concat(className, "` from `").concat(packageName, "`\n                                      ").concat(more, "\n                                      ").concat(envVariablesMessage, "\n                        "));
-        // <- TODO: !!!!!! Is this indented correctly?
+        return providerMessage;
     })
         .join('\n')), "\n        "); });
 }
 /**
  * TODO: [®] DRY Register logic
+ * TODO: [🧠][⚛] Maybe pass env as argument
  */
 
 /**
@@ -10060,7 +10103,23 @@ var _AzureOpenAiMetadataRegistration = $llmToolsMetadataRegister.register({
         else if (typeof env.AZUREOPENAI_RESOURCE_NAME === 'string' ||
             typeof env.AZUREOPENAI_DEPLOYMENT_NAME === 'string' ||
             typeof env.AZUREOPENAI_API_KEY === 'string') {
-            throw new Error(spaceTrim("\n                    You must provide all of the following environment variables:\n\n                    - AZUREOPENAI_RESOURCE_NAME (".concat(typeof env.AZUREOPENAI_RESOURCE_NAME === 'string' ? 'defined' : 'not defined', ")\n                    - AZUREOPENAI_DEPLOYMENT_NAME (").concat(typeof env.AZUREOPENAI_DEPLOYMENT_NAME === 'string' ? 'defined' : 'not defined', ")\n                    - AZUREOPENAI_API_KEY (").concat(typeof env.AZUREOPENAI_API_KEY === 'string' ? 'defined' : 'not defined', ")\n                ")));
+            return null;
+            /*
+            Note: [🗨] Partial configuration is handled more gracefully elsewhere
+            > throw new Error(
+            >     spaceTrim(`
+            >         You must provide all of the following environment variables:
+            >
+            >         - AZUREOPENAI_RESOURCE_NAME (${
+            >             typeof env.AZUREOPENAI_RESOURCE_NAME === 'string' ? 'defined' : 'not defined'
+            >         })
+            >         - AZUREOPENAI_DEPLOYMENT_NAME (${
+            >             typeof env.AZUREOPENAI_DEPLOYMENT_NAME === 'string' ? 'defined' : 'not defined'
+            >         })
+            >         - AZUREOPENAI_API_KEY (${typeof env.AZUREOPENAI_API_KEY === 'string' ? 'defined' : 'not defined'})
+            >     `),
+            > );
+            */
         }
         return null;
     },
@@ -10179,9 +10238,8 @@ var _OpenAiAssistantMetadataRegistration = $llmToolsMetadataRegister.register({
     title: 'Open AI Assistant',
     packageName: '@promptbook/openai',
     className: 'OpenAiAssistantExecutionTools',
-    envVariables: [
-    /* TODO: 'OPENAI_API_KEY', 'OPENAI_ASSISTANT_ID' */
-    ],
+    envVariables: null,
+    //            <- TODO: ['OPENAI_API_KEY', 'OPENAI_ASSISTANT_ID']
     getBoilerplateConfiguration: function () {
         return {
             title: 'Open AI Assistant (boilerplate)',