ducjs 2.4.0 → 3.0.3

package/README.md

@@ -1,3 +1,5 @@
+# ducjs
+
 <p align="center">
   <br/>
   <a href="https://duc.ducflair.com" target="_blank"><img width="256px" src="https://raw.githubusercontent.com/ducflair/assets/refs/heads/main/src/duc/duc-extended.png" /></a>
@@ -10,10 +12,7 @@
   </p>
 </p>
 
-
-# ducjs
-
-The `ducjs` package offers comprehensive TypeScript types and helper functions to work effortlessly with the `duc` CAD file format. Built with Flatbuffers and optimized for performance, this package enables you to parse, validate, and manipulate `duc` files with ease.
+The `ducjs` package offers comprehensive TypeScript types and helper functions to work effortlessly with the `duc` CAD file format. Built with SQLite and optimized for performance, this package enables you to parse, validate, and manipulate `duc` files with ease.
 
 ## Documentation
 
@@ -39,4 +38,4 @@ To ensure smooth releases with semantic-release, please follow [these guidelines
 
 ---
 
-*The duc format and libraries are constantly evolving, aiming to set new standards in the 2D CAD industry. Be a part of this transformation and help shape the future of design technology!*
+*The duc format and libraries are constantly evolving, aiming to set new standards in the 2D CAD industry. Be a part of this transformation and help shape the future of design technology!*

package/dist/enums.d.ts

@@ -0,0 +1,135 @@
+/**
+ * Native enum definitions for DUC types.
+ * Source of truth: duc.sql
+ */
+export declare enum VERTICAL_ALIGN {
+    TOP = 10,
+    MIDDLE = 11,
+    BOTTOM = 12
+}
+export declare enum TEXT_ALIGN {
+    LEFT = 10,
+    CENTER = 11,
+    RIGHT = 12
+}
+export declare enum LINE_SPACING_TYPE {
+    AT_LEAST = 10,
+    EXACTLY = 11,
+    MULTIPLE = 12
+}
+export declare enum STROKE_PLACEMENT {
+    INSIDE = 10,
+    CENTER = 11,
+    OUTSIDE = 12
+}
+export declare enum STROKE_PREFERENCE {
+    SOLID = 10,
+    DASHED = 11,
+    DOTTED = 12,
+    CUSTOM = 13
+}
+export declare enum STROKE_SIDE_PREFERENCE {
+    TOP = 10,
+    BOTTOM = 11,
+    LEFT = 12,
+    RIGHT = 13,
+    CUSTOM = 14,
+    ALL = 15
+}
+export declare enum STROKE_CAP {
+    BUTT = 10,
+    ROUND = 11,
+    SQUARE = 12
+}
+export declare enum STROKE_JOIN {
+    MITER = 10,
+    ROUND = 11,
+    BEVEL = 12
+}
+export declare enum LINE_HEAD {
+    ARROW = 10,
+    BAR = 11,
+    CIRCLE = 12,
+    CIRCLE_OUTLINED = 13,
+    TRIANGLE = 14,
+    TRIANGLE_OUTLINED = 15,
+    DIAMOND = 16,
+    DIAMOND_OUTLINED = 17,
+    CROSS = 18,
+    OPEN_ARROW = 19,
+    REVERSED_ARROW = 20,
+    REVERSED_TRIANGLE = 21,
+    REVERSED_TRIANGLE_OUTLINED = 22,
+    CONE = 23,
+    HALF_CONE = 24
+}
+export declare enum BEZIER_MIRRORING {
+    NONE = 10,
+    ANGLE = 11,
+    ANGLE_LENGTH = 12
+}
+export declare enum BLENDING {
+    MULTIPLY = 11,
+    SCREEN = 12,
+    OVERLAY = 13,
+    DARKEN = 14,
+    LIGHTEN = 15,
+    DIFFERENCE = 16,
+    EXCLUSION = 17
+}
+export declare enum ELEMENT_CONTENT_PREFERENCE {
+    SOLID = 12,
+    FILL = 14,
+    FIT = 15,
+    TILE = 16,
+    STRETCH = 17,
+    HATCH = 18
+}
+export declare enum HATCH_STYLE {
+    NORMAL = 10,
+    OUTER = 11,
+    IGNORE = 12
+}
+export declare enum IMAGE_STATUS {
+    PENDING = 10,
+    SAVED = 11,
+    ERROR = 12
+}
+export declare enum PRUNING_LEVEL {
+    CONSERVATIVE = 10,
+    BALANCED = 20,
+    AGGRESSIVE = 30
+}
+export declare enum BOOLEAN_OPERATION {
+    UNION = 10,
+    SUBTRACT = 11,
+    INTERSECT = 12,
+    EXCLUDE = 13
+}
+export declare enum YOUTUBE_STATES {
+    /** The YouTube player is unstarted. */
+    UNSTARTED = -1,
+    /** The YouTube player has ended. */
+    ENDED = 0,
+    /** The YouTube player is currently playing. */
+    PLAYING = 1,
+    /** The YouTube player is paused. */
+    PAUSED = 2,
+    /** The YouTube player is buffering. */
+    BUFFERING = 3,
+    /** The YouTube player is cued. */
+    CUED = 5
+}
+export declare enum HANDLE_TYPE {
+    HANDLE_IN = 10,
+    HANDLE_OUT = 11
+}
+export declare enum UNIT_SYSTEM {
+    METRIC = 10,
+    IMPERIAL = 11
+}
+export declare enum AXIS {
+    X = 10,
+    Y = 20,
+    Z = 30
+}

package/dist/enums.js

@@ -0,0 +1,155 @@
+/**
+ * Native enum definitions for DUC types.
+ * Source of truth: duc.sql
+ */
+export var VERTICAL_ALIGN;
+(function (VERTICAL_ALIGN) {
+    VERTICAL_ALIGN[VERTICAL_ALIGN["TOP"] = 10] = "TOP";
+    VERTICAL_ALIGN[VERTICAL_ALIGN["MIDDLE"] = 11] = "MIDDLE";
+    VERTICAL_ALIGN[VERTICAL_ALIGN["BOTTOM"] = 12] = "BOTTOM";
+})(VERTICAL_ALIGN || (VERTICAL_ALIGN = {}));
+export var TEXT_ALIGN;
+(function (TEXT_ALIGN) {
+    TEXT_ALIGN[TEXT_ALIGN["LEFT"] = 10] = "LEFT";
+    TEXT_ALIGN[TEXT_ALIGN["CENTER"] = 11] = "CENTER";
+    TEXT_ALIGN[TEXT_ALIGN["RIGHT"] = 12] = "RIGHT";
+})(TEXT_ALIGN || (TEXT_ALIGN = {}));
+export var LINE_SPACING_TYPE;
+(function (LINE_SPACING_TYPE) {
+    LINE_SPACING_TYPE[LINE_SPACING_TYPE["AT_LEAST"] = 10] = "AT_LEAST";
+    LINE_SPACING_TYPE[LINE_SPACING_TYPE["EXACTLY"] = 11] = "EXACTLY";
+    LINE_SPACING_TYPE[LINE_SPACING_TYPE["MULTIPLE"] = 12] = "MULTIPLE";
+})(LINE_SPACING_TYPE || (LINE_SPACING_TYPE = {}));
+export var STROKE_PLACEMENT;
+(function (STROKE_PLACEMENT) {
+    STROKE_PLACEMENT[STROKE_PLACEMENT["INSIDE"] = 10] = "INSIDE";
+    STROKE_PLACEMENT[STROKE_PLACEMENT["CENTER"] = 11] = "CENTER";
+    STROKE_PLACEMENT[STROKE_PLACEMENT["OUTSIDE"] = 12] = "OUTSIDE";
+})(STROKE_PLACEMENT || (STROKE_PLACEMENT = {}));
+export var STROKE_PREFERENCE;
+(function (STROKE_PREFERENCE) {
+    STROKE_PREFERENCE[STROKE_PREFERENCE["SOLID"] = 10] = "SOLID";
+    STROKE_PREFERENCE[STROKE_PREFERENCE["DASHED"] = 11] = "DASHED";
+    STROKE_PREFERENCE[STROKE_PREFERENCE["DOTTED"] = 12] = "DOTTED";
+    STROKE_PREFERENCE[STROKE_PREFERENCE["CUSTOM"] = 13] = "CUSTOM";
+})(STROKE_PREFERENCE || (STROKE_PREFERENCE = {}));
+export var STROKE_SIDE_PREFERENCE;
+(function (STROKE_SIDE_PREFERENCE) {
+    STROKE_SIDE_PREFERENCE[STROKE_SIDE_PREFERENCE["TOP"] = 10] = "TOP";
+    STROKE_SIDE_PREFERENCE[STROKE_SIDE_PREFERENCE["BOTTOM"] = 11] = "BOTTOM";
+    STROKE_SIDE_PREFERENCE[STROKE_SIDE_PREFERENCE["LEFT"] = 12] = "LEFT";
+    STROKE_SIDE_PREFERENCE[STROKE_SIDE_PREFERENCE["RIGHT"] = 13] = "RIGHT";
+    STROKE_SIDE_PREFERENCE[STROKE_SIDE_PREFERENCE["CUSTOM"] = 14] = "CUSTOM";
+    STROKE_SIDE_PREFERENCE[STROKE_SIDE_PREFERENCE["ALL"] = 15] = "ALL";
+})(STROKE_SIDE_PREFERENCE || (STROKE_SIDE_PREFERENCE = {}));
+export var STROKE_CAP;
+(function (STROKE_CAP) {
+    STROKE_CAP[STROKE_CAP["BUTT"] = 10] = "BUTT";
+    STROKE_CAP[STROKE_CAP["ROUND"] = 11] = "ROUND";
+    STROKE_CAP[STROKE_CAP["SQUARE"] = 12] = "SQUARE";
+})(STROKE_CAP || (STROKE_CAP = {}));
+export var STROKE_JOIN;
+(function (STROKE_JOIN) {
+    STROKE_JOIN[STROKE_JOIN["MITER"] = 10] = "MITER";
+    STROKE_JOIN[STROKE_JOIN["ROUND"] = 11] = "ROUND";
+    STROKE_JOIN[STROKE_JOIN["BEVEL"] = 12] = "BEVEL";
+})(STROKE_JOIN || (STROKE_JOIN = {}));
+export var LINE_HEAD;
+(function (LINE_HEAD) {
+    LINE_HEAD[LINE_HEAD["ARROW"] = 10] = "ARROW";
+    LINE_HEAD[LINE_HEAD["BAR"] = 11] = "BAR";
+    LINE_HEAD[LINE_HEAD["CIRCLE"] = 12] = "CIRCLE";
+    LINE_HEAD[LINE_HEAD["CIRCLE_OUTLINED"] = 13] = "CIRCLE_OUTLINED";
+    LINE_HEAD[LINE_HEAD["TRIANGLE"] = 14] = "TRIANGLE";
+    LINE_HEAD[LINE_HEAD["TRIANGLE_OUTLINED"] = 15] = "TRIANGLE_OUTLINED";
+    LINE_HEAD[LINE_HEAD["DIAMOND"] = 16] = "DIAMOND";
+    LINE_HEAD[LINE_HEAD["DIAMOND_OUTLINED"] = 17] = "DIAMOND_OUTLINED";
+    LINE_HEAD[LINE_HEAD["CROSS"] = 18] = "CROSS";
+    LINE_HEAD[LINE_HEAD["OPEN_ARROW"] = 19] = "OPEN_ARROW";
+    LINE_HEAD[LINE_HEAD["REVERSED_ARROW"] = 20] = "REVERSED_ARROW";
+    LINE_HEAD[LINE_HEAD["REVERSED_TRIANGLE"] = 21] = "REVERSED_TRIANGLE";
+    LINE_HEAD[LINE_HEAD["REVERSED_TRIANGLE_OUTLINED"] = 22] = "REVERSED_TRIANGLE_OUTLINED";
+    LINE_HEAD[LINE_HEAD["CONE"] = 23] = "CONE";
+    LINE_HEAD[LINE_HEAD["HALF_CONE"] = 24] = "HALF_CONE";
+})(LINE_HEAD || (LINE_HEAD = {}));
+export var BEZIER_MIRRORING;
+(function (BEZIER_MIRRORING) {
+    BEZIER_MIRRORING[BEZIER_MIRRORING["NONE"] = 10] = "NONE";
+    BEZIER_MIRRORING[BEZIER_MIRRORING["ANGLE"] = 11] = "ANGLE";
+    BEZIER_MIRRORING[BEZIER_MIRRORING["ANGLE_LENGTH"] = 12] = "ANGLE_LENGTH";
+})(BEZIER_MIRRORING || (BEZIER_MIRRORING = {}));
+export var BLENDING;
+(function (BLENDING) {
+    BLENDING[BLENDING["MULTIPLY"] = 11] = "MULTIPLY";
+    BLENDING[BLENDING["SCREEN"] = 12] = "SCREEN";
+    BLENDING[BLENDING["OVERLAY"] = 13] = "OVERLAY";
+    BLENDING[BLENDING["DARKEN"] = 14] = "DARKEN";
+    BLENDING[BLENDING["LIGHTEN"] = 15] = "LIGHTEN";
+    BLENDING[BLENDING["DIFFERENCE"] = 16] = "DIFFERENCE";
+    BLENDING[BLENDING["EXCLUSION"] = 17] = "EXCLUSION";
+})(BLENDING || (BLENDING = {}));
+export var ELEMENT_CONTENT_PREFERENCE;
+(function (ELEMENT_CONTENT_PREFERENCE) {
+    ELEMENT_CONTENT_PREFERENCE[ELEMENT_CONTENT_PREFERENCE["SOLID"] = 12] = "SOLID";
+    ELEMENT_CONTENT_PREFERENCE[ELEMENT_CONTENT_PREFERENCE["FILL"] = 14] = "FILL";
+    ELEMENT_CONTENT_PREFERENCE[ELEMENT_CONTENT_PREFERENCE["FIT"] = 15] = "FIT";
+    ELEMENT_CONTENT_PREFERENCE[ELEMENT_CONTENT_PREFERENCE["TILE"] = 16] = "TILE";
+    ELEMENT_CONTENT_PREFERENCE[ELEMENT_CONTENT_PREFERENCE["STRETCH"] = 17] = "STRETCH";
+    ELEMENT_CONTENT_PREFERENCE[ELEMENT_CONTENT_PREFERENCE["HATCH"] = 18] = "HATCH";
+})(ELEMENT_CONTENT_PREFERENCE || (ELEMENT_CONTENT_PREFERENCE = {}));
+export var HATCH_STYLE;
+(function (HATCH_STYLE) {
+    HATCH_STYLE[HATCH_STYLE["NORMAL"] = 10] = "NORMAL";
+    HATCH_STYLE[HATCH_STYLE["OUTER"] = 11] = "OUTER";
+    HATCH_STYLE[HATCH_STYLE["IGNORE"] = 12] = "IGNORE";
+})(HATCH_STYLE || (HATCH_STYLE = {}));
+export var IMAGE_STATUS;
+(function (IMAGE_STATUS) {
+    IMAGE_STATUS[IMAGE_STATUS["PENDING"] = 10] = "PENDING";
+    IMAGE_STATUS[IMAGE_STATUS["SAVED"] = 11] = "SAVED";
+    IMAGE_STATUS[IMAGE_STATUS["ERROR"] = 12] = "ERROR";
+})(IMAGE_STATUS || (IMAGE_STATUS = {}));
+export var PRUNING_LEVEL;
+(function (PRUNING_LEVEL) {
+    PRUNING_LEVEL[PRUNING_LEVEL["CONSERVATIVE"] = 10] = "CONSERVATIVE";
+    PRUNING_LEVEL[PRUNING_LEVEL["BALANCED"] = 20] = "BALANCED";
+    PRUNING_LEVEL[PRUNING_LEVEL["AGGRESSIVE"] = 30] = "AGGRESSIVE";
+})(PRUNING_LEVEL || (PRUNING_LEVEL = {}));
+export var BOOLEAN_OPERATION;
+(function (BOOLEAN_OPERATION) {
+    BOOLEAN_OPERATION[BOOLEAN_OPERATION["UNION"] = 10] = "UNION";
+    BOOLEAN_OPERATION[BOOLEAN_OPERATION["SUBTRACT"] = 11] = "SUBTRACT";
+    BOOLEAN_OPERATION[BOOLEAN_OPERATION["INTERSECT"] = 12] = "INTERSECT";
+    BOOLEAN_OPERATION[BOOLEAN_OPERATION["EXCLUDE"] = 13] = "EXCLUDE";
+})(BOOLEAN_OPERATION || (BOOLEAN_OPERATION = {}));
+export var YOUTUBE_STATES;
+(function (YOUTUBE_STATES) {
+    /** The YouTube player is unstarted. */
+    YOUTUBE_STATES[YOUTUBE_STATES["UNSTARTED"] = -1] = "UNSTARTED";
+    /** The YouTube player has ended. */
+    YOUTUBE_STATES[YOUTUBE_STATES["ENDED"] = 0] = "ENDED";
+    /** The YouTube player is currently playing. */
+    YOUTUBE_STATES[YOUTUBE_STATES["PLAYING"] = 1] = "PLAYING";
+    /** The YouTube player is paused. */
+    YOUTUBE_STATES[YOUTUBE_STATES["PAUSED"] = 2] = "PAUSED";
+    /** The YouTube player is buffering. */
+    YOUTUBE_STATES[YOUTUBE_STATES["BUFFERING"] = 3] = "BUFFERING";
+    /** The YouTube player is cued. */
+    YOUTUBE_STATES[YOUTUBE_STATES["CUED"] = 5] = "CUED";
+})(YOUTUBE_STATES || (YOUTUBE_STATES = {}));
+export var HANDLE_TYPE;
+(function (HANDLE_TYPE) {
+    HANDLE_TYPE[HANDLE_TYPE["HANDLE_IN"] = 10] = "HANDLE_IN";
+    HANDLE_TYPE[HANDLE_TYPE["HANDLE_OUT"] = 11] = "HANDLE_OUT";
+})(HANDLE_TYPE || (HANDLE_TYPE = {}));
+export var UNIT_SYSTEM;
+(function (UNIT_SYSTEM) {
+    UNIT_SYSTEM[UNIT_SYSTEM["METRIC"] = 10] = "METRIC";
+    UNIT_SYSTEM[UNIT_SYSTEM["IMPERIAL"] = 11] = "IMPERIAL";
+})(UNIT_SYSTEM || (UNIT_SYSTEM = {}));
+export var AXIS;
+(function (AXIS) {
+    AXIS[AXIS["X"] = 10] = "X";
+    AXIS[AXIS["Y"] = 20] = "Y";
+    AXIS[AXIS["Z"] = 30] = "Z";
+})(AXIS || (AXIS = {}));

package/dist/index.d.ts

@@ -1,8 +1,11 @@
-export * as DucBin from "./flatbuffers/duc";
+export * from "./enums";
 export * from "./lazy-files";
 export * from "./parse";
 export * from "./restore";
 export * from "./serialize";
 export * from "./technical";
+export * from "./transform";
 export * from "./types";
 export * from "./utils";
+export * as vc from "./version-control";
+export { ensureWasm, getWasmBinary } from "./wasm";

package/dist/index.js

@@ -1,8 +1,11 @@
-export * as DucBin from "./flatbuffers/duc";
+export * from "./enums";
 export * from "./lazy-files";
 export * from "./parse";
 export * from "./restore";
 export * from "./serialize";
 export * from "./technical";
+export * from "./transform";
 export * from "./types";
 export * from "./utils";
+export * as vc from "./version-control";
+export { ensureWasm, getWasmBinary } from "./wasm";

package/dist/lazy-files.d.ts

@@ -1,84 +1,44 @@
+import type { DucExternalFileData, DucExternalFiles } from "./types";
+export type LazyFileMetadata = {
+    id: string;
+    mimeType: string;
+    created: number;
+    lastRetrieved?: number;
+    version?: number;
+};
 /**
- * LazyExternalFileStore — Zero-copy, on-demand access to external file data from a FlatBuffer.
+ * Provides lazy access to external files embedded inside a `.duc` buffer.
  *
- * Instead of eagerly parsing and copying every external file's binary data into JS memory,
- * this store keeps a reference to the original FlatBuffer Uint8Array and reads file bytes
- * only when explicitly requested. FlatBuffer `dataArray()` returns a zero-copy view
- * (a Uint8Array pointing into the original buffer), so no allocation occurs until the
- * consumer actually needs the data.
- *
- * Memory lifecycle:
- *   1. On parse: only metadata (~200 bytes per file) enters JS heap.
- *   2. On demand: `getFileData(fileId)` reads the zero-copy slice from the buffer.
- *   3. The caller (renderer/worker) uses the data, then lets it GC naturally.
- *   4. If the store is released, the buffer reference is dropped, freeing everything.
- *
- * This is the key to supporting 1000s of external files without RAM bloat.
+ * Instead of loading all file blobs into memory at parse time, this store
+ * keeps a reference to the raw `.duc` buffer and fetches individual files
+ * on demand via WASM calls.
  */
-import type { DucExternalFileData, DucExternalFileMetadata, DucExternalFiles } from "./types";
-export type ExternalFileMetadataMap = Record<string, DucExternalFileMetadata>;
 export declare class LazyExternalFileStore {
-    private _buffer;
-    private _byteBuffer;
-    private _dataState;
-    /** Map from file id → lazy entry */
-    private _entries;
-    /** Map from element key → file id (the external_files vector uses element id as key) */
-    private _keyToFileId;
-    /**
-     * Files that were added at runtime (e.g. user uploading a new image).
-     * These aren't in the original FlatBuffer so we hold their data directly.
-     */
-    private _runtimeFiles;
+    private buffer;
+    private metadataCache;
+    private runtimeFiles;
     constructor(buffer: Uint8Array);
-    private _indexMetadata;
-    /** Total number of external files */
+    get isReleased(): boolean;
     get size(): number;
-    /** Whether a file with the given id exists */
+    /** Check if a file with this ID exists. */
     has(fileId: string): boolean;
-    /** Get metadata only (no binary data copied) — ~200 bytes per file */
-    getMetadata(fileId: string): DucExternalFileMetadata | null;
-    /** Get all metadata entries (for UI listing, etc.) */
-    getAllMetadata(): ExternalFileMetadataMap;
-    /**
-     * Get full file data (metadata + binary bytes) ON DEMAND.
-     *
-     * For files from the original FlatBuffer, this returns a zero-copy Uint8Array
-     * view into the original buffer — no allocation for the file bytes themselves.
-     * The view is valid as long as this store hasn't been released.
-     *
-     * For runtime-added files, returns the data directly.
-     */
+    /** Get metadata (without data blob) for a specific file. */
+    getMetadata(fileId: string): LazyFileMetadata | undefined;
+    /** Get metadata for all files. */
+    getAllMetadata(): LazyFileMetadata[];
+    /** Fetch the full file data (including blob) for a specific file. */
     getFileData(fileId: string): DucExternalFileData | null;
-    /**
-     * Get a detached copy of the file data (allocates new ArrayBuffer).
-     * Use this when you need to transfer data to a worker or keep it beyond store lifetime.
-     */
+    /** Fetch file data and return a copy of the data buffer (safe for transfer). */
     getFileDataCopy(fileId: string): DucExternalFileData | null;
-    /**
-     * Add a file at runtime (user upload, paste, etc.).
-     * These files are held in memory since they aren't in the FlatBuffer.
-     */
-    addRuntimeFile(fileData: DucExternalFileData): void;
-    /** Remove a runtime-added file */
-    removeRuntimeFile(fileId: string): void;
-    /**
-     * Export all files as a standard DucExternalFiles record.
-     * This COPIES all file data eagerly — use only for serialization.
-     */
+    /** Add a file at runtime (not persisted in .duc until next serialize). */
+    addRuntimeFile(fileId: string, data: DucExternalFileData): void;
+    /** Remove a runtime file. */
+    removeRuntimeFile(fileId: string): boolean;
+    /** Export all files eagerly as a DucExternalFiles record. */
     toExternalFiles(): DucExternalFiles;
-    /**
-     * Merge runtime files from the given DucExternalFiles map.
-     * Only adds files not already present in the store.
-     */
+    /** Merge files from another source (only adds missing). */
     mergeFiles(files: DucExternalFiles): void;
-    /** Estimated RAM usage for metadata only (not counting the backing buffer) */
-    get estimatedMetadataBytes(): number;
-    /**
-     * Release the FlatBuffer reference. After this, only runtime-added files remain accessible.
-     * Call this when switching documents or when the store is no longer needed.
-     */
+    /** Release the underlying buffer to free memory. */
     release(): void;
-    /** Whether the store has been released */
-    get isReleased(): boolean;
+    private getMetadataMap;
 }