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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/README.md +7 -2
  2. package/dist/textmode.export.esm.js +1 -1
  3. package/dist/textmode.export.umd.js +1 -1
  4. package/dist/types/exporters/base/FileHandler.d.ts +1 -14
  5. package/dist/types/exporters/base/FilenamePolicy.d.ts +6 -0
  6. package/dist/types/exporters/base/FramePreparation.d.ts +7 -0
  7. package/dist/types/exporters/base/frame-sequence/ExclusiveCaptureGate.d.ts +7 -0
  8. package/dist/types/exporters/base/frame-sequence/FrameSchedule.d.ts +8 -0
  9. package/dist/types/exporters/{video/VideoFrameDriver.d.ts → base/frame-sequence/FrameSequenceDriver.d.ts} +5 -11
  10. package/dist/types/exporters/base/frame-sequence/errors.d.ts +12 -0
  11. package/dist/types/exporters/base/frame-sequence/index.d.ts +5 -0
  12. package/dist/types/exporters/base/frame-sequence/types.d.ts +20 -0
  13. package/dist/types/exporters/base/frame-sequence/withAbortableTimeout.d.ts +1 -0
  14. package/dist/types/exporters/base/index.d.ts +3 -0
  15. package/dist/types/exporters/gif/GIFExporter.d.ts +1 -1
  16. package/dist/types/exporters/gif/index.d.ts +0 -1
  17. package/dist/types/exporters/gif/types.d.ts +6 -12
  18. package/dist/types/exporters/json/JSONExporter.d.ts +2 -2
  19. package/dist/types/exporters/video/VideoEncodingPolicy.d.ts +2 -19
  20. package/dist/types/exporters/video/VideoExporter.d.ts +4 -6
  21. package/dist/types/exporters/video/VideoRecorder.d.ts +2 -1
  22. package/dist/types/exporters/video/errors.d.ts +1 -0
  23. package/dist/types/exporters/video/index.d.ts +1 -1
  24. package/dist/types/exporters/video/types.d.ts +104 -107
  25. package/dist/types/exporters/zip/FrameSerializerRegistry.d.ts +4 -0
  26. package/dist/types/exporters/zip/ZIPArchiveWriter.d.ts +21 -0
  27. package/dist/types/exporters/zip/ZIPExporter.d.ts +32 -0
  28. package/dist/types/exporters/zip/ZIPManifest.d.ts +12 -0
  29. package/dist/types/exporters/zip/errors.d.ts +14 -0
  30. package/dist/types/exporters/zip/index.d.ts +3 -0
  31. package/dist/types/exporters/zip/types.d.ts +177 -0
  32. package/dist/types/index.d.ts +34 -6
  33. package/dist/types/overlay/blades/VideoBlade.d.ts +3 -6
  34. package/dist/types/overlay/types.d.ts +2 -4
  35. package/dist/types/runtime/TextmodeExportController.d.ts +3 -0
  36. package/dist/types/types.d.ts +72 -11
  37. package/package.json +6 -3
  38. package/dist/types/exporters/gif/GIFRecorder.d.ts +0 -23
package/README.md CHANGED
@@ -4,12 +4,12 @@
4
4
 
5
5
  <img alt="textmode.export.js — save textmode in every format" src=".github/assets/readme-og.png" />
6
6
 
7
- | [![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/) [![Vite](https://img.shields.io/badge/Vite-646CFF?logo=vite&logoColor=white)](https://vitejs.dev/) | [![API](https://img.shields.io/badge/API-typedoc-3178c6?logo=typescript&logoColor=white)](https://code.textmode.art/api/textmode.export.js/) [![docs](https://img.shields.io/badge/docs-vitepress-646cff?logo=vitepress&logoColor=white)](https://code.textmode.art/docs/exporting.html) [![Discord](https://img.shields.io/discord/1357070706181017691?color=5865F2&label=Discord&logo=discord&logoColor=white)](https://discord.gg/sjrw8QXNks) | [![ko-fi](https://shields.io/badge/ko--fi-donate-ff5f5f?logo=ko-fi)](https://ko-fi.com/V7V8JG2FY) [![GitHub-sponsors](https://img.shields.io/badge/sponsor-30363D?logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/humanbydefinition) |
7
+ | [![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/) [![Vite](https://img.shields.io/badge/Vite-646CFF?logo=vite&logoColor=white)](https://vitejs.dev/) | [![API](https://img.shields.io/badge/API-typedoc-3178c6?logo=typescript&logoColor=white)](https://code.textmode.art/api/textmode.export.js/) [![docs](https://img.shields.io/badge/docs-vitepress-646cff?logo=vitepress&logoColor=white)](https://code.textmode.art/docs/exporting.html) | [![ko-fi](https://shields.io/badge/ko--fi-donate-ff5f5f?logo=ko-fi)](https://ko-fi.com/V7V8JG2FY) [![GitHub-sponsors](https://img.shields.io/badge/sponsor-30363D?logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/humanbydefinition) |
8
8
  |:---|:---|:---|
9
9
 
10
10
  </div>
11
11
 
12
- `textmode.export.js` is an export add-on for [`textmode.js`](https://github.com/humanbydefinition/textmode.js) that turns a sketch into shareable files and data. Through one consistent browser-based API, it produces plain text and JSON, raster images, animated GIFs, WebM and MP4 video, and scalable vector graphics.
12
+ `textmode.export.js` is an export add-on for [`textmode.js`](https://github.com/humanbydefinition/textmode.js) that turns a sketch into shareable files and data. Through one consistent browser-based API, it produces plain text and JSON, raster images, animated GIFs, WebM and MP4 video, scalable vector graphics, and ZIP frame sequences.
13
13
 
14
14
  Choose a compact still, structured document data, or a complete animation to suit the way your work will be used. `textmode.export.js` offers programmatic controls for automated workflows and an optional overlay UI for people saving and sharing directly from a sketch.
15
15
 
@@ -22,6 +22,7 @@ Choose a compact still, structured document data, or a complete animation to sui
22
22
  - **Interactive overlay** - Built-in format controls, live layer selectors, runtime defaults, visibility controls, and remembered placement
23
23
  - **Clipboard workflows** - Copy text, JSON, SVG, and raster output without downloading files
24
24
  - **Controlled animation capture** - Configure frames, frame rate, scale, GIF repetition, video encoding, transparency, progress, and more
25
+ - **ZIP frame sequences** - Archive deterministic PNG, JPEG, WebP, SVG, JSON, or TXT frames with a versioned manifest
25
26
 
26
27
  ## Try it online first
27
28
 
@@ -104,3 +105,7 @@ Contribution details and profile links are maintained on the [textmode.js contri
104
105
  - **[gifenc](https://github.com/mattdesl/gifenc)**
105
106
  - Animated GIF encoding by [Matt DesLauriers](https://github.com/mattdesl).
106
107
  - License: [MIT License](https://github.com/mattdesl/gifenc/blob/main/LICENSE.md).
108
+
109
+ - **[fflate](https://github.com/101arrowz/fflate)**
110
+ - Streaming ZIP archive creation by [101arrowz](https://github.com/101arrowz).
111
+ - License: [MIT License](https://github.com/101arrowz/fflate/blob/master/LICENSE).