Merge pull request #13836 from kaulshashank/safer-distinct-return-type

BREAKING CHANGE: Safer types for `Model.distinct` and `Query.distinct`.
Automattic · Sep 8, 2023 · 1f79e2c · 1f79e2c
2 parents e16da72 + b951883
commit 1f79e2c
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 7 deletions.
diff --git a/test/types/queries.test.ts b/test/types/queries.test.ts
@@ -295,8 +295,9 @@ async function gh11306(): Promise<void> {
   // 3. Create a Model.
   const MyModel = model<User>('User', schema);
 
-  expectType<any[]>(await MyModel.distinct('name'));
-  expectType<string[]>(await MyModel.distinct<string>('name'));
+  expectType<unknown[]>(await MyModel.distinct('notThereInSchema'));
+  expectType<string[]>(await MyModel.distinct('name'));
+  expectType<number[]>(await MyModel.distinct<'overrideTest', number>('overrideTest'));
 }
 
 function autoTypedQuery() {

diff --git a/types/models.d.ts b/types/models.d.ts
@@ -443,8 +443,11 @@ declare module 'mongoose' {
     translateAliases(raw: any): any;
 
     /** Creates a `distinct` query: returns the distinct values of the given `field` that match `filter`. */
-    distinct<ReturnType = any>(field: string, filter?: FilterQuery<TRawDocType>): QueryWithHelpers<
-      Array<ReturnType>,
+    distinct<DocKey extends string, ResultType = unknown>(
+      field: DocKey,
+      filter?: FilterQuery<TRawDocType>
+    ): QueryWithHelpers<
+      Array<DocKey extends keyof TRawDocType ? TRawDocType[DocKey] : ResultType>,
       THydratedDocumentType,
       TQueryHelpers,
       TRawDocType,

diff --git a/types/query.d.ts b/types/query.d.ts
@@ -317,10 +317,10 @@ declare module 'mongoose' {
     deleteOne(): QueryWithHelpers<any, DocType, THelpers, RawDocType, 'deleteOne'>;
 
     /** Creates a `distinct` query: returns the distinct values of the given `field` that match `filter`. */
-    distinct<ReturnType = any>(
-      field: string,
+    distinct<DocKey extends string, ResultType = unknown>(
+      field: DocKey,
       filter?: FilterQuery<DocType>
-    ): QueryWithHelpers<Array<ReturnType>, DocType, THelpers, RawDocType, 'distinct'>;
+    ): QueryWithHelpers<Array<DocKey extends keyof DocType ? DocType[DocKey] : ResultType>, DocType, THelpers, RawDocType, 'distinct'>;
 
     /** Specifies a `$elemMatch` query condition. When called with one argument, the most recent path passed to `where()` is used. */
     elemMatch<K = string>(path: K, val: any): this;