@promptbook/components 0.100.0-24

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

@@ -0,0 +1,21 @@
+/**
+ * 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: "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 [{
+            readonly name: "nonce";
+            readonly description: "Just to prevent EXPERIMENTAL_MATCHER to be set as implicit formfactor";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [];
+    };
+};

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

@@ -0,0 +1,26 @@
+/**
+ * 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: "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 [{
+            readonly name: "inputSheet";
+            readonly description: "Input sheet to be processed as csv";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "outputSheet";
+            readonly description: "Output sheet as csv";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
+    };
+};

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

@@ -0,0 +1,25 @@
+/**
+ * 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: "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 [{
+            readonly name: "inputMessage";
+            readonly description: "Input message to be translated";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "outputMessage";
+            readonly description: "Translated output message";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
+    };
+};

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

@@ -0,0 +1,20 @@
+import type { $PipelineJson } from '../../commands/_common/types/CommandParser';
+/**
+ * Used in `parsePipeline`
+ *
+ * @private
+ */
+export type SyncHighLevelAbstraction = {
+    type: 'SYNC';
+    /**
+     * Apply the abstraction to the `pipelineJson`
+     *
+     * Note: `$` is used to indicate that this function mutates given `pipelineJson`
+     */
+    $applyToPipelineJson($pipelineJson: $PipelineJson): void;
+};
+/**
+ * TODO: [♓️] Add order here
+ * TODO: [🧠][🍱] Maybe make some common abstraction between `HighLevelAbstraction` and `CommandParser`
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/high-level-abstractions/implicit-formfactor/ImplicitFormfactorHla.d.ts

@@ -0,0 +1,10 @@
+import type { $PipelineJson } from '../../commands/_common/types/CommandParser';
+/**
+ * Set formfactor based on the pipeline interface e
+ *
+ * @private
+ */
+export declare const ImplicitFormfactorHla: {
+    type: "SYNC";
+    $applyToPipelineJson($pipelineJson: $PipelineJson): void;
+};

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

@@ -0,0 +1,54 @@
+/**
+ * All high-level abstractions
+ *
+ * @private internal index of `parsePipeline` (= used for sync) and `preparePipeline` (= used for async)
+ */
+export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
+    type: "SYNC";
+    $applyToPipelineJson($pipelineJson: import("type-fest/source/writable-deep").WritableObjectDeep<{
+        readonly pipelineUrl?: string | undefined;
+        readonly sourceFile?: string | undefined;
+        readonly title: string;
+        readonly bookVersion?: string | undefined;
+        readonly description?: string | undefined;
+        readonly parameters: import("../_packages/types.index").ParameterJson[];
+        readonly defaultModelRequirements?: Partial<import("../types/ModelRequirements").ModelRequirements> | undefined;
+        readonly tasks: import("../_packages/types.index").TaskJson[];
+        readonly knowledgeSources: (import("../_packages/types.index").KnowledgeSourceJson | import("../_packages/types.index").KnowledgeSourcePreparedJson)[];
+        readonly knowledgePieces: import("../_packages/types.index").KnowledgePiecePreparedJson[];
+        readonly personas: (import("../_packages/types.index").PersonaJson | import("../_packages/types.index").PersonaPreparedJson)[];
+        readonly preparations: import("../_packages/types.index").PreparationJson[];
+        readonly sources: readonly {
+            type: "BOOK";
+            path: string | null;
+            content: import("../pipeline/PipelineString").PipelineString;
+        }[];
+        readonly formfactorName?: "CHATBOT" | "COMPLETION" | "GENERATOR" | "GENERIC" | "IMAGE_GENERATOR" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
+    }>): void;
+}, {
+    type: "SYNC";
+    $applyToPipelineJson($pipelineJson: import("type-fest/source/writable-deep").WritableObjectDeep<{
+        readonly pipelineUrl?: string | undefined;
+        readonly sourceFile?: string | undefined;
+        readonly title: string;
+        readonly bookVersion?: string | undefined;
+        readonly description?: string | undefined;
+        readonly parameters: import("../_packages/types.index").ParameterJson[];
+        readonly defaultModelRequirements?: Partial<import("../types/ModelRequirements").ModelRequirements> | undefined;
+        readonly tasks: import("../_packages/types.index").TaskJson[];
+        readonly knowledgeSources: (import("../_packages/types.index").KnowledgeSourceJson | import("../_packages/types.index").KnowledgeSourcePreparedJson)[];
+        readonly knowledgePieces: import("../_packages/types.index").KnowledgePiecePreparedJson[];
+        readonly personas: (import("../_packages/types.index").PersonaJson | import("../_packages/types.index").PersonaPreparedJson)[];
+        readonly preparations: import("../_packages/types.index").PreparationJson[];
+        readonly sources: readonly {
+            type: "BOOK";
+            path: string | null;
+            content: import("../pipeline/PipelineString").PipelineString;
+        }[];
+        readonly formfactorName?: "CHATBOT" | "COMPLETION" | "GENERATOR" | "GENERIC" | "IMAGE_GENERATOR" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
+    }>): void;
+}];
+/**
+ * TODO: Test that all sync high-level abstractions are before async high-level abstractions
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts

@@ -0,0 +1,13 @@
+import type { $PipelineJson } from '../../commands/_common/types/CommandParser';
+/**
+ * Allow to define chatbot with no need to write full interface
+ *
+ * @private
+ */
+export declare const QuickChatbotHla: {
+    type: "SYNC";
+    $applyToPipelineJson($pipelineJson: $PipelineJson): void;
+};
+/**
+ * TODO: [🧠][📛] Should this be here?
+ */

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

