Merge pull request #13346 from Jokero/handleDocumentArrayInFlattenMaps

Handle `DocumentArray` in `FlattenMaps`
Automattic · May 2, 2023 · aaacf46 · aaacf46
2 parents 8e84ede + 4055c64
commit aaacf46
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 3 deletions.
diff --git a/test/types/lean.test.ts b/test/types/lean.test.ts
@@ -1,5 +1,5 @@
-import { Schema, model, Document, Types } from 'mongoose';
-import { expectError, expectType } from 'tsd';
+import { Schema, model, Document, Types, InferSchemaType, FlattenMaps } from 'mongoose';
+import { expectAssignable, expectError, expectType } from 'tsd';
 
 function gh10345() {
   (function() {
@@ -143,3 +143,39 @@ async function gh13010() {
   const country = await CountryModel.findOne().lean().orFail().exec();
   expectType<Record<string, string>>(country.name);
 }
+
+async function gh13345_1() {
+  const imageSchema = new Schema({
+    url: { required: true, type: String }
+  });
+
+  const placeSchema = new Schema({
+    images: { required: true, type: [imageSchema] }
+  });
+
+  type Place = InferSchemaType<typeof placeSchema>;
+
+  const PlaceModel = model('Place', placeSchema);
+
+  const place = await PlaceModel.findOne().lean().orFail().exec();
+  expectAssignable<Place>(place);
+}
+
+async function gh13345_2() {
+  const imageSchema = new Schema({
+    description: { required: true, type: Map, of: String },
+    url: { required: true, type: String }
+  });
+
+  const placeSchema = new Schema({
+    images: { required: true, type: [imageSchema] }
+  });
+
+  type Place = InferSchemaType<typeof placeSchema>;
+
+  const PlaceModel = model('Place', placeSchema);
+
+  const place = await PlaceModel.findOne().lean().orFail().exec();
+  expectAssignable<FlattenMaps<Place>>(place);
+  expectType<Record<string, string>>(place.images[0].description);
+}
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -596,7 +596,8 @@ declare module 'mongoose' {
   export type FlattenMaps<T> = {
     [K in keyof T]: T[K] extends Map<any, infer V>
       ? Record<string, V> : T[K] extends TreatAsPrimitives
-        ? T[K] : FlattenMaps<T[K]>;
+        ? T[K] : T[K] extends Types.DocumentArray<infer ItemType>
+          ? Types.DocumentArray<FlattenMaps<ItemType>> : FlattenMaps<T[K]>;
   };
 
   export type actualPrimitives = string | boolean | number | bigint | symbol | null | undefined;