@promptbook/templates 0.100.0-44 → 0.100.0-45

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

@@ -3,14 +3,24 @@ import type { AvatarChipProps } from '../book-components/AvatarProfile/AvatarChi
 import { AvatarChip } from '../book-components/AvatarProfile/AvatarChip/AvatarChip';
 import type { AvatarChipFromSourceProps } from '../book-components/AvatarProfile/AvatarChip/AvatarChipFromSource';
 import { AvatarChipFromSource } from '../book-components/AvatarProfile/AvatarChip/AvatarChipFromSource';
+import type { AvatarProfileProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
+import { AvatarProfile } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
+import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
+import { AvatarProfileFromSource } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
 import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
 import { BookEditor } from '../book-components/BookEditor/BookEditor';
 import { DEFAULT_BOOK_FONT_CLASS } from '../book-components/BookEditor/config';
+import { Chat } from '../book-components/Chat/Chat/Chat';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export type { AvatarChipProps };
 export { AvatarChip };
 export type { AvatarChipFromSourceProps };
 export { AvatarChipFromSource };
+export type { AvatarProfileProps };
+export { AvatarProfile };
+export type { AvatarProfileFromSourceProps };
+export { AvatarProfileFromSource };
 export type { BookEditorProps };
 export { BookEditor };
 export { DEFAULT_BOOK_FONT_CLASS };
+export { Chat };

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

@@ -49,6 +49,7 @@ import { DEFAULT_IS_AUTO_INSTALLED } from '../config';
 import { DEFAULT_TASK_SIMULATED_DURATION_MS } from '../config';
 import { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME } from '../config';
 import { DEFAULT_MAX_REQUESTS_PER_MINUTE } from '../config';
+import { PROMPTBOOK_LOGO_URL } from '../config';
 import { MODEL_TRUST_LEVELS } from '../constants';
 import { MODEL_ORDERS } from '../constants';
 import { ORDER_OF_PIPELINE_JSON } from '../constants';
@@ -211,6 +212,7 @@ export { DEFAULT_IS_AUTO_INSTALLED };
 export { DEFAULT_TASK_SIMULATED_DURATION_MS };
 export { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME };
 export { DEFAULT_MAX_REQUESTS_PER_MINUTE };
+export { PROMPTBOOK_LOGO_URL };
 export { MODEL_TRUST_LEVELS };
 export { MODEL_ORDERS };
 export { ORDER_OF_PIPELINE_JSON };

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

@@ -13,7 +13,13 @@ import type { RetrievalResult } from '../book-2.0/commitments/KNOWLEDGE/types';
 import type { RAGConfig } from '../book-2.0/commitments/KNOWLEDGE/types';
 import type { AvatarChipProps } from '../book-components/AvatarProfile/AvatarChip/AvatarChip';
 import type { AvatarChipFromSourceProps } from '../book-components/AvatarProfile/AvatarChip/AvatarChipFromSource';
+import type { AvatarProfileProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
+import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
 import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
+import type { ChatMessage } from '../book-components/Chat/interfaces/ChatMessage';
+import type { UserChatMessage } from '../book-components/Chat/interfaces/ChatMessage';
+import type { PromptbookPersonaChatMessage } from '../book-components/Chat/interfaces/ChatMessage';
+import type { CompleteChatMessage } from '../book-components/Chat/interfaces/ChatMessage';
 import type { PipelineCollection } from '../collection/PipelineCollection';
 import type { Command } from '../commands/_common/types/Command';
 import type { CommandParser } from '../commands/_common/types/CommandParser';
@@ -334,7 +340,13 @@ export type { RetrievalResult };
 export type { RAGConfig };
 export type { AvatarChipProps };
 export type { AvatarChipFromSourceProps };
+export type { AvatarProfileProps };
+export type { AvatarProfileFromSourceProps };
 export type { BookEditorProps };
+export type { ChatMessage };
+export type { UserChatMessage };
+export type { PromptbookPersonaChatMessage };
+export type { CompleteChatMessage };
 export type { PipelineCollection };
 export type { Command };
 export type { CommandParser };

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

@@ -0,0 +1,26 @@
+import type { AgentBasicInformation } from '../../../book-2.0/agent-source/parseAgentSource';
+import type { string_css_class } from '../../../types/typeAliases';
+/**
+ * Props of `AvatarProfile`
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type AvatarProfileProps = {
+    /**
+     * Agent to be shown
+     */
+    readonly agent: AgentBasicInformation & {
+        agentTitle?: string;
+        agentDescription?: string;
+    };
+    /**
+     * Optional CSS class name which will be added to root <div> element
+     */
+    readonly className?: string_css_class;
+};
+/**
+ * Shows a box with user avatar, name and description
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function AvatarProfile(props: AvatarProfileProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource.d.ts

@@ -0,0 +1,19 @@
+import type { string_book } from '../../../book-2.0/agent-source/string_book';
+import type { AvatarProfileProps } from './AvatarProfile';
+/**
+ * Props of `AvatarProfileFromSource`
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type AvatarProfileFromSourceProps = Omit<AvatarProfileProps, 'agent'> & {
+    /**
+     * Agent source to be shown
+     */
+    readonly agentSource: string_book;
+};
+/**
+ * Shows a box with user avatar, name and description from a string source
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function AvatarProfileFromSource(props: AvatarProfileFromSourceProps): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,15 @@
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+/**
+ * @private util of `<BookEditor />`
+ */
+export type BookEditorInnerProps = {
+    className?: string;
+    fontClassName?: string;
+    value?: string_book;
+    onChange?(value: string_book): void;
+    isVerbose?: boolean;
+};
+/**
+ * @private util of `<BookEditor />`
+ */
+export declare function BookEditorInner(props: BookEditorInnerProps): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,134 @@
+import type { CSSProperties, ReactNode } from 'react';
+import type { Promisable } from 'type-fest';
+import type { ChatMessage } from '../interfaces/ChatMessage';
+/**
+ * @deprecated use `isComplete` instead
+ * @private util of `<Chat />`
+ */
+export declare const LOADING_INTERACTIVE_IMAGE = "Loading...";
+interface ChatProps {
+    /**
+     * Optional callback to create a new agent from the template.
+     * If provided, renders the [Use this template] button.
+     */
+    onUseTemplate?: () => void;
+    /**
+     * Messages to render - they are rendered as they are
+     */
+    readonly messages: Array<ChatMessage>;
+    /**
+     * Called every time the user types or dictated a message
+     */
+    onChange?(messageContent: string): void;
+    /**
+     * Called when user sends a message
+     *
+     * Note: You must handle the message yourself and add it to the `messages` array
+     */
+    onMessage(messageContent: string): Promisable<void>;
+    /**
+     * Optional callback, when set, button for resetting chat will be shown
+     */
+    onReset?(): Promisable<void>;
+    /**
+     * Determines whether the voice recognition button is rendered
+     */
+    readonly isVoiceRecognitionButtonShown?: boolean;
+    /**
+     * The language code to use for voice recognition
+     */
+    readonly voiceLanguage?: string;
+    /**
+     * Avatars for each user
+     */
+    readonly avatars?: Partial<Record<ChatMessage['from'], string>>;
+    /**
+     * Optional placeholder message for the textarea
+     *
+     * @default "Write a message"
+     */
+    readonly placeholderMessageContent?: string;
+    /**
+     * Optional preset message in chat
+     */
+    readonly defaultMessage?: string;
+    /**
+     * List of tasks that are currently in progress that should be displayed
+     */
+    readonly tasksProgress?: Array<{
+        id: string;
+        name: string;
+        progress?: number;
+    }>;
+    /**
+     * Content to be shown inside the chat bar in head
+     * If not provided, the chat bar will not be rendered
+     */
+    readonly children?: ReactNode;
+    /**
+     * Optional CSS class name which will be added to root <div/> element
+     */
+    readonly className?: string;
+    /**
+     * Optional CSS style which will be added to root <div/> element
+     */
+    readonly style?: CSSProperties;
+    /**
+     * Voice call props - when provided, voice call button will be shown
+     */
+    readonly voiceCallProps?: {
+        selectedModel: string;
+        providerClients: Map<string, unknown>;
+        currentPersonaContent?: string;
+        onVoiceMessage?: (content: string, isVoiceCall: boolean) => void;
+        onAssistantVoiceResponse?: (content: string, isVoiceCall: boolean) => void;
+        onVoiceCallStateChange?: (isVoiceCalling: boolean) => void;
+    };
+    /**
+     * Indicates whether a voice call is currently active
+     */
+    readonly isVoiceCalling?: boolean;
+    /**
+     * Whether experimental features are enabled (required for voice calling)
+     */
+    readonly isExperimental?: boolean;
+    /**
+     * Whether the save button is enabled and shown
+     */
+    readonly isSaveButtonEnabled?: boolean;
+    /**
+     * Optional markdown header to include at the top of exported files.
+     * Example: "## Discussion Topic\n\nSome topic here"
+     */
+    readonly exportHeaderMarkdown?: string;
+    /**
+     * Optional mapping of participant IDs (message.from) to display metadata for exports.
+     * Keys should match ChatMessage.from values (e.g., 'USER', 'AGENT_{id}', etc.)
+     */
+    readonly participants?: Record<string, {
+        name: string;
+        avatarUrl?: string;
+    }>;
+}
+/**
+ * Renders a chat with messages and input for new messages
+ *
+ * Note: 🔇 This component does NOT have speak functionality, it just allows to trigger voice recognition
+ *
+ * Note: There are multiple chat components:
+ * - <Chat/> renders chat as it is without any logic
+ * - <SimpleChat/> with callback function after each message 🔵->🟢->🔵->🟢->🔵->🟢->...
+ * - <WorkerChat/> with continuously running worker function on background which binds on dialogues queue  🔵->🟢->🔵->🟢->🔵->🟢->...
+ * - <SignalChat/> fully controlled by signal that is passed in 🔵->🟢->🟢->🟢->🔵->🟢->...
+ * - <LlmChat/> connected to LLM Execution Tools of Promptbook
+ * - <AgentChat/> direct OpenAI API integration with streaming responses and model selection
+ * - <ChatbotMiniapp/> Fully working chatbot miniapp created from book
+ * - <AssistantChatPage/> page for assistant chat with welcome message and avatar
+ * - <ModelAwareChat/> wrapper around <Chat/> that provides model-aware avatars
+ *
+ * Use <WorkerChat/> or <SignalChat/> in most cases.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function Chat(props: ChatProps): import("react/jsx-runtime").JSX.Element;
+export {};

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

@@ -0,0 +1,30 @@
+export type ChatMessage = UserChatMessage | PromptbookPersonaChatMessage;
+export interface UserChatMessage {
+    id: string;
+    date: Date;
+    from: 'USER';
+    content: string;
+    isComplete: boolean;
+    expectedAnswer?: string;
+    isVoiceCall?: boolean;
+}
+export interface PromptbookPersonaChatMessage {
+    id: string;
+    date: Date;
+    from: 'PROMPTBOOK_PERSONA';
+    avatar?: string | {
+        src: string;
+        width?: number;
+        height?: number;
+    };
+    content: string;
+    isComplete: boolean;
+    expectedAnswer?: string;
+    isVoiceCall?: boolean;
+}
+export interface CompleteChatMessage {
+    isComplete: true;
+}
+/**
+ * TODO: [🧠] ACRY Rename PROMPTBOOK_PERSONA + USER, Teacher, teacher to sth else
+ */

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

