@promptbook/wizard 0.95.0

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,25 @@
+import type { RemoteServer } from './RemoteServer';
+import type { RemoteServerOptions } from './types/RemoteServerOptions';
+/**
+ * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
+ *
+ * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
+ * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
+ *
+ * @see https://github.com/webgptorg/promptbook#remote-server
+ * @public exported from `@promptbook/remote-server`
+ */
+export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): RemoteServer;
+/**
+ * TODO: [🌡] Add CORS and security - probably via `helmet`
+ * TODO: Split this file into multiple functions - handler for each request
+ * TODO: Maybe use `$exportJson`
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [⚖] Expose the collection to be able to connect to same collection via createCollectionFromUrl
+ * TODO: Handle progress - support streaming
+ * TODO: [🗯] Do not hang up immediately but wait until client closes OR timeout
+ * TODO: [🗯] Timeout on chat to free up resources
+ * TODO: [🃏] Pass here some security token to prevent malitious usage and/or DDoS
+ * TODO: [0] Set unavailable models as undefined in `RemoteLlmExecutionTools` NOT throw error here
+ * TODO: Allow to constrain anonymous mode for specific models / providers
+ */

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

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

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

@@ -0,0 +1,164 @@
+import type { Request, Response } from 'express';
+import type { Promisable } from 'type-fest';
+import type { PipelineCollection } from '../../collection/PipelineCollection';
+import { AuthenticationError } from '../../errors/AuthenticationError';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { string_app_id } from '../../types/typeAliases';
+import type { string_email } from '../../types/typeAliases';
+import type { string_password } from '../../types/typeAliases';
+import type { string_token } from '../../types/typeAliases';
+import type { string_user_id } from '../../types/typeAliases';
+import type { ApplicationModeIdentification } from '../socket-types/_subtypes/Identification';
+import type { Identification } from '../socket-types/_subtypes/Identification';
+/**
+ * Options for configuring the Promptbook remote server.
+ *
+ * There are two modes of remote server:
+ *
+ * 1) **Application mode** Server will receive `collection` and execute prompts only from this collection
+ * 2) **Anonymous mode** Server will receive full `LlmToolsConfiguration` (with api keys) and just acts as a proxy
+ *    In anonymous mode, `collection` will be ignored and any prompt will be executed
+ *
+ * You can enable both modes at the same time.
+ *
+ * @public exported from `@promptbook/remote-server`
+ */
+export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
+    /**
+     * Port on which the server will listen
+     * @property {number} port The port number the server will listen on.
+     */
+    readonly port: number;
+    /**
+     * Creates execution tools the client
+     *
+     * This is relevant also in anonymous mode in opposition to `createLlmExecutionTools`
+     *
+     * Note: You can provide only some tools and leave the rest to the default ones also llm tools are created by `createLlmExecutionTools`
+     * Note: This is useful when you want to provide some custom restrictions for example:
+     * - Limit access to certain websites for some users
+     * - Bind user-interface tools to email agent
+     * - Allow / block script execution
+     * - And many more
+     */
+    createExecutionTools?(options: Identification<TCustomOptions>): Promisable<Partial<Omit<ExecutionTools, 'llm'>>>;
+} & ((AnonymousRemoteServerOptions & {
+    readonly isApplicationModeAllowed?: false;
+}) | ({
+    readonly isAnonymousModeAllowed?: false;
+} & ApplicationRemoteServerOptions<TCustomOptions>) | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
+export type AnonymousRemoteServerOptions = {
+    /**
+     * Enable anonymous mode
+     */
+    readonly isAnonymousModeAllowed: true;
+};
+export type ApplicationRemoteServerOptions<TCustomOptions> = {
+    /**
+     * Enable application mode
+     */
+    readonly isApplicationModeAllowed: true;
+    /**
+     * Promptbook collection to use
+     *
+     * This is used to check validity of the prompt to prevent misuse
+     */
+    readonly collection: PipelineCollection;
+    /**
+     * User tries to login to the server, this function will be called verify the user and return the identification or throw an error
+     * This can be also doubled as a function to register the user
+     *
+     * Note: In most cases, you will return `PromptbookServer_ApplicationIdentification`
+     *       `PromptbookServer_AnonymousIdentification` is useful only in scenarios when user stores its own api keys on the application server and
+     *       server acts only as a api key provider
+     *
+     * Note: In most cases DO NOT THROW `AuthenticationError` but return `isSuccess: false` with message
+     * @throws `AuthenticationError`  if the user is not allowed to login for example because of invalid credentials
+     */
+    login(loginRequest: LoginRequest): Promise<LoginResponse<TCustomOptions>>;
+    /**
+     * Creates llm execution tools for each client
+     */
+    createLlmExecutionTools(options: ApplicationModeIdentification<TCustomOptions>): Promisable<LlmExecutionTools>;
+};
+export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
+    /**
+     * Identifier of the application
+     *
+     * Note: This is useful when you use Promptbook remote server for multiple apps/frontends, if its used just for single app, use here just "app" or "your-app-name"
+     * Note: This can be some id or some semantic name like "email-agent"
+     */
+    readonly appId: string_app_id | null;
+    /**
+     * Identifier of the end user
+     *
+     * Note: This can be either some id or email or any other identifier
+     * Note: This is also passed to the certain model providers to identify misuse
+     */
+    readonly userId?: string_user_id;
+    /**
+     * Token of the user to verify its identity
+     *
+     * Note: This is passed for example to `createLlmExecutionTools`
+     */
+    readonly userToken?: string_token;
+    /**
+     * Additional arbitrary options to identify the client or to pass custom metadata
+     */
+    readonly customOptions?: TCustomOptions;
+};
+/**
+ * Login request for the application mode
+ */
+export type LoginRequest = {
+    /**
+     * Identifier of the application you are using
+     *
+     * Note: This is useful when you use Promptbook remote server for multiple apps/frontends, if its used just for single app, use here just "app" or "your-app-name"
+     */
+    readonly appId: string_app_id | null;
+    /**
+     * Username (for example email) of the user
+     */
+    readonly username: string_email | string;
+    /**
+     * Password of the user
+     */
+    readonly password: string_password;
+    /**
+     * Request object from express if you want to access some request data for example headers, IP address, etc.
+     */
+    readonly rawRequest: Request;
+    /**
+     * Response object from express if you want to add some custom headers.
+     *
+     * Note: It is not recommended to use this object to send body of the response because it can confuse the client
+     */
+    readonly rawResponse: Response;
+};
+/**
+ * Login response for the application mode
+ */
+export type LoginResponse<TCustomOptions> = {
+    /**
+     * Was the login successful
+     */
+    readonly isSuccess: boolean;
+    /**
+     * Message to display to the user, this message is always displayed
+     */
+    readonly message?: string;
+    /**
+     * Optional error if the login was not successful
+     */
+    readonly error?: AuthenticationError;
+    /**
+     * Identification of the user to be used in the future requests
+     */
+    readonly identification?: Identification<TCustomOptions>;
+};
+/**
+ * TODO: Constrain anonymous mode for specific models / providers
+ */

