Merge pull request #16021 from Automattic/fix/gh-15965-subdoc-toObject

fix(types): preserve subdocument toObject() field types when using virtuals + versionKey options

Author: vkarpov15

test/types/document.test.ts

@@ -501,6 +501,33 @@ function gh15965() {
   ExpectType<Date>(obj.updatedAt);
 }
 
+function gh15965SubdocToObject() {
+  const documentSchema = new Schema({
+    title: { type: String, required: true },
+    text: { type: String, required: true }
+  });
+
+  const podcastSchema = new Schema({
+    documents: [documentSchema]
+  }, {
+    timestamps: true,
+    virtuals: { hello: { get() { return 'world'; } } }
+  });
+
+  const Podcast = model('Podcast', podcastSchema);
+  const podcast = new Podcast({ documents: [{ title: 'test', text: 'body' }] });
+  const subdoc = podcast.documents[0];
+
+  const obj = subdoc.toObject({ flattenObjectIds: true, versionKey: false, virtuals: true });
+
+  // @ts-expect-error title should be string, not any
+  const _titleCheck: number = obj.title;
+  // @ts-expect-error text should be string, not any
+  const _textCheck: number = obj.text;
+  // @ts-expect-error no index signature: nonexistent properties should be a type error
+  obj.doesNotExist;
+}
+
 function gh13079() {
   const schema = new Schema({
     name: { type: String, required: true }

types/types.d.ts

@@ -84,7 +84,7 @@ declare module 'mongoose' {
     class ObjectId extends mongodb.ObjectId {
     }
 
-    class Subdocument<IdType = any, TQueryHelpers = any, DocType = any> extends Document<IdType, TQueryHelpers, DocType> {
+    class Subdocument<IdType = any, TQueryHelpers = any, DocType = any, TVirtuals = {}, TSchemaOptions = {}> extends Document<IdType, TQueryHelpers, DocType, TVirtuals, TSchemaOptions> {
       $isSingleNested: true;
 
       /** Returns the top level document of this sub-document. */
@@ -97,7 +97,7 @@ declare module 'mongoose' {
       $parent(): Document;
     }
 
-    class ArraySubdocument<IdType = any, TQueryHelpers = unknown, DocType = unknown> extends Subdocument<IdType, TQueryHelpers, DocType> {
+    class ArraySubdocument<IdType = any, TQueryHelpers = unknown, DocType = unknown, TVirtuals = {}, TSchemaOptions = {}> extends Subdocument<IdType, TQueryHelpers, DocType, TVirtuals, TSchemaOptions> {
       /** Returns this sub-documents parent array. */
       parentArray(): Types.DocumentArray<unknown>;
     }