@promptbook/javascript 0.111.0-3 → 0.111.0-7

package/umd/src/execution/execution-report/ExecutionReportString.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ExecutionReport is result of executing one promptbook
+ * It is kind of a variant of the promptbook useful for debugging, logging and transparency for users.
+ *
+ * It can have 2 formats:
+ * -   _(this)_ **.md file** created from the **JSON** format
+ * -   **JSON** format
+ *
+ * @see https://github.com/webgptorg/promptbook#execution-report
+ */
+export type ExecutionReportString = string & {
+    readonly _type: 'ExecutionReportString';
+};
+/**
+ * TODO: [💩] Better validation or remove branded type and make it just string
+ */

package/umd/src/execution/execution-report/ExecutionReportStringOptions.d.ts

@@ -0,0 +1,25 @@
+import type { number_percent } from '../../types/typeAliases';
+/**
+ * Options for `executionReportJsonToString`
+ *
+ * @public exported from `@promptbook/core`
+ */
+export type ExecutionReportStringOptions = {
+    /**
+     * The tax rate to be applied, expressed as a percentage from 0 to 1 (=100%) or even more
+     */
+    readonly taxRate: number_percent;
+    /**
+     * The width of the charts in the report
+     */
+    readonly chartsWidth: number;
+};
+/**
+ * Default options for generating an execution report string
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ExecutionReportStringOptionsDefaults: {
+    taxRate: number;
+    chartsWidth: number;
+};

package/umd/src/execution/execution-report/countWorkingDuration.d.ts

@@ -0,0 +1,7 @@
+import type { FromtoItems } from '../../utils/misc/FromtoItems';
+/**
+ * Count the duration of working time
+ *
+ * @private within the repository
+ */
+export declare function countWorkingDuration(items: FromtoItems): number;

package/umd/src/execution/execution-report/countWorkingDuration.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/execution/execution-report/executionReportJsonToString.d.ts

@@ -0,0 +1,15 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { ExecutionReportJson } from './ExecutionReportJson';
+import type { ExecutionReportString } from './ExecutionReportString';
+import type { ExecutionReportStringOptions } from './ExecutionReportStringOptions';
+/**
+ * Converts execution report from JSON to string format
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function executionReportJsonToString(executionReportJson: ReadonlyDeep<ExecutionReportJson>, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
+/**
+ * TODO: Add mermaid chart for every report
+ * TODO: [🧠] Allow to filter out some parts of the report by options
+ * TODO: [🧠] Should be in generated file GENERATOR_WARNING
+ */

package/umd/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts

@@ -0,0 +1,7 @@
+import type { Promisable } from 'type-fest';
+/**
+ * @private still in development [🏳]
+ */
+export type AutomaticTranslator = {
+    translate(message: string): Promisable<string>;
+};

package/umd/src/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts

@@ -0,0 +1,11 @@
+import type { AutomaticTranslator } from './AutomaticTranslator';
+/**
+ * This will wrap an automatic translator and log each translation into the console
+ *
+ * @private still in development [🏳]
+ */
+export declare class DebugAutomaticTranslator implements AutomaticTranslator {
+    private readonly automaticTranslator;
+    constructor(automaticTranslator: AutomaticTranslator);
+    translate(message: string): Promise<string>;
+}

package/umd/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts

@@ -0,0 +1,8 @@
+import type { AutomaticTranslator } from './AutomaticTranslator';
+/**
+ * @private still in development [🏳]
+ */
+export declare class FakeAutomaticTranslator implements AutomaticTranslator {
+    constructor();
+    translate(message: string): string;
+}

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

@@ -0,0 +1,22 @@
+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 [🏳️]
+ */
+export declare class LindatAutomaticTranslator implements AutomaticTranslator {
+    protected readonly options: LindatAutomaticTranslatorOptions;
+    constructor(options: LindatAutomaticTranslatorOptions);
+    translate(message: string): Promise<string>;
+}
+export {};

package/umd/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @private still in development [🏳]
+ */
+export type TranslatorOptions = {
+    readonly from?: string;
+    readonly to: string;
+};

package/umd/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts

@@ -0,0 +1,8 @@
+/**
+ *
+ * @param message
+ * @returns
+ * @throws {PipelineExecutionError}
+ * @private still in development [🏳]
+ */
+export declare function extractMultiplicatedOccurrence(message: string): string;

