@promptbook/javascript 0.104.0-0 → 0.104.0-10

package/esm/typings/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts

@@ -2,6 +2,7 @@ import type { string_markdown } from '../../../types/typeAliases';
 type MarkdownContentProps = {
     content: string_markdown;
     className?: string;
+    onCreateAgent?: (bookContent: string) => void;
 };
 /**
  * Renders markdown content with support for code highlighting, math, and tables.

package/esm/typings/src/book-components/Chat/types/ChatMessage.d.ts

@@ -1,22 +1,17 @@
+import { Message } from '../../../types/Message';
 import type { id, string_markdown } from '../../../types/typeAliases';
 /**
  * A message in the chat
  *
  * @public exported from `@promptbook/components`
  */
-export type ChatMessage = {
+export type ChatMessage = Omit<Message<id>, 'direction' | 'recipients' | 'threadId' | 'metadata'> & {
     /**
-     * Unique identifier of the message
-     */
-    id?: id;
-    /**
-     * Date when the message was created
-     */
-    date?: Date;
-    /**
-     * The name of the participant who sent the message
+     * Force the channel to be 'PROMPTBOOK_CHAT'
+     *
+     * @default 'PROMPTBOOK_CHAT'
      */
-    from: id;
+    channel?: 'PROMPTBOOK_CHAT';
     /**
      * The content of the message with optional markdown formatting
      */
@@ -37,6 +32,7 @@ export type ChatMessage = {
     isVoiceCall?: boolean;
 };
 /**
+ * TODO: Make all fields readonly
  * TODO: Delete `expectedAnswer` from ChatMessage
  * TODO: Rename `date` into `created`+`modified`
  */

package/esm/typings/src/book-components/_common/Dropdown/Dropdown.d.ts

@@ -1,7 +1,7 @@
-import { JSX } from 'react';
+import { ReactNode } from 'react';
 type DropdownProps = {
     actions: Array<{
-        icon: JSX.Element;
+        icon: ReactNode;
         name: string;
         onClick: () => void;
     }>;

package/esm/typings/src/book-components/_common/MenuHoisting/MenuHoistingContext.d.ts

@@ -0,0 +1,56 @@
+import { ReactNode } from 'react';
+/**
+ * Item that can be hoisted to the top menu
+ *
+ * @private mechanism inside Promptbook
+ */
+export type HoistedMenuItem = {
+    /**
+     * Unique key for the menu item
+     */
+    key?: string;
+    /**
+     * Icon to display
+     */
+    icon: ReactNode;
+    /**
+     * Name/Tooltip of the item
+     */
+    name: string;
+    /**
+     * Action to perform when clicked
+     */
+    onClick: () => void;
+    /**
+     * If true, the item is active/toggled
+     */
+    isActive?: boolean;
+};
+type MenuHoistingContextType = {
+    /**
+     * The currently hoisted menu items
+     */
+    menu: HoistedMenuItem[];
+    /**
+     * Set the hoisted menu items
+     */
+    setMenu: (items: HoistedMenuItem[]) => void;
+};
+/**
+ * Provider for menu hoisting
+ *
+ * @private mechanism inside Promptbook
+ */
+export declare function MenuHoistingProvider({ children }: {
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+/**
+ * Hook to use the menu hoisting system
+ *
+ * @private mechanism inside Promptbook
+ */
+export declare function useMenuHoisting(): MenuHoistingContextType | null;
+export {};
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts

@@ -1,7 +1,7 @@
 import type { SupabaseClient } from '@supabase/supabase-js';
 import type { AgentBasicInformation } from '../../../../book-2.0/agent-source/AgentBasicInformation';
 import type { string_book } from '../../../../book-2.0/agent-source/string_book';
-import type { string_agent_name } from '../../../../types/typeAliases';
+import type { string_agent_name, string_agent_permanent_id } from '../../../../types/typeAliases';
 import { AgentCollectionInSupabaseOptions } from './AgentCollectionInSupabaseOptions';
 import type { AgentsDatabaseSchema } from './AgentsDatabaseSchema';
 /**
@@ -28,38 +28,48 @@ export declare class AgentCollectionInSupabase {
     /**
      * [🐱‍🚀]@@@
      */
-    getAgentSource(agentName: string_agent_name): Promise<string_book>;
+    getAgentPermanentId(agentNameOrPermanentId: string_agent_name | string_agent_permanent_id): Promise<string_agent_permanent_id>;
+    /**
+     * [🐱‍🚀]@@@
+     */
+    getAgentSource(agentNameOrPermanentId: string_agent_name | string_agent_permanent_id): Promise<string_book>;
     /**
      * Creates a new agent in the collection
      *
      * Note: You can set 'PARENT' in the agent source to inherit from another agent in the collection.
      */
-    createAgent(agentSource: string_book): Promise<AgentBasicInformation>;
+    createAgent(agentSource: string_book): Promise<AgentBasicInformation & Required<Pick<AgentBasicInformation, 'permanentId'>>>;
     /**
      * Updates an existing agent in the collection
      */
-    updateAgentSource(agentName: string_agent_name, agentSource: string_book): Promise<void>;
+    updateAgentSource(permanentId: string_agent_permanent_id, agentSource: string_book): Promise<void>;
     /**
-     * Deletes an agent from the collection
+     * List agents that are soft deleted (deletedAt IS NOT NULL)
      */
-    deleteAgent(agentName: string_agent_name): Promise<void>;
+    listDeletedAgents(): Promise<ReadonlyArray<AgentBasicInformation>>;
     /**
      * List history of an agent
      */
-    listAgentHistory(agentName: string_agent_name): Promise<ReadonlyArray<{
+    listAgentHistory(permanentId: string_agent_permanent_id): Promise<ReadonlyArray<{
         id: number;
         createdAt: string;
         agentHash: string;
         promptbookEngineVersion: string;
     }>>;
     /**
-     * List agents that are in history but not in the active agents list
+     * Restore a soft-deleted agent by setting deletedAt to NULL
+     */
+    restoreAgent(permanentId: string_agent_permanent_id): Promise<void>;
+    /**
+     * Restore an agent from a specific history entry
+     *
+     * This will update the current agent with the source from the history entry
      */
-    listDeletedAgents(): Promise<ReadonlyArray<string_agent_name>>;
+    restoreAgentFromHistory(historyId: number): Promise<void>;
     /**
-     * Restore an agent from history
+     * Soft delete an agent by setting deletedAt to current timestamp
      */
-    restoreAgent(historyId: number): Promise<void>;
+    deleteAgent(permanentId: string_agent_permanent_id): Promise<void>;
     /**
      * Get the Supabase table name with prefix
      *

package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentsDatabaseSchema.d.ts

@@ -3,11 +3,12 @@
  * Source of truth: `/apps/agents-server/src/database/schema.sql` *(do not edit table structure here manually)*
  *
  * [💽] Prompt:
- * Re-generate this sub-schema
+ * Re-generate this sub-schema from `/apps/agents-server/src/database/schema.ts` *(which was generated from `/apps/agents-server/src/database/migrations/*.sql`)*
+ * `AgentsDatabaseSchema` is strict subset of `AgentsServerDatabase`
  * Generate Supabase TypeScript schema which is a subset of `AgentsServerDatabase`
  * containing only tables `Agent` and `AgentHistory`
  *
- * NOTE: This file intentionally omits all other tables (EnvironmentVariable, ChatHistory, ChatFeedback)
+ * NOTE: This file intentionally omits all other tables (`Metadata`, `ChatHistory`, `ChatFeedback`, `User`, `LlmCache`, etc.)
  *       and any extra schemas (e.g. `graphql_public`) to remain a strict subset.
  */
 export type Json = string | number | boolean | null | {
@@ -22,6 +23,7 @@ export type AgentsDatabaseSchema = {
                     agentName: string;
                     createdAt: string;
                     updatedAt: string | null;
+                    permanentId: string | null;
                     agentHash: string;
                     agentSource: string;
                     agentProfile: Json;
@@ -29,12 +31,15 @@ export type AgentsDatabaseSchema = {
                     usage: Json | null;
                     preparedModelRequirements: Json | null;
                     preparedExternals: Json | null;
+                    deletedAt: string | null;
+                    visibility: 'PUBLIC' | 'PRIVATE';
                 };
                 Insert: {
                     id?: number;
                     agentName: string;
                     createdAt: string;
                     updatedAt?: string | null;
+                    permanentId?: string | null;
                     agentHash: string;
                     agentSource: string;
                     agentProfile: Json;
@@ -42,12 +47,15 @@ export type AgentsDatabaseSchema = {
                     usage?: Json | null;
                     preparedModelRequirements?: Json | null;
                     preparedExternals?: Json | null;
+                    deletedAt?: string | null;
+                    visibility?: 'PUBLIC' | 'PRIVATE';
                 };
                 Update: {
                     id?: number;
                     agentName?: string;
                     createdAt?: string;
                     updatedAt?: string | null;
+                    permanentId?: string | null;
                     agentHash?: string;
                     agentSource?: string;
                     agentProfile?: Json;
@@ -55,6 +63,8 @@ export type AgentsDatabaseSchema = {
                     usage?: Json | null;
                     preparedModelRequirements?: Json | null;
                     preparedExternals?: Json | null;
+                    deletedAt?: string | null;
+                    visibility?: 'PUBLIC' | 'PRIVATE';
                 };
                 Relationships: [];
             };
@@ -63,6 +73,7 @@ export type AgentsDatabaseSchema = {
                     id: number;
                     createdAt: string;
                     agentName: string;
+                    permanentId: string;
                     agentHash: string;
                     previousAgentHash: string | null;
                     agentSource: string;
@@ -72,6 +83,7 @@ export type AgentsDatabaseSchema = {
                     id?: number;
                     createdAt: string;
                     agentName: string;
+                    permanentId: string;
                     agentHash: string;
                     previousAgentHash?: string | null;
                     agentSource: string;
@@ -81,26 +93,80 @@ export type AgentsDatabaseSchema = {
                     id?: number;
                     createdAt?: string;
                     agentName?: string;
+                    permanentId?: string;
                     agentHash?: string;
                     previousAgentHash?: string | null;
                     agentSource?: string;
                     promptbookEngineVersion?: string;
                 };
+                Relationships: [
+                    {
+                        foreignKeyName: 'AgentHistory_permanentId_fkey';
+                        columns: ['permanentId'];
+                        referencedRelation: 'Agent';
+                        referencedColumns: ['permanentId'];
+                    }
+                ];
+            };
+            GenerationLock: {
+                Row: {
+                    id: number;
+                    createdAt: string;
+                    updatedAt: string;
+                    lockKey: string;
+                    expiresAt: string;
+                };
+                Insert: {
+                    id?: number;
+                    createdAt?: string;
+                    updatedAt?: string;
+                    lockKey: string;
+                    expiresAt: string;
+                };
+                Update: {
+                    id?: number;
+                    createdAt?: string;
+                    updatedAt?: string;
+                    lockKey?: string;
+                    expiresAt?: string;
+                };
+                Relationships: [];
+            };
+            Image: {
+                Row: {
+                    id: number;
+                    createdAt: string;
+                    updatedAt: string;
+                    filename: string;
+                    prompt: string;
+                    cdnUrl: string;
+                    cdnKey: string;
+                };
+                Insert: {
+                    id?: number;
+                    createdAt?: string;
+                    updatedAt?: string;
+                    filename: string;
+                    prompt: string;
+                    cdnUrl: string;
+                    cdnKey: string;
+                };
+                Update: {
+                    id?: number;
+                    createdAt?: string;
+                    updatedAt?: string;
+                    filename?: string;
+                    prompt?: string;
+                    cdnUrl?: string;
+                    cdnKey?: string;
+                };
                 Relationships: [];
             };
         };
-        Views: {
-            [_ in never]: never;
-        };
-        Functions: {
-            [_ in never]: never;
-        };
-        Enums: {
-            [_ in never]: never;
-        };
-        CompositeTypes: {
-            [_ in never]: never;
-        };
+        Views: Record<string, never>;
+        Functions: Record<string, never>;
+        Enums: Record<string, never>;
+        CompositeTypes: Record<string, never>;
     };
 };
 type PublicSchema = AgentsDatabaseSchema[Extract<keyof AgentsDatabaseSchema, 'public'>];

package/esm/typings/src/commitments/DICTIONARY/DICTIONARY.d.ts

@@ -0,0 +1,46 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * DICTIONARY commitment definition
+ *
+ * The DICTIONARY commitment defines specific terms and their meanings that the agent should use correctly
+ * in its reasoning and responses. This ensures consistent terminology usage.
+ *
+ * Key features:
+ * - Multiple DICTIONARY commitments are automatically merged into one
+ * - Content is placed in a dedicated section of the system message
+ * - Terms and definitions are stored in metadata.DICTIONARY for debugging
+ * - Agent should use the defined terms correctly in responses
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * Legal Assistant
+ *
+ * PERSONA You are a knowledgeable legal assistant
+ * DICTIONARY Misdemeanor is a minor wrongdoing or criminal offense
+ * DICTIONARY Felony is a serious crime usually punishable by imprisonment for more than one year
+ * DICTIONARY Tort is a civil wrong that causes harm or loss to another person, leading to legal liability
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class DictionaryCommitmentDefinition extends BaseCommitmentDefinition<'DICTIONARY'> {
+    constructor();
+    /**
+     * Short one-line description of DICTIONARY.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for DICTIONARY commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -4,6 +4,7 @@ import { ActionCommitmentDefinition } from './ACTION/ACTION';
 import { ClosedCommitmentDefinition } from './CLOSED/CLOSED';
 import { ComponentCommitmentDefinition } from './COMPONENT/COMPONENT';
 import { DeleteCommitmentDefinition } from './DELETE/DELETE';
+import { DictionaryCommitmentDefinition } from './DICTIONARY/DICTIONARY';
 import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
 import { FromCommitmentDefinition } from './FROM/FROM';
 import { GoalCommitmentDefinition } from './GOAL/GOAL';
@@ -39,7 +40,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
  *
  * @private Use functions to access commitments instead of this array directly
  */
-export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, FromCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
+export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, FromCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
 /**
  * Gets a commitment definition by its type
  * @param type The commitment type to look up

package/esm/typings/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts

@@ -1,8 +1,8 @@
 import type { ChatParticipant } from '../../book-components/Chat/types/ChatParticipant';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult, PromptResult } from '../../execution/PromptResult';
-import type { ChatPrompt, CompletionPrompt, EmbeddingPrompt, Prompt } from '../../types/Prompt';
+import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult, ImagePromptResult, PromptResult } from '../../execution/PromptResult';
+import type { ChatPrompt, CompletionPrompt, EmbeddingPrompt, ImagePrompt, Prompt } from '../../types/Prompt';
 import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
 /**
  * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
@@ -43,6 +43,10 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
      * Calls the best available embedding model
      */
     callEmbeddingModel(prompt: EmbeddingPrompt): Promise<EmbeddingPromptResult>;
+    /**
+     * Calls the best available embedding model
+     */
+    callImageGenerationModel(prompt: ImagePrompt): Promise<ImagePromptResult>;
     /**
      * Calls the best available model
      *

package/esm/typings/src/llm-providers/agent/AgentLlmExecutionTools.d.ts

@@ -22,7 +22,7 @@ import type { CreateAgentLlmExecutionToolsOptions } from './CreateAgentLlmExecut
  * @public exported from `@promptbook/core`
  */
 export declare class AgentLlmExecutionTools implements LlmExecutionTools {
-    private readonly options;
+    protected readonly options: CreateAgentLlmExecutionToolsOptions;
     /**
      * Cache of OpenAI assistants to avoid creating duplicates
      */

package/esm/typings/src/llm-providers/ollama/OllamaExecutionTools.d.ts

@@ -39,7 +39,7 @@ export declare class OllamaExecutionTools extends OpenAiCompatibleExecutionTools
      */
     protected getDefaultEmbeddingModel(): AvailableModel;
     /**
-     * Default model for image generation variant.
+     * Default model for completion variant.
      */
     protected getDefaultImageGenerationModel(): AvailableModel;
 }

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

@@ -64,7 +64,7 @@ export declare class HardcodedOpenAiCompatibleExecutionTools extends OpenAiCompa
      */
     protected getDefaultEmbeddingModel(): AvailableModel;
     /**
-     * Default model for image generation variant.
+     * Default model for completion variant.
      */
     protected getDefaultImageGenerationModel(): AvailableModel;
 }

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

@@ -46,6 +46,7 @@ export declare class RemoteLlmExecutionTools<TCustomOptions = undefined> impleme
     private callCommonModel;
 }
 /**
+ * TODO: !!!! Deprecate pipeline server and all of its components
  * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
  * TODO: [🍓] Allow to list compatible models with each variant

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

@@ -0,0 +1,49 @@
+import { Arrayable } from 'type-fest';
+import { really_any } from '../_packages/types.index';
+import { id, string_date_iso8601, string_markdown } from './typeAliases';
+/**
+ * A generic message structure for various communication channels
+ */
+export type Message<TParticipant> = {
+    /**
+     * Unique identifier of the message
+     */
+    readonly id?: id;
+    /**
+     * Date when the message was created
+     */
+    readonly createdAt?: Date | string_date_iso8601;
+    /**
+     * The communication channel of the message
+     */
+    readonly channel?: 'PROMPTBOOK_CHAT' | 'EMAIL' | 'SMS' | 'WHATSAPP' | 'TELEGRAM' | 'SIGNAL' | string | 'UNKNOWN';
+    /**
+     * Is the message send from the Promptbook or to the Promptbook
+     */
+    readonly direction?: 'INBOUND' | 'OUTBOUND' | 'INTERNAL' | 'INITIAL';
+    /**
+     * Who sent the message
+     */
+    readonly sender: TParticipant;
+    /**
+     * Who are the recipients of the message
+     */
+    readonly recipients?: Readonly<Arrayable<TParticipant>>;
+    /**
+     * The content of the message as markdown
+     *
+     * Note: We are converting all message content to markdown for consistency
+     */
+    readonly content: string_markdown;
+    /**
+     * The thread identifier the message belongs to
+     *
+     * - `null` means the message is not part of any thread
+     * - `undefined` means that we don't know if the message is part of a thread or not
+     */
+    readonly threadId?: id | null;
+    /**
+     * Arbitrary metadata associated with the message
+     */
+    readonly metadata?: Readonly<Record<string, really_any>>;
+};

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

@@ -17,7 +17,17 @@ export type CompletionModelRequirements = CommonModelRequirements & {
     /**
      * Completion model variant
      */
-    modelVariant: 'COMPLETION';
+    readonly modelVariant: 'COMPLETION';
+    /**
+     * The temperature of the model
+     *
+     * Note: [💱] Promptbook is using just `temperature` (not `top_k` and `top_p`)
+     */
+    readonly temperature?: number_model_temperature;
+    /**
+     * Maximum number of tokens that can be generated by the model
+     */
+    readonly maxTokens?: number;
 };
 /**
  * Model requirements for the chat variant
@@ -28,11 +38,21 @@ export type ChatModelRequirements = CommonModelRequirements & {
     /**
      * Chat model variant
      */
-    modelVariant: 'CHAT';
+    readonly modelVariant: 'CHAT';
     /**
      * System message to be used in the model
      */
     readonly systemMessage?: string_system_message;
+    /**
+     * The temperature of the model
+     *
+     * Note: [💱] Promptbook is using just `temperature` (not `top_k` and `top_p`)
+     */
+    readonly temperature?: number_model_temperature;
+    /**
+     * Maximum number of tokens that can be generated by the model
+     */
+    readonly maxTokens?: number;
 };
 /**
  * Model requirements for the image generation variant
@@ -43,7 +63,21 @@ export type ImageGenerationModelRequirements = CommonModelRequirements & {
     /**
      * Image generation model variant
      */
-    modelVariant: 'IMAGE_GENERATION';
+    readonly modelVariant: 'IMAGE_GENERATION';
+    /**
+     * Size of the generated image
+     *
+     * e.g. '1536x1536'
+     */
+    readonly size?: '1024x1024' | '1792x1024' | '1024x1792' | `${number}x${number}`;
+    /**
+     * Quality of the generated image
+     */
+    readonly quality?: 'standard' | 'hd';
+    /**
+     * Style of the generated image
+     */
+    readonly style?: 'vivid' | 'natural';
 };
 /**
  * Model requirements for the embedding variant
@@ -54,7 +88,7 @@ export type EmbeddingModelRequirements = CommonModelRequirements & {
     /**
      * Embedding model variant
      */
-    modelVariant: 'EMBEDDING';
+    readonly modelVariant: 'EMBEDDING';
 };
 /**
  * Common properties for all model requirements variants
@@ -84,20 +118,10 @@ export type CommonModelRequirements = {
      * @example 'gpt-4', 'gpt-4-32k-0314', 'gpt-3.5-turbo-instruct',...
      */
     readonly modelName?: string_model_name;
-    /**
-     * The temperature of the model
-     *
-     * Note: [💱] Promptbook is using just `temperature` (not `top_k` and `top_p`)
-     */
-    readonly temperature?: number_model_temperature;
     /**
      * Seed for the model
      */
     readonly seed?: number_seed;
-    /**
-     * Maximum number of tokens that can be generated by the model
-     */
-    readonly maxTokens?: number;
 };
 /**
  * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (similar that `user` identification is not here)