mongodb-client-encryption
Advanced tools
mongodb-client-encryption - npm Package Compare versions
Comparing version 6.0.0-alpha.3 to 6.0.0
@@ -5,2 +5,4 @@ # Changelog | ||
| ## [6.0.0](https://github.com/mongodb/libmongocrypt/compare/node-v6.0.0-alpha.3...node-v6.0.0) (2023-08-28) | ||
| ## [6.0.0-alpha.3](https://github.com/mongodb/libmongocrypt/compare/node-v6.0.0-alpha.2...node-v6.0.0-alpha.3) (2023-08-09) | ||
@@ -7,0 +9,0 @@ |
| { | ||
| "name": "mongodb-client-encryption", | ||
| "version": "6.0.0-alpha.3", | ||
| "version": "6.0.0", | ||
| "description": "Official client encryption module for the MongoDB Node.js driver", | ||
@@ -48,4 +48,4 @@ "main": "lib/index.js", | ||
| "@types/mocha": "^10.0.1", | ||
| "@types/node": "^20.4.2", | ||
| "@typescript-eslint/eslint-plugin": "^6.0.0", | ||
| "@types/node": "^20.4.9", | ||
| "@typescript-eslint/eslint-plugin": "^6.3.0", | ||
| "bson": "^5.4.0", | ||
@@ -55,4 +55,4 @@ "chai": "^4.3.7", | ||
| "clang-format": "^1.8.0", | ||
| "eslint": "^8.39.0", | ||
| "eslint-config-prettier": "^8.8.0", | ||
| "eslint": "^8.46.0", | ||
| "eslint-config-prettier": "^8.10.0", | ||
| "eslint-plugin-prettier": "^4.2.1", | ||
@@ -67,3 +67,3 @@ "mocha": "^10.2.0", | ||
| "standard-version": "^9.5.0", | ||
| "tar": "^6.1.14", | ||
| "tar": "^6.1.15", | ||
| "ts-node": "^10.9.1", | ||
@@ -70,0 +70,0 @@ "typescript": "^5.1.6", |
@@ -1,6 +0,18 @@ | ||
| MongoDB Client Encryption | ||
| ========================= | ||
| # MongoDB Client Encryption | ||
| The Node.js wrapper for [`libmongocrypt`](../../README.md) | ||
| **Note** This library provides encryption functionality for the MongoDB Node.js driver but is **not intended** to be consumed in isolation. The public API that uses the functionality in this library is available in the `mongodb` package. | ||
| ### 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. | ||
| | | `mongodb-client-encryption@1.x` | `mongodb-client-encryption@2.x` | `mongodb-client-encryption@6.x` | | ||
| | ------------- | ------------------------------- | ------------------------------- | ------------------------------- | | ||
| | `mongodb@6.x` | N/A | N/A | ✓ | | ||
| | `mongodb@5.x` | N/A | ✓ | N/A | | ||
| | `mongodb@4.x` | ✓ | ✓ | N/A | | ||
| | `mongodb@3.x` | ✓ | N/A | N/A | | ||
| ### Installation | ||
@@ -15,2 +27,3 @@ | ||
| ### Development | ||
| #### Setup | ||
@@ -28,20 +41,8 @@ | ||
| To lint the Typescript, you can run `npm run check:eslint -- --fix`. To lint the c++, run `npm run clang-format`. | ||
| To lint the Typescript, you can run `npm run check:eslint -- --fix`. To lint the c++, run `npm run clang-format`. | ||
| #### Testing | ||
| Some tests require a standalone server to be running with authentication enabled. Set up a single | ||
| server running with the following conditions: | ||
| The unit tests require the binding to be built. Run `npm run rebuild` to build the addon from the c++ source. Then the tests can be run with `npm test`. | ||
| | param | value | | ||
| |-----------|-----------| | ||
| | host | localhost | | ||
| | port | 27017 | | ||
| This is the standard setup for a standalone server with no authentication. | ||
| Run the test suite using: | ||
| ```bash | ||
| npm test | ||
| ``` | ||
| Note: changes to c++ source are not automatically re-compiled. One needs to rebuild the bindings after each change. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.54%
75024
- Number of low quality alerts
- decreased by-50%
1
- Number of lines in readme file
- increased by2.17%
47