@promptbook/vercel 0.92.0-9 → 0.92.0

package/esm/typings/src/storage/file-cache-storage/FileCacheStorage.d.ts

@@ -2,7 +2,10 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PromptbookStorage } from '../_common/PromptbookStorage';
 import type { FileCacheStorageOptions } from './FileCacheStorageOptions';
 /**
- * @@@
+ * A storage implementation that caches data in files organized in a directory structure.
+ * Provides methods for retrieving, storing, and managing cached data on the filesystem.
+ *
+ * This class implements the PromptbookStorage interface for filesystem-based caching.
  *
  * @public exported from `@promptbook/node`
  */
@@ -11,19 +14,23 @@ export declare class FileCacheStorage<TItem> implements PromptbookStorage<TItem>
     private readonly options;
     constructor(tools: Required<Pick<ExecutionTools, 'fs'>>, options: FileCacheStorageOptions);
     /**
-     * @@@
+     * Converts a storage key to a filesystem path where the data should be stored.
+     * Creates a consistent, deterministic file path based on the key string.
      */
     private getFilenameForKey;
     /**
-     * @@@ Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
+     * Returns the current value associated with the given key, or null if the given key does not exist.
+     * Retrieves the cached data from the file system storage.
      */
     getItem(key: string): Promise<TItem | null>;
     /**
-     * @@@ Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     * Persists data to the file system, creating necessary directory structure if it doesn't exist.
      */
     setItem(key: string, value: TItem): Promise<void>;
     /**
-     * @@@ Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
+     * Removes the key/value pair with the given key from the storage, if a key/value pair with the given key exists.
+     * Deletes the corresponding file from the filesystem.
      */
     removeItem(key: string): Promise<void>;
 }

package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts

@@ -1,10 +1,12 @@
 import type { string_dirname } from '../../types/typeAliases';
 /**
- * @@@
+ * Configuration options for the FileCacheStorage implementation.
+ * Defines how and where file cache data should be stored and managed.
  */
 export type FileCacheStorageOptions = {
     /**
-     * @@@
+     * The absolute path to the root directory where cache files will be stored.
+     * This directory must exist and be writable by the application.
      */
     rootFolderPath: string_dirname;
 };

package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts

@@ -1,6 +1,7 @@
 import type { string_name } from '../../../types/typeAliases';
 /**
- * @@@
+ * Converts a name to a properly formatted subfolder path for cache storage.
+ * Handles normalization and path formatting to create consistent cache directory structures.
  *
  * @private for `FileCacheStorage`
  */

package/esm/typings/src/storage/local-storage/getIndexedDbStorage.d.ts

@@ -0,0 +1,11 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+import type { IndexedDbStorageOptions } from './utils/IndexedDbStorageOptions';
+/**
+ * Gets wrapper around IndexedDB which can be used as PromptbookStorage
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare function getIndexedDbStorage<TItem>(options: IndexedDbStorageOptions): PromptbookStorage<TItem>;
+/**
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

package/esm/typings/src/storage/local-storage/utils/IndexedDbStorageOptions.d.ts

@@ -0,0 +1,14 @@
+import type { string_name } from '../../../types/typeAliases';
+/**
+ * Options for IndexedDB storage
+ */
+export type IndexedDbStorageOptions = {
+    /**
+     * Name of the database
+     */
+    databaseName: string_name;
+    /**
+     * Name of the object store (table) in the database
+     */
+    storeName: string_name;
+};

package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromIndexedDb.d.ts

@@ -0,0 +1,8 @@
+import type { PromptbookStorage } from '../../_common/PromptbookStorage';
+import type { IndexedDbStorageOptions } from './IndexedDbStorageOptions';
+/**
+ * Creates a PromptbookStorage backed by IndexedDB.
+ * Uses a single object store named 'promptbook'.
+ * @private for `getIndexedDbStorage`
+ */
+export declare function makePromptbookStorageFromIndexedDb<TValue>(options: IndexedDbStorageOptions): PromptbookStorage<TValue>;

package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts

@@ -1,6 +1,7 @@
 import type { PromptbookStorage } from '../../_common/PromptbookStorage';
 /**
- * @@@
+ * Creates a Promptbook storage interface from a web storage object.
+ * Facilitates using Web Storage (localStorage/sessionStorage) as a storage backend.
  *
  * @private for `getLocalStorage` and `getSessionStorage`
  */

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

@@ -1,5 +1,6 @@
 /**
- * @@@
+ * Defines strategies for handling intermediate files during pipeline execution.
+ * Controls how temporary or intermediate files are managed throughout processing.
  */
 export type IntermediateFilesStrategy = 'HIDE_AND_CLEAN' | 'HIDE_AND_KEEP';
 /**

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

@@ -93,9 +93,9 @@ export type CommonModelRequirements = {
     readonly maxTokens?: number;
 };
 /**
- * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (simmilar that `user` identification is not here)
+ * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (similar that `user` identification is not here)
  * TODO: [🧠][💱] Add more model options: `stop_token`, `logit_bias`, `logprobs` (`top_logprobs`), `top_k`, `top_p`, `presence_penalty`, `frequency_penalty`, `bestOf`, `logitBias`, `logitBiasType`,...
- *       [💱] Probbably keep using just `temperature` in Promptbook (not `top_k` and `top_p`)
+ *       [💱] Probably keep using just `temperature` in Promptbook (not `top_k` and `top_p`)
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  * TODO: Maybe figure out better word than "variant"
  * TODO: Add here more requirement options like max context size, max tokens, etc.

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

@@ -2,14 +2,14 @@ import type { TupleToUnion } from 'type-fest';
 /**
  * Model variant describes the very general type of the model
  *
- * There are two variants:
- * - **COMPLETION** - model that takes prompt and writes the rest of the text
- * - **CHAT** - model that takes prompt and previous messages and returns response
+ * There are these supported model variants:
+ * - `COMPLETION` - Model that takes prompt and writes the rest of the text
+ * - `CHAT` - Model that takes prompt and previous messages and returns response
+ * - `EMBEDDING` - Model that convert text into vector representations
  */
 export type ModelVariant = TupleToUnion<typeof MODEL_VARIANTS>;
 /**
- * @@@
- *
+ * @see {@link ModelVariant}
  * @public exported from `@promptbook/core`
  */
 export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];

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

@@ -123,7 +123,8 @@ export type InputParameters = Exclude<Record<string_parameter_name, really_unkno
  */
 export type string_reserved_parameter_name = TupleToUnion<typeof RESERVED_PARAMETER_NAMES>;
 /**
- * @@@
+ * Represents a mapping of reserved parameter names to their values.
+ * Reserved parameters are used internally by the pipeline and should not be set by users.
  *
  * Note: [🚉] This is fully serializable as JSON
  */
