@promptbook/browser 0.72.0-9 → 0.72.0

package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts

@@ -1,10 +1,11 @@
+import type { CsvSettings } from '../../formats/csv/CsvSettings';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 import type { ExecutionTools } from '../ExecutionTools';
-import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
 /**
  * Options for `createPipelineExecutor`
  */
-export type CreatePipelineExecutorOptions = {
+export type CreatePipelineExecutorOptions = PrepareAndScrapeOptions & {
     /**
      * The pipeline to be executed
      */
@@ -14,10 +15,32 @@ export type CreatePipelineExecutorOptions = {
      */
     readonly tools: ExecutionTools;
     /**
-     * Optional settings for the pipeline executor
+     * When executor does not satisfy expectations it will be retried this amount of times
+     *
+     * @default MAX_EXECUTION_ATTEMPTS
      */
-    readonly settings?: Partial<CreatePipelineExecutorSettings>;
+    readonly maxExecutionAttempts?: number;
+    /**
+     * Settings for CSV format
+     *
+     * @default DEFAULT_CSV_SETTINGS
+     */
+    readonly csvSettings?: CsvSettings;
+    /**
+     * If you pass fully prepared pipeline, this does not matter
+     *
+     * Otherwise:
+     * If false or not set, warning is shown when pipeline is not prepared
+     * If true, warning is suppressed
+     *
+     * @default false
+     */
+    readonly isNotPreparedWarningSupressed?: boolean;
 };
 /**
- * TODO: !!!!!! Unite `CreatePipelineExecutorOptions` and `CreatePipelineExecutorSettings` OR describe the difference
- */ 
+ * TODO: [🧎][🧠] Move `csvSettings` to some better place
+ *       1) either to some dependency in `ExecutionTools`
+ *       2) or make here container for multiple formats
+ *       3) or make the setting more universal and which just sets things like `delimiter` and `quote` without specifying the format
+ * TODO: [🤹‍♂️] More granular setting for limits of execution + better waiting for queue
+ */

package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts

