@nullix/zod-mongoose-studio 1.0.13 → 2.0.0

package/.output/server/node_modules/mongoose/lib/mongoose.js

@@ -39,7 +39,7 @@ require('./helpers/printJestWarning');
 
 const objectIdHexRegexp = /^[0-9A-Fa-f]{24}$/;
 
-const { AsyncLocalStorage } = require('node:async_hooks');
+const { AsyncLocalStorage } = require('async_hooks');
 
 /**
  * Mongoose constructor.
@@ -56,7 +56,7 @@ const { AsyncLocalStorage } = require('node:async_hooks');
  *     const m = new mongoose.Mongoose();
  *
  * @api public
- * @param {Object} options see [`Mongoose#set()` docs](https://mongoosejs.com/docs/api/mongoose.html#Mongoose.prototype.set())
+ * @param {object} options see [`Mongoose#set()` docs](https://mongoosejs.com/docs/api/mongoose.html#Mongoose.prototype.set())
  */
 function Mongoose(options) {
   this.connections = [];
@@ -82,7 +82,7 @@ function Mongoose(options) {
 
   // If a user creates their own Mongoose instance, give them a separate copy
   // of the `Schema` constructor so they get separate custom types. (gh-6933)
-  if (!options || !options[defaultMongooseSymbol]) {
+  if (!options?.[defaultMongooseSymbol]) {
     const _this = this;
     this.Schema = function() {
       this.base = _this;
@@ -206,8 +206,8 @@ Mongoose.prototype.setDriver = function setDriver(driver) {
 /**
  * Sets mongoose options
  *
- * `key` can be used a object to set multiple options at once.
- * If a error gets thrown for one option, other options will still be evaluated.
+ * `key` can be used as an object to set multiple options at once.
+ * If an error gets thrown for one option, other options will still be evaluated.
  *
  * #### Example:
  *
@@ -228,30 +228,40 @@ Mongoose.prototype.setDriver = function setDriver(driver) {
  * - `bufferCommands`: enable/disable mongoose's buffering mechanism for all connections and models
  * - `bufferTimeoutMS`: If bufferCommands is on, this option sets the maximum amount of time Mongoose buffering will wait before throwing an error. If not specified, Mongoose will use 10000 (10 seconds).
  * - `cloneSchemas`: `false` by default. Set to `true` to `clone()` all schemas before compiling into a model.
- * - `debug`: If `true`, prints the operations mongoose sends to MongoDB to the console. If a writable stream is passed, it will log to that stream, without colorization. If a callback function is passed, it will receive the collection name, the method name, then all arguments passed to the method. For example, if you wanted to replicate the default logging, you could output from the callback `Mongoose: ${collectionName}.${methodName}(${methodArgs.join(', ')})`.
+ * - `debug`: If `true`, prints the operations mongoose sends to MongoDB to the console. If an object is passed, you can set `color`, `shell`, and `timestamp` options. If `timestamp` is `true`, Mongoose prefixes console debug output with an ISO timestamp in brackets. If a writable stream is passed, it will log to that stream, without colorization. If a callback function is passed, it will receive the collection name, the method name, then all arguments passed to the method. For example, if you wanted to replicate the default logging, you could output from the callback `Mongoose: ${collectionName}.${methodName}(${methodArgs.join(', ')})`.
  * - `id`: If `true`, adds a `id` virtual to all schemas unless overwritten on a per-schema basis.
- * - `timestamps.createdAt.immutable`: `true` by default. If `false`, it will change the `createdAt` field to be [`immutable: false`](https://mongoosejs.com/docs/api/schematype.html#SchemaType.prototype.immutable) which means you can update the `createdAt`
  * - `maxTimeMS`: If set, attaches [maxTimeMS](https://www.mongodb.com/docs/manual/reference/operator/meta/maxTimeMS/) to every query
  * - `objectIdGetter`: `true` by default. Mongoose adds a getter to MongoDB ObjectId's called `_id` that returns `this` for convenience with populate. Set this to false to remove the getter.
  * - `overwriteModels`: Set to `true` to default to overwriting models with the same name when calling `mongoose.model()`, as opposed to throwing an `OverwriteModelError`.
- * - `returnOriginal`: If `false`, changes the default `returnOriginal` option to `findOneAndUpdate()`, `findByIdAndUpdate`, and `findOneAndReplace()` to false. This is equivalent to setting the `new` option to `true` for `findOneAndX()` calls by default. Read our [`findOneAndUpdate()` tutorial](https://mongoosejs.com/docs/tutorials/findoneandupdate.html) for more information.
+ * - `returnDocument`: Set to `'before'` or `'after'` to set the default value for the `returnDocument` option to `findOneAndUpdate()`, `findByIdAndUpdate()`, and `findOneAndReplace()`. Defaults to `'before'`, which returns the document before the update was applied. Read our [`findOneAndUpdate()` tutorial](https://mongoosejs.com/docs/tutorials/findoneandupdate.html) for more information.
+ * - `returnOriginal`: **Deprecated.** Use `returnDocument` instead. If `false`, changes the default `returnOriginal` option to `findOneAndUpdate()`, `findByIdAndUpdate`, and `findOneAndReplace()` to false. This is equivalent to setting the `new` option to `true` for `findOneAndX()` calls by default. Read our [`findOneAndUpdate()` tutorial](https://mongoosejs.com/docs/tutorials/findoneandupdate.html) for more information.
  * - `runValidators`: `false` by default. Set to true to enable [update validators](https://mongoosejs.com/docs/validation.html#update-validators) for all validators by default.
  * - `sanitizeFilter`: `false` by default. Set to true to enable the [sanitization of the query filters](https://mongoosejs.com/docs/api/mongoose.html#Mongoose.prototype.sanitizeFilter()) against query selector injection attacks by wrapping any nested objects that have a property whose name starts with `$` in a `$eq`.
  * - `selectPopulatedPaths`: `true` by default. Set to false to opt out of Mongoose adding all fields that you `populate()` to your `select()`. The schema-level option `selectPopulatedPaths` overwrites this one.
- * - `strict`: `true` by default, may be `false`, `true`, or `'throw'`. Sets the default strict mode for schemas.
  * - `strictQuery`: `false` by default. May be `false`, `true`, or `'throw'`. Sets the default [strictQuery](https://mongoosejs.com/docs/guide.html#strictQuery) mode for schemas.
+ * - `strict`: `true` by default, may be `false`, `true`, or `'throw'`. Sets the default strict mode for schemas.
+ * - `timestamps.createdAt.immutable`: `true` by default. If `false`, it will change the `createdAt` field to be [`immutable: false`](https://mongoosejs.com/docs/api/schematype.html#SchemaType.prototype.immutable) which means you can update the `createdAt`
  * - `toJSON`: `{ transform: true, flattenDecimals: true }` by default. Overwrites default objects to [`toJSON()`](https://mongoosejs.com/docs/api/document.html#Document.prototype.toJSON()), for determining how Mongoose documents get serialized by `JSON.stringify()`
  * - `toObject`: `{ transform: true, flattenDecimals: true }` by default. Overwrites default objects to [`toObject()`](https://mongoosejs.com/docs/api/document.html#Document.prototype.toObject())
+ * - `transactionAsyncLocalStorage`: `false` by default. If `true`, Mongoose will automatically pass the `session` to any operation executing within a transaction executor function. See [transaction AsyncLocalStorage documentation](https://mongoosejs.com/docs/transactions.html#asynclocalstorage)
+ * - `translateAliases`: `false` by default. If `true`, Mongoose will automatically translate aliases to their original paths before sending the query to MongoDB.
+ * - `updatePipeline`: `false` by default. If `true`, allows passing update pipelines (arrays) to update operations by default without explicitly setting `updatePipeline: true` in each query.
  *
- * @param {String|Object} key The name of the option or a object of multiple key-value pairs
- * @param {String|Function|Boolean} value The value of the option, unused if "key" is a object
- * @returns {Mongoose} The used Mongoose instnace
+ * @param {string|object} key The name of the option or an object of multiple key-value pairs
+ * @param {string|Function|boolean} value The value of the option, unused if "key" is an object
+ * @returns {Mongoose} The used Mongoose instance
  * @api public
  */
 
 Mongoose.prototype.set = function getsetOptions(key, value) {
   const _mongoose = this instanceof Mongoose ? this : mongoose;
 
+  if (key == null) {
+    const error = new SetOptionError();
+    error.addError(String(key), new SetOptionError.SetOptionInnerError(String(key)));
+    throw error;
+  }
+
   if (arguments.length === 1 && typeof key !== 'object') {
     if (VALID_OPTIONS.indexOf(key) === -1) {
       const error = new SetOptionError();
@@ -307,11 +317,28 @@ Mongoose.prototype.set = function getsetOptions(key, value) {
     } else if (optionKey === 'createInitialConnection') {
       if (optionValue && !_mongoose.connection) {
         _createDefaultConnection(_mongoose);
-      } else if (optionValue === false && _mongoose.connection && _mongoose.connection[defaultConnectionSymbol]) {
-        if (_mongoose.connection.readyState === STATES.disconnected && Object.keys(_mongoose.connection.models).length === 0) {
+      } else if (optionValue === false && _mongoose.connection?.[defaultConnectionSymbol]) {
+        if (_mongoose.connection.readyState === STATES.disconnected && utils.hasOwnKeys(_mongoose.connection.models) === false) {
           _mongoose.connections.shift();
         }
       }
+    } else if (optionKey === 'returnOriginal') {
+      if (_mongoose.options.returnDocument != null) {
+        throw new MongooseError(
+          'Cannot set `returnOriginal` when `returnDocument` is already set. Use `returnDocument` instead.'
+        );
+      }
+      const replacement = optionValue === true ? '\'before\'' : '\'after\'';
+      utils.warn(
+        'Mongoose: the `returnOriginal` option for `mongoose.set()` is deprecated. ' +
+        'Use `mongoose.set(\'returnDocument\', ' + replacement + ')` instead.'
+      );
+    } else if (optionKey === 'returnDocument') {
+      if (_mongoose.options.returnOriginal != null) {
+        throw new MongooseError(
+          'Cannot set `returnDocument` when `returnOriginal` is already set. Use `returnDocument` instead of `returnOriginal`.'
+        );
+      }
     }
   }
 
@@ -329,7 +356,7 @@ Mongoose.prototype.set = function getsetOptions(key, value) {
  *
  *     mongoose.get('test') // returns the 'test' value
  *
- * @param {String} key
+ * @param {string} key
  * @method get
  * @api public
  */
@@ -364,18 +391,17 @@ Mongoose.prototype.get = Mongoose.prototype.set;
  *     db = mongoose.createConnection();
  *     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 {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.
- * @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 {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/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 {number} [options.maxPoolSize=100] 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=0] 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.
+ * @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.
  * @return {Connection} the created Connection object. Connections are not thenable, so you can't do `await mongoose.createConnection()`. To await use `mongoose.createConnection(uri).asPromise()` instead.
  * @api public
  */
@@ -415,22 +441,21 @@ Mongoose.prototype.createConnection = function createConnection(uri, options) {
  *     const uri = 'mongodb://nonexistent.domain:27000';
  *     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 {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.
- * @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 {Number} [options.maxPoolSize=100] 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=0] The minimum number of sockets the MongoDB driver will keep open for this connection.
- * @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.
+ * @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/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.
+ * @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 {number} [options.maxPoolSize=100] 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=0] The minimum number of sockets the MongoDB driver will keep open for this connection.
+ * @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 {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.
  * @see Mongoose#createConnection https://mongoosejs.com/docs/api/mongoose.html#Mongoose.prototype.createConnection()
  * @api public
  * @return {Promise} resolves to `this` if connection succeeded
@@ -480,8 +505,8 @@ 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 {Boolean} [options.causalConsistency=true] set to false to disable causal consistency
+ * @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
  */
@@ -554,11 +579,11 @@ Mongoose.prototype.pluralize = function pluralize(fn) {
  *     const collectionName = 'actor';
  *     const M = mongoose.model('Actor', schema, collectionName);
  *
- * @param {String|Function} name model name or class extending Model
+ * @param {string|Function} name model name or class extending Model
  * @param {Schema} [schema] the schema to use.
- * @param {String} [collection] name (optional, inferred from model name)
- * @param {Object} [options]
- * @param {Boolean} [options.overwriteModels=false] If true, overwrite existing models with the same name to avoid `OverwriteModelError`
+ * @param {string} [collection] name (optional, inferred from model name)
+ * @param {object} [options]
+ * @param {boolean} [options.overwriteModels=false] If true, overwrite existing models with the same name to avoid `OverwriteModelError`
  * @return {Model} The model associated with `name`. Mongoose will create the model if it doesn't already exist.
  * @api public
  */
@@ -704,7 +729,7 @@ Mongoose.prototype._model = function _model(name, schema, collection, options) {
  *     });
  *
  * @api public
- * @param {String|RegExp} name if string, the name of the model to remove. If regexp, removes all models whose name matches the regexp.
+ * @param {string|RegExp} name if string, the name of the model to remove. If regexp, removes all models whose name matches the regexp.
  * @return {Mongoose} this
  */
 
@@ -745,8 +770,8 @@ Mongoose.prototype._applyPlugins = function _applyPlugins(schema, options) {
   const _mongoose = this instanceof Mongoose ? this : mongoose;
 
   options = options || {};
-  options.applyPluginsToDiscriminators = _mongoose.options && _mongoose.options.applyPluginsToDiscriminators || false;
-  options.applyPluginsToChildSchemas = typeof (_mongoose.options && _mongoose.options.applyPluginsToChildSchemas) === 'boolean' ?
+  options.applyPluginsToDiscriminators = _mongoose.options?.applyPluginsToDiscriminators || false;
+  options.applyPluginsToChildSchemas = typeof _mongoose.options?.applyPluginsToChildSchemas === 'boolean' ?
     _mongoose.options.applyPluginsToChildSchemas :
     true;
   applyPlugins(schema, _mongoose.plugins, options, '$globalPluginsApplied');
@@ -758,7 +783,7 @@ Mongoose.prototype._applyPlugins = function _applyPlugins(schema, options) {
  * Equivalent to calling `.plugin(fn)` on each Schema you create.
  *
  * @param {Function} fn plugin callback
- * @param {Object} [opts] optional options
+ * @param {object} [opts] optional options
  * @return {Mongoose} this
  * @see plugins https://mongoosejs.com/docs/plugins.html
  * @api public
@@ -839,7 +864,7 @@ Mongoose.prototype.connections;
  *
  * @memberOf Mongoose
  * @instance
- * @property {Number} nextConnectionId
+ * @property {number} nextConnectionId
  * @api private
  */
 
@@ -1005,7 +1030,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)
@@ -1050,16 +1075,6 @@ Mongoose.prototype.Model = Model;
 
 Mongoose.prototype.Document = Document;
 
-/**
- * The Mongoose DocumentProvider constructor. Mongoose users should not have to
- * use this directly
- *
- * @method DocumentProvider
- * @api public
- */
-
-Mongoose.prototype.DocumentProvider = require('./documentProvider');
-
 /**
  * The Mongoose ObjectId [SchemaType](https://mongoosejs.com/docs/schematypes.html). Used for
  * declaring paths in your schema that should be
@@ -1091,7 +1106,7 @@ Mongoose.prototype.ObjectId = SchemaTypes.ObjectId;
  *     mongoose.isValidObjectId({ test: 42 }); // false
  *
  * @method isValidObjectId
- * @param {Any} v
+ * @param {any} v
  * @returns {boolean} true if `v` is something Mongoose can coerce to an ObjectId
  * @api public
  */
@@ -1123,7 +1138,7 @@ Mongoose.prototype.isValidObjectId = function isValidObjectId(v) {
  *     mongoose.isObjectIdOrHexString({ test: 42 }); // false
  *
  * @method isObjectIdOrHexString
- * @param {Any} v
+ * @param {any} v
  * @returns {boolean} true if `v` is an ObjectId instance _or_ a 24 char hex string
  * @api public
  */
@@ -1136,8 +1151,8 @@ Mongoose.prototype.isObjectIdOrHexString = function isObjectIdOrHexString(v) {
  *
  * Syncs all the indexes for the models registered with this connection.
  *
- * @param {Object} options
- * @param {Boolean} options.continueOnError `false` by default. If set to `true`, mongoose will not throw an error if one model syncing failed, and will return an object where the keys are the names of the models, and the values are the results/errors for each model.
+ * @param {object} options
+ * @param {boolean} options.continueOnError `false` by default. If set to `true`, mongoose will not throw an error if one model syncing failed, and will return an object where the keys are the names of the models, and the values are the results/errors for each model.
  * @return {Promise} Returns a Promise, when the Promise resolves the value is a list of the dropped indexes.
  */
 Mongoose.prototype.syncIndexes = function syncIndexes(options) {
@@ -1224,7 +1239,7 @@ Mongoose.prototype.MongooseError = MongooseError;
  * using a tool like [Sinon](https://www.npmjs.com/package/sinon) for testing.
  *
  * @method now
- * @returns Date the current time
+ * @returns {Date} the current time
  * @api public
  */
 
@@ -1234,9 +1249,9 @@ Mongoose.prototype.now = function now() { return new Date(); };
  * The Mongoose CastError constructor
  *
  * @method CastError
- * @param {String} type The name of the type
- * @param {Any} value The value that failed to cast
- * @param {String} path The path `a.b.c` in the doc where this cast error occurred
+ * @param {string} type The name of the type
+ * @param {any} value The value that failed to cast
+ * @param {string} path The path `a.b.c` in the doc where this cast error occurred
  * @param {Error} [reason] The original error that was thrown
  * @api public
  */
@@ -1272,8 +1287,8 @@ Mongoose.prototype.mquery = require('mquery');
  * ```
  *
  * @method sanitizeFilter
- * @param {Object} filter
- * @returns Object the sanitized object
+ * @param {object} filter
+ * @returns {object} the sanitized object
  * @api public
  */
 
@@ -1292,8 +1307,8 @@ Mongoose.prototype.sanitizeFilter = sanitizeFilter;
  * ```
  *
  * @method trusted
- * @param {Object} obj
- * @returns Object the passed in object
+ * @param {object} obj
+ * @returns {object} the passed in object
  * @api public
  */
 
@@ -1336,6 +1351,43 @@ Mongoose.prototype.skipMiddlewareFunction = Kareem.skipWrappedFunction;
 
 Mongoose.prototype.overwriteMiddlewareResult = Kareem.overwriteResult;
 
+/**
+ * Use this function in `pre()` middleware to replace the arguments passed to the next middleware or hook.
+ *
+ * #### Example:
+ *
+ *     // Suppose you have a schema for time in "HH:MM" string format, but you want to store it as an object { hours, minutes }
+ *     const timeStringToObject = (time) => {
+ *       if (typeof time !== 'string') return time;
+ *       const [hours, minutes] = time.split(':');
+ *       return { hours: parseInt(hours), minutes: parseInt(minutes) };
+ *     };
+ *
+ *     const timeSchema = new Schema({
+ *       hours: { type: Number, required: true },
+ *       minutes: { type: Number, required: true },
+ *     });
+ *
+ *     // In a pre('init') hook, replace raw string doc with custom object form
+ *     timeSchema.pre('init', function(doc) {
+ *       if (typeof doc === 'string') {
+ *         return mongoose.overwriteMiddlewareArguments(timeStringToObject(doc));
+ *       }
+ *     });
+ *
+ *     // Now, initializing with a time string gets auto-converted by the hook
+ *     const userSchema = new Schema({ time: timeSchema });
+ *     const User = mongoose.model('User', userSchema);
+ *     const doc = new User({});
+ *     doc.$init({ time: '12:30' });
+ *
+ * @method overwriteMiddlewareArguments
+ * @param {...any} args The new arguments to be passed to the next middleware. Pass multiple arguments as a spread, **not** as an array.
+ * @api public
+ */
+
+Mongoose.prototype.overwriteMiddlewareArguments = Kareem.overwriteArguments;
+
 /**
  * Takes in an object and deletes any keys from the object whose values
  * are strictly equal to `undefined`.
@@ -1351,8 +1403,8 @@ Mongoose.prototype.overwriteMiddlewareResult = Kareem.overwriteResult;
  *     await UserModel.findOne(mongoose.omitUndefined(filter));
  *
  * @method omitUndefined
- * @param {Object} [val] the object to remove undefined keys from
- * @returns {Object} the object passed in
+ * @param {object} [val] the object to remove undefined keys from
+ * @returns {object} the object passed in
  * @api public
  */
 

package/.output/server/node_modules/mongoose/lib/options/schemaArrayOptions.js

@@ -46,7 +46,7 @@ Object.defineProperty(SchemaArrayOptions.prototype, 'enum', opts);
  * @api public
  * @property of
  * @memberOf SchemaArrayOptions
- * @type {Function|String}
+ * @type {Function|string}
  * @instance
  */
 
@@ -65,7 +65,7 @@ Object.defineProperty(SchemaArrayOptions.prototype, 'of', opts);
  * @api public
  * @property castNonArrays
  * @memberOf SchemaArrayOptions
- * @type {Boolean}
+ * @type {boolean}
  * @instance
  */
 

package/.output/server/node_modules/mongoose/lib/options/schemaBufferOptions.js

@@ -25,7 +25,7 @@ const opts = require('./propertyOptions');
  * @api public
  * @property subtype
  * @memberOf SchemaBufferOptions
- * @type {Number}
+ * @type {number}
  * @instance
  */
 

package/.output/server/node_modules/mongoose/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/.output/server/node_modules/mongoose/lib/options/schemaNumberOptions.js

@@ -26,7 +26,7 @@ const opts = require('./propertyOptions');
  * @api public
  * @property min
  * @memberOf SchemaNumberOptions
- * @type {Number}
+ * @type {number}
  * @instance
  */
 
@@ -39,7 +39,7 @@ Object.defineProperty(SchemaNumberOptions.prototype, 'min', opts);
  * @api public
  * @property max
  * @memberOf SchemaNumberOptions
- * @type {Number}
+ * @type {number}
  * @instance
  */
 
@@ -88,7 +88,7 @@ Object.defineProperty(SchemaNumberOptions.prototype, 'enum', opts);
  * @api public
  * @property populate
  * @memberOf SchemaNumberOptions
- * @type {Object}
+ * @type {object}
  * @instance
  */
 

package/.output/server/node_modules/mongoose/lib/options/schemaObjectIdOptions.js

@@ -25,7 +25,7 @@ const opts = require('./propertyOptions');
  * @api public
  * @property auto
  * @memberOf SchemaObjectIdOptions
- * @type {Boolean}
+ * @type {boolean}
  * @instance
  */
 
@@ -51,7 +51,7 @@ Object.defineProperty(SchemaObjectIdOptions.prototype, 'auto', opts);
  * @api public
  * @property populate
  * @memberOf SchemaObjectIdOptions
- * @type {Object}
+ * @type {object}
  * @instance
  */
 

package/.output/server/node_modules/mongoose/lib/options/schemaStringOptions.js

@@ -51,7 +51,7 @@ Object.defineProperty(SchemaStringOptions.prototype, 'match', opts);
  * @api public
  * @property lowercase
  * @memberOf SchemaStringOptions
- * @type {Boolean}
+ * @type {boolean}
  * @instance
  */
 
@@ -64,7 +64,7 @@ Object.defineProperty(SchemaStringOptions.prototype, 'lowercase', opts);
  * @api public
  * @property trim
  * @memberOf SchemaStringOptions
- * @type {Boolean}
+ * @type {boolean}
  * @instance
  */
 
@@ -77,7 +77,7 @@ Object.defineProperty(SchemaStringOptions.prototype, 'trim', opts);
  * @api public
  * @property uppercase
  * @memberOf SchemaStringOptions
- * @type {Boolean}
+ * @type {boolean}
  * @instance
  */
 
@@ -94,7 +94,7 @@ Object.defineProperty(SchemaStringOptions.prototype, 'uppercase', opts);
  * @api public
  * @property minLength
  * @memberOf SchemaStringOptions
- * @type {Number}
+ * @type {number}
  * @instance
  */
 
@@ -112,7 +112,7 @@ Object.defineProperty(SchemaStringOptions.prototype, 'minlength', opts);
  * @api public
  * @property maxLength
  * @memberOf SchemaStringOptions
- * @type {Number}
+ * @type {number}
  * @instance
  */
 
@@ -125,7 +125,7 @@ Object.defineProperty(SchemaStringOptions.prototype, 'maxlength', opts);
  * @api public
  * @property populate
  * @memberOf SchemaStringOptions
- * @type {Object}
+ * @type {object}
  * @instance
  */
 

package/.output/server/node_modules/mongoose/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;