@promptbook/legacy-documents 0.71.0-12

package/esm/typings/src/llm-providers/openai/computeUsage.d.ts

@@ -0,0 +1,16 @@
+/**
+ * String value found on OpenAI and Anthropic Claude page
+ *
+ * @see https://openai.com/api/pricing/
+ * @see https://docs.anthropic.com/en/docs/models-overview
+ *
+ * @private within the repository, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
+ */
+type string_model_price = `$${number}.${number} / ${number}M tokens`;
+/**
+ * Function computeUsage will create price per one token based on the string value found on openai page
+ *
+ * @private within the repository, used only as internal helper for `OPENAI_MODELS`
+ */
+export declare function computeUsage(value: string_model_price): number;
+export {};

package/esm/typings/src/llm-providers/openai/computeUsage.test.d.ts

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

package/esm/typings/src/llm-providers/openai/createOpenAiExecutionTools.d.ts

@@ -0,0 +1,15 @@
+import { OpenAiExecutionTools } from './OpenAiExecutionTools';
+import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
+/**
+ * Execution Tools for calling OpenAI API
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare const createOpenAiExecutionTools: ((options: OpenAiExecutionToolsOptions) => OpenAiExecutionTools) & {
+    packageName: string;
+    className: string;
+};
+/**
+ * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/llm-providers/openai/openai-models.d.ts

@@ -0,0 +1,30 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { number_usd } from '../../types/typeAliases';
+/**
+ * List of available OpenAI models with pricing
+ *
+ * Note: Done at 2024-05-20
+ *
+ * @see https://platform.openai.com/docs/models/
+ * @see https://openai.com/api/pricing/
+ * @public exported from `@promptbook/openai`
+ */
+export declare const OPENAI_MODELS: Array<AvailableModel & {
+    pricing?: {
+        readonly prompt: number_usd;
+        readonly output: number_usd;
+    };
+}>;
+/**
+ * Note: [🤖] Add models of new variant
+ * TODO: [🧠] Some mechanism to propagate unsureness
+ * TODO: [🎰] Some mechanism to auto-update available models
+ * TODO: [🎰][👮‍♀️] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
+ * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
+ * @see https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4
+ * @see https://openai.com/api/pricing/
+ * @see /other/playground/playground.ts
+ * TODO: [🍓] Make better
+ * TODO: Change model titles to human eg: "gpt-4-turbo-2024-04-09" -> "GPT-4 Turbo (2024-04-09)"
+ * TODO: [🚸] Not all models are compatible with JSON mode, add this information here and use it
+ */

package/esm/typings/src/llm-providers/openai/playground/playground.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/llm-providers/openai/register-configuration.d.ts

@@ -0,0 +1,10 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiMetadataRegistration: Registration;

package/esm/typings/src/llm-providers/openai/register-constructor.d.ts

