@promptbook/javascript 0.111.0-3 → 0.111.0-7

package/umd/src/collection/pipeline-collection/PipelineCollection.d.ts

@@ -0,0 +1,29 @@
+import type { Promisable } from 'type-fest';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { Prompt } from '../../types/Prompt';
+import type { string_pipeline_url } from '../../types/typeAliases';
+/**
+ * Collection that groups together pipelines, knowledge, personas, tools and actions
+ *
+ * Note: [🧸] There are two types of collections:
+ * - `AgentCollection` - which groups together AI Agents
+ * - `PipelineCollection` - which groups together *(deprecated)* pipelines
+ */
+export type PipelineCollection = {
+    /**
+     * Gets all pipelines in the collection
+     */
+    listPipelines(): Promisable<ReadonlyArray<string_pipeline_url>>;
+    /**
+     * Gets pipeline by its URL
+     *
+     * Note: This is not a direct fetching from the URL, but a lookup in the collection
+     */
+    getPipelineByUrl(url: string_pipeline_url): Promisable<PipelineJson>;
+    /**
+     * Checks whether given prompt was defined in any pipeline in the collection
+     *
+     * @deprecated Make better mechanism for skimming the remote server
+     */
+    isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
+};

package/umd/src/collection/pipeline-collection/SimplePipelineCollection.d.ts

@@ -0,0 +1,37 @@
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { Prompt } from '../../types/Prompt';
+import type { string_pipeline_url } from '../../types/typeAliases';
+import type { PipelineCollection } from './PipelineCollection';
+/**
+ * Library of pipelines that groups together pipelines for an application.
+ * This implementation is a very thin wrapper around the Array / Map of pipelines.
+ *
+ * @private internal function of `createPipelineCollectionFromJson`, use `createPipelineCollectionFromJson` instead
+ * @see https://github.com/webgptorg/pipeline#pipeline-collection
+ */
+export declare class SimplePipelineCollection implements PipelineCollection {
+    private collection;
+    /**
+     * Constructs a pipeline collection from pipelines
+     *
+     * @param pipelines Array of pipeline JSON objects to include in the collection
+     *
+     * Note: During the construction logic of all pipelines are validated
+     * Note: It is not recommended to use this constructor directly, use `createPipelineCollectionFromJson` *(or other variant)* instead
+     */
+    constructor(...pipelines: ReadonlyArray<PipelineJson>);
+    /**
+     * Gets all pipelines in the collection
+     */
+    listPipelines(): ReadonlyArray<string_pipeline_url>;
+    /**
+     * Gets pipeline by its URL
+     *
+     * Note: This is not a direct fetching from the URL, but a lookup in the collection
+     */
+    getPipelineByUrl(url: string_pipeline_url): PipelineJson;
+    /**
+     * Checks whether given prompt was defined in any pipeline in the collection
+     */
+    isResponsibleForPrompt(prompt: Prompt): boolean;
+}

package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromDirectory.d.ts

