Merge pull request #60 from siefkenj/for-tsify

Merge tsify-next into tsify
Great thanks to @siefkenj.

Author: madonoharu

.github/workflows/on-pull-request.yml

@@ -0,0 +1,90 @@
+name: Build and Test
+
+on:
+    push:
+        branches: [main, next]
+    pull_request:
+        branches: ["*"]
+
+jobs:
+    build:
+        name: Build
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout sources
+              uses: actions/checkout@v3
+
+            - name: Install toolchain
+              uses: actions-rs/toolchain@v1
+              with:
+                  profile: minimal
+                  toolchain: stable
+                  override: true
+
+            - name: Check
+              uses: actions-rs/cargo@v1
+              with:
+                  command: check
+
+            - name: Build
+              uses: actions-rs/cargo@v1
+              with:
+                  command: build
+    test:
+        name: Test
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout sources
+              uses: actions/checkout@v3
+
+            - name: Setup Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version: '20'
+
+            - name: Install toolchain
+              uses: actions-rs/toolchain@v1
+              with:
+                  profile: minimal
+                  toolchain: stable
+                  override: true
+                  components: rustfmt
+
+            - name: Install wasm-pack
+              uses: jetli/wasm-pack-action@v0.4.0
+              with:
+                  # Optional version of wasm-pack to install(eg. 'v0.9.1', 'latest')
+                  version: "latest"
+
+            - name: Add cargo-expand
+              run: cargo install cargo-expand
+
+            # Run the ./test.sh script
+            - name: Test
+              run: ./test.sh
+    lint:
+        name: Lint
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout sources
+              uses: actions/checkout@v3
+
+            - name: Install toolchain
+              uses: actions-rs/toolchain@v1
+              with:
+                  profile: minimal
+                  toolchain: stable
+                  override: true
+                  components: rustfmt, clippy
+
+            - name: Cargo fmt
+              uses: actions-rs/cargo@v1
+              with:
+                  command: fmt
+                  args: --all -- --check
+
+            - name: Cargo clippy
+              run: cargo clippy -- -D warnings

.gitignore

@@ -1,2 +1,4 @@
 /target
