@promptbook/types 0.75.0-1 → 0.75.0-4

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

@@ -1,4 +1,4 @@
-import type { PipelineTemplateCommandParser } from '../_common/types/CommandParser';
+import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
 import type { ForeachCommand } from './ForeachCommand';
 /**
  * Parses the foreach command
@@ -8,7 +8,7 @@ import type { ForeachCommand } from './ForeachCommand';
  * @see `documentationUrl` for more details
  * @private within the commands folder
  */
-export declare const foreachCommandParser: PipelineTemplateCommandParser<ForeachCommand>;
+export declare const foreachCommandParser: PipelineTaskCommandParser<ForeachCommand>;
 /**
  * TODO: [🍭] Make .book.md file with examples of the FOREACH with wrong parsing and logic
  */

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

@@ -1,4 +1,4 @@
-import type { PipelineTemplateCommandParser } from '../_common/types/CommandParser';
+import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
 import type { FormatCommand } from './FormatCommand';
 /**
  * Parses the format command
@@ -6,4 +6,4 @@ import type { FormatCommand } from './FormatCommand';
  * @see `documentationUrl` for more details
  * @private within the commands folder
  */
-export declare const formatCommandParser: PipelineTemplateCommandParser<FormatCommand>;
+export declare const formatCommandParser: PipelineTaskCommandParser<FormatCommand>;

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

@@ -1,4 +1,4 @@
-import type { PipelineTemplateCommandParser } from '../_common/types/CommandParser';
+import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
 import type { JokerCommand } from './JokerCommand';
 /**
  * Parses the joker command
@@ -6,4 +6,4 @@ import type { JokerCommand } from './JokerCommand';
  * @see `documentationUrl` for more details
  * @private within the commands folder
  */
-export declare const jokerCommandParser: PipelineTemplateCommandParser<JokerCommand>;
+export declare const jokerCommandParser: PipelineTaskCommandParser<JokerCommand>;

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

@@ -1,4 +1,4 @@
-import type { PipelineTemplateCommandParser } from '../_common/types/CommandParser';
+import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
 import type { PostprocessCommand } from './PostprocessCommand';
 /**
  * Parses the postprocess command
@@ -6,4 +6,4 @@ import type { PostprocessCommand } from './PostprocessCommand';
  * @see `documentationUrl` for more details
  * @private within the commands folder
  */
-export declare const postprocessCommandParser: PipelineTemplateCommandParser<PostprocessCommand>;
+export declare const postprocessCommandParser: PipelineTaskCommandParser<PostprocessCommand>;

package/esm/typings/src/commands/SECTION/SectionCommand.d.ts

@@ -0,0 +1,11 @@
+import type { SectionType } from '../../types/SectionType';
+/**
+ * Parsed SECTION command
+ *
+ * @see ./sectionCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type SectionCommand = {
+    readonly type: 'SECTION';
+    readonly taskType: SectionType;
+};

package/esm/typings/src/commands/{TEMPLATE/templateCommandParser.d.ts → SECTION/sectionCommandParser.d.ts}

@@ -1,18 +1,18 @@
-import type { PipelineTemplateCommandParser } from '../_common/types/CommandParser';
-import type { TemplateCommand } from './TemplateCommand';
+import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
+import type { SectionCommand } from './SectionCommand';
 /**
- * Parses the template command
+ * Parses the section command
  *
  * @see `documentationUrl` for more details
  * @private within the commands folder
  */
