@promptbook/javascript 0.88.0-1

package/esm/typings/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/esm/typings/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/esm/typings/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/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts

@@ -0,0 +1,22 @@
+import type { AutomaticTranslator } from './AutomaticTranslator';
+import type { TranslatorOptions } from './TranslatorOptions';
+/**
+ * @@@
+ */
+type LindatAutomaticTranslatorOptions = TranslatorOptions & {
+    /**
+     * @@@
+     */
+    readonly apiUrl?: URL;
+};
+/**
+ * @@@
+ *
+ * @private still in development [🏳]
+ */
+export declare class LindatAutomaticTranslator implements AutomaticTranslator {
+    protected readonly options: LindatAutomaticTranslatorOptions;
+    constructor(options: LindatAutomaticTranslatorOptions);
+    translate(message: string): Promise<string>;
+}
+export {};

package/esm/typings/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/esm/typings/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/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts

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

package/esm/typings/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 floder listing
+ * 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/$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/addUsage.d.ts

@@ -0,0 +1,9 @@
+import type { PromptResultUsage } from '../PromptResultUsage';
+/**
+ * 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<PromptResultUsage>): PromptResultUsage;

package/esm/typings/src/execution/utils/addUsage.test.d.ts

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

package/esm/typings/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 simmilar 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 simmilar 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 `TextFormatDefinition`
+ * Note: [💝] and [🤠] are interconnected together
+ */

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

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

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

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

package/esm/typings/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/esm/typings/src/execution/utils/uncertainNumber.d.ts

@@ -0,0 +1,9 @@
+import type { UncertainNumber } from '../UncertainNumber';
+/**
+ * Make UncertainNumber
+ *
+ * @param value
+ *
+ * @private utility for initializating UncertainNumber
+ */
+export declare function uncertainNumber(value?: number | typeof NaN | undefined | null): UncertainNumber;

package/esm/typings/src/execution/utils/usage-constants.d.ts

