@promptbook/legacy-documents 0.71.0-17 → 0.71.0-19

package/esm/typings/src/_packages/core.index.d.ts

@@ -7,20 +7,21 @@ import { createSubcollection } from '../collection/constructors/createSubcollect
 import type { TemplateType } from '../commands/TEMPLATE/TemplateTypes';
 import { TemplateTypes } from '../commands/TEMPLATE/TemplateTypes';
 import { CLAIM } from '../config';
-import { MAX_PARALLEL_COUNT } from '../config';
-import { MAX_EXECUTION_ATTEMPTS } from '../config';
 import { MAX_FILENAME_LENGTH } from '../config';
-import { MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH } from '../config';
-import { MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL } from '../config';
-import { EXECUTIONS_CACHE_DIRNAME } from '../config';
-import { SCRAPE_CACHE_DIRNAME } from '../config';
-import { PIPELINE_COLLECTION_BASE_FILENAME } from '../config';
+import { DEFAULT_INTERMEDIATE_FILES_STRATEGY } from '../config';
+import { DEFAULT_MAX_PARALLEL_COUNT } from '../config';
+import { DEFAULT_MAX_EXECUTION_ATTEMPTS } from '../config';
+import { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH } from '../config';
+import { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL } from '../config';
+import { DEFAULT_EXECUTIONS_CACHE_DIRNAME } from '../config';
+import { DEFAULT_SCRAPE_CACHE_DIRNAME } from '../config';
+import { DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME } from '../config';
 import { RESERVED_PARAMETER_NAMES } from '../config';
 import { DEFAULT_REMOTE_URL } from '../config';
 import { DEFAULT_REMOTE_URL_PATH } from '../config';
 import { DEFAULT_CSV_SETTINGS } from '../config';
-import { IS_VERBOSE } from '../config';
-import { IS_AUTO_INSTALLED } from '../config';
+import { DEFAULT_IS_VERBOSE } from '../config';
+import { DEFAULT_IS_AUTO_INSTALLED } from '../config';
 import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
 import { pipelineStringToJson } from '../conversion/pipelineStringToJson';
 import { pipelineStringToJsonSync } from '../conversion/pipelineStringToJsonSync';
@@ -65,6 +66,7 @@ import { limitTotalUsage } from '../llm-providers/_common/utils/count-total-usag
 import { _AnthropicClaudeMetadataRegistration } from '../llm-providers/anthropic-claude/register-configuration';
 import { _AzureOpenAiMetadataRegistration } from '../llm-providers/azure-openai/register-configuration';
 import { joinLlmExecutionTools } from '../llm-providers/multiple/joinLlmExecutionTools';
+import { MultipleLlmExecutionTools } from '../llm-providers/multiple/MultipleLlmExecutionTools';
 import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { preparePersona } from '../personas/preparePersona';
 import { isPipelinePrepared } from '../prepare/isPipelinePrepared';
@@ -74,6 +76,7 @@ import { unpreparePipeline } from '../prepare/unpreparePipeline';
 import { prepareKnowledgePieces } from '../scrapers/_common/prepareKnowledgePieces';
 import { $scrapersMetadataRegister } from '../scrapers/_common/register/$scrapersMetadataRegister';
 import { $scrapersRegister } from '../scrapers/_common/register/$scrapersRegister';
+import { makeKnowledgeSourceHandler } from '../scrapers/_common/utils/makeKnowledgeSourceHandler';
 import { _LegacyDocumentScraperMetadataRegistration } from '../scrapers/document-legacy/register-metadata';
 import { _DocumentScraperMetadataRegistration } from '../scrapers/document/register-metadata';
 import { _MarkdownScraperMetadataRegistration } from '../scrapers/markdown/register-metadata';
@@ -95,20 +98,21 @@ export { createSubcollection };
 export type { TemplateType };
 export { TemplateTypes };
 export { CLAIM };
-export { MAX_PARALLEL_COUNT };
-export { MAX_EXECUTION_ATTEMPTS };
 export { MAX_FILENAME_LENGTH };
