@promptbook/openai 0.70.0-1 → 0.71.0-12

package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { ExpectCommand } from './ExpectCommand';
 /**
  * Parses the expect command
  *
- * @see ./EXPECT-README.md for more details
+ * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const expectCommandParser: PipelineTemplateCommandParser<ExpectCommand>;

package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts

@@ -1,14 +1,10 @@
-import type { string_parameter_name } from '../../types/typeAliases';
-import type { TODO_string } from '../../utils/organization/TODO_string';
+import type { ForeachJson } from './ForeachJson';
 /**
- * Parsed FOREACH command <- Write [🍭] !!!!!!
+ * Parsed FOREACH command which is used to iterate over a table of values
  *
  * @see ./foreachCommandParser.ts for more details
  * @private within the commands folder
  */
 export type ForeachCommand = {
     readonly type: 'FOREACH';
-    formatName: TODO_string;
-    cellName: TODO_string;
-    parameterName: string_parameter_name;
-};
+} & ForeachJson;

package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts

@@ -0,0 +1,27 @@
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { TODO_string } from '../../utils/organization/TODO_string';
+/**
+ * @@@
+ */
+export type ForeachJson = {
+    /**
+     * @@@
+     */
+    readonly formatName: TODO_string;
+    /**
+     * @@@
+     */
+    readonly subformatName: TODO_string;
+    /**
+     * @@@
+     */
+    readonly parameterName: string_parameter_name;
+    /**
+     * @@@
+     */
+    readonly inputSubparameterNames: Array<string_parameter_name>;
+    /**
+     * @@@
+     */
+    readonly outputSubparameterName: string_parameter_name;
+};

package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts

@@ -5,11 +5,10 @@ import type { ForeachCommand } from './ForeachCommand';
  *
  * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.ptbk.md` file
  *
- * @see ./FOREACH-README.md for more details <- TODO: @@@ Write theese README files OR remove this link + add annotation here (to all commands)
+ * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const foreachCommandParser: PipelineTemplateCommandParser<ForeachCommand>;
 /**
- * TODO: !!!!!! Comment console logs
- * TODO: [🍭] !!!!!! Make .ptbk.md file with examples of the FOREACH command and also with wrong parsing and logic
+ * TODO: [🍭] Make .ptbk.md file with examples of the FOREACH with wrong parsing and logic
  */

package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { FormatCommand } from './FormatCommand';
 /**
  * Parses the format command
  *
- * @see ./FORMAT-README.md for more details
+ * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const formatCommandParser: PipelineTemplateCommandParser<FormatCommand>;

package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { JokerCommand } from './JokerCommand';
 /**
  * Parses the joker command
  *
- * @see ./JOKER-README.md for more details
+ * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const jokerCommandParser: PipelineTemplateCommandParser<JokerCommand>;

package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { KnowledgeCommand } from './KnowledgeCommand';
 /**
  * Parses the knowledge command
  *
- * @see ./KNOWLEDGE-README.md for more details
+ * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const knowledgeCommandParser: PipelineHeadCommandParser<KnowledgeCommand>;

package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.d.ts

@@ -0,0 +1,11 @@
+import type { string_knowledge_source_content } from '../../../types/typeAliases';
+import type { string_name } from '../../../types/typeAliases';
+/**
+ * Creates unique name for the source
+ *
+ * @private within the repository
+ */
+export declare function sourceContentToName(sourceContent: string_knowledge_source_content): string_name;
+/**
+ * TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
+ */

package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
+ */

package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { ModelCommand } from './ModelCommand';
 /**
  * Parses the model command
  *
- * @see ./MODEL-README.md for more details
+ * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const modelCommandParser: PipelineBothCommandParser<ModelCommand>;

package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { ParameterCommand } from './ParameterCommand';
 /**
  * Parses the parameter command
  *
- * @see ./PARAMETER-README.md for more details
+ * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const parameterCommandParser: PipelineBothCommandParser<ParameterCommand>;

package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { PersonaCommand } from './PersonaCommand';
 /**
  * Parses the persona command
  *
- * @see ./PERSONA-README.md for more details
+ * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const personaCommandParser: PipelineBothCommandParser<PersonaCommand>;

package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { PostprocessCommand } from './PostprocessCommand';
 /**
  * Parses the postprocess command
  *
- * @see ./POSTPROCESS-README.md for more details
+ * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const postprocessCommandParser: PipelineTemplateCommandParser<PostprocessCommand>;

package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { PromptbookVersionCommand } from './PromptbookVersionCommand';
 /**
  * Parses the PROMPTBOOK_VERSION command
  *
- * @see ./PROMPTBOOK_VERSION-README.md for more details
+ * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const promptbookVersionCommandParser: PipelineHeadCommandParser<PromptbookVersionCommand>;

package/esm/typings/src/commands/TEMPLATE/templateCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { TemplateCommand } from './TemplateCommand';
 /**
  * Parses the template command
  *
- * @see ./TEMPLATE-README.md for more details
+ * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const templateCommandParser: PipelineTemplateCommandParser<TemplateCommand>;

package/esm/typings/src/commands/URL/urlCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { UrlCommand } from './UrlCommand';
 /**
  * Parses the url command
  *
- * @see ./URL-README.md for more details
+ * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const urlCommandParser: PipelineHeadCommandParser<UrlCommand>;

package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { ActionCommand } from './ActionCommand';
 /**
  * Parses the action command
  *
- * @see ./ACTION-README.md for more details
+ * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const actionCommandParser: PipelineHeadCommandParser<ActionCommand>;

package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { InstrumentCommand } from './InstrumentCommand';
 /**
  * Parses the instrument command
  *
- * @see ./INSTRUMENT-README.md for more details
+ * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const instrumentCommandParser: PipelineHeadCommandParser<InstrumentCommand>;

package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts

@@ -5,7 +5,7 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
  *
  * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.ptbk.md` file
  *
