fix(types): correctly infer this when using pre('updateOne') with…

… `{ document: true, query: false }` Fix #11257
Automattic · Dec 8, 2022 · 2a927bd · 2a927bd
1 parent 82943da
commit 2a927bd
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 6 deletions.
diff --git a/test/types/middleware.test.ts b/test/types/middleware.test.ts
@@ -117,12 +117,6 @@ schema.post<Query<ITest, ITest>>('findOneAndDelete', function(res, next) {
 
 const Test = model<ITest>('Test', schema);
 
-function gh11257(): void {
-  schema.pre('save', { document: true }, function() {
-    expectType<HydratedDocument<ITest>>(this);
-  });
-}
-
 function gh11480(): void {
   type IUserSchema = {
     name: string;
@@ -155,3 +149,29 @@ function gh12583() {
     console.log(doc.name);
   });
 }
+
+function gh11257() {
+  interface User {
+    name: string;
+    email: string;
+    avatar?: string;
+  }
+
+  const schema = new Schema<User>({
+    name: { type: String, required: true },
+    email: { type: String, required: true },
+    avatar: String
+  });
+
+  schema.pre('save', { document: true }, function() {
+    expectType<HydratedDocument<User>>(this);
+  });
+
+  schema.pre('updateOne', { document: true, query: false }, function() {
+    this.isNew;
+  });
+
+  schema.pre('updateOne', { document: false, query: true }, function() {
+    this.find();
+  });
+}
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -305,6 +305,16 @@ declare module 'mongoose' {
     post<T = M>(method: 'insertMany' | RegExp, options: SchemaPostOptions, fn: ErrorHandlingMiddlewareFunction<T>): this;
 
     /** Defines a pre hook for the model. */
+    pre<T = HydratedDocument<DocType, TInstanceMethods>>(
+      method: DocumentOrQueryMiddleware | DocumentOrQueryMiddleware[],
+      options: SchemaPreOptions & { document: true; query: false; },
+      fn: PreMiddlewareFunction<T>
+    ): this;
+    pre<T = Query<any, any>>(
+      method: DocumentOrQueryMiddleware | DocumentOrQueryMiddleware[],
+      options: SchemaPreOptions & { document: false; query: true; },
+      fn: PreMiddlewareFunction<T>
+    ): this;
     pre<T = HydratedDocument<DocType, TInstanceMethods>>(method: 'save', fn: PreSaveMiddlewareFunction<T>): this;
     pre<T = HydratedDocument<DocType, TInstanceMethods>>(method: 'save', options: SchemaPreOptions, fn: PreSaveMiddlewareFunction<T>): this;
     pre<T = Query<any, any>>(method: MongooseQueryMiddleware | MongooseQueryMiddleware[] | RegExp, fn: PreMiddlewareFunction<T>): this;

diff --git a/types/middlewares.d.ts b/types/middlewares.d.ts
@@ -2,6 +2,7 @@ declare module 'mongoose' {
 
   type MongooseDocumentMiddleware = 'validate' | 'save' | 'remove' | 'updateOne' | 'deleteOne' | 'init';
   type MongooseQueryMiddleware = 'count' | 'estimatedDocumentCount' | 'countDocuments' | 'deleteMany' | 'deleteOne' | 'distinct' | 'find' | 'findOne' | 'findOneAndDelete' | 'findOneAndRemove' | 'findOneAndReplace' | 'findOneAndUpdate' | 'remove' | 'replaceOne' | 'update' | 'updateOne' | 'updateMany';
+  type DocumentOrQueryMiddleware = 'updateOne' | 'deleteOne' | 'remove';
 
   type MiddlewareOptions = {
     /**