@promptbook/markitdown 0.84.0-10

package/esm/typings/src/pipeline/PipelineString.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Promptbook is the **core concept of this package**.
+ * It represents a series of tasks chained together to form a pipeline / one big task with input and result parameters.
+ *
+ * @see @@@ https://github.com/webgptorg/promptbook#promptbook
+ */
+export type PipelineString = string & {
+    readonly _type: 'Promptbook';
+};

package/esm/typings/src/pipeline/book-notation.d.ts

@@ -0,0 +1,18 @@
+import type { PipelineString } from './PipelineString';
+/**
+ * Tag function for notating a pipeline with a book\`...\ notation as template literal
+ *
+ * Note: There are 2 similar functions:
+ * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
+ * 1) `book` for notating and validating entire books exported from `@promptbook/utils`
+ *
+ * @param strings @@@
+ * @param values @@@
+ * @returns the pipeline string
+ * @public exported from `@promptbook/core`
+ */
+export declare function book(strings: TemplateStringsArray, ...values: Array<string>): PipelineString;
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/pipeline/isValidPipelineString.d.ts

@@ -0,0 +1,13 @@
+import type { PipelineString } from './PipelineString';
+/**
+ * Function `isValidPipelineString` will validate the if the string is a valid pipeline string
+ * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
+ *
+ * @param {string} pipelineString the candidate for a pipeline string
+ * @returns {boolean} if the string is a valid pipeline string
+ * @public exported from `@promptbook/core`
+ */
+export declare function isValidPipelineString(pipelineString: string): pipelineString is PipelineString;
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ */

package/esm/typings/src/pipeline/isValidPipelineString.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ */

package/esm/typings/src/pipeline/prompt-notation.d.ts

@@ -0,0 +1,18 @@
+import type { string_prompt } from '../types/typeAliases';
+/**
+ * Tag function for notating a prompt as template literal
+ *
+ * Note: There are 2 similar functions:
+ * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
+ * 1) `book` for notating and validating entire books exported from `@promptbook/utils`
+ *
+ * @param strings @@@
+ * @param values @@@
+ * @returns the pipeline string
+ * @public exported from `@promptbook/utils`
+ */
+export declare function prompt(strings: TemplateStringsArray, ...values: Array<string>): string_prompt;
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/pipeline/prompt-notation.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ */

package/esm/typings/src/pipeline/validatePipelineString.d.ts

@@ -0,0 +1,14 @@
+import type { PipelineString } from './PipelineString';
+/**
+ * Function `validatePipelineString` will validate the if the string is a valid pipeline string
+ * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
+ *
+ * @param {string} pipelineString the candidate for a pipeline string
+ * @returns {PipelineString} the same string as input, but validated as valid
+ * @throws {ParseError} if the string is not a valid pipeline string
+ * @public exported from `@promptbook/core`
+ */
+export declare function validatePipelineString(pipelineString: string): PipelineString;
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ */

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,51 @@
+import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
+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 null or `process.cwd()` when created via `$provide...` function in node
+     */
+    readonly rootDirname?: string_dirname | null;
+    /**
+     * Path to the cache folder
+     *
+     * Note: When the folder does not exist, it is created recursively
+     *
+     * @default DEFAULT_SCRAPE_CACHE_DIRNAME
+     */
+    readonly cacheDirname?: string_dirname;
+    /**
+     * Strategy for caching the intermediate results for knowledge source
+     *
+     * @default DEFAULT_INTERMEDIATE_FILES_STRATEGY
+     */
+    readonly intermediateFilesStrategy?: IntermediateFilesStrategy;
+    /**
+     * Maximum number of tasks running in parallel
+     *
+     * @default DEFAULT_MAX_PARALLEL_COUNT
+     */
+    readonly maxParallelCount?: number;
+    /**
+     * If true, the missing software is automatically installed
+     *
+     * @default DEFAULT_IS_AUTO_INSTALLED
+     */
+    readonly isAutoInstalled?: boolean;
+    /**
+     * If true, the preparation logs additional information
+     *
+     * @default DEFAULT_IS_VERBOSE
+     */
+    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,18 @@
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+/**
+ * Determine if the pipeline is fully prepared
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
+ *
+ * @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 task
+ *     - [♨] Are examples prepared
+ *     - [♨] Are tasks 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,22 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
+/**
+ * Prepare pipeline locally
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
+ *
+ * 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' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<PipelineJson>;
+/**
+ * TODO: Write tests for `preparePipeline` and `preparePipelineOnRemoteServer`
+ * 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
+ */

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

