Merge branch 'master' of github.com:Automattic/mongoose

benchmarks/benchjs/casting.js

@@ -18,7 +18,6 @@ const utils = require('../../lib/utils.js');
  * These are all the benchmark tests for casting stuff
  */
 
-
 const Comments = new Schema();
 
 Comments.add({
@@ -48,6 +47,7 @@ const BlogPost = new Schema({
     default: 'kandinsky'
   }
 });
+
 const commentData = {
   title: 'test comment',
   date: new Date(),
@@ -78,6 +78,7 @@ const blogData10 = utils.clone(blogData);
 const blogData100 = utils.clone(blogData);
 const blogData1000 = utils.clone(blogData);
 const blogData10000 = utils.clone(blogData);
+
 for (let i = 0; i < 10; i++) {
   blogData10.comments.push(commentData);
 }
@@ -90,47 +91,54 @@ for (let i = 0; i < 1000; i++) {
 for (let i = 0; i < 10000; i++) {
   blogData10000.comments.push(commentData);
 }
+
 mongoose.model('BlogPost', BlogPost);
 
-suite.add('Casting - Embedded Docs - 0 Docs', {
-  fn: function() {
-    const BlogPost = mongoose.model('BlogPost');
-    const bp = new BlogPost();
-    bp.init(blogData);
-  }
-}).add('Casting - Embedded Docs - 10 Docs', {
-  fn: function() {
-    const BlogPost = mongoose.model('BlogPost');
-    const bp = new BlogPost();
-    bp.init(blogData10);
-  }
-}).add('Casting - Embedded Docs - 100 Docs', {
-  fn: function() {
-    const BlogPost = mongoose.model('BlogPost');
-    const bp = new BlogPost();
-    bp.init(blogData100);
-  }
-}).add('Casting - Embedded Docs - 1000 Docs', {
-  fn: function() {
-    const BlogPost = mongoose.model('BlogPost');
-    const bp = new BlogPost();
-    bp.init(blogData1000);
-  }
-}).add('Casting - Embedded Docs - 10000 Docs', {
-  fn: function() {
-    const BlogPost = mongoose.model('BlogPost');
-    const bp = new BlogPost();
-    bp.init(blogData10000);
-  }
-})
-  .on('cycle', function(evt) {
+suite
+  .add('Casting - Embedded Docs - 0 Docs', {
+    fn: function () {
+      const BlogPost = mongoose.model('BlogPost');
+      const bp = new BlogPost();
+      bp.init(blogData);
+    }
+  })
+  .add('Casting - Embedded Docs - 10 Docs', {
+    fn: function () {
+      const BlogPost = mongoose.model('BlogPost');
+      const bp = new BlogPost();
+      bp.init(blogData10);
+    }
+  })
+  .add('Casting - Embedded Docs - 100 Docs', {
+    fn: function () {
+      const BlogPost = mongoose.model('BlogPost');
+      const bp = new BlogPost();
+      bp.init(blogData100);
+    }
+  })
+  .add('Casting - Embedded Docs - 1000 Docs', {
+    fn: function () {
+      const BlogPost = mongoose.model('BlogPost');
+      const bp = new BlogPost();
+      bp.init(blogData1000);
+    }
+  })
+  .add('Casting - Embedded Docs - 10000 Docs', {
+    fn: function () {
+      const BlogPost = mongoose.model('BlogPost');
+      const bp = new BlogPost();
+      bp.init(blogData10000);
+    }
+  })
+  .on('cycle', function (evt) {
     if (process.env.MONGOOSE_DEV || process.env.PULL_REQUEST) {
       console.log(String(evt.target));
     }
-  }).on('complete', function() {
+  })
+  .on('complete', function () {
     if (!process.env.MONGOOSE_DEV && !process.env.PULL_REQUEST) {
       const outObj = {};
-      this.forEach(function(item) {
+      this.forEach(function (item) {
         const out = {};
         out.stats = item.stats;
         delete out.stats.sample;
@@ -139,4 +147,5 @@ suite.add('Casting - Embedded Docs - 0 Docs', {
       });
       console.dir(outObj, { depth: null, colors: true });
     }
-  }).run({ async: true });
+  })
+  .run({ async: true });

docs/typescript/subdocuments.md

@@ -1,7 +1,7 @@
 # Handling Subdocuments in TypeScript
 
 Subdocuments are tricky in TypeScript.
-By default, Mongoose treats object properties in document interfaces as _nested propertes_ rather than subdocuments.
+By default, Mongoose treats object properties in document interfaces as _nested properties_ rather than subdocuments.
 
 ```ts
 // Setup
@@ -81,4 +81,4 @@ const UserModel = model<User, UserModelType>('User', new Schema<User, UserModelT
 
 const doc = new UserModel({});
 doc.names[0].ownerDocument(); // Works!
-```
+```

lib/index.js

@@ -1223,7 +1223,7 @@ Mongoose.prototype._promiseOrCallback = function(callback, fn, ee) {
 /**
  * Use this function in `pre()` middleware to skip calling the wrapped function.
  *
- * ####Example:
+ * #### Example:
  *
  *     schema.pre('save', function() {
  *       // Will skip executing `save()`, but will execute post hooks as if
@@ -1241,7 +1241,7 @@ Mongoose.prototype.skipMiddlewareFunction = Kareem.skipWrappedFunction;
 /**
  * Use this function in `post()` middleware to replace the result
  *
- * ####Example:
+ * #### Example:
  *
  *     schema.post('find', function(res) {
  *       // Normally you have to modify `res` in place. But with

lib/schema.js

@@ -477,7 +477,7 @@ Schema.prototype.defaultOptions = function(options) {
  * Inherit a Schema by applying a discriminator on an existing Schema.
  *
  *
- * ####Example:
+ * #### Example:
  *
  *     const options = { discriminatorKey: 'kind' };
  *
@@ -648,7 +648,7 @@ Schema.prototype.add = function add(obj, prefix) {
  * removeIndex only removes indexes from your schema object. Does **not** affect the indexes
  * in MongoDB.
  *
- * ####Example:
+ * #### Example:
  *
  *     const ToySchema = new Schema({ name: String, color: String, price: Number });
  *
@@ -701,7 +701,7 @@ Schema.prototype.removeIndex = function removeIndex(index) {
  * clearIndexes only removes indexes from your schema object. Does **not** affect the indexes
  * in MongoDB.
  *
- * ####Example:
+ * #### Example:
  *
  *     const ToySchema = new Schema({ name: String, color: String, price: Number });
  *     ToySchema.index({ name: 1 });

test/types/schema.test.ts

@@ -9,7 +9,8 @@ import {
   InferSchemaType,
   SchemaType,
   Query,
-  HydratedDocument
+  HydratedDocument,
+  SchemaOptions
 } from 'mongoose';
 import { expectType, expectError, expectAssignable } from 'tsd';
 
@@ -559,6 +560,7 @@ function gh11828() {
     }
   });
 }
+
 function gh11997() {
   interface IUser {
     name: string;
@@ -569,3 +571,17 @@ function gh11997() {
   });
   userSchema.index({ name: 1 }, { weights: { name: 1 } });
 }
+
+function gh12003() {
+  const baseSchemaOptions: SchemaOptions = {
+    versionKey: false
+  };
+
+  const BaseSchema = new Schema({
+    name: String
+  }, baseSchemaOptions);
+
+  type BaseSchemaType = InferSchemaType<typeof BaseSchema>;
+
+  expectType<{ name?: string }>({} as BaseSchemaType);
+}

types/index.d.ts

@@ -166,7 +166,7 @@ declare module 'mongoose' {
     /**
      * Create a new schema
      */
-    constructor(definition?: SchemaDefinition<SchemaDefinitionType<EnforcedDocType>> | DocType, options?: SchemaOptions<TPathTypeKey, DocType, TInstanceMethods, TQueryHelpers, TStaticMethods>);
+    constructor(definition?: SchemaDefinition<SchemaDefinitionType<EnforcedDocType>> | DocType, options?: SchemaOptions<TPathTypeKey, FlatRecord<DocType>, TInstanceMethods, TQueryHelpers, TStaticMethods>);
 
     /** Adds key path / schema type pairs to this schema. */
     add(obj: SchemaDefinition<SchemaDefinitionType<EnforcedDocType>> | Schema, prefix?: string): this;

types/utility.d.ts

@@ -12,4 +12,11 @@ declare module 'mongoose' {
 
   type MergeType<A, B> = Omit<A, keyof B> & B;
 
+  /**
+   * @summary Converts Unions to one record "object".
+   * @description It makes intellisense dialog box easier to read as a single object instead of showing that in multiple object unions.
+   * @param {T} T The type to be converted.
+   */
+   type FlatRecord<T> = { [K in keyof T]: T[K] };
+
 }