@@ -0,0 +1,15 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+/**
+ * Creates a wrapper around LlmExecutionTools that only exposes models matching the filter function
+ *
+ * @param llmTools The original LLM execution tools to wrap
+ * @param predicate Function that determines whether a model should be included
+ * @returns A new LlmExecutionTools instance with filtered models
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function filterModels<TLlmTools extends LlmExecutionTools>(llmTools: TLlmTools, predicate: (model: AvailableModel) => boolean): TLlmTools;
+/**
+ * TODO: !!! [models] Test that this is working
+ */

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

@@ -0,0 +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 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

@@ -0,0 +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 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/$provideEnvFilename.d.ts

@@ -0,0 +1,12 @@
+import type { string_filename } from '../../../types/typeAliases';
+/**
+ * Provides the path to the `.env` file
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file
+ *
+ * @private within the repository - for CLI utils
+ */
+export declare function $provideEnvFilename(): Promise<string_filename | null>;
+/**
+ * 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/$provideLlmToolsConfigurationFromEnv.d.ts

@@ -0,0 +1,19 @@
+import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
+/**
+ * Provides LLM tools configuration by reading environment variables.
+ *
+ * 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:
+ * - `process.env.OPENAI_API_KEY`
+ * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
+ * - ...
+ *
+ * @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

@@ -0,0 +1,27 @@
+import '../../../_packages/cli.index';
+import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
+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
+     */
+    isCacheReloaded?: boolean;
+};
+/**
+ * Returns LLM tools for testing purposes
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file
+ *
+ * @private within the repository - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
+ */
+export declare function $provideLlmToolsForTestingAndScriptsAndPlayground(options?: GetLlmToolsForTestingAndScriptsAndPlaygroundOptions): Promise<LlmExecutionToolsWithTotalUsage>;
+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 logi
+ */ 

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

@@ -0,0 +1,59 @@
+import { Promisable } from 'type-fest';
+import type { Identification } from '../../../remote-server/socket-types/_subtypes/Identification';
+import type { string_app_id } from '../../../types/typeAliases';
+import type { string_url } from '../../../types/typeAliases';
+import type { really_any } from '../../../utils/organization/really_any';
+import type { CacheLlmToolsOptions } from '../utils/cache/CacheLlmToolsOptions';
+import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
+type ProvideLlmToolsForWizardOrCliOptions = {
+    /**
+     * If true, user will be always prompted for login
+     *
+     * Note: This is used in `ptbk login` command
+     */
+    isLoginloaded?: true;
+} & Pick<CacheLlmToolsOptions, 'isCacheReloaded'> & ({
+    /**
+     * Use local keys and execute LLMs directly
+     */
+    readonly strategy: 'BRING_YOUR_OWN_KEYS';
+} | {
+    /**
+     * Do not use local keys but login to Promptbook server and execute LLMs there
+     */
+    readonly strategy: 'REMOTE_SERVER';
+    /**
+     * URL of the remote server
+     *
+     * @default `DEFAULT_REMOTE_SERVER_URL`
+     */
+    readonly remoteServerUrl?: string_url;
+    /**
+     * Identifier of the application which will be passed to the remote server identification
+     *
+     * Note: This can be some id or some semantic name like "email-agent"
+     */
+    readonly appId: string_app_id;
+    /**
+     *
+     *
+     * Note: When login prompt fails, `process.exit(1)` is called
+     */
+    loginPrompt(): Promisable<Identification<really_any>>;
+});
+/**
+ * Returns LLM tools for CLI
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file and also writes this .env file
+ *
+ * @private within the repository - for CLI utils
+ */
+export declare function $provideLlmToolsForWizardOrCli(options?: ProvideLlmToolsForWizardOrCliOptions): Promise<LlmExecutionToolsWithTotalUsage>;
+export {};
+/**
+ * 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: [🥃] Allow `ptbk make` without llm tools
+ * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
+ * TODO: [®] DRY Register logic
+ */

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

