@promptbook/types 0.61.0-1 → 0.61.0-11

package/umd/typings/src/_packages/core.index.d.ts

@@ -17,6 +17,7 @@ import { PipelineExecutionError } from '../errors/PipelineExecutionError';
 import { PipelineLogicError } from '../errors/PipelineLogicError';
 import { ReferenceError } from '../errors/ReferenceError';
 import { UnexpectedError } from '../errors/UnexpectedError';
+import { VersionMismatchError } from '../errors/VersionMismatchError';
 import { ExpectError } from '../errors/_ExpectError';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { createPipelineExecutor } from '../execution/createPipelineExecutor';
@@ -29,6 +30,8 @@ import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callbac
 import { SimplePromptInterfaceTools } from '../knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools';
 import { prepareKnowledgeFromMarkdown } from '../knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown';
 import { joinLlmExecutionTools } from '../llm-providers/multiple/joinLlmExecutionTools';
+import { preparePipeline } from '../prepare/preparePipeline';
+import { unpreparePipeline } from '../prepare/unpreparePipeline';
 import type { ExecutionReportStringOptions } from '../types/execution-report/ExecutionReportStringOptions';
 import { ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
@@ -39,6 +42,7 @@ export { addUsage, assertsExecutionSuccessful, checkExpectations, embeddingVecto
 export { collectionToJson, createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createSubcollection, };
 export { SimplePromptInterfaceTools };
 export { pipelineJsonToString, pipelineStringToJson, pipelineStringToJsonSync, validatePipeline };
+export { preparePipeline, unpreparePipeline };
 export { createPipelineExecutor, joinLlmExecutionTools };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };
-export { CollectionError, ExpectError, NotFoundError, ParsingError, PipelineExecutionError, PipelineLogicError, ReferenceError, UnexpectedError, };
+export { CollectionError, ExpectError, NotFoundError, ParsingError, PipelineExecutionError, PipelineLogicError, ReferenceError, UnexpectedError, VersionMismatchError, };

package/umd/typings/src/_packages/types.index.d.ts

@@ -12,10 +12,12 @@ import type { ModelRequirements, ModelVariant } from '../types/ModelRequirements
 import type { Parameters } from '../types/Parameters';
 import type { ExpectationAmount, ExpectationUnit, Expectations } from '../types/PipelineJson/Expectations';
 import { EXPECTATION_UNITS } from '../types/PipelineJson/Expectations';
-import { KnowledgeJson } from '../types/PipelineJson/KnowledgeJson';
+import { KnowledgePiecePreparedJson } from '../types/PipelineJson/KnowledgePieceJson';
+import { KnowledgeSourceJson, KnowledgeSourcePreparedJson } from '../types/PipelineJson/KnowledgeSourceJson';
 import type { LlmTemplateJson } from '../types/PipelineJson/LlmTemplateJson';
-import { MaterialKnowledgePieceJson } from '../types/PipelineJson/MaterialKnowledgePieceJson';
+import { PersonaJson, PersonaPreparedJson } from '../types/PipelineJson/PersonaJson';
 import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import { PreparationJson } from '../types/PipelineJson/PreparationJson';
 import type { PromptDialogJson } from '../types/PipelineJson/PromptDialogJson';
 import type { PromptTemplateJson } from '../types/PipelineJson/PromptTemplateJson';
 import type { PromptTemplateParameterJson } from '../types/PipelineJson/PromptTemplateParameterJson';
@@ -27,12 +29,12 @@ import type { ScriptLanguage } from '../types/ScriptLanguage';
 import type { TaskProgress } from '../types/TaskProgress';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
 import type { string_char_emoji } from '../types/typeAliasEmoji';
-import type { client_id, string_char, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_emails, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_pipeline_url, string_pipeline_url_with_hashtemplate, string_prompt, string_script, string_semantic_version, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_uuid } from '../types/typeAliases';
+import type { client_id, number_model_temperature, number_seed, string_char, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_emails, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_parameter_name, string_parameter_value, string_person_fullname, string_pipeline_url, string_pipeline_url_with_hashtemplate, string_prompt, string_script, string_semantic_version, string_sha256, string_system_message, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_uuid } from '../types/typeAliases';
 import type { FromtoItems } from '../utils/FromtoItems';
 import { PROMPTBOOK_VERSION, string_promptbook_version } from '../version';
 export { PROMPTBOOK_VERSION };
 export { EXPECTATION_UNITS };
-export type { AvailableModel, BlockType, CommonExecutionToolsOptions, EmbeddingVector, ExecutionReportJson, ExecutionTools, ExpectationAmount, ExpectationUnit, Expectations, FromtoItems, KnowledgeJson, LlmExecutionTools, LlmTemplateJson, MaterialKnowledgePieceJson, ModelRequirements, ModelVariant, Parameters, PipelineCollection, PipelineExecutor, PipelineJson, PipelineString, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptEmbeddingResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, client_id, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_emails, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_pipeline_url, string_pipeline_url_with_hashtemplate, string_prompt, string_promptbook_version, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_uuid, string_semantic_version as string_version, };
+export type { AvailableModel, BlockType, CommonExecutionToolsOptions, EmbeddingVector, ExecutionReportJson, ExecutionTools, ExpectationAmount, ExpectationUnit, Expectations, FromtoItems, KnowledgePiecePreparedJson, KnowledgeSourceJson, KnowledgeSourcePreparedJson, LlmExecutionTools, LlmTemplateJson, ModelRequirements, ModelVariant, Parameters, PersonaJson, PersonaPreparedJson, PipelineCollection, PipelineExecutor, PipelineJson, PipelineString, PreparationJson, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptEmbeddingResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, client_id, number_model_temperature, number_seed, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_emails, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_parameter_name, string_parameter_value, string_person_fullname, string_pipeline_url, string_pipeline_url_with_hashtemplate, string_prompt, string_promptbook_version, string_script, string_semantic_version, string_sha256, string_system_message, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_uuid, };
 /**
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here
  */

package/umd/typings/src/_packages/utils.index.d.ts

@@ -7,6 +7,7 @@ import { titleToName } from '../conversion/utils/titleToName';
 import { forEachAsync } from '../execution/utils/forEachAsync';
 import { replaceParameters } from '../execution/utils/replaceParameters';
 import { isValidJsonString } from '../formats/json/utils/isValidJsonString';
+import { $currentDate } from '../utils/currentDate';
 import { countCharacters } from '../utils/expectation-counters/countCharacters';
 import { countLines } from '../utils/expectation-counters/countLines';
 import { countPages } from '../utils/expectation-counters/countPages';
@@ -34,6 +35,7 @@ import { removeDiacritics } from '../utils/normalization/removeDiacritics';
 import { searchKeywords } from '../utils/normalization/searchKeywords';
 import { parseNumber } from '../utils/parseNumber';
 import { extractBlock } from '../utils/postprocessing/extractBlock';
+import { $randomSeed } from '../utils/random/randomSeed';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';
 import { difference } from '../utils/sets/difference';
@@ -53,8 +55,8 @@ import { isValidUrl } from '../utils/validators/url/isValidUrl';
 import { isValidUuid } from '../utils/validators/uuid/isValidUuid';
 import { PROMPTBOOK_VERSION } from '../version';
 export { forEachAsync, PROMPTBOOK_VERSION };
-export { extractBlock, // <- [🌻] + maybe export through `@promptbook/markdown-utils`
-extractParameters, extractVariables, isHostnameOnPrivateNetwork, isUrlOnPrivateNetwork, isValidFilePath, isValidJavascriptName, isValidJsonString, isValidPipelineUrl as isValidPipelineUrl, isValidPromptbookVersion, isValidSemanticVersion, isValidUrl, isValidUuid, parseNumber, // <- [🌻]
+export { $currentDate, $randomSeed, extractBlock, // <- [🌻] + maybe export through `@promptbook/markdown-utils`
+extractParameters, extractVariables, isHostnameOnPrivateNetwork, isUrlOnPrivateNetwork, isValidFilePath, isValidJavascriptName, isValidJsonString, isValidPipelineUrl, isValidPromptbookVersion, isValidSemanticVersion, isValidUrl, isValidUuid, parseNumber, // <- [🌻]
 removeEmojis, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
 export { splitIntoSentences };
@@ -70,6 +72,5 @@ export type { string_camelCase, string_kebab_case, string_PascalCase, string_SCR
 export { extractParametersFromPromptTemplate, renameParameter, renderPromptbookMermaid };
 export { difference, intersection, union };
 /**
- * TODO: [🧠] Maybe create some indipendent package like `@promptbook/markdown-utils`
  * Note: [🕙] It does not make sence to have simple lower / UPPER case normalization
  */

package/umd/typings/src/collection/constructors/createCollectionFromDirectory.d.ts

@@ -29,7 +29,7 @@ type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions
      *
      * @default true
      */
-    isCrashOnError?: boolean;
+    isCrashedOnError?: boolean;
 };
 /**
  * Constructs Promptbook from given directory

package/umd/typings/src/collection/constructors/createCollectionFromUrl.d.ts

@@ -9,13 +9,13 @@ type CreatePipelineCollectionFromUrlyOptions = {
      *
      * @default false
      */
-    isVerbose?: boolean;
+    readonly isVerbose?: boolean;
     /**
      * If true, directory will be scanned only when needed not during the construction
      *
      * @default false
      */
-    isLazyLoaded?: boolean;
+    readonly isLazyLoaded?: boolean;
 };
 /**
  * Constructs Promptbook from remote Promptbase URL

package/umd/typings/src/commands/MODEL/ModelCommand.d.ts

@@ -1,5 +1,5 @@
 import type { ModelRequirements } from '../../types/ModelRequirements';
-import type { TODO } from '../../types/typeAliases';
+import type { TODO } from '../../utils/organization/TODO';
 /**
  * Parsed MODEL command
  *

package/umd/typings/src/commands/PERSONA/PersonaCommand.d.ts

@@ -1,3 +1,5 @@
+import type { string_name } from '../../types/typeAliases';
+import type { string_persona_description } from '../../types/typeAliases';
 /**
  * Parsed PERSONA command
  *
@@ -6,6 +8,6 @@
  */
 export type PersonaCommand = {
     readonly type: 'PERSONA';
-    personaName: string;
-    personaDescription: string | null;
+    readonly personaName: string_name;
+    readonly personaDescription: string_persona_description | null;
 };

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

@@ -1,3 +1,5 @@
+import type { WritableDeep } from 'type-fest';
+import type { PipelineJson } from '../../../types/PipelineJson/PipelineJson';
 import type { string_markdown_text } from '../../../types/typeAliases';
 import type { string_name } from '../../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
@@ -5,24 +7,25 @@ import type { CommandUsagePlace } from './CommandUsagePlaces';
 export type CommandParser<TCommand extends {
     type: string_name & string_SCREAMING_CASE;
 }> = {
-    name: string_name & string_SCREAMING_CASE;
-    aliasNames?: Array<string_name & string_SCREAMING_CASE>;
-    deprecatedNames?: Array<string_name & string_SCREAMING_CASE>;
-    usagePlaces: Array<CommandUsagePlace>;
-    description: string_markdown_text;
-    discussionUrl: `https://github.com/webgptorg/promptbook/discussions/${number | '@@'}`;
-    examples: Array<string_markdown_text>;
+    readonly name: string_name & string_SCREAMING_CASE;
+    readonly aliasNames?: Array<string_name & string_SCREAMING_CASE>;
+    readonly deprecatedNames?: Array<string_name & string_SCREAMING_CASE>;
+    readonly usagePlaces: Array<CommandUsagePlace>;
+    readonly description: string_markdown_text;
+    readonly discussionUrl: `https://github.com/webgptorg/promptbook/discussions/${number | '@@'}`;
+    readonly examples: Array<string_markdown_text>;
     /**
      * @throws {ParsingError} if the parsing fails
      */
     parse(input: CommandParserInput): TCommand;
+    applyToPipelineJson?(pipelineJson: WritableDeep<PipelineJson>, personaCommand: TCommand): void;
 };
 export type CommandParserInput = {
-    usagePlace: CommandUsagePlace;
-    raw: string_markdown_text;
-    rawArgs: string_markdown_text;
-    normalized: string_name & string_SCREAMING_CASE;
-    args: Array<string_name & string_SCREAMING_CASE>;
+    readonly usagePlace: CommandUsagePlace;
+    readonly raw: string_markdown_text;
+    readonly rawArgs: string_markdown_text;
+    readonly normalized: string_name & string_SCREAMING_CASE;
+    readonly args: Array<string_name & string_SCREAMING_CASE>;
 };
 /**
  * TODO: !!!! Annotate

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

@@ -6,6 +6,14 @@ export declare const LOOP_LIMIT = 1000;
  * The maximum number of iterations for a loops which adds characters one by one
  */
 export declare const CHARACTER_LOOP_LIMIT = 100000;
+/**
+ * The maximum number of (LLM) tasks running in parallel
+ */
+export declare const MAX_PARALLEL_COUNT = 5;
+/**
+ * The maximum length of the (generated) filename
+ */
+export declare const MAX_FILENAME_LENGTH = 30;
 /**
  * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
  */

package/umd/typings/src/conversion/pipelineStringToJson.d.ts

@@ -2,20 +2,23 @@ import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
 import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 import type { PipelineString } from '../types/PipelineString';
 /**
- * Options for pipelineStringToJson
+ * Options for `pipelineStringToJson`
  */
 export type PipelineStringToJsonOptions = {
     /**
-     * Tools for processing required for knowledge processing *(not for actual execution)*
+     * Tools for processing required for preparation of knowledge *(not for actual execution)*
+     *
+     * Note: If you provide `null`, the knowledge will not be prepared
      */
-    llmTools?: LlmExecutionTools;
+    readonly llmTools: LlmExecutionTools | null;
 };
 /**
- * Compile promptbook from string (markdown) format to JSON format
+ * Compile pipeline from string (markdown) format to JSON format
  *
- * Note: There are two similar functions:
+ * Note: There are 3 similar functions:
  * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
  * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `preparePipeline` - just one step in the compilation process
  *
  * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
  * @param options - Options and tools for the compilation
@@ -28,4 +31,5 @@ export type PipelineStringToJsonOptions = {
 export declare function pipelineStringToJson(pipelineString: PipelineString, options?: PipelineStringToJsonOptions): Promise<PipelineJson>;
 /**
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

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

@@ -1,14 +1,14 @@
 import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 import type { PipelineString } from '../types/PipelineString';
 /**
- * Compile promptbook from string (markdown) format to JSON format synchronously
+ * Compile pipeline from string (markdown) format to JSON format synchronously
  *
- * Note: There are two similar functions:
+ * Note: There are 3 similar functions:
  * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
  * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `preparePipeline` - just one step in the compilation process
  *
  * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
- * @param options - Options and tools for the compilation
  * @returns {Promptbook} compiled in JSON format (.ptbk.json)
  * @throws {ParsingError} if the promptbook string is not valid
  *
@@ -22,4 +22,6 @@ export declare function pipelineStringToJsonSync(pipelineString: PipelineString)
  * TODO: Use spaceTrim more effectively
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
  * TODO: [🥞] Not optimal parsing because `splitMarkdownIntoSections` is executed twice with same string, once through `flattenMarkdown` and second directly here
+ * TODO: [♈] Probbably move expectations from templates to parameters
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/umd/typings/src/conversion/prettify/PrettifyOptions.d.ts

@@ -5,9 +5,9 @@ export type PrettifyOptions = {
     /***
      * If true, adds Mermaid graph to the Promptbook string
      */
-    isGraphAdded?: boolean;
+    readonly isGraphAdded?: boolean;
     /**
      * If true, the string is prettifyed as markdown
      */
-    isPrettifyed?: boolean;
+    readonly isPrettifyed?: boolean;
 };

package/umd/typings/src/conversion/utils/renameParameter.d.ts

@@ -5,15 +5,15 @@ type RenameParameterOptions = {
      * Pipeline to search and replace for parameters
      * This pipeline is returned as copy with replaced parameters
      */
-    pipeline: PipelineJson;
+    readonly pipeline: PipelineJson;
     /**
      * Original parameter name that should be replaced
      */
-    oldParameterName: string_name;
+    readonly oldParameterName: string_name;
     /**
      * New parameter name that should replace the original parameter name
      */
-    newParameterName: string_name;
+    readonly newParameterName: string_name;
 };
 /**
  * Function renameParameter will find all usable parameters for given prompt template

package/umd/typings/src/conversion/validation/_importPipeline.d.ts

@@ -9,5 +9,5 @@ import type { PipelineString } from '../../types/PipelineString';
  * @param path - The path to the file relative to samples/templates directory
  * @private
  */
-export declare function importPipeline(path: `${string}.ptbk.md`): PipelineString;
-export declare function importPipeline(path: `${string}.ptbk.json`): PipelineJson;
+export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.md`): PipelineString;
+export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.json`): PipelineJson;

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

