@promptbook/remote-server 0.72.0-8 → 0.72.0

package/esm/typings/src/execution/Executables.d.ts

@@ -0,0 +1,18 @@
+import type { string_executable_path } from '../types/typeAliases';
+/**
+ * Paths to the external programs executables
+ */
+export type Executables = {
+    /**
+     * Path to the `pandoc` executable
+     *
+     * @example 'C:/Users/me/AppData/Local/Pandoc/pandoc.exe'
+     */
+    pandocPath?: string_executable_path;
+    /**
+     * Path to the LibreOffice executable
+     *
+     * @example 'C:/Program Files/LibreOffice/program/swriter.exe'
+     */
+    libreOfficePath?: string_executable_path;
+};

package/esm/typings/src/execution/ExecutionTools.d.ts

@@ -1,4 +1,7 @@
+import type { Scraper } from '../scrapers/_common/Scraper';
 import type { Arrayable } from '../types/Arrayable';
+import type { Executables } from './Executables';
+import type { FilesystemTools } from './FilesystemTools';
 import type { LlmExecutionTools } from './LlmExecutionTools';
 import type { ScriptExecutionTools } from './ScriptExecutionTools';
 import type { UserInterfaceTools } from './UserInterfaceTools';
@@ -9,20 +12,44 @@ import type { UserInterfaceTools } from './UserInterfaceTools';
  */
 export type ExecutionTools = {
     /**
-     * Tools for executing prompts to large language models like GPT-4
+     * Tools for executing prompts in large language models
      *
-     * Tip: Use `createLlmToolsFromEnv()` to use all available LLM providers you configured
-     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#llm-execution-tools
+     * Tip: Use `$provideLlmToolsFromEnv` to use all available LLM providers you configured
+     *
+     * @default [] - If not provided, no LLM execution will be possible - it does not make sense in most cases
      */
     readonly llm?: Arrayable<LlmExecutionTools>;
+    /**
+     * Tools for filesystem operations
+     *
+     * Tip: Use `$provideFilesystemForNode` to use filesystem in Node.js
+     *
+     * @default undefined - If not provided, no filesystem operations will be possible
+     */
+    readonly fs?: FilesystemTools;
+    /**
+     * Scrapers for extracting knowledge from external sources
+     *
+     * Tip: Use `$provideExecutablesForNode`
+     *
+     * @default [] - If not provided, no external knowledge extraction will be possible
+     */
+    readonly executables?: Executables;
+    /**
+     * Scrapers for extracting knowledge from external sources
+     *
+     * Tip: Use `$provideScrapersForNode` OR `$provideScrapersForBrowser` to use all available scrapers
+     *
+     * @default [] - If not provided, no external knowledge extraction will be possible
+     */
+    readonly scrapers?: Arrayable<Scraper>;
     /**
      * Tools for executing scripts
      *
      * Note: You can pass multiple ScriptExecutionTools, they will be tried one by one until one of them supports the script
      *       If none of them supports the script, an error is thrown
-     * Tip: Use here `new JavascriptExecutionTools()`
+     * Tip: Use here `new JavascriptExecutionTools`
      *
-     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#script-execution-tools
      * @default [] - If not provided, no script execution will be possible
      */
     readonly script?: Arrayable<ScriptExecutionTools>;
@@ -30,7 +57,6 @@ export type ExecutionTools = {
      * Tools for interacting with the user
      *
      * Note: When undefined, the user interface is disabled and promptbook which requires user interaction will fail
-     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#user-interface-tools
      */
     readonly userInterface?: UserInterfaceTools;
 };

package/esm/typings/src/execution/FilesystemTools.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="node" />
+import type fs from 'fs/promises';
+/**
+ * Container for all the tools needed to manipulate with filesystem
+ */
+export type FilesystemTools = Pick<typeof fs, 'access' | 'constants' | 'readFile' | 'writeFile' | 'stat' | 'readdir'>;
+/**
+ * TODO: Implement destroyable pattern to free resources
+ */

package/esm/typings/src/execution/LlmExecutionTools.d.ts

@@ -37,7 +37,7 @@ export type LlmExecutionTools = {
     /**
      * List all available models that can be used
      */
-    listModels(): Promisable<Array<AvailableModel>>;
+    listModels(): Promisable<ReadonlyArray<AvailableModel>>;
     /**
      * Calls a chat model
      */
@@ -52,7 +52,7 @@ export type LlmExecutionTools = {
     callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
 };
 /**
- * TODO: Implement destroyable pattern to free resources
+ * TODO: [🍚] Implement destroyable pattern to free resources
  * TODO: [🏳] Add `callTranslationModel`
  * TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat
  * TODO: [🍓][♐] Some heuristic to pick the best model in listed models

package/esm/typings/src/execution/PipelineExecutorResult.d.ts

@@ -27,11 +27,11 @@ export type PipelineExecutorResult = {
     /**
      * Errors that occured during the execution, details are aviable in `executionReport`
      */
-    readonly errors: ReadonlyDeep<Array<ErrorJson>>;
+    readonly errors: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
     /**
      * Warnings that occured during the execution, details are aviable in `executionReport`
      */
-    readonly warnings: ReadonlyDeep<Array<ErrorJson>>;
+    readonly warnings: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
     /**
      * The report of the execution with all details
      */

package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts

@@ -1,4 +1,4 @@
-import type { PipelineExecutor } from './PipelineExecutor';
+import type { PipelineExecutorResult } from './PipelineExecutorResult';
 /**
  * Asserts that the execution of a Promptbook is successful
  *
@@ -6,7 +6,8 @@ import type { PipelineExecutor } from './PipelineExecutor';
  * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
  * @public exported from `@promptbook/core`
  */
-export declare function assertsExecutionSuccessful(executionResult: Pick<Awaited<ReturnType<PipelineExecutor>>, 'isSuccessful' | 'errors'>): void;
+export declare function assertsExecutionSuccessful(executionResult: Pick<PipelineExecutorResult, 'isSuccessful' | 'errors'>): void;
 /**
+ * TODO: [🐚] This function should be removed OR changed OR be completely rewritten
  * TODO: [🧠] Can this return type be better typed than void
  */

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 `executePipelinex`
+ * @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,18 +1,16 @@
-import { Promisable, ReadonlyDeep } from 'type-fest';
-import { MultipleLlmExecutionTools } from '../../llm-providers/multiple/MultipleLlmExecutionTools';
+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 & {
     /**
      * @@@
      */
@@ -25,26 +23,14 @@ type executeSingleTemplateOptions = {
      * @@@
      */
     readonly parametersToPass: Readonly<Parameters>;
-    /**
-     * @@@
-     */
-    readonly tools: Omit<ExecutionTools, 'llm'>;
-    /**
-     * @@@
-     */
-    readonly llmTools: MultipleLlmExecutionTools;
     /**
      * @@@
      */
     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,29 +1,31 @@
-import type { ReadonlyDeep } from 'type-fest';
-import { MultipleLlmExecutionTools } from '../../llm-providers/multiple/MultipleLlmExecutionTools';
+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;
     /**
@@ -45,19 +47,7 @@ export type ExecuteAttemptsOptions = {
     /**
      * @@@
      */
-    readonly tools: Omit<ExecutionTools, 'llm'>;
-    /**
-     * @@@
-     */
-    readonly llmTools: MultipleLlmExecutionTools;
-    /**
-     * 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/translation/automatic-translate/translateMessages.d.ts

@@ -8,4 +8,5 @@ export declare function translateMessages({ automaticTranslator, from, to, }: {
 } & TranslatorOptions): Promise<void>;
 /**
  * TODO: [😶] Unite floder listing
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts

@@ -0,0 +1,13 @@
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import type { ExecutionTools } from '../ExecutionTools';
+/**
+ * Note: There is unfortunately no equivalent for this function in the browser environment
+ *       because it is not possible automatically detect configured LLM providers
+ *       you need to provide them manually BUT you can help by utilities like `$provideScrapersForBrowser`
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $provideExecutionToolsForNode(options?: PrepareAndScrapeOptions): Promise<ExecutionTools>;
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

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/{$llmToolsMetadataRegister.d.ts → register/$llmToolsMetadataRegister.d.ts}

@@ -1,4 +1,4 @@
-import { $Register } from '../../utils/$Register';
+import { $Register } from '../../../utils/$Register';
 import type { LlmToolsMetadata } from './LlmToolsMetadata';
 /**
  * @@@
@@ -8,3 +8,6 @@ import type { LlmToolsMetadata } from './LlmToolsMetadata';
  * @public exported from `@promptbook/core`
  */
 export declare const $llmToolsMetadataRegister: $Register<LlmToolsMetadata>;
+/**
+ * TODO: [®] DRY Register logic
+ */ 

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

@@ -1,5 +1,5 @@
-import type { LlmExecutionToolsConstructor } from '../../execution/LlmExecutionToolsConstructor';
-import { $Register } from '../../utils/$Register';
+import type { LlmExecutionToolsConstructor } from '../../../execution/LlmExecutionToolsConstructor';
+import { $Register } from '../../../utils/$Register';
 /**
  * @@@
  *
@@ -8,3 +8,6 @@ import { $Register } from '../../utils/$Register';
  * @public exported from `@promptbook/core`
  */
 export declare const $llmToolsRegister: $Register<LlmExecutionToolsConstructor>;
+/**
+ * TODO: [®] DRY Register logic
+ */ 

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

@@ -11,14 +11,14 @@ import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
  * @returns @@@
  * @public exported from `@promptbook/node`
  */
-export declare function createLlmToolsFromConfigurationFromEnv(): LlmToolsConfiguration;
+export declare function $provideLlmToolsConfigurationFromEnv(): LlmToolsConfiguration;
 /**
  * TODO: [🧠][🪁] Maybe do allow to do auto-install if package not registered and not found
  * TODO: Add Azure OpenAI
  * TODO: [🧠][🍛]
  * TODO: [🧠] Is there some meaningfull way how to test this util
- * Note: [🟢] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  * TODO: This should be maybe not under `_common` but under `utils`
  * TODO: [🧠] Maybe pass env as argument
- */
+ * TODO: [®] DRY Register logic */

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

@@ -1,22 +1,15 @@
-import type { LlmExecutionToolsWithTotalUsage } from './utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
-type GetLlmToolsForCliOptions = {
-    /**
-     * @@@
-     *
-     * @default false
-     */
-    isCacheReloaded?: boolean;
-};
+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 getLlmToolsForCli(options?: GetLlmToolsForCliOptions): LlmExecutionToolsWithTotalUsage;
-export {};
+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
  * TODO: [🥃] Allow `ptbk make` without llm tools
  * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
+ * TODO: [®] DRY Register logic
  */

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

@@ -1,6 +1,6 @@
-import '../../_packages/cli.index';
+import '../../../_packages/cli.index';
+import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
 import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFromConfiguration';
-import type { LlmExecutionToolsWithTotalUsage } from './utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
 type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromConfigurationOptions & {
     /**
      * @@@
@@ -14,10 +14,11 @@ type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromCon
  *
  * @private within the repository - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
  */
-export declare function getLlmToolsForTestingAndScriptsAndPlayground(options?: GetLlmToolsForTestingAndScriptsAndPlaygroundOptions): LlmExecutionToolsWithTotalUsage;
+export declare function $provideLlmToolsForTestingAndScriptsAndPlayground(options?: GetLlmToolsForTestingAndScriptsAndPlaygroundOptions): LlmExecutionToolsWithTotalUsage;
 export {};
 /**
  * Note: [⚪] This should never be in any released package
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
+ * TODO: [®] DRY Register logic
  */

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

@@ -1,4 +1,4 @@
-import { MultipleLlmExecutionTools } from '../multiple/MultipleLlmExecutionTools';
+import { MultipleLlmExecutionTools } from '../../multiple/MultipleLlmExecutionTools';
 import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFromConfiguration';
 /**
  * @@@
@@ -14,12 +14,13 @@ import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFro
  * @returns @@@
  * @public exported from `@promptbook/node`
  */
-export declare function createLlmToolsFromEnv(options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;
+export declare function $provideLlmToolsFromEnv(options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;
 /**
- * TODO: @@@ write `createLlmToolsFromEnv` vs `createLlmToolsFromConfigurationFromEnv` vs `createLlmToolsFromConfiguration`
- * TODO: [🧠][🍛] Which name is better `createLlmToolsFromEnv` or `createLlmToolsFromEnvironment`?
+ * 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 published outside of `@promptbook/node` and `@promptbook/cli`
+ * 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
  */

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,22 +1,23 @@
-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';
 /**
  * @@@
  *
  * @@@ `LlmToolsMetadata` vs `LlmToolsConfiguration` vs `LlmToolsOptions` (vs `Registered`)
  */
-export type LlmToolsConfiguration = Array<Registered & {
+export type LlmToolsConfiguration = ReadonlyArray<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
  */