Add CHANGELOG entry.

realm · Apr 11, 2024 · cb27021 · cb27021
1 parent 08a52e2
commit cb27021
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,13 @@
 > [!NOTE]
 > This version communicates with Atlas Device Services through a different URL (https://services.cloud.mongodb.com). While we consider this an internal detail of the SDK, you might need to update rules in firewalls or other configuration that you've used to limit connections made by your app.
 
+### Breaking changes
+* The re-exported [bson](https://www.npmjs.com/package/bson) library (via `Realm.BSON`) has been upgraded from 4.7.2 to 6.6.0. ([6561](https://github.com/realm/realm-js/issues/6561))
+  * Notable changes (refer to BSON's [v5](https://github.com/mongodb/js-bson/releases/tag/v5.0.0) and [v6](https://github.com/mongodb/js-bson/releases/tag/v6.0.0) release notes for all changes):
+    * Removed `ObjectID` with uppercase `D` (please use `ObjectId`).
+    * `EJSON` is only exported as the value and not the type (to use it as a type, please use `typeof EJSON`).
+    * The `Decimal128.bytes` type is now a `Uint8Array` instead of a `Buffer`.
+
 ### Enhancements
 * Updated bundled OpenSSL version to 3.2.0. ([realm/realm-core#7303](https://github.com/realm/realm-core/pull/7303))
 * Improved performance of object notifiers with complex schemas by ~20%. ([realm/realm-core#7424](https://github.com/realm/realm-core/pull/7424))

diff --git a/packages/realm-web/CHANGELOG.md b/packages/realm-web/CHANGELOG.md
@@ -3,6 +3,13 @@
 > [!NOTE]
 > This version communicates with Atlas Device Services through a different URL (https://services.cloud.mongodb.com). While we consider this an internal detail of the SDK, you might need to update rules in firewalls or other configuration that you've used to limit connections made by your app.
 
+### Breaking changes
+* The re-exported [bson](https://www.npmjs.com/package/bson) library (via `Realm.BSON`) has been upgraded from 4.7.2 to 6.6.0. ([6561](https://github.com/realm/realm-js/issues/6561))
+  * Notable changes (refer to BSON's [v5](https://github.com/mongodb/js-bson/releases/tag/v5.0.0) and [v6](https://github.com/mongodb/js-bson/releases/tag/v6.0.0) release notes for all changes):
+    * Removed `ObjectID` with uppercase `D` (please use `ObjectId`).
+    * `EJSON` is only exported as the value and not the type (to use it as a type, please use `typeof EJSON`).
+    * The `Decimal128.bytes` type is now a `Uint8Array` instead of a `Buffer`.
+
 ### Deprecations
 * None