-export declare const templateCommandParser: PipelineTemplateCommandParser<TemplateCommand>;
+export declare const sectionCommandParser: PipelineTaskCommandParser<SectionCommand>;
 /**
  * Note: [⛱] There are two types of KNOWLEDGE, ACTION and INSTRUMENT commands:
  * 1) There are commands `KNOWLEDGE`, `ACTION` and `INSTRUMENT` used in the pipeline head, they just define the knowledge, action or instrument as single line after the command
  *    - KNOWLEDGE Look at https://en.wikipedia.org/wiki/Artificial_intelligence
- * 2) `KNOWLEDGE TEMPLATE` which has short form `KNOWLEDGE` is used in the template, does not refer the line itself, but the content of the template
- *   - KNOWLEDGE TEMPLATE
+ * 2) `KNOWLEDGE SECTION` which has short form `KNOWLEDGE` is used in the sectiom, does not refer the line itself, but the content of the section block
+ *   - KNOWLEDGE SECTION
  *
  *   ```
  *   Look at https://en.wikipedia.org/wiki/Artificial_intelligence

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

@@ -1,6 +1,6 @@
 import { COMMANDS } from '../../index';
 /**
- * Command is one piece of the template which adds some logic to the template or the whole pipeline.
+ * Command is one piece of the book file section which adds some logic to the task or the whole pipeline.
  * It is parsed from the markdown from ul/ol items - one command per one item.
  */
 export type Command = ReturnType<typeof COMMANDS[number]['parse']>;

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

@@ -1,6 +1,6 @@
 import type { WritableDeep } from 'type-fest';
-import type { PipelineJson } from '../../../types/PipelineJson/PipelineJson';
-import type { TemplateJson } from '../../../types/PipelineJson/TemplateJson';
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../../pipeline/PipelineJson/TaskJson';
 import type { string_markdown_text } from '../../../types/typeAliases';
 import type { string_name } from '../../../types/typeAliases';
 import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