@@ -2,23 +2,18 @@ import type { Promisable, ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 import type { TaskProgress } from '../../types/TaskProgress';
 import type { Parameters } from '../../types/typeAliases';
-import type { ExecutionTools } from '../ExecutionTools';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
-import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
+import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
  * @@@
  *
  * @private internal type of `executePipeline`
  */
-type ExecutePipelineOptions = {
+type ExecutePipelineOptions = CreatePipelineExecutorOptions & {
     /**
      * @@@
      */
     readonly inputParameters: Readonly<Parameters>;
-    /**
-     * @@@
-     */
-    readonly tools: ExecutionTools;
     /**
      * @@@
      */
@@ -39,10 +34,6 @@ type ExecutePipelineOptions = {
      * @@@
      */
     readonly pipelineIdentification: string;
-    /**
-     * Settings for the pipeline executor
-     */
-    readonly settings: CreatePipelineExecutorSettings;
 };
 /**
  * @@@

package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts

@@ -1,17 +1,16 @@
-import { Promisable, ReadonlyDeep } from 'type-fest';
+import type { Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
 import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
 import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
 import type { TaskProgress } from '../../types/TaskProgress';
 import type { Parameters } from '../../types/typeAliases';
-import type { ExecutionTools } from '../ExecutionTools';
-import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
+import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
  * @@@
  *
  * @private internal type of `executeTemplate`
  */
-type executeSingleTemplateOptions = {
+type executeSingleTemplateOptions = CreatePipelineExecutorOptions & {
     /**
      * @@@
      */
@@ -24,22 +23,14 @@ type executeSingleTemplateOptions = {
      * @@@
      */
     readonly parametersToPass: Readonly<Parameters>;
-    /**
-     * @@@
-     */
-    readonly tools: ExecutionTools;
     /**
      * @@@
      */
     readonly onProgress: (taskProgress: TaskProgress) => Promisable<void>;
-    /**
-     * Settings for the pipeline executor
-     */
-    readonly settings: CreatePipelineExecutorSettings;
     /**
      * @@@
      */
-    readonly $executionReport: ExecutionReportJson;
+    readonly $executionReport: WritableDeep<ExecutionReportJson>;
     /**
      * @@@
      */

package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -1,28 +1,31 @@
-import type { ReadonlyDeep } from 'type-fest';
+import type { ReadonlyDeep, WritableDeep } from 'type-fest';
 import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
 import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
 import type { Parameters } from '../../types/typeAliases';
 import type { string_parameter_name } from '../../types/typeAliases';
 import type { TODO_string } from '../../utils/organization/TODO_string';
-import type { ExecutionTools } from '../ExecutionTools';
-import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
+import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
  * @@@
  *
  * @private internal type of `executeAttempts`
  */
-export type ExecuteAttemptsOptions = {
+export type ExecuteAttemptsOptions = Omit<CreatePipelineExecutorOptions, 'pipeline'> & {
     /**
      * @@@
      */
-    readonly jokerParameterNames: Readonly<Array<string_parameter_name>>;
+    readonly jokerParameterNames: Readonly<ReadonlyArray<string_parameter_name>>;
     /**
      * @@@
      */
     readonly priority: number;
     /**
      * @@@
+     *
+     * Note: [💂] There are two distinct variabiles
+     * 1) `maxExecutionAttempts` - the amount of attempts LLM model
+     * 2) `maxAttempts` - the amount of attempts for any template - LLM, SCRIPT, DIALOG, etc.
      */
     readonly maxAttempts: number;
     /**
@@ -44,15 +47,7 @@ export type ExecuteAttemptsOptions = {
     /**
      * @@@
      */
-    readonly tools: ExecutionTools;
-    /**
-     * Settings for the pipeline executor
-     */
-    readonly settings: CreatePipelineExecutorSettings;
-    /**
-     * @@@
-     */
-    readonly $executionReport: ExecutionReportJson;
+    readonly $executionReport: WritableDeep<ExecutionReportJson>;
     /**
      * @@@
      */

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts

@@ -1,9 +1,17 @@
 import type { AutomaticTranslator } from './AutomaticTranslator';
 import type { TranslatorOptions } from './TranslatorOptions';
-interface LindatAutomaticTranslatorOptions extends TranslatorOptions {
-    apiUrl?: URL;
-}
 /**
+ * @@@
+ */
+type LindatAutomaticTranslatorOptions = TranslatorOptions & {
+    /**
+     * @@@
+     */
+    readonly apiUrl?: URL;
+};
+/**
+ * @@@
+ *
  * @private still in development [🏳]
  */
 export declare class LindatAutomaticTranslator implements AutomaticTranslator {

package/esm/typings/src/execution/utils/addUsage.d.ts

@@ -6,4 +6,4 @@ import type { PromptResultUsage } from '../PromptResultUsage';
  *
  * @public exported from `@promptbook/core`
  */
-export declare function addUsage(...usageItems: Array<PromptResultUsage>): PromptResultUsage;
+export declare function addUsage(...usageItems: ReadonlyArray<PromptResultUsage>): PromptResultUsage;

package/esm/typings/src/execution/utils/forEachAsync.d.ts

@@ -16,5 +16,5 @@ type ForEachAsyncOptions = {
  * @public exported from `@promptbook/utils`
  * @deprecated [🪂] Use queues instead
  */
-export declare function forEachAsync<TItem>(array: Array<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: Array<TItem>) => Promisable<void>): Promise<void>;
+export declare function forEachAsync<TItem>(array: ReadonlyArray<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: ReadonlyArray<TItem>) => Promisable<void>): Promise<void>;
 export {};

package/esm/typings/src/formats/_common/FormatDefinition.d.ts

@@ -21,7 +21,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
     /**
      * Aliases for the `formatName`
      */
-    readonly aliases?: Array<string_name & string_SCREAMING_CASE>;
+    readonly aliases?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
     /**
      * The mime type of the format (if any)
      *
@@ -58,7 +58,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
     /**
      * @@@
      */
-    readonly subvalueDefinitions: Array<FormatSubvalueDefinition<TValue, TSettings>>;
+    readonly subvalueDefinitions: ReadonlyArray<FormatSubvalueDefinition<TValue, TSettings>>;
 };
 /**
  * TODO: [♏] Add some prepare hook to modify prompt according to the format

package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts

@@ -1,7 +1,7 @@
 import type { Promisable } from 'type-fest';
 import type { Parameters } from '../../types/typeAliases';
-import type { string_parameter_name } from '../../types/typeAliases';
 import type { string_name } from '../../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { empty_object } from '../../utils/organization/empty_object';
 /**
@@ -17,7 +17,7 @@ export type FormatSubvalueDefinition<TValue extends string, TSettings extends em
     /**
      * Aliases for the `subvalueName`
      */
-    readonly aliases?: Array<string_name & string_SCREAMING_CASE>;
+    readonly aliases?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
     /**
      * Maps values
      *

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForCli.d.ts

@@ -1,11 +1,11 @@
-import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+import type { CacheLlmToolsOptions } from '../utils/cache/CacheLlmToolsOptions';
 import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
 /**
  * Returns LLM tools for CLI
  *
  * @private within the repository - for CLI utils
  */
-export declare function $provideLlmToolsForCli(options?: Pick<PrepareAndScrapeOptions, 'isCacheCleaned'>): LlmExecutionToolsWithTotalUsage;
+export declare function $provideLlmToolsForCli(options?: Pick<CacheLlmToolsOptions, 'isCacheReloaded'>): LlmExecutionToolsWithTotalUsage;
 /**
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools

package/esm/typings/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts

@@ -6,7 +6,7 @@ import type { LlmToolsOptions } from './LlmToolsOptions';
  *
  * @@@ `LlmToolsMetadata` vs `LlmToolsConfiguration` vs `LlmToolsOptions` (vs `Registered`)
  */
-export type LlmToolsConfiguration = Array<Registered & {
+export type LlmToolsConfiguration = ReadonlyArray<Registered & {
     /**
      * @@@
      */

package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts

@@ -1,3 +1,4 @@
+import type { string_user_id } from '../../../types/typeAliases';
 import { MultipleLlmExecutionTools } from '../../multiple/MultipleLlmExecutionTools';
 import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
 /**
@@ -12,6 +13,12 @@ export type CreateLlmToolsFromConfigurationOptions = {
      * @default false
      */
     isVerbose?: boolean;
+    /**
+     * Identifier of the end user
+     *
+     * Note: This is passed to the LLM tools providers to identify misuse
+     */
+    readonly userId?: string_user_id | null;
 };
 /**
  * @@@

package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts

@@ -1,5 +1,8 @@
 import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
 import type { CacheItem } from './CacheItem';
+/**
+ * @@@
+ */
 export type CacheLlmToolsOptions = {
     /**
      * @@@
@@ -12,5 +15,5 @@ export type CacheLlmToolsOptions = {
      *
      * @default false
      */
-    isReloaded?: boolean;
+    isCacheReloaded?: boolean;
 };

package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -35,7 +35,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
     /**
      * List all available Anthropic Claude models that can be used
      */
-    listModels(): Array<AvailableModel>;
+    listModels(): ReadonlyArray<AvailableModel>;
     /**
      * Calls Anthropic Claude API to use a chat model.
      */

package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts

@@ -25,7 +25,7 @@ export type AnthropicClaudeExecutionToolsDirectOptions = CommonToolsOptions & Cl
  */
 export type AnthropicClaudeExecutionToolsProxiedOptions = CommonToolsOptions & ClientOptions & {
     isProxied: true;
-} & Pick<RemoteLlmExecutionToolsOptions, 'remoteUrl' | 'path'>;
+} & Pick<RemoteLlmExecutionToolsOptions<undefined>, 'remoteUrl' | 'path'>;
 /**
- * TODO: [🧠][🤺] Detecting `user`
+ * TODO: [🧠][🤺] Pass `userId`
  */

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

@@ -8,7 +8,7 @@ import type { number_usd } from '../../types/typeAliases';
  * @see https://docs.anthropic.com/en/docs/models-overview
  * @public exported from `@promptbook/anthropic-claude`
  */
-export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
+export declare const ANTHROPIC_CLAUDE_MODELS: ReadonlyArray<AvailableModel & {
     pricing?: {
         readonly prompt: number_usd;
         readonly output: number_usd;

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

@@ -35,7 +35,7 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
     /**
      * List all available Azure OpenAI models that can be used
      */
-    listModels(): Promise<Array<AvailableModel>>;
+    listModels(): Promise<ReadonlyArray<AvailableModel>>;
     /**
      * Calls OpenAI API to use a chat model.
      */

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

@@ -1,6 +1,7 @@
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { string_name } from '../../types/typeAliases';
 import type { string_token } from '../../types/typeAliases';
+import type { string_user_id } from '../../types/typeAliases';
 /**
  * Options for `AzureOpenAiExecutionTools`
  *
@@ -32,5 +33,5 @@ export type AzureOpenAiExecutionToolsOptions = CommonToolsOptions & {
      *
      * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids (document from OpenAI not Azure, but same concept)
      */
-    readonly user?: string_token;
+    readonly userId: string_user_id | null;
 };

package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts

@@ -14,4 +14,4 @@ export declare class LangtailExecutionTools extends OpenAiExecutionTools impleme
 }
 /**
  * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
- */ 
+ */

package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts

@@ -9,7 +9,7 @@ import type { string_postprocessing_function_name } from '../../types/typeAliase
  *
  * @private internal utility for MockedFackedLlmExecutionTools
  */
-export declare function $fakeTextToExpectations(expectations: Expectations, postprocessingFunctionNames?: Array<string_postprocessing_function_name>): Promise<string>;
+export declare function $fakeTextToExpectations(expectations: Expectations, postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>): Promise<string>;
 /**
  * TODO: [💝] Unite object for expecting amount and format - use here also a format
  */

package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -24,7 +24,7 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     /**
      * List all available mocked-models that can be used
      */
-    listModels(): Array<AvailableModel>;
+    listModels(): ReadonlyArray<AvailableModel>;
     /**
      * Mocks chat model
      */

package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -25,7 +25,7 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
     /**
      * List all available fake-models that can be used
      */
-    listModels(): Array<AvailableModel>;
+    listModels(): ReadonlyArray<AvailableModel>;
     /**
      * Fakes chat model
      */

package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts

@@ -15,18 +15,17 @@ import type { string_title } from '../../types/typeAliases';
  * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
  *
  * Note: Internal utility of `joinLlmExecutionTools` but exposed type
- * @public exported from `@promptbook/types`
- * TODO: !!!!!! Export as runtime class not just type
+ * @public exported from `@promptbook/core`
  */
 export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
     /**
      * Array of execution tools in order of priority
      */
-    readonly llmExecutionTools: Array<LlmExecutionTools>;
+    readonly llmExecutionTools: ReadonlyArray<LlmExecutionTools>;
     /**
      * Gets array of execution tools in order of priority
      */
-    constructor(...llmExecutionTools: Array<LlmExecutionTools>);
+    constructor(...llmExecutionTools: ReadonlyArray<LlmExecutionTools>);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     /**
@@ -37,7 +36,7 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
      * List all available models that can be used
      * This lists is a combination of all available models from all execution tools
      */
-    listModels(): Promise<Array<AvailableModel>>;
+    listModels(): Promise<ReadonlyArray<AvailableModel>>;
     /**
      * Calls the best available chat model
      */

package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts

@@ -15,7 +15,7 @@ import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
  *
  * @public exported from `@promptbook/core`
  */
-export declare function joinLlmExecutionTools(...llmExecutionTools: Array<LlmExecutionTools>): MultipleLlmExecutionTools;
+export declare function joinLlmExecutionTools(...llmExecutionTools: ReadonlyArray<LlmExecutionTools>): MultipleLlmExecutionTools;
 /**
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */

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

@@ -29,7 +29,6 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
     callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>): Promise<ChatPromptResult>;
 }
 /**
- * TODO: !!!!!! DO not use colors - can be used in browser
  * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
  * TODO: Maybe make custom OpenAiError
  * TODO: [🧠][🈁] Maybe use `isDeterministic` from options

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

@@ -27,7 +27,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
      *
      * @param options which are relevant are directly passed to the OpenAI client
      */
-    constructor(options?: OpenAiExecutionToolsOptions);
+    constructor(options: OpenAiExecutionToolsOptions);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     getClient(): Promise<OpenAI>;
@@ -45,7 +45,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     /**
      * List all available OpenAI models that can be used
      */
-    listModels(): Array<AvailableModel>;
+    listModels(): ReadonlyArray<AvailableModel>;
     /**
      * Calls OpenAI API to use a chat model.
      */

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

@@ -1,6 +1,6 @@
 import type { ClientOptions } from 'openai';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
-import type { string_token } from '../../types/typeAliases';
+import type { string_user_id } from '../../types/typeAliases';
 /**
  * Options for `OpenAiExecutionTools`
  *
@@ -16,5 +16,5 @@ export type OpenAiExecutionToolsOptions = CommonToolsOptions & ClientOptions & {
      *
      * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids
      */
-    user?: string_token;
+    userId: string_user_id | null;
 };

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

@@ -9,7 +9,7 @@ import type { number_usd } from '../../types/typeAliases';
  * @see https://openai.com/api/pricing/
  * @public exported from `@promptbook/openai`
  */
-export declare const OPENAI_MODELS: Array<AvailableModel & {
+export declare const OPENAI_MODELS: ReadonlyArray<AvailableModel & {
     pricing?: {
         readonly prompt: number_usd;
         readonly output: number_usd;

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

@@ -19,9 +19,9 @@ import type { RemoteLlmExecutionToolsOptions } from './interfaces/RemoteLlmExecu
  * @see https://github.com/webgptorg/promptbook#remote-server
  * @public exported from `@promptbook/remote-client`
  */
-export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
-    protected readonly options: RemoteLlmExecutionToolsOptions;
-    constructor(options: RemoteLlmExecutionToolsOptions);
+export declare class RemoteLlmExecutionTools<TCustomOptions = undefined> implements LlmExecutionTools {
+    protected readonly options: RemoteLlmExecutionToolsOptions<TCustomOptions>;
+    constructor(options: RemoteLlmExecutionToolsOptions<TCustomOptions>);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     /**
@@ -31,7 +31,7 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
     /**
      * List all available models that can be used
      */
-    listModels(): Promise<Array<AvailableModel>>;
+    listModels(): Promise<ReadonlyArray<AvailableModel>>;
     /**
      * Creates a connection to the remote proxy server.
      */

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

@@ -1,21 +1,30 @@
+import type { string_user_id } from '../../../types/typeAliases';
 import type { LlmToolsConfiguration } from '../../_common/register/LlmToolsConfiguration';
+import type { CollectionRemoteServerClientOptions } from './RemoteServerOptions';
 /**
  * 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 = {
+export type PromptbookServer_ListModels_Request<TCustomOptions> = PromptbookServer_ListModels_CollectionRequest<TCustomOptions> | PromptbookServer_ListModels_AnonymousRequest;
+export type PromptbookServer_ListModels_CollectionRequest<TCustomOptions> = CollectionRemoteServerClientOptions<TCustomOptions> & {
     /**
-     * Collection mode
+     * Application mode
      */
-    isAnonymous: false;
+    readonly isAnonymous: false;
 };
 export type PromptbookServer_ListModels_AnonymousRequest = {
     /**
      * Anonymous mode
      */
-    isAnonymous: true;
+    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 | null;
     /**
      * Configuration for the LLM tools
      */
@@ -24,6 +33,6 @@ export type PromptbookServer_ListModels_AnonymousRequest = {
 /**
  * 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: [🧠][🤺] Maybe allow overriding of `userId` for each prompt - 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

@@ -4,12 +4,12 @@ import type { AvailableModel } from '../../../execution/AvailableModel';
  *
  * This is sent from server to client when models are listed
  */
-export interface PromptbookServer_ListModels_Response {
+export type PromptbookServer_ListModels_Response = {
     /**
      * Available models that can be used
      */
-    models: Array<AvailableModel>;
-}
+    readonly models: ReadonlyArray<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_Request.d.ts

@@ -1,24 +1,18 @@
 import type { Prompt } from '../../../types/Prompt';
 import type { string_user_id } from '../../../types/typeAliases';
 import type { LlmToolsConfiguration } from '../../_common/register/LlmToolsConfiguration';
+import type { CollectionRemoteServerClientOptions } from './RemoteServerOptions';
 /**
  * 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 = {
+export type PromptbookServer_Prompt_Request<TCustomOptions> = PromptbookServer_Prompt_CollectionRequest<TCustomOptions> | PromptbookServer_Prompt_AnonymousRequest;
+export type PromptbookServer_Prompt_CollectionRequest<TCustomOptions> = CollectionRemoteServerClientOptions<TCustomOptions> & {
     /**
-     * Collection mode
+     * Application 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
      */
@@ -33,9 +27,9 @@ export type PromptbookServer_Prompt_AnonymousRequest = {
      * 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
+     * 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;
+    readonly userId: string_user_id | null;
     /**
      * Configuration for the LLM tools
      */