@promptbook/openai 0.69.0-8 → 0.69.1

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

@@ -1,6 +1,6 @@
 import type { ForeachJson } from './ForeachJson';
 /**
- * Parsed FOREACH command <- Write [🍭] !!!!!!
+ * Parsed FOREACH command which is used to iterate over a table of values
  *
  * @see ./foreachCommandParser.ts for more details
  * @private within the commands folder

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

@@ -11,7 +11,7 @@ export type ForeachJson = {
     /**
      * @@@
      */
-    readonly cellName: TODO_string;
+    readonly subformatName: TODO_string;
     /**
      * @@@
      */
@@ -19,8 +19,9 @@ export type ForeachJson = {
     /**
      * @@@
      */
-    readonly subparameterName: string_parameter_name;
+    readonly inputSubparameterNames: Array<string_parameter_name>;
+    /**
+     * @@@
+     */
+    readonly outputSubparameterName: string_parameter_name;
 };
-/**
- * TODO: [🧠] Betetr name for `parameterName` and `subparameterName`
- */

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

@@ -10,6 +10,5 @@ import type { ForeachCommand } from './ForeachCommand';
  */
 export declare const foreachCommandParser: PipelineTemplateCommandParser<ForeachCommand>;
 /**
- * TODO: !!!!!! Comment console logs
- * TODO: [🍭] !!!!!! Make .ptbk.md file with examples of the FOREACH command and also with wrong parsing and logic
+ * TODO: [🍭] Make .ptbk.md file with examples of the FOREACH with wrong parsing and logic
  */

package/esm/typings/src/commands/_common/types/CommandParser.d.ts

