mongoose 6.8.0 → 6.8.2

package/tools/auth.js

@@ -21,11 +21,11 @@ async function run() {
   // Start process
   await server.start();
 
-  const db = await mongodb.MongoClient.connect('mongodb://localhost:27017/admin');
+  const db = await mongodb.MongoClient.connect('mongodb://127.0.0.1:27017/admin');
 
   await db.addUser('passwordIsTaco', 'taco', {
     roles: ['dbOwner']
   });
 
   console.log('done');
-}
+}

package/tools/sharded.js

@@ -17,18 +17,18 @@ async function run() {
 
   await topology.addShard([{
     options: {
-      bind_ip: 'localhost', port: 31000, dbpath: '/data/db/31000', shardsvr: null
+      bind_ip: '127.0.0.1', port: 31000, dbpath: '/data/db/31000', shardsvr: null
     }
   }], { replSet: 'rs1' });
 
   await topology.addConfigurationServers([{
     options: {
-      bind_ip: 'localhost', port: 35000, dbpath: '/data/db/35000'
+      bind_ip: '127.0.0.1', port: 35000, dbpath: '/data/db/35000'
     }
   }], { replSet: 'rs0' });
 
   await topology.addProxies([{
-    bind_ip: 'localhost', port: 51000, configdb: 'localhost:35000'
+    bind_ip: '127.0.0.1', port: 51000, configdb: '127.0.0.1:35000'
   }], {
     binary: 'mongos'
   });
@@ -43,4 +43,4 @@ async function run() {
   await topology.enableSharding('test');
 
   console.log('done');
-}
+}

package/types/aggregate.d.ts

@@ -68,13 +68,13 @@ declare module 'mongoose' {
     [key: string]: any;
   }
 