@@ -18,7 +18,7 @@ export type CommandBase = {
 /**
  * @@@
  */
-export type CommandParser<TCommand extends CommandBase> = PipelineHeadCommandParser<TCommand> | PipelineTemplateCommandParser<TCommand> | PipelineBothCommandParser<TCommand>;
+export type CommandParser<TCommand extends CommandBase> = PipelineHeadCommandParser<TCommand> | PipelineTaskCommandParser<TCommand> | PipelineBothCommandParser<TCommand>;
 /**
  * @@@
  *
@@ -36,7 +36,7 @@ export type CommonCommandParser<TCommand extends CommandBase> = {
     /**
      * @@@
      */
-    readonly isUsedInPipelineTemplate: boolean;
+    readonly isUsedInPipelineTask: boolean;
     /**
      * @@@
      */
@@ -71,7 +71,7 @@ export type CommonCommandParser<TCommand extends CommandBase> = {
 /**
  * @@@
  */
-export type PipelineBothCommandParser<TCommand extends CommandBase> = ___and___ & Omit<PipelineHeadCommandParser<TCommand>, 'isUsedInPipelineTemplate'> & Omit<PipelineTemplateCommandParser<TCommand>, 'isUsedInPipelineHead'>;
+export type PipelineBothCommandParser<TCommand extends CommandBase> = ___and___ & Omit<PipelineHeadCommandParser<TCommand>, 'isUsedInPipelineTask'> & Omit<PipelineTaskCommandParser<TCommand>, 'isUsedInPipelineHead'>;
 /**
  * @@@
  */
@@ -83,7 +83,7 @@ export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonComm
     /**
      * @@@
      */
-    readonly isUsedInPipelineTemplate: false;
+    readonly isUsedInPipelineTask: false;
     /**
      * Apply the command to the `pipelineJson`
      *
@@ -99,10 +99,8 @@ export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonComm
 };
 /**
  * @@@
- *
- * TODO: !!!!!! Rename to PipelineTaskCommandParser, applyToTaskJson, TaskJson, isUsedInPipelineTask,...
  */
-export type PipelineTemplateCommandParser<TCommand extends CommandBase> = CommonCommandParser<TCommand> & {
+export type PipelineTaskCommandParser<TCommand extends CommandBase> = CommonCommandParser<TCommand> & {
     /**
      * @@@
      */
@@ -110,19 +108,19 @@ export type PipelineTemplateCommandParser<TCommand extends CommandBase> = Common
     /**
      * @@@
      */
-    readonly isUsedInPipelineTemplate: true;
+    readonly isUsedInPipelineTask: true;
     /**
      * Apply the command to the `pipelineJson`
      *
-     * Note: `$` is used to indicate that this function mutates given `templateJson` and/or `pipelineJson`
+     * Note: `$` is used to indicate that this function mutates given `taskJson` and/or `pipelineJson`
      */
-    $applyToTemplateJson(command: TCommand, $templateJson: $TemplateJson, $pipelineJson: $PipelineJson): void;
+    $applyToTaskJson(command: TCommand, $taskJson: $TaskJson, $pipelineJson: $PipelineJson): void;
     /**
-     * Reads the command from the `TemplateJson`
+     * Reads the command from the `TaskJson`
      *
      * Note: This is used in `pipelineJsonToString` utility
      */
-    takeFromTemplateJson($templateJson: $TemplateJson): ReadonlyArray<TCommand>;
+    takeFromTaskJson($taskJson: $TaskJson): ReadonlyArray<TCommand>;
 };
 /**
  * @@@
@@ -131,10 +129,10 @@ export type PipelineTemplateCommandParser<TCommand extends CommandBase> = Common
  *
  * @private internal helper for command parsers
  */
-export type $TemplateJson = {
-    isTemplateTypeSet: boolean;
-    isTemplate: boolean;
-} & Partial<WritableDeep<TemplateJson>>;
+export type $TaskJson = {
+    isSectionTypeSet: boolean;
+    isTask: boolean;
+} & Partial<WritableDeep<TaskJson>>;
 /**
  * @@@
  *
@@ -151,7 +149,7 @@ export type CommandParserInput = {
      * @@@
      *
      * @example 'PIPELINE_HEAD'
-     * @example 'PIPELINE_TEMPLATE'
+     * @example 'PIPELINE_TASK'
      */
     readonly usagePlace: CommandUsagePlace;
     /**

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

@@ -8,4 +8,4 @@ export type CommandUsagePlace = TupleToUnion<typeof CommandUsagePlaces>;
  *
  * @private internal base for `CommandUsagePlace`
  */
-export declare const CommandUsagePlaces: readonly ["PIPELINE_HEAD", "PIPELINE_TEMPLATE"];
+export declare const CommandUsagePlaces: readonly ["PIPELINE_HEAD", "PIPELINE_TASK"];

package/esm/typings/src/commands/index.d.ts

@@ -3,4 +3,7 @@
  *
  * @private internal index of `parseCommand`
  */
-export declare const COMMANDS: readonly [import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./TEMPLATE/TemplateCommand").TemplateCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./EXPECT/ExpectCommand").ExpectCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./FORMAT/FormatCommand").FormatCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./JOKER/JokerCommand").JokerCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./MODEL/ModelCommand").ModelCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PARAMETER/ParameterCommand").ParameterCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./POSTPROCESS/PostprocessCommand").PostprocessCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./BOOK_VERSION/BookVersionCommand").BookVersionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./FORMFACTOR/FormfactorCommand").FormfactorCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./URL/UrlCommand").UrlCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./KNOWLEDGE/KnowledgeCommand").KnowledgeCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_ACTION/ActionCommand").ActionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_INSTRUMENT/InstrumentCommand").InstrumentCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PERSONA/PersonaCommand").PersonaCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./FOREACH/ForeachCommand").ForeachCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./_BOILERPLATE/BoilerplateCommand").BoilerplateCommand>];
+export declare const COMMANDS: readonly [import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./SECTION/SectionCommand").SectionCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./EXPECT/ExpectCommand").ExpectCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./FORMAT/FormatCommand").FormatCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./JOKER/JokerCommand").JokerCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./MODEL/ModelCommand").ModelCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PARAMETER/ParameterCommand").ParameterCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./POSTPROCESS/PostprocessCommand").PostprocessCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./BOOK_VERSION/BookVersionCommand").BookVersionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./FORMFACTOR/FormfactorCommand").FormfactorCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./URL/UrlCommand").UrlCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./KNOWLEDGE/KnowledgeCommand").KnowledgeCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_ACTION/ActionCommand").ActionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_INSTRUMENT/InstrumentCommand").InstrumentCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PERSONA/PersonaCommand").PersonaCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./FOREACH/ForeachCommand").ForeachCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./_BOILERPLATE/BoilerplateCommand").BoilerplateCommand>];
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */ 

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

