@promptbook/core 0.77.0-5 → 0.77.0-6

package/esm/typings/src/_packages/types.index.d.ts

@@ -145,6 +145,7 @@ import type { string_reserved_parameter_name } from '../types/typeAliases';
 import type { ReservedParameters } from '../types/typeAliases';
 import type { string_title } from '../types/typeAliases';
 import type { string_persona_description } from '../types/typeAliases';
+import type { string_model_description } from '../types/typeAliases';
 import type { string_knowledge_source_content } from '../types/typeAliases';
 import type { string_knowledge_source_link } from '../types/typeAliases';
 import type { string_html } from '../types/typeAliases';
@@ -402,6 +403,7 @@ export type { string_reserved_parameter_name };
 export type { ReservedParameters };
 export type { string_title };
 export type { string_persona_description };
+export type { string_model_description };
 export type { string_knowledge_source_content };
 export type { string_knowledge_source_link };
 export type { string_html };

package/esm/typings/src/execution/AvailableModel.d.ts

@@ -1,4 +1,5 @@
 import type { ModelVariant } from '../types/ModelVariant';
+import type { string_model_description } from '../types/typeAliases';
 import type { string_model_name } from '../types/typeAliases';
 import type { string_title } from '../types/typeAliases';
 /**
@@ -6,19 +7,32 @@ import type { string_title } from '../types/typeAliases';
  */
 export type AvailableModel = {
     /**
-     * The model title
+     * The model title, when not provided, the `modelName` should be used
+     *
+     * @example "GPT o1"
      */
     readonly modelTitle?: string_title;
     /**
      * The model name aviailable
+     *
+     * @example "o1"
      */
     readonly modelName: string_model_name;
     /**
      * Variant of the model
+     *
+     * @example "CHAT"
      */
     readonly modelVariant: ModelVariant;
+    /**
+     * Unstructured description of the model
+     *
+     * This will be used to pick the best available model for each task
+     *
+     * @example "Model with 1 billion parameters and advanced reasoning capabilities"
+     */
+    readonly modelDescription?: string_model_description;
 };
 /**
- * TODO: !!!!!! Maybe remove `modelTitle`
  * TODO: !!!!!! Put pricing information here
  */

package/esm/typings/src/execution/LlmExecutionTools.d.ts

