@promptbook/openai 0.60.0 → 0.61.0-0

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

@@ -1,4 +1,5 @@
 import type { PipelineCollection } from '../collection/PipelineCollection';
+import type { BlockType } from '../commands/BLOCK/BlockTypes';
 import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
 import { EmbeddingVector } from '../execution/EmbeddingVector';
 import type { ExecutionTools } from '../execution/ExecutionTools';
@@ -7,27 +8,31 @@ import type { PipelineExecutor } from '../execution/PipelineExecutor';
 import type { PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptEmbeddingResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, UncertainNumber } from '../execution/PromptResult';
 import type { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
 import type { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
-import type { ExecutionType } from '../types/ExecutionTypes';
 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 type { LlmTemplateJson } from '../types/PipelineJson/LlmTemplateJson';
 import { MaterialKnowledgePieceJson } from '../types/PipelineJson/MaterialKnowledgePieceJson';
 import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import type { ExpectationAmount, ExpectationUnit, Expectations, LlmTemplateJson, PromptDialogJson, PromptTemplateJson, ScriptJson, SimpleTemplateJson } from '../types/PipelineJson/PromptTemplateJson';
-import { EXPECTATION_UNITS } from '../types/PipelineJson/PromptTemplateJson';
+import type { PromptDialogJson } from '../types/PipelineJson/PromptDialogJson';
+import type { PromptTemplateJson } from '../types/PipelineJson/PromptTemplateJson';
 import type { PromptTemplateParameterJson } from '../types/PipelineJson/PromptTemplateParameterJson';
+import type { ScriptJson } from '../types/PipelineJson/ScriptJson';
+import type { SimpleTemplateJson } from '../types/PipelineJson/SimpleTemplateJson';
 import type { PipelineString } from '../types/PipelineString';
 import type { Prompt } from '../types/Prompt';
 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_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_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_version } from '../types/typeAliases';
+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 { FromtoItems } from '../utils/FromtoItems';
-import { PROMPTBOOK_VERSION } from '../version';
+import { PROMPTBOOK_VERSION, string_promptbook_version } from '../version';
 export { PROMPTBOOK_VERSION };
 export { EXPECTATION_UNITS };
-export type { AvailableModel, CommonExecutionToolsOptions, EmbeddingVector, ExecutionReportJson, ExecutionTools, ExecutionType, 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_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_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_version, };
+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, };
 /**
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here
  */

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

@@ -2,7 +2,6 @@ import { spaceTrim } from 'spacetrim';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMermaidOptions';
 import { extractParametersFromPromptTemplate } from '../conversion/utils/extractParametersFromPromptTemplate';
 import { extractVariables } from '../conversion/utils/extractVariables';
-import { parseNumber } from '../conversion/utils/parseNumber';
 import { renameParameter } from '../conversion/utils/renameParameter';
 import { titleToName } from '../conversion/utils/titleToName';
 import { forEachAsync } from '../execution/utils/forEachAsync';
@@ -16,11 +15,6 @@ import { countSentences, splitIntoSentences } from '../utils/expectation-counter
 import { countWords } from '../utils/expectation-counters/countWords';
 import { CountUtils } from '../utils/expectation-counters/index';
 import { extractParameters } from '../utils/extractParameters';
-import { extractAllBlocksFromMarkdown } from '../utils/markdown/extractAllBlocksFromMarkdown';
-import { extractAllListItemsFromMarkdown } from '../utils/markdown/extractAllListItemsFromMarkdown';
-import { extractOneBlockFromMarkdown } from '../utils/markdown/extractOneBlockFromMarkdown';
-import { removeContentComments } from '../utils/markdown/removeContentComments';
-import { removeMarkdownFormatting } from '../utils/markdown/removeMarkdownFormatting';
 import { DIACRITIC_VARIANTS_LETTERS } from '../utils/normalization/DIACRITIC_VARIANTS_LETTERS';
 import type { IKeywords, string_keyword } from '../utils/normalization/IKeywords';
 import { capitalize } from '../utils/normalization/capitalize';
@@ -28,16 +22,17 @@ import { decapitalize } from '../utils/normalization/decapitalize';
 import { isValidKeyword } from '../utils/normalization/isValidKeyword';
 import { nameToUriPart } from '../utils/normalization/nameToUriPart';
 import { nameToUriParts } from '../utils/normalization/nameToUriParts';
