Merge pull request #13066 from Automattic/vkarpov15/gh-13040

fix(types): use MergeTypes for type overrides in HydratedDocument

package.json

@@ -32,8 +32,8 @@
     "@babel/preset-env": "7.20.2",
     "@typescript-eslint/eslint-plugin": "5.50.0",
     "@typescript-eslint/parser": "5.50.0",
-    "acquit": "1.2.1",
-    "acquit-ignore": "0.2.0",
+    "acquit": "1.3.0",
+    "acquit-ignore": "0.2.1",
     "acquit-require": "0.1.1",
     "assert-browserify": "2.0.0",
     "axios": "1.1.3",

test/types/.eslintrc.yml

@@ -0,0 +1,2 @@
+rules:
+  "@typescript-eslint/no-empty-interface": off

test/types/lean.test.ts

@@ -182,7 +182,7 @@ async function getBaseDocumentTypeFromModel(): Promise<void> {
 
   type baseFromUserDocType = BaseDocumentType<UserDocType>;
 
-  expectType<User & { _id: Types.ObjectId }>({} as baseFromUserDocType);
+  expectType<Omit<User & { _id: Types.ObjectId }, never>>({} as baseFromUserDocType);
 
   const a: UserDocType = {} as any;
 

test/types/subdocuments.test.ts

@@ -76,3 +76,35 @@ function gh10674() {
 async function gh10947(): Promise<void> {
   await Test.findOneAndUpdate({}, { child1: { name: 'foo' } });
 }
+
+function gh13040(): void {
+  interface Product {}
+
+  interface User {
+    products: Product[];
+  }
+
+  // I want my `UserDocument` type to define `products` as a `DocumentArray`; I'll do this using overrides
+
+  interface UserOverrides {
+    products: Types.DocumentArray<Product>;
+  }
+
+  type UserModel = Model<User, {}, UserOverrides>;
+
+  // Here I determine the type of user documents; I could also manually define a `HydratedDocument` - makes no difference.
+
+  type UserDocument = InstanceType<UserModel>;
+
+  // Assume I have an instance of `UserDocument`
+
+  let user!: UserDocument;
+
+  // This is then fine:
+
+  user.products[0].ownerDocument(); // ok
+
+  user.products.forEach(product => {
+    product.ownerDocument();
+  });
+}

types/index.d.ts

@@ -129,12 +129,14 @@ declare module 'mongoose' {
     ? IfAny<U, T & { _id: Types.ObjectId }, T & Required<{ _id: U }>>
     : T & { _id: Types.ObjectId };
 
-  export type HydratedDocument<DocType, TMethodsAndOverrides = {}, TVirtuals = {}> = DocType extends Document ? Require_id<DocType> : (Document<unknown, any, DocType> & Require_id<DocType> & TVirtuals & TMethodsAndOverrides);
+  export type HydratedDocument<DocType, TMethodsAndOverrides = {}, TVirtuals = {}> = DocType extends Document ?
+    Require_id<DocType> :
+    Document<unknown, any, DocType> & MergeType<Require_id<DocType>, TVirtuals & TMethodsAndOverrides>;
 
   export type HydratedDocumentFromSchema<TSchema extends Schema> = HydratedDocument<
   InferSchemaType<TSchema>,
-  ObtainSchemaGeneric<TSchema, 'TQueryHelpers'>,
-  ObtainSchemaGeneric<TSchema, 'TInstanceMethods'>
+  ObtainSchemaGeneric<TSchema, 'TInstanceMethods'>,
+  ObtainSchemaGeneric<TSchema, 'TVirtuals'>
   >;
 
   export interface TagSet {