@mlightcad/libredwg-web 0.7.3 → 0.7.5

package/lib/libredwg.js

@@ -2,7 +2,7 @@ import createModule from '../wasm/libredwg-web.js';
 import { LibreDwgConverter } from './converter';
 import { dwgCodePageToEncoding, dwgVersions } from './database';
 import { SvgConverter } from './svg';
-import { Dwg_File_Type, Dwg_Object_Type } from './types';
+import { Dwg_Error, Dwg_File_Type, Dwg_Object_Type } from './types';
 export { createModule };
 export var DwgThumbnailImageType;
 (function (DwgThumbnailImageType) {
@@ -32,8 +32,12 @@ export class LibreDwg {
             try {
                 this.wasmInstance.FS.writeFile(fileName, new Uint8Array(fileContent));
                 const result = this.wasmInstance.dwg_read_file(fileName);
+                if (result.error & Dwg_Error.OUTOFMEM) {
+                    this.wasmInstance.dwg_abandon(result.data);
+                    throw new Error('Failed to decode DWG: out of WASM memory. Rebuild with pnpm build:wasm (INITIAL_MEMORY=1GB) or use a smaller file.');
+                }
                 if (result.error != 0) {
-                    console.log('Open dwg file with error code: ', result.error);
+                    console.warn('Open dwg file with error code:', result.error);
                 }
                 return result.data;
             }
@@ -168,7 +172,20 @@ export class LibreDwg {
      * @param data Pointer to Dwg_Data instance.
      */
     dwg_free(data) {
-        this.wasmInstance.dwg_free(data);
+        if (!data) {
+            return;
+        }
+        try {
+            this.wasmInstance.dwg_free(data);
+        }
+        catch {
+            try {
+                this.wasmInstance.dwg_abandon(data);
+            }
+            catch {
+                // best effort; wasm heap may already be corrupt
+            }
+        }
     }
     /**
      * Frees the object (all three structs and its fields)
@@ -239,6 +256,58 @@ export class LibreDwg {
     dwg_resolve_handleref(ref_ptr, obj_ptr) {
         return this.wasmInstance.dwg_resolve_handleref(ref_ptr, obj_ptr);
     }
+    /**
+     * Returns the absolute handle reference of one Dwg_Object_Ref instance.
+     * @group Handle Conversion Methods
+     * @returns Returns null when the reference or absolute_ref is absent.
+     */
+    dwg_ref_get_absref(ref_ptr) {
+        if (!ref_ptr)
+            return null;
+        const absref = this.wasmInstance.dwg_ref_get_absref(ref_ptr);
+        return absref === 0 ? null : absref;
+    }
+    /**
+     * Returns the handle value of one Dwg_Object_Ref instance.
+     * @group Handle Conversion Methods
+     * @returns Returns null when the reference or handle value is absent.
+     */
+    dwg_ref_get_handle_value(ref_ptr) {
+        if (!ref_ptr)
+            return null;
+        const value = this.wasmInstance.dwg_ref_get_handle_value(ref_ptr);
+        return value === 0n ? null : value;
+    }
+    /**
+     * Returns the absolute_ref of one Dwg_Object_Ref instance as bigint.
+     * @group Handle Conversion Methods
+     * @returns Returns null when the reference or absolute_ref is absent.
+     */
+    dwg_ref_get_handle_absolute_ref(ref_ptr) {
+        if (!ref_ptr)
+            return null;
+        const value = this.wasmInstance.dwg_ref_get_handle_absolute_ref(ref_ptr);
+        return value === 0n ? null : value;
+    }
+    /**
+     * Returns the handle value of one Dwg_Object instance.
+     * @group Handle Conversion Methods
+     * @returns Returns null when the object or handle value is absent.
+     */
+    dwg_obj_get_handle_value(obj_ptr) {
+        if (!obj_ptr)
+            return null;
+        const value = this.wasmInstance.dwg_obj_get_handle_value(obj_ptr);
+        return value === 0n ? null : value;
+    }
+    /**
+     * Returns the absolute_ref of one Dwg_Object_Ref as uppercase hex handle id.
+     * @group Handle Conversion Methods
+     */
+    dwg_ref_get_id(ref_ptr) {
+        const absref = this.dwg_ref_get_absref(ref_ptr);
+        return absref == null ? undefined : absref.toString(16).toUpperCase();
+    }
     /**
      * Returns object (such as line type, layer name, dimension style, and etc.) name by its handle.
      * @group Handle Conversion Methods
@@ -249,8 +318,7 @@ export class LibreDwg {
         const wasmInstance = this.wasmInstance;
         const obj = wasmInstance.dwg_ref_get_object(ref_ptr);
         const obj_tio = wasmInstance.dwg_object_to_object_tio(obj);
-        const obj_name = this.dwg_dynapi_entity_value(obj_tio, 'name')
-            .data;
+        const obj_name = this.dwg_dynapi_entity_data(obj_tio, 'name');
         return obj_name;
     }
     /**
@@ -733,6 +801,13 @@ export class LibreDwg {
         }
         return value;
     }
+    /**
+     * Returns the decoded field data of one object or entity.
+     * @group Dynamic API Methods
+     */
+    dwg_dynapi_entity_data(obj, field) {
+        return this.dwg_dynapi_entity_value(obj, field).data;
+    }
     /**
      * Header field value getter. Used to get the field value of dwg/dxf header.
      * @group Dynamic API Methods
@@ -743,6 +818,13 @@ export class LibreDwg {
     dwg_dynapi_header_value(data, field) {
         return this.wasmInstance.dwg_dynapi_header_value(data, field);
     }
+    /**
+     * Returns the field data of dwg/dxf header.
+     * @group Dynamic API Methods
+     */
+    dwg_dynapi_header_data(data, field) {
+        return this.dwg_dynapi_header_value(data, field).data;
+    }
     /**
      * The common field value getter. Used to get the value of object or entity common fields.
      * @group Dynamic API Methods
@@ -753,6 +835,13 @@ export class LibreDwg {
     dwg_dynapi_common_value(obj, field) {
         return this.wasmInstance.dwg_dynapi_common_value(obj, field);
     }
+    /**
+     * Returns the field data of object or entity common fields.
+     * @group Dynamic API Methods
+     */
+    dwg_dynapi_common_data(obj, field) {
+        return this.dwg_dynapi_common_value(obj, field).data;
+    }
     /**
      * The field of one object or entity may not be primitive type. It means one field may consist of
      * multiple sub-fields. This method is used to get the sub-field value of those complex field.
@@ -765,6 +854,31 @@ export class LibreDwg {
     dwg_dynapi_subclass_value(obj, subclass, field) {
         return this.wasmInstance.dwg_dynapi_subclass_value(obj, subclass, field);
     }
+    /**
+     * Returns the sub-field data of one complex field.
+     * @group Dynamic API Methods
+     */
+    dwg_dynapi_subclass_data(obj, subclass, field) {
+        return this.dwg_dynapi_subclass_value(obj, subclass, field).data;
+    }
+    /**
+     * Returns the struct size of a dynapi subclass.
+     */
+    dwg_dynapi_subclass_size(subclass) {
+        return this.wasmInstance.dwg_dynapi_subclass_size(subclass);
+    }
+    /**
+     * Returns the byte offset of a field within an entity struct.
+     */
+    dwg_dynapi_entity_field_offset(entity, field) {
+        return this.wasmInstance.dwg_dynapi_entity_field_offset(entity, field);
+    }
+    /**
+     * Returns the byte offset of a field within a dynapi subclass struct.
+     */
+    dwg_dynapi_subclass_field_offset(subclass, field) {
+        return this.wasmInstance.dwg_dynapi_subclass_field_offset(subclass, field);
+    }
     /**
      * Returns the handle of one Dwg_Object instance.
      * @group Dwg_Object Methods
@@ -876,8 +990,7 @@ export class LibreDwg {
      */
     dwg_entity_get_block_name(ptr, field) {
         const wasmInstance = this.wasmInstance;
-        const block_header_ref = wasmInstance.dwg_dynapi_entity_value(ptr, field)
-            .data;
+        const block_header_ref = this.dwg_dynapi_entity_data(ptr, field);
         const block_header_obj = wasmInstance.dwg_ref_get_object(block_header_ref);
         const block_header_tio = wasmInstance.dwg_object_to_object_tio(block_header_obj);
         const block = this.dwg_entity_block_header_get_block(block_header_tio);
@@ -893,12 +1006,10 @@ export class LibreDwg {
      */
     dwg_entity_get_dimstyle_name(ptr, field = 'dimstyle') {
         const wasmInstance = this.wasmInstance;
-        const dimstyle_ref = wasmInstance.dwg_dynapi_entity_value(ptr, field)
-            .data;
+        const dimstyle_ref = this.dwg_dynapi_entity_data(ptr, field);
         const dimstyle_obj = wasmInstance.dwg_ref_get_object(dimstyle_ref);
         const dimstyle_tio = wasmInstance.dwg_object_to_object_tio(dimstyle_obj);
-        const dimstyle_name = this.dwg_dynapi_entity_value(dimstyle_tio, 'name')
-            .data;
+        const dimstyle_name = this.dwg_dynapi_entity_data(dimstyle_tio, 'name');
         return dimstyle_name;
     }
     /**
@@ -909,14 +1020,11 @@ export class LibreDwg {
      */
     dwg_entity_block_header_get_block(ptr) {
         const wasmInstance = this.wasmInstance;
-        const block_ref = wasmInstance.dwg_dynapi_entity_value(ptr, 'block_entity')
-            .data;
+        const block_ref = this.dwg_dynapi_entity_data(ptr, 'block_entity');
         const block_obj = wasmInstance.dwg_ref_get_object(block_ref);
         const block_tio = wasmInstance.dwg_object_to_entity_tio(block_obj);
-        const name = wasmInstance.dwg_dynapi_entity_value(block_tio, 'name')
-            .data;
-        const base_pt = wasmInstance.dwg_dynapi_entity_value(block_tio, 'base_pt')
-            .data;
+        const name = this.dwg_dynapi_entity_data(block_tio, 'name');
+        const base_pt = this.dwg_dynapi_entity_data(block_tio, 'base_pt');
         return {
             name,
             base_pt // preR13 only
@@ -986,12 +1094,10 @@ export class LibreDwg {
      */
     dwg_entity_mtext_get_style_name(ptr) {
         const wasmInstance = this.wasmInstance;
-        const style_ref = wasmInstance.dwg_dynapi_entity_value(ptr, 'style')
-            .data;
+        const style_ref = this.dwg_dynapi_entity_data(ptr, 'style');
         const style_obj = wasmInstance.dwg_ref_get_object(style_ref);
         const style_tio = wasmInstance.dwg_object_to_object_tio(style_obj);
-        const name = wasmInstance.dwg_dynapi_entity_value(style_tio, 'name')
-            .data;
+        const name = this.dwg_dynapi_entity_data(style_tio, 'name');
         return name;
     }
     /**

package/lib/types/enums.d.ts

@@ -2,6 +2,23 @@ export declare enum Dwg_Object_Supertype {
     DWG_SUPERTYPE_ENTITY = 0,
     DWG_SUPERTYPE_OBJECT = 1
 }
+/** Bit flags returned by dwg_read_file (see include/dwg.h DWG_ERROR). */
+export declare enum Dwg_Error {
+    WRONGCRC = 1,
+    NOTYETSUPPORTED = 2,
+    UNHANDLEDCLASS = 4,
+    INVALIDTYPE = 8,
+    INVALIDHANDLE = 16,
+    INVALIDEED = 32,
+    VALUEOUTOFBOUNDS = 64,
+    CLASSESNOTFOUND = 128,
+    SECTIONNOTFOUND = 256,
+    PAGENOTFOUND = 512,
+    INTERNALERROR = 1024,
+    INVALIDDWG = 2048,
+    IOERROR = 4096,
+    OUTOFMEM = 8192
+}
 export declare enum Dwg_Object_Type {
     DWG_TYPE_UNUSED = 0,
     DWG_TYPE_TEXT = 1,

package/lib/types/enums.js

@@ -3,6 +3,24 @@ export var Dwg_Object_Supertype;
     Dwg_Object_Supertype[Dwg_Object_Supertype["DWG_SUPERTYPE_ENTITY"] = 0] = "DWG_SUPERTYPE_ENTITY";
     Dwg_Object_Supertype[Dwg_Object_Supertype["DWG_SUPERTYPE_OBJECT"] = 1] = "DWG_SUPERTYPE_OBJECT";
 })(Dwg_Object_Supertype || (Dwg_Object_Supertype = {}));
+/** Bit flags returned by dwg_read_file (see include/dwg.h DWG_ERROR). */
+export var Dwg_Error;
+(function (Dwg_Error) {
+    Dwg_Error[Dwg_Error["WRONGCRC"] = 1] = "WRONGCRC";
+    Dwg_Error[Dwg_Error["NOTYETSUPPORTED"] = 2] = "NOTYETSUPPORTED";
+    Dwg_Error[Dwg_Error["UNHANDLEDCLASS"] = 4] = "UNHANDLEDCLASS";
+    Dwg_Error[Dwg_Error["INVALIDTYPE"] = 8] = "INVALIDTYPE";
+    Dwg_Error[Dwg_Error["INVALIDHANDLE"] = 16] = "INVALIDHANDLE";
+    Dwg_Error[Dwg_Error["INVALIDEED"] = 32] = "INVALIDEED";
+    Dwg_Error[Dwg_Error["VALUEOUTOFBOUNDS"] = 64] = "VALUEOUTOFBOUNDS";
+    Dwg_Error[Dwg_Error["CLASSESNOTFOUND"] = 128] = "CLASSESNOTFOUND";
+    Dwg_Error[Dwg_Error["SECTIONNOTFOUND"] = 256] = "SECTIONNOTFOUND";
+    Dwg_Error[Dwg_Error["PAGENOTFOUND"] = 512] = "PAGENOTFOUND";
+    Dwg_Error[Dwg_Error["INTERNALERROR"] = 1024] = "INTERNALERROR";
+    Dwg_Error[Dwg_Error["INVALIDDWG"] = 2048] = "INVALIDDWG";
+    Dwg_Error[Dwg_Error["IOERROR"] = 4096] = "IOERROR";
+    Dwg_Error[Dwg_Error["OUTOFMEM"] = 8192] = "OUTOFMEM";
+})(Dwg_Error || (Dwg_Error = {}));
 export var Dwg_Object_Type;
 (function (Dwg_Object_Type) {
     Dwg_Object_Type[Dwg_Object_Type["DWG_TYPE_UNUSED"] = 0] = "DWG_TYPE_UNUSED";

package/package.json

@@ -3,9 +3,12 @@
   "description": "A DWG/DXF JavaScript parser based on libredwg",
   "license": "GPL-3.0",
   "private": false,
-  "version": "0.7.3",
+  "version": "0.7.5",
   "author": "MLight Lee <mlight.lee@outlook.com>",
   "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/mlightcad/libredwg-web"
@@ -41,6 +44,7 @@
     "require": "./dist/libredwg-web.umd.cjs"
   },
   "devDependencies": {
+    "@eslint/js": "^9.9.1",
     "@typescript-eslint/parser": "^8.4.0",
     "eslint": "^9.9.1",
     "eslint-config-prettier": "^9.1.0",
@@ -70,15 +74,18 @@
     "demo": "live-server examples --entry-file=index.html",
     "doc": "typedoc",
     "build": "tsc && vite build && cp -rf wasm examples/ && cp -rf dist examples/",
-    "build:prepare": "mkdir -p ../../build-wasm && cd ../../build-wasm && emconfigure ../configure CFLAGS=\"-O2 -sUSE_ZLIB=1\" CC=emcc --enable-release --disable-docs --disable-write --disable-python --disable-bindings --disable-shared --disable-json --enable-partial --enable-experimental",
+    "build:prepare": "mkdir -p ../../build-wasm && cd ../../build-wasm && emconfigure ../configure CFLAGS=\"-O2 -sUSE_ZLIB=1 -DNDEBUG\" CC=emcc --enable-release --disable-docs --disable-write --disable-python --disable-bindings --disable-shared --disable-json --enable-partial --enable-experimental",
     "build:obj": "cd ../../build-wasm && emmake make",
-    "build:wasm": "cd ../../build-wasm && emcc ../bindings/javascript/embind/*.cpp src/*.o -O2 -lembind -std=c++17 -Isrc -I../src -I../include -o libredwg-web.js -s ALLOW_MEMORY_GROWTH=1 -s EXPORT_ES6=1 -s MODULARIZE=1 -s EXPORT_NAME=\"createModule\" -sEXPORTED_RUNTIME_METHODS=FS,ENV,ccall,cwrap,UTF8ToString,stringToNewUTF8,setValue --emit-tsd libredwg-web.d.ts",
+    "build:wasm": "cd ../../build-wasm && emcc ../bindings/javascript/embind/*.cpp src/*.o -O2 -lembind -std=c++17 -Isrc -I../src -I../include -o libredwg-web.js -s ALLOW_MEMORY_GROWTH=1 -s INITIAL_MEMORY=1GB -s MAXIMUM_MEMORY=4GB -s MALLOC=mimalloc -s EXPORT_ES6=1 -s MODULARIZE=1 -s EXPORT_NAME=\"createModule\" -sEXPORTED_RUNTIME_METHODS=FS,ENV,ccall,cwrap,UTF8ToString,stringToNewUTF8,setValue --emit-tsd libredwg-web.d.ts",
     "clean": "rm -rf ../../build-wasm ./docs ./dist ./lib",
     "copy": "cp -f ../../build-wasm/libredwg-web.d.ts ../../build-wasm/libredwg-web.js ../../build-wasm/libredwg-web.wasm wasm/ && cp -f ../../build-wasm/libredwg-web.js src/",
     "format": "prettier --config ./.prettierrc.js --write src/**/*.{ts,js}",
     "install:emsdk": "cd $EMSDK && ./emsdk install latest && ./emsdk activate latest",
     "link": "node script/create-symlink.js ./wasm/libredwg-web.js ./src/libredwg-web.js",
     "lint": "eslint src/",
-    "lint:fix": "eslint --fix --quiet src/"
+    "lint:fix": "eslint --fix --quiet src/",
+    "test": "node --test test/node-api.test.mjs",
+    "test:node": "pnpm build && pnpm test",
+    "publish:npm": "pnpm publish --access public --no-git-checks"
   }
 }

package/wasm/libredwg-web.d.ts

@@ -224,6 +224,26 @@ declare class FSNode {
     get isDevice(): any;
 }
 interface WasmModule {
+  __Znwm(_0: number): number;
+  __ZdlPvm(_0: number, _1: number): void;
+  _strndup(_0: number, _1: number): number;
+  __ZdaPv(_0: number): void;
+  __ZdaPvm(_0: number, _1: number): void;
+  __ZdlPv(_0: number): void;
+  _emscripten_builtin_malloc(_0: number): number;
+  __Znam(_0: number): number;
+  __ZnamSt11align_val_t(_0: number, _1: number): number;
+  __ZnwmSt11align_val_t(_0: number, _1: number): number;
+  ___libc_calloc(_0: number, _1: number): number;
+  ___libc_free(_0: number): void;
+  ___libc_malloc(_0: number): number;
+  ___libc_realloc(_0: number, _1: number): number;
+  _emscripten_builtin_calloc(_0: number, _1: number): number;
+  _emscripten_builtin_free(_0: number): void;
+  _emscripten_builtin_realloc(_0: number, _1: number): number;
+  _malloc_size(_0: number): number;
+  _malloc_usable_size(_0: number): number;
+  _reallocf(_0: number, _1: number): number;
 }
 
 type EmbindString = ArrayBuffer|Uint8Array|Uint8ClampedArray|Int8Array|string;
@@ -389,6 +409,7 @@ interface EmbindModule {
   dwg_get_next_object(_0: number, _1: Dwg_Object_Type, _2: number): number;
   dwg_resolve_jump(_0: number): number;
   dwg_free(_0: number): void;
+  dwg_abandon(_0: number): void;
   dwg_free_object(_0: number): void;
   dwg_new_ref(_0: number): number;
   dwg_dup_handleref(_0: number, _1: number): number;
@@ -426,6 +447,9 @@ interface EmbindModule {
   dwg_dynapi_entity_set_value(_0: number, _1: EmbindString, _2: EmbindString, _3: number, _4: boolean): boolean;
   dwg_dynapi_common_set_value(_0: number, _1: EmbindString, _2: number, _3: boolean): boolean;
   dwg_dynapi_handle_name(_0: number, _1: number, _2: number): string;
+  dwg_dynapi_subclass_size(_0: EmbindString): number;
+  dwg_dynapi_entity_field_offset(_0: number, _1: EmbindString): number;
+  dwg_dynapi_subclass_field_offset(_0: EmbindString, _1: EmbindString): number;
   dwg_write_dxf(_0: EmbindString, _1: EmbindString): number;
   dwg_find_tablehandle(_0: number, _1: EmbindString, _2: EmbindString): number;
   dwg_find_tablehandle_index(_0: number, _1: number, _2: EmbindString): number;