@promptbook/documents 0.113.0-1 → 0.113.0-11

package/umd/src/utils/agents/terminalAgentAvatarVisual.d.ts

@@ -0,0 +1,94 @@
+import { type CreateCanvasForAsciiArt } from '../../avatars/renderAvatarVisualAsciiArt';
+import type { AvatarVisualId } from '../../avatars/types/AvatarVisualDefinition';
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+import type { AsciiArtColorDepth } from '../ascii-art/convertImageDataToAsciiArt';
+/**
+ * Output width of the terminal agent avatar visual in character cells.
+ *
+ * @private shared helper for terminal avatar rendering
+ */
+export declare const TERMINAL_AGENT_AVATAR_VISUAL_COLUMNS = 48;
+/**
+ * Output height of the terminal agent avatar visual in character cells.
+ *
+ * @private shared helper for terminal avatar rendering
+ */
+export declare const TERMINAL_AGENT_AVATAR_VISUAL_ROWS = 12;
+/**
+ * Refresh cadence used while a terminal agent avatar visual is animated.
+ *
+ * @private shared helper for terminal avatar rendering
+ */
+export declare const TERMINAL_AGENT_AVATAR_VISUAL_REFRESH_INTERVAL_MS = 300;
+/**
+ * Options passed when rendering one animated terminal avatar frame.
+ *
+ * @private shared helper for terminal avatar rendering
+ */
+export type TerminalAgentAvatarVisualFrameOptions = {
+    /**
+     * Current animation time forwarded to the shared avatar renderer.
+     */
+    readonly animationTimeMs: number;
+};
+/**
+ * Runtime renderer for an agent avatar visual shown in a terminal.
+ *
+ * @private shared helper for terminal avatar rendering
+ */
+export type TerminalAgentAvatarVisual = {
+    /**
+     * Whether the selected built-in visual changes over time.
+     */
+    readonly isAnimated: boolean;
+    /**
+     * Renders one ANSI ASCII-art frame for the current terminal timestamp.
+     */
+    readonly renderFrame: (options: TerminalAgentAvatarVisualFrameOptions) => ReadonlyArray<string>;
+};
+/**
+ * Options for creating a terminal avatar visual renderer from an agent book source.
+ *
+ * @private shared helper for terminal avatar rendering
+ */
+export type CreateTerminalAgentAvatarVisualOptions = {
+    /**
+     * Source of the agent book whose metadata controls avatar identity.
+     */
+    readonly agentSource: string_book;
+    /**
+     * Built-in avatar visual used when the agent does not declare `META AVATAR` or `META VISUAL`.
+     */
+    readonly defaultAvatarVisualId?: AvatarVisualId;
+    /**
+     * Color depth of the emitted ANSI escape codes.
+     */
+    readonly colorDepth?: AsciiArtColorDepth;
+    /**
+     * Platform-specific canvas factory used to rasterize the visual.
+     */
+    readonly createCanvas: CreateCanvasForAsciiArt;
+};
+/**
+ * Resolves the built-in avatar visual selected for terminal rendering of one agent source.
+ *
+ * @param agentSource Source of the agent book.
+ * @param defaultAvatarVisualId Built-in fallback used when the source does not declare an avatar visual.
+ * @returns Supported built-in avatar visual id.
+ *
+ * @private shared helper for terminal avatar rendering
+ */
+export declare function resolveTerminalAgentAvatarVisualId(agentSource: string_book, defaultAvatarVisualId?: AvatarVisualId): AvatarVisualId;
+/**
+ * Creates an ANSI ASCII-art avatar renderer for terminal UIs.
+ *
+ * The agent's avatar visual is resolved the same way as on the website: `META AVATAR`
+ * / `META VISUAL` wins, then the provided fallback visual, then the shared default visual.
+ * The terminal variant uses a transparent horizontal canvas instead of the website's framed square surface.
+ *
+ * @param options Agent source, canvas factory, and optional terminal color settings.
+ * @returns Runtime terminal avatar visual renderer.
+ *
+ * @private shared helper for terminal avatar rendering
+ */
+export declare function createTerminalAgentAvatarVisual(options: CreateTerminalAgentAvatarVisualOptions): TerminalAgentAvatarVisual;

package/umd/src/utils/agents/terminalAgentAvatarVisual.test.d.ts

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

package/umd/src/utils/ascii-art/$detectTerminalAnsiColorDepth.d.ts

@@ -0,0 +1,15 @@
+import type { AsciiArtColorDepth } from './convertImageDataToAsciiArt';
+/**
+ * Detects the ANSI color depth supported by the current terminal.
+ *
+ * Prefers 24-bit true color when the environment advertises it (modern terminals such as
+ * Windows Terminal, ConEmu, VS Code, mintty, iTerm2, and WezTerm) and falls back to the
+ * portable 256-color palette otherwise.
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it reads the process environment
+ *
+ * @returns Color depth usable by `convertImageDataToAsciiArt`
+ *
+ * @private within the repository
+ */
+export declare function $detectTerminalAnsiColorDepth(): AsciiArtColorDepth;

