Enum support for TryIntoJs, structured errors from Result

CHANGELOG.md

@@ -3,9 +3,11 @@
 ## Unreleased
 ### Improvements
 
-## [4.4.0] - TBD
+## [5.0.0] - TBD
 ### Improvements
-- Added support for automatic conversion of structs into the JS representation by decorating their definition with `#[node_bindgen]`
+- Added support for automatic conversion of structs and enums into the JS representation by decorating their definition with `#[node_bindgen]` ([#148](https://github.com/infinyon/node-bindgen/pull/148) and [#155](https://github.com/infinyon/node-bindgen/pull/155))
+- Defined a `NjError::Native` Error payload, which allows errors to return structured data to JS
+- `Result<T, E>` converts the error value to JS using `TryIntoJs` for structured error payloads
 - Add support for passing tuples between Node and Rust ([#142](https://github.com/infinyon/node-bindgen/pull/142))
 - Bump electron from 9.3.1 to 9.4.0 in /examples/electron ([#135](https://github.com/infinyon/node-bindgen/pull/135))
 - Update JSArrayBuffer to be usable in `env.convert_to_rust` ([#136](https://github.com/infinyon/node-bindgen/pull/136))

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "node-bindgen"
-version = "4.4.0"
+version = "5.0.0"
 authors = ["Fluvio Contributors <[email protected]>"]
 edition = "2018"
 description = "easy way to write nodejs module using rust"
@@ -15,7 +15,7 @@ build = ["nj-build"]
 
 [dependencies]
 nj-sys = { path = "nj-sys", version = "3.0.0", optional = true }
-nj-core = { path = "nj-core", version = "4.3.0", optional = true }
+nj-core = { path = "nj-core", version = "5.0.0", optional = true }
 nj-build = { path = "nj-build", version = "0.2.3", optional = true }
 nj-derive = { path = "nj-derive", version = "3.2.0", optional = true }
 

README.md

@@ -270,7 +270,7 @@ fn my_json() -> MyJson {
 
 ```js
 let addon = require('./dist');
-assert.deepEqual(addon.my_json(), {
+assert.deepStrictEqual(addon.my_json(), {
     someName: "John",
     aNumber: 1337
 });
@@ -281,6 +281,53 @@ Note that the fields must implement
 Any references must also implement `Clone`.
 Field names will be converted to camelCase.
 
+## Enums
+
+Enums will also have their JS representation autogenerated with the help of `node_bindgen`:
+
+```rust
+#[node_bindgen]
+enum ErrorType {
+    WithMessage(String, usize),
+    WithFields {
+        val: usize
+    },
+    UnitErrorType
+}
+
+#[node_bindgen]
+fn with_message() -> ErrorType {
+    ErrorType::WithMessage("test".to_owned(), 321)
+}
+
+#[node_bindgen]
+fn with_fields() -> ErrorType {
+    ErrorType::WithFields {
+        val: 123
+    }
+}
+
+#[node_bindgen]
+fn with_unit() -> ErrorType {
+    ErrorType::UnitErrorType
+}
+```
+
+```js
+assert.deepStrictEqual(addon.withMessage(), {
+    withMessage: ["test", 321n]
+});
+assert.deepStrictEqual(addon.withFields(), {
+    withFields: {
+        val: 123n
+    }
+});
+assert.deepStrictEqual(addon.withUnit(), "UnitErrorType")
+```
+
+Tuple variants will be converted into lists, struct variants converted to objects, and unit variants converted into strings matching the variant's name in PascalCase.
+Generics and references are supported, with the same caveats as for structs.
+
 ## JavaScript class
 
 JavaScript class is supported.