Merge pull request #15517 from Automattic/vkarpov15/gh-15516

types(schema): use user-provided THydratedDocumentType as context for virtual get() and set()

Author: vkarpov15

test/types/schema.test.ts

@@ -1841,3 +1841,17 @@ function gh15479() {
     return obj.testField;
   }
 }
+
+function gh15516() {
+  interface IUser {
+    name: string;
+  }
+  type HydratedUserDoc = HydratedDocument<IUser & { customProperty: number, myVirtual: number }>;
+  const schema = new Schema<IUser, Model<IUser>, {}, {}, { myVirtual: number }, {}, DefaultSchemaOptions, any, HydratedUserDoc>({
+    name: String
+  });
+
+  schema.virtual('myVirtual').get(function() {
+    expectType<HydratedUserDoc>(this);
+  });
+}

types/index.d.ts

@@ -519,7 +519,7 @@ declare module 'mongoose' {
     toJSONSchema(options?: { useBsonType?: boolean }): Record<string, any>;
 
     /** Creates a virtual type with the given name. */
-    virtual<T = HydratedDocument<DocType, TVirtuals & TInstanceMethods, TQueryHelpers>>(
+    virtual<T = THydratedDocumentType>(
       name: keyof TVirtuals | string,
       options?: VirtualTypeOptions<T, DocType>
     ): VirtualType<T>;