@promptbook/types 0.59.0 → 0.60.0-3

package/esm/typings/src/utils/emojis.d.ts

@@ -5,7 +5,7 @@ import type { string_char_emoji } from '../types/typeAliasEmoji';
  *
  * @see https://getemoji.com/
  *
- * @private within the library
+ * @private within the package
  * @deprecated Use /\p{Extended_Pictographic}/ instead
  */
 export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
@@ -13,7 +13,7 @@ export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoj
  *
  * All possible emoji chars like "🍆", "🍡", "🍤"...
  *
- * @private within the library
+ * @private within the package
  * @deprecated Use /\p{Extended_Pictographic}/ instead
  */
 export declare const EMOJIS: Set<string_char_emoji>;

package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Counts number of characters in the text
  */

package/esm/typings/src/utils/expectation-counters/countLines.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Counts number of lines in the text
  */

package/esm/typings/src/utils/expectation-counters/countPages.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Counts number of pages in the text
  */

package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Counts number of paragraphs in the text
  */

package/esm/typings/src/utils/expectation-counters/countSentences.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Split text into sentences
  */

package/esm/typings/src/utils/expectation-counters/countWords.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Counts number of words in the text
  */

package/esm/typings/src/utils/expectation-counters/index.d.ts

@@ -1,5 +1,5 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
-import type { ExpectationUnit } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationUnit } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Index of all counter functions
  */

package/esm/typings/src/utils/formatNumber.d.ts

@@ -1,6 +1,6 @@
 /**
  * Format either small or big number
  *
- * @private within the library
+ * @private within the package
  */
 export declare function formatNumber(value: number): string;

package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts

