mongoose 6.4.0 → 6.4.3

package/lib/options/SchemaArrayOptions.js

@@ -56,4 +56,4 @@ Object.defineProperty(SchemaArrayOptions.prototype, 'of', opts);
  * ignore
  */
 
-module.exports = SchemaArrayOptions;
+module.exports = SchemaArrayOptions;

package/lib/options/SchemaBufferOptions.js

@@ -35,4 +35,4 @@ Object.defineProperty(SchemaBufferOptions.prototype, 'subtype', opts);
  * ignore
  */
 
-module.exports = SchemaBufferOptions;
+module.exports = SchemaBufferOptions;

package/lib/options/SchemaDocumentArrayOptions.js

@@ -65,4 +65,4 @@ Object.defineProperty(SchemaDocumentArrayOptions.prototype, '_id', opts);
  * ignore
  */
 
-module.exports = SchemaDocumentArrayOptions;
+module.exports = SchemaDocumentArrayOptions;

package/lib/options/SchemaMapOptions.js

@@ -40,4 +40,4 @@ const opts = require('./propertyOptions');
 
 Object.defineProperty(SchemaMapOptions.prototype, 'of', opts);
 
-module.exports = SchemaMapOptions;
+module.exports = SchemaMapOptions;

package/lib/options/SchemaNumberOptions.js

@@ -96,4 +96,4 @@ Object.defineProperty(SchemaNumberOptions.prototype, 'populate', opts);
  * ignore
  */
 
-module.exports = SchemaNumberOptions;
+module.exports = SchemaNumberOptions;

package/lib/options/SchemaObjectIdOptions.js

@@ -60,4 +60,4 @@ Object.defineProperty(SchemaObjectIdOptions.prototype, 'populate', opts);
  * ignore
  */
 
-module.exports = SchemaObjectIdOptions;
+module.exports = SchemaObjectIdOptions;

package/lib/options/SchemaSubdocumentOptions.js

@@ -39,4 +39,4 @@ const opts = require('./propertyOptions');
 
 Object.defineProperty(SchemaSubdocumentOptions.prototype, '_id', opts);
 
-module.exports = SchemaSubdocumentOptions;
+module.exports = SchemaSubdocumentOptions;

package/lib/options/SchemaTypeOptions.js

@@ -241,4 +241,4 @@ Object.defineProperty(SchemaTypeOptions.prototype, 'text', opts);
 
 Object.defineProperty(SchemaTypeOptions.prototype, 'transform', opts);
 
-module.exports = SchemaTypeOptions;
+module.exports = SchemaTypeOptions;

package/lib/options/VirtualOptions.js

@@ -161,4 +161,4 @@ Object.defineProperty(VirtualOptions.prototype, 'limit', opts);
 
 Object.defineProperty(VirtualOptions.prototype, 'perDocumentLimit', opts);
 
-module.exports = VirtualOptions;
+module.exports = VirtualOptions;

package/lib/options/propertyOptions.js

@@ -5,4 +5,4 @@ module.exports = Object.freeze({
   configurable: true,
   writable: true,
   value: void 0
-});
+});

package/lib/options/removeOptions.js

@@ -11,4 +11,4 @@ class RemoveOptions {
   }
 }
 
-module.exports = RemoveOptions;
+module.exports = RemoveOptions;

package/lib/options/saveOptions.js

@@ -11,4 +11,4 @@ class SaveOptions {
   }
 }
 
-module.exports = SaveOptions;
+module.exports = SaveOptions;

package/lib/plugins/trackTransaction.js

@@ -89,4 +89,4 @@ function mergeAtomics(destination, source) {
   }
 
   return destination;
-}
+}

package/lib/queryhelpers.js

