@promptbook/components 0.100.0-24

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

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
+ */

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

@@ -0,0 +1,15 @@
+import { OpenAiAssistantExecutionTools } from './OpenAiAssistantExecutionTools';
+import type { OpenAiAssistantExecutionToolsOptions } from './OpenAiAssistantExecutionToolsOptions';
+/**
+ * Execution Tools for calling OpenAI API
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare const createOpenAiAssistantExecutionTools: ((options: OpenAiAssistantExecutionToolsOptions) => OpenAiAssistantExecutionTools) & {
+    packageName: string;
+    className: string;
+};
+/**
+ * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

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

@@ -0,0 +1,74 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { Usage } from '../../execution/Usage';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_model_name } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
+import { RemoteLlmExecutionTools } from '../remote/RemoteLlmExecutionTools';
+import { computeOpenAiUsage } from './computeOpenAiUsage';
+import { OpenAiCompatibleExecutionTools } from './OpenAiCompatibleExecutionTools';
+import type { OpenAiCompatibleExecutionToolsNonProxiedOptions } from './OpenAiCompatibleExecutionToolsOptions';
+import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleExecutionToolsOptions';
+/**
+ * Execution Tools for calling OpenAI compatible API
+ *
+ * Note: This can be used for any OpenAI compatible APIs
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare const createOpenAiCompatibleExecutionTools: ((options: OpenAiCompatibleExecutionToolsOptions & {
+    /**
+     * The model name to use for all operations
+     *
+     * This will be the only model available through this LLM provider and it will be a chat model.
+     * Other variants won't be available for now.
+     */
+    defaultModelName: string_model_name;
+}) => OpenAiCompatibleExecutionTools | RemoteLlmExecutionTools) & {
+    packageName: string;
+    className: string;
+};
+/**
+ * Execution Tools for calling ONE SPECIFIC PRECONFIGURED OpenAI compatible provider
+ *
+ * @private for `createOpenAiCompatibleExecutionTools`
+ */
+export declare class HardcodedOpenAiCompatibleExecutionTools extends OpenAiCompatibleExecutionTools implements LlmExecutionTools {
+    private readonly defaultModelName;
+    protected readonly options: OpenAiCompatibleExecutionToolsNonProxiedOptions;
+    /**
+     * Creates OpenAI compatible Execution Tools.
+     *
+     * @param options which are relevant are directly passed to the OpenAI compatible client
+     */
+    constructor(defaultModelName: string_model_name, options: OpenAiCompatibleExecutionToolsNonProxiedOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * List all available models (non dynamically)
+     *
+     * Note: Purpose of this is to provide more information about models than standard listing from API
+     */
+    protected get HARDCODED_MODELS(): ReadonlyArray<AvailableModel>;
+    /**
+     * Computes the usage
+     */
+    protected computeUsage(...args: Parameters<typeof computeOpenAiUsage>): Usage;
+    /**
+     * Default model for chat variant.
+     */
+    protected getDefaultChatModel(): AvailableModel;
+    /**
+     * Default model for completion variant.
+     */
+    protected getDefaultCompletionModel(): AvailableModel;
+    /**
+     * Default model for completion variant.
+     */
+    protected getDefaultEmbeddingModel(): AvailableModel;
+}
+/**
+ * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

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

@@ -0,0 +1,17 @@
+import { OpenAiExecutionTools } from './OpenAiExecutionTools';
+import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
+/**
+ * Execution Tools for calling OpenAI API
+ *
+ * Note: This can be also used for other OpenAI compatible APIs, like Ollama
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare const createOpenAiExecutionTools: ((options: OpenAiExecutionToolsOptions) => OpenAiExecutionTools) & {
+    packageName: string;
+    className: string;
+};
+/**
+ * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

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

@@ -0,0 +1,25 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+/**
+ * List of available OpenAI models with pricing
+ *
+ * Note: Done at 2025-05-06
+ *
+ * @see https://platform.openai.com/docs/models/
+ * @see https://openai.com/api/pricing/
+ * @public exported from `@promptbook/openai`
+ */
+export declare const OPENAI_MODELS: ReadonlyArray<AvailableModel>;
+/**
+ * Note: [🤖] Add models of new variant
+ * TODO: [🧠] Some mechanism to propagate unsureness
+ * TODO: [🎰] Some mechanism to auto-update available models
+ * TODO: [🎰][👮‍♀️] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
+ * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
+ * @see https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4
+ * @see https://openai.com/api/pricing/
+ * @see /other/playground/playground.ts
+ * TODO: [🍓][💩] Make better
+ * TODO: Change model titles to human eg: "gpt-4-turbo-2024-04-09" -> "GPT-4 Turbo (2024-04-09)"
+ * TODO: [🚸] Not all models are compatible with JSON mode, add this information here and use it
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,6 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * Note: [⚫] Code in this file should never be published in any package
+ */

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

@@ -0,0 +1,35 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiMetadataRegistration: Registration;
+/**
+ * Registration of the OpenAI Assistant metadata
+ *
+ * Note: [🏐] Configurations registrations are done in the metadata registration section, but the constructor registration is handled separately.
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiAssistantMetadataRegistration: Registration;
+/**
+ * Registration of the OpenAI Compatible metadata
+ *
+ * Note: OpenAiCompatibleExecutionTools is an abstract class and cannot be instantiated directly.
+ * It serves as a base class for OpenAiExecutionTools and other compatible implementations.
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiCompatibleMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,39 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/openai`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiRegistration: Registration;
+/**
+ * Registration of the OpenAI Assistant provider
+ *
+ * Note: [🏐] Configurations registrations are done in register-constructor.ts BUT constructor register-constructor.ts
+ *
+ * @public exported from `@promptbook/openai`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiAssistantRegistration: Registration;
+/**
+ * Registration of the OpenAI Compatible provider
+ *
+ * Note: [🏐] Configurations registrations are done in register-constructor.ts BUT constructor register-constructor.ts
+ *
+ * @public exported from `@promptbook/openai`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiCompatibleRegistration: Registration;
+/**
+ * Note: OpenAiCompatibleExecutionTools is an abstract class and cannot be registered directly.
+ * It serves as a base class for OpenAiExecutionTools and other compatible implementations.
+ */
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts

@@ -0,0 +1,59 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { ChatPromptResult } from '../../execution/PromptResult';
+import type { CompletionPromptResult } from '../../execution/PromptResult';
+import type { EmbeddingPromptResult } from '../../execution/PromptResult';
+import type { RemoteClientOptions } from '../../remote-server/types/RemoteClientOptions';
+import type { ChatPrompt } from '../../types/Prompt';
+import type { CompletionPrompt } from '../../types/Prompt';
+import type { EmbeddingPrompt } from '../../types/Prompt';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
+/**
+ * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
+ *
+ * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
+ * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
+ *
+ * @see https://github.com/webgptorg/promptbook#remote-server
+ * @public exported from `@promptbook/remote-client`
+ */
+export declare class RemoteLlmExecutionTools<TCustomOptions = undefined> implements LlmExecutionTools {
+    protected readonly options: RemoteClientOptions<TCustomOptions>;
+    constructor(options: RemoteClientOptions<TCustomOptions>);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * Check the configuration of all execution tools
+     */
+    checkConfiguration(): Promise<void>;
+    /**
+     * List all available models that can be used
+     */
+    listModels(): Promise<ReadonlyArray<AvailableModel>>;
+    /**
+     * Calls remote proxy server to use a chat model
+     */
+    callChatModel(prompt: ChatPrompt): Promise<ChatPromptResult>;
+    /**
+     * Calls remote proxy server to use a completion model
+     */
+    callCompletionModel(prompt: CompletionPrompt): Promise<CompletionPromptResult>;
+    /**
+     * Calls remote proxy server to use a embedding model
+     */
+    callEmbeddingModel(prompt: EmbeddingPrompt): Promise<EmbeddingPromptResult>;
+    /**
+     * Calls remote proxy server to use both completion or chat model
+     */
+    private callCommonModel;
+}
+/**
+ * TODO: Maybe use `$exportJson`
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [🍓] Allow to list compatible models with each variant
+ * TODO: [🗯] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
+ * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
+ * TODO: [🧠] Maybe remove `@promptbook/remote-client` and just use `@promptbook/core`
+ */

package/esm/typings/src/llm-providers/remote/playground/playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+import '../../openai/register-constructor';
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts

@@ -0,0 +1,23 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { VercelProvider } from './VercelProvider';
+/**
+ * Options for `createExecutionToolsFromVercelProvider`
+ *
+ * @public exported from `@promptbook/google`
+ */
+export type VercelExecutionToolsOptions = CommonToolsOptions & Pick<LlmExecutionTools, 'title' | 'description'> & {
+    /**
+     * Vercel provider for the execution tools
+     */
+    readonly vercelProvider: VercelProvider;
+    /**
+     * List of available models for given Vercel provider
+     */
+    readonly availableModels: ReadonlyArray<AvailableModel>;
+    /**
+     * Additional settings for chat models when calling `vercelProvider.chat('model-name', settings)`
+     */
+    readonly additionalChatSettings?: Partial<Parameters<VercelProvider['chat']>[1]>;
+};

package/esm/typings/src/llm-providers/vercel/VercelProvider.d.ts

@@ -0,0 +1,13 @@
+import type { createGoogleGenerativeAI } from '@ai-sdk/google';
+import type { createOpenAI } from '@ai-sdk/openai';
+/**
+ * This is common interface for all v1 Vercel providers
+ *
+ * @public exported from `@promptbook/vercel`
+ */
+export type VercelProvider = ReturnType<typeof createOpenAI> | ReturnType<typeof createGoogleGenerativeAI>;
+/**
+ * ^^^^
+ * TODO: Is there some way to get the type of the provider directly,
+ *       NOT this stupid way via inferring the return type from a specific vercel provider⁉
+ */

package/esm/typings/src/llm-providers/vercel/createExecutionToolsFromVercelProvider.d.ts

@@ -0,0 +1,8 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { VercelExecutionToolsOptions } from './VercelExecutionToolsOptions';
+/**
+ * Adapter which creates Promptbook execution tools from Vercel provider
+ *
+ * @public exported from `@promptbook/vercel`
+ */
+export declare function createExecutionToolsFromVercelProvider(options: VercelExecutionToolsOptions): LlmExecutionTools;

package/esm/typings/src/llm-providers/vercel/playground/playground.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/migrations/migratePipeline.d.ts

@@ -0,0 +1,9 @@
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+/**
+ * Migrates the pipeline to the latest version
+ *
+ * Note: Migration does not do heavy lifting like calling the LLMs, just lightweight changes of the structure
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function migratePipeline(deprecatedPipeline: PipelineJson): PipelineJson;

package/esm/typings/src/other/templates/getBookTemplates.d.ts

@@ -0,0 +1,24 @@
+import { SetRequired } from 'type-fest';
+import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { NonEmptyReadonlyArray } from '../../types/NonEmptyArray';
+/**
+ * Internal cache for the `getBookTemplates` function, storing retrieved pipelines.
+ *
+ * @singleton
+ * @private internal cache of `getBookTemplate`
+ */
+export declare let pipelines: Array<SetRequired<PipelineJson, 'pipelineUrl'>> | null;
+/**
+ * Retrieves a collection of Promptbook templates.
+ *
+ * @param formfactorName - optional filter for FORMFACTOR - get only pipelines for this formfactor
+ * @returns list of pipelines
+ * @public exported from `@promptbook/templates`
+ */
+export declare function getBookTemplates(formfactorName?: string_formfactor_name): NonEmptyReadonlyArray<SetRequired<PipelineJson, 'pipelineUrl'>>;
+/**
+ * TODO: Unit test + test that what we guarantee - always return non-empty array is true for e
+ * TODO: [🧠] Which is the best place for this function
+ * TODO: !!6 For GENERIC template ensure at least one pipeline is present for typescript in `getBookTemplates`
+ */

package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts

@@ -0,0 +1,10 @@
+import type { PipelineCollection } from '../../collection/PipelineCollection';
+/**
+ * Get pipeline collection for Untitled Promptbook project
+ *
+ * ⚠️ WARNING: This code has been generated by `@promptbook/cli` so that any manual changes will be overwritten
+ *
+ * @generated
+ * @returns {PipelineCollection} Library of promptbooks for Untitled Promptbook project
+ */
+export declare function getTemplatesPipelineCollection(): PipelineCollection;

package/esm/typings/src/personas/preparePersona.d.ts

@@ -0,0 +1,17 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PersonaPreparedJson } from '../pipeline/PipelineJson/PersonaJson';
+import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
+import type { string_persona_description } from '../types/typeAliases';
+/**
+ * Prepares the persona for the pipeline
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/22
+ * @public exported from `@promptbook/core`
+ */
+export declare function preparePersona(personaDescription: string_persona_description, tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions): Promise<Pick<PersonaPreparedJson, 'modelsRequirements'>>;
+/**
+ * TODO: [🔃][main] If the persona was prepared with different version or different set of models, prepare it once again
+ * TODO: [🏢] Check validity of `modelName` in pipeline
+ * TODO: [🏢] Check validity of `systemMessage` in pipeline
+ * TODO: [🏢] Check validity of `temperature` in pipeline
+ */