- * @see ./BOILERPLATE-README.md for more details <- TODO: @@@ Write theese README files OR remove this link + add annotation here (to all commands)
+ * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const boilerplateCommandParser: PipelineBothCommandParser<BoilerplateCommand>;

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

@@ -156,28 +156,28 @@ export type CommandParserInput = {
      * @@@
      *
      * @example 'promptbook version 0.62.0'
-     * @example 'FOREACH List Line -> `{customer}`'
+     * @example 'FOREACH Text Line `{customers}` -> `{customer}`'
      */
     readonly raw: string_markdown_text;
     /**
      * @@@
      *
      * @example '0.62.0'
-     * @example 'List Line -> `{customer}`'
+     * @example 'List Line `{customers}` -> `{customer}`'
      */
     readonly rawArgs: string_markdown_text;
     /**
      * @@@
      *
      * @example 'PROMPTBOOK_VERSION_0_62_0'
-     * @example 'FOREACH_LIST_LINE_CUSTOMER'
+     * @example 'FOREACH_LIST_LINE_CUSTOMERS_CUSTOMER'
      */
     readonly normalized: string_name & string_SCREAMING_CASE;
     /**
      * @@@
      *
      * @example [ '0.62.0' ]
-     * @example [ 'List', 'Line', '', '{customer}' ]
+     * @example [ 'List', 'Line', '{customers}', '', '{customer}' ]
      */
     readonly args: Array<string_name>;
 };

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

@@ -1,3 +1,4 @@
+import type { CsvSettings } from './formats/csv/CsvSettings';
 /**
  * Warning message for the generated sections and files files
  *
@@ -68,14 +69,14 @@ export declare const MAX_EXECUTION_ATTEMPTS = 3;
 export declare const MAX_FILENAME_LENGTH = 30;
 /**
  * @@@
- * TODO: [🐝] !!! Use
+ * TODO: [🐝][main] !!! Use
  *
  * @public exported from `@promptbook/core`
  */
 export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
 /**
  * @@@
- * TODO: [🐝] !!! Use
+ * TODO: [🐝][main] !!! Use
  *
  * @public exported from `@promptbook/core`
  */
