@promptbook/markdown-utils 0.61.0-7

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

@@ -0,0 +1,44 @@
+import { collectionToJson } from '../collection/collectionToJson';
+import { createCollectionFromJson } from '../collection/constructors/createCollectionFromJson';
+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 { 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 { UnexpectedError } from '../errors/UnexpectedError';
+import { ExpectError } from '../errors/_ExpectError';
+import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
+import { createPipelineExecutor } from '../execution/createPipelineExecutor';
+import { embeddingVectorToString } from '../execution/embeddingVectorToString';
+import { addUsage } from '../execution/utils/addUsage';
+import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
+import { usageToWorktime } from '../execution/utils/usageToWorktime';
+import { CallbackInterfaceTools } from '../knowledge/dialogs/callback/CallbackInterfaceTools';
+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 { 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 { 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, joinLlmExecutionTools };
+export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };
+export { CollectionError, ExpectError, NotFoundError, ParsingError, PipelineExecutionError, PipelineLogicError, ReferenceError, UnexpectedError, };

package/esm/typings/src/_packages/execute-javascript.index.d.ts

@@ -0,0 +1,48 @@
+import spaceTrim from 'spacetrim';
+import { JavascriptEvalExecutionTools } from '../scripting/javascript/JavascriptEvalExecutionTools';
+import { JavascriptExecutionTools } from '../scripting/javascript/JavascriptExecutionTools';
+import { prettifyMarkdown } from '../utils/markdown/prettifyMarkdown';
+import { capitalize } from '../utils/normalization/capitalize';
+import { decapitalize } from '../utils/normalization/decapitalize';
+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 { normalizeWhitespaces } from '../utils/normalization/normalizeWhitespaces';
+import { removeDiacritics } from '../utils/normalization/removeDiacritics';
+import { extractBlock } from '../utils/postprocessing/extractBlock';
+import { removeEmojis } from '../utils/removeEmojis';
+import { removeQuotes } from '../utils/removeQuotes';
+import { trimCodeBlock } from '../utils/trimCodeBlock';
+import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
+import { unwrapResult } from '../utils/unwrapResult';
+import { PROMPTBOOK_VERSION } from '../version';
+export { PROMPTBOOK_VERSION };
+declare const POSTPROCESSING_FUNCTIONS: {
+    spaceTrim: typeof spaceTrim;
+    removeQuotes: typeof removeQuotes;
+    unwrapResult: typeof unwrapResult;
+    trimEndOfCodeBlock: typeof trimEndOfCodeBlock;
+    trimCodeBlock: typeof trimCodeBlock;
+    trim: (str: string) => string;
+    reverse: (str: string) => string;
+    removeEmojis: typeof removeEmojis;
+    prettifyMarkdown: typeof prettifyMarkdown;
+    capitalize: typeof capitalize;
+    decapitalize: typeof decapitalize;
+    nameToUriPart: typeof nameToUriPart;
+    nameToUriParts: typeof nameToUriParts;
+    removeDiacritics: typeof removeDiacritics;
+    normalizeWhitespaces: typeof normalizeWhitespaces;
+    normalizeToKebabCase: typeof normalizeToKebabCase;
+    normalizeTo_camelCase: typeof normalizeTo_camelCase;
+    normalizeTo_snake_case: typeof normalizeTo_snake_case;
+    normalizeTo_PascalCase: typeof normalizeTo_PascalCase;
+    parseKeywords: (input: string) => string;
+    normalizeTo_SCREAMING_CASE: typeof normalizeTo_SCREAMING_CASE;
+    extractBlock: typeof extractBlock;
+};
+export { JavascriptEvalExecutionTools, JavascriptExecutionTools, POSTPROCESSING_FUNCTIONS };

package/esm/typings/src/_packages/fake-llm.index.d.ts

@@ -0,0 +1,7 @@
+import { MockedEchoLlmExecutionTools } from '../llm-providers/mocked/MockedEchoLlmExecutionTools';
+import { MockedFackedLlmExecutionTools } from '../llm-providers/mocked/MockedFackedLlmExecutionTools';
+import { PROMPTBOOK_VERSION } from '../version';
+export { MockedEchoLlmExecutionTools, MockedFackedLlmExecutionTools, PROMPTBOOK_VERSION };
+/**
+ * TODO: [🚏] FakeLLM
+ */

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

@@ -0,0 +1,4 @@
+import { LangtailExecutionTools } from '../llm-providers/langtail/LangtailExecutionTools';
+import type { LangtailExecutionToolsOptions } from '../llm-providers/langtail/LangtailExecutionToolsOptions';
+import { PROMPTBOOK_VERSION } from '../version';
+export { LangtailExecutionTools, LangtailExecutionToolsOptions, PROMPTBOOK_VERSION };

package/esm/typings/src/_packages/markdown-utils.index.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/node.index.d.ts

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

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

@@ -0,0 +1,5 @@
+import { OPENAI_MODELS } from '../llm-providers/openai/openai-models';
+import { OpenAiExecutionTools } from '../llm-providers/openai/OpenAiExecutionTools';
+import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
+import { PROMPTBOOK_VERSION } from '../version';
+export { OPENAI_MODELS, OpenAiExecutionTools, OpenAiExecutionToolsOptions, PROMPTBOOK_VERSION };

package/esm/typings/src/_packages/remote-client.index.d.ts

@@ -0,0 +1,5 @@
+import type { RemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
+import { RemoteLlmExecutionTools } from '../llm-providers/remote/RemoteLlmExecutionTools';
+import type { RemoteLlmExecutionToolsOptions } from '../llm-providers/remote/RemoteLlmExecutionToolsOptions';
+import { PROMPTBOOK_VERSION } from '../version';
+export { PROMPTBOOK_VERSION, RemoteLlmExecutionTools, RemoteLlmExecutionToolsOptions, RemoteServerOptions };

package/esm/typings/src/_packages/remote-server.index.d.ts

@@ -0,0 +1,4 @@
+import type { RemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
+import { startRemoteServer } from '../llm-providers/remote/startRemoteServer';
+import { PROMPTBOOK_VERSION } from '../version';
+export { PROMPTBOOK_VERSION, RemoteServerOptions, startRemoteServer };

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

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

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

@@ -0,0 +1,74 @@
+import { spaceTrim } from 'spacetrim';
+import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMermaidOptions';
+import { extractParametersFromPromptTemplate } from '../conversion/utils/extractParametersFromPromptTemplate';
+import { extractVariables } from '../conversion/utils/extractVariables';
+import { renameParameter } from '../conversion/utils/renameParameter';
+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 { 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, 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 { 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 { isValidKeyword } from '../utils/normalization/isValidKeyword';
+import { nameToUriPart } from '../utils/normalization/nameToUriPart';
+import { nameToUriParts } from '../utils/normalization/nameToUriParts';
+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';
+import { difference } from '../utils/sets/difference';
+import { intersection } from '../utils/sets/intersection';
+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 { 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;
+    PascalCase: typeof normalizeTo_PascalCase;
+    SCREAMING_CASE: typeof normalizeTo_SCREAMING_CASE;
+    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 type { string_camelCase, string_kebab_case, string_PascalCase, string_SCREAMING_CASE, string_snake_case };
+export { extractParametersFromPromptTemplate, renameParameter, renderPromptbookMermaid };
+export { difference, intersection, union };
+/**
+ * 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/cli/promptbookCli.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Runs CLI utilities of Promptbook package
+ */
+export declare function promptbookCli(): Promise<void>;
+/**
+ * TODO: [🥠] Do not export to utils directly, its just for CLI script
+ * TODO: [🕌] When more functionalities, rename
+ * Note: 11:11
+ */

package/esm/typings/src/collection/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-collection
+ */
+export type PipelineCollection = {
+    /**
+     * Gets all pipelines in the collection
+     */
+    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 collection
+     */
+    getPipelineByUrl(url: string_pipeline_url): Promisable<PipelineJson>;
+    /**
+     * Checks whether given prompt was defined in any pipeline in the collection
+     */
+    isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
+};

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

@@ -0,0 +1,38 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { Prompt } from '../types/Prompt';
+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 `createCollectionFromJson` instead
+ * @see https://github.com/webgptorg/promptbook#promptbook-collection
+ */
+export declare class SimplePipelineCollection implements PipelineCollection {
+    private collection;
+    /**
+     * Constructs a pipeline collection from promptbooks
+     *
+     * @param promptbooks !!!
+     *
+     * @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 `createCollectionFromJson` *(or other variant)* instead
+     */
+    constructor(...promptbooks: Array<PipelineJson>);
+    /**
+     * Gets all promptbooks in the collection
+     */
+    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 collection
+     */
+    getPipelineByUrl(url: string_pipeline_url): PipelineJson;
+    /**
+     * Checks whether given prompt was defined in any promptbook in the collection
+     */
+    isResponsibleForPrompt(prompt: Prompt): boolean;
+}

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

@@ -0,0 +1,11 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PipelineCollection } from './PipelineCollection';
+/**
+ * Converts PipelineCollection to serialized JSON
+ *
+ * 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

@@ -0,0 +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

@@ -0,0 +1,47 @@
+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 = PipelineStringToJsonOptions & {
+    /**
+     * If true, the directory is searched recursively for promptbooks
+     *
+     * @default true
+     */
+    isRecursive?: boolean;
+    /**
+     * If true, the collection creation outputs information about each file it reads
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    isLazyLoaded?: boolean;
+    /**
+     * If true, whole collection creation crashes on error in any promptbook
+     * If true and isLazyLoaded is true, the error is thrown on first access to the promptbook
+     *
+     * @default true
+     */
+    isCrashOnError?: boolean;
+};
+/**
+ * Constructs Promptbook from given directory
+ *
+ * Note: Works only in Node.js environment because it reads the file system
+ *
+ * @param path - path to the directory with promptbooks
+ * @param options - Misc options for the collection
+ * @returns PipelineCollection
+ */
+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/collection/constructors/createCollectionFromDirectory.test.d.ts

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

package/esm/typings/src/collection/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 `collectionToJson` 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;

package/esm/typings/src/collection/constructors/createCollectionFromJson.test.d.ts

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

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

@@ -0,0 +1,22 @@
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Constructs Promptbook from async sources
+ * It can be one of the following:
+ * - Promise of array of PipelineJson or PipelineString
+ * - Factory function that returns Promise of array of PipelineJson or PipelineString
+ *
+ * Note: This is useful as internal tool for other constructor functions like
+ *       `createCollectionFromUrl` or `createCollectionFromDirectory`
+ *       Consider using those functions instead of this one
+ *
+ * Note: The function does NOT return promise it returns the collection directly which waits for the sources to be resolved
+ *       when error occurs in given promise or factory function, it is thrown during `listPipelines` or `getPipelineByUrl` call
+ *
+ * Note: Consider using  `createCollectionFromDirectory` or `createCollectionFromUrl`
+ *
+ * @param promptbookSourcesPromiseOrFactory
+ * @returns PipelineCollection
+ * @deprecated Do not use, it will became internal tool for other constructor functions
+ */
+export declare function createCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PipelineJson>> | (() => Promise<Array<PipelineJson>>)): PipelineCollection;

package/esm/typings/src/collection/constructors/createCollectionFromPromise.test.d.ts

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

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

@@ -0,0 +1,29 @@
+import type { string_url } from '../../types/typeAliases';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Options for `createCollectionFromDirectory` function
+ */
+type CreatePipelineCollectionFromUrlyOptions = {
+    /**
+     * If true, the collection creation outputs information about each file it reads
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    isLazyLoaded?: boolean;
+};
+/**
+ * Constructs Promptbook from remote Promptbase URL
+
+ * @returns PipelineCollection
+ */
+export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
+export {};
+/**
+ * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
+ */

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

@@ -0,0 +1,12 @@
+import type { string_pipeline_url } from '../../types/typeAliases';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Creates PipelineCollection as a subset of another PipelineCollection
+ *
+ * Note: You can use any type of collection as a parent collection - local, remote, etc.
+ * Note: This is just a thin wrapper / proxy around the parent collection
+ *
+ * @param promptbookSources
+ * @returns PipelineCollection
+ */
+export declare function createSubcollection(collection: PipelineCollection, predicate: (url: string_pipeline_url) => boolean): PipelineCollection;

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

@@ -0,0 +1,7 @@
+/**
+ * Just testing imports and compatibility
+ */
+export declare function justTestFsImport(): Promise<void>;
+/**
+ * TODO: !!! Remove this file
+ */ 

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/blockCommand.test.d.ts

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

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';
+};