-export { MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH };
-export { MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL };
-export { EXECUTIONS_CACHE_DIRNAME };
-export { SCRAPE_CACHE_DIRNAME };
-export { PIPELINE_COLLECTION_BASE_FILENAME };
+export { DEFAULT_INTERMEDIATE_FILES_STRATEGY };
+export { DEFAULT_MAX_PARALLEL_COUNT };
+export { DEFAULT_MAX_EXECUTION_ATTEMPTS };
+export { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH };
+export { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL };
+export { DEFAULT_EXECUTIONS_CACHE_DIRNAME };
+export { DEFAULT_SCRAPE_CACHE_DIRNAME };
+export { DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME };
 export { RESERVED_PARAMETER_NAMES };
 export { DEFAULT_REMOTE_URL };
 export { DEFAULT_REMOTE_URL_PATH };
 export { DEFAULT_CSV_SETTINGS };
-export { IS_VERBOSE };
-export { IS_AUTO_INSTALLED };
+export { DEFAULT_IS_VERBOSE };
+export { DEFAULT_IS_AUTO_INSTALLED };
 export { pipelineJsonToString };
 export { pipelineStringToJson };
 export { pipelineStringToJsonSync };
@@ -153,6 +157,7 @@ export { limitTotalUsage };
 export { _AnthropicClaudeMetadataRegistration };
 export { _AzureOpenAiMetadataRegistration };
 export { joinLlmExecutionTools };
+export { MultipleLlmExecutionTools };
 export { _OpenAiMetadataRegistration };
 export { preparePersona };
 export { isPipelinePrepared };
@@ -162,6 +167,7 @@ export { unpreparePipeline };
 export { prepareKnowledgePieces };
 export { $scrapersMetadataRegister };
 export { $scrapersRegister };
+export { makeKnowledgeSourceHandler };
 export { _LegacyDocumentScraperMetadataRegistration };
 export { _DocumentScraperMetadataRegistration };
 export { _MarkdownScraperMetadataRegistration };

package/esm/typings/src/_packages/node.index.d.ts

@@ -3,6 +3,7 @@ import { createCollectionFromDirectory } from '../collection/constructors/create
 import { $provideExecutionToolsForNode } from '../execution/utils/$provideExecutionToolsForNode';
 import { $provideLlmToolsConfigurationFromEnv } from '../llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv';
 import { $provideLlmToolsFromEnv } from '../llm-providers/_common/register/$provideLlmToolsFromEnv';
+import { $provideExecutablesForNode } from '../scrapers/_common/register/$provideExecutablesForNode';
 import { $provideFilesystemForNode } from '../scrapers/_common/register/$provideFilesystemForNode';
 import { $provideScrapersForNode } from '../scrapers/_common/register/$provideScrapersForNode';
 import { FileCacheStorage } from '../storage/file-cache-storage/FileCacheStorage';
@@ -13,6 +14,7 @@ export { createCollectionFromDirectory };
 export { $provideExecutionToolsForNode };
 export { $provideLlmToolsConfigurationFromEnv };
 export { $provideLlmToolsFromEnv };
+export { $provideExecutablesForNode };
 export { $provideFilesystemForNode };
 export { $provideScrapersForNode };
 export { FileCacheStorage };

package/esm/typings/src/_packages/types.index.d.ts

@@ -17,8 +17,8 @@ import type { ErrorJson } from '../errors/utils/ErrorJson';
 import type { AvailableModel } from '../execution/AvailableModel';
 import type { CommonToolsOptions } from '../execution/CommonToolsOptions';
 import type { CreatePipelineExecutorOptions } from '../execution/createPipelineExecutor/00-CreatePipelineExecutorOptions';
-import type { CreatePipelineExecutorSettings } from '../execution/createPipelineExecutor/00-CreatePipelineExecutorSettings';
 import type { EmbeddingVector } from '../execution/EmbeddingVector';
