mongoose 9.2.4 → 9.3.0

package/lib/model.js

@@ -373,6 +373,23 @@ function _createSaveOptions(doc, options) {
 
 Model.prototype.$__save = async function $__save(options) {
   try {
+    const hasValidateBeforeSaveOption = options &&
+      (typeof options === 'object') &&
+      ('validateBeforeSave' in options);
+    const shouldValidateBeforeSave = hasValidateBeforeSaveOption ?
+      !!options.validateBeforeSave :
+      this.$__schema.options.validateBeforeSave;
+    if (shouldValidateBeforeSave) {
+      const hasValidateModifiedOnlyOption = options != null &&
+        typeof options === 'object' &&
+        Object.hasOwn(options, 'validateModifiedOnly');
+      const validateOptions = hasValidateModifiedOnlyOption ?
+        { validateModifiedOnly: options.validateModifiedOnly } :
+        null;
+      await this.$validate(validateOptions);
+      this.$op = 'save';
+    }
+
     await this._execDocumentPreHooks('save', options, [options]);
   } catch (error) {
     await this._execDocumentPostHooks('save', options, error);
@@ -387,7 +404,9 @@ Model.prototype.$__save = async function $__save(options) {
 
     if (this.$isNew) {
       // send entire doc
-      const obj = this.toObject(saveToObjectOptions);
+      const obj = this.$__hasOnlyPrimitiveValues() ?
+        this.$__toObjectShallow() :
+        this.toObject(saveToObjectOptions);
       if ((obj || {})._id === void 0) {
         // documents must have an _id else mongoose won't know
         // what to update later if more changes are made. the user
@@ -625,11 +644,13 @@ Model.prototype.save = async function save(options) {
   if (this.$__.timestamps != null) {
     options.timestamps = this.$__.timestamps;
   }
-  this.$__.$versionError = generateVersionError(
-    this,
-    this.modifiedPaths(),
-    Object.keys(this.$__.activePaths.getStatePaths('default'))
-  );
+  if (!this.$isNew) {
+    this.$__.$versionError = generateVersionError(
+      this,
+      this.modifiedPaths(),
+      Object.keys(this.$__.activePaths.getStatePaths('default'))
+    );
+  }
 
   if (parallelSave) {
     this.$__handleReject(parallelSave);
@@ -1172,7 +1193,7 @@ Model.init = function init() {
  *     });
  *
  * @api public
- * @param {object} [options] see [MongoDB driver docs](https://mongodb.github.io/node-mongodb-native/4.9/classes/Db.html#createCollection)
+ * @param {object} [options] see [MongoDB driver docs](https://mongodb.github.io/node-mongodb-native/7.0/classes/Db.html#createCollection)
  * @returns {Promise}
  */
 
@@ -1629,7 +1650,7 @@ Model.ensureIndexes = async function ensureIndexes(options) {
 };
 
 /**
- * Similar to `ensureIndexes()`, except for it uses the [`createIndex`](https://mongodb.github.io/node-mongodb-native/4.9/classes/Db.html#createIndex)
+ * Similar to `ensureIndexes()`, except for it uses the [`createIndex`](https://mongodb.github.io/node-mongodb-native/7.0/classes/Db.html#createIndex)
  * function.
  *
  * @param {object} [options] internal options
@@ -2206,7 +2227,7 @@ Model.estimatedDocumentCount = function estimatedDocumentCount(options) {
  * a full collection scan and **not** use any indexes.
  *
  * The `countDocuments()` function is similar to `count()`, but there are a
- * [few operators that `countDocuments()` does not support](https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#countDocuments).
+ * [few operators that `countDocuments()` does not support](https://mongodb.github.io/node-mongodb-native/7.0/classes/Collection.html#countDocuments).
  * Below are the operators that `count()` supports but `countDocuments()` does not,
  * and the suggested replacement:
  *
@@ -2373,7 +2394,7 @@ Model.$where = function $where() {
  * @param {object|string} [options.sort] if multiple docs are found by the conditions, sets the sort order to choose which doc to update.
  * @param {boolean} [options.runValidators] if true, runs [update validators](https://mongoosejs.com/docs/validation.html#update-validators) on this command. Update validators validate the update operation against the model's schema
  * @param {boolean} [options.setDefaultsOnInsert=true] If `setDefaultsOnInsert` and `upsert` are true, mongoose will apply the [defaults](https://mongoosejs.com/docs/defaults.html) specified in the model's schema if a new document is created
- * @param {boolean} [options.includeResultMetadata] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html)
+ * @param {boolean} [options.includeResultMetadata] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/7.0/interfaces/ModifyResult.html)
  * @param {boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @param {boolean} [options.overwriteDiscriminatorKey=false] Mongoose removes discriminator key updates from `update` by default, set `overwriteDiscriminatorKey` to `true` to allow updating the discriminator key
  * @return {Query}
@@ -2457,7 +2478,7 @@ Model.findOneAndUpdate = function(conditions, update, options) {
  * @param {object|string} [options.sort] if multiple docs are found by the conditions, sets the sort order to choose which doc to update.
  * @param {boolean} [options.runValidators] if true, runs [update validators](https://mongoosejs.com/docs/validation.html#update-validators) on this command. Update validators validate the update operation against the model's schema
  * @param {boolean} [options.setDefaultsOnInsert=true] If `setDefaultsOnInsert` and `upsert` are true, mongoose will apply the [defaults](https://mongoosejs.com/docs/defaults.html) specified in the model's schema if a new document is created
- * @param {boolean} [options.includeResultMetadata] if true, returns the full [ModifyResult from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html) rather than just the document
+ * @param {boolean} [options.includeResultMetadata] if true, returns the full [ModifyResult from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/7.0/interfaces/ModifyResult.html) rather than just the document
  * @param {boolean} [options.upsert=false] if true, and no documents found, insert a new document
  * @param {boolean} [options.new=false] if true, return the modified document rather than the original
  * @param {object|string} [options.select] sets the document fields to return.
@@ -2513,7 +2534,7 @@ Model.findByIdAndUpdate = function(id, update, options) {
  * @param {boolean|'throw'} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {object|string|string[]} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.select())
  * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](https://mongoosejs.com/docs/transactions.html).
- * @param {boolean} [options.includeResultMetadata] if true, returns the full [ModifyResult from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html) rather than just the document
+ * @param {boolean} [options.includeResultMetadata] if true, returns the full [ModifyResult from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/7.0/interfaces/ModifyResult.html) rather than just the document
  * @param {object|string} [options.sort] if multiple docs are found by the conditions, sets the sort order to choose which doc to update.
  * @param {object|string} [options.select] sets the document fields to return.
  * @param {number} [options.maxTimeMS] puts a time limit on the query - requires mongodb >= 2.6.0
@@ -2594,7 +2615,7 @@ Model.findByIdAndDelete = function(id, options) {
  * @param {boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](https://mongoosejs.com/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Note that this allows you to overwrite timestamps. Does nothing if schema-level timestamps are not set.
  * @param {object|string|string[]} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.select())
  * @param {object|string} [options.sort] if multiple docs are found by the conditions, sets the sort order to choose which doc to update.
- * @param {boolean} [options.includeResultMetadata] if true, returns the full [ModifyResult from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html) rather than just the document
+ * @param {boolean} [options.includeResultMetadata] if true, returns the full [ModifyResult from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/7.0/interfaces/ModifyResult.html) rather than just the document
  * @param {object|string} [options.select] sets the document fields to return.
  * @param {number} [options.maxTimeMS] puts a time limit on the query - requires mongodb >= 2.6.0
  * @param {boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
@@ -2711,6 +2732,26 @@ Model.create = async function create(doc, options) {
     throw new MongooseError('Cannot call `create()` with a session and multiple documents unless `ordered: true` is set');
   }
 
+  if (!Array.isArray(doc) && args.length === 1) {
+    let toSave = doc;
+
+    const Model = this.discriminators && doc[discriminatorKey] != null ?
+      this.discriminators[doc[discriminatorKey]] || getDiscriminatorByValue(this.discriminators, doc[discriminatorKey]) :
+      this;
+    if (Model == null) {
+      throw new MongooseError(`Discriminator "${doc[discriminatorKey]}" not ` +
+      `found for model "${this.modelName}"`);
+    }
+
+    if (!(toSave instanceof Model)) {
+      toSave = new Model(toSave);
+    }
+
+    await toSave.$save(options);
+
+    return toSave;
+  }
+
   if (options.ordered) {
     for (let i = 0; i < args.length; i++) {
       try {
@@ -2789,11 +2830,6 @@ Model.create = async function create(doc, options) {
     }
   }
 
-
-  if (!Array.isArray(doc) && args.length === 1) {
-    return res[0];
-  }
-
   return res;
 };
 
@@ -2867,7 +2903,7 @@ Model.insertOne = async function insertOne(doc, options) {
  *     await doc.deleteOne();
  *
  * @param {Array} [pipeline]
- * @param {object} [options] see the [mongodb driver options](https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#watch)
+ * @param {object} [options] see the [mongodb driver options](https://mongodb.github.io/node-mongodb-native/7.0/classes/Collection.html#watch)
  * @param {boolean} [options.hydrate=false] if true and `fullDocument: 'updateLookup'` is set, Mongoose will automatically hydrate `fullDocument` into a fully fledged Mongoose document
  * @return {ChangeStream} mongoose-specific change stream wrapper, inherits from EventEmitter
  * @api public
@@ -2883,24 +2919,14 @@ Model.watch = function(pipeline, options) {
   options.model = this;
 
 
-  const changeStreamThunk = cb => {
-    pipeline = pipeline || [];
-    prepareDiscriminatorPipeline(pipeline, this.schema, 'fullDocument');
-    if (this.$__collection.buffer) {
-      this.$__collection.addQueue(() => {
-        if (this.closed) {
-          return;
-        }
-        const driverChangeStream = this.$__collection.watch(pipeline, watchOptions);
-        cb(null, driverChangeStream);
-      });
-    } else {
-      const driverChangeStream = this.$__collection.watch(pipeline, watchOptions);
-      cb(null, driverChangeStream);
-    }
-  };
+  pipeline = pipeline || [];
+  prepareDiscriminatorPipeline(pipeline, this.schema, 'fullDocument');
 
-  return new ChangeStream(changeStreamThunk, pipeline, options);
+  const changeStreamPromise = this.db._waitForConnect().then(
+    () => this.$__collection.watch(pipeline, watchOptions)
+  );
+
+  return new ChangeStream(changeStreamPromise, pipeline, options);
 };
 
 /**
@@ -2923,7 +2949,7 @@ Model.watch = function(pipeline, options) {
  *     // secondary that is experiencing replication lag.
  *     doc = await Person.findOne({ name: 'Ned Stark' }, null, { session, readPreference: 'secondary' });
  *
- * @param {object} [options] see the [mongodb driver options](https://mongodb.github.io/node-mongodb-native/4.9/classes/MongoClient.html#startSession)
+ * @param {object} [options] see the [mongodb driver options](https://mongodb.github.io/node-mongodb-native/7.0/classes/MongoClient.html#startSession)
  * @param {boolean} [options.causalConsistency=true] set to false to disable causal consistency
  * @return {Promise<ClientSession>} promise that resolves to a MongoDB driver `ClientSession`
  * @api public
@@ -2967,9 +2993,9 @@ Model.startSession = function() {
  *     ], { rawResult: true });
  *
  * @param {Array|object|any} doc(s)
- * @param {object} [options] see the [mongodb driver options](https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#insertMany)
+ * @param {object} [options] see the [mongodb driver options](https://mongodb.github.io/node-mongodb-native/7.0/classes/Collection.html#insertMany)
  * @param {boolean} [options.ordered=true] if true, will fail fast on the first error encountered. If false, will insert all the documents it can and report errors later. An `insertMany()` with `ordered = false` is called an "unordered" `insertMany()`.
- * @param {boolean} [options.rawResult=false] if false, the returned promise resolves to the documents that passed mongoose document validation. If `true`, will return the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/InsertManyResult.html) with a `mongoose` property that contains `validationErrors` and `results` if this is an unordered `insertMany`.
+ * @param {boolean} [options.rawResult=false] if false, the returned promise resolves to the documents that passed mongoose document validation. If `true`, will return the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/7.0/interfaces/InsertManyResult.html) with a `mongoose` property that contains `validationErrors` and `results` if this is an unordered `insertMany`.
  * @param {boolean} [options.lean=false] if `true`, skips hydrating the documents. This means Mongoose will **not** cast, validate, or apply defaults to any of the documents passed to `insertMany()`. This option is useful if you need the extra performance, but comes with data integrity risk. Consider using with [`castObject()`](https://mongoosejs.com/docs/api/model.html#Model.castObject()) and [`applyDefaults()`](https://mongoosejs.com/docs/api/model.html#Model.applyDefaults()).
  * @param {number} [options.limit=null] this limits the number of documents being processed (validation/casting) by mongoose in parallel, this does **NOT** send the documents in batches to MongoDB. Use this option if you're processing a large number of documents and your app is running out of memory.
  * @param {string|object|Array} [options.populate=null] populates the result documents. This option is a no-op if `rawResult` is set.
@@ -3340,7 +3366,7 @@ function _setIsNew(doc, val) {
  * @param {boolean|object} [options.middleware=true] set to `false` to skip all user-defined middleware
  * @param {boolean} [options.middleware.pre=true] set to `false` to skip only pre hooks
  * @param {boolean} [options.middleware.post=true] set to `false` to skip only post hooks
- * @return {Promise} resolves to a [`BulkWriteOpResult`](https://mongodb.github.io/node-mongodb-native/4.9/classes/BulkWriteResult.html) if the operation succeeds
+ * @return {Promise} resolves to a [`BulkWriteOpResult`](https://mongodb.github.io/node-mongodb-native/7.0/classes/BulkWriteResult.html) if the operation succeeds
  * @api public
  */
 
@@ -3964,7 +3990,7 @@ Model.hydrate = function(obj, projection, options) {
  * @return {Query}
  * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see MongoDB docs https://www.mongodb.com/docs/manual/reference/command/update/#update-command-output
- * @see UpdateResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/UpdateResult.html
+ * @see UpdateResult https://mongodb.github.io/node-mongodb-native/7.0/interfaces/UpdateResult.html
  * @api public
  */
 
@@ -4012,7 +4038,7 @@ Model.updateMany = function updateMany(conditions, update, options) {
  * @return {Query}
  * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see MongoDB docs https://www.mongodb.com/docs/manual/reference/command/update/#update-command-output
- * @see UpdateResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/UpdateResult.html
+ * @see UpdateResult https://mongodb.github.io/node-mongodb-native/7.0/interfaces/UpdateResult.html
  * @api public
  */
 
@@ -4048,7 +4074,7 @@ Model.updateOne = function updateOne(conditions, doc, options) {
  * @param {boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @return {Query}
  * @see Query docs https://mongoosejs.com/docs/queries.html
- * @see UpdateResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/UpdateResult.html
+ * @see UpdateResult https://mongodb.github.io/node-mongodb-native/7.0/interfaces/UpdateResult.html
  * @return {Query}
  * @api public
  */
@@ -4866,7 +4892,6 @@ Model.compile = function compile(name, schema, collectionName, connection, base)
   model.events = new EventEmitter();
 
   schema._preCompile();
-
   const _userProvidedOptions = schema._userProvidedOptions || {};
 
   const collectionOptions = {

package/lib/mongoose.js

@@ -386,13 +386,12 @@ Mongoose.prototype.get = Mongoose.prototype.set;
  *     await db.openUri('mongodb://127.0.0.1:27017/database');
  *
  * @param {string} uri mongodb URI to connect to
- * @param {object} [options] passed down to the [MongoDB driver's `connect()` function](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/MongoClientOptions.html), except for 4 mongoose-specific options explained below.
+ * @param {object} [options] passed down to the [MongoDB driver's `connect()` function](https://mongodb.github.io/node-mongodb-native/7.0/interfaces/MongoClientOptions.html), except for 4 mongoose-specific options explained below.
  * @param {boolean} [options.bufferCommands=true] Mongoose specific option. Set to false to [disable buffering](https://mongoosejs.com/docs/faq.html#callback_never_executes) on all models associated with this connection.
  * @param {string} [options.dbName] The name of the database you want to use. If not provided, Mongoose uses the database name from connection string.
  * @param {string} [options.user] username for authentication, equivalent to `options.auth.username`. Maintained for backwards compatibility.
  * @param {string} [options.pass] password for authentication, equivalent to `options.auth.password`. Maintained for backwards compatibility.
  * @param {boolean} [options.autoIndex=true] Mongoose-specific option. Set to false to disable automatic index creation for all models associated with this connection.
- * @param {Class} [options.promiseLibrary] Sets the [underlying driver's promise library](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/MongoClientOptions.html#promiseLibrary).
  * @param {number} [options.maxPoolSize=5] The maximum number of sockets the MongoDB driver will keep open for this connection. Keep in mind that MongoDB only allows one operation per socket at a time, so you may want to increase this if you find you have a few slow queries that are blocking faster queries from proceeding. See [Slow Trains in MongoDB and Node.js](https://thecodebarbarian.com/slow-trains-in-mongodb-and-nodejs).
  * @param {number} [options.minPoolSize=1] The minimum number of sockets the MongoDB driver will keep open for this connection. Keep in mind that MongoDB only allows one operation per socket at a time, so you may want to increase this if you find you have a few slow queries that are blocking faster queries from proceeding. See [Slow Trains in MongoDB and Node.js](https://thecodebarbarian.com/slow-trains-in-mongodb-and-nodejs).
  * @param {number} [options.socketTimeoutMS=0] How long the MongoDB driver will wait before killing a socket due to inactivity _after initial connection_. Defaults to 0, which means Node.js will not time out the socket due to inactivity. A socket may be inactive because of either no activity or a long-running operation. This option is passed to [Node.js `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback) after the MongoDB driver successfully completes.
@@ -437,7 +436,7 @@ Mongoose.prototype.createConnection = function createConnection(uri, options) {
  *     await mongoose.connect(uri);
  *
  * @param {string} uri mongodb URI to connect to
- * @param {object} [options] passed down to the [MongoDB driver's `connect()` function](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/MongoClientOptions.html), except for 4 mongoose-specific options explained below.
+ * @param {object} [options] passed down to the [MongoDB driver's `connect()` function](https://mongodb.github.io/node-mongodb-native/7.0/interfaces/MongoClientOptions.html), except for 4 mongoose-specific options explained below.
  * @param {boolean} [options.bufferCommands=true] Mongoose specific option. Set to false to [disable buffering](https://mongoosejs.com/docs/faq.html#callback_never_executes) on all models associated with this connection.
  * @param {number} [options.bufferTimeoutMS=10000] Mongoose specific option. If `bufferCommands` is true, Mongoose will throw an error after `bufferTimeoutMS` if the operation is still buffered.
  * @param {string} [options.dbName] The name of the database we want to use. If not provided, use database name from connection string.
@@ -448,7 +447,6 @@ Mongoose.prototype.createConnection = function createConnection(uri, options) {
  * @param {number} [options.serverSelectionTimeoutMS] If `useUnifiedTopology = true`, the MongoDB driver will try to find a server to send any given operation to, and keep retrying for `serverSelectionTimeoutMS` milliseconds before erroring out. If not set, the MongoDB driver defaults to using `30000` (30 seconds).
  * @param {number} [options.heartbeatFrequencyMS] If `useUnifiedTopology = true`, the MongoDB driver sends a heartbeat every `heartbeatFrequencyMS` to check on the status of the connection. A heartbeat is subject to `serverSelectionTimeoutMS`, so the MongoDB driver will retry failed heartbeats for up to 30 seconds by default. Mongoose only emits a `'disconnected'` event after a heartbeat has failed, so you may want to decrease this setting to reduce the time between when your server goes down and when Mongoose emits `'disconnected'`. We recommend you do **not** set this setting below 1000, too many heartbeats can lead to performance degradation.
  * @param {boolean} [options.autoIndex=true] Mongoose-specific option. Set to false to disable automatic index creation for all models associated with this connection.
- * @param {Class} [options.promiseLibrary] Sets the [underlying driver's promise library](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/MongoClientOptions.html#promiseLibrary).
  * @param {number} [options.socketTimeoutMS=0] How long the MongoDB driver will wait before killing a socket due to inactivity _after initial connection_. A socket may be inactive because of either no activity or a long-running operation. `socketTimeoutMS` defaults to 0, which means Node.js will not time out the socket due to inactivity. This option is passed to [Node.js `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback) after the MongoDB driver successfully completes.
  * @param {number} [options.family=0] Passed transparently to [Node.js' `dns.lookup()`](https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback) function. May be either `0`, `4`, or `6`. `4` means use IPv4 only, `6` means use IPv6 only, `0` means try both.
  * @param {boolean} [options.autoCreate=false] Set to `true` to make Mongoose automatically call `createCollection()` on every model created on this connection.
@@ -501,7 +499,7 @@ Mongoose.prototype.disconnect = async function disconnect() {
  * Sessions are scoped to a connection, so calling `mongoose.startSession()`
  * starts a session on the [default mongoose connection](https://mongoosejs.com/docs/api/mongoose.html#Mongoose.prototype.connection).
  *
- * @param {object} [options] see the [mongodb driver options](https://mongodb.github.io/node-mongodb-native/4.9/classes/MongoClient.html#startSession)
+ * @param {object} [options] see the [mongodb driver options](https://mongodb.github.io/node-mongodb-native/7.0/classes/MongoClient.html#startSession)
  * @param {boolean} [options.causalConsistency=true] set to false to disable causal consistency
  * @return {Promise<ClientSession>} promise that resolves to a MongoDB driver `ClientSession`
  * @api public
@@ -1026,7 +1024,7 @@ Mongoose.prototype.VirtualType = VirtualType;
  * - [Array](https://mongoosejs.com/docs/schematypes.html#arrays)
  * - [Buffer](https://mongoosejs.com/docs/schematypes.html#buffers)
  * - [Embedded](https://mongoosejs.com/docs/schematypes.html#schemas)
- * - [DocumentArray](https://mongoosejs.com/docs/api/documentarraypath.html)
+ * - [DocumentArray](https://mongoosejs.com/docs/api/documentarray.html)
  * - [Decimal128](https://mongoosejs.com/docs/api/mongoose.html#Mongoose.prototype.Decimal128)
  * - [ObjectId](https://mongoosejs.com/docs/schematypes.html#objectids)
  * - [Map](https://mongoosejs.com/docs/schematypes.html#maps)

package/lib/options/schemaDocumentArrayOptions.js

@@ -61,6 +61,29 @@ Object.defineProperty(SchemaDocumentArrayOptions.prototype, 'excludeIndexes', op
 
 Object.defineProperty(SchemaDocumentArrayOptions.prototype, '_id', opts);
 
+/**
+ * Defines embedded discriminators for this document array path.
+ *
+ * #### Example:
+ *
+ *     const eventSchema = Schema({ message: String }, { discriminatorKey: 'kind' });
+ *     const clickedSchema = Schema({ element: String });
+ *     const parentSchema = Schema({
+ *       events: [{
+ *         type: eventSchema,
+ *         discriminators: { Clicked: clickedSchema }
+ *       }]
+ *     });
+ *
+ * @api public
+ * @property discriminators
+ * @memberOf SchemaDocumentArrayOptions
+ * @type {Object}
+ * @instance
+ */
+
+Object.defineProperty(SchemaDocumentArrayOptions.prototype, 'discriminators', opts);
+
 /*!
  * ignore
  */

package/lib/options/schemaSubdocumentOptions.js

@@ -63,4 +63,27 @@ Object.defineProperty(SchemaSubdocumentOptions.prototype, '_id', opts);
 
 Object.defineProperty(SchemaSubdocumentOptions.prototype, 'minimize', opts);
 
+/**
+ * Defines embedded discriminators for this single nested path.
+ *
+ * #### Example:
+ *
+ *     const eventSchema = Schema({ message: String }, { discriminatorKey: 'kind' });
+ *     const clickedSchema = Schema({ element: String });
+ *     const parentSchema = Schema({
+ *       event: {
+ *         type: eventSchema,
+ *         discriminators: { Clicked: clickedSchema }
+ *       }
+ *     });
+ *
+ * @api public
+ * @property discriminators
+ * @memberOf SchemaSubdocumentOptions
+ * @type {Object}
+ * @instance
+ */
+
+Object.defineProperty(SchemaSubdocumentOptions.prototype, 'discriminators', opts);
+
 module.exports = SchemaSubdocumentOptions;

package/lib/plugins/index.js

@@ -3,4 +3,3 @@
 exports.saveSubdocs = require('./saveSubdocs');
 exports.sharding = require('./sharding');
 exports.trackTransaction = require('./trackTransaction');
-exports.validateBeforeSave = require('./validateBeforeSave');