@promptbook/vercel 0.76.0

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

@@ -0,0 +1,13 @@
+import type { ModelRequirements } from '../../types/ModelRequirements';
+import type { TODO_any } from '../../utils/organization/TODO_any';
+/**
+ * Parsed MODEL command
+ *
+ * @see ./modelCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type ModelCommand = {
+    readonly type: 'MODEL';
+    readonly key: keyof ModelRequirements;
+    readonly value: TODO_any;
+};

package/esm/typings/src/commands/MODEL/modelCommand.test.d.ts

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

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

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

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

@@ -0,0 +1,15 @@
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Parsed PARAMETER command
+ *
+ * @see ./parameterCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type ParameterCommand = {
+    readonly type: 'PARAMETER';
+    readonly isInput: boolean;
+    readonly isOutput: boolean;
+    readonly parameterName: string_name;
+    readonly parameterDescription: string_markdown_text | null;
+};

package/esm/typings/src/commands/PARAMETER/parameterCommand.test.d.ts

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

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

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

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

@@ -0,0 +1,13 @@
+import type { string_name } from '../../types/typeAliases';
+import type { string_persona_description } from '../../types/typeAliases';
+/**
+ * Parsed PERSONA command
+ *
+ * @see ./personaCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type PersonaCommand = {
+    readonly type: 'PERSONA';
+    readonly personaName: string_name;
+    readonly personaDescription: string_persona_description | null;
+};

package/esm/typings/src/commands/PERSONA/personaCommand.test.d.ts

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

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

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

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

@@ -0,0 +1,11 @@
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Parsed POSTPROCESS command
+ *
+ * @see ./postprocessCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type PostprocessCommand = {
+    readonly type: 'POSTPROCESS';
+    readonly functionName: string_name;
+};

package/esm/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts

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

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

@@ -0,0 +1,9 @@
+import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
+import type { PostprocessCommand } from './PostprocessCommand';
+/**
+ * Parses the postprocess command
+ *
+ * @see `documentationUrl` for more details
+ * @private within the commands folder
+ */
+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/SECTION/sectionCommand.test.d.ts

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

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

@@ -0,0 +1,20 @@
+import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
+import type { SectionCommand } from './SectionCommand';
+/**
+ * Parses the section command
+ *
+ * @see `documentationUrl` for more details
+ * @private within the commands folder
+ */
+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 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/URL/UrlCommand.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Parsed URL command
+ *
+ * @see ./urlCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type UrlCommand = {
+    readonly type: 'URL';
+    readonly pipelineUrl: URL;
+};

package/esm/typings/src/commands/URL/urlCommand.test.d.ts

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

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * Parsed ACTION command
+ *
+ * @see ./actionCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type ActionCommand = {
+    readonly type: 'ACTION';
+};

package/esm/typings/src/commands/X_ACTION/actionCommand.test.d.ts

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

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

@@ -0,0 +1,12 @@
+import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
+import type { ActionCommand } from './ActionCommand';
+/**
+ * Parses the action command
+ *
+ * @see `documentationUrl` for more details
+ * @private within the commands folder
+ */
+export declare const actionCommandParser: PipelineHeadCommandParser<ActionCommand>;
+/**
+ * Note: [⛱] There are two types of ACTION commands *...(read more in [⛱])*
+ */

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

@@ -0,0 +1,9 @@
+/**
+ * Parsed INSTRUMENT command
+ *
+ * @see ./instrumentCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type InstrumentCommand = {
+    readonly type: 'INSTRUMENT';
+};

package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts

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

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

@@ -0,0 +1,12 @@
+import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
+import type { InstrumentCommand } from './InstrumentCommand';
+/**
+ * Parses the instrument command
+ *
+ * @see `documentationUrl` for more details
+ * @private within the commands folder
+ */
+export declare const instrumentCommandParser: PipelineHeadCommandParser<InstrumentCommand>;
+/**
+ * Note: [⛱] There are two types of INSTRUMENT commands *...(read more in [⛱])*
+ */

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

@@ -0,0 +1,10 @@
+/**
+ * Parsed BOILERPLATE command
+ *
+ * @see ./boilerplateCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type BoilerplateCommand = {
+    readonly type: 'BOILERPLATE';
+    readonly value: string;
+};

package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts

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

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

@@ -0,0 +1,11 @@
+import type { PipelineBothCommandParser } from '../_common/types/CommandParser';
+import type { BoilerplateCommand } from './BoilerplateCommand';
+/**
+ * Parses the boilerplate command
+ *
+ * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.book.md` file
+ *
+ * @see `documentationUrl` for more details
+ * @private within the commands folder
+ */
+export declare const boilerplateCommandParser: PipelineBothCommandParser<BoilerplateCommand>;

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

@@ -0,0 +1,11 @@
+import type { Command } from './types/Command';
+import type { CommandParser } from './types/CommandParser';
+/**
+ * Gets the parser for the command
+ *
+ * @returns the parser for the command
+ * @throws {UnexpectedError} if the parser is not found
+ *
+ * @private within the pipelineStringToJson
+ */
+export declare function getParserForCommand<TCommand extends Command>(command: TCommand): CommandParser<TCommand>;

package/esm/typings/src/commands/_common/getParserForCommand.test.d.ts

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

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

@@ -0,0 +1,12 @@
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { Command } from './types/Command';
+import type { CommandUsagePlace } from './types/CommandUsagePlaces';
+/**
+ * Parses one line of ul/ol to command
+ *
+ * @returns parsed command object
+ * @throws {ParseError} if the command is invalid
+ *
+ * @private within the pipelineStringToJson
+ */
+export declare function parseCommand(raw: string_markdown_text, usagePlace: CommandUsagePlace): Command;

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

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

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