-  class Aggregate<R> implements SessionOperation {
+  class Aggregate<ResultType> implements SessionOperation {
     /**
      * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js)
      * You do not need to call this function explicitly, the JavaScript runtime
      * will call it for you.
      */
-    [Symbol.asyncIterator](): AsyncIterableIterator<Unpacked<R>>;
+    [Symbol.asyncIterator](): AsyncIterableIterator<Unpacked<ResultType>>;
 
     options: AggregateOptions;
 
@@ -103,7 +103,7 @@ declare module 'mongoose' {
      * resolved with either the doc(s) or rejected with the error.
      * Like [`.then()`](#query_Query-then), but only takes a rejection handler.
      */
-    catch: Promise<R>['catch'];
+    catch: Promise<ResultType>['catch'];
 
     /** Set the collation. */
     collation(options: mongodb.CollationOptions): this;
@@ -121,8 +121,8 @@ declare module 'mongoose' {
 
 
     /** Executes the aggregate pipeline on the currently bound Model. */
-    exec(callback: Callback<R>): void;
-    exec(): Promise<R>;
+    exec(callback: Callback<ResultType>): void;
+    exec(): Promise<ResultType>;
 
     /** Execute the aggregation with explain */
     explain(verbosity: mongodb.ExplainVerbosityLike, callback: Callback<AnyObject>): void;
@@ -215,7 +215,7 @@ declare module 'mongoose' {
     sort(arg: string | Record<string, SortValues> | PipelineStage.Sort['$sort']): this;
 
     /** Provides promise for aggregate. */
-    then: Promise<R>['then'];
+    then: Promise<ResultType>['then'];
 
     /**
      * Appends a new $sortByCount operator to this aggregate pipeline. Accepts either a string field name

package/types/document.d.ts

@@ -28,6 +28,9 @@ declare module 'mongoose' {
     /** Assert that a given path or paths is populated. Throws an error if not populated. */
     $assertPopulated<Paths = {}>(path: string | string[], values?: Partial<Paths>): Omit<this, keyof Paths> & Paths;
 
+    /** Returns a deep clone of this document */
+    $clone(): this;
+
     /* Get all subdocs (by bfs) */
     $getAllSubdocs(): Document[];
 

package/types/index.d.ts

@@ -305,6 +305,16 @@ declare module 'mongoose' {
     post<T = M>(method: 'insertMany' | RegExp, options: SchemaPostOptions, fn: ErrorHandlingMiddlewareFunction<T>): this;
 
     /** Defines a pre hook for the model. */
+    pre<T = HydratedDocument<DocType, TInstanceMethods>>(
+      method: DocumentOrQueryMiddleware | DocumentOrQueryMiddleware[],
+      options: SchemaPreOptions & { document: true; query: false; },
+      fn: PreMiddlewareFunction<T>
+    ): this;
+    pre<T = Query<any, any>>(
+      method: DocumentOrQueryMiddleware | DocumentOrQueryMiddleware[],
+      options: SchemaPreOptions & { document: false; query: true; },
+      fn: PreMiddlewareFunction<T>
+    ): this;
     pre<T = HydratedDocument<DocType, TInstanceMethods>>(method: 'save', fn: PreSaveMiddlewareFunction<T>): this;
     pre<T = HydratedDocument<DocType, TInstanceMethods>>(method: 'save', options: SchemaPreOptions, fn: PreSaveMiddlewareFunction<T>): this;
     pre<T = Query<any, any>>(method: MongooseQueryMiddleware | MongooseQueryMiddleware[] | RegExp, fn: PreMiddlewareFunction<T>): this;

package/types/inferschematype.d.ts

@@ -83,15 +83,19 @@ type IsPathDefaultUndefined<PathType> = PathType extends { default: undefined }
 type IsPathRequired<P, TypeKey extends string = DefaultTypeKey> =
   P extends { required: true | [true, string | undefined] } | ArrayConstructor | any[]
     ? true
-    : P extends (Record<TypeKey, ArrayConstructor | any[]>)
-      ? IsPathDefaultUndefined<P> extends true
+    : P extends { required: boolean }
+      ? P extends { required: false }
         ? false
         : true
-      : P extends (Record<TypeKey, any>)
-        ? P extends { default: any }
-          ? IfEquals<P['default'], undefined, false, true>
-          : false
-        : false;
+      : P extends (Record<TypeKey, ArrayConstructor | any[]>)
+        ? IsPathDefaultUndefined<P> extends true
+          ? false
+          : true
+        : P extends (Record<TypeKey, any>)
+          ? P extends { default: any }
+            ? IfEquals<P['default'], undefined, false, true>
+            : false
+          : false;
 
 /**
  * @summary Path base type defined by using TypeKey

package/types/middlewares.d.ts

@@ -2,6 +2,7 @@ declare module 'mongoose' {
 
   type MongooseDocumentMiddleware = 'validate' | 'save' | 'remove' | 'updateOne' | 'deleteOne' | 'init';
   type MongooseQueryMiddleware = 'count' | 'estimatedDocumentCount' | 'countDocuments' | 'deleteMany' | 'deleteOne' | 'distinct' | 'find' | 'findOne' | 'findOneAndDelete' | 'findOneAndRemove' | 'findOneAndReplace' | 'findOneAndUpdate' | 'remove' | 'replaceOne' | 'update' | 'updateOne' | 'updateMany';
+  type DocumentOrQueryMiddleware = 'updateOne' | 'deleteOne' | 'remove';
 
   type MiddlewareOptions = {
     /**

package/types/schemaoptions.d.ts

@@ -213,6 +213,12 @@ declare module 'mongoose' {
      * Virtual paths.
      */
     virtuals?: SchemaOptionsVirtualsPropertyType<DocType, TVirtuals, TInstanceMethods>,
+
+    /**
+     * Set to `true` to default to overwriting models with the same name when calling `mongoose.model()`, as opposed to throwing an `OverwriteModelError`.
+     * @default false
+     */
+    overwriteModels?: boolean;
   }
 
   interface DefaultSchemaOptions {

package/types/schematypes.d.ts

@@ -278,6 +278,9 @@ declare module 'mongoose' {
 
     /** Adds validator(s) for this document path. */
     validate(obj: RegExp | ((this: DocType, value: any, validatorProperties?: Validator) => any), errorMsg?: string, type?: string): this;
+
+    /** Default options for this SchemaType */
+    defaultOptions?: Record<string, any>;
   }
 
   namespace Schema {
@@ -294,6 +297,9 @@ declare module 'mongoose' {
         /** The schematype embedded in this array */
         caster?: SchemaType;
 
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
+
         /**
          * Adds an enum validator if this is an array of strings or numbers. Equivalent to
          * `SchemaString.prototype.enum()` or `SchemaNumber.prototype.enum()`
@@ -310,6 +316,9 @@ declare module 'mongoose' {
 
         /** Configure which values get casted to `false`. */
         static convertToFalse: Set<any>;
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class Buffer extends SchemaType {
@@ -321,6 +330,9 @@ declare module 'mongoose' {
          * for this buffer. You can find a [list of allowed subtypes here](http://api.mongodb.com/python/current/api/bson/binary.html).
          */
         subtype(subtype: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 128): this;
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class Date extends SchemaType {
@@ -335,11 +347,17 @@ declare module 'mongoose' {
 
         /** Sets a minimum date validator. */
         min(value: NativeDate, message: string): this;
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class Decimal128 extends SchemaType {
         /** This schema type's name, to defend against minifiers that mangle function names. */
         static schemaName: 'Decimal128';
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class DocumentArray extends SchemaType implements AcceptsDiscriminator {
@@ -356,16 +374,25 @@ declare module 'mongoose' {
 
         /** The constructor used for subdocuments in this array */
         caster?: typeof Types.Subdocument;
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class Map extends SchemaType {
         /** This schema type's name, to defend against minifiers that mangle function names. */
         static schemaName: 'Map';
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class Mixed extends SchemaType {
         /** This schema type's name, to defend against minifiers that mangle function names. */
         static schemaName: 'Mixed';
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class Number extends SchemaType {
@@ -380,6 +407,9 @@ declare module 'mongoose' {
 
         /** Sets a minimum number validator. */
         min(value: number, message: string): this;
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class ObjectId extends SchemaType {
@@ -388,6 +418,9 @@ declare module 'mongoose' {
 
         /** Adds an auto-generated ObjectId default if turnOn is true. */
         auto(turnOn: boolean): this;
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class Subdocument extends SchemaType implements AcceptsDiscriminator {
@@ -397,6 +430,9 @@ declare module 'mongoose' {
         /** The document's schema */
         schema: Schema;
 
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
+
         discriminator<T, U>(name: string | number, schema: Schema<T, U>, value?: string): U;
         discriminator<D>(name: string | number, schema: Schema, value?: string): Model<D>;
       }
@@ -425,11 +461,17 @@ declare module 'mongoose' {
 
         /** Adds an uppercase [setter](http://mongoosejs.com/docs/api/schematype.html#schematype_SchemaType-set). */
         uppercase(shouldApply?: boolean): this;
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
 
       class UUID extends SchemaType {
         /** This schema type's name, to defend against minifiers that mangle function names. */
         static schemaName: 'UUID';
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
       }
     }
   }

package/lib/plugins/clearValidating.js

@@ -1,28 +0,0 @@
-'use strict';
-
-/*!
- * ignore
- */
-
-module.exports = function clearValidating(schema) {
-  // `this.$__.validating` tracks whether there are multiple validations running
-  // in parallel. We need to clear `this.$__.validating` before post hooks for gh-8597
-  const unshift = true;
-  schema.s.hooks.post('validate', false, function clearValidatingPostValidate() {
-    if (this.$isSubdocument) {
-      return;
-    }
-
-    this.$__.validating = null;
-  }, unshift);
-
-  schema.s.hooks.post('validate', false, function clearValidatingPostValidateError(error, res, next) {
-    if (this.$isSubdocument) {
-      next();
-      return;
-    }
-
-    this.$__.validating = null;
-    next();
-  }, unshift);
-};