@@ -0,0 +1,17 @@
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOptions';
+/**
+ * Prepare pipeline on remote server
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
+ *
+ * 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/remote-client`
+ */
+export declare function preparePipelineOnRemoteServer<TCustomOptions = undefined>(pipeline: PipelineJson, options: RemoteClientOptions<TCustomOptions>): Promise<PipelineJson>;
+/**
+ * TODO: !!!! Do not return Promise<PipelineJson> But PreparePipelineTask
+ */

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

@@ -0,0 +1,33 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../pipeline/PipelineJson/TaskJson';
+import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
+type PrepareTaskInput = Pick<PipelineJson, 'tasks' | 'parameters'> & {
+    /**
+     * @@@
+     */
+    readonly knowledgePiecesCount: number;
+};
+type PreparedTasks = {
+    /**
+     * @@@ Sequence of tasks that are chained together to form a pipeline
+     */
+    readonly tasksPrepared: ReadonlyArray<TaskJson>;
+};
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function prepareTasks(pipeline: PrepareTaskInput, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<PreparedTasks>;
+export {};
+/**
+ * TODO: [😂] Adding knowledge should be convert to async high-level abstractions, simmilar thing with expectations to sync high-level abstractions
+ * TODO: [🧠] Add context to each task (if missing)
+ * TODO: [🧠] What is better name `prepareTask` or `prepareTaskAndParameters`
+ * TODO: [♨][main] !!3 Prepare index the examples and maybe tasks
+ * 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
+ */

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

@@ -0,0 +1,13 @@
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+/**
+ * Unprepare just strips the preparation data of the pipeline
+ *
+ * @deprecated In future version this function will be removed or deprecated
+ * @public exported from `@promptbook/core`
+ */
+export declare function unpreparePipeline(pipeline: PipelineJson): PipelineJson;
+/**
+ * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
+ * TODO: Write tests for `preparePipeline`
+ * TODO: [🍙] Make some standard order of json properties
+ */

package/esm/typings/src/remote-server/createRemoteClient.d.ts

@@ -0,0 +1,10 @@
+import type { Socket } from 'socket.io-client';
+import type { RemoteClientOptions } from './types/RemoteClientOptions';
+/**
+ * Creates a connection to the remote proxy server.
+ *
+ * Note: This function creates a connection to the remote server and returns a socket but responsibility of closing the connection is on the caller
+ *
+ * @private internal utility function
+ */
+export declare function createRemoteClient<TCustomOptions = undefined>(options: RemoteClientOptions<TCustomOptions>): Promise<Socket>;

package/esm/typings/src/remote-server/socket-types/_common/PromptbookServer_Error.d.ts

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

package/esm/typings/src/remote-server/socket-types/_common/PromptbookServer_Progress.d.ts

@@ -0,0 +1,10 @@
+import type { TaskProgress } from '../../../types/TaskProgress';
+/**
+ * This is sent from server to client as indication of prograss arbitrarily and may be sent multiple times
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_Progress = TaskProgress;
+/**
+ * TODO: `PromptbookServer_Progress` is unused for now, but it will be used in the future
+ */

package/esm/typings/src/remote-server/socket-types/_subtypes/PromptbookServer_Identification.d.ts

@@ -0,0 +1,49 @@
+import type { LlmToolsConfiguration } from '../../../llm-providers/_common/register/LlmToolsConfiguration';
+import type { string_user_id } from '../../../types/typeAliases';
+import type { ApplicationRemoteServerClientOptions } from '../../types/RemoteServerOptions';
+/**
+ * Identification of client for Socket.io remote server
+ *
+ * @public exported from `@promptbook/remote-server`
+ * @public exported from `@promptbook/remote-client`
+ */
+export type PromptbookServer_Identification<TCustomOptions> = PromptbookServer_ApplicationIdentification<TCustomOptions> | PromptbookServer_AnonymousIdentification;
+/**
+ * Application mode is @@@!!!
+ *
+ * @public exported from `@promptbook/remote-server`
+ * @public exported from `@promptbook/remote-client`
+ */
+export type PromptbookServer_ApplicationIdentification<TCustomOptions> = ApplicationRemoteServerClientOptions<TCustomOptions> & {
+    /**
+     * Application mode
+     */
+    readonly isAnonymous: false;
+};
+/**
+ * Anonymous mode is @@@!!!
+ *
+ * @public exported from `@promptbook/remote-server`
+ * @public exported from `@promptbook/remote-client`
+ */
+export type PromptbookServer_AnonymousIdentification = {
+    /**
+     * 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, there is no need to identify yourself, nor does it change the actual configuration of LLM Tools (unlike in application mode)
+     */
+    readonly userId?: string_user_id;
+    /**
+     * Configuration for the LLM tools
+     */
+    readonly llmToolsConfiguration: LlmToolsConfiguration;
+};
+/**
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [🧠][🤺] Maybe allow overriding of `userId` for each prompt - Pass `userId` in `PromptbookServer_ListModels_Request`
+ */

package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts

@@ -0,0 +1,17 @@
+import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
+/**
+ * List models available in the server
+ *
+ * This is a request from client to server
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_ListModels_Request<TCustomOptions> = {
+    /**
+     * Identifier of the end user or application
+     */
+    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+};
+/**
+ * TODO: [🧠] Listing models inanonymous mode does not make sence - keeping only to preserve consistency
+ */

