@promptbook/remote-server 0.71.0-0 → 0.71.0-13

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

@@ -0,0 +1,27 @@
+import { MultipleLlmExecutionTools } from '../../multiple/MultipleLlmExecutionTools';
+import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFromConfiguration';
+/**
+ * @@@
+ *
+ * Note: This function is not cached, every call creates new instance of `MultipleLlmExecutionTools`
+ *
+ * @@@ .env
+ *
+ * It looks for environment variables:
+ * - `process.env.OPENAI_API_KEY`
+ * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
+ *
+ * @returns @@@
+ * @public exported from `@promptbook/node`
+ */
+export declare function $provideLlmToolsFromEnv(options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;
+/**
+ * TODO: @@@ write `$provideLlmToolsFromEnv` vs `$provideLlmToolsConfigurationFromEnv` vs `createLlmToolsFromConfiguration`
+ * TODO: [🧠][🍛] Which name is better `$provideLlmToolsFromEnv` or `$provideLlmToolsFromEnvironment`?
+ * TODO: [🧠] Is there some meaningfull way how to test this util
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * TODO: [🥃] Allow `ptbk make` without llm tools
+ * TODO: This should be maybe not under `_common` but under `utils`
+ * TODO: [®] DRY Register logic
+ * TODO: [🍂] Maybe make llm = $provideLlmToolsFromEnv() without problem with bundle contaminated by only `@promptbook/node` and `@promptbook/cli` stuff
+ */

package/esm/typings/src/llm-providers/_common/{$registeredLlmToolsMessage.d.ts → register/$registeredLlmToolsMessage.d.ts}

@@ -1,9 +1,12 @@
-import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown } from '../../../types/typeAliases';
 /**
  * Creates a message with all registered LLM tools
  *
  * Note: This function is used to create a (error) message when there is no constructor for some LLM provider
  *
- * @private internal function of `createLlmToolsFromConfiguration` and `createLlmToolsFromEnv`
+ * @private internal function of `createLlmToolsFromConfiguration` and `$provideLlmToolsFromEnv`
  */
 export declare function $registeredLlmToolsMessage(): string_markdown;
+/**
+ * TODO: [®] DRY Register logic
+ */

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

@@ -1,5 +1,5 @@
-import type { string_title } from '../../types/typeAliases';
-import type { Registered } from '../../utils/$Register';
+import type { string_title } from '../../../types/typeAliases';
+import type { Registered } from '../../../utils/$Register';
 import type { LlmToolsOptions } from './LlmToolsOptions';
 /**
  * @@@
@@ -10,13 +10,14 @@ export type LlmToolsConfiguration = Array<Registered & {
     /**
      * @@@
      */
-    title: string_title;
+    readonly title: string_title;
     /**
      * @@@
      */
-    options: LlmToolsOptions;
+    readonly options: LlmToolsOptions;
 }>;
 /**
  * TODO: [🧠][🌰] `title` is redundant BUT maybe allow each provider pass it's own title for tracking purposes
  * TODO: Maybe instead of `LlmToolsConfiguration[number]` make `LlmToolsConfigurationItem`
+ * TODO: [®] DRY Register logic
  */

package/esm/typings/src/llm-providers/_common/{LlmToolsMetadata.d.ts → register/LlmToolsMetadata.d.ts}

@@ -1,6 +1,6 @@
-import type { string_name } from '../../types/typeAliases';
-import type { string_title } from '../../types/typeAliases';
-import type { Registered } from '../../utils/$Register';
+import type { string_name } from '../../../types/typeAliases';
+import type { string_title } from '../../../types/typeAliases';
+import type { Registered } from '../../../utils/$Register';
 import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
 /**
  * @@@
@@ -11,7 +11,7 @@ export type LlmToolsMetadata = Registered & {
     /**
      * @@@
      */
-    title: string_title;
+    readonly title: string_title;
     /**
      * @@@
      */
