@promptbook/openai 0.70.0-1 → 0.71.0-12

package/esm/typings/src/execution/PipelineExecutorResult.d.ts

@@ -1,7 +1,8 @@
+import { ReadonlyDeep } from 'type-fest';
+import type { ErrorJson } from '../errors/utils/ErrorJson';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
-import type { Parameters } from '../types/typeAliases';
 import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import type { ErrorJson } from '../errors/utils/ErrorJson';
+import type { Parameters } from '../types/typeAliases';
 import type { PromptResultUsage } from './PromptResultUsage';
 /**
  * @@@
@@ -14,7 +15,7 @@ export type PipelineExecutorResult = {
      *
      * Note: If the execution was not successful, there are only some of the result parameters
      */
-    readonly outputParameters: Parameters;
+    readonly outputParameters: Readonly<Parameters>;
     /**
      * Whether the execution was successful, details are aviable in `executionReport`
      */
@@ -22,26 +23,26 @@ export type PipelineExecutorResult = {
     /**
      * Added usage of whole execution, detailed usage is aviable in `executionReport`
      */
-    readonly usage: PromptResultUsage;
+    readonly usage: ReadonlyDeep<PromptResultUsage>;
     /**
      * Errors that occured during the execution, details are aviable in `executionReport`
      */
-    readonly errors: Array<ErrorJson>;
+    readonly errors: ReadonlyDeep<Array<ErrorJson>>;
     /**
      * Warnings that occured during the execution, details are aviable in `executionReport`
      */
-    readonly warnings: Array<ErrorJson>;
+    readonly warnings: ReadonlyDeep<Array<ErrorJson>>;
     /**
      * The report of the execution with all details
      */
-    readonly executionReport: ExecutionReportJson;
+    readonly executionReport: ReadonlyDeep<ExecutionReportJson>;
     /**
      * The prepared pipeline that was used for the execution
      *
      * Note: If you called `createPipelineExecutor` with fully prepared pipeline, this is the same object as this pipeline
      *       If you passed not fully prepared pipeline, this is same pipeline but fully prepared
      */
-    readonly preparedPipeline: PipelineJson;
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
 };
 /**
  * TODO: [🧠] Should this file be in /execution or /types folder?

package/esm/typings/src/execution/createPipelineExecutor/$OngoingTemplateResult.d.ts

@@ -0,0 +1,45 @@
+import { ExpectError } from '../../errors/ExpectError';
+import type { Prompt } from '../../types/Prompt';
+import type { ChatPromptResult } from '../PromptResult';
+import type { CompletionPromptResult } from '../PromptResult';
+import type { EmbeddingPromptResult } from '../PromptResult';
+import type { PromptResult } from '../PromptResult';
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export type $OngoingTemplateResult = {
+    /**
+     * @@@
+     */
+    $prompt?: Prompt;
+    /**
+     * @@@
+     */
+    $chatResult?: ChatPromptResult;
+    /**
+     * @@@
+     */
+    $completionResult?: CompletionPromptResult;
+    /**
+     * @@@
+     */
+    $embeddingResult?: EmbeddingPromptResult;
+    /**
+     * @@@
+     */
+    $result: PromptResult | null;
+    /**
+     * @@@
+     */
+    $resultString: string | null;
+    /**
+     * @@@
+     */
+    $expectError: ExpectError | null;
+    /**
+     * @@@
+     */
+    $scriptPipelineExecutionErrors: Array<Error>;
+};

package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts

@@ -0,0 +1,23 @@
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { ExecutionTools } from '../ExecutionTools';
+import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
+/**
+ * Options for `createPipelineExecutor`
+ */
+export type CreatePipelineExecutorOptions = {
+    /**
+     * The pipeline to be executed
+     */
+    readonly pipeline: PipelineJson;
+    /**
+     * The execution tools to be used during the execution of the pipeline
+     */
+    readonly tools: ExecutionTools;
+    /**
+     * Optional settings for the pipeline executor
+     */
+    readonly settings?: Partial<CreatePipelineExecutorSettings>;
+};
+/**
+ * TODO: !!!!!! Unite `CreatePipelineExecutorOptions` and `CreatePipelineExecutorSettings` OR describe the difference
+ */ 

package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts

