@promptbook/markitdown 0.84.0-10

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

@@ -0,0 +1,162 @@
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { VALUE_STRINGS } from '../config';
+import { SMALL_NUMBER } from '../config';
+import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMermaidOptions';
+import { extractVariablesFromScript } from '../conversion/utils/extractVariablesFromScript';
+import { deserializeError } from '../errors/utils/deserializeError';
+import { serializeError } from '../errors/utils/serializeError';
+import { forEachAsync } from '../execution/utils/forEachAsync';
+import { isValidJsonString } from '../formats/json/utils/isValidJsonString';
+import { prompt } from '../pipeline/prompt-notation';
+import { $getCurrentDate } from '../utils/$getCurrentDate';
+import { $isRunningInBrowser } from '../utils/environment/$isRunningInBrowser';
+import { $isRunningInJest } from '../utils/environment/$isRunningInJest';
+import { $isRunningInNode } from '../utils/environment/$isRunningInNode';
+import { $isRunningInWebWorker } from '../utils/environment/$isRunningInWebWorker';
+import { CHARACTERS_PER_STANDARD_LINE } from '../utils/expectation-counters/constants';
+import { LINES_PER_STANDARD_PAGE } from '../utils/expectation-counters/constants';
+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 { splitIntoSentences } from '../utils/expectation-counters/countSentences';
+import { countSentences } from '../utils/expectation-counters/countSentences';
+import { countWords } from '../utils/expectation-counters/countWords';
+import { CountUtils } from '../utils/expectation-counters/index';
+import { capitalize } from '../utils/normalization/capitalize';
+import { decapitalize } from '../utils/normalization/decapitalize';
+import { DIACRITIC_VARIANTS_LETTERS } from '../utils/normalization/DIACRITIC_VARIANTS_LETTERS';
+import type { string_keyword } from '../utils/normalization/IKeywords';
+import type { Keywords } from '../utils/normalization/IKeywords';
+import { isValidKeyword } from '../utils/normalization/isValidKeyword';
+import { nameToUriPart } from '../utils/normalization/nameToUriPart';
+import { nameToUriParts } from '../utils/normalization/nameToUriParts';
+import type { string_kebab_case } from '../utils/normalization/normalize-to-kebab-case';
+import { normalizeToKebabCase } from '../utils/normalization/normalize-to-kebab-case';
+import type { string_camelCase } from '../utils/normalization/normalizeTo_camelCase';
+import { normalizeTo_camelCase } from '../utils/normalization/normalizeTo_camelCase';
+import type { string_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
+import { normalizeTo_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
+import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
+import { normalizeTo_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
+import { normalizeTo_snake_case } from '../utils/normalization/normalizeTo_snake_case';
+import { normalizeWhitespaces } from '../utils/normalization/normalizeWhitespaces';
+import { orderJson } from '../utils/normalization/orderJson';
+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 { titleToName } from '../utils/normalization/titleToName';
+import { spaceTrim } from '../utils/organization/spaceTrim';
+import { extractParameterNames } from '../utils/parameters/extractParameterNames';
+import { numberToString } from '../utils/parameters/numberToString';
+import { templateParameters } from '../utils/parameters/templateParameters';
+import { valueToString } from '../utils/parameters/valueToString';
+import { parseNumber } from '../utils/parseNumber';
+import { $randomSeed } from '../utils/random/$randomSeed';
+import { removeEmojis } from '../utils/removeEmojis';
+import { removeQuotes } from '../utils/removeQuotes';
+import { $deepFreeze } from '../utils/serialization/$deepFreeze';
+import { checkSerializableAsJson } from '../utils/serialization/checkSerializableAsJson';
+import { clonePipeline } from '../utils/serialization/clonePipeline';
+import { deepClone } from '../utils/serialization/deepClone';
+import { exportJson } from '../utils/serialization/exportJson';
+import { isSerializableAsJson } from '../utils/serialization/isSerializableAsJson';
+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 { isValidEmail } from '../utils/validators/email/isValidEmail';
+import { isRootPath } from '../utils/validators/filePath/isRootPath';
+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';
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export { VALUE_STRINGS };
+export { SMALL_NUMBER };
+export { renderPromptbookMermaid };
+export { extractVariablesFromScript };
+export { deserializeError };
+export { serializeError };
+export { forEachAsync };
+export { isValidJsonString };
+export { prompt };
+export { $getCurrentDate };
+export { $isRunningInBrowser };
+export { $isRunningInJest };
+export { $isRunningInNode };
+export { $isRunningInWebWorker };
+export { CHARACTERS_PER_STANDARD_LINE };
+export { LINES_PER_STANDARD_PAGE };
+export { countCharacters };
+export { countLines };
+export { countPages };
+export { countParagraphs };
+export { splitIntoSentences };
+export { countSentences };
+export { countWords };
+export { CountUtils };
+export { capitalize };
+export { decapitalize };
+export { DIACRITIC_VARIANTS_LETTERS };
+export type { string_keyword };
+export type { Keywords };
+export { isValidKeyword };
+export { nameToUriPart };
+export { nameToUriParts };
+export type { string_kebab_case };
+export { normalizeToKebabCase };
+export type { string_camelCase };
+export { normalizeTo_camelCase };
+export type { string_PascalCase };
+export { normalizeTo_PascalCase };
+export type { string_SCREAMING_CASE };
+export { normalizeTo_SCREAMING_CASE };
+export { normalizeTo_snake_case };
+export { normalizeWhitespaces };
+export { orderJson };
+export { parseKeywords };
+export { parseKeywordsFromString };
+export { removeDiacritics };
+export { searchKeywords };
+export { titleToName };
+export { spaceTrim };
+export { extractParameterNames };
+export { numberToString };
+export { templateParameters };
+export { valueToString };
+export { parseNumber };
+export { $randomSeed };
+export { removeEmojis };
+export { removeQuotes };
+export { $deepFreeze };
+export { checkSerializableAsJson };
+export { clonePipeline };
+export { deepClone };
+export { exportJson };
+export { isSerializableAsJson };
+export { difference };
+export { intersection };
+export { union };
+export { trimCodeBlock };
+export { trimEndOfCodeBlock };
+export { unwrapResult };
+export { isValidEmail };
+export { isRootPath };
+export { isValidFilePath };
+export { isValidJavascriptName };
+export { isValidPromptbookVersion };
+export { isValidSemanticVersion };
+export { isHostnameOnPrivateNetwork };
+export { isUrlOnPrivateNetwork };
+export { isValidPipelineUrl };
+export { isValidUrl };
+export { isValidUuid };

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

@@ -0,0 +1,6 @@
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { createExecutionToolsFromVercelProvider } from '../llm-providers/vercel/createExecutionToolsFromVercelProvider';
+import type { VercelProvider } from '../llm-providers/vercel/VercelProvider';
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export { createExecutionToolsFromVercelProvider };
+export type { VercelProvider };

package/esm/typings/src/_packages/website-crawler.index.d.ts

@@ -0,0 +1,8 @@
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { createWebsiteScraper } from '../scrapers/website/createWebsiteScraper';
+import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
+import { WebsiteScraper } from '../scrapers/website/WebsiteScraper';
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export { createWebsiteScraper };
+export { _WebsiteScraperRegistration };
+export { WebsiteScraper };

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

@@ -0,0 +1,52 @@
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { _AnthropicClaudeMetadataRegistration } from '../llm-providers/anthropic-claude/register-configuration';
+import { _AnthropicClaudeRegistration } from '../llm-providers/anthropic-claude/register-constructor';
+import { _AzureOpenAiMetadataRegistration } from '../llm-providers/azure-openai/register-configuration';
+import { _AzureOpenAiRegistration } from '../llm-providers/azure-openai/register-constructor';
+import { _GoogleMetadataRegistration } from '../llm-providers/google/register-configuration';
+import { _GoogleRegistration } from '../llm-providers/google/register-constructor';
+import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
+import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
+import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
+import { _OpenAiAssistantRegistration } from '../llm-providers/openai/register-constructor';
+import { _BoilerplateScraperRegistration } from '../scrapers/_boilerplate/register-constructor';
+import { _BoilerplateScraperMetadataRegistration } from '../scrapers/_boilerplate/register-metadata';
+import { _LegacyDocumentScraperRegistration } from '../scrapers/document-legacy/register-constructor';
+import { _LegacyDocumentScraperMetadataRegistration } from '../scrapers/document-legacy/register-metadata';
+import { _DocumentScraperRegistration } from '../scrapers/document/register-constructor';
+import { _DocumentScraperMetadataRegistration } from '../scrapers/document/register-metadata';
+import { _MarkdownScraperRegistration } from '../scrapers/markdown/register-constructor';
+import { _MarkdownScraperMetadataRegistration } from '../scrapers/markdown/register-metadata';
+import { _MarkitdownScraperRegistration } from '../scrapers/markitdown/register-constructor';
+import { _MarkitdownScraperMetadataRegistration } from '../scrapers/markitdown/register-metadata';
+import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
+import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
+import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
+import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
+import { wizzard } from '../wizzard/wizzard';
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export { _AnthropicClaudeMetadataRegistration };
+export { _AnthropicClaudeRegistration };
+export { _AzureOpenAiMetadataRegistration };
+export { _AzureOpenAiRegistration };
+export { _GoogleMetadataRegistration };
+export { _GoogleRegistration };
+export { _OpenAiMetadataRegistration };
+export { _OpenAiAssistantMetadataRegistration };
+export { _OpenAiRegistration };
+export { _OpenAiAssistantRegistration };
+export { _BoilerplateScraperRegistration };
+export { _BoilerplateScraperMetadataRegistration };
+export { _LegacyDocumentScraperRegistration };
+export { _LegacyDocumentScraperMetadataRegistration };
+export { _DocumentScraperRegistration };
+export { _DocumentScraperMetadataRegistration };
+export { _MarkdownScraperRegistration };
+export { _MarkdownScraperMetadataRegistration };
+export { _MarkitdownScraperRegistration };
+export { _MarkitdownScraperMetadataRegistration };
+export { _PdfScraperRegistration };
+export { _PdfScraperMetadataRegistration };
+export { _WebsiteScraperRegistration };
+export { _WebsiteScraperMetadataRegistration };
+export { wizzard };

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

@@ -0,0 +1,12 @@
+import type { Command as Program } from 'commander';
+/**
+ * Initializes `about` command for Promptbook CLI utilities
+ *
+ * @private internal function of `promptbookCli`
+ */
+export declare function initializeAboutCommand(program: Program): void;
+/**
+ * TODO: [🗽] Unite branding and make single place for it
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
+ */

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

@@ -0,0 +1,12 @@
+import type { Command as Program } from 'commander';
+/**
+ * Initializes testing `hello` command for Promptbook CLI utilities
+ *
+ * @private internal function of `promptbookCli`
+ */
+export declare function initializeHelloCommand(program: Program): void;
+/**
+ * TODO: [🧠][🐣] Make here some easter egg with generated hello greeting via LLM models
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
+ */

package/esm/typings/src/cli/cli-commands/list-models.d.ts

@@ -0,0 +1,11 @@
+import type { Command as Program } from 'commander';
+/**
+ * Initializes `list-models` command for Promptbook CLI utilities
+ *
+ * @private internal function of `promptbookCli`
+ */
+export declare function initializeListModelsCommand(program: Program): void;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
+ */

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

@@ -0,0 +1,14 @@
+import type { Command as Program } from 'commander';
+/**
+ * Initializes `make` command for Promptbook CLI utilities
+ *
+ * @private internal function of `promptbookCli`
+ */
+export declare function initializeMakeCommand(program: Program): void;
+/**
+ * TODO: [🥃][main] !!3 Allow `ptbk make` without configuring any llm tools
+ * TODO: [0] DRY Javascript and typescript - Maybe make ONLY typescript and for javascript just remove types
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
+ * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
+ */

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

@@ -0,0 +1,13 @@
+import type { Command as Program } from 'commander';
+/**
+ * Initializes `prettify` command for Promptbook CLI utilities
+ *
+ * @private internal function of `promptbookCli`
+ */
+export declare function initializePrettifyCommand(program: Program): void;
+/**
+ * TODO: [😶] Unite floder listing
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
+ * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
+ */

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

@@ -0,0 +1,15 @@
+import type { Command as Program } from 'commander';
+/**
+ * Initializes `run` command for Promptbook CLI utilities
+ *
+ * @private internal function of `promptbookCli`
+ */
+export declare function initializeRunCommand(program: Program): void;
+/**
+ * TODO: !!5 Catch and wrap all errors from CLI
+ * TODO: [🧠] Pass `maxExecutionAttempts`, `csvSettings`
+ * TODO: [🥃][main] !!3 Allow `ptbk run` without configuring any llm tools
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
+ * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
+ */

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

@@ -0,0 +1,32 @@
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineExecutor } from '../../execution/PipelineExecutor';
+/**
+ * Options for running the interactive chatbot
+ */
+type RunInteractiveChatbotOptions = {
+    /**
+     * Prepared pipeline to run
+     */
+    pipeline: PipelineJson;
+    /**
+     * Prepared pipeline executor
+     */
+    pipelineExecutor: PipelineExecutor;
+    /**
+     * Whether to show verbose output
+     */
+    isVerbose: boolean;
+};
+/**
+ * Run the interactive chatbot in CLI
+ *
+ * @returns Never-ending promise or process exit
+ * @private internal function of `promptbookCli` and `initializeRunCommand`
+ */
+export declare function runInteractiveChatbot(options: RunInteractiveChatbotOptions): Promise<void | never>;
+export {};
+/**
+ * TODO: Saving reports from the chatbot conversation
+ * TODO: [⛲️] This is the right place to start implementing INK
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
+ */

package/esm/typings/src/cli/cli-commands/test-command.d.ts

@@ -0,0 +1,14 @@
+import type { Command as Program } from 'commander';
+/**
+ * Initializes `test` command for Promptbook CLI utilities
+ *
+ * @private internal function of `promptbookCli`
+ */
+export declare function initializeTestCommand(program: Program): void;
+/**
+ * TODO: [😶] Unite floder listing
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
+ * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
+ * Note: This is named "test-command.ts" to avoid name collision with jest unit test files
+ */

package/esm/typings/src/cli/main.d.ts

@@ -0,0 +1,16 @@
+import { promptbookCli } from './promptbookCli';
+/**
+ * Note: [🔺] Purpose of this file is to export CLI for production environment
+ */
+/**
+ * Hidden utilities which should not be used by external consumers.
+ *
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _CLI: {
+    _initialize_promptbookCli: typeof promptbookCli;
+};
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
+ */

package/esm/typings/src/cli/promptbookCli.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Runs CLI utilities of Promptbook package
+ *
+ * @private within the `@promptbook/cli`
+ */
+export declare function promptbookCli(): Promise<void>;
+/**
+ * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.book.md` -> `ptbk ./foo.book.md`
+ * TODO: [🥠] Do not export, its just for CLI script
+ * TODO: [🕌] When more functionalities, rename
+ * Note: 11:11
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
+ */

package/esm/typings/src/cli/test/ptbk.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+/**
+ * Note: [🔺] Purpose of this file is to test and use the current CLI in development environment
+ */
+import '../../_packages/cli.index.ts';

package/esm/typings/src/cli/test/ptbk.test.d.ts

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

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

@@ -0,0 +1,27 @@
+import type { Promisable } from 'type-fest';
+import type { PipelineJson } from '../pipeline/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<ReadonlyArray<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
+     *
+     * @deprecated Make better mechanism for skimming the remote server
+     */
+    isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
+};

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

@@ -0,0 +1,37 @@
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { Prompt } from '../types/Prompt';
+import type { string_pipeline_url } from '../types/typeAliases';
+import type { PipelineCollection } from './PipelineCollection';
+/**
+ * Library of pipelines that groups together pipelines for an application.
+ * This implementation is a very thin wrapper around the Array / Map of pipelines.
+ *
+ * @private internal function of `createCollectionFromJson`, use `createCollectionFromJson` instead
+ * @see https://github.com/webgptorg/pipeline#pipeline-collection
+ */
+export declare class SimplePipelineCollection implements PipelineCollection {
+    private collection;
+    /**
+     * Constructs a pipeline collection from pipelines
+     *
+     * @param pipelines @@@
+     *
+     * Note: During the construction logic of all pipelines are validated
+     * Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead
+     */
+    constructor(...pipelines: ReadonlyArray<PipelineJson>);
+    /**
+     * Gets all pipelines in the collection
+     */
+    listPipelines(): ReadonlyArray<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): PipelineJson;
+    /**
+     * Checks whether given prompt was defined in any pipeline in the collection
+     */
+    isResponsibleForPrompt(prompt: Prompt): boolean;
+}

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