package/umd/src/utils/ascii-art/convertImageDataToAsciiArt.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Color depth of the ANSI escape codes emitted by the ASCII-art conversion.
+ *
+ * - `TRUE_COLOR` emits 24-bit `38;2;r;g;b` / `48;2;r;g;b` sequences
+ * - `ANSI_256` approximates colors on the 256-color ANSI cube for older terminals
+ *
+ * @private within the repository
+ */
+export type AsciiArtColorDepth = 'TRUE_COLOR' | 'ANSI_256';
+/**
+ * Minimal structural subset of the DOM `ImageData` accepted by the ASCII-art conversion.
+ *
+ * Works with browser canvas `ImageData`, `@napi-rs/canvas` image data, or any raw RGBA buffer.
+ *
+ * @private within the repository
+ */
+export type AsciiArtImageData = {
+    /**
+     * Source image width in pixels.
+     */
+    readonly width: number;
+    /**
+     * Source image height in pixels.
+     */
+    readonly height: number;
+    /**
+     * Flat RGBA pixel buffer with 4 bytes per pixel.
+     */
+    readonly data: ArrayLike<number>;
+};
+/**
+ * Options for `convertImageDataToAsciiArt`.
+ *
+ * @private within the repository
+ */
+export type ConvertImageDataToAsciiArtOptions = {
+    /**
+     * Source pixels to convert.
+     */
+    readonly imageData: AsciiArtImageData;
+    /**
+     * Output width in terminal character cells.
+     */
+    readonly columns: number;
+    /**
+     * Output height in terminal character cells.
+     *
+     * Each character cell renders two vertically stacked pixels, so `rows = columns / 2`
+     * keeps a square image visually square in a common terminal font.
+     */
+    readonly rows: number;
+    /**
+     * Color depth of the emitted ANSI escape codes.
+     *
+     * @default 'TRUE_COLOR'
+     */
+    readonly colorDepth?: AsciiArtColorDepth;
+    /**
+     * Alpha channel value (0-255) below which an averaged half-cell is treated as fully transparent.
+     *
+     * @default 32
+     */
+    readonly alphaThreshold?: number;
+};
+/**
+ * Converts raw RGBA image pixels into colored ASCII art for ANSI terminals.
+ *
+ * This is the universal image-to-terminal technique used across the repository:
+ * every output character cell covers a rectangular region of source pixels which is
+ * split into a top and bottom half; each half is area-averaged and rendered with
+ * half-block characters (`▀` / `▄`) so one character shows two "pixels" vertically.
+ * Transparent halves keep the terminal background so non-rectangular images
+ * (for example rounded avatar cards) compose naturally into any terminal UI.
+ *
+ * @param options Source pixels, output grid size, and ANSI color depth.
+ * @returns One ANSI-colored string per output row, each ending with a color reset.
+ *
+ * @private within the repository
+ */
+export declare function convertImageDataToAsciiArt(options: ConvertImageDataToAsciiArtOptions): ReadonlyArray<string>;

package/umd/src/utils/color/Color.d.ts

@@ -1,8 +1,8 @@
 import type { string_color } from '../../types/string_person_fullname';
 import type { string_url_image } from '../../types/string_url_image';
 import type { WithTake } from '../take/interfaces/ITakeChain';
-import { CSS_COLORS } from './css-colors';
 import { ColorValue } from './ColorValue';
+import { CSS_COLORS } from './css-colors';
 /**
  * Color object represents an RGB color with alpha channel
  *

package/umd/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.113.0-0`).
+ * It follows semantic versioning (e.g., `0.113.0-10`).
  *
  * @generated
  */

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

@@ -1,12 +0,0 @@
-/**
- * Width of the browser viewport used for live knowledge previews.
- *
- * @private shared constant of Agents Server knowledge previews
- */
-export declare const LIVE_PAGE_PREVIEW_VIEWPORT_WIDTH = 1280;
-/**
- * Height of the browser viewport used for live knowledge previews.
- *
- * @private shared constant of Agents Server knowledge previews
- */
-export declare const LIVE_PAGE_PREVIEW_VIEWPORT_HEIGHT = 800;

package/umd/src/book-components/Chat/utils/livePagePreviewConstants.d.ts

@@ -1,12 +0,0 @@
-/**
- * Width of the browser viewport used for live knowledge previews.
- *
- * @private shared constant of Agents Server knowledge previews
- */
-export declare const LIVE_PAGE_PREVIEW_VIEWPORT_WIDTH = 1280;
-/**
- * Height of the browser viewport used for live knowledge previews.
- *
- * @private shared constant of Agents Server knowledge previews
- */
-export declare const LIVE_PAGE_PREVIEW_VIEWPORT_HEIGHT = 800;