feat: add bson ObjectId impl (#340)

Co-authored-by: gustavo-shigueo <[email protected]>
Aleph-Alpha · Jul 24, 2024 · e268437 · e268437
1 parent 68f2f22
commit e268437
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 # master
 ### Breaking
 ### Features
+
+- The `bson-uuid-impl` feature now supports `bson::oid::ObjectId` as well
+
 ### Fixes
 
 # 9.0.1

diff --git a/README.md b/README.md
@@ -79,8 +79,8 @@ When running `cargo test`, the TypeScript bindings will be exported to the file
 | chrono-impl        | Implement `TS` for types from *chrono*                                                                                                                                                                    |
 | bigdecimal-impl    | Implement `TS` for types from *bigdecimal*                                                                                                                                                                |
 | url-impl           | Implement `TS` for types from *url*                                                                                                                                                                       |
-| uuid-impl          | Implement `TS` for types from *uuid*                                                                                                                                                                      |
-| bson-uuid-impl     | Implement `TS` for types from *bson*                                                                                                                                                                      |
+| uuid-impl          | Implement `TS` for types from *uuid*
+| bson-uuid-impl     | Implement `TS` for *bson::oid::ObjectId* and *bson::uuid*                                                                                                                                                 |
 | bytes-impl         | Implement `TS` for types from *bytes*                                                                                                                                                                     |
 | indexmap-impl      | Implement `TS` for types from *indexmap*                                                                                                                                                                  |
 | ordered-float-impl | Implement `TS` for types from *ordered_float*                                                                                                                                                             |

diff --git a/ts-rs/src/lib.rs b/ts-rs/src/lib.rs
@@ -77,8 +77,8 @@
 //! | chrono-impl        | Implement `TS` for types from *chrono*                                                                                                                                                                    |
 //! | bigdecimal-impl    | Implement `TS` for types from *bigdecimal*                                                                                                                                                                |
 //! | url-impl           | Implement `TS` for types from *url*                                                                                                                                                                       |
-//! | uuid-impl          | Implement `TS` for types from *uuid*                                                                                                                                                                      |
-//! | bson-uuid-impl     | Implement `TS` for types from *bson*                                                                                                                                                                      |
+//! | uuid-impl          | Implement `TS` for types from *uuid*    
+//! | bson-uuid-impl     | Implement `TS` for *bson::oid::ObjectId* and *bson::uuid*                                                                                                                                                 |
 //! | bytes-impl         | Implement `TS` for types from *bytes*                                                                                                                                                                     |
 //! | indexmap-impl      | Implement `TS` for types from *indexmap*                                                                                                                                                                  |
 //! | ordered-float-impl | Implement `TS` for types from *ordered_float*                                                                                                                                                             |
@@ -1006,6 +1006,9 @@ impl_primitives! { ordered_float::OrderedFloat<f32> => "number" }
 #[cfg(feature = "ordered-float-impl")]
 impl_primitives! { ordered_float::OrderedFloat<f64> => "number" }
 
+#[cfg(feature = "bson-uuid-impl")]
+impl_primitives! { bson::oid::ObjectId => "string" }
+
 #[cfg(feature = "bson-uuid-impl")]
 impl_primitives! { bson::Uuid => "string" }
 

diff --git a/ts-rs/tests/integration/bson.rs b/ts-rs/tests/integration/bson.rs
@@ -0,0 +1,16 @@
+#![cfg(feature = "bson-uuid-impl")]
+
+use bson::{oid::ObjectId, Uuid};
+use ts_rs::TS;
+
+#[derive(TS)]
+#[ts(export, export_to = "bson/")]
+struct User {
+    _id: ObjectId,
+    _uuid: Uuid,
+}
+
+#[test]
+fn bson() {
+    assert_eq!(User::decl(), "type User = { _id: string, _uuid: string, };")
+}
diff --git a/ts-rs/tests/integration/main.rs b/ts-rs/tests/integration/main.rs
@@ -2,6 +2,7 @@
 
 mod arrays;
 mod bound;
+mod bson;
 mod chrono;
 mod concrete_generic;
 mod docs;