From e6d2fbe5fa246d6b6e527b79809a2f9130887ed3 Mon Sep 17 00:00:00 2001 From: Valeri Karpov Date: Thu, 16 Nov 2023 18:19:55 -0500 Subject: [PATCH] types: fix issues backporting #14078 to 7.x --- types/middlewares.d.ts | 2 +- types/models.d.ts | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/types/middlewares.d.ts b/types/middlewares.d.ts index 9302b9b7d48..5cf3af901c0 100644 --- a/types/middlewares.d.ts +++ b/types/middlewares.d.ts @@ -6,7 +6,7 @@ declare module 'mongoose' { type MongooseDocumentMiddleware = MongooseDistinctDocumentMiddleware | MongooseQueryAndDocumentMiddleware; type MongooseRawResultQueryMiddleware = 'findOneAndUpdate' | 'findOneAndReplace' | 'findOneAndDelete'; - type MongooseDistinctQueryMiddleware = 'estimatedDocumentCount' | 'countDocuments' | 'deleteMany' | 'distinct' | 'find' | 'findOne' | 'findOneAndDelete' | 'findOneAndReplace' | 'findOneAndUpdate' | 'replaceOne' | 'updateMany'; + type MongooseDistinctQueryMiddleware = 'count' | 'estimatedDocumentCount' | 'countDocuments' | 'deleteMany' | 'distinct' | 'find' | 'findOne' | 'findOneAndDelete' | 'findOneAndReplace' | 'findOneAndRemove' | 'findOneAndUpdate' | 'replaceOne' | 'updateMany'; type MongooseDefaultQueryMiddleware = MongooseDistinctQueryMiddleware | 'updateOne' | 'deleteOne'; type MongooseQueryMiddleware = MongooseDistinctQueryMiddleware | MongooseQueryAndDocumentMiddleware; diff --git a/types/models.d.ts b/types/models.d.ts index ddb28542ed7..24ceae501d2 100644 --- a/types/models.d.ts +++ b/types/models.d.ts @@ -555,6 +555,18 @@ declare module 'mongoose' { options?: QueryOptions | null ): QueryWithHelpers; + /** Creates a `findByIdAndRemove` query, filtering by the given `_id`. */ + findByIdAndRemove( + id: mongodb.ObjectId | any, + options: QueryOptions & { lean: true } + ): QueryWithHelpers< + GetLeanResultType | null, + ResultDoc, + TQueryHelpers, + TRawDocType, + 'findOneAndDelete' + >; + /** Creates a `findOneAndUpdate` query, filtering by the given `_id`. */ findByIdAndUpdate( id: mongodb.ObjectId | any, @@ -572,6 +584,11 @@ declare module 'mongoose' { update: UpdateQuery, options: QueryOptions & { rawResult: true } ): QueryWithHelpers, ResultDoc, TQueryHelpers, TRawDocType, 'findOneAndUpdate'>; + findByIdAndUpdate( + id: mongodb.ObjectId | any, + update: UpdateQuery, + options: QueryOptions & { includeResultMetadata: true } + ): QueryWithHelpers, ResultDoc, TQueryHelpers, TRawDocType, 'findOneAndUpdate'>; findByIdAndUpdate( id: mongodb.ObjectId | any, update: UpdateQuery, @@ -630,6 +647,11 @@ declare module 'mongoose' { replacement: TRawDocType | AnyObject, options: QueryOptions & { rawResult: true } ): QueryWithHelpers, ResultDoc, TQueryHelpers, TRawDocType, 'findOneAndReplace'>; + findOneAndReplace( + filter: FilterQuery, + replacement: TRawDocType | AnyObject, + options: QueryOptions & { includeResultMetadata: true } + ): QueryWithHelpers, ResultDoc, TQueryHelpers, TRawDocType, 'findOneAndReplace'>; findOneAndReplace( filter: FilterQuery, replacement: TRawDocType | AnyObject,