@promptbook/vercel 0.92.0-3 → 0.92.0-31

package/esm/typings/src/formats/xml/XmlFormatParser.d.ts

@@ -0,0 +1,19 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
+import type { FormatParser } from '../_common/FormatParser';
+/**
+ * Definition for XML format
+ *
+ * @private still in development [🏢]
+ */
+export declare const XmlFormatParser: FormatParser<string, string, TODO_any, TODO_any>;
+/**
+ * TODO: [🧠] Maybe propper instance of object
+ * TODO: [0] Make string_serialized_xml
+ * TODO: [1] Make type for XML Settings and Schema
+ * TODO: [🧠] What to use for validating XMLs - XSD,...
+ * TODO: [🍓] In `XmlFormatParser` implement simple `isValid`
+ * TODO: [🍓] In `XmlFormatParser` implement partial `canBeValid`
+ * TODO: [🍓] In `XmlFormatParser` implement `heal
+ * TODO: [🍓] In `XmlFormatParser` implement `subvalueParsers`
+ * TODO: [🏢] Allow to expect something inside XML and other formats
+ */

package/esm/typings/src/formats/xml/utils/isValidXmlString.d.ts

@@ -2,7 +2,7 @@
  * Function to check if a string is valid XML
  *
  * @param value
- * @returns True if the string is a valid XML string, false otherwise
+ * @returns `true` if the string is a valid XML string, false otherwise
  *
  * @public exported from `@promptbook/utils`
  */

package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts

@@ -1,11 +1,12 @@
 /**
- * Boilerplate is form of app that @@@
+ * Boilerplate is form of app that serves as a template structure for creating other formfactors
+ * and should not be used directly in production.
  *
  * @public exported from `@promptbook/core`
  */
 export declare const BoilerplateFormfactorDefinition: {
     readonly name: "BOILERPLATE";
-    readonly description: "@@@";
+    readonly description: "A template structure for creating new formfactors, providing the base architecture and interfaces that should be implemented.";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [];

package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts

@@ -4,34 +4,43 @@ import type { string_name } from '../../types/typeAliases';
 import type { string_promptbook_documentation_url } from '../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
 /**
- * @@@
+ * AbstractFormfactorDefinition provides the base structure for all form factor implementations
+ * in the Promptbook system. It defines common properties and interfaces that must be
+ * implemented by specific form factors.
  *
  * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/172
  */
 export type AbstractFormfactorDefinition = {
     /**
-     * @@@
+     * Unique identifier for the form factor in SCREAMING_CASE format
+     * Used for programmatic identification and reference
      */
     readonly name: string_name & string_SCREAMING_CASE;
     /**
-     * @@@
+     * Alternative names that can be used to reference this form factor
+     * Also in SCREAMING_CASE format for consistency
      */
     readonly aliasNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
     /**
-     * @@@
+     * Previous names that were used for this form factor but are now deprecated
+     * These are maintained for backward compatibility purposes
      */
     readonly deprecatedNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
     /**
-     * @@@
+     * Human-readable description of the form factor in markdown format
+     * Explains the purpose, functionality, and use cases of this form factor
      */
     readonly description: string_markdown_text;
     /**
-     * @@@
+     * URL pointing to detailed documentation for this form factor
+     * Provides additional resources and guidance for implementation and usage
      */
     readonly documentationUrl: string_promptbook_documentation_url;
     /**
-     * @@@
+     * Defines the interface structure for this form factor's pipeline
+     * Specifies how inputs and outputs are handled, processed, and formatted
+     * Required for properly configuring and executing the form factor's functionality
      */
     readonly pipelineInterface: PipelineInterface;
 };

package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts

@@ -1,6 +1,8 @@
 import { FORMFACTOR_DEFINITIONS } from '../index';
 /**
- * @@@
+ * FormfactorDefinition is a type that defines the structure and capabilities of a specific
+ * application form factor in the Promptbook system. It encapsulates all properties needed
+ * to represent how a particular interface handles inputs, outputs, and behaviors.
  *
  * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/172

package/esm/typings/src/formfactors/_common/string_formfactor_name.d.ts

@@ -1,5 +1,6 @@
 import type { FormfactorDefinition } from './FormfactorDefinition';
 /**
- * @@@
+ * A type alias representing the name of a formfactor, used for type checking and validation
+ * in the formfactor registry and selection processes
  */
 export type string_formfactor_name = FormfactorDefinition['name'];

package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts

@@ -1,12 +1,12 @@
 /**
- * @@@
+ * Chatbot form factor definition for conversational interfaces that interact with users in a chat-like manner.
  *
  * @public exported from `@promptbook/core`
  */
 export declare const ChatbotFormfactorDefinition: {
     readonly name: "CHATBOT";
     readonly aliasNames: readonly ["CHAT"];
-    readonly description: "@@@";
+    readonly description: "A chatbot form factor for conversational user interfaces.";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/174";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{

package/esm/typings/src/formfactors/completion/CompletionFormfactorDefinition.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Completion is formfactor that emulates completion models
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const CompletionFormfactorDefinition: {
+    readonly name: "COMPLETION";
+    readonly description: "Completion is formfactor that emulates completion models";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [{
+            readonly name: "inputText";
+            readonly description: "Input text to be completed";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }, {
+            readonly name: "instructions";
+            readonly description: "Additional instructions for the model, for example the required length, empty by default";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "followingText";
+            readonly description: "Text that follows the input text";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
+    };
+};

package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts

@@ -1,5 +1,6 @@
 /**
- * Generator is form of app that @@@
+ * Generator form factor represents an application that generates content or data based on user input or predefined rules.
+ * This form factor is used for apps that produce outputs, such as text, images, or other media, based on provided input.
  *
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts

@@ -1,11 +1,11 @@
 /**
- * @@@
+ * A generic pipeline
  *
  * @public exported from `@promptbook/core`
  */
 export declare const GenericFormfactorDefinition: {
     readonly name: "GENERIC";
-    readonly description: "@@@";
+    readonly description: "A generic pipeline";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/173";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [];

package/esm/typings/src/formfactors/index.d.ts

@@ -5,7 +5,7 @@
  */
 export declare const FORMFACTOR_DEFINITIONS: readonly [{
     readonly name: "GENERIC";
-    readonly description: "@@@";
+    readonly description: "A generic pipeline";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/173";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [];
@@ -14,7 +14,7 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
 }, {
     readonly name: "CHATBOT";
     readonly aliasNames: readonly ["CHAT"];
-    readonly description: "@@@";
+    readonly description: "A chatbot form factor for conversational user interfaces.";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/174";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{
@@ -36,9 +36,6 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
         readonly outputParameters: readonly [{
             readonly name: "title";
             readonly description: "Title of the conversation";
-            /**
-             * Note: [💞] Ignore a discrepancy between file name and entity name
-             */
             readonly isInput: false;
             readonly isOutput: true;
         }, {
@@ -55,7 +52,7 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
     };
 }, {
     readonly name: "TRANSLATOR";
-    readonly description: "@@@";
+    readonly description: "A text transformation system that converts input content into different forms,\n    including language translations, paraphrasing, style conversions, and tone adjustments.\n    This form factor takes one input and produces one transformed output.";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/175";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{
@@ -74,7 +71,7 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
 }, {
     readonly name: "SHEETS";
     readonly aliasNames: readonly ["SHEETS", "SHEET"];
-    readonly description: "@@@";
+    readonly description: "A formfactor for processing spreadsheet-like data in CSV format, enabling AI transformations on tabular data";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/176";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{
@@ -92,7 +89,7 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
     };
 }, {
     readonly name: "EXPERIMENTAL_MATCHER";
-    readonly description: "@@@";
+    readonly description: "An evaluation system that determines whether content meets specific criteria or patterns.\n    Used for content validation, quality assessment, and intelligent filtering tasks. Currently in experimental phase.";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/177";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{
@@ -132,6 +129,11 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
             readonly isInput: true;
             readonly isOutput: false;
         }];
+        /**
+         * All available formfactor definitions
+         *
+         * @public exported from `@promptbook/core`
+         */
         readonly outputParameters: readonly [{
             readonly name: "prompt";
             readonly description: "Prompt to be used for image generation";
@@ -139,6 +141,29 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
             readonly isOutput: true;
         }];
     };
+}, {
+    readonly name: "COMPLETION";
+    readonly description: "Completion is formfactor that emulates completion models";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [{
+            readonly name: "inputText";
+            readonly description: "Input text to be completed";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }, {
+            readonly name: "instructions";
+            readonly description: "Additional instructions for the model, for example the required length, empty by default";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "followingText";
+            readonly description: "Text that follows the input text";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
+    };
 }];
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts

@@ -1,11 +1,13 @@
 /**
- * Matcher is form of app that @@@
+ * Matcher is form of app that evaluates (spreadsheet) content against defined criteria or patterns,
+ * determining if it matches or meets specific requirements. Used for classification,
+ * validation, filtering, and quality assessment of inputs.
  *
  * @public exported from `@promptbook/core`
  */
 export declare const MatcherFormfactorDefinition: {
     readonly name: "EXPERIMENTAL_MATCHER";
-    readonly description: "@@@";
+    readonly description: "An evaluation system that determines whether content meets specific criteria or patterns.\n    Used for content validation, quality assessment, and intelligent filtering tasks. Currently in experimental phase.";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/177";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{

package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts

@@ -1,12 +1,13 @@
 /**
- * Sheets is form of app that @@@
+ * Sheets is form of app that processes tabular data in CSV format, allowing transformation
+ * and analysis of structured data through AI-powered operations
  *
  * @public exported from `@promptbook/core`
  */
 export declare const SheetsFormfactorDefinition: {
     readonly name: "SHEETS";
     readonly aliasNames: readonly ["SHEETS", "SHEET"];
-    readonly description: "@@@";
+    readonly description: "A formfactor for processing spreadsheet-like data in CSV format, enabling AI transformations on tabular data";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/176";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{

package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts

@@ -1,11 +1,12 @@
 /**
- * Translator is form of app that @@@
+ * Translator is form of app that transforms input text from one form to another,
+ * such as language translation, style conversion, tone modification, or other text transformations.
  *
  * @public exported from `@promptbook/core`
  */
 export declare const TranslatorFormfactorDefinition: {
     readonly name: "TRANSLATOR";
-    readonly description: "@@@";
+    readonly description: "A text transformation system that converts input content into different forms,\n    including language translations, paraphrasing, style conversions, and tone adjustments.\n    This form factor takes one input and produces one transformed output.";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/175";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{

package/esm/typings/src/high-level-abstractions/index.d.ts

@@ -23,7 +23,7 @@ export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
             path: string | null;
             content: import("../pipeline/PipelineString").PipelineString;
         }[];
-        readonly formfactorName?: "CHATBOT" | "GENERATOR" | "GENERIC" | "IMAGE_GENERATOR" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
+        readonly formfactorName?: "CHATBOT" | "COMPLETION" | "GENERATOR" | "GENERIC" | "IMAGE_GENERATOR" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
     }>): void;
 }, {
     type: "SYNC";
@@ -45,7 +45,7 @@ export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
             path: string | null;
             content: import("../pipeline/PipelineString").PipelineString;
         }[];
-        readonly formfactorName?: "CHATBOT" | "GENERATOR" | "GENERIC" | "IMAGE_GENERATOR" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
+        readonly formfactorName?: "CHATBOT" | "COMPLETION" | "GENERATOR" | "GENERIC" | "IMAGE_GENERATOR" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
     }>): void;
 }];
 /**

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

@@ -1,13 +1,13 @@
 import { $Register } from '../../../utils/$Register';
 import type { LlmToolsMetadata } from './LlmToolsMetadata';
 /**
- * @@@
+ * Register for LLM tools metadata.
  *
  * Note: `$` is used to indicate that this interacts with the global scope
- * @singleton Only one instance of each register is created per build, but thare can be more @@@
+ * @singleton Only one instance of each register is created per build, but there can be more instances across different builds or environments.
  * @public exported from `@promptbook/core`
  */
 export declare const $llmToolsMetadataRegister: $Register<LlmToolsMetadata>;
 /**
  * TODO: [®] DRY Register logic
- */ 
+ */

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

