ansimax 1.3.1 → 1.3.3

package/dist/index.d.ts

@@ -960,7 +960,82 @@ interface RenderOptions$1 {
     /** Use braille (2×4 sub-char resolution). Overrides halfBlock. */
     braille?: boolean;
 }
+/**
+ * Render a 2D grid of pixels (`{r, g, b, a?}` objects) as terminal output
+ * using half-block characters (`▀`) to fit two vertical pixels per row.
+ * This doubles vertical resolution compared to one-character-per-pixel.
+ *
+ * @param pixels - 2D grid of pixel objects.
+ * @param opts   - Render options (scale, background, etc.).
+ *
+ * @example basic pixel art
+ * ```js
+ * import { renderPixelArt } from 'ansimax';
+ *
+ * const heart = [
+ *   [null, {r:255,g:0,b:0}, null, {r:255,g:0,b:0}, null],
+ *   [{r:255,g:0,b:0}, {r:255,g:0,b:0}, {r:255,g:0,b:0}, {r:255,g:0,b:0}, {r:255,g:0,b:0}],
+ *   [{r:255,g:0,b:0}, {r:255,g:0,b:0}, {r:255,g:0,b:0}, {r:255,g:0,b:0}, {r:255,g:0,b:0}],
+ *   [null, {r:255,g:0,b:0}, {r:255,g:0,b:0}, {r:255,g:0,b:0}, null],
+ *   [null, null, {r:255,g:0,b:0}, null, null],
+ * ];
+ *
+ * console.log(renderPixelArt(heart));
+ * ```
+ *
+ * @example with scale (each pixel rendered as multiple chars)
+ * ```js
+ * console.log(renderPixelArt(myPixels, { scale: 2 }));
+ * // Each pixel becomes 2x2 in the output
+ * ```
+ *
+ * @example with background color (transparent pixels show through)
+ * ```js
+ * console.log(renderPixelArt(myPixels, {
+ *   background: { r: 30, g: 30, b: 30 },
+ * }));
+ * ```
+ *
+ * @example combined with a sprite from SPRITES
+ * ```js
+ * import { renderPixelArt, SPRITES } from 'ansimax';
+ *
+ * console.log(renderPixelArt(SPRITES.heart.pixels, { scale: 3 }));
+ * ```
+ */
 declare const renderPixelArt: (pixels: PixelGrid, opts?: RenderOptions$1) => string;
+/**
+ * Built-in sprite library — small pre-defined pixel art ready for use.
+ *
+ * Each entry has a `pixels` property containing a `PixelGrid`.
+ *
+ * Currently available: `heart`, `star`, `arrow`, `check`, `x`, `bell`,
+ * `gear`, `bolt`, `flag`, `crown`.
+ *
+ * @example render a built-in sprite
+ * ```js
+ * import { renderPixelArt, SPRITES } from 'ansimax';
+ *
+ * console.log(renderPixelArt(SPRITES.heart.pixels));
+ * console.log(renderPixelArt(SPRITES.star.pixels, { scale: 2 }));
+ * ```
+ *
+ * @example list all available sprites
+ * ```js
+ * console.log('Available sprites:', Object.keys(SPRITES).join(', '));
+ * ```
+ *
+ * @example compose sprites on a canvas
+ * ```js
+ * import { createCanvas, SPRITES } from 'ansimax';
+ *
+ * const canvas = createCanvas(30, 10);
+ * canvas.drawSprite(2,  2, SPRITES.heart.pixels);
+ * canvas.drawSprite(10, 2, SPRITES.star.pixels);
+ * canvas.drawSprite(18, 2, SPRITES.crown.pixels);
+ * canvas.print();
+ * ```
+ */
 declare const SPRITES: Record<string, {
     pixels: PixelGrid;
 }>;
@@ -985,6 +1060,78 @@ interface GradientRectOptions {
     /** Render in braille mode for 2× horizontal × 4× vertical resolution. */
     braille?: boolean;
 }
