@promptbook/remote-server 0.68.0-0 → 0.68.0-2

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

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

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

@@ -1,4 +1,4 @@
-import type { CommandParser } from '../_common/types/CommandParser';
+import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
 import type { KnowledgeCommand } from './KnowledgeCommand';
 /**
  * Parses the knowledge command
@@ -6,4 +6,4 @@ import type { KnowledgeCommand } from './KnowledgeCommand';
  * @see ./KNOWLEDGE-README.md for more details
  * @private within the commands folder
  */
-export declare const knowledgeCommandParser: CommandParser<KnowledgeCommand>;
+export declare const knowledgeCommandParser: PipelineHeadCommandParser<KnowledgeCommand>;

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

@@ -1,4 +1,4 @@
-import type { CommandParser } from '../_common/types/CommandParser';
+import type { PipelineBothCommandParser } from '../_common/types/CommandParser';
 import type { ModelCommand } from './ModelCommand';
 /**
  * Parses the model command
@@ -6,4 +6,4 @@ import type { ModelCommand } from './ModelCommand';
  * @see ./MODEL-README.md for more details
  * @private within the commands folder
  */
-export declare const modelCommandParser: CommandParser<ModelCommand>;
+export declare const modelCommandParser: PipelineBothCommandParser<ModelCommand>;

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

@@ -1,4 +1,4 @@
-import type { CommandParser } from '../_common/types/CommandParser';
+import type { PipelineBothCommandParser } from '../_common/types/CommandParser';
 import type { ParameterCommand } from './ParameterCommand';
 /**
  * Parses the parameter command
@@ -6,4 +6,4 @@ import type { ParameterCommand } from './ParameterCommand';
  * @see ./PARAMETER-README.md for more details
  * @private within the commands folder
  */
-export declare const parameterCommandParser: CommandParser<ParameterCommand>;
+export declare const parameterCommandParser: PipelineBothCommandParser<ParameterCommand>;

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

@@ -1,4 +1,4 @@
-import type { CommandParser } from '../_common/types/CommandParser';
+import type { PipelineBothCommandParser } from '../_common/types/CommandParser';
 import type { PersonaCommand } from './PersonaCommand';
 /**
  * Parses the persona command
@@ -6,4 +6,4 @@ import type { PersonaCommand } from './PersonaCommand';
  * @see ./PERSONA-README.md for more details
  * @private within the commands folder
  */
-export declare const personaCommandParser: CommandParser<PersonaCommand>;
+export declare const personaCommandParser: PipelineBothCommandParser<PersonaCommand>;

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

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

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

@@ -1,4 +1,4 @@
-import type { CommandParser } from '../_common/types/CommandParser';
+import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
 import type { PromptbookVersionCommand } from './PromptbookVersionCommand';
 /**
  * Parses the PROMPTBOOK_VERSION command
@@ -6,4 +6,4 @@ import type { PromptbookVersionCommand } from './PromptbookVersionCommand';
  * @see ./PROMPTBOOK_VERSION-README.md for more details
  * @private within the commands folder
  */
-export declare const promptbookVersionCommandParser: CommandParser<PromptbookVersionCommand>;
+export declare const promptbookVersionCommandParser: PipelineHeadCommandParser<PromptbookVersionCommand>;

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

@@ -1,4 +1,4 @@
-import type { CommandParser } from '../_common/types/CommandParser';
+import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
 import type { UrlCommand } from './UrlCommand';
 /**
  * Parses the url command
@@ -6,4 +6,4 @@ import type { UrlCommand } from './UrlCommand';
  * @see ./URL-README.md for more details
  * @private within the commands folder
  */
-export declare const urlCommandParser: CommandParser<UrlCommand>;
+export declare const urlCommandParser: PipelineHeadCommandParser<UrlCommand>;

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

