@promptbook/editable 0.92.0-26 → 0.92.0-27

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

@@ -52,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 [{
@@ -89,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 [{

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

@@ -39,13 +39,19 @@ export declare const MODEL_ORDER: {
     readonly LOW_TIER: 0;
 };
 /**
- * @@@
+ * 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;
     /**
@@ -64,11 +70,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/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-26`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/editable",
-    "version": "0.92.0-26",
+    "version": "0.92.0-27",
     "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/editable.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.92.0-26"
+        "@promptbook/core": "0.92.0-27"
     },
     "dependencies": {
         "crypto-js": "4.2.0",

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-26';
+    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-27';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -193,7 +193,7 @@
     /**
      * Parses the boilerplate command
      *
-     * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.book` file
+     * Note: @@ This command is used as boilerplate for new commands - it should NOT be used in any `.book` file
      *
      * @see `documentationUrl` for more details
      * @private within the commands folder
@@ -2194,17 +2194,20 @@
     };
 
     /**
-     * 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`
      */
     const MatcherFormfactorDefinition = {
         name: 'EXPERIMENTAL_MATCHER',
-        description: `@@@`,
+        description: `An evaluation system that determines whether content meets specific criteria or patterns.
+    Used for content validation, quality assessment, and intelligent filtering tasks. Currently in experimental phase.`,
         documentationUrl: `https://github.com/webgptorg/promptbook/discussions/177`,
         pipelineInterface: {
             inputParameters: [
-                /* @@@ */
+                /* Input parameters for content to be matched and criteria to match against */
                 {
                     name: 'nonce',
                     description: 'Just to prevent EXPERIMENTAL_MATCHER to be set as implicit formfactor',
@@ -2213,7 +2216,7 @@
                 },
             ],
             outputParameters: [
-            /* @@@ */
+            /* Output parameters containing match results, confidence scores, and relevant metadata */
             ],
         },
     };
@@ -2250,13 +2253,16 @@
     };
 
     /**
-     * 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`
      */
     const TranslatorFormfactorDefinition = {
         name: 'TRANSLATOR',
-        description: `@@@`,
+        description: `A text transformation system that converts input content into different forms,
+    including language translations, paraphrasing, style conversions, and tone adjustments.
+    This form factor takes one input and produces one transformed output.`,
         documentationUrl: `https://github.com/webgptorg/promptbook/discussions/175`,
         pipelineInterface: {
             inputParameters: [
@@ -3885,7 +3891,10 @@
               `));
     }
     /**
-     * @@@
+     * Generates a markdown-formatted message listing all supported commands
+     * with their descriptions and documentation links
+     *
+     * @returns A formatted markdown string containing all available commands and their details
      */
     function getSupportedCommandsMessage() {
         return COMMANDS.flatMap(({ name, aliasNames, description, documentationUrl }) => 
@@ -3896,7 +3905,10 @@
         ]).join('\n');
     }
     /**
-     * @@@
+     * Attempts to parse a command variant using the provided input parameters
+     *
+     * @param input Object containing command parsing information including raw command text and normalized values
+     * @returns A parsed Command object if successful, or null if the command cannot be parsed
      */
     function parseCommandVariant(input) {
         const { commandNameRaw, usagePlace, normalized, args, raw, rawArgs } = input;