@promptbook/markdown-utils 0.92.0-9 → 0.92.0

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

@@ -1,10 +1,11 @@
 import type { ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { Parameters } from '../../types/typeAliases';
 import type { ReservedParameters } from '../../types/typeAliases';
 import type { ExecutionTools } from '../ExecutionTools';
 /**
- * @@@
+ * Options for retrieving reserved parameters for a pipeline task, including context, pipeline, and identification.
  *
  * @private internal type of `getReservedParametersForTask`
  */
@@ -14,20 +15,32 @@ type GetReservedParametersForTaskOptions = {
      */
     readonly tools: ExecutionTools;
     /**
-     * @@@
+     * The prepared and validated pipeline in which the task resides.
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
     /**
-     * @@@
+     * The task for which reserved parameters are being retrieved.
      */
     readonly task: ReadonlyDeep<TaskJson>;
     /**
-     * @@@
+     * Parameters to complete the content of the task for embedding and context.
+     */
+    readonly parameters: Readonly<Parameters>;
+    /**
+     * String identifier for the pipeline, used in error messages and reporting.
      */
     readonly pipelineIdentification: string;
+    /**
+     * If true, the preparation logs the reserved parameters for debugging purposes.
+     */
+    readonly isVerbose?: boolean;
 };
 /**
- * @@@
+ * Retrieves all reserved parameters for a given pipeline task, including context, knowledge, examples, and metadata.
+ * Ensures all reserved parameters are defined and throws if any are missing.
+ *
+ * @param options - Options including tools, pipeline, task, and context.
+ * @returns An object containing all reserved parameters for the task.
  *
  * @private internal utility of `createPipelineExecutor`
  */

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

@@ -0,0 +1,9 @@
+import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
+/**
+ *
+ * @param knowledgePieces
+ * @returns
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function knowledgePiecesToString(knowledgePieces: ReadonlyArray<Pick<KnowledgePiecePreparedJson, 'content'>>): string;

package/esm/typings/src/execution/execution-report/ExecutionReportJson.d.ts

@@ -4,7 +4,7 @@ import type { string_semantic_version } from '../../types/typeAliases';
 import type { ExecutionPromptReportJson } from './ExecutionPromptReportJson';
 /**
  * ExecutionReport is result of executing one promptbook
- * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
+ * It is kind of a variant of the promptbook useful for debugging, logging and transparency for users.
  *
  * It can have 2 formats:
  * -   **.md file** created from the **JSON** format

package/esm/typings/src/execution/execution-report/ExecutionReportString.d.ts

@@ -1,6 +1,6 @@
 /**
  * ExecutionReport is result of executing one promptbook
- * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
+ * 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

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

@@ -1,18 +1,18 @@
 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 [🏳]
+ * @private still in development [🏳️]
  */
 export declare class LindatAutomaticTranslator implements AutomaticTranslator {
     protected readonly options: LindatAutomaticTranslatorOptions;

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

@@ -2,7 +2,7 @@ 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:
+ * Note: There are two similar functions:
  * - `checkExpectations` which throws an error if the expectations are not met
  * - `isPassingExpectations` which returns a boolean
  *
@@ -14,7 +14,7 @@ export declare function checkExpectations(expectations: Expectations, value: str
 /**
  * Function checkExpectations will check if the expectations on given value are met
  *
- * Note: There are two simmilar functions:
+ * Note: There are two similar functions:
  * - `checkExpectations` which throws an error if the expectations are not met
  * - `isPassingExpectations` which returns a boolean
  *
@@ -24,6 +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`
+ * TODO: [🧠][🤠] This should be part of `TextFormatParser`
  * Note: [💝] and [🤠] are interconnected together
  */

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

@@ -2,8 +2,9 @@ import type { UncertainNumber } from '../UncertainNumber';
 /**
  * Make UncertainNumber
  *
- * @param value
+ * @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): UncertainNumber;
+export declare function uncertainNumber(value?: number | typeof NaN | undefined | null, isUncertain?: boolean): UncertainNumber;

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

@@ -10,7 +10,7 @@ type PartialUsage = Pick<Usage, 'input' | 'output'> & {
 /**
  * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
  *
- * Note: This is an estimate based of theese sources:
+ * 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
  *

package/esm/typings/src/formats/_common/{FormatDefinition.d.ts → FormatParser.d.ts}

@@ -2,16 +2,18 @@ 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';
+import type { FormatSubvalueParser } from './FormatSubvalueParser';
 /**
- * A format definition is a set of functions that define how to validate, heal and convert response from LLM
+ * A format definition is a set of functions that define how to validate, heal and convert response from LLM.
  *
- * @@@ Describe setting vs schema
+ * @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 FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
+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
      *
@@ -56,9 +58,9 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
      */
     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 subvalueDefinitions: ReadonlyArray<FormatSubvalueDefinition<TValue, TSettings>>;
+    readonly subvalueParsers: ReadonlyArray<FormatSubvalueParser<TValue, TSettings>>;
 };
 /**
  * TODO: [♏] Add some prepare hook to modify prompt according to the format

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/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

@@ -1,10 +1,10 @@
 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`
  */

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

@@ -2,7 +2,7 @@
  * 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
+ * @returns `true` if the string is a valid CSV string, false otherwise
  *
  * @public exported from `@promptbook/utils`
  */

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

@@ -3,7 +3,7 @@
  *
  * @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>];
+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

@@ -2,7 +2,7 @@
  * 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
+ * @returns `true` if the string is a valid JSON string, false otherwise
  *
  * @public exported from `@promptbook/utils`
  */

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

@@ -6,6 +6,3 @@
  * @public exported from `@promptbook/utils`
  */
 export declare function jsonParse<T>(value: string): T;
-/**
- * TODO: !!!! Use in Promptbook.studio
- */

package/esm/typings/src/formats/text/{TextFormatDefinition.d.ts → TextFormatParser.d.ts}

@@ -1,19 +1,19 @@
 import type { TODO_any } from '../../utils/organization/TODO_any';
-import type { FormatDefinition } from '../_common/FormatDefinition';
+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 `subvalueDefinitions`
+ * Note: This is not useful for validation, but for splitting and mapping with `subvalueParsers`
  *
  * @public exported from `@promptbook/core`
  */
-export declare const TextFormatDefinition: FormatDefinition<string, string, TODO_any, TODO_any>;
+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 `TextFormatDefinition` implement simple `isValid`
- * TODO: [🍓] In `TextFormatDefinition` implement partial `canBeValid`
- * TODO: [🍓] In `TextFormatDefinition` implement `heal
- * TODO: [🍓] In `TextFormatDefinition` implement `subvalueDefinitions`
+ * 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

@@ -2,7 +2,7 @@
  * Function to check if a string is valid XML
  *
  * @param value
- * @returns True if the string is a valid XML string, false otherwise
+ * @returns `true` if the string is a valid XML string, false otherwise
  *
  * @public exported from `@promptbook/utils`
  */

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

@@ -1,11 +1,12 @@
 /**
- * Boilerplate is form of app that @@@
+ * 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: "@@@";
+    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 [];

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

@@ -4,34 +4,43 @@ 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;
 };

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

@@ -1,6 +1,8 @@
 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

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

@@ -1,5 +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'];

package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts

@@ -1,12 +1,12 @@
 /**
- * @@@
+ * Chatbot form factor definition for conversational interfaces that interact with users in a chat-like manner.
  *
  * @public exported from `@promptbook/core`
  */
 export declare const ChatbotFormfactorDefinition: {
     readonly name: "CHATBOT";
     readonly aliasNames: readonly ["CHAT"];
-    readonly description: "@@@";
+    readonly description: "A chatbot form factor for conversational user interfaces.";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/174";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{

package/esm/typings/src/formfactors/completion/CompletionFormfactorDefinition.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Completion is formfactor that emulates completion models
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const CompletionFormfactorDefinition: {
+    readonly name: "COMPLETION";
+    readonly description: "Completion is formfactor that emulates completion models";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [{
+            readonly name: "inputText";
+            readonly description: "Input text to be completed";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }, {
+            readonly name: "instructions";
+            readonly description: "Additional instructions for the model, for example the required length, empty by default";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "followingText";
+            readonly description: "Text that follows the input text";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
+    };
+};

package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts

@@ -1,5 +1,6 @@
 /**
- * Generator is form of app that @@@
+ * Generator form factor represents an application that generates content or data based on user input or predefined rules.
+ * This form factor is used for apps that produce outputs, such as text, images, or other media, based on provided input.
  *
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts

@@ -1,11 +1,11 @@
 /**
- * @@@
+ * A generic pipeline
  *
  * @public exported from `@promptbook/core`
  */
 export declare const GenericFormfactorDefinition: {
     readonly name: "GENERIC";
-    readonly description: "@@@";
+    readonly description: "A generic pipeline";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/173";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [];