@promptbook/browser 0.72.0-2 → 0.72.0-26

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/createCollectionFromDirectory.d.ts

@@ -1,10 +1,14 @@
-import type { PipelineStringToJsonOptions } from '../../conversion/pipelineStringToJson';
-import type { string_folder_path } from '../../types/typeAliases';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import type { string_dirname } from '../../types/typeAliases';
 import type { PipelineCollection } from '../PipelineCollection';
 /**
  * Options for `createCollectionFromDirectory` function
+ *
+ * Note: `rootDirname` is not needed because it is the folder in which `.ptbk.md` file is located
+ *       This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
  */
-type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions & {
+type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {
     /**
      * If true, the directory is searched recursively for pipelines
      *
@@ -37,13 +41,14 @@ type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions
  * Note: Works only in Node.js environment because it reads the file system
  *
  * @param path - path to the directory with pipelines
- * @param options - Misc options for the collection
+ * @param tools - Execution tools to be used for pipeline preparation if needed - If not provided, `$provideExecutionToolsForNode` will be used
+ * @param options - Options for the collection creation
  * @returns PipelineCollection
  * @public exported from `@promptbook/node`
  */
-export declare function createCollectionFromDirectory(path: string_folder_path, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
+export declare function createCollectionFromDirectory(path: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
 export {};
 /**
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
  * TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed
+ * TODO: Maybe move from `@promptbook/node` to `@promptbook/core` as we removes direct dependency on `fs`
  */

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/collection/constructors/createCollectionFromUrl.d.ts

@@ -25,5 +25,5 @@ type CreatePipelineCollectionFromUrlyOptions = {
 export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
 export {};
 /**
- * TODO:[main] !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
+ * TODO: [main] !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
  */

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/ForeachJson.d.ts

@@ -19,5 +19,9 @@ export type ForeachJson = {
     /**
      * @@@
      */
-    readonly subparameterNames: Array<string_parameter_name>;
+    readonly inputSubparameterNames: Array<string_parameter_name>;
+    /**
+     * @@@
+     */
+    readonly outputSubparameterName: string_parameter_name;
 };

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

@@ -5,7 +5,7 @@ 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>;

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

@@ -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,49 +51,65 @@ 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
  *
+ * Note: When the folder does not exist, it is created recursively
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_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 EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-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
  *
@@ -149,7 +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 DEFAULT_IS_AUTO_INSTALLED = false;
 /**
  * @@@
  *

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' | 'fs' | '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:[main] !!!! 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/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

@@ -32,11 +32,11 @@ export declare function validatePipelineCore(pipeline: PipelineJson): void;
  *     >  ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
  */
 /**
- * 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: [🧳][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
  *
@@ -10,13 +10,13 @@ import type { UserInterfaceToolsPromptDialogOptions } from '../../../execution/U
  * @public exported from `@promptbook/browser`
  */
 export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
-    protected readonly options: CommonExecutionToolsOptions;
-    constructor(options?: CommonExecutionToolsOptions);
+    protected readonly options: CommonToolsOptions;
+    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/executables/$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: [🧠] Allow to override the executables without need to call `locatePandoc` / `locateLibreoffice` in case of provided
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/executables/apps/locateLibreoffice.d.ts

@@ -0,0 +1,11 @@
+import type { string_executable_path } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locateLibreoffice(): Promise<string_executable_path>;
+/**
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/legacy-documents`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/executables/apps/locatePandoc.d.ts

@@ -0,0 +1,11 @@
+import type { string_executable_path } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locatePandoc(): Promise<string_executable_path>;
+/**
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/documents`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/executables/locateApp.d.ts

@@ -0,0 +1,33 @@
+import type { RequireAtLeastOne } from 'type-fest';
+import type { string_executable_path } from '../types/typeAliases';
+/**
+ * Options for locating any application
+ */
+export interface LocateAppOptions {
+    /**
+     * Name of the application
+     */
+    appName: string;
+    /**
+     * Name of the executable on Linux
+     */
+    linuxWhich?: string;
+    /**
+     * Path suffix on Windows
+     */
+    windowsSuffix?: string;
+    /**
+     * Name of the application on macOS
+     */
+    macOsName?: string;
+}
+/**
+ * Locates an application on the system
+ *
+ * @private within the repository
+ */
+export declare function locateApp(options: RequireAtLeastOne<LocateAppOptions, 'linuxWhich' | 'windowsSuffix' | 'macOsName'>): Promise<string_executable_path>;
+/**
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */