@textmode/document 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,111 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+4. Limitations and Disclaimers.
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

package/README.md

@@ -1,3 +1,61 @@
-# Temporary Holding Version
+# @textmode/document
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<div align="center">
+
+<img alt="@textmode/document, portable textmode documents" src=".github/assets/readme-og.png" />
+
+| [![Node.js 24](https://img.shields.io/badge/Node.js-24-339933?logo=nodedotjs&logoColor=white)](https://nodejs.org/) [![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/) [![JSON Schema Draft 2020-12](https://img.shields.io/badge/JSON_Schema-Draft_2020--12-85EA2D?logo=json&logoColor=white)](https://json-schema.org/draft/2020-12) | [![docs](https://img.shields.io/badge/docs-vitepress-646cff?logo=vitepress&logoColor=white)](https://code.textmode.art/) [![Discord](https://img.shields.io/discord/1357070706181017691?color=5865F2&label=Discord&logo=discord&logoColor=white)](https://discord.gg/sjrw8QXNks) | [![Ko-fi](https://shields.io/badge/ko--fi-donate-ff5f5f?logo=ko-fi)](https://ko-fi.com/V7V8JG2FY) [![GitHub Sponsors](https://img.shields.io/badge/sponsor-30363D?logo=GitHub-Sponsors&logoColor=%23EA4AAA)](https://github.com/sponsors/humanbydefinition) |
+| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+
+</div>
+
+`@textmode/document` defines a portable, versioned JSON format for textmode artwork. It provides a language-neutral specification, JSON Schema, TypeScript types, and a dependency-free decoder for browsers and Node.js.
+
+The package reads `textmode.document@2.0.0` and migrates `textmode.layer@1.0.0` and `textmode.layer@1.1.0`. The package version and document format version are independent. Updating this library does not change existing files.
+
+## Install
+
+Install the package from npm:
+
+```sh
+npm install @textmode/document
+```
+
+The JavaScript interface is ESM-only and has no runtime dependencies. It does not require `textmode.js`, a renderer, DOM globals, or media encoders.
+
+## Decode a document
+
+```js
+import { parseTextmodeDocumentJSON } from '@textmode/document';
+
+const result = parseTextmodeDocumentJSON(jsonText, {
+	limits: { maxCells: 65536, maxLayers: 64 },
+});
+
+if (!result.ok) {
+	console.error(result.error.code, result.error.path, result.error.message);
+} else {
+	console.log(result.document.target, result.warnings);
+}
+```
+
+Successful decoding returns a new canonical document. Colors use RGBA objects, cell rotations use `[0, 360)`, and unknown properties are omitted. Apply each app's supported-feature policy after decoding.
+
+## Documentation
+
+- [Consumer guide](docs/consumer-guide.md): parsing, schema imports, error handling, resource budgets, and complete examples.
+- [Format 2.0 specification](docs/specification-2.0.md): the language-neutral contract for producers and consumers.
+- [Maintenance guide](docs/maintenance.md): ownership, compatibility, tests, and release policy.
+- [JSON Schema](schemas/2.0/schema.json): also available from `@textmode/document/schema/2.0`.
+
+The schema identifier is an identifier. It does not promise that the schema is hosted at that URL. Test fixtures are private test data. They are not package exports and are excluded from npm packages.
+
+## Contributing
+
+Thank you for considering a contribution to this project.
+
+Read the [Contributing Guide](./CONTRIBUTING.md) to get started.
+
+## License
+
+`@textmode/document` is dedicated to the public domain under [CC0 1.0 Universal](./LICENSE).

package/dist/constants.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Canonical format discriminator for textmode document files.
+ *
+ */
+export declare const TEXTMODE_DOCUMENT_FORMAT: "textmode.document";
+/**
+ * Current textmode document schema revision.
+ *
+ */
+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.
+ *
+ */
+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/constants.js

@@ -0,0 +1,29 @@
+/**
+ * Canonical format discriminator for textmode document files.
+ *
+ */
+export const TEXTMODE_DOCUMENT_FORMAT = 'textmode.document';
+/**
+ * Current textmode document schema revision.
+ *
+ */
+export const TEXTMODE_DOCUMENT_FORMAT_VERSION = '2.0.0';
+/** Legacy format discriminator accepted by the compatibility decoder. */
+export const LEGACY_TEXTMODE_LAYER_FORMAT = 'textmode.layer';
+/** Legacy selected-layer schema revision. */
+export const LEGACY_TEXTMODE_SELECTED_VERSION = '1.0.0';
+/** Legacy layer-stack schema revision. */
+export const LEGACY_TEXTMODE_ALL_VERSION = '1.1.0';
+/**
+ * Canonical dense row encoding used by textmode document v2.
+ *
+ */
+export const TEXTMODE_OBJECT_ROWS_ENCODING = 'object-rows-v1';
+/** Default protocol safety limits. Product-specific limits belong to callers. */
+export const DEFAULT_TEXTMODE_DOCUMENT_LIMITS = {
+    maxCells: 16777216,
+    maxLayers: 4096,
+    maxLayerIdLength: 1024,
+    maxCharacterLength: 64,
+    maxMetadataStringLength: 4096,
+};

package/dist/decode-shapes.d.ts

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

package/dist/decode-shapes.js

@@ -0,0 +1,108 @@
+import { TEXTMODE_DOCUMENT_FORMAT, TEXTMODE_DOCUMENT_FORMAT_VERSION, TEXTMODE_OBJECT_ROWS_ENCODING, } from './constants.js';
+import { assertCanvasMatchesGrid, checkedProduct, decodeCanvas, decodeColor, decodeGrid, decodeLayerId, decodeMetadata, fail, normalizeRotation, requireArray, requireBoolean, requireBoundedString, requireCharacter, requireFiniteNumber, requireNumberInRange, requireRecord, requireSafeInteger, requireString, } from './validation.js';
+export function decodeSelectedDocument(root, context) {
+    const canvas = decodeCanvas(root.canvas, '$.canvas');
+    const grid = decodeGrid(root.grid, '$.grid');
+    assertCanvasMatchesGrid(canvas, grid, '$.canvas');
+    const layer = requireRecord(root.layer, '$.layer');
+    return {
+        format: TEXTMODE_DOCUMENT_FORMAT,
+        formatVersion: TEXTMODE_DOCUMENT_FORMAT_VERSION,
+        target: 'selected',
+        ...(root.metadata === undefined
+            ? {}
+            : { metadata: decodeMetadata(root.metadata, '$.metadata', context.limits) }),
+        canvas,
+        grid,
+        layer: {
+            id: decodeLayerId(layer.id, '$.layer.id', context.limits),
+            cells: decodeCells(layer.cells, grid, '$.layer.cells', context),
+        },
+    };
+}
+export function decodeAllDocument(root, context) {
+    const canvas = decodeCanvas(root.canvas, '$.canvas');
+    const layersValue = requireArray(root.layers, '$.layers');
+    if (layersValue.length === 0) {
+        fail('INVALID_DOCUMENT', 'A layer-stack document must contain at least one layer.', '$.layers');
+    }
+    if (layersValue.length > context.limits.maxLayers) {
+        fail('LIMIT_EXCEEDED', `Layer count ${layersValue.length} exceeds the configured limit ${context.limits.maxLayers}.`, '$.layers');
+    }
+    const layers = layersValue.map((value, index) => decodeLayer(value, `$.layers[${index}]`, context));
+    assertCanvasMatchesGrid(canvas, layers[0].grid, '$.canvas');
+    return {
+        format: TEXTMODE_DOCUMENT_FORMAT,
+        formatVersion: TEXTMODE_DOCUMENT_FORMAT_VERSION,
+        target: 'all',
+        ...(root.metadata === undefined
+            ? {}
+            : { metadata: decodeMetadata(root.metadata, '$.metadata', context.limits) }),
+        canvas,
+        layers,
+    };
+}
+function decodeLayer(value, path, context) {
+    const layer = requireRecord(value, path);
+    const grid = decodeGrid(layer.grid, `${path}.grid`);
+    return {
+        id: decodeLayerId(layer.id, `${path}.id`, context.limits),
+        visible: requireBoolean(layer.visible, `${path}.visible`),
+        opacity: requireNumberInRange(layer.opacity, `${path}.opacity`, 0, 1),
+        blendMode: requireBoundedString(layer.blendMode, `${path}.blendMode`, context.limits.maxMetadataStringLength),
+        offsetX: requireFiniteNumber(layer.offsetX, `${path}.offsetX`),
+        offsetY: requireFiniteNumber(layer.offsetY, `${path}.offsetY`),
+        rotationZ: requireFiniteNumber(layer.rotationZ, `${path}.rotationZ`),
+        grid,
+        cells: decodeCells(layer.cells, grid, `${path}.cells`, context),
+    };
+}
+function decodeCells(value, grid, path, context) {
+    const collection = requireRecord(value, path);
+    const encoding = requireString(collection.encoding, `${path}.encoding`);
+    if (encoding !== TEXTMODE_OBJECT_ROWS_ENCODING) {
+        fail('UNSUPPORTED_ENCODING', `Unsupported cell encoding: ${encoding}.`, `${path}.encoding`);
+    }
+    const expectedCellCount = checkedProduct(grid.cols, grid.rows, `${path}.rows`);
+    if (expectedCellCount > context.remainingCells) {
+        fail('LIMIT_EXCEEDED', `Document cell count exceeds the configured limit ${context.limits.maxCells}.`, `${path}.rows`);
+    }
+    context.remainingCells -= expectedCellCount;
+    const rows = requireArray(collection.rows, `${path}.rows`);
+    if (rows.length !== grid.rows) {
+        fail('INVALID_DOCUMENT', `Expected ${grid.rows} cell rows, received ${rows.length}.`, `${path}.rows`);
+    }
+    return {
+        encoding: TEXTMODE_OBJECT_ROWS_ENCODING,
+        rows: rows.map((rowValue, y) => {
+            const rowPath = `${path}.rows[${y}]`;
+            const row = requireArray(rowValue, rowPath);
+            if (row.length !== grid.cols) {
+                fail('INVALID_DOCUMENT', `Expected ${grid.cols} cells, received ${row.length}.`, rowPath);
+            }
+            return row.map((cell, x) => decodeCell(cell, x, y, `${rowPath}[${x}]`, context));
+        }),
+    };
+}
+function decodeCell(value, expectedX, expectedY, path, context) {
+    const cell = requireRecord(value, path);
+    const x = requireSafeInteger(cell.x, `${path}.x`);
+    const y = requireSafeInteger(cell.y, `${path}.y`);
+    if (x !== expectedX || y !== expectedY) {
+        fail('INVALID_DOCUMENT', `Cell coordinates must match their row position (${expectedX}, ${expectedY}).`, path);
+    }
+    const transform = requireRecord(cell.transform, `${path}.transform`);
+    return {
+        x,
+        y,
+        character: requireCharacter(cell.character, `${path}.character`, context.limits),
+        foreground: decodeColor(cell.foreground, `${path}.foreground`),
+        background: decodeColor(cell.background, `${path}.background`),
+        transform: {
+            invert: requireBoolean(transform.invert, `${path}.transform.invert`),
+            flipX: requireBoolean(transform.flipX, `${path}.transform.flipX`),
+            flipY: requireBoolean(transform.flipY, `${path}.transform.flipY`),
+            rotation: normalizeRotation(requireFiniteNumber(transform.rotation, `${path}.transform.rotation`)),
+        },
+    };
+}

package/dist/decode.d.ts

@@ -0,0 +1,24 @@
+import type { TextmodeDocumentDecodeOptions, TextmodeDocumentDecodeResult, TextmodeDocumentParseResult } from './types/index.js';
+/**
+ * Decode a parsed value and normalize known document fields.
+ * Invalid input returns a typed failure; invalid limit configuration throws TypeError.
+ *
+ * @example
+ * ```ts
+ * import { decodeTextmodeDocument } from '@textmode/document';
+ * const result = decodeTextmodeDocument({ format: 'unsupported' });
+ * if (!result.ok) console.log(result.error.code);
+ * ```
+ */
+export declare function decodeTextmodeDocument(value: unknown, options?: TextmodeDocumentDecodeOptions): TextmodeDocumentDecodeResult;
+/**
+ * Parse JSON syntax and decode a textmode document in one call.
+ *
+ * @example
+ * ```ts
+ * import { parseTextmodeDocumentJSON } from '@textmode/document';
+ * const result = parseTextmodeDocumentJSON('{');
+ * if (!result.ok) console.log(result.error.code); // INVALID_JSON
+ * ```
+ */
+export declare function parseTextmodeDocumentJSON(json: string, options?: TextmodeDocumentDecodeOptions): TextmodeDocumentParseResult;

package/dist/decode.js

@@ -0,0 +1,88 @@
+import { LEGACY_TEXTMODE_ALL_VERSION, LEGACY_TEXTMODE_LAYER_FORMAT, LEGACY_TEXTMODE_SELECTED_VERSION, TEXTMODE_DOCUMENT_FORMAT, TEXTMODE_DOCUMENT_FORMAT_VERSION, } from './constants.js';
+import { decodeAllDocument, decodeSelectedDocument } from './decode-shapes.js';
+import { parseJSON } from './parse.js';
+import { DocumentDecodeFailure, fail, failure, requireRecord, requireString, resolveLimits } from './validation.js';
+/**
+ * Decode a parsed value and normalize known document fields.
+ * Invalid input returns a typed failure; invalid limit configuration throws TypeError.
+ *
+ * @example
+ * ```ts
+ * import { decodeTextmodeDocument } from '@textmode/document';
+ * const result = decodeTextmodeDocument({ format: 'unsupported' });
+ * if (!result.ok) console.log(result.error.code);
+ * ```
+ */
+export function decodeTextmodeDocument(value, options = {}) {
+    try {
+        const limits = resolveLimits(options.limits);
+        const context = {
+            limits,
+            remainingCells: limits.maxCells,
+        };
+        const root = requireRecord(value, '$');
+        const format = requireString(root.format, '$.format');
+        if (format === TEXTMODE_DOCUMENT_FORMAT) {
+            return {
+                ok: true,
+                document: decodeCurrentDocument(root, context),
+                warnings: [],
+            };
+        }
+        if (format === LEGACY_TEXTMODE_LAYER_FORMAT && (options.acceptLegacy ?? true)) {
+            return {
+                ok: true,
+                document: decodeLegacyDocument(root, context),
+                warnings: [
+                    {
+                        code: 'LEGACY_DOCUMENT_MIGRATED',
+                        message: 'Migrated a legacy textmode.layer document to textmode.document 2.0.0.',
+                    },
+                ],
+            };
+        }
+        return failure('UNSUPPORTED_FORMAT', `Unsupported textmode document format: ${format}.`, '$.format');
+    }
+    catch (error) {
+        if (error instanceof DocumentDecodeFailure) {
+            return { ok: false, error: error.detail };
+        }
+        throw error;
+    }
+}
+/**
+ * Parse JSON syntax and decode a textmode document in one call.
+ *
+ * @example
+ * ```ts
+ * import { parseTextmodeDocumentJSON } from '@textmode/document';
+ * const result = parseTextmodeDocumentJSON('{');
+ * if (!result.ok) console.log(result.error.code); // INVALID_JSON
+ * ```
+ */
+export function parseTextmodeDocumentJSON(json, options = {}) {
+    const parsed = parseJSON(json);
+    if (!parsed.ok)
+        return parsed;
+    return decodeTextmodeDocument(parsed.value, options);
+}
+function decodeCurrentDocument(root, context) {
+    const version = requireString(root.formatVersion, '$.formatVersion');
+    if (version !== TEXTMODE_DOCUMENT_FORMAT_VERSION) {
+        fail('UNSUPPORTED_VERSION', `Unsupported textmode.document version: ${version}.`, '$.formatVersion');
+    }
+    const target = requireString(root.target, '$.target');
+    if (target === 'selected')
+        return decodeSelectedDocument(root, context);
+    if (target === 'all')
+        return decodeAllDocument(root, context);
+    fail('UNSUPPORTED_TARGET', `Unsupported textmode document target: ${target}.`, '$.target');
+}
+function decodeLegacyDocument(root, context) {
+    const version = requireString(root.formatVersion, '$.formatVersion');
+    if (version === LEGACY_TEXTMODE_SELECTED_VERSION)
+        return decodeSelectedDocument(root, context);
+    if (version === LEGACY_TEXTMODE_ALL_VERSION)
+        return decodeAllDocument(root, context);
+    fail('UNSUPPORTED_VERSION', `Unsupported legacy textmode.layer version: ${version}.`, '$.formatVersion');
+}

package/dist/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.js';
+export { decodeTextmodeDocument, parseTextmodeDocumentJSON } from './decode.js';
+export { parseJSON } from './parse.js';
+export type { CanonicalTextmodeAllDocument, CanonicalTextmodeCell, CanonicalTextmodeCellCollection, CanonicalTextmodeDocument, CanonicalTextmodeDocumentLayer, CanonicalTextmodeSelectedDocument, JSONParseResult, 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/index.js';

package/dist/index.js

@@ -0,0 +1,12 @@
+/**
+ * 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.js';
+export { decodeTextmodeDocument, parseTextmodeDocumentJSON } from './decode.js';
+export { parseJSON } from './parse.js';

package/dist/parse.d.ts

@@ -0,0 +1,12 @@
+import type { JSONParseResult } from './types/index.js';
+/**
+ * Parse JSON syntax before routing the resulting value by its format discriminator.
+ *
+ * @example
+ * ```ts
+ * import { parseJSON } from '@textmode/document';
+ * const parsed = parseJSON('{"format":"textmode.document"}');
+ * if (parsed.ok) console.log(parsed.value);
+ * ```
+ */
+export declare function parseJSON(json: string): JSONParseResult;

package/dist/parse.js

@@ -0,0 +1,24 @@
+/**
+ * Parse JSON syntax before routing the resulting value by its format discriminator.
+ *
+ * @example
+ * ```ts
+ * import { parseJSON } from '@textmode/document';
+ * const parsed = parseJSON('{"format":"textmode.document"}');
+ * if (parsed.ok) console.log(parsed.value);
+ * ```
+ */
+export function parseJSON(json) {
+    try {
+        return { ok: true, value: JSON.parse(json) };
+    }
+    catch (error) {
+        return {
+            ok: false,
+            error: {
+                code: 'INVALID_JSON',
+                message: error instanceof Error ? error.message : 'The file is not valid JSON.',
+            },
+        };
+    }
+}

package/dist/types/canonical.d.ts

@@ -0,0 +1,24 @@
+import type { TextmodeDocumentCell, TextmodeDocumentRGBAColor, TextmodeDocumentCellTransform, TextmodeSelectedDocumentJSON, TextmodeDocumentLayer, TextmodeAllDocumentJSON } from './wire.js';
+import type { TEXTMODE_OBJECT_ROWS_ENCODING } from '../constants.js';
+export interface CanonicalTextmodeCell extends Omit<TextmodeDocumentCell, 'foreground' | 'background' | 'transform'> {
+    foreground: TextmodeDocumentRGBAColor;
+    background: TextmodeDocumentRGBAColor;
+    transform: TextmodeDocumentCellTransform;
+}
+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;

package/dist/types/canonical.js

@@ -0,0 +1 @@
+export {};

package/dist/types/decode.d.ts

@@ -0,0 +1,38 @@
+import type { CanonicalTextmodeDocument } from './canonical.js';
+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;

package/dist/types/decode.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export type * from './wire.js';
+export type * from './canonical.js';
+export type * from './decode.js';
+export type * from './legacy.js';

package/dist/types/index.js

@@ -0,0 +1 @@
+export {};

package/dist/types/legacy.d.ts

@@ -0,0 +1,25 @@
+import type { LEGACY_TEXTMODE_ALL_VERSION, LEGACY_TEXTMODE_LAYER_FORMAT, LEGACY_TEXTMODE_SELECTED_VERSION } from '../constants.js';
+import type { TextmodeDocumentMetadata, TextmodeDocumentGrid, TextmodeSelectedDocumentLayer, TextmodeDocumentLayer } from './wire.js';
+export interface LegacyTextmodeSelectedDocumentJSON {
+    $schema?: string;
+    format: typeof LEGACY_TEXTMODE_LAYER_FORMAT;
+    formatVersion: typeof LEGACY_TEXTMODE_SELECTED_VERSION;
+    metadata?: TextmodeDocumentMetadata;
+    canvas: {
+        width: number;
+        height: number;
+    };
+    grid: TextmodeDocumentGrid;
+    layer: TextmodeSelectedDocumentLayer;
+}
+export interface LegacyTextmodeAllDocumentJSON {
+    $schema?: string;
+    format: typeof LEGACY_TEXTMODE_LAYER_FORMAT;
+    formatVersion: typeof LEGACY_TEXTMODE_ALL_VERSION;
+    metadata?: TextmodeDocumentMetadata;
+    canvas: {
+        width: number;
+        height: number;
+    };
+    layers: TextmodeDocumentLayer[];
+}

package/dist/types/legacy.js

@@ -0,0 +1 @@
+export {};