@@ -0,0 +1,62 @@
+import type { ExecutionTools } from '../../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+import type { string_dirname, string_pipeline_root_url } from '../../../types/typeAliases';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Options for `createPipelineCollectionFromDirectory` function
+ *
+ * Note: `rootDirname` is not needed because it is the folder in which `.book` or `.book` file is located
+ *       This is not same as `path` which is the first argument of `createPipelineCollectionFromDirectory` - it can be a subfolder
+ */
+type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {
+    /**
+     * If true, the directory is searched recursively for pipelines
+     *
+     * @default true
+     */
+    isRecursive?: boolean;
+    /**
+     * If true, the collection creation outputs information about each file it reads
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+    /**
+     * This will be used as a root URL for all pipelines in the collection
+     *
+     * It has 2 purposes:
+     * 1) Every pipeline in the collection is checked if it is a child of `rootUrl`
+     * 2) If the pipeline does not have a URL, it is created from the `rootUrl` and path to the pipeline
+     */
+    rootUrl?: string_pipeline_root_url;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    isLazyLoaded?: boolean;
+    /**
+     * If true, whole collection creation crashes on error in any pipeline
+     * If true and isLazyLoaded is true, the error is thrown on first access to the pipeline
+     *
+     * @default true
+     */
+    isCrashedOnError?: boolean;
+};
+/**
+ * Constructs `PipelineCollection` from given directory
+ *
+ * Note: Works only in Node.js environment because it reads the file system
+ *
+ * @param rootPath - path to the directory with pipelines
+ * @param tools - Execution tools to be used for pipeline preparation if needed - If not provided, `$provideExecutionToolsForNode` will be used
+ * @param options - Options for the collection creation
+ * @returns PipelineCollection
+ * @public exported from `@promptbook/node`
+ */
+export declare function createPipelineCollectionFromDirectory(rootPath: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
+export {};
+/**
+ * TODO: [🖇] What about symlinks? Maybe option `isSymlinksFollowed`
+ * TODO: Maybe move from `@promptbook/node` to `@promptbook/core` as we removes direct dependency on `fs`
+ */

package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromDirectory.test.d.ts

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

package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromJson.d.ts

@@ -0,0 +1,13 @@
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Creates `PipelineCollection` from array of PipelineJson or PipelineString
+ *
+ * Note: Functions `pipelineCollectionToJson` and `createPipelineCollectionFromJson` are complementary
+ * Note: Syntax, parsing, and logic consistency checks are performed on all sources during build
+ *
+ * @param promptbookSources
+ * @returns PipelineCollection
+ * @public exported from `@promptbook/core`
+ */
+export declare function createPipelineCollectionFromJson(...promptbooks: ReadonlyArray<PipelineJson>): PipelineCollection;

package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromJson.test.d.ts

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

package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromPromise.d.ts

@@ -0,0 +1,24 @@
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Constructs `PipelineCollection` from async sources
+ *
+ * It can be one of the following:
+ * - Promise of array of PipelineJson or PipelineString
+ * - Factory function that returns Promise of array of PipelineJson or PipelineString
+ *
+ * Note: This is useful as internal tool for other constructor functions like
+ *       `createPipelineCollectionFromUrl` or `createPipelineCollectionFromDirectory`
+ *       Consider using those functions instead of this one
+ *
+ * Note: The function does NOT return promise it returns the collection directly which waits for the sources to be resolved
+ *       when error occurs in given promise or factory function, it is thrown during `listPipelines` or `getPipelineByUrl` call
+ *
+ * Note: Consider using  `createPipelineCollectionFromDirectory` or `createPipelineCollectionFromUrl`
+ *
+ * @param promptbookSourcesPromiseOrFactory
+ * @returns PipelineCollection
+ * @deprecated Do not use, it will became internal tool for other constructor functions
+ * @public exported from `@promptbook/core`
+ */
+export declare function createPipelineCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<ReadonlyArray<PipelineJson>> | (() => Promise<ReadonlyArray<PipelineJson>>)): PipelineCollection;

package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromPromise.test.d.ts

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

package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromUrl.d.ts

@@ -0,0 +1,29 @@
+import type { string_url } from '../../../types/typeAliases';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Options for `createPipelineCollectionFromDirectory` function
+ */
+type CreatePipelineCollectionFromUrlyOptions = {
+    /**
+     * If true, the collection creation outputs information about each file it reads
+     *
+     * @default false
+     */
+    readonly isVerbose?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    readonly isLazyLoaded?: boolean;
+};
+/**
+ * Constructs Promptbook from remote Promptbase URL
+ * @returns PipelineCollection
+ * @public exported from `@promptbook/core`
+ */
+export declare function createPipelineCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
+export {};
+/**
+ * TODO: [main] !!4 [🧠] Library precompilation and do not mix markdown and json promptbooks
+ */

package/umd/src/collection/pipeline-collection/constructors/createPipelineSubcollection.d.ts

@@ -0,0 +1,13 @@
+import type { string_pipeline_url } from '../../../types/typeAliases';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Creates `PipelineCollection` as a subset of another `PipelineCollection`
+ *
+ * Note: You can use any type of collection as a parent collection - local, remote, etc.
+ * Note: This is just a thin wrapper / proxy around the parent collection
+ *
+ * @param promptbookSources
+ * @returns PipelineCollection
+ * @public exported from `@promptbook/core`
+ */
+export declare function createPipelineSubcollection(collection: PipelineCollection, predicate: (url: string_pipeline_url) => boolean): PipelineCollection;

package/umd/src/collection/pipeline-collection/pipelineCollectionToJson.d.ts