+/**
+ * Render a rectangle filled with a multi-color gradient. Supports horizontal,
+ * vertical, diagonal, arbitrary-angle, radial, and conic gradient styles.
+ *
+ * @param opts - Configuration: dimensions, colors, style, dithering.
+ *
+ * @example horizontal gradient (default)
+ * ```js
+ * import { gradientRect } from 'ansimax';
+ *
+ * console.log(gradientRect({
+ *   width: 40, height: 10,
+ *   colors: ['#ff0000', '#0000ff'],
+ * }));
+ * ```
+ *
+ * @example vertical gradient with multiple stops
+ * ```js
+ * console.log(gradientRect({
+ *   width: 30, height: 15,
+ *   colors: ['#ff0000', '#ffff00', '#00ff00', '#0000ff'],
+ *   style: 'vertical',
+ * }));
+ * ```
+ *
+ * @example arbitrary angle (45° = bottom-left to top-right)
+ * ```js
+ * console.log(gradientRect({
+ *   width: 40, height: 20,
+ *   colors: ['#bd93f9', '#ff79c6'],
+ *   style: 'diagonal',
+ *   angle: 45,
+ * }));
+ * ```
+ *
+ * @example radial gradient (center to edge)
+ * ```js
+ * console.log(gradientRect({
+ *   width: 30, height: 15,
+ *   colors: ['#ffffff', '#000000'],
+ *   style: 'radial',
+ * }));
+ * ```
+ *
+ * @example conic (rainbow wheel) — v1.2.0+
+ * ```js
+ * console.log(gradientRect({
+ *   width: 30, height: 15,
+ *   colors: ['#ff0000', '#ffff00', '#00ff00', '#00ffff', '#0000ff', '#ff00ff', '#ff0000'],
+ *   style: 'conic',
+ *   startAngle: 0,
+ * }));
+ * ```
+ *
+ * @example with Bayer dithering for smoother tonal transitions
+ * ```js
+ * console.log(gradientRect({
+ *   width: 60, height: 20,
+ *   colors: ['#000033', '#ffcc00'],
+ *   dither: 'bayer',
+ * }));
+ * ```
+ *
+ * @example braille mode (4× vertical resolution per cell)
+ * ```js
+ * console.log(gradientRect({
+ *   width: 60, height: 30,
+ *   colors: ['#ff0000', '#0000ff'],
+ *   braille: true,
+ * }));
+ * ```
+ */
 declare const gradientRect: (opts?: GradientRectOptions) => string;
 interface CanvasRenderOptions extends RenderOptions$1 {
     /** Render only the dirty region instead of the whole canvas. Default: false. */
@@ -1011,6 +1158,61 @@ interface Canvas {
     /** Deep copy of the current pixel grid. Mutations don't affect the canvas. */
     pixels: PixelGrid;
 }
+/**
+ * Create a mutable in-memory canvas with drawing primitives (line, rect,
+ * circle, sprite). The canvas tracks dirty regions so subsequent renders
+ * can update only changed pixels (useful for animation).
+ *
+ * @param width     - Canvas width in pixels (1 to MAX_DIMENSION).
+ * @param height    - Canvas height in pixels (1 to MAX_DIMENSION).
+ * @param fillColor - Initial fill (`null` for transparent). Default `null`.
+ * @returns A Canvas object with drawing methods.
+ *
+ * @example draw and render a simple scene
+ * ```js
+ * import { createCanvas } from 'ansimax';
+ *
+ * const canvas = createCanvas(40, 20, { r: 20, g: 20, b: 30 });
+ *
+ * canvas.drawRect(5, 5, 30, 10, { r: 100, g: 200, b: 255 }, true);
+ * canvas.drawCircle(20, 10, 4, { r: 255, g: 200, b: 0 }, true);
+ * canvas.drawLine(0, 0, 39, 19, { r: 255, g: 0, b: 100 });
+ *
+ * canvas.print();  // render and write to stdout
+ * ```
+ *
+ * @example animated frame with dirty-region tracking
+ * ```js
+ * const canvas = createCanvas(60, 30);
+ *
+ * for (let frame = 0; frame < 100; frame++) {
+ *   canvas.setPixel(frame % 60, 15, { r: 255, g: 0, b: 0 });
+ *
+ *   // Only re-render changed pixels (much faster than full redraw)
+ *   process.stdout.write(canvas.render({ dirtyOnly: true }));
+ *   await new Promise(r => setTimeout(r, 50));
+ * }
+ * ```
+ *
+ * @example composite sprites
+ * ```js
+ * import { createCanvas, SPRITES } from 'ansimax';
+ *
+ * const canvas = createCanvas(40, 20);
+ * canvas.drawSprite(5, 5, SPRITES.heart.pixels);
+ * canvas.drawSprite(20, 5, SPRITES.star.pixels);
+ * canvas.print();
+ * ```
+ *
+ * @example resize while preserving content
+ * ```js
+ * const canvas = createCanvas(20, 10, { r: 50, g: 50, b: 50 });
+ * canvas.drawCircle(10, 5, 3, { r: 255, g: 0, b: 0 });
+ *
+ * canvas.resize(40, 20);  // existing pixels remain in upper-left
+ * canvas.print();
+ * ```
+ */
 declare const createCanvas: (width: number, height: number, fillColor?: Pixel) => Canvas;
 declare const images: {
     render: (pixels: PixelGrid, opts?: RenderOptions$1) => string;
@@ -1077,6 +1279,20 @@ interface BoxOptions {
     borderStyle?: BoxStyle;
     /** Fix inner content width. Lines are padded/truncated to fit. */
     width?: number | null;
+    /**
+     * Optional title shown in the top border, e.g. `─ Title ─────`.
+     * When set, the box expands to fit the title if content is narrower.
+     *
+     * @since 1.3.3
+     */
+    title?: string | null;
+    /**
+     * Title alignment in the top border: `'left'` | `'center'` (default) | `'right'`.
+     * Only applies when `title` is set.
+     *
+     * @since 1.3.3
+     */
+    titleAlign?: 'left' | 'center' | 'right';
 }
 interface BannerOptions {
     font?: FontName | string;
@@ -1092,6 +1308,13 @@ interface DividerOptions {
     width?: number | null;
     label?: string | null;
     style?: BoxStyle;
+    /**
+     * Label alignment: `'left'` | `'center'` (default) | `'right'`.
+     * Only applies when `label` is set.
+     *
+     * @since 1.3.3
+     */
+    align?: 'left' | 'center' | 'right';
 }
 interface LogoOptions {
     gradient?: ColorFn | null;
@@ -2097,9 +2320,16 @@ interface FrameOptions {
      */
     bottomChar?: string;
     /**
-     * Optional title shown centered in the top edge.
+     * Optional title shown in the top edge.
      */
     title?: string;
+    /**
+     * Title alignment: `'left'` | `'center'` (default) | `'right'`.
+     * Only applies when `title` is set.
+     *
+     * @since 1.3.3
+     */
+    titleAlign?: 'left' | 'center' | 'right';
 }
 /**
  * Add decorative top/bottom rule lines around a block (lighter than `ascii.box`
@@ -2137,11 +2367,71 @@ interface FrameOptions {
  * ```
  */
 declare const frame: (block: string, opts?: FrameOptions) => string;
+interface GridOptions {
+    /** Number of columns. Required. */
+    columns: number;
+    /** Horizontal gap between cells. Default `1`. */
+    gapX?: number;
+    /** Vertical gap between rows. Default `0`. */
+    gapY?: number;
+    /** Horizontal alignment of content within each cell. Default `'start'`. */
+    alignX?: Alignment;
+    /** Vertical alignment of content within each cell. Default `'start'`. */
+    alignY?: Alignment;
+    /**
+     * Fix each cell to this width (in visible characters). If omitted, cells
+     * use the max width of the widest block in their column.
+     */
+    cellWidth?: number | null;
+}
+/**
+ * Arrange blocks in a grid of N columns, flowing left-to-right then
+ * top-to-bottom. Each row is auto-sized to its tallest block, and each
+ * column is auto-sized to its widest block (unless `cellWidth` is fixed).
+ *
+ * Internally uses `vsplit` for rows + `hsplit` for the column stack, so
+ * all alignment + ANSI rules behave consistently.
+ *
+ * @param blocks - Pre-rendered string blocks. Flows in reading order.
+ * @param opts   - Grid configuration. `columns` is required.
+ *
+ * @example 2×2 grid of stats cards
+ * ```js
+ * import { panels, ascii } from 'ansimax';
+ *
+ * const cards = [
+ *   ascii.box('FILES\n42',   { borderStyle: 'rounded', padding: 1 }),
+ *   ascii.box('LINES\n1247', { borderStyle: 'rounded', padding: 1 }),
+ *   ascii.box('TESTS\n38',   { borderStyle: 'rounded', padding: 1 }),
+ *   ascii.box('COV\n98%',    { borderStyle: 'rounded', padding: 1 }),
+ * ];
+ *
+ * console.log(panels.grid(cards, { columns: 2, gapX: 2, gapY: 1 }));
+ * ```
+ *
+ * @example 3-column gallery with auto-flow
+ * ```js
+ * // 7 items in 3 columns → 3 rows: [3, 3, 1]
+ * const items = ['One', 'Two', 'Three', 'Four', 'Five', 'Six', 'Seven'];
+ * console.log(panels.grid(items, { columns: 3, gapX: 4 }));
+ * ```
+ *
+ * @example uniform cell width for visual consistency
+ * ```js
+ * console.log(panels.grid(blocks, {
+ *   columns: 4,
+ *   cellWidth: 15,
+ *   alignX: 'center',
+ * }));
+ * ```
+ */
+declare const grid: (blocks: string[], opts: GridOptions) => string;
 declare const panels: {
     vsplit: (blocks: string[], opts?: VsplitOptions) => string;
     hsplit: (blocks: string[], opts?: HsplitOptions) => string;
     center: (block: string, opts: CenterOptions) => string;
     frame: (block: string, opts?: FrameOptions) => string;
+    grid: (blocks: string[], opts: GridOptions) => string;
 };
 
 /**
@@ -2199,6 +2489,23 @@ interface PrettyOptions {
      * @since 1.3.1
      */
     inlineArrayMaxLength?: number;
+    /**
+     * Output mode controls what kind of string is produced:
+     *
+     * - `'display'` (default) — terminal-friendly output with colors (when
+     *   enabled) and informational placeholders like `[Circular]`,
+     *   `[Function: name]`, `Symbol(x)`, `Map(2) {...}`, `Set(3) {...}`,
+     *   `Date(2026-06-13T...)`, `BigInt(123n)`. Not parseable as JSON.
+     *
+     * - `'json'` — strict, parseable JSON output. Colors are forced off,
+     *   circular references throw `TypeError`, and types not representable
+     *   in JSON (functions, symbols, undefined) are omitted from objects /
+     *   replaced with `null` in arrays. Map/Set are converted to objects/arrays.
+     *   Dates become ISO strings. BigInt becomes a number (or string if too large).
+     *
+     * @since 1.3.3
+     */
+    mode?: 'display' | 'json';
 }
 /**
  * Pretty-print a JavaScript value with colored output suitable for
@@ -2416,4 +2723,4 @@ declare const ansimax: {
     configure: (opts?: AnsimaxConfig, meta?: ConfigureOptions) => void;
 };
 
-export { ASCII_RAMPS, type Alignment, type AnimateGradientController, type AnimateGradientOptions, type AnimationHooks, type AnimationSpeed, type AnsiCode, type AnsimaxConfig, type AsciiRamp, BEL, BG, type BadgeOptions, type BallOptions, type BannerOptions, type BoxOptions, type BoxStyle, type BreatheOptions, DEFAULTS as CONFIG_DEFAULTS, CSI, type Canvas, type CanvasRenderOptions, type CenterOptions, type ColorChain, type ColorFn, type ColorLevel, type ColorMode, type ColorSupport, type ColumnsOptions, type ConfigChangeListener, type ConfigKey, type ConfigKeyListener, type ConfigureOptions, type CountdownOptions, type CustomOptions, DEFAULT_TERM_COLS, DEFAULT_TERM_ROWS, type DebounceOptions, type DiffType, type Dimensions, type DividerOptions, type DotsOptions, ESC, type EasingFn, type EasingName, type EraseMode, FG, FRAME_MS, type FadeOptions, type FigletFont, type FigletOptions, type FontMap, type FontName, type FrameCallback, type FrameHandle, type FrameOptions, type FromImageOptions, type GlitchOptions, type Glyph, type GradientOptions, type GradientRectOptions, type HsplitOptions, type PrettyOptions as JsonPrettyOptions, type LineDiff, type LiveController, type LiveOptions, type LoadingBarOptions, type LogoOptions, MENU_CANCELLED, type MemoizeOptions, type MenuInput, type MenuOptions, type MenuOutput, type MenuResult, type MultiLoader, type MultiLoaderItem, OSC, type OnResizeOptions, type OutputBuffer, type ParallelOptions, type ParallelStep, type Pixel, type PixelGrid, type PlayController, type PlayOptions, type PresetName, type ProgressAnimateOptions, type ProgressBarOptions, type ProgressOptions, type PulseOptions, type RGB, type RGBA, type RegisterFontOptions, type RenderOptions$1 as RenderOptions, type ResizeListener, type ReusableGradient, type RevealOptions, SPINNERS, SPRITES, ST, STYLE, type SectionOptions, type SleepOptions, type SlideOptions, type SpinOptions, type SpinnerType, type StatusOptions, type StatusType, type StopFn, type StreamOptions, type TableBorderStyle, type TableOptions, type Task, type TaskResult, type TasksOptions, type Theme, type BannerOpts as ThemeBannerOpts, type ThemeChangeListener, type ThemeInstance, type ThemeStyleName, type TimelineEvent, type TimelineOptions, type TreeData, type TreeDimensions, type TreeNode, type RenderOptions as TreeRenderOptions, type TreeStyle, type TypeDeleteOptions, type TypewriterOptions, type VsplitOptions, type WalkVisitor, type WaveOptions, type WriteAsyncOptions, animate, animateGradient, ascii, bell, bg256, bgRgb, box, canAnimate, cancelTerminalFrame, center$1 as center, center as centerBlock, chain, charWidth, clamp, clearAnsiCache, clearColorCache, clearRenderCache, clearThemeColorCache, color, colorLevel, presets as colorPresets, components, compose, configure, countNodes, createCanvas, createGradient, createOutputBuffer, createTheme, cursor, debounce, ansimax as default, diffLines, escapeRegex, fg256, fgRgb, figletText, filterTree, findInTree, flipHorizontal, flipVertical, frame, frames, fromImage, getConfig, getConfigValue, getRenderCacheSize, getSpeedMultiplier, getTerminalHeight, getTerminalWidth, gradient, gradientColor, gradientRect, graphemes, hasFont, hexToRgb, hideCursor, hsplit, images, isHexColor, isNoColor, json, pretty as jsonPretty, lerp, lerpColor, link, listFonts, listPresets, loader, mapTree, measureTree, memoize, nextTick, onConfigChange, onConfigKeyChange, onResize, once, padBoth, padEnd, padStart, panels, parseFiglet, pauseListeners, presetNames, presets, rainbow, registerFont, registerPreset, renderPixelArt, renderTree, renderTreeStream, repeatVisible, requestTerminalFrame, reset, resetColorSupportCache, resetConfig, resetCursorRefCount, resetFramesCursorCount, resetLoaderCursorCount, resetNoColor, resumeListeners, reverseGradient, rgbTo256, rgbToHex, rotate90, safeJson, screen, setNoColor, setTitle, sgr, showCursor, sleep, sleepFrame, sliceAnsi, stripAnsi$1 as stripAnsi, stripAnsi$2 as stripAnsiCodes, stripAnsi as stripAnsiColors, supportsColor, supportsColorLevel, termSize, themes, throttle, tree, trees, truncateAnsi, visibleLen, vsplit, walkTree, withConfig, wordWrap, wrapAnsi, write, writeAsync, writeErr, writeln, writelnErr };
+export { ASCII_RAMPS, type Alignment, type AnimateGradientController, type AnimateGradientOptions, type AnimationHooks, type AnimationSpeed, type AnsiCode, type AnsimaxConfig, type AsciiRamp, BEL, BG, type BadgeOptions, type BallOptions, type BannerOptions, type BoxOptions, type BoxStyle, type BreatheOptions, DEFAULTS as CONFIG_DEFAULTS, CSI, type Canvas, type CanvasRenderOptions, type CenterOptions, type ColorChain, type ColorFn, type ColorLevel, type ColorMode, type ColorSupport, type ColumnsOptions, type ConfigChangeListener, type ConfigKey, type ConfigKeyListener, type ConfigureOptions, type CountdownOptions, type CustomOptions, DEFAULT_TERM_COLS, DEFAULT_TERM_ROWS, type DebounceOptions, type DiffType, type Dimensions, type DividerOptions, type DotsOptions, ESC, type EasingFn, type EasingName, type EraseMode, FG, FRAME_MS, type FadeOptions, type FigletFont, type FigletOptions, type FontMap, type FontName, type FrameCallback, type FrameHandle, type FrameOptions, type FromImageOptions, type GlitchOptions, type Glyph, type GradientOptions, type GradientRectOptions, type GridOptions, type HsplitOptions, type PrettyOptions as JsonPrettyOptions, type LineDiff, type LiveController, type LiveOptions, type LoadingBarOptions, type LogoOptions, MENU_CANCELLED, type MemoizeOptions, type MenuInput, type MenuOptions, type MenuOutput, type MenuResult, type MultiLoader, type MultiLoaderItem, OSC, type OnResizeOptions, type OutputBuffer, type ParallelOptions, type ParallelStep, type Pixel, type PixelGrid, type PlayController, type PlayOptions, type PresetName, type ProgressAnimateOptions, type ProgressBarOptions, type ProgressOptions, type PulseOptions, type RGB, type RGBA, type RegisterFontOptions, type RenderOptions$1 as RenderOptions, type ResizeListener, type ReusableGradient, type RevealOptions, SPINNERS, SPRITES, ST, STYLE, type SectionOptions, type SleepOptions, type SlideOptions, type SpinOptions, type SpinnerType, type StatusOptions, type StatusType, type StopFn, type StreamOptions, type TableBorderStyle, type TableOptions, type Task, type TaskResult, type TasksOptions, type Theme, type BannerOpts as ThemeBannerOpts, type ThemeChangeListener, type ThemeInstance, type ThemeStyleName, type TimelineEvent, type TimelineOptions, type TreeData, type TreeDimensions, type TreeNode, type RenderOptions as TreeRenderOptions, type TreeStyle, type TypeDeleteOptions, type TypewriterOptions, type VsplitOptions, type WalkVisitor, type WaveOptions, type WriteAsyncOptions, animate, animateGradient, ascii, bell, bg256, bgRgb, box, canAnimate, cancelTerminalFrame, center$1 as center, center as centerBlock, chain, charWidth, clamp, clearAnsiCache, clearColorCache, clearRenderCache, clearThemeColorCache, color, colorLevel, presets as colorPresets, components, compose, configure, countNodes, createCanvas, createGradient, createOutputBuffer, createTheme, cursor, debounce, ansimax as default, diffLines, escapeRegex, fg256, fgRgb, figletText, filterTree, findInTree, flipHorizontal, flipVertical, frame, frames, fromImage, getConfig, getConfigValue, getRenderCacheSize, getSpeedMultiplier, getTerminalHeight, getTerminalWidth, gradient, gradientColor, gradientRect, graphemes, grid, hasFont, hexToRgb, hideCursor, hsplit, images, isHexColor, isNoColor, json, pretty as jsonPretty, lerp, lerpColor, link, listFonts, listPresets, loader, mapTree, measureTree, memoize, nextTick, onConfigChange, onConfigKeyChange, onResize, once, padBoth, padEnd, padStart, panels, parseFiglet, pauseListeners, presetNames, presets, rainbow, registerFont, registerPreset, renderPixelArt, renderTree, renderTreeStream, repeatVisible, requestTerminalFrame, reset, resetColorSupportCache, resetConfig, resetCursorRefCount, resetFramesCursorCount, resetLoaderCursorCount, resetNoColor, resumeListeners, reverseGradient, rgbTo256, rgbToHex, rotate90, safeJson, screen, setNoColor, setTitle, sgr, showCursor, sleep, sleepFrame, sliceAnsi, stripAnsi$1 as stripAnsi, stripAnsi$2 as stripAnsiCodes, stripAnsi as stripAnsiColors, supportsColor, supportsColorLevel, termSize, themes, throttle, tree, trees, truncateAnsi, visibleLen, vsplit, walkTree, withConfig, wordWrap, wrapAnsi, write, writeAsync, writeErr, writeln, writelnErr };