@@ -26,7 +26,7 @@ export type LlmExecutionTools = {
      *
      * @example "Use all models from OpenAI"
      */
-    readonly description: string_markdown;
+    readonly description?: string_markdown;
     /**
      * Check comfiguration
      *

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

@@ -21,5 +21,5 @@ export declare function $provideLlmToolsConfigurationFromEnv(): LlmToolsConfigur
  * 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: [🧠][⚛] Maybe pass env as argument
  * TODO: [®] DRY Register logic */

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

@@ -9,4 +9,5 @@ import type { string_markdown } from '../../../types/typeAliases';
 export declare function $registeredLlmToolsMessage(): string_markdown;
 /**
  * TODO: [®] DRY Register logic
+ * TODO: [🧠][⚛] Maybe pass env as argument
  */

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

@@ -1,7 +1,7 @@
-import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { string_name } from '../../../types/typeAliases';
 import type { string_title } from '../../../types/typeAliases';
 import type { Registered } from '../../../utils/$Register';
+import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
 /**
  * @@@
@@ -14,9 +14,12 @@ export type LlmToolsMetadata = Registered & {
      */
     readonly title: string_title;
     /**
-     * @@@
+     * List of environment variables that can be used to configure the provider
+     *
+     * If `[]`, empty array, it means that the provider is available automatically without any configuration
+     * If `null`, it means that the provider can not be configured via environment variables
      */
-    readonly envVariables: ReadonlyArray<string_name & string_SCREAMING_CASE>;
+    readonly envVariables: ReadonlyArray<string_name & string_SCREAMING_CASE> | null;
     /**
      * @@@
      */

package/esm/typings/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts

@@ -1,12 +1,9 @@
 import type { createGoogleGenerativeAI } from '@ai-sdk/google';
-import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { VercelExecutionToolsOptions } from '../vercel/VercelExecutionToolsOptions';
 /**
  * Options for `GoogleExecutionTools`
  *
- * !!!!!! This extends Google's `ClientOptions` with are directly passed to the Google generative AI client.
+ * This combines options for Promptbook, Google and Vercel together
  * @public exported from `@promptbook/google`
  */
-export type GoogleExecutionToolsOptions = CommonToolsOptions & Parameters<typeof createGoogleGenerativeAI>[0];
-/**
- * TODO: [🧠][🤺] Pass `userId`
- */
+export type GoogleExecutionToolsOptions = Omit<VercelExecutionToolsOptions, 'title' | 'description' | 'vercelProvider' | 'availableModels'> & Parameters<typeof createGoogleGenerativeAI>[0];

package/esm/typings/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts

@@ -1,12 +1,13 @@
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { VercelProvider } from './VercelProvider';
 /**
  * Options for `createExecutionToolsFromVercelProvider`
  *
  * @public exported from `@promptbook/google`
  */
-export type VercelExecutionToolsOptions = CommonToolsOptions & {
+export type VercelExecutionToolsOptions = CommonToolsOptions & Pick<LlmExecutionTools, 'title' | 'description'> & {
     /**
      * Vercel provider for the execution tools
      */

package/esm/typings/src/llm-providers/vercel/createExecutionToolsFromVercelProvider.d.ts

@@ -1,7 +1,7 @@
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { VercelExecutionToolsOptions } from './VercelExecutionToolsOptions';
 /**
- * !!!!!!
+ * Adapter which creates Promptbook execution tools from Vercel provider
  *
  * @public exported from `@promptbook/vercel`
  */

package/esm/typings/src/types/typeAliases.d.ts

@@ -128,11 +128,17 @@ export type ReservedParameters = Record<string_reserved_parameter_name, string_p
  */
 export type string_title = string;
 /**
- * Description of persona
+ * Unstructured description of the persona
  *
  * For example `"Skilled copywriter"`
  */
 export type string_persona_description = string;
+/**
+ * Unstructured description of the model
+ *
+ * For example `"Model with logical reasoning and creative mindset"`
+ */
+export type string_model_description = string;
 /**
  * Source of one knowledge
  *

package/esm/typings/src/utils/serialization/asSerializable.d.ts

@@ -0,0 +1,11 @@
+import type { really_any } from '../organization/really_any';
+/**
+ * Function `asSerializable` will convert values which are not serializable to serializable values
+ * It walks deeply through the object and converts all values
+ *
+ * For example:
+ * - `Date` objects will be converted to string
+ *
+ * @private Internal helper function
+ */
+export declare function asSerializable(value: really_any): really_any;

package/esm/typings/src/utils/serialization/asSerializable.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.77.0-5",
+    "version": "0.77.0-6",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -54,6 +54,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/core.index.d.ts",
     "dependencies": {
+        "colors": "1.4.0",
         "crypto-js": "4.2.0",
         "moment": "2.30.1",
         "papaparse": "5.4.1",

package/umd/index.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('spacetrim'), require('prettier'), require('prettier/parser-html'), require('waitasecond'), require('papaparse'), require('path'), require('crypto-js'), require('crypto-js/enc-hex'), require('mime-types'), require('moment'), require('crypto-js/sha256')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'spacetrim', 'prettier', 'prettier/parser-html', 'waitasecond', 'papaparse', 'path', 'crypto-js', 'crypto-js/enc-hex', 'mime-types', 'moment', 'crypto-js/sha256'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-core"] = {}, global.spaceTrim, global.prettier, global.parserHtml, global.waitasecond, global.papaparse, global.path, global.cryptoJs, global.hexEncoder, global.mimeTypes, global.moment, global.sha256));
-})(this, (function (exports, spaceTrim, prettier, parserHtml, waitasecond, papaparse, path, cryptoJs, hexEncoder, mimeTypes, moment, sha256) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('spacetrim'), require('prettier'), require('prettier/parser-html'), require('waitasecond'), require('papaparse'), require('path'), require('crypto-js'), require('crypto-js/enc-hex'), require('mime-types'), require('moment'), require('colors'), require('crypto-js/sha256')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'spacetrim', 'prettier', 'prettier/parser-html', 'waitasecond', 'papaparse', 'path', 'crypto-js', 'crypto-js/enc-hex', 'mime-types', 'moment', 'colors', 'crypto-js/sha256'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-core"] = {}, global.spaceTrim, global.prettier, global.parserHtml, global.waitasecond, global.papaparse, global.path, global.cryptoJs, global.hexEncoder, global.mimeTypes, global.moment, global.colors, global.sha256));
+})(this, (function (exports, spaceTrim, prettier, parserHtml, waitasecond, papaparse, path, cryptoJs, hexEncoder, mimeTypes, moment, colors, sha256) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -10,6 +10,7 @@
     var parserHtml__default = /*#__PURE__*/_interopDefaultLegacy(parserHtml);
     var hexEncoder__default = /*#__PURE__*/_interopDefaultLegacy(hexEncoder);
     var moment__default = /*#__PURE__*/_interopDefaultLegacy(moment);
+    var colors__default = /*#__PURE__*/_interopDefaultLegacy(colors);
     var sha256__default = /*#__PURE__*/_interopDefaultLegacy(sha256);
 
     // ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
@@ -24,7 +25,7 @@
      *
      * @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
@@ -9608,6 +9609,15 @@
      * 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
      *
@@ -9617,20 +9627,21 @@
      */
     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 }; }
@@ -9660,6 +9671,7 @@
             finally { if (e_2) throw e_2.error; }
         }
         var metadata = all.map(function (metadata) {
+            var _a, _b;
             var isMetadataAviailable = $llmToolsMetadataRegister
                 .list()
                 .find(function (_a) {
@@ -9672,46 +9684,77 @@
                 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__default["default"](function (block) { return "\n            Available LLM providers are:\n            ".concat(block(metadata
+        return spaceTrim__default["default"](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__default["default"]("\n                                ".concat(i + 1, ") **").concat(title, "** `").concat(className, "` from `").concat(packageName, "`\n                                    ").concat(morePieces.join('; '), "\n                            "));
+            if ($isRunningInNode) {
+                if (isInstalled && isFullyConfigured) {
+                    providerMessage = colors__default["default"].green(providerMessage);
+                }
+                else if (isInstalled && isPartiallyConfigured) {
+                    providerMessage = colors__default["default"].yellow(providerMessage);
+                }
+                else {
+                    providerMessage = colors__default["default"].gray(providerMessage);
+                }
             }
-            return spaceTrim__default["default"]("\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
      */
 
     /**
@@ -10062,7 +10105,23 @@
             else if (typeof env.AZUREOPENAI_RESOURCE_NAME === 'string' ||
                 typeof env.AZUREOPENAI_DEPLOYMENT_NAME === 'string' ||
                 typeof env.AZUREOPENAI_API_KEY === 'string') {
-                throw new Error(spaceTrim__default["default"]("\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;
         },
@@ -10181,9 +10240,8 @@
         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)',