@promptbook/remote-server 0.72.0-3 → 0.72.0-30

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

@@ -1,6 +1,8 @@
+import type { Promisable } from 'type-fest';
 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_app_id } from '../../../types/typeAliases';
 import type { string_uri } from '../../../types/typeAliases';
 import type { string_user_id } from '../../../types/typeAliases';
 /**
@@ -8,7 +10,7 @@ import type { string_user_id } from '../../../types/typeAliases';
  *
  * There are two modes of remote server:
  *
- * 1) **Collection mode** Server will recieve `collection` and execute prompts only from this collection
+ * 1) **Application mode** Server will recieve `collection` and execute prompts only from this collection
  * 2) **Anonymous mode** Server will recieve full `LlmToolsConfiguration` (with api keys) and just acts as a proxy
  *    In anonymous mode, `collection` will be ignored and any prompt will be executed
  *
@@ -17,7 +19,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<TCustomOptions> = CommonToolsOptions & {
     /**
      * Port on which the server will listen
      */
@@ -29,18 +31,18 @@ export type RemoteServerOptions = CommonExecutionToolsOptions & {
      * @example '/promptbook/socket.io'
      */
     readonly path: string_uri;
-} & (AnonymousRemoteServerOptions | CollectionRemoteServerOptions | (AnonymousRemoteServerOptions & CollectionRemoteServerOptions));
+} & (AnonymousRemoteServerOptions | CollectionRemoteServerOptions<TCustomOptions> | (AnonymousRemoteServerOptions & CollectionRemoteServerOptions<TCustomOptions>));
 export type AnonymousRemoteServerOptions = {
     /**
      * Enable anonymous mode
      */
     readonly isAnonymousModeAllowed: true;
 };
-export type CollectionRemoteServerOptions = {
+export type CollectionRemoteServerOptions<TCustomOptions> = {
     /**
-     * Enable collection mode
+     * Enable application mode
      */
-    readonly isCollectionModeAllowed: true;
+    readonly isApplicationModeAllowed: true;
     /**
      * Promptbook collection to use
      *
@@ -50,9 +52,22 @@ export type CollectionRemoteServerOptions = {
     /**
      * Creates llm execution tools for each client
      */
-    createLlmExecutionTools(userId: string_user_id | undefined): LlmExecutionTools;
+    createLlmExecutionTools(options: CollectionRemoteServerClientOptions<TCustomOptions>): Promisable<LlmExecutionTools>;
+};
+export type CollectionRemoteServerClientOptions<TCustomOptions> = {
+    /**
+     * @@@
+     */
+    readonly appId: string_app_id | null;
+    /**
+     * @@@
+     */
+    readonly userId: string_user_id | null;
+    /**
+     * @@@
+     */
+    readonly customOptions?: TCustomOptions;
 };
 /**
  * TODO: Constrain anonymous mode for specific models / providers
- * TODO: [🧠][🤺] Remove `createLlmExecutionTools`, pass just `llmExecutionTools`
  */

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/llm-providers/remote/startRemoteServer.d.ts

@@ -9,7 +9,7 @@ import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
  * @see https://github.com/webgptorg/promptbook#remote-server
  * @public exported from `@promptbook/remote-server`
  */
-export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
+export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): IDestroyable;
 /**
  * TODO: Maybe use `$asDeeplyFrozenSerializableJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`

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,49 @@
+import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
+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;
+    /**
+     * Strategy for caching the intermediate results for knowledge source
+     *
+     * @default DEFAULT_INTERMEDIATE_FILES_STRATEGY
+     */
+    readonly intermediateFilesStrategy?: IntermediateFilesStrategy;
+    /**
+     * Maximum number of tasks running in parallel
+     *
+     * @default MAX_PARALLEL_COUNT
+     */
+    readonly maxParallelCount?: number;
+    /**
+     * 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' | 'fs' | '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'> & {
     /**
      * @@@
@@ -11,14 +12,14 @@ type PreparedTemplates = {
     /**
      * @@@ Sequence of templates that are chained together to form a pipeline
      */