+import type { Executables } from '../execution/Executables';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { FilesystemTools } from '../execution/FilesystemTools';
 import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
@@ -49,7 +49,6 @@ import type { AnthropicClaudeExecutionToolsDirectOptions } from '../llm-provider
 import type { AnthropicClaudeExecutionToolsProxiedOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
 import type { AzureOpenAiExecutionToolsOptions } from '../llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions';
 import type { LangtailExecutionToolsOptions } from '../llm-providers/langtail/LangtailExecutionToolsOptions';
-import type { MultipleLlmExecutionTools } from '../llm-providers/multiple/MultipleLlmExecutionTools';
 import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
 import type { PromptbookServer_Error } from '../llm-providers/remote/interfaces/PromptbookServer_Error';
 import type { PromptbookServer_ListModels_Request } from '../llm-providers/remote/interfaces/PromptbookServer_ListModels_Request';
@@ -80,6 +79,7 @@ import type { ExecutionPromptReportJson } from '../types/execution-report/Execut
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
 import type { ExecutionReportString } from '../types/execution-report/ExecutionReportString';
 import type { ExecutionReportStringOptions } from '../types/execution-report/ExecutionReportStringOptions';
+import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
 import type { ModelRequirements } from '../types/ModelRequirements';
 import type { CompletionModelRequirements } from '../types/ModelRequirements';
 import type { ChatModelRequirements } from '../types/ModelRequirements';
@@ -222,13 +222,13 @@ import type { number_gigabytes } from '../types/typeAliases';
 import type { number_terabytes } from '../types/typeAliases';
 import type { Registered } from '../utils/$Register';
 import type { Registration } from '../utils/$Register';
-import type { IExecCommandOptions } from '../utils/execCommand/IExecCommandOptions';
-import type { IExecCommandOptionsAdvanced } from '../utils/execCommand/IExecCommandOptions';
+import type { ExecCommandOptions } from '../utils/execCommand/ExecCommandOptions';
+import type { ExecCommandOptionsAdvanced } from '../utils/execCommand/ExecCommandOptions';
 import type { FromtoItems } from '../utils/FromtoItems';
 import type { CodeBlock } from '../utils/markdown/extractAllBlocksFromMarkdown';
 import type { MarkdownSection } from '../utils/markdown/parseMarkdownSection';
 import type { string_keyword } from '../utils/normalization/IKeywords';
-import type { IKeywords } from '../utils/normalization/IKeywords';
+import type { Keywords } from '../utils/normalization/IKeywords';
 import type { string_kebab_case } from '../utils/normalization/normalize-to-kebab-case';
 import type { string_camelCase } from '../utils/normalization/normalizeTo_camelCase';
 import type { string_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
@@ -257,8 +257,8 @@ export type { ErrorJson };
 export type { AvailableModel };
 export type { CommonToolsOptions };
 export type { CreatePipelineExecutorOptions };
-export type { CreatePipelineExecutorSettings };
 export type { EmbeddingVector };
+export type { Executables };
 export type { ExecutionTools };
 export type { FilesystemTools };
 export type { LlmExecutionTools };
@@ -289,7 +289,6 @@ export type { AnthropicClaudeExecutionToolsDirectOptions };
 export type { AnthropicClaudeExecutionToolsProxiedOptions };
 export type { AzureOpenAiExecutionToolsOptions };
 export type { LangtailExecutionToolsOptions };
-export type { MultipleLlmExecutionTools };
 export type { OpenAiExecutionToolsOptions };
 export type { PromptbookServer_Error };
 export type { PromptbookServer_ListModels_Request };
@@ -320,6 +319,7 @@ export type { ExecutionPromptReportJson };
 export type { ExecutionReportJson };
 export type { ExecutionReportString };
 export type { ExecutionReportStringOptions };
+export type { IntermediateFilesStrategy };
 export type { ModelRequirements };
 export type { CompletionModelRequirements };
 export type { ChatModelRequirements };
@@ -462,13 +462,13 @@ export type { number_gigabytes };
 export type { number_terabytes };
 export type { Registered };
 export type { Registration };
-export type { IExecCommandOptions };
-export type { IExecCommandOptionsAdvanced };
+export type { ExecCommandOptions };
+export type { ExecCommandOptionsAdvanced };
 export type { FromtoItems };
 export type { CodeBlock };
 export type { MarkdownSection };
 export type { string_keyword };
-export type { IKeywords };
+export type { Keywords };
 export type { string_kebab_case };
 export type { string_camelCase };
 export type { string_PascalCase };

package/esm/typings/src/_packages/utils.index.d.ts

@@ -24,7 +24,7 @@ import { capitalize } from '../utils/normalization/capitalize';
 import { decapitalize } from '../utils/normalization/decapitalize';
 import { DIACRITIC_VARIANTS_LETTERS } from '../utils/normalization/DIACRITIC_VARIANTS_LETTERS';
 import type { string_keyword } from '../utils/normalization/IKeywords';
-import type { IKeywords } from '../utils/normalization/IKeywords';
+import type { Keywords } from '../utils/normalization/IKeywords';
 import { isValidKeyword } from '../utils/normalization/isValidKeyword';
 import { nameToUriPart } from '../utils/normalization/nameToUriPart';
 import { nameToUriParts } from '../utils/normalization/nameToUriParts';
@@ -95,7 +95,7 @@ export { capitalize };
 export { decapitalize };
 export { DIACRITIC_VARIANTS_LETTERS };
 export type { string_keyword };
-export type { IKeywords };
+export type { Keywords };
 export { isValidKeyword };
 export { nameToUriPart };
 export { nameToUriParts };

package/esm/typings/src/collection/PipelineCollection.d.ts

@@ -11,7 +11,7 @@ export type PipelineCollection = {
     /**
      * Gets all pipelines in the collection
      */
-    listPipelines(): Promisable<Array<string_pipeline_url>>;
+    listPipelines(): Promisable<ReadonlyArray<string_pipeline_url>>;
     /**
      * Gets pipeline by its URL
      *

package/esm/typings/src/collection/SimplePipelineCollection.d.ts

@@ -19,11 +19,11 @@ export declare class SimplePipelineCollection implements PipelineCollection {
      * Note: During the construction logic of all pipelines are validated
      * Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead
      */
-    constructor(...pipelines: Array<PipelineJson>);
+    constructor(...pipelines: ReadonlyArray<PipelineJson>);
     /**
      * Gets all pipelines in the collection
      */
-    listPipelines(): Array<string_pipeline_url>;
+    listPipelines(): ReadonlyArray<string_pipeline_url>;
     /**
      * Gets pipeline by its URL
      *

package/esm/typings/src/collection/collectionToJson.d.ts

@@ -7,7 +7,7 @@ import type { PipelineCollection } from './PipelineCollection';
  *
  * @public exported from `@promptbook/core`
  */
-export declare function collectionToJson(collection: PipelineCollection): Promise<Array<PipelineJson>>;
+export declare function collectionToJson(collection: PipelineCollection): Promise<ReadonlyArray<PipelineJson>>;
 /**
  * TODO: [🧠] Maybe clear `sourceFile` or clear when exposing through API or remote server
  */

package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts

@@ -10,4 +10,4 @@ import type { PipelineCollection } from '../PipelineCollection';
  * @returns PipelineCollection
  * @public exported from `@promptbook/core`
  */
-export declare function createCollectionFromJson(...promptbooks: Array<PipelineJson>): PipelineCollection;
+export declare function createCollectionFromJson(...promptbooks: ReadonlyArray<PipelineJson>): PipelineCollection;

package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts

@@ -20,4 +20,4 @@ import type { PipelineCollection } from '../PipelineCollection';
  * @deprecated Do not use, it will became internal tool for other constructor functions
  * @public exported from `@promptbook/core`
  */
-export declare function createCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PipelineJson>> | (() => Promise<Array<PipelineJson>>)): PipelineCollection;
+export declare function createCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<ReadonlyArray<PipelineJson>> | (() => Promise<ReadonlyArray<PipelineJson>>)): PipelineCollection;

package/esm/typings/src/commands/_common/types/CommandParser.d.ts

@@ -40,11 +40,11 @@ export type CommonCommandParser<TCommand extends CommandBase> = {
     /**
      * @@@
      */
-    readonly aliasNames?: Array<string_name & string_SCREAMING_CASE>;
+    readonly aliasNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
     /**
      * @@@
      */
-    readonly deprecatedNames?: Array<string_name & string_SCREAMING_CASE>;
+    readonly deprecatedNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
     /**
      * @@@
      */
@@ -56,7 +56,7 @@ export type CommonCommandParser<TCommand extends CommandBase> = {
     /**
      * @@@
      */
-    readonly examples: Array<string_markdown_text>;
+    readonly examples: ReadonlyArray<string_markdown_text>;
     /**
      * @throws {ParseError} if the parsing fails
      */
@@ -95,7 +95,7 @@ export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonComm
      *
      * Note: This is used in `pipelineJsonToString` utility
      */
-    takeFromPipelineJson(pipelineJson: PipelineJson): Array<TCommand>;
+    takeFromPipelineJson(pipelineJson: PipelineJson): ReadonlyArray<TCommand>;
 };
 /**
  * @@@
@@ -120,7 +120,7 @@ export type PipelineTemplateCommandParser<TCommand extends CommandBase> = Common
      *
      * Note: This is used in `pipelineJsonToString` utility
      */
-    takeFromTemplateJson($templateJson: $TemplateJson): Array<TCommand>;
+    takeFromTemplateJson($templateJson: $TemplateJson): ReadonlyArray<TCommand>;
 };
 /**
  * @@@

package/esm/typings/src/config.d.ts

@@ -1,4 +1,5 @@
 import type { CsvSettings } from './formats/csv/CsvSettings';
+import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
 /**
  * Warning message for the generated sections and files files
  *
@@ -12,7 +13,7 @@ export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has be
  *
  * @public exported from `@promptbook/core`
  */
-export declare const CLAIM = "Supercharge LLM models with Promptbook";
+export declare const CLAIM = "Build responsible, controlled and transparent applications on top of LLM models!";
 /**
  * Warning message for the generated sections and files files
  *
@@ -50,37 +51,43 @@ export declare const CONNECTION_RETRIES_LIMIT = 5;
  */
 export declare const IMMEDIATE_TIME = 10;
 /**
- * The maximum number of (LLM) tasks running in parallel
+ * The maximum length of the (generated) filename
  *
  * @public exported from `@promptbook/core`
  */
-export declare const MAX_PARALLEL_COUNT = 5;
+export declare const MAX_FILENAME_LENGTH = 30;
 /**
- * The maximum number of attempts to execute LLM task before giving up
+ * Strategy for caching the intermediate results for knowledge sources
  *
  * @public exported from `@promptbook/core`
  */
-export declare const MAX_EXECUTION_ATTEMPTS = 3;
+export declare const DEFAULT_INTERMEDIATE_FILES_STRATEGY: IntermediateFilesStrategy;
 /**
- * The maximum length of the (generated) filename
+ * The maximum number of (LLM) tasks running in parallel
  *
  * @public exported from `@promptbook/core`
  */
-export declare const MAX_FILENAME_LENGTH = 30;
+export declare const DEFAULT_MAX_PARALLEL_COUNT = 5;
+/**
+ * The maximum number of attempts to execute LLM task before giving up
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_MAX_EXECUTION_ATTEMPTS = 3;
 /**
  * @@@
  * TODO: [🐝][main] !!! Use
  *
  * @public exported from `@promptbook/core`
  */
-export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
+export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
 /**
  * @@@
  * TODO: [🐝][main] !!! Use
  *
  * @public exported from `@promptbook/core`
  */
-export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
+export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
 /**
  * Where to store the cache of executions for promptbook CLI
  *
@@ -88,7 +95,7 @@ export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
  *
  * @public exported from `@promptbook/core`
  */
-export declare const EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-cache";
+export declare const DEFAULT_EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-cache";
 /**
  * Where to store the scrape cache
  *
@@ -96,13 +103,13 @@ export declare const EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-cache";
  *
  * @public exported from `@promptbook/core`
  */
-export declare const SCRAPE_CACHE_DIRNAME = "/.promptbook/scrape-cache";
+export declare const DEFAULT_SCRAPE_CACHE_DIRNAME = "/.promptbook/scrape-cache";
 /**
  * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
  *
  * @public exported from `@promptbook/core`
  */
-export declare const PIPELINE_COLLECTION_BASE_FILENAME = "index";
+export declare const DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME = "index";
 /**
  * Nonce which is used for replacing things in strings
  *
@@ -159,13 +166,13 @@ export declare const DEFAULT_CSV_SETTINGS: CsvSettings;
  *
  * @public exported from `@promptbook/core`
  */
-export declare const IS_VERBOSE = false;
+export declare const DEFAULT_IS_VERBOSE = false;
 /**
  * @@@
  *
  * @public exported from `@promptbook/core`
  */
-export declare const IS_AUTO_INSTALLED = false;
+export declare const DEFAULT_IS_AUTO_INSTALLED = false;
 /**
  * @@@
  *

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

@@ -1,7 +1,7 @@
 /**
  * Represents a vector in an latent space of the embedding model
  */
-export type EmbeddingVector = Array<number>;
+export type EmbeddingVector = ReadonlyArray<number>;
 /**
  * TODO: Figure out how to use NPM package xyzt
  *       Not using IVectorData due to HUGE dimensionality

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

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

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

@@ -1,5 +1,6 @@
 import type { Scraper } from '../scrapers/_common/Scraper';
 import type { Arrayable } from '../types/Arrayable';
+import type { Executables } from './Executables';
 import type { FilesystemTools } from './FilesystemTools';
 import type { LlmExecutionTools } from './LlmExecutionTools';
 import type { ScriptExecutionTools } from './ScriptExecutionTools';
@@ -26,6 +27,14 @@ export type ExecutionTools = {
      * @default undefined - If not provided, no filesystem operations will be possible
      */
     readonly fs?: FilesystemTools;
+    /**
+     * Scrapers for extracting knowledge from external sources
+     *
+     * Tip: Use `$provideExecutablesForNode`
+     *
+     * @default [] - If not provided, no external knowledge extraction will be possible
+     */
+    readonly executables?: Executables;
     /**
      * Scrapers for extracting knowledge from external sources
      *
@@ -51,6 +60,3 @@ export type ExecutionTools = {
      */
     readonly userInterface?: UserInterfaceTools;
 };