@@ -0,0 +1,130 @@
+/**
+ * Represents the usage with no resources consumed
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ZERO_USAGE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    readonly price: {
+        readonly value: 0;
+    };
+    readonly input: {
+        readonly tokensCount: {
+            readonly value: 0;
+        };
+        readonly charactersCount: {
+            readonly value: 0;
+        };
+        readonly wordsCount: {
+            readonly value: 0;
+        };
+        readonly sentencesCount: {
+            readonly value: 0;
+        };
+        readonly linesCount: {
+            readonly value: 0;
+        };
+        readonly paragraphsCount: {
+            readonly value: 0;
+        };
+        readonly pagesCount: {
+            readonly value: 0;
+        };
+    };
+    readonly output: {
+        readonly tokensCount: {
+            readonly value: 0;
+        };
+        readonly charactersCount: {
+            readonly value: 0;
+        };
+        readonly wordsCount: {
+            readonly value: 0;
+        };
+        readonly sentencesCount: {
+            readonly value: 0;
+        };
+        readonly linesCount: {
+            readonly value: 0;
+        };
+        readonly paragraphsCount: {
+            readonly value: 0;
+        };
+        readonly pagesCount: {
+            readonly value: 0;
+        };
+    };
+}>;
+/**
+ * Represents the usage with unknown resources consumed
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const UNCERTAIN_USAGE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    readonly price: {
+        readonly value: 0;
+        readonly isUncertain: true;
+    };
+    readonly input: {
+        readonly tokensCount: {
+            readonly value: 0;
+            readonly isUncertain: true;
+        };
+        readonly charactersCount: {
+            readonly value: 0;
+            readonly isUncertain: true;
+        };
+        readonly wordsCount: {
+            readonly value: 0;
+            readonly isUncertain: true;
+        };
+        readonly sentencesCount: {
+            readonly value: 0;
+            readonly isUncertain: true;
+        };
+        readonly linesCount: {
+            readonly value: 0;
+            readonly isUncertain: true;
+        };
+        readonly paragraphsCount: {
+            readonly value: 0;
+            readonly isUncertain: true;
+        };
+        readonly pagesCount: {
+            readonly value: 0;
+            readonly isUncertain: true;
+        };
+    };
+    readonly output: {
+        readonly tokensCount: {
+            readonly value: 0;
+            readonly isUncertain: true;
+        };
+        readonly charactersCount: {
+            readonly value: 0;
+            readonly isUncertain: true;
+        };
+        readonly wordsCount: {
+            readonly value: 0;
+            readonly isUncertain: true;
+        };
+        readonly sentencesCount: {
+            readonly value: 0;
+            readonly isUncertain: true;
+        };
+        readonly linesCount: {
+            readonly value: 0;
+            readonly isUncertain: true;
+        };
+        readonly paragraphsCount: {
+            readonly value: 0;
+            readonly isUncertain: true;
+        };
+        readonly pagesCount: {
+            readonly value: 0;
+            readonly isUncertain: true;
+        };
+    };
+}>;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,26 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { PromptResultUsage } from '../PromptResultUsage';
+import type { UncertainNumber } from '../UncertainNumber';
+/**
+ * Minimal usage information required to calculate worktime
+ */
+type PartialPromptResultUsage = Partial<PromptResultUsage> & {
+    price: UncertainNumber;
+    input: Pick<PromptResultUsage['input'], 'wordsCount'>;
+    output: Pick<PromptResultUsage['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: PartialPromptResultUsage): 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/esm/typings/src/execution/utils/usageToWorktime.d.ts

@@ -0,0 +1,20 @@
+import type { PromptResultUsage } from '../PromptResultUsage';
+import type { UncertainNumber } from '../UncertainNumber';
+/**
+ * Minimal usage information required to calculate worktime
+ */
+type PartialPromptResultUsage = Pick<PromptResultUsage, 'input' | 'output'> & {
+    input: Pick<PromptResultUsage['input'], 'wordsCount'>;
+    output: Pick<PromptResultUsage['output'], 'wordsCount'>;
+};
+/**
+ * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
+ *
+ * Note: This is an estimate based of theese 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: PartialPromptResultUsage): UncertainNumber;
+export {};

package/esm/typings/src/execution/utils/usageToWorktime.test.d.ts

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

package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts

@@ -0,0 +1,10 @@
+import type { PromptbookFetch } from '../../execution/PromptbookFetch';
+import type { string_name } from '../../types/typeAliases';
+/**
+ * @private still in development
+ */
+export declare function isDomainNameFree(name: string_name, fetch: PromptbookFetch): Promise<boolean>;
+/**
+ * TODO: [🍓][🧠] Test and implement `isDomainNameFree`
+ * TODO: Export via some (and probably new) NPM package
+ */

package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts

@@ -0,0 +1,10 @@
+import type { PromptbookFetch } from '../../execution/PromptbookFetch';
+import type { string_name } from '../../types/typeAliases';
+/**
+ * @private still in development
+ */
+export declare function isGithubNameFree(name: string_name, fetch: PromptbookFetch): Promise<boolean>;
+/**
+ * TODO: [🍓][🧠] Test and implement `isGithubNameFree`
+ * TODO: Export via some (and probably new) NPM package
+ */

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

@@ -0,0 +1,70 @@
+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, 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;
+    /**
+     * @@@
+     */
+    readonly subvalueDefinitions: ReadonlyArray<FormatSubvalueDefinition<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/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_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';
+/**
+ * @@@
+ */
+export type FormatSubvalueDefinition<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 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/CsvFormatDefinition.d.ts

@@ -0,0 +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
+ *
+ * @public exported from `@promptbook/core`
+ *                          <- TODO: [🏢] Export from package `@promptbook/csv`
+ */
+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 `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

@@ -0,0 +1,9 @@
+/**
+ * Definitions for all formats supported by Promptbook
+ *
+ * @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>];
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */ 

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

@@ -0,0 +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, 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: [🏢] Allow to expect something inside JSON objects and other formats
+ */

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

@@ -0,0 +1,6 @@
+/**
+ * Function isValidJsonString will tell you if the string is valid JSON or not
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isValidJsonString(value: string): boolean;

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

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

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 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: [🏢] Allow to expect something inside each item of list and other formats
+ */

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

@@ -0,0 +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, TODO_any, TODO_any>;
+/**
+ * TODO: [🧠] Maybe propper instance of object
+ * TODO: [0] Make string_serialized_xml
+ * 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 `subvalueDefinitions`
+ * TODO: [🏢] Allow to expect something inside XML and other formats
+ */

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

@@ -0,0 +1,14 @@
+/**
+ * Boilerplate is form of app that @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const BoilerplateFormfactorDefinition: {
+    readonly name: "BOILERPLATE";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [];
+        readonly outputParameters: readonly [];
+    };
+};