mongoose 6.2.7 → 6.2.10

package/lib/schema/SubdocumentPath.js

@@ -26,7 +26,7 @@ module.exports = SubdocumentPath;
  * Single nested subdocument SchemaType constructor.
  *
  * @param {Schema} schema
- * @param {String} key
+ * @param {String} path
  * @param {Object} options
  * @inherits SchemaType
  * @api public
@@ -243,6 +243,9 @@ SubdocumentPath.prototype.doValidate = function(value, fn, scope, options) {
   }
 
   if (options && options.skipSchemaValidators) {
+    if (!value) {
+      return fn(null);
+    }
     return value.validate(fn);
   }
 
@@ -280,7 +283,7 @@ SubdocumentPath.prototype.doValidateSync = function(value, scope, options) {
 /**
  * Adds a discriminator to this single nested subdocument.
  *
- * ####Example:
+ * #### Example:
  *     const shapeSchema = Schema({ name: String }, { discriminatorKey: 'kind' });
  *     const schema = Schema({ shape: shapeSchema });
  *
@@ -318,7 +321,7 @@ SubdocumentPath.prototype.discriminator = function(name, schema, options) {
 /**
  * Sets a default option for all SubdocumentPath instances.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make all numbers have option `min` equal to 0.
  *     mongoose.Schema.Embedded.set('required', true);

package/lib/schema/array.js

@@ -32,6 +32,7 @@ const emptyOpts = Object.freeze({});
  * @param {String} key
  * @param {SchemaType} cast
  * @param {Object} options
+ * @param {Object} schemaOptions
  * @inherits SchemaType
  * @api public
  */
@@ -152,7 +153,7 @@ SchemaArray.defaultOptions = {};
 /**
  * Sets a default option for all Array instances.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make all Array instances have `required` of true by default.
  *     mongoose.Schema.Array.set('required', true);
@@ -185,7 +186,7 @@ SchemaArray._checkRequired = SchemaType.prototype.checkRequired;
  * Override the function the required validator uses to check whether an array
  * passes the `required` check.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Require non-empty array to pass `required` check
  *     mongoose.Schema.Types.Array.checkRequired(v => Array.isArray(v) && v.length);

package/lib/schema/boolean.js

@@ -47,7 +47,7 @@ SchemaBoolean._cast = castBoolean;
 /**
  * Sets a default option for all Boolean instances.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make all booleans have `default` of false.
  *     mongoose.Schema.Boolean.set('default', false);
@@ -68,7 +68,7 @@ SchemaBoolean.set = SchemaType.set;
 /**
  * Get/set the function used to cast arbitrary values to booleans.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make Mongoose cast empty string '' to false.
  *     const original = mongoose.Schema.Boolean.cast();
@@ -148,7 +148,7 @@ SchemaBoolean.prototype.checkRequired = function(value) {
 /**
  * Configure which values get casted to `true`.
  *
- * ####Example:
+ * #### Example:
  *
  *     const M = mongoose.model('Test', new Schema({ b: Boolean }));
  *     new M({ b: 'affirmative' }).b; // undefined
@@ -168,7 +168,7 @@ Object.defineProperty(SchemaBoolean, 'convertToTrue', {
 /**
  * Configure which values get casted to `false`.
  *
- * ####Example:
+ * #### Example:
  *
  *     const M = mongoose.model('Test', new Schema({ b: Boolean }));
  *     new M({ b: 'nay' }).b; // undefined

package/lib/schema/buffer.js

@@ -52,7 +52,7 @@ SchemaBuffer._checkRequired = v => !!(v && v.length);
 /**
  * Sets a default option for all Buffer instances.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make all buffers have `required` of true by default.
  *     mongoose.Schema.Buffer.set('required', true);
@@ -74,7 +74,7 @@ SchemaBuffer.set = SchemaType.set;
  * Override the function the required validator uses to check whether a string
  * passes the `required` check.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Allow empty strings to pass `required` check
  *     mongoose.Schema.Types.String.checkRequired(v => v != null);
@@ -204,7 +204,7 @@ SchemaBuffer.prototype.cast = function(value, doc, init) {
  * Sets the default [subtype](https://studio3t.com/whats-new/best-practices-uuid-mongodb/)
  * for this buffer. You can find a [list of allowed subtypes here](https://api.mongodb.com/python/current/api/bson/binary.html).
  *
- * ####Example:
+ * #### Example:
  *
  *     const s = new Schema({ uuid: { type: Buffer, subtype: 4 });
  *     const M = db.model('M', s);

package/lib/schema/date.js

@@ -52,7 +52,7 @@ SchemaDate._cast = castDate;
 /**
  * Sets a default option for all Date instances.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make all dates have `required` of true by default.
  *     mongoose.Schema.Date.set('required', true);
@@ -73,7 +73,7 @@ SchemaDate.set = SchemaType.set;
 /**
  * Get/set the function used to cast arbitrary values to dates.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Mongoose converts empty string '' into `null` for date types. You
  *     // can create a custom caster to disable it.
@@ -122,14 +122,14 @@ SchemaDate._defaultCaster = v => {
  * This sets the `expireAfterSeconds` index option available in MongoDB >= 2.1.2.
  * This index type is only compatible with Date types.
  *
- * ####Example:
+ * #### Example:
  *
  *     // expire in 24 hours
  *     new Schema({ createdAt: { type: Date, expires: 60*60*24 }});
  *
  * `expires` utilizes the `ms` module from [guille](https://github.com/guille/) allowing us to use a friendlier syntax:
  *
- * ####Example:
+ * #### Example:
  *
  *     // expire in 24 hours
  *     new Schema({ createdAt: { type: Date, expires: '24h' }});
@@ -167,7 +167,7 @@ SchemaDate._checkRequired = v => v instanceof Date;
  * Override the function the required validator uses to check whether a string
  * passes the `required` check.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Allow empty strings to pass `required` check
  *     mongoose.Schema.Types.String.checkRequired(v => v != null);
@@ -210,7 +210,7 @@ SchemaDate.prototype.checkRequired = function(value, doc) {
 /**
  * Sets a minimum date validator.
  *
- * ####Example:
+ * #### Example:
  *
  *     const s = new Schema({ d: { type: Date, min: Date('1970-01-01') })
  *     const M = db.model('M', s)
@@ -272,7 +272,7 @@ SchemaDate.prototype.min = function(value, message) {
 /**
  * Sets a maximum date validator.
  *
- * ####Example:
+ * #### Example:
  *
  *     const s = new Schema({ d: { type: Date, max: Date('2014-01-01') })
  *     const M = db.model('M', s)

package/lib/schema/decimal128.js

@@ -48,7 +48,7 @@ Decimal128._cast = castDecimal128;
 /**
  * Sets a default option for all Decimal128 instances.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make all decimal 128s have `required` of true by default.
  *     mongoose.Schema.Decimal128.set('required', true);
@@ -69,7 +69,7 @@ Decimal128.set = SchemaType.set;
 /**
  * Get/set the function used to cast arbitrary values to decimals.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make Mongoose only refuse to cast numbers as decimal128
  *     const original = mongoose.Schema.Types.Decimal128.cast();

package/lib/schema/documentarray.js

@@ -12,6 +12,7 @@ const SchemaDocumentArrayOptions =
 const SchemaType = require('../schematype');
 const discriminator = require('../helpers/model/discriminator');
 const handleIdOption = require('../helpers/schema/handleIdOption');
+const handleSpreadDoc = require('../helpers/document/handleSpreadDoc');
 const util = require('util');
 const utils = require('../utils');
 const getConstructor = require('../helpers/discriminator/getConstructor');
@@ -29,6 +30,7 @@ let Subdocument;
  * @param {String} key
  * @param {Schema} schema
  * @param {Object} options
+ * @param {Object} schemaOptions
  * @inherits SchemaArray
  * @api public
  */
@@ -150,7 +152,7 @@ function _createConstructor(schema, options, baseClass) {
 /**
  * Adds a discriminator to this document array.
  *
- * ####Example:
+ * #### Example:
  *     const shapeSchema = Schema({ name: String }, { discriminatorKey: 'kind' });
  *     const schema = Schema({ shapes: [shapeSchema] });
  *
@@ -272,7 +274,7 @@ DocumentArrayPath.prototype.doValidate = function(array, fn, scope, options) {
 /**
  * Performs local validations first, then validations on each embedded doc.
  *
- * ####Note:
+ * #### Note:
  *
  * This method ignores the asynchronous validators.
  *
@@ -427,13 +429,18 @@ DocumentArrayPath.prototype.cast = function(value, doc, init, prev, options) {
     const Constructor = getConstructor(this.casterConstructor, rawArray[i]);
 
     // Check if the document has a different schema (re gh-3701)
-    if (rawArray[i].$__ && !(rawArray[i] instanceof Constructor)) {
-      rawArray[i] = rawArray[i].toObject({
-        transform: false,
-        // Special case: if different model, but same schema, apply virtuals
-        // re: gh-7898
-        virtuals: rawArray[i].schema === Constructor.schema
-      });
+    if (rawArray[i].$__ != null && !(rawArray[i] instanceof Constructor)) {
+      const spreadDoc = handleSpreadDoc(rawArray[i], true);
+      if (rawArray[i] !== spreadDoc) {
+        rawArray[i] = spreadDoc;
+      } else {
+        rawArray[i] = rawArray[i].toObject({
+          transform: false,
+          // Special case: if different model, but same schema, apply virtuals
+          // re: gh-7898
+          virtuals: rawArray[i].schema === Constructor.schema
+        });
+      }
     }
 
     if (rawArray[i] instanceof Subdocument) {
@@ -558,7 +565,7 @@ function scopePaths(array, fields, init) {
 /**
  * Sets a default option for all DocumentArray instances.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make all numbers have option `min` equal to 0.
  *     mongoose.Schema.DocumentArray.set('_id', false);

package/lib/schema/mixed.js

@@ -56,7 +56,7 @@ Mixed.prototype.constructor = Mixed;
 /**
  * Attaches a getter for all Mixed paths.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Hide the 'hidden' path
  *     mongoose.Schema.Mixed.get(v => Object.assign({}, v, { hidden: null }));
@@ -76,7 +76,7 @@ Mixed.get = SchemaType.get;
 /**
  * Sets a default option for all Mixed instances.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make all mixed instances have `required` of true by default.
  *     mongoose.Schema.Mixed.set('required', true);

package/lib/schema/number.js

@@ -29,7 +29,7 @@ function SchemaNumber(key, options) {
 /**
  * Attaches a getter for all Number instances.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make all numbers round down
  *     mongoose.Number.get(function(v) { return Math.floor(v); });
@@ -49,7 +49,7 @@ SchemaNumber.get = SchemaType.get;
 /**
  * Sets a default option for all Number instances.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make all numbers have option `min` equal to 0.
  *     mongoose.Schema.Number.set('min', 0);
@@ -76,7 +76,7 @@ SchemaNumber._cast = castNumber;
 /**
  * Get/set the function used to cast arbitrary values to numbers.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make Mongoose cast empty strings '' to 0 for paths declared as numbers
  *     const original = mongoose.Number.cast();
@@ -180,7 +180,7 @@ SchemaNumber.prototype.checkRequired = function checkRequired(value, doc) {
 /**
  * Sets a minimum number validator.
  *
- * ####Example:
+ * #### Example:
  *
  *     const s = new Schema({ n: { type: Number, min: 10 })
  *     const M = db.model('M', s)
@@ -234,7 +234,7 @@ SchemaNumber.prototype.min = function(value, message) {
 /**
  * Sets a maximum number validator.
  *
- * ####Example:
+ * #### Example:
  *
  *     const s = new Schema({ n: { type: Number, max: 10 })
  *     const M = db.model('M', s)
@@ -288,7 +288,7 @@ SchemaNumber.prototype.max = function(value, message) {
 /**
  * Sets a enum validator
  *
- * ####Example:
+ * #### Example:
  *
  *     const s = new Schema({ n: { type: Number, enum: [1, 2, 3] });
  *     const M = db.model('M', s);

package/lib/schema/objectid.js

@@ -55,7 +55,7 @@ ObjectId.prototype.OptionsConstructor = SchemaObjectIdOptions;
 /**
  * Attaches a getter for all ObjectId instances
  *
- * ####Example:
+ * #### Example:
  *
  *     // Always convert to string when getting an ObjectId
  *     mongoose.ObjectId.get(v => v.toString());
@@ -75,7 +75,7 @@ ObjectId.get = SchemaType.get;
 /**
  * Sets a default option for all ObjectId instances.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make all object ids have option `required` equal to true.
  *     mongoose.Schema.ObjectId.set('required', true);
@@ -124,7 +124,7 @@ ObjectId._cast = castObjectId;
 /**
  * Get/set the function used to cast arbitrary values to objectids.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make Mongoose only try to cast length 24 strings. By default, any 12
  *     // char string is a valid ObjectId.
@@ -171,7 +171,7 @@ ObjectId._defaultCaster = v => {
  * Override the function the required validator uses to check whether a string
  * passes the `required` check.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Allow empty strings to pass `required` check
  *     mongoose.Schema.Types.String.checkRequired(v => v != null);

package/lib/schema/string.js

@@ -58,7 +58,7 @@ SchemaString._cast = castString;
 /**
  * Get/set the function used to cast arbitrary values to strings.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Throw an error if you pass in an object. Normally, Mongoose allows
  *     // objects with custom `toString()` functions.
@@ -104,7 +104,7 @@ SchemaString._defaultCaster = v => {
 /**
  * Attaches a getter for all String instances.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make all numbers round down
  *     mongoose.Schema.String.get(v => v.toLowerCase());
@@ -124,7 +124,7 @@ SchemaString.get = SchemaType.get;
 /**
  * Sets a default option for all String instances.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make all strings have option `trim` equal to true.
  *     mongoose.Schema.String.set('trim', true);
@@ -152,7 +152,7 @@ SchemaString._checkRequired = v => (v instanceof String || typeof v === 'string'
  * Override the function the required validator uses to check whether a string
  * passes the `required` check.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Allow empty strings to pass `required` check
  *     mongoose.Schema.Types.String.checkRequired(v => v != null);
@@ -172,7 +172,7 @@ SchemaString.checkRequired = SchemaType.checkRequired;
 /**
  * Adds an enum validator
  *
- * ####Example:
+ * #### Example:
  *
  *     const states = ['opening', 'open', 'closing', 'closed']
  *     const s = new Schema({ state: { type: String, enum: states }})
@@ -255,7 +255,7 @@ SchemaString.prototype.enum = function() {
 /**
  * Adds a lowercase [setter](https://mongoosejs.com/docs/api.html#schematype_SchemaType-set).
  *
- * ####Example:
+ * #### Example:
  *
  *     const s = new Schema({ email: { type: String, lowercase: true }})
  *     const M = db.model('M', s);
@@ -265,7 +265,7 @@ SchemaString.prototype.enum = function() {
  *
  * Note that `lowercase` does **not** affect regular expression queries:
  *
- * ####Example:
+ * #### Example:
  *     // Still queries for documents whose `email` matches the regular
  *     // expression /SomeEmail/. Mongoose does **not** convert the RegExp
  *     // to lowercase.
@@ -293,7 +293,7 @@ SchemaString.prototype.lowercase = function(shouldApply) {
 /**
  * Adds an uppercase [setter](https://mongoosejs.com/docs/api.html#schematype_SchemaType-set).
  *
- * ####Example:
+ * #### Example:
  *
  *     const s = new Schema({ caps: { type: String, uppercase: true }})
  *     const M = db.model('M', s);
@@ -303,7 +303,7 @@ SchemaString.prototype.lowercase = function(shouldApply) {
  *
  * Note that `uppercase` does **not** affect regular expression queries:
  *
- * ####Example:
+ * #### Example:
  *     // Mongoose does **not** convert the RegExp to uppercase.
  *     M.find({ email: /an example/ });
  *
@@ -331,7 +331,7 @@ SchemaString.prototype.uppercase = function(shouldApply) {
  *
  * The string value will be [trimmed](https://masteringjs.io/tutorials/fundamentals/trim-string) when set.
  *
- * ####Example:
+ * #### Example:
  *
  *     const s = new Schema({ name: { type: String, trim: true }});
  *     const M = db.model('M', s);
@@ -345,7 +345,7 @@ SchemaString.prototype.uppercase = function(shouldApply) {
  *
  * Note that `trim` does **not** affect regular expression queries:
  *
- * ####Example:
+ * #### Example:
  *     // Mongoose does **not** trim whitespace from the RegExp.
  *     M.find({ name: / some name / });
  *
@@ -371,7 +371,7 @@ SchemaString.prototype.trim = function(shouldTrim) {
 /**
  * Sets a minimum length validator.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({ postalCode: { type: String, minlength: 5 })
  *     const Address = db.model('Address', schema)
@@ -427,7 +427,7 @@ SchemaString.prototype.minLength = SchemaString.prototype.minlength;
 /**
  * Sets a maximum length validator.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({ postalCode: { type: String, maxlength: 9 })
  *     const Address = db.model('Address', schema)
@@ -485,7 +485,7 @@ SchemaString.prototype.maxLength = SchemaString.prototype.maxlength;
  *
  * Any value that does not pass `regExp`.test(val) will fail validation.
  *
- * ####Example:
+ * #### Example:
  *
  *     const s = new Schema({ name: { type: String, match: /^a/ }})
  *     const M = db.model('M', s)