@promptbook/wizard 0.113.0-8 → 0.114.0-0

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

@@ -39,7 +39,7 @@ export type ResolveAgentAvatarOptions = {
  */
 export type ResolveAgentAvatarImageUrlOptions = ResolveAgentAvatarOptions;
 /**
- * Default built-in avatar visual used when an agent does not define `META IMAGE`.
+ * Default built-in avatar visual used when an agent does not define `META IMAGE`, `META AVATAR`, or `META VISUAL`.
  *
  * @private shared avatar contract
  */
@@ -76,7 +76,7 @@ export declare function resolveAgentAvatarVisualId(agent: ResolveAgentAvatarOpti
 export declare function resolveAgentAvatarFallbackUrl(options: ResolveAgentAvatarOptions): string_url_image | null;
 /**
  * Resolve the best avatar representation for an agent, preferring explicit `META IMAGE`
- * and otherwise returning the default deterministic canvas visual.
+ * and otherwise returning the selected deterministic canvas visual.
  *
  * @private utility of `<Chat/>`
  */

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

@@ -0,0 +1,104 @@
+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;
+/**
+ * Centers ANSI-colored terminal avatar lines within one terminal frame.
+ *
+ * @param lines ANSI-colored avatar lines.
+ * @param frameColumns Available frame width in terminal character cells.
+ * @returns Avatar lines with leading terminal spaces added.
+ *
+ * @private shared helper for terminal avatar rendering
+ */
+export declare function centerTerminalAgentAvatarVisualLines(lines: ReadonlyArray<string>, frameColumns: number): ReadonlyArray<string>;
+/**
+ * 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/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/utils/html/escapeHtml.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Escapes text so it can be safely inserted into HTML markup or an HTML attribute.
+ *
+ * @param value - Plain text value.
+ * @returns HTML-safe text.
+ *
+ * @private internal utility for building standalone HTML documents
+ */
+export declare function escapeHtml(value: string): string;

package/umd/src/utils/markdown/shiftMarkdownHeadingLevels.d.ts

@@ -0,0 +1,15 @@
+import type { string_markdown } from '../../types/string_markdown';
+/**
+ * Moves every heading of a markdown document deeper into the hierarchy.
+ *
+ * This is needed when an independent markdown document is embedded under an
+ * existing heading, so that the merged document keeps one consistent outline.
+ * Headings inside fenced code blocks are left untouched.
+ *
+ * @param markdown - Markdown document to shift.
+ * @param headingLevelShift - How many levels the headings should move down.
+ * @returns Markdown with shifted headings.
+ *
+ * @private internal utility for composing markdown documents
+ */
+export declare function shiftMarkdownHeadingLevels(markdown: string_markdown, headingLevelShift: number): string_markdown;

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-5`).
+ * It follows semantic versioning (e.g., `0.113.1-0`).
  *
  * @generated
  */

package/esm/src/book-2.0/book-language-documentation/bookLanguageCommonPitfalls.d.ts

@@ -1,25 +0,0 @@
-/**
- * One practical "don't vs do" pitfall item for Book language authoring.
- *
- * @private internal utility of `createStandaloneBookLanguageMarkdown`
- */
-export type BookLanguageCommonPitfall = {
-    /**
-     * Short pitfall title.
-     */
-    readonly title: string;
-    /**
-     * Description of what to avoid.
-     */
-    readonly dont: string;
-    /**
-     * Practical corrective action.
-     */
-    readonly doInstead: string;
-};
-/**
- * Common anti-patterns with practical fixes.
- *
- * @private internal utility of `createStandaloneBookLanguageMarkdown`
- */
-export declare const bookLanguageCommonPitfalls: ReadonlyArray<BookLanguageCommonPitfall>;

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

@@ -1,6 +0,0 @@
-/**
- * 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/umd/src/book-2.0/book-language-documentation/bookLanguageCommonPitfalls.d.ts

@@ -1,25 +0,0 @@
-/**
- * One practical "don't vs do" pitfall item for Book language authoring.
- *
- * @private internal utility of `createStandaloneBookLanguageMarkdown`
- */
-export type BookLanguageCommonPitfall = {
-    /**
-     * Short pitfall title.
-     */
-    readonly title: string;
-    /**
-     * Description of what to avoid.
-     */
-    readonly dont: string;
-    /**
-     * Practical corrective action.
-     */
-    readonly doInstead: string;
-};
-/**
- * Common anti-patterns with practical fixes.
- *
- * @private internal utility of `createStandaloneBookLanguageMarkdown`
- */
-export declare const bookLanguageCommonPitfalls: ReadonlyArray<BookLanguageCommonPitfall>;

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

@@ -1,6 +0,0 @@
-/**
- * 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;