-    readonly templatesPrepared: Array<TemplateJson>;
+    readonly templatesPrepared: ReadonlyArray<TemplateJson>;
 };
 /**
  * @@@
  *
  * @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' | 'fs' | '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,59 @@
+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<ReadonlyArray<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>;
+};
+/**
+ * TODO: [🥽] Add ` asBlob(): Promisable<Blob>;` or asFile
+ * TODO: [🐝] @@@ Annotate all
+ * TODO: [🔼] Export via types
+ */

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: 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`

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

@@ -0,0 +1,11 @@
+import type { FilesystemTools } from '../../../execution/FilesystemTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+/**
+ * @@@
+ *
+ * @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,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<ReadonlyArray<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, '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/$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
+ */

package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts

@@ -0,0 +1,41 @@
+import type { Executables } from '../../../execution/Executables';
+import type { string_mime_type } from '../../../types/typeAliases';
+import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
+import type { string_title } from '../../../types/typeAliases';
+import type { Registered } from '../../../utils/$Register';
+/**
+ * @@@
+ *
+ * @@@
+ * x) `Scraper`
+ * x) `Converter`
+ * x) `ScraperConstructor`
+ * x) `Registered`
+ * x) `ExecutionTools`
+ * x) `ScraperAndConverterMetadata`
+ * x) `PrepareAndScrapeOptions`
+ * x) `ScraperConfiguration`
+ * x) `ScraperOptions`
+ */
+export type ScraperAndConverterMetadata = Registered & {
+    /**
+     * @@@
+     */
+    readonly title: string_title;
+    /**
+     * Mime types that this scraper can handle
+     */
+    readonly mimeTypes: ReadonlyArray<string_mime_type>;
+    /**
+     * @@@
+     */
+    readonly isAvilableInBrowser: boolean;
+    /**
+     * @@@
+     */
+    readonly requiredExecutables: ReadonlyArray<Capitalize<keyof Executables extends `${infer N}Path` ? N : never>>;
+    /**
+     * Link to documentation
+     */
+    readonly documentationUrl: string_promptbook_documentation_url;
+};

package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts

@@ -0,0 +1,12 @@
+import type { ExecutionTools } from '../../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+import type { Registered } from '../../../utils/$Register';
+import type { Scraper } from '../Scraper';
+import type { ScraperAndConverterMetadata } from './ScraperAndConverterMetadata';
+/**
+ * @@@
+ */
+export type ScraperConstructor = Registered & ScraperAndConverterMetadata & ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => Scraper);
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts

@@ -0,0 +1,34 @@
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+import type { string_file_extension } from '../../../types/typeAliases';
+import type { ScraperSourceHandler } from '../Scraper';
+import type { ScraperIntermediateSource } from '../ScraperIntermediateSource';
+/**
+ * @@@
+ *
+ * @private internal utility of `getScraperIntermediateSource`
+ */
+type GetScraperIntermediateSourceSource = Pick<ScraperSourceHandler, 'filename' | 'url'>;
+/**
+ * @@@
+ *
+ * @private internal utility of `getScraperIntermediateSource`
+ */
+type GetScraperIntermediateSourceHandler = Required<Pick<PrepareAndScrapeOptions, 'rootDirname' | 'cacheDirname' | 'intermediateFilesStrategy' | 'isVerbose'>> & {
+    readonly extension: string_file_extension;
+};
+/**
+ * Create a filename for intermediate cache for scrapers
+ *
+ * Note: It also checks if directory exists and creates it if not
+ *
+ * @private as internal utility for scrapers
+ */
+export declare function getScraperIntermediateSource(source: GetScraperIntermediateSourceSource, options: GetScraperIntermediateSourceHandler): Promise<ScraperIntermediateSource>;
+export {};
+/**
+ * Note: Not using `FileCacheStorage` for two reasons:
+ * 1) Need to store more than serialized JSONs
+ * 2) Need to switch between a `rootDirname` and `cacheDirname` <- TODO: [😡]
+ * TODO: [🐱‍🐉][🧠] Make some smart crop
+ * 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/utils/getScraperIntermediateSource.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🐱‍🐉][🧠] Make some smart crop
+ */

package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts

@@ -0,0 +1,11 @@
+import type { SetOptional } from 'type-fest';
+import type { ExecutionTools } from '../../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+import type { KnowledgeSourceJson } from '../../../types/PipelineJson/KnowledgeSourceJson';
+import type { ScraperSourceHandler } from '../Scraper';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function makeKnowledgeSourceHandler(knowledgeSource: SetOptional<KnowledgeSourceJson, 'name'>, tools: Pick<ExecutionTools, 'fs'>, options?: Pick<PrepareAndScrapeOptions, 'rootDirname' | 'isVerbose'>): Promise<ScraperSourceHandler>;

package/esm/typings/src/scrapers/document/DocumentScraper.d.ts

@@ -0,0 +1,43 @@
+import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+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 .docx and .odt files
+ *
+ * @see `documentationUrl` for more details
+ * @public exported from `@promptbook/documents`
+ */
+export declare class DocumentScraper 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 `.docx` or `.odt`  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 11:11
+ * 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/document/DocumentScraper.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [📓] Maybe test all file in samples (not just 10-simple.docx)
+ */

package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts

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

package/esm/typings/src/scrapers/document/playground/document-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/document/register-constructor.d.ts

@@ -0,0 +1,13 @@
+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/documents`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _DocumentScraperRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

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

@@ -0,0 +1,24 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Metadata of the scraper
+ *
+ * @private within the scraper directory
+ */
+export declare const documentScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    title: string;
+    packageName: string;
+    className: string;
+    mimeTypes: string[];
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    isAvilableInBrowser: false;
+    requiredExecutables: "Pandoc"[];
+}>;
+/**
+ * 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/cli`
+ */
+export declare const _DocumentScraperMetadataRegistration: Registration;