textmode.export.js 0.0.1

package/dist/types/overlay/utils/classes.d.ts

@@ -0,0 +1,35 @@
+export declare const overlayClasses: {
+    readonly root: "textmode-export-overlay";
+    readonly stack: "textmode-export-overlay__stack";
+    readonly stackDense: "textmode-export-overlay__stack--dense";
+    readonly stackCompact: "textmode-export-overlay__stack--compact";
+    readonly section: "textmode-export-overlay__section";
+    readonly header: "textmode-export-overlay__header";
+    readonly headerTitleRow: "textmode-export-overlay__header-title-row";
+    readonly headerLinks: "textmode-export-overlay__header-links";
+    readonly row: "textmode-export-overlay__row";
+    readonly label: "textmode-export-overlay__label";
+    readonly field: "textmode-export-overlay__field";
+    readonly fieldCompact: "textmode-export-overlay__field--compact";
+    readonly fieldDense: "textmode-export-overlay__field--dense";
+    readonly fieldFull: "textmode-export-overlay__field--full";
+    readonly fieldChannel: "textmode-export-overlay__field--channel";
+    readonly input: "textmode-export-overlay__input";
+    readonly checkbox: "textmode-export-overlay__checkbox";
+    readonly muted: "textmode-export-overlay__muted";
+    readonly status: "textmode-export-overlay__status";
+    readonly statusGif: "textmode-export-overlay__status--gif";
+    readonly statusVideo: "textmode-export-overlay__status--video";
+    readonly statusTitle: "textmode-export-overlay__status-title";
+    readonly statusValue: "textmode-export-overlay__status-value";
+    readonly divider: "textmode-export-overlay__divider";
+    readonly title: "textmode-export-overlay__title";
+    readonly button: "textmode-export-overlay__button";
+    readonly buttonPrimary: "textmode-export-overlay__button--primary";
+    readonly buttonSecondary: "textmode-export-overlay__button--secondary";
+    readonly buttonFull: "textmode-export-overlay__button--full";
+    readonly supportLink: "textmode-export-overlay__support-link";
+    readonly supportIcon: "textmode-export-overlay__support-icon";
+    readonly linkIcon: "textmode-export-overlay__link-icon";
+};
+//# sourceMappingURL=classes.d.ts.map

package/dist/types/overlay/utils/classes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"classes.d.ts","sourceRoot":"","sources":["../../../../src/overlay/utils/classes.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiCjB,CAAC"}

package/dist/types/types.d.ts

@@ -0,0 +1,63 @@
+import type { ImageExportOptions } from './exporters/image';
+import type { TXTExportOptions } from './exporters/txt';
+import type { SVGExportOptions } from './exporters/svg';
+import type { GIFExportOptions } from './exporters/gif';
+import type { VideoExportOptions } from './exporters/video';
+/**
+ * Runtime export helpers that `createExportPlugin` attaches to the `Textmodifier` instance.
+ */
+export interface TextmodeExportAPI {
+    /**
+     * Saves the current canvas content to an image file *(`'png'` by default)*.
+     * @param options Export options.
+     */
+    saveCanvas(options?: ImageExportOptions): Promise<void>;
+    /**
+     * Copies the current canvas to the user's clipboard as an image.
+     * @param options Export options.
+     */
+    copyCanvas(options?: ImageExportOptions): Promise<void>;
+    /**
+     * Downloads the current frame as an SVG file.
+     * @param options Export options.
+     */
+    saveSVG(options?: SVGExportOptions): void;
+    /**
+     * Downloads the current text content as a plain-text file.
+     * @param options Export options.
+     */
+    saveStrings(options?: TXTExportOptions): void;
+    /**
+     * Generates the SVG markup for the current frame.
+     * @param options Export options.
+     * @returns The SVG content representing the artwork.
+     */
+    toSVG(options?: SVGExportOptions): string;
+    /**
+     * Produces the current text content as a string.
+     * @param options Export options.
+     * @returns The textual representation of the artwork.
+     */
+    toString(options?: TXTExportOptions): string;
+    /**
+     * Records an animated GIF and saves it to disk.
+     * @param options Export options.
+     */
+    saveGIF(options?: GIFExportOptions): Promise<void>;
+    /**
+     * Captures a WEBM video and saves it to disk.
+     * @param options Export options.
+     */
+    saveWEBM(options?: VideoExportOptions): Promise<void>;
+}
+/**
+ * Options for configuring the export plugin.
+ */
+export interface TextmodeExportPluginOptions {
+    /**
+     * Controls whether the export overlay UI should be created.
+     * Defaults to `true`.
+     */
+    overlay?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +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,iBAAiB;IAChC;;;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;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB"}

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

@@ -0,0 +1,13 @@
+/**
+ * Convert a pixel array to an RGBA object.
+ * @param pixels Pixel array (Uint8Array)
+ * @param index Starting index in the pixel array
+ * @returns RGBA object
+ */
+export declare function pixelsToRGBA(pixels: Uint8Array, index: number): {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+};
+//# sourceMappingURL=pixels.d.ts.map

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

@@ -0,0 +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"}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "textmode.export.js",
+  "version": "0.0.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",
+    "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-markdown": "^4.9.0",
+    "typescript": "~5.8.3",
+    "vite": "^7.1.7",
+    "vite-plugin-css-injected-by-js": "^3.5.2"
+  },
+  "dependencies": {
+    "gifenc": "^1.0.1",
+    "textmode.js": "^0.3.2-beta.2",
+    "webm-writer": "^1.0.0"
+  },
+  "peerDependencies": {
+    "textmode.js": ">=0.4.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"
+  ]
+}