@promptbook/components 0.100.0-24

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

@@ -0,0 +1,313 @@
+import type { CsvSettings } from './formats/csv/CsvSettings';
+import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
+import type { string_app_id } from './types/typeAliases';
+import type { string_email } from './types/typeAliases';
+import type { string_name } from './types/typeAliases';
+import type { string_promptbook_server_url } from './types/typeAliases';
+/**
+ * Warning message for the generated sections and files files
+ *
+ * @private within the repository
+ */
+export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has been generated so that any manual changes will be overwritten";
+/**
+ * Name for the Promptbook
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const NAME = "Promptbook";
+/**
+ * Email of the responsible person
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ADMIN_EMAIL: string_email;
+/**
+ * Name of the responsible person for the Promptbook on GitHub
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ADMIN_GITHUB_NAME: string_name;
+/**
+ * Claim for the Promptbook
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const CLAIM = "It's time for a paradigm shift. The future of software in plain English, French or Latin";
+/**
+ * When the title is not provided, the default title is used
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_BOOK_TITLE = "\u2728 Untitled Book";
+/**
+ * When the title of task is not provided, the default title is used
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_TASK_TITLE = "Task";
+/**
+ * When the title of the prompt task is not provided, the default title is used
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_PROMPT_TASK_TITLE = "Prompt";
+/**
+ * When the pipeline is flat and no name of return parameter is provided, this name is used
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_BOOK_OUTPUT_PARAMETER_NAME = "result";
+/**
+ * Maximum file size limit
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_MAX_FILE_SIZE: number;
+/**
+ * Threshold value that determines when a dataset is considered "big"
+ * and may require special handling or optimizations
+ *
+ * For example, when error occurs in one item of the big dataset, it will not fail the whole pipeline
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const BIG_DATASET_TRESHOLD = 50;
+/**
+ * Placeholder text used to represent a placeholder value of failed operation
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const FAILED_VALUE_PLACEHOLDER = "!?";
+/**
+ * Placeholder text used to represent operations or values that are still in progress
+ * or awaiting completion in UI displays and logging
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PENDING_VALUE_PLACEHOLDER = "\u2026";
+/**
+ * Warning message for the generated sections and files files
+ *
+ * @private within the repository
+ */
+export declare const GENERATOR_WARNING_BY_PROMPTBOOK_CLI = "\u26A0\uFE0F WARNING: This code has been generated by `@promptbook/cli` so that any manual changes will be overwritten";
+/**
+ * Warning message for the automatically generated sections of `.env` files
+ *
+ * @private within the repository
+ */
+export declare const GENERATOR_WARNING_IN_ENV = "Note: Added by Promptbook";
+/**
+ * The maximum number of iterations for a loops
+ *
+ * @private within the repository - too low-level in comparison with other `MAX_...`
+ */
+export declare const LOOP_LIMIT = 1000;
+/**
+ * The maximum number of iterations for a loops which adds characters one by one
+ *
+ * @private within the repository - too low-level in comparison with other `MAX_...`
+ */
+export declare const CHARACTER_LOOP_LIMIT = 100000;
+/**
+ * Strings to represent various values in the context of parameter values
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const VALUE_STRINGS: {
+    readonly empty: "(nothing; empty string)";
+    readonly null: "(no value; null)";
+    readonly undefined: "(unknown value; undefined)";
+    readonly nan: "(not a number; NaN)";
+    readonly infinity: "(infinity; ∞)";
+    readonly negativeInfinity: "(negative infinity; -∞)";
+    readonly unserializable: "(unserializable value)";
+    readonly circular: "(circular JSON)";
+};
+/**
+ * Small number limit
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const SMALL_NUMBER = 0.001;
+/**
+ * Timeout for the connections in milliseconds
+ *
+ * @private within the repository - too low-level in comparison with other `MAX_...`
+ */
+export declare const CONNECTION_TIMEOUT_MS: number;
+/**
+ * How many times to retry the connections
+ *
+ * @private within the repository - too low-level in comparison with other `MAX_...`
+ */
+export declare const CONNECTION_RETRIES_LIMIT = 5;
+/**
+ * Short time interval to prevent race conditions in milliseconds
+ *
+ * @private within the repository - too low-level in comparison with other `MAX_...`
+ */
+export declare const IMMEDIATE_TIME = 10;
+/**
+ * The maximum length of the (generated) filename
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MAX_FILENAME_LENGTH = 30;
+/**
+ * Strategy for caching the intermediate results for knowledge sources
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_INTERMEDIATE_FILES_STRATEGY: IntermediateFilesStrategy;
+/**
+ * The maximum number of (LLM) tasks running in parallel
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_MAX_PARALLEL_COUNT = 5;
+/**
+ * The maximum number of attempts to execute LLM task before giving up
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_MAX_EXECUTION_ATTEMPTS = 7;
+/**
+ * The maximum depth to which knowledge sources will be scraped when building a knowledge base.
+ * This prevents infinite recursion and limits resource usage.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
+/**
+ * The maximum total number of knowledge sources that will be scraped in a single operation.
+ * This acts as a global limit to avoid excessive resource consumption.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
+/**
+ * Where to store your books
+ * This is kind of a "src" for your books
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_BOOKS_DIRNAME = "./books";
+/**
+ * Where to store the temporary downloads
+ *
+ * Note: When the folder does not exist, it is created recursively
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_DOWNLOAD_CACHE_DIRNAME = "./.promptbook/download-cache";
+/**
+ * Where to store the cache of executions for promptbook CLI
+ *
+ * Note: When the folder does not exist, it is created recursively
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_EXECUTION_CACHE_DIRNAME = "./.promptbook/execution-cache";
+/**
+ * Where to store the scrape cache
+ *
+ * Note: When the folder does not exist, it is created recursively
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_SCRAPE_CACHE_DIRNAME = "./.promptbook/scrape-cache";
+/**
+ * Id of application for the CLI when using remote server
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const CLI_APP_ID: string_app_id;
+/**
+ * Id of application for the playground
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PLAYGROUND_APP_ID: string_app_id;
+/**
+ * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME = "index";
+/**
+ * The thresholds for the relative time in the `moment` NPM package.
+ *
+ * @see https://momentjscom.readthedocs.io/en/latest/moment/07-customization/13-relative-time-threshold/
+ * @private within the repository - too low-level in comparison with other constants
+ */
+export declare const MOMENT_ARG_THRESHOLDS: {
+    readonly ss: 3;
+};
+/**
+ * Default remote server URL for the Promptbook
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_REMOTE_SERVER_URL: string_promptbook_server_url;
+/**
+ * Default settings for parsing and generating CSV files in Promptbook.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_CSV_SETTINGS: CsvSettings;
+/**
+ * Controls whether verbose logging is enabled by default throughout the application.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare let DEFAULT_IS_VERBOSE: boolean;
+/**
+ * Enables or disables verbose logging globally at runtime.
+ *
+ * Note: This is an experimental feature.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function SET_IS_VERBOSE(isVerbose: boolean): void;
+/**
+ * Controls whether auto-installation of dependencies is enabled by default.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_IS_AUTO_INSTALLED = false;
+/**
+ * Function name for generated function via `ptbk make` to get the pipeline collection
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME = "getPipelineCollection";
+/**
+ * Default rate limits (requests per minute)
+ *
+ * Note: Adjust based on the provider tier you are have
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_MAX_REQUESTS_PER_MINUTE = 60;
+/**
+ * Indicates whether pipeline logic validation is enabled. When true, the pipeline logic is checked for consistency.
+ *
+ * @private within the repository
+ */
+export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
+/**
+ * Indicates whether cost-prevention is enabled. When true, real API keys are prevented from being used in tests.
+ *
+ * @private within the repository
+ */
+export declare const IS_COST_PREVENTED: boolean;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteServerUrl and path into single value
+ */