@@ -0,0 +1,29 @@
+import type { CsvSettings } from '../../formats/csv/CsvSettings';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+export type CreatePipelineExecutorSettings = Omit<PrepareAndScrapeOptions, 'llmTools'> & {
+    /**
+     * When executor does not satisfy expectations it will be retried this amount of times
+     *
+     * @default MAX_EXECUTION_ATTEMPTS
+     */
+    readonly maxExecutionAttempts: number;
+    /**
+     * Settings for CSV format
+     *
+     * @default DEFAULT_CSV_SETTINGS
+     */
+    readonly csvSettings: CsvSettings;
+    /**
+     * If you pass fully prepared pipeline, this does not matter
+     *
+     * Otherwise:
+     * If false or not set, warning is shown when pipeline is not prepared
+     * If true, warning is suppressed
+     *
+     * @default false
+     */
+    readonly isNotPreparedWarningSupressed: boolean;
+};
+/**
+ * TODO: [🤹‍♂️] More granular setting for limits of execution + better waiting for queue
+ */

package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts

@@ -0,0 +1,13 @@
+import type { PipelineExecutor } from '../PipelineExecutor';
+import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
+/**
+ * Creates executor function from pipeline and execution tools.
+ *
+ * @returns The executor function
+ * @throws {PipelineLogicError} on logical error in the pipeline
+ * @public exported from `@promptbook/core`
+ */
+export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
+/**
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
+ */

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

@@ -0,0 +1,58 @@
+import type { Promisable, ReadonlyDeep } from 'type-fest';
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { TaskProgress } from '../../types/TaskProgress';
+import type { Parameters } from '../../types/typeAliases';
+import type { ExecutionTools } from '../ExecutionTools';
+import type { PipelineExecutorResult } from '../PipelineExecutorResult';
+import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
+/**
+ * @@@
+ *
+ * @private internal type of `executePipeline`
+ */
+type ExecutePipelineOptions = {
+    /**
+     * @@@
+     */
+    readonly inputParameters: Readonly<Parameters>;
+    /**
+     * @@@
+     */
+    readonly tools: ExecutionTools;
+    /**
+     * @@@
+     */
+    onProgress?(taskProgress: TaskProgress): Promisable<void>;
+    /**
+     * @@@
+     */
+    readonly pipeline: PipelineJson;
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly setPreparedPipeline: (preparedPipeline: ReadonlyDeep<PipelineJson>) => void;
+    /**
+     * @@@
+     */
+    readonly pipelineIdentification: string;
+    /**
+     * Settings for the pipeline executor
+     */
+    readonly settings: CreatePipelineExecutorSettings;
+};
+/**
+ * @@@
+ *
+ * Note: This is not a `PipelineExecutor` (which is binded with one exact pipeline), but a utility function of `createPipelineExecutor` which creates `PipelineExecutor`
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function executePipeline(options: ExecutePipelineOptions): Promise<PipelineExecutorResult>;
+export {};
+/**
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
+ */

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

