@mimik/mongooser 4.0.1 → 4.1.0

package/README.md

@@ -41,6 +41,8 @@ Creates a MongoDB connection manager for mimik microservices.
 | [config.encryption.aws] | <code>object</code> | AWS KMS provider settings. |
 | [config.encryption.database] | <code>string</code> | Database name for key vault. |
 | [config.encryption.keyVaultTable] | <code>string</code> | Collection name for key vault. |
+| [config.encryption.cryptSharedLibPath] | <code>string</code> | Absolute path to the crypt_shared library (.dylib/.so/.dll). When set, uses crypt_shared instead of mongocryptd and sets cryptSharedLibRequired: true so mongocryptd is never spawned. Download from https://www.mongodb.com/try/download/enterprise |
+| [config.encryption.mongocryptdURI] | <code>string</code> | URI of a remote mongocryptd process (e.g. Atlas-hosted). When set, the driver connects to this URI instead of spawning a local mongocryptd. Takes precedence over cryptSharedLibPath. |
 
 <a name="module_mongooser--module.exports..validate"></a>
 
@@ -80,9 +82,13 @@ Database initialization.
 **Kind**: inner method of [<code>module.exports</code>](#exp_module_mongooser--module.exports)  
 **Returns**: <code>object</code> - The mongoose database object. Connection is established asynchronously in the background.
 
-When encryption is enabled, configures auto-encryption by setting `keyVaultNamespace` and `kmsProviders`
-on the mongoose connection options.
-Check MongoDB documentation for the full autoEncryption specification: https://docs.mongodb.com/manual/reference/method/Mongo/#clientsidefieldlevelencryptionoptions
+When encryption is enabled, configures auto-encryption by setting `keyVaultNamespace`, `kmsProviders`,
+and optionally `extraOptions.cryptSharedLibPath` on the mongoose connection options.
+When `config.encryption.mongocryptdURI` is set, the driver connects to that remote mongocryptd (e.g. Atlas-hosted)
+and bypasses local auto-spawn. When `config.encryption.cryptSharedLibPath` is set instead, `crypt_shared` is used
+(no separate process required). `mongocryptdURI` takes precedence over `cryptSharedLibPath` if both are set.
+Without either, the driver falls back to spawning `mongocryptd` at localhost:27020 (requires MongoDB Enterprise).
+Note: `ClientEncryption` for explicit encryption should be imported from `mongodb`, not `mongodb-client-encryption`.
 
 Will exit 1 if the connection request generates an error or the connection state is `disconnected` or `disconnecting`.  
 **Category**: sync  

package/bitbucket-pipelines.yml

@@ -0,0 +1,25 @@
+# bitbucket-pipelines.yml
+image: node:24-alpine
+
+pipelines:
+  branches:
+    develop:
+      - step:
+          name: Test package
+          runs-on:
+            - backend.services
+          script:
+            - npm install
+            - npm run lint
+            - npm run test
+      - step:
+          name: Build and Publish
+          runs-on:
+            - backend.services
+          trigger: 'manual'
+          script:
+            - npm install
+            - pipe: atlassian/npm-publish:1.1.1
+              variables:
+                NPM_TOKEN: $NPM_TOKEN
+                EXTRA_ARGS: "--access public"

package/index.js

@@ -46,6 +46,8 @@ const MILLI_SEC = 1000;
  * @param {object} [config.encryption.aws] - AWS KMS provider settings.
  * @param {string} [config.encryption.database] - Database name for key vault.
  * @param {string} [config.encryption.keyVaultTable] - Collection name for key vault.
+ * @param {string} [config.encryption.cryptSharedLibPath] - Absolute path to the crypt_shared library (.dylib/.so/.dll). When set, uses crypt_shared instead of mongocryptd and sets cryptSharedLibRequired: true so mongocryptd is never spawned. Download from https://www.mongodb.com/try/download/enterprise
+ * @param {string} [config.encryption.mongocryptdURI] - URI of a remote mongocryptd process (e.g. Atlas-hosted). When set, the driver connects to this URI instead of spawning a local mongocryptd. Takes precedence over cryptSharedLibPath.
  * @return {object} Object with methods: initializeSync, validate, replicaSet, getKMSProviders.
  */
 export default (config) => {
@@ -88,9 +90,13 @@ export default (config) => {
    * @category sync
    * @return {object} The mongoose database object. Connection is established asynchronously in the background.
    *
-   * When encryption is enabled, configures auto-encryption by setting `keyVaultNamespace` and `kmsProviders`
-   * on the mongoose connection options.
-   * Check MongoDB documentation for the full autoEncryption specification: https://docs.mongodb.com/manual/reference/method/Mongo/#clientsidefieldlevelencryptionoptions
+   * When encryption is enabled, configures auto-encryption by setting `keyVaultNamespace`, `kmsProviders`,
+   * and optionally `extraOptions.cryptSharedLibPath` on the mongoose connection options.
+   * When `config.encryption.mongocryptdURI` is set, the driver connects to that remote mongocryptd (e.g. Atlas-hosted)
+   * and bypasses local auto-spawn. When `config.encryption.cryptSharedLibPath` is set instead, `crypt_shared` is used
+   * (no separate process required). `mongocryptdURI` takes precedence over `cryptSharedLibPath` if both are set.
+   * Without either, the driver falls back to spawning `mongocryptd` at localhost:27020 (requires MongoDB Enterprise).
+   * Note: `ClientEncryption` for explicit encryption should be imported from `mongodb`, not `mongodb-client-encryption`.
    *
    * Will exit 1 if the connection request generates an error or the connection state is `disconnected` or `disconnecting`.
    */
@@ -102,6 +108,18 @@ export default (config) => {
           autoEncryption: {
             keyVaultNamespace: `${encryption.database}.${encryption.keyVaultTable}`,
             kmsProviders: getKMSProviders(),
+            ...(encryption.mongocryptdURI && {
+              extraOptions: {
+                mongocryptdURI: encryption.mongocryptdURI,
+                mongocryptdBypassSpawn: true,
+              },
+            }),
+            ...(!encryption.mongocryptdURI && encryption.cryptSharedLibPath && {
+              extraOptions: {
+                cryptSharedLibPath: encryption.cryptSharedLibPath,
+                cryptSharedLibRequired: true,
+              },
+            }),
           },
         }
       : options;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/mongooser",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "Helper for setting up mongodb using mongoose for mimik microservices",
   "main": "./index.js",
   "type": "module",
@@ -11,8 +11,8 @@
   "scripts": {
     "lint": "eslint . --no-error-on-unmatched-pattern",
     "docs": "jsdoc2md index.js > README.md",
-    "test": "mocha --reporter mochawesome --bail --exit test/",
-    "test-ci": "c8 --reporter=lcov --reporter=text npm test",
+    "test": "mocha",
+    "test-ci": "c8 npm test",
     "prepublishOnly": "npm run docs && npm run lint && npm run test-ci",
     "commit-ready": "npm run docs && npm run lint && npm run test-ci"
   },
@@ -27,25 +27,26 @@
     "url": "https://bitbucket.org/mimiktech/mongooser"
   },
   "dependencies": {
-    "@mimik/lib-filters": "^2.0.8",
-    "@mimik/request-helper": "^2.0.6",
-    "@mimik/sumologic-winston-logger": "^2.2.2",
-    "mongoose": "9.3.1"
+    "@mimik/lib-filters": "^2.0.9",
+    "@mimik/request-helper": "^2.0.7",
+    "@mimik/sumologic-winston-logger": "^2.2.4",
+    "mongoose": "9.6.3"
   },
   "devDependencies": {
-    "@eslint/js": "9.39.4",
-    "@mimik/eslint-plugin-document-env": "^2.0.9",
-    "@mimik/eslint-plugin-logger": "^1.0.3",
+    "@eslint/js": "10.0.1",
+    "@mimik/eslint-plugin-document-env": "^2.1.0",
+    "@mimik/eslint-plugin-logger": "^1.0.4",
     "@stylistic/eslint-plugin": "5.10.0",
     "c8": "11.0.0",
     "chai": "6.2.2",
-    "eslint": "9.39.4",
-    "eslint-plugin-import": "2.32.0",
-    "esmock": "2.7.3",
-    "globals": "17.4.0",
+    "eslint": "10.4.1",
+    "eslint-plugin-import-x": "4.16.2",
+    "esmock": "2.7.6",
+    "globals": "17.6.0",
     "husky": "9.1.7",
     "jsdoc-to-markdown": "9.1.3",
-    "mocha": "11.7.5",
+    "mocha": "11.7.6",
     "mochawesome": "7.1.4"
-  }
+  },
+  "packageManager": "pnpm@11.5.1+sha512.93f7b57422ea7068257235b4c16eb60762eb68e1dc23723199cc739043ea9be2c4143274a399d8c6defa2b1176226d9ca1c4b63482d6200c1a8fbaa78c1d1485"
 }