@promptbook/remote-server 0.92.0-26 → 0.92.0-28

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/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/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,61 +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';
 /**
- * How is the model provider trusted?
+ * Metadata definition for LLM execution tools that provides information about a provider's capabilities,
+ * configuration options, and relationships within the registry system.
  *
- * @public exported from `@promptbook/core`
- */
-export declare const MODEL_TRUST_LEVEL: {
-    readonly FULL: "Model is running on the local machine, training data and model weights are known, data are ethically sourced";
-    readonly OPEN: "Model is open source, training data and model weights are known";
-    readonly PARTIALLY_OPEN: "Model is open source, but training data and model weights are not (fully) known";
-    readonly CLOSED_LOCAL: "Model can be run locally, but it is not open source";
-    readonly CLOSED_FREE: "Model is behind API gateway but free to use";
-    readonly CLOSED_BUSINESS: "Model is behind API gateway and paid but has good SLA, TOS, privacy policy and in general is a good to use in business applications";
-    readonly CLOSED: "Model is behind API gateway and paid";
-    readonly UNTRUSTED: "Model has questions about the training data and ethics, but it is not known if it is a problem or not";
-    readonly VURNABLE: "Model has some known serious vulnerabilities, leaks, ethical problems, etc.";
-};
-/**
- * How is the model provider important?
- *
- * @public exported from `@promptbook/core`
- */
-export declare const MODEL_ORDER: {
-    /**
-     * Top-tier models, e.g. OpenAI, Anthropic,...
-     */
-    readonly TOP_TIER: 333;
-    /**
-     * Mid-tier models, e.g. Llama, Mistral, etc.
-     */
-    readonly NORMAL: 100;
-    /**
-     * Low-tier models, e.g. Phi, Tiny, etc.
-     */
-    readonly LOW_TIER: 0;
-};
-/**
- * @@@
- *
- * @@@ `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_LEVEL;
+    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_ORDER[keyof typeof MODEL_ORDER] | number;
+    readonly order: typeof MODEL_ORDERS[keyof typeof MODEL_ORDERS] | number;
     /**
      * List of environment variables that can be used to configure the provider
      *
@@ -64,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

@@ -5,7 +5,11 @@ import type { TODO_object } from '../../../utils/organization/TODO_object';
  * This type is used to pass provider-specific options to LLM execution tools.
  *
  *
- * @@@ `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 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`

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

@@ -1,6 +1,7 @@
 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.
@@ -14,6 +15,10 @@ export type CacheItem = {
      * 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.
      */

package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available Anthropic Claude models with pricing
  *
- * Note: Done at 2024-08-16
+ * Note: Done at 2025-05-06
  *
  * @see https://docs.anthropic.com/en/docs/models-overview
  * @public exported from `@promptbook/anthropic-claude`

package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available Deepseek models with descriptions
  *
- * Note: Done at 2025-04-22
+ * Note: Done at 2025-05-06
  *
  * @see https://www.deepseek.com/models
  * @public exported from `@promptbook/deepseek`

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

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available Google models with descriptions
  *
- * Note: Done at 2025-04-22
+ * Note: Done at 2025-05-06
  *
  * @see https://ai.google.dev/models/gemini
  * @public exported from `@promptbook/google`

package/esm/typings/src/llm-providers/openai/openai-models.d.ts

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available OpenAI models with pricing
  *
- * Note: Done at 2024-05-20
+ * Note: Done at 2025-05-06
  *
  * @see https://platform.openai.com/docs/models/
  * @see https://openai.com/api/pricing/

package/esm/typings/src/llm-providers/openai/register-configuration.d.ts

@@ -10,9 +10,9 @@ import type { Registration } from '../../utils/$Register';
  */
 export declare const _OpenAiMetadataRegistration: Registration;
 /**
- * @@@ registration1 of default configuration for Open AI
+ * Registration of the OpenAI Assistant metadata
  *
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ * Note: [🏐] Configurations registrations are done in the metadata registration section, but the constructor registration is handled separately.
  *
  * @public exported from `@promptbook/core`
  * @public exported from `@promptbook/wizzard`

package/esm/typings/src/llm-providers/openai/register-constructor.d.ts

@@ -10,9 +10,9 @@ import type { Registration } from '../../utils/$Register';
  */
 export declare const _OpenAiRegistration: Registration;
 /**
- * @@@ registration2
+ * Registration of the OpenAI Assistant provider
  *
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ * Note: [🏐] Configurations registrations are done in register-constructor.ts BUT constructor register-constructor.ts
  *
  * @public exported from `@promptbook/openai`
  * @public exported from `@promptbook/wizzard`

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.92.0-25`).
+ * It follows semantic versioning (e.g., `0.92.0-27`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-server",
-    "version": "0.92.0-26",
+    "version": "0.92.0-28",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -51,7 +51,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/remote-server.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.92.0-26"
+        "@promptbook/core": "0.92.0-28"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -48,7 +48,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-26';
+    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-28';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -887,7 +887,8 @@
      */
 
     /**
-     * @@@
+     * Attempts to locate the specified application on a Linux system using the 'which' command.
+     * Returns the path to the executable if found, or null otherwise.
      *
      * @private within the repository
      */