@@ -0,0 +1,60 @@
+import { Promisable, ReadonlyDeep } from 'type-fest';
+import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { TaskProgress } from '../../types/TaskProgress';
+import type { Parameters } from '../../types/typeAliases';
+import type { ExecutionTools } from '../ExecutionTools';
+import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
+/**
+ * @@@
+ *
+ * @private internal type of `executeTemplate`
+ */
+type executeSingleTemplateOptions = {
+    /**
+     * @@@
+     */
+    readonly currentTemplate: ReadonlyDeep<TemplateJson>;
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly parametersToPass: Readonly<Parameters>;
+    /**
+     * @@@
+     */
+    readonly tools: ExecutionTools;
+    /**
+     * @@@
+     */
+    readonly onProgress: (taskProgress: TaskProgress) => Promisable<void>;
+    /**
+     * Settings for the pipeline executor
+     */
+    readonly settings: CreatePipelineExecutorSettings;
+    /**
+     * @@@
+     */
+    readonly $executionReport: ExecutionReportJson;
+    /**
+     * @@@
+     */
+    readonly pipelineIdentification: string;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function executeTemplate(options: executeSingleTemplateOptions): Promise<Readonly<Parameters>>;
+export {};
+/**
+ * TODO: [🤹‍♂️]
+ */
+/**
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
+ */

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

@@ -0,0 +1,15 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
+import type { ExecuteAttemptsOptions } from './40-executeAttempts';
+/**
+ * @@@
+ *
+ * @private internal type of `executeFormatSubvalues`
+ */
+type ExecuteFormatCellsOptions = ExecuteAttemptsOptions;
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function executeFormatSubvalues(options: ExecuteFormatCellsOptions): Promise<TODO_any>;
+export {};

package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -0,0 +1,69 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { Parameters } from '../../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { TODO_string } from '../../utils/organization/TODO_string';
+import type { ExecutionTools } from '../ExecutionTools';
+import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
+/**
+ * @@@
+ *
+ * @private internal type of `executeAttempts`
+ */
+export type ExecuteAttemptsOptions = {
+    /**
+     * @@@
+     */
+    readonly jokerParameterNames: Readonly<Array<string_parameter_name>>;
+    /**
+     * @@@
+     */
+    readonly priority: number;
+    /**
+     * @@@
+     */
+    readonly maxAttempts: number;
+    /**
+     * @@@
+     */
+    readonly preparedContent: TODO_string;
+    /**
+     * @@@
+     */
+    readonly parameters: Readonly<Parameters>;
+    /**
+     * @@@
+     */
+    readonly template: ReadonlyDeep<TemplateJson>;
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly tools: ExecutionTools;
+    /**
+     * Settings for the pipeline executor
+     */
+    readonly settings: CreatePipelineExecutorSettings;
+    /**
+     * @@@
+     */
+    readonly $executionReport: ExecutionReportJson;
+    /**
+     * @@@
+     */
+    readonly pipelineIdentification: string;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function executeAttempts(options: ExecuteAttemptsOptions): Promise<TODO_string>;
+/**
+ * TODO: Break into smaller functions
+ */

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

@@ -0,0 +1,34 @@
+import type { ReadonlyDeep } from 'type-fest';
+import { PipelineExecutionError } from '../../errors/PipelineExecutionError';
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { Parameters } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal type of `createPipelineExecutor`
+ */
+type FilterJustOutputParametersOptions = {
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly parametersToPass: Readonly<Parameters>;
+    /**
+     * @@@
+     */
+    readonly $warnings: PipelineExecutionError[];
+    /**
+     * @@@
+     */
+    readonly pipelineIdentification: string;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function filterJustOutputParameters(options: FilterJustOutputParametersOptions): Parameters;
+export {};

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

@@ -0,0 +1,10 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getContextForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;

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

@@ -0,0 +1,27 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal type of `getKnowledgeForTemplate`
+ */
+type GetKnowledgeForTemplateOptions = {
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly template: ReadonlyDeep<TemplateJson>;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getKnowledgeForTemplate(options: GetKnowledgeForTemplateOptions): Promise<string_parameter_value & string_markdown>;
+export {};

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

@@ -0,0 +1,30 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { ReservedParameters } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal type of `getReservedParametersForTemplate`
+ */
+type GetReservedParametersForTemplateOptions = {
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly template: ReadonlyDeep<TemplateJson>;
+    /**
+     * @@@
+     */
+    readonly pipelineIdentification: string;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getReservedParametersForTemplate(options: GetReservedParametersForTemplateOptions): Promise<Readonly<ReservedParameters>>;
+export {};

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

@@ -0,0 +1,10 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getSamplesForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;

package/esm/typings/src/execution/embeddingVectorToString.d.ts

@@ -4,4 +4,4 @@ import type { EmbeddingVector } from './EmbeddingVector';
  *
  * @public exported from `@promptbook/core`
  */
-export declare function embeddingVectorToString(embeddingVector: EmbeddingVector): string;
+export declare function embeddingVectorToString(embeddingVector: Readonly<EmbeddingVector>): string;

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

@@ -6,3 +6,6 @@ import type { TranslatorOptions } from './automatic-translators/TranslatorOption
 export declare function translateMessages({ automaticTranslator, from, to, }: {
     automaticTranslator: AutomaticTranslator;
 } & TranslatorOptions): Promise<void>;
+/**
+ * TODO: [😶] Unite floder listing
+ */

package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts

@@ -0,0 +1,13 @@
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import type { ExecutionTools } from '../ExecutionTools';
+/**
+ * Note: There is unfortunately no equivalent for this function in the browser environment
+ *       because it is not possible automatically detect configured LLM providers
+ *       you need to provide them manually BUT you can help by utilities like `$provideScrapersForBrowser`
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $provideExecutionToolsForNode(options?: PrepareAndScrapeOptions): Promise<ExecutionTools>;
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

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

@@ -24,4 +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`
+ * Note: [💝] and [🤠] are interconnected together
  */

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

@@ -14,6 +14,7 @@ type ForEachAsyncOptions = {
  * @param options - Options for the function
  * @param callbackfunction - Function to call for each item
  * @public exported from `@promptbook/utils`
+ * @deprecated [🪂] Use queues instead
  */
 export declare function forEachAsync<TItem>(array: Array<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: Array<TItem>) => Promisable<void>): Promise<void>;
 export {};

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

@@ -7,11 +7,10 @@ import type { PromptResultUsage } from '../PromptResultUsage';
  */
 export declare function usageToHuman(usage: PromptResultUsage): string_markdown;
 /**
- * TODO: Use "$1" not "1 USD"
- * TODO: Use markdown formatting like "Cost approximately **$1**"
- * TODO: Report in minutes, seconds, days NOT 0.1 hours
+ * TODO: [🍓][🧞‍♂️] Use "$1" not "1 USD"
+ * TODO: [🍓][🧞‍♂️] Use markdown formatting like "Cost approximately **$1**"
+ * TODO: [🍓][🧞‍♂️] Report in minutes, seconds, days NOT 0.1 hours
  * TODO: [🧠] Maybe make from `uncertainNumberToHuman` separate exported utility
- * TODO: When negligible usage, report "Negligible" or just don't report it
  * TODO: [🧠] Maybe use "~" instead of "approximately"
  * TODO: [🏛] Maybe make some markdown builder
  */

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

@@ -1,22 +1,27 @@
 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';
 /**
  * A format definition is a set of functions that define how to validate, heal and convert response from LLM
  *
+ * @@@ Describe setting vs schema
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/36
  * @private still in development [🏢]
  */
-export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSchema extends object> = {
+export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
     /**
      * The name of the format used in .ptbk.md files
      *
      * @sample "JSON"
      */
-    readonly name: string_name;
+    readonly formatName: string_name & string_SCREAMING_CASE;
     /**
-     * Aliases for the name
+     * Aliases for the `formatName`
      */
-    readonly aliases?: Array<string_name>;
+    readonly aliases?: Array<string_name & string_SCREAMING_CASE>;
     /**
      * The mime type of the format (if any)
      *
@@ -29,7 +34,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
      * @param value The value to check, for example "{\"foo\": true}"
      * @param schema Optional schema to do extra validation
      */
-    isValid(value: string, schema?: TSchema): value is TValue;
+    isValid(value: string, settings?: TSettings, schema?: TSchema): value is TValue;
     /**
      * Check if a first part of a value is valid
      *
@@ -38,7 +43,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
      * @param partialValue Partial value to check, for example "{\"foo\": t"
      * @param schema Optional schema to do extra validation
      */
-    canBeValid(partialValue: string, schema?: TSchema): partialValue is TPartialValue;
+    canBeValid(partialValue: string, settings?: TSettings, schema?: TSchema): partialValue is TPartialValue;
     /**
      * Heal a value to make it valid if possible
      *
@@ -49,17 +54,11 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
      * @param scheme
      * @throws {Error} If the value cannot be healed
      */
-    heal(value: string, scheme?: TSchema): TValue;
+    heal(value: string, settings?: TSettings, scheme?: TSchema): TValue;
     /**
-     * Parses just the values and removes structural information
-     *
-     * Note: This is useful when you want to combine format expectations with counting words, characters,...
-     *
-     * @param value The value to check, for example "{\"name\": "John Smith"}"
-     * @param schema Optional schema
-     * @example "{\"name\": "John Smith"}" -> ["John Smith"]
+     * @@@
      */
-    extractValues(value: string, schema?: TSchema): Array<string>;
+    readonly subvalueDefinitions: Array<FormatSubvalueDefinition<TValue, TSettings>>;
 };
 /**
  * TODO: [♏] Add some prepare hook to modify prompt according to the format

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

@@ -0,0 +1,31 @@
+import type { Promisable } from 'type-fest';
+import type { Parameters } from '../../types/typeAliases';
+import type { string_parameter_name } 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';
+/**
+ * @@@
+ */
+export type FormatSubvalueDefinition<TValue extends string, TSettings extends empty_object> = {
+    /**
+     * The name of the format used in .ptbk.md files
+     *
+     * @sample "CELL"
+     */
+    readonly subvalueName: string_name & string_SCREAMING_CASE;
+    /**
+     * Aliases for the `subvalueName`
+     */
+    readonly aliases?: Array<string_name & string_SCREAMING_CASE>;
+    /**
+     * Maps values
+     *
+     * For example, if you have a JSON object and you want to map all values to uppercase
+     * Or iterate over all CSV cells @@@
+     */
+    mapValues(value: TValue, outputParameterName: string_parameter_name, settings: TSettings, mapCallback: (subvalues: Parameters, index: number) => Promisable<string>): Promise<string>;
+};
+/**
+ * Note: [👩🏾‍🤝‍🧑🏽]
+ */