@promptbook/components 0.103.0-67 → 0.103.0-68

package/esm/typings/src/_packages/components.index.d.ts

@@ -45,6 +45,7 @@ import type { MessageButton } from '../book-components/Chat/utils/parseMessageBu
 import { parseMessageButtons } from '../book-components/Chat/utils/parseMessageButtons';
 import { ArrowIcon } from '../book-components/icons/ArrowIcon';
 import { AttachmentIcon } from '../book-components/icons/AttachmentIcon';
+import { CameraIcon } from '../book-components/icons/CameraIcon';
 import { MicIcon } from '../book-components/icons/MicIcon';
 import { PauseIcon } from '../book-components/icons/PauseIcon';
 import { PlayIcon } from '../book-components/icons/PlayIcon';
@@ -105,6 +106,7 @@ export type { MessageButton };
 export { parseMessageButtons };
 export { ArrowIcon };
 export { AttachmentIcon };
+export { CameraIcon };
 export { MicIcon };
 export { PauseIcon };
 export { PlayIcon };

package/esm/typings/src/_packages/types.index.d.ts

@@ -88,6 +88,7 @@ import type { PromptbookFetch } from '../execution/PromptbookFetch';
 import type { PromptResult } from '../execution/PromptResult';
 import type { CompletionPromptResult } from '../execution/PromptResult';
 import type { ChatPromptResult } from '../execution/PromptResult';
+import type { ImagePromptResult } from '../execution/PromptResult';
 import type { EmbeddingPromptResult } from '../execution/PromptResult';
 import type { ScriptExecutionTools } from '../execution/ScriptExecutionTools';
 import type { ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
@@ -187,6 +188,7 @@ import type { LlmCall } from '../types/LlmCall';
 import type { ModelRequirements } from '../types/ModelRequirements';
 import type { CompletionModelRequirements } from '../types/ModelRequirements';
 import type { ChatModelRequirements } from '../types/ModelRequirements';
+import type { ImageGenerationModelRequirements } from '../types/ModelRequirements';
 import type { EmbeddingModelRequirements } from '../types/ModelRequirements';
 import type { ModelVariant } from '../types/ModelVariant';
 import type { NonEmptyArray } from '../types/NonEmptyArray';
@@ -194,6 +196,7 @@ import type { NonEmptyReadonlyArray } from '../types/NonEmptyArray';
 import type { Prompt } from '../types/Prompt';
 import type { CompletionPrompt } from '../types/Prompt';
 import type { ChatPrompt } from '../types/Prompt';
+import type { ImagePrompt } from '../types/Prompt';
 import type { EmbeddingPrompt } from '../types/Prompt';
 import type { ScriptLanguage } from '../types/ScriptLanguage';
 import type { SectionType } from '../types/SectionType';
@@ -449,6 +452,7 @@ export type { PromptbookFetch };
 export type { PromptResult };
 export type { CompletionPromptResult };
 export type { ChatPromptResult };
+export type { ImagePromptResult };
 export type { EmbeddingPromptResult };
 export type { ScriptExecutionTools };
 export type { ScriptExecutionToolsExecuteOptions };
@@ -548,6 +552,7 @@ export type { LlmCall };
 export type { ModelRequirements };
 export type { CompletionModelRequirements };
 export type { ChatModelRequirements };
+export type { ImageGenerationModelRequirements };
 export type { EmbeddingModelRequirements };
 export type { ModelVariant };
 export type { NonEmptyArray };
@@ -555,6 +560,7 @@ export type { NonEmptyReadonlyArray };
 export type { Prompt };
 export type { CompletionPrompt };
 export type { ChatPrompt };
+export type { ImagePrompt };
 export type { EmbeddingPrompt };
 export type { ScriptLanguage };
 export type { SectionType };

package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts

@@ -81,6 +81,16 @@ export type BookEditorProps = {
          */
         readonly readonlyMessage?: string;
     };
+    /**
+     * If true, shows the upload button in the action bar.
+     * By default, the upload button is shown.
+     */
+    readonly isUploadButtonShown?: boolean;
+    /**
+     * If true, shows the camera button in the action bar.
+     * By default, the camera button is shown on mobile devices.
+     */
+    readonly isCameraButtonShown?: boolean;
     /**
      * If true, shows the download button in the action bar.
      * By default, the download button is shown.

package/esm/typings/src/book-components/BookEditor/BookEditorActionbar.d.ts

@@ -1,9 +1,13 @@
 type BookEditorActionbarProps = {
     value: string | undefined;
     isDownloadButtonShown?: boolean;
+    isUploadButtonShown?: boolean;
+    isCameraButtonShown?: boolean;
     isAboutButtonShown?: boolean;
     isFullscreenButtonShown?: boolean;
     onFullscreenClick?: () => void;
+    onUploadDocument?: () => void;
+    onTakePhoto?: () => void;
     isFullscreen?: boolean;
 };
 /**

package/esm/typings/src/book-components/icons/CameraIcon.d.ts

@@ -0,0 +1,11 @@
+type CameraIconProps = {
+    size?: number;
+    color?: string;
+};
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function CameraIcon({ size, color }: CameraIconProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/esm/typings/src/execution/LlmExecutionTools.d.ts

@@ -3,7 +3,7 @@ import type { ChatParticipant } from '../book-components/Chat/types/ChatParticip
 import type { Prompt } from '../types/Prompt';
 import type { string_markdown, string_markdown_text, string_title } from '../types/typeAliases';
 import type { AvailableModel } from './AvailableModel';
-import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult } from './PromptResult';
+import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult, ImagePromptResult } from './PromptResult';
 /**
  * Container for all the tools needed to execute prompts to large language models like GPT-4
  * On its interface it exposes common methods for prompt execution.
@@ -70,6 +70,10 @@ export type LlmExecutionTools = {
      * Calls a completion model
      */
     callCompletionModel?(prompt: Prompt): Promise<CompletionPromptResult>;
+    /**
+     * Calls a image generation model
+     */
+    callImageGenerationModel?(prompt: Prompt): Promise<ImagePromptResult>;
     /**
      * Calls an embedding model
      */

package/esm/typings/src/execution/PromptResult.d.ts

@@ -8,7 +8,7 @@ import type { Usage } from './Usage';
  *
  * @see https://github.com/webgptorg/promptbook#prompt-result
  */
-export type PromptResult = CompletionPromptResult | ChatPromptResult | EmbeddingPromptResult;
+export type PromptResult = CompletionPromptResult | ChatPromptResult | ImagePromptResult | EmbeddingPromptResult;
 /**
  * Completion prompt result
  *
@@ -22,6 +22,12 @@ export type CompletionPromptResult = CommonPromptResult;
  * Note: [🚉] This is fully serializable as JSON
  */
 export type ChatPromptResult = CommonPromptResult & {};
+/**
+ * Image prompt result
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ImagePromptResult = CommonPromptResult;
 /**
  * Embedding prompt  result
  *

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

@@ -38,6 +38,10 @@ export declare class OllamaExecutionTools extends OpenAiCompatibleExecutionTools
      * Default model for completion variant.
      */
     protected getDefaultEmbeddingModel(): AvailableModel;
+    /**
+     * Default model for image generation variant.
+     */
+    protected getDefaultImageGenerationModel(): AvailableModel;
 }
 /**
  * TODO: [🛄] Some way how to re-wrap the errors from `OpenAiCompatibleExecutionTools`

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

@@ -1,7 +1,7 @@
 import OpenAI from 'openai';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult } from '../../execution/PromptResult';
+import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult, ImagePromptResult } from '../../execution/PromptResult';
 import type { Usage } from '../../execution/Usage';
 import type { Prompt } from '../../types/Prompt';
 import type { string_markdown, string_markdown_text, string_model_name, string_title } from '../../types/typeAliases';
@@ -63,6 +63,14 @@ export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecu
      * Internal method that handles parameter retry for embedding model calls
      */
     private callEmbeddingModelWithRetry;
