@spectratools/graphic-designer-cli 0.3.1 → 0.4.0

package/dist/index.d.ts

@@ -1,17 +1,42 @@
 import { Cli } from 'incur';
-import { T as ThemeInput, D as DesignSpec, a as Rect, b as DrawCommand, c as Theme, d as RenderedElement } from './spec.schema-BxXBTOn-.js';
-export { A as AutoLayoutConfig, B as BuiltInTheme, C as CardElement, e as CodeBlockElement, f as ConnectionElement, g as ConstraintSpec, h as DEFAULT_GENERATOR_VERSION, i as DEFAULT_RAINBOW_COLORS, j as Decorator, k as DesignSafeFrame, l as DrawBadge, m as DrawBezier, n as DrawCircle, o as DrawFontFamily, p as DrawGradientRect, q as DrawLine, r as DrawPath, s as DrawPoint, t as DrawRect, u as DrawText, E as Element, F as FlowNodeElement, G as Gradient, v as GradientOverlayDecorator, w as GradientSpec, x as GradientStop, y as GridLayoutConfig, I as ImageElement, L as LayoutConfig, z as LayoutSnapshot, M as ManualLayoutConfig, H as RainbowRuleDecorator, R as RenderMetadata, J as RenderResult, S as ShapeElement, K as StackLayoutConfig, N as TerminalElement, O as TextElement, P as ThemeInput, V as VignetteDecorator, W as WrittenArtifacts, Q as builtInThemeBackgrounds, U as builtInThemes, X as computeSpecHash, Y as defaultAutoLayout, Z as defaultCanvas, _ as defaultConstraints, $ as defaultGridLayout, a0 as defaultLayout, a1 as defaultStackLayout, a2 as defaultTheme, a3 as deriveSafeFrame, a4 as designSpecSchema, a5 as drawGradientRect, a6 as drawRainbowRule, a7 as drawVignette, a8 as inferLayout, a9 as inferSidecarPath, aa as parseDesignSpec, ab as renderDesign, ac as resolveTheme, ad as writeRenderArtifacts } from './spec.schema-BxXBTOn-.js';
+import { T as ThemeInput, D as DesignSpec, a as Rect, b as DrawCommand, c as Theme, d as RenderedElement } from './spec.schema-BUTof436.js';
+export { A as AutoLayoutConfig, B as BuiltInTheme, C as CardElement, e as CodeBlockElement, f as ConnectionElement, g as ConstraintSpec, h as DEFAULT_GENERATOR_VERSION, i as DEFAULT_RAINBOW_COLORS, j as Decorator, k as DesignSafeFrame, l as DrawBadge, m as DrawBezier, n as DrawCircle, o as DrawFontFamily, p as DrawGradientRect, q as DrawLine, r as DrawPath, s as DrawPoint, t as DrawRect, u as DrawText, E as Element, F as FlowNodeElement, G as Gradient, v as GradientOverlayDecorator, w as GradientSpec, x as GradientStop, y as GridLayoutConfig, I as ImageElement, L as LayoutConfig, z as LayoutSnapshot, M as ManualLayoutConfig, H as RainbowRuleDecorator, R as RenderMetadata, J as RenderResult, S as ShapeElement, K as StackLayoutConfig, N as TerminalElement, O as TextElement, P as ThemeInput, V as VignetteDecorator, W as WrittenArtifacts, Q as builtInThemeBackgrounds, U as builtInThemes, X as computeSpecHash, Y as defaultAutoLayout, Z as defaultCanvas, _ as defaultConstraints, $ as defaultGridLayout, a0 as defaultLayout, a1 as defaultStackLayout, a2 as defaultTheme, a3 as deriveSafeFrame, a4 as designSpecSchema, a5 as drawGradientRect, a6 as drawRainbowRule, a7 as drawVignette, a8 as inferLayout, a9 as inferSidecarPath, aa as parseDesignSpec, ab as renderDesign, ac as resolveTheme, ad as writeRenderArtifacts } from './spec.schema-BUTof436.js';
 import { SKRSContext2D } from '@napi-rs/canvas';
 export { QaIssue, QaReport, QaSeverity, readMetadata, runQa } from './qa.js';
 import { Highlighter } from 'shiki';
 export { GistPublishOptions, GistPublishResult, GitHubPublishOptions, GitHubPublishResult, publishToGist, publishToGitHub } from './publish/index.js';
 import 'zod';
+import '@spectratools/cli-shared/middleware';
 
 declare const cli: Cli.Cli<{}, undefined, undefined>;
 
 declare const themeToShikiMap: Record<string, string>;
 declare function resolveShikiTheme(theme: ThemeInput): string;
 
