@promptbook/templates 0.81.0-11

package/esm/typings/src/commands/BOOK_VERSION/BookVersionCommand.d.ts

@@ -0,0 +1,11 @@
+import type { string_semantic_version } from '../../types/typeAliases';
+/**
+ * Parsed BOOK_VERSION command
+ *
+ * @see ./bookVersionCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type BookVersionCommand = {
+    readonly type: 'BOOK_VERSION';
+    readonly bookVersion: string_semantic_version;
+};

package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommand.test.d.ts

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

package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts

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

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

@@ -0,0 +1,17 @@
+import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations';
+import type { ExpectationUnit } from '../../pipeline/PipelineJson/Expectations';
+/**
+ * Expect amount command describes the desired output of the task (after post-processing)
+ * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
+ *
+ * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
+ */
+export type ExpectCommand = {
+    readonly type: 'EXPECT';
+    readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
+    readonly unit: ExpectationUnit;
+    readonly amount: ExpectationAmount;
+};
+/**
+ * TODO: [🍋] Allow to `EXPECT` relative amounts like `EXPECT MAX 130% {foo} Words`
+ */

package/esm/typings/src/commands/EXPECT/expectCommand.test.d.ts

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

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

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

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

@@ -0,0 +1,10 @@
+import type { ForeachJson } from './ForeachJson';
+/**
+ * Parsed FOREACH command which is used to iterate over a table of values
+ *
+ * @see ./foreachCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type ForeachCommand = {
+    readonly type: 'FOREACH';
+} & ForeachJson;

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

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

package/esm/typings/src/commands/FOREACH/foreachCommand.test.d.ts

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

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

@@ -0,0 +1,14 @@
+import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
+import type { ForeachCommand } from './ForeachCommand';
+/**
+ * Parses the foreach command
+ *
+ * Note: @@@ This command is used as foreach 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 foreachCommandParser: PipelineTaskCommandParser<ForeachCommand>;
+/**
+ * TODO: [🍭] Make .book.md file with examples of the FOREACH with wrong parsing and logic
+ */

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

@@ -0,0 +1,9 @@
+/**
+ * Represents a command that expects a specific format.
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type FormatCommand = {
+    readonly type: 'FORMAT';
+    readonly format: 'JSON';
+};

package/esm/typings/src/commands/FORMAT/formatCommand.test.d.ts

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

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

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

package/esm/typings/src/commands/FORMFACTOR/FormfactorCommand.d.ts

@@ -0,0 +1,11 @@
+import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
+/**
+ * Parsed FORMFACTOR command
+ *
+ * @see ./formfactorCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type FormfactorCommand = {
+    readonly type: 'FORMFACTOR';
+    readonly formfactorName: string_formfactor_name;
+};

package/esm/typings/src/commands/FORMFACTOR/formfactorCommand.test.d.ts

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

package/esm/typings/src/commands/FORMFACTOR/formfactorCommandParser.d.ts

@@ -0,0 +1,11 @@
+import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
+import type { FormfactorCommand } from './FormfactorCommand';
+/**
+ * Parses the formfactor command
+ *
+ * Note: @@@ This command is used as formfactor 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 formfactorCommandParser: PipelineHeadCommandParser<FormfactorCommand>;

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

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

package/esm/typings/src/commands/JOKER/jokerCommand.test.d.ts

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

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

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

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

@@ -0,0 +1,11 @@
+import type { string_knowledge_source_content } from '../../types/typeAliases';
+/**
+ * Parsed KNOWLEDGE command
+ *
+ * @see ./knowledgeCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type KnowledgeCommand = {
+    readonly type: 'KNOWLEDGE';
+    readonly sourceContent: string_knowledge_source_content;
+};

package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts

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

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

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

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/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 compilePipeline
+ */
+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 compilePipeline
+ */
+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 compilePipeline
+ */
+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']>;