@promptbook/javascript 0.88.0-1

package/esm/typings/src/commands/_common/parseCommand.test.d.ts

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

package/esm/typings/src/commands/_common/stringifyCommand.d.ts

@@ -0,0 +1,12 @@
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { Command } from './types/Command';
+/**
+ * Stringifies the command
+ *
+ * @returns stringified command
+ * @throws {UnexpectedError} if the command is invalid
+ *
+ * @deprecated Option to convert JSON back to string is outdated and will be removed
+ * @private within the compilePipeline
+ */
+export declare function stringifyCommand(command: Command): string_markdown_text;

package/esm/typings/src/commands/_common/stringifyCommand.test.d.ts

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

package/esm/typings/src/commands/_common/types/Command.d.ts

@@ -0,0 +1,6 @@
+import { COMMANDS } from '../../index';
+/**
+ * Command is one piece of the book file section which adds some logic to the task or the whole pipeline.
+ * It is parsed from the markdown from ul/ol items - one command per one item.
+ */
+export type Command = ReturnType<typeof COMMANDS[number]['parse']>;

package/esm/typings/src/commands/_common/types/CommandParser.d.ts

@@ -0,0 +1,197 @@
+import type { SetOptional, WritableDeep } from 'type-fest';
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../../pipeline/PipelineJson/TaskJson';
+import type { string_markdown_text } from '../../../types/typeAliases';
+import type { string_name } from '../../../types/typeAliases';
+import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
+import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
+import type { ___and___ } from '../../../utils/organization/___and___';
+import type { CommandUsagePlace } from './CommandUsagePlaces';
+/**
+ * @@@
+ *
+ * @private just abstract helper for command parsers
+ */
+export type CommandBase = {
+    type: string_name & string_SCREAMING_CASE;
+};
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export type CommandParser<TCommand extends CommandBase> = PipelineHeadCommandParser<TCommand> | PipelineTaskCommandParser<TCommand> | PipelineBothCommandParser<TCommand>;
+/**
+ * @@@
+ *
+ * @private just abstract the common properties of the command parsers
+ */
+export type CommonCommandParser<TCommand extends CommandBase> = {
+    /**
+     * @@@
+     */
+    readonly name: string_name & string_SCREAMING_CASE;
+    /**
+     * @@@
+     */
+    readonly isUsedInPipelineHead: boolean;
+    /**
+     * @@@
+     */
+    readonly isUsedInPipelineTask: boolean;
+    /**
+     * @@@
+     */
+    readonly aliasNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
+    /**
+     * @@@
+     */
+    readonly deprecatedNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
+    /**
+     * @@@
+     */
+    readonly description: string_markdown_text;
+    /**
+     * @@@
+     */
+    readonly documentationUrl: string_promptbook_documentation_url;
+    /**
+     * @@@
+     */
+    readonly examples: ReadonlyArray<string_markdown_text>;
+    /**
+     * @throws {ParseError} if the parsing fails
+     */
+    parse(input: CommandParserInput): TCommand;
+    /**
+     * Converts the command back to string
+     *
+     * Note: This is used in `pipelineJsonToString` utility
+     * @deprecated TODO: [🥍][🧠] Backup original files in `PipelineJson` same as in Promptbook.studio
+     */
+    stringify(command: TCommand): string_markdown_text;
+};
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export type PipelineBothCommandParser<TCommand extends CommandBase> = ___and___ & Omit<PipelineHeadCommandParser<TCommand>, 'isUsedInPipelineTask'> & Omit<PipelineTaskCommandParser<TCommand>, 'isUsedInPipelineHead'>;
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonCommandParser<TCommand> & {
+    /**
+     * @@@
+     */
+    readonly isUsedInPipelineHead: true;
+    /**
+     * @@@
+     */
+    readonly isUsedInPipelineTask: false;
+    /**
+     * Apply the command to the `pipelineJson`
+     *
+     * Note: `$` is used to indicate that this function mutates given `pipelineJson`
+     */
+    $applyToPipelineJson(command: TCommand, $pipelineJson: $PipelineJson): void;
+    /**
+     * Reads the command from the `PipelineJson`
+     *
+     * Note: This is used in `pipelineJsonToString` utility
+     * @deprecated TODO: [🥍][🧠] Backup original files in `PipelineJson` same as in Promptbook.studio
+     */
+    takeFromPipelineJson(pipelineJson: PipelineJson): ReadonlyArray<TCommand>;
+};
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export type PipelineTaskCommandParser<TCommand extends CommandBase> = CommonCommandParser<TCommand> & {
+    /**
+     * @@@
+     */
+    readonly isUsedInPipelineHead: false;
+    /**
+     * @@@
+     */
+    readonly isUsedInPipelineTask: true;
+    /**
+     * Apply the command to the `pipelineJson`
+     *
+     * Note: `$` is used to indicate that this function mutates given `taskJson` and/or `pipelineJson`
+     */
+    $applyToTaskJson(command: TCommand, $taskJson: $TaskJson, $pipelineJson: $PipelineJson): void;
+    /**
+     * Reads the command from the `TaskJson`
+     *
+     * Note: This is used in `pipelineJsonToString` utility
+     */
+    takeFromTaskJson($taskJson: $TaskJson): ReadonlyArray<TCommand>;
+};
+/**
+ * @@@
+ *
+ * Note: `$` is used to indicate that purpose of this type is to mutate the given object
+ *
+ * @private internal helper for command parsers
+ */
+export type $TaskJson = {
+    isSectionTypeSet: boolean;
+    isTask: boolean;
+} & Partial<WritableDeep<TaskJson>>;
+/**
+ * @@@
+ *
+ *  Note: `$` is used to indicate that purpose of this type is to mutate the given object
+ *
+ * @private internal helper for command parsers
+ */
+export type $PipelineJson = WritableDeep<SetOptional<PipelineJson, 'formfactorName'>>;
+/**
+ * @@@
+ */
+export type CommandParserInput = {
+    /**
+     * @@@
+     *
+     * @example 'PIPELINE_HEAD'
+     * @example 'PIPELINE_TASK'
+     */
+    readonly usagePlace: CommandUsagePlace;
+    /**
+     * @@@
+     *
+     * @example 'promptbook version 0.62.0'
+     * @example 'FOREACH Text Line `{customers}` -> `{customer}`'
+     */
+    readonly raw: string_markdown_text;
+    /**
+     * @@@
+     *
+     * @example '0.62.0'
+     * @example 'List Line `{customers}` -> `{customer}`'
+     */
+    readonly rawArgs: string_markdown_text;
+    /**
+     * @@@
+     *
+     * @example 'PROMPTBOOK_ENGINE_VERSION_0_62_0'
+     * @example 'FOREACH_LIST_LINE_CUSTOMERS_CUSTOMER'
+     */
+    readonly normalized: string_name & string_SCREAMING_CASE;
+    /**
+     * @@@
+     *
+     * @example [ '0.62.0' ]
+     * @example [ 'List', 'Line', '{customers}', '', '{customer}' ]
+     */
+    readonly args: Array<string_name>;
+};
+/**
+ * TODO: [♓️] Add order here
+ * TODO: [🧠][🍱] Maybe make some common abstraction between `HighLevelAbstraction` and `CommandParser`
+ */

