ansimax 1.2.8 → 1.3.1

package/dist/index.d.ts

@@ -359,7 +359,7 @@ declare const sliceAnsi: (str: string, start: number, end?: number) => string;
 declare const truncateAnsi: (str: string, width: number, ellipsis?: string) => string;
 declare const padEnd: (str: string, width: number, ch?: string) => string;
 declare const padStart: (str: string, width: number, ch?: string) => string;
-declare const center: (str: string, width: number, ch?: string) => string;
+declare const center$1: (str: string, width: number, ch?: string) => string;
 /** Repeats a string until its visible length reaches the target width. */
 declare const repeatVisible: (str: string, width: number) => string;
 /**
@@ -1904,6 +1904,352 @@ declare const clearThemeColorCache: () => void;
  */
 declare const themes: ThemeInstance;
 
+/**
+ * ansimax — panels module
+ * ─────────────────────────────────────────────
+ *
+ * Split layouts for composing terminal UIs: hsplit (top/bottom) and
+ * vsplit (left/right). Both operate on already-rendered string blocks
+ * (typically from `ascii.box`, `components.table`, etc.) and handle:
+ *
+ *   • ANSI-aware width measurement
+ *   • Variable height (each block keeps its own line count)
+ *   • Alignment within columns
+ *   • Configurable gap between blocks
+ *   • Nesting (panels can contain panels)
+ *
+ * Philosophy: panels do composition, not styling. Style your blocks
+ * first (with `ascii.box`, `components.timeline`, etc.), then compose
+ * them with `panels.hsplit` / `panels.vsplit`.
+ */
+type Alignment = 'start' | 'center' | 'end';
+interface VsplitOptions {
+    /** Horizontal gap (in space characters) between columns. Default `1`. */
+    gap?: number;
+    /**
+     * Vertical alignment of shorter blocks within the joined column row.
+     * `'start'` (default) keeps blocks top-aligned; shorter blocks have
+     * padding below. `'center'` centers each block. `'end'` aligns to bottom.
+     */
+    align?: Alignment;
+    /**
+     * Pad each block with spaces to a fixed width. Useful for grids where
+     * each cell should be the same size regardless of content.
+     * If omitted, each column uses its natural max-line width.
+     */
+    widths?: number[] | null;
+}
+interface HsplitOptions {
+    /** Vertical gap (in blank lines) between rows. Default `0`. */
+    gap?: number;
+    /**
+     * Horizontal alignment of narrower blocks within the joined width.
+     * `'start'` (default) keeps blocks left-aligned. `'center'` and `'end'`
+     * pad with spaces on the appropriate side.
+     */
+    align?: Alignment;
+}
+/**
+ * Split blocks side-by-side (left / right / right ...).
+ *
+ * Each block is split into lines, then joined column-by-column with a
+ * configurable gap. Shorter blocks are padded to match the tallest one.
+ *
+ * @param blocks - Pre-rendered string blocks (multi-line OK).
+ * @param opts   - Layout options.
+ *
+ * @example basic two-column layout
+ * ```js
+ * import { panels, ascii } from 'ansimax';
+ *
+ * console.log(panels.vsplit([
+ *   ascii.box('Left side',  { borderStyle: 'rounded' }),
+ *   ascii.box('Right side', { borderStyle: 'rounded' }),
+ * ], { gap: 2 }));
+ * ```
+ *
+ * @example three columns with centered vertical alignment
+ * ```js
+ * console.log(panels.vsplit([
+ *   'Short',
+ *   'A\nMedium\nblock',
+ *   'A\nlonger\nblock\nwith\nfive lines',
+ * ], { align: 'center', gap: 4 }));
+ * ```
+ *
+ * @example fixed column widths (grid-like)
+ * ```js
+ * console.log(panels.vsplit([col1, col2, col3], {
+ *   widths: [20, 30, 20],
+ *   gap: 2,
+ * }));
+ * ```
+ */
+declare const vsplit: (blocks: string[], opts?: VsplitOptions) => string;
+/**
+ * Stack blocks vertically (top / bottom / bottom ...).
+ *
+ * Each block is concatenated with `\n` between them. With `gap > 0`,
+ * additional blank lines are inserted between blocks.
+ *
+ * @param blocks - Pre-rendered string blocks (multi-line OK).
+ * @param opts   - Layout options.
+ *
+ * @example basic stacking
+ * ```js
+ * import { panels, ascii } from 'ansimax';
+ *
+ * console.log(panels.hsplit([
+ *   '── Header ──',
+ *   ascii.box('Body content', { borderStyle: 'rounded' }),
+ *   '── Footer ──',
+ * ]));
+ * ```
+ *
+ * @example with vertical gap + centered alignment
+ * ```js
+ * console.log(panels.hsplit([
+ *   'Top',
+ *   ascii.box('Middle'),
+ *   'Bottom',
+ * ], { gap: 1, align: 'center' }));
+ * ```
+ *
+ * @example nested (an hsplit inside a vsplit)
+ * ```js
+ * const sidebar = ascii.box('Sidebar', { width: 20 });
+ * const main    = ascii.box('Main content area', { width: 40 });
+ *
+ * console.log(panels.hsplit([
+ *   '── Application ──',
+ *   panels.vsplit([sidebar, main], { gap: 2 }),
+ *   '── End ──',
+ * ]));
+ * ```
+ */
+declare const hsplit: (blocks: string[], opts?: HsplitOptions) => string;
+interface CenterOptions {
+    /** Total width to center within. Required. */
+    width: number;
+    /**
+     * Vertical alignment if `height` is also specified.
+     * Default `'start'`.
+     */
+    align?: Alignment;
+    /**
+     * Total height to fit the block into. Optional — if omitted, only
+     * horizontal centering is applied.
+     */
+    height?: number;
+}
+/**
+ * Center a multi-line block horizontally (and optionally vertically)
+ * within a given width/height. Each line is padded with spaces on both
+ * sides; ANSI escapes are preserved.
+ *
+ * @example horizontal centering only
+ * ```js
+ * import { panels } from 'ansimax';
+ *
+ * console.log(panels.center('Hello!', { width: 30 }));
+ * //                "            Hello!            "
+ * ```
+ *
+ * @example multi-line centered in a fixed area
+ * ```js
+ * console.log(panels.center('Line 1\nLine 2\nLine 3', {
+ *   width: 30,
+ *   height: 7,
+ *   align: 'center',
+ * }));
+ * ```
+ *
+ * @example combined with box for a centered card
+ * ```js
+ * import { ascii, panels } from 'ansimax';
+ *
+ * console.log(panels.center(ascii.box('Hello'), { width: 80 }));
+ * // Box appears centered in a 80-wide terminal
+ * ```
+ */
+declare const center: (block: string, opts: CenterOptions) => string;
+interface FrameOptions {
+    /**
+     * Padding (in spaces) between the block content and the inner edge of
+     * the frame. Default `0`.
+     */
+    padding?: number;
+    /**
+     * Padding above + below the block. If unset, falls back to `padding`.
+     */
+    paddingY?: number;
+    /**
+     * Padding left + right of the block. If unset, falls back to `padding`.
+     */
+    paddingX?: number;
+    /**
+     * Top decoration character — e.g. `'─'`, `'═'`, `'━'`, `'·'`.
+     * Default `'─'`.
+     */
+    topChar?: string;
+    /**
+     * Bottom decoration character. Default same as `topChar`.
+     */
+    bottomChar?: string;
+    /**
+     * Optional title shown centered in the top edge.
+     */
+    title?: string;
+}
+/**
+ * Add decorative top/bottom rule lines around a block (lighter than `ascii.box`
+ * which draws four sides). Useful for visual separation without full borders.
+ *
+ * @example simple top/bottom rules
+ * ```js
+ * console.log(panels.frame('Hello world!'));
+ * // ─────────────
+ * // Hello world!
+ * // ─────────────
+ * ```
+ *
+ * @example with title and padding
+ * ```js
+ * console.log(panels.frame('Body content\nMore content', {
+ *   title: 'Header',
+ *   padding: 1,
+ * }));
+ * // ───── Header ─────
+ * //
+ * //  Body content
+ * //  More content
+ * //
+ * // ──────────────────
+ * ```
+ *
+ * @example custom decorations
+ * ```js
+ * console.log(panels.frame('Important!', {
+ *   topChar: '═',
+ *   bottomChar: '═',
+ *   padding: 2,
+ * }));
+ * ```
+ */
+declare const frame: (block: string, opts?: FrameOptions) => 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;
+};
+
+/**
+ * ansimax — json module
+ * ─────────────────────────────────────────────
+ *
+ * Colored JSON / YAML pretty-printer for terminal display.
+ *
+ * Features:
+ *   • Configurable indent
+ *   • Color-coded by value type (string, number, boolean, null, key)
+ *   • Max depth with collapse marker (`{...}` / `[...]`)
+ *   • Circular reference detection (avoids infinite recursion)
+ *   • ANSI cleanly disabled in NO_COLOR / non-TTY environments
+ *
+ * Philosophy: data → human-readable text. Not a parser, not a validator —
+ * just pretty rendering of in-memory JS values.
+ */
+interface PrettyOptions {
+    /** Indent width in spaces. Default `2`. */
+    indent?: number;
+    /**
+     * Apply ANSI colors to keys/values. Default `true`. Auto-disabled when
+     * `NO_COLOR` is set or output is non-TTY.
+     */
+    colors?: boolean;
+    /**
+     * Maximum nesting depth. Objects/arrays beyond this level are collapsed
+     * to `{...}` / `[...]`. Default `Infinity` (no limit).
+     */
+    maxDepth?: number;
+    /**
+     * Maximum array length to display fully. Arrays longer than this show
+     * the first N items + a `... (M more)` marker. Default `Infinity`.
+     */
+    maxItems?: number;
+    /**
+     * Maximum string length before truncation with ellipsis. Default `Infinity`.
+     */
+    maxStringLength?: number;
+    /**
+     * Sort object keys alphabetically. Useful for deterministic diffs (e.g.,
+     * comparing two JSON snapshots) and for visual scanning of large objects.
+     * Default `false` (insertion order preserved).
+     *
+     * @since 1.3.1
+     */
+    sortKeys?: boolean;
+    /**
+     * Arrays of primitives shorter than this character width (in their
+     * rendered form) are displayed on a single line: `[1, 2, 3]` instead of
+     * three lines. Nested objects/arrays never inline regardless of size.
+     * Set to `0` to disable inlining. Default `60`.
+     *
+     * @since 1.3.1
+     */
+    inlineArrayMaxLength?: number;
+}
+/**
+ * Pretty-print a JavaScript value with colored output suitable for
+ * terminal display. Handles primitives, objects, arrays, and circular
+ * references gracefully.
+ *
+ * @param value - Any JavaScript value to render.
+ * @param opts  - Optional formatting configuration.
+ *
+ * @example basic
+ * ```js
+ * import { json } from 'ansimax';
+ *
+ * console.log(json.pretty({
+ *   name: 'ansimax',
+ *   version: '1.3.0',
+ *   features: ['colors', 'gradients', 'panels'],
+ *   stats: { tests: 2000, coverage: 0.98 },
+ * }));
+ * ```
+ *
+ * @example with depth limit (collapses deeply nested objects)
+ * ```js
+ * console.log(json.pretty(deeplyNestedObject, { maxDepth: 2 }));
+ * // Anything beyond depth 2 renders as {...} or [...]
+ * ```
+ *
+ * @example with item limit (for huge arrays)
+ * ```js
+ * console.log(json.pretty(largeArray, { maxItems: 10 }));
+ * // Shows first 10 items + "... (N more)"
+ * ```
+ *
+ * @example monochrome (e.g. for log files)
+ * ```js
+ * console.log(json.pretty(data, { colors: false }));
+ * ```
+ *
+ * @example handles circular references
+ * ```js
+ * const obj = { name: 'foo' };
+ * obj.self = obj;  // circular!
+ * console.log(json.pretty(obj));
+ * // → { "name": "foo", "self": [Circular] }
+ * ```
+ */
+declare const pretty: (value: unknown, opts?: PrettyOptions) => string;
+declare const json: {
+    pretty: (value: unknown, opts?: PrettyOptions) => string;
+};
+
 declare const ansimax: {
     color: {
         black: ColorFn;
@@ -2070,4 +2416,4 @@ declare const ansimax: {
     configure: (opts?: AnsimaxConfig, meta?: ConfigureOptions) => void;
 };
 
-export { ASCII_RAMPS, 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 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 FromImageOptions, type GlitchOptions, type Glyph, type GradientOptions, type GradientRectOptions, 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 WalkVisitor, type WaveOptions, type WriteAsyncOptions, animate, animateGradient, ascii, bell, bg256, bgRgb, box, canAnimate, cancelTerminalFrame, center, 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, frames, fromImage, getConfig, getConfigValue, getRenderCacheSize, getSpeedMultiplier, getTerminalHeight, getTerminalWidth, gradient, gradientColor, gradientRect, graphemes, hasFont, hexToRgb, hideCursor, images, isHexColor, isNoColor, lerp, lerpColor, link, listFonts, listPresets, loader, mapTree, measureTree, memoize, nextTick, onConfigChange, onConfigKeyChange, onResize, once, padBoth, padEnd, padStart, 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, 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 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 };