textmode.export.js 1.2.1 → 1.3.0-beta.1

package/dist/types/types.d.ts

@@ -3,24 +3,45 @@ 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';
 /**
  * Controller for managing the export overlay UI visibility at runtime.
  */
 export interface ExportOverlayController {
     /**
      * Shows the export overlay UI.
+     *
+     * @example
+     * ```ts
+     * t.exportOverlay.show();
+     * ```
      */
     show(): void;
     /**
      * Hides the export overlay UI.
+     *
+     * @example
+     * ```ts
+     * t.exportOverlay.hide();
+     * ```
      */
     hide(): void;
     /**
      * Toggles the export overlay UI visibility.
+     *
+     * @example
+     * ```ts
+     * t.exportOverlay.toggle();
+     * ```
      */
     toggle(): void;
     /**
      * Checks if the export overlay is currently visible.
+     *
+     * @example
+     * ```ts
+     * const visible = t.exportOverlay.isVisible();
+     * ```
      */
     isVisible(): boolean;
 }
@@ -34,44 +55,127 @@ export interface TextmodeExportAPI {
     exportOverlay: ExportOverlayController;
     /**
      * Saves the current canvas content to an image file *(`'png'` by default)*.
+     *
      * @param options Export options.
+     *
+     * @example
+     * ```ts
+     * await t.saveCanvas({ format: 'png', filename: 'frame-001' });
+     * ```
      */
     saveCanvas(options?: ImageExportOptions): Promise<void>;
     /**
      * Copies the current canvas to the user's clipboard as an image.
+     *
      * @param options Export options.
+     *
+     * @example
+     * ```ts
+     * await t.copyCanvas({ format: 'png' });
+     * ```
      */
     copyCanvas(options?: ImageExportOptions): Promise<void>;
     /**
      * Downloads the current frame as an SVG file.
+     *
      * @param options Export options.
+     *
+     * @example
+     * ```ts
+     * t.saveSVG({ filename: 'poster', includeBackgroundRectangles: true });
+     * ```
      */
     saveSVG(options?: SVGExportOptions): void;
     /**
      * Downloads the current text content as a plain-text file.
+     *
      * @param options Export options.
+     *
+     * @example
+     * ```ts
+     * t.saveStrings({ filename: 'frame', preserveTrailingSpaces: true });
+     * ```
      */
     saveStrings(options?: TXTExportOptions): void;
     /**
      * Generates the SVG markup for the current frame.
+     *
      * @param options Export options.
      * @returns The SVG content representing the artwork.
+     *
+     * @example
+     * ```ts
+     * const svg = t.toSVG({ drawMode: 'stroke', strokeWidth: 1.5 });
+     * ```
      */
     toSVG(options?: SVGExportOptions): string;
     /**
      * Produces the current text content as a string.
+     *
      * @param options Export options.
      * @returns The textual representation of the artwork.
+     *
+     * @example
+     * ```ts
+     * const text = t.toString({ preserveTrailingSpaces: false });
+     * ```
      */
     toString(options?: TXTExportOptions): string;
+    /**
+     * Produces the current base layer as structured JSON data.
+     *
+     * @param options Export options.
+     * @returns The JSON document representing the current base layer.
+     *
+     * @example
+     * ```ts
+     * const layer = t.toJSON({ colorMode: 'hex', includeMetadata: true });
+     * ```
+     */
+    toJSON(options?: JSONExportOptions): TextmodeLayerJSON;
+    /**
+     * Produces the current base layer as a JSON string.
+     *
+     * @param options Export options.
+     * @returns Serialized JSON string for the current base layer.
+     *
+     * @example
+     * ```ts
+     * const json = t.toJSONString({ pretty: false, colorMode: 'hex' });
+     * ```
+     */
+    toJSONString(options?: JSONExportOptions): string;
+    /**
+     * Downloads the current base layer as a JSON file.
+     *
+     * @param options Export options.
+     *
+     * @example
+     * ```ts
+     * t.saveJSON({ filename: 'frame', pretty: true });
+     * ```
+     */
+    saveJSON(options?: JSONExportOptions): void;
     /**
      * Records an animated GIF and saves it to disk.
+     *
      * @param options Export options.
+     *
+     * @example
+     * ```ts
+     * await t.saveGIF({ frameCount: 120, frameRate: 30, filename: 'loop' });
+     * ```
      */
     saveGIF(options?: GIFExportOptions): Promise<void>;
     /**
      * Captures a WEBM video and saves it to disk.
+     *
      * @param options Export options.
+     *
+     * @example
+     * ```ts
+     * await t.saveWEBM({ frameCount: 240, frameRate: 60, filename: 'capture' });
+     * ```
      */
     saveWEBM(options?: VideoExportOptions): Promise<void>;
 }

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;AAE5D;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb;;OAEG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb;;OAEG;IACH,MAAM,IAAI,IAAI,CAAC;IAEf;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,aAAa,EAAE,uBAAuB,CAAC;IAEvC;;;OAGG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;OAGG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;OAGG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE1C;;;OAGG;IACH,WAAW,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE9C;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAAC;IAE1C;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAAC;IAE7C;;;OAGG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB"}
+{"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"}

