mongoose 8.16.5 → 8.17.1

package/types/index.d.ts

@@ -91,7 +91,8 @@ declare module 'mongoose' {
       InferSchemaType<TSchema>,
       ObtainSchemaGeneric<TSchema, 'TVirtuals'> & ObtainSchemaGeneric<TSchema, 'TInstanceMethods'>,
       ObtainSchemaGeneric<TSchema, 'TQueryHelpers'>,
-      ObtainSchemaGeneric<TSchema, 'TVirtuals'>
+      ObtainSchemaGeneric<TSchema, 'TVirtuals'>,
+      ObtainSchemaGeneric<TSchema, 'TSchemaOptions'>
     >,
     TSchema
   > & ObtainSchemaGeneric<TSchema, 'TStaticMethods'>;
@@ -139,7 +140,7 @@ declare module 'mongoose' {
     ? IfAny<U, T & { _id: Types.ObjectId }, T & Required<{ _id: U }>>
     : T & { _id: Types.ObjectId };
 
-  export type Default__v<T> = T extends { __v?: infer U }
+  export type Default__v<T, TSchemaOptions = {}> = TSchemaOptions extends { versionKey: false } ? T : T extends { __v?: infer U }
     ? T
     : T & { __v: number };
 
@@ -148,17 +149,18 @@ declare module 'mongoose' {
     DocType,
     TOverrides = {},
     TQueryHelpers = {},
-    TVirtuals = {}
+    TVirtuals = {},
+    TSchemaOptions = {}
   > = IfAny<
     DocType,
     any,
     TOverrides extends Record<string, never> ?
-      Document<unknown, TQueryHelpers, DocType, TVirtuals> & Default__v<Require_id<DocType>> :
+      Document<unknown, TQueryHelpers, DocType, TVirtuals, TSchemaOptions> & Default__v<Require_id<DocType>, TSchemaOptions> :
       IfAny<
         TOverrides,
-        Document<unknown, TQueryHelpers, DocType, TVirtuals> & Default__v<Require_id<DocType>>,
-        Document<unknown, TQueryHelpers, DocType, TVirtuals> & MergeType<
-          Default__v<Require_id<DocType>>,
+        Document<unknown, TQueryHelpers, DocType, TVirtuals, TSchemaOptions> & Default__v<Require_id<DocType>, TSchemaOptions>,
+        Document<unknown, TQueryHelpers, DocType, TVirtuals, TSchemaOptions> & MergeType<
+          Default__v<Require_id<DocType>, TSchemaOptions>,
           TOverrides
         >
       >
@@ -196,10 +198,11 @@ declare module 'mongoose' {
     >;
 
   export type HydratedDocumentFromSchema<TSchema extends Schema> = HydratedDocument<
-  InferSchemaType<TSchema>,
-  ObtainSchemaGeneric<TSchema, 'TInstanceMethods'> & ObtainSchemaGeneric<TSchema, 'TVirtuals'>,
-  ObtainSchemaGeneric<TSchema, 'TQueryHelpers'>,
-  ObtainSchemaGeneric<TSchema, 'TVirtuals'>
+    InferSchemaType<TSchema>,
+    ObtainSchemaGeneric<TSchema, 'TInstanceMethods'> & ObtainSchemaGeneric<TSchema, 'TVirtuals'>,
+    ObtainSchemaGeneric<TSchema, 'TQueryHelpers'>,
+    ObtainSchemaGeneric<TSchema, 'TVirtuals'>,
+    ObtainSchemaGeneric<TSchema, 'TSchemaOptions'>
   >;
 
   export interface TagSet {
@@ -272,7 +275,7 @@ declare module 'mongoose' {
       ObtainDocumentType<any, RawDocType, ResolveSchemaOptions<TSchemaOptions>>,
       ResolveSchemaOptions<TSchemaOptions>
     >,
-    THydratedDocumentType = HydratedDocument<FlatRecord<DocType>, TVirtuals & TInstanceMethods, {}, TVirtuals>
+    THydratedDocumentType = HydratedDocument<FlatRecord<DocType>, TVirtuals & TInstanceMethods, {}, TVirtuals, ResolveSchemaOptions<TSchemaOptions>>
   >
     extends events.EventEmitter {
     /**
@@ -370,6 +373,8 @@ declare module 'mongoose' {
     /** Returns a new schema that has the `paths` from the original schema, minus the omitted ones. */
     omit<T = this>(paths: string[], options?: SchemaOptions): T;
 
+    options: SchemaOptions;
+
     /** Gets/sets schema paths. */
     path<ResultType extends SchemaType = SchemaType<any, THydratedDocumentType>>(path: string): ResultType;
     path<pathGeneric extends keyof RawDocType>(path: pathGeneric): SchemaType<RawDocType[pathGeneric]>;
@@ -602,7 +607,7 @@ declare module 'mongoose' {
     | typeof Schema.Types.UUID;
 
 
-  export type InferId<T> = T extends { _id?: any } ? T['_id'] : Types.ObjectId;
+  export type InferId<T> = mongodb.InferIdType<T>;
 
   export interface VirtualTypeOptions<HydratedDocType = Document, DocType = unknown> {
     /** If `ref` is not nullish, this becomes a populated virtual. */
@@ -699,9 +704,9 @@ declare module 'mongoose' {
           [K in keyof T]?: T[K] extends Record<string, any> ? Projector<T[K], Element> | Element : Element;
         }
         : Element;
-  type _IDType = { _id?: boolean | 1 | 0 };
+  type _IDType = { _id?: boolean | number };
   export type InclusionProjection<T> = IsItRecordAndNotAny<T> extends true
-    ? Omit<Projector<WithLevel1NestedPaths<T>, true | 1>, '_id'> & _IDType
+    ? Omit<Projector<WithLevel1NestedPaths<T>, boolean | number>, '_id'> & _IDType
     : AnyObject;
   export type ExclusionProjection<T> = IsItRecordAndNotAny<T> extends true
     ? Omit<Projector<WithLevel1NestedPaths<T>, false | 0>, '_id'> & _IDType
@@ -897,11 +902,6 @@ declare module 'mongoose' {
 
   export type SchemaDefinitionType<T> = T extends Document ? Omit<T, Exclude<keyof Document, '_id' | 'id' | '__v'>> : T;
 
-  /**
-   * Helper to choose the best option between two type helpers
-   */
-  export type _pickObject<T1, T2, Fallback> = T1 extends false ? T2 extends false ? Fallback : T2 : T1;
-
   /* for ts-mongoose */
   export class mquery { }
 

package/types/models.d.ts

@@ -273,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;
@@ -313,11 +312,11 @@ 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<MongooseBulkWriteResult>;
     bulkWrite<DocContents = TRawDocType>(
-      writes: Array<AnyBulkWriteOperation<DocContents extends Document ? any : (DocContents extends {} ? DocContents : any)>>,
+      writes: Array<AnyBulkWriteOperation<DocContents>>,
       options?: MongooseBulkWriteOptions
     ): Promise<MongooseBulkWriteResult>;
 
@@ -334,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,
@@ -426,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.
@@ -469,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,
@@ -481,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>,
@@ -700,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,
@@ -712,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>,
@@ -885,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

@@ -207,9 +207,11 @@ declare module 'mongoose' {
 
     /** If set, Mongoose will add a custom validator that ensures the given string's `length` is at least the given number. */
     minlength?: number | [number, string] | readonly [number, string];
+    minLength?: number | [number, string] | readonly [number, string];
 
     /** If set, Mongoose will add a custom validator that ensures the given string's `length` is at most the given number. */
     maxlength?: number | [number, string] | readonly [number, string];
+    maxLength?: number | [number, string] | readonly [number, string];
 
     [other: string]: any;
 
@@ -268,6 +270,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 +355,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 +373,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 +387,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 +401,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 +415,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 +432,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 +440,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 +448,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 +457,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 +469,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 +477,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 +485,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 +502,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 +510,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 +521,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 +532,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 +566,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 +574,7 @@ declare module 'mongoose' {
         static schemaName: 'UUID';
 
         /** Default options for this SchemaType */
-        defaultOptions: Record<string, any>;
+        static defaultOptions: Record<string, any>;
       }
     }
   }