@@ -0,0 +1,13 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/openai`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts

@@ -0,0 +1,63 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { ChatPromptResult } from '../../execution/PromptResult';
+import type { CompletionPromptResult } from '../../execution/PromptResult';
+import type { EmbeddingPromptResult } from '../../execution/PromptResult';
+import type { ChatPrompt } from '../../types/Prompt';
+import type { CompletionPrompt } from '../../types/Prompt';
+import type { EmbeddingPrompt } from '../../types/Prompt';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
+import type { RemoteLlmExecutionToolsOptions } from './interfaces/RemoteLlmExecutionToolsOptions';
+/**
+ * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
+ *
+ * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
+ * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
+ *
+ * @see https://github.com/webgptorg/promptbook#remote-server
+ * @public exported from `@promptbook/remote-client`
+ */
+export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
+    private readonly options;
+    constructor(options: RemoteLlmExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * Check the configuration of all execution tools
+     */
+    checkConfiguration(): Promise<void>;
+    /**
+     * List all available models that can be used
+     */
+    listModels(): Promise<Array<AvailableModel>>;
+    /**
+     * Creates a connection to the remote proxy server.
+     */
+    private makeConnection;
+    /**
+     * Calls remote proxy server to use a chat model
+     */
+    callChatModel(prompt: ChatPrompt): Promise<ChatPromptResult>;
+    /**
+     * Calls remote proxy server to use a completion model
+     */
+    callCompletionModel(prompt: CompletionPrompt): Promise<CompletionPromptResult>;
+    /**
+     * Calls remote proxy server to use a embedding model
+     */
+    callEmbeddingModel(prompt: EmbeddingPrompt): Promise<EmbeddingPromptResult>;
+    /**
+     * Calls remote proxy server to use both completion or chat model
+     */
+    private callCommonModel;
+}
+/**
+ * TODO: Maybe use `$asDeeplyFrozenSerializableJson`
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [🍓] Allow to list compatible models with each variant
+ * TODO: [🗯] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
+ * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
+ * TODO: [🧠] Maybe remove `@promptbook/remote-client` and just use `@promptbook/core`
+ */

package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Error.d.ts

@@ -0,0 +1,7 @@
+import type { ErrorJson } from '../../../errors/utils/ErrorJson';
+/**
+ * Socket.io error for remote text generation
+ *
+ * This is sent from server to client when error occurs and stops the process
+ */
+export type PromptbookServer_Error = ErrorJson;

package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts

@@ -0,0 +1,29 @@
+import type { LlmToolsConfiguration } from '../../_common/register/LlmToolsConfiguration';
+/**
+ * Socket.io progress for remote text generation
+ *
+ * This is a request from client to server
+ */
+export type PromptbookServer_ListModels_Request = PromptbookServer_ListModels_CollectionRequest | PromptbookServer_ListModels_AnonymousRequest;
+export type PromptbookServer_ListModels_CollectionRequest = {
+    /**
+     * Collection mode
+     */
+    isAnonymous: false;
+};
+export type PromptbookServer_ListModels_AnonymousRequest = {
+    /**
+     * Anonymous mode
+     */
+    isAnonymous: true;
+    /**
+     * Configuration for the LLM tools
+     */
+    readonly llmToolsConfiguration: LlmToolsConfiguration;
+};
+/**
+ * TODO: [👡] DRY `PromptbookServer_Prompt_Request` and `PromptbookServer_ListModels_Request`
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [🧠][🤺] Pass `userId` in `PromptbookServer_ListModels_Request`
+ * TODO: [👒] Listing models (and checking configuration) probbably should go through REST API not Socket.io
+ */

package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts

@@ -0,0 +1,15 @@
+import type { AvailableModel } from '../../../execution/AvailableModel';
+/**
+ * Socket.io error for remote text generation
+ *
+ * This is sent from server to client when models are listed
+ */
+export interface PromptbookServer_ListModels_Response {
+    /**
+     * Available models that can be used
+     */
+    models: Array<AvailableModel>;
+}
+/**
+ * TODO: [👒] Listing models (and checking configuration) probbably should go through REST API not Socket.io
+ */ 

package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Progress.d.ts

@@ -0,0 +1,12 @@
+import type { TaskProgress } from '../../../types/TaskProgress';
+/**
+ * Socket.io progress for remote text generation
+ *
+ * This is sent from server to client arbitrarily and may be sent multiple times
+ */
+export type PromptbookServer_Prompt_Progress = {
+    /**
+     * The progress of text generation
+     */
+    readonly taskProgress: TaskProgress;
+};

package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts

@@ -0,0 +1,51 @@
+import type { Prompt } from '../../../types/Prompt';
+import type { string_user_id } from '../../../types/typeAliases';
+import type { LlmToolsConfiguration } from '../../_common/register/LlmToolsConfiguration';
+/**
+ * Socket.io progress for remote text generation
+ *
+ * This is a request from client to server
+ */
+export type PromptbookServer_Prompt_Request = PromptbookServer_Prompt_CollectionRequest | PromptbookServer_Prompt_AnonymousRequest;
+export type PromptbookServer_Prompt_CollectionRequest = {
+    /**
+     * Collection mode
+     */
+    readonly isAnonymous: false;
+    /**
+     * Identifier of the end user
+     *
+     * Note: this is passed to the certain model providers to identify misuse
+     * Note: In anonymous mode it is not required to identify
+     */
+    readonly userId: string_user_id;
+    /**
+     * The Prompt to execute
+     */
+    readonly prompt: Prompt;
+};
+export type PromptbookServer_Prompt_AnonymousRequest = {
+    /**
+     * Anonymous mode
+     */
+    readonly isAnonymous: true;
+    /**
+     * Identifier of the end user
+     *
+     * Note: this is passed to the certain model providers to identify misuse
+     * Note: In anonymous mode it is not required to identify
+     */
+    readonly userId?: string_user_id;
+    /**
+     * Configuration for the LLM tools
+     */
+    readonly llmToolsConfiguration: LlmToolsConfiguration;
+    /**
+     * The Prompt to execute
+     */
+    readonly prompt: Prompt;
+};
+/**
+ * TODO: [👡] DRY `PromptbookServer_Prompt_Request` and `PromptbookServer_ListModels_Request`
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ */

package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Response.d.ts

@@ -0,0 +1,12 @@
+import type { PromptResult } from '../../../execution/PromptResult';
+/**
+ * Socket.io error for remote text generation
+ *
+ * This is sent from server to client when the generated text is completed
+ */
+export interface PromptbookServer_Prompt_Response {
+    /**
+     * The result of the prompt
+     */
+    promptResult: PromptResult;
+}

package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts

@@ -0,0 +1,59 @@
+import type { CommonToolsOptions } from '../../../execution/CommonToolsOptions';
+import type { string_base_url } from '../../../types/typeAliases';
+import type { string_uri } from '../../../types/typeAliases';
+import type { string_user_id } from '../../../types/typeAliases';
+import type { LlmToolsConfiguration } from '../../_common/register/LlmToolsConfiguration';
+/**
+ * Options for `RemoteLlmExecutionTools`
+ *
+ * @public exported from `@promptbook/remote-client`
+ */
+export type RemoteLlmExecutionToolsOptions = CommonToolsOptions & {
+    /**
+     * URL of the remote PROMPTBOOK server
+     * On this server will be connected to the socket.io server
+     */
+    readonly remoteUrl: string_base_url;
+    /**
+     * Path for the Socket.io server to listen
+     *
+     * @default '/socket.io'
+     * @example '/promptbook/socket.io'
+     */
+    readonly path: string_uri;
+    /**
+     * Mode of the server to connect to
+     */
+    isAnonymous: boolean;
+} & ({
+    /**
+     * Use anonymous server with anonymous mode
+     */
+    isAnonymous: true;
+    /**
+     * Configuration for the LLM tools
+     */
+    readonly llmToolsConfiguration: LlmToolsConfiguration;
+    /**
+     * Identifier of the end user
+     *
+     * Note: this is passed to the certain model providers to identify misuse
+     * Note: In anonymous mode it is not required to identify
+     */
+    readonly userId?: string_user_id;
+} | {
+    /**
+     * Use anonymous server with client identification and fixed collection
+     */
+    isAnonymous: false;
+    /**
+     * Identifier of the end user
+     *
+     * Note: this is passed to the certain model providers to identify misuse
+     */
+    readonly userId: string_user_id;
+});
+/**
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ */

package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts

@@ -0,0 +1,58 @@
+import type { PipelineCollection } from '../../../collection/PipelineCollection';
+import type { CommonToolsOptions } from '../../../execution/CommonToolsOptions';
+import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { string_uri } from '../../../types/typeAliases';
+import type { string_user_id } from '../../../types/typeAliases';
+/**
+ * @@@
+ *
+ * There are two modes of remote server:
+ *
+ * 1) **Collection mode** Server will recieve `collection` and execute prompts only from this collection
+ * 2) **Anonymous mode** Server will recieve full `LlmToolsConfiguration` (with api keys) and just acts as a proxy
+ *    In anonymous mode, `collection` will be ignored and any prompt will be executed
+ *
+ * You can enable both modes at the same time.
+ *
+ * @public exported from `@promptbook/remote-client`
+ * @public exported from `@promptbook/remote-server`
+ */
+export type RemoteServerOptions = CommonToolsOptions & {
+    /**
+     * Port on which the server will listen
+     */
+    readonly port: number;
+    /**
+     * Path for the Socket.io server to listen
+     *
+     * @default '/socket.io'
+     * @example '/promptbook/socket.io'
+     */
+    readonly path: string_uri;
+} & (AnonymousRemoteServerOptions | CollectionRemoteServerOptions | (AnonymousRemoteServerOptions & CollectionRemoteServerOptions));
+export type AnonymousRemoteServerOptions = {
+    /**
+     * Enable anonymous mode
+     */
+    readonly isAnonymousModeAllowed: true;
+};
+export type CollectionRemoteServerOptions = {
+    /**
+     * Enable collection mode
+     */
+    readonly isCollectionModeAllowed: true;
+    /**
+     * Promptbook collection to use
+     *
+     * This is used to check validity of the prompt to prevent misuse
+     */
+    readonly collection: PipelineCollection;
+    /**
+     * Creates llm execution tools for each client
+     */
+    createLlmExecutionTools(userId: string_user_id | undefined): LlmExecutionTools;
+};
+/**
+ * TODO: Constrain anonymous mode for specific models / providers
+ * TODO: [🧠][🤺] Remove `createLlmExecutionTools`, pass just `llmExecutionTools`
+ */

package/esm/typings/src/llm-providers/remote/playground/playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+import '../../openai/register-constructor';
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts

@@ -0,0 +1,23 @@
+import type { IDestroyable } from 'destroyable';
+import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
+/**
+ * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
+ *
+ * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
+ * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
+ *
+ * @see https://github.com/webgptorg/promptbook#remote-server
+ * @public exported from `@promptbook/remote-server`
+ */
+export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
+/**
+ * TODO: Maybe use `$asDeeplyFrozenSerializableJson`
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [⚖] Expose the collection to be able to connect to same collection via createCollectionFromUrl
+ * TODO: Handle progress - support streaming
+ * TODO: [🗯] Do not hang up immediately but wait until client closes OR timeout
+ * TODO: [🗯] Timeout on chat to free up resources
+ * TODO: [🃏] Pass here some security token to prevent malitious usage and/or DDoS
+ * TODO: [0] Set unavailable models as undefined in `RemoteLlmExecutionTools` NOT throw error here
+ * TODO: Constrain anonymous mode for specific models / providers
+ */

package/esm/typings/src/personas/preparePersona.d.ts

@@ -0,0 +1,17 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
+import type { PersonaPreparedJson } from '../types/PipelineJson/PersonaJson';
+import type { string_persona_description } from '../types/typeAliases';
+/**
+ * Prepares the persona for the pipeline
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/22
+ * @public exported from `@promptbook/core`
+ */
+export declare function preparePersona(personaDescription: string_persona_description, tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions): Promise<PersonaPreparedJson['modelRequirements']>;
+/**
+ * TODO: [🔃][main] !!!!! If the persona was prepared with different version or different set of models, prepare it once again
+ * TODO: [🏢] !! Check validity of `modelName` in pipeline
+ * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
+ * TODO: [🏢] !! Check validity of `temperature` in pipeline
+ */

package/esm/typings/src/postprocessing/utils/extractBlock.d.ts

@@ -0,0 +1,16 @@
+import type { string_markdown } from '../../types/typeAliases';
+/**
+ * Extracts code block from markdown.
+ *
+ * - When there are multiple or no code blocks the function throws a `ParseError`
+ *
+ * Note: There are multiple simmilar function:
+ * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
+ * - `extractJsonBlock` extracts exactly one valid JSON code block
+ * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
+ * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ * @throws {ParseError} if there is not exactly one code block in the markdown
+ */
+export declare function extractBlock(markdown: string_markdown): string;

package/esm/typings/src/postprocessing/utils/extractJsonBlock.d.ts

@@ -0,0 +1,25 @@
+import type { string_json } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
+import type { really_unknown } from '../../utils/organization/really_unknown';
+/**
+ * Extracts  extracts exactly one valid JSON code block
+ *
+ * - When given string is a valid JSON as it is, it just returns it
+ * - When there is no JSON code block the function throws a `ParseError`
+ * - When there are multiple JSON code blocks the function throws a `ParseError`
+ *
+ * Note: It is not important if marked as ```json BUT if it is VALID JSON
+ * Note: There are multiple simmilar function:
+ * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
+ * - `extractJsonBlock` extracts exactly one valid JSON code block
+ * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
+ * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ * @throws {ParseError} if there is no valid JSON block in the markdown
+ */
+export declare function extractJsonBlock(markdown: string_markdown): string_json<really_unknown>;
+/**
+ * TODO: Add some auto-healing logic + extract YAML, JSON5, TOML, etc.
+ * TODO: [🏢] Make this logic part of `JsonFormatDefinition` or `isValidJsonString`
+ */

