fix(types): handle arrays in ApplyBasicQueryCasting correctly

Fix #11964
Automattic · Jun 24, 2022 · b66cdc6 · b66cdc6
1 parent e991892
commit b66cdc6
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 2 deletions.
diff --git a/test/types/queries.test.ts b/test/types/queries.test.ts
@@ -1,4 +1,18 @@
-import { HydratedDocument, Schema, model, Document, Types, Query, Model, QueryWithHelpers, PopulatedDoc, FilterQuery, UpdateQuery } from 'mongoose';
+import {
+  HydratedDocument,
+  Schema,
+  model,
+  Document,
+  Types,
+  Query,
+  Model,
+  QueryWithHelpers,
+  PopulatedDoc,
+  FilterQuery,
+  UpdateQuery,
+  ApplyBasicQueryCasting,
+  QuerySelector
+} from 'mongoose';
 import { ObjectId } from 'mongodb';
 import { expectError, expectType } from 'tsd';
 import { autoTypedModel } from './models.test';
@@ -295,3 +309,21 @@ function autoTypedQuery() {
   const query = AutoTypedModel.find();
   expectType<typeof query>(AutoTypedModel.find().byUserName(''));
 }
+
+function gh11964() {
+  type Condition<T> = ApplyBasicQueryCasting<T> | QuerySelector<ApplyBasicQueryCasting<T>>; // redefined here because it's not exported by mongoose
+
+  type WithId<T extends object> = T & { id: string };
+
+  class Repository<T extends object> {
+    /* ... */
+
+    find(id: string) {
+      const idCondition: Condition<WithId<T>>['id'] = id; // error :(
+      const filter: FilterQuery<WithId<T>> = { id }; // error :(
+
+      /* ... */
+    }
+  }
+
+}
diff --git a/types/query.d.ts b/types/query.d.ts
@@ -1,7 +1,7 @@
 declare module 'mongoose' {
   import mongodb = require('mongodb');
 
-  export type ApplyBasicQueryCasting<T, defaultT = T | T[] | {}> = T extends any[] ? T[0] & defaultT: defaultT;
+  export type ApplyBasicQueryCasting<T> = T | T[] | (T extends (infer U)[] ? U : any) | any;
   type Condition<T> = ApplyBasicQueryCasting<T> | QuerySelector<ApplyBasicQueryCasting<T>>;
 
   type _FilterQuery<T> = {