mongoose 8.16.4 → 8.17.0

package/types/models.d.ts

@@ -23,7 +23,14 @@ declare module 'mongoose' {
     ): U;
   }
 
-  interface MongooseBulkWriteOptions extends mongodb.BulkWriteOptions {
+  export type MongooseBulkWriteResult = mongodb.BulkWriteResult & {
+    mongoose?: {
+      validationErrors: Error[],
+      results: Array<Error | mongodb.WriteError | null>
+    }
+  };
+
+  export interface MongooseBulkWriteOptions extends mongodb.BulkWriteOptions {
     session?: ClientSession;
     skipValidation?: boolean;
     throwOnValidationError?: boolean;
@@ -266,7 +273,6 @@ declare module 'mongoose' {
     THydratedDocumentType = HydratedDocument<TRawDocType, TVirtuals & TInstanceMethods, TQueryHelpers, TVirtuals>,
     TSchema = any> extends
     NodeJS.EventEmitter,
-    AcceptsDiscriminator,
     IndexManager,
     SessionStarter {
     new <DocType = Partial<TRawDocType>>(doc?: DocType, fields?: any | null, options?: boolean | AnyObject): THydratedDocumentType;
@@ -306,20 +312,20 @@ declare module 'mongoose' {
      * round trip to the MongoDB server.
      */
     bulkWrite<DocContents = TRawDocType>(
-      writes: Array<AnyBulkWriteOperation<DocContents extends Document ? any : (DocContents extends {} ? DocContents : any)>>,
+      writes: Array<AnyBulkWriteOperation<DocContents>>,
       options: MongooseBulkWriteOptions & { ordered: false }
-    ): Promise<mongodb.BulkWriteResult & { mongoose?: { validationErrors: Error[], results: Array<Error | mongodb.WriteError | null> } }>;
+    ): Promise<MongooseBulkWriteResult>;
     bulkWrite<DocContents = TRawDocType>(
-      writes: Array<AnyBulkWriteOperation<DocContents extends Document ? any : (DocContents extends {} ? DocContents : any)>>,
+      writes: Array<AnyBulkWriteOperation<DocContents>>,
       options?: MongooseBulkWriteOptions
-    ): Promise<mongodb.BulkWriteResult>;
+    ): Promise<MongooseBulkWriteResult>;
 
     /**
      * Sends multiple `save()` calls in a single `bulkWrite()`. This is faster than
      * sending multiple `save()` calls because with `bulkSave()` there is only one
      * network round trip to the MongoDB server.
      */
-    bulkSave(documents: Array<Document>, options?: MongooseBulkSaveOptions): Promise<mongodb.BulkWriteResult>;
+    bulkSave(documents: Array<Document>, options?: MongooseBulkSaveOptions): Promise<MongooseBulkWriteResult>;
 
     /** Collection the model uses. */
     collection: Collection;
@@ -327,7 +333,7 @@ declare module 'mongoose' {
     /** Creates a `countDocuments` query: counts the number of documents that match `filter`. */
     countDocuments(
       filter?: RootFilterQuery<TRawDocType>,
-      options?: (mongodb.CountOptions & MongooseBaseQueryOptions<TRawDocType>) | null
+      options?: (mongodb.CountOptions & MongooseBaseQueryOptions<TRawDocType> & mongodb.Abortable) | null
     ): QueryWithHelpers<
       number,
       THydratedDocumentType,
@@ -419,6 +425,28 @@ declare module 'mongoose' {
       TInstanceMethods & TVirtuals
     >;
 
+    /** Adds a discriminator type. */
+    discriminator<TDiscriminatorSchema extends Schema<any, any>>(
+      name: string | number,
+      schema: TDiscriminatorSchema,
+      value?: string | number | ObjectId | DiscriminatorOptions
+    ): Model<
+      TRawDocType & InferSchemaType<TDiscriminatorSchema>,
+      TQueryHelpers & ObtainSchemaGeneric<TDiscriminatorSchema, 'TQueryHelpers'>,
+      TInstanceMethods & ObtainSchemaGeneric<TDiscriminatorSchema, 'TInstanceMethods'>,
+      TVirtuals & ObtainSchemaGeneric<TDiscriminatorSchema, 'TVirtuals'>
+    > & ObtainSchemaGeneric<TDiscriminatorSchema, 'TStaticMethods'>;
+    discriminator<D>(
+      name: string | number,
+      schema: Schema,
+      value?: string | number | ObjectId | DiscriminatorOptions
+    ): Model<D>;
+    discriminator<T, U>(
+      name: string | number,
+      schema: Schema<T, U>,
+      value?: string | number | ObjectId | DiscriminatorOptions
+    ): U;
+
     /**
      * Delete an existing [Atlas search index](https://www.mongodb.com/docs/atlas/atlas-search/create-index/) by name.
      * This function only works when connected to MongoDB Atlas.
@@ -462,7 +490,7 @@ declare module 'mongoose' {
     findOne<ResultDoc = THydratedDocumentType>(
       filter: RootFilterQuery<TRawDocType>,
       projection: ProjectionType<TRawDocType> | null | undefined,
-      options: QueryOptions<TRawDocType> & { lean: true }
+      options: QueryOptions<TRawDocType> & { lean: true } & mongodb.Abortable
     ): QueryWithHelpers<
       GetLeanResultType<TRawDocType, TRawDocType, 'findOne'> | null,
       ResultDoc,
@@ -474,7 +502,7 @@ declare module 'mongoose' {
     findOne<ResultDoc = THydratedDocumentType>(
       filter?: RootFilterQuery<TRawDocType>,
       projection?: ProjectionType<TRawDocType> | null,
-      options?: QueryOptions<TRawDocType> | null
+      options?: QueryOptions<TRawDocType> & mongodb.Abortable | null
     ): QueryWithHelpers<ResultDoc | null, ResultDoc, TQueryHelpers, TRawDocType, 'findOne', TInstanceMethods & TVirtuals>;
     findOne<ResultDoc = THydratedDocumentType>(
       filter?: RootFilterQuery<TRawDocType>,
@@ -693,7 +721,7 @@ declare module 'mongoose' {
     find<ResultDoc = THydratedDocumentType>(
       filter: RootFilterQuery<TRawDocType>,
       projection: ProjectionType<TRawDocType> | null | undefined,
-      options: QueryOptions<TRawDocType> & { lean: true }
+      options: QueryOptions<TRawDocType> & { lean: true } & mongodb.Abortable
     ): QueryWithHelpers<
       GetLeanResultType<TRawDocType, TRawDocType[], 'find'>,
       ResultDoc,
@@ -705,7 +733,7 @@ declare module 'mongoose' {
     find<ResultDoc = THydratedDocumentType>(
       filter: RootFilterQuery<TRawDocType>,
       projection?: ProjectionType<TRawDocType> | null | undefined,
-      options?: QueryOptions<TRawDocType> | null | undefined
+      options?: QueryOptions<TRawDocType> & mongodb.Abortable | null | undefined
     ): QueryWithHelpers<Array<ResultDoc>, ResultDoc, TQueryHelpers, TRawDocType, 'find', TInstanceMethods & TVirtuals>;
     find<ResultDoc = THydratedDocumentType>(
       filter: RootFilterQuery<TRawDocType>,
@@ -878,7 +906,7 @@ declare module 'mongoose' {
     replaceOne<ResultDoc = THydratedDocumentType>(
       filter?: RootFilterQuery<TRawDocType>,
       replacement?: TRawDocType | AnyObject,
-      options?: (mongodb.ReplaceOptions & MongooseQueryOptions<TRawDocType>) | null
+      options?: (mongodb.ReplaceOptions & QueryOptions<TRawDocType>) | null
     ): QueryWithHelpers<UpdateWriteOpResult, ResultDoc, TQueryHelpers, TRawDocType, 'replaceOne', TInstanceMethods & TVirtuals>;
 
     /** Apply changes made to this model's schema after this model was compiled. */

package/types/query.d.ts

@@ -31,19 +31,9 @@ declare module 'mongoose' {
     | 'strictQuery'
     | 'translateAliases';
 
-  type MongooseQueryOptions<
-    DocType = unknown,
-    Keys extends keyof QueryOptions<DocType> = MongooseBaseQueryOptionKeys | 'timestamps' | 'lean'
-  > = Pick<QueryOptions<DocType>, Keys> & {
-    [other: string]: any;
-  };
+  type MongooseBaseQueryOptions<DocType = unknown> = Pick<QueryOptions<DocType>, MongooseBaseQueryOptionKeys>;
 
-  type MongooseBaseQueryOptions<DocType = unknown> = MongooseQueryOptions<DocType, MongooseBaseQueryOptionKeys>;
-
-  type MongooseUpdateQueryOptions<DocType = unknown> = MongooseQueryOptions<
-    DocType,
-    MongooseBaseQueryOptionKeys | 'timestamps'
-  >;
+  type MongooseUpdateQueryOptions<DocType = unknown> = Pick<QueryOptions<DocType>, MongooseBaseQueryOptionKeys | 'timestamps'>;
 
   type ProjectionFields<DocType> = { [Key in keyof DocType]?: any } & Record<string, any>;
 
@@ -239,7 +229,7 @@ declare module 'mongoose' {
     : MergeType<ResultType, Paths>;
 
   class Query<ResultType, DocType, THelpers = {}, RawDocType = unknown, QueryOp = 'find', TDocOverrides = Record<string, never>> implements SessionOperation {
-    _mongooseOptions: MongooseQueryOptions<DocType>;
+    _mongooseOptions: QueryOptions<DocType>;
 
     /**
      * Returns a wrapper around a [mongodb driver cursor](https://mongodb.github.io/node-mongodb-native/4.9/classes/FindCursor.html).
@@ -634,7 +624,7 @@ declare module 'mongoose' {
      * Getter/setter around the current mongoose-specific options for this query
      * Below are the current Mongoose-specific options.
      */
-    mongooseOptions(val?: MongooseQueryOptions): MongooseQueryOptions;
+    mongooseOptions(val?: QueryOptions<DocType>): QueryOptions<DocType>;
 
     /** Specifies a `$ne` query condition. When called with one argument, the most recent path passed to `where()` is used. */
     ne<K = string>(path: K, val: any): this;

package/types/schematypes.d.ts

@@ -268,6 +268,9 @@ declare module 'mongoose' {
     /** Array containing default setters for all instances of this SchemaType */
     static setters: ((val?: unknown, priorVal?: unknown, doc?: Document<unknown>, options?: Record<string, any> | null) => unknown)[];
 
+    /** Contains the handlers for different query operators for this schema type. */
+    $conditionalHandlers: { [op: string]: (val: any, context: any) => any };
+
     /** The class that Mongoose uses internally to instantiate this SchemaType's `options` property. */
     OptionsConstructor: SchemaTypeOptions<T>;
 
@@ -350,7 +353,7 @@ declare module 'mongoose' {
     validateAll(validators: Array<RegExp | ValidatorFunction<DocType> | Validator<DocType>>): this;
 
     /** Default options for this SchemaType */
-    defaultOptions?: Record<string, any>;
+    static defaultOptions?: Record<string, any>;
   }
 
   namespace Schema {
@@ -368,7 +371,7 @@ declare module 'mongoose' {
         caster?: SchemaType;
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
 
         /**
          * Adds an enum validator if this is an array of strings or numbers. Equivalent to
@@ -382,7 +385,7 @@ declare module 'mongoose' {
         static schemaName: 'BigInt';
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
       }
 
       class Boolean extends SchemaType {
@@ -396,7 +399,7 @@ declare module 'mongoose' {
         static convertToFalse: Set<any>;
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
       }
 
       class Buffer extends SchemaType {
@@ -410,7 +413,7 @@ declare module 'mongoose' {
         subtype(subtype: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 128): this;
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
       }
 
       class Date extends SchemaType {
@@ -427,7 +430,7 @@ declare module 'mongoose' {
         min(value: NativeDate, message?: string): this;
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
       }
 
       class Decimal128 extends SchemaType {
@@ -435,7 +438,7 @@ declare module 'mongoose' {
         static schemaName: 'Decimal128';
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
       }
 
       class Int32 extends SchemaType {
@@ -443,7 +446,7 @@ declare module 'mongoose' {
         static schemaName: 'Int32';
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
       }
 
       class DocumentArray extends SchemaType implements AcceptsDiscriminator {
@@ -452,6 +455,8 @@ declare module 'mongoose' {
 
         static options: { castNonArrays: boolean; };
 
+        schemaOptions?: SchemaOptions;
+
         discriminator<D>(name: string | number, schema: Schema, value?: string): Model<D>;
         discriminator<T, U>(name: string | number, schema: Schema<T, U>, value?: string): U;
 
@@ -462,7 +467,7 @@ declare module 'mongoose' {
         caster?: typeof Types.Subdocument;
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
       }
 
       class Map extends SchemaType {
@@ -470,7 +475,7 @@ declare module 'mongoose' {
         static schemaName: 'Map';
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
       }
 
       class Mixed extends SchemaType {
@@ -478,7 +483,7 @@ declare module 'mongoose' {
         static schemaName: 'Mixed';
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
       }
 
       class Number extends SchemaType {
@@ -495,7 +500,7 @@ declare module 'mongoose' {
         min(value: number, message?: string): this;
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
       }
 
       class Double extends SchemaType {
@@ -503,7 +508,7 @@ declare module 'mongoose' {
         static schemaName: 'Double';
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
       }
 
       class ObjectId extends SchemaType {
@@ -514,7 +519,7 @@ declare module 'mongoose' {
         auto(turnOn: boolean): this;
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
       }
 
       class Subdocument<DocType = unknown> extends SchemaType implements AcceptsDiscriminator {
@@ -525,7 +530,7 @@ declare module 'mongoose' {
         schema: Schema;
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
 
         discriminator<T, U>(name: string | number, schema: Schema<T, U>, value?: string): U;
         discriminator<D>(name: string | number, schema: Schema, value?: string): Model<D>;
@@ -559,7 +564,7 @@ declare module 'mongoose' {
         uppercase(shouldApply?: boolean): this;
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
       }
 
       class UUID extends SchemaType {
@@ -567,7 +572,7 @@ declare module 'mongoose' {
         static schemaName: 'UUID';
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
       }
     }
   }