package/esm/typings/src/pipeline/PipelineInterface/PipelineInterface.d.ts

@@ -0,0 +1,22 @@
+import type { InputParameterJson } from '../PipelineJson/ParameterJson';
+import type { OutputParameterJson } from '../PipelineJson/ParameterJson';
+/**
+ * Defines the interface of a Promptbook pipeline, specifying its input and output parameters.
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ */
+export type PipelineInterface = {
+    /**
+     * Input parameters required by the pipeline.
+     *
+     * Note: Sorted alphabetically
+     */
+    readonly inputParameters: ReadonlyArray<InputParameterJson>;
+    /**
+     * Output parameters produced by the pipeline.
+     *
+     * Note: Sorted alphabetically
+     */
+    readonly outputParameters: ReadonlyArray<OutputParameterJson>;
+};

package/esm/typings/src/pipeline/PipelineInterface/constants.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Pipeline interface which is equivalent to `any`
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const GENERIC_PIPELINE_INTERFACE: {
+    readonly inputParameters: readonly [];
+    readonly outputParameters: readonly [];
+};
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/pipeline/PipelineInterface/getPipelineInterface.d.ts

@@ -0,0 +1,11 @@
+import type { PipelineJson } from '../PipelineJson/PipelineJson';
+import type { PipelineInterface } from './PipelineInterface';
+/**
+ * Extracts the interface (input and output parameters) from a pipeline.
+ *
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getPipelineInterface(pipeline: PipelineJson): PipelineInterface;

package/esm/typings/src/pipeline/PipelineInterface/isPipelineImplementingInterface.d.ts

@@ -0,0 +1,27 @@
+import type { PipelineJson } from '../PipelineJson/PipelineJson';
+import type { PipelineInterface } from './PipelineInterface';
+/**
+ * Options for the `isPipelineImplementingInterface` function.
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ */
+export type IsPipelineImplementingInterfaceOptions = {
+    /**
+     * @param pipeline The pipeline to check.
+     */
+    pipeline: PipelineJson;
+    /**
+     * @param pipelineInterface The interface to check against.
+     */
+    pipelineInterface: PipelineInterface;
+};
+/**
+ * Checks if a given pipeline satisfies the requirements of a specified pipeline interface.
+ *
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ * @returns `true` if the pipeline implements the interface, `false` otherwise.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function isPipelineImplementingInterface(options: IsPipelineImplementingInterfaceOptions): boolean;

package/esm/typings/src/pipeline/PipelineInterface/isPipelineInterfacesEqual.d.ts

@@ -0,0 +1,10 @@
+import type { PipelineInterface } from './PipelineInterface';
+/**
+ * Checks if two pipeline interfaces are structurally identical.
+ *
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
+ * @see https://github.com/webgptorg/promptbook/discussions/171
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function isPipelineInterfacesEqual(pipelineInterface1: PipelineInterface, pipelineInterface2: PipelineInterface): boolean;

package/esm/typings/src/pipeline/PipelineJson/CommonTaskJson.d.ts

@@ -0,0 +1,103 @@
+import type { ForeachJson } from '../../commands/FOREACH/ForeachJson';
+import type { FormatCommand } from '../../commands/FORMAT/FormatCommand';
+import type { SectionType } from '../../types/SectionType';
+import type { string_javascript } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { string_postprocessing_function_name } from '../../types/typeAliases';
+import type { string_prompt } from '../../types/typeAliases';
+import type { string_template } from '../../types/typeAliases';
+import type { Expectations } from './Expectations';
+/**
+ * Common properties of all tasks
+ */
+export type CommonTaskJson = {
+    /**
+     * Name of the task
+     * - It must be unique across the pipeline
+     * - It should start uppercase and can contain letters and numbers
+     * - The pipelineUrl together with hash and name are used to identify the task in the pipeline
+     */
+    readonly name: string_name;
+    /**
+     * Title of the task
+     * It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
+     */
+    readonly title: string;
+    /**
+     * Description of the task
+     * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
+     */
+    readonly description?: string_markdown_text;
+    /**
+     * List of parameter names that are used in the task and must be defined before the task is executed
+     *
+     * Note: Joker is one of the dependent parameters
+     */
+    readonly dependentParameterNames: Array<string_parameter_name>;
+    /**
+     * List of parameter names that act as jokers.
+     * If a joker parameter meets the expectations, its value is used instead of executing the task.
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/66
+     */
+    readonly jokerParameterNames?: Array<string_parameter_name>;
+    /**
+     * Configuration for the FOREACH command, if used.
+     * Allows iterating over a list parameter.
+     */
+    readonly foreach?: ForeachJson;
+    /**
+     * Type of the execution
+     * This determines if the task is send to LLM, user or some scripting evaluation
+     */
+    readonly taskType: SectionType;
+    /**
+     * Raw content of the task with {placeholders} for parameters before any preparation.
+     *
+     * @see preparedContent
+     */
+    readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
+    /**
+     * Content of the task after preparation, with {placeholders} for parameters.
+     * This is the content used during execution.
+     *
+     * @see content
+     *
+     * @default "{content}"
+     */
+    readonly preparedContent?: (string_prompt | string_javascript | string_markdown) & string_template;
+    /**
+     * List of postprocessing steps that are executed after the task
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/31
+     */
+    readonly postprocessingFunctionNames?: Array<string_postprocessing_function_name>;
+    /**
+     * Expect this amount of each unit in the answer
+     *
+     * For example 5 words, 3 sentences, 2 paragraphs, ...
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     * @see https://github.com/webgptorg/promptbook/discussions/30
+     */
+    readonly expectations?: Expectations;
+    /**
+     * Expect this format of the answer
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     * @see https://github.com/webgptorg/promptbook/discussions/30
+     * @deprecated [💝]
+     */
+    readonly format?: FormatCommand['format'];
+    /**
+     * Name of the parameter that is the result of the task
+     */
+    readonly resultingParameterName: string_name;
+};
+/**
+ * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
+ * TODO: [♈] Probably move expectations from tasks to parameters
+ */

package/esm/typings/src/pipeline/PipelineJson/DialogTaskJson.d.ts

@@ -0,0 +1,13 @@
+import type { CommonTaskJson } from './CommonTaskJson';
+/**
+ * Task for prompt to user
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook/discussions/76
+ */
+export type DialogTaskJson = CommonTaskJson & {
+    readonly taskType: 'DIALOG_TASK';
+};
+/**
+ * TODO: [🍙] Make some standard order of json properties
+ */