Skip to content

Commit 25aa1cc

Browse files
committed
feat: Bump GraphViz and emsdk versions
Fix documentation typos Add extra information to quick migration documentation Signed-off-by: Gordon Smith <[email protected]>
1 parent 6406aa1 commit 25aa1cc

File tree

4 files changed

+16
-6
lines changed

4 files changed

+16
-6
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,17 @@
22

33
![Tests](https://github.com/hpcc-systems/hpcc-js-wasm/workflows/Test%20PR/badge.svg)
44

5+
**@hpcc-js/wasm is now an ESM by default package** - this is a good thing, but does require some breaking changes.
6+
57
This repository contains a collection of useful c++ libraries compiled to WASM for (re)use in Node JS, Web Browsers and JavaScript Libraries:
68
- [base91](https://base91.sourceforge.net/) - v0.6.0
79
- [expat](https://libexpat.github.io/) - v2.4.9
8-
- [graphviz](https://www.graphviz.org/) - v7.0.0
10+
- [graphviz](https://www.graphviz.org/) - v7.0.1
911
- [zstd](https://github.com/facebook/zstd) - v1.5.2
1012
- ...more to follow...
1113

1214
Built with:
13-
- [emsdk](https://github.com/emscripten-core/emsdk) - v3.1.24
15+
- [emsdk](https://github.com/emscripten-core/emsdk) - v3.1.25
1416

1517
## Homepage and Documents
1618

@@ -54,3 +56,11 @@ Notes:
5456
* wasmFolder is no longer needed
5557
* All wasm libraries have the same asynchronous load pattern
5658
- `const instance = await Wasm.load();`
59+
60+
### ⚠⚠⚠ TypeScript Notes ⚠⚠⚠
61+
62+
When importing an ESM package AND referencing explicit `exports` (like `@hpcc-js/wasm/graphviz` or `@hpcc-js/wasm/expat`), you should change the following tsconfig.json setting:
63+
* `moduleResolution: Node16`
64+
65+
This will ensure the correct "types" are auto discovered.
66+

scripts/cpp-install-emsdk.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# List of current vertsion can be found in https://github.com/emscripten-core/emsdk/tags ---
44
# UPDATE README.md
5-
VERSION=3.1.24
5+
VERSION=3.1.25
66

77
if [ ! -d "./emsdk" ]
88
then

scripts/cpp-install-graphviz.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# List of current vertsion can be found in https://gitlab.com/graphviz/graphviz/-/tags ---
44
# UPDATE README.md
5-
VERSION=7.0.0
5+
VERSION=7.0.1
66

77
if [ ! -d "src-graphviz" ]
88
then

src/zstd.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ let g_zstd: Promise<Zstd>;
1010
/**
1111
* The Zstandard WASM library, provides a simplified wrapper around the Zstandard c++ library.
1212
*
13-
* Dee [Zstandard](https://facebook.github.io/zstd/) for more details.
13+
* See [Zstandard](https://facebook.github.io/zstd/) for more details.
1414
*
1515
* ```ts
16-
* import { Graphviz } from "@hpcc-js/wasm/zstd";
16+
* import { Zstd } from "@hpcc-js/wasm/zstd";
1717
*
1818
* const zstd = await Zstd.load();
1919
*

0 commit comments

Comments
 (0)