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

package/dist/types/types.d.ts

@@ -3,53 +3,42 @@ 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.
  *
- * @category Overlay
- *
  * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/TXTOverlayDefaults | TXTOverlayDefaults API reference}
  */
 export type TXTOverlayDefaults = Pick<TXTExportOptions, 'preserveTrailingSpaces' | 'emptyCharacter'>;
 /**
  * Default JSON export fields controlled by the export overlay.
  *
- * @category Overlay
- *
  * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/JSONOverlayDefaults | JSONOverlayDefaults API reference}
  */
 export type JSONOverlayDefaults = Pick<JSONExportOptions, 'target' | 'pretty' | 'includeMetadata' | 'colorMode'>;
 /**
  * Default image export fields controlled by the export overlay.
  *
- * @category Overlay
- *
  * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/ImageOverlayDefaults | ImageOverlayDefaults API reference}
  */
 export type ImageOverlayDefaults = Pick<ImageExportOptions, 'format' | 'scale'>;
 /**
  * Default SVG export fields controlled by the export overlay.
  *
- * @category Overlay
- *
  * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/SVGOverlayDefaults | SVGOverlayDefaults API reference}
  */
 export type SVGOverlayDefaults = Pick<SVGExportOptions, 'includeBackgroundRectangles' | 'drawMode' | 'strokeWidth'>;
 /**
  * Default GIF export fields controlled by the export overlay.
  *
- * @category Overlay
- *
  * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/GIFOverlayDefaults | GIFOverlayDefaults API reference}
  */
 export type GIFOverlayDefaults = Pick<GIFExportOptions, 'frameCount' | 'frameRate' | 'scale' | 'repeat'>;
 /**
  * Default video export fields controlled by the export overlay.
  *
- * @category Overlay
- *
  * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/VideoOverlayDefaults | VideoOverlayDefaults API reference}
  */
 export type VideoOverlayDefaults = Pick<VideoExportOptions, 'format' | 'frameCount' | 'frameRate' | 'quality' | 'hardwareAcceleration' | 'keyFrameInterval' | 'transparent'>;
@@ -63,8 +52,6 @@ export type VideoOverlayDefaults = Pick<VideoExportOptions, 'format' | 'frameCou
  * {@link ExportOverlayController.getDefaults} and
  * {@link ExportOverlayController.setDefaults}.
  *
- * @category Overlay
- *
  * @see {@link https://code.textmode.art/api/textmode.export.js/type-aliases/ExportDefaults | ExportDefaults API reference}
  */
 export type ExportDefaults = {
@@ -88,8 +75,6 @@ export type ExportDefaults = {
  * format's curated defaults. Top-level `format` changes the overlay's selected
  * format. Omitted keys keep their current value.
  *
- * @category Overlay
- *
  * @example
  * ```ts
  * t.exportOverlay.setDefaults({ format: 'image', image: { scale: 2 }, gif: { frameRate: 30 } });
@@ -108,8 +93,6 @@ export type ExportDefaultsPatch = {
  * `auto` means the overlay is using the library default offset from the
  * textmode canvas. `custom` means the user or runtime API has moved it.
  *
- * @category Overlay
- *
  * @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/ExportOverlayPosition | ExportOverlayPosition API reference}
  */
 export interface ExportOverlayPosition {
@@ -120,8 +103,6 @@ export interface ExportOverlayPosition {
 /**
  * Canvas-relative placement coordinates for the export overlay UI.
  *
- * @category Overlay
- *
  * @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/ExportOverlayPositionInput | ExportOverlayPositionInput API reference}
  */
 export interface ExportOverlayPositionInput {
@@ -131,8 +112,6 @@ export interface ExportOverlayPositionInput {
 /**
  * Controller for managing the export overlay UI visibility at runtime.
  *
- * @category Overlay
- *
  * @see {@link https://code.textmode.art/api/textmode.export.js/interfaces/ExportOverlayController | ExportOverlayController API reference}
  */
 export interface ExportOverlayController {
@@ -282,8 +261,6 @@ export interface ExportOverlayController {
 /**
  * Runtime export helpers that `ExportPlugin` attaches to the `Textmodifier` instance.
  *
- * @category Workflow
- *
  * @example
  * {@includeCode ../examples/ExportPlugin/layerTargets/sketch.js}
  *
@@ -388,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.
@@ -397,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.
@@ -418,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.
      *
@@ -514,8 +493,6 @@ export interface TextmodeExportAPI {
      * @returns A promise that resolves after the archive download is initiated.
      * @throws {Error} When validation, capture, serialization, archive writing, or download fails.
      *
-     * @category ZIP frame-sequence export
-     *
      * @example
      * ```ts
      * await t.saveZip({
@@ -540,8 +517,6 @@ export interface TextmodeExportAPI {
      * @returns The completed `application/zip` blob.
      * @throws {Error} When validation, capture, serialization, archive writing, or cancellation fails.
      *
-     * @category ZIP frame-sequence export
-     *
      * @example
      * ```ts
      * const archive = await t.toZipBlob({ format: 'svg', frameCount: 60, frameRate: 24 });

package/package.json

@@ -1,12 +1,12 @@
 {
 	"name": "textmode.export.js",
-	"version": "1.9.0-beta.1",
+	"version": "1.9.0",
 	"description": "Export plugin for textmode.js - Save images, GIFs, videos, SVG, JSON, text, and ZIP frame sequences.",
 	"type": "module",
 	"devEngines": {
 		"runtime": {
 			"name": "node",
-			"version": "^24.0.0",
+			"version": ">=24.0.0",
 			"onFail": "error"
 		},
 		"packageManager": {
@@ -63,21 +63,24 @@
 		"textmode.js": "^0.18.0"
 	},
 	"dependencies": {
+		"@textmode/document": "1.1.0",
 		"fflate": "0.8.3",
 		"gifenc": "^1.0.1",
-		"mediabunny": "1.55.2"
+		"mediabunny": "1.62.1"
 	},
 	"devDependencies": {
-		"@textmode/build": "^0.1.0",
+		"@textmode/build": "^0.1.1",
 		"@textmode/docs": "^0.3.0",
-		"@textmode/lint": "^0.1.0",
+		"@textmode/lint": "^0.1.2",
 		"@textmode/release": "^0.2.0",
-		"@textmode/tsconfig": "^0.2.1",
-		"@types/node": "^24.0.0",
+		"@textmode/tsconfig": "^0.2.2",
+		"@types/node": "^26.4.1",
+		"ajv": "^8.20.0",
+		"ajv-formats": "^3.0.1",
 		"textmode.js": "^0.18.0",
 		"typescript": "^6.0.3",
 		"vite-plugin-css-injected-by-js": "^5.0.2",
-		"vitest": "^4.1.10"
+		"vitest": "^5.0.0"
 	},
 	"keywords": [
 		"textmode",