@@ -0,0 +1,41 @@
+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`
+ *
+ * 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:
+ * - `process.env.OPENAI_API_KEY`
+ * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
+ * - ...
+ *
+ * @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: 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
+ * TODO: [🥃] Allow `ptbk make` without llm tools
+ * TODO: This should be maybe not under `_common` but under `utils`
+ * TODO: [®] DRY Register logic
+ */

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

@@ -0,0 +1,22 @@
+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
+ *
+ * Note: This function is used to create a (error) message when there is no constructor for some LLM provider
+ *
+ * @private internal function of `createLlmToolsFromConfiguration` and `$provideLlmToolsFromEnv`
+ */
+export declare function $registeredLlmToolsMessage(): string_markdown;
+/**
+ * TODO: [®] DRY Register logic
+ * TODO: [🧠][⚛] Maybe pass env as argument
+ */

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

@@ -0,0 +1,30 @@
+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.
+ *
+ * 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;
+}>;
+/**
+ * TODO: [🧠][🌰] `title` is redundant BUT maybe allow each provider pass it's own title for tracking purposes
+ * TODO: Maybe instead of `LlmToolsConfiguration[number]` make `LlmToolsConfigurationItem`
+ * TODO: [®] DRY Register logic
+ */

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

@@ -0,0 +1,58 @@
+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.
+ *
+ * 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
+     *
+     * 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> | 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;
+};
+/**
+ * TODO: Add configuration schema and maybe some documentation link
+ * TODO: Maybe constrain LlmToolsConfiguration[number] by generic to ensure that `createConfigurationFromEnv` and `getBoilerplateConfiguration` always create same `packageName` and `className`
+ * TODO: [®] DRY Register logic
+ */

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

@@ -0,0 +1,17 @@
+import type { TODO_object } from '../../../utils/organization/TODO_object';
+/**
+ * Options for configuring LLM (Large Language Model) tools.
+ *
+ * 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;
+/**
+ * TODO: [®] DRY Register logic
+ */

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

@@ -0,0 +1,49 @@
+import type { string_user_id } from '../../../types/typeAliases';
+import { MultipleLlmExecutionTools } from '../../_multiple/MultipleLlmExecutionTools';
+import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
+/**
+ * Options for `$provideLlmToolsFromEnv`
+ *
+ * @private internal type for `$provideLlmToolsFromEnv` and `$provideLlmToolsForTestingAndScriptsAndPlayground`
+ */
+export type CreateLlmToolsFromConfigurationOptions = {
+    /**
+     * This will will be passed to the created `LlmExecutionTools`
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+    /**
+     * Identifier of the end user
+     *
+     * Note: This is passed to the LLM tools providers to identify misuse
+     */
+    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`
+ *
+ * @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: 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`
+ * TODO: [®] DRY Register logic
+ */

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

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

package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts

@@ -0,0 +1,33 @@
+import type { PromptResult } from '../../../../execution/PromptResult';
+import type { Prompt } from '../../../../types/Prompt';
+import type { string_date_iso8601 } from '../../../../types/typeAliases';
+import type { string_semantic_version } from '../../../../types/typeAliases';
+import type { string_promptbook_version } from '../../../../version';
+/**
+ * Represents a single item stored in the LLM cache.
+ */
+export type CacheItem = {
+    /**
+     * The date and time when the cache item was created, in ISO 8601 format.
+     */
+    date: string_date_iso8601;
+    /**
+     * The version of the Promptbook library used when this cache item was created.
+     */
+    promptbookVersion?: string_promptbook_version;
+    /**
+     * The version of the Book language used when this cache item was created.
+     */
+    bookVersion?: string_semantic_version;
+    /**
+     * The prompt that was sent to the LLM.
+     */
+    prompt: Prompt;
+    /**
+     * The response received from the LLM.
+     */
+    promptResult: PromptResult;
+};
+/**
+ * TODO: [🧠] Should be this exported alongsite `cacheLlmTools` through `@promptbook/utils` OR through `@promptbook/types`
+ */

package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts

@@ -0,0 +1,27 @@
+import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
+import type { CacheItem } from './CacheItem';
+/**
+ * Options for configuring caching behavior for LlmExecutionTools.
+ */
+export type CacheLlmToolsOptions = {
+    /**
+     * The cache provider instance to use for storing and retrieving cached data.
+     *
+     * @default MemoryStorage
+     */
+    storage: PromptbookStorage<CacheItem>;
+    /**
+     * When set to `true`, the cache will be reloaded regardless of whether the data is already present in the cache.
+     * This can be useful for debugging or when you want to ensure that the latest data is always fetched.
+     * Data will ne still saved to the cache.
+     *
+     * @default false
+     */
+    isCacheReloaded?: boolean;
+    /**
+     * If true, the preparation logs additional information
+     *
+     * @default DEFAULT_IS_VERBOSE
+     */
+    readonly isVerbose?: boolean;
+};