package/esm/typings/src/commands/_common/types/CommandType.d.ts

@@ -0,0 +1,17 @@
+import type { Command } from './Command';
+/**
+ * Command is one piece of the book file section which adds some logic to the task or the whole pipeline.
+ * It is parsed from the markdown from ul/ol items - one command per one item.
+ *
+ * This is a type of the command like "KNOWLEDGE" or "PERSONA"
+ */
+export type CommandType = Command['type'];
+/**
+ * Command is one piece of the book file section which adds some logic to the task or the whole pipeline.
+ * It is parsed from the markdown from ul/ol items - one command per one item.
+ *
+ * This is a type of the command like "KNOWLEDGE" or "PERSONA"
+ *
+ex--rt type CommandTypeOrAlias = Command['type'] | Command['aliasNames'] | Command['deprecatedNames'];
+// <- TODO: [🧘] Implement
+*/

package/esm/typings/src/commands/_common/types/CommandUsagePlaces.d.ts

@@ -0,0 +1,13 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Where the command can be used
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export type CommandUsagePlace = TupleToUnion<typeof CommandUsagePlaces>;
+/**
+ * Where the command can be used
+ *
+ * @private internal base for `CommandUsagePlace`
+ */
+export declare const CommandUsagePlaces: readonly ["PIPELINE_HEAD", "PIPELINE_TASK"];

