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

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

@@ -46,4 +46,4 @@ export declare function getLayerTargetOptions(textmodifier: Textmodifier): Layer
 export declare function createLayerTargetProvider(textmodifier: Textmodifier): LayerTargetProvider;
 export declare function getLayerTargetId(textmodifier: Textmodifier, layer: TextmodeLayer): string;
 export declare function resolveLayerExportTarget(textmodifier: Textmodifier, layer?: TextmodeLayer): ResolvedLayerExportTarget;
-export declare function resolveLayerStackExportTargets(textmodifier: Textmodifier): ResolvedLayerStackExportTarget[];
+export declare function resolveLayerStackExportTargets(textmodifier: Textmodifier, selectedLayers?: readonly TextmodeLayer[]): ResolvedLayerStackExportTarget[];

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

@@ -1,5 +1,6 @@
 import type { Textmodifier } from 'textmode.js';
-import type { JSONExportOptions, TextmodeDocumentJSON } from './types';
+import type { JSONExportOptions } from './types';
+import type { TextmodeDocumentJSON } from '@textmode/document';
 /**
  * Main JSON exporter for the textmode.js library.
  * Orchestrates structured selected-layer or layer-stack export and file download.

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

@@ -1,3 +1,2 @@
 export { JSONExporter } from './JSONExporter';
-export { JSONDataExtractor } from './JSONDataExtractor';
-export type { JSONDocumentFormat, JSONDocumentVersion, JSONCellCollection, JSONCellData, JSONCellTransform, JSONColorValue, JSONExportColorMode, JSONExportMetadata, JSONExportOptions, JSONExportTarget, JSONGenerationOptions, JSONLayerGrid, JSONObjectRowCell, JSONObjectRowsCellCollection, JSONRGBAColor, TextmodeAllDocumentJSON, TextmodeDocumentJSON, TextmodeDocumentLayer, TextmodeSelectedDocumentJSON, TextmodeSelectedDocumentLayer, } from './types';
+export type { JSONExportTarget, JSONExportColorMode, JSONExportOptions } from './types';

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

@@ -1,5 +1,11 @@
 import type { LayerExportOptions } from '../base';
-import type { JSONCellTransform, JSONExportTarget, JSONRGBAColor } from '../../document';
+import type { TextmodeDocumentCellTransform, TextmodeDocumentRGBAColor } from '@textmode/document';
+/**
+ * Layer selection for export; never serialized into the document.
+ *
+ * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/JSONExportTarget | JSONExportTarget API reference}
+ */
+export type JSONExportTarget = 'selected' | 'all';
 /**
  * Color representation written by the JSON exporter: hexadecimal strings or
  * RGBA channel objects.
@@ -7,7 +13,6 @@ import type { JSONCellTransform, JSONExportTarget, JSONRGBAColor } from '../../d
  * @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';
 /**
  * Options for exporting textmode content to JSON.
  *
@@ -45,7 +50,7 @@ export interface JSONCellData {
     x: number;
     y: number;
     character: string;
-    foreground: JSONRGBAColor;
-    background: JSONRGBAColor;
-    transform: JSONCellTransform;
+    foreground: TextmodeDocumentRGBAColor;
+    background: TextmodeDocumentRGBAColor;
+    transform: TextmodeDocumentCellTransform;
 }

package/dist/types/index.d.ts

@@ -24,9 +24,7 @@ export type { TextmodeExportAPI, ExportOverlayController } from './types';
 export type { ImageExportOptions } from './exporters/image';
 export type { SVGExportOptions } from './exporters/svg';
 export type { TXTExportOptions } from './exporters/txt';
-export { TEXTMODE_DOCUMENT_FORMAT, TEXTMODE_DOCUMENT_FORMAT_VERSION, TEXTMODE_OBJECT_ROWS_ENCODING } from './document';
-export type { JSONExportTarget, TextmodeDocumentJSON, TextmodeDocumentTarget } from './document';
-export type { JSONExportColorMode, JSONExportOptions } from './exporters/json';
+export type { JSONExportTarget, JSONExportColorMode, JSONExportOptions } from './exporters/json';
 export type { GIFExportOptions, GIFExportProgress } from './exporters/gif';
 export { ZIPExportError } from './exporters/zip';
 export type { ZIPCaptureOptions, ZIPExportErrorCode, ZIPExportOptions, ZIPExportProgress, ZIPExportState, ZIPFrameFormat, ZIPFrameOptionsMap, } from './exporters/zip';

package/dist/types/types.d.ts

@@ -3,7 +3,8 @@ import type { TXTExportOptions } from './exporters/txt';
 import type { SVGExportOptions } from './exporters/svg';
 import type { GIFExportOptions } from './exporters/gif';
 import type { VideoExportOptions } from './exporters/video';
-import type { JSONExportOptions, TextmodeDocumentJSON } from './exporters/json';
+import type { JSONExportOptions } from './exporters/json';
+import type { TextmodeDocumentJSON } from '@textmode/document';
 import type { ZIPExportOptions } from './exporters/zip';
 /**
  * Default TXT export fields controlled by the export overlay.
@@ -364,7 +365,8 @@ export interface TextmodeExportAPI {
      */
     toString(options?: TXTExportOptions): string;
     /**
-     * Produces the selected layer or layer stack as structured JSON data.
+     * Produces a v3 document with a nonempty layers array.
+     * Selected layers retain their visibility, opacity, blending, and transforms.
      *
      * @param options Export options.
      * @returns The JSON document representing the selected layer or layer stack.
@@ -373,13 +375,14 @@ export interface TextmodeExportAPI {
      * ```ts
      * const layer = t.toJSON({ layer: t.layers.base, colorMode: 'hex', includeMetadata: true });
      * const stack = t.toJSON({ target: 'all' });
+     * console.log(layer.layers[0].grid, stack.formatVersion); // 3.0.0
      * ```
      *
      * @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/TextmodeExportAPI#tojson | TextmodeExportAPI.toJSON API reference}
      */
     toJSON(options?: JSONExportOptions): TextmodeDocumentJSON;
     /**
-     * Produces the selected layer or layer stack as a JSON string.
+     * Produces the selected layer or layer stack as a v3 JSON document string.
      *
      * @param options Export options.
      * @returns Serialized JSON string for the selected layer or layer stack.
@@ -394,7 +397,7 @@ export interface TextmodeExportAPI {
      */
     toJSONString(options?: JSONExportOptions): string;
     /**
-     * Downloads the selected layer or layer stack as a JSON file.
+     * Downloads the selected layer or layer stack as a v3 JSON document file.
      *
      * @param options Export options.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "textmode.export.js",
-	"version": "1.9.0-beta.2",
+	"version": "1.9.0",
 	"description": "Export plugin for textmode.js - Save images, GIFs, videos, SVG, JSON, text, and ZIP frame sequences.",
 	"type": "module",
 	"devEngines": {
@@ -23,38 +23,6 @@
 			"types": "./dist/types/index.d.ts",
 			"import": "./dist/textmode.export.esm.js",
 			"require": "./dist/textmode.export.umd.js"
-		},
-		"./document": {
-			"types": "./dist/types/document/index.d.ts",
-			"import": "./dist/textmode.document.esm.js"
-		},
-		"./schema": {
-			"types": "./protocol/textmode-document/2.0/textmode-document-2.0.schema.d.ts",
-			"default": "./protocol/textmode-document/2.0/textmode-document-2.0.schema.json"
-		},
-		"./document/schema/2.0": {
-			"types": "./protocol/textmode-document/2.0/textmode-document-2.0.schema.d.ts",
-			"default": "./protocol/textmode-document/2.0/textmode-document-2.0.schema.json"
-		},
-		"./document/fixtures/2.0/textmode-document-selected-v2.json": {
-			"types": "./protocol/textmode-document/2.0/fixture.d.ts",
-			"default": "./protocol/textmode-document/2.0/fixtures/textmode-document-selected-v2.json"
-		},
-		"./document/fixtures/2.0/textmode-document-all-v2.json": {
-			"types": "./protocol/textmode-document/2.0/fixture.d.ts",
-			"default": "./protocol/textmode-document/2.0/fixtures/textmode-document-all-v2.json"
-		},
-		"./document/fixtures/2.0/textmode-document-create-integration-v2.json": {
-			"types": "./protocol/textmode-document/2.0/fixture.d.ts",
-			"default": "./protocol/textmode-document/2.0/fixtures/textmode-document-create-integration-v2.json"
-		},
-		"./document/fixtures/2.0/textmode-layer-selected-v1.json": {
-			"types": "./protocol/textmode-document/2.0/fixture.d.ts",
-			"default": "./protocol/textmode-document/2.0/fixtures/textmode-layer-selected-v1.json"
-		},
-		"./document/fixtures/2.0/textmode-layer-all-v1.1.json": {
-			"types": "./protocol/textmode-document/2.0/fixture.d.ts",
-			"default": "./protocol/textmode-document/2.0/fixtures/textmode-layer-all-v1.1.json"
 		}
 	},
 	"sideEffects": [
@@ -62,17 +30,15 @@
 		"./dist/textmode.export.umd.js"
 	],
 	"files": [
-		"dist",
-		"protocol/textmode-document/2.0"
+		"dist"
 	],
 	"scripts": {
 		"prebuild": "npm run clean",
 		"clean": "rm -rf dist",
 		"dev": "textmode-build dev --port 5174 --host",
 		"build:bundle": "textmode-build build",
-		"build:document": "vite build --config vite.document.config.ts",
 		"build:types": "textmode-types build",
-		"build": "npm run build:bundle && npm run build:document && npm run build:types",
+		"build": "npm run build:bundle && npm run build:types",
 		"check": "npm run format:check && npm run lint && npm run lint:markdown && npm run typecheck && npm run docs:check && npm run test && npm run build && npm run types:verify",
 		"docs:links:add": "textmode-docs links add",
 		"docs:api:check": "textmode-docs api-check",
@@ -97,9 +63,10 @@
 		"textmode.js": "^0.18.0"
 	},
 	"dependencies": {
+		"@textmode/document": "1.1.0",
 		"fflate": "0.8.3",
 		"gifenc": "^1.0.1",
-		"mediabunny": "1.56.1"
+		"mediabunny": "1.62.1"
 	},
 	"devDependencies": {
 		"@textmode/build": "^0.1.1",

package/dist/textmode.document.esm.js

@@ -1 +0,0 @@
-var e="textmode.document",t="2.0.0",r="textmode.layer",n="1.0.0",a="1.1.0",o="object-rows-v1",i={maxCells:16777216,maxLayers:4096,maxLayerIdLength:1024,maxCharacterLength:64,maxMetadataStringLength:4096},s=class extends Error{detail;constructor(e){super(e.message),this.detail=e}};function c(e,t){if("string"==typeof e){const r=/^#([0-9a-f]{6}|[0-9a-f]{8})$/i.exec(e);r||b("INVALID_DOCUMENT","Expected #RRGGBB or #RRGGBBAA color notation.",t);const n=r[1];return{r:Number.parseInt(n.slice(0,2),16),g:Number.parseInt(n.slice(2,4),16),b:Number.parseInt(n.slice(4,6),16),a:8===n.length?Number.parseInt(n.slice(6,8),16):255}}const r=I(e,t);return{r:T(r.r,`${t}.r`),g:T(r.g,`${t}.g`),b:T(r.b,`${t}.b`),a:T(r.a,`${t}.a`)}}function l(e,t){const r=I(e,t);return{width:A(r.width,`${t}.width`),height:A(r.height,`${t}.height`)}}function m(e,t){const r=I(e,t);return{cols:A(r.cols,`${t}.cols`),rows:A(r.rows,`${t}.rows`),cellWidth:A(r.cellWidth,`${t}.cellWidth`),cellHeight:A(r.cellHeight,`${t}.cellHeight`)}}function d(e,t,r){const n=I(e,t),a=I(n.generator,`${t}.generator`),o=N(a.name,`${t}.generator.name`,r.maxMetadataStringLength),i=N(n.createdAt,`${t}.createdAt`,r.maxMetadataStringLength);return function(e,t){const r=u.exec(e);r||b("INVALID_DOCUMENT","Expected an uppercase RFC 3339 timestamp with seconds and a timezone.",t);const n=Number(r[1]),a=Number(r[2]);Number(r[3])>[31,n%4!=0||n%100==0&&n%400!=0?28:29,31,30,31,30,31,31,30,31,30,31][a-1]&&b("INVALID_DOCUMENT","Timestamp contains an invalid calendar date.",t)}(i,`${t}.createdAt`),{createdAt:i,generator:{name:o,version:N(a.version,`${t}.generator.version`,r.maxMetadataStringLength)}}}var u=/^([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\.[0-9]+)?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])$/;function g(e,t,r){return N(e,t,r.maxLayerIdLength)}function f(e,t,r){const n=$(t.cols,t.cellWidth,`${r}.width`),a=$(t.rows,t.cellHeight,`${r}.height`);e.width===n&&e.height===a||b("INVALID_DOCUMENT",`Canvas must equal the grid pixel extent ${n}x${a}.`,r)}function h(e,t,r){if(void 0===e)return t;if(!Number.isSafeInteger(e)||e<=0)throw new TypeError(`${r} must be a positive safe integer.`);return e}function $(e,t,r){const n=e*t;return Number.isSafeInteger(n)||b("LIMIT_EXCEEDED","Numeric dimensions exceed the safe integer range.",r),n}function x(e){const t=(e%360+360)%360;return Object.is(t,-0)?0:t}function I(e,t){return("object"!=typeof e||null===e||Array.isArray(e))&&b("INVALID_DOCUMENT","Expected an object.",t),e}function E(e,t){return Array.isArray(e)||b("INVALID_DOCUMENT","Expected an array.",t),e}function p(e,t){return"string"!=typeof e&&b("INVALID_DOCUMENT","Expected a string.",t),e}function N(e,t,r){const n=p(e,t);return 0===n.length&&b("INVALID_DOCUMENT","Expected a non-empty string.",t),n.length>r&&b("LIMIT_EXCEEDED",`String length exceeds the configured limit ${r}.`,t),n}function L(e,t,r){const n=p(e,t);return 0===n.length&&b("INVALID_DOCUMENT","Expected a non-empty glyph string.",t),function(e,t){for(let r=0;r<e.length;r++){const n=e.charCodeAt(r);if(n>=55296&&n<=56319){const n=e.charCodeAt(r+1);(!Number.isInteger(n)||n<56320||n>57343)&&b("INVALID_DOCUMENT","Glyph strings must not contain unpaired surrogates.",t),r++;continue}n>=56320&&n<=57343&&b("INVALID_DOCUMENT","Glyph strings must not contain unpaired surrogates.",t)}}(n,t),Array.from(n).length>r.maxCharacterLength&&b("LIMIT_EXCEEDED",`Glyph string scalar count exceeds the configured limit ${r.maxCharacterLength}.`,t),n}function D(e,t){return"boolean"!=typeof e&&b("INVALID_DOCUMENT","Expected a boolean.",t),e}function y(e,t){return"number"==typeof e&&Number.isFinite(e)||b("INVALID_DOCUMENT","Expected a finite number.",t),e}function C(e,t,r,n){const a=y(e,t);return(a<r||a>n)&&b("INVALID_DOCUMENT",`Expected a number from ${r} through ${n}.`,t),a}function M(e,t){return"number"==typeof e&&Number.isSafeInteger(e)||b("INVALID_DOCUMENT","Expected a safe integer.",t),e}function A(e,t){const r=M(e,t);return r<=0&&b("INVALID_DOCUMENT","Expected a positive safe integer.",t),r}function T(e,t){const r=M(e,t);return(r<0||r>255)&&b("INVALID_DOCUMENT","Expected an integer from 0 through 255.",t),r}function b(e,t,r){throw new s({code:e,message:t,...r?{path:r}:{}})}function v(r,n){const a=l(r.canvas,"$.canvas"),o=m(r.grid,"$.grid");f(a,o,"$.canvas");const i=I(r.layer,"$.layer");return{format:e,formatVersion:t,target:"selected",...void 0===r.metadata?{}:{metadata:d(r.metadata,"$.metadata",n.limits)},canvas:a,grid:o,layer:{id:g(i.id,"$.layer.id",n.limits),cells:O(i.cells,o,"$.layer.cells",n)}}}function U(r,n){const a=l(r.canvas,"$.canvas"),o=E(r.layers,"$.layers");0===o.length&&b("INVALID_DOCUMENT","A layer-stack document must contain at least one layer.","$.layers"),o.length>n.limits.maxLayers&&b("LIMIT_EXCEEDED",`Layer count ${o.length} exceeds the configured limit ${n.limits.maxLayers}.`,"$.layers");const i=o.map((e,t)=>function(e,t,r){const n=I(e,t),a=m(n.grid,`${t}.grid`);return{id:g(n.id,`${t}.id`,r.limits),visible:D(n.visible,`${t}.visible`),opacity:C(n.opacity,`${t}.opacity`,0,1),blendMode:N(n.blendMode,`${t}.blendMode`,r.limits.maxMetadataStringLength),offsetX:y(n.offsetX,`${t}.offsetX`),offsetY:y(n.offsetY,`${t}.offsetY`),rotationZ:y(n.rotationZ,`${t}.rotationZ`),grid:a,cells:O(n.cells,a,`${t}.cells`,r)}}(e,`$.layers[${t}]`,n));return f(a,i[0].grid,"$.canvas"),{format:e,formatVersion:t,target:"all",...void 0===r.metadata?{}:{metadata:d(r.metadata,"$.metadata",n.limits)},canvas:a,layers:i}}function O(e,t,r,n){const a=I(e,r),i=p(a.encoding,`${r}.encoding`);"object-rows-v1"!==i&&b("UNSUPPORTED_ENCODING",`Unsupported cell encoding: ${i}.`,`${r}.encoding`);const s=$(t.cols,t.rows,`${r}.rows`);s>n.remainingCells&&b("LIMIT_EXCEEDED",`Document cell count exceeds the configured limit ${n.limits.maxCells}.`,`${r}.rows`),n.remainingCells-=s;const l=E(a.rows,`${r}.rows`);return l.length!==t.rows&&b("INVALID_DOCUMENT",`Expected ${t.rows} cell rows, received ${l.length}.`,`${r}.rows`),{encoding:o,rows:l.map((e,a)=>{const o=`${r}.rows[${a}]`,i=E(e,o);return i.length!==t.cols&&b("INVALID_DOCUMENT",`Expected ${t.cols} cells, received ${i.length}.`,o),i.map((e,t)=>function(e,t,r,n,a){const o=I(e,n),i=M(o.x,`${n}.x`),s=M(o.y,`${n}.y`);i===t&&s===r||b("INVALID_DOCUMENT",`Cell coordinates must match their row position (${t}, ${r}).`,n);const l=I(o.transform,`${n}.transform`);return{x:i,y:s,character:L(o.character,`${n}.character`,a.limits),foreground:c(o.foreground,`${n}.foreground`),background:c(o.background,`${n}.background`),transform:{invert:D(l.invert,`${n}.transform.invert`),flipX:D(l.flipX,`${n}.transform.flipX`),flipY:D(l.flipY,`${n}.transform.flipY`),rotation:x(y(l.rotation,`${n}.transform.rotation`))}}}(e,t,a,`${o}[${t}]`,n))})}}function _(e){try{return{ok:!0,value:JSON.parse(e)}}catch(t){return{ok:!1,error:{code:"INVALID_JSON",message:t instanceof Error?t.message:"The file is not valid JSON."}}}}function V(e,t={}){try{const r=function(e){return{maxCells:h(e?.maxCells,i.maxCells,"maxCells"),maxLayers:h(e?.maxLayers,i.maxLayers,"maxLayers"),maxLayerIdLength:h(e?.maxLayerIdLength,i.maxLayerIdLength,"maxLayerIdLength"),maxCharacterLength:h(e?.maxCharacterLength,i.maxCharacterLength,"maxCharacterLength"),maxMetadataStringLength:h(e?.maxMetadataStringLength,i.maxMetadataStringLength,"maxMetadataStringLength")}}(t.limits),n={limits:r,remainingCells:r.maxCells},a=I(e,"$"),o=p(a.format,"$.format");return"textmode.document"===o?{ok:!0,document:S(a,n),warnings:[]}:"textmode.layer"===o&&(t.acceptLegacy??!0)?{ok:!0,document:R(a,n),warnings:[{code:"LEGACY_DOCUMENT_MIGRATED",message:"Migrated a legacy textmode.layer document to textmode.document 2.0.0."}]}:{ok:!1,error:{code:"UNSUPPORTED_FORMAT",message:`Unsupported textmode document format: ${o}.`,..."$.format"?{path:"$.format"}:{}}}}catch(r){if(r instanceof s)return{ok:!1,error:r.detail};throw r}}function w(e,t={}){const r=_(e);return r.ok?V(r.value,t):r}function S(e,t){const r=p(e.formatVersion,"$.formatVersion");"2.0.0"!==r&&b("UNSUPPORTED_VERSION",`Unsupported textmode.document version: ${r}.`,"$.formatVersion");const n=p(e.target,"$.target");return"selected"===n?v(e,t):"all"===n?U(e,t):void b("UNSUPPORTED_TARGET",`Unsupported textmode document target: ${n}.`,"$.target")}function R(e,t){const r=p(e.formatVersion,"$.formatVersion");return"1.0.0"===r?v(e,t):"1.1.0"===r?U(e,t):void b("UNSUPPORTED_VERSION",`Unsupported legacy textmode.layer version: ${r}.`,"$.formatVersion")}export{i as DEFAULT_TEXTMODE_DOCUMENT_LIMITS,a as LEGACY_TEXTMODE_ALL_VERSION,r as LEGACY_TEXTMODE_LAYER_FORMAT,n as LEGACY_TEXTMODE_SELECTED_VERSION,e as TEXTMODE_DOCUMENT_FORMAT,t as TEXTMODE_DOCUMENT_FORMAT_VERSION,o as TEXTMODE_OBJECT_ROWS_ENCODING,V as decodeTextmodeDocument,_ as parseJSON,w as parseTextmodeDocumentJSON};

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

@@ -1,32 +0,0 @@
-/**
- * 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

@@ -1,4 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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

@@ -1,13 +0,0 @@
-/**
- * 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

@@ -1,3 +0,0 @@
-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

@@ -1,209 +0,0 @@
-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

@@ -1,37 +0,0 @@
-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;