@@ -25,3 +25,7 @@ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
  *     >  * -   ...
  *     >  ex port function validatePipeline(promptbook: unknown): asserts promptbook is PipelineJson {
  */
+/**
+ * TODO: [🧠] !!!!! Validate new things
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ */ 

package/umd/typings/src/errors/EnvironmentMismatchError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This error type indicates that you try to use a feature that is not available in the current environment
+ */
+export declare class EnvironmentMismatchError extends Error {
+    readonly name = "EnvironmentMismatchError";
+    constructor(message: string);
+}

package/umd/typings/src/errors/VersionMismatchError.d.ts

@@ -0,0 +1,8 @@
+import type { string_semantic_version } from '../types/typeAliases';
+/**
+ * This error type indicates that the version of the pipeline is not matching the expected version
+ */
+export declare class VersionMismatchError extends Error {
+    readonly name = "UnexpectedError";
+    constructor(message: string, expectedVersion: string_semantic_version);
+}

package/umd/typings/src/execution/LlmExecutionTools.d.ts

@@ -63,8 +63,10 @@ export type AvailableModel = {
     readonly modelVariant: ModelVariant;
 };
 /**
- * TODO: !!!! Translation model
+ * TODO: [🏳] Add `callTranslationModel`
+ * TODO: Maybe reorder `listModels` and put it befor `callChatModel`, `callCompletionModel`, `callEmbeddingModel`
  * TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat
  * TODO: [🍓][♐] Some heuristic to pick the best model in listed models
  * TODO: [🧠] Should or should not there be a word "GPT" in both callCompletionModel and callChatModel
+ * TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
  */

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

@@ -1,7 +1,8 @@
 import type { Promisable } from 'type-fest';
 import type { TaskProgress } from '../types/TaskProgress';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
-import type { string_name } from '../types/typeAliases';
+import type { string_parameter_name } from '../types/typeAliases';
+import type { string_parameter_value } from '../types/typeAliases';
 import type { PromptResultUsage } from './PromptResult';
 /**
  * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
@@ -12,29 +13,29 @@ import type { PromptResultUsage } from './PromptResult';
  * @see https://github.com/webgptorg/promptbook#executor
  */
 export type PipelineExecutor = {
-    (inputParameters: Record<string_name, string>, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
+    (inputParameters: Record<string_parameter_name, string_parameter_value>, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
         /**
          * Whether the execution was successful, details are aviable in `executionReport`
          */
-        isSuccessful: boolean;
+        readonly isSuccessful: boolean;
         /**
          * Added usage of whole execution, detailed usage is aviable in `executionReport`
          */
-        usage: PromptResultUsage;
+        readonly usage: PromptResultUsage;
         /**
          * Errors that occured during the execution, details are aviable in `executionReport`
          */
-        errors: Array<Error>;
+        readonly errors: Array<Error>;
         /**
          * The report of the execution with all details
          */
-        executionReport: ExecutionReportJson;
+        readonly executionReport: ExecutionReportJson;
         /**
          * Result parameters of the execution
          *
          * Note: If the execution was not successful, there are only some of the result parameters
          */
-        outputParameters: Record<string_name, string>;
+        readonly outputParameters: Record<string_parameter_name, string_parameter_value>;
     }>;
 };
 /**

package/umd/typings/src/execution/PromptResult.d.ts

@@ -15,15 +15,21 @@ export type PromptResult = PromptCompletionResult | PromptChatResult | PromptEmb
 /**
  * Prompt completion result
  * It contains only the following text NOT the whole completion
+ *
+ * Note: This is fully serializable as JSON
  */
 export type PromptCompletionResult = PromptCommonResult;
 /**
  * Prompt chat result
+ *
+ * Note: This is fully serializable as JSON
  */
 export type PromptChatResult = PromptCommonResult & {};
 /**
  * Prompt embedding result
  * It contains only the following text NOT the whole completion
+ *
+ * Note: This is fully serializable as JSON
  */
 export type PromptEmbeddingResult = Omit<PromptCommonResult, 'content'> & {
     /**
@@ -31,6 +37,11 @@ export type PromptEmbeddingResult = Omit<PromptCommonResult, 'content'> & {
      */
     content: EmbeddingVector;
 };
+/**
+ * Common properties for all prompt results
+ *
+ * Note: This is fully serializable as JSON
+ */
 export type PromptCommonResult = {
     /**
      * Exact text response from the model
@@ -47,15 +58,15 @@ export type PromptCommonResult = {
         /**
          * Start of the execution
          */
-        start: string_date_iso8601;
+        readonly start: string_date_iso8601;
         /**
          * First token generated
          */
-        firstToken?: string_date_iso8601;
+        readonly firstToken?: string_date_iso8601;
         /**
          * End of the execution
          */
-        complete: string_date_iso8601;
+        readonly complete: string_date_iso8601;
     };
     /**
      * Usage of the prompt execution
@@ -99,11 +110,11 @@ export type UncertainNumber = {
     /**
      * The numeric value
      */
-    value: number_usd & (number_positive | 0);
+    readonly value: number_usd & (number_positive | 0);
     /**
      * Is the value uncertain
      */
-    isUncertain?: true;
+    readonly isUncertain?: true;
 };
 /**
  * TODO: [🧠] Maybe timing more accurate then seconds?
@@ -111,4 +122,5 @@ export type UncertainNumber = {
  * TODO: [🧠] Maybe type raw properly - not onject but OpenAI.result.whatever
  * TODO: [🧠] Maybe remove redundant raw.choices.text
  * TODO: Log raw even if prompt failed - log the raw error
+ * TODO: [🏳] Add `PromptTranslationResult`
  */

package/umd/typings/src/execution/ScriptExecutionTools.d.ts

@@ -1,5 +1,6 @@
 import type { ScriptLanguage } from '../types/ScriptLanguage';
-import type { string_name } from '../types/typeAliases';
+import type { string_parameter_name } from '../types/typeAliases';
+import type { string_parameter_value } from '../types/typeAliases';
 import type { string_script } from '../types/typeAliases';
 /**
  * Represents all the tools needed to EXECUTE SCRIPTs
@@ -16,13 +17,13 @@ export type ScriptExecutionToolsExecuteOptions = {
     /**
      * Language of the script
      */
-    scriptLanguage: ScriptLanguage;
+    readonly scriptLanguage: ScriptLanguage;
     /**
      * Parameters for the script
      * Theese parameters are passed to the script as variables
      * For example: { "name": "John" } => const name = "John";
      */
-    parameters: Record<string_name, string>;
+    readonly parameters: Record<string_parameter_name, string_parameter_value>;
     /**
      * The content of the script to execute
      * - It can be a single statement
@@ -31,8 +32,9 @@ export type ScriptExecutionToolsExecuteOptions = {
      * - It can be IIFE (immediately invoked function expression)
      * - It can use the parameters as variables and functions from global scope
      */
-    script: string_script;
+    readonly script: string_script;
 };
 /**
  * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ * TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
  */

