mongoose 9.1.2 → 9.1.3

package/lib/helpers/timestamps/setupTimestamps.js

@@ -51,15 +51,24 @@ module.exports = function setupTimestamps(schema, timestamps) {
     setDocumentTimestamps(this, timestampOption, currentTime, createdAt, updatedAt);
   });
 
-  schema.methods.initializeTimestamps = function() {
+  schema.methods.initializeTimestamps = function(timestampsOptions) {
+    if (timestampsOptions === false) {
+      return this;
+    }
     const ts = currentTime != null ?
       currentTime() : this.constructor.base.now();
 
+    const initTimestampsCreatedAt = timestampsOptions != null ?
+      handleTimestampOption(timestampsOptions, 'createdAt') :
+      createdAt;
+    const initTimestampsUpdatedAt = timestampsOptions != null ?
+      handleTimestampOption(timestampsOptions, 'updatedAt') :
+      updatedAt;
 
-    if (createdAt && !this.get(createdAt)) {
+    if (initTimestampsCreatedAt && !this.get(initTimestampsCreatedAt)) {
       this.$set(createdAt, ts);
     }
-    if (updatedAt && !this.get(updatedAt)) {
+    if (initTimestampsUpdatedAt && !this.get(initTimestampsUpdatedAt)) {
       this.$set(updatedAt, ts);
     }
     if (this.$isSubdocument) {
@@ -69,7 +78,7 @@ module.exports = function setupTimestamps(schema, timestamps) {
     const subdocs = this.$getAllSubdocs();
     for (const subdoc of subdocs) {
       if (subdoc.initializeTimestamps) {
-        subdoc.initializeTimestamps();
+        subdoc.initializeTimestamps(timestampsOptions);
       }
     }
 

package/lib/model.js

@@ -3029,9 +3029,9 @@ Model.insertMany = async function insertMany(arr, options) {
     if (doc.$__schema.options.versionKey) {
       doc[doc.$__schema.options.versionKey] = 0;
     }
-    const shouldSetTimestamps = (!options || options.timestamps !== false) && doc.initializeTimestamps && (!doc.$__ || doc.$__.timestamps !== false);
+    const shouldSetTimestamps = options?.timestamps !== false && doc.initializeTimestamps && (!doc.$__ || doc.$__.timestamps !== false);
     if (shouldSetTimestamps) {
-      doc.initializeTimestamps();
+      doc.initializeTimestamps(options?.timestamps);
     }
     if (doc.$__hasOnlyPrimitiveValues()) {
       return doc.$__toObjectShallow();

package/lib/query.js

@@ -4025,7 +4025,7 @@ Query.prototype._mergeUpdate = function(update) {
 
   if (update instanceof Query) {
     if (Array.isArray(this._update)) {
-      throw new MongooseError('Cannot mix array and object updates');
+      throw new MongooseError(`Cannot mix array and object updates (current: ${_previewUpdate(this._update)}, incoming: ${_previewUpdate(update._update)})`);
     }
     if (update._update) {
       utils.mergeClone(this._update, update._update);
@@ -4037,18 +4037,33 @@ Query.prototype._mergeUpdate = function(update) {
       if (this._update == null || utils.isEmptyObject(this._update)) {
         this._update = [];
       } else {
-        throw new MongooseError('Cannot mix array and object updates');
+        throw new MongooseError(`Cannot mix array and object updates (current: ${_previewUpdate(this._update)}, incoming: ${_previewUpdate(update)})`);
       }
     }
     this._update = this._update.concat(update);
   } else {
     if (Array.isArray(this._update)) {
-      throw new MongooseError('Cannot mix array and object updates');
+      throw new MongooseError(`Cannot mix array and object updates (current: ${_previewUpdate(this._update)}, incoming: ${_previewUpdate(update)})`);
     }
     utils.mergeClone(this._update, update);
   }
 };
 
+function _previewUpdate(update) {
+  const preview = util.inspect(update, {
+    depth: 2,
+    maxArrayLength: 5,
+    breakLength: 80,
+    compact: true
+  });
+
+  if (preview.length > 200) {
+    return `${preview.slice(0, 197)}...`;
+  }
+
+  return preview;
+}
+
 /*!
  * ignore
  */

package/lib/schema/array.js

@@ -155,7 +155,7 @@ SchemaArray.defaultOptions = {};
  * #### Example:
  *
  *     // Make all Array instances have `required` of true by default.
- *     mongoose.Schema.Array.set('required', true);
+ *     mongoose.Schema.Types.Array.set('required', true);
  *
  *     const User = mongoose.model('User', new Schema({ test: Array }));
  *     new User({ }).validateSync().errors.test.message; // Path `test` is required.

package/lib/schema/bigint.js

@@ -52,7 +52,7 @@ SchemaBigInt._cast = castBigInt;
  * #### Example:
  *
  *     // Make all bigints required by default
- *     mongoose.Schema.BigInt.set('required', true);
+ *     mongoose.Schema.Types.BigInt.set('required', true);
  *
  * @param {String} option The option you'd like to set the value for
  * @param {Any} value value for option
@@ -72,7 +72,7 @@ SchemaBigInt.setters = [];
  * #### Example:
  *
  *     // Convert bigints to numbers
- *     mongoose.Schema.BigInt.get(v => v == null ? v : Number(v));
+ *     mongoose.Schema.Types.BigInt.get(v => v == null ? v : Number(v));
  *
  * @param {Function} getter
  * @return {this}
@@ -90,7 +90,7 @@ SchemaBigInt.get = SchemaType.get;
  *
  *     // Make Mongoose cast empty string '' to false.
  *     const original = mongoose.Schema.Types.BigInt.cast();
- *     mongoose.Schema.BigInt.cast(v => {
+ *     mongoose.Schema.Types.BigInt.cast(v => {
  *       if (v === '') {
  *         return false;
  *       }
@@ -98,7 +98,7 @@ SchemaBigInt.get = SchemaType.get;
  *     });
  *
  *     // Or disable casting entirely
- *     mongoose.Schema.BigInt.cast(false);
+ *     mongoose.Schema.Types.BigInt.cast(false);
  *
  * @param {Function} caster
  * @return {Function}

package/lib/schema/boolean.js

@@ -52,7 +52,7 @@ SchemaBoolean._cast = castBoolean;
  * #### Example:
  *
  *     // Make all booleans have `default` of false.
- *     mongoose.Schema.Boolean.set('default', false);
+ *     mongoose.Schema.Types.Boolean.set('default', false);
  *
  *     const Order = mongoose.model('Order', new Schema({ isPaid: Boolean }));
  *     new Order({ }).isPaid; // false
@@ -74,7 +74,7 @@ SchemaBoolean.setters = [];
  *
  * #### Example:
  *
- *     mongoose.Schema.Boolean.get(v => v === true ? 'yes' : 'no');
+ *     mongoose.Schema.Types.Boolean.get(v => v === true ? 'yes' : 'no');
  *
  *     const Order = mongoose.model('Order', new Schema({ isPaid: Boolean }));
  *     new Order({ isPaid: false }).isPaid; // 'no'
@@ -94,8 +94,8 @@ SchemaBoolean.get = SchemaType.get;
  * #### Example:
  *
  *     // Make Mongoose cast empty string '' to false.
- *     const original = mongoose.Schema.Boolean.cast();
- *     mongoose.Schema.Boolean.cast(v => {
+ *     const original = mongoose.Schema.Types.Boolean.cast();
+ *     mongoose.Schema.Types.Boolean.cast(v => {
  *       if (v === '') {
  *         return false;
  *       }
@@ -103,7 +103,7 @@ SchemaBoolean.get = SchemaType.get;
  *     });
  *
  *     // Or disable casting entirely
- *     mongoose.Schema.Boolean.cast(false);
+ *     mongoose.Schema.Types.Boolean.cast(false);
  *
  * @param {Function} caster
  * @return {Function}
@@ -175,7 +175,7 @@ SchemaBoolean.prototype.checkRequired = function(value) {
  *
  *     const M = mongoose.model('Test', new Schema({ b: Boolean }));
  *     new M({ b: 'affirmative' }).b; // undefined
- *     mongoose.Schema.Boolean.convertToTrue.add('affirmative');
+ *     mongoose.Schema.Types.Boolean.convertToTrue.add('affirmative');
  *     new M({ b: 'affirmative' }).b; // true
  *
  * @property convertToTrue

package/lib/schema/buffer.js

@@ -58,7 +58,7 @@ SchemaBuffer._checkRequired = v => !!v?.length;
  * #### Example:
  *
  *     // Make all buffers have `required` of true by default.
- *     mongoose.Schema.Buffer.set('required', true);
+ *     mongoose.Schema.Types.Buffer.set('required', true);
  *
  *     const User = mongoose.model('User', new Schema({ test: Buffer }));
  *     new User({ }).validateSync().errors.test.message; // Path `test` is required.

package/lib/schema/date.js

@@ -58,7 +58,7 @@ SchemaDate._cast = castDate;
  * #### Example:
  *
  *     // Make all dates have `required` of true by default.
- *     mongoose.Schema.Date.set('required', true);
+ *     mongoose.Schema.Types.Date.set('required', true);
  *
  *     const User = mongoose.model('User', new Schema({ test: Date }));
  *     new User({ }).validateSync().errors.test.message; // Path `test` is required.
@@ -81,7 +81,7 @@ SchemaDate.setters = [];
  * #### Example:
  *
  *     // Always convert Dates to string
- *     mongoose.Date.get(v => v.toString());
+ *     mongoose.Schema.Types.Date.get(v => v.toString());
  *
  *     const Model = mongoose.model('Test', new Schema({ date: { type: Date, default: () => new Date() } }));
  *     typeof (new Model({}).date); // 'string'

package/lib/schema/decimal128.js

@@ -53,7 +53,7 @@ SchemaDecimal128._cast = castDecimal128;
  * #### Example:
  *
  *     // Make all decimal 128s have `required` of true by default.
- *     mongoose.Schema.Decimal128.set('required', true);
+ *     mongoose.Schema.Types.Decimal128.set('required', true);
  *
  *     const User = mongoose.model('User', new Schema({ test: mongoose.Decimal128 }));
  *     new User({ }).validateSync().errors.test.message; // Path `test` is required.
@@ -76,7 +76,7 @@ SchemaDecimal128.setters = [];
  * #### Example:
  *
  *     // Automatically convert Decimal128s to Numbers
- *     mongoose.Schema.Decimal128.get(v => v == null ? v : Number(v));
+ *     mongoose.Schema.Types.Decimal128.get(v => v == null ? v : Number(v));
  *
  * @param {Function} getter
  * @return {this}

package/lib/schema/documentArray.js

@@ -574,8 +574,8 @@ SchemaDocumentArray.defaultOptions = {};
  *
  * #### Example:
  *
- *     // Make all numbers have option `min` equal to 0.
- *     mongoose.Schema.DocumentArray.set('_id', false);
+ *     // Make all document arrays not have `_id` by default.
+ *     mongoose.Schema.Types.DocumentArray.set('_id', false);
  *
  * @param {String} option The name of the option you'd like to set (e.g. trim, lowercase, etc...)
  * @param {Any} value The value of the option you'd like to set.

package/lib/schema/documentArrayElement.js

@@ -49,6 +49,36 @@ SchemaDocumentArrayElement.schemaName = 'DocumentArrayElement';
 
 SchemaDocumentArrayElement.defaultOptions = {};
 
+/**
+ * Sets a default option for all SchemaDocumentArrayElement instances.
+ *
+ * #### Example:
+ *
+ *     // Make all document array elements have option `_id` equal to false.
+ *     mongoose.Schema.Types.DocumentArrayElement.set('_id', false);
+ *
+ * @param {String} option The name of the option you'd like to set
+ * @param {Any} value The value of the option you'd like to set.
+ * @return {void}
+ * @function set
+ * @static
+ * @api public
+ */
+
+SchemaDocumentArrayElement.set = SchemaType.set;
+
+/**
+ * Attaches a getter for all DocumentArrayElement instances
+ *
+ * @param {Function} getter
+ * @return {this}
+ * @function get
+ * @static
+ * @api public
+ */
+
+SchemaDocumentArrayElement.get = SchemaType.get;
+
 /*!
  * Inherits from SchemaType.
  */

package/lib/schema/double.js

@@ -52,7 +52,7 @@ SchemaDouble._cast = castDouble;
  * #### Example:
  *
  *     // Make all Double fields required by default
- *     mongoose.Schema.Double.set('required', true);
+ *     mongoose.Schema.Types.Double.set('required', true);
  *
  * @param {String} option The option you'd like to set the value for
  * @param {Any} value value for option
@@ -72,7 +72,7 @@ SchemaDouble.setters = [];
  * #### Example:
  *
  *     // Converts Double to be a represent milliseconds upon access
- *     mongoose.Schema.Double.get(v => v == null ? '0.000 ms' : v.toString() + ' ms');
+ *     mongoose.Schema.Types.Double.get(v => v == null ? '0.000 ms' : v.toString() + ' ms');
  *
  * @param {Function} getter
  * @return {this}
@@ -112,7 +112,7 @@ SchemaDouble._defaultCaster = v => {
  *     });
  *
  *     // Or disable casting for Doubles entirely (only JS numbers are permitted)
- *     mongoose.Schema.Double.cast(false);
+ *     mongoose.Schema.Types.Double.cast(false);
  *
  *
  * @param {Function} caster

package/lib/schema/index.js

@@ -12,6 +12,7 @@ exports.Buffer = require('./buffer');
 exports.Date = require('./date');
 exports.Decimal128 = exports.Decimal = require('./decimal128');
 exports.DocumentArray = require('./documentArray');
+exports.DocumentArrayElement = require('./documentArrayElement');
 exports.Double = require('./double');
 exports.Int32 = require('./int32');
 exports.Map = require('./map');

package/lib/schema/int32.js

@@ -53,7 +53,7 @@ SchemaInt32._cast = castInt32;
  * #### Example:
  *
  *     // Make all Int32 fields required by default
- *     mongoose.Schema.Int32.set('required', true);
+ *     mongoose.Schema.Types.Int32.set('required', true);
  *
  * @param {String} option The option you'd like to set the value for
  * @param {Any} value value for option
@@ -73,7 +73,7 @@ SchemaInt32.setters = [];
  * #### Example:
  *
  *     // Converts int32 to be a represent milliseconds upon access
- *     mongoose.Schema.Int32.get(v => v == null ? '0 ms' : v.toString() + ' ms');
+ *     mongoose.Schema.Types.Int32.get(v => v == null ? '0 ms' : v.toString() + ' ms');
  *
  * @param {Function} getter
  * @return {this}
@@ -116,7 +116,7 @@ SchemaInt32._defaultCaster = v => {
  *     });
  *
  *     // Or disable casting for Int32s entirely (only JS numbers within 32-bit integer bounds and null-ish values are permitted)
- *     mongoose.Schema.Int32.cast(false);
+ *     mongoose.Schema.Types.Int32.cast(false);
  *
  *
  * @param {Function} caster

package/lib/schema/mixed.js

@@ -61,7 +61,7 @@ SchemaMixed.prototype.constructor = SchemaMixed;
  * #### Example:
  *
  *     // Hide the 'hidden' path
- *     mongoose.Schema.Mixed.get(v => Object.assign({}, v, { hidden: null }));
+ *     mongoose.Schema.Types.Mixed.get(v => Object.assign({}, v, { hidden: null }));
  *
  *     const Model = mongoose.model('Test', new Schema({ test: {} }));
  *     new Model({ test: { hidden: 'Secret!' } }).test.hidden; // null
@@ -81,7 +81,7 @@ SchemaMixed.get = SchemaType.get;
  * #### Example:
  *
  *     // Make all mixed instances have `required` of true by default.
- *     mongoose.Schema.Mixed.set('required', true);
+ *     mongoose.Schema.Types.Mixed.set('required', true);
  *
  *     const User = mongoose.model('User', new Schema({ test: mongoose.Mixed }));
  *     new User({ }).validateSync().errors.test.message; // Path `test` is required.

package/lib/schema/number.js

@@ -56,7 +56,7 @@ SchemaNumber.get = SchemaType.get;
  * #### Example:
  *
  *     // Make all numbers have option `min` equal to 0.
- *     mongoose.Schema.Number.set('min', 0);
+ *     mongoose.Schema.Types.Number.set('min', 0);
  *
  *     const Order = mongoose.model('Order', new Schema({ amount: Number }));
  *     new Order({ amount: -10 }).validateSync().errors.amount.message; // Path `amount` must be larger than 0.

package/lib/schema/objectId.js

@@ -33,7 +33,7 @@ function SchemaObjectId(key, options, _schemaOptions, parentSchema) {
   if ((isKeyHexStr || typeof key === 'undefined') && !suppressWarning) {
     utils.warn('mongoose: To create a new ObjectId please try ' +
       '`Mongoose.Types.ObjectId` instead of using ' +
-      '`Mongoose.Schema.ObjectId`. Set the `suppressWarning` option if ' +
+      '`Mongoose.Schema.Types.ObjectId`. Set the `suppressWarning` option if ' +
       'you\'re trying to create a hex char path in your schema.');
   }
   SchemaType.call(this, key, options, 'ObjectId', parentSchema);
@@ -82,7 +82,7 @@ SchemaObjectId.get = SchemaType.get;
  * #### Example:
  *
  *     // Make all object ids have option `required` equal to true.
- *     mongoose.Schema.ObjectId.set('required', true);
+ *     mongoose.Schema.Types.ObjectId.set('required', true);
  *
  *     const Order = mongoose.model('Order', new Schema({ userId: ObjectId }));
  *     new Order({ }).validateSync().errors.userId.message; // Path `userId` is required.

package/lib/schema/string.js

@@ -111,7 +111,7 @@ SchemaString._defaultCaster = v => {
  * #### Example:
  *
  *     // Make all numbers round down
- *     mongoose.Schema.String.get(v => v.toLowerCase());
+ *     mongoose.Schema.Types.String.get(v => v.toLowerCase());
  *
  *     const Model = mongoose.model('Test', new Schema({ test: String }));
  *     new Model({ test: 'FOO' }).test; // 'foo'
@@ -131,7 +131,7 @@ SchemaString.get = SchemaType.get;
  * #### Example:
  *
  *     // Make all strings have option `trim` equal to true.
- *     mongoose.Schema.String.set('trim', true);
+ *     mongoose.Schema.Types.String.set('trim', true);
  *
  *     const User = mongoose.model('User', new Schema({ name: String }));
  *     new User({ name: '   John Doe   ' }).name; // 'John Doe'

package/lib/schema/subdocument.js

@@ -364,8 +364,8 @@ SchemaSubdocument.defaultOptions = {};
  *
  * #### Example:
  *
- *     // Make all numbers have option `min` equal to 0.
- *     mongoose.Schema.Subdocument.set('required', true);
+ *     // Make all subdocuments required by default.
+ *     mongoose.Schema.Types.Subdocument.set('required', true);
  *
  * @param {String} option The option you'd like to set the value for
  * @param {Any} value value for option

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "9.1.2",
+  "version": "9.1.3",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",

package/types/models.d.ts

@@ -71,6 +71,7 @@ declare module 'mongoose' {
     ordered?: boolean;
     lean?: boolean;
     throwOnValidationError?: boolean;
+    timestamps?: boolean | QueryTimestampsConfig;
   }
 
   interface InsertManyResult<T> extends mongodb.InsertManyResult<T> {
@@ -237,7 +238,11 @@ declare module 'mongoose' {
       ? (Record<KeyType, ValueType> | Array<[KeyType, ValueType]> | T[K])
       : NonNullable<T[K]> extends Types.DocumentArray<infer RawSubdocType>
          ? RawSubdocType[] | T[K]
-         : QueryTypeCasting<T[K]>;
+         : NonNullable<T[K]> extends Document<any, any, infer RawSubdocType>
+           ? ApplyBasicCreateCasting<RawSubdocType> | T[K]
+           : NonNullable<T[K]> extends Record<string, any>
+             ? ApplyBasicCreateCasting<T[K]> | T[K]
+             : QueryTypeCasting<T[K]>;
   };
 
   type HasLeanOption<TSchema> = 'lean' extends keyof ObtainSchemaGeneric<TSchema, 'TSchemaOptions'> ?

package/types/schematypes.d.ts

@@ -513,6 +513,15 @@ declare module 'mongoose' {
         static defaultOptions: Record<string, any>;
       }
 
+      class DocumentArrayElement extends SchemaType {
+        /** This schema type's name, to defend against minifiers that mangle function names. */
+        static schemaName: 'DocumentArrayElement';
+        readonly schemaName: 'DocumentArrayElement';
+
+        /** Default options for this SchemaType */
+        static defaultOptions: Record<string, any>;
+      }
+
       class Map extends SchemaType {
         /** This schema type's name, to defend against minifiers that mangle function names. */
         static schemaName: 'Map';

package/types/utility.d.ts

@@ -15,7 +15,7 @@ declare module 'mongoose' {
         // If not a document, then return the type. Otherwise, get the DocType.
         ? NonNullable<T[P]>
         : Extract<NonNullable<T[P]>, Document> extends Document<any, any, infer DocType, any>
-          ? DocType
+          ? DocType | Exclude<NonNullable<T[P]>, Document>
           : never
       // Handle nested paths
       : P extends `${infer Key}.${infer Rest}`