-/**
- * TODO: !!!!!! Move here also the executables and make $provideXxxxForNode
- */

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

@@ -37,7 +37,7 @@ export type LlmExecutionTools = {
     /**
      * List all available models that can be used
      */
-    listModels(): Promisable<Array<AvailableModel>>;
+    listModels(): Promisable<ReadonlyArray<AvailableModel>>;
     /**
      * Calls a chat model
      */

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

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

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

@@ -8,5 +8,6 @@ import type { PipelineExecutor } from './PipelineExecutor';
  */
 export declare function assertsExecutionSuccessful(executionResult: Pick<Awaited<ReturnType<PipelineExecutor>>, 'isSuccessful' | 'errors'>): void;
 /**
+ * TODO: [🐚] This function should be removed OR changed OR be completely rewritten
  * TODO: [🧠] Can this return type be better typed than void
  */

package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts

@@ -1,10 +1,11 @@
+import type { CsvSettings } from '../../formats/csv/CsvSettings';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 import type { ExecutionTools } from '../ExecutionTools';
-import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
 /**
  * Options for `createPipelineExecutor`
  */
-export type CreatePipelineExecutorOptions = {
+export type CreatePipelineExecutorOptions = PrepareAndScrapeOptions & {
     /**
      * The pipeline to be executed
      */
@@ -14,10 +15,32 @@ export type CreatePipelineExecutorOptions = {
      */
     readonly tools: ExecutionTools;
     /**
-     * Optional settings for the pipeline executor
+     * When executor does not satisfy expectations it will be retried this amount of times
+     *
+     * @default MAX_EXECUTION_ATTEMPTS
      */
-    readonly settings?: Partial<CreatePipelineExecutorSettings>;
+    readonly maxExecutionAttempts?: number;
+    /**
+     * Settings for CSV format
+     *
+     * @default DEFAULT_CSV_SETTINGS
+     */
+    readonly csvSettings?: CsvSettings;
+    /**
+     * If you pass fully prepared pipeline, this does not matter
+     *
+     * Otherwise:
+     * If false or not set, warning is shown when pipeline is not prepared
+     * If true, warning is suppressed
+     *
+     * @default false
+     */
+    readonly isNotPreparedWarningSupressed?: boolean;
 };
 /**
- * TODO: !!!!!! Unite `CreatePipelineExecutorOptions` and `CreatePipelineExecutorSettings` OR describe the difference
- */ 
+ * TODO: [🧎][🧠] Move `csvSettings` to some better place
+ *       1) either to some dependency in `ExecutionTools`
+ *       2) or make here container for multiple formats
+ *       3) or make the setting more universal and which just sets things like `delimiter` and `quote` without specifying the format
+ * TODO: [🤹‍♂️] More granular setting for limits of execution + better waiting for queue
+ */

