Merge pull request #14228 from Automattic/vkarpov15/gh-14204

types(model+query): use stricter typings for updateX(), replaceOne(),deleteX() Model functions

Author: vkarpov15

types/models.d.ts

@@ -222,7 +222,7 @@ declare module 'mongoose' {
     /** Creates a `countDocuments` query: counts the number of documents that match `filter`. */
     countDocuments(
       filter?: FilterQuery<TRawDocType>,
-      options?: QueryOptions<TRawDocType>
+      options?: (mongodb.CountOptions & Omit<MongooseSpecificQueryOptions, 'lean' | 'timestamps'>) | null
     ): QueryWithHelpers<
       number,
       THydratedDocumentType,
@@ -254,7 +254,7 @@ declare module 'mongoose' {
      */
     deleteMany(
       filter?: FilterQuery<TRawDocType>,
-      options?: QueryOptions<TRawDocType>
+      options?: (mongodb.DeleteOptions & Omit<MongooseSpecificQueryOptions, 'lean' | 'timestamps'>) | null
     ): QueryWithHelpers<
       mongodb.DeleteResult,
       THydratedDocumentType,
@@ -279,7 +279,7 @@ declare module 'mongoose' {
      */
     deleteOne(
       filter?: FilterQuery<TRawDocType>,
-      options?: QueryOptions<TRawDocType>
+      options?: (mongodb.DeleteOptions & Omit<MongooseSpecificQueryOptions, 'lean' | 'timestamps'>) | null
     ): QueryWithHelpers<
       mongodb.DeleteResult,
       THydratedDocumentType,
@@ -689,7 +689,7 @@ declare module 'mongoose' {
     replaceOne<ResultDoc = THydratedDocumentType>(
       filter?: FilterQuery<TRawDocType>,
       replacement?: TRawDocType | AnyObject,
-      options?: QueryOptions<TRawDocType> | null
+      options?: (mongodb.ReplaceOptions & MongooseSpecificQueryOptions) | null
     ): QueryWithHelpers<UpdateWriteOpResult, ResultDoc, TQueryHelpers, TRawDocType, 'replaceOne'>;
 
     /** Schema the model uses. */
@@ -699,14 +699,14 @@ declare module 'mongoose' {
     updateMany<ResultDoc = THydratedDocumentType>(
       filter?: FilterQuery<TRawDocType>,
       update?: UpdateQuery<TRawDocType> | UpdateWithAggregationPipeline,
-      options?: QueryOptions<TRawDocType> | null
+      options?: (mongodb.UpdateOptions & Omit<MongooseSpecificQueryOptions, 'lean'>) | null
     ): QueryWithHelpers<UpdateWriteOpResult, ResultDoc, TQueryHelpers, TRawDocType, 'updateMany'>;
 
     /** Creates a `updateOne` query: updates the first document that matches `filter` with `update`. */
     updateOne<ResultDoc = THydratedDocumentType>(
       filter?: FilterQuery<TRawDocType>,
       update?: UpdateQuery<TRawDocType> | UpdateWithAggregationPipeline,
-      options?: QueryOptions<TRawDocType> | null
+      options?: (mongodb.UpdateOptions & Omit<MongooseSpecificQueryOptions, 'lean'>) | null
     ): QueryWithHelpers<UpdateWriteOpResult, ResultDoc, TQueryHelpers, TRawDocType, 'updateOne'>;
 
     /** Creates a Query, applies the passed conditions, and returns the Query. */

types/query.d.ts

@@ -95,81 +95,95 @@ declare module 'mongoose' {
     updatedAt?: boolean;
   }
 
-  interface QueryOptions<DocType = unknown> extends
-    PopulateOption,
-    SessionOption {
-    arrayFilters?: { [key: string]: any }[];
-    batchSize?: number;
-    collation?: mongodb.CollationOptions;
-    comment?: any;
-    context?: string;
-    explain?: mongodb.ExplainVerbosityLike;
-    fields?: any | string;
-    hint?: mongodb.Hint;
+  interface MongooseSpecificQueryOptions {
     /**
      * If truthy, mongoose will return the document as a plain JavaScript object rather than a mongoose document.
      */
     lean?: boolean | Record<string, any>;
-    limit?: number;
-    maxTimeMS?: number;
-    multi?: boolean;
+
     multipleCastError?: boolean;
-    /**
-     * By default, `findOneAndUpdate()` returns the document as it was **before**
-     * `update` was applied. If you set `new: true`, `findOneAndUpdate()` will
-     * instead give you the object after `update` was applied.
-     */
-    new?: boolean;
 
     overwriteDiscriminatorKey?: boolean;
-    projection?: ProjectionType<DocType>;
-    /**
-     * if true, returns the full ModifyResult rather than just the document
-     */
-    includeResultMetadata?: boolean;
-    readPreference?: string | mongodb.ReadPreferenceMode;
-    /**
-     * An alias for the `new` option. `returnOriginal: false` is equivalent to `new: true`.
-     */
-    returnOriginal?: boolean;
-    /**
-     * Another alias for the `new` option. `returnOriginal` is deprecated so this should be used.
-     */
-    returnDocument?: 'before' | 'after';
     /**
      * Set to true to enable `update validators`
      * (https://mongoosejs.com/docs/validation.html#update-validators). Defaults to false.
      */
     runValidators?: boolean;
-    /* Set to `true` to automatically sanitize potentially unsafe user-generated query projections */
-    sanitizeProjection?: boolean;
     /**
      * Set to `true` to automatically sanitize potentially unsafe query filters by stripping out query selectors that
      * aren't explicitly allowed using `mongoose.trusted()`.
      */
     sanitizeFilter?: boolean;
+    /* Set to `true` to automatically sanitize potentially unsafe user-generated query projections */
+    sanitizeProjection?: boolean;
     setDefaultsOnInsert?: boolean;
-    skip?: number;
-    sort?: any;
     /** overwrites the schema's strict mode option */
     strict?: boolean | string;
+
     /**
      * equal to `strict` by default, may be `false`, `true`, or `'throw'`. Sets the default
      * [strictQuery](https://mongoosejs.com/docs/guide.html#strictQuery) mode for schemas.
      */
     strictQuery?: boolean | 'throw';
-    tailable?: number;
     /**
      * If set to `false` and schema-level timestamps are enabled,
      * skip timestamps for this update. Note that this allows you to overwrite
      * timestamps. Does nothing if schema-level timestamps are not set.
      */
     timestamps?: boolean | QueryTimestampsConfig;
+
     /**
      * If `true`, convert any aliases in filter, projection, update, and distinct
      * to their database property names. Defaults to false.
      */
     translateAliases?: boolean;
+
+    [other: string]: any;
+  }
+
+  interface QueryOptions<DocType = unknown> extends
+    PopulateOption,
+    SessionOption,
+    MongooseSpecificQueryOptions {
+    arrayFilters?: { [key: string]: any }[];
+    batchSize?: number;
+    bypassDocumentValidation?: boolean;
+    collation?: mongodb.CollationOptions;
+    comment?: any;
+    context?: string;
+    explain?: mongodb.ExplainVerbosityLike;
+    fields?: any | string;
+    hint?: mongodb.Hint;
+
+    let?: Record<string, any>;
+    limit?: number;
+    maxTimeMS?: number;
+    multi?: boolean;
+    /**
+     * By default, `findOneAndUpdate()` returns the document as it was **before**
+     * `update` was applied. If you set `new: true`, `findOneAndUpdate()` will
+     * instead give you the object after `update` was applied.
+     */
+    new?: boolean;
+    projection?: ProjectionType<DocType>;
+    /**
+     * if true, returns the full ModifyResult rather than just the document
+     */
+    includeResultMetadata?: boolean;
+    readPreference?: string | mongodb.ReadPreferenceMode;
+    /**
+     * An alias for the `new` option. `returnOriginal: false` is equivalent to `new: true`.
+     */
+    returnOriginal?: boolean;
+    /**
+     * Another alias for the `new` option. `returnOriginal` is deprecated so this should be used.
+     */
+    returnDocument?: 'before' | 'after';
+    skip?: number;
+    sort?: any;
+
+    tailable?: number;
+
     upsert?: boolean;
     useBigInt64?: boolean;
     writeConcern?: mongodb.WriteConcern;