@@ -954,7 +955,8 @@
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     const userhome = require('userhome');
     /**
-     * @@@
+     * Attempts to locate the specified application on a macOS system by checking standard application paths and using mdfind.
+     * Returns the path to the executable if found, or null otherwise.
      *
      * @private within the repository
      */
@@ -986,7 +988,8 @@
      */
 
     /**
-     * @@@
+     * Attempts to locate the specified application on a Windows system by searching common installation directories.
+     * Returns the path to the executable if found, or null otherwise.
      *
      * @private within the repository
      */
@@ -1057,7 +1060,8 @@
      */
 
     /**
-     * @@@
+     * Locates the LibreOffice executable on the current system by searching platform-specific paths.
+     * Returns the path to the executable if found, or null otherwise.
      *
      * @private within the repository
      */
@@ -1075,7 +1079,8 @@
      */
 
     /**
-     * @@@
+     * Locates the Pandoc executable on the current system by searching platform-specific paths.
+     * Returns the path to the executable if found, or null otherwise.
      *
      * @private within the repository
      */
@@ -1093,7 +1098,7 @@
      */
 
     /**
-     * @@@
+     * Provides paths to required executables (i.e. as Pandoc and LibreOffice) for Node.js environments.
      *
      * @public exported from `@promptbook/node`
      */
@@ -4442,7 +4447,7 @@
     }
 
     /**
-     * @@@
+     * Contains configuration options for parsing and generating CSV files, such as delimiters and quoting rules.
      *
      * @public exported from `@promptbook/core`
      */
@@ -5157,8 +5162,12 @@
      */
 
     /**
-     * @@@
+     * Executes a pipeline task with multiple attempts, including joker and retry logic. Handles different task types
+     * (prompt, script, dialog, etc.), applies postprocessing, checks expectations, and updates the execution report.
+     * Throws errors if execution fails after all attempts.
      *
+     * @param options - The options for execution, including task, parameters, pipeline, and configuration.
+     * @returns The result string of the executed task.
      * @private internal utility of `createPipelineExecutor`
      */
     async function executeAttempts(options) {
@@ -5616,8 +5625,12 @@
     }
 
     /**
-     * @@@
+     * Returns the context for a given task, typically used to provide additional information or variables
+     * required for the execution of the task within a pipeline. The context is returned as a string value
+     * that may include markdown formatting.
      *
+     * @param task - The task for which the context is being generated. This should be a deeply immutable TaskJson object.
+     * @returns The context as a string, formatted as markdown and parameter value.
      * @private internal utility of `createPipelineExecutor`
      */
     async function getContextForTask(task) {
@@ -5625,7 +5638,7 @@
     }
 
     /**
-     * @@@
+     * Retrieves example values or templates for a given task, used to guide or validate pipeline execution.
      *
      * @private internal utility of `createPipelineExecutor`
      */
@@ -5672,9 +5685,8 @@
     }
 
     /**
-     * @@@
-     *
-     * Here is the place where RAG (retrieval-augmented generation) happens
+     * Retrieves the most relevant knowledge pieces for a given task using embedding-based similarity search.
+     * This is where retrieval-augmented generation (RAG) is performed to enhance the task with external knowledge.
      *
      * @private internal utility of `createPipelineExecutor`
      */
@@ -5893,7 +5905,8 @@
      */
 
     /**
-     * @@@
+     * Filters and returns only the output parameters from the provided pipeline execution options.
+     * Adds warnings for any expected output parameters that are missing.
      *
      * @private internal utility of `createPipelineExecutor`
      */
@@ -6425,11 +6438,16 @@
      */
 
     /**
-     * @@@
+     * 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`
      */
     function createLlmToolsFromConfiguration(configuration, options = {}) {
@@ -6468,7 +6486,11 @@
     /**
      * 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`