@promptbook/openai 0.71.0-0 → 0.71.0-12

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)

package/esm/typings/src/scrapers/_common/Converter.d.ts

@@ -0,0 +1,22 @@
+import type { ScraperAndConverterMetadata } from './register/ScraperAndConverterMetadata';
+import type { ScraperSourceHandler } from './Scraper';
+import type { ScraperIntermediateSource } from './ScraperIntermediateSource';
+/**
+ * @@@
+ *
+ */
+export type Converter = {
+    /**
+     * Metadata of the converter which includes title, mime types, etc.
+     */
+    readonly metadata: ScraperAndConverterMetadata;
+    /**
+     * Convert the the file and returns intermediate source or `null` if it can't convert it
+     *
+     * For example, convert a `.docx` to `.doc` file
+     * Or convert a `.pdf` to `.md` file
+     *
+     * Note: `$` is used to indicate that this function is not a pure function - it leaves files on the disk and you are responsible for cleaning them by calling `destroy` method of returned object
+     */
+    $convert(source: ScraperSourceHandler): Promise<ScraperIntermediateSource>;
+};

package/esm/typings/src/scrapers/_common/Scraper.d.ts

@@ -0,0 +1,66 @@
+import type { Promisable } from 'type-fest';
+import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
+import type { string_filename } from '../../types/typeAliases';
+import type { string_knowledge_source_link } from '../../types/typeAliases';
+import type { string_mime_type } from '../../types/typeAliases';
+import type { string_url } from '../../types/typeAliases';
+import type { ScraperAndConverterMetadata } from './register/ScraperAndConverterMetadata';
+/**
+ * @@@
+ *
+ */
+export type Scraper = {
+    /**
+     * Metadata of the scraper which includes title, mime types, etc.
+     */
+    readonly metadata: ScraperAndConverterMetadata;
+    /**
+     * Scrapes the markdown file and returns the knowledge pieces or `null` if it can't scrape it
+     */
+    scrape(source: ScraperSourceHandler): Promisable<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+};
+/**
+ * @@@
+ */
+export type ScraperSourceHandler = {
+    /**
+     * The source of the knowledge
+     */
+    readonly source: string_knowledge_source_link;
+    /**
+     * The path to the file, if it is a file
+     *
+     * Note: Typically one of the `filename` or `url` is set and the other is `null`
+     */
+    readonly filename: string_filename | null;
+    /**
+     * The URL, if it is online
+     *
+     * Note: Typically one of the `filename` or `url` is set and the other is `null`
+     */
+    readonly url: string_url | null;
+    /**
+     * Mime type of the source
+     */
+    readonly mimeType: string_mime_type;
+    /**
+     * Get the content as parsed JSON
+     */
+    asJson(): Promisable<unknown>;
+    /**
+     * Get the content as a utf-8 string
+     */
+    asText(): Promisable<string>;
+    /**
+     * Get the content as a blob
+     */
+    asBlob(): Promisable<Blob>;
+};
+/**
+ * TODO: [🐝] @@@ Annotate all
+ * TODO: [🔼] Export via types
+ */
+/**
+ * TODO: !!!!!! Test that this is catched
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts

@@ -0,0 +1,11 @@
+import type { IDestroyable } from 'destroyable';
+import type { string_absolute_filename } from '../../types/typeAliases';
+/**
+ * @@@
+ */
+export type ScraperIntermediateSource = IDestroyable & {
+    /**
+     * @@@
+     */
+    readonly filename: string_absolute_filename;
+};

package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.d.ts

@@ -1,13 +1,14 @@
-import type { PrepareOptions } from '../../../prepare/PrepareOptions';
-import type { KnowledgePiecePreparedJson } from '../../../types/PipelineJson/KnowledgePieceJson';
-import type { KnowledgeSourceJson } from '../../../types/PipelineJson/KnowledgeSourceJson';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
+import type { KnowledgeSourceJson } from '../../types/PipelineJson/KnowledgeSourceJson';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
 /**
  * Prepares the knowle
  *
  * @see https://github.com/webgptorg/promptbook/discussions/41
  * @public exported from `@promptbook/core`
  */
-export declare function prepareKnowledgePieces(knowledgeSources: Array<KnowledgeSourceJson>, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'preparationIds'>>>;
+export declare function prepareKnowledgePieces(knowledgeSources: Array<KnowledgeSourceJson>, tools: Pick<ExecutionTools, 'llm' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'preparationIds'>>>;
 /**
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
  *       Put `knowledgePieces` into `PrepareKnowledgeOptions`

package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts

@@ -0,0 +1,12 @@
+import type { ExecutionTools } from '../../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+import type { Scraper } from '../Scraper';
+/**
+ * @@@!!!!!!
+ *
+ * 1) @@@
+ * 2) @@@
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare function $provideScrapersForBrowser(tools: Pick<ExecutionTools, 'llm'>, options?: PrepareAndScrapeOptions): Promise<Array<Scraper>>;

package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts

@@ -0,0 +1,15 @@
+import type { ExecutionTools } from '../../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+import type { Scraper } from '../Scraper';
+/**
+ * !!!!!!
+ *
+ * 1) @@@
+ * 2) @@@
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $provideScrapersForNode(tools: Pick<ExecutionTools, 'llm'>, options?: PrepareAndScrapeOptions): Promise<Array<Scraper>>;
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts

@@ -0,0 +1,12 @@
+import type { string_markdown } from '../../../types/typeAliases';
+/**
+ * Creates a message with all registered scrapers
+ *
+ * Note: This function is used to create a (error) message when there is no scraper for particular mime type
+ *
+ * @private internal function of `createScrapersFromConfiguration` and `createScrapersFromEnv`
+ */
+export declare function $registeredScrapersMessage(): string_markdown;
+/**
+ * TODO: [®] DRY Register logic
+ */

package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts

@@ -0,0 +1,13 @@
+import { $Register } from '../../../utils/$Register';
+import type { ScraperAndConverterMetadata } from './ScraperAndConverterMetadata';
+/**
+ * @@@
+ *
+ * Note: `$` is used to indicate that this interacts with the global scope
+ * @singleton Only one instance of each register is created per build, but thare can be more @@@
+ * @public exported from `@promptbook/core`
+ */
+export declare const $scrapersMetadataRegister: $Register<ScraperAndConverterMetadata>;
+/**
+ * TODO: [®] DRY Register logic
+ */

package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts

@@ -0,0 +1,13 @@
+import { $Register } from '../../../utils/$Register';
+import type { ScraperConstructor } from './ScraperConstructor';
+/**
+ * @@@
+ *
+ * Note: `$` is used to indicate that this interacts with the global scope
+ * @singleton Only one instance of each register is created per build, but thare can be more @@@
+ * @public exported from `@promptbook/core`
+ */
+export declare const $scrapersRegister: $Register<ScraperConstructor>;
+/**
+ * TODO: [®] DRY Register logic
+ */