types(schematypes): allow defining map path using type: 'Map' in ad…

…dition to `type: Map` Fix #13755
Automattic · Oct 9, 2023 · 098c644 · 098c644
1 parent b721f54
commit 098c644
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/test/types/maps.test.ts b/test/types/maps.test.ts
@@ -71,3 +71,19 @@ function gh10872(): void {
 
   doc.toJSON().map1.foo;
 }
+
+function gh13755() {
+  class Test {
+    instance: Map<string, string>;
+    constructor() {
+      this.instance = new Map<string, string>();
+    }
+  }
+
+  const testSchema = new Schema<Test>({
+    instance: {
+      type: 'Map',
+      of: 'Mixed'
+    }
+  });
+}
diff --git a/test/types/schemaTypeOptions.test.ts b/test/types/schemaTypeOptions.test.ts
@@ -22,7 +22,7 @@ expectType<BooleanSchemaDefinition | undefined>(new SchemaTypeOptions<boolean>()
 expectType<NumberSchemaDefinition | undefined>(new SchemaTypeOptions<number>().type);
 expectType<DateSchemaDefinition | undefined>(new SchemaTypeOptions<Date>().type);
 expectType<StringSchemaDefinition | undefined>(new SchemaTypeOptions<string>().type);
-expectType<SchemaDefinition<typeof Map> | undefined>(new SchemaTypeOptions<Map<any, any>>().type);
+expectType<SchemaDefinition<typeof Map> | SchemaDefinition<'Map'> | undefined>(new SchemaTypeOptions<Map<any, any>>().type);
 expectType<SchemaDefinition<typeof Buffer> | undefined>(new SchemaTypeOptions<Buffer>().type);
 expectType<ObjectIdSchemaDefinition | undefined>(new SchemaTypeOptions<Types.ObjectId>().type);
 expectType<AnyArray<ObjectIdSchemaDefinition> | AnyArray<SchemaTypeOptions<ObjectId>> | undefined>(new SchemaTypeOptions<Types.ObjectId[]>().type);

diff --git a/types/schematypes.d.ts b/types/schematypes.d.ts
@@ -45,7 +45,7 @@ declare module 'mongoose' {
       T extends number ? NumberSchemaDefinition :
         T extends boolean ? BooleanSchemaDefinition :
           T extends NativeDate ? DateSchemaDefinition :
-            T extends Map<any, any> ? SchemaDefinition<typeof Map> :
+            T extends Map<any, any> ? SchemaDefinition<typeof Map> | SchemaDefinition<'Map'> :
               T extends Buffer ? SchemaDefinition<typeof Buffer> :
                 T extends Types.ObjectId ? ObjectIdSchemaDefinition :
                   T extends Types.ObjectId[] ? AnyArray<ObjectIdSchemaDefinition> | AnyArray<SchemaTypeOptions<ObjectId, EnforcedDocType>> :