@@ -83,9 +84,19 @@ export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
 /**
  * Where to store the cache of executions for promptbook CLI
  *
+ * Note: When the folder does not exist, it is created recursively
+ *
  * @public exported from `@promptbook/core`
  */
 export declare const EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-cache";
+/**
+ * Where to store the scrape cache
+ *
+ * Note: When the folder does not exist, it is created recursively
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const SCRAPE_CACHE_DIRNAME = "/.promptbook/scrape-cache";
 /**
  * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
  *
@@ -137,18 +148,36 @@ export declare const DEFAULT_REMOTE_URL = "https://api.pavolhejny.com/";
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_REMOTE_URL_PATH = "/promptbook/socket.io";
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_CSV_SETTINGS: CsvSettings;
 /**
  * @@@
  *
  * @public exported from `@promptbook/core`
  */
 export declare const IS_VERBOSE = false;
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const IS_AUTO_INSTALLED = false;
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
 /**
  * @@@
  *
  * @private within the repository
  */
-export declare const DEBUG_ALLOW_PAYED_TESTING: boolean;
+export declare const IS_COST_PREVENTED: boolean;
 /**
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
  */

package/esm/typings/src/conversion/pipelineStringToJson.d.ts

@@ -1,19 +1,7 @@
-import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
 import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 import type { PipelineString } from '../types/PipelineString';