@@ -1,13 +1,13 @@
 import type { LlmExecutionToolsConstructor } from '../../../execution/LlmExecutionToolsConstructor';
 import { $Register } from '../../../utils/$Register';
 /**
- * @@@
+ * Register for LLM tools.
  *
  * Note: `$` is used to indicate that this interacts with the global scope
- * @singleton Only one instance of each register is created per build, but thare can be more @@@
+ * @singleton Only one instance of each register is created per build, but there can be more instances across different builds or environments.
  * @public exported from `@promptbook/core`
  */
 export declare const $llmToolsRegister: $Register<LlmExecutionToolsConstructor>;
 /**
  * TODO: [®] DRY Register logic
- */ 
+ */

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

@@ -1,8 +1,7 @@
 import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
 /**
- * @@@
+ * Provides LLM tools configuration by reading environment variables.
  *
- * @@@ .env
  * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file
  *
  * It looks for environment variables:
@@ -10,10 +9,11 @@ import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
  * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
  * - ...
  *
- * @returns @@@
+ * @see Environment variables documentation or .env file for required variables.
+ * @returns A promise that resolves to the LLM tools configuration, or null if configuration is incomplete or missing.
  * @public exported from `@promptbook/node`
  */
 export declare function $provideLlmToolsConfigurationFromEnv(): Promise<LlmToolsConfiguration>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- */
