mongoose 6.4.2 → 6.4.3

package/.eslintrc.json

@@ -187,6 +187,7 @@
       "error"
     ],
     "no-empty": "off",
-    "eol-last": "warn"
+    "eol-last": "warn",
+    "no-multiple-empty-lines": ["warn", { "max": 2 }]
   }
 }

package/lib/document.js

@@ -1409,7 +1409,11 @@ Document.prototype.$set = function $set(path, val, type, options) {
       // later in `$__set()` because we don't take `_doc` when we iterate through
       // a single nested doc. That's to make sure we get the correct context.
       // Otherwise we would double-call the setter, see gh-7196.
-      val = schema.applySetters(val, this, false, priorVal, options);
+      if (options != null && options.overwriteImmutable) {
+        val = schema.applySetters(val, this, false, priorVal, { overwriteImmutable: true });
+      } else {
+        val = schema.applySetters(val, this, false, priorVal);
+      }
     }
 
     if (Array.isArray(val) &&

package/lib/schematype.js

@@ -384,6 +384,7 @@ SchemaType.prototype.default = function(val) {
  * #### Example:
  *
  *     const s = new Schema({ name: { type: String, index: true })
+ *     const s = new Schema({ name: { type: String, index: -1 })
  *     const s = new Schema({ loc: { type: [Number], index: 'hashed' })
  *     const s = new Schema({ loc: { type: [Number], index: '2d', sparse: true })
  *     const s = new Schema({ loc: { type: [Number], index: { type: '2dsphere', sparse: true }})
@@ -399,7 +400,7 @@ SchemaType.prototype.default = function(val) {
  * read/write operations you send until the index build.
  * Specify `background: false` to override Mongoose's default._
  *
- * @param {Object|Boolean|String} options
+ * @param {Object|Boolean|String|Number} options
  * @return {SchemaType} this
  * @api public
  */

package/lib/types/buffer.js

@@ -70,7 +70,7 @@ MongooseBuffer.mixin = {
    *
    * @api private
    * @property _subtype
-   * @receiver MongooseBuffer
+   * @memberOf MongooseBuffer
    */
 
   _subtype: undefined,
@@ -80,7 +80,7 @@ MongooseBuffer.mixin = {
    *
    * @api private
    * @method _markModified
-   * @receiver MongooseBuffer
+   * @memberOf MongooseBuffer
    */
 
   _markModified: function() {
@@ -97,7 +97,7 @@ MongooseBuffer.mixin = {
    *
    * @api public
    * @method write
-   * @receiver MongooseBuffer
+   * @memberOf MongooseBuffer
    */
 
   write: function() {
@@ -120,7 +120,7 @@ MongooseBuffer.mixin = {
    * @return {Number} The number of bytes copied.
    * @param {Buffer} target
    * @method copy
-   * @receiver MongooseBuffer
+   * @memberOf MongooseBuffer
    */
 
   copy: function(target) {
@@ -161,24 +161,22 @@ MongooseBuffer.mixin = {
 /**
  * Converts this buffer to its Binary type representation.
  *
- * ####SubTypes:
- *
- *   const bson = require('bson')
- *   bson.BSON_BINARY_SUBTYPE_DEFAULT
- *   bson.BSON_BINARY_SUBTYPE_FUNCTION
- *   bson.BSON_BINARY_SUBTYPE_BYTE_ARRAY
- *   bson.BSON_BINARY_SUBTYPE_UUID
- *   bson.BSON_BINARY_SUBTYPE_MD5
- *   bson.BSON_BINARY_SUBTYPE_USER_DEFINED
- *
- *   doc.buffer.toObject(bson.BSON_BINARY_SUBTYPE_USER_DEFINED);
+ * #### SubTypes:
+ *     const bson = require('bson')
+ *     bson.BSON_BINARY_SUBTYPE_DEFAULT
+ *     bson.BSON_BINARY_SUBTYPE_FUNCTION
+ *     bson.BSON_BINARY_SUBTYPE_BYTE_ARRAY
+ *     bson.BSON_BINARY_SUBTYPE_UUID
+ *     bson.BSON_BINARY_SUBTYPE_MD5
+ *     bson.BSON_BINARY_SUBTYPE_USER_DEFINED
+ *     doc.buffer.toObject(bson.BSON_BINARY_SUBTYPE_USER_DEFINED);
  *
  * @see https://bsonspec.org/#/specification
  * @param {Hex} [subtype]
  * @return {Binary}
  * @api public
  * @method toObject
- * @receiver MongooseBuffer
+ * @memberOf MongooseBuffer
  */
 
 MongooseBuffer.mixin.toObject = function(options) {
@@ -196,7 +194,7 @@ MongooseBuffer.mixin.$toObject = MongooseBuffer.mixin.toObject;
  * @return {Binary}
  * @api public
  * @method toBSON
- * @receiver MongooseBuffer
+ * @memberOf MongooseBuffer
  */
 
 MongooseBuffer.mixin.toBSON = function() {
@@ -209,7 +207,7 @@ MongooseBuffer.mixin.toBSON = function() {
  * @param {Buffer} other
  * @return {Boolean}
  * @method equals
- * @receiver MongooseBuffer
+ * @memberOf MongooseBuffer
  */
 
 MongooseBuffer.mixin.equals = function(other) {
@@ -233,23 +231,23 @@ MongooseBuffer.mixin.equals = function(other) {
 /**
  * Sets the subtype option and marks the buffer modified.
  *
- * ####SubTypes:
+ * #### SubTypes:
  *
- *   const bson = require('bson')
- *   bson.BSON_BINARY_SUBTYPE_DEFAULT
- *   bson.BSON_BINARY_SUBTYPE_FUNCTION
- *   bson.BSON_BINARY_SUBTYPE_BYTE_ARRAY
- *   bson.BSON_BINARY_SUBTYPE_UUID
- *   bson.BSON_BINARY_SUBTYPE_MD5
- *   bson.BSON_BINARY_SUBTYPE_USER_DEFINED
+ *     const bson = require('bson')
+ *     bson.BSON_BINARY_SUBTYPE_DEFAULT
+ *     bson.BSON_BINARY_SUBTYPE_FUNCTION
+ *     bson.BSON_BINARY_SUBTYPE_BYTE_ARRAY
+ *     bson.BSON_BINARY_SUBTYPE_UUID
+ *     bson.BSON_BINARY_SUBTYPE_MD5
+ *     bson.BSON_BINARY_SUBTYPE_USER_DEFINED
  *
- *   doc.buffer.subtype(bson.BSON_BINARY_SUBTYPE_UUID);
+ *     doc.buffer.subtype(bson.BSON_BINARY_SUBTYPE_UUID);
  *
  * @see https://bsonspec.org/#/specification
  * @param {Hex} subtype
  * @api public
  * @method subtype
- * @receiver MongooseBuffer
+ * @memberOf MongooseBuffer
  */
 
 MongooseBuffer.mixin.subtype = function(subtype) {

package/lib/types/decimal128.js

@@ -1,11 +1,11 @@
 /**
- * ObjectId type constructor
+ * Decimal128 type constructor
  *
  * #### Example
  *
- *     const id = new mongoose.Types.ObjectId;
+ *     const id = new mongoose.Types.Decimal128('3.1415');
  *
- * @constructor ObjectId
+ * @constructor Decimal128
  */
 
 'use strict';

package/lib/types/map.js

@@ -42,6 +42,14 @@ class MongooseMap extends Map {
     super.set(key, value);
   }
 
+  /**
+   * Overwrites native Map's `get()` function to support Mongoose getters.
+   *
+   * @api public
+   * @method get
+   * @memberOf Map
+   */
+
   get(key, options) {
     if (isBsonType(key, 'ObjectID')) {
       key = key.toString();
@@ -54,6 +62,20 @@ class MongooseMap extends Map {
     return this.$__schemaType.applyGetters(super.get(key), this.$__parent);
   }
 
+  /**
+   * Overwrites native Map's `set()` function to support setters, `populate()`,
+   * and change tracking. Note that Mongoose maps _only_ support strings and
+   * ObjectIds as keys.
+   *
+   * #### Example:
+   *     doc.myMap.set('test', 42); // works
+   *     doc.myMap.set({ obj: 42 }, 42); // Throws "Mongoose maps only support string keys"
+   *
+   * @api public
+   * @method set
+   * @memberOf Map
+   */
+
   set(key, value) {
     if (isBsonType(key, 'ObjectID')) {
       key = key.toString();
@@ -108,6 +130,14 @@ class MongooseMap extends Map {
     }
   }
 
+  /**
+   * Overwrites native Map's `clear()` function to support change tracking.
+   *
+   * @api public
+   * @method clear
+   * @memberOf Map
+   */
+
   clear() {
     super.clear();
     const parent = this.$__parent;
@@ -116,6 +146,14 @@ class MongooseMap extends Map {
     }
   }
 
+  /**
+   * Overwrites native Map's `delete()` function to support change tracking.
+   *
+   * @api public
+   * @method delete
+   * @memberOf Map
+   */
+
   delete(key) {
     if (isBsonType(key, 'ObjectID')) {
       key = key.toString();
@@ -125,6 +163,14 @@ class MongooseMap extends Map {
     super.delete(key);
   }
 
+  /**
+   * Converts this map to a native JavaScript Map so the MongoDB driver can serialize it.
+   *
+   * @api public
+   * @method toBSON
+   * @memberOf Map
+   */
+
   toBSON() {
     return new Map(this);
   }
@@ -146,6 +192,21 @@ class MongooseMap extends Map {
     return this.constructor.prototype.toObject.apply(this, arguments);
   }
 
+  /**
+   * Converts this map to a native JavaScript Map for `JSON.stringify()`. Set
+   * the `flattenMaps` option to convert this map to a POJO instead.
+   *
+   * #### Example:
+   *     doc.myMap.toJSON() instanceof Map; // true
+   *     doc.myMap.toJSON({ flattenMaps: true }) instanceof Map; // false
+   *
+   * @api public
+   * @method toJSON
+   * @param {Object} [options]
+   * @param {Boolean} [options.flattenMaps=false] set to `true` to convert the map to a POJO rather than a native JavaScript map
+   * @memberOf Map
+   */
+
   toJSON(options) {
     if (typeof (options && options.flattenMaps) === 'boolean' ? options.flattenMaps : true) {
       const ret = {};
@@ -209,6 +270,15 @@ Object.defineProperty(MongooseMap.prototype, '$__schemaType', {
   configurable: false
 });
 
+/**
+ * Set to `true` for all Mongoose map instances
+ *
+ * @api public
+ * @property $isMongooseMap
+ * @memberOf Map
+ * @instance
+ */
+
 Object.defineProperty(MongooseMap.prototype, '$isMongooseMap', {
   enumerable: false,
   writable: false,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "6.4.2",
+  "version": "6.4.3",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -28,9 +28,9 @@
     "sift": "16.0.0"
   },
   "devDependencies": {
-    "@babel/core": "7.18.2",
-    "@typescript-eslint/eslint-plugin": "5.27.0",
-    "@typescript-eslint/parser": "5.27.0",
+    "@babel/core": "7.18.6",
+    "@typescript-eslint/eslint-plugin": "5.30.3",
+    "@typescript-eslint/parser": "5.30.3",
     "acquit": "1.2.1",
     "acquit-ignore": "0.2.0",
     "acquit-require": "0.1.1",
@@ -40,19 +40,19 @@
     "benchmark": "2.1.4",
     "bluebird": "3.7.2",
     "buffer": "^5.6.0",
-    "cheerio": "1.0.0-rc.11",
+    "cheerio": "1.0.0-rc.12",
     "crypto-browserify": "3.12.0",
     "dox": "0.3.1",
-    "eslint": "8.16.0",
+    "eslint": "8.19.0",
     "eslint-plugin-mocha-no-only": "1.1.1",
     "highlight.js": "11.5.1",
     "lodash.isequal": "4.5.0",
     "lodash.isequalwith": "4.4.0",
-    "marked": "4.0.16",
+    "marked": "4.0.17",
     "mkdirp": "^1.0.4",
     "mocha": "10.0.0",
     "moment": "2.x",
-    "mongodb-memory-server": "8.6.0",
+    "mongodb-memory-server": "8.7.2",
     "ncp": "^2.0.0",
     "nyc": "15.1.0",
     "pug": "3.0.2",
@@ -61,10 +61,10 @@
     "sinon": "14.0.0",
     "stream-browserify": "3.0.0",
     "ts-benchmark": "^1.0.2",
-    "tsd": "0.20.0",
-    "typescript": "4.7.2",
+    "tsd": "0.22.0",
+    "typescript": "4.7.4",
     "uuid": "8.3.2",
-    "webpack": "5.72.1"
+    "webpack": "5.73.0"
   },
   "directories": {
     "lib": "./lib/mongoose"

package/types/expressions.d.ts

@@ -32,7 +32,7 @@ declare module 'mongoose' {
        *
        * @see https://docs.mongodb.com/manual/reference/operator/aggregation/add/#mongodb-expression-exp.-add
        */
-      $add: (NumberExpression | DateExpression)[];
+      $add: Expression[];
     }
 
     export interface Ceil {
@@ -1043,7 +1043,7 @@ declare module 'mongoose' {
        *
        * @see https://docs.mongodb.com/manual/reference/operator/aggregation/cond/#mongodb-expression-exp.-cond
        */
-      $cond: { if: BooleanExpression, then: AnyExpression, else: AnyExpression } | [BooleanExpression, AnyExpression, AnyExpression];
+      $cond: { if: Expression, then: AnyExpression, else: AnyExpression } | [BooleanExpression, AnyExpression, AnyExpression];
     }
 
     export interface IfNull {
@@ -1957,7 +1957,7 @@ declare module 'mongoose' {
        * @version 5.0
        * @see https://docs.mongodb.com/manual/reference/operator/aggregation/addToSet/#mongodb-expression-exp.-addToSet
        */
-      $addToSet: ArrayExpression;
+      $addToSet: Expression | Record<string, Expression>;
     }
 
     export interface Avg {
@@ -1967,7 +1967,7 @@ declare module 'mongoose' {
        * @version 5.0
        * @see https://docs.mongodb.com/manual/reference/operator/aggregation/avg/#mongodb-expression-exp.-avg
        */
-      $avg: ArrayExpression;
+      $avg: Expression;
     }
 
     export interface Count {
@@ -2316,6 +2316,21 @@ declare module 'mongoose' {
       $toObjectId: Expression;
     }
 
+    export interface Top {
+      $top: {
+        sortBy: AnyObject,
+        output: Expression
+      };
+    }
+
+    export interface TopN {
+      $topN: {
+        n: Expression,
+        sortBy: AnyObject,
+        output: Expression
+      };
+    }
+
     export interface ToString {
       /**
        * Converts a value to a string. If the value cannot be converted to a string, $toString errors. If the value is
@@ -2406,7 +2421,10 @@ declare module 'mongoose' {
     TypeExpressionOperator |
     AccumulatorOperator |
     VariableExpressionOperator |
-    WindowOperator;
+    WindowOperator |
+    Expression.Top |
+    Expression.TopN |
+    any;
 
   export type NullExpression = null;
 
@@ -2478,7 +2496,8 @@ declare module 'mongoose' {
     DataSizeOperatorReturningNumber |
     CustomAggregationExpressionOperatorReturningAny |
     TypeExpressionOperatorReturningNumber |
-    DateExpression;
+    DateExpression |
+    DateExpressionOperatorReturningNumber;
 
   export type ObjectExpression =
     Path |

package/types/index.d.ts

@@ -227,6 +227,7 @@ declare module 'mongoose' {
     obj: SchemaDefinition<SchemaDefinitionType<EnforcedDocType>>;
 
     /** Gets/sets schema paths. */
+    path<pathGeneric extends keyof EnforcedDocType>(path: pathGeneric): SchemaType<EnforcedDocType[pathGeneric]>;
     path<ResultType extends SchemaType = SchemaType>(path: string): ResultType;
     path(path: string, constructor: any): this;
 

package/types/pipelinestage.d.ts

@@ -212,7 +212,7 @@ declare module 'mongoose' {
 
     export interface Set {
       /** [`$set` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/set/) */
-      $set: Record<string, AnyExpression>
+      $set: Record<string, AnyExpression | any>
     }
 
     export interface SetWindowFields {