mongoose 9.3.2 → 9.3.3

package/lib/aggregate.js

@@ -159,7 +159,7 @@ Aggregate.prototype.model = function(model) {
  *     const pipeline = [{ $match: { daw: 'Logic Audio X' }} ];
  *     aggregate.append(pipeline);
  *
- * @param {...object|object[]} ops operator(s) to append. Can either be a spread of objects or a single parameter of a object array.
+ * @param {...object|object[]} ops operator(s) to append. Can either be a spread of objects or a single parameter of an object array.
  * @return {Aggregate}
  * @api public
  */

package/lib/connection.js

@@ -177,7 +177,7 @@ Connection.prototype.get = function getOption(key) {
  * Supported options include:
  *
  * - `maxTimeMS`: Set [`maxTimeMS`](https://mongoosejs.com/docs/api/query.html#Query.prototype.maxTimeMS()) for all queries on this connection.
- * - '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 arugments 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 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(', ')})`.
  *
  * #### Example:
  *

package/lib/helpers/isBsonType.js

@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Get the bson type, if it exists
+ * Determines if `obj` has the given BSON type.
  * @api private
  */
 

package/lib/mongoose.js

@@ -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:
  *
@@ -247,8 +247,8 @@ Mongoose.prototype.setDriver = function setDriver(driver) {
  * - `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
+ * @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
  */

package/lib/query.js

@@ -5582,7 +5582,7 @@ Query.prototype[Symbol.asyncIterator] = function queryAsyncIterator() {
  * @see $box https://www.mongodb.com/docs/manual/reference/operator/box/
  * @see within() Query#within https://mongoosejs.com/docs/api/query.html#Query.prototype.within()
  * @see MongoDB Geospatial Indexing https://www.mongodb.com/docs/manual/core/geospatial-indexes/
- * @param {object|Array<number>} val1 Lower Left Coordinates OR a object of lower-left(ll) and upper-right(ur) Coordinates
+ * @param {object|Array<number>} val1 Lower Left Coordinates OR an object of lower-left(ll) and upper-right(ur) Coordinates
  * @param {Array<number>} [val2] Upper Right Coordinates
  * @return {Query} this
  * @api public

package/lib/schema.js

@@ -2253,7 +2253,7 @@ Schema.prototype.plugin = function(fn, opts) {
  *
  * NOTE: `Schema.method()` adds instance methods to the `Schema.methods` object. You can also add instance methods directly to the `Schema.methods` object as seen in the [guide](https://mongoosejs.com/docs/guide.html#methods)
  *
- * @param {string|object} name The Method Name for a single function, or a Object of "string-function" pairs.
+ * @param {string|object} name The Method Name for a single function, or an Object of "string-function" pairs.
  * @param {Function} [fn] The Function in a single-function definition.
  * @api public
  */
@@ -2298,7 +2298,7 @@ Schema.prototype.method = function(name, fn, options) {
  *
  * If a hash of name/fn pairs is passed as the only argument, each name/fn pair will be added as statics.
  *
- * @param {string|object} name The Method Name for a single function, or a Object of "string-function" pairs.
+ * @param {string|object} name The Method Name for a single function, or an Object of "string-function" pairs.
  * @param {Function} [fn] The Function in a single-function definition.
  * @api public
  * @see Statics https://mongoosejs.com/docs/guide.html#statics
@@ -3119,7 +3119,7 @@ Schema.prototype.toJSONSchema = function toJSONSchema(options) {
   for (const path of Object.keys(this.paths)) {
     const schemaType = this.paths[path];
 
-    // Skip Map embedded paths, maps will be handled seperately.
+    // Skip Map embedded paths, maps will be handled separately.
     if (schemaType._presplitPath.indexOf('$*') !== -1) {
       continue;
     }

package/lib/schemaType.js

@@ -99,11 +99,11 @@ function SchemaType(path, options, instance, parentSchema) {
           const index = this._index;
           if (typeof index === 'object' && index != null) {
             if (index.unique) {
-              throw new Error('Path "' + this.path + '" may not have `index` ' +
+              throw new MongooseError('Path "' + this.path + '" may not have `index` ' +
                 'set to false and `unique` set to true');
             }
             if (index.sparse) {
-              throw new Error('Path "' + this.path + '" may not have `index` ' +
+              throw new MongooseError('Path "' + this.path + '" may not have `index` ' +
                 'set to false and `sparse` set to true');
             }
           }
@@ -317,7 +317,7 @@ SchemaType.prototype.castFunction = function castFunction(caster, message) {
  */
 
 SchemaType.prototype.cast = function cast() {
-  throw new Error('Base SchemaType class does not implement a `cast()` function');
+  throw new MongooseError('Base SchemaType class does not implement a `cast()` function');
 };
 
 /**
@@ -491,7 +491,7 @@ SchemaType.prototype.unique = function unique(value, message) {
     if (!value) {
       return;
     }
-    throw new Error('Path "' + this.path + '" may not have `index` set to ' +
+    throw new MongooseError('Path "' + this.path + '" may not have `index` set to ' +
       'false and `unique` set to true');
   }
 
@@ -530,7 +530,7 @@ SchemaType.prototype.text = function(bool) {
     if (!bool) {
       return this;
     }
-    throw new Error('Path "' + this.path + '" may not have `index` set to ' +
+    throw new MongooseError('Path "' + this.path + '" may not have `index` set to ' +
       'false and `text` set to true');
   }
 
@@ -567,7 +567,7 @@ SchemaType.prototype.sparse = function(bool) {
     if (!bool) {
       return this;
     }
-    throw new Error('Path "' + this.path + '" may not have `index` set to ' +
+    throw new MongooseError('Path "' + this.path + '" may not have `index` set to ' +
       'false and `sparse` set to true');
   }
 
@@ -1003,7 +1003,7 @@ SchemaType.prototype.validate = function(obj, message, type) {
         + arg
         + '. See https://mongoosejs.com/docs/api/schematype.html#SchemaType.prototype.validate()';
 
-      throw new Error(msg);
+      throw new MongooseError(msg);
     }
     this.validate(arg.validator, arg);
   }
@@ -1704,7 +1704,7 @@ SchemaType.prototype.castForQuery = function($conditional, val, context) {
   if ($conditional != null) {
     handler = this.$conditionalHandlers[$conditional];
     if (!handler) {
-      throw new Error('Can\'t use ' + $conditional);
+      throw new MongooseError('Can\'t use ' + $conditional);
     }
     return handler.call(this, val, context);
   }
@@ -1820,7 +1820,7 @@ SchemaType.prototype._duplicateKeyErrorMessage = null;
  */
 
 SchemaType.prototype.toJSONSchema = function toJSONSchema(_options) { // eslint-disable-line no-unused-vars
-  throw new Error(`Converting unsupported SchemaType to JSON Schema: ${this.instance} at path "${this.path}"`);
+  throw new MongooseError(`Converting unsupported SchemaType to JSON Schema: ${this.instance} at path "${this.path}"`);
 };
 
 /**

package/package.json

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

package/types/utility.d.ts

@@ -103,7 +103,7 @@ declare module 'mongoose' {
     ? T
     : Omit<T, keyof U> & U;
 
-  type MergeType<A, B> = Omit<A, keyof B> & B;
+  type MergeType<A, B> = A extends unknown ? Omit<A, keyof B> & B : never;
 
   /**
    * @summary Converts Unions to one record "object".