package/esm/typings/src/commands/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * All available command parsers
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export declare const COMMANDS: readonly [import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./SECTION/SectionCommand").SectionCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./EXPECT/ExpectCommand").ExpectCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./FORMAT/FormatCommand").FormatCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./JOKER/JokerCommand").JokerCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./MODEL/ModelCommand").ModelCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PARAMETER/ParameterCommand").ParameterCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./POSTPROCESS/PostprocessCommand").PostprocessCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./BOOK_VERSION/BookVersionCommand").BookVersionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./FORMFACTOR/FormfactorCommand").FormfactorCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./URL/UrlCommand").UrlCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./KNOWLEDGE/KnowledgeCommand").KnowledgeCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_ACTION/ActionCommand").ActionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_INSTRUMENT/InstrumentCommand").InstrumentCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PERSONA/PersonaCommand").PersonaCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./FOREACH/ForeachCommand").ForeachCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./_BOILERPLATE/BoilerplateCommand").BoilerplateCommand>];
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,285 @@
+import type { CsvSettings } from './formats/csv/CsvSettings';
+import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
+import type { string_email } from './types/typeAliases';
+import type { string_name } from './types/typeAliases';
+import type { string_url_image } 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";
+/**
+ * Logo for the light theme
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const LOGO_LIGHT_SRC: string_url_image;
+/**
+ * Logo for the dark theme
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const LOGO_DARK_SRC: string_url_image;
+/**
+ * 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;
+/**
+ * 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";
+/**
+ * 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)";
+};
+/**
+ * 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 = 3;
+/**
+ * @@@
+ * TODO: [🐝][main] !!3 Use
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
+/**
+ * @@@
+ * TODO: [🐝][main] !!3 Use
+ *
+ * @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";
+/**
+ * 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;
+};
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_REMOTE_URL = "https://api.pavolhejny.com/";
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_REMOTE_URL_PATH = "/promptbook/socket.io";
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_CSV_SETTINGS: CsvSettings;
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare let DEFAULT_IS_VERBOSE: boolean;
+/**
+ * @@@
+ *
+ * Note: This is experimental feature
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function SET_IS_VERBOSE(isVerbose: boolean): void;
+/**
+ * @@@
+ *
+ * @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";
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare const IS_COST_PREVENTED: boolean;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl 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,35 @@
+import type { PipelineJson } from './pipeline/PipelineJson/PipelineJson';
+import type { ExportJsonOptions } from './utils/serialization/exportJson';
+/**
+ * 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";
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare const RESERVED_PARAMETER_MISSING_VALUE: string;
+/**
+ * @@@
+ *
+ * @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 { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { string_filename } from '../../types/typeAliases';
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+/**
+ * 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 Prompbook
+ */
+export declare function loadArchive(filePath: string_filename, fs: FilesystemTools): Promise<Array<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 { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { string_filename } from '../../types/typeAliases';
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+/**
+ * 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 Prompbook
+ */
+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`
+ */