@promptbook/wizard 0.100.0-5 → 0.100.0-61

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

@@ -0,0 +1,21 @@
+import type { string_book } from '../../../book-2.0/agent-source/string_book';
+import type { AvatarChipProps } from './AvatarChip';
+/**
+ * Props of `AvatarChipFromSource`
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type AvatarChipFromSourceProps = Omit<AvatarChipProps, 'avatarBasicInformation'> & {
+    /**
+     * Avatar to be shown
+     */
+    readonly source: string_book;
+};
+/**
+ * Shows a chip with avatar's avatar and name based on the avatar source string
+ *
+ * This component is wrapped around the `<AvatarChip/>`, it just parses the avatar source string into `AvatarBasicInformation` and passes it to the `<AvatarChip/>` component.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function AvatarChipFromSource(props: AvatarChipFromSourceProps): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,2 @@
+export * from './AvatarChip';
+export * from './AvatarChipFromSource';

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

@@ -0,0 +1,35 @@
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+/**
+ * Props of `BookEditor`
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type BookEditorProps = {
+    /**
+     * Additional CSS classes to apply to the editor container.
+     */
+    readonly className?: string;
+    /**
+     * CSS className for a font (e.g. from next/font) to style the editor text.
+     * If omitted, defaults to system serif fonts.
+     */
+    readonly fontClassName?: string;
+    /**
+     * The book which is being edited.
+     */
+    readonly value?: string_book;
+    /**
+     * Callback function to handle changes in the book content.
+     */
+    onChange?(value: string_book): void;
+    /**
+     * If true, logs verbose debug info to the console and shows additional visual cues
+     */
+    readonly isVerbose?: boolean;
+};
+/**
+ * Renders a book editor
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function BookEditor(props: BookEditorProps): 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/BookEditor/config.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Default font class name for the BookEditor component
+ * In Next.js environments, you can override this by importing the font directly
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const DEFAULT_BOOK_FONT_CLASS: any;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,11 @@
+/**
+ * Inject the CSS module rules (derived from imported `styles`) into the provided shadow root.
+ * This allows CSS modules (which are normally emitted into the document head) to be
+ * available inside the component's shadow DOM.
+ *
+ * @private within the promptbook components <- TODO: Maybe make promptbook util from this
+ */
+export declare function injectCssModuleIntoShadowRoot(shadowRoot: ShadowRoot): void;
+/**
+ * TODO: Make some utility functions for working with CSS modules in shadow DOM independent of `BookEditor.module.css`
+ */

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

@@ -0,0 +1,20 @@
+import type { ChatProps } from './ChatProps';
+/**
+ * @deprecated use `isComplete` instead
+ * @private util of `<Chat />`
+ */
+export declare const LOADING_INTERACTIVE_IMAGE = "Loading...";
+/**
+ * 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
+ * - `<LlmChat/>` connected to LLM Execution Tools of Promptbook
+ *
+ * Use <WorkerChat/> or <SignalChat/> in most cases.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function Chat(props: ChatProps): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,110 @@
+import type { CSSProperties, ReactNode } from 'react';
+import type { Promisable } from 'type-fest';
+import type { ChatMessage } from '../types/ChatMessage';
+import type { ChatParticipant } from '../types/ChatParticipant';
+/**
+ * @public exported from `@promptbook/components`
+ */
+export type 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: ReadonlyArray<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;
+    /**
+     * 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;
+    /**
+     * Is the writing textarea automatically focused?
+     *
+     * @default true on Desktop false on mobile (to prevent mobile keyboard from popping up)
+     */
+    readonly isFocusedOnLoad?: 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?: ReadonlyArray<ChatParticipant>;
+};

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