@@ -0,0 +1,13 @@
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineCollection } from './PipelineCollection';
+/**
+ * Converts PipelineCollection to serialized JSON
+ *
+ * Note: Functions `pipelineCollectionToJson` and `createPipelineCollectionFromJson` are complementary
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function pipelineCollectionToJson(collection: PipelineCollection): Promise<ReadonlyArray<PipelineJson>>;
+/**
+ * TODO: [🧠] Maybe clear `sourceFile` or clear when exposing through API or remote server
+ */

package/umd/src/collection/pipeline-collection/pipelineCollectionToJson.test.d.ts

@@ -0,0 +1,7 @@
+export {};
+/**
+ * Note: [🐠] For example here URL https://example.com/pipeline.book is not valid
+ *       because it is on private network BUT its very hard to debug because
+ *       there is no error message and false return (the error) happen deep in:
+ *       `isValidPipelineUrl` -> `isValidPipelineUrl` -> `isUrlOnPrivateNetwork`
+ */

package/umd/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
+ * @public exported from `@promptbook/editable`
+ */
+export type BookVersionCommand = {
+    readonly type: 'BOOK_VERSION';
+    readonly bookVersion: string_semantic_version;
+};

package/umd/src/commands/BOOK_VERSION/bookVersionCommand.test.d.ts

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

package/umd/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
+ * @public exported from `@promptbook/editable`
+ */
+export declare const bookVersionCommandParser: PipelineHeadCommandParser<BookVersionCommand>;

package/umd/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/umd/src/commands/EXPECT/expectCommand.test.d.ts

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

package/umd/src/commands/EXPECT/expectCommandParser.d.ts

@@ -0,0 +1,11 @@
+import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
+import type { ExpectCommand } from './ExpectCommand';
+/**
+import { WrappedError } from '../../errors/WrappedError';
+import { assertsError } from '../../errors/assertsError';
+ * Parses the expect command
+ *
+ * @see `documentationUrl` for more details
+ * @public exported from `@promptbook/editable`
+ */
+export declare const expectCommandParser: PipelineTaskCommandParser<ExpectCommand>;

package/umd/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
+ * @public exported from `@promptbook/editable`
+ */
+export type ForeachCommand = {
+    readonly type: 'FOREACH';
+} & ForeachJson;

package/umd/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';
+/**
+ * Information for the FOREACH command, describing how to iterate over a parameter's subvalues in a pipeline task.
+ */
+export type ForeachJson = {
+    /**
+     * The name of the format to use for parsing the parameter (e.g., 'CSV').
+     */
+    readonly formatName: TODO_string;
+    /**
+     * The name of the subformat to use (e.g., CSV Rows).
+     */
+    readonly subformatName: TODO_string;
+    /**
+     * The name of the parameter to iterate over.
+     */
+    readonly parameterName: string_parameter_name;
+    /**
+     * The names of the subparameters (e.g., name of the CSV rows)
+     */
+    readonly inputSubparameterNames: Array<string_parameter_name>;
+    /**
+     * The name of the subparameters (e.g., name of the CSV rows)
+     */
+    readonly outputSubparameterName: string_parameter_name;
+};

package/umd/src/commands/FOREACH/foreachCommand.test.d.ts

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

package/umd/src/commands/FOREACH/foreachCommandParser.d.ts

@@ -0,0 +1,12 @@
+import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
+import type { ForeachCommand } from './ForeachCommand';
+/**
+ * Parses the foreach command
+ *
+ * @see `documentationUrl` for more details
+ * @public exported from `@promptbook/editable`
+ */
+export declare const foreachCommandParser: PipelineTaskCommandParser<ForeachCommand>;
+/**
+ * TODO: [🍭] Make .book.md file with examples of the FOREACH with wrong parsing and logic
+ */

package/umd/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/umd/src/commands/FORMAT/formatCommand.test.d.ts

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

package/umd/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
+ * @public exported from `@promptbook/editable`
+ */
+export declare const formatCommandParser: PipelineTaskCommandParser<FormatCommand>;

package/umd/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
+ * @public exported from `@promptbook/editable`
+ */
+export type FormfactorCommand = {
+    readonly type: 'FORMFACTOR';
+    readonly formfactorName: string_formfactor_name;
+};

package/umd/src/commands/FORMFACTOR/formfactorCommand.test.d.ts

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

package/umd/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 a formfactor for new commands and defines the app type format - it should NOT be used in any `.book` file
+ *
+ * @see `documentationUrl` for more details
+ * @public exported from `@promptbook/editable`
+ */
+export declare const formfactorCommandParser: PipelineHeadCommandParser<FormfactorCommand>;