package/esm/typings/src/scrapers/_boilerplate/BoilerplateScraper.d.ts

@@ -0,0 +1,43 @@
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import type { Converter } from '../_common/Converter';
+import type { ScraperAndConverterMetadata } from '../_common/register/ScraperAndConverterMetadata';
+import type { Scraper } from '../_common/Scraper';
+import type { ScraperSourceHandler } from '../_common/Scraper';
+import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
+/**
+ * Scraper of @@ files
+ *
+ * @see `documentationUrl` for more details
+ * @public exported from `@promptbook/boilerplate`
+ */
+export declare class BoilerplateScraper implements Converter, Scraper {
+    private readonly tools;
+    private readonly options;
+    /**
+     * Metadata of the scraper which includes title, mime types, etc.
+     */
+    get metadata(): ScraperAndConverterMetadata;
+    /**
+     * Markdown scraper is used internally
+     */
+    private readonly markdownScraper;
+    constructor(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options: PrepareAndScrapeOptions);
+    /**
+     * Convert the `.@@`  to `.md` file and returns intermediate source
+     *
+     * 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>;
+    /**
+     * Scrapes the docx file and returns the knowledge pieces or `null` if it can't scrape it
+     */
+    scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+}
+/**
+ * TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
+ * TODO: [🪂] Do it in parallel
+ * Note: No need to aggregate usage here, it is done by intercepting the llmTools
+ * @@ Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts

@@ -0,0 +1,20 @@
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import { BoilerplateScraper } from './BoilerplateScraper';
+/**
+ * Constructor of `BoilerplateScraper`
+ *
+ * @public exported from `@promptbook/boilerplate`
+ */
+export declare const createBoilerplateScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => BoilerplateScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    title: string;
+    packageName: string;
+    className: string;
+    mimeTypes: string[];
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    isAvailableInBrowser: false;
+    requiredExecutables: never[];
+}>;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts

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

package/esm/typings/src/scrapers/_boilerplate/register-constructor.d.ts

@@ -0,0 +1,15 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of known scraper
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
+ *
+ * @public exported from `@promptbook/boilerplate`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _BoilerplateScraperRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts

@@ -0,0 +1,28 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Metadata of the scraper
+ *
+ * @private within the scraper directory
+ */
+export declare const boilerplateScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    title: string;
+    packageName: string;
+    className: string;
+    mimeTypes: string[];
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    isAvailableInBrowser: false;
+    requiredExecutables: never[];
+}>;
+/**
+ * Registration of known scraper metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _BoilerplateScraperMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,25 @@
+import type { ScraperAndConverterMetadata } from './register/ScraperAndConverterMetadata';
+import type { ScraperSourceHandler } from './Scraper';
+import type { ScraperIntermediateSource } from './ScraperIntermediateSource';
+/**
+ * Interface defining the requirements for converter implementations.
+ * Converters transform scraped content from one format to another,
+ * optimizing it for knowledge extraction and processing.
+ *
+ * Note: [🌏] Converters are not usable in browser because they produce a files
+ */
+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,60 @@
+import type { Promisable } from 'type-fest';
+import type { KnowledgePiecePreparedJson } from '../../pipeline/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';
+/**
+ * Interface defining the requirements for scraper implementations.
+ * Scrapers are responsible for extracting structured content from various knowledge sources.
+ */
+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<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+};
+/**
+ * Handler for accessing and processing content from diverse knowledge sources.
+ * Provides standardized methods to interact with files, URLs and raw text sources.
+ */
+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>;
+};
+/**
+ * TODO: [🧠] Maybe split `ScraperSourceHandler` into `ScraperWebsiteSourceHandler` + `ScraperFileSourceHandler`
+ * TODO: [🥽] Add ` asBlob(): Promisable<Blob>;` or asFile
+ * TODO: [🔼] Export via types
+ */

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

