@promptbook/vercel 0.92.0-3 → 0.92.0-31

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>;
+    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

@@ -1,13 +1,25 @@
+import type { PartialDeep, Promisable } from 'type-fest';
 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;
+type ExecuteFormatCellsOptions = ExecuteAttemptsOptions & {
+    /**
+     * Callback invoked with partial results as the execution progresses.
+     */
+    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/40-executeAttempts.d.ts

@@ -7,55 +7,61 @@ import type { TODO_string } from '../../utils/organization/TODO_string';
 import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
- * @@@
+ * Options for executing attempts of a pipeline task, including configuration for jokers, priority,
+ * maximum attempts, prepared content, parameters, the task itself, the prepared pipeline, execution report,
+ * and pipeline identification. Used internally by the pipeline executor.
  *
  * @private internal type of `executeAttempts`
  */
 export type ExecuteAttemptsOptions = Required<Omit<CreatePipelineExecutorOptions, 'pipeline'>> & {
     /**
-     * @@@
+     * Names of parameters that act as jokers, which can be used to bypass normal execution if their value meets requirements.
      */
     readonly jokerParameterNames: Readonly<ReadonlyArray<string_parameter_name>>;
     /**
-     * @@@
+     * Priority of the current execution attempt, used to influence UI or execution order.
      */
     readonly priority: number;
     /**
-     * @@@
-     *
+     * Maximum number of attempts allowed for this task, including retries and joker attempts.
      * Note: [💂] There are two distinct variabiles
-     * 1) `maxExecutionAttempts` - the amount of attempts LLM model
-     * 2) `maxAttempts` - the amount of attempts for any task - LLM, SCRIPT, DIALOG, etc.
+     * 1) `maxExecutionAttempts` - attempts for LLM model
+     * 2) `maxAttempts` - attempts for any task (LLM, SCRIPT, DIALOG, etc.)
      */
     readonly maxAttempts: number;
     /**
-     * @@@
+     * The content prepared for execution, with parameters already substituted.
      */
     readonly preparedContent: TODO_string;
     /**
-     * @@@
+     * The parameters provided for this execution attempt.
      */
     readonly parameters: Readonly<Parameters>;
     /**
-     * @@@
+     * The task being executed, as a deeply immutable TaskJson object.
+     * Note: Naming should be unified between `task` and `currentTask`.
      */
     readonly task: ReadonlyDeep<TaskJson>;
     /**
-     * @@@
+     * The pipeline structure prepared for execution, as a deeply immutable PipelineJson object.
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
     /**
-     * @@@
+     * The execution report object, which is updated during execution.
      */
     readonly $executionReport: WritableDeep<ExecutionReportJson>;
     /**
-     * @@@
+     * String identifier for the pipeline, used for logging and error reporting.
      */
     readonly pipelineIdentification: string;
 };
 /**
- * @@@
+ * 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`
  */
 export declare function executeAttempts(options: ExecuteAttemptsOptions): Promise<TODO_string>;

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

@@ -0,0 +1,13 @@
+import type { EmbeddingVector } from '../EmbeddingVector';
+/**
+ * Computes the cosine similarity between two embedding vectors
+ *
+ * Note: This is helping function for RAG (retrieval-augmented generation)
+ *
+ * @param embeddingVector1
+ * @param embeddingVector2
+ * @returns Cosine similarity between the two vectors
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function computeCosineSimilarity(embeddingVector1: EmbeddingVector, embeddingVector2: EmbeddingVector): number;

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

@@ -3,30 +3,31 @@ import { PipelineExecutionError } from '../../errors/PipelineExecutionError';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { Parameters } from '../../types/typeAliases';
 /**
- * @@@
+ * Options for filtering and extracting only output parameters from a pipeline execution.
  *
  * @private internal type of `createPipelineExecutor`
  */
 type FilterJustOutputParametersOptions = {
     /**
-     * @@@
+     * The fully prepared pipeline containing parameter definitions.
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
     /**
-     * @@@
+     * The parameters passed to the pipeline, including both input and output values.
      */
     readonly parametersToPass: Readonly<Parameters>;
     /**
-     * @@@
+     * Array to collect warnings encountered during parameter extraction.
      */
     readonly $warnings: PipelineExecutionError[];
     /**
-     * @@@
+     * String identifier for the pipeline, used in warning messages.
      */
     readonly pipelineIdentification: string;
 };
 /**
- * @@@
+ * 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`
  */

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

@@ -3,8 +3,12 @@ import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
 /**
- * @@@
+ * 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`
  */
 export declare function getContextForTask(task: ReadonlyDeep<TaskJson>): Promise<string_parameter_value & string_markdown>;

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

@@ -3,7 +3,7 @@ import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
 /**
- * @@@
+ * Retrieves example values or templates for a given task, used to guide or validate pipeline execution.
  *
  * @private internal utility of `createPipelineExecutor`
  */

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

@@ -1,27 +1,43 @@
 import type { ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { Parameters } from '../../types/typeAliases';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
+import type { ExecutionTools } from '../ExecutionTools';
 /**
- * @@@
+ * Options for retrieving relevant knowledge for a specific task during pipeline execution.
  *
- * @private internal type of `getKnowledgeFoTask`
+ * @private internal type of `getKnowledgeForTask`
  */
 type GetKnowledgeForTaskOptions = {
     /**
-     * @@@
+     * The execution tools to be used during the execution of the pipeline.
+     */
+    readonly tools: ExecutionTools;
+    /**
+     * The fully prepared pipeline containing all tasks and knowledge pieces.
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
     /**
-     * @@@
+     * The current task for which knowledge is being retrieved.
      */
     readonly task: ReadonlyDeep<TaskJson>;
+    /**
+     * Parameters used to complete the content of the task for embedding and knowledge retrieval.
+     */
+    readonly parameters: Readonly<Parameters>;
 };
 /**
- * @@@
+ * 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`
  */
 export declare function getKnowledgeForTask(options: GetKnowledgeForTaskOptions): Promise<string_parameter_value & string_markdown>;
 export {};
+/**
+ * TODO: !!!! Verify if this is working
+ * TODO: [♨] Implement Better - use keyword search
+ * TODO: [♨] Examples of values
+ */

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

@@ -1,28 +1,42 @@
 import type { ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+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`
  */
 type GetReservedParametersForTaskOptions = {
     /**
-     * @@@
+     * The execution tools to be used during the execution of the pipeline
+     */
+    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 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/execution/createPipelineExecutor/knowledgePiecesToString.d.ts

@@ -0,0 +1,9 @@
+import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
+/**
+ *
+ * @param knowledgePieces
+ * @returns
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function knowledgePiecesToString(knowledgePieces: ReadonlyArray<Pick<KnowledgePiecePreparedJson, 'content'>>): string;

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts

@@ -1,18 +1,18 @@
 import type { AutomaticTranslator } from './AutomaticTranslator';
 import type { TranslatorOptions } from './TranslatorOptions';
 /**
- * @@@
+ * Options for configuring the Lindat automatic translator, including API URL and language settings.
  */
 type LindatAutomaticTranslatorOptions = TranslatorOptions & {
     /**
-     * @@@
+     * Optional URL of the Lindat translation API endpoint.
      */
     readonly apiUrl?: URL;
 };
 /**
- * @@@
+ * Automatic translator implementation using the Lindat translation API.
  *
- * @private still in development [🏳]
+ * @private still in development [🏳️]
  */
 export declare class LindatAutomaticTranslator implements AutomaticTranslator {
     protected readonly options: LindatAutomaticTranslatorOptions;

package/esm/typings/src/execution/utils/checkExpectations.d.ts

@@ -24,6 +24,6 @@ export declare function checkExpectations(expectations: Expectations, value: str
 export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
 /**
  * TODO: [💝] Unite object for expecting amount and format
- * TODO: [🧠][🤠] This should be part of `TextFormatDefinition`
+ * TODO: [🧠][🤠] This should be part of `TextFormatParser`
  * Note: [💝] and [🤠] are interconnected together
  */

package/esm/typings/src/execution/utils/uncertainNumber.d.ts

@@ -2,8 +2,9 @@ import type { UncertainNumber } from '../UncertainNumber';
 /**
  * Make UncertainNumber
  *
- * @param value
+ * @param value value of the uncertain number, if `NaN` or `undefined`, it will be set to 0 and `isUncertain=true`
+ * @param isUncertain if `true`, the value is uncertain, otherwise depends on the value
  *
  * @private utility for initializating UncertainNumber
  */
-export declare function uncertainNumber(value?: number | typeof NaN | undefined | null): UncertainNumber;
+export declare function uncertainNumber(value?: number | typeof NaN | undefined | null, isUncertain?: boolean): UncertainNumber;

package/esm/typings/src/formats/_common/{FormatDefinition.d.ts → FormatParser.d.ts}

@@ -2,16 +2,18 @@ import type { string_mime_type } from '../../types/typeAliases';
 import type { string_name } from '../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { empty_object } from '../../utils/organization/empty_object';
-import type { FormatSubvalueDefinition } from './FormatSubvalueDefinition';
+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 [🏢]
  */
-export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
+export type FormatParser<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
     /**
      * The name of the format used in .book.md files
      *
@@ -56,9 +58,9 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
      */
     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 subvalueDefinitions: ReadonlyArray<FormatSubvalueDefinition<TValue, TSettings>>;
+    readonly subvalueParsers: ReadonlyArray<FormatSubvalueParser<TValue, TSettings>>;
 };
 /**
  * TODO: [♏] Add some prepare hook to modify prompt according to the format

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

@@ -0,0 +1,66 @@
+import type { Promisable } from 'type-fest';
+import type { Parameters } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+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> = {
+    /**
+     * The name of the format used in .book.md files
+     *
+     * @example "CELL"
+     */
+    readonly subvalueName: string_name & string_SCREAMING_CASE;
+    /**
+     * Aliases for the `subvalueName`
+     */
+    readonly aliases?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
+    /**
+     * Maps or transforms subvalues from the main value. For example, iterates over all CSV cells or JSON array items.
+     *
+     * @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;
+    /**
+     * 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>;
+};
+/**
+ * Note: [👩🏾‍🤝‍🧑🏽]
+ */

package/esm/typings/src/formats/csv/CsvFormatParser.d.ts

@@ -0,0 +1,17 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
+import type { FormatParser } from '../_common/FormatParser';
+import type { CsvSettings } from './CsvSettings';
+/**
+ * Definition for CSV spreadsheet
+ *
+ * @public exported from `@promptbook/core`
+ *                          <- TODO: [🏢] Export from package `@promptbook/csv`
+ */
+export declare const CsvFormatParser: FormatParser<string, string, CsvSettings, TODO_any>;
+/**
+ * TODO: [🍓] In `CsvFormatParser` implement simple `isValid`
+ * TODO: [🍓] In `CsvFormatParser` implement partial `canBeValid`
+ * TODO: [🍓] In `CsvFormatParser` implement `heal
+ * TODO: [🍓] In `CsvFormatParser` implement `subvalueParsers`
+ * TODO: [🏢] Allow to expect something inside CSV objects and other formats
+ */

package/esm/typings/src/formats/csv/CsvSettings.d.ts

@@ -1,10 +1,10 @@
 import type { ParseConfig, UnparseConfig } from 'papaparse';
 /**
- * @@@
+ * Settings and configuration options for CSV format handling within the application.
  */
 export type CsvSettings = Pick<ParseConfig & UnparseConfig, 'delimiter' | 'quoteChar' | 'newline' | 'skipEmptyLines'>;
 /**
- * @@@
+ * Contains configuration options for parsing and generating CSV files, such as delimiters and quoting rules.
  *
  * @public exported from `@promptbook/core`
  */

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

@@ -0,0 +1,12 @@
+import type { ParseResult } from 'papaparse';
+import type { TODO_any } from '../../../utils/organization/TODO_any';
+import type { Parameters } from '../../../types/typeAliases';
+import type { CsvSettings } from '../CsvSettings';
+/**
+ * Converts a CSV string into an object
+ *
+ * Note: This is wrapper around `papaparse.parse()` with better autohealing
+ *
+ * @private - for now until `@promptbook/csv` is released
+ */
+export declare function csvParse(value: string, settings?: CsvSettings, schema?: TODO_any): ParseResult<Parameters>;

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/index.d.ts

@@ -3,7 +3,7 @@
  *
  * @private internal index of `...` <- TODO [🏢]
  */
-export declare const FORMAT_DEFINITIONS: readonly [import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, import("./csv/CsvSettings").CsvSettings, any>];
+export declare const FORMAT_DEFINITIONS: readonly [import("./_common/FormatParser").FormatParser<string, string, any, any>, import("./_common/FormatParser").FormatParser<string, string, any, any>, import("./_common/FormatParser").FormatParser<string, string, any, any>, import("./_common/FormatParser").FormatParser<string, string, import("./csv/CsvSettings").CsvSettings, any>];
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
- */ 
+ */

package/esm/typings/src/formats/json/{JsonFormatDefinition.d.ts → JsonFormatParser.d.ts}

@@ -1,19 +1,19 @@
 import type { TODO_any } from '../../utils/organization/TODO_any';
-import type { FormatDefinition } from '../_common/FormatDefinition';
+import type { FormatParser } from '../_common/FormatParser';
 /**
  * Definition for JSON format
  *
  * @private still in development [🏢]
  */
-export declare const JsonFormatDefinition: FormatDefinition<string, string, TODO_any, TODO_any>;
+export declare const JsonFormatParser: FormatParser<string, string, TODO_any, TODO_any>;
 /**
  * TODO: [🧠] Maybe propper instance of object
  * TODO: [0] Make string_serialized_json
  * TODO: [1] Make type for JSON Settings and Schema
  * TODO: [🧠] What to use for validating JSONs - JSON Schema, ZoD, typescript types/interfaces,...?
- * TODO: [🍓] In `JsonFormatDefinition` implement simple `isValid`
- * TODO: [🍓] In `JsonFormatDefinition` implement partial `canBeValid`
- * TODO: [🍓] In `JsonFormatDefinition` implement `heal
- * TODO: [🍓] In `JsonFormatDefinition` implement `subvalueDefinitions`
+ * TODO: [🍓] In `JsonFormatParser` implement simple `isValid`
+ * TODO: [🍓] In `JsonFormatParser` implement partial `canBeValid`
+ * TODO: [🍓] In `JsonFormatParser` implement `heal
+ * TODO: [🍓] In `JsonFormatParser` implement `subvalueParsers`
  * TODO: [🏢] Allow to expect something inside JSON objects and other formats
  */

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/json/utils/jsonParse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Converts a JavaScript Object Notation (JSON) string into an object.
+ *
+ * Note: This is wrapper around `JSON.parse()` with better error and type handling
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function jsonParse<T>(value: string): T;

package/esm/typings/src/formats/text/{TextFormatDefinition.d.ts → TextFormatParser.d.ts}

@@ -1,19 +1,19 @@
 import type { TODO_any } from '../../utils/organization/TODO_any';
-import type { FormatDefinition } from '../_common/FormatDefinition';
+import type { FormatParser } from '../_common/FormatParser';
 /**
  * Definition for any text - this will be always valid
  *
- * Note: This is not useful for validation, but for splitting and mapping with `subvalueDefinitions`
+ * Note: This is not useful for validation, but for splitting and mapping with `subvalueParsers`
  *
  * @public exported from `@promptbook/core`
  */
-export declare const TextFormatDefinition: FormatDefinition<string, string, TODO_any, TODO_any>;
+export declare const TextFormatParser: FormatParser<string, string, TODO_any, TODO_any>;
 /**
  * TODO: [1] Make type for XML Text and Schema
  * TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages available as subvalues
- * TODO: [🍓] In `TextFormatDefinition` implement simple `isValid`
- * TODO: [🍓] In `TextFormatDefinition` implement partial `canBeValid`
- * TODO: [🍓] In `TextFormatDefinition` implement `heal
- * TODO: [🍓] In `TextFormatDefinition` implement `subvalueDefinitions`
+ * TODO: [🍓] In `TextFormatParser` implement simple `isValid`
+ * TODO: [🍓] In `TextFormatParser` implement partial `canBeValid`
+ * TODO: [🍓] In `TextFormatParser` implement `heal
+ * TODO: [🍓] In `TextFormatParser` implement `subvalueParsers`
  * TODO: [🏢] Allow to expect something inside each item of list and other formats
  */