textmode.export.js 1.3.0 → 1.5.0

package/dist/types/types.d.ts

@@ -3,7 +3,7 @@ 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, TextmodeLayerJSON } from './exporters/json';
+import type { JSONExportOptions, TextmodeDocumentJSON } from './exporters/json';
 /**
  * Controller for managing the export overlay UI visibility at runtime.
  */
@@ -47,6 +47,9 @@ export interface ExportOverlayController {
 }
 /**
  * Runtime export helpers that `createExportPlugin` attaches to the `Textmodifier` instance.
+ *
+ * @example
+ * {@includeCode ../examples/ExportPlugin/layerTargets/sketch.js}
  */
 export interface TextmodeExportAPI {
     /**
@@ -76,83 +79,86 @@ export interface TextmodeExportAPI {
      */
     copyCanvas(options?: ImageExportOptions): Promise<void>;
     /**
-     * Downloads the current frame as an SVG file.
+     * Downloads the selected layer as an SVG file.
      *
      * @param options Export options.
      *
      * @example
      * ```ts
-     * t.saveSVG({ filename: 'poster', includeBackgroundRectangles: true });
+     * t.saveSVG({ filename: 'poster', layer: t.layers.base, includeBackgroundRectangles: true });
      * ```
      */
     saveSVG(options?: SVGExportOptions): void;
     /**
-     * Downloads the current text content as a plain-text file.
+     * Downloads the selected layer's text content as a plain-text file.
      *
      * @param options Export options.
      *
      * @example
      * ```ts
-     * t.saveStrings({ filename: 'frame', preserveTrailingSpaces: true });
+     * t.saveStrings({ filename: 'frame', layer: t.layers.base, preserveTrailingSpaces: true });
      * ```
      */
     saveStrings(options?: TXTExportOptions): void;
     /**
-     * Generates the SVG markup for the current frame.
+     * Generates SVG markup for the selected layer.
      *
      * @param options Export options.
      * @returns The SVG content representing the artwork.
      *
      * @example
      * ```ts
-     * const svg = t.toSVG({ drawMode: 'stroke', strokeWidth: 1.5 });
+     * const svg = t.toSVG({ layer: t.layers.base, drawMode: 'stroke', strokeWidth: 1.5 });
      * ```
      */
     toSVG(options?: SVGExportOptions): string;
     /**
-     * Produces the current text content as a string.
+     * Produces the selected layer's text content as a string.
      *
      * @param options Export options.
      * @returns The textual representation of the artwork.
      *
      * @example
      * ```ts
-     * const text = t.toString({ preserveTrailingSpaces: false });
+     * const text = t.toString({ layer: t.layers.base, preserveTrailingSpaces: false });
      * ```
      */
     toString(options?: TXTExportOptions): string;
     /**
-     * Produces the current base layer as structured JSON data.
+     * Produces the selected layer or layer stack as structured JSON data.
      *
      * @param options Export options.
-     * @returns The JSON document representing the current base layer.
+     * @returns The JSON document representing the selected layer or layer stack.
      *
      * @example
      * ```ts
-     * const layer = t.toJSON({ colorMode: 'hex', includeMetadata: true });
+     * const layer = t.toJSON({ layer: t.layers.base, colorMode: 'hex', includeMetadata: true });
+     * const stack = t.toJSON({ target: 'all' });
      * ```
      */
-    toJSON(options?: JSONExportOptions): TextmodeLayerJSON;
+    toJSON(options?: JSONExportOptions): TextmodeDocumentJSON;
     /**
-     * Produces the current base layer as a JSON string.
+     * Produces the selected layer or layer stack as a JSON string.
      *
      * @param options Export options.
-     * @returns Serialized JSON string for the current base layer.
+     * @returns Serialized JSON string for the selected layer or layer stack.
      *
      * @example
      * ```ts
-     * const json = t.toJSONString({ pretty: false, colorMode: 'hex' });
+     * const json = t.toJSONString({ layer: t.layers.base, pretty: false, colorMode: 'hex' });
+     * const stackJson = t.toJSONString({ target: 'all' });
      * ```
      */
     toJSONString(options?: JSONExportOptions): string;
     /**
-     * Downloads the current base layer as a JSON file.
+     * Downloads the selected layer or layer stack as a JSON file.
      *
      * @param options Export options.
      *
      * @example
      * ```ts
-     * t.saveJSON({ filename: 'frame', pretty: true });
+     * t.saveJSON({ filename: 'frame', layer: t.layers.base, pretty: true });
+     * t.saveJSON({ filename: 'stack', target: 'all' });
      * ```
      */
     saveJSON(options?: JSONExportOptions): void;
@@ -168,16 +174,25 @@ export interface TextmodeExportAPI {
      */
     saveGIF(options?: GIFExportOptions): Promise<void>;
     /**
-     * Captures a WEBM video and saves it to disk.
+     * Captures a video and saves it to disk *(`'mp4'` by default)*.
      *
      * @param options Export options.
      *
      * @example
      * ```ts
-     * await t.saveWEBM({ frameCount: 240, frameRate: 60, filename: 'capture' });
+     * await t.saveVideo({ frameCount: 240, frameRate: 60, filename: 'capture' });
+     * await t.saveVideo({
+     *     format: 'webm',
+     *     bitrate: 'high',
+     *     bitrateMode: 'variable',
+     *     latencyMode: 'quality',
+     *     keyFrameInterval: 2,
+     *     frameCount: 240,
+     *     filename: 'capture',
+     * });
      * ```
      */
-    saveWEBM(options?: VideoExportOptions): Promise<void>;
+    saveVideo(options?: VideoExportOptions): Promise<void>;
 }
 /**
  * Options for configuring the export plugin.

package/dist/types/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;;;;;OAOG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb;;;;;;;OAOG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb;;;;;;;OAOG;IACH,MAAM,IAAI,IAAI,CAAC;IAEf;;;;;;;OAOG;IACH,SAAS,IAAI,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IACjC;;OAEG;IACH,aAAa,EAAE,uBAAuB,CAAC;IAEvC;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;;;;;;OASG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE1C;;;;;;;;;OASG;IACH,WAAW,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE9C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAAC;IAE1C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAAC;IAE7C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,iBAAiB,CAAC;IAEvD;;;;;;;;;;OAUG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,MAAM,CAAC;IAElD;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAE5C;;;;;;;;;OASG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,2BAA2B;IAC3C;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAEhF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;;;;;OAOG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb;;;;;;;OAOG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb;;;;;;;OAOG;IACH,MAAM,IAAI,IAAI,CAAC;IAEf;;;;;;;OAOG;IACH,SAAS,IAAI,OAAO,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IACjC;;OAEG;IACH,aAAa,EAAE,uBAAuB,CAAC;IAEvC;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;;;;;;OASG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE1C;;;;;;;;;OASG;IACH,WAAW,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE9C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAAC;IAE1C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAAC;IAE7C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,oBAAoB,CAAC;IAE1D;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,MAAM,CAAC;IAElD;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAE5C;;;;;;;;;OASG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,2BAA2B;IAC3C;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "textmode.export.js",
-	"version": "1.3.0",
+	"version": "1.5.0",
 	"description": "Export plugin for textmode.js - Save your creations as images, GIFs, videos, SVG, JSON, and plain text.",
 	"type": "module",
 	"main": "./dist/textmode.export.umd.js",
@@ -43,11 +43,11 @@
 		"prepare": "husky"
 	},
 	"peerDependencies": {
-		"textmode.js": ">=0.10.0"
+		"textmode.js": ">=0.13.0"
 	},
 	"dependencies": {
 		"gifenc": "^1.0.1",
-		"webm-writer": "^1.0.0"
+		"mediabunny": "^1.45.4"
 	},
 	"devDependencies": {
 		"@commitlint/cli": "^20.5.0",
@@ -56,6 +56,7 @@
 		"@rollup/plugin-terser": "^0.4.4",
 		"@semantic-release/commit-analyzer": "^13.0.1",
 		"@semantic-release/exec": "^7.1.0",
+		"@semantic-release/git": "^10.0.1",
 		"@semantic-release/github": "^12.0.6",
 		"@semantic-release/npm": "^13.1.5",
 		"@semantic-release/release-notes-generator": "^14.1.0",
@@ -72,7 +73,7 @@
 		"prettier": "^3.8.3",
 		"semantic-release": "^25.0.3",
 		"terser": "^5.44.0",
-		"textmode.js": "^0.12.0",
+		"textmode.js": "^0.16.0",
 		"typedoc": "^0.28.19",
 		"typedoc-plugin-frontmatter": "^1.3.1",
 		"typedoc-plugin-markdown": "^4.11.0",