mongoose 6.2.7 → 6.2.10

package/lib/types/array/methods/index.js

@@ -100,7 +100,7 @@ const methods = {
   /**
    * Atomically shifts the array at most one time per document `save()`.
    *
-   * ####NOTE:
+   * #### Note:
    *
    * _Calling this multiple times on an array before saving sends the same command as calling it once._
    * _This update is implemented using the MongoDB [$pop](https://www.mongodb.org/display/DOCS/Updating/#Updating-%24pop) method which enforces this restriction._
@@ -365,7 +365,7 @@ const methods = {
   /**
    * Adds values to the array if not already present.
    *
-   * ####Example:
+   * #### Example:
    *
    *     console.log(doc.array) // [2,3,4]
    *     const added = doc.array.addToSet(4,5);
@@ -445,6 +445,7 @@ const methods = {
    * Return whether or not the `obj` is included in the array.
    *
    * @param {Object} obj the item to check
+   * @param {Number} fromIndex
    * @return {Boolean}
    * @api public
    * @method includes
@@ -460,6 +461,7 @@ const methods = {
    * Return the index of `obj` or `-1` if not found.
    *
    * @param {Object} obj the item to look for
+   * @param {Number} fromIndex
    * @return {Number}
    * @api public
    * @method indexOf
@@ -496,7 +498,7 @@ const methods = {
   /**
    * Pushes items to the array non-atomically.
    *
-   * ####NOTE:
+   * #### Note:
    *
    * _marks the entire array as modified, which if saved, will store it as a `$set` operation, potentially overwritting any changes that happen between when you retrieved the object and when you save it._
    *
@@ -517,7 +519,7 @@ const methods = {
   /**
    * Wraps [`Array#pop`](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/pop) with proper change tracking.
    *
-   * ####Note:
+   * #### Note:
    *
    * _marks the entire array as modified which will pass the entire thing to $set potentially overwriting any changes that happen between when you retrieved the object and when you save it._
    *
@@ -539,7 +541,7 @@ const methods = {
    * the provided value to an embedded document and comparing using
    * [the `Document.equals()` function.](/docs/api.html#document_Document-equals)
    *
-   * ####Examples:
+   * #### Examples:
    *
    *     doc.array.pull(ObjectId)
    *     doc.array.pull({ _id: 'someId' })
@@ -609,7 +611,7 @@ const methods = {
   /**
    * Wraps [`Array#push`](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/push) with proper change tracking.
    *
-   * ####Example:
+   * #### Example:
    *
    *     const schema = Schema({ nums: [Number] });
    *     const Model = mongoose.model('Test', schema);
@@ -704,7 +706,7 @@ const methods = {
   /**
    * Sets the casted `val` at index `i` and marks the array modified.
    *
-   * ####Example:
+   * #### Example:
    *
    *     // given documents based on the following
    *     const Doc = mongoose.model('Doc', new Schema({ array: [Number] }));
@@ -743,14 +745,14 @@ const methods = {
   /**
    * Wraps [`Array#shift`](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/unshift) with proper change tracking.
    *
-   * ####Example:
+   * #### Example:
    *
    *     doc.array = [2,3];
    *     const res = doc.array.shift();
    *     console.log(res) // 2
    *     console.log(doc.array) // [3]
    *
-   * ####Note:
+   * #### Note:
    *
    * _marks the entire array as modified, which if saved, will store it as a `$set` operation, potentially overwritting any changes that happen between when you retrieved the object and when you save it._
    *
@@ -770,7 +772,7 @@ const methods = {
   /**
    * Wraps [`Array#sort`](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/sort) with proper change tracking.
    *
-   * ####NOTE:
+   * #### Note:
    *
    * _marks the entire array as modified, which if saved, will store it as a `$set` operation, potentially overwritting any changes that happen between when you retrieved the object and when you save it._
    *
@@ -790,7 +792,7 @@ const methods = {
   /**
    * Wraps [`Array#splice`](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/splice) with proper change tracking and casting.
    *
-   * ####Note:
+   * #### Note:
    *
    * _marks the entire array as modified, which if saved, will store it as a `$set` operation, potentially overwritting any changes that happen between when you retrieved the object and when you save it._
    *
@@ -867,7 +869,7 @@ const methods = {
   /**
    * Wraps [`Array#unshift`](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/unshift) with proper change tracking.
    *
-   * ####Note:
+   * #### Note:
    *
    * _marks the entire array as modified, which if saved, will store it as a `$set` operation, potentially overwriting any changes that happen between when you retrieved the object and when you save it._
    *

package/lib/types/buffer.js

@@ -113,7 +113,7 @@ MongooseBuffer.mixin = {
   /**
    * Copies the buffer.
    *
-   * ####Note:
+   * #### Note:
    *
    * `Buffer#copy` does not mark `target` as modified so you must copy from a `MongooseBuffer` for it to work as expected. This is a work around since `copy` modifies the target, not this.
    *

package/lib/types/decimal128.js

@@ -1,7 +1,7 @@
 /**
  * ObjectId type constructor
  *
- * ####Example
+ * #### Example
  *
  *     const id = new mongoose.Types.ObjectId;
  *

package/lib/types/objectid.js

@@ -1,7 +1,7 @@
 /**
  * ObjectId type constructor
  *
- * ####Example
+ * #### Example
  *
  *     const id = new mongoose.Types.ObjectId;
  *

package/lib/types/subdocument.js

@@ -58,7 +58,7 @@ Subdocument.prototype.toBSON = function() {
 /**
  * Used as a stub for middleware
  *
- * ####NOTE:
+ * #### Note:
  *
  * _This is a no-op. Does not actually save the doc to the db._
  *
@@ -116,7 +116,7 @@ Subdocument.prototype.$__pathRelativeToParent = function(p) {
 /**
  * Used as a stub for middleware
  *
- * ####NOTE:
+ * #### Note:
  *
  * _This is a no-op. Does not actually save the doc to the db._
  *

package/lib/virtualtype.js

@@ -7,7 +7,7 @@ const utils = require('./utils');
  *
  * This is what mongoose uses to define virtual attributes via `Schema.prototype.virtual`.
  *
- * ####Example:
+ * #### Example:
  *
  *     const fullname = schema.virtual('fullname');
  *     fullname instanceof mongoose.VirtualType // true
@@ -24,6 +24,7 @@ const utils = require('./utils');
  * @param {Number} [options.skip=null] add a default `skip` to the `populate()` query
  * @param {Number} [options.perDocumentLimit=null] For legacy reasons, `limit` with `populate()` may give incorrect results because it only executes a single query for every document being populated. If you set `perDocumentLimit`, Mongoose will ensure correct `limit` per document by executing a separate query for each document to `populate()`. For example, `.find().populate({ path: 'test', perDocumentLimit: 2 })` will execute 2 additional queries if `.find()` returns 2 documents.
  * @param {Object} [options.options=null] Additional options like `limit` and `lean`.
+ * @param {string} name
  * @api public
  */
 
@@ -77,7 +78,7 @@ VirtualType.prototype.clone = function() {
  * - `virtual`: the virtual object you called `.get()` on
  * - `doc`: the document this virtual is attached to. Equivalent to `this`.
  *
- * ####Example:
+ * #### Example:
  *
  *     const virtual = schema.virtual('fullname');
  *     virtual.get(function(value, virtual, doc) {
@@ -103,7 +104,7 @@ VirtualType.prototype.get = function(fn) {
  * - `virtual`: the virtual object you're calling `.set()` on
  * - `doc`: the document this virtual is attached to. Equivalent to `this`.
  *
- * ####Example:
+ * #### Example:
  *
  *     const virtual = schema.virtual('fullname');
  *     virtual.set(function(value, virtual, doc) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "6.2.7",
+  "version": "6.2.10",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -20,7 +20,7 @@
   "license": "MIT",
   "dependencies": {
     "bson": "^4.2.2",
-    "kareem": "2.3.4",
+    "kareem": "2.3.5",
     "mongodb": "4.3.1",
     "mpath": "0.8.4",
     "mquery": "4.0.2",
@@ -28,33 +28,34 @@
     "sift": "16.0.0"
   },
   "devDependencies": {
-    "@babel/core": "7.17.5",
+    "@babel/core": "7.17.8",
     "@babel/preset-env": "7.16.11",
-    "@typescript-eslint/eslint-plugin": "5.12.0",
-    "@typescript-eslint/parser": "5.12.0",
-    "acquit": "1.x",
-    "acquit-ignore": "0.2.x",
-    "acquit-require": "0.1.x",
-    "babel-loader": "8.2.3",
+    "@typescript-eslint/eslint-plugin": "5.17.0",
+    "@typescript-eslint/parser": "5.17.0",
+    "acquit": "1.2.1",
+    "acquit-ignore": "0.2.0",
+    "acquit-require": "0.1.1",
+    "axios": "0.26.1",
+    "babel-loader": "8.2.4",
     "benchmark": "2.1.4",
     "bluebird": "3.7.2",
     "cheerio": "1.0.0-rc.10",
     "dox": "0.3.1",
-    "eslint": "8.9.0",
+    "eslint": "8.12.0",
     "eslint-plugin-mocha-no-only": "1.1.1",
-    "highlight.js": "9.18.3",
+    "highlight.js": "11.5.0",
     "lodash.isequal": "4.5.0",
     "lodash.isequalwith": "4.4.0",
-    "marked": "2.1.3",
-    "mocha": "9.2.1",
+    "marked": "4.0.12",
+    "mocha": "9.2.2",
     "moment": "2.x",
     "mongodb-memory-server": "^8.3.0",
     "nyc": "^15.1.0",
     "pug": "3.0.2",
     "q": "1.5.1",
     "serve-handler": "6.1.3",
-    "tsd": "0.19.1",
-    "typescript": "4.5.5",
+    "tsd": "0.20.0",
+    "typescript": "4.6.3",
     "uuid": "8.3.2",
     "webpack": "4.44.1"
   },
@@ -69,7 +70,7 @@
     "release-legacy": "git pull origin 5.x && git push origin 5.x --tags && npm publish --tag legacy",
     "mongo": "node ./tools/repl.js",
     "test": "mocha --exit ./test/*.test.js",
-    "test-tsd": "tsd",
+    "test-tsd": "node ./test/types/check-types-filename && tsd",
     "tdd": "mocha ./test/*.test.js ./test/typescript/main.test.js --inspect --watch --recursive --watch-files ./**/*.js",
     "test-coverage": "nyc --reporter=html --reporter=text npm test"
   },
@@ -116,4 +117,4 @@
       "target": "ES2017"
     }
   }
-}
+}

package/tools/repl.js

@@ -5,7 +5,7 @@ run().catch(error => {
   process.exit(-1);
 });
 
-async function run () {
+async function run() {
   const ReplSet = require('mongodb-memory-server').MongoMemoryReplSet;
 
   // Create new instance
@@ -15,20 +15,20 @@ async function run () {
     },
     instanceOpts: [
       // Set the expiry job in MongoDB to run every second
-      { 
+      {
         port: 27017,
-        args: ["--setParameter", "ttlMonitorSleepSecs=1"] },
+        args: ['--setParameter', 'ttlMonitorSleepSecs=1'] }
     ],
     dbName: 'mongoose_test',
     replSet: {
-      name: "rs0",
+      name: 'rs0',
       count: 2,
-      storageEngine: "wiredTiger",
-    },
+      storageEngine: 'wiredTiger'
+    }
   });
 
   await replSet.start();
   await replSet.waitUntilRunning();
-  console.log("MongoDB-ReplicaSet is now running.")
-  console.log(replSet.getUri("mongoose_test"));
+  console.log('MongoDB-ReplicaSet is now running.');
+  console.log(replSet.getUri('mongoose_test'));
 }

package/tools/sharded.js

@@ -6,7 +6,7 @@ run().catch(error => {
 });
 
 
-async function run () {
+async function run() {
   const Sharded = require('mongodb-topology-manager').Sharded;
 
   // Create new instance
@@ -17,13 +17,13 @@ async function run () {
 
   await topology.addShard([{
     options: {
-      bind_ip: 'localhost', port: 31000, dbpath: `/data/db/31000`, shardsvr: null
+      bind_ip: 'localhost', port: 31000, dbpath: '/data/db/31000', shardsvr: null
     }
   }], { replSet: 'rs1' });
 
   await topology.addConfigurationServers([{
     options: {
-      bind_ip: 'localhost', port: 35000, dbpath: `/data/db/35000`
+      bind_ip: 'localhost', port: 35000, dbpath: '/data/db/35000'
     }
   }], { replSet: 'rs0' });