package/umd/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
+ * @public exported from `@promptbook/editable`
+ */
+export type JokerCommand = {
+    readonly type: 'JOKER';
+    readonly parameterName: string_name;
+};

package/umd/src/commands/JOKER/jokerCommand.test.d.ts

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

package/umd/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
+ * @public exported from `@promptbook/editable`
+ */
+export declare const jokerCommandParser: PipelineTaskCommandParser<JokerCommand>;

package/umd/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
+ * @public exported from `@promptbook/editable`
+ */
+export type KnowledgeCommand = {
+    readonly type: 'KNOWLEDGE';
+    readonly knowledgeSourceContent: string_knowledge_source_content;
+};

package/umd/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts

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

package/umd/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
+ * @public exported from `@promptbook/editable`
+ */
+export declare const knowledgeCommandParser: PipelineHeadCommandParser<KnowledgeCommand>;
+/**
+ * Note: [⛱] There are two types of KNOWLEDGE commands *...(read more in [⛱])*
+ */

package/umd/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.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
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export declare function knowledgeSourceContentToName(knowledgeSourceContent: 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/umd/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.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/umd/src/commands/MODEL/ModelCommand.d.ts

@@ -0,0 +1,14 @@
+import type { ModelRequirements } from '../../types/ModelRequirements';
+import type { TODO_any } from '../../utils/organization/TODO_any';
+/**
+ * Parsed MODEL command
+ *
+ * @see ./modelCommandParser.ts for more details
+ * @deprecated Option to manually set the model requirements is not recommended to use, use `PERSONA` instead
+ * @public exported from `@promptbook/editable`
+ */
+export type ModelCommand = {
+    readonly type: 'MODEL';
+    readonly key: keyof ModelRequirements;
+    readonly value: TODO_any;
+};

package/umd/src/commands/MODEL/modelCommand.test.d.ts

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

package/umd/src/commands/MODEL/modelCommandParser.d.ts

@@ -0,0 +1,10 @@
+import type { PipelineBothCommandParser } from '../_common/types/CommandParser';
+import type { ModelCommand } from './ModelCommand';
+/**
+ * Parses the model command
+ *
+ * @see `documentationUrl` for more details
+ * @deprecated Option to manually set the model requirements is not recommended to use, use `PERSONA` instead
+ * @public exported from `@promptbook/editable`
+ */
+export declare const modelCommandParser: PipelineBothCommandParser<ModelCommand>;

package/umd/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
+ * @public exported from `@promptbook/editable`
+ */
+export type ParameterCommand = {
+    readonly type: 'PARAMETER';
+    readonly isInput: boolean;
+    readonly isOutput: boolean;
+    readonly parameterName: string_name;
+    readonly parameterDescription: string_markdown_text | null;
+};

package/umd/src/commands/PARAMETER/parameterCommand.test.d.ts

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

package/umd/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
+ * @public exported from `@promptbook/editable`
+ */
+export declare const parameterCommandParser: PipelineBothCommandParser<ParameterCommand>;

package/umd/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
+ * @public exported from `@promptbook/editable`
+ */
+export type PersonaCommand = {
+    readonly type: 'PERSONA';
+    readonly personaName: string_name;
+    readonly personaDescription: string_persona_description | null;
+};

package/umd/src/commands/PERSONA/personaCommand.test.d.ts

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

package/umd/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
+ * @public exported from `@promptbook/editable`
+ */
+export declare const personaCommandParser: PipelineBothCommandParser<PersonaCommand>;

package/umd/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
+ * @public exported from `@promptbook/editable`
+ */
+export type PostprocessCommand = {
+    readonly type: 'POSTPROCESS';
+    readonly functionName: string_name;
+};

package/umd/src/commands/POSTPROCESS/postprocessCommand.test.d.ts

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

package/umd/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
+ * @public exported from `@promptbook/editable`
+ */
+export declare const postprocessCommandParser: PipelineTaskCommandParser<PostprocessCommand>;

package/umd/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
+ * @public exported from `@promptbook/editable`
+ */
+export type SectionCommand = {
+    readonly type: 'SECTION';
+    readonly taskType: SectionType;
+};

package/umd/src/commands/SECTION/sectionCommand.test.d.ts

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