@promptbook/utils 0.103.0-8 → 0.103.0

package/esm/typings/src/remote-server/startRemoteServer.d.ts

@@ -11,15 +11,18 @@ import type { RemoteServerOptions } from './types/RemoteServerOptions';
  */
 export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): RemoteServer;
 /**
+
+ * TODO: [🕋] Use here `aboutPromptbookInformation`
  * TODO: [🌡] Add CORS and security - probably via `helmet`
  * TODO: Split this file into multiple functions - handler for each request
  * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
- * TODO: [⚖] Expose the collection to be able to connect to same collection via createCollectionFromUrl
+ * TODO: [⚖] Expose the collection to be able to connect to same collection via createPipelineCollectionFromUrl
  * TODO: Handle progress - support streaming
  * TODO: [🗯] Do not hang up immediately but wait until client closes OR timeout
  * TODO: [🗯] Timeout on chat to free up resources
  * TODO: [🃏] Pass here some security token to prevent malitious usage and/or DDoS
  * TODO: [0] Set unavailable models as undefined in `RemoteLlmExecutionTools` NOT throw error here
  * TODO: Allow to constrain anonymous mode for specific models / providers
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts

@@ -1,17 +1,12 @@
 import type { Request, Response } from 'express';
 import type { Promisable } from 'type-fest';
-import type { PipelineCollection } from '../../collection/PipelineCollection';
+import type { PipelineCollection } from '../../collection/pipeline-collection/PipelineCollection';
 import { AuthenticationError } from '../../errors/AuthenticationError';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { string_app_id } from '../../types/typeAliases';
-import type { string_email } from '../../types/typeAliases';
-import type { string_password } from '../../types/typeAliases';
-import type { string_token } from '../../types/typeAliases';
-import type { string_user_id } from '../../types/typeAliases';
-import type { ApplicationModeIdentification } from '../socket-types/_subtypes/Identification';
-import type { Identification } from '../socket-types/_subtypes/Identification';
+import type { string_app_id, string_email, string_password, string_token, string_user_id } from '../../types/typeAliases';
+import type { ApplicationModeIdentification, Identification } from '../socket-types/_subtypes/Identification';
 /**
  * Options for configuring the Promptbook remote server.
  *

package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts

@@ -1,20 +1,9 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { BoilerplateScraper } from './BoilerplateScraper';
 /**
  * Constructor of `BoilerplateScraper`
  *
  * @public exported from `@promptbook/boilerplate`
  */
-export declare const createBoilerplateScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => BoilerplateScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const createBoilerplateScraper: any;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const boilerplateScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const boilerplateScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts

@@ -1,20 +1,9 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { DocumentScraper } from './DocumentScraper';
 /**
  * Creates a scraper for document content.
  *
  * @public exported from `@promptbook/documents`
  */
-export declare const createDocumentScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => DocumentScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: "Pandoc"[];
-}>;
+export declare const createDocumentScraper: any;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

package/esm/typings/src/scrapers/document/register-metadata.d.ts

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const documentScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: "Pandoc"[];
-}>;
+export declare const documentScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts

@@ -1,21 +1,10 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { LegacyDocumentScraper } from './LegacyDocumentScraper';
 /**
  * Creates a scraper for legacy document formats (.doc, .rtf, etc).
  * Uses LibreOffice for conversion to extract content from older document formats.
  *
  * @public exported from `@promptbook/legacy-documents`
  */
-export declare const createLegacyDocumentScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => LegacyDocumentScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: ("Pandoc" | "LibreOffice")[];
-}>;
+export declare const createLegacyDocumentScraper: any;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const legacyDocumentScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: ("Pandoc" | "LibreOffice")[];
-}>;
+export declare const legacyDocumentScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts

@@ -1,20 +1,9 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { MarkdownScraper } from './MarkdownScraper';
 /**
  * Creates a scraper for markdown content.
  *
  * @public exported from `@promptbook/markdown-utils`
  */
-export declare const createMarkdownScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => MarkdownScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: true;
-    requiredExecutables: never[];
-}>;
+export declare const createMarkdownScraper: any;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

