Pass DocType to statics, methods & query props in SchemaOptions to ge…

…t better intellisense.
Automattic · Mar 29, 2022 · d499f2e · d499f2e
1 parent 1b00038
commit d499f2e
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/test/types/schema.test.ts b/test/types/schema.test.ts
@@ -1,5 +1,5 @@
 import { Schema, Document, SchemaDefinition, Model, Types, InferSchemaType, SchemaType, Query } from 'mongoose';
-import { expectType, expectError, expectAssignable, expectNotAssignable } from 'tsd';
+import { expectType, expectError, expectAssignable } from 'tsd';
 
 enum Genre {
   Action,
@@ -439,19 +439,19 @@ export function autoTypedSchema() {
   }, {
     statics: {
       staticFn() {
-        expectAssignable<Model<any>>(this);
+        expectType<Model<M0_0aAutoTypedSchemaType['schema']>>(this);
         return 'Returned from staticFn' as const;
       }
     },
     methods: {
       instanceFn() {
-        expectAssignable<Document>(this);
+        expectAssignable<Document<any, any, M0_0aAutoTypedSchemaType['schema']>>(this);
         return 'Returned from DocumentInstanceFn' as const;
       }
     },
     query: {
       byUserName(userName) {
-        expectAssignable<Query<unknown, unknown>>(this);
+        expectAssignable<Query<unknown, M0_0aAutoTypedSchemaType['schema']>>(this);
         return this.where({ userName });
       }
     }

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -766,7 +766,7 @@ declare module 'mongoose' {
     /**
      * Create a new schema
      */
-    constructor(definition?: SchemaDefinition<SchemaDefinitionType<EnforcedDocType>> | DocType, options?: SchemaOptions<TPathTypeKey, TInstanceMethods, TQueryHelpers, TStaticMethods>);
+    constructor(definition?: SchemaDefinition<SchemaDefinitionType<EnforcedDocType>> | DocType, options?: SchemaOptions<TPathTypeKey, DocType, TInstanceMethods, TQueryHelpers, TStaticMethods>);
 
     /** Adds key path / schema type pairs to this schema. */
     add(obj: SchemaDefinition<SchemaDefinitionType<EnforcedDocType>> | Schema, prefix?: string): this;

diff --git a/types/schemaoptions.d.ts b/types/schemaoptions.d.ts
@@ -11,7 +11,7 @@ declare module 'mongoose' {
   type TypeKeyBaseType = string;
 
   type DefaultTypeKey = 'type';
-  interface SchemaOptions<PathTypeKey extends TypeKeyBaseType = DefaultTypeKey, InstanceMethods = {}, QueryHelpers = {}, StaticMethods = {}> {
+  interface SchemaOptions<PathTypeKey extends TypeKeyBaseType = DefaultTypeKey, DocType = unknown, InstanceMethods = {}, QueryHelpers = {}, StaticMethods = {}> {
     /**
      * By default, Mongoose's init() function creates all the indexes defined in your model's schema by
      * calling Model.createIndexes() after you successfully connect to MongoDB. If you want to disable
@@ -192,16 +192,16 @@ declare module 'mongoose' {
     /**
      * Model Statics methods.
      */
-    statics?: Record<any, <T extends Model<any>>(this: T, ...args: any) => unknown> | StaticMethods,
+    statics?: Record<any, <T extends Model<DocType>>(this: T, ...args: any) => unknown> | StaticMethods,
 
     /**
      * Document instance methods.
      */
-    methods?: Record<any, <T extends Document>(this: T, ...args: any) => unknown> | InstanceMethods,
+    methods?: Record<any, <T extends Document<any, any, DocType>>(this: T, ...args: any) => unknown> | InstanceMethods,
 
     /**
      * Query helper functions
      */
-    query?: Record<any, <T extends QueryWithHelpers<unknown, unknown>>(this: T, ...args: any) => T> | QueryHelpers,
+    query?: Record<any, <T extends QueryWithHelpers<unknown, DocType>>(this: T, ...args: any) => T> | QueryHelpers,
   }
 }