-Cargo.lock
+Cargo.lock
+.vscode
+tests-e2e/*/pkg

CHANGELOG.md

@@ -0,0 +1,30 @@
+# tsify Changelog
+
+## v0.5.5
+
+- Don't assume a struct named `Range` is automatically a `Range` type
+- Put `#[automatically_derived]` on `impl` blocks
+- Better handling of `#[serde(skip)]`
+- Bump the `wasm_bindgen` dep version
+
+## v0.5.4
+
+-  Allow serializing of `Vec<Struct>` provided that `Struct` is serializable.
+
+## v0.5.3
+
+-   Propagate errors encountered during serialization.
+-   More fixes for missing `From` trait implementations.
+
+## v0.5.2
+
+-   Fix missing trait bounds for implemented `From` traits.
+
+## v0.5.1
+
+-   @Pantamis contributed #22, implementing more `From` traits for more ergonomic use of Futures.
+-   Fix: empty enums now produce a valid type of `void` rather than producing invalid Typescript.
+
+## v0.5.0
+
+-   Forked from `tsify` merging most PRs that were queued on Github

Cargo.toml

@@ -1,8 +1,11 @@
 [package]
 name = "tsify"
-version = "0.4.5"
+version = "0.5.5"
 edition = "2021"
-authors = ["Madono Haru <madonoharu@gmail.com>"]
+authors = [
+  "Madono Haru <madonoharu@gmail.com>",
+  "Jason Siefken <siefkenj@gmail.com>"
+]
 license = "MIT OR Apache-2.0"
 description = "Tsify is a library for generating TypeScript definitions from rust code."
 repository = "https://github.com/madonoharu/tsify"
@@ -11,28 +14,29 @@ keywords = ["wasm", "wasm-bindgen", "typescript"]
 categories = ["wasm"]
 
 [dependencies]
-tsify-macros = { path = "tsify-macros", version = "0.4.3" }
-wasm-bindgen = { version = "0.2.86", optional = true }
-serde = { version = "1.0", optional = true }
+tsify-macros = { path = "tsify-macros", version = "0.5.5" }
+wasm-bindgen = { version = "0.2.100", optional = true }
+serde = { version = "1.0", features = ["derive"], optional = true }
 serde_json = { version = "1.0", optional = true }
-serde-wasm-bindgen = { version = "0.5.0", optional = true }
-gloo-utils = { version = "0.1.6", optional = true }
+serde-wasm-bindgen = { version = "0.6", optional = true }
+gloo-utils = { version = "0.2", optional = true }
 
 [dev-dependencies]
-indoc = "2.0.1"
-js-sys = "0.3.63"
+indoc = "2.0.5"
+js-sys = "0.3"
 macrotest = "1.0"
-pretty_assertions = "1.3.0"
-serde = { version = "1.0", features = ["derive"] }
-serde-wasm-bindgen = "0.5.0"
-serde_json = "1.0"
-wasm-bindgen = "0.2.86"
-wasm-bindgen-test = "0.3.36"
+pretty_assertions = "1.4.0"
+wasm-bindgen-test = "0.3"
 
 [features]
 default = ["json"]
 wasm-bindgen = ["tsify-macros/wasm-bindgen", "dep:wasm-bindgen"]
-js = ["wasm-bindgen", "tsify-macros/js", "dep:serde", "dep:serde-wasm-bindgen"]
+js = [
+  "wasm-bindgen",
+  "tsify-macros/js",
+  "dep:serde",
+  "dep:serde-wasm-bindgen"
+]
 json = [
   "wasm-bindgen",
   "tsify-macros/json",
@@ -42,4 +46,5 @@ json = [
 ]
 
 [workspace]
-members = ["tsify-macros"]
+members = ["tsify-macros", "tests-e2e/*"]
+exclude = ["tests-e2e/reference_output"]

README.md

@@ -15,7 +15,7 @@ Click to show Cargo.toml.
 
 ```toml
 [dependencies]
-tsify = "0.4.5"
+tsify = "0.5.5"
 serde = { version = "1.0", features = ["derive"] }
 wasm-bindgen = { version = "0.2" }
 ```
@@ -57,45 +57,45 @@ export function into_js(): Point;
  */
 export function from_js(point: Point): void;
 export interface Point {
-  x: number;
-  y: number;
+    x: number;
+    y: number;
 }
 ```
 
 This is the behavior due to [`typescript_custom_section`](https://rustwasm.github.io/docs/wasm-bindgen/reference/attributes/on-rust-exports/typescript_custom_section.html) and [`Rust Type conversions`](https://rustwasm.github.io/docs/wasm-bindgen/contributing/design/rust-type-conversions.html).
 
 ## Crate Features
 
-- `json` (default) enables serialization through [`serde_json`](https://github.com/serde-rs/json).
-- `js` enables serialization through [`serde-wasm-bindgen`](https://github.com/cloudflare/serde-wasm-bindgen) and generates the appropriate types for it. This will be the default in future versions.
+-   `json` (default) enables serialization through [`serde_json`](https://github.com/serde-rs/json).
+-   `js` enables serialization through [`serde-wasm-bindgen`](https://github.com/cloudflare/serde-wasm-bindgen) and generates the appropriate types for it. This will be the default in future versions.
 
 ## Attributes
 
 Tsify container attributes
 
-- `into_wasm_abi` implements `IntoWasmAbi` and `OptionIntoWasmAbi`. This can be converted directly from Rust to JS via `serde_json` or `serde-wasm-bindgen`.
-- `from_wasm_abi` implements `FromWasmAbi` and `OptionFromWasmAbi`. This is the opposite operation of the above.
-- `namespace` generates a namespace for the enum variants.
+-   `into_wasm_abi` implements `IntoWasmAbi` and `OptionIntoWasmAbi`. This can be converted directly from Rust to JS via `serde_json` or `serde-wasm-bindgen`.
+-   `from_wasm_abi` implements `FromWasmAbi` and `OptionFromWasmAbi`. This is the opposite operation of the above.
+-   `namespace` generates a namespace for the enum variants.
 
 Tsify field attributes
 
-- `type`
-- `optional`
+-   `type`
+-   `optional`
 
 Serde attributes
 
-- `rename`
-- `rename-all`
-- `tag`
-- `content`
-- `untagged`
-- `skip`
-- `skip_serializing`
-- `skip_deserializing`
-- `skip_serializing_if = "Option::is_none"`
-- `flatten`
-- `default`
-- `transparent`
+-   `rename`
+-   `rename-all`
+-   `tag`
+-   `content`
+-   `untagged`
+-   `skip`
+-   `skip_serializing`
+-   `skip_deserializing`
+-   `skip_serializing_if = "Option::is_none"`
+-   `flatten`
+-   `default`
+-   `transparent`
 
 ## Type Override
 
@@ -113,7 +113,7 @@ Generated type:
 
 ```ts
 export interface Foo {
-  x: 0 | 1 | 2;
+    x: 0 | 1 | 2;
 }
 ```
 
@@ -135,9 +135,9 @@ Generated type:
 
 ```ts
 export interface Optional {
-  a?: number;
-  b?: string;
-  c?: number;
+    a?: number;
+    b?: string;
+    c?: number;
 }
 ```
 
@@ -162,11 +162,11 @@ Generated type:
 
 ```ts
 export type Color =