@@ -0,0 +1,13 @@
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineCollection } from './PipelineCollection';
+/**
+ * Converts PipelineCollection to serialized JSON
+ *
+ * Note: Functions `collectionToJson` and `createCollectionFromJson` are complementary
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function collectionToJson(collection: PipelineCollection): Promise<ReadonlyArray<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.book.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,65 @@
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import type { string_dirname } from '../../types/typeAliases';
+import type { string_pipeline_root_url } from '../../types/typeAliases';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Options for `createCollectionFromDirectory` function
+ *
+ * Note: `rootDirname` is not needed because it is the folder in which `.book.md` file is located
+ *       This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
+ */
+type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {
+    /**
+     * If true, the directory is searched recursively for pipelines
+     *
+     * @default true
+     */
+    isRecursive?: boolean;
+    /**
+     * If true, the collection creation outputs information about each file it reads
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+    /**
+     * This will be used as a root URL for all pipelines in the collection
+     *
+     * It has 2 purposes:
+     * 1) Every pipeline in the collection is checked if it is a child of `rootUrl`
+     * 2) If the pipeline does not have a URL, it is created from the `rootUrl` and path to the pipeline
+     *
+     * @default false
+     */
+    rootUrl?: string_pipeline_root_url;
+    /**
+     * 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 pipeline
+     * If true and isLazyLoaded is true, the error is thrown on first access to the pipeline
+     *
+     * @default true
+     */
+    isCrashedOnError?: boolean;
+};
+/**
+ * Constructs Pipeline from given directory
+ *
+ * Note: Works only in Node.js environment because it reads the file system
+ *
+ * @param path - path to the directory with pipelines
+ * @param tools - Execution tools to be used for pipeline preparation if needed - If not provided, `$provideExecutionToolsForNode` will be used
+ * @param options - Options for the collection creation
+ * @returns PipelineCollection
+ * @public exported from `@promptbook/node`
+ */
+export declare function createCollectionFromDirectory(path: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
+export {};
+/**
+ * TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed
+ * TODO: Maybe move from `@promptbook/node` to `@promptbook/core` as we removes direct dependency on `fs`
+ */

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,13 @@
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Creates PipelineCollection from array of PipelineJson or PipelineString
+ *
+ * Note: Functions `collectionToJson` and `createCollectionFromJson` are complementary
+ * Note: Syntax, parsing, and logic consistency checks are performed on all sources during build
+ *
+ * @param promptbookSources
+ * @returns PipelineCollection
+ * @public exported from `@promptbook/core`
+ */
+export declare function createCollectionFromJson(...promptbooks: ReadonlyArray<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,23 @@
+import type { PipelineJson } from '../../pipeline/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
+ * @public exported from `@promptbook/core`
+ */
+export declare function createCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<ReadonlyArray<PipelineJson>> | (() => Promise<ReadonlyArray<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
+     */
+    readonly isVerbose?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    readonly isLazyLoaded?: boolean;
+};
+/**
+ * Constructs Promptbook from remote Promptbase URL
+ * @returns PipelineCollection
+ * @public exported from `@promptbook/core`
+ */
+export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
+export {};
+/**
+ * TODO: [main] !!4 [🧠] Library precompilation and do not mix markdown and json promptbooks
+ */