package/umd/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,12 @@
+import type { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
+import type { TranslatorOptions } from './automatic-translators/TranslatorOptions';
+/**
+ * @private still in development [🏳]
+ */
+export declare function translateMessages({ automaticTranslator, from, to, }: {
+    automaticTranslator: AutomaticTranslator;
+} & TranslatorOptions): Promise<void>;
+/**
+ * TODO: [😶] Unite folder listing
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/umd/src/execution/utils/$provideExecutionToolsForNode.d.ts

@@ -0,0 +1,14 @@
+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
+ * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
+ */

package/umd/src/execution/utils/addUsage.d.ts

@@ -0,0 +1,9 @@
+import type { Usage } from '../Usage';
+/**
+ * Function `addUsage` will add multiple usages into one
+ *
+ * Note: If you provide 0 values, it returns ZERO_USAGE
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function addUsage(...usageItems: ReadonlyArray<Usage>): Usage;

package/umd/src/execution/utils/addUsage.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/execution/utils/checkExpectations.d.ts

@@ -0,0 +1,29 @@
+import type { Expectations } from '../../pipeline/PipelineJson/Expectations';
+/**
+ * Function checkExpectations will check if the expectations on given value are met
+ *
+ * Note: There are two similar functions:
+ * - `checkExpectations` which throws an error if the expectations are not met
+ * - `isPassingExpectations` which returns a boolean
+ *
+ * @throws {ExpectError} if the expectations are not met
+ * @returns {void} Nothing
+ * @private internal function of `createPipelineExecutor`
+ */
+export declare function checkExpectations(expectations: Expectations, value: string): void;
+/**
+ * Function checkExpectations will check if the expectations on given value are met
+ *
+ * Note: There are two similar functions:
+ * - `checkExpectations` which throws an error if the expectations are not met
+ * - `isPassingExpectations` which returns a boolean
+ *
+ * @returns {boolean} True if the expectations are met
+ * @public exported from `@promptbook/core`
+ */
+export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
+/**
+ * TODO: [💝] Unite object for expecting amount and format
+ * TODO: [🧠][🤠] This should be part of `TextFormatParser`
+ * Note: [💝] and [🤠] are interconnected together
+ */

package/umd/src/execution/utils/checkExpectations.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/execution/utils/computeUsageCounts.d.ts

@@ -0,0 +1,10 @@
+import type { UsageCounts } from '../Usage';
+/**
+ * Helper of usage compute
+ *
+ * @param content the content of prompt or response
+ * @returns part of UsageCounts
+ *
+ * @private internal utility of LlmExecutionTools
+ */
+export declare function computeUsageCounts(content: string): Omit<UsageCounts, 'tokensCount'>;

package/umd/src/execution/utils/forEachAsync.d.ts

@@ -0,0 +1,20 @@
+import type { Promisable } from 'type-fest';
+type ForEachAsyncOptions = {
+    /**
+     * Maximum number of tasks running in parallel
+     *
+     * @default Infinity
+     */
+    readonly maxParallelCount?: number;
+};
+/**
+ * Async version of Array.forEach
+ *
+ * @param array - Array to iterate over
+ * @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: ReadonlyArray<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: ReadonlyArray<TItem>) => Promisable<void>): Promise<void>;
+export {};

package/umd/src/execution/utils/uncertainNumber.d.ts

@@ -0,0 +1,10 @@
+import type { UncertainNumber } from '../UncertainNumber';
+/**
+ * Make UncertainNumber
+ *
+ * @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, isUncertain?: boolean): UncertainNumber;

package/umd/src/execution/utils/usage-constants.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Represents the uncertain value
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ZERO_VALUE: any;
+/**
+ * Represents the uncertain value
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const UNCERTAIN_ZERO_VALUE: any;
+/**
+ * Represents the usage with no resources consumed
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ZERO_USAGE: any;
+/**
+ * Represents the usage with unknown resources consumed
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const UNCERTAIN_USAGE: any;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/umd/src/execution/utils/usageToHuman.d.ts

@@ -0,0 +1,26 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { UncertainNumber } from '../UncertainNumber';
+import type { Usage } from '../Usage';
+/**
+ * Minimal usage information required to calculate worktime
+ */
+type PartialUsage = Partial<Usage> & {
+    price: UncertainNumber;
+    input: Pick<Usage['input'], 'wordsCount'>;
+    output: Pick<Usage['output'], 'wordsCount' | 'charactersCount'>;
+};
+/**
+ * Function `usageToHuman` will take usage and convert it to human readable report
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function usageToHuman(usage: PartialUsage): string_markdown;
+export {};
+/**
+ * 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: [🧠] Maybe use "~" instead of "approximately"
+ * TODO: [🏛] Maybe make some markdown builder
+ */

package/umd/src/execution/utils/usageToWorktime.d.ts

@@ -0,0 +1,20 @@
+import type { UncertainNumber } from '../UncertainNumber';
+import type { Usage } from '../Usage';
+/**
+ * Minimal usage information required to calculate worktime
+ */
+type PartialUsage = Pick<Usage, 'input' | 'output'> & {
+    input: Pick<Usage['input'], 'wordsCount'>;
+    output: Pick<Usage['output'], 'wordsCount'>;
+};
+/**
+ * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
+ *
+ * Note: This is an estimate based of these sources:
+ * - https://jecas.cz/doba-cteni
+ * - https://www.originalnitonery.cz/blog/psani-vsemi-deseti-se-muzete-naucit-i-sami-doma
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function usageToWorktime(usage: PartialUsage): UncertainNumber;
+export {};

package/umd/src/execution/utils/usageToWorktime.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/execution/utils/validatePromptResult.d.ts

@@ -0,0 +1,55 @@
+import type { FormatCommand } from '../../commands/FORMAT/FormatCommand';
+import { ExpectError } from '../../errors/ExpectError';
+import type { Expectations } from '../../pipeline/PipelineJson/Expectations';
+import type { string_postprocessing_function_name } from '../../types/typeAliases';
+/**
+ * Options for validating a prompt result
+ */
+export type ValidatePromptResultOptions = {
+    /**
+     * The result string to validate
+     */
+    resultString: string;
+    /**
+     * Expectations for the result (word count, sentence count, etc.)
+     */
+    expectations?: Expectations;
+    /**
+     * Expected format of the result (e.g., 'JSON')
+     */
+    format?: FormatCommand['format'];
+    /**
+     * List of postprocessing function names that should be applied
+     * Note: This is for validation purposes only - postprocessing should be done before calling this function
+     */
+    postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>;
+};
+/**
+ * Result of prompt result validation
+ */
+export type ValidatePromptResultResult = {
+    /**
+     * Whether the result is valid (passes all expectations and format checks)
+     */
+    isValid: boolean;
+    /**
+     * The processed result string (may be modified if format extraction was needed)
+     */
+    processedResultString: string;
+    /**
+     * Error that occurred during validation, if any
+     */
+    error?: ExpectError;
+};
+/**
+ * Validates a prompt result against expectations and format requirements.
+ * This function provides a common abstraction for result validation that can be used
+ * by both execution logic and caching logic to ensure consistency.
+ *
+ * Note: [🔂] This function is idempotent.
+ *
+ * @param options - The validation options including result string, expectations, and format
+ * @returns Validation result with processed string and validity status
+ * @private internal function of `createPipelineExecutor` and `cacheLlmTools`
+ */
+export declare function validatePromptResult(options: ValidatePromptResultOptions): ValidatePromptResultResult;

package/umd/src/formats/_common/FormatParser.d.ts

@@ -0,0 +1,72 @@
+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 { FormatSubvalueParser } from './FormatSubvalueParser';
+/**
+ * A format definition is a set of functions that define how to validate, heal and convert response from LLM.
+ *
+ * @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 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
+     *
+     * @example "JSON"
+     */
+    readonly formatName: string_name & string_SCREAMING_CASE;
+    /**
+     * Aliases for the `formatName`
+     */
+    readonly aliases?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
+    /**
+     * The mime type of the format (if any)
+     *
+     * @example "application/json"
+     */
+    readonly mimeType?: string_mime_type;
+    /**
+     * Check if a value is fully valid
+     *
+     * @param value The value to check, for example "{\"foo\": true}"
+     * @param schema Optional schema to do extra validation
+     */
+    isValid(value: string, settings?: TSettings, schema?: TSchema): value is TValue;
+    /**
+     * Check if a first part of a value is valid
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/37
+     *
+     * @param partialValue Partial value to check, for example "{\"foo\": t"
+     * @param schema Optional schema to do extra validation
+     */
+    canBeValid(partialValue: string, settings?: TSettings, schema?: TSchema): partialValue is TPartialValue;
+    /**
+     * Heal a value to make it valid if possible
+     *
+     * Note: This make sense in context of LLMs that often returns slightly invalid values
+     * @see https://github.com/webgptorg/promptbook/discussions/31
+     *
+     * @param value The value to heal, for example "{foo: true}"
+     * @param scheme
+     * @throws {Error} If the value cannot be healed
+     */
+    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>>;
+};
+/**
+ * TODO: [♏] Add some prepare hook to modify prompt according to the format
+ * TODO: [🍓]`name` and `aliases` should be UPPERCASE only and interpreted as case-insensitive (via normalization)
+ * TODO: [🍓][👨‍⚖️] Compute TPartialValue dynamically - PartialString<TValue>
+ * TODO: [🍓][🧠] Should execution tools be available to heal, canBeValid and isValid?
+ * TODO: [🍓][🧠] llm Provider Bindings
+ * TODO: [🍓][🔼] Export via some package
+ */

package/umd/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/umd/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/umd/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/umd/src/formats/csv/CsvSettings.d.ts

@@ -0,0 +1,13 @@
+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`
+ */
+export declare const MANDATORY_CSV_SETTINGS: Readonly<{
+    readonly header: true;
+}>;

package/umd/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/umd/src/formats/csv/utils/isValidCsvString.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isValidCsvString(value: string): boolean;

package/umd/src/formats/csv/utils/isValidCsvString.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/formats/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Definitions for all formats supported by Promptbook
+ *
+ * @private internal index of `...` <- TODO [🏢]
+ */
+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/umd/src/formats/json/JsonFormatParser.d.ts

@@ -0,0 +1,19 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
+import type { FormatParser } from '../_common/FormatParser';
+/**
+ * Definition for JSON format
+ *
+ * @private still in development [🏢]
+ */
+export declare const JsonFormatParser: FormatParser<string, string, TODO_any, TODO_any>;
+/**
+ * TODO: [🧠] Maybe proper 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 `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
+ */