package/esm/typings/src/config.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] Maybe more elegant how to prevent accidental costs
+ */

package/esm/typings/src/constants.d.ts

@@ -0,0 +1,76 @@
+import type { PipelineJson } from './pipeline/PipelineJson/PipelineJson';
+import type { ExportJsonOptions } from './utils/serialization/exportJson';
+/**
+ * How is the model provider trusted?
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MODEL_TRUST_LEVELS: {
+    readonly FULL: "Model is running on the local machine, training data and model weights are known, data are ethically sourced";
+    readonly OPEN: "Model is open source, training data and model weights are known";
+    readonly PARTIALLY_OPEN: "Model is open source, but training data and model weights are not (fully) known";
+    readonly CLOSED_LOCAL: "Model can be run locally, but it is not open source";
+    readonly CLOSED_FREE: "Model is behind API gateway but free to use";
+    readonly CLOSED_BUSINESS: "Model is behind API gateway and paid but has good SLA, TOS, privacy policy and in general is a good to use in business applications";
+    readonly CLOSED: "Model is behind API gateway and paid";
+    readonly UNTRUSTED: "Model has questions about the training data and ethics, but it is not known if it is a problem or not";
+    readonly VURNABLE: "Model has some known serious vulnerabilities, leaks, ethical problems, etc.";
+};
+/**
+ * How is the model provider important?
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MODEL_ORDERS: {
+    /**
+     * Top-tier models, e.g. OpenAI, Anthropic,...
+     */
+    readonly TOP_TIER: 333;
+    /**
+     * Mid-tier models, e.g. Llama, Mistral, etc.
+     */
+    readonly NORMAL: 100;
+    /**
+     * Low-tier models, e.g. Phi, Tiny, etc.
+     */
+    readonly LOW_TIER: 0;
+};
+/**
+ * Order of keys in the pipeline JSON
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ORDER_OF_PIPELINE_JSON: ExportJsonOptions<PipelineJson>['order'];
+/**
+ * Nonce which is used for replacing things in strings
+ *
+ * @private within the repository
+ */
+export declare const REPLACING_NONCE = "ptbkauk42kV2dzao34faw7FudQUHYPtW";
+/**
+ * Nonce which is used as string which is not occurring in normal text
+ *
+ * @private within the repository
+ */
+export declare const SALT_NONCE = "ptbkghhewbvruets21t54et5";
+/**
+ * Placeholder value indicating a parameter is missing its value.
+ *
+ * @private within the repository
+ */
+export declare const RESERVED_PARAMETER_MISSING_VALUE: string;
+/**
+ * Placeholder value indicating a parameter is restricted and cannot be used directly.
+ *
+ * @private within the repository
+ */
+export declare const RESERVED_PARAMETER_RESTRICTED: string;
+/**
+ * The names of the parameters that are reserved for special purposes
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const RESERVED_PARAMETER_NAMES: readonly ["content", "context", "knowledge", "examples", "modelName", "currentDate"];
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/conversion/archive/loadArchive.d.ts

@@ -0,0 +1,16 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { string_filename } from '../../types/typeAliases';
+/**
+ * Loads the books from the archive file with `.bookc` extension
+ *
+ * @param filePath Path to the archive file with `.bookc` extension
+ * @param fs Filesystem tools
+ * @returns Pipelines loaded from the archive
+ *
+ * @private utility of Promptbook
+ */
+export declare function loadArchive(filePath: string_filename, fs: FilesystemTools): Promise<ReadonlyArray<PipelineJson>>;
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/conversion/archive/saveArchive.d.ts