@@ -13,7 +13,7 @@ export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has be
  *
  * @public exported from `@promptbook/core`
  */
-export declare const CLAIM = "Build responsible, controlled and transparent applications on top of LLM models!";
+export declare const CLAIM = "It's time for a paradigm shift. The future of software in plain English, French or Latin";
 /**
  * When the title is not provided, the default title is used
  *
@@ -94,6 +94,13 @@ export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
+/**
+ * Where to store your books
+ * This is kind of a "src" for your books
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_BOOKS_DIRNAME = "./books";
 /**
  * Where to store the cache of executions for promptbook CLI
  *
@@ -101,7 +108,7 @@ export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
  *
  * @public exported from `@promptbook/core`
  */
-export declare const DEFAULT_EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-cache";
+export declare const DEFAULT_EXECUTIONS_CACHE_DIRNAME = "./.promptbook/executions-cache";
 /**
  * Where to store the scrape cache
  *
@@ -109,7 +116,7 @@ export declare const DEFAULT_EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions
  *
  * @public exported from `@promptbook/core`
  */
-export declare const DEFAULT_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`
  *
@@ -193,5 +200,6 @@ export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
 export declare const IS_COST_PREVENTED: boolean;
 /**
  * TODO: Extract `constants.ts` from `config.ts`
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
  */

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

@@ -1,5 +1,5 @@
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import type { PipelineString } from '../types/PipelineString';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
 /**
  * Converts promptbook in JSON format to string format
  *
@@ -9,7 +9,7 @@ import type { PipelineString } from '../types/PipelineString';
  */
 export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
 /**
- * TODO: [🛋] Implement new features and commands into `pipelineJsonToString` + `templateParameterJsonToString` , use `stringifyCommand`
+ * TODO: [🛋] Implement new features and commands into `pipelineJsonToString` + `taskParameterJsonToString` , use `stringifyCommand`
  * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
  * TODO: [🏛] Maybe make some markdown builder
  * TODO: [🏛] Escape all

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

@@ -1,7 +1,7 @@
 import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
 import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import type { PipelineString } from '../types/PipelineString';
 /**
  * Compile pipeline from string (markdown) format to JSON format
  *

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

@@ -1,5 +1,5 @@
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import type { PipelineString } from '../types/PipelineString';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
 /**
  * Compile pipeline from string (markdown) format to JSON format synchronously
  *
@@ -23,7 +23,7 @@ export declare function pipelineStringToJsonSync(pipelineString: PipelineString)
  * TODO: Use spaceTrim more effectively
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
  * TODO: [🥞] Not optimal parsing because `splitMarkdownIntoSections` is executed twice with same string, once through `flattenMarkdown` and second directly here
- * TODO: [♈] Probbably move expectations from templates to parameters
+ * TODO: [♈] Probbably move expectations from tasks to parameters
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  * TODO: [🍙] Make some standard order of json properties
  */

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

@@ -1,4 +1,4 @@
-import type { PipelineString } from '../../types/PipelineString';
+import type { PipelineString } from '../../pipeline/PipelineString';
 import type { PrettifyOptions } from './PrettifyOptions';
 /**
  * Prettyfies Promptbook string and adds Mermaid graph

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

@@ -1,14 +1,14 @@
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { string_href } from '../../types/typeAliases';
 /**
  * Addtional options for rendering Mermaid graph
  */
 export type renderPipelineMermaidOptions = {
     /**
-     * Callback for creating from template graph node
+     * Callback for creating from task graph node
      */
-    linkTemplate?(template: TemplateJson): {
+    linkTask?(task: TaskJson): {
         href: string_href;
         title: string;
     } | null;

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

@@ -0,0 +1,15 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { string_parameter_name } from '../../types/typeAliases';
+/**
+ * Parses the task and returns the set of all used parameters
+ *
+ * @param task the task with used parameters
+ * @returns the set of parameter names
+ * @throws {ParseError} if the script is invalid
+ * @public exported from `@promptbook/utils`
+ */
+export declare function extractParameterNamesFromTask(task: ReadonlyDeep<Pick<TaskJson, 'title' | 'description' | 'taskType' | 'content' | 'preparedContent' | 'jokerParameterNames' | 'foreach'>>): Set<string_parameter_name>;
+/**
+ * TODO: [🔣] If script require contentLanguage
+ */

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

@@ -1,4 +1,4 @@
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { string_name } from '../../types/typeAliases';
 type RenameParameterOptions = {
     /**
@@ -16,8 +16,8 @@ type RenameParameterOptions = {
     readonly newParameterName: string_name;
 };
 /**
- * Function `renameParameter` will find all usable parameters for given template
- * In other words, it will find all parameters that are not used in the template itseld and all its dependencies
+ * Function `renameParameter` will find all usable parameters for given task
+ * In other words, it will find all parameters that are not used in the task itseld and all its dependencies
  *
  * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
  * @public exported from `@promptbook/utils`

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

@@ -1,5 +1,5 @@
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { PipelineString } from '../../types/PipelineString';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../../pipeline/PipelineString';
 import type { string_json } from '../../types/typeAliases';
 /**
  * Import the pipeline.book.md or pipeline.book.json file
@@ -25,5 +25,6 @@ export declare function importPipelineJson(path: `${string}.book.json`): Pipelin
  */
 export declare function importPipelineJsonAsString(path: `${string}.book.json`): string_json<PipelineJson>;
 /**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [⚫] Code in this file should never be published in any package
  */

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

@@ -1,4 +1,4 @@
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 /**
  * Validates PipelineJson if it is logically valid
  *

package/esm/typings/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts

@@ -13,7 +13,7 @@ export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
     protected readonly options: CommonToolsOptions;
     constructor(options?: CommonToolsOptions);
     /**
-     * Trigger window.DIALOG TEMPLATE
+     * Trigger window.prompt dialog
      */
     promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
 }

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

@@ -27,3 +27,6 @@ export declare const ERRORS: {
     readonly PipelineUrlError: typeof PipelineUrlError;
     readonly UnexpectedError: typeof UnexpectedError;
 };
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */ 

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

@@ -1,8 +1,8 @@
 import { ReadonlyDeep } from 'type-fest';
 import type { ErrorJson } from '../errors/utils/ErrorJson';
-import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 import type { Parameters } from '../types/typeAliases';
+import type { ExecutionReportJson } from './execution-report/ExecutionReportJson';
 import type { PromptResultUsage } from './PromptResultUsage';
 /**
  * @@@

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

@@ -1,5 +1,5 @@
 import type { KebabCase } from 'type-fest';
-import type { ExpectationUnit } from '../types/PipelineJson/Expectations';
+import type { ExpectationUnit } from '../pipeline/PipelineJson/Expectations';
 import type { UncertainNumber } from './UncertainNumber';
 /**
  * Usage statistics for one or many prompt results

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

@@ -2,7 +2,7 @@ import type { ScriptLanguage } from '../types/ScriptLanguage';
 import type { Parameters } from '../types/typeAliases';
 import type { string_script } from '../types/typeAliases';
 /**
- * Represents all the tools needed to execute SCRIPT TEMPLATE
+ * Represents all the tools needed to execute `SCRIPT` tasks
  *
  * @see https://github.com/webgptorg/promptbook#script-execution-tools
  */

package/esm/typings/src/execution/createPipelineExecutor/{$OngoingTemplateResult.d.ts → $OngoingTaskResult.d.ts}

@@ -9,7 +9,7 @@ import type { PromptResult } from '../PromptResult';
  *
  * @private internal utility of `createPipelineExecutor`
  */
-export type $OngoingTemplateResult = {
+export type $OngoingTaskResult = {
     /**
      * @@@
      */

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

@@ -1,6 +1,6 @@
 import type { CsvSettings } from '../../formats/csv/CsvSettings';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 import type { ExecutionTools } from '../ExecutionTools';
 /**
  * Options for `createPipelineExecutor`

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

@@ -1,5 +1,5 @@
 import type { Promisable, ReadonlyDeep } from 'type-fest';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskProgress } from '../../types/TaskProgress';
 import type { Parameters } from '../../types/typeAliases';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';

package/esm/typings/src/execution/createPipelineExecutor/{20-executeTemplate.d.ts → 20-executeTask.d.ts}

@@ -1,20 +1,20 @@
 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 { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { TaskProgress } from '../../types/TaskProgress';
 import type { Parameters } from '../../types/typeAliases';
+import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
  * @@@
  *
- * @private internal type of `executeTemplate`
+ * @private internal type of `executeTask`
  */
-type executeSingleTemplateOptions = CreatePipelineExecutorOptions & {
+type executeSingleTaskOptions = CreatePipelineExecutorOptions & {
     /**
      * @@@
      */
-    readonly currentTemplate: ReadonlyDeep<TemplateJson>;
+    readonly currentTask: ReadonlyDeep<TaskJson>;
     /**
      * @@@
      */
@@ -41,7 +41,7 @@ type executeSingleTemplateOptions = CreatePipelineExecutorOptions & {
  *
  * @private internal utility of `createPipelineExecutor`
  */
-export declare function executeTemplate(options: executeSingleTemplateOptions): Promise<Readonly<Parameters>>;
+export declare function executeTask(options: executeSingleTaskOptions): Promise<Readonly<Parameters>>;
 export {};
 /**
  * TODO: [🤹‍♂️]

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

@@ -1,10 +1,10 @@
 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 { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 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 { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
  * @@@
@@ -25,7 +25,7 @@ export type ExecuteAttemptsOptions = Omit<CreatePipelineExecutorOptions, 'pipeli
      *
      * 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.
+     * 2) `maxAttempts` - the amount of attempts for any task - LLM, SCRIPT, DIALOG, etc.
      */
     readonly maxAttempts: number;
     /**
@@ -39,7 +39,7 @@ export type ExecuteAttemptsOptions = Omit<CreatePipelineExecutorOptions, 'pipeli
     /**
      * @@@
      */
-    readonly template: ReadonlyDeep<TemplateJson>;
+    readonly task: ReadonlyDeep<TaskJson>;
     /**
      * @@@
      */

package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts

@@ -1,6 +1,6 @@
 import type { ReadonlyDeep } from 'type-fest';
 import { PipelineExecutionError } from '../../errors/PipelineExecutionError';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { Parameters } from '../../types/typeAliases';
 /**
  * @@@

package/esm/typings/src/execution/createPipelineExecutor/{getContextForTemplate.d.ts → getContextForTask.d.ts}

@@ -1,5 +1,5 @@
 import type { ReadonlyDeep } from 'type-fest';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
 /**
@@ -7,4 +7,4 @@ import type { string_parameter_value } from '../../types/typeAliases';
  *
  * @private internal utility of `createPipelineExecutor`
  */
-export declare function getContextForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;
+export declare function getContextForTask(task: ReadonlyDeep<TaskJson>): Promise<string_parameter_value & string_markdown>;

package/esm/typings/src/execution/createPipelineExecutor/{getExamplesForTemplate.d.ts → getExamplesForTask.d.ts}

@@ -1,5 +1,5 @@
 import type { ReadonlyDeep } from 'type-fest';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
 /**
@@ -7,4 +7,4 @@ import type { string_parameter_value } from '../../types/typeAliases';
  *
  * @private internal utility of `createPipelineExecutor`
  */
-export declare function getExamplesForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;
+export declare function getExamplesForTask(task: ReadonlyDeep<TaskJson>): Promise<string_parameter_value & string_markdown>;

package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts

@@ -0,0 +1,27 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal type of `getKnowledgeFoTask`
+ */
+type GetKnowledgeForTaskOptions = {
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly task: ReadonlyDeep<TaskJson>;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getKnowledgeForTask(options: GetKnowledgeForTaskOptions): Promise<string_parameter_value & string_markdown>;
+export {};