@hpcc-js/wasm 1.20.1 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hpcc-js/wasm",
-  "version": "1.20.1",
+  "version": "2.0.0",
   "description": "hpcc-js - WASM Libraries",
   "keywords": [
     "graphviz",
@@ -15,48 +15,37 @@
     "patchwork",
     "xml"
   ],
+  "type": "module",
   "exports": {
-    ".": {
-      "types": "./types/index.d.ts",
-      "node": {
-        "import": "./dist/index.node.es6.mjs",
-        "require": "./dist/index.node.js"
-      },
-      "browser": {
-        "import": "./dist/index.es6.js",
-        "default": "./dist/index.js"
-      },
-      "expat": {
-        "import": "./dist/expat.es6.js",
-        "default": "./dist/expat.js"
-      },
-      "extract": {
-        "import": "./dist/extract.es6.js",
-        "default": "./dist/extract.js"
-      },
-      "graphviz": {
-        "import": "./dist/graphviz.es6.js",
-        "default": "./dist/graphviz.js"
-      },
-      "sfx-graphviz": {
-        "import": "./dist/sfx-graphviz.esm.js",
-        "default": "./dist/sfx-graphviz.js"
-      },
-      "zstd": {
-        "import": "./dist/zstd.es6.js",
-        "default": "./dist/zstd.js"
-      },
-      "default": "./dist/index.js"
+    "./base91": {
+      "types": "./types/base91.d.ts",
+      "import": "./dist/base91.js",
+      "default": "./dist/base91.umd.js"
+    },
+    "./expat": {
+      "types": "./types/expat.d.ts",
+      "import": "./dist/expat.js",
+      "default": "./dist/expat.umd.js"
+    },
+    "./graphviz": {
+      "types": "./types/graphviz.d.ts",
+      "import": "./dist/graphviz.js",
+      "default": "./dist/graphviz.umd.js"
+    },
+    "./zstd": {
+      "types": "./types/zstd.d.ts",
+      "import": "./dist/zstd.js",
+      "default": "./dist/zstd.umd.js"
     }
   },
-  "main": "dist/index.node.js",
-  "module": "dist/index.node.es6.mjs",
-  "browser": "dist/index.js",
-  "unpkg": "dist/index.min.js",
-  "jsdelivr": "dist/index.min.js",
-  "types": "types/index.d.ts",
+  "main": "./dist/graphviz.umd.js",
+  "module": "./dist/graphviz.js",
+  "browser": "./dist/graphviz.umd.js",
+  "unpkg": "./dist/index.umd.min.js",
+  "jsdelivr": "./dist/index.umd.min.js",
+  "types": "./types/index.d.ts",
   "bin": {
-    "dot-wasm": "bin/dot-wasm.mjs"
+    "dot-wasm": "./bin/dot-wasm.js"
   },
   "files": [
     "bin/*.*",
@@ -76,37 +65,46 @@
     "install-vcpkg:win32": "wsl -e ./scripts/cpp-install-vcpkg.sh",
     "install-build-deps": "run-p install-emsdk install-graphviz install-vcpkg",
     "uninstall-build-deps": "rimraf ./emsdk ./src-graphviz ./vcpkg ./src-expat ./src-vcpkg",
-    "clean": "rimraf bin build coverage dist* lib* output-* tmp types *.tsbuildinfo",
+    "clean-build": "rimraf bin build coverage dist* lib* output-* tmp types *.tsbuildinfo",
+    "clean-docs": "rimraf docs/.vitepress/dist docs/classes docs/interfaces docs/modules docs/.nojekyll docs/README.md",
+    "clean": "run-p clean-build clean-docs",
+    "copy-res": "cp ./docs/hpccsystems.png ./docs/.vitepress/dist",
     "compile": "tsc",
     "compile-watch": "npm run compile -- -w",
     "compile-cpp": "run-script-os",
     "compile-cpp:linux": "./scripts/cpp-build.sh",
     "compile-cpp:win32": "wsl -e ./scripts/cpp-build.sh",
     "bundle": "rollup -c",
-    "bundle-watch": "npm run bundle -- -w",
-    "bundle-sfx": "rollup -c ./rollup-sfx.config.mjs",
-    "gen-sfx-base91": "node ./bin/sfx-wasm.mjs ./build/cpp/base91/base91lib.wasm > ./lib-es6/base91lib.wasm.js",
-    "gen-sfx-expat": "node ./bin/sfx-wasm.mjs ./build/cpp/expat/expatlib/expatlib.wasm > ./lib-es6/expatlib.wasm.js",
-    "gen-sfx-graphviz": "node ./bin/sfx-wasm.mjs ./build/cpp/graphviz/graphvizlib/graphvizlib.wasm > ./lib-es6/graphvizlib.wasm.js",
-    "gen-sfx-zstd": "node ./bin/sfx-wasm.mjs ./build/cpp/zstd/zstdlib.wasm > ./lib-es6/zstdlib.wasm.js",
-    "gen-sfx": "run-p gen-sfx-base91 gen-sfx-expat gen-sfx-graphviz gen-sfx-graphviz",
-    "minimize": "terser dist/index.js -c -m --source-map -o dist/index.min.js && terser dist/sfx-graphviz.js -c -m --source-map -o dist/sfx-graphviz.min.js",
-    "build": "run-s compile-cpp compile bundle gen-sfx bundle-sfx minimize",
+    "bundle-debug": "rollup -c --configDebug",
+    "bundle-watch": "npm run bundle-debug -- -w",
+    "bundle-sfx": "rollup -c ./rollup-sfx.config.js",
+    "gen-sfx-base91": "node ./utils/sfx-wasm.js ./build/cpp/base91/base91lib.wasm > ./lib-esm/base91lib.wasm.js",
+    "gen-sfx-expat": "node ./utils/sfx-wasm.js ./build/cpp/expat/expatlib/expatlib.wasm > ./lib-esm/expatlib.wasm.js",
+    "gen-sfx-graphviz": "node ./utils/sfx-wasm.js ./build/cpp/graphviz/graphvizlib/graphvizlib.wasm > ./lib-esm/graphvizlib.wasm.js",
+    "gen-sfx-zstd": "node ./utils/sfx-wasm.js ./build/cpp/zstd/zstdlib.wasm > ./lib-esm/zstdlib.wasm.js",
+    "gen-sfx": "mkdir -p ./lib-esm && run-p gen-sfx-base91 gen-sfx-expat gen-sfx-graphviz gen-sfx-graphviz gen-sfx-zstd",
+    "gen-docs": "typedoc",
+    "gen-docs-watch": "typedoc --watch",
+    "build-docs-vitepress": "vitepress build docs",
+    "build-docs": "run-s gen-docs build-docs-vitepress copy-res",
+    "build-docs-watch": "vitepress dev docs",
     "build-docker": "docker build --rm --progress plain -f \"./docker/ubuntu-dev.dockerfile\" -t hpcc-js-wasm-build:latest \".\"",
+    "build": "run-s compile-cpp gen-sfx compile bundle",
     "standard-version": "standard-version",
     "standard-version-dryrun": "standard-version --dry-run",
     "git-push": "git push --follow-tags upstream trunk",
     "watch": "run-p compile-watch bundle-watch",
-    "dev-start": "ws",
+    "serve-docs": "vitepress serve docs",
+    "serve": "ws",
     "lint": "eslint src/**/*.ts",
     "lint-fix": "npm run lint -- --fix",
-    "test-cli": "node ./bin/dot-wasm.mjs -v",
-    "test-cli-help": "node ./bin/dot-wasm.mjs",
-    "test-bundle": "npx -y esbuild --bundle ./dist/index.js --bundle ./dist/index.es6.js --outdir=tmp",
-    "test-bundle-node": "npx -y esbuild --bundle --platform=node --bundle ./dist/index.node.js ./dist/index.node.es6.mjs --outdir=tmp",
-    "test-chrome": "karma start --single-run --browsers ChromeHeadless karma.conf.js",
-    "test-firefox": "karma start --single-run --browsers Firefox karma.conf.js",
-    "test-node": "node ./bin/dot-wasm.mjs -v && mocha ./dist-test/index.node.js --reporter spec",
+    "test-cli": "node ./bin/dot-wasm.js -v",
+    "test-cli-help": "node ./bin/dot-wasm.js",
+    "test-bundle": "npx -y esbuild --bundle ./dist/base91.umd.js --bundle ./dist/base91.js --outdir=tmp",
+    "test-bundle-node": "npx -y esbuild --bundle --platform=node --bundle ./dist/base91.umd.js ./dist/base91.js --outdir=tmp",
+    "test-chrome": "karma start --single-run --browsers ChromeHeadless karma.conf.cjs",
+    "test-firefox": "karma start --single-run --browsers Firefox karma.conf.cjs",
+    "test-node": "node ./bin/dot-wasm.js -v && mocha ./dist-test/index.node.cjs --reporter spec && mocha ./dist-test/index.node.js --reporter spec",
     "test": "run-s test-bundle test-bundle-node test-chrome test-node",
     "tag": "run-s standard-version git-push",
     "purge-jsdelivr": "node ./utils/purge-jsdelivr.js",
@@ -114,42 +112,41 @@
     "update": "npx npm-check-updates -u -t minor"
   },
   "dependencies": {
-    "yargs": "17.6.0"
+    "@rollup/plugin-typescript": "^9.0.2",
+    "yargs": "17.6.2"
   },
   "devDependencies": {
-    "@rollup/plugin-alias": "3.1.9",
-    "@rollup/plugin-commonjs": "22.0.2",
-    "@rollup/plugin-node-resolve": "13.3.0",
-    "@rollup/plugin-replace": "4.0.0",
-    "@rollup/plugin-wasm": "6.0.1",
+    "@rollup/plugin-commonjs": "23.0.2",
+    "@rollup/plugin-node-resolve": "15.0.1",
+    "@rollup/plugin-terser": "0.1.0",
     "@types/chai": "4.3.3",
     "@types/emscripten": "1.39.6",
-    "@types/mocha": "9.1.1",
-    "@types/yargs": "^17.0.13",
+    "@types/mocha": "10.0.0",
+    "@types/yargs": "17.0.13",
     "@typescript-eslint/eslint-plugin": "5.42.0",
     "@typescript-eslint/parser": "5.42.0",
     "chai": "4.3.6",
-    "eslint": "8.26.0",
-    "fzstd": "^0.0.4",
+    "eslint": "8.27.0",
+    "fzstd": "0.0.4",
     "karma": "6.4.1",
     "karma-chai": "0.1.0",
     "karma-chrome-launcher": "3.1.1",
-    "karma-firefox-launcher": "^2.1.2",
+    "karma-firefox-launcher": "2.1.2",
     "karma-mocha": "2.0.1",
     "karma-spec-reporter": "0.0.34",
     "local-web-server": "5.2.1",
     "mocha": "10.1.0",
-    "node-base91": "^0.3.4",
-    "node-fetch": "3.2.10",
     "npm-run-all": "4.1.5",
     "rimraf": "3.0.2",
-    "rollup": "2.79.1",
-    "rollup-plugin-sourcemaps": "^0.6.3",
+    "rollup": "3.2.5",
+    "rollup-plugin-sourcemaps": "0.6.3",
     "run-script-os": "1.1.6",
     "standard-version": "9.5.0",
-    "terser": "5.15.1",
     "tslib": "2.4.1",
-    "typescript": "4.8.4"
+    "typedoc": "^0.23.20",
+    "typedoc-plugin-markdown": "^3.13.6",
+    "typescript": "4.8.4",
+    "vitepress": "1.0.0-alpha.27"
   },
   "repository": {
     "type": "git",

package/types/__bin__/dot-wasm.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=dot-wasm.d.ts.map

package/types/__bin__/dot-wasm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dot-wasm.d.ts","sourceRoot":"","sources":["../../src/__bin__/dot-wasm.ts"],"names":[],"mappings":""}

package/types/__tests__/graphviz.d.ts

@@ -1,4 +1,4 @@
-import { Engine, Format } from "../index";
+import { Engine, Format } from "@hpcc-js/wasm/graphviz";
 export declare const formats: Format[];
 export declare const engines: Engine[];
 //# sourceMappingURL=graphviz.d.ts.map

package/types/__tests__/graphviz.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"graphviz.d.ts","sourceRoot":"","sources":["../../src/__tests__/graphviz.ts"],"names":[],"mappings":"AACA,OAAO,EAAc,MAAM,EAAE,MAAM,EAAyD,MAAM,UAAU,CAAC;AAI7G,eAAO,MAAM,OAAO,EAAE,MAAM,EAA0E,CAAC;AACvG,eAAO,MAAM,OAAO,EAAE,MAAM,EAA4E,CAAC"}
+{"version":3,"file":"graphviz.d.ts","sourceRoot":"","sources":["../../src/__tests__/graphviz.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAY,MAAM,wBAAwB,CAAC;AAIlE,eAAO,MAAM,OAAO,EAAE,MAAM,EAA0E,CAAC;AACvG,eAAO,MAAM,OAAO,EAAE,MAAM,EAA4E,CAAC"}

package/types/__tests__/index-browser.d.ts

@@ -0,0 +1,3 @@
+export * from "./index-common.js";
+export * from "./browser-tests.js";
+//# sourceMappingURL=index-browser.d.ts.map

package/types/__tests__/index-browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-browser.d.ts","sourceRoot":"","sources":["../../src/__tests__/index-browser.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC"}

package/types/__tests__/index-common.d.ts

@@ -1,5 +1,5 @@
-export * from "./base91";
-export * from "./expat";
-export * from "./graphviz";
-export * from "./zstd";
+export * from "./base91.js";
+export * from "./expat.js";
+export * from "./graphviz.js";
+export * from "./zstd.js";
 //# sourceMappingURL=index-common.d.ts.map

package/types/__tests__/index-common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index-common.d.ts","sourceRoot":"","sources":["../../src/__tests__/index-common.ts"],"names":[],"mappings":"AAGA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC"}
+{"version":3,"file":"index-common.d.ts","sourceRoot":"","sources":["../../src/__tests__/index-common.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC"}

package/types/__tests__/index-node.d.ts

@@ -1,3 +1,3 @@
-export * from "./index-common";
-export * from "./node-tests";
+export * from "./index-common.js";
+export * from "./node-tests.js";
 //# sourceMappingURL=index-node.d.ts.map

package/types/__tests__/index-node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index-node.d.ts","sourceRoot":"","sources":["../../src/__tests__/index-node.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index-node.d.ts","sourceRoot":"","sources":["../../src/__tests__/index-node.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC"}

package/types/base91.d.ts

@@ -1,9 +1,44 @@
-import { Options, WasmLibrary } from "./wasm-library";
+import { WasmLibrary } from "./wasm-library.js";
+/**
+ * Base 91 WASM library, similar to Base 64 but uses more characters resulting in smaller strings.
+ *
+ * See [Base91](https://base91.sourceforge.net/) for more details.
+ *
+ * ```ts
+ * import { Base91 } from "@hpcc-js/wasm/base91";
+ *
+ * const base91 = await Base91.load();
+ *
+ * const encoded_data = await base91.encode(data);
+ * const decoded_data = await base91.decode(encoded_data);
+ * ```
+ */
 export declare class Base91 extends WasmLibrary {
     private constructor();
-    static load(options?: Options): Promise<Base91>;
+    /**
+     * Compiles and instantiates the raw wasm.
+     *
+     * ::: info
+     * In general WebAssembly compilation is disallowed on the main thread if the buffer size is larger than 4KB, hence forcing `load` to be asynchronous;
+     * :::
+     *
+     * @returns A promise to an instance of the Base91 class.
+     */
+    static load(): Promise<Base91>;
+    /**
+     * @returns The Base91 c++ version
+     */
     version(): string;
+    /**
+     * @param data Data to encode.
+     * @returns string containing the Base 91 encoded data
+     */
     encode(data: Uint8Array): string;
+    /**
+     *
+     * @param base91Str encoded string
+     * @returns origonal data
+     */
     decode(base91Str: string): Uint8Array;
 }
 //# sourceMappingURL=base91.d.ts.map

package/types/base91.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base91.d.ts","sourceRoot":"","sources":["../src/base91.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAMtD,qBAAa,MAAO,SAAQ,WAAW;IAEnC,OAAO;IAIP,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAS/C,OAAO,IAAI,MAAM;IAIjB,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAgBhC,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,UAAU;CAexC"}
+{"version":3,"file":"base91.d.ts","sourceRoot":"","sources":["../src/base91.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAMhD;;;;;;;;;;;;;GAaG;AACH,qBAAa,MAAO,SAAQ,WAAW;IAEnC,OAAO;IAIP;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC;IAS9B;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAgBhC;;;;OAIG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,UAAU;CAexC"}

package/types/expat.d.ts

@@ -6,6 +6,63 @@ export interface IParser {
     endElement(tag: string): void;
     characterData(content: string): void;
 }
+/**
+ * Expat XML parser WASM library, provides a simplified wrapper around the Expat XML Parser library.
+ *
+ * See [libexpat.github.io](https://libexpat.github.io/) for c++ details.
+ *
+ * ```ts
+ * import { Expat } from "@hpcc-js/wasm/expat";
+ *
+ * const expat = await Expat.load();
+ *
+ * const xml = ` \
+ *     <root>
+ *         <child xxx="yyy">content</child>
+ *     </root>
+ * `;
+ *
+ * const callback = {
+ *     startElement(tag, attrs) { console.log("start", tag, attrs); },
+ *     endElement(tag) { console.log("end", tag); },
+ *     characterData(content) { console.log("characterData", content); }
+ * };
+ *
+ * expat.parse(xml, callback);
+ * ```
+ 
+ */
+export declare class Expat {
+    protected _module: any;
+    private constructor();
+    /**
+     * Compiles and instantiates the raw wasm.
+     *
+     * ::: info
+     * In general WebAssembly compilation is disallowed on the main thread if the buffer size is larger than 4KB, hence forcing `load` to be asynchronous;
+     * :::
+     *
+     * @returns A promise to an instance of the Expat class.
+     */
+    static load(): Promise<Expat>;
+    /**
+     *
+     * @returns The Expat c++ version
+     */
+    version(): string;
+    /**
+     * Parses the XML with suitable callbacks.
+     *
+     * :::tip
+     * The _IParser.characterData_ callback method can get called several times for a single tag element.
+     * :::
+     *
+     * @param xml string containing XML
+     * @param callback Callback interface
+     * @returns `true`|`false` if the XML parse succeeds.
+     */
+    parse(xml: string, callback: IParser): boolean;
+}
 export declare class StackElement {
     readonly tag: string;
     readonly attrs: Attributes;
@@ -16,12 +73,10 @@ export declare class StackElement {
 }
 export declare class StackParser implements IParser {
     private _stack;
-    parse(xml: string, wasmFolder?: string, wasmBinary?: ArrayBuffer): Promise<boolean>;
+    parse(xml: string): Promise<boolean>;
     top(): StackElement;
     startElement(tag: string, attrs: Attributes): StackElement;
     endElement(tag: string): StackElement;
     characterData(content: string): void;
 }
-export declare function expatVersion(wasmFolder?: string, wasmBinary?: ArrayBuffer): Promise<any>;
-export declare function parse(xml: string, callback: IParser, wasmFolder?: string, wasmBinary?: ArrayBuffer): Promise<boolean>;
 //# sourceMappingURL=expat.d.ts.map

package/types/expat.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"expat.d.ts","sourceRoot":"","sources":["../src/expat.ts"],"names":[],"mappings":"AAIA,oBAAY,UAAU,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AACnD,MAAM,WAAW,OAAO;IACpB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;IACnD,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAED,qBAAa,YAAY;IAOT,QAAQ,CAAC,GAAG,EAAE,MAAM;IAAE,QAAQ,CAAC,KAAK,EAAE,UAAU;IAL5D,OAAO,CAAC,QAAQ,CAAM;IACtB,IAAI,OAAO,IAAI,MAAM,CAEpB;gBAEoB,GAAG,EAAE,MAAM,EAAW,KAAK,EAAE,UAAU;IAG5D,aAAa,CAAC,OAAO,EAAE,MAAM;CAGhC;AAED,qBAAa,WAAY,YAAW,OAAO;IACvC,OAAO,CAAC,MAAM,CAAsB;IAEpC,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAInF,GAAG,IAAI,YAAY;IAInB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,YAAY;IAM1D,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY;IAIrC,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;CAGvC;AAcD,wBAAgB,YAAY,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,WAAW,gBAIzE;AAED,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAkBrH"}
+{"version":3,"file":"expat.d.ts","sourceRoot":"","sources":["../src/expat.ts"],"names":[],"mappings":"AAGA,oBAAY,UAAU,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AACnD,MAAM,WAAW,OAAO;IACpB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;IACnD,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAcD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,KAAK;IAEM,SAAS,CAAC,OAAO,EAAE,GAAG;IAA1C,OAAO;IAGP;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC;IAM7B;;;OAGG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO;CAiBjD;AAED,qBAAa,YAAY;IAOT,QAAQ,CAAC,GAAG,EAAE,MAAM;IAAE,QAAQ,CAAC,KAAK,EAAE,UAAU;IAL5D,OAAO,CAAC,QAAQ,CAAM;IACtB,IAAI,OAAO,IAAI,MAAM,CAEpB;gBAEoB,GAAG,EAAE,MAAM,EAAW,KAAK,EAAE,UAAU;IAG5D,aAAa,CAAC,OAAO,EAAE,MAAM;CAGhC;AAED,qBAAa,WAAY,YAAW,OAAO;IACvC,OAAO,CAAC,MAAM,CAAsB;IAE9B,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAK1C,GAAG,IAAI,YAAY;IAInB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,YAAY;IAM1D,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY;IAIrC,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;CAGvC"}

package/types/graphviz.d.ts

@@ -1,6 +1,31 @@
+/**
+ * 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.
+ */
 export declare type Format = "svg" | "dot" | "json" | "dot_json" | "xdot_json" | "plain" | "plain-ext";
+/**
+ * Various algorithms for projecting abstract graphs into a space for visualization.  See [Layout Engines](https://graphviz.gitlab.io/docs/layouts/) for more details.
+ */
 export declare type Engine = "circo" | "dot" | "fdp" | "sfdp" | "neato" | "osage" | "patchwork" | "twopi";
+/**
+ * Example:  Passing a web hosted Image to GraphViz:
+ * ```ts
+ * import { Graphviz } from "@hpcc-js/wasm/graphviz";
+ *
+ * const graphviz = await Graphviz.load();
+ * const svg = graphviz.layout('digraph { a[image="https://.../image.png"]; }', "svg", "dot", {
+ *    images: [{
+ *        path: "https://.../image.png",
+ *            width: "272px",
+ *            height: "92px"
+ *    }]
+ * });
+ * document.getElementById("placeholder").innerHTML = svg;
+ * ```
+ */
 export interface Image {
+    /**
+     * Full URL to image
+     */
     path: string;
     width: string;
     height: string;
@@ -9,38 +34,130 @@ export interface File {
     path: string;
     data: string;
 }
-export interface Ext {
+export interface Options {
     images?: Image[];
     files?: File[];
-    wasmFolder?: string;
-    wasmBinary?: ArrayBuffer;
     yInvert?: boolean;
     nop?: number;
 }
-export declare function graphvizVersion(wasmFolder?: string, wasmBinary?: ArrayBuffer): Promise<any>;
-export declare const graphviz: {
-    layout(dotSource: string, outputFormat?: Format, layoutEngine?: Engine, ext?: Ext): Promise<string>;
-    circo(dotSource: string, outputFormat?: Format, ext?: Ext): Promise<string>;
-    dot(dotSource: string, outputFormat?: Format, ext?: Ext): Promise<string>;
-    fdp(dotSource: string, outputFormat?: Format, ext?: Ext): Promise<string>;
-    sfdp(dotSource: string, outputFormat?: Format, ext?: Ext): Promise<string>;
-    neato(dotSource: string, outputFormat?: Format, ext?: Ext): Promise<string>;
-    osage(dotSource: string, outputFormat?: Format, ext?: Ext): Promise<string>;
-    patchwork(dotSource: string, outputFormat?: Format, ext?: Ext): Promise<string>;
-    twopi(dotSource: string, outputFormat?: Format, ext?: Ext): Promise<string>;
-};
-export declare class GraphvizSync {
-    private _wasm;
-    constructor(_wasm: any);
-    layout(dotSource: string, outputFormat?: Format, layoutEngine?: Engine, ext?: Ext): string;
-    circo(dotSource: string, outputFormat?: Format, ext?: Ext): string;
-    dot(dotSource: string, outputFormat?: Format, ext?: Ext): string;
-    fdp(dotSource: string, outputFormat?: Format, ext?: Ext): string;
-    sfdp(dotSource: string, outputFormat?: Format, ext?: Ext): string;
-    neato(dotSource: string, outputFormat?: Format, ext?: Ext): string;
-    osage(dotSource: string, outputFormat?: Format, ext?: Ext): string;
-    patchwork(dotSource: string, outputFormat?: Format, ext?: Ext): string;
-    twopi(dotSource: string, outputFormat?: Format, ext?: Ext): string;
+/**
+ * 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.
+ *
+ * Graphviz has many useful features for concrete diagrams, such as options for colors, fonts, tabular node layouts, line styles, hyperlinks, and custom shapes.
+ *
+ * See [graphviz.org](https://graphviz.org/) for more details.
+ *
+ * ```ts
+ * import { Graphviz } from "@hpcc-js/wasm/graphviz";
+ *
+ * const graphviz = await Graphviz.load();
+ *
+ * const dot = "digraph G { Hello -> World }";
+ * const svg = graphviz.dot(dot);
+ * ```
+ *
+ * ### Online Demos
+ * * https://raw.githack.com/hpcc-systems/hpcc-js-wasm/trunk/index.html
+ * * https://observablehq.com/@gordonsmith/graphviz
+ */
+export declare class Graphviz {
+    protected _module: any;
+    private constructor();
+    /**
+     * Compiles and instantiates the raw wasm.
+     *
+     * ::: info
+     * In general WebAssembly compilation is disallowed on the main thread if the buffer size is larger than 4KB, hence forcing `load` to be asynchronous;
+     * :::
+     *
+     * @returns A promise to an instance of the Graphviz class.
+     */
+    static load(): Promise<Graphviz>;
+    /**
+     * @returns The Graphviz c++ version
+     */
+    version(): string;
+    /**
+     * Performs layout for the supplied _dotSource_, see [The DOT Language](https://graphviz.gitlab.io/doc/info/lang.html) for specification.
+     *
+     * @param dotSource Required - graph definition in [DOT](https://graphviz.gitlab.io/doc/info/lang.html) language
+     * @param outputFormat The format of the result.
+     * @param layoutEngine The type of layout to perform.
+     * @param options Advanced Options for images, files, yInvert and nop.
+     * @returns A string containing the calculated layout in the format specified by `outputFormat`
+     */
+    layout(dotSource: string, outputFormat?: Format, layoutEngine?: Engine, options?: Options): string;
+    /**
+     * Convenience function that performs the **circo** layout, is equivalent to `layout(dotSource, outputFormat, "circo");`.
+     *
+     * @param dotSource Required - graph definition in [DOT](https://graphviz.gitlab.io/doc/info/lang.html) language
+     * @param outputFormat The format of the result.
+     * @param options Advanced Options for images, files, yInvert and nop.
+     * @returns A string containing the calculated layout in the format specified by `outputFormat`
+     */
+    circo(dotSource: string, outputFormat?: Format, options?: Options): string;
+    /**
+     * Convenience function that performs the **dot** layout, is equivalent to `layout(dotSource, outputFormat, "dot");`.
+     *
+     * @param dotSource Required - graph definition in [DOT](https://graphviz.gitlab.io/doc/info/lang.html) language
+     * @param outputFormat The format of the result.
+     * @param options Advanced Options for images, files, yInvert and nop.
+     * @returns A string containing the calculated layout in the format specified by `outputFormat`
+     */
+    dot(dotSource: string, outputFormat?: Format, options?: Options): string;
+    /**
+     * Convenience function that performs the **fdp** layout, is equivalent to `layout(dotSource, outputFormat, "fdp");`.
+     *
+     * @param dotSource Required - graph definition in [DOT](https://graphviz.gitlab.io/doc/info/lang.html) language
+     * @param outputFormat The format of the result.
+     * @param options Advanced Options for images, files, yInvert and nop.
+     * @returns A string containing the calculated layout in the format specified by `outputFormat`
+     */
+    fdp(dotSource: string, outputFormat?: Format, options?: Options): string;
+    /**
+     * Convenience function that performs the **sfdp** layout, is equivalent to `layout(dotSource, outputFormat, "sfdp");`.
+     *
+     * @param dotSource Required - graph definition in [DOT](https://graphviz.gitlab.io/doc/info/lang.html) language
+     * @param outputFormat The format of the result.
+     * @param options Advanced Options for images, files, yInvert and nop.
+     * @returns A string containing the calculated layout in the format specified by `outputFormat`
+     */
+    sfdp(dotSource: string, outputFormat?: Format, options?: Options): string;
+    /**
+     * Convenience function that performs the **neato** layout, is equivalent to `layout(dotSource, outputFormat, "neato");`.
+     *
+     * @param dotSource Required - graph definition in [DOT](https://graphviz.gitlab.io/doc/info/lang.html) language
+     * @param outputFormat The format of the result.
+     * @param options Advanced Options for images, files, yInvert and nop.
+     * @returns A string containing the calculated layout in the format specified by `outputFormat`
+     */
+    neato(dotSource: string, outputFormat?: Format, options?: Options): string;
+    /**
+     * Convenience function that performs the **osage** layout, is equivalent to `layout(dotSource, outputFormat, "osage");`.
+     *
+     * @param dotSource Required - graph definition in [DOT](https://graphviz.gitlab.io/doc/info/lang.html) language
+     * @param outputFormat The format of the result.
+     * @param options Advanced Options for images, files, yInvert and nop.
+     * @returns A string containing the calculated layout in the format specified by `outputFormat`
+     */
+    osage(dotSource: string, outputFormat?: Format, options?: Options): string;
+    /**
+     * Convenience function that performs the **patchwork** layout, is equivalent to `layout(dotSource, outputFormat, "patchwork");`.
+     *
+     * @param dotSource Required - graph definition in [DOT](https://graphviz.gitlab.io/doc/info/lang.html) language
+     * @param outputFormat The format of the result.
+     * @param options Advanced Options for images, files, yInvert and nop.
+     * @returns A string containing the calculated layout in the format specified by `outputFormat`
+     */
+    patchwork(dotSource: string, outputFormat?: Format, options?: Options): string;
+    /**
+     * Convenience function that performs the **twopi** layout, is equivalent to `layout(dotSource, outputFormat, "twopi");`.
+     *
+     * @param dotSource Required - graph definition in [DOT](https://graphviz.gitlab.io/doc/info/lang.html) language
+     * @param outputFormat The format of the result.
+     * @param options Advanced Options for images, files, yInvert and nop.
+     * @returns A string containing the calculated layout in the format specified by `outputFormat`
+     */
+    twopi(dotSource: string, outputFormat?: Format, options?: Options): string;
 }
-export declare function graphvizSync(wasmFolder?: string, wasmBinary?: ArrayBuffer): Promise<GraphvizSync>;
 //# sourceMappingURL=graphviz.d.ts.map

package/types/graphviz.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"graphviz.d.ts","sourceRoot":"","sources":["../src/graphviz.ts"],"names":[],"mappings":"AAIA,oBAAY,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,OAAO,GAAG,WAAW,CAAC;AAC/F,oBAAY,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,OAAO,CAAC;AAElG,MAAM,WAAW,KAAK;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,IAAI;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,GAAG;IAChB,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;IACjB,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB;AAwBD,wBAAgB,eAAe,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,WAAW,gBAK5E;AAED,eAAO,MAAM,QAAQ;sBACC,MAAM,iBAAgB,MAAM,iBAAwB,MAAM,QAAgB,GAAG,GAAG,QAAQ,MAAM,CAAC;qBAoBhG,MAAM,iBAAgB,MAAM,QAAgB,GAAG,GAAG,QAAQ,MAAM,CAAC;mBAGnE,MAAM,iBAAgB,MAAM,QAAgB,GAAG,GAAG,QAAQ,MAAM,CAAC;mBAGjE,MAAM,iBAAgB,MAAM,QAAgB,GAAG,GAAG,QAAQ,MAAM,CAAC;oBAGhE,MAAM,iBAAgB,MAAM,QAAgB,GAAG,GAAG,QAAQ,MAAM,CAAC;qBAGhE,MAAM,iBAAgB,MAAM,QAAgB,GAAG,GAAG,QAAQ,MAAM,CAAC;qBAGjE,MAAM,iBAAgB,MAAM,QAAgB,GAAG,GAAG,QAAQ,MAAM,CAAC;yBAG7D,MAAM,iBAAgB,MAAM,QAAgB,GAAG,GAAG,QAAQ,MAAM,CAAC;qBAGrE,MAAM,iBAAgB,MAAM,QAAgB,GAAG,GAAG,QAAQ,MAAM,CAAC;CAGrF,CAAC;AAEF,qBAAa,YAAY;IAET,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,GAAG;IAG9B,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,YAAY,GAAE,MAAc,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,MAAM;IAmBxG,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,MAAM;IAIzE,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,MAAM;IAIvE,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,MAAM;IAIvE,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,MAAM;IAIxE,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,MAAM;IAIzE,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,MAAM;IAIzE,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,MAAM;IAI7E,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,MAAM;CAG5E;AAED,wBAAgB,YAAY,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,CAEjG"}
+{"version":3,"file":"graphviz.d.ts","sourceRoot":"","sources":["../src/graphviz.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,oBAAY,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,OAAO,GAAG,WAAW,CAAC;AAE/F;;GAEG;AACH,oBAAY,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,OAAO,CAAC;AAElG;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,KAAK;IAClB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,IAAI;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,OAAO;IACpB,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;IACjB,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB;AAwBD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,QAAQ;IAEG,SAAS,CAAC,OAAO,EAAE,GAAG;IAA1C,OAAO;IAGP;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC;IAMhC;;OAEG;IACH,OAAO,IAAI,MAAM;IAGjB;;;;;;;;OAQG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,YAAY,GAAE,MAAc,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM;IAkBhH;;;;;;;OAOG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM;IAIjF;;;;;;;OAOG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM;IAI/E;;;;;;;OAOG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM;IAI/E;;;;;;;OAOG;IACH,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM;IAIhF;;;;;;;OAOG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM;IAIjF;;;;;;;OAOG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM;IAIjF;;;;;;;OAOG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM;IAIrF;;;;;;;OAOG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,GAAE,MAAc,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM;CAGpF"}

package/types/index.d.ts

@@ -1,2 +1,10 @@
-export * from "./index-common";
+export declare namespace Base91 {
+    function load(): Promise<typeof import("./base91.js").Base91>;
+}
+export declare namespace Graphviz {
+    function load(): Promise<typeof import("./graphviz.js").Graphviz>;
+}
+export declare namespace Zstd {
+    function load(): Promise<typeof import("./zstd.js").Zstd>;
+}
 //# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,yBAAiB,MAAM,CAAC;IACpB,SAAgB,IAAI,iDAEnB;CACJ;AAQD,yBAAiB,QAAQ,CAAC;IACtB,SAAgB,IAAI,qDAEnB;CACJ;AAED,yBAAiB,IAAI,CAAC;IAClB,SAAgB,IAAI,6CAEnB;CACJ"}