@@ -0,0 +1,11 @@
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { Command } from './types/Command';
+/**
+ * Stringifies the command
+ *
+ * @returns stringified command
+ * @throws {UnexpectedError} if the command is invalid
+ *
+ * @private within the pipelineStringToJson
+ */
+export declare function stringifyCommand(command: Command): string_markdown_text;

package/esm/typings/src/commands/_common/stringifyCommand.test.d.ts

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

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

@@ -0,0 +1,6 @@
+import { COMMANDS } from '../../index';
+/**
+ * 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

@@ -0,0 +1,186 @@
+import type { WritableDeep } from 'type-fest';
+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';
+import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
+import type { ___and___ } from '../../../utils/organization/___and___';
+import type { CommandUsagePlace } from './CommandUsagePlaces';
+/**
+ * @@@
+ *
+ * @private just abstract helper for command parsers
+ */
+export type CommandBase = {
+    type: string_name & string_SCREAMING_CASE;
+};
+/**
+ * @@@
+ */
+export type CommandParser<TCommand extends CommandBase> = PipelineHeadCommandParser<TCommand> | PipelineTaskCommandParser<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 isUsedInPipelineTask: boolean;
+    /**
+     * @@@
+     */
+    readonly aliasNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
+    /**
+     * @@@
+     */
+    readonly deprecatedNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
+    /**
+     * @@@
+     */
+    readonly description: string_markdown_text;
+    /**
+     * @@@
+     */
+    readonly documentationUrl: string_promptbook_documentation_url;
+    /**
+     * @@@
+     */
+    readonly examples: ReadonlyArray<string_markdown_text>;
+    /**
+     * @throws {ParseError} if the parsing fails
+     */
+    parse(input: CommandParserInput): TCommand;
+    /**
+     * Converts the command back to string
+     *
+     * Note: This is used in `pipelineJsonToString` utility
+     */
+    stringify(command: TCommand): string_markdown_text;
+};
+/**
+ * @@@
+ */
+export type PipelineBothCommandParser<TCommand extends CommandBase> = ___and___ & Omit<PipelineHeadCommandParser<TCommand>, 'isUsedInPipelineTask'> & Omit<PipelineTaskCommandParser<TCommand>, 'isUsedInPipelineHead'>;
+/**
+ * @@@
+ */
+export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonCommandParser<TCommand> & {
+    /**
+     * @@@
+     */
+    readonly isUsedInPipelineHead: true;
+    /**
+     * @@@
+     */
+    readonly isUsedInPipelineTask: 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): ReadonlyArray<TCommand>;
+};
+/**
+ * @@@
+ */
+export type PipelineTaskCommandParser<TCommand extends CommandBase> = CommonCommandParser<TCommand> & {
+    /**
+     * @@@
+     */
+    readonly isUsedInPipelineHead: false;
+    /**
+     * @@@
+     */
+    readonly isUsedInPipelineTask: true;
+    /**
+     * Apply the command to the `pipelineJson`
+     *
+     * Note: `$` is used to indicate that this function mutates given `taskJson` and/or `pipelineJson`
+     */
+    $applyToTaskJson(command: TCommand, $taskJson: $TaskJson, $pipelineJson: $PipelineJson): void;
+    /**
+     * Reads the command from the `TaskJson`
+     *
+     * Note: This is used in `pipelineJsonToString` utility
+     */
+    takeFromTaskJson($taskJson: $TaskJson): ReadonlyArray<TCommand>;
+};
+/**
+ * @@@
+ *
+ * Note: `$` is used to indicate that purpose of this type is to mutate the given object
+ *
+ * @private internal helper for command parsers
+ */
+export type $TaskJson = {
+    isSectionTypeSet: boolean;
+    isTask: boolean;
+} & Partial<WritableDeep<TaskJson>>;
+/**
+ * @@@
+ *
+ *  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 = {
+    /**
+     * @@@
+     *
+     * @example 'PIPELINE_HEAD'
+     * @example 'PIPELINE_TASK'
+     */
+    readonly usagePlace: CommandUsagePlace;
+    /**
+     * @@@
+     *
+     * @example 'promptbook version 0.62.0'
+     * @example 'FOREACH Text Line `{customers}` -> `{customer}`'
+     */
+    readonly raw: string_markdown_text;
+    /**
+     * @@@
+     *
+     * @example '0.62.0'
+     * @example 'List Line `{customers}` -> `{customer}`'
+     */
+    readonly rawArgs: string_markdown_text;
+    /**
+     * @@@
+     *
+     * @example 'PROMPTBOOK_ENGINE_VERSION_0_62_0'
+     * @example 'FOREACH_LIST_LINE_CUSTOMERS_CUSTOMER'
+     */
+    readonly normalized: string_name & string_SCREAMING_CASE;
+    /**
+     * @@@
+     *
+     * @example [ '0.62.0' ]
+     * @example [ 'List', 'Line', '{customers}', '', '{customer}' ]
+     */
+    readonly args: Array<string_name>;
+};
+/**
+ * TODO: [♓️] Add order here
+ */

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

@@ -0,0 +1,11 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Where the command can be used
+ */
+export type CommandUsagePlace = TupleToUnion<typeof CommandUsagePlaces>;
+/**
+ * Where the command can be used
+ *
+ * @private internal base for `CommandUsagePlace`
+ */
+export declare const CommandUsagePlaces: readonly ["PIPELINE_HEAD", "PIPELINE_TASK"];

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

@@ -0,0 +1,9 @@
+/**
+ * All available command parsers
+ *
+ * @private internal index of `parseCommand`
+ */
+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
+ */