@promptbook/wizard 0.95.0

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

@@ -0,0 +1,147 @@
+/**
+ * Represents the uncertain value
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ZERO_VALUE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    readonly value: 0;
+}>;
+/**
+ * Represents the uncertain value
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const UNCERTAIN_ZERO_VALUE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    readonly value: 0;
+    readonly isUncertain: true;
+}>;
+/**
+ * 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: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+        readonly value: 0;
+    }>;
+    readonly input: {
+        readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+        }>;
+        readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+        }>;
+        readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+        }>;
+        readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+        }>;
+        readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+        }>;
+        readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+        }>;
+        readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+        }>;
+    };
+    readonly output: {
+        readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+        }>;
+        readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+        }>;
+        readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+        }>;
+        readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+        }>;
+        readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+        }>;
+        readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+        }>;
+        readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            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: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+        readonly value: 0;
+        readonly isUncertain: true;
+    }>;
+    readonly input: {
+        readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+            readonly isUncertain: true;
+        }>;
+        readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+            readonly isUncertain: true;
+        }>;
+        readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+            readonly isUncertain: true;
+        }>;
+        readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+            readonly isUncertain: true;
+        }>;
+        readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+            readonly isUncertain: true;
+        }>;
+        readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+            readonly isUncertain: true;
+        }>;
+        readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+            readonly isUncertain: true;
+        }>;
+    };
+    readonly output: {
+        readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+            readonly isUncertain: true;
+        }>;
+        readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+            readonly isUncertain: true;
+        }>;
+        readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+            readonly isUncertain: true;
+        }>;
+        readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+            readonly isUncertain: true;
+        }>;
+        readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+            readonly isUncertain: true;
+        }>;
+        readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            readonly value: 0;
+            readonly isUncertain: true;
+        }>;
+        readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+            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 { 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/esm/typings/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/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/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/esm/typings/src/formats/_common/FormatSubvalueParser.d.ts

@@ -0,0 +1,66 @@
+import type { Promisable } from 'type-fest';
+import type { Parameters } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
+import type { empty_object } from '../../utils/organization/empty_object';
+/**
+ * Defines how to extract or map subvalues from a main value in a specific format (e.g., cells from CSV, items from JSON array).
+ * Used for iterating or transforming structured data in pipeline tasks.
+ */
+export type FormatSubvalueParser<TValue extends string, TSettings extends empty_object> = {
+    /**
+     * The name of the format used in .book.md files
+     *
+     * @example "CELL"
+     */
+    readonly subvalueName: string_name & string_SCREAMING_CASE;
+    /**
+     * Aliases for the `subvalueName`
+     */
+    readonly aliases?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
+    /**
+     * Maps or transforms subvalues from the main value. For example, iterates over all CSV cells or JSON array items.
+     *
+     * @param options - Options for mapping, including callbacks for progress and value transformation.
+     * @returns The final mapped string result.
+     */
+    mapValues(options: FormatSubvalueParserMapValuesOptions<TValue, TSettings>): Promise<string>;
+};
+/**
+ * Options for mapping or extracting subvalues from a main value using a FormatSubvalueParser.
+ */
+export type FormatSubvalueParserMapValuesOptions<TValue extends string, TSettings extends empty_object> = {
+    /**
+     * The input string value to parse for subvalues
+     */
+    readonly value: TValue;
+    /**
+     * The name of the output parameter where the processed value will be stored
+     */
+    readonly outputParameterName: string_parameter_name;
+    /**
+     * Format-specific settings that control how subvalues are parsed or processed
+     */
+    readonly settings: TSettings;
+    /**
+     * Callback function that processes each subvalue and returns the transformed value
+     *
+     * @param subvalues Object containing the extracted subvalues
+     * @param index Current index of the subvalue which is being mapped
+     * @param length Full length of the subvalues
+     * @param number Total number of subvalues to process
+     * @returns Transformed value after processing
+     */
+    mapCallback(subvalues: Parameters, index: number, length: number): Promisable<TValue>;
+    /**
+     * Progress callback that receives partial results during processing
+     *
+     * @param partialResultString The current partial result as processing progresses
+     * @returns Promise or void to continue execution
+     */
+    onProgress(partialResultString: TValue): Promisable<void>;
+};
+/**
+ * Note: [👩🏾‍🤝‍🧑🏽]
+ */

package/esm/typings/src/formats/csv/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/CsvFormatParser.d.ts

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

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

@@ -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/esm/typings/src/formats/csv/utils/csvParse.d.ts

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

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

@@ -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/esm/typings/src/formats/csv/utils/isValidCsvString.test.d.ts

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

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/FormatParser").FormatParser<string, string, any, any>, import("./_common/FormatParser").FormatParser<string, string, any, any>, import("./_common/FormatParser").FormatParser<string, string, any, any>, import("./_common/FormatParser").FormatParser<string, string, import("./csv/CsvSettings").CsvSettings, any>];
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/formats/json/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
+ */

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

@@ -0,0 +1,9 @@
+/**
+ * Function isValidJsonString will tell you if the string is valid JSON or not
+ *
+ * @param value The string to check
+ * @returns `true` if the string is a valid JSON string, false otherwise
+ *
+ * @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/json/utils/jsonParse.d.ts

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

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

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

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

@@ -0,0 +1,19 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
+import type { FormatParser } from '../_common/FormatParser';
+/**
+ * Definition for XML format
+ *
+ * @private still in development [🏢]
+ */
+export declare const XmlFormatParser: FormatParser<string, string, TODO_any, TODO_any>;
+/**
+ * TODO: [🧠] Maybe proper 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 `XmlFormatParser` implement simple `isValid`
+ * TODO: [🍓] In `XmlFormatParser` implement partial `canBeValid`
+ * TODO: [🍓] In `XmlFormatParser` implement `heal
+ * TODO: [🍓] In `XmlFormatParser` implement `subvalueParsers`
+ * TODO: [🏢] Allow to expect something inside XML and other formats
+ */

package/esm/typings/src/formats/xml/utils/isValidXmlString.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Function to check if a string is valid XML
+ *
+ * @param value
+ * @returns `true` if the string is a valid XML string, false otherwise
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isValidXmlString(value: string): boolean;

package/esm/typings/src/formats/xml/utils/isValidXmlString.test.d.ts

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

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

@@ -0,0 +1,15 @@
+/**
+ * Boilerplate is form of app that serves as a template structure for creating other formfactors
+ * and should not be used directly in production.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const BoilerplateFormfactorDefinition: {
+    readonly name: "BOILERPLATE";
+    readonly description: "A template structure for creating new formfactors, providing the base architecture and interfaces that should be implemented.";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [];
+        readonly outputParameters: readonly [];
+    };
+};

package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts

@@ -0,0 +1,49 @@
+import type { PipelineInterface } from '../../pipeline/PipelineInterface/PipelineInterface';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+import type { string_promptbook_documentation_url } from '../../types/typeAliases';
+import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
+/**
+ * AbstractFormfactorDefinition provides the base structure for all form factor implementations
+ * in the Promptbook system. It defines common properties and interfaces that must be
+ * implemented by specific form factors.
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/172
+ */
+export type AbstractFormfactorDefinition = {
+    /**
+     * Unique identifier for the form factor in SCREAMING_CASE format
+     * Used for programmatic identification and reference
+     */
+    readonly name: string_name & string_SCREAMING_CASE;
+    /**
+     * Alternative names that can be used to reference this form factor
+     * Also in SCREAMING_CASE format for consistency
+     */
+    readonly aliasNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
+    /**
+     * Previous names that were used for this form factor but are now deprecated
+     * These are maintained for backward compatibility purposes
+     */
+    readonly deprecatedNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
+    /**
+     * Human-readable description of the form factor in markdown format
+     * Explains the purpose, functionality, and use cases of this form factor
+     */
+    readonly description: string_markdown_text;
+    /**
+     * URL pointing to detailed documentation for this form factor
+     * Provides additional resources and guidance for implementation and usage
+     */
+    readonly documentationUrl: string_promptbook_documentation_url;
+    /**
+     * Defines the interface structure for this form factor's pipeline
+     * Specifies how inputs and outputs are handled, processed, and formatted
+     * Required for properly configuring and executing the form factor's functionality
+     */
+    readonly pipelineInterface: PipelineInterface;
+};
+/**
+ * TODO: [🧠][🤓] How to pass optional parameters - for example summary in FORMFACTOR Translator
+ */

package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts

@@ -0,0 +1,10 @@
+import { FORMFACTOR_DEFINITIONS } from '../index';
+/**
+ * FormfactorDefinition is a type that defines the structure and capabilities of a specific
+ * application form factor in the Promptbook system. It encapsulates all properties needed
+ * to represent how a particular interface handles inputs, outputs, and behaviors.
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/172
+ */
+export type FormfactorDefinition = typeof FORMFACTOR_DEFINITIONS[number];

package/esm/typings/src/formfactors/_common/string_formfactor_name.d.ts

@@ -0,0 +1,6 @@
+import type { FormfactorDefinition } from './FormfactorDefinition';
+/**
+ * A type alias representing the name of a formfactor, used for type checking and validation
+ * in the formfactor registry and selection processes
+ */
+export type string_formfactor_name = FormfactorDefinition['name'];