This module provide and usefull helper to use mongoose library. 

federico-garcia

awilches

hjimenez-condorlabs

jorgelozano95

jorgesanes

kevin.pedroza_condorlabs.io

daniel.castillo

@condor-labs/mongodb

- Add support for Mongoose 7 versions [#317](https://github.com/cebroker/condorlabs-npm-helpers/pull/317).

- An update of the dependencies is performed to eliminate security alerts. [#308](https://github.com/cebroker/condorlabs-npm-helpers/pull/308).

- [#258](https://github.com/cebroker/condorlabs-npm-helpers/issues/307)

- Fix mongoose prototype pollution vulnerability.

- An update of the dependencies is performed to eliminate security alerts. [#259](https://github.com/cebroker/condorlabs-npm-helpers/pull/259).

- [#258](https://github.com/cebroker/condorlabs-npm-helpers/issues/258)

- The @hapi/joi library is deprecated, it was changed to joi.

- An update of the mongoose version is performed.

- The query-string library has been upgraded.

If you get the following message: **[MONGOOSE] DeprecationWarning: Mongoose: the `strictQuery` option will be switched back to `false` by default in Mongoose 7. Use `mongoose.set('strictQuery', false);` if you want to prepare for this change. Or use `mongoose.set('strictQuery', true);` to suppress this warning.**

This is a warning message from Mongoose indicating that the strictQuery option will be switched to false by default in Mongoose 7. This option controls whether database queries should strictly apply the schema definition.

To prepare for this change, you can add the following code to your Mongoose configuration file:

This will globally set strictQuery to false in your application.

If for some reason you wish to continue using strictQuery in Mongoose 7, you can set the option to true with:

It's important to note that this warning only applies to the strictQuery option, and has no effect on the behavior of your application. It's simply a notification that the default value of this option will change in future versions of Mongoose.

- We have implemented Typescript for the MongoDB library. Also, we upgraded the versions of mongoose and the logger. [#225](https://github.com/cebroker/condorlabs-npm-helpers/pull/225)

  "description": "This module provide and usefull helper to use mongoose library.",

    "coverage": "jest --env=jsdom --coverage",

    "url": "git+https://github.com/cebroker/condorlabs-npm-helpers.git"

    "url": "https://github.com/cebroker/condorlabs-npm-helpers/issues"

  "homepage": "https://github.com/cebroker/condorlabs-npm-helpers/tree/master/mongodb/library#readme",

      "<rootDir>/(lib|build|docs|node_modules)/"

    "mongoose": "^6.11.4 || >=7.0.0 <8.0.0"

See official documentation [here](https://github.com/Automattic/mongoose).

The minimum supported version of Node.js is v8.

To use the library you just need to follow the following steps

const mongodb = require('@condor-labs/mongodb')(settings);

### `settings` array of object properties

those are the properties for each connection object

| Property                                      | Default              | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |

| --------------------------------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| connectionName _(String)_                     |                      | It is a unique value that will indentify the connection you are using                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |

| host _(String)_                               | `127.0.0.1`          | The host name of the database you are connecting to. In case you want to connect to mongo Atlas via cluster. <br> A) You must check the connection metrics of your cluster. <br> B) Copy the hosts of your metrics and concatenate them in the host property of your connection configuration to mongo example: in its connection parameters. host: 'cluster0-shard-00-00.ksccs.mongodbnet'cluster0-shard-00-01.ksccs.mongodb.net,cluster0-shard-00-02.ksccs.mongodb.net' <br>keep in mind which host property receives one or multiple hosts. |

| port _(Number)_                               | `27017`              | The port number to connect to.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |

| user _(String)_                               |                      | The username for authentication. This option is mongoose-specific, they are equivalent to the MongoDB driver's auth.username options.                                                                                                                                                                                                                                                                                                                                                                                                          |

| password _(String)_                           |                      | The password for authentication. This option is mongoose-specific, they are equivalent to the MongoDB driver's auth.password options.                                                                                                                                                                                                                                                                                                                                                                                                          |

| database _(String)_                           |                      | Specifies which database to connect to and overrides any database specified in the connection string.                                                                                                                                                                                                                                                                                                                                                                                                                                          |

| replicaSet _(String)_                         |                      | To connect to a single node replica set, specify the replicaSet option, see [Replica Set Host Names ](https://mongoosejs.com/docs/connections.html#replicaset-hostnames)                                                                                                                                                                                                                                                                                                                                                                       |

| ssl _(Boolean)_                               | `false`              | Flag to indicate the connection will use SSL                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |

| authSource _(String)_                         |                      | See [Replica Set Connections ](https://mongoosejs.com/docs/connections.html#replicaset_connections)                                                                                                                                                                                                                                                                                                                                                                                                                                            |

| ~~reconnectTries _(Number)_~~ (Deprecrated)   | `30000`              | If you're connected to a single server or mongos proxy (as opposed to a replica set), the MongoDB driver will try to reconnect every reconnectInterval milliseconds for reconnectTries times, and give up afterward. When the driver gives up, the mongoose connection emits a reconnectFailed event. This option does nothing for replica set connections.                                                                                                                                                                                    |

| ~~reconnectInterval _(Number)_~~ (Deprecated) | `1000`               | See `reconnectTries`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |

| readPreference _(String)_                     | `secondaryPreferred` | Read preference describes how MongoDB clients route read operations to the members of a replica set. Possibles values: `primary`, `primaryPreferred`, `secondary`, `secondaryPreferred`, `nearest`.<br>**Docs:** https://docs.mongodb.com/manual/core/read-preference/                                                                                                                                                                                                                                                                         |

| Property           | Description                                                                                                                             |

| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |

| primary            | All operations read from the current replica set primary.                                                                               |

| primaryPreferred   | In most situations, operations read from the primary but if it is unavailable, operations read from secondary members.                  |

| secondary          | All operations read from the secondary members of the replica set.                                                                      |

| secondaryPreferred | In most situations, operations read from secondary members but if no secondary members are available, operations read from the primary. |

| nearest            | Operations read from member of the replica set with the least network latency, irrespective of the member’s type.                       |

### In case you want to connect to mongo Atlas via cluster,

1. You should check the connection metrics of your cluster.You must verify that this is your ip

2. Copy the hosts of your metrics and concatenate them in the host property of your connection configuration to mongo example: in its connection parameters.

   Only the url of this section should be included, separated by commas.

**host:** 'cluster0-shard-00-00.ksccs.mongodb.net,cluster0-shard-00-01.ksccs.mongodb.net,cluster0-shard-00-02.ksccs.mongodb.net'

3. You may have an authentication error, you must verify that your user has read and write permissions.

this error may also be due to not adding the **authSource** attribute in the configuration json.

There are two ways to connect the MongoDB with @condor-labs/mongodb, one is a single connection and the other is multi-connection

## 1. Connect using a single connection and Replica Set

This session provides a help to connect to mongodb using a single connection and Replica Sets.

To use this connection you need the following

A. Define the configuration variables in an object in the `constants.js` file for the connection, which are the following

    host: 'exapmle-shard-00-00-8burs.mongodb.net,exapmle-shard-00-01-8burs.mongodb.net,exapmle-shard-00-02-8burs.mongodb.net',

    replicaSet: 'compliance-support-shard-0',

B. Import the @condor-labs/mongodb library and the configuration variables in the `connectionMongoDb.js` file as follows

const mongodb = require('@condor-labs/mongodb')(mongo.settings);

C. To establish the connection with MongoDB the instance is created in the `connectionMongoDb.js` file

const mongodb = require("@condor-labs/mongodb")(mongo.settings);

  console.log(`isConnected(after):${mongodb._isConnected()}`);

		@@ -0,1 +1,6 @@
		# 3.1.0 - 2023-10-05
		Notes:

		- Add support for Mongoose 7 versions [#317](https://github.com/cebroker/condorlabs-npm-helpers/pull/317).

		# 3.0.0 - 2023-07-18
		@@ -2,0 +7,0 @@ Notes:

		{
		"name": "@condor-labs/mongodb",
		"version": "3.0.0",
		"version": "3.1.0",
		"description": "This module provide and usefull helper to use mongoose library.",
		@@ -46,3 +46,3 @@ "main": "index.js",
		"peerDependencies": {
		"mongoose": "^6.11.4 <7.0.0"
		"mongoose": "^6.11.4 \|\| >=7.0.0 <8.0.0"
		},
		@@ -49,0 +49,0 @@ "devDependencies": {

		@@ -16,3 +16,3 @@ This module provide and usefull helper to use mongoose library.
		```js
		npm i -S mongoose@">=6.0.0 <7.0.0"
		npm i -S mongoose@">=6.11.4 <8.0.0"
		// or
		@@ -19,0 +19,0 @@ npm i -S mongoose@6.11.4

Improved metrics