package/esm/typings/src/scrapers/markdown/register-metadata.d.ts

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const markdownScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: true;
-    requiredExecutables: never[];
-}>;
+export declare const markdownScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts

@@ -1,21 +1,10 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { MarkitdownScraper } from './MarkitdownScraper';
 /**
  * Constructor of `MarkitdownScraper`
  *
  * @public exported from `@promptbook/markitdown`
  * @public exported from `@promptbook/pdf`
  */
-export declare const createMarkitdownScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => MarkitdownScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const createMarkitdownScraper: any;
 /**
  * TODO: [🧠][🌜] Export only from `@promptbook/markitdown` or `@promptbook/pdf` NOT both
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"

package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const markitdownScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const markitdownScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts

@@ -1,21 +1,10 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { PdfScraper } from './PdfScraper';
 /**
  * Factory function to create an instance of PdfScraper.
  * It bundles the scraper class with its metadata.
  *
  * @public exported from `@promptbook/pdf`
  */
-export declare const createPdfScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => PdfScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const createPdfScraper: any;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

package/esm/typings/src/scrapers/pdf/register-metadata.d.ts

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const pdfScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const pdfScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts

@@ -1,21 +1,10 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { WebsiteScraper } from './WebsiteScraper';
 /**
  * Factory function to create an instance of WebsiteScraper.
  * It bundles the scraper class with its metadata.
  *
  * @public exported from `@promptbook/website-crawler`
  */
-export declare const createWebsiteScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => WebsiteScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const createWebsiteScraper: any;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

package/esm/typings/src/scrapers/website/register-metadata.d.ts

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const websiteScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const websiteScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/storage/_common/PromptbookStorage.d.ts

@@ -21,4 +21,5 @@ export type PromptbookStorage<TItem> = {
 };
 /**
  * TODO: [💺] Constrain `TItem` to [🚉] JSON-serializable objects only in type level
+ * TODO: [☹️] Unite the storages
  */

package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts

@@ -1,3 +1,4 @@
+import type { $side_effect } from '../../utils/organization/$side_effect';
 import type { PromptbookStorage } from '../_common/PromptbookStorage';
 /**
  * Stores data in .env variables
@@ -29,7 +30,7 @@ export declare class $EnvStorage<TItem> implements PromptbookStorage<TItem> {
     /**
      * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
      */
-    setItem(key: string, value: TItem): Promise<void>;
+    setItem(key: string, value: TItem): Promise<$side_effect>;
     /**
      * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
      */

package/esm/typings/src/transpilers/_common/BookTranspiler.d.ts

@@ -0,0 +1,33 @@
+import { Promisable } from 'type-fest';
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { string_name, string_script, string_title } from '../../types/typeAliases';
+import type { Registered } from '../../utils/misc/$Register';
+import type { BookTranspilerOptions } from './BookTranspilerOptions';
+/**
+ * Transpiler takes a book and transpiles it into another format (e.g., Langchain).
+ */
+export type BookTranspiler = Registered & {
+    /**
+     * The name of the transpiler.
+     * It is used to identify the transpiler in the register.
+     *
+     * @example 'python-langchain'
+     */
+    readonly name: string_name;
+    /**
+     * The title of the transpiler.
+     * It is used to display the transpiler in the UI.
+     *
+     * @example 'Python Langchain'
+     */
+    readonly title: string_title;
+    /**
+     * Transpiles a book.
+     *
+     * @param book book to transpile
+     * @param options additional options for the transpiler
+     * @returns transpiled book
+     */
+    transpileBook(book: string_book, tools: ExecutionTools, options?: BookTranspilerOptions): Promisable<string_script>;
+};

package/esm/typings/src/transpilers/_common/BookTranspilerOptions.d.ts

@@ -0,0 +1,18 @@
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+/**
+ * Options for the BookTranspiler.
+ */
+export type BookTranspilerOptions = Omit<CommonToolsOptions, 'maxRequestsPerMinute'> & {
+    /**
+     * If true, the transpiler will log verbose information to the console.
+     *
+     * @default false
+     */
+    readonly isVerbose?: boolean;
+    /**
+     * If true, the transpiler will include comments in the output.
+     *
+     * @default true
+     */
+    readonly shouldIncludeComments?: boolean;
+};