package/umd/typings/src/execution/UserInterfaceTools.d.ts

@@ -21,26 +21,26 @@ export type UserInterfaceToolsPromptDialogOptions = {
      * Note: This is not a prompt to language model but a prompt to the user
      * @example "Your name"
      */
-    promptTitle: string;
+    readonly promptTitle: string;
     /**
      * Prompt message
      *
      * Note: This is not a prompt to language model but a prompt to the user
      * @example "Please enter your name, including your last name, title, etc."
      */
-    promptMessage: string;
+    readonly promptMessage: string;
     /**
      * Default value for the input/textarea
      */
-    defaultValue: string | null;
+    readonly defaultValue: string | null;
     /**
      * Placeholder for the input/textarea
      */
-    placeholder?: string;
+    readonly placeholder?: string;
     /**
      * Priority of the prompt
      *
      * Note: This would be reflected for example into the UI z-index of the prompt modal
      */
-    priority: number_integer & number_positive;
+    readonly priority: number_integer & number_positive;
 };

package/umd/typings/src/execution/createPipelineExecutor.d.ts

@@ -10,7 +10,7 @@ type CreatePipelineExecutorSettings = {
     readonly maxExecutionAttempts: number;
 };
 /**
- * Options for creating a pipeline executor
+ * Options for `createPipelineExecutor`
  */
 interface CreatePipelineExecutorOptions {
     /**
@@ -35,8 +35,11 @@ interface CreatePipelineExecutorOptions {
 export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
 export {};
 /**
+ * TODO: [🪂] Pass maxParallelCount here
+ * TODO: [♈] Probbably move expectations from templates to parameters
  * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
  * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
  * Note: CreatePipelineExecutorOptions are just connected to PipelineExecutor so do not extract to types folder
  * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

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

@@ -1,4 +1,4 @@
 export type TranslatorOptions = {
-    from?: string;
-    to: string;
+    readonly from?: string;
+    readonly to: string;
 };

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

@@ -5,7 +5,7 @@ type ForEachAsyncOptions = {
      *
      * @default Infinity
      */
-    inParallelCount?: number;
+    readonly maxParallelCount?: number;
 };
 /**
  * Async version of Array.forEach

package/umd/typings/src/formats/csv/ListFormatDefinition.d.ts

@@ -8,4 +8,4 @@ export declare const CsvFormatDefinition: FormatDefinition<string, string, objec
  * TODO: [🍓] In `CsvFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `CsvFormatDefinition` implement `heal
  * TODO: [🍓] In `CsvFormatDefinition` implement `extractValues`
- */ 
+ */

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

@@ -12,4 +12,4 @@ export declare const JsonFormatDefinition: FormatDefinition<string, string, obje
  * TODO: [🍓] In `JsonFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `JsonFormatDefinition` implement `heal
  * TODO: [🍓] In `JsonFormatDefinition` implement `extractValues`
- */ 
+ */

package/umd/typings/src/formats/list/ListFormatDefinition.d.ts

@@ -10,4 +10,4 @@ export declare const ListFormatDefinition: FormatDefinition<string, string, obje
  * TODO: [🍓] In `ListFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `ListFormatDefinition` implement `heal
  * TODO: [🍓] In `ListFormatDefinition` implement `extractValues`
- */ 
+ */

package/umd/typings/src/knowledge/dialogs/callback/CallbackInterfaceToolsOptions.d.ts

@@ -2,7 +2,7 @@ import type { Promisable } from 'type-fest';
 import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
 import type { UserInterfaceToolsPromptDialogOptions } from '../../../execution/UserInterfaceTools';
 /**
- * Options for CallbackInterfaceTools
+ * Options for `CallbackInterfaceTools`
  */
 export type CallbackInterfaceToolsOptions = CommonExecutionToolsOptions & {
     /**