package/dist/types/utils/pixels.d.ts

@@ -1,5 +1,6 @@
 /**
  * Convert a pixel array to an RGBA object.
+ *
  * @param pixels Pixel array (Uint8Array)
  * @param index Starting index in the pixel array
  * @returns RGBA object

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

@@ -1 +1 @@
-{"version":3,"file":"pixels.d.ts","sourceRoot":"","sources":["../../../src/utils/pixels.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,GAAG;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAO9G"}
+{"version":3,"file":"pixels.d.ts","sourceRoot":"","sources":["../../../src/utils/pixels.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,GAAG;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAO9G"}

package/dist/types/version.d.ts

@@ -0,0 +1,2 @@
+export declare const TEXTMODE_EXPORT_VERSION = "1.2.1";
+//# sourceMappingURL=version.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,uBAAuB,UAAU,CAAC"}

package/package.json

@@ -1,71 +1,118 @@
-{
-  "name": "textmode.export.js",
-  "version": "1.2.1",
-  "description": "Export plugin for textmode.js - Save your creations as images, GIFs, videos, SVG, and plain text.",
-  "type": "module",
-  "types": "./dist/types/index.d.ts",
-  "main": "./dist/textmode.export.umd.js",
-  "module": "./dist/textmode.export.esm.js",
-  "exports": {
-    ".": {
-      "types": "./dist/types/index.d.ts",
-      "import": "./dist/textmode.export.esm.js",
-      "require": "./dist/textmode.export.umd.js"
-    }
-  },
-  "scripts": {
-    "dev": "vite --port 5174",
-    "build": "vite build && tsc",
-    "preview": "vite preview",
-    "build:docs": "typedoc",
-    "dev:docs": "typedoc --watch"
-  },
-  "devDependencies": {
-    "@rollup/plugin-terser": "^0.4.4",
-    "@types/node": "^24.5.2",
-    "terser": "^5.44.0",
-    "typedoc": "^0.28.13",
-    "typedoc-plugin-frontmatter": "^1.3.1",
-    "typedoc-plugin-markdown": "^4.9.0",
-    "typedoc-vitepress-theme": "^1.1.2",
-    "typescript": "~5.8.3",
-    "vite": "^7.1.7",
-    "vite-plugin-css-injected-by-js": "^3.5.2"
-  },
-  "dependencies": {
-    "gifenc": "^1.0.1",
-    "webm-writer": "^1.0.0",
-    "textmode.js": ">=0.7.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/humanbydefinition/textmode.export.js.git"
-  },
-  "keywords": [
-    "textmode",
-    "textmode.js",
-    "ascii",
-    "petscii",
-    "export",
-    "plugin",
-    "gif",
-    "video",
-    "webm",
-    "svg",
-    "image",
-    "png",
-    "jpg",
-    "webp",
-    "creative-coding",
-    "canvas"
-  ],
-  "author": "humanbydefinition",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/humanbydefinition/textmode.export.js/issues"
-  },
-  "homepage": "https://code.textmode.art",
-  "files": [
-    "dist"
-  ]
-}
+{
+	"name": "textmode.export.js",
+	"version": "1.3.0-beta.1",
+	"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",
+	"module": "./dist/textmode.export.esm.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/textmode.export.esm.js",
+			"require": "./dist/textmode.export.umd.js"
+		}
+	},
+	"sideEffects": [
+		"./dist/textmode.export.esm.js",
+		"./dist/textmode.export.umd.js"
+	],
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"dev": "vite --port 5174 --host",
+		"build:bundle": "vite build",
+		"build:types": "tsc",
+		"build": "npm run build:bundle && npm run build:types",
+		"check": "npm run check:format && npm run lint && npm run lint:md && npm run check:types && npm run check:api-docs && npm run test && npm run build",
+		"check:api-docs": "node ./scripts/check-public-api-docs.mjs",
+		"dev:docs": "typedoc --watch",
+		"build:docs": "typedoc",
+		"preview": "vite preview",
+		"test": "vitest run --passWithNoTests",
+		"test:watch": "vitest --passWithNoTests",
+		"test:ui": "vitest --ui --passWithNoTests",
+		"test:coverage": "vitest --coverage --passWithNoTests",
+		"format": "prettier --write .",
+		"check:format": "prettier --check .",
+		"check:types": "tsc --noEmit",
+		"lint:md": "markdownlint-cli2",
+		"lint:md:fix": "markdownlint-cli2 --fix",
+		"lint": "eslint src --config eslint.config.js",
+		"prepare": "husky"
+	},
+	"peerDependencies": {
+		"textmode.js": ">=0.10.0"
+	},
+	"dependencies": {
+		"gifenc": "^1.0.1",
+		"webm-writer": "^1.0.0"
+	},
+	"devDependencies": {
+		"@commitlint/cli": "^20.5.0",
+		"@commitlint/config-conventional": "^20.5.0",
+		"@eslint/js": "^9.39.4",
+		"@rollup/plugin-terser": "^0.4.4",
+		"@semantic-release/commit-analyzer": "^13.0.1",
+		"@semantic-release/exec": "^7.1.0",
+		"@semantic-release/github": "^12.0.6",
+		"@semantic-release/npm": "^13.1.5",
+		"@semantic-release/release-notes-generator": "^14.1.0",
+		"@types/node": "^24.0.13",
+		"@vitest/ui": "^3.1.2",
+		"eslint": "^9.39.2",
+		"eslint-plugin-jsdoc": "^62.9.0",
+		"globals": "^17.5.0",
+		"husky": "^9.1.7",
+		"jsdom": "^26.1.0",
+		"lint-staged": "^16.4.0",
+		"markdownlint-cli2": "^0.22.1",
+		"markdownlint-cli2-formatter-default": "^0.0.6",
+		"prettier": "^3.8.3",
+		"semantic-release": "^25.0.3",
+		"terser": "^5.44.0",
+		"textmode.js": "^0.12.0",
+		"typedoc": "^0.28.19",
+		"typedoc-plugin-frontmatter": "^1.3.1",
+		"typedoc-plugin-markdown": "^4.11.0",
+		"typedoc-vitepress-theme": "^1.1.2",
+		"typescript": "^5.9.2",
+		"typescript-eslint": "^8.59.0",
+		"vite": "^6.3.4",
+		"vite-plugin-css-injected-by-js": "^3.5.2",
+		"vitest": "^3.1.2"
+	},
+	"keywords": [
+		"textmode",
+		"textmode.js",
+		"ascii",
+		"petscii",
+		"export",
+		"plugin",
+		"gif",
+		"video",
+		"webm",
+		"svg",
+		"json",
+		"image",
+		"png",
+		"jpg",
+		"webp",
+		"creative-coding",
+		"canvas"
+	],
+	"author": "humanbydefinition <hello@textmode.art> (https://code.textmode.art)",
+	"license": "MIT",
+	"homepage": "https://code.textmode.art",
+	"lint-staged": {
+		"*": "prettier --ignore-unknown --write"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/humanbydefinition/textmode.export.js.git"
+	},
+	"bugs": {
+		"url": "https://github.com/humanbydefinition/textmode.export.js/issues"
+	}
+}