From 7a4410fdd7504d8686e3802eb4ee53a2b06d242d Mon Sep 17 00:00:00 2001 From: Daria Pardue Date: Thu, 10 Aug 2023 11:42:50 -0400 Subject: [PATCH 1/8] docs: add component support matrix to readme --- README.md | 39 ++++++++++++++++++++++++++------------- 1 file changed, 26 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index ce65b755609..38b873d1db7 100644 --- a/README.md +++ b/README.md @@ -6,19 +6,19 @@ The official [MongoDB](https://www.mongodb.com/) driver for Node.js. ## Quick Links -| Site | Link | -| -------------------------| ----------------------------------------------------------------------------------------------------------------- | -| Documentation | [www.mongodb.com/docs/drivers/node](https://www.mongodb.com/docs/drivers/node) | -| API Docs | [mongodb.github.io/node-mongodb-native](https://mongodb.github.io/node-mongodb-native) | -| `npm` package | [www.npmjs.com/package/mongodb](https://www.npmjs.com/package/mongodb) | -| MongoDB | [www.mongodb.com](https://www.mongodb.com) | -| MongoDB University | [learn.mongodb.com](https://learn.mongodb.com/catalog?labels=%5B%22Language%22%5D&values=%5B%22Node.js%22%5D) | -| MongoDB Developer Center | [www.mongodb.com/developer](https://www.mongodb.com/developer/languages/javascript/) | +| Site | Link | +| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | +| Documentation | [www.mongodb.com/docs/drivers/node](https://www.mongodb.com/docs/drivers/node) | +| API Docs | [mongodb.github.io/node-mongodb-native](https://mongodb.github.io/node-mongodb-native) | +| `npm` package | [www.npmjs.com/package/mongodb](https://www.npmjs.com/package/mongodb) | +| MongoDB | [www.mongodb.com](https://www.mongodb.com) | +| MongoDB University | [learn.mongodb.com](https://learn.mongodb.com/catalog?labels=%5B%22Language%22%5D&values=%5B%22Node.js%22%5D) | +| MongoDB Developer Center | [www.mongodb.com/developer](https://www.mongodb.com/developer/languages/javascript/) | | Stack Overflow | [stackoverflow.com](https://stackoverflow.com/search?q=%28%5Btypescript%5D+or+%5Bjavascript%5D+or+%5Bnode.js%5D%29+and+%5Bmongodb%5D) | -| Source Code | [github.com/mongodb/node-mongodb-native](https://github.com/mongodb/node-mongodb-native) | -| Upgrade to v5 | [etc/notes/CHANGES_5.0.0.md](https://github.com/mongodb/node-mongodb-native/blob/HEAD/etc/notes/CHANGES_5.0.0.md) | -| Contributing | [CONTRIBUTING.md](https://github.com/mongodb/node-mongodb-native/blob/HEAD/CONTRIBUTING.md) | -| Changelog | [HISTORY.md](https://github.com/mongodb/node-mongodb-native/blob/HEAD/HISTORY.md) | +| Source Code | [github.com/mongodb/node-mongodb-native](https://github.com/mongodb/node-mongodb-native) | +| Upgrade to v5 | [etc/notes/CHANGES_5.0.0.md](https://github.com/mongodb/node-mongodb-native/blob/HEAD/etc/notes/CHANGES_5.0.0.md) | +| Contributing | [CONTRIBUTING.md](https://github.com/mongodb/node-mongodb-native/blob/HEAD/CONTRIBUTING.md) | +| Changelog | [HISTORY.md](https://github.com/mongodb/node-mongodb-native/blob/HEAD/HISTORY.md) | ### Bugs / Feature Requests @@ -42,11 +42,24 @@ Change history can be found in [`HISTORY.md`](https://github.com/mongodb/node-mo ### Compatibility -For version compatibility matrices, please refer to the following links: +For server and runtime version compatibility matrices, please refer to the following links: - [MongoDB](https://www.mongodb.com/docs/drivers/node/current/compatibility/#mongodb-compatibility) - [NodeJS](https://www.mongodb.com/docs/drivers/node/current/compatibility/#language-compatibility) +#### Component Support Matrix + +The following table describes add-on compponent version compatibility for the Node.js driver. Only packages with versions in these supported ranges are stable when used in combination. + +| Component | mongodb@3.x | mongodb@4.x | mongodb@5.x | mongodb@6.x | +| ------------------------- | ----------- | ------------------ | ------------------ | ----------- | +| bson | ^1.0.0 | ^2.0.0 | ^5.0.0 | ^6.0.0 | +| bson-ext | ^1.0.0 | ^2.0.0 | N/A | N/A | +| kerberos | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.0.0 | +| mongodb-client-encryption | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.3.0 | ^6.0.0 | +| mongodb-legacy | N/A | ^4.0.0 | ^5.0.0 | ^6.0.0 | +| @mongodb-js/zstd | N/A | ^1.0.0 | ^1.0.0 | ^1.1.0 | + #### Typescript Version We recommend using the latest version of typescript, however we currently ensure the driver's public types compile against `typescript@4.1.6`. From ef794dad6b6f8df805f2551114319701322d87b3 Mon Sep 17 00:00:00 2001 From: Daria Pardue Date: Thu, 10 Aug 2023 11:44:46 -0400 Subject: [PATCH 2/8] fix: escape special character --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 38b873d1db7..4d88c270c9c 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ The following table describes add-on compponent version compatibility for the No | kerberos | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.0.0 | | mongodb-client-encryption | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.3.0 | ^6.0.0 | | mongodb-legacy | N/A | ^4.0.0 | ^5.0.0 | ^6.0.0 | -| @mongodb-js/zstd | N/A | ^1.0.0 | ^1.0.0 | ^1.1.0 | +| \@mongodb-js/zstd | N/A | ^1.0.0 | ^1.0.0 | ^1.1.0 | #### Typescript Version From b420382eccfbddd2441ec464f6e3f46d92abd6d4 Mon Sep 17 00:00:00 2001 From: Daria Pardue Date: Thu, 10 Aug 2023 16:27:28 -0400 Subject: [PATCH 3/8] docs: add links to add-on libs --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4d88c270c9c..0977802e718 100644 --- a/README.md +++ b/README.md @@ -51,14 +51,14 @@ For server and runtime version compatibility matrices, please refer to the follo The following table describes add-on compponent version compatibility for the Node.js driver. Only packages with versions in these supported ranges are stable when used in combination. -| Component | mongodb@3.x | mongodb@4.x | mongodb@5.x | mongodb@6.x | -| ------------------------- | ----------- | ------------------ | ------------------ | ----------- | -| bson | ^1.0.0 | ^2.0.0 | ^5.0.0 | ^6.0.0 | -| bson-ext | ^1.0.0 | ^2.0.0 | N/A | N/A | -| kerberos | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.0.0 | -| mongodb-client-encryption | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.3.0 | ^6.0.0 | -| mongodb-legacy | N/A | ^4.0.0 | ^5.0.0 | ^6.0.0 | -| \@mongodb-js/zstd | N/A | ^1.0.0 | ^1.0.0 | ^1.1.0 | +| Component | mongodb@3.x | mongodb@4.x | mongodb@5.x | mongodb@6.x | +| ------------------------------------------------------------------------------------ | ----------- | ------------------ | ------------------ | ----------- | +| [bson](https://www.npmjs.com/package/bson) | ^1.0.0 | ^2.0.0 | ^5.0.0 | ^6.0.0 | +| [bson-ext](https://www.npmjs.com/package/bson-ext) | ^1.0.0 | ^2.0.0 | N/A | N/A | +| [kerberos](https://www.npmjs.com/package/kerberos) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.0.0 | +| [mongodb-client-encryption](https://www.npmjs.com/package/mongodb-client-encryption) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.3.0 | ^6.0.0 | +| [mongodb-legacy](https://www.npmjs.com/package/mongodb-legacy) | N/A | ^4.0.0 | ^5.0.0 | ^6.0.0 | +| [\@mongodb-js/zstd](https://www.npmjs.com/package/@mongodb-js/zstd) | N/A | ^1.0.0 | ^1.0.0 | ^1.1.0 | #### Typescript Version From add47b59bc8d3df8956f9eb1886f9a5a514b4281 Mon Sep 17 00:00:00 2001 From: Daria Pardue Date: Thu, 10 Aug 2023 16:32:04 -0400 Subject: [PATCH 4/8] fix: more escape characters --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0977802e718..940724bac29 100644 --- a/README.md +++ b/README.md @@ -51,14 +51,14 @@ For server and runtime version compatibility matrices, please refer to the follo The following table describes add-on compponent version compatibility for the Node.js driver. Only packages with versions in these supported ranges are stable when used in combination. -| Component | mongodb@3.x | mongodb@4.x | mongodb@5.x | mongodb@6.x | -| ------------------------------------------------------------------------------------ | ----------- | ------------------ | ------------------ | ----------- | -| [bson](https://www.npmjs.com/package/bson) | ^1.0.0 | ^2.0.0 | ^5.0.0 | ^6.0.0 | -| [bson-ext](https://www.npmjs.com/package/bson-ext) | ^1.0.0 | ^2.0.0 | N/A | N/A | -| [kerberos](https://www.npmjs.com/package/kerberos) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.0.0 | -| [mongodb-client-encryption](https://www.npmjs.com/package/mongodb-client-encryption) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.3.0 | ^6.0.0 | -| [mongodb-legacy](https://www.npmjs.com/package/mongodb-legacy) | N/A | ^4.0.0 | ^5.0.0 | ^6.0.0 | -| [\@mongodb-js/zstd](https://www.npmjs.com/package/@mongodb-js/zstd) | N/A | ^1.0.0 | ^1.0.0 | ^1.1.0 | +| Component | mongodb\@3.x | mongodb\@4.x | mongodb\@5.x | mongodb\@6.x | +| ------------------------------------------------------------------------------------ | ------------ | ------------------ | ------------------ | ------------ | +| [bson](https://www.npmjs.com/package/bson) | ^1.0.0 | ^2.0.0 | ^5.0.0 | ^6.0.0 | +| [bson-ext](https://www.npmjs.com/package/bson-ext) | ^1.0.0 | ^2.0.0 | N/A | N/A | +| [kerberos](https://www.npmjs.com/package/kerberos) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.0.0 | +| [mongodb-client-encryption](https://www.npmjs.com/package/mongodb-client-encryption) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.3.0 | ^6.0.0 | +| [mongodb-legacy](https://www.npmjs.com/package/mongodb-legacy) | N/A | ^4.0.0 | ^5.0.0 | ^6.0.0 | +| [\@mongodb-js/zstd](https://www.npmjs.com/package/@mongodb-js/zstd) | N/A | ^1.0.0 | ^1.0.0 | ^1.1.0 | #### Typescript Version From dae6f56708a565c62dcce4fff1ffd2f757b3180d Mon Sep 17 00:00:00 2001 From: Daria Pardue Date: Thu, 10 Aug 2023 16:35:30 -0400 Subject: [PATCH 5/8] fix: formatting --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 940724bac29..4dbd82d9dc2 100644 --- a/README.md +++ b/README.md @@ -51,14 +51,14 @@ For server and runtime version compatibility matrices, please refer to the follo The following table describes add-on compponent version compatibility for the Node.js driver. Only packages with versions in these supported ranges are stable when used in combination. -| Component | mongodb\@3.x | mongodb\@4.x | mongodb\@5.x | mongodb\@6.x | -| ------------------------------------------------------------------------------------ | ------------ | ------------------ | ------------------ | ------------ | -| [bson](https://www.npmjs.com/package/bson) | ^1.0.0 | ^2.0.0 | ^5.0.0 | ^6.0.0 | -| [bson-ext](https://www.npmjs.com/package/bson-ext) | ^1.0.0 | ^2.0.0 | N/A | N/A | -| [kerberos](https://www.npmjs.com/package/kerberos) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.0.0 | -| [mongodb-client-encryption](https://www.npmjs.com/package/mongodb-client-encryption) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.3.0 | ^6.0.0 | -| [mongodb-legacy](https://www.npmjs.com/package/mongodb-legacy) | N/A | ^4.0.0 | ^5.0.0 | ^6.0.0 | -| [\@mongodb-js/zstd](https://www.npmjs.com/package/@mongodb-js/zstd) | N/A | ^1.0.0 | ^1.0.0 | ^1.1.0 | +| Component | `mongodb@3.x` | `mongodb@4.x` | `mongodb@5.x` | `mongodb@6.x` | +| ------------------------------------------------------------------------------------ | ------------- | ------------------ | ------------------ | ------------- | +| [bson](https://www.npmjs.com/package/bson) | ^1.0.0 | ^2.0.0 | ^5.0.0 | ^6.0.0 | +| [bson-ext](https://www.npmjs.com/package/bson-ext) | ^1.0.0 | ^2.0.0 | N/A | N/A | +| [kerberos](https://www.npmjs.com/package/kerberos) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.0.0 | +| [mongodb-client-encryption](https://www.npmjs.com/package/mongodb-client-encryption) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.3.0 | ^6.0.0 | +| [mongodb-legacy](https://www.npmjs.com/package/mongodb-legacy) | N/A | ^4.0.0 | ^5.0.0 | ^6.0.0 | +| [@mongodb-js/zstd](https://www.npmjs.com/package/@mongodb-js/zstd) | N/A | ^1.0.0 | ^1.0.0 | ^1.1.0 | #### Typescript Version From 2a64dcef893cadcca82747f9a2f61818533dd4d9 Mon Sep 17 00:00:00 2001 From: Daria Pardue Date: Fri, 11 Aug 2023 15:34:45 -0400 Subject: [PATCH 6/8] Update README.md Co-authored-by: Durran Jordan --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4dbd82d9dc2..fcb711028a5 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ The following table describes add-on compponent version compatibility for the No | ------------------------------------------------------------------------------------ | ------------- | ------------------ | ------------------ | ------------- | | [bson](https://www.npmjs.com/package/bson) | ^1.0.0 | ^2.0.0 | ^5.0.0 | ^6.0.0 | | [bson-ext](https://www.npmjs.com/package/bson-ext) | ^1.0.0 | ^2.0.0 | N/A | N/A | -| [kerberos](https://www.npmjs.com/package/kerberos) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.0.0 | +| [kerberos](https://www.npmjs.com/package/kerberos) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.0.1 | | [mongodb-client-encryption](https://www.npmjs.com/package/mongodb-client-encryption) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.3.0 | ^6.0.0 | | [mongodb-legacy](https://www.npmjs.com/package/mongodb-legacy) | N/A | ^4.0.0 | ^5.0.0 | ^6.0.0 | | [@mongodb-js/zstd](https://www.npmjs.com/package/@mongodb-js/zstd) | N/A | ^1.0.0 | ^1.0.0 | ^1.1.0 | From 8e52b26c2258ea50c948699bc3783a22f2494684 Mon Sep 17 00:00:00 2001 From: Daria Pardue Date: Fri, 11 Aug 2023 15:38:18 -0400 Subject: [PATCH 7/8] docs: adjust compat table for bson and bson-ext --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fcb711028a5..8c838476d18 100644 --- a/README.md +++ b/README.md @@ -51,14 +51,14 @@ For server and runtime version compatibility matrices, please refer to the follo The following table describes add-on compponent version compatibility for the Node.js driver. Only packages with versions in these supported ranges are stable when used in combination. -| Component | `mongodb@3.x` | `mongodb@4.x` | `mongodb@5.x` | `mongodb@6.x` | -| ------------------------------------------------------------------------------------ | ------------- | ------------------ | ------------------ | ------------- | -| [bson](https://www.npmjs.com/package/bson) | ^1.0.0 | ^2.0.0 | ^5.0.0 | ^6.0.0 | -| [bson-ext](https://www.npmjs.com/package/bson-ext) | ^1.0.0 | ^2.0.0 | N/A | N/A | -| [kerberos](https://www.npmjs.com/package/kerberos) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.0.1 | -| [mongodb-client-encryption](https://www.npmjs.com/package/mongodb-client-encryption) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.3.0 | ^6.0.0 | -| [mongodb-legacy](https://www.npmjs.com/package/mongodb-legacy) | N/A | ^4.0.0 | ^5.0.0 | ^6.0.0 | -| [@mongodb-js/zstd](https://www.npmjs.com/package/@mongodb-js/zstd) | N/A | ^1.0.0 | ^1.0.0 | ^1.1.0 | +| Component | `mongodb@3.x` | `mongodb@4.x` | `mongodb@5.x` | `mongodb@6.x` | +| ------------------------------------------------------------------------------------ | ------------------ | ------------------ | ------------------ | ------------- | +| [bson](https://www.npmjs.com/package/bson) | ^1.0.0 | ^4.0.0 | ^5.0.0 | ^6.0.0 | +| [bson-ext](https://www.npmjs.com/package/bson-ext) | ^1.0.0 \|\| ^2.0.0 | ^4.0.0 | N/A | N/A | +| [kerberos](https://www.npmjs.com/package/kerberos) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.0.1 | +| [mongodb-client-encryption](https://www.npmjs.com/package/mongodb-client-encryption) | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.3.0 | ^6.0.0 | +| [mongodb-legacy](https://www.npmjs.com/package/mongodb-legacy) | N/A | ^4.0.0 | ^5.0.0 | ^6.0.0 | +| [@mongodb-js/zstd](https://www.npmjs.com/package/@mongodb-js/zstd) | N/A | ^1.0.0 | ^1.0.0 | ^1.1.0 | #### Typescript Version From 7d44569d894683044b40b861b98a4fd39ebca920 Mon Sep 17 00:00:00 2001 From: Daria Pardue Date: Fri, 11 Aug 2023 15:40:53 -0400 Subject: [PATCH 8/8] Update README.md Co-authored-by: Neal Beeken --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8c838476d18..9943f6f8223 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ For server and runtime version compatibility matrices, please refer to the follo #### Component Support Matrix -The following table describes add-on compponent version compatibility for the Node.js driver. Only packages with versions in these supported ranges are stable when used in combination. +The following table describes add-on component version compatibility for the Node.js driver. Only packages with versions in these supported ranges are stable when used in combination. | Component | `mongodb@3.x` | `mongodb@4.x` | `mongodb@5.x` | `mongodb@6.x` | | ------------------------------------------------------------------------------------ | ------------------ | ------------------ | ------------------ | ------------- |