@promptbook/legacy-documents 0.72.0-13 → 0.72.0-15

package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -1,28 +1,31 @@
-import type { ReadonlyDeep } from 'type-fest';
+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;
     /**
@@ -44,15 +47,7 @@ export type ExecuteAttemptsOptions = {
     /**
      * @@@
      */
-    readonly tools: ExecutionTools;
-    /**
-     * 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/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/register/$provideLlmToolsForCli.d.ts

@@ -1,11 +1,11 @@
-import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+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 $provideLlmToolsForCli(options?: Pick<PrepareAndScrapeOptions, 'isCacheCleaned'>): LlmExecutionToolsWithTotalUsage;
+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

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

@@ -6,7 +6,7 @@ import type { LlmToolsOptions } from './LlmToolsOptions';
  *
  * @@@ `LlmToolsMetadata` vs `LlmToolsConfiguration` vs `LlmToolsOptions` (vs `Registered`)
  */
-export type LlmToolsConfiguration = Array<Registered & {
+export type LlmToolsConfiguration = ReadonlyArray<Registered & {
     /**
      * @@@
      */

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

@@ -1,3 +1,4 @@
+import type { string_user_id } from '../../../types/typeAliases';
 import { MultipleLlmExecutionTools } from '../../multiple/MultipleLlmExecutionTools';
 import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
 /**
@@ -12,6 +13,12 @@ export type CreateLlmToolsFromConfigurationOptions = {
      * @default false
      */
     isVerbose?: boolean;
+    /**
+     * Identifier of the end user
+     *
+     * Note: This is passed to the LLM tools providers to identify misuse
+     */
+    readonly userId?: string_user_id | null;
 };
 /**
  * @@@

package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts

@@ -1,5 +1,8 @@
 import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
 import type { CacheItem } from './CacheItem';
+/**
+ * @@@
+ */
 export type CacheLlmToolsOptions = {
     /**
      * @@@
@@ -12,5 +15,5 @@ export type CacheLlmToolsOptions = {
      *
      * @default false
      */
-    isReloaded?: boolean;
+    isCacheReloaded?: boolean;
 };

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

@@ -35,7 +35,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
     /**
      * List all available Anthropic Claude models that can be used
      */
-    listModels(): Array<AvailableModel>;
+    listModels(): ReadonlyArray<AvailableModel>;
     /**
      * Calls Anthropic Claude API to use a chat model.
      */

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

@@ -8,7 +8,7 @@ import type { number_usd } from '../../types/typeAliases';
  * @see https://docs.anthropic.com/en/docs/models-overview
  * @public exported from `@promptbook/anthropic-claude`
  */
-export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
+export declare const ANTHROPIC_CLAUDE_MODELS: ReadonlyArray<AvailableModel & {
     pricing?: {
         readonly prompt: number_usd;
         readonly output: number_usd;

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

@@ -35,7 +35,7 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
     /**
      * List all available Azure OpenAI models that can be used
      */
-    listModels(): Promise<Array<AvailableModel>>;
+    listModels(): Promise<ReadonlyArray<AvailableModel>>;
     /**
      * Calls OpenAI API to use a chat model.
      */

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

@@ -9,7 +9,7 @@ import type { string_postprocessing_function_name } from '../../types/typeAliase
  *
  * @private internal utility for MockedFackedLlmExecutionTools
  */
-export declare function $fakeTextToExpectations(expectations: Expectations, postprocessingFunctionNames?: Array<string_postprocessing_function_name>): Promise<string>;
+export declare function $fakeTextToExpectations(expectations: Expectations, postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>): Promise<string>;
 /**
  * TODO: [💝] Unite object for expecting amount and format - use here also a format
  */

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

@@ -24,7 +24,7 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     /**
      * List all available mocked-models that can be used
      */
-    listModels(): Array<AvailableModel>;
+    listModels(): ReadonlyArray<AvailableModel>;
     /**
      * Mocks chat model
      */

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

@@ -25,7 +25,7 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
     /**
      * List all available fake-models that can be used
      */
-    listModels(): Array<AvailableModel>;
+    listModels(): ReadonlyArray<AvailableModel>;
     /**
      * Fakes chat model
      */

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

@@ -15,18 +15,17 @@ import type { string_title } from '../../types/typeAliases';
  * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
  *
  * Note: Internal utility of `joinLlmExecutionTools` but exposed type
- * @public exported from `@promptbook/types`
- * TODO: !!!!!! Export as runtime class not just type
+ * @public exported from `@promptbook/core`
  */
 export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
     /**
      * Array of execution tools in order of priority
      */
-    readonly llmExecutionTools: Array<LlmExecutionTools>;
+    readonly llmExecutionTools: ReadonlyArray<LlmExecutionTools>;
     /**
      * Gets array of execution tools in order of priority
      */
-    constructor(...llmExecutionTools: Array<LlmExecutionTools>);
+    constructor(...llmExecutionTools: ReadonlyArray<LlmExecutionTools>);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     /**
@@ -37,7 +36,7 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
      * List all available models that can be used
      * This lists is a combination of all available models from all execution tools
      */
-    listModels(): Promise<Array<AvailableModel>>;
+    listModels(): Promise<ReadonlyArray<AvailableModel>>;
     /**
      * Calls the best available chat model
      */

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

@@ -15,7 +15,7 @@ import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
  *
  * @public exported from `@promptbook/core`
  */
-export declare function joinLlmExecutionTools(...llmExecutionTools: Array<LlmExecutionTools>): MultipleLlmExecutionTools;
+export declare function joinLlmExecutionTools(...llmExecutionTools: ReadonlyArray<LlmExecutionTools>): MultipleLlmExecutionTools;
 /**
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */

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

@@ -45,7 +45,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     /**
      * List all available OpenAI models that can be used
      */
-    listModels(): Array<AvailableModel>;
+    listModels(): ReadonlyArray<AvailableModel>;
     /**
      * Calls OpenAI API to use a chat model.
      */

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

@@ -9,7 +9,7 @@ import type { number_usd } from '../../types/typeAliases';
  * @see https://openai.com/api/pricing/
  * @public exported from `@promptbook/openai`
  */
-export declare const OPENAI_MODELS: Array<AvailableModel & {
+export declare const OPENAI_MODELS: ReadonlyArray<AvailableModel & {
     pricing?: {
         readonly prompt: number_usd;
         readonly output: number_usd;

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

@@ -31,7 +31,7 @@ export declare class RemoteLlmExecutionTools<TCustomOptions = undefined> impleme
     /**
      * List all available models that can be used
      */
-    listModels(): Promise<Array<AvailableModel>>;
+    listModels(): Promise<ReadonlyArray<AvailableModel>>;
     /**
      * Creates a connection to the remote proxy server.
      */

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

@@ -4,12 +4,12 @@ import type { AvailableModel } from '../../../execution/AvailableModel';
  *
  * This is sent from server to client when models are listed
  */
-export interface PromptbookServer_ListModels_Response {
+export type PromptbookServer_ListModels_Response = {
     /**
      * Available models that can be used
      */
-    readonly models: Array<AvailableModel>;
-}
+    readonly models: ReadonlyArray<AvailableModel>;
+};
 /**
  * TODO: [👒] Listing models (and checking configuration) probbably should go through REST API not Socket.io
  */

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

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

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

@@ -1,3 +1,4 @@
+import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
 import type { string_dirname } from '../types/typeAliases';
 /**
  * Options for preparation of the pipeline
@@ -21,37 +22,17 @@ export type PrepareAndScrapeOptions = {
      */
     readonly cacheDirname?: string_dirname;
     /**
-     * If true, the cache is cleaned after the scraping
+     * Strategy for caching the intermediate results for knowledge source
      *
-     *
-     * @default false // <- TODO: !!!!!! Change to `cacheStrategy`/`intermediateFiles`, Put to global config, change to `true` and explicitly set to `false` in all playgrounds
+     * @default DEFAULT_INTERMEDIATE_FILES_STRATEGY
      */
-    readonly isCacheCleaned?: boolean;
+    readonly intermediateFilesStrategy?: IntermediateFilesStrategy;
     /**
      * 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
      */

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

@@ -12,7 +12,7 @@ type PreparedTemplates = {
     /**
      * @@@ Sequence of templates that are chained together to form a pipeline
      */
-    readonly templatesPrepared: Array<TemplateJson>;
+    readonly templatesPrepared: ReadonlyArray<TemplateJson>;
 };
 /**
  * @@@

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

@@ -17,7 +17,7 @@ export type Scraper = {
     /**
      * 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>;
+    scrape(source: ScraperSourceHandler): Promisable<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
 };
 /**
  * @@@
@@ -60,7 +60,3 @@ export type ScraperSourceHandler = {
  * 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/prepareKnowledgePieces.d.ts

@@ -8,7 +8,7 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
  * @see https://github.com/webgptorg/promptbook/discussions/41
  * @public exported from `@promptbook/core`
  */
-export declare function prepareKnowledgePieces(knowledgeSources: Array<KnowledgeSourceJson>, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): 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/$provideExecutablesForNode.d.ts

@@ -0,0 +1,12 @@
+import type { Executables } from '../../../execution/Executables';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $provideExecutablesForNode(options?: PrepareAndScrapeOptions): Promise<Executables>;
+/**
+ * TODO: [🧠] THis should be maybe in different folder
+ * 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

@@ -2,11 +2,11 @@ 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>>;
+export declare function $provideScrapersForBrowser(tools: Pick<ExecutionTools, 'llm'>, options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<Scraper>>;

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

@@ -2,14 +2,14 @@ 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'>, options?: PrepareAndScrapeOptions): Promise<Array<Scraper>>;
+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/ScraperAndConverterMetadata.d.ts

@@ -1,8 +1,8 @@
+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';
-import type { TODO_any } from '../../../utils/organization/TODO_any';
 /**
  * @@@
  *
@@ -33,7 +33,7 @@ export type ScraperAndConverterMetadata = Registered & {
     /**
      * @@@
      */
-    readonly requiredExecutables: TODO_any;
+    readonly requiredExecutables: ReadonlyArray<Capitalize<keyof Executables extends `${infer N}Path` ? N : never>>;
     /**
      * Link to documentation
      */

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

@@ -13,7 +13,7 @@ type GetScraperIntermediateSourceSource = Pick<ScraperSourceHandler, 'filename'
  *
  * @private internal utility of `getScraperIntermediateSource`
  */
-type GetScraperIntermediateSourceHandler = Required<Pick<PrepareAndScrapeOptions, 'rootDirname' | 'cacheDirname' | 'isCacheCleaned' | 'isVerbose'>> & {
+type GetScraperIntermediateSourceHandler = Required<Pick<PrepareAndScrapeOptions, 'rootDirname' | 'cacheDirname' | 'intermediateFilesStrategy' | 'isVerbose'>> & {
     readonly extension: string_file_extension;
 };
 /**
@@ -28,7 +28,7 @@ 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: !!!!
+ * 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/document/DocumentScraper.d.ts

@@ -23,7 +23,7 @@ export declare class DocumentScraper implements Converter, Scraper {
      * Markdown scraper is used internally
      */
     private readonly markdownScraper;
-    constructor(tools: Pick<ExecutionTools, 'fs' | 'llm'>, options: PrepareAndScrapeOptions);
+    constructor(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options: PrepareAndScrapeOptions);
     /**
      * Convert the `.docx` or `.odt`  to `.md` file and returns intermediate source
      *
@@ -33,7 +33,7 @@ export declare class DocumentScraper implements Converter, Scraper {
     /**
      * Scrapes the docx file and returns the knowledge pieces or `null` if it can't scrape it
      */
-    scrape(source: ScraperSourceHandler): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+    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

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

@@ -13,7 +13,7 @@ export declare const createDocumentScraper: ((tools: Pick<ExecutionTools, 'llm'>
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: false;
-    requiredExecutables: string[];
+    requiredExecutables: "Pandoc"[];
 }>;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"

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

@@ -11,7 +11,7 @@ export declare const documentScraperMetadata: import("type-fest/source/readonly-
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: false;
-    requiredExecutables: string[];
+    requiredExecutables: "Pandoc"[];
 }>;
 /**
  * Registration of known scraper metadata

package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts

@@ -7,7 +7,7 @@ import type { Scraper } from '../_common/Scraper';
 import type { ScraperSourceHandler } from '../_common/Scraper';
 import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
 /**
- * Scraper for .docx files
+ * Scraper for old document files (like .doc and .rtf)
  *
  * @see `documentationUrl` for more details
  * @public exported from `@promptbook/legacy-documents`
@@ -23,7 +23,7 @@ export declare class LegacyDocumentScraper implements Converter, Scraper {
      * Document scraper is used internally
      */
     private readonly documentScraper;
-    constructor(tools: Pick<ExecutionTools, 'fs' | 'llm'>, options: PrepareAndScrapeOptions);
+    constructor(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options: PrepareAndScrapeOptions);
     /**
      * Convert the `.doc` or `.rtf`  to `.doc` file and returns intermediate source
      *
@@ -33,7 +33,7 @@ export declare class LegacyDocumentScraper implements Converter, Scraper {
     /**
      * Scrapes the `.doc` or `.rtf` file and returns the knowledge pieces or `null` if it can't scrape it
      */
-    scrape(source: ScraperSourceHandler): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+    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

package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts

@@ -13,7 +13,7 @@ export declare const createLegacyDocumentScraper: ((tools: Pick<ExecutionTools,
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: false;
-    requiredExecutables: string[];
+    requiredExecutables: ("Pandoc" | "LibreOffice")[];
 }>;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"

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

@@ -11,7 +11,7 @@ export declare const legacyDocumentScraperMetadata: import("type-fest/source/rea
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: false;
-    requiredExecutables: string[];
+    requiredExecutables: ("Pandoc" | "LibreOffice")[];
 }>;
 /**
  * Registration of known scraper metadata

package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts

@@ -21,7 +21,7 @@ export declare class MarkdownScraper implements Scraper {
     /**
      * Scrapes the markdown file and returns the knowledge pieces or `null` if it can't scrape it
      */
-    scrape(source: ScraperSourceHandler): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+    scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
 }
 /**
  * TODO: [🪂] Do it in parallel 11:11

package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts

@@ -13,7 +13,7 @@ export declare const createMarkdownScraper: ((tools: Pick<ExecutionTools, 'llm'>
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: true;
-    requiredExecutables: string[];
+    requiredExecutables: never[];
 }>;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"