+    /**
+     * Calls OpenAI compatible API to use a image generation model
+     */
+    callImageGenerationModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<ImagePromptResult>;
+    /**
+     * Internal method that handles parameter retry for image generation model calls
+     */
+    private callImageGenerationModelWithRetry;
     /**
      * Get the model that should be used as default
      */
@@ -89,6 +97,10 @@ export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecu
      * Default model for completion variant.
      */
     protected abstract getDefaultEmbeddingModel(): AvailableModel;
+    /**
+     * Default model for image generation variant.
+     */
+    protected abstract getDefaultImageGenerationModel(): AvailableModel;
     /**
      * Makes a request with retry logic for network errors like ECONNRESET
      */

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

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

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

@@ -1,15 +1,11 @@
 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 type { string_markdown, string_markdown_text, string_model_name, 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';
+import type { OpenAiCompatibleExecutionToolsNonProxiedOptions, OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleExecutionToolsOptions';
 /**
  * Execution Tools for calling OpenAI compatible API
  *
@@ -67,6 +63,10 @@ export declare class HardcodedOpenAiCompatibleExecutionTools extends OpenAiCompa
      * Default model for completion variant.
      */
     protected getDefaultEmbeddingModel(): AvailableModel;
+    /**
+     * Default model for image generation variant.
+     */
+    protected getDefaultImageGenerationModel(): AvailableModel;
 }
 /**
  * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?

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/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.103.0-66`).
+ * It follows semantic versioning (e.g., `0.103.0-67`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/components",
-    "version": "0.103.0-67",
+    "version": "0.103.0-68",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,