@@ -148,27 +149,29 @@ export type string_persona_description = string;
  */
 export type string_model_description = string;
 /**
- * Source of one knowledge
+ * Source of one knowledge piece.
  *
- * It can be a link, a relative path to file or direct text
+ * It can be a link, a relative path to file or direct text content.
  *
  * For example `"https://pavolhejny.com/"`
  * For example `"./pavol-hejny-cv.pdf"`
  * For example `"Pavol Hejný has web https://pavolhejny.com/"`
  * For example `"Pavol Hejný is web developer and creator of Promptbook and Collboard"`
  *
- * @@@ string_knowledge_source vs string_knowledge_source_link
+ * Note: Distinguishes between `string_knowledge_source_content` and `string_knowledge_source_link`:
+ * `string_knowledge_source_content` refers to the actual content or source of knowledge
+ * `string_knowledge_source_link` refers to a reference or link to the knowledge source
  */
 export type string_knowledge_source_content = string_knowledge_source_link | string_markdown;
 /**
- * One link to knowledge source
+ * One link to a knowledge source.
  *
- * It can be a link or relative path
+ * It can be a URL or relative path.
  *
  * For example `"https://pavolhejny.com/"`
  * For example `"./pavol-hejny-cv.pdf"`
  *
- * @@@ string_knowledge_source vs string_knowledge_source_link
+ * Note: string_knowledge_source_link refers to a reference or link to the knowledge source, while string_knowledge_source_content can be the link or the actual content.
  */
 export type string_knowledge_source_link = string_url | string_filename;
 /**
@@ -183,7 +186,7 @@ export type string_html = string;
  * For example `"<foo>bar</foo>"`
  *
  *
- * TODO: [🎞️] Probbably use some object-based method for working with XMLs
+ * TODO: [🎞️] Probably use some object-based method for working with XMLs
  */
 export type string_xml = string;
 /**
@@ -233,7 +236,9 @@ export type string_markdown_text = string;
  */
 export type string_markdown_codeblock_language = 'book' | 'markdown' | 'text' | 'javascript' | 'css' | 'json';
 /**
- * @@@
+ * A URL pointing to Promptbook documentation or a specific discussion.
+ *
+ * For example: `https://github.com/webgptorg/promptbook/discussions/123`
  */
 export type string_promptbook_documentation_url = `https://github.com/webgptorg/promptbook/discussions/${number | `@@${string}`}`;
 /**
@@ -448,15 +453,14 @@ export type string_uuid = string & {
     readonly _type: 'uuid';
 };
 /**
- * Application identifier
+ * Application identifier, used to distinguish different apps or clients.
  *
- * @@@
+ * For example: 'cli', 'playground', or a custom app id.
  */
 export type string_app_id = id | 'app';
 /**
- * End user identifier
- *
- * @@@
+ * End user identifier, can be a user id or email address.
+ * Used for tracking and abuse prevention.
  */
 export type string_user_id = id | string_email;
 /**
@@ -630,7 +634,7 @@ export type number_integer = number;
 export type number_port = number_positive & number_integer;
 /**
  * Semantic helper;
- * Percentage from 0 to 1 (100%) (and bellow and above)
+ * Percentage from 0 to 1 (100%) (and below and above)
  */
 export type number_percent = number;
 /**
@@ -649,10 +653,9 @@ export type number_seed = number_percent;
 /**
  * Likeness of the wallpaper
  *
- * - 👍 is eqivalent for 1
- * - 👎 is eqivalent for -1
- * - ❤ is eqivalent for more than 1
- * - etc
+ * - 👍 is equivalent to 1
+ * - 👎 is equivalent to -1
+ * - ❤ is equivalent to more than 1
  */
 export type number_likeness = number;
 export type number_miliseconds = number_integer;

package/esm/typings/src/utils/$Register.d.ts