@@ -0,0 +1,14 @@
+import type { LlmChatProps } from './LlmChatProps';
+/**
+ * LlmChat component that provides chat functionality with LLM integration
+ *
+ * This component internally manages messages, participants, and task progress,
+ * and uses the provided LLM tools to generate responses via `LlmExecutionTools.callChatModel`.
+ *
+ * Note: There are multiple chat components:
+ * - `<Chat/>` renders chat as it is without any logic
+ * - `<LlmChat/>` connected to LLM Execution Tools of Promptbook
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function LlmChat(props: LlmChatProps): import("react/jsx-runtime").JSX.Element;

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

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

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

@@ -0,0 +1,24 @@
+import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { ChatProps } from '../Chat/ChatProps';
+import type { ChatMessage } from '../types/ChatMessage';
+import type { ChatParticipant } from '../types/ChatParticipant';
+/**
+ * Props for LlmChat component, derived from ChatProps but with LLM-specific modifications
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type LlmChatProps = Omit<ChatProps, 'messages' | 'onMessage' | 'onChange'> & {
+    /**
+     * LLM execution tools for chatting with the model
+     */
+    readonly llmTools: LlmExecutionTools;
+    /**
+     * Optional key for persisting conversation in localStorage
+     * When provided, the conversation will be saved and restored from localStorage
+     */
+    readonly persistenceKey?: string;
+    /**
+     * Called when the chat state changes (messages, participants, etc.)
+     */
+    onChange?(messages: ReadonlyArray<ChatMessage>, participants: ReadonlyArray<ChatParticipant>): void;
+};

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

@@ -0,0 +1,16 @@
+import type { string_markdown } from '../../../types/typeAliases';
+import type { string_name } from '../../../types/typeAliases';
+/**
+ * A message in the chat
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type ChatMessage = {
+    id: string;
+    date: Date;
+    from: string_name;
+    content: string_markdown;
+    isComplete?: boolean;
+    expectedAnswer?: string;
+    isVoiceCall?: boolean;
+};

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

@@ -0,0 +1,32 @@
+import type { string_color } from '../../../types/typeAliases';
+import type { string_name } from '../../../types/typeAliases';
+import type { string_person_fullname } from '../../../types/typeAliases';
+import type { string_url_image } from '../../../types/typeAliases';
+import { Color } from '../../../utils/color/Color';
+/**
+ * A participant in the chat
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type ChatParticipant = {
+    /**
+     * Identifies the participant by their name, same as `message.from`
+     */
+    name: string_name;
+    /**
+     * Full name of the participant
+     */
+    fullname: string_person_fullname;
+    /**
+     * Am I the participant? (i.e. is this the user)
+     */
+    isMe?: boolean;
+    /**
+     * Profile picture
+     */
+    avatarSrc?: string_url_image;
+    /**
+     * Color associated with the participant
+     */
+    color: string_color | Color;
+};

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

@@ -0,0 +1,25 @@
+import type { ChatMessage } from '../types/ChatMessage';
+/**
+ * Utility functions for persisting chat conversations in localStorage
+ *
+ * @private util of `LlmChat`
+ */
+export declare class ChatPersistence {
+    private static readonly STORAGE_PREFIX;
+    /**
+     * Save messages to localStorage under the given key
+     */
+    static saveMessages(persistenceKey: string, messages: ReadonlyArray<ChatMessage>): void;
+    /**
+     * Load messages from localStorage for the given key
+     */
+    static loadMessages(persistenceKey: string): ChatMessage[];
+    /**
+     * Clear messages from localStorage for the given key
+     */
+    static clearMessages(persistenceKey: string): void;
+    /**
+     * Check if localStorage is available
+     */
+    static isAvailable(): boolean;
+}

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,9 @@
+import type { ChatMessage } from '../types/ChatMessage';
+import type { ChatParticipant } from '../types/ChatParticipant';
+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?: ReadonlyArray<ChatParticipant>): Promise<void>;

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

@@ -0,0 +1,8 @@
+import type { ChatMessage } from '../types/ChatMessage';
+import type { ChatParticipant } from '../types/ChatParticipant';
+/**
+ * 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?: ReadonlyArray<ChatParticipant>): 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,8 @@
+import type { ChatMessage } from '../types/ChatMessage';
+import type { ChatParticipant } from '../types/ChatParticipant';
+/**
+ * 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?: ReadonlyArray<ChatParticipant>): string;

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

@@ -0,0 +1,7 @@
+import type { ChatMessage } from '../types/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,8 @@
+import type { ChatMessage } from '../types/ChatMessage';
+import type { ChatParticipant } from '../types/ChatParticipant';
+/**
+ * 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?: ReadonlyArray<ChatParticipant>): string;

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

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

package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts

@@ -0,0 +1,7 @@
+import type { string_css_class } from '../../../types/typeAliases';
+/**
+ * Utility function for joining multiple truthy class names into one string
+ *
+ * @private within the `@promptbook/components`
+ */
+export declare function classNames(...classes: Array<string_css_class | undefined | false | null>): string_css_class;