package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts

@@ -2,23 +2,18 @@ import type { Promisable, ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 import type { TaskProgress } from '../../types/TaskProgress';
 import type { Parameters } from '../../types/typeAliases';
-import type { ExecutionTools } from '../ExecutionTools';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
-import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
+import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
  * @@@
  *
  * @private internal type of `executePipeline`
  */
-type ExecutePipelineOptions = {
+type ExecutePipelineOptions = CreatePipelineExecutorOptions & {
     /**
      * @@@
      */
     readonly inputParameters: Readonly<Parameters>;
-    /**
-     * @@@
-     */
-    readonly tools: ExecutionTools;
     /**
      * @@@
      */
@@ -39,10 +34,6 @@ type ExecutePipelineOptions = {
      * @@@
      */
     readonly pipelineIdentification: string;
-    /**
-     * Settings for the pipeline executor
-     */
-    readonly settings: CreatePipelineExecutorSettings;
 };
 /**
  * @@@

package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts

@@ -1,17 +1,16 @@
-import { Promisable, ReadonlyDeep } from 'type-fest';
+import type { Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
 import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
 import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
 import type { TaskProgress } from '../../types/TaskProgress';
 import type { Parameters } from '../../types/typeAliases';
-import type { ExecutionTools } from '../ExecutionTools';
-import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
+import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
  * @@@
  *
  * @private internal type of `executeTemplate`
  */
-type executeSingleTemplateOptions = {
+type executeSingleTemplateOptions = CreatePipelineExecutorOptions & {
     /**
      * @@@
      */
@@ -24,22 +23,14 @@ type executeSingleTemplateOptions = {
      * @@@
      */
     readonly parametersToPass: Readonly<Parameters>;
-    /**
-     * @@@
-     */
-    readonly tools: ExecutionTools;
     /**
      * @@@
      */
     readonly onProgress: (taskProgress: TaskProgress) => Promisable<void>;
-    /**
-     * Settings for the pipeline executor
-     */
-    readonly settings: CreatePipelineExecutorSettings;
     /**
      * @@@
      */
-    readonly $executionReport: ExecutionReportJson;
+    readonly $executionReport: WritableDeep<ExecutionReportJson>;
     /**
      * @@@
      */