@hpcc-js/wasm-graphviz 1.17.0 → 1.18.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hpcc-js/wasm-graphviz",
-  "version": "1.17.0",
+  "version": "1.18.1",
   "description": "hpcc-js - WASM Graphviz",
   "type": "module",
   "exports": {
@@ -26,7 +26,7 @@
     "build-dev": "run-p gen-types bundle-dev",
     "build": "run-p gen-types bundle",
     "lint-skypack": "npx -y @skypack/package-check",
-    "lint-eslint": "eslint src/**/*.ts tests/**/*.ts",
+    "lint-eslint": "eslint \"src/**/*.ts\" \"tests/**/*.ts\"",
     "lint": "run-p lint-eslint",
     "test-browser": "vitest run --project browser",
     "test-node": "vitest run --project node",
@@ -36,7 +36,8 @@
     "update-major": "npx -y npm-check-updates -u"
   },
   "devDependencies": {
-    "@hpcc-js/esbuild-plugins": "1.7.0"
+    "@hpcc-js/esbuild-plugins": "1.7.0",
+    "@hpcc-js/wasm-util": "1.0.0"
   },
   "keywords": [
     "graphviz",
@@ -54,5 +55,5 @@
   },
   "homepage": "https://hpcc-systems.github.io/hpcc-js-wasm/",
   "license": "Apache-2.0",
-  "gitHead": "39b68e046380ff41bd6474242929cd68a6918fef"
+  "gitHead": "11395f5acfc865accde71905509bb45d5c79b11b"
 }

package/src/graphviz.ts

@@ -1,5 +1,7 @@
 // @ts-expect-error importing from a wasm file is resolved via a custom esbuild plugin
-import load, { reset } from "../../../build/packages/graphviz/src-cpp/graphvizlib.wasm";
+import load, { reset } from "../../../build/packages/graphviz/graphvizlib.wasm";
+import type { MainModule } from "../types/graphvizlib.js";
+import { MainModuleEx } from "@hpcc-js/wasm-util";
 
 /**
  * Various graphic and data formats for end user, web, documents and other applications.  See [Output Formats](https://graphviz.gitlab.io/docs/outputs/) for more information.
@@ -70,6 +72,8 @@ function createFiles(graphviz: any, _options?: Options) {
     [...options.files, ...imagesToFiles(options.images)].forEach(file => graphviz.createFile(file.path, file.data));
 }
 
+let g_graphviz: Promise<Graphviz>;
+
 /**
  * The Graphviz layout algorithms take descriptions of graphs in a simple text language, and make diagrams in useful formats, such as images and SVG for web pages or display in an interactive graph browser.
  * 
@@ -90,9 +94,10 @@ function createFiles(graphviz: any, _options?: Options) {
  * * https://raw.githack.com/hpcc-systems/hpcc-js-wasm/trunk/index.html
  * * https://observablehq.com/@gordonsmith/graphviz
  */