@@ -0,0 +1,16 @@
+import type { IDestroyable } from 'destroyable';
+import type { string_absolute_filename } from '../../types/typeAliases';
+/**
+ * Interface representing an intermediate storage location for scraper results.
+ * Provides functionality for caching and managing temporary data during scraping operations.
+ */
+export type ScraperIntermediateSource = IDestroyable & {
+    /**
+     * The absolute path to the file where intermediate data is stored.
+     * This file serves as a cache for scraped content to avoid redundant processing.
+     */
+    readonly filename: string_absolute_filename;
+};
+/**
+ * Note: [🌏] Converters can be used only in node because they uses `ScraperIntermediateSource` which  uses file system
+ */

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

@@ -0,0 +1,19 @@
+import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
+import type { KnowledgeSourceJson } from '../../pipeline/PipelineJson/KnowledgeSourceJson';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+/**
+ * Prepares the knowledge pieces
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/41
+ * @public exported from `@promptbook/core`
+ */
+export declare function prepareKnowledgePieces(knowledgeSources: ReadonlyArray<KnowledgeSourceJson>, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'preparationIds'>>>;
+/**
+ * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
+ *       Put `knowledgePieces` into `PrepareKnowledgeOptions`
+ * TODO: [🪂] More than max things can run in parallel by accident [1,[2a,2b,_],[3a,3b,_]]
+ * TODO: [🧠][❎] Do here proper M:N mapping
+ *       [x] One source can make multiple pieces
+ *       [ ] One piece can have multiple sources
+ */

package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,12 @@
+import type { FilesystemTools } from '../../../execution/FilesystemTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+/**
+ * Provides filesystem access (for example for Node.js-based scrapers)
+ * Creates a standardized filesystem interface that scrapers can use for file operations.
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $provideFilesystemForNode(options?: Pick<PrepareAndScrapeOptions, 'isVerbose'>): FilesystemTools;
+/**
+ * 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/$provideScrapersForBrowser.d.ts

@@ -0,0 +1,15 @@
+import type { ExecutionTools } from '../../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+import type { Scraper } from '../Scraper';
+/**
+ * Provides a collection of scrapers optimized for browser environments.
+ * Only includes scrapers that can safely run in a browser context.
+ *
+ * Note: Browser scrapers have limitations compared to Node.js scrapers.
+ *
+ * 1) `provideScrapersForNode` use as default
+ * 2) `provideScrapersForBrowser` use in limited browser environment
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare function $provideScrapersForBrowser(tools: Pick<ExecutionTools, 'llm'>, options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<Scraper>>;

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

@@ -0,0 +1,13 @@
+import type { ExecutionTools } from '../../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+import type { Scraper } from '../Scraper';
+/**
+ * Provides a collection of scrapers optimized for Node.js environment.
+ * 1) `provideScrapersForNode` use as default
+ * 2) `provideScrapersForBrowser` use in limited browser environment *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $provideScrapersForNode(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<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/$provideScriptingForNode.d.ts

@@ -0,0 +1,11 @@
+import type { ScriptExecutionTools } from '../../../execution/ScriptExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+/**
+ * Provides script execution tools
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $provideScriptingForNode(options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<ScriptExecutionTools>>;
+/**
+ * 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,13 @@
+import type { string_markdown } from '../../../types/typeAliases';
+import type { Scraper } from '../Scraper';
+/**
+ * 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(availableScrapers: ReadonlyArray<Scraper>): 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';
+/**
+ * Global registry for storing metadata about all available scrapers and converters.
+ *
+ * Note: `$` is used to indicate that this interacts with the global scope.
+ * @singleton Only one instance of each register is created per build, but there can be more in different contexts (e.g., tests).
+ * @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,14 @@
+import { $Register } from '../../../utils/$Register';
+import type { ScraperConstructor } from './ScraperConstructor';
+/**
+ * Registry for all available scrapers in the system.
+ * Central point for registering and accessing different types of content scrapers.
+ *
+ * Note: `$` is used to indicate that this interacts with the global scope
+ * @singleton Only one instance of each register is created per build, but there can be more than one in different build modules
+ * @public exported from `@promptbook/core`
+ */
+export declare const $scrapersRegister: $Register<ScraperConstructor>;
+/**
+ * TODO: [®] DRY Register logic
+ */