@@ -1,4 +1,4 @@
-import type { CommandParser } from '../_common/types/CommandParser';
+import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
 import type { ActionCommand } from './ActionCommand';
 /**
  * Parses the action command
@@ -6,4 +6,4 @@ import type { ActionCommand } from './ActionCommand';
  * @see ./ACTION-README.md for more details
  * @private within the commands folder
  */
-export declare const actionCommandParser: CommandParser<ActionCommand>;
+export declare const actionCommandParser: PipelineHeadCommandParser<ActionCommand>;

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

@@ -1,4 +1,4 @@
-import type { CommandParser } from '../_common/types/CommandParser';
+import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
 import type { InstrumentCommand } from './InstrumentCommand';
 /**
  * Parses the instrument command
@@ -6,4 +6,4 @@ import type { InstrumentCommand } from './InstrumentCommand';
  * @see ./INSTRUMENT-README.md for more details
  * @private within the commands folder
  */
-export declare const instrumentCommandParser: CommandParser<InstrumentCommand>;
+export declare const instrumentCommandParser: PipelineHeadCommandParser<InstrumentCommand>;

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

@@ -1,12 +1,14 @@
-import type { CommandParser } from '../_common/types/CommandParser';
+import type { PipelineBothCommandParser } from '../_common/types/CommandParser';
 import type { BoilerplateCommand } from './BoilerplateCommand';
 /**
  * Parses the boilerplate command
  *
- * @see ./BOILERPLATE-README.md for more details
+ * 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)
  * @private within the commands folder
  */
-export declare const boilerplateCommandParser: CommandParser<BoilerplateCommand>;
+export declare const boilerplateCommandParser: PipelineBothCommandParser<BoilerplateCommand>;
 /**
- * TODO: [💐] Implement BOILERPLATE command into `pipelineStringToJsonSync` function
+ * TODO: !!!!!! Make .ptbk.md file with examples of the BOILERPLATE command and fail
  */

package/esm/typings/src/commands/_common/parseCommand.d.ts

@@ -5,7 +5,7 @@ import type { CommandUsagePlace } from './types/CommandUsagePlaces';
  * Parses one line of ul/ol to command
  *
  * @returns parsed command object
- * @throws {ParsingError} if the command is invalid
+ * @throws {ParseError} if the command is invalid
  *
  * @private within the pipelineStringToJson
  */

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

@@ -1,6 +1,6 @@
 import { COMMANDS } from '../../index';
 /**
- * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
+ * Command is one piece of the template which adds some logic to the template 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,64 +1,171 @@
 import type { WritableDeep } from 'type-fest';
-import type { PromptTemplateJson } from '../../../types/PipelineJson/PromptTemplateJson';
 import type { PipelineJson } from '../../../types/PipelineJson/PipelineJson';
+import type { TemplateJson } from '../../../types/PipelineJson/TemplateJson';
 import type { string_markdown_text } from '../../../types/typeAliases';
 import type { string_name } from '../../../types/typeAliases';
 import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
+import type { ___and___ } from '../../../utils/organization/___and___';
 import type { CommandUsagePlace } from './CommandUsagePlaces';
-export type CommandParser<TCommand extends {
+/**
+ * @@@
+ *
+ * @private just abstract helper for command parsers
+ */
+export type CommandBase = {
     type: string_name & string_SCREAMING_CASE;
-}> = {
+};
+/**
+ * @@@
+ */
+export type CommandParser<TCommand extends CommandBase> = PipelineHeadCommandParser<TCommand> | PipelineTemplateCommandParser<TCommand> | PipelineBothCommandParser<TCommand>;
+/**
+ * @@@
+ *
+ * @private just abstract the common properties of the command parsers
+ */
+export type CommonCommandParser<TCommand extends CommandBase> = {
+    /**
+     * @@@
+     */
     readonly name: string_name & string_SCREAMING_CASE;
+    /**
+     * @@@
+     */
+    readonly isUsedInPipelineHead: boolean;
+    /**
+     * @@@
+     */
+    readonly isUsedInPipelineTemplate: boolean;
+    /**
+     * @@@
+     */
     readonly aliasNames?: Array<string_name & string_SCREAMING_CASE>;
+    /**
+     * @@@
+     */
     readonly deprecatedNames?: Array<string_name & string_SCREAMING_CASE>;
-    readonly usagePlaces: Array<CommandUsagePlace>;
+    /**
+     * @@@
+     */
     readonly description: string_markdown_text;
+    /**
+     * @@@
+     */
     readonly documentationUrl: string_promptbook_documentation_url;
+    /**
+     * @@@
+     */
     readonly examples: Array<string_markdown_text>;
     /**
-     * @throws {ParsingError} if the parsing fails
+     * @throws {ParseError} if the parsing fails
      */
     parse(input: CommandParserInput): TCommand;
     /**
-     * @@@ Mutated by the command
+     * Converts the command back to string
+     *
+     * Note: This is used in `pipelineJsonToString` utility
      */
-    applyToPipelineJson?(command: TCommand, subjects: ApplyToPipelineJsonSubjects): void;
+    stringify(command: TCommand): string_markdown_text;
 };