package/esm/typings/src/postprocessing/utils/extractJsonBlock.test.d.ts

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

package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts

@@ -0,0 +1,68 @@
+import type { string_dirname } from '../types/typeAliases';
+/**
+ * Options for preparation of the pipeline
+ */
+export type PrepareAndScrapeOptions = {
+    /**
+     * Path to the root folder of the pipeline
+     *
+     * Note: When the pipeline is not created from files, it is `null`
+     * Note: This folder must exist (=it is not created recursively)
+     *
+     * @default process.cwd()
+     */
+    readonly rootDirname?: string_dirname | null;
+    /**
+     * Path to the cache folder
+     *
+     * Note: When the folder does not exist, it is created recursively
+     *
+     * @default SCRAPE_CACHE_DIRNAME
+     */
+    readonly cacheDirname?: string_dirname;
+    /**
+     * If true, the cache is cleaned after the scraping
+     *
+     *
+     * @default false // <- TODO: !!!!!! Change to `cacheStrategy`/`intermediateFiles`, Put to global config, change to `true` and explicitly set to `false` in all playgrounds
+     */
+    readonly isCacheCleaned?: boolean;
+    /**
+     * Maximum number of tasks running in parallel
+     *
+     * @default MAX_PARALLEL_COUNT
+     */
+    readonly maxParallelCount?: number;
+    /**
+     * Path to the external programs executables
+     *
+     * TODO: !!!!!! Transform to scrapers and make them Classy
+     */
+    readonly externalProgramsPaths?: {
+        /**
+         * Path to the `pandoc` executable
+         *
+         * @example 'C:/Users/me/AppData/Local/Pandoc/pandoc.exe'
+         */
+        readonly pandocPath?: string;
+        /**
+         * Path to the LibreOffice executable
+         *
+         * @example 'C:/Program Files/LibreOffice/program/swriter.exe'
+         */
+        readonly libreOfficePath?: string;
+    };
+    /**
+     * If true, the missing software is automatically installed
+     */
+    readonly isAutoInstalled?: boolean;
+    /**
+     * If true, the preparation logs additional information
+     *
+     * @default false
+     */
+    readonly isVerbose?: boolean;
+};
+/**
+ * TODO: [🧠] Maybe split `PrepareAndScrapeOptions` and `ScrapeOptions` (`ScrapeOptions` should be extended from `PrepareAndScrapeOptions`)
+ */