-  | "Red"
-  | "Blue"
-  | "Green"
-  | { Rgb: [number, number, number] }
-  | { Hsv: { hue: number; saturation: number; value: number } };
+    | "Red"
+    | "Blue"
+    | "Green"
+    | { Rgb: [number, number, number] }
+    | { Hsv: { hue: number; saturation: number; value: number } };
 ```
 
 ## Enum with namespace
@@ -191,19 +191,21 @@ Generated type:
 
 ```ts
 declare namespace Color {
-  export type Red = "Red";
-  export type Blue = "Blue";
-  export type Green = "Green";
-  export type Rgb = { Rgb: [number, number, number] };
-  export type Hsv = { Hsv: { hue: number; saturation: number; value: number } };
+    export type Red = "Red";
+    export type Blue = "Blue";
+    export type Green = "Green";
+    export type Rgb = { Rgb: [number, number, number] };
+    export type Hsv = {
+        Hsv: { hue: number; saturation: number; value: number };
+    };
 }
 
 export type Color =
-  | "Red"
-  | "Blue"
-  | "Green"
-  | { Rgb: [number, number, number] }
-  | { Hsv: { hue: number; saturation: number; value: number } };
+    | "Red"
+    | "Blue"
+    | "Green"
+    | { Rgb: [number, number, number] }
+    | { Hsv: { hue: number; saturation: number; value: number } };
 ```
 
 ## Type Aliases

src/lib.rs

@@ -1,16 +1,36 @@
 #![allow(clippy::wrong_self_convention)]
 
+#[cfg(not(any(feature = "json", feature = "js")))]
+compile_error!(
+    "Either the \"json\" or \"js\" feature must be enabled for tsify to function properly"
+);
+
 #[cfg(all(feature = "json", not(feature = "js")))]
 pub use gloo_utils::format::JsValueSerdeExt;
+#[cfg(feature = "js")]
+pub use serde_wasm_bindgen;
 pub use tsify_macros::*;
 #[cfg(feature = "wasm-bindgen")]
 use wasm_bindgen::{JsCast, JsValue};
 
+pub struct SerializationConfig {
+    pub missing_as_null: bool,
+    pub hashmap_as_object: bool,
+    pub large_number_types_as_bigints: bool,
+}
+
+/// `Tsify` is a trait that allows you to convert a type to and from JavaScript.
+/// Can be implemented manually if you need to customize the serialization or deserialization.
 pub trait Tsify {
     #[cfg(feature = "wasm-bindgen")]
     type JsType: JsCast;
 
     const DECL: &'static str;
+    const SERIALIZATION_CONFIG: SerializationConfig = SerializationConfig {
+        missing_as_null: false,
+        hashmap_as_object: false,
+        large_number_types_as_bigints: false,
+    };
 
     #[cfg(all(feature = "json", not(feature = "js")))]
     #[inline]
@@ -36,7 +56,12 @@ pub trait Tsify {
     where
         Self: serde::Serialize,
     {
-        serde_wasm_bindgen::to_value(self).map(JsCast::unchecked_from_js)
+        let config = <Self as Tsify>::SERIALIZATION_CONFIG;
+        let serializer = serde_wasm_bindgen::Serializer::new()
+            .serialize_missing_as_null(config.missing_as_null)
+            .serialize_maps_as_objects(config.hashmap_as_object)
+            .serialize_large_number_types_as_bigints(config.large_number_types_as_bigints);
+        self.serialize(&serializer).map(JsCast::unchecked_from_js)
     }
 
     #[cfg(feature = "js")]