@promptbook/markdown-utils 0.92.0-22 → 0.92.0-24

package/esm/typings/src/_packages/core.index.d.ts

@@ -13,6 +13,9 @@ import { DEFAULT_TASK_TITLE } from '../config';
 import { DEFAULT_PROMPT_TASK_TITLE } from '../config';
 import { DEFAULT_BOOK_OUTPUT_PARAMETER_NAME } from '../config';
 import { DEFAULT_MAX_FILE_SIZE } from '../config';
+import { BIG_DATASET_TRESHOLD } from '../config';
+import { FAILED_VALUE_PLACEHOLDER } from '../config';
+import { PENDING_VALUE_PLACEHOLDER } from '../config';
 import { MAX_FILENAME_LENGTH } from '../config';
 import { DEFAULT_INTERMEDIATE_FILES_STRATEGY } from '../config';
 import { DEFAULT_MAX_PARALLEL_COUNT } from '../config';
@@ -158,6 +161,9 @@ export { DEFAULT_TASK_TITLE };
 export { DEFAULT_PROMPT_TASK_TITLE };
 export { DEFAULT_BOOK_OUTPUT_PARAMETER_NAME };
 export { DEFAULT_MAX_FILE_SIZE };
+export { BIG_DATASET_TRESHOLD };
+export { FAILED_VALUE_PLACEHOLDER };
+export { PENDING_VALUE_PLACEHOLDER };
 export { MAX_FILENAME_LENGTH };
 export { DEFAULT_INTERMEDIATE_FILES_STRATEGY };
 export { DEFAULT_MAX_PARALLEL_COUNT };

package/esm/typings/src/collection/PipelineCollection.d.ts