@@ -0,0 +1,4 @@
+/**
+ * @private utility of `<Chat/>` component
+ */
+export type ExportFormat = 'pdf' | 'txt' | 'md' | 'html' | 'json';

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

@@ -0,0 +1,7 @@
+import type { ExportFormat } from './ExportFormat';
+/**
+ * Utility: add UTM parameters to a URL for tracking
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function addUtmParamsToUrl(baseUrl: string, format: ExportFormat): string;

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

@@ -0,0 +1,7 @@
+/**
+ * Create a short link for chat sharing.
+ * Simplified version without Supabase dependency.
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function createShortLinkForChat(utmUrl: string): Promise<string>;

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

@@ -0,0 +1,6 @@
+/**
+ * Downloads a file with the given content and filename
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function downloadFile(content: string, filename: string, mimeType: string): void;

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

@@ -0,0 +1,11 @@
+import type { ChatMessage } from '../interfaces/ChatMessage';
+import type { ExportFormat } from './ExportFormat';
+/**
+ * Exports chat messages in the specified format
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function exportChatHistory(messages: ChatMessage[], format: ExportFormat, headerMarkdown?: string, participants?: Record<string, {
+    name: string;
+    avatarUrl?: string;
+}>): Promise<void>;

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

@@ -0,0 +1,10 @@
+import type { ChatMessage } from '../interfaces/ChatMessage';
+/**
+ * Generates PDF content using HTML and triggers print dialog
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function generatePdfContent(messages: ChatMessage[], shareUrl: string, qrDataUrl?: string | null, headerMarkdown?: string, participants?: Record<string, {
+    name: string;
+    avatarUrl?: string;
+}>): void;

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

@@ -0,0 +1,7 @@
+/**
+ * Utility: generate a QR code data URL for a given text
+ * Simplified version without QR code library dependency
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function generateQrDataUrl(text: string): Promise<string | null>;

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

@@ -0,0 +1,6 @@
+/**
+ * Generates Promptbook branding header for exported files
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function getPromptbookBranding(shareUrl: string): string;

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

@@ -0,0 +1,10 @@
+import type { ChatMessage } from '../interfaces/ChatMessage';
+/**
+ * Converts chat messages to HTML format
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function messagesToHtml(messages: ChatMessage[], shareUrl: string, qrDataUrl?: string | null, headerMarkdown?: string, participants?: Record<string, {
+    name: string;
+    avatarUrl?: string;
+}>): string;

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

@@ -0,0 +1,7 @@
+import type { ChatMessage } from '../interfaces/ChatMessage';
+/**
+ * Converts chat messages to JSON format
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function messagesToJson(messages: ChatMessage[], shareUrl: string): string;

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

@@ -0,0 +1,10 @@
+import type { ChatMessage } from '../interfaces/ChatMessage';
+/**
+ * Converts chat messages to Markdown format
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function messagesToMarkdown(messages: ChatMessage[], shareUrl: string, qrDataUrl?: string | null, headerMarkdown?: string, participants?: Record<string, {
+    name: string;
+    avatarUrl?: string;
+}>): string;

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

@@ -0,0 +1,10 @@
+import type { ChatMessage } from '../interfaces/ChatMessage';
+/**
+ * Converts chat messages to plain text format
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function messagesToText(messages: ChatMessage[], shareUrl: string, headerMarkdown?: string, participants?: Record<string, {
+    name: string;
+    avatarUrl?: string;
+}>): string;

package/esm/typings/src/config.d.ts

@@ -301,6 +301,12 @@ export declare const DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME = "getPipelin
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_MAX_REQUESTS_PER_MINUTE = 60;
+/**
+ * URL of the Promptbook logo
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PROMPTBOOK_LOGO_URL = "https://promptbook.studio/logos/logo-blue-white-256.png";
 /**
  * Indicates whether pipeline logic validation is enabled. When true, the pipeline logic is checked for consistency.
  *

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

@@ -20,7 +20,8 @@ type CreateTaskOptions<TTaskResult extends AbstractTaskResult> = {
     readonly title: AbstractTask<TTaskResult>['title'];
     /**
      * Callback that processes the task and updates the ongoing result
-     * @param ongoingResult The partial result of the task processing
+     * @param updateOngoingResult Function to update the partial result of the task processing
+     * @param updateTldr Function to update tldr progress information
      * @returns The final task result
      */
     taskProcessCallback(updateOngoingResult: (newOngoingResult: PartialDeep<TTaskResult> & {
@@ -28,20 +29,10 @@ type CreateTaskOptions<TTaskResult extends AbstractTaskResult> = {
          * Optional update of the task title
          */
         readonly title?: AbstractTask<TTaskResult>['title'];
-    }) => void): Promise<TTaskResult>;
-    /**
-     * Optional callback to provide custom tldr information
-     * @param createdAt When the task was created
-     * @param status Current task status
-     * @param currentValue Current partial result
-     * @param errors Current errors
-     * @param warnings Current warnings
-     * @returns Custom tldr information
-     */
-    tldrProvider?(createdAt: Date, status: task_status, currentValue: PartialDeep<TTaskResult>, errors: Array<Error>, warnings: Array<Error>): {
+    }) => void, updateTldr: (tldrInfo: {
         readonly percent: number_percent;
         readonly message: string;
-    };
+    }) => void): Promise<TTaskResult>;
 };
 /**
  * Helper to create a new task

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.100.0-43`).
+ * It follows semantic versioning (e.g., `0.100.0-44`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/templates",
-    "version": "0.100.0-44",
+    "version": "0.100.0-45",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -95,7 +95,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/templates.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.100.0-44"
+        "@promptbook/core": "0.100.0-45"
     },
     "dependencies": {
         "prettier": "2.8.1",

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.100.0-44';
+    const PROMPTBOOK_ENGINE_VERSION = '0.100.0-45';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1596,7 +1596,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.100.0-43",
+                        "promptbookVersion": "0.100.0-44",
                         "usage": {
                             "price": {
                                 "value": 0.040614
@@ -2179,7 +2179,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.100.0-43",
+                        "promptbookVersion": "0.100.0-44",
                         "usage": {
                             "price": {
                                 "value": 0.040614
@@ -2885,7 +2885,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.100.0-43",
+                        "promptbookVersion": "0.100.0-44",
                         "usage": {
                             "price": {
                                 "value": 0.038256
@@ -3033,7 +3033,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.100.0-43",
+                        "promptbookVersion": "0.100.0-44",
                         "usage": {
                             "price": {
                                 "value": 0.038181
@@ -3129,7 +3129,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.100.0-43",
+                        "promptbookVersion": "0.100.0-44",
                         "usage": {
                             "price": {
                                 "value": 0
@@ -3278,7 +3278,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.100.0-43",
+                        "promptbookVersion": "0.100.0-44",
                         "usage": {
                             "price": {
                                 "value": 0.038508
@@ -3428,7 +3428,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.100.0-43",
+                        "promptbookVersion": "0.100.0-44",
                         "usage": {
                             "price": {
                                 "value": 0.036648
@@ -3761,7 +3761,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.100.0-43",
+                        "promptbookVersion": "0.100.0-44",
                         "usage": {
                             "price": {
                                 "value": 0.039036
@@ -3908,7 +3908,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.100.0-43",
+                        "promptbookVersion": "0.100.0-44",
                         "usage": {
                             "price": {
                                 "value": 0.038313