-export type CommandParserInput = {
-    readonly usagePlace: CommandUsagePlace;
-    readonly raw: string_markdown_text;
-    readonly rawArgs: string_markdown_text;
-    readonly normalized: string_name & string_SCREAMING_CASE;
-    readonly args: Array<string_name & string_SCREAMING_CASE>;
+/**
+ * @@@
+ */
+export type PipelineBothCommandParser<TCommand extends CommandBase> = ___and___ & Omit<PipelineHeadCommandParser<TCommand>, 'isUsedInPipelineTemplate'> & Omit<PipelineTemplateCommandParser<TCommand>, 'isUsedInPipelineHead'>;
+/**
+ * @@@
+ */
+export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonCommandParser<TCommand> & {
+    /**
+     * @@@
+     */
+    readonly isUsedInPipelineHead: true;
+    /**
+     * @@@
+     */
+    readonly isUsedInPipelineTemplate: false;
+    /**
+     * Apply the command to the `pipelineJson`
+     *
+     * Note: `$` is used to indicate that this function mutates given `pipelineJson`
+     */
+    $applyToPipelineJson(command: TCommand, $pipelineJson: $PipelineJson): void;
+    /**
+     * Reads the command from the `PipelineJson`
+     *
+     * Note: This is used in `pipelineJsonToString` utility
+     */
+    takeFromPipelineJson(pipelineJson: PipelineJson): Array<TCommand>;
 };
 /**
- * @@@ Mutated by the command
+ * @@@
  */
-export type ApplyToPipelineJsonSubjects = {
+export type PipelineTemplateCommandParser<TCommand extends CommandBase> = CommonCommandParser<TCommand> & {
     /**
-     * @@@ Mutated by the command
+     * @@@
      */
-    readonly pipelineJson: WritableDeep<PipelineJson>;
+    readonly isUsedInPipelineHead: false;
     /**
      * @@@
+     */
+    readonly isUsedInPipelineTemplate: true;
+    /**
+     * Apply the command to the `pipelineJson`
      *
-     * @@@ Mutated by the command
+     * Note: `$` is used to indicate that this function mutates given `templateJson` and/or `pipelineJson`
+     */
+    $applyToTemplateJson(command: TCommand, $templateJson: $TemplateJson, $pipelineJson: $PipelineJson): void;
+    /**
+     * Reads the command from the `TemplateJson`
      *
-     * When used in
-     * - `PIPELINE_HEAD` it is `null`
-     * - `PIPELINE_TEMPLATE` it is the prompt template
+     * Note: This is used in `pipelineJsonToString` utility
      */
-    readonly templateJson: null | Partial<WritableDeep<PromptTemplateJson>>;
+    takeFromTemplateJson($templateJson: $TemplateJson): Array<TCommand>;
 };
 /**
- * TODO: @@@ Annotate all
- * TODO: [🍧][♓️] Add order here
- * TODO: [🧠] Maybe put flag if it is for whole `.ptbk.md` file of just one section
- * TODO: [🍧] All commands must implement `applyToPipelineJson` method
- *       which will apply parsed command to the pipeline JSON
- *       it will be called from `pipelineStringToJsonSync`
- *       and replace hardcoded switch statement and [💐]
- *       and throw ParsingError
+ * @@@
  *
+ * Note: `$` is used to indicate that purpose of this type is to mutate the given object
+ *
+ * @private internal helper for command parsers
+ */
+export type $TemplateJson = {
+    isBlockTypeSet: boolean;
+    isTemplateBlock: boolean;
+} & Partial<WritableDeep<TemplateJson>>;
+/**
+ * @@@
+ *
+ *  Note: `$` is used to indicate that purpose of this type is to mutate the given object
+ *
+ * @private internal helper for command parsers
+ */
+export type $PipelineJson = WritableDeep<PipelineJson>;
+/**
+ * @@@
+ */
+export type CommandParserInput = {
+    /**
+     * @@@
+     */
+    readonly usagePlace: CommandUsagePlace;
+    /**
+     * @@@
+     */
+    readonly raw: string_markdown_text;
+    /**
+     * @@@
+     */
+    readonly rawArgs: string_markdown_text;
+    /**
+     * @@@
+     */
+    readonly normalized: string_name & string_SCREAMING_CASE;
+    /**
+     * @@@
+     */
+    readonly args: Array<string_name & string_SCREAMING_CASE>;
+};
+/**
+ * TODO: [♓️] Add order here
  */

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

@@ -3,4 +3,4 @@
  *
  * @private internal index of `parseCommand`
  */
-export declare const COMMANDS: readonly [import("./_common/types/CommandParser").CommandParser<import("./BLOCK/BlockCommand").BlockCommand>, import("./_common/types/CommandParser").CommandParser<import("./EXPECT/ExpectCommand").ExpectCommand>, import("./_common/types/CommandParser").CommandParser<import("./JOKER/JokerCommand").JokerCommand>, import("./_common/types/CommandParser").CommandParser<import("./MODEL/ModelCommand").ModelCommand>, import("./_common/types/CommandParser").CommandParser<import("./PARAMETER/ParameterCommand").ParameterCommand>, import("./_common/types/CommandParser").CommandParser<import("./POSTPROCESS/PostprocessCommand").PostprocessCommand>, import("./_common/types/CommandParser").CommandParser<import("./PROMPTBOOK_VERSION/PromptbookVersionCommand").PromptbookVersionCommand>, import("./_common/types/CommandParser").CommandParser<import("./URL/UrlCommand").UrlCommand>, import("./_common/types/CommandParser").CommandParser<import("./KNOWLEDGE/KnowledgeCommand").KnowledgeCommand>, import("./_common/types/CommandParser").CommandParser<import("./X_ACTION/ActionCommand").ActionCommand>, import("./_common/types/CommandParser").CommandParser<import("./X_INSTRUMENT/InstrumentCommand").InstrumentCommand>, import("./_common/types/CommandParser").CommandParser<import("./PERSONA/PersonaCommand").PersonaCommand>, import("./_common/types/CommandParser").CommandParser<import("./_BOILERPLATE/BoilerplateCommand").BoilerplateCommand>];
+export declare const COMMANDS: readonly [import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./BLOCK/BlockCommand").BlockCommand>, 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("./PROMPTBOOK_VERSION/PromptbookVersionCommand").PromptbookVersionCommand>, 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>];

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

@@ -9,7 +9,7 @@ import type { PipelineString } from '../types/PipelineString';
  */
 export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
 /**
- * TODO: !!!! Implement new features and commands into `promptTemplateParameterJsonToString`
+ * TODO: !!!!!! Implement new features and commands into `templateParameterJsonToString`
  * 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

@@ -28,7 +28,7 @@ export type PipelineStringToJsonOptions = {
  * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
  * @param options - Options and tools for the compilation
  * @returns {Promptbook} compiled in JSON format (.ptbk.json)
- * @throws {ParsingError} if the promptbook string is not valid
+ * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */
 export declare function pipelineStringToJson(pipelineString: PipelineString, options?: PipelineStringToJsonOptions): Promise<PipelineJson>;

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

@@ -13,7 +13,7 @@ import type { PipelineString } from '../types/PipelineString';
  *
  * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
  * @returns {Promptbook} compiled in JSON format (.ptbk.json)
- * @throws {ParsingError} if the promptbook string is not valid
+ * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */
 export declare function pipelineStringToJsonSync(pipelineString: PipelineString): PipelineJson;
@@ -25,5 +25,5 @@ export declare function pipelineStringToJsonSync(pipelineString: PipelineString)
  * 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: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
- * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🍙] Make some standard order of json properties
  */

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

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

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

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

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

@@ -0,0 +1 @@
+export {};

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

@@ -5,7 +5,7 @@ import type { string_javascript_name } from '../../types/typeAliases';
  *
  * @param script from which to extract the variables
  * @returns the list of variable names
- * @throws {ParsingError} if the script is invalid
+ * @throws {ParseError} if the script is invalid
  * @public exported from `@promptbook/utils`
  */
 export declare function extractVariables(script: string_javascript): Set<string_javascript_name>;

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

@@ -16,8 +16,8 @@ type RenameParameterOptions = {
     readonly newParameterName: string_name;
 };
 /**
- * Function renameParameter will find all usable parameters for given prompt template
- * In other words, it will find all parameters that are not used in the prompt template itseld and all its dependencies
+ * 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
  *
  * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
  * @public exported from `@promptbook/utils`

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

@@ -12,5 +12,5 @@ export declare function stringifyPipelineJson<TType>(pipeline: TType): string_js
  * TODO: [🐝] Not Working propperly @see https://promptbook.studio/samples/mixed-knowledge.ptbk.md
  * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
  * TODO: [🧠] Maybe more elegant solution than replacing via regex
- * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🍙] Make some standard order of json properties
  */

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

@@ -7,7 +7,7 @@ import type { string_json } from '../../types/typeAliases';
  * Note: Using here custom import to work in jest tests
  * Note: Using sync version is 💩 in the production code, but it's ok here in tests
  *
- * @param path - The path to the file relative to samples/templates directory
+ * @param path - The path to the file relative to samples/pipelines directory
  * @private internal function of tests
  */
 export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.md`): PipelineString;

package/esm/typings/src/errors/{ParsingError.d.ts → ParseError.d.ts}

@@ -3,7 +3,10 @@
  *
  * @public exported from `@promptbook/core`
  */
-export declare class ParsingError extends Error {
-    readonly name = "ParsingError";
+export declare class ParseError extends Error {
+    readonly name = "ParseError";
     constructor(message: string);
 }
+/**
+ * TODO: Maybe split `ParseError` and `ApplyError`
+ */

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

@@ -4,7 +4,7 @@ import { ExpectError } from './ExpectError';
 import { LimitReachedError } from './LimitReachedError';
 import { NotFoundError } from './NotFoundError';
 import { NotYetImplementedError } from './NotYetImplementedError';
-import { ParsingError } from './ParsingError';
+import { ParseError } from './ParseError';
 import { PipelineExecutionError } from './PipelineExecutionError';
 import { PipelineLogicError } from './PipelineLogicError';
 import { PipelineUrlError } from './PipelineUrlError';
@@ -21,7 +21,7 @@ export declare const ERRORS: {
     readonly LimitReachedError: typeof LimitReachedError;
     readonly NotFoundError: typeof NotFoundError;
     readonly NotYetImplementedError: typeof NotYetImplementedError;
-    readonly ParsingError: typeof ParsingError;
+    readonly ParseError: typeof ParseError;
     readonly PipelineExecutionError: typeof PipelineExecutionError;
     readonly PipelineLogicError: typeof PipelineLogicError;
     readonly PipelineUrlError: typeof PipelineUrlError;

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

@@ -1,3 +1,8 @@
+/**
+ * @@@
+ *
+ * @private just abstract the common properties for the execution tools
+ */
 export type CommonExecutionToolsOptions = {
     /**
      * If true, the internal executions will be logged

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

@@ -39,6 +39,8 @@ export type EmbeddingPromptResult = Omit<CommonPromptResult, 'content'> & {
  * Common properties for all prompt results
  *
  * Note: [🚉] This is fully serializable as JSON
+ *
+ * @private just abstract the common properties of the prompt results
  */
 export type CommonPromptResult = {
     /**

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

@@ -29,5 +29,5 @@ export type PromptResultUsage = {
  */
 export type PromptResultUsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
 /**
- * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🍙] Make some standard order of json properties
  */

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

@@ -63,7 +63,7 @@ export {};
  * TODO: [🧠][🌳] Use here `countTotalUsage` and put preparation and prepared pipiline to report
  * TODO: [🪂] Use maxParallelCount here (not only pass to `preparePipeline`)
  * TODO: [♈] Probbably move expectations from templates to parameters
- * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
+ * TODO: [🧠] When not meet expectations in DIALOG_TEMPLATE, make some way to tell the user
  * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
  * Note: CreatePipelineExecutorOptions are just connected to PipelineExecutor so do not extract to types folder
  * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode

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

@@ -13,7 +13,7 @@ export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
     private readonly options;
     constructor(options?: CommonExecutionToolsOptions);
     /**
-     * Trigger window.PROMPT DIALOG
+     * Trigger window.DIALOG BLOCK
      */
     promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
 }

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

@@ -39,7 +39,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     /**
      * Calls OpenAI API to use a chat model.
      */
-    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'expectFormat'>): Promise<ChatPromptResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>): Promise<ChatPromptResult>;
     /**
      * Calls OpenAI API to use a complete model.
      */

package/esm/typings/src/postprocessing/utils/extractBlock.d.ts

@@ -2,7 +2,7 @@ import type { string_markdown } from '../../types/typeAliases';
 /**
  * Extracts code block from markdown.
  *
- * - When there are multiple or no code blocks the function throws a `ParsingError`
+ * - When there are multiple or no code blocks the function throws a `ParseError`
  *
  * Note: There are multiple simmilar function:
  * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
@@ -11,6 +11,6 @@ import type { string_markdown } from '../../types/typeAliases';
  * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
  *
  * @public exported from `@promptbook/markdown-utils`
- * @throws {ParsingError} if there is not exactly one code block in the markdown
+ * @throws {ParseError} if there is not exactly one code block in the markdown
  */
 export declare function extractBlock(markdown: string_markdown): string;

package/esm/typings/src/postprocessing/utils/extractJsonBlock.d.ts

@@ -5,8 +5,8 @@ import type { really_unknown } from '../../utils/organization/really_unknown';
  * Extracts  extracts exactly one valid JSON code block
  *
  * - When given string is a valid JSON as it is, it just returns it
- * - When there is no JSON code block the function throws a `ParsingError`
- * - When there are multiple JSON code blocks the function throws a `ParsingError`
+ * - When there is no JSON code block the function throws a `ParseError`
+ * - When there are multiple JSON code blocks the function throws a `ParseError`
  *
  * Note: It is not important if marked as ```json BUT if it is VALID JSON
  * Note: There are multiple simmilar function:
@@ -16,7 +16,7 @@ import type { really_unknown } from '../../utils/organization/really_unknown';
  * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
  *
  * @public exported from `@promptbook/markdown-utils`
- * @throws {ParsingError} if there is no valid JSON block in the markdown
+ * @throws {ParseError} if there is no valid JSON block in the markdown
  */
 export declare function extractJsonBlock(markdown: string_markdown): string_json<really_unknown>;
 /**