@@ -156,7 +156,7 @@ export type CommandParserInput = {
      * @@@
      *
      * @example 'promptbook version 0.62.0'
-     * @example 'FOREACH List Line `{customers}` -> `{customer}`'
+     * @example 'FOREACH Text Line `{customers}` -> `{customer}`'
      */
     readonly raw: string_markdown_text;
     /**

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

@@ -1,3 +1,4 @@
+import type { CsvSettings } from './formats/csv/CsvSettings';
 /**
  * Warning message for the generated sections and files files
  *
@@ -68,14 +69,14 @@ export declare const MAX_EXECUTION_ATTEMPTS = 3;
 export declare const MAX_FILENAME_LENGTH = 30;
 /**
  * @@@
- * TODO: [🐝] !!! Use
+ * TODO: [🐝][main] !!! Use
  *
  * @public exported from `@promptbook/core`
  */
 export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
 /**
  * @@@
- * TODO: [🐝] !!! Use
+ * TODO: [🐝][main] !!! Use
  *
  * @public exported from `@promptbook/core`
  */
@@ -137,6 +138,12 @@ export declare const DEFAULT_REMOTE_URL = "https://api.pavolhejny.com/";
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_REMOTE_URL_PATH = "/promptbook/socket.io";
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_CSV_SETTINGS: CsvSettings;
 /**
  * @@@
  *
@@ -148,13 +155,13 @@ export declare const IS_VERBOSE = false;
  *
  * @private within the repository
  */
-export declare const IS_COST_PREVENTED: boolean;
+export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
 /**
  * @@@
  *
  * @private within the repository
  */
-export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
+export declare const IS_COST_PREVENTED: boolean;
 /**
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
  */

package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts

@@ -18,7 +18,7 @@ import type { PipelineString } from '../types/PipelineString';
  */
 export declare function pipelineStringToJsonSync(pipelineString: PipelineString): PipelineJson;
 /**
- * TODO: !!!! Warn if used only sync version
+ * TODO: [main] !!!! Warn if used only sync version
  * TODO: [🚞] Report here line/column of error
  * TODO: Use spaceTrim more effectively
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal

package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts

@@ -22,9 +22,9 @@ export type renderPipelineMermaidOptions = {
  */
 export declare function renderPromptbookMermaid(pipelineJson: PipelineJson, options?: renderPipelineMermaidOptions): string;
 /**
- * TODO: !!!!!! FOREACH in mermaid graph
- * TODO: !!!!!! Knowledge in mermaid graph
- * TODO: !!!!!! Personas in mermaid graph
+ * TODO: !!!!! FOREACH in mermaid graph
+ * TODO: !!!!! Knowledge in mermaid graph
+ * TODO: !!!!! Personas in mermaid graph
  * TODO: Maybe use some Mermaid package instead of string templating
  * TODO: [🕌] When more than 2 functionalities, split into separate functions
  */

package/esm/typings/src/conversion/validation/validatePipeline.d.ts

@@ -20,6 +20,7 @@ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
  */
 export declare function validatePipelineCore(pipeline: PipelineJson): void;
 /**
+ * TODO: !!!!! [🧞‍♀️] Do not allow joker + foreach
  * TODO: [🧠] Work with promptbookVersion
  * TODO: Use here some json-schema, Zod or something similar and change it to:
  *     > /**
@@ -31,11 +32,11 @@ export declare function validatePipelineCore(pipeline: PipelineJson): void;
  *     >  ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
  */
 /**
- * TODO: [🐣] !!!! Validate that all samples match expectations
- * TODO: [🐣][🐝] !!!! Validate that knowledge is valid (non-void)
- * TODO: [🐣] !!!! Validate that persona can be used only with CHAT variant
- * TODO: [🐣] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
- * TODO: [🐣] !!!! Validate that reserved parameter is not used as joker
+ * TODO: [🐣][main] !!!! Validate that all samples match expectations
+ * TODO: [🐣][🐝][main] !!!! Validate that knowledge is valid (non-void)
+ * TODO: [🐣][main] !!!! Validate that persona can be used only with CHAT variant
+ * TODO: [🐣][main] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
+ * TODO: [🐣][main] !!!! Validate that reserved parameter is not used as joker
  * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/esm/typings/src/errors/AbstractFormatError.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This error indicates problems parsing the format value
+ *
+ * For example, when the format value is not a valid JSON or CSV
+ * This is not thrown directly but in extended classes
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class AbstractFormatError extends Error {
+    constructor(message: string);
+}

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

@@ -14,5 +14,6 @@ export type PipelineExecutor = {
     (inputParameters: Parameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
 };
 /**
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
  * TODO: [🧠] Should this file be in /execution or /types folder?
  */

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

@@ -15,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`
      */
@@ -23,19 +23,19 @@ 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
      *
@@ -45,7 +45,6 @@ export type PipelineExecutorResult = {
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
 };
 /**
- * TODO: !!!!!! Maybe add ReadonlyDeep< to all
  * TODO: [🧠] Should this file be in /execution or /types folder?
  * TODO: [🧠] Maybe constrain `ErrorJson` -> `ErrorJson & { name: 'PipelineExecutionError' | 'Error' }`
  */

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

@@ -10,12 +10,36 @@ 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-CreatePipelineExecutorSettings.d.ts

@@ -1,3 +1,4 @@
+import type { CsvSettings } from '../../formats/csv/CsvSettings';
 export type CreatePipelineExecutorSettings = {
     /**
      * When executor does not satisfy expectations it will be retried this amount of times
@@ -17,6 +18,12 @@ export type CreatePipelineExecutorSettings = {
      * @default false
      */
     readonly isVerbose: boolean;
+    /**
+     * Settings for CSV format
+     *
+     * @default DEFAULT_CSV_SETTINGS
+     */
+    readonly csvSettings: CsvSettings;
     /**
      * If you pass fully prepared pipeline, this does not matter
      *

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

@@ -8,3 +8,6 @@ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorO
  * @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

@@ -22,7 +22,7 @@ type ExecutePipelineOptions = {
     /**
      * @@@
      */
-    readonly onProgress?: (taskProgress: TaskProgress) => Promisable<void>;
+    onProgress?(taskProgress: TaskProgress): Promisable<void>;
     /**
      * @@@
      */
@@ -53,3 +53,6 @@ type ExecutePipelineOptions = {
  */
 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

@@ -60,3 +60,6 @@ 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-executeFormatCells.d.ts → 30-executeFormatSubvalues.d.ts}

@@ -3,7 +3,7 @@ import type { ExecuteAttemptsOptions } from './40-executeAttempts';
 /**
  * @@@
  *
- * @private internal type of `executeFormatCells`
+ * @private internal type of `executeFormatSubvalues`
  */
 type ExecuteFormatCellsOptions = ExecuteAttemptsOptions;
 /**
@@ -11,5 +11,5 @@ type ExecuteFormatCellsOptions = ExecuteAttemptsOptions;
  *
  * @private internal utility of `createPipelineExecutor`
  */
-export declare function executeFormatCells(options: ExecuteFormatCellsOptions): Promise<TODO_any>;
+export declare function executeFormatSubvalues(options: ExecuteFormatCellsOptions): Promise<TODO_any>;
 export {};

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

@@ -5,10 +5,8 @@ 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_any } from '../../utils/organization/TODO_any';
 import type { TODO_string } from '../../utils/organization/TODO_string';
 import type { ExecutionTools } from '../ExecutionTools';
-import type { $OngoingTemplateResult } from './$OngoingTemplateResult';
 import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
 /**
  * @@@
@@ -16,10 +14,6 @@ import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutor
  * @private internal type of `executeAttempts`
  */
 export type ExecuteAttemptsOptions = {
-    /**
-     * @@@
-     */
-    readonly $ongoingTemplateResult: $OngoingTemplateResult;
     /**
      * @@@
      */
@@ -39,7 +33,7 @@ export type ExecuteAttemptsOptions = {
     /**
      * @@@
      */
-    readonly parameters: ReadonlyDeep<Parameters>;
+    readonly parameters: Readonly<Parameters>;
     /**
      * @@@
      */
@@ -74,7 +68,7 @@ export type ExecuteAttemptsOptions = {
  *
  * @private internal utility of `createPipelineExecutor`
  */
-export declare function executeAttempts(options: ExecuteAttemptsOptions): Promise<TODO_any>;
+export declare function executeAttempts(options: ExecuteAttemptsOptions): Promise<TODO_string>;
 /**
  * TODO: Break into smaller functions
  */

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/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/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: [👩🏾‍🤝‍🧑🏽]
+ */

package/esm/typings/src/formats/csv/{ListFormatDefinition.d.ts → CsvFormatDefinition.d.ts}

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

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

@@ -0,0 +1,10 @@
+import { AbstractFormatError } from "../../errors/AbstractFormatError";
+/**
+ * This error indicates problem with parsing of CSV
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class CsvFormatError extends AbstractFormatError {
+    readonly name = "CsvFormatError";
+    constructor(message: string);
+}

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

@@ -0,0 +1,13 @@
+import type { ParseConfig, UnparseConfig } from 'papaparse';
+/**
+ * @@@
+ */
+export type CsvSettings = Pick<ParseConfig & UnparseConfig, 'delimiter' | 'quoteChar' | 'newline' | 'skipEmptyLines'>;
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MANDATORY_CSV_SETTINGS: Readonly<{
+    readonly header: true;
+}>;

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

@@ -3,4 +3,4 @@
  *
  * @private internal index of `...` <- TODO [🏢]
  */
-export declare const FORMAT_DEFINITIONS: import("./_common/FormatDefinition").FormatDefinition<string, string, object>[];
+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>];

package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts

@@ -1,18 +1,19 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
 import type { FormatDefinition } from '../_common/FormatDefinition';
 /**
  * Definition for JSON format
  *
  * @private still in development [🏢]
  */
-export declare const JsonFormatDefinition: FormatDefinition<string, string, object>;
+export declare const JsonFormatDefinition: FormatDefinition<string, string, TODO_any, TODO_any>;
 /**
  * TODO: [🧠] Maybe propper instance of object
  * TODO: [0] Make string_serialized_json
- * TODO: [1] Make type for JSON Schema
+ * 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 `extractValues`
+ * TODO: [🍓] In `JsonFormatDefinition` implement `subvalueDefinitions`
  * TODO: [🏢] Allow to expect something inside JSON objects and other formats
  */

package/esm/typings/src/formats/text/TextFormatDefinition.d.ts

@@ -0,0 +1,19 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
+import type { FormatDefinition } from '../_common/FormatDefinition';
+/**
+ * Definition for any text - this will be always valid
+ *
+ * Note: This is not useful for validation, but for splitting and mapping with `subvalueDefinitions`
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const TextFormatDefinition: FormatDefinition<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 aviable 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: [🏢] Allow to expect something inside each item of list and other formats
+ */

package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts

@@ -1,18 +1,19 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
 import type { FormatDefinition } from '../_common/FormatDefinition';
 /**
  * Definition for XML format
  *
  * @private still in development [🏢]
  */
-export declare const XmlFormatDefinition: FormatDefinition<string, string, object>;
+export declare const XmlFormatDefinition: FormatDefinition<string, string, TODO_any, TODO_any>;
 /**
  * TODO: [🧠] Maybe propper instance of object
  * TODO: [0] Make string_serialized_xml
- * TODO: [1] Make type for XML Schema
+ * TODO: [1] Make type for XML Settings and Schema
  * TODO: [🧠] What to use for validating XMLs - XSD,...
  * TODO: [🍓] In `XmlFormatDefinition` implement simple `isValid`
  * TODO: [🍓] In `XmlFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `XmlFormatDefinition` implement `heal
- * TODO: [🍓] In `XmlFormatDefinition` implement `extractValues`
+ * TODO: [🍓] In `XmlFormatDefinition` implement `subvalueDefinitions`
  * TODO: [🏢] Allow to expect something inside XML and other formats
  */

package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -8,7 +8,7 @@ import type { string_markdown } from '../../../types/typeAliases';
  */
 export declare function prepareKnowledgeFromMarkdown(knowledgeContent: string_markdown, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
 /**
- * TODO: [🐝][🔼] !!! Export via `@promptbook/markdown`
+ * TODO: [🐝][🔼][main] !!! Export via `@promptbook/markdown`
  * TODO: [🪂] Do it in parallel 11:11
  * Note: No need to aggregate usage here, it is done by intercepting the llmTools
  */

package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts

@@ -8,7 +8,7 @@ import type { string_base64 } from '../../../types/typeAliases';
  */
 export declare function prepareKnowledgeFromPdf(content: string_base64, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
 /**
- * TODO: [🐝][🔼] !!! Export via `@promptbook/pdf`
+ * TODO: [🐝][🔼][main] !!! Export via `@promptbook/pdf`
  * TODO: [🧺] In future, content can be alse File or Blob BUT for now for wider compatibility its only base64
  *       @see https://stackoverflow.com/questions/14653349/node-js-cant-create-blobs
  * TODO: [🪂] Do it in parallel