package/esm/typings/src/transpilers/_common/register/$bookTranspilersRegister.d.ts

@@ -0,0 +1,15 @@
+import { $Register } from '../../../utils/misc/$Register';
+import type { BookTranspiler } from '../BookTranspiler';
+/**
+ * Register for book transpilers.
+ *
+ * Note: `$` is used to indicate that this interacts with the global scope
+ * @singleton Only one instance of each register is created per build, but there can be more instances across different builds or environments.
+ * @see https://github.com/webgptorg/promptbook/issues/249
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const $bookTranspilersRegister: $Register<BookTranspiler>;
+/**
+ * TODO: [®] DRY Register logic
+ */

package/esm/typings/src/transpilers/formatted-book-in-markdown/FormattedBookInMarkdownTranspiler.d.ts

@@ -0,0 +1,16 @@
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { string_markdown } from '../../types/typeAliases';
+import type { BookTranspilerOptions } from '../_common/BookTranspilerOptions';
+/**
+ * Converts a book into a 1:1 formatted markdown
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const FormattedBookInMarkdownTranspiler: {
+    readonly name: "formatted-book-in-markdown";
+    readonly title: "Formatted Book in Markdown";
+    readonly packageName: "@promptbook/core";
+    readonly className: "FormattedBookInMarkdownTranspiler";
+    readonly transpileBook: (book: string_book, tools: ExecutionTools, options?: BookTranspilerOptions) => string_markdown;
+};

package/esm/typings/src/transpilers/formatted-book-in-markdown/register.d.ts

@@ -0,0 +1,15 @@
+import type { Registration } from '../../utils/misc/$Register';
+/**
+ * Registration of transpiler
+ *
+ * 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/wizard`
+ * @public exported from `@promptbook/cli`
+ *
+ * TODO: !!! Which package should export this?
+ */
+export declare const _FormattedBookInMarkdownTranspilerRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/transpilers/openai-sdk/OpenAiSdkTranspiler.d.ts

@@ -0,0 +1,16 @@
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { string_script } from '../../types/typeAliases';
+import type { BookTranspilerOptions } from '../_common/BookTranspilerOptions';
+/**
+ * Transpiler to Javascript code using OpenAI SDK.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const OpenAiSdkTranspiler: {
+    readonly name: "openai-sdk";
+    readonly title: "OpenAI SDK";
+    readonly packageName: "@promptbook/core";
+    readonly className: "OpenAiSdkTranspiler";
+    readonly transpileBook: (book: string_book, tools: ExecutionTools, options?: BookTranspilerOptions) => Promise<string_script>;
+};

package/esm/typings/src/transpilers/openai-sdk/OpenAiSdkTranspiler.test.d.ts

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

package/esm/typings/src/transpilers/openai-sdk/playground/playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/transpilers/openai-sdk/register.d.ts

@@ -0,0 +1,15 @@
+import type { Registration } from '../../utils/misc/$Register';
+/**
+ * Registration of transpiler
+ *
+ * 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/wizard`
+ * @public exported from `@promptbook/cli`
+ *
+ * TODO: [🧠] Which package should export this?
+ */
+export declare const _OpenAiSdkTranspilerRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/types/LlmCall.d.ts

@@ -0,0 +1,20 @@
+import type { ExecutionPromptReportJson } from '../execution/execution-report/ExecutionPromptReportJson';
+import type { string_model_name } from './typeAliases';
+/**
+ * Represents a single LLM call with its report.
+ *
+ * @see https://github.com/webgptorg/promptbook/issues/24
+ */
+export type LlmCall = {
+    /**
+     * The name of the model used for the call.
+     */
+    readonly modelName: string_model_name;
+    /**
+     * The report of the LLM execution.
+     */
+    readonly report: ExecutionPromptReportJson;
+};
+/**
+ * TODO: !!! Maybe different shape of LlmCall
+ */

package/esm/typings/src/types/ModelRequirements.d.ts