@@ -0,0 +1,18 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { string_filename } from '../../types/typeAliases';
+/**
+ * Saves the given books into an archive file with `.bookc` extension
+ *
+ * @param filePath Path to the archive file with `.bookc` extension
+ * @param books Pipelines to be saved in the archive
+ * @param fs Filesystem tools
+ *
+ * @private utility of Promptbook
+ */
+export declare function saveArchive(filePath: string_filename, collectionJson: ReadonlyArray<PipelineJson>, fs: FilesystemTools): Promise<void>;
+/**
+ * TODO: Add metadata to zip
+ * TODO: Compression level and other zip options from config
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/conversion/compilePipeline.d.ts

@@ -0,0 +1,25 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
+import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
+/**
+ * Compile pipeline from string (markdown) format to JSON format
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
+ *
+ * Note: This function does not validate logic of the pipeline only the parsing
+ * Note: This function acts as compilation process
+ *
+ * @param pipelineString {Promptbook} in string markdown format (.book.md)
+ * @param tools - Tools for the preparation and scraping - if not provided together with `llm`, the preparation will be skipped
+ * @param options - Options and tools for the compilation
+ * @returns {Promptbook} compiled in JSON format (.bookc)
+ * @throws {ParseError} if the promptbook string is not valid
+ * @public exported from `@promptbook/core`
+ */
+export declare function compilePipeline(pipelineString: PipelineString, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
+/**
+ * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ * TODO: [🧠] Should be in generated JSON file GENERATOR_WARNING
+ */

package/esm/typings/src/conversion/compilePipeline.test.d.ts

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

package/esm/typings/src/conversion/compilePipelineOnRemoteServer.d.ts

@@ -0,0 +1,21 @@
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
+import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOptions';
+/**
+ * Compile pipeline from string (markdown) format to JSON format
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
+ *
+ * Note: This function does not validate logic of the pipeline only the parsing
+ * Note: This function acts as compilation process
+ *
+ * @param pipelineString {Promptbook} in string markdown format (.book.md)
+ * @param options - Configuration of the remote server
+ * @returns {Promptbook} compiled in JSON format (.bookc)
+ * @throws {ParseError} if the promptbook string is not valid
+ * @public exported from `@promptbook/remote-client`
+ */
+export declare function compilePipelineOnRemoteServer<TCustomOptions = undefined>(pipelineString: PipelineString, options: RemoteClientOptions<TCustomOptions>): Promise<PipelineJson>;
+/**
+ * TODO: [🐚] Do not return `Promise<PipelineJson>` But `PreparationTask`
+ */

package/esm/typings/src/conversion/parsePipeline.d.ts

@@ -0,0 +1,30 @@
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
+/**
+ * Compile pipeline from string (markdown) format to JSON format synchronously
+ *
+ * Note: There are 3 similar functions:
+ * - `compilePipeline` **(preferred)** - which properly compiles the promptbook and uses embedding for external knowledge
+ * - `parsePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `preparePipeline` - just one step in the compilation process
+ *
+ * Note: This function does not validate logic of the pipeline only the parsing
+ * Note: This function acts as compilation process
+ *
+ * @param pipelineString {Promptbook} in string markdown format (.book.md)
+ * @returns {Promptbook} compiled in JSON format (.bookc)
+ * @throws {ParseError} if the promptbook string is not valid
+ * @public exported from `@promptbook/core`
+ */
+export declare function parsePipeline(pipelineString: PipelineString): PipelineJson;
+/**
+ * TODO: [🧠] Maybe more things here can be refactored as high-level abstractions
+ * TODO: [main] !!4 Warn if used only sync version
+ * TODO: [🚞] Report here line/column of error
+ * TODO: Use spaceTrim more effectively
+ * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
+ * TODO: [🥞] Not optimal parsing because `splitMarkdownIntoSections` is executed twice with same string, once through `flattenMarkdown` and second directly here
+ * TODO: [♈] Probably move expectations from tasks to parameters
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ * TODO: [🍙] Make some standard order of json properties
+ */

package/esm/typings/src/conversion/parsePipeline.test.d.ts

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

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

@@ -0,0 +1,18 @@
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
+/**
+ * Converts promptbook in JSON format to string format
+ *
+ * @deprecated TODO: [🥍][🧠] Backup original files in `PipelineJson` same as in Promptbook.studio
+ * @param pipelineJson Promptbook in JSON format (.bookc)
+ * @returns Promptbook in string format (.book.md)
+ * @public exported from `@promptbook/core`
+ */
+export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
+/**
+ * TODO: [🛋] Implement new features and commands into `pipelineJsonToString` + `taskParameterJsonToString` , use `stringifyCommand`
+ * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
+ * TODO: [🏛] Maybe make some markdown builder
+ * TODO: [🏛] Escape all
+ * TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
+ */

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

@@ -0,0 +1,13 @@
+/**
+ * Options for `prettifyPipelineString` function
+ */
+export type PrettifyOptions = {
+    /***
+     * If true, adds Mermaid graph to the Promptbook string
+     */
+    readonly isGraphAdded?: boolean;
+    /**
+     * If true, the string is prettifyed as markdown
+     */
+    readonly isPrettifyed?: boolean;
+};

package/esm/typings/src/conversion/prettify/prettifyPipelineString.d.ts

@@ -0,0 +1,12 @@
+import type { PipelineString } from '../../pipeline/PipelineString';
+import type { PrettifyOptions } from './PrettifyOptions';
+/**
+ * Prettyfies Promptbook string and adds Mermaid graph
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function prettifyPipelineString(pipelineString: PipelineString, options: PrettifyOptions): Promise<PipelineString>;
+/**
+ * TODO: Maybe use some Mermaid package instead of string templating
+ * TODO: [🕌] When more than 2 functionalities, split into separate functions
+ */

package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts

@@ -0,0 +1,30 @@
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { string_href } from '../../types/typeAliases';
+/**
+ * Additional options for rendering Mermaid graph
+ */
+export type renderPipelineMermaidOptions = {
+    /**
+     * Callback for creating from task graph node
+     */
+    linkTask?(task: TaskJson): {
+        href: string_href;
+        title: string;
+    } | null;
+};
+/**
+ * Creates a Mermaid graph based on the promptbook
+ *
+ * Note: The result is not wrapped in a Markdown code block
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function renderPromptbookMermaid(pipelineJson: PipelineJson, options?: renderPipelineMermaidOptions): string;
+/**
+ * TODO: [🧠] FOREACH in mermaid graph
+ * TODO: [🧠] Knowledge in mermaid graph
+ * TODO: [🧠] Personas in mermaid graph
+ * TODO: Maybe use some Mermaid package instead of string templating
+ * TODO: [🕌] When more than 2 functionalities, split into separate functions
+ */

package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.d.ts

@@ -0,0 +1,15 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { string_parameter_name } from '../../types/typeAliases';
+/**
+ * Parses the task and returns the set of all used parameters
+ *
+ * @param task the task with used parameters
+ * @returns the set of parameter names
+ * @throws {ParseError} if the script is invalid
+ * @public exported from `@promptbook/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
+ */
+export declare function extractParameterNamesFromTask(task: ReadonlyDeep<Pick<TaskJson, 'title' | 'description' | 'taskType' | 'content' | 'preparedContent' | 'jokerParameterNames' | 'foreach'>>): Set<string_parameter_name>;
+/**
+ * TODO: [🔣] If script require contentLanguage
+ */

package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.test.d.ts

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

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

@@ -0,0 +1,23 @@
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../../pipeline/PipelineString';
+/**
+ * Import the pipeline.book or pipeline.bookc 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 examples/pipelines directory
+ * @private internal function of tests
+ */
+export declare function importPipelineWithoutPreparation(path: `${string}.book`): Promise<PipelineString>;
+export declare function importPipelineWithoutPreparation(path: `${string}.bookc`): Promise<PipelineJson>;
+/**
+ * Import the pipeline.bookc file as parsed JSON
+ *
+ * @private internal function of tests
+ */
+export declare function importPipelineJson(path: `${string}.bookc`): Promise<PipelineJson>;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/conversion/validation/pipelineStringToJson-parseErrors.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🚏] DRY
+ */

package/esm/typings/src/conversion/validation/validatePipeline-logicErrors.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🚏] DRY
+ */