textmode.export.js 1.9.0-beta.1 → 1.9.0-beta.2

package/dist/types/document/constants.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Canonical format discriminator for textmode document files.
+ *
+ * @see {@link https://code.textmode.art/api/textmode.export.js/variables/TEXTMODE_DOCUMENT_FORMAT | TEXTMODE_DOCUMENT_FORMAT API reference}
+ */
+export declare const TEXTMODE_DOCUMENT_FORMAT: "textmode.document";
+/**
+ * Current textmode document schema revision.
+ *
+ * @see {@link https://code.textmode.art/api/textmode.export.js/variables/TEXTMODE_DOCUMENT_FORMAT_VERSION | TEXTMODE_DOCUMENT_FORMAT_VERSION API reference}
+ */
+export declare const TEXTMODE_DOCUMENT_FORMAT_VERSION: "2.0.0";
+/** Legacy format discriminator accepted by the compatibility decoder. */
+export declare const LEGACY_TEXTMODE_LAYER_FORMAT: "textmode.layer";
+/** Legacy selected-layer schema revision. */
+export declare const LEGACY_TEXTMODE_SELECTED_VERSION: "1.0.0";
+/** Legacy layer-stack schema revision. */
+export declare const LEGACY_TEXTMODE_ALL_VERSION: "1.1.0";
+/**
+ * Canonical dense row encoding used by textmode document v2.
+ *
+ * @see {@link https://code.textmode.art/api/textmode.export.js/variables/TEXTMODE_OBJECT_ROWS_ENCODING | TEXTMODE_OBJECT_ROWS_ENCODING API reference}
+ */
+export declare const TEXTMODE_OBJECT_ROWS_ENCODING: "object-rows-v1";
+/** Default protocol safety limits. Product-specific limits belong to callers. */
+export declare const DEFAULT_TEXTMODE_DOCUMENT_LIMITS: {
+    readonly maxCells: 16777216;
+    readonly maxLayers: 4096;
+    readonly maxLayerIdLength: 1024;
+    readonly maxCharacterLength: 64;
+    readonly maxMetadataStringLength: 4096;
+};

package/dist/types/document/decode-shapes.d.ts

@@ -0,0 +1,4 @@
+import type { DecodeContext, UnknownRecord } from './validation';
+import type { CanonicalTextmodeAllDocument, CanonicalTextmodeSelectedDocument } from './types';
+export declare function decodeSelectedDocument(root: UnknownRecord, context: DecodeContext): CanonicalTextmodeSelectedDocument;
+export declare function decodeAllDocument(root: UnknownRecord, context: DecodeContext): CanonicalTextmodeAllDocument;

package/dist/types/document/decode.d.ts

@@ -0,0 +1,5 @@
+import type { TextmodeDocumentDecodeOptions, TextmodeDocumentDecodeResult, TextmodeDocumentParseResult } from './types';
+/** Decode a parsed JSON value into the canonical textmode document union. */
+export declare function decodeTextmodeDocument(value: unknown, options?: TextmodeDocumentDecodeOptions): TextmodeDocumentDecodeResult;
+/** Parse JSON syntax and decode its value in one convenience call. */
+export declare function parseTextmodeDocumentJSON(json: string, options?: TextmodeDocumentDecodeOptions): TextmodeDocumentParseResult;

package/dist/types/document/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Dependency-free textmode document protocol codec.
+ *
+ * This entry point contains no DOM, renderer, textmode.js, or media encoder
+ * dependencies. It decodes every valid v2 document variant; product-specific
+ * import policy belongs to callers.
+ *
+ * @packageDocumentation
+ */
+export { DEFAULT_TEXTMODE_DOCUMENT_LIMITS, LEGACY_TEXTMODE_ALL_VERSION, LEGACY_TEXTMODE_LAYER_FORMAT, LEGACY_TEXTMODE_SELECTED_VERSION, TEXTMODE_DOCUMENT_FORMAT, TEXTMODE_DOCUMENT_FORMAT_VERSION, TEXTMODE_OBJECT_ROWS_ENCODING, } from './constants';
+export { decodeTextmodeDocument, parseTextmodeDocumentJSON } from './decode';
+export { parseJSON } from './parse';
+export type { CanonicalTextmodeAllDocument, CanonicalTextmodeCell, CanonicalTextmodeCellCollection, CanonicalTextmodeDocument, CanonicalTextmodeDocumentLayer, CanonicalTextmodeSelectedDocument, JSONCellCollection, JSONCellTransform, JSONColorValue, JSONDocumentFormat, JSONDocumentVersion, JSONExportMetadata, JSONExportTarget, JSONLayerGrid, JSONObjectRowCell, JSONObjectRowsCellCollection, JSONParseResult, JSONRGBAColor, LegacyTextmodeAllDocumentJSON, LegacyTextmodeSelectedDocumentJSON, TextmodeAllDocumentJSON, TextmodeDocumentDecodeOptions, TextmodeDocumentDecodeResult, TextmodeDocumentCell, TextmodeDocumentCellCollection, TextmodeDocumentCellTransform, TextmodeDocumentColor, TextmodeDocumentError, TextmodeDocumentErrorCode, TextmodeDocumentFormat, TextmodeDocumentGrid, TextmodeDocumentJSON, TextmodeDocumentLayer, TextmodeDocumentLimits, TextmodeDocumentMetadata, TextmodeDocumentParseResult, TextmodeDocumentRGBAColor, TextmodeDocumentTarget, TextmodeDocumentVersion, TextmodeDocumentWarning, TextmodeSelectedDocumentJSON, TextmodeSelectedDocumentLayer, } from './types';

package/dist/types/document/parse.d.ts

@@ -0,0 +1,3 @@
+import type { JSONParseResult } from './types';
+/** Parse JSON syntax once before routing the resulting value by discriminator. */
+export declare function parseJSON(json: string): JSONParseResult;

package/dist/types/document/types.d.ts

@@ -0,0 +1,209 @@
+import type { LEGACY_TEXTMODE_ALL_VERSION, LEGACY_TEXTMODE_LAYER_FORMAT, LEGACY_TEXTMODE_SELECTED_VERSION, TEXTMODE_DOCUMENT_FORMAT, TEXTMODE_DOCUMENT_FORMAT_VERSION, TEXTMODE_OBJECT_ROWS_ENCODING } from './constants';
+/**
+ * Scope encoded by a textmode document.
+ *
+ * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/TextmodeDocumentTarget | TextmodeDocumentTarget API reference}
+ */
+export type TextmodeDocumentTarget = 'selected' | 'all';
+/** Format discriminator encoded in a document. */
+export type TextmodeDocumentFormat = typeof TEXTMODE_DOCUMENT_FORMAT;
+/** Current on-disk format version, independent of the npm package version. */
+export type TextmodeDocumentVersion = typeof TEXTMODE_DOCUMENT_FORMAT_VERSION;
+/** RGBA color channels, each an integer from 0 through 255. */
+export interface TextmodeDocumentRGBAColor {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}
+/** On-disk color notation; decoded colors use RGBA channels. */
+export type TextmodeDocumentColor = string | TextmodeDocumentRGBAColor;
+/** Per-cell transform in degrees. */
+export interface TextmodeDocumentCellTransform {
+    invert: boolean;
+    flipX: boolean;
+    flipY: boolean;
+    rotation: number;
+}
+/** Cell at its redundant row-major x/y coordinates. */
+export interface TextmodeDocumentCell {
+    x: number;
+    y: number;
+    character: string;
+    foreground: TextmodeDocumentColor;
+    background: TextmodeDocumentColor;
+    transform: TextmodeDocumentCellTransform;
+}
+/** Dense row-major cell collection. */
+export interface TextmodeDocumentCellCollection {
+    encoding: typeof TEXTMODE_OBJECT_ROWS_ENCODING;
+    rows: TextmodeDocumentCell[][];
+}
+/** Logical grid dimensions and pixel extent of each cell. */
+export interface TextmodeDocumentGrid {
+    cols: number;
+    rows: number;
+    cellWidth: number;
+    cellHeight: number;
+}
+/** Optional producer information; it does not control decoding behavior. */
+export interface TextmodeDocumentMetadata {
+    createdAt: string;
+    generator: {
+        name: string;
+        version: string;
+    };
+}
+/**
+ * Scope selected by the JSON exporter.
+ *
+ * @deprecated Use TextmodeDocumentTarget.
+ * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/JSONExportTarget | JSONExportTarget API reference}
+ */
+export type JSONExportTarget = TextmodeDocumentTarget;
+/** @deprecated Use TextmodeDocumentFormat. */
+export type JSONDocumentFormat = TextmodeDocumentFormat;
+/** @deprecated Use TextmodeDocumentVersion. */
+export type JSONDocumentVersion = TextmodeDocumentVersion;
+/** @deprecated Use TextmodeDocumentRGBAColor. */
+export type JSONRGBAColor = TextmodeDocumentRGBAColor;
+/** @deprecated Use TextmodeDocumentColor. */
+export type JSONColorValue = TextmodeDocumentColor;
+/** @deprecated Use TextmodeDocumentCellTransform. */
+export type JSONCellTransform = TextmodeDocumentCellTransform;
+/** @deprecated Use TextmodeDocumentCell. */
+export type JSONObjectRowCell = TextmodeDocumentCell;
+/** @deprecated Use TextmodeDocumentCellCollection. */
+export type JSONObjectRowsCellCollection = TextmodeDocumentCellCollection;
+/** @deprecated Use TextmodeDocumentCellCollection. */
+export type JSONCellCollection = TextmodeDocumentCellCollection;
+/** @deprecated Use TextmodeDocumentGrid. */
+export type JSONLayerGrid = TextmodeDocumentGrid;
+/** @deprecated Use TextmodeDocumentMetadata. */
+export type JSONExportMetadata = TextmodeDocumentMetadata;
+export interface TextmodeSelectedDocumentLayer {
+    id: string;
+    cells: JSONCellCollection;
+}
+export interface TextmodeSelectedDocumentJSON {
+    format: JSONDocumentFormat;
+    formatVersion: JSONDocumentVersion;
+    target: 'selected';
+    metadata?: JSONExportMetadata;
+    canvas: {
+        width: number;
+        height: number;
+    };
+    grid: JSONLayerGrid;
+    layer: TextmodeSelectedDocumentLayer;
+}
+export interface TextmodeDocumentLayer {
+    id: string;
+    visible: boolean;
+    opacity: number;
+    blendMode: string;
+    offsetX: number;
+    offsetY: number;
+    rotationZ: number;
+    grid: JSONLayerGrid;
+    cells: JSONCellCollection;
+}
+export interface TextmodeAllDocumentJSON {
+    format: JSONDocumentFormat;
+    formatVersion: JSONDocumentVersion;
+    target: 'all';
+    metadata?: JSONExportMetadata;
+    canvas: {
+        width: number;
+        height: number;
+    };
+    layers: TextmodeDocumentLayer[];
+}
+/**
+ * JSON document produced by the selected-layer or layer-stack exporter.
+ *
+ * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/TextmodeDocumentJSON | TextmodeDocumentJSON API reference}
+ */
+export type TextmodeDocumentJSON = TextmodeSelectedDocumentJSON | TextmodeAllDocumentJSON;
+export interface CanonicalTextmodeCell extends Omit<JSONObjectRowCell, 'foreground' | 'background' | 'transform'> {
+    foreground: JSONRGBAColor;
+    background: JSONRGBAColor;
+    transform: JSONCellTransform;
+}
+export interface CanonicalTextmodeCellCollection {
+    encoding: typeof TEXTMODE_OBJECT_ROWS_ENCODING;
+    rows: CanonicalTextmodeCell[][];
+}
+export interface CanonicalTextmodeSelectedDocument extends Omit<TextmodeSelectedDocumentJSON, 'layer'> {
+    layer: {
+        id: string;
+        cells: CanonicalTextmodeCellCollection;
+    };
+}
+export interface CanonicalTextmodeDocumentLayer extends Omit<TextmodeDocumentLayer, 'cells'> {
+    cells: CanonicalTextmodeCellCollection;
+}
+export interface CanonicalTextmodeAllDocument extends Omit<TextmodeAllDocumentJSON, 'layers'> {
+    layers: CanonicalTextmodeDocumentLayer[];
+}
+export type CanonicalTextmodeDocument = CanonicalTextmodeSelectedDocument | CanonicalTextmodeAllDocument;
+export interface TextmodeDocumentLimits {
+    maxCells?: number;
+    maxLayers?: number;
+    maxLayerIdLength?: number;
+    maxCharacterLength?: number;
+    maxMetadataStringLength?: number;
+}
+export interface TextmodeDocumentDecodeOptions {
+    limits?: TextmodeDocumentLimits;
+    acceptLegacy?: boolean;
+}
+export type TextmodeDocumentErrorCode = 'INVALID_JSON' | 'INVALID_DOCUMENT' | 'UNSUPPORTED_FORMAT' | 'UNSUPPORTED_VERSION' | 'UNSUPPORTED_TARGET' | 'UNSUPPORTED_ENCODING' | 'LIMIT_EXCEEDED';
+export interface TextmodeDocumentError {
+    code: TextmodeDocumentErrorCode;
+    message: string;
+    path?: string;
+}
+export interface TextmodeDocumentWarning {
+    code: 'LEGACY_DOCUMENT_MIGRATED';
+    message: string;
+}
+export type JSONParseResult = {
+    ok: true;
+    value: unknown;
+} | {
+    ok: false;
+    error: TextmodeDocumentError;
+};
+export type TextmodeDocumentDecodeResult = {
+    ok: true;
+    document: CanonicalTextmodeDocument;
+    warnings: TextmodeDocumentWarning[];
+} | {
+    ok: false;
+    error: TextmodeDocumentError;
+};
+export type TextmodeDocumentParseResult = TextmodeDocumentDecodeResult;
+export interface LegacyTextmodeSelectedDocumentJSON {
+    $schema?: string;
+    format: typeof LEGACY_TEXTMODE_LAYER_FORMAT;
+    formatVersion: typeof LEGACY_TEXTMODE_SELECTED_VERSION;
+    metadata?: JSONExportMetadata;
+    canvas: {
+        width: number;
+        height: number;
+    };
+    grid: JSONLayerGrid;
+    layer: TextmodeSelectedDocumentLayer;
+}
+export interface LegacyTextmodeAllDocumentJSON {
+    $schema?: string;
+    format: typeof LEGACY_TEXTMODE_LAYER_FORMAT;
+    formatVersion: typeof LEGACY_TEXTMODE_ALL_VERSION;
+    metadata?: JSONExportMetadata;
+    canvas: {
+        width: number;
+        height: number;
+    };
+    layers: TextmodeDocumentLayer[];
+}

package/dist/types/document/validation.d.ts

@@ -0,0 +1,37 @@
+import type { JSONExportMetadata, JSONLayerGrid, JSONRGBAColor, TextmodeDocumentDecodeResult, TextmodeDocumentError, TextmodeDocumentErrorCode, TextmodeDocumentLimits } from './types';
+export type UnknownRecord = Record<string, unknown>;
+export type ResolvedLimits = Required<TextmodeDocumentLimits>;
+export type DecodeContext = {
+    limits: ResolvedLimits;
+    remainingCells: number;
+};
+export declare class DocumentDecodeFailure extends Error {
+    readonly detail: TextmodeDocumentError;
+    constructor(detail: TextmodeDocumentError);
+}
+export declare function decodeColor(value: unknown, path: string): JSONRGBAColor;
+export declare function decodeCanvas(value: unknown, path: string): {
+    width: number;
+    height: number;
+};
+export declare function decodeGrid(value: unknown, path: string): JSONLayerGrid;
+export declare function decodeMetadata(value: unknown, path: string, limits: ResolvedLimits): JSONExportMetadata;
+export declare function decodeLayerId(value: unknown, path: string, limits: ResolvedLimits): string;
+export declare function assertCanvasMatchesGrid(canvas: {
+    width: number;
+    height: number;
+}, grid: JSONLayerGrid, path: string): void;
+export declare function resolveLimits(limits: TextmodeDocumentLimits | undefined): ResolvedLimits;
+export declare function checkedProduct(left: number, right: number, path: string): number;
+export declare function normalizeRotation(rotation: number): number;
+export declare function requireRecord(value: unknown, path: string): UnknownRecord;
+export declare function requireArray(value: unknown, path: string): unknown[];
+export declare function requireString(value: unknown, path: string): string;
+export declare function requireBoundedString(value: unknown, path: string, maxLength: number): string;
+export declare function requireCharacter(value: unknown, path: string, limits: ResolvedLimits): string;
+export declare function requireBoolean(value: unknown, path: string): boolean;
+export declare function requireFiniteNumber(value: unknown, path: string): number;
+export declare function requireNumberInRange(value: unknown, path: string, minimum: number, maximum: number): number;
+export declare function requireSafeInteger(value: unknown, path: string): number;
+export declare function failure(code: TextmodeDocumentErrorCode, message: string, path?: string): TextmodeDocumentDecodeResult;
+export declare function fail(code: TextmodeDocumentErrorCode, message: string, path?: string): never;

package/dist/types/exporters/base/LayerTarget.d.ts

@@ -4,8 +4,6 @@ import type { TextmodeLayer } from 'textmode.js';
 /**
  * Shared option for exporters that read layer framebuffer data.
  *
- * @category Layer data export
- *
  * @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/LayerExportOptions | LayerExportOptions API reference}
  */
 export interface LayerExportOptions {

package/dist/types/exporters/gif/types.d.ts

@@ -3,8 +3,6 @@ export type GIFRecordingState = 'idle' | 'recording' | 'encoding' | 'completed'
 /**
  * Progress information emitted while deterministic frames are captured and encoded as an animated GIF.
  *
- * @category GIF export
- *
  * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/GIFExportProgress | GIFExportProgress API reference}
  */
 export type GIFExportProgress = {
@@ -36,8 +34,6 @@ export type GIFExportProgress = {
 /**
  * Options for capturing deterministic textmode frames as an animated GIF.
  *
- * @category GIF export
- *
  * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/GIFExportOptions | GIFExportOptions API reference}
  */
 export type GIFExportOptions = {

package/dist/types/exporters/image/types.d.ts

@@ -8,8 +8,6 @@ export type ImageFormat = 'png' | 'jpg' | 'webp';
 /**
  * Options for exporting the textmode content to image format.
  *
- * @category Canvas capture
- *
  * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/ImageExportOptions | ImageExportOptions API reference}
  */
 export type ImageExportOptions = {

package/dist/types/exporters/json/types.d.ts

@@ -1,225 +1,37 @@
 import type { LayerExportOptions } from '../base';
+import type { JSONCellTransform, JSONExportTarget, JSONRGBAColor } from '../../document';
 /**
- * Target scope for JSON export.
- *
- * @category JSON document data
- *
- * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/JSONExportTarget | JSONExportTarget API reference}
- */
-export type JSONExportTarget = 'selected' | 'all';
-/**
- * Canonical JSON document format identifier.
- *
- * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/JSONDocumentFormat | JSONDocumentFormat API reference}
- */
-export type JSONDocumentFormat = 'textmode.document';
-/**
- * Canonical JSON document format version.
- *
- * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/JSONDocumentVersion | JSONDocumentVersion API reference}
- */
-export type JSONDocumentVersion = '2.0.0';
-/**
- * Supported JSON color output modes.
- *
- * @category JSON document data
+ * Color representation written by the JSON exporter: hexadecimal strings or
+ * RGBA channel objects.
  *
  * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/JSONExportColorMode | JSONExportColorMode API reference}
  */
 export type JSONExportColorMode = 'hex' | 'rgba';
+export type { JSONCellCollection, JSONCellTransform, JSONColorValue, JSONDocumentFormat, JSONDocumentVersion, JSONExportMetadata, JSONExportTarget, JSONLayerGrid, JSONObjectRowCell, JSONObjectRowsCellCollection, JSONRGBAColor, TextmodeAllDocumentJSON, TextmodeDocumentJSON, TextmodeDocumentLayer, TextmodeSelectedDocumentJSON, TextmodeSelectedDocumentLayer, } from '../../document';
 /**
- * RGBA color representation used in JSON exports.
- *
- * @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/JSONRGBAColor | JSONRGBAColor API reference}
- */
-export interface JSONRGBAColor {
-    r: number;
-    g: number;
-    b: number;
-    a: number;
-}
-/**
- * Color value used in the exported JSON document.
- *
- * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/JSONColorValue | JSONColorValue API reference}
- */
-export type JSONColorValue = string | JSONRGBAColor;
-/**
- * Cell transform data for JSON exports.
- *
- * @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/JSONCellTransform | JSONCellTransform API reference}
- */
-export interface JSONCellTransform {
-    invert: boolean;
-    flipX: boolean;
-    flipY: boolean;
-    rotation: number;
-}
-/**
- * Rich per-cell representation for readable JSON exports.
- *
- * @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/JSONObjectRowCell | JSONObjectRowCell API reference}
- */
-export interface JSONObjectRowCell {
-    x: number;
-    y: number;
-    character: string;
-    foreground: JSONColorValue;
-    background: JSONColorValue;
-    transform: JSONCellTransform;
-}
-/**
- * Row-based cell encoding.
- *
- * @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/JSONObjectRowsCellCollection | JSONObjectRowsCellCollection API reference}
- */
-export interface JSONObjectRowsCellCollection {
-    encoding: 'object-rows-v1';
-    rows: JSONObjectRowCell[][];
-}
-/**
- * Supported JSON cell collection variants.
- *
- * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/JSONCellCollection | JSONCellCollection API reference}
- */
-export type JSONCellCollection = JSONObjectRowsCellCollection;
-/**
- * Grid dimensions exported for a layer.
- *
- * @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/JSONLayerGrid | JSONLayerGrid API reference}
- */
-export interface JSONLayerGrid {
-    cols: number;
-    rows: number;
-    cellWidth: number;
-    cellHeight: number;
-}
-/**
- * Optional export metadata.
- *
- * @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/JSONExportMetadata | JSONExportMetadata API reference}
- */
-export interface JSONExportMetadata {
-    createdAt: string;
-    generator: {
-        name: 'textmode.export.js';
-        version: string;
-    };
-}
-/**
- * Selected-layer entry in a JSON document export.
- *
- * @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeSelectedDocumentLayer | TextmodeSelectedDocumentLayer API reference}
- */
-export interface TextmodeSelectedDocumentLayer {
-    id: string;
-    cells: JSONCellCollection;
-}
-/**
- * Selected-layer document exported by the JSON exporter.
- *
- * @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeSelectedDocumentJSON | TextmodeSelectedDocumentJSON API reference}
- */
-export interface TextmodeSelectedDocumentJSON {
-    format: JSONDocumentFormat;
-    formatVersion: JSONDocumentVersion;
-    target: 'selected';
-    metadata?: JSONExportMetadata;
-    canvas: {
-        width: number;
-        height: number;
-    };
-    grid: JSONLayerGrid;
-    layer: TextmodeSelectedDocumentLayer;
-}
-/**
- * Single layer entry in an all-layers JSON export.
- *
- * @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeDocumentLayer | TextmodeDocumentLayer API reference}
- */
-export interface TextmodeDocumentLayer {
-    id: string;
-    visible: boolean;
-    opacity: number;
-    blendMode: string;
-    offsetX: number;
-    offsetY: number;
-    rotationZ: number;
-    grid: JSONLayerGrid;
-    cells: JSONCellCollection;
-}
-/**
- * Layer stack document exported by the JSON exporter.
- *
- * @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeAllDocumentJSON | TextmodeAllDocumentJSON API reference}
- */
-export interface TextmodeAllDocumentJSON {
-    format: JSONDocumentFormat;
-    formatVersion: JSONDocumentVersion;
-    target: 'all';
-    metadata?: JSONExportMetadata;
-    canvas: {
-        width: number;
-        height: number;
-    };
-    layers: TextmodeDocumentLayer[];
-}
-/**
- * JSON document exported by the JSON exporter.
- *
- * @category JSON document data
- *
- * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/TextmodeDocumentJSON | TextmodeDocumentJSON API reference}
- */
-export type TextmodeDocumentJSON = TextmodeSelectedDocumentJSON | TextmodeAllDocumentJSON;
-/**
- * Options for exporting the textmode content to JSON format.
- *
- * @category JSON document data
+ * Options for exporting textmode content to JSON.
  *
  * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/JSONExportOptions | JSONExportOptions API reference}
  */
 export type JSONExportOptions = LayerExportOptions & {
     /**
-     * Scope of the JSON export.
-     *
-     * Use `'selected'` to export one layer, or `'all'` to export the base layer and every user-created layer.
-     *
-     * Defaults to `'selected'`.
+     * Export one selected layer or the complete layer stack.
+     * Defaults to `selected`.
      */
     target?: JSONExportTarget;
-    /**
-     * The filename to save the JSON file as.
-     *
-     * If not provided, a default filename is used.
-     */
+    /** Filename used by the download helper. A default name is used when omitted. */
     filename?: string;
     /**
-     * Pretty-print the generated JSON.
-     *
-     * When set to `true`, output uses two-space indentation.
-     * When set to a number, that value is used as indentation width.
-     * When `false`, the output is minified.
-     *
-     * Defaults to `true`.
+     * Pretty-print with two spaces when `true`, use the given indentation width
+     * when numeric, or produce compact JSON when `false`. Defaults to `true`.
      */
     pretty?: boolean | number;
-    /**
-     * Color representation used for foreground and background values.
-     *
-     * Defaults to `'hex'`.
-     */
+    /** Foreground and background color representation. Defaults to `hex`. */
     colorMode?: JSONExportColorMode;
-    /**
-     * Whether to include export metadata such as timestamp and generator details.
-     *
-     * Defaults to `true`.
-     */
+    /** Include the creation timestamp and generator metadata. Defaults to `true`. */
     includeMetadata?: boolean;
 };
-/**
- * Internal options used by JSON generation (with all defaults applied).
- */
+/** Internal JSON generation options after defaults have been applied. */
 export interface JSONGenerationOptions {
     target: JSONExportTarget;
     pretty: boolean | number;
@@ -228,9 +40,7 @@ export interface JSONGenerationOptions {
     filename?: string;
     layer?: LayerExportOptions['layer'];
 }
-/**
- * Internal extracted cell data used while building the JSON document.
- */
+/** Internal framebuffer cell data used while building a document. */
 export interface JSONCellData {
     x: number;
     y: number;

package/dist/types/exporters/svg/types.d.ts

@@ -1,4 +1,4 @@
-import type { LayerExportOptions } from '../base';
+import type { LayerExportOptions } from '../base/LayerTarget';
 /**
  * RGBA color representation.
  */
@@ -54,8 +54,6 @@ export interface FramebufferData {
 /**
  * Options for exporting the textmode content to SVG format.
  *
- * @category Layer data export
- *
  * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/SVGExportOptions | SVGExportOptions API reference}
  */
 export type SVGExportOptions = LayerExportOptions & {

package/dist/types/exporters/txt/types.d.ts

@@ -2,8 +2,6 @@ import type { LayerExportOptions } from '../base';
 /**
  * Options for exporting the textmode content to TXT format.
  *
- * @category Layer data export
- *
  * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/TXTExportOptions | TXTExportOptions API reference}
  */
 export type TXTExportOptions = LayerExportOptions & {