@promptbook/openai 0.60.0-0 → 0.60.0-4

package/esm/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/esm/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/esm/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/esm/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/esm/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/esm/typings/src/conversion/prettify/PrettifyOptions.d.ts

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

package/{umd/typings/src/conversion/prettify/prettifyPromptbookString.d.ts → esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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;

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

@@ -0,0 +1,27 @@
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+/**
+ * Validates PipelineJson if it is logically valid
+ *
+ * It checks:
+ * -   if it has correct parameters dependency
+ *
+ * It does NOT check:
+ * -   if it is valid json
+ * -   if it is meaningful
+ *
+ * @param pipeline valid or invalid PipelineJson
+ * @returns the same pipeline if it is logically valid
+ * @throws {PipelineLogicError} on logical error in the pipeline
+ */
+export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
+/**
+ * TODO: [🧠] Work with promptbookVersion
+ * TODO: Use here some json-schema, Zod or something similar and change it to:
+ *     > /**
+ *     >  * Validates PipelineJson if it is logically valid.
+ *     >  *
+ *     >  * It checks:
+ *     >  * -   it has a valid structure
+ *     >  * -   ...
+ *     >  ex port function validatePipeline(promptbook: unknown): asserts promptbook is PipelineJson {
+ */

package/{umd/typings/src/errors/PromptbookLibraryError.d.ts → esm/typings/src/errors/CollectionError.d.ts}

@@ -1,7 +1,7 @@
 /**
  * This error indicates that the promptbook library cannot be propperly loaded
  */
-export declare class PromptbookLibraryError extends Error {
-    readonly name = "PromptbookLibraryError";
+export declare class CollectionError extends Error {
+    readonly name = "CollectionError";
     constructor(message: string);
 }

package/esm/typings/src/errors/{PromptbookExecutionError.d.ts → ExecutionError.d.ts}

@@ -1,7 +1,7 @@
 /**
  * This error indicates errors during the execution of the promptbook
  */
-export declare class PromptbookExecutionError extends Error {
-    readonly name = "PromptbookExecutionError";
+export declare class ExecutionError extends Error {
+    readonly name = "ExecutionError";
     constructor(message: string);
 }

package/{umd/typings/src/errors/PromptbookNotFoundError.d.ts → esm/typings/src/errors/NotFoundError.d.ts}

@@ -1,7 +1,7 @@
 /**
  * This error indicates that promptbook not found in the library
  */
-export declare class PromptbookNotFoundError extends Error {
-    readonly name = "PromptbookNotFoundError";
+export declare class NotFoundError extends Error {
+    readonly name = "NotFoundError";
     constructor(message: string);
 }

package/{umd/typings/src/errors/PromptbookLogicError.d.ts → esm/typings/src/errors/PipelineLogicError.d.ts}

@@ -1,7 +1,7 @@
 /**
  * This error indicates that the promptbook object has valid syntax but contains logical errors (like circular dependencies)
  */
-export declare class PromptbookLogicError extends Error {
-    readonly name = "PromptbookLogicError";
+export declare class PipelineLogicError extends Error {
+    readonly name = "PipelineLogicError";
     constructor(message: string);
 }

package/{umd/typings/src/errors/PromptbookReferenceError.d.ts → esm/typings/src/errors/ReferenceError.d.ts}

@@ -1,7 +1,7 @@
 /**
  * This error indicates errors in referencing promptbooks between each other
  */
-export declare class PromptbookReferenceError extends Error {
-    readonly name = "PromptbookReferenceError";
+export declare class ReferenceError extends Error {
+    readonly name = "ReferenceError";
     constructor(message: string);
 }

package/esm/typings/src/errors/{PromptbookSyntaxError.d.ts → SyntaxError.d.ts}

@@ -1,7 +1,7 @@
 /**
  * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
  */
-export declare class PromptbookSyntaxError extends Error {
-    readonly name = "PromptbookSyntaxError";
+export declare class SyntaxError extends Error {
+    readonly name = "SyntaxError";
     constructor(message: string);
 }

package/esm/typings/src/errors/TemplateError.d.ts

@@ -1,7 +1,7 @@
 /**
  * This error occurs during the parameter replacement in the template
  *
- * Note: This is a kindof subtype of PromptbookExecutionError because it occurs during the execution of the pipeline
+ * Note: This is a kindof subtype of ExecutionError because it occurs during the execution of the pipeline
  */
 export declare class TemplateError extends Error {
     readonly name = "TemplateError";

package/esm/typings/src/errors/_ExpectError.d.ts

@@ -1,8 +1,8 @@
 /**
  * This error occurs when some expectation is not met in the execution of the pipeline
  *
- * @private Always catched and rethrown as `PromptbookExecutionError`
- * Note: This is a kindof subtype of PromptbookExecutionError
+ * @private Always catched and rethrown as `ExecutionError`
+ * Note: This is a kindof subtype of ExecutionError
  */
 export declare class ExpectError extends Error {
     readonly name = "ExpectError";

package/esm/typings/src/execution/ExecutionTools.d.ts

@@ -2,7 +2,7 @@ import type { LlmExecutionTools } from './LlmExecutionTools';
 import type { ScriptExecutionTools } from './ScriptExecutionTools';
 import type { UserInterfaceTools } from './UserInterfaceTools';
 /**
- * All the tools needed to execute prompts (template pipelines).
+ * All the tools needed to execute pipelines.
  *
  * @see https://github.com/webgptorg/promptbook#execution-tools
  */

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

@@ -16,11 +16,11 @@ export type LlmExecutionTools = {
     /**
      * Use a chat model
      */
-    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    callChatModel(prompt: Prompt): Promise<PromptChatResult>;
     /**
      * Use a completion model
      */
-    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    callCompletionModel(prompt: Prompt): Promise<PromptCompletionResult>;
     /**
      * List all available models that can be used
      */
@@ -46,6 +46,6 @@ export type AvailableModel = {
 /**
  * TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat
  * TODO: [🍓][♐] Some heuristic to pick the best model in listed models
- * TODO: [🏳] gptChat -> chat, gptComplete -> complete, translate
- * TODO: [🧠] Should or should not there be a word "GPT" in both gptComplete and gptChat
+ * TODO: [🏳] callChatModel -> chat, callCompletionModel -> complete, translate
+ * TODO: [🧠] Should or should not there be a word "GPT" in both callCompletionModel and callChatModel
  */

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

@@ -1,5 +1,5 @@
 import type { KebabCase } from 'type-fest';
-import type { ExpectationUnit } from '../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationUnit } from '../types/PipelineJson/PromptTemplateJson';
 import type { number_positive } from '../types/typeAliases';
 import type { number_usd } from '../types/typeAliases';
 import type { string_date_iso8601 } from '../types/typeAliases';

package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts

@@ -3,7 +3,7 @@ import type { PromptbookExecutor } from './PromptbookExecutor';
  * Asserts that the execution of a promptnook is successful
  *
  * @param executionResult - The partial result of the promptnook execution
- * @throws {PromptbookExecutionError} If the execution is not successful or if multiple errors occurred
+ * @throws {ExecutionError} If the execution is not successful or if multiple errors occurred
  */
 export declare function assertsExecutionSuccessful(executionResult: Pick<Awaited<ReturnType<PromptbookExecutor>>, 'isSuccessful' | 'errors'>): void;
 /**

package/esm/typings/src/execution/createPromptbookExecutor.d.ts

@@ -1,4 +1,4 @@
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 import type { ExecutionTools } from './ExecutionTools';
 import type { PromptbookExecutor } from './PromptbookExecutor';
 type CreatePromptbookExecutorSettings = {
@@ -16,7 +16,7 @@ interface CreatePromptbookExecutorOptions {
     /**
      * The promptbook to be executed
      */
-    readonly promptbook: PromptbookJson;
+    readonly promptbook: PipelineJson;
     /**
      * The execution tools to be used during the execution of the PROMPTBOOK
      */
@@ -30,7 +30,7 @@ interface CreatePromptbookExecutorOptions {
  * Creates executor function from promptbook and execution tools.
  *
  * @returns The executor function
- * @throws {PromptbookLogicError} on logical error in the promptbook
+ * @throws {PipelineLogicError} on logical error in the promptbook
  */
 export declare function createPromptbookExecutor(options: CreatePromptbookExecutorOptions): PromptbookExecutor;
 export {};

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

@@ -2,6 +2,6 @@
  *
  * @param message
  * @returns
- * @throws {PromptbookExecutionError}
+ * @throws {ExecutionError}
  */
 export declare function extractMultiplicatedOccurrence(message: string): string;

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

@@ -1,4 +1,4 @@
-import type { Expectations } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { Expectations } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Function checkExpectations will check if the expectations on given value are met
  *

package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -1,5 +1,5 @@
 import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
-import type { KnowledgeJson } from '../../../types/PromptbookJson/KnowledgeJson';
+import type { KnowledgeJson } from '../../../types/PipelineJson/KnowledgeJson';
 import type { string_markdown } from '../../../types/typeAliases';
 type PrepareKnowledgeFromMarkdownOptions = {
     /**

package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts

@@ -1,5 +1,5 @@
 import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
-import type { KnowledgeJson } from '../../../types/PromptbookJson/KnowledgeJson';
+import type { KnowledgeJson } from '../../../types/PipelineJson/KnowledgeJson';
 import type { string_base64 } from '../../../types/typeAliases';
 type PrepareKnowledgeFromPdfOptions = {
     /**

package/esm/typings/src/library/PipelineCollection.d.ts

@@ -0,0 +1,25 @@
+import type { Promisable } from 'type-fest';
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { Prompt } from '../types/Prompt';
+import type { string_pipeline_url } from '../types/typeAliases';
+/**
+ * Collection that groups together pipelines, knowledge, personas, tools and actions
+ *
+ * @see !!! https://github.com/webgptorg/pipeline#pipeline-library
+ */
+export type PipelineCollection = {
+    /**
+     * Gets all pipelines in the library
+     */
+    listPipelines(): Promisable<Array<string_pipeline_url>>;
+    /**
+     * Gets pipeline by its URL
+     *
+     * Note: This is not a direct fetching from the URL, but a lookup in the library
+     */
+    getPipelineByUrl(url: string_pipeline_url): Promisable<PipelineJson>;
+    /**
+     * Checks whether given prompt was defined in any pipeline in the library
+     */
+    isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
+};

package/esm/typings/src/library/{SimplePromptbookLibrary.d.ts → SimplePipelineCollection.d.ts}

@@ -1,36 +1,36 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 import type { Prompt } from '../types/Prompt';
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { string_promptbook_url } from '../types/typeAliases';
-import type { PromptbookLibrary } from './PromptbookLibrary';
+import type { string_pipeline_url } from '../types/typeAliases';
+import type { PipelineCollection } from './PipelineCollection';
 /**
  * Library of promptbooks that groups together promptbooks for an application.
  * This implementation is a very thin wrapper around the Array / Map of promptbooks.
  *
- * @private use `createLibraryFromJson` instead
- * @see https://github.com/webgptorg/promptbook#promptbook-library
+ * @private use `createCollectionFromJson` instead
+ * @see https://github.com/webgptorg/promptbook#promptbook-collection
  */
-export declare class SimplePromptbookLibrary implements PromptbookLibrary {
+export declare class SimplePipelineCollection implements PipelineCollection {
     private library;
     /**
      * Constructs a promptbook library from promptbooks
      *
      * @param promptbooks !!!
      *
-     * @private Use instead `createLibraryFromJson`
+     * @private Use instead `createCollectionFromJson`
      * Note: During the construction logic of all promptbooks are validated
-     * Note: It is not recommended to use this constructor directly, use `createLibraryFromJson` *(or other variant)* instead
+     * Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead
      */
-    constructor(...promptbooks: Array<PromptbookJson>);
+    constructor(...promptbooks: Array<PipelineJson>);
     /**
      * Gets all promptbooks in the library
      */
-    listPromptbooks(): Array<string_promptbook_url>;
+    listPipelines(): Array<string_pipeline_url>;
     /**
      * Gets promptbook by its URL
      *
      * Note: This is not a direct fetching from the URL, but a lookup in the library
      */
-    getPromptbookByUrl(url: string_promptbook_url): PromptbookJson;
+    getPipelineByUrl(url: string_pipeline_url): PipelineJson;
     /**
      * Checks whether given prompt was defined in any promptbook in the library
      */

package/{umd/typings/src/library/constructors/createLibraryFromDirectory.d.ts → esm/typings/src/library/constructors/createCollectionFromDirectory.d.ts}

@@ -1,9 +1,9 @@
 import type { string_folder_path } from '../../types/typeAliases';
-import type { PromptbookLibrary } from '../PromptbookLibrary';
+import type { PipelineCollection } from '../PipelineCollection';
 /**
- * Options for `createLibraryFromDirectory` function
+ * Options for `createCollectionFromDirectory` function
  */
-type CreatePromptbookLibraryFromDirectoryOptions = {
+type CreatePipelineCollectionFromDirectoryOptions = {
     /**
      * If true, the directory is searched recursively for promptbooks
      *
@@ -37,9 +37,9 @@ type CreatePromptbookLibraryFromDirectoryOptions = {
  *
  * @param path - path to the directory with promptbooks
  * @param options - Misc options for the library
- * @returns PromptbookLibrary
+ * @returns PipelineCollection
  */
-export declare function createLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): Promise<PromptbookLibrary>;
+export declare function createCollectionFromDirectory(path: string_folder_path, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
 export {};
 /**
  * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks

package/esm/typings/src/library/constructors/createCollectionFromJson.d.ts

@@ -0,0 +1,12 @@
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Creates PipelineCollection from array of PipelineJson or PipelineString
+ *
+ * Note: Functions `libraryToJson` and `createCollectionFromJson` are complementary
+ * Note: During the construction syntax and logic of all sources are validated
+ *
+ * @param promptbookSources
+ * @returns PipelineCollection
+ */
+export declare function createCollectionFromJson(...promptbooks: Array<PipelineJson>): PipelineCollection;