@promptbook/types 0.60.0 → 0.61.0-0

package/README.md

@@ -341,6 +341,7 @@ Or you can install them separately:
 -   **[@promptbook/core](https://www.npmjs.com/package/@promptbook/core)** - Core of the library, it contains the main logic for promptbooks
 -   **[@promptbook/node](https://www.npmjs.com/package/@promptbook/node)** - Core of the library for Node.js
 -   ⭐ **[@promptbook/utils](https://www.npmjs.com/package/@promptbook/utils)** - Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
+-   **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown
 -   _(Not finished)_ **[@promptbook/wizzard](https://www.npmjs.com/package/@promptbook/wizzard)** - Wizard for creating+running promptbooks in single line
 -   **[@promptbook/execute-javascript](https://www.npmjs.com/package/@promptbook/execute-javascript)** - Execution tools for javascript inside promptbooks
 -   **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
@@ -414,7 +415,7 @@ For example:
 }
 ```
 
-### Execution type
+### Block type
 
 Each block of promptbook can have a different execution type.
 It is specified in list of requirements for the block.
@@ -503,9 +504,8 @@ Internally it calls OpenAI, Azure, GPU, proxy, cache, logging,...
 -   _(Not implemented yet)_ `BardExecutionTools`
 -   _(Not implemented yet)_ `LamaExecutionTools`
 -   _(Not implemented yet)_ `GpuExecutionTools`
--   And a special case are `MultipleLlmExecutionTools` that combines multiple execution tools together and tries to execute the prompt on the best one.
--   Another special case are `RemoteLlmExecutionTools` that connect to a remote server and run one of the above execution tools on that server.
--   The another special case is `MockedEchoLlmExecutionTools` that is used for testing and mocking.
+-   Special case are `RemoteLlmExecutionTools` that connect to a remote server and run one of the above execution tools on that server.
+-   Another special case is `MockedEchoLlmExecutionTools` that is used for testing and mocking.
 -   The another special case is `LogLlmExecutionToolsWrapper` that is technically also an execution tools but it is more proxy wrapper around other execution tools that logs all calls to execution tools.
 
 #### Script Execution Tools
@@ -593,8 +593,6 @@ There are two types of expectations which are not strictly symmetrical:
 
 Look at [expectations.ptbk.md](samples/templates/45-expectations.ptbk.md) and [expect-json.ptbk.md](samples/templates/45-expect-json.ptbk.md) samples for more.
 
-
-
 ### Execution report
 
 Execution report is a simple object or markdown that contains information about the execution of the pipeline.

package/esm/index.es.js

@@ -4,14 +4,13 @@
 var EXPECTATION_UNITS = ['CHARACTERS', 'WORDS', 'SENTENCES', 'LINES', 'PARAGRAPHS', 'PAGES'];
 /**
  * TODO: [💝] Unite object for expecting amount and format - remove expectFormat
- * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
- * TODO: [👙][🧠] Just selecting gpt3 or gpt4 level of model
  */
 
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.60.0-8';
+var PROMPTBOOK_VERSION = '0.60.0';
+// TODO: !!!! List here all the versions and annotate + put into script
 
 export { EXPECTATION_UNITS, PROMPTBOOK_VERSION };
 //# sourceMappingURL=index.es.js.map

package/esm/index.es.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.es.js","sources":["../../../../src/types/PipelineJson/PromptTemplateJson.ts","../../../../src/version.ts"],"sourcesContent":[null,null],"names":[],"mappings":"AA2CA;;;IAGa,iBAAiB,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAW;AAmH/G;;;;;;AC/JA;;;IAGa,kBAAkB,GAAmB;;;;"}
+{"version":3,"file":"index.es.js","sources":["../../../../src/types/PipelineJson/Expectations.ts","../../../../src/version.ts"],"sourcesContent":[null,null],"names":[],"mappings":"AAcA;;;IAGa,iBAAiB,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAW;AAY/G;;;;AC3BA;;;IAGa,kBAAkB,GAA8B,SAAS;AAGtE;;;;"}

package/esm/typings/promptbook-collection/index.d.ts

@@ -1,4 +1,4 @@
-declare const _default: {
+declare const _default: ({
     title: string;
     pipelineUrl: string;
     promptbookVersion: string;
@@ -12,7 +12,7 @@ declare const _default: {
         name: string;
         title: string;
         dependentParameterNames: string[];
-        executionType: string;
+        blockType: string;
         modelRequirements: {
             modelVariant: string;
             modelName: string;
@@ -20,6 +20,63 @@ declare const _default: {
         content: string;
         resultingParameterName: string;
     }[];
-    knowledge: never[];
-}[];
+    knowledge: {
+        name: string;
+        title: string;
+        content: string;
+        keywords: string[];
+        index: {
+            modelName: string;
+            position: number[];
+        }[];
+        sources: {
+            title: string;
+            href: string;
+        }[];
+    }[];
+    sourceFile: string;
+} | {
+    title: string;
+    pipelineUrl: string;
+    promptbookVersion: string;
+    parameters: {
+        name: string;
+        description: string;
+        isInput: boolean;
+        isOutput: boolean;
+    }[];
+    promptTemplates: {
+        name: string;
+        title: string;
+        dependentParameterNames: string[];
+        blockType: string;
+        expectations: {
+            words: {
+                min: number;
+                max: number;
+            };
+        };
+        modelRequirements: {
+            modelVariant: string;
+            modelName: string;
+        };
+        content: string;
+        resultingParameterName: string;
+    }[];
+    knowledge: {
+        name: string;
+        title: string;
+        content: string;
+        keywords: string[];
+        index: {
+            modelName: string;
+            position: number[];
+        }[];
+        sources: {
+            title: string;
+            href: string;
+        }[];
+    }[];
+    sourceFile: string;
+})[];
 export default _default;

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

@@ -3,18 +3,19 @@ import { createCollectionFromJson } from '../collection/constructors/createColle
 import { createCollectionFromPromise } from '../collection/constructors/createCollectionFromPromise';
 import { createCollectionFromUrl } from '../collection/constructors/createCollectionFromUrl';
 import { createSubcollection } from '../collection/constructors/createSubcollection';
+import { BlockTypes } from '../commands/BLOCK/BlockTypes';
+import { RESERVED_PARAMETER_NAMES } from '../config';
 import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
 import { pipelineStringToJson } from '../conversion/pipelineStringToJson';
 import { pipelineStringToJsonSync } from '../conversion/pipelineStringToJsonSync';
 import { prettifyPipelineString } from '../conversion/prettify/prettifyPipelineString';
 import { validatePipeline } from '../conversion/validation/validatePipeline';
 import { CollectionError } from '../errors/CollectionError';
-import { ExecutionError } from '../errors/ExecutionError';
 import { NotFoundError } from '../errors/NotFoundError';
+import { ParsingError } from '../errors/ParsingError';
+import { PipelineExecutionError } from '../errors/PipelineExecutionError';
 import { PipelineLogicError } from '../errors/PipelineLogicError';
 import { ReferenceError } from '../errors/ReferenceError';
-import { SyntaxError } from '../errors/SyntaxError';
-import { TemplateError } from '../errors/TemplateError';
 import { UnexpectedError } from '../errors/UnexpectedError';
 import { ExpectError } from '../errors/_ExpectError';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
@@ -27,18 +28,17 @@ import { CallbackInterfaceTools } from '../knowledge/dialogs/callback/CallbackIn
 import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools';
 import { prepareKnowledgeFromMarkdown } from '../knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown';
-import { MultipleLlmExecutionTools } from '../llm-providers/multiple/MultipleLlmExecutionTools';
-import { ExecutionTypes } from '../types/ExecutionTypes';
+import { joinLlmExecutionTools } from '../llm-providers/multiple/joinLlmExecutionTools';
 import type { ExecutionReportStringOptions } from '../types/execution-report/ExecutionReportStringOptions';
 import { ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
-export { ExecutionTypes };
+export { BlockTypes, RESERVED_PARAMETER_NAMES };
 export { addUsage, assertsExecutionSuccessful, checkExpectations, embeddingVectorToString, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPipelineString, usageToWorktime, };
 export { collectionToJson, createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createSubcollection, };
 export { SimplePromptInterfaceTools };
 export { pipelineJsonToString, pipelineStringToJson, pipelineStringToJsonSync, validatePipeline };
-export { createPipelineExecutor, MultipleLlmExecutionTools };
+export { createPipelineExecutor, joinLlmExecutionTools };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };
-export { CollectionError, ExecutionError, ExpectError, NotFoundError, PipelineLogicError, ReferenceError, SyntaxError, TemplateError, UnexpectedError, };
+export { CollectionError, ExpectError, NotFoundError, ParsingError, PipelineExecutionError, PipelineLogicError, ReferenceError, UnexpectedError, };

package/esm/typings/src/_packages/markdown-utils.d.ts

@@ -0,0 +1,17 @@
+import type { string_markdown_section, string_markdown_section_content, string_markdown_text } from '../types/typeAliases';
+import { addAutoGeneratedSection } from '../utils/markdown/addAutoGeneratedSection';
+import { createMarkdownChart } from '../utils/markdown/createMarkdownChart';
+import { createMarkdownTable } from '../utils/markdown/createMarkdownTable';
+import { escapeMarkdownBlock } from '../utils/markdown/escapeMarkdownBlock';
+import { extractAllBlocksFromMarkdown } from '../utils/markdown/extractAllBlocksFromMarkdown';
+import { extractAllListItemsFromMarkdown } from '../utils/markdown/extractAllListItemsFromMarkdown';
+import { extractOneBlockFromMarkdown } from '../utils/markdown/extractOneBlockFromMarkdown';
+import { flattenMarkdown } from '../utils/markdown/flattenMarkdown';
+import type { MarkdownSection } from '../utils/markdown/parseMarkdownSection';
+import { parseMarkdownSection } from '../utils/markdown/parseMarkdownSection';
+import { removeContentComments } from '../utils/markdown/removeContentComments';
+import { removeMarkdownFormatting } from '../utils/markdown/removeMarkdownFormatting';
+import { splitMarkdownIntoSections } from '../utils/markdown/splitMarkdownIntoSections';
+import { string_markdown } from './types.index';
+export { addAutoGeneratedSection, createMarkdownChart, createMarkdownTable, escapeMarkdownBlock, extractAllBlocksFromMarkdown, extractAllListItemsFromMarkdown, extractOneBlockFromMarkdown, flattenMarkdown, parseMarkdownSection, removeContentComments, removeMarkdownFormatting, splitMarkdownIntoSections, };
+export type { MarkdownSection, string_markdown, string_markdown_section, string_markdown_section_content, string_markdown_text, };

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