@@ -2,33 +2,34 @@ import { type IDestroyable } from 'destroyable';
 import type { string_name } from '../types/typeAliases';
 import type { TODO_string } from './organization/TODO_string';
 /**
- * @@@
+ * Represents an entity in a global registry.
+ * Contains identifying information about the package and class.
  */
 export type Registered = {
     /**
-     * @@@
+     * The name of the package where the registered entity is defined.
      */
     readonly packageName: TODO_string;
     /**
-     * @@@
+     * The name of the class being registered.
      */
     readonly className: TODO_string;
 };
 /**
- * @@@
+ * Represents a registration record, including destroyable interface and registry name.
  */
 export type Registration = Registered & IDestroyable & {
     /**
-     * @@@
+     * The name of the register this entity is registered in.
      */
     readonly registerName: string_name;
 };
 /**
- * Register is @@@
+ * Global registry for storing and managing registered entities of a given type.
  *
  * Note: `$` is used to indicate that this function is not a pure function - it accesses and adds variables in global scope.
  *
- * @private internal utility, exported are only signleton instances of this class
+ * @private internal utility, exported are only singleton instances of this class
  */
 export declare class $Register<TRegistered extends Registered> {
     private readonly registerName;

package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts

@@ -5,7 +5,7 @@ type AddPipelineCommandOptions = {
     pipelineString: PipelineString;
 };
 /**
- * @@@
+ * Adds a new command to a pipeline string in the correct format.
  *
  * @public exported from `@promptbook/editable`
  */
@@ -14,4 +14,4 @@ export {};
 /**
  * TODO: [🧠] What is the better solution - `- xxx`, - `-   xxx` or preserve (see also next TODO)
  * TODO: When existing commands 1) as 2) number 3) list, add 4) new command as next number
- */
+ */ 

package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts

@@ -1,6 +1,9 @@
 import type { PipelineString } from '../../../pipeline/PipelineString';
 /**
- * @@@
+ * Converts a pipeline structure to its string representation.
+ *
+ * Transforms a flat, simple pipeline into a properly formatted pipeline string
+ * with sections for title, prompt, and return statement.
  *
  * @public exported from `@promptbook/editable`
  */

package/esm/typings/src/utils/editable/utils/isFlatPipeline.d.ts

@@ -1,6 +1,7 @@
 import type { PipelineString } from '../../../pipeline/PipelineString';
 /**
- * @@@
+ * Utility to determine if a pipeline string is in flat format.
+ * A flat pipeline is a simple text without proper structure (headers, blocks, etc).
  *
  * @public exported from `@promptbook/editable`
  */

package/esm/typings/src/utils/editable/utils/stringifyPipelineJson.d.ts

@@ -9,7 +9,7 @@ import type { string_json } from '../../../types/typeAliases';
  */
 export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
 /**
- * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book
+ * TODO: [🐝] Not Working properly @see https://promptbook.studio/examples/mixed-knowledge.book
  * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
  * TODO: [🧠] Maybe more elegant solution than replacing via regex
  * TODO: [🍙] Make some standard order of json properties

package/esm/typings/src/utils/environment/$getGlobalScope.d.ts

@@ -1,6 +1,7 @@
 import type { really_any } from '../organization/really_any';
 /**
- * @@@
+ * Safely retrieves the global scope object (window in browser, global in Node.js)
+ * regardless of the JavaScript environment in which the code is running
  *
  * Note: `$` is used to indicate that this function is not a pure function - it access global scope
  *

package/esm/typings/src/utils/expectation-counters/index.d.ts

@@ -7,6 +7,6 @@ import type { ExpectationUnit } from '../../pipeline/PipelineJson/Expectations';
  */
 export declare const CountUtils: Record<ExpectationUnit, (text: string) => ExpectationAmount>;
 /**
- * TODO: [🧠][🤠] This should be probbably as part of `TextFormatDefinition`
+ * TODO: [🧠][🤠] This should be probably as part of `TextFormatParser`
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts

@@ -19,8 +19,8 @@ export type CodeBlock = {
 /**
  * Extracts all code blocks from markdown.
  *
- * Note: There are multiple simmilar function:
- * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
+ * Note: There are multiple similar functions:
+ * - `extractBlock` just extracts the content of the code block which is also used as built-in function for postprocessing
  * - `extractJsonBlock` extracts exactly one valid JSON code block
  * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
  * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block

package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts

@@ -9,7 +9,7 @@ import type { string_markdown_text } from '../../types/typeAliases';
  * Note: It can not work with html syntax and comments
  *
  * @param markdown any valid markdown
- * @returns @@@
+ * @returns An array of strings, each representing an individual list item found in the markdown
  * @public exported from `@promptbook/markdown-utils`
  */
 export declare function extractAllListItemsFromMarkdown(markdown: string_markdown): string_markdown_text[];

package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts

@@ -5,8 +5,8 @@ import type { CodeBlock } from './extractAllBlocksFromMarkdown';
  *
  * - When there are multiple or no code blocks the function throws a `ParseError`
  *
- * Note: There are multiple simmilar function:
- * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
+ * Note: There are multiple similar functions:
+ * - `extractBlock` just extracts the content of the code block which is also used as built-in function for postprocessing
  * - `extractJsonBlock` extracts exactly one valid JSON code block
  * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
  * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block

package/esm/typings/src/utils/normalization/nameToUriPart.d.ts

@@ -1,9 +1,9 @@
 /**
- * @@@
+ * Converts a name string into a URI-compatible format.
  *
- * @param name @@@
- * @returns @@@
- * @example @@@
+ * @param name The string to be converted to a URI-compatible format.
+ * @returns A URI-compatible string derived from the input name.
+ * @example 'Hello World' -> 'hello-world'
  * @public exported from `@promptbook/utils`
  */
 export declare function nameToUriPart(name: string): string;

package/esm/typings/src/utils/normalization/nameToUriParts.d.ts

@@ -1,9 +1,9 @@
 /**
- * @@@
+ * Converts a given name into URI-compatible parts.
  *
- * @param name @@@
- * @returns @@@
- * @example @@@
+ * @param name The name to be converted into URI parts.
+ * @returns An array of URI-compatible parts derived from the name.
+ * @example 'Example Name' -> ['example', 'name']
  * @public exported from `@promptbook/utils`
  */
 export declare function nameToUriParts(name: string): string[];

package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts

@@ -7,10 +7,10 @@
  */
 export type string_kebab_case = string;
 /**
- * @@@
+ * Converts a given text to kebab-case format.
  *
- * @param text @@@
- * @returns @@@
+ * @param text The text to be converted.
+ * @returns The kebab-case formatted string.
  * @example 'hello-world'
  * @example 'i-love-promptbook'
  * @public exported from `@promptbook/utils`

package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts

@@ -7,10 +7,10 @@
  */
 export type string_SCREAMING_CASE = string;
 /**
- * @@@
+ * Normalizes a text string to SCREAMING_CASE (all uppercase with underscores).
  *
- * @param text @@@
- * @returns @@@
+ * @param text The text string to be converted to SCREAMING_CASE format.
+ * @returns The normalized text in SCREAMING_CASE format.
  * @example 'HELLO_WORLD'
  * @example 'I_LOVE_PROMPTBOOK'
  * @public exported from `@promptbook/utils`

package/esm/typings/src/utils/normalization/normalizeTo_camelCase.d.ts

@@ -7,11 +7,11 @@
  */
 export type string_camelCase = string;
 /**
- * @@@
+ * Normalizes a given text to camelCase format.
  *
- * @param text @@@
- * @param _isFirstLetterCapital @@@
- * @returns @@@
+ * @param text The text to be normalized.
+ * @param _isFirstLetterCapital Whether the first letter should be capitalized.
+ * @returns The camelCase formatted string.
  * @example 'helloWorld'
  * @example 'iLovePromptbook'
  * @public exported from `@promptbook/utils`

package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts

@@ -6,10 +6,10 @@
  */
 export type string_snake_case = string;
 /**
- * @@@
+ * Normalizes a text string to snake_case format.
  *
- * @param text @@@
- * @returns @@@
+ * @param text The text string to be converted to snake_case format.
+ * @returns The normalized text in snake_case format.
  * @example 'hello_world'
  * @example 'i_love_promptbook'
  * @public exported from `@promptbook/utils`

package/esm/typings/src/utils/normalization/removeDiacritics.d.ts

@@ -1,8 +1,8 @@
 /**
- * @@@
+ * Removes diacritic marks (accents) from characters in a string.
  *
- * @param input @@@
- * @returns @@@
+ * @param input The string containing diacritics to be normalized.
+ * @returns The string with diacritics removed or normalized.
  * @public exported from `@promptbook/utils`
  */
 export declare function removeDiacritics(input: string): string;

package/esm/typings/src/utils/normalization/searchKeywords.d.ts

@@ -1,6 +1,6 @@
 import type { Keywords } from './IKeywords';
 /**
- * @@@
+ * Searches set of keywords for a specific keyword
  *
  * @param haystack
  * @param needle
@@ -8,3 +8,6 @@ import type { Keywords } from './IKeywords';
  * @public exported from `@promptbook/utils`
  */
 export declare function searchKeywords(haystack: Keywords, needle: Keywords): boolean;
+/**
+ * TODO: Rename to `isKeywordInKeywords`
+ */

package/esm/typings/src/utils/normalization/titleToName.d.ts

@@ -1,9 +1,9 @@
 /**
- * @@@
+ * Converts a title string into a normalized name.
  *
- * @param value @@@
- * @returns @@@
- * @example @@@
+ * @param value The title string to be converted to a name.
+ * @returns A normalized name derived from the input title.
+ * @example 'Hello World!' -> 'hello-world'
  * @public exported from `@promptbook/utils`
  */
 export declare function titleToName(value: string): string;

package/esm/typings/src/utils/organization/TODO_USE.d.ts

@@ -3,7 +3,7 @@ import type { really_any } from './really_any';
  * Just marks a place of place where should be something implemented
  * No side effects.
  *
- * Note: It can be usefull suppressing eslint errors of unused variables
+ * Note: It can be useful suppressing eslint errors of unused variables
  *
  * @param value any values
  * @returns void

package/esm/typings/src/utils/organization/empty_object.d.ts

@@ -2,8 +2,8 @@
  * Organizational helper to better mark the place where to really use empty object `{}`
  *
  * Note: There are 2 similar types>
- * - `empty_object` @@@
- * - `just_empty_object` @@@
+ * - `empty_object` Type used for empty data objects allowing for potential future extensions
+ * - `just_empty_object` Type used when an object must remain permanently empty
  *
  * @private within the repository
  */

package/esm/typings/src/utils/organization/just.d.ts

@@ -2,7 +2,7 @@
  * Returns the same value that is passed as argument.
  * No side effects.
  *
- * Note: It can be usefull for:
+ * Note: It can be useful for:
  *
  * 1) Leveling indentation
  * 2) Putting always-true or always-false conditions without getting eslint errors