-/**
- * Options for `pipelineStringToJson`
- *
- * @public exported from `@promptbook/core`
- */
-export type PipelineStringToJsonOptions = {
-    /**
-     * Tools for processing required for preparation of knowledge *(not for actual execution)*
-     *
-     * Note: If you provide `null`, the knowledge will not be prepared
-     */
-    readonly llmTools: LlmExecutionTools | null;
-};
 /**
  * Compile pipeline from string (markdown) format to JSON format
  *
@@ -26,12 +14,13 @@ export type PipelineStringToJsonOptions = {
  * Note: This function acts as compilation process
  *
  * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
+ * @param tools - Tools for the preparation and scraping - if not provided together with `llm`, the preparation will be skipped
  * @param options - Options and tools for the compilation
  * @returns {Promptbook} compiled in JSON format (.ptbk.json)
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */
-export declare function pipelineStringToJson(pipelineString: PipelineString, options?: PipelineStringToJsonOptions): Promise<PipelineJson>;
+export declare function pipelineStringToJson(pipelineString: PipelineString, tools?: Pick<ExecutionTools, 'llm' | 'scrapers'>, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
 /**
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools

package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts

@@ -18,7 +18,7 @@ import type { PipelineString } from '../types/PipelineString';
  */
 export declare function pipelineStringToJsonSync(pipelineString: PipelineString): PipelineJson;
 /**
- * TODO: !!!! Warn if used only sync version
+ * TODO: [main] !!!! Warn if used only sync version
  * TODO: [🚞] Report here line/column of error
  * TODO: Use spaceTrim more effectively
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal

package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts

@@ -22,6 +22,9 @@ export type renderPipelineMermaidOptions = {
  */
 export declare function renderPromptbookMermaid(pipelineJson: PipelineJson, options?: renderPipelineMermaidOptions): string;
 /**
+ * TODO: !!!!! FOREACH in mermaid graph
+ * TODO: !!!!! Knowledge in mermaid graph
+ * TODO: !!!!! Personas in mermaid graph
  * TODO: Maybe use some Mermaid package instead of string templating
  * TODO: [🕌] When more than 2 functionalities, split into separate functions
  */

package/esm/typings/src/conversion/utils/extractParameterNamesFromTemplate.d.ts

@@ -1,3 +1,4 @@
+import type { ReadonlyDeep } from 'type-fest';
 import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
 import type { string_parameter_name } from '../../types/typeAliases';
 /**
@@ -8,7 +9,7 @@ import type { string_parameter_name } from '../../types/typeAliases';
  * @throws {ParseError} if the script is invalid
  * @public exported from `@promptbook/utils`
  */
-export declare function extractParameterNamesFromTemplate(template: Pick<TemplateJson, 'title' | 'description' | 'templateType' | 'content' | 'preparedContent' | 'jokerParameterNames'>): Set<string_parameter_name>;
+export declare function extractParameterNamesFromTemplate(template: ReadonlyDeep<Pick<TemplateJson, 'title' | 'description' | 'templateType' | 'content' | 'preparedContent' | 'jokerParameterNames' | 'foreach'>>): Set<string_parameter_name>;
 /**
  * TODO: [🔣] If script require contentLanguage
  */

package/esm/typings/src/conversion/validation/_importPipeline.d.ts

@@ -25,5 +25,5 @@ export declare function importPipelineJson(path: `${string}.ptbk.json`): Pipelin
  */
 export declare function importPipelineJsonAsString(path: `${string}.ptbk.json`): string_json<PipelineJson>;
 /**
- * TODO: [🥯] This should be part of scripting + testing utilities set which are not builded into packages
+ * Note: [⚫] Code in this file should never be published in any package
  */

package/esm/typings/src/conversion/validation/validatePipeline.d.ts

@@ -16,6 +16,11 @@ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
  */
 export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
 /**
+ * @private internal function for `validatePipeline`
+ */
+export declare function validatePipelineCore(pipeline: PipelineJson): void;
+/**
+ * TODO: !!!!! [🧞‍♀️] Do not allow joker + foreach
  * TODO: [🧠] Work with promptbookVersion
  * TODO: Use here some json-schema, Zod or something similar and change it to:
  *     > /**
@@ -27,11 +32,11 @@ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
  *     >  ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
  */
 /**
- * TODO: [🐣] !!!! Validate that all samples match expectations
- * TODO: [🐣][🐝] !!!! Validate that knowledge is valid (non-void)
- * TODO: [🐣] !!!! Validate that persona can be used only with CHAT variant
- * TODO: [🐣] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
- * TODO: [🐣] !!!! Validate that reserved parameter is not used as joker
+ * TODO: [🧳][main] !!!! Validate that all samples match expectations
+ * TODO: [🧳][🐝][main] !!!! Validate that knowledge is valid (non-void)
+ * TODO: [🧳][main] !!!! Validate that persona can be used only with CHAT variant
+ * TODO: [🧳][main] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
+ * TODO: [🧳][main] !!!! Validate that reserved parameter is not used as joker
  * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceTools.d.ts

@@ -1,5 +1,5 @@
-import type { UserInterfaceTools } from '../../../execution/UserInterfaceTools';
-import type { UserInterfaceToolsPromptDialogOptions } from '../../../execution/UserInterfaceTools';
+import type { UserInterfaceTools } from '../../execution/UserInterfaceTools';
+import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
 import type { CallbackInterfaceToolsOptions } from './CallbackInterfaceToolsOptions';
 /**
  * Delagates the user interaction to a async callback function

package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceToolsOptions.d.ts

@@ -1,12 +1,12 @@
 import type { Promisable } from 'type-fest';
-import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
-import type { UserInterfaceToolsPromptDialogOptions } from '../../../execution/UserInterfaceTools';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
 /**
  * Options for `CallbackInterfaceTools`
  *
  * @public exported from `@promptbook/core`
  */
-export type CallbackInterfaceToolsOptions = CommonExecutionToolsOptions & {
+export type CallbackInterfaceToolsOptions = CommonToolsOptions & {
     /**
      * The callback function to be called when promptDialog is called
      */

package/esm/typings/src/{knowledge/dialogs → dialogs}/simple-prompt/SimplePromptInterfaceTools.d.ts

@@ -1,6 +1,6 @@
-import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
-import type { UserInterfaceTools } from '../../../execution/UserInterfaceTools';
-import type { UserInterfaceToolsPromptDialogOptions } from '../../../execution/UserInterfaceTools';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { UserInterfaceTools } from '../../execution/UserInterfaceTools';
+import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
 /**
  * Wrapper around `window.prompt` synchronous function that interacts with the user via browser prompt
  *
@@ -11,12 +11,12 @@ import type { UserInterfaceToolsPromptDialogOptions } from '../../../execution/U
  */
 export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
     private readonly options;
-    constructor(options?: CommonExecutionToolsOptions);
+    constructor(options?: CommonToolsOptions);
     /**
      * Trigger window.DIALOG TEMPLATE
      */
     promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
 }
 /**
- * Note: [🔵] This code should never be published outside of `@promptbook/browser`
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
  */

package/esm/typings/src/errors/AbstractFormatError.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This error indicates problems parsing the format value
+ *
+ * For example, when the format value is not a valid JSON or CSV
+ * This is not thrown directly but in extended classes
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class AbstractFormatError extends Error {
+    constructor(message: string);
+}

package/esm/typings/src/errors/KnowledgeScrapeError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This error indicates that the promptbook can not retrieve knowledge from external sources
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class KnowledgeScrapeError extends Error {
+    readonly name = "KnowledgeScrapeError";
+    constructor(message: string);
+}

package/esm/typings/src/errors/MissingToolsError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This error type indicates that some tools are missing for pipeline execution or preparation
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class MissingToolsError extends Error {
+    readonly name = "MissingToolsError";
+    constructor(message: string);
+}

package/esm/typings/src/execution/{CommonExecutionToolsOptions.d.ts → CommonToolsOptions.d.ts}

@@ -3,7 +3,7 @@
  *
  * Note: Keep it public to allow people to make their own execution tools
  */
-export type CommonExecutionToolsOptions = {
+export type CommonToolsOptions = {
     /**
      * If true, the internal executions will be logged
      */

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

@@ -1,3 +1,4 @@
+import type { Scraper } from '../scrapers/_common/Scraper';
 import type { Arrayable } from '../types/Arrayable';
 import type { LlmExecutionTools } from './LlmExecutionTools';
 import type { ScriptExecutionTools } from './ScriptExecutionTools';
@@ -9,12 +10,21 @@ import type { UserInterfaceTools } from './UserInterfaceTools';
  */
 export type ExecutionTools = {
     /**
-     * Tools for executing prompts to large language models like GPT-4
+     * Tools for executing prompts in large language models
      *
-     * Tip: Use `createLlmToolsFromEnv()` to use all available LLM providers you configured
-     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#llm-execution-tools
+     * Tip: Use `$provideLlmToolsFromEnv()` to use all available LLM providers you configured
+     *
+     * @default [] - If not provided, no LLM execution will be possible - it does not make sense in most cases
      */
-    llm?: Arrayable<LlmExecutionTools>;
+    readonly llm?: Arrayable<LlmExecutionTools>;
+    /**
+     * Scrapers for extracting knowledge from external sources
+     *
+     * Tip: Use `$provideScrapersForNode` OR `$provideScrapersForBrowser` to use all available scrapers
+     *
+     * @default [] - If not provided, no external knowledge extraction will be possible
+     */
+    readonly scrapers?: Arrayable<Scraper>;
     /**
      * Tools for executing scripts
      *
@@ -22,15 +32,17 @@ export type ExecutionTools = {
      *       If none of them supports the script, an error is thrown
      * Tip: Use here `new JavascriptExecutionTools()`
      *
-     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#script-execution-tools
      * @default [] - If not provided, no script execution will be possible
      */
-    script?: Arrayable<ScriptExecutionTools>;
+    readonly script?: Arrayable<ScriptExecutionTools>;
     /**
      * Tools for interacting with the user
      *
      * Note: When undefined, the user interface is disabled and promptbook which requires user interaction will fail
-     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#user-interface-tools
      */
-    userInterface?: UserInterfaceTools;
+    readonly userInterface?: UserInterfaceTools;
 };
+/**
+ * TODO: [🍂] Maybe make llm = $provideLlmToolsFromEnv() without problem with bundle contaminated by only `@promptbook/node` and `@promptbook/cli` stuff
+ * TODO: [🍂] Same with scrapers
+ */

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

@@ -14,5 +14,6 @@ export type PipelineExecutor = {
     (inputParameters: Parameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
 };
 /**
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
  * TODO: [🧠] Should this file be in /execution or /types folder?
  */