@@ -7,7 +7,7 @@ import type { number_model_temperature, number_seed, string_model_name, string_s
  * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook#model-requirements
  */
-export type ModelRequirements = CompletionModelRequirements | ChatModelRequirements | EmbeddingModelRequirements;
+export type ModelRequirements = CompletionModelRequirements | ChatModelRequirements | ImageGenerationModelRequirements | EmbeddingModelRequirements;
 /**
  * Model requirements for the completion variant
  *
@@ -34,6 +34,17 @@ export type ChatModelRequirements = CommonModelRequirements & {
      */
     readonly systemMessage?: string_system_message;
 };
+/**
+ * Model requirements for the image generation variant
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ImageGenerationModelRequirements = CommonModelRequirements & {
+    /**
+     * Image generation model variant
+     */
+    modelVariant: 'IMAGE_GENERATION';
+};
 /**
  * Model requirements for the embedding variant
  *
@@ -59,6 +70,7 @@ export type CommonModelRequirements = {
      * There are 3 variants:
      * - **COMPLETION** - model that takes prompt and writes the rest of the text
      * - **CHAT** - model that takes prompt and previous messages and returns response
+     * - **IMAGE_GENERATION** - model that takes prompt and returns image
      * - **EMBEDDING** - model that takes prompt and returns embedding
      * <- [🤖]
      */

package/esm/typings/src/types/ModelVariant.d.ts

@@ -12,4 +12,4 @@ export type ModelVariant = TupleToUnion<typeof MODEL_VARIANTS>;
  * @see {@link ModelVariant}
  * @public exported from `@promptbook/core`
  */
-export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];
+export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "IMAGE_GENERATION", "EMBEDDING"];

package/esm/typings/src/types/Prompt.d.ts

@@ -4,6 +4,7 @@ import type { Expectations } from '../pipeline/PipelineJson/Expectations';
 import type { ChatModelRequirements } from './ModelRequirements';
 import type { CompletionModelRequirements } from './ModelRequirements';
 import type { EmbeddingModelRequirements } from './ModelRequirements';
+import type { ImageGenerationModelRequirements } from './ModelRequirements';
 import type { ModelRequirements } from './ModelRequirements';
 import type { Parameters } from './typeAliases';
 import type { string_pipeline_url_with_task_hash } from './typeAliases';
@@ -17,7 +18,7 @@ import type { string_title } from './typeAliases';
  * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook#prompt
  */
-export type Prompt = CompletionPrompt | ChatPrompt | EmbeddingPrompt;
+export type Prompt = CompletionPrompt | ChatPrompt | ImagePrompt | EmbeddingPrompt;
 /**
  * Completion prompt
  *
@@ -44,6 +45,17 @@ export type ChatPrompt = CommonPrompt & {
      */
     thread?: ChatMessage[];
 };
+/**
+ * Image prompt
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ImagePrompt = CommonPrompt & {
+    /**
+     * Requirements for image generation model
+     */
+    modelRequirements: ImageGenerationModelRequirements;
+};
 /**
  * Embedding prompt
  *

package/esm/typings/src/types/Updatable.d.ts

@@ -0,0 +1,19 @@
+import { BehaviorSubject } from 'rxjs';
+/**
+ * A type that represents a value that can be updated over time:
+ *
+ * 1) It can be a static value of type `TValue`
+ * 2) Or a `BehaviorSubject` that emits values of type `TValue`
+ * 3) Or pair of `[getValue, setValue]` functions for getting and setting the value
+ */
+export type Updatable<TValue> = TValue | BehaviorSubject<TValue> | [TValue, (value: TValue) => void];
+/**
+ * Restricts an Updatable to a (2) BehaviorSubject variant
+ *
+ * @see Updatable
+ * @private internal utility <- TODO: [🧠] Maybe export from `@promptbook/types`
+ */
+export declare function asUpdatableSubject<TValue>(value: Updatable<TValue>): BehaviorSubject<TValue>;
+/**
+ * TODO: [🧠] Maybe `BehaviorSubject` is too heavy for this use case, maybe just tuple `[value,setValue]` is enough
+ */