package/esm/typings/src/book-components/_common/react-utils/collectCssTextsForClass.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Collect matching CSS texts from document stylesheets for a given class.
+ * This will skip cross-origin stylesheets (they throw when accessed).
+ *
+ * @private within the promptbook components <- TODO: Maybe make promptbook util from this
+ */
+export declare function collectCssTextsForClass(className: string): string[];

package/esm/typings/src/book-components/_common/react-utils/escapeHtml.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Escape HTML to safely render user text inside a <pre> with dangerouslySetInnerHTML.
+ *
+ * @private within the promptbook components <- TODO: Maybe make promptbook util from this
+ */
+export declare function escapeHtml(input: string): string;

package/esm/typings/src/book-components/_common/react-utils/escapeRegex.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Escape text for safe use inside a RegExp pattern.
+ *
+ * @private within the promptbook components <- TODO: Maybe make promptbook util from this
+ */
+export declare function escapeRegex(input: string): string;

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

@@ -281,6 +281,12 @@ export declare function SET_IS_VERBOSE(isVerbose: boolean): void;
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_IS_AUTO_INSTALLED = false;
+/**
+ * Default simulated duration for a task in milliseconds (used for progress reporting)
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_TASK_SIMULATED_DURATION_MS: number;
 /**
  * Function name for generated function via `ptbk make` to get the pipeline collection
  *
@@ -295,6 +301,19 @@ export declare const DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME = "getPipelin
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_MAX_REQUESTS_PER_MINUTE = 60;
+/**
+ * API request timeout in milliseconds
+ * Can be overridden via API_REQUEST_TIMEOUT environment variable
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const API_REQUEST_TIMEOUT: number;
+/**
+ * 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/AvailableModel.d.ts

@@ -40,6 +40,10 @@ export type AvailableModel = {
         readonly prompt: number_usd;
         readonly output: number_usd;
     };
+    /**
+     * If the model is deprecated, it should not be used for new tasks
+     */
+    readonly isDeprecated?: boolean;
 };
 /**
  * TODO: [🧠] Maybe rename to something else - like `ModelInformation` or `ModelMetadata`

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

@@ -1,5 +1,6 @@
 import type { Observable } from 'rxjs';
 import { PartialDeep } from 'type-fest';
+import type { number_percent } from '../types/typeAliases';
 import type { task_id } from '../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { string_promptbook_version } from '../version';
@@ -19,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> & {
@@ -27,6 +29,9 @@ type CreateTaskOptions<TTaskResult extends AbstractTaskResult> = {
          * Optional update of the task title
          */
         readonly title?: AbstractTask<TTaskResult>['title'];
+    }) => void, updateTldr: (tldrInfo: {
+        readonly percent: number_percent;
+        readonly message: string;
     }) => void): Promise<TTaskResult>;
 };
 /**
@@ -80,6 +85,19 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      * Status of the task
      */
     readonly status: task_status;
+    /**
+     * Short summary of the task status for quick overview in the UI
+     */
+    readonly tldr: {
+        /**
+         * Progress in percentage from 0 to 1 (100%) that can be used to display a progress bar
+         */
+        readonly percent: number_percent;
+        /**
+         * Short summary message of the task status that can be displayed in the UI
+         */
+        readonly message: string;
+    };
     /**
      * Date when the task was created
      */
@@ -92,6 +110,14 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      * Gets a promise that resolves with the task result
      */
     asPromise(options?: {
+        /**
+         * Do the task throws on error
+         *
+         * - If `true` when error occurs the returned promise will rejects
+         * - If `false` the promise will resolve with object with all listed errors and warnings and partial result
+         *
+         * @default true
+         */
         readonly isCrashedOnError?: boolean;
     }): Promise<TTaskResult>;
     /**