+ */ 

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

@@ -3,7 +3,8 @@ import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage
 import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFromConfiguration';
 type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromConfigurationOptions & {
     /**
-     * @@@
+     * Flag indicating whether the cache should be reloaded or reused
+     * When set to true, the existing cache will not be used but thinks will be still saved to the cache
      *
      * @default false
      */
@@ -22,5 +23,5 @@ export {};
  * Note: [⚪] This should never be in any released package
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
- * TODO: [®] DRY Register logic
- */
+ * TODO: [®] DRY Register logi
+ */ 

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

@@ -1,11 +1,14 @@
 import { MultipleLlmExecutionTools } from '../../multiple/MultipleLlmExecutionTools';
 import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFromConfiguration';
 /**
- * @@@
+ * Automatically configures LLM tools from environment variables in Node.js
+ *
+ * This utility function detects available LLM providers based on environment variables
+ * and creates properly configured LLM execution tools for each detected provider.
  *
  * Note: This function is not cached, every call creates new instance of `MultipleLlmExecutionTools`
  *
- * @@@ .env
+ * Supports environment variables from .env files when dotenv is configured
  * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file
  *
  * It looks for environment variables:
@@ -13,12 +16,22 @@ import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFro
  * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
  * - ...
  *
- * @returns @@@
+ * @param options Configuration options for the LLM tools
+ * @returns A unified interface containing all detected and configured LLM tools
  * @public exported from `@promptbook/node`
  */
 export declare function $provideLlmToolsFromEnv(options?: CreateLlmToolsFromConfigurationOptions): Promise<MultipleLlmExecutionTools>;
 /**
- * TODO: @@@ write `$provideLlmToolsFromEnv` vs `$provideLlmToolsConfigurationFromEnv` vs `createLlmToolsFromConfiguration`
+ * TODO: The architecture for LLM tools configuration consists of three key functions:
+ * 1. `$provideLlmToolsFromEnv` - High-level function that detects available providers from env vars and returns ready-to-use LLM tools
+ * 2. `$provideLlmToolsConfigurationFromEnv` - Middle layer that extracts configuration objects from environment variables
+ * 3. `createLlmToolsFromConfiguration` - Low-level function that instantiates LLM tools from explicit configuration
+ *
+ * This layered approach allows flexibility in how tools are configured:
+ * - Use $provideLlmToolsFromEnv for automatic detection and setup in Node.js environments
+ * - Use $provideLlmToolsConfigurationFromEnv to extract config objects for modification before instantiation
+ * - Use createLlmToolsFromConfiguration for explicit control over tool configurations
+ *
  * TODO: [🧠][🍛] Which name is better `$provideLlmToolsFromEnv` or `$provideLlmToolsFromEnvironment`?
  * 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

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

@@ -2,17 +2,24 @@ import type { string_title } from '../../../types/typeAliases';
 import type { Registered } from '../../../utils/$Register';
 import type { LlmToolsOptions } from './LlmToolsOptions';
 /**
- * @@@
+ * Configuration definition for LLM execution tools, containing provider-specific settings
+ * that can be passed during runtime to instantiate and configure LLM tools properly.
  *
- * @@@ `LlmToolsMetadata` vs `LlmToolsConfiguration` vs `LlmToolsOptions` (vs `Registered`)
+ * The Promptbook LLM tools architecture involves several related types:
+ * - `LlmToolsMetadata`: Contains static metadata about the tool, such as name, version, and capabilities
+ * - `LlmToolsConfiguration`: Runtime configuration from environment variables or settings
+ * - `LlmToolsOptions`: Provider-specific options for instantiating tools
+ * - `Registered`: The record of a registered tool in the global registry
  */
 export type LlmToolsConfiguration = ReadonlyArray<Registered & {
     /**
-     * @@@
+     * Human-readable name for this specific provider configuration
+     * Used in UI components and logs for identifying this particular configuration
      */
     readonly title: string_title;
     /**
-     * @@@
+     * Provider-specific configuration options used for instantiating and configuring LLM tools
+     * Contains values like API keys, model preferences, endpoint URLs, and other settings
      */
     readonly options: LlmToolsOptions;
 }>;

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

@@ -1,18 +1,34 @@
+import { MODEL_ORDERS } from '../../../constants';
+import { MODEL_TRUST_LEVELS } from '../../../constants';
 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';
 /**
- * @@@
+ * Metadata definition for LLM execution tools that provides information about a provider's capabilities,
+ * configuration options, and relationships within the registry system.
  *
- * @@@ `LlmToolsMetadata` vs `LlmToolsConfiguration` vs `LlmToolsOptions` (vs `Registered`)
+ * The Promptbook LLM tools architecture involves several related types:
+ * - `LlmToolsMetadata`: Contains static metadata about the tool, such as name, version, and capabilities
+ * - `LlmToolsConfiguration`: Runtime configuration from environment variables or settings
+ * - `LlmToolsOptions`: Provider-specific options for instantiating tools
+ * - `Registered`: The record of a registered tool in the global registry
  */
 export type LlmToolsMetadata = Registered & {
     /**
-     * @@@
+     * Human-readable display name for the LLM provider
+     * Used in UI components and documentation references
      */
     readonly title: string_title;
+    /**
+     * How is the model is trusted?
+     */
+    readonly trustLevel: keyof typeof MODEL_TRUST_LEVELS;
+    /**
+     * How is the model provider important and should be sorted in the list of available providers?
+     */
+    readonly order: typeof MODEL_ORDERS[keyof typeof MODEL_ORDERS] | number;
     /**
      * List of environment variables that can be used to configure the provider
      *
@@ -21,11 +37,17 @@ export type LlmToolsMetadata = Registered & {
      */
     readonly envVariables: ReadonlyArray<string_name & string_SCREAMING_CASE> | null;
     /**
-     * @@@
+     * Provides a default configuration template for this LLM provider
+     * Used to generate example configurations or as fallback when no specific configuration is provided
+     * @returns A standardized configuration object for this LLM provider
      */
     getBoilerplateConfiguration(): LlmToolsConfiguration[number];
     /**
-     * @@@
+     * Creates a provider-specific configuration object from environment variables
+     * Used to automatically configure LLM tools based on available environment settings
+     *
+     * @param env Dictionary of environment variables (key-value pairs)
+     * @returns Configuration object for this LLM provider if required variables are present, or null if configuration is not possible
      */
     createConfigurationFromEnv(env: Record<string_name, string>): LlmToolsConfiguration[number] | null;
 };

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

@@ -1,8 +1,15 @@
 import type { TODO_object } from '../../../utils/organization/TODO_object';
 /**
- * @@@
+ * Options for configuring LLM (Large Language Model) tools.
  *
- * @@@ `LlmToolsMetadata` vs `LlmToolsConfiguration` vs `LlmToolsOptions` (vs `Registered`)
+ * This type is used to pass provider-specific options to LLM execution tools.
+ *
+ *
+ * The Promptbook LLM tools architecture involves several related types:
+ * - `LlmToolsMetadata`: Contains static metadata about the tool, such as name, version, and capabilities
+ * - `LlmToolsConfiguration`: Runtime configuration from environment variables or settings
+ * - `LlmToolsOptions`: Provider-specific options for instantiating tools
+ * - `Registered`: The record of a registered tool in the global registry
  */
 export type LlmToolsOptions = TODO_object;
 /**

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

@@ -21,18 +21,27 @@ export type CreateLlmToolsFromConfigurationOptions = {
     readonly userId?: string_user_id;
 };
 /**
- * @@@
+ * Creates LLM execution tools from provided configuration objects
+ *
+ * Instantiates and configures LLM tool instances for each configuration entry,
+ * combining them into a unified interface via MultipleLlmExecutionTools.
  *
  * Note: This function is not cached, every call creates new instance of `MultipleLlmExecutionTools`
  *
- * @returns @@@
+ * @param configuration Array of LLM tool configurations to instantiate
+ * @param options Additional options for configuring the LLM tools
+ * @returns A unified interface combining all successfully instantiated LLM tools
  * @public exported from `@promptbook/core`
  */
 export declare function createLlmToolsFromConfiguration(configuration: LlmToolsConfiguration, options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;
 /**
  * TODO: [🎌] Together with `createLlmToolsFromConfiguration` + 'EXECUTION_TOOLS_CLASSES' gets to `@promptbook/core` ALL model providers, make this more efficient
  * TODO: [🧠][🎌] Dynamically install required providers
- * TODO: @@@ write discussion about this - wizzard
+ * TODO: We should implement an interactive configuration wizard that would:
+ *       1. Detect which LLM providers are available in the environment
+ *       2. Guide users through required configuration settings for each provider
+ *       3. Allow testing connections before completing setup
+ *       4. Generate appropriate configuration code for application integration
  * TODO: [🧠][🍛] Which name is better `createLlmToolsFromConfig` or `createLlmToolsFromConfiguration`?
  * TODO: [🧠] Is there some meaningfull way how to test this util
  * TODO: This should be maybe not under `_common` but under `utils`