-import { normalizeToKebabCase } from '../utils/normalization/normalize-to-kebab-case';
-import { normalizeTo_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
-import { normalizeTo_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
-import { normalizeTo_camelCase } from '../utils/normalization/normalizeTo_camelCase';
-import { normalizeTo_snake_case } from '../utils/normalization/normalizeTo_snake_case';
+import { normalizeToKebabCase, string_kebab_case } from '../utils/normalization/normalize-to-kebab-case';
+import { normalizeTo_PascalCase, string_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
+import { normalizeTo_SCREAMING_CASE, string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
+import { normalizeTo_camelCase, string_camelCase } from '../utils/normalization/normalizeTo_camelCase';
+import { normalizeTo_snake_case, string_snake_case } from '../utils/normalization/normalizeTo_snake_case';
 import { normalizeWhitespaces } from '../utils/normalization/normalizeWhitespaces';
 import { parseKeywords } from '../utils/normalization/parseKeywords';
 import { parseKeywordsFromString } from '../utils/normalization/parseKeywordsFromString';
 import { removeDiacritics } from '../utils/normalization/removeDiacritics';
 import { searchKeywords } from '../utils/normalization/searchKeywords';
+import { parseNumber } from '../utils/parseNumber';
 import { extractBlock } from '../utils/postprocessing/extractBlock';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';
@@ -47,13 +42,21 @@ import { union } from '../utils/sets/union';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
+import { isValidFilePath } from '../utils/validators/filePath/isValidFilePath';
+import { isValidJavascriptName } from '../utils/validators/javascriptName/isValidJavascriptName';
+import { isValidPromptbookVersion } from '../utils/validators/semanticVersion/isValidPromptbookVersion';
+import { isValidSemanticVersion } from '../utils/validators/semanticVersion/isValidSemanticVersion';
+import { isHostnameOnPrivateNetwork } from '../utils/validators/url/isHostnameOnPrivateNetwork';
+import { isUrlOnPrivateNetwork } from '../utils/validators/url/isUrlOnPrivateNetwork';
+import { isValidPipelineUrl } from '../utils/validators/url/isValidPipelineUrl';
+import { isValidUrl } from '../utils/validators/url/isValidUrl';
+import { isValidUuid } from '../utils/validators/uuid/isValidUuid';
 import { PROMPTBOOK_VERSION } from '../version';
-export { PROMPTBOOK_VERSION, forEachAsync };
-export { extractAllBlocksFromMarkdown, // <- [🌻]
-extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
-extractOneBlockFromMarkdown, extractParameters, extractVariables, isValidJsonString, parseNumber, // <- [🌻]
-removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
-export { CountUtils, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords };
+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, // <- [🌻]
+removeEmojis, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
 export { splitIntoSentences };
 export declare const normalizeTo: {
     camelCase: typeof normalizeTo_camelCase;
@@ -62,10 +65,11 @@ export declare const normalizeTo: {
     snake_case: typeof normalizeTo_snake_case;
     'kebab-case': typeof normalizeToKebabCase;
 };
-export { DIACRITIC_VARIANTS_LETTERS, IKeywords, capitalize, decapitalize, isValidKeyword, nameToUriPart, nameToUriParts, normalizeToKebabCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_camelCase, normalizeTo_snake_case, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, removeDiacritics, searchKeywords, string_keyword, titleToName, };
+export { capitalize, decapitalize, DIACRITIC_VARIANTS_LETTERS, IKeywords, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo_camelCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_snake_case, normalizeToKebabCase, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, removeDiacritics, searchKeywords, string_keyword, titleToName, };
+export type { string_camelCase, string_kebab_case, string_PascalCase, string_SCREAMING_CASE, string_snake_case };
 export { extractParametersFromPromptTemplate, renameParameter, renderPromptbookMermaid };
 export { difference, intersection, union };
 /**
- * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
+ * TODO: [🧠] Maybe create some indipendent package like `@promptbook/markdown-utils`
  * Note: [🕙] It does not make sence to have simple lower / UPPER case normalization
  */

package/esm/typings/src/cli/cli-commands/hello.d.ts

@@ -0,0 +1,7 @@
+import type { Command as Program } from 'commander';
+/**
+ * Initializes testing `hello` command for Promptbook CLI utilities
+ *
+ * @private part of `promptbookCli`
+ */
+export declare function initializeHelloCommand(program: Program): void;

package/esm/typings/src/cli/cli-commands/make.d.ts

@@ -0,0 +1,7 @@
+import type { Command as Program } from 'commander';
+/**
+ * Initializes `make` command for Promptbook CLI utilities
+ *
+ * @private part of `promptbookCli`
+ */
+export declare function initializeMakeCommand(program: Program): void;

package/esm/typings/src/cli/cli-commands/prettify.d.ts

@@ -0,0 +1,7 @@
+import type { Command as Program } from 'commander';
+/**
+ * Initializes `prettify` command for Promptbook CLI utilities
+ *
+ * @private part of `promptbookCli`
+ */
+export declare function initializePrettifyCommand(program: Program): void;

package/esm/typings/src/collection/collectionToJson.d.ts

@@ -6,3 +6,6 @@ import type { PipelineCollection } from './PipelineCollection';
  * Note: Functions `collectionToJson` and `createCollectionFromJson` are complementary
  */
 export declare function collectionToJson(collection: PipelineCollection): Promise<Array<PipelineJson>>;
+/**
+ * TODO: [🧠] Maybe clear `sourceFile` or clear when exposing through API or remote server
+ */

package/esm/typings/src/collection/collectionToJson.test.d.ts

@@ -1 +1,7 @@
 export {};
+/**
+ * Note: [🐠] For example here URL https://example.com/pipeline.ptbk.md is not valid
+ *       because it is on private network BUT its very hard to debug because
+ *       there is no error message and false return (the error) happen deep in:
+ *       `isValidPipelineUrl` -> `isValidPipelineUrl` -> `isUrlOnPrivateNetwork`
+ */

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

@@ -1,9 +1,10 @@
+import type { PipelineStringToJsonOptions } from '../../conversion/pipelineStringToJson';
 import type { string_folder_path } from '../../types/typeAliases';
 import type { PipelineCollection } from '../PipelineCollection';
 /**
  * Options for `createCollectionFromDirectory` function
  */
-type CreatePipelineCollectionFromDirectoryOptions = {
+type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions & {
     /**
      * If true, the directory is searched recursively for promptbooks
      *

package/esm/typings/src/commands/BLOCK/BlockCommand.d.ts

@@ -0,0 +1,11 @@
+import type { BlockType } from './BlockTypes';
+/**
+ * Parsed BLOCK command
+ *
+ * @see ./blockCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type BlockCommand = {
+    readonly type: 'BLOCK';
+    readonly blockType: BlockType;
+};

package/esm/typings/src/commands/BLOCK/BlockTypes.d.ts

@@ -0,0 +1,13 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Block type describes the way how the block is blockd
+ *
+ * @see https://github.com/webgptorg/promptbook#block-type
+ */
+export type BlockType = TupleToUnion<typeof BlockTypes>;
+/**
+ * Block type describes the way how the block is blockd
+ *
+ * @see https://github.com/webgptorg/promptbook#block-type
+ */
+export declare const BlockTypes: readonly ["PROMPT_TEMPLATE", "SIMPLE_TEMPLATE", "SCRIPT", "PROMPT_DIALOG", "SAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];

package/esm/typings/src/commands/BLOCK/blockCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { BlockCommand } from './BlockCommand';
+/**
+ * Parses the block command
+ *
+ * @see ./BLOCK-README.md for more details
+ * @private within the commands folder
+ */
+export declare const blockCommandParser: CommandParser<BlockCommand>;

package/esm/typings/src/commands/EXPECT/ExpectAmountCommand.d.ts

@@ -0,0 +1,14 @@
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+import type { ExpectationUnit } from '../../types/PipelineJson/Expectations';
+/**
+ * Expect amount command describes the desired output of the prompt template (after post-processing)
+ * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
+ *
+ * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
+ */
+export type ExpectAmountCommand = {
+    readonly type: 'EXPECT_AMOUNT';
+    readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
+    readonly unit: ExpectationUnit;
+    readonly amount: ExpectationAmount;
+};

package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts

@@ -0,0 +1,9 @@
+import type { ExpectAmountCommand } from "./ExpectAmountCommand";
+import type { ExpectFormatCommand } from "./ExpectFormatCommand";
+/**
+ * Parsed EXPECT command
+ *
+ * @see ./expectCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type ExpectCommand = ExpectAmountCommand | ExpectFormatCommand;

package/esm/typings/src/commands/EXPECT/ExpectFormatCommand.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Represents a command that expects a specific format.
+ */
+export type ExpectFormatCommand = {
+    readonly type: 'EXPECT_FORMAT';
+    readonly format: 'JSON';
+};

package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { ExpectCommand } from './ExpectCommand';
+/**
+ * Parses the expect command
+ *
+ * @see ./EXPECT-README.md for more details
+ * @private within the commands folder
+ */
+export declare const expectCommandParser: CommandParser<ExpectCommand>;

package/esm/typings/src/commands/JOKER/JokerCommand.d.ts

@@ -0,0 +1,11 @@
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Parsed JOKER command
+ *
+ * @see ./jokerCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type JokerCommand = {
+    readonly type: 'JOKER';
+    readonly parameterName: string_name;
+};

package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { JokerCommand } from './JokerCommand';
+/**
+ * Parses the joker command
+ *
+ * @see ./JOKER-README.md for more details
+ * @private within the commands folder
+ */
+export declare const jokerCommandParser: CommandParser<JokerCommand>;

package/esm/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts

@@ -0,0 +1,12 @@
+import type { string_file_relative_path } from '../../types/typeAliases';
+import type { string_url } from '../../types/typeAliases';
+/**
+ * Parsed KNOWLEDGE command
+ *
+ * @see ./knowledgeCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type KnowledgeCommand = {
+    readonly type: 'KNOWLEDGE';
+    readonly source: string_url | string_file_relative_path;
+};

package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { KnowledgeCommand } from './KnowledgeCommand';
+/**
+ * Parses the knowledge command
+ *
+ * @see ./KNOWLEDGE-README.md for more details
+ * @private within the commands folder
+ */
+export declare const knowledgeCommandParser: CommandParser<KnowledgeCommand>;

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

@@ -0,0 +1,13 @@
+import type { ModelRequirements } from '../../types/ModelRequirements';
+import type { TODO } from '../../types/typeAliases';
+/**
+ * Parsed MODEL command
+ *
+ * @see ./modelCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type ModelCommand = {
+    readonly type: 'MODEL';
+    readonly key: keyof ModelRequirements;
+    readonly value: TODO;
+};

package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { ModelCommand } from './ModelCommand';
+/**
+ * Parses the model command
+ *
+ * @see ./MODEL-README.md for more details
+ * @private within the commands folder
+ */
+export declare const modelCommandParser: CommandParser<ModelCommand>;

package/esm/typings/src/commands/PARAMETER/ParameterCommand.d.ts

@@ -0,0 +1,15 @@
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Parsed PARAMETER command
+ *
+ * @see ./parameterCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type ParameterCommand = {
+    readonly type: 'PARAMETER';
+    readonly isInput: boolean;
+    readonly isOutput: boolean;
+    readonly parameterName: string_name;
+    readonly parameterDescription: string_markdown_text | null;
+};

package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { ParameterCommand } from './ParameterCommand';
+/**
+ * Parses the parameter command
+ *
+ * @see ./PARAMETER-README.md for more details
+ * @private within the commands folder
+ */
+export declare const parameterCommandParser: CommandParser<ParameterCommand>;

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

@@ -0,0 +1,11 @@
+/**
+ * Parsed PERSONA command
+ *
+ * @see ./personaCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type PersonaCommand = {
+    readonly type: 'PERSONA';
+    personaName: string;
+    personaDescription: string | null;
+};

package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { PersonaCommand } from './PersonaCommand';
+/**
+ * Parses the persona command
+ *
+ * @see ./PERSONA-README.md for more details
+ * @private within the commands folder
+ */
+export declare const personaCommandParser: CommandParser<PersonaCommand>;

package/esm/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts

@@ -0,0 +1,11 @@
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Parsed POSTPROCESS command
+ *
+ * @see ./postprocessCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type PostprocessCommand = {
+    readonly type: 'POSTPROCESS';
+    readonly functionName: string_name;
+};

package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { PostprocessCommand } from './PostprocessCommand';
+/**
+ * Parses the postprocess command
+ *
+ * @see ./POSTPROCESS-README.md for more details
+ * @private within the commands folder
+ */
+export declare const postprocessCommandParser: CommandParser<PostprocessCommand>;

package/esm/typings/src/commands/PROMPTBOOK_VERSION/PromptbookVersionCommand.d.ts

@@ -0,0 +1,11 @@
+import type { string_semantic_version } from '../../types/typeAliases';
+/**
+ * Parsed PROMPTBOOK_VERSION command
+ *
+ * @see ./promptbookVersionCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type PromptbookVersionCommand = {
+    readonly type: 'PROMPTBOOK_VERSION';
+    readonly promptbookVersion: string_semantic_version;
+};

package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { PromptbookVersionCommand } from './PromptbookVersionCommand';
+/**
+ * Parses the PROMPTBOOK_VERSION command
+ *
+ * @see ./PROMPTBOOK_VERSION-README.md for more details
+ * @private within the commands folder
+ */
+export declare const promptbookVersionCommandParser: CommandParser<PromptbookVersionCommand>;

package/esm/typings/src/commands/URL/UrlCommand.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Parsed URL command
+ *
+ * @see ./urlCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type UrlCommand = {
+    readonly type: 'URL';
+    readonly pipelineUrl: URL;
+};

package/esm/typings/src/commands/URL/urlCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { UrlCommand } from './UrlCommand';
+/**
+ * Parses the url command
+ *
+ * @see ./URL-README.md for more details
+ * @private within the commands folder
+ */
+export declare const urlCommandParser: CommandParser<UrlCommand>;

package/esm/typings/src/commands/X_ACTION/ActionCommand.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Parsed ACTION command
+ *
+ * @see ./actionCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type ActionCommand = {
+    readonly type: 'ACTION';
+};

package/esm/typings/src/commands/X_ACTION/actionCommand.test.d.ts

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

package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { ActionCommand } from './ActionCommand';
+/**
+ * Parses the action command
+ *
+ * @see ./ACTION-README.md for more details
+ * @private within the commands folder
+ */
+export declare const actionCommandParser: CommandParser<ActionCommand>;

package/esm/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Parsed INSTRUMENT command
+ *
+ * @see ./instrumentCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type InstrumentCommand = {
+    readonly type: 'INSTRUMENT';
+};

package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts

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

package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { InstrumentCommand } from './InstrumentCommand';
+/**
+ * Parses the instrument command
+ *
+ * @see ./INSTRUMENT-README.md for more details
+ * @private within the commands folder
+ */
+export declare const instrumentCommandParser: CommandParser<InstrumentCommand>;

package/esm/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Parsed BOILERPLATE command
+ *
+ * @see ./boilerplateCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type BoilerplateCommand = {
+    readonly type: 'BOILERPLATE';
+    readonly value: string;
+};

package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts

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

package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts

@@ -0,0 +1,12 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { BoilerplateCommand } from './BoilerplateCommand';
+/**
+ * Parses the boilerplate command
+ *
+ * @see ./BOILERPLATE-README.md for more details
+ * @private within the commands folder
+ */
+export declare const boilerplateCommandParser: CommandParser<BoilerplateCommand>;
+/**
+ * TODO: [💐] Implement BOILERPLATE command into `pipelineStringToJsonSync` function
+ */

package/esm/typings/src/commands/_common/parseCommand.d.ts

@@ -0,0 +1,12 @@
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { Command } from './types/Command';
+import type { CommandUsagePlace } from './types/CommandUsagePlaces';
+/**
+ * Parses one line of ul/ol to command
+ *
+ * @returns parsed command object
+ * @throws {ParsingError} if the command is invalid
+ *
+ * @private within the pipelineStringToJson
+ */
+export declare function parseCommand(raw: string_markdown_text, usagePlace: CommandUsagePlace): Command;

package/esm/typings/src/commands/_common/parseCommand.test.d.ts

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

package/esm/typings/src/commands/_common/types/Command.d.ts

@@ -0,0 +1,6 @@
+import { COMMANDS } from '../../index';
+/**
+ * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
+ * It is parsed from the markdown from ul/ol items - one command per one item.
+ */
+export type Command = ReturnType<typeof COMMANDS[number]['parse']>;

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

@@ -0,0 +1,36 @@
+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';
+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>;
+    /**
+     * @throws {ParsingError} if the parsing fails
+     */
+    parse(input: CommandParserInput): TCommand;
+};
+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>;
+};
+/**
+ * TODO: !!!! Annotate
+ * TODO: [🧠] Maybe put flag if it is for whole `.ptbk.md` file of just one section
+ * TODO: [🍧] CommandParser should have applyToPipelineJson method
+ *       which will apply parsed command to the pipeline JSON
+ *       it will be called from `pipelineStringToJsonSync`
+ *       and replace hardcoded switch statement and [💐]
+ *       and throw ParsingError
+ *
+ */