-export class Graphviz {
+export class Graphviz extends MainModuleEx<MainModule> {
 
-    private constructor(protected _module: any) {
+    private constructor(_module: MainModule) {
+        super(_module);
     }
 
     /**
@@ -105,9 +110,10 @@ export class Graphviz {
      * @returns A promise to an instance of the Graphviz class.
      */
     static load(): Promise<Graphviz> {
-        return load().then((module: any) => {
-            return new Graphviz(module);
-        });
+        if (!g_graphviz) {
+            g_graphviz = (load() as Promise<MainModule>).then((module) => new Graphviz(module));
+        }
+        return g_graphviz;
     }
 
     /**
@@ -121,7 +127,7 @@ export class Graphviz {
      * @returns The Graphviz c++ version
      */
     version(): string {
-        return this._module.Graphviz.prototype.version();
+        return this._module.CGraphviz.version();
     }
 
     /**
@@ -135,7 +141,7 @@ export class Graphviz {
      */
     layout(dotSource: string, outputFormat: Format = "svg", layoutEngine: Engine = "dot", options?: Options): string {
         if (!dotSource) return "";
-        const graphViz = new this._module.Graphviz(options?.yInvert ? 1 : 0, options?.nop ? options?.nop : 0);
+        const graphViz = new this._module.CGraphviz(options?.yInvert ? 1 : 0, options?.nop ? options?.nop : 0);
         let retVal = "";
         let errorMsg = "";
         try {
@@ -145,9 +151,9 @@ export class Graphviz {
             } catch (e: any) {
                 errorMsg = e.message;
             };
-            errorMsg = graphViz.lastError() || errorMsg;
+            errorMsg = this._module.CGraphviz.lastError() || errorMsg;
         } finally {
-            this._module.destroy(graphViz);
+            graphViz.delete();
         }
         if (!retVal && errorMsg) {
             Graphviz.unload();
@@ -166,7 +172,7 @@ export class Graphviz {
       */
     acyclic(dotSource: string, doWrite: boolean = false, verbose: boolean = false): { acyclic: boolean, num_rev: number, outFile: string } {
         if (!dotSource) return { acyclic: false, num_rev: 0, outFile: "" };
-        const graphViz = new this._module.Graphviz();
+        const graphViz = new this._module.CGraphviz();
         let acyclic: boolean = false;
         let num_rev: number = 0;
         let outFile: string = "";
@@ -179,9 +185,9 @@ export class Graphviz {
             } catch (e: any) {
                 errorMsg = e.message;
             };
-            errorMsg = graphViz.lastError() || errorMsg;
+            errorMsg = this._module.CGraphviz.lastError() || errorMsg;
         } finally {
-            this._module.destroy(graphViz);
+            graphViz.delete();
         }
         if (errorMsg) {
             Graphviz.unload();
@@ -200,7 +206,7 @@ export class Graphviz {
       */
     tred(dotSource: string, verbose: boolean = false, printRemovedEdges: boolean = false): { out: string, err: string } {
         if (!dotSource) return { out: "", err: "" };
-        const graphViz = new this._module.Graphviz();
+        const graphViz = new this._module.CGraphviz();
         let out: string = "";
         let err: string = "";
         let errorMsg = "";
@@ -212,9 +218,9 @@ export class Graphviz {
             } catch (e: any) {
                 errorMsg = e.message;
             };
-            errorMsg = graphViz.lastError() || errorMsg;
+            errorMsg = this._module.CGraphviz.lastError() || errorMsg;
         } finally {
-            this._module.destroy(graphViz);
+            graphViz.delete();
         }
         if (!out && errorMsg) {
             Graphviz.unload();
@@ -234,7 +240,7 @@ export class Graphviz {
      */
     unflatten(dotSource: string, maxMinlen: number = 0, do_fans: boolean = false, chainLimit: number = 0): string {
         if (!dotSource) return "";
-        const graphViz = new this._module.Graphviz();
+        const graphViz = new this._module.CGraphviz();
         let retVal = "";
         let errorMsg = "";
         try {
@@ -243,9 +249,9 @@ export class Graphviz {
             } catch (e: any) {
                 errorMsg = e.message;
             };
-            errorMsg = graphViz.lastError() || errorMsg;
+            errorMsg = this._module.CGraphviz.lastError() || errorMsg;
         } finally {
-            this._module.destroy(graphViz);
+            graphViz.delete();
         }
         if (!retVal && errorMsg) {
             Graphviz.unload();

package/types/graphviz.d.ts

@@ -1,3 +1,5 @@
+import type { MainModule } from "../types/graphvizlib.js";
+import { MainModuleEx } from "@hpcc-js/wasm-util";
 /**
  * Various graphic and data formats for end user, web, documents and other applications.  See [Output Formats](https://graphviz.gitlab.io/docs/outputs/) for more information.
  */
@@ -60,8 +62,7 @@ export interface Options {
  * * https://raw.githack.com/hpcc-systems/hpcc-js-wasm/trunk/index.html
  * * https://observablehq.com/@gordonsmith/graphviz
  */
-export declare class Graphviz {
-    protected _module: any;
+export declare class Graphviz extends MainModuleEx<MainModule> {
     private constructor();
     /**
      * Compiles and instantiates the raw wasm.

package/types/graphvizlib.d.ts

@@ -0,0 +1,65 @@
+// TypeScript bindings for emscripten-generated code.  Automatically generated at compile time.
+declare namespace RuntimeExports {
+    /**
+     * Given a pointer 'ptr' to a null-terminated UTF8-encoded string in the
+     * emscripten HEAP, returns a copy of that string as a Javascript String object.
+     *
+     * @param {number} ptr
+     * @param {number=} maxBytesToRead - An optional length that specifies the
+     *   maximum number of bytes to read. You can omit this parameter to scan the
+     *   string until the first 0 byte. If maxBytesToRead is passed, and the string
+     *   at [ptr, ptr+maxBytesToReadr[ contains a null byte in the middle, then the
+     *   string will cut short at that byte index.
+     * @param {boolean=} ignoreNul - If true, the function will not stop on a NUL character.
+     * @return {string}
+     */
+    function UTF8ToString(ptr: number, maxBytesToRead?: number | undefined, ignoreNul?: boolean | undefined): string;
+    function lengthBytesUTF8(str: any): number;
+    function stringToUTF8(str: any, outPtr: any, maxBytesToWrite: any): any;
+    let HEAPU8: any;
+}
+interface WasmModule {
+  _malloc(_0: number): number;
+  _free(_0: number): void;
+}
+
+type EmbindString = ArrayBuffer|Uint8Array|Uint8ClampedArray|Int8Array|string;
+export interface ClassHandle {
+  isAliasOf(other: ClassHandle): boolean;
+  delete(): void;
+  deleteLater(): this;
+  isDeleted(): boolean;
+  // @ts-ignore - If targeting lower than ESNext, this symbol might not exist.
+  [Symbol.dispose](): void;
+  clone(): this;
+}
+export interface CGraphviz extends ClassHandle {
+  acyclic_num_rev: number;
+  get layout_result(): string;
+  set layout_result(value: EmbindString);
+  get acyclic_outFile(): string;
+  set acyclic_outFile(value: EmbindString);
+  get tred_out(): string;
+  set tred_out(value: EmbindString);
+  get tred_err(): string;
+  set tred_err(value: EmbindString);
+  get unflatten_out(): string;
+  set unflatten_out(value: EmbindString);
+  createFile(_0: EmbindString, _1: EmbindString): void;
+  layout(_0: EmbindString, _1: EmbindString, _2: EmbindString): string;
+  acyclic(_0: EmbindString, _1: boolean, _2: boolean): boolean;
+  tred(_0: EmbindString, _1: boolean, _2: boolean): void;
+  unflatten(_0: EmbindString, _1: number, _2: boolean, _3: number): string;
+}
+
+interface EmbindModule {
+  CGraphviz: {
+    new(): CGraphviz;
+    new(_0: number, _1: number): CGraphviz;
+    version(): string;
+    lastError(): string;
+  };
+}
+
+export type MainModule = WasmModule & typeof RuntimeExports & EmbindModule;
+export default function MainModuleFactory (options?: unknown): Promise<MainModule>;