package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Response.d.ts

@@ -0,0 +1,17 @@
+import type { AvailableModel } from '../../../execution/AvailableModel';
+/**
+ * Models available for use in the server
+ *
+ * This is sent from server to client when models are listed
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_ListModels_Response = {
+    /**
+     * Available models that can be used
+     */
+    readonly models: ReadonlyArray<AvailableModel>;
+};
+/**
+ * TODO: [👒] Listing models (and checking configuration) probbably should go through REST API not Socket.io
+ */

package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Request.d.ts

@@ -0,0 +1,17 @@
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
+/**
+ * This is a request from client to server to prepare a pipeline
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_PreparePipeline_Request<TCustomOptions> = {
+    /**
+     * Identifier of the end user or application
+     */
+    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+    /**
+     * The Pipeline to prepare
+     */
+    readonly pipeline: PipelineJson;
+};

package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Response.d.ts

@@ -0,0 +1,12 @@
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+/**
+ * This is sent from server to client when the pipeline is prepared
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_PreparePipeline_Response = {
+    /**
+     * Prepared pipeline
+     */
+    readonly preparedPipeline: PipelineJson;
+};

package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Request.d.ts

@@ -0,0 +1,17 @@
+import type { Prompt } from '../../../types/Prompt';
+import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
+/**
+ * This is a request from client to server to execute a prompt
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_Prompt_Request<TCustomOptions> = {
+    /**
+     * Identifier of the end user or application
+     */
+    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+    /**
+     * The Prompt to execute
+     */
+    readonly prompt: Prompt;
+};

package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Response.d.ts

@@ -0,0 +1,12 @@
+import type { PromptResult } from '../../../execution/PromptResult';
+/**
+ * This is sent from server to client when the generated text is completed
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_Prompt_Response = {
+    /**
+     * The result of the prompt
+     */
+    readonly promptResult: PromptResult;
+};

package/esm/typings/src/remote-server/startRemoteServer.d.ts

@@ -0,0 +1,24 @@
+import type { IDestroyable } from 'destroyable';
+import type { RemoteServerOptions } from './types/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<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): IDestroyable;
+/**
+ * TODO: Split this file into multiple functions - handler for each request
+ * TODO: Maybe use `$exportJson`
+ * 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: Allow to constrain anonymous mode for specific models / providers
+ */

package/esm/typings/src/remote-server/types/RemoteClientOptions.d.ts

@@ -0,0 +1,32 @@
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { string_base_url } from '../../types/typeAliases';
+import type { string_uri } from '../../types/typeAliases';
+import type { PromptbookServer_Identification } from '../socket-types/_subtypes/PromptbookServer_Identification';
+/**
+ * Options for `RemoteLlmExecutionTools`
+ *
+ * @public exported from `@promptbook/remote-client`
+ */
+export type RemoteClientOptions<TCustomOptions> = CommonToolsOptions & {
+    /**
+     * URL of the remote 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;
+    /**
+     * Identification of client for Socket.io remote server
+     */
+    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+};
+/**
+ * TODO: Pass more options from Socket.io to `RemoteClientOptions` (like `transports`)
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ */

package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts

@@ -0,0 +1,73 @@
+import type { Promisable } from 'type-fest';
+import type { PipelineCollection } from '../../collection/PipelineCollection';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { string_app_id } from '../../types/typeAliases';
+import type { string_uri } from '../../types/typeAliases';
+import type { string_user_id } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * There are two modes of remote server:
+ *
+ * 1) **Application 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<TCustomOptions> = 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 | ApplicationRemoteServerOptions<TCustomOptions> | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
+export type AnonymousRemoteServerOptions = {
+    /**
+     * Enable anonymous mode
+     */
+    readonly isAnonymousModeAllowed: true;
+};
+export type ApplicationRemoteServerOptions<TCustomOptions> = {
+    /**
+     * Enable application mode
+     */
+    readonly isApplicationModeAllowed: 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(options: ApplicationRemoteServerClientOptions<TCustomOptions>): Promisable<LlmExecutionTools>;
+};
+export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
+    /**
+     * @@@
+     */
+    readonly appId: string_app_id | null;
+    /**
+     * @@@
+     */
+    readonly userId?: string_user_id;
+    /**
+     * @@@
+     */
+    readonly customOptions?: TCustomOptions;
+};
+/**
+ * TODO: Constrain anonymous mode for specific models / providers
+ */