package/esm/typings/src/prepare/isPipelinePrepared.d.ts

@@ -0,0 +1,16 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+/**
+ * Determine if the pipeline is fully prepared
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
+/**
+ * TODO: [🔃][main] !!!!! If the pipeline was prepared with different version or different set of models, prepare it once again
+ * TODO: [🐠] Maybe base this on `makeValidator`
+ * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
+ * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
+ *     - [🏍] ? Is context in each template
+ *     - [♨] Are samples prepared
+ *     - [♨] Are templates prepared
+ */

package/esm/typings/src/prepare/isPipelinePrepared.test.d.ts

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

package/esm/typings/src/prepare/preparePipeline.d.ts

@@ -0,0 +1,20 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
+/**
+ * Prepare pipeline from string (markdown) format to JSON format
+ *
+ * Note: This function does not validate logic of the pipeline
+ * Note: This function acts as part of compilation process
+ * Note: When the pipeline is already prepared, it returns the same pipeline
+ * @public exported from `@promptbook/core`
+ */
+export declare function preparePipeline(pipeline: PipelineJson, tools: Pick<ExecutionTools, 'llm' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<PipelineJson>;
+/**
+ * TODO: Write tests for `preparePipeline`
+ * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
+ * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ * TODO: [🧠][♏] Maybe if expecting JSON (In Anthropic Claude and other models without non-json) and its not specified in prompt content, append the instructions
+ *       @see https://docs.anthropic.com/en/docs/test-and-evaluate/strengthen-guardrails/increase-consistency#specify-the-desired-output-format
+ */