@@ -3,7 +3,7 @@ import type { string_name } from '../../types/typeAliases';
 /**
  * Add or modify an auto-generated section in a markdown file
  *
- * @private within the library
+ * @private within the package
  */
 export declare function addAutoGeneratedSection(content: string_markdown, options: {
     sectionName: string_name;

package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts

@@ -31,7 +31,7 @@ type CreateMarkdownChartOptions = {
 /**
  * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
  *
- * @private within the library
+ * @private within the package
  */
 export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
 export {};

package/esm/typings/src/utils/markdown/createMarkdownTable.d.ts

@@ -3,6 +3,6 @@ import type { string_markdown_text } from '../../types/typeAliases';
 /**
  * Create a markdown table from a 2D array of strings
  *
- * @private within the library
+ * @private within the package
  */
 export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;

package/esm/typings/src/utils/markdown-json/MarkdownStructure.d.ts

@@ -1,7 +1,7 @@
 /**
  * Represents the structure of a markdown file.
  *
- * @private within the library
+ * @private within the package
  */
 export type MarkdownStructure = {
     /**

package/esm/typings/src/utils/markdown-json/countMarkdownStructureDeepness.d.ts

@@ -2,6 +2,6 @@ import type { MarkdownStructure } from './MarkdownStructure';
 /**
  * Computes the deepness of the markdown structure.
  *
- * @private within the library
+ * @private within the package
  */
 export declare function countMarkdownStructureDeepness(markdownStructure: MarkdownStructure): number;

package/esm/typings/src/utils/markdown-json/markdownToMarkdownStructure.d.ts

@@ -8,6 +8,6 @@ import type { MarkdownStructure } from './MarkdownStructure';
  * @param markdown The markdown string to parse.
  * @returns The MarkdownStructure object.
  *
- * @private within the library
+ * @private within the package
  */
 export declare function markdownToMarkdownStructure(markdown: string): MarkdownStructure;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@promptbook/types",
-    "version": "0.59.0",
-    "description": "Library to supercharge your use of large language models",
+    "version": "0.60.0-3",
+    "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
     "repository": {
@@ -45,7 +45,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.59.0"
+        "@promptbook/core": "0.60.0-3"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -17,7 +17,7 @@
 	/**
 	 * The version of the Promptbook library
 	 */
-	var PROMPTBOOK_VERSION = '0.59.0-36';
+	var PROMPTBOOK_VERSION = '0.60.0-2';
 
 	exports.EXPECTATION_UNITS = EXPECTATION_UNITS;
 	exports.PROMPTBOOK_VERSION = PROMPTBOOK_VERSION;

package/umd/index.umd.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.umd.js","sources":["../../../../src/types/PromptbookJson/PromptTemplateJson.ts","../../../../src/version.ts"],"sourcesContent":[null,null],"names":[],"mappings":";;;;;;CA2CA;;;KAGa,iBAAiB,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAW;CAmH/G;;;;;;CC/JA;;;KAGa,kBAAkB,GAAmB;;;;;;;;;;;"}
+{"version":3,"file":"index.umd.js","sources":["../../../../src/types/PipelineJson/PromptTemplateJson.ts","../../../../src/version.ts"],"sourcesContent":[null,null],"names":[],"mappings":";;;;;;CA2CA;;;KAGa,iBAAiB,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAW;CAmH/G;;;;;;CC/JA;;;KAGa,kBAAkB,GAAmB;;;;;;;;;;;"}

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

@@ -1,17 +1,17 @@
-import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
-import { promptbookJsonToString } from '../conversion/promptbookJsonToString';
-import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
-import { promptbookStringToJsonSync } from '../conversion/promptbookStringToJsonSync';
-import { validatePromptbook } from '../conversion/validation/validatePromptbook';
-import { ExpectError } from '../errors/_ExpectError';
-import { PromptbookExecutionError } from '../errors/PromptbookExecutionError';
-import { PromptbookLibraryError } from '../errors/PromptbookLibraryError';
-import { PromptbookLogicError } from '../errors/PromptbookLogicError';
-import { PromptbookNotFoundError } from '../errors/PromptbookNotFoundError';
-import { PromptbookReferenceError } from '../errors/PromptbookReferenceError';
-import { PromptbookSyntaxError } from '../errors/PromptbookSyntaxError';
+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 { 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';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
 import { embeddingVectorToString } from '../execution/embeddingVectorToString';
@@ -22,23 +22,23 @@ 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 { createLibraryFromJson } from '../library/constructors/createLibraryFromJson';
-import { createLibraryFromPromise } from '../library/constructors/createLibraryFromPromise';
-import { createLibraryFromUrl } from '../library/constructors/createLibraryFromUrl';
-import { createSublibrary } from '../library/constructors/createSublibrary';
+import { createCollectionFromJson } from '../library/constructors/createCollectionFromJson';
+import { createCollectionFromPromise } from '../library/constructors/createCollectionFromPromise';
+import { createCollectionFromUrl } from '../library/constructors/createCollectionFromUrl';
+import { createSubcollection } from '../library/constructors/createSubcollection';
 import { libraryToJson } from '../library/libraryToJson';
 import { MultipleLlmExecutionTools } from '../llm-providers/multiple/MultipleLlmExecutionTools';
-import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
+import { ExecutionTypes } from '../types/ExecutionTypes';
 import type { ExecutionReportStringOptions } from '../types/execution-report/ExecutionReportStringOptions';
 import { ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
-import { ExecutionTypes } from '../types/ExecutionTypes';
+import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 export { ExecutionTypes };
-export { addUsage, assertsExecutionSuccessful, checkExpectations, embeddingVectorToString, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPromptbookString, usageToWorktime, };
-export { createLibraryFromJson, createLibraryFromPromise, createLibraryFromUrl, createSublibrary, libraryToJson };
+export { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, addUsage, assertsExecutionSuccessful, checkExpectations, embeddingVectorToString, executionReportJsonToString, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPipelineString, usageToWorktime, };
+export { createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createSubcollection as createSublibrary, libraryToJson, };
 export { SimplePromptInterfaceTools };
-export { promptbookJsonToString, promptbookStringToJson, promptbookStringToJsonSync, validatePromptbook };
-export { createPromptbookExecutor, MultipleLlmExecutionTools };
+export { pipelineJsonToString, pipelineStringToJson, pipelineStringToJsonSync, validatePipeline };
+export { MultipleLlmExecutionTools, createPromptbookExecutor };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };
-export { ExpectError, PromptbookExecutionError, PromptbookLibraryError, PromptbookLogicError, PromptbookNotFoundError, PromptbookReferenceError, PromptbookSyntaxError, TemplateError, UnexpectedError, };
+export { CollectionError, ExecutionError, ExpectError, NotFoundError, PipelineLogicError, ReferenceError, SyntaxError, TemplateError, UnexpectedError, };

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

@@ -1,4 +1,4 @@
-import { createLibraryFromDirectory } from '../library/constructors/createLibraryFromDirectory';
+import { createCollectionFromDirectory } from '../library/constructors/createCollectionFromDirectory';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
-export { createLibraryFromDirectory };
+export { createCollectionFromDirectory };

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

@@ -2,32 +2,32 @@ import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionTo
 import { EmbeddingVector } from '../execution/EmbeddingVector';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { AvailableModel, LlmExecutionTools } from '../execution/LlmExecutionTools';
-import type { PromptEmbeddingResult, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, UncertainNumber } from '../execution/PromptResult';
+import type { PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptEmbeddingResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, UncertainNumber } from '../execution/PromptResult';
 import type { PromptbookExecutor } from '../execution/PromptbookExecutor';
 import type { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
 import type { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
-import type { PromptbookLibrary } from '../library/PromptbookLibrary';
+import type { PipelineCollection } from '../library/PipelineCollection';
 import type { ExecutionType } from '../types/ExecutionTypes';
 import type { ModelRequirements, ModelVariant } from '../types/ModelRequirements';
 import type { Parameters } from '../types/Parameters';
+import { KnowledgeJson } from '../types/PipelineJson/KnowledgeJson';
+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 { PromptTemplateParameterJson } from '../types/PipelineJson/PromptTemplateParameterJson';
+import type { PipelineString } from '../types/PipelineString';
 import type { Prompt } from '../types/Prompt';
-import { KnowledgeJson } from '../types/PromptbookJson/KnowledgeJson';
-import { MaterialKnowledgePieceJson } from '../types/PromptbookJson/MaterialKnowledgePieceJson';
-import type { ExpectationAmount, Expectations, ExpectationUnit, LlmTemplateJson, PromptDialogJson, PromptTemplateJson, ScriptJson, SimpleTemplateJson } from '../types/PromptbookJson/PromptTemplateJson';
-import { EXPECTATION_UNITS } from '../types/PromptbookJson/PromptTemplateJson';
-import type { PromptTemplateParameterJson } from '../types/PromptbookJson/PromptTemplateParameterJson';
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../types/PromptbookString';
 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_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, 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_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 { FromtoItems } from '../utils/FromtoItems';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 export { EXPECTATION_UNITS };
-export type { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, KnowledgeJson, LlmExecutionTools, LlmTemplateJson, MaterialKnowledgePieceJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptEmbeddingResult, EmbeddingVector, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, 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_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, 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, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
+export type { AvailableModel, CommonExecutionToolsOptions, EmbeddingVector, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, ExpectationUnit, Expectations, FromtoItems, KnowledgeJson, LlmExecutionTools, LlmTemplateJson, MaterialKnowledgePieceJson, ModelRequirements, ModelVariant, Parameters, PipelineCollection, PipelineJson, PipelineString, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptEmbeddingResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, PromptbookExecutor, 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, };
 /**
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here
  */

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

@@ -1,5 +1,5 @@
 import { spaceTrim } from 'spacetrim';
-import { renderPromptbookMermaid } from '../conversion/prettify/renderPromptbookMermaid';
+import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMermaidOptions';
 import { extractParametersFromPromptTemplate } from '../conversion/utils/extractParametersFromPromptTemplate';
 import { extractVariables } from '../conversion/utils/extractVariables';
 import { parseNumber } from '../conversion/utils/parseNumber';
@@ -8,32 +8,30 @@ 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 { CountUtils } from '../utils/expectation-counters/index';
 import { countCharacters } from '../utils/expectation-counters/countCharacters';
 import { countLines } from '../utils/expectation-counters/countLines';
 import { countPages } from '../utils/expectation-counters/countPages';
 import { countParagraphs } from '../utils/expectation-counters/countParagraphs';
-import { countSentences } from '../utils/expectation-counters/countSentences';
-import { splitIntoSentences } from '../utils/expectation-counters/countSentences';
+import { countSentences, splitIntoSentences } from '../utils/expectation-counters/countSentences';
 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';
 import { decapitalize } from '../utils/normalization/decapitalize';
-import { DIACRITIC_VARIANTS_LETTERS } from '../utils/normalization/DIACRITIC_VARIANTS_LETTERS';
-import type { IKeywords } from '../utils/normalization/IKeywords';
-import type { string_keyword } from '../utils/normalization/IKeywords';
 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_camelCase } from '../utils/normalization/normalizeTo_camelCase';
 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 { normalizeWhitespaces } from '../utils/normalization/normalizeWhitespaces';
 import { parseKeywords } from '../utils/normalization/parseKeywords';
@@ -50,12 +48,12 @@ import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
 import { PROMPTBOOK_VERSION } from '../version';
-export { forEachAsync, PROMPTBOOK_VERSION };
+export { PROMPTBOOK_VERSION, forEachAsync };
 export { extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
 extractOneBlockFromMarkdown, extractParameters, extractVariables, isValidJsonString, parseNumber, // <- [🌻]
 removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
-export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
+export { CountUtils, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords };
 export { splitIntoSentences };
 export declare const normalizeTo: {
     camelCase: typeof normalizeTo_camelCase;
@@ -64,7 +62,7 @@ export declare const normalizeTo: {
     snake_case: typeof normalizeTo_snake_case;
     'kebab-case': typeof normalizeToKebabCase;
 };
-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 { 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 { extractParametersFromPromptTemplate, renameParameter, renderPromptbookMermaid };
 export { difference, intersection, union };
 /**

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

@@ -7,6 +7,6 @@ export declare const LOOP_LIMIT = 1000;
  */
 export declare const CHARACTER_LOOP_LIMIT = 100000;
 /**
- * The name of the builded promptbook library made by CLI `promptbook make` and for lookup in `createLibraryFromDirectory`
+ * The name of the builded promptbook library made by CLI `promptbook make` and for lookup in `createCollectionFromDirectory`
  */
 export declare const PROMPTBOOK_MAKED_BASE_FILENAME = "index";

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

@@ -0,0 +1,12 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PipelineString } from '../types/PipelineString';
+/**
+ * Converts promptbook in JSON format to string format
+ *
+ * @param pipelineJson Promptbook in JSON format (.ptbk.json)
+ * @returns Promptbook in string format (.ptbk.md)
+ */
+export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
+/**
+ * TODO: Escape all
+ */

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

@@ -0,0 +1,32 @@
+import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PipelineString } from '../types/PipelineString';
+/**
+ * Options for pipelineStringToJson
+ */
+type PipelineStringToJsonOptions = {
+    /**
+     * Tools for processing required for knowledge processing *(not for actual execution)*
+     */
+    llmTools?: LlmExecutionTools;
+};
+/**
+ * Compile promptbook from string (markdown) format to JSON format
+ *
+ * Note: There are two 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
+ *
+ * @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 {SyntaxError} if the promptbook string is not valid
+ *
+ * Note: This function does not validate logic of the pipeline only the syntax
+ * Note: This function acts as compilation process
+ */
+export declare function pipelineStringToJson(pipelineString: PipelineString, options?: PipelineStringToJsonOptions): Promise<PipelineJson>;
+export {};
+/**
+ * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
+ */

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

@@ -0,0 +1,23 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PipelineString } from '../types/PipelineString';
+/**
+ * Compile promptbook from string (markdown) format to JSON format synchronously
+ *
+ * Note: There are two 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
+ *
+ * @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 {SyntaxError} if the promptbook string is not valid
+ *
+ * Note: This function does not validate logic of the pipeline only the syntax
+ * Note: This function acts as compilation process
+ */
+export declare function pipelineStringToJsonSync(pipelineString: PipelineString): PipelineJson;
+/**
+ * TODO: Report here line/column of error
+ * TODO: Use spaceTrim more effectively
+ * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
+ */

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

@@ -1,5 +1,5 @@
 /**
- * Options for `prettifyPromptbookString` function
+ * Options for `prettifyPipelineString` function
  */
 export type PrettifyOptions = {
     /***

package/{esm/typings/src/conversion/prettify/prettifyPromptbookString.d.ts → umd/typings/src/conversion/prettify/prettifyPipelineString.d.ts}

@@ -1,9 +1,9 @@
-import type { PromptbookString } from '../../types/PromptbookString';
+import type { PipelineString } from '../../types/PipelineString';
 import type { PrettifyOptions } from './PrettifyOptions';
 /**
  * Prettyfies Promptbook string and adds Mermaid graph
  */
-export declare function prettifyPromptbookString(promptbookString: PromptbookString, options: PrettifyOptions): Promise<PromptbookString>;
+export declare function prettifyPipelineString(pipelineString: PipelineString, options: PrettifyOptions): Promise<PipelineString>;
 /**
  * TODO: Maybe use some Mermaid library instead of string templating
  * TODO: [🕌] When more than 2 functionalities, split into separate functions

package/umd/typings/src/conversion/prettify/{renderPromptbookMermaid.d.ts → renderPipelineMermaidOptions.d.ts}

@@ -1,10 +1,10 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import type { PromptTemplateJson } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PromptTemplateJson } from '../../types/PipelineJson/PromptTemplateJson';
 import type { string_href } from '../../types/typeAliases';
 /**
  * Addtional options for rendering Mermaid graph
  */
-export type renderPromptbookMermaidOptions = {
+export type renderPipelineMermaidOptions = {
     /**
      * Callback for creating from prompt template graph node
      */
@@ -18,7 +18,7 @@ export type renderPromptbookMermaidOptions = {
  *
  * Note: The result is not wrapped in a Markdown code block
  */
-export declare function renderPromptbookMermaid(promptbookJson: PromptbookJson, options?: renderPromptbookMermaidOptions): string;
+export declare function renderPromptbookMermaid(pipelineJson: PipelineJson, options?: renderPipelineMermaidOptions): string;
 /**
  * TODO: Maybe use some Mermaid library instead of string templating
  * TODO: [🕌] When more than 2 functionalities, split into separate functions

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

@@ -1,11 +1,11 @@
-import type { PromptTemplateJson } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { PromptTemplateJson } from '../../types/PipelineJson/PromptTemplateJson';
 import type { string_name } from '../../types/typeAliases';
 /**
  * Parses the prompt template and returns the set of all used parameters
  *
  * @param promptTemplate the template with used parameters
  * @returns the set of parameter names
- * @throws {PromptbookSyntaxError} if the script is invalid
+ * @throws {SyntaxError} if the script is invalid
  */
 export declare function extractParametersFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'executionType' | 'content'>): Set<string_name>;
 /**

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

@@ -5,7 +5,7 @@ import type { string_javascript_name } from '../../types/typeAliases';
  *
  * @param script from which to extract the variables
  * @returns the list of variable names
- * @throws {PromptbookSyntaxError} if the script is invalid
+ * @throws {SyntaxError} if the script is invalid
  */
 export declare function extractVariables(script: string_javascript): Set<string_javascript_name>;
 /**

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

@@ -4,8 +4,8 @@ import type { string_markdown_text } from '../../types/typeAliases';
  * Parses one line of ul/ol to command
  *
  * @returns parsed command object
- * @throws {PromptbookSyntaxError} if the command is invalid
+ * @throws {SyntaxError} if the command is invalid
  *
- * @private within the promptbookStringToJson
+ * @private within the pipelineStringToJson
  */
 export declare function parseCommand(listItem: string_markdown_text): Command;

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

@@ -5,7 +5,7 @@
  * Note: it also works only with decimal numbers
  *
  * @returns parsed number
- * @throws {PromptbookSyntaxError} if the value is not a number
+ * @throws {SyntaxError} if the value is not a number
  *
  * @private within the parseCommand
  */

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

@@ -1,11 +1,11 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 import type { string_name } from '../../types/typeAliases';
 type RenameParameterOptions = {
     /**
      * Promptbook to search and replace for parameters
      * This promptbook is returned as copy with replaced parameters
      */
-    promptbook: PromptbookJson;
+    promptbook: PipelineJson;
     /**
      * Original parameter name that should be replaced
      */
@@ -19,7 +19,7 @@ type RenameParameterOptions = {
  * Function renameParameter will find all usable parameters for given prompt template
  * In other words, it will find all parameters that are not used in the prompt template itseld and all its dependencies
  *
- * @throws {PromptbookLogicError} If the new parameter name is already used in the promptbook
+ * @throws {PipelineLogicError} If the new parameter name is already used in the promptbook
  */
-export declare function renameParameter(options: RenameParameterOptions): PromptbookJson;
+export declare function renameParameter(options: RenameParameterOptions): PipelineJson;
 export {};

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

@@ -0,0 +1,13 @@
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineString } from '../../types/PipelineString';
+/**
+ * Import the text file
+ *
+ * Note: Using here custom import to work in jest tests
+ * Note: Using sync version is 💩 in the production code, but it's ok here in tests
+ *
+ * @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;