+/**
+ * Build a validated {@link DesignSpec} for a flowchart diagram.
+ *
+ * Accepts plain-text node and edge definitions and converts them into
+ * `flow-node` and `connection` elements with automatic ELK-based layout.
+ *
+ * Node tokens use the format `"Label"` or `"Label:shape"` (e.g.
+ * `"Start:pill"`). Edge tokens use `"From->To"` or `"From->To:label"`.
+ *
+ * @param options - Flowchart configuration.
+ * @param options.nodes - Array of node token strings to create.
+ * @param options.edges - Array of edge token strings defining connections.
+ * @param options.title - Optional header title displayed above the flowchart.
+ * @param options.direction - ELK layout direction. Defaults to `"TB"`.
+ * @param options.algorithm - ELK layout algorithm. Defaults to `"layered"`.
+ * @param options.theme - Built-in theme name. Defaults to `"dark"`.
+ * @param options.nodeShape - Default node shape when not specified per-node.
+ *   Defaults to `"rounded-box"`.
+ * @param options.width - Canvas width override in pixels.
+ * @param options.height - Canvas height override in pixels.
+ * @returns A fully validated and parsed {@link DesignSpec}.
+ * @throws When a node token is empty, duplicated, or an edge references an
+ *   unknown node.
+ */
 declare function buildFlowchartSpec(options: {
     nodes: string[];
     edges: string[];
@@ -26,6 +51,31 @@ declare function buildFlowchartSpec(options: {
 
 type WindowControls = 'macos' | 'bw' | 'none';
 
+/**
+ * Build a validated {@link DesignSpec} for a Carbon-style code screenshot.
+ *
+ * Wraps a code snippet in a single `code-block` element with macOS-style window
+ * chrome, drop shadow, and syntax highlighting. The resulting spec uses a
+ * vertical stack layout.
+ *
+ * @param options - Code screenshot configuration.
+ * @param options.code - The source code string to display.
+ * @param options.language - Programming language for syntax highlighting (e.g.
+ *   `"typescript"`).
+ * @param options.title - Optional title shown in the window title bar.
+ * @param options.theme - Built-in theme name. Defaults to `"dark"`.
+ * @param options.showLineNumbers - Whether to render line numbers. Defaults to
+ *   `false`.
+ * @param options.highlightLines - Array of 1-based line numbers to highlight.
+ * @param options.startLine - Starting line number for display. Defaults to `1`.
+ * @param options.width - Canvas width in pixels. Defaults to `800`.
+ * @param options.height - Canvas height in pixels. Defaults to `500`.
+ * @param options.surroundColor - Background colour behind the code window.
+ * @param options.windowControls - Window control style (`"macos"`, `"bw"`, or
+ *   `"none"`). Defaults to `"macos"`.
+ * @param options.scale - Render scale multiplier. Defaults to `2`.
+ * @returns A fully validated and parsed {@link DesignSpec}.
+ */
 declare function buildCodeSpec(options: {
     code: string;
     language: string;
@@ -41,6 +91,31 @@ declare function buildCodeSpec(options: {
     scale?: number;
 }): DesignSpec;
 
+/**
+ * Build a validated {@link DesignSpec} for a terminal screenshot.
+ *
+ * Accepts either raw terminal content or a command/output pair and wraps it in
+ * a single `terminal` element with macOS-style window chrome and a drop shadow.
+ * At least one of `content`, `command`, or `output` must be provided.
+ *
+ * @param options - Terminal screenshot configuration.
+ * @param options.command - Shell command to display (prepended with the prompt).
+ * @param options.output - Command output text.
+ * @param options.content - Raw terminal content — takes precedence over
+ *   `command`/`output` when provided.
+ * @param options.title - Optional window title bar text.
+ * @param options.prompt - Prompt prefix used when rendering `command`. Defaults
+ *   to `"$ "`.
+ * @param options.theme - Built-in theme name. Defaults to `"dark"`.
+ * @param options.width - Canvas width in pixels. Defaults to `800`.
+ * @param options.height - Canvas height in pixels. Defaults to `400`.
+ * @param options.surroundColor - Background colour behind the terminal window.
+ * @param options.windowControls - Window control style (`"macos"`, `"bw"`, or
+ *   `"none"`). Defaults to `"macos"`.
+ * @param options.scale - Render scale multiplier. Defaults to `2`.
+ * @returns A fully validated and parsed {@link DesignSpec}.
+ * @throws When none of `content`, `command`, or `output` is provided.
+ */
 declare function buildTerminalSpec(options: {
     command?: string;
     output?: string;
@@ -55,6 +130,26 @@ declare function buildTerminalSpec(options: {
     scale?: number;
 }): DesignSpec;
 
+/**
+ * Build a validated {@link DesignSpec} for a card grid layout.
+ *
+ * Converts an array of card data into `card` elements arranged in a grid. The
+ * number of columns is inferred from the card count when not specified
+ * explicitly.
+ *
+ * @param options - Card grid configuration.
+ * @param options.cards - Array of card data objects. Each must include `title`
+ *   and `body`; `badge`, `metric`, and `tone` are optional.
+ * @param options.title - Optional header title displayed above the card grid.
+ * @param options.subtitle - Optional header subtitle (only rendered when
+ *   `title` is also set).
+ * @param options.columns - Number of grid columns. When omitted, a heuristic
+ *   chooses based on card count (1–4 columns).
+ * @param options.theme - Built-in theme name. Defaults to `"dark"`.
+ * @param options.width - Canvas width override in pixels.
+ * @param options.height - Canvas height override in pixels.
+ * @returns A fully validated and parsed {@link DesignSpec}.
+ */
 declare function buildCardsSpec(options: {
     cards: Array<{
         title: string;
@@ -88,10 +183,46 @@ type ElkLayoutResult = LayoutResult & {
     edgeRoutes?: Map<string, EdgeRoute>;
 };
 
+/**
+ * Render an array of freestyle draw commands onto a canvas context.
+ *
+ * Supports eight command types: `rect`, `circle`, `text`, `line`, `bezier`,
+ * `path`, `badge`, and `gradient-rect`. Each command is rendered in order and
+ * produces a corresponding {@link RenderedElement} with computed bounds for
+ * downstream QA checks.
+ *
+ * @param ctx - The `@napi-rs/canvas` 2D rendering context to draw into.
+ * @param commands - Array of {@link DrawCommand} objects from the design spec's
+ *   `draw` field.
+ * @param theme - The resolved {@link Theme} used for font resolution and
+ *   default colours.
+ * @returns An array of {@link RenderedElement} entries describing each drawn
+ *   command's bounding box and colours.
+ */
 declare function renderDrawCommands(ctx: SKRSContext2D, commands: DrawCommand[], theme: Theme): RenderedElement[];
 
+/**
+ * Register the bundled font families (Inter, JetBrains Mono, Space Grotesk)
+ * with the global `@napi-rs/canvas` font registry.
+ *
+ * **Must be called before {@link renderDesign}.** Without registered fonts the
+ * canvas will fall back to system defaults, producing inconsistent output across
+ * environments. {@link renderDesign} calls this internally, but consumers using
+ * lower-level APIs (e.g. `renderDrawCommands`) should call it explicitly.
+ *
+ * This function is idempotent — subsequent calls after the first are no-ops.
+ */
 declare function loadFonts(): void;
 
+/**
+ * Initialise (or return the existing) shiki syntax highlighter singleton.
+ *
+ * Loads all bundled themes and languages on first call. Subsequent calls return
+ * the cached instance immediately. Must be called (or allowed to be called
+ * implicitly via {@link highlightCode}) before any syntax highlighting work.
+ *
+ * @returns The shared shiki {@link Highlighter} instance.
+ */
 declare function initHighlighter(): Promise<Highlighter>;
 type HighlightedLine = {
     tokens: Array<{
@@ -99,7 +230,30 @@ type HighlightedLine = {
         color: string;
     }>;
 };
+/**
+ * Tokenise and syntax-highlight a code string.
+ *
+ * Lazily initialises the highlighter via {@link initHighlighter} if it has not
+ * been created yet. Language aliases (e.g. `"ts"` → `"typescript"`) are
+ * resolved automatically.
+ *
+ * @param code - The source code string to highlight.
+ * @param language - Programming language identifier or alias (e.g.
+ *   `"typescript"`, `"ts"`, `"python"`).
+ * @param themeName - Shiki theme name to use for colouring (e.g.
+ *   `"github-dark"`).
+ * @returns An array of {@link HighlightedLine} objects, one per line, each
+ *   containing an array of coloured text tokens.
+ * @throws When the language or theme is not among the bundled set.
+ */
 declare function highlightCode(code: string, language: string, themeName: string): Promise<HighlightedLine[]>;
+/**
+ * Dispose the shared shiki highlighter instance and release its resources.
+ *
+ * After disposal, the next call to {@link initHighlighter} or
+ * {@link highlightCode} will create a fresh instance. Safe to call even when no
+ * highlighter has been initialised (no-op in that case).
+ */
 declare function disposeHighlighter(): void;
 
 export { DesignSpec, DrawCommand, type EdgeRoute, type ElkLayoutResult, type HighlightedLine, type LayoutResult, Rect, RenderedElement, Theme, buildCardsSpec, buildCodeSpec, buildFlowchartSpec, buildTerminalSpec, cli, disposeHighlighter, highlightCode, initHighlighter, loadFonts, renderDrawCommands, resolveShikiTheme, themeToShikiMap };