package/esm/typings/src/utils/organization/just_empty_object.d.ts

@@ -1,9 +1,9 @@
 /**
- * Organizational helper to better @@@@
+ * Organizational helper to better distinguish different empty object use cases.
  *
- * Note: There are 2 similar types>
- * - `empty_object` @@@
- * - `just_empty_object` @@@
+ * Note: There are 2 similar types:
+ * - `empty_object` Type used for empty data objects with potential extensions
+ * - `just_empty_object` Type used specifically for objects that must remain empty
  *
  * Note: In most cases, you should use `empty_object`
  *

package/esm/typings/src/utils/organization/keepUnused.d.ts

@@ -3,7 +3,7 @@ import type { really_any } from './really_any';
  * Just says that the variable is not used but should be kept
  * No side effects.
  *
- * Note: It can be usefull for:
+ * Note: It can be useful for:
  *
  * 1) Suppressing eager optimization of unused imports
  * 2) Suppressing eslint errors of unused variables in the tests

package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts

@@ -1,26 +1,26 @@
 import type { string_parameter_name } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
 /**
- * @@@
+ * Options for mapping available parameters to expected parameters in a pipeline task.
  */
 type MakeapAvailableToExpectedParametersOptions = {
     /**
-     * @@@
+     * The set of expected parameter names (keys) for the task, all values are null.
      */
     readonly expectedParameters: Readonly<Record<string_parameter_name, null>>;
     /**
-     * @@@
+     * The set of available parameters (name-value pairs) to map to the expected parameters.
      */
     readonly availableParameters: Readonly<Record<string_parameter_name, string_parameter_value>>;
 };
 /**
- * Maps available parameters to expected parameters
+ * Maps available parameters to expected parameters for a pipeline task.
  *
  * The strategy is:
- * 1) @@@
- * 2) @@@
+ * 1) First, match parameters by name where both available and expected.
+ * 2) Then, if there are unmatched expected and available parameters, map them by order.
  *
- * @throws {PipelineExecutionError} @@@
+ * @throws {PipelineExecutionError} If the number of unmatched expected and available parameters does not match, or mapping is ambiguous.
  * @private within the repository used in `createPipelineExecutor`
  */
 export declare function mapAvailableToExpectedParameters(options: MakeapAvailableToExpectedParametersOptions): Readonly<Record<string_parameter_name, string_parameter_value>>;