@@ -24,4 +24,5 @@ export type LlmToolsMetadata = Registered & {
 /**
  * TODO: Add configuration schema and maybe some documentation link
  * TODO: Maybe constrain LlmToolsConfiguration[number] by generic to ensure that `createConfigurationFromEnv` and `getBoilerplateConfiguration` always create same `packageName` and `className`
+ * TODO: [®] DRY Register logic
  */

package/esm/typings/src/llm-providers/_common/{LlmToolsOptions.d.ts → register/LlmToolsOptions.d.ts}

@@ -1,7 +1,10 @@
-import type { TODO_object } from '../../utils/organization/TODO_object';
+import type { TODO_object } from '../../../utils/organization/TODO_object';
 /**
  * @@@
  *
  * @@@ `LlmToolsMetadata` vs `LlmToolsConfiguration` vs `LlmToolsOptions` (vs `Registered`)
  */
 export type LlmToolsOptions = TODO_object;
+/**
+ * TODO: [®] DRY Register logic
+ */

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

@@ -1,9 +1,9 @@
-import { MultipleLlmExecutionTools } from '../multiple/MultipleLlmExecutionTools';
+import { MultipleLlmExecutionTools } from '../../multiple/MultipleLlmExecutionTools';
 import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
 /**
- * Options for `createLlmToolsFromEnv`
+ * Options for `$provideLlmToolsFromEnv`
  *
- * @private internal type for `createLlmToolsFromEnv` and `getLlmToolsForTestingAndScriptsAndPlayground`
+ * @private internal type for `$provideLlmToolsFromEnv` and `$provideLlmToolsForTestingAndScriptsAndPlayground`
  */
 export type CreateLlmToolsFromConfigurationOptions = {
     /**
@@ -23,10 +23,11 @@ export type CreateLlmToolsFromConfigurationOptions = {
  */
 export declare function createLlmToolsFromConfiguration(configuration: LlmToolsConfiguration, options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;
 /**
- * TODO: [🎌] Togethere with `createLlmToolsFromConfiguration` + 'EXECUTION_TOOLS_CLASSES' gets to `@promptbook/core` ALL model providers, make this more efficient
+ * TODO: [🎌] Together with `createLlmToolsFromConfiguration` + 'EXECUTION_TOOLS_CLASSES' gets to `@promptbook/core` ALL model providers, make this more efficient
  * TODO: [🧠][🎌] Dynamically install required providers
  * TODO: @@@ write discussion about this - wizzard
  * TODO: [🧠][🍛] Which name is better `createLlmToolsFromConfig` or `createLlmToolsFromConfiguration`?
  * TODO: [🧠] Is there some meaningfull way how to test this util
  * TODO: This should be maybe not under `_common` but under `utils`
+ * TODO: [®] DRY Register logic
  */

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

@@ -1,3 +1,4 @@
+import Anthropic from '@anthropic-ai/sdk';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
@@ -26,7 +27,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
     constructor(options?: AnthropicClaudeExecutionToolsDirectOptions);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
-    private getClient;
+    getClient(): Promise<Anthropic>;
     /**
      * Check the `options` passed to `constructor`
      */

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

@@ -1,5 +1,5 @@
 import type { ClientOptions } from '@anthropic-ai/sdk';
-import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { RemoteLlmExecutionToolsOptions } from '../remote/interfaces/RemoteLlmExecutionToolsOptions';
 /**
  * Options for `AnthropicClaudeExecutionTools`
@@ -14,7 +14,7 @@ export type AnthropicClaudeExecutionToolsOptions = AnthropicClaudeExecutionTools
  * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
  * @public exported from `@promptbook/anthropic-claude`
  */
-export type AnthropicClaudeExecutionToolsDirectOptions = CommonExecutionToolsOptions & ClientOptions & {
+export type AnthropicClaudeExecutionToolsDirectOptions = CommonToolsOptions & ClientOptions & {
     isProxied?: false;
 };
 /**
@@ -23,7 +23,7 @@ export type AnthropicClaudeExecutionToolsDirectOptions = CommonExecutionToolsOpt
  * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
  * @public exported from `@promptbook/anthropic-claude`
  */
-export type AnthropicClaudeExecutionToolsProxiedOptions = CommonExecutionToolsOptions & ClientOptions & {
+export type AnthropicClaudeExecutionToolsProxiedOptions = CommonToolsOptions & ClientOptions & {
     isProxied: true;
 } & Pick<RemoteLlmExecutionToolsOptions, 'remoteUrl' | 'path'>;
 /**

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

@@ -1,6 +1,7 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO:[main] !!! Playground with WebGPT / Promptbook.studio anonymous server
- * TODO:[main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * TODO: [main] !!! Playground with WebGPT / Promptbook.studio anonymous server
+ * 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/anthropic-claude/register-configuration.d.ts

@@ -1,9 +1,10 @@
+import type { Registration } from '../../utils/$Register';
 /**
- * @@@ registration1 of default configuration for Anthropic Claude
+ * Registration of LLM provider metadata
  *
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ * 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 _AnthropicClaudeMetadataRegistration: void;
+export declare const _AnthropicClaudeMetadataRegistration: Registration;

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

@@ -1,12 +1,13 @@
+import type { Registration } from '../../utils/$Register';
 /**
- * @@@ registration2
+ * Registration of LLM provider
  *
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ * 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/anthropic-claude`
  * @public exported from `@promptbook/cli`
  */
-export declare const _AnthropicClaudeRegistration: void;
+export declare const _AnthropicClaudeRegistration: Registration;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

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

@@ -1,3 +1,4 @@
+import { OpenAIClient } from '@azure/openai';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
@@ -26,7 +27,7 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
     constructor(options: AzureOpenAiExecutionToolsOptions);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
-    private getClient;
+    getClient(): Promise<OpenAIClient>;
     /**
      * Check the `options` passed to `constructor`
      */
@@ -43,6 +44,12 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
      * Calls Azure OpenAI API to use a complete model.
      */
     callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
+    /**
+     * Library `@azure/openai` has bug/weird behavior that it does not throw error but hangs forever
+     *
+     * This method wraps the promise with timeout
+     */
+    private withTimeout;
     /**
      * Changes Azure error (which is not propper Error but object) to propper Error
      */

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

@@ -1,4 +1,4 @@
-import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { string_name } from '../../types/typeAliases';
 import type { string_token } from '../../types/typeAliases';
 /**
@@ -7,7 +7,7 @@ import type { string_token } from '../../types/typeAliases';
  * @see https://oai.azure.com/portal/
  * @public exported from `@promptbook/azure-openai`
  */
-export type AzureOpenAiExecutionToolsOptions = CommonExecutionToolsOptions & {
+export type AzureOpenAiExecutionToolsOptions = CommonToolsOptions & {
     /**
      * The resource name of the Azure OpenAI resource
      *

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

@@ -2,4 +2,5 @@
 export {};
 /**
  * TODO: 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/azure-openai/register-configuration.d.ts

@@ -1,9 +1,10 @@
+import type { Registration } from '../../utils/$Register';
 /**
- * @@@ registration1 of default configuration for Azure Open AI
+ * Registration of LLM provider metadata
  *
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ * 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 _AzureOpenAiMetadataRegistration: void;
+export declare const _AzureOpenAiMetadataRegistration: Registration;

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

@@ -1,12 +1,13 @@
+import type { Registration } from '../../utils/$Register';
 /**
- * @@@ registration2
+ * Registration of LLM provider
  *
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ * 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/azure-openai`
  * @public exported from `@promptbook/cli`
  */
-export declare const _AzureOpenAiRegistration: void;
+export declare const _AzureOpenAiRegistration: Registration;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

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

@@ -1,2 +1,5 @@
 #!/usr/bin/env ts-node
 export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

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

@@ -1,5 +1,5 @@
 import type { AvailableModel } from '../../execution/AvailableModel';
-import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
 import type { CompletionPromptResult } from '../../execution/PromptResult';
@@ -14,7 +14,7 @@ import type { string_title } from '../../types/typeAliases';
  */
 export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     private readonly options;
-    constructor(options?: CommonExecutionToolsOptions);
+    constructor(options?: CommonToolsOptions);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     /**

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

@@ -1,5 +1,5 @@
 import type { AvailableModel } from '../../execution/AvailableModel';
-import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
 import type { CompletionPromptResult } from '../../execution/PromptResult';
@@ -15,7 +15,7 @@ import type { string_title } from '../../types/typeAliases';
  */
 export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools {
     private readonly options;
-    constructor(options?: CommonExecutionToolsOptions);
+    constructor(options?: CommonToolsOptions);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     /**

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

@@ -16,6 +16,7 @@ import type { string_title } from '../../types/typeAliases';
  *
  * Note: Internal utility of `joinLlmExecutionTools` but exposed type
  * @public exported from `@promptbook/types`
+ * TODO: !!!!!! Export as runtime class not just type
  */
 export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
     /**

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

@@ -1,2 +1,5 @@
 #!/usr/bin/env ts-node
 export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

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

@@ -1,3 +1,4 @@
+import OpenAI from 'openai';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
@@ -27,7 +28,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     constructor(options?: OpenAiExecutionToolsOptions);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
-    private getClient;
+    getClient(): Promise<OpenAI>;
     /**
      * Check the `options` passed to `constructor`
      */

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

@@ -1,5 +1,5 @@
 import type { ClientOptions } from 'openai';
-import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { string_token } from '../../types/typeAliases';
 /**
  * Options for `OpenAiExecutionTools`
@@ -9,7 +9,7 @@ import type { string_token } from '../../types/typeAliases';
  *
  * @public exported from `@promptbook/openai`
  */
-export type OpenAiExecutionToolsOptions = CommonExecutionToolsOptions & ClientOptions & {
+export type OpenAiExecutionToolsOptions = CommonToolsOptions & ClientOptions & {
     /**
      * A unique identifier representing your end-user, which can help OpenAI to monitor
      * and detect abuse.

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

@@ -1,5 +1,6 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO:[main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * 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

@@ -1,9 +1,10 @@
+import type { Registration } from '../../utils/$Register';
 /**
- * @@@ registration1 of default configuration for Open AI
+ * Registration of LLM provider metadata
  *
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ * 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: void;
+export declare const _OpenAiMetadataRegistration: Registration;

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

@@ -1,12 +1,13 @@
+import type { Registration } from '../../utils/$Register';
 /**
- * @@@ registration2
+ * Registration of LLM provider
  *
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ * 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: void;
+export declare const _OpenAiRegistration: Registration;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

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

@@ -1,4 +1,4 @@
-import type { LlmToolsConfiguration } from '../../_common/LlmToolsConfiguration';
+import type { LlmToolsConfiguration } from '../../_common/register/LlmToolsConfiguration';
 /**
  * Socket.io progress for remote text generation
  *

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

@@ -1,6 +1,6 @@
 import type { Prompt } from '../../../types/Prompt';
 import type { string_user_id } from '../../../types/typeAliases';
-import type { LlmToolsConfiguration } from '../../_common/LlmToolsConfiguration';
+import type { LlmToolsConfiguration } from '../../_common/register/LlmToolsConfiguration';
 /**
  * Socket.io progress for remote text generation
  *

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

@@ -1,14 +1,14 @@
-import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
+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/LlmToolsConfiguration';
+import type { LlmToolsConfiguration } from '../../_common/register/LlmToolsConfiguration';
 /**
  * Options for `RemoteLlmExecutionTools`
  *
  * @public exported from `@promptbook/remote-client`
  */
-export type RemoteLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
+export type RemoteLlmExecutionToolsOptions = CommonToolsOptions & {
     /**
      * URL of the remote PROMPTBOOK server
      * On this server will be connected to the socket.io server

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

@@ -1,5 +1,5 @@
 import type { PipelineCollection } from '../../../collection/PipelineCollection';
-import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
+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';
@@ -17,7 +17,7 @@ import type { string_user_id } from '../../../types/typeAliases';
  * @public exported from `@promptbook/remote-client`
  * @public exported from `@promptbook/remote-server`
  */
-export type RemoteServerOptions = CommonExecutionToolsOptions & {
+export type RemoteServerOptions = CommonToolsOptions & {
     /**
      * Port on which the server will listen
      */

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

@@ -1,2 +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/personas/preparePersona.d.ts

@@ -1,4 +1,5 @@
-import type { PrepareOptions } from '../prepare/PrepareOptions';
+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';
 /**
@@ -7,7 +8,7 @@ import type { string_persona_description } from '../types/typeAliases';
  * @see https://github.com/webgptorg/promptbook/discussions/22
  * @public exported from `@promptbook/core`
  */
-export declare function preparePersona(personaDescription: string_persona_description, options: PrepareOptions): Promise<PersonaPreparedJson['modelRequirements']>;
+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

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/preparePipeline.d.ts

@@ -1,5 +1,6 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import type { PrepareOptions } from './PrepareOptions';
+import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
 /**
  * Prepare pipeline from string (markdown) format to JSON format
  *
@@ -8,7 +9,7 @@ import type { PrepareOptions } from './PrepareOptions';
  * Note: When the pipeline is already prepared, it returns the same pipeline
  * @public exported from `@promptbook/core`
  */
-export declare function preparePipeline(pipeline: PipelineJson, options: PrepareOptions): Promise<PipelineJson>;
+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

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

@@ -1,6 +1,7 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 import type { TemplateJson } from '../types/PipelineJson/TemplateJson';
-import type { PrepareOptions } from './PrepareOptions';
+import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
 type PrepareTemplateInput = Pick<PipelineJson, 'templates' | 'parameters'> & {
     /**
      * @@@
@@ -18,7 +19,7 @@ type PreparedTemplates = {
  *
  * @public exported from `@promptbook/core`
  */
-export declare function prepareTemplates(pipeline: PrepareTemplateInput, options: PrepareOptions): Promise<PreparedTemplates>;
+export declare function prepareTemplates(pipeline: PrepareTemplateInput, tools: Pick<ExecutionTools, 'llm' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<PreparedTemplates>;
 export {};
 /**
  * TODO: [🧠] Add context to each template (if missing)