bson 5.3.0 → 6.0.0-alpha

package/README.md

@@ -4,6 +4,7 @@ BSON is short for "Binary JSON," and is the binary-encoded serialization of JSON
 You can learn more about it in [the specification](http://bsonspec.org).
 
 ### Table of Contents
+
 - [Usage](#usage)
 - [Bugs/Feature Requests](#bugs--feature-requests)
 - [Installation](#installation)
@@ -18,7 +19,7 @@ Think you've found a bug? Want to see a new feature in `bson`? Please open a cas
 2. Navigate to the NODE project: [jira.mongodb.org/browse/NODE](https://jira.mongodb.org/browse/NODE)
 3. Click **Create Issue** - Please provide as much information as possible about the issue and how to reproduce it.
 
-Bug reports in JIRA for all driver projects (i.e. NODE, PYTHON, CSHARP, JAVA) and the Core Server (i.e. SERVER) project are **public**.
+Bug reports in JIRA for the NODE driver project are **public**.
 
 ## Usage
 
@@ -67,9 +68,20 @@ If you are working directly in the browser without a bundler please use the `.mj
 npm install bson
 ```
 
+### MongoDB Node.js Driver Version Compatibility
+
+Only the following version combinations with the [MongoDB Node.js Driver](https://github.com/mongodb/node-mongodb-native) are considered stable.
+
+|               | `bson@1.x` | `bson@4.x` | `bson@5.x` | `bson@6.x` |
+| ------------- | ---------- | ---------- | ---------- | ---------- |
+| `mongodb@6.x` | N/A        | N/A        | N/A        | ✓          |
+| `mongodb@5.x` | N/A        | N/A        | ✓          | N/A        |
+| `mongodb@4.x` | N/A        | ✓          | N/A        | N/A        |
+| `mongodb@3.x` | ✓          | N/A        | N/A        | N/A        |
+
 ## Documentation
 
-### BSON 
+### BSON
 
 [API documentation](https://mongodb.github.io/node-mongodb-native/Next/modules/BSON.html)
 
@@ -77,31 +89,31 @@ npm install bson
 
 ### EJSON
 
-* [EJSON](#EJSON)
-
-    * [.parse(text, [options])](#EJSON.parse)
+- [EJSON](#EJSON)
 
-    * [.stringify(value, [replacer], [space], [options])](#EJSON.stringify)
+  - [.parse(text, [options])](#EJSON.parse)
 
-    * [.serialize(bson, [options])](#EJSON.serialize)
+  - [.stringify(value, [replacer], [space], [options])](#EJSON.stringify)
 
-    * [.deserialize(ejson, [options])](#EJSON.deserialize)
+  - [.serialize(bson, [options])](#EJSON.serialize)
 
+  - [.deserialize(ejson, [options])](#EJSON.deserialize)
 
 <a name="EJSON.parse"></a>
 
-#### *EJSON*.parse(text, [options])
+#### _EJSON_.parse(text, [options])
 
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| text | <code>string</code> |  |  |
-| [options] | <code>object</code> |  | Optional settings |
+| Param             | Type                 | Default           | Description                                                                        |
+| ----------------- | -------------------- | ----------------- | ---------------------------------------------------------------------------------- |
+| text              | <code>string</code>  |                   |                                                                                    |
+| [options]         | <code>object</code>  |                   | Optional settings                                                                  |
 | [options.relaxed] | <code>boolean</code> | <code>true</code> | Attempt to return native JS types where possible, rather than BSON types (if true) |
 
 Parse an Extended JSON string, constructing the JavaScript value or object described by that
 string.
 
 **Example**
+
 ```js
 const { EJSON } = require('bson');
 const text = '{ "int32": { "$numberInt": "10" } }';
@@ -112,24 +124,26 @@ console.log(EJSON.parse(text, { relaxed: false }));
 // prints { int32: 10 }
 console.log(EJSON.parse(text));
 ```
+
 <a name="EJSON.stringify"></a>
 
-#### *EJSON*.stringify(value, [replacer], [space], [options])
+#### _EJSON_.stringify(value, [replacer], [space], [options])
 
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| value | <code>object</code> |  | The value to convert to extended JSON |
-| [replacer] | <code>function</code> \| <code>array</code> |  | A function that alters the behavior of the stringification process, or an array of String and Number objects that serve as a whitelist for selecting/filtering the properties of the value object to be included in the JSON string. If this value is null or not provided, all properties of the object are included in the resulting JSON string |
-| [space] | <code>string</code> \| <code>number</code> |  | A String or Number object that's used to insert white space into the output JSON string for readability purposes. |
-| [options] | <code>object</code> |  | Optional settings |
-| [options.relaxed] | <code>boolean</code> | <code>true</code> | Enabled Extended JSON's `relaxed` mode |
-| [options.legacy] | <code>boolean</code> | <code>true</code> | Output in Extended JSON v1 |
+| Param             | Type                                        | Default           | Description                                                                                                                                                                                                                                                                                                                                        |
+| ----------------- | ------------------------------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| value             | <code>object</code>                         |                   | The value to convert to extended JSON                                                                                                                                                                                                                                                                                                              |
+| [replacer]        | <code>function</code> \| <code>array</code> |                   | A function that alters the behavior of the stringification process, or an array of String and Number objects that serve as a whitelist for selecting/filtering the properties of the value object to be included in the JSON string. If this value is null or not provided, all properties of the object are included in the resulting JSON string |
+| [space]           | <code>string</code> \| <code>number</code>  |                   | A String or Number object that's used to insert white space into the output JSON string for readability purposes.                                                                                                                                                                                                                                  |
+| [options]         | <code>object</code>                         |                   | Optional settings                                                                                                                                                                                                                                                                                                                                  |
+| [options.relaxed] | <code>boolean</code>                        | <code>true</code> | Enabled Extended JSON's `relaxed` mode                                                                                                                                                                                                                                                                                                             |
+| [options.legacy]  | <code>boolean</code>                        | <code>true</code> | Output in Extended JSON v1                                                                                                                                                                                                                                                                                                                         |
 
 Converts a BSON document to an Extended JSON string, optionally replacing values if a replacer
 function is specified or optionally including only the specified properties if a replacer array
 is specified.
 
 **Example**
+
 ```js
 const { EJSON } = require('bson');
 const Int32 = require('mongodb').Int32;
@@ -141,24 +155,25 @@ console.log(EJSON.stringify(doc, { relaxed: false }));
 // prints '{"int32":10}'
 console.log(EJSON.stringify(doc));
 ```
+
 <a name="EJSON.serialize"></a>
 
-#### *EJSON*.serialize(bson, [options])
+#### _EJSON_.serialize(bson, [options])
 
-| Param | Type | Description |
-| --- | --- | --- |
-| bson | <code>object</code> | The object to serialize |
+| Param     | Type                | Description                                          |
+| --------- | ------------------- | ---------------------------------------------------- |
+| bson      | <code>object</code> | The object to serialize                              |
 | [options] | <code>object</code> | Optional settings passed to the `stringify` function |
 
 Serializes an object to an Extended JSON string, and reparse it as a JavaScript object.
 
 <a name="EJSON.deserialize"></a>
 
-#### *EJSON*.deserialize(ejson, [options])
+#### _EJSON_.deserialize(ejson, [options])
 
-| Param | Type | Description |
-| --- | --- | --- |
-| ejson | <code>object</code> | The Extended JSON object to deserialize |
+| Param     | Type                | Description                                  |
+| --------- | ------------------- | -------------------------------------------- |
+| ejson     | <code>object</code> | The Extended JSON object to deserialize      |
 | [options] | <code>object</code> | Optional settings passed to the parse method |
 
 Deserializes an Extended JSON object into a plain JavaScript object with native/BSON types
@@ -188,23 +203,16 @@ try {
 
 ## React Native
 
-BSON requires that `TextEncoder`, `TextDecoder`, `atob`, `btoa`, and `crypto.getRandomValues` are available globally.  These are present in most Javascript runtimes but require polyfilling in React Native.  Polyfills for the missing functionality can be installed with the following command:
+BSON vendors the required polyfills for `TextEncoder`, `TextDecoder`, `atob`, `btoa` imported from React Native and therefore doesn't expect users to polyfill these. One additional polyfill, `crypto.getRandomValues` is recommended and can be installed with the following command:
+
 ```sh
-npm install --save react-native-get-random-values text-encoding-polyfill base-64
+npm install --save react-native-get-random-values
 ```
 
-The following snippet should be placed at the top of the entrypoint (by default this is the root `index.js` file) for React Native projects using the BSON library.  These lines must be placed for any code that imports `BSON`.
+The following snippet should be placed at the top of the entrypoint (by default this is the root `index.js` file) for React Native projects using the BSON library. These lines must be placed for any code that imports `BSON`.
 
 ```typescript
 // Required Polyfills For ReactNative
-import {encode, decode} from 'base-64';
-if (global.btoa == null) {
-  global.btoa = encode;
-}
-if (global.atob == null) {
-  global.atob = decode;
-}
-import 'text-encoding-polyfill';
 import 'react-native-get-random-values';
 ```
 
@@ -214,11 +222,11 @@ Finally, import the `BSON` library like so:
 import { BSON, EJSON } from 'bson';
 ```
 
-This will cause React Native to import the `node_modules/bson/lib/bson.cjs` bundle (see the `"react-native"` setting we have in the `"exports"` section of our [package.json](./package.json).)
+This will cause React Native to import the `node_modules/bson/lib/bson.rn.cjs` bundle (see the `"react-native"` setting we have in the `"exports"` section of our [package.json](./package.json).)
 
 ### Technical Note about React Native module import
 
-The `"exports"` definition in our `package.json` will result in BSON's CommonJS bundle being imported in a React Native project instead of the ES module bundle.  Importing the CommonJS bundle is necessary because BSON's ES module bundle of BSON uses top-level await, which is not supported syntax in [React Native's runtime hermes](https://hermesengine.dev/).
+The `"exports"` definition in our `package.json` will result in BSON's CommonJS bundle being imported in a React Native project instead of the ES module bundle. Importing the CommonJS bundle is necessary because BSON's ES module bundle of BSON uses top-level await, which is not supported syntax in [React Native's runtime hermes](https://hermesengine.dev/).
 
 ## FAQ
 

package/bson.d.ts

@@ -31,16 +31,10 @@ export declare class Binary extends BSONValue {
     position: number;
     /**
      * Create a new Binary instance.
-     *
-     * This constructor can accept a string as its first argument. In this case,
-     * this string will be encoded using ISO-8859-1, **not** using UTF-8.
-     * This is almost certainly not what you want. Use `new Binary(Buffer.from(string))`
-     * instead to convert the string to a Buffer using UTF-8 first.
-     *
      * @param buffer - a buffer object containing the binary data.
      * @param subType - the option binary type.
      */
-    constructor(buffer?: string | BinarySequence, subType?: number);
+    constructor(buffer?: BinarySequence, subType?: number);
     /**
      * Updates this binary with byte_value.
      *
@@ -48,12 +42,12 @@ export declare class Binary extends BSONValue {
      */
     put(byteValue: string | number | Uint8Array | number[]): void;
     /**
-     * Writes a buffer or string to the binary.
+     * Writes a buffer to the binary.
      *
      * @param sequence - a string or buffer to be written to the Binary BSON object.
      * @param offset - specify the binary of where to write the content.
      */
-    write(sequence: string | BinarySequence, offset: number): void;
+    write(sequence: BinarySequence, offset: number): void;
     /**
      * Reads **length** bytes starting at **position**.
      *
@@ -61,13 +55,8 @@ export declare class Binary extends BSONValue {
      * @param length - the number of bytes to read.
      */
     read(position: number, length: number): BinarySequence;
-    /**
-     * Returns the value of this binary as a string.
-     * @param asRaw - Will skip converting to a string
-     * @remarks
-     * This is handy when calling this function conditionally for some key value pairs and not others
-     */
-    value(asRaw?: boolean): string | BinarySequence;
+    /** returns a view of the binary value as a Uint8Array */
+    value(): Uint8Array;
     /** the length of the binary sequence */
     length(): number;
     toJSON(): string;
@@ -990,7 +979,7 @@ export declare class ObjectId extends BSONValue {
      */
     get id(): Uint8Array;
     set id(value: Uint8Array);
-    /** Returns the ObjectId id as a 24 character hex string representation */
+    /** Returns the ObjectId id as a 24 lowercase character hex string representation */
     toHexString(): string;
     /* Excluded from this release type: getInc */
     /**
@@ -1006,12 +995,13 @@ export declare class ObjectId extends BSONValue {
     toString(encoding?: 'hex' | 'base64'): string;
     /** Converts to its JSON the 24 character hex string representation. */
     toJSON(): string;
+    /* Excluded from this release type: is */
     /**
      * Compares the equality of this ObjectId with `otherID`.
      *
      * @param otherId - ObjectId instance to compare against.
      */
-    equals(otherId: string | ObjectId | ObjectIdLike): boolean;
+    equals(otherId: string | ObjectId | ObjectIdLike | undefined | null): boolean;
     /** Returns the generation date (accurate up to the second) that this ID was generated. */
     getTimestamp(): Date;
     /* Excluded from this release type: createPk */
@@ -1030,9 +1020,8 @@ export declare class ObjectId extends BSONValue {
     /** Creates an ObjectId instance from a base64 string */
     static createFromBase64(base64: string): ObjectId;
     /**
-     * Checks if a value is a valid bson ObjectId
-     *
-     * @param id - ObjectId instance to validate.
+     * Checks if a value can be used to create a valid bson ObjectId
+     * @param id - any JS value
      */
     static isValid(id: string | number | ObjectId | ObjectIdLike | Uint8Array): boolean;
     /* Excluded from this release type: toExtendedJSON */
@@ -1213,8 +1202,6 @@ export declare type TimestampOverrides = '_bsontype' | 'toExtendedJSON' | 'fromE
  * @public
  */
 export declare class UUID extends Binary {
-    /** @deprecated Hex string is no longer cached, this control will be removed in a future major release */
-    static cacheHexString: boolean;
     /**
      * Create a UUID type
      *