@@ -209,6 +209,11 @@ exports.applyPaths = function applyPaths(fields, schema) {
       // user didn't specify fields, implies returning all fields.
       // only need to apply excluded fields and delete any plus paths
       for (const fieldName of excluded) {
+        if (fields[fieldName] != null) {
+          // Skip applying default projections to fields with non-defining
+          // projections, like `$slice`
+          continue;
+        }
         fields[fieldName] = 0;
       }
       break;

package/lib/schema/array.js

@@ -212,7 +212,7 @@ SchemaArray.checkRequired = SchemaType.checkRequired;
  */
 
 SchemaArray.prototype.checkRequired = function checkRequired(value, doc) {
-  if (SchemaType._isRef(this, value, doc, true)) {
+  if (typeof value === 'object' && SchemaType._isRef(this, value, doc, true)) {
     return !!value;
   }
 

package/lib/schema/date.js

@@ -195,8 +195,8 @@ SchemaDate.checkRequired = SchemaType.checkRequired;
  */
 
 SchemaDate.prototype.checkRequired = function(value, doc) {
-  if (SchemaType._isRef(this, value, doc, true)) {
-    return !!value;
+  if (typeof value === 'object' && SchemaType._isRef(this, value, doc, true)) {
+    return value != null;
   }
 
   // `require('util').inherits()` does **not** copy static properties, and

package/lib/schema/number.js

@@ -164,8 +164,8 @@ SchemaNumber.checkRequired = SchemaType.checkRequired;
  */
 
 SchemaNumber.prototype.checkRequired = function checkRequired(value, doc) {
-  if (SchemaType._isRef(this, value, doc, true)) {
-    return !!value;
+  if (typeof value === 'object' && SchemaType._isRef(this, value, doc, true)) {
+    return value != null;
   }
 
   // `require('util').inherits()` does **not** copy static properties, and

package/lib/schema/string.js

@@ -561,8 +561,8 @@ SchemaString.prototype.match = function match(regExp, message) {
  */
 
 SchemaString.prototype.checkRequired = function checkRequired(value, doc) {
-  if (SchemaType._isRef(this, value, doc, true)) {
-    return !!value;
+  if (typeof value === 'object' && SchemaType._isRef(this, value, doc, true)) {
+    return value != null;
   }
 
   // `require('util').inherits()` does **not** copy static properties, and

package/lib/schema/symbols.js

@@ -2,4 +2,4 @@
 
 exports.schemaMixedSymbol = Symbol.for('mongoose:schema_mixed');
 
-exports.builtInMiddleware = Symbol.for('mongoose:built-in-middleware');
+exports.builtInMiddleware = Symbol.for('mongoose:built-in-middleware');

package/lib/schema.js

@@ -477,7 +477,7 @@ Schema.prototype.defaultOptions = function(options) {
  * Inherit a Schema by applying a discriminator on an existing Schema.
  *
  *
- * ####Example:
+ * #### Example:
  *
  *     const options = { discriminatorKey: 'kind' };
  *
@@ -648,7 +648,7 @@ Schema.prototype.add = function add(obj, prefix) {
  * removeIndex only removes indexes from your schema object. Does **not** affect the indexes
  * in MongoDB.
  *
- * ####Example:
+ * #### Example:
  *
  *     const ToySchema = new Schema({ name: String, color: String, price: Number });
  *
@@ -701,7 +701,7 @@ Schema.prototype.removeIndex = function removeIndex(index) {
  * clearIndexes only removes indexes from your schema object. Does **not** affect the indexes
  * in MongoDB.
  *
- * ####Example:
+ * #### Example:
  *
  *     const ToySchema = new Schema({ name: String, color: String, price: Number });
  *     ToySchema.index({ name: 1 });

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/DocumentArray/methods/index.js

@@ -376,4 +376,4 @@ function _updateParentPopulated(arr) {
 
     parent.$__.populated[path].value = arr.map(val => val.$populated(remnant));
   }
-}
+}

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.0",
+  "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/collection.d.ts

@@ -43,4 +43,4 @@ declare module 'mongoose' {
     getIndexes(): ReturnType<mongodb.Collection<T>['indexInformation']>;
   }
   let Collection: Collection;
-}
+}

package/types/document.d.ts

@@ -4,6 +4,12 @@ declare module 'mongoose' {
   /** A list of paths to skip. If set, Mongoose will validate every modified path that is not in this list. */
   type pathsToSkip = string[] | string;
 
+  interface DocumentSetOptions {
+    merge?: boolean;
+
+    [key: string]: any;
+  }
+
   /**
    * Generic types for Document:
    * *  T - the type of _id
@@ -74,8 +80,8 @@ declare module 'mongoose' {
     $session(session?: ClientSession | null): ClientSession | null;
 
     /** Alias for `set()`, used internally to avoid conflicts */
-    $set(path: string, val: any, type: any, options?: any): this;
-    $set(path: string, val: any, options?: any): this;
+    $set(path: string, val: any, type: any, options?: DocumentSetOptions): this;
+    $set(path: string, val: any, options?: DocumentSetOptions): this;
     $set(value: any): this;
 
     /** Set this property to add additional query filters when Mongoose saves this document and `isNew` is false. */
@@ -194,10 +200,10 @@ declare module 'mongoose' {
     $parent(): Document | undefined;
 
     /** Populates document references. */
-    populate<Paths = {}>(path: string | PopulateOptions | (string | PopulateOptions)[]): Promise<this & Paths>;
-    populate<Paths = {}>(path: string | PopulateOptions | (string | PopulateOptions)[], callback: Callback<this & Paths>): void;
-    populate<Paths = {}>(path: string, select?: string | AnyObject, model?: Model<any>, match?: AnyObject, options?: PopulateOptions): Promise<this & Paths>;
-    populate<Paths = {}>(path: string, select?: string | AnyObject, model?: Model<any>, match?: AnyObject, options?: PopulateOptions, callback?: Callback<this & Paths>): void;
+    populate<Paths = {}>(path: string | PopulateOptions | (string | PopulateOptions)[]): Promise<MergeType<this, Paths>>;
+    populate<Paths = {}>(path: string | PopulateOptions | (string | PopulateOptions)[], callback: Callback<MergeType<this, Paths>>): void;
+    populate<Paths = {}>(path: string, select?: string | AnyObject, model?: Model<any>, match?: AnyObject, options?: PopulateOptions): Promise<MergeType<this, Paths>>;
+    populate<Paths = {}>(path: string, select?: string | AnyObject, model?: Model<any>, match?: AnyObject, options?: PopulateOptions, callback?: Callback<MergeType<this, Paths>>): void;
 
     /** Gets _id(s) used during population of the given `path`. If the path was not populated, returns `undefined`. */
     populated(path: string): any;