@@ -4,8 +4,6 @@ import type { Prompt } from '../types/Prompt';
 import type { string_pipeline_url } from '../types/typeAliases';
 /**
  * Collection that groups together pipelines, knowledge, personas, tools and actions
- *
- * @see @@@ https://github.com/webgptorg/pipeline#pipeline-collection
  */
 export type PipelineCollection = {
     /**

package/esm/typings/src/collection/SimplePipelineCollection.d.ts

@@ -14,7 +14,7 @@ export declare class SimplePipelineCollection implements PipelineCollection {
     /**
      * Constructs a pipeline collection from pipelines
      *
-     * @param pipelines @@@
+     * @param pipelines Array of pipeline JSON objects to include in the collection
      *
      * Note: During the construction logic of all pipelines are validated
      * Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead

package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts

@@ -1,27 +1,27 @@
 import type { string_parameter_name } from '../../types/typeAliases';
 import type { TODO_string } from '../../utils/organization/TODO_string';
 /**
- * @@@
+ * Information for the FOREACH command, describing how to iterate over a parameter's subvalues in a pipeline task.
  */
 export type ForeachJson = {
     /**
-     * @@@
+     * The name of the format to use for parsing the parameter (e.g., 'CSV').
      */
     readonly formatName: TODO_string;
     /**
-     * @@@
+     * The name of the subformat to use (e.g., CSV Rows).
      */
     readonly subformatName: TODO_string;
     /**
-     * @@@
+     * The name of the parameter to iterate over.
      */
     readonly parameterName: string_parameter_name;
     /**
-     * @@@
+     * The names of the subparameters (e.g., name of the CSV rows)
      */
     readonly inputSubparameterNames: Array<string_parameter_name>;
     /**
-     * @@@
+     * The name of the subparameters (e.g., name of the CSV rows)
      */
     readonly outputSubparameterName: string_parameter_name;
 };

package/esm/typings/src/commands/FORMFACTOR/formfactorCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { FormfactorCommand } from './FormfactorCommand';
 /**
  * Parses the formfactor command
  *
- * Note: @@@ This command is used as formfactor for new commands - it should NOT be used in any `.book` file
+ * Note: This command is used as a formfactor for new commands and defines the app type format - it should NOT be used in any `.book` file
  *
  * @see `documentationUrl` for more details
  * @public exported from `@promptbook/editable`

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

@@ -68,6 +68,28 @@ export declare const DEFAULT_BOOK_OUTPUT_PARAMETER_NAME = "result";
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_MAX_FILE_SIZE: number;
+/**
+ * Threshold value that determines when a dataset is considered "big"
+ * and may require special handling or optimizations
+ *
+ * For example, when error occurs in one item of the big dataset, it will not fail the whole pipeline
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const BIG_DATASET_TRESHOLD = 50;
+/**
+ * Placeholder text used to represent a placeholder value of failed operation
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const FAILED_VALUE_PLACEHOLDER = "!?";
+/**
+ * Placeholder text used to represent operations or values that are still in progress
+ * or awaiting completion in UI displays and logging
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PENDING_VALUE_PLACEHOLDER = "\u2026";
 /**
  * Warning message for the generated sections and files files
  *
@@ -156,15 +178,15 @@ export declare const DEFAULT_MAX_PARALLEL_COUNT = 5;
  */
 export declare const DEFAULT_MAX_EXECUTION_ATTEMPTS = 10;
 /**
- * @@@
- * TODO: [🐝][main] !!3 Use
+ * The maximum depth to which knowledge sources will be scraped when building a knowledge base.
+ * This prevents infinite recursion and limits resource usage.
  *
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
 /**
- * @@@
- * TODO: [🐝][main] !!3 Use
+ * The maximum total number of knowledge sources that will be scraped in a single operation.
+ * This acts as a global limit to avoid excessive resource consumption.
  *
  * @public exported from `@promptbook/core`
  */
@@ -234,27 +256,27 @@ export declare const MOMENT_ARG_THRESHOLDS: {
  */
 export declare const DEFAULT_REMOTE_SERVER_URL: string_promptbook_server_url;
 /**
- * @@@
+ * Default settings for parsing and generating CSV files in Promptbook.
  *
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_CSV_SETTINGS: CsvSettings;
 /**
- * @@@
+ * Controls whether verbose logging is enabled by default throughout the application.
  *
  * @public exported from `@promptbook/core`
  */
 export declare let DEFAULT_IS_VERBOSE: boolean;
 /**
- * @@@
+ * Enables or disables verbose logging globally at runtime.
  *
- * Note: This is experimental feature
+ * Note: This is an experimental feature.
  *
  * @public exported from `@promptbook/core`
  */
 export declare function SET_IS_VERBOSE(isVerbose: boolean): void;
 /**
- * @@@
+ * Controls whether auto-installation of dependencies is enabled by default.
  *
  * @public exported from `@promptbook/core`
  */
@@ -274,13 +296,13 @@ export declare const DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME = "getPipelin
  */
 export declare const DEFAULT_RPM = 60;
 /**
- * @@@
+ * Indicates whether pipeline logic validation is enabled. When true, the pipeline logic is checked for consistency.
  *
  * @private within the repository
  */
 export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
 /**
- * @@@
+ * Indicates whether cost-prevention is enabled. When true, real API keys are prevented from being used in tests.
  *
  * @private within the repository
  */

package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts

@@ -4,40 +4,43 @@ import type { InputParameters } from '../../types/typeAliases';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
- * @@@
+ * Options for executing an entire pipeline, including input parameters, pipeline context, and progress callbacks.
  *
  * @private internal type of `executePipeline`
  */
 type ExecutePipelineOptions = Required<CreatePipelineExecutorOptions> & {
     /**
-     * @@@
+     * The input parameters provided by the user for pipeline execution.
      */
     readonly inputParameters: Readonly<InputParameters>;
     /**
-     * @@@
+     * Optional callback invoked with partial results as the pipeline execution progresses.
      */
     onProgress?(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
     /**
-     * @@@
+     * The pipeline definition to execute.
      */
     readonly pipeline: PipelineJson;
     /**
-     * @@@
+     * The prepared and validated pipeline, ready for execution.
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
     /**
-     * @@@
+     * Callback to update the prepared pipeline reference after preparation.
      */
     readonly setPreparedPipeline: (preparedPipeline: ReadonlyDeep<PipelineJson>) => void;
     /**
-     * @@@
+     * String identifier for the pipeline, used in error messages and reporting.
      */
     readonly pipelineIdentification: string;
 };
 /**
- * @@@
+ * Executes an entire pipeline, resolving tasks in dependency order, handling errors, and reporting progress.
  *
- * Note: This is not a `PipelineExecutor` (which is binded with one exact pipeline), but a utility function of `createPipelineExecutor` which creates `PipelineExecutor`
+ * Note: This is not a `PipelineExecutor` (which is bound to a single pipeline), but a utility function used by `createPipelineExecutor` to create a `PipelineExecutor`.
+ *
+ * @param options - Options for execution, including input parameters, pipeline, and callbacks.
+ * @returns The result of the pipeline execution, including output parameters, errors, and usage statistics.
  *
  * @private internal utility of `createPipelineExecutor`
  */

package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts

@@ -6,38 +6,41 @@ import type { ExecutionReportJson } from '../execution-report/ExecutionReportJso
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
- * @@@
+ * Options for executing a single pipeline task, including task details, pipeline context, parameters, and callbacks.
  *
  * @private internal type of `executeTask`
  */
 type executeSingleTaskOptions = Required<CreatePipelineExecutorOptions> & {
     /**
-     * @@@
+     * The task to be executed.
      */
     readonly currentTask: ReadonlyDeep<TaskJson>;
     /**
-     * @@@
+     * The pipeline in which the task resides, fully prepared and validated.
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
     /**
-     * @@@
+     * The parameters to pass to the task execution.
      */
     readonly parametersToPass: Readonly<Parameters>;
     /**
-     * @@@
+     * Callback invoked with partial results as the execution progresses.
      */
     readonly onProgress: (newOngoingResult: PartialDeep<PipelineExecutorResult>) => Promisable<void>;
     /**
-     * @@@
+     * Mutable execution report object for tracking execution details.
      */
     readonly $executionReport: WritableDeep<ExecutionReportJson>;
     /**
-     * @@@
+     * String identifier for the pipeline, used in error messages and reporting.
      */
     readonly pipelineIdentification: string;
 };
 /**
- * @@@
+ * Executes a single task within a pipeline, handling parameter validation, error checking, and progress reporting.
+ *
+ * @param options - Options for execution, including the task, pipeline, parameters, and callbacks.
+ * @returns The output parameters produced by the task.
  *
  * @private internal utility of `createPipelineExecutor`
  */

package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts

@@ -3,18 +3,23 @@ import type { TODO_any } from '../../utils/organization/TODO_any';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { ExecuteAttemptsOptions } from './40-executeAttempts';
 /**
- * @@@
+ * Options for executing a pipeline task that involves formatting subvalues (e.g., iterating over CSV rows).
+ * Extends ExecuteAttemptsOptions with a progress callback.
  *
  * @private internal type of `executeFormatSubvalues`
  */
 type ExecuteFormatCellsOptions = ExecuteAttemptsOptions & {
     /**
-     * @@@
+     * Callback invoked with partial results as the execution progresses.
      */
     readonly onProgress: (newOngoingResult: PartialDeep<PipelineExecutorResult>) => Promisable<void>;
 };
 /**
- * @@@
+ * Executes a pipeline task that requires mapping or iterating over subvalues of a parameter (such as rows in a CSV).
+ * Handles format and subformat resolution, error handling, and progress reporting.
+ *
+ * @param options - Options for execution, including task details and progress callback.
+ * @returns The result of the subvalue mapping or execution attempts.
  *
  * @private internal utility of `createPipelineExecutor`
  */

package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts

@@ -5,7 +5,7 @@ import type { Parameters } from '../../types/typeAliases';
 import type { ReservedParameters } from '../../types/typeAliases';
 import type { ExecutionTools } from '../ExecutionTools';
 /**
- * @@@
+ * Options for retrieving reserved parameters for a pipeline task, including context, pipeline, and identification.
  *
  * @private internal type of `getReservedParametersForTask`
  */
@@ -15,26 +15,28 @@ type GetReservedParametersForTaskOptions = {
      */
     readonly tools: ExecutionTools;
     /**
-     * @@@
+     * The prepared and validated pipeline in which the task resides.
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
     /**
-     * @@@
+     * The task for which reserved parameters are being retrieved.
      */
     readonly task: ReadonlyDeep<TaskJson>;
     /**
-     * @@@
-     *
-     * Parameters to complete the content of the task for embedding
+     * Parameters to complete the content of the task for embedding and context.
      */
     readonly parameters: Readonly<Parameters>;
     /**
-     * @@@
+     * String identifier for the pipeline, used in error messages and reporting.
      */
     readonly pipelineIdentification: string;
 };
 /**
- * @@@
+ * Retrieves all reserved parameters for a given pipeline task, including context, knowledge, examples, and metadata.
+ * Ensures all reserved parameters are defined and throws if any are missing.
+ *
+ * @param options - Options including tools, pipeline, task, and context.
+ * @returns An object containing all reserved parameters for the task.
  *
  * @private internal utility of `createPipelineExecutor`
  */

package/esm/typings/src/formats/_common/FormatParser.d.ts

@@ -4,9 +4,11 @@ import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeT
 import type { empty_object } from '../../utils/organization/empty_object';
 import type { FormatSubvalueParser } from './FormatSubvalueParser';
 /**
- * A format definition is a set of functions that define how to validate, heal and convert response from LLM
+ * A format definition is a set of functions that define how to validate, heal and convert response from LLM.
  *
- * @@@ Describe setting vs schema
+ * @remarks
+ * - "settings" are runtime options that affect parsing (e.g., delimiter for CSV).
+ * - "schema" is a structural definition or contract for the data (e.g., expected fields in JSON).
  *
  * @see https://github.com/webgptorg/promptbook/discussions/36
  * @private still in development [🏢]
@@ -56,7 +58,7 @@ export type FormatParser<TValue extends TPartialValue, TPartialValue extends str
      */
     heal(value: string, settings?: TSettings, scheme?: TSchema): TValue;
     /**
-     * @@@
+     * Parsers for extracting or mapping subvalues from the main value (e.g., rows from CSV, items from JSON array).
      */
     readonly subvalueParsers: ReadonlyArray<FormatSubvalueParser<TValue, TSettings>>;
 };

package/esm/typings/src/formats/_common/FormatSubvalueParser.d.ts

@@ -5,7 +5,8 @@ import type { string_parameter_name } from '../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { empty_object } from '../../utils/organization/empty_object';
 /**
- * @@@
+ * Defines how to extract or map subvalues from a main value in a specific format (e.g., cells from CSV, items from JSON array).
+ * Used for iterating or transforming structured data in pipeline tasks.
  */
 export type FormatSubvalueParser<TValue extends string, TSettings extends empty_object> = {
     /**
@@ -19,21 +20,45 @@ export type FormatSubvalueParser<TValue extends string, TSettings extends empty_
      */
     readonly aliases?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
     /**
-     * Maps values
+     * Maps or transforms subvalues from the main value. For example, iterates over all CSV cells or JSON array items.
      *
-     * For example, if you have a JSON object and you want to map all values to uppercase
-     * Or iterate over all CSV cells @@@
+     * @param options - Options for mapping, including callbacks for progress and value transformation.
+     * @returns The final mapped string result.
      */
     mapValues(options: FormatSubvalueParserMapValuesOptions<TValue, TSettings>): Promise<string>;
 };
 /**
- * @@@
+ * Options for mapping or extracting subvalues from a main value using a FormatSubvalueParser.
  */
 export type FormatSubvalueParserMapValuesOptions<TValue extends string, TSettings extends empty_object> = {
+    /**
+     * The input string value to parse for subvalues
+     */
     readonly value: TValue;
+    /**
+     * The name of the output parameter where the processed value will be stored
+     */
     readonly outputParameterName: string_parameter_name;
+    /**
+     * Format-specific settings that control how subvalues are parsed or processed
+     */
     readonly settings: TSettings;
-    mapCallback: (subvalues: Parameters, index: number) => Promisable<TValue>;
+    /**
+     * Callback function that processes each subvalue and returns the transformed value
+     *
+     * @param subvalues Object containing the extracted subvalues
+     * @param index Current index of the subvalue which is being mapped
+     * @param length Full length of the subvalues
+     * @param number Total number of subvalues to process
+     * @returns Transformed value after processing
+     */
+    mapCallback(subvalues: Parameters, index: number, length: number): Promisable<TValue>;
+    /**
+     * Progress callback that receives partial results during processing
+     *
+     * @param partialResultString The current partial result as processing progresses
+     * @returns Promise or void to continue execution
+     */
     onProgress(partialResultString: TValue): Promisable<void>;
 };
 /**

package/esm/typings/src/formats/csv/utils/isValidCsvString.d.ts

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

package/esm/typings/src/formats/json/utils/isValidJsonString.d.ts

@@ -2,7 +2,7 @@
  * Function isValidJsonString will tell you if the string is valid JSON or not
  *
  * @param value The string to check
- * @returns True if the string is a valid JSON string, false otherwise
+ * @returns `true` if the string is a valid JSON string, false otherwise
  *
  * @public exported from `@promptbook/utils`
  */

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

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

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

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

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

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

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

@@ -71,7 +71,7 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
 }, {
     readonly name: "SHEETS";
     readonly aliasNames: readonly ["SHEETS", "SHEET"];
-    readonly description: "@@@";
+    readonly description: "A formfactor for processing spreadsheet-like data in CSV format, enabling AI transformations on tabular data";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/176";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{

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

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

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

@@ -1,6 +1,9 @@
 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.
+ *
  *
  * @@@ `LlmToolsMetadata` vs `LlmToolsConfiguration` vs `LlmToolsOptions` (vs `Registered`)
  */

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

@@ -13,7 +13,7 @@ export declare function cacheLlmTools<TLlmTools extends LlmExecutionTools>(llmTo
 /**
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
  * TODO: [🧠] Is there some meaningfull way how to test this util
- * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
- *            @@@ write discussion about this and storages
- *            @@@ write how to combine multiple interceptors
+ * TODO: [👷‍♂️] Comprehensive manual about construction of llmTools
+ *            Detailed explanation about caching strategies and appropriate storage selection for different use cases
+ *            Examples of how to combine multiple interceptors for advanced caching, logging, and usage tracking
  */

package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts

@@ -1,10 +1,10 @@
 import { $Register } from '../../../utils/$Register';
 import type { ScraperAndConverterMetadata } from './ScraperAndConverterMetadata';
 /**
- * @@@
+ * Global registry for storing metadata about all available scrapers and converters.
  *
- * Note: `$` is used to indicate that this interacts with the global scope
- * @singleton Only one instance of each register is created per build, but thare can be more @@@
+ * 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 in different contexts (e.g., tests).
  * @public exported from `@promptbook/core`
  */
 export declare const $scrapersMetadataRegister: $Register<ScraperAndConverterMetadata>;

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
  */
@@ -233,7 +234,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 +451,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;
 /**

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;