mongoose 6.2.8 → 6.2.11

package/types/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference path="./aggregate.d.ts" />
 /// <reference path="./connection.d.ts" />
 /// <reference path="./cursor.d.ts" />
 /// <reference path="./document.d.ts" />
@@ -178,7 +179,7 @@ declare module 'mongoose' {
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface ClientSession extends mongodb.ClientSession { }
 
-   /*
+  /*
    * section collection.js
    * http://mongoosejs.com/docs/api.html#collection-js
    */
@@ -231,7 +232,9 @@ declare module 'mongoose' {
   }
 
   type AnyKeys<T> = { [P in keyof T]?: T[P] | any };
-  interface AnyObject { [k: string]: any }
+  interface AnyObject {
+    [k: string]: any
+  }
 
   type Require_id<T> = T extends { _id?: any } ? (T & { _id: T['_id'] }) : (T & { _id: Types.ObjectId });
 
@@ -246,7 +249,11 @@ declare module 'mongoose' {
 
   interface ModifyResult<T> {
     value: Require_id<T> | null;
-    lastErrorObject?: mongodb.Document;
+    /** see https://www.mongodb.com/docs/manual/reference/command/findAndModify/#lasterrorobject */
+    lastErrorObject?: {
+      updatedExisting?: boolean;
+      upserted?: mongodb.ObjectId;
+    };
     ok: 0 | 1;
   }
 
@@ -749,8 +756,6 @@ declare module 'mongoose' {
   type SchemaPreOptions = { document?: boolean, query?: boolean };
   type SchemaPostOptions = { document?: boolean, query?: boolean };
 
-  type ExtractVirtuals<M> = M extends Model<any, any, any, infer TVirtuals> ? TVirtuals : {};
-
   type IndexDirection = 1 | -1 | '2d' | '2dsphere' | 'geoHaystack' | 'hashed' | 'text';
   type IndexDefinition = Record<string, IndexDirection>;
 
@@ -906,23 +911,24 @@ declare module 'mongoose' {
   type SchemaDefinitionWithBuiltInClass<T> = T extends number
     ? NumberSchemaDefinition
     : T extends string
-    ? StringSchemaDefinition
-    : T extends boolean
-    ? BooleanSchemaDefinition
-    : T extends NativeDate
-    ? DateSchemaDefinition
-    : (Function | string);
+      ? StringSchemaDefinition
+      : T extends boolean
+        ? BooleanSchemaDefinition
+        : T extends NativeDate
+          ? DateSchemaDefinition
+          : (Function | string);
 
   type SchemaDefinitionProperty<T = undefined> = SchemaDefinitionWithBuiltInClass<T> |
-    SchemaTypeOptions<T extends undefined ? any : T> |
+  SchemaTypeOptions<T extends undefined ? any : T> |
     typeof SchemaType |
-    Schema<any, any, any> |
-    Schema<any, any, any>[] |
-    SchemaTypeOptions<T extends undefined ? any : Unpacked<T>>[] |
-    Function[] |
-    SchemaDefinition<T> |
-    SchemaDefinition<Unpacked<T>>[] |
-    typeof SchemaTypes.Mixed;
+  Schema<any, any, any> |
+  Schema<any, any, any>[] |
+  SchemaTypeOptions<T extends undefined ? any : Unpacked<T>>[] |
+  Function[] |
+  SchemaDefinition<T> |
+  SchemaDefinition<Unpacked<T>>[] |
+    typeof Schema.Types.Mixed |
+  MixedSchemaTypeOptions;
 
   type SchemaDefinition<T = undefined> = T extends undefined
     ? { [path: string]: SchemaDefinitionProperty; }
@@ -937,22 +943,26 @@ declare module 'mongoose' {
 
   type ExtractMongooseArray<T> = T extends Types.Array<any> ? AnyArray<Unpacked<T>> : T;
 
+  class MixedSchemaTypeOptions extends SchemaTypeOptions<Schema.Types.Mixed> {
+    type: typeof Schema.Types.Mixed;
+  }
+
   export class SchemaTypeOptions<T> {
     type?:
-      T extends string ? StringSchemaDefinition :
+    T extends string ? StringSchemaDefinition :
       T extends number ? NumberSchemaDefinition :
-      T extends boolean ? BooleanSchemaDefinition :
-      T extends NativeDate ? DateSchemaDefinition :
-      T extends Map<any, any> ? SchemaDefinition<typeof Map> :
-      T extends Buffer ? SchemaDefinition<typeof Buffer> :
-      T extends Types.ObjectId ? ObjectIdSchemaDefinition :
-      T extends Types.ObjectId[] ? AnyArray<ObjectIdSchemaDefinition> | AnyArray<SchemaTypeOptions<ObjectId>> :
-      T extends object[] ? (AnyArray<Schema<any, any, any>> | AnyArray<SchemaDefinition<Unpacked<T>>> | AnyArray<SchemaTypeOptions<Unpacked<T>>>) :
-      T extends string[] ? AnyArray<StringSchemaDefinition> | AnyArray<SchemaTypeOptions<string>> :
-      T extends number[] ? AnyArray<NumberSchemaDefinition> | AnyArray<SchemaTypeOptions<number>> :
-      T extends boolean[] ? AnyArray<BooleanSchemaDefinition> | AnyArray<SchemaTypeOptions<boolean>> :
-      T extends Function[] ? AnyArray<Function | string> | AnyArray<SchemaTypeOptions<Unpacked<T>>> :
-      T | typeof SchemaType | Schema<any, any, any> | SchemaDefinition<T> | Function | AnyArray<Function>;
+        T extends boolean ? BooleanSchemaDefinition :
+          T extends NativeDate ? DateSchemaDefinition :
+            T extends Map<any, any> ? SchemaDefinition<typeof Map> :
+              T extends Buffer ? SchemaDefinition<typeof Buffer> :
+                T extends Types.ObjectId ? ObjectIdSchemaDefinition :
+                  T extends Types.ObjectId[] ? AnyArray<ObjectIdSchemaDefinition> | AnyArray<SchemaTypeOptions<ObjectId>> :
+                    T extends object[] ? (AnyArray<Schema<any, any, any>> | AnyArray<SchemaDefinition<Unpacked<T>>> | AnyArray<SchemaTypeOptions<Unpacked<T>>>) :
+                      T extends string[] ? AnyArray<StringSchemaDefinition> | AnyArray<SchemaTypeOptions<string>> :
+                        T extends number[] ? AnyArray<NumberSchemaDefinition> | AnyArray<SchemaTypeOptions<number>> :
+                          T extends boolean[] ? AnyArray<BooleanSchemaDefinition> | AnyArray<SchemaTypeOptions<boolean>> :
+                            T extends Function[] ? AnyArray<Function | string> | AnyArray<SchemaTypeOptions<Unpacked<T>>> :
+                              T | typeof SchemaType | Schema<any, any, any> | SchemaDefinition<T> | Function | AnyArray<Function>;
 
     /** Defines a virtual with the given name that gets/sets this path. */
     alias?: string;
@@ -974,7 +984,7 @@ declare module 'mongoose' {
      * The default value for this path. If a function, Mongoose executes the function
      * and uses the return value as the default.
      */
-    default?: ExtractMongooseArray<T> | ((this: any, doc: any) => Partial<ExtractMongooseArray<T>>);
+    default?: T extends Schema.Types.Mixed ? ({} | ((this: any, doc: any) => any)) : (ExtractMongooseArray<T> | ((this: any, doc: any) => Partial<ExtractMongooseArray<T>>));
 
     /**
      * The model that `populate()` should use if populating this path.
@@ -1097,7 +1107,7 @@ declare module 'mongoose' {
   export type PopulatedDoc<
     PopulatedType,
     RawId extends RefType = (PopulatedType extends { _id?: RefType; } ? NonNullable<PopulatedType['_id']> : mongoose.Types.ObjectId) | undefined
-    > = PopulatedType | RawId;
+  > = PopulatedType | RawId;
 
   interface IndexOptions extends mongodb.CreateIndexesOptions {
     /**
@@ -1465,17 +1475,17 @@ declare module 'mongoose' {
     }
   }
 
-  type ReturnsNewDoc = { new: true } | { returnOriginal: false } | {returnDocument: 'after'};
+  type ReturnsNewDoc = { new: true } | { returnOriginal: false } | { returnDocument: 'after' };
 
   type QueryWithHelpers<ResultType, DocType, THelpers = {}, RawDocType = DocType> = Query<ResultType, DocType, THelpers, RawDocType> & THelpers;
 
-  type UnpackedIntersection<T, U> = T extends (infer A)[]
+  type UnpackedIntersection<T, U> = T extends null ? null : T extends (infer A)[]
     ? (Omit<A, keyof U> & U)[]
     : keyof U extends never
-    ? T
-  : Omit<T, keyof U> & U;
+      ? T
+      : Omit<T, keyof U> & U;
 
-  type ProjectionFields<DocType> = {[Key in keyof Omit<LeanDocument<DocType>, '__v'>]?: any} & Record<string, any>;
+  type ProjectionFields<DocType> = { [Key in keyof Omit<LeanDocument<DocType>, '__v'>]?: any } & Record<string, any>;
 
   class Query<ResultType, DocType, THelpers = {}, RawDocType = DocType> {
     _mongooseOptions: MongooseQueryOptions;
@@ -1774,8 +1784,8 @@ declare module 'mongoose' {
     polygon(path: string, ...coordinatePairs: number[][]): this;
 
     /** Specifies paths which should be populated with other documents. */
-    populate<Paths = {}>(path: string | string[], select?: string | any, model?: string | Model<any, THelpers>, match?: any): QueryWithHelpers<UnpackedIntersection<ResultType, Paths>, DocType, THelpers, RawDocType>;
-    populate<Paths = {}>(options: PopulateOptions | (PopulateOptions | string)[]): QueryWithHelpers<UnpackedIntersection<ResultType, Paths>, DocType, THelpers, RawDocType>;
+    populate<Paths = {}>(path: string | string[], select?: string | any, model?: string | Model<any, THelpers>, match?: any): QueryWithHelpers<UnpackedIntersection<ResultType, Paths>, DocType, THelpers, UnpackedIntersection<RawDocType, Paths>>;
+    populate<Paths = {}>(options: PopulateOptions | (PopulateOptions | string)[]): QueryWithHelpers<UnpackedIntersection<ResultType, Paths>, DocType, THelpers, UnpackedIntersection<RawDocType, Paths>>;
 
     /** Get/set the current projection (AKA fields). Pass `null` to remove the current projection. */
     projection(): ProjectionFields<DocType> | null;
@@ -1965,10 +1975,10 @@ declare module 'mongoose' {
     $or?: Array<FilterQuery<T>>;
     /** @see https://docs.mongodb.com/manual/reference/operator/query/text */
     $text?: {
-        $search: string;
-        $language?: string;
-        $caseSensitive?: boolean;
-        $diacriticSensitive?: boolean;
+      $search: string;
+      $language?: string;
+      $caseSensitive?: boolean;
+      $diacriticSensitive?: boolean;
     };
     /** @see https://docs.mongodb.com/manual/reference/operator/query/where/#op._S_where */
     $where?: string | Function;
@@ -1985,7 +1995,7 @@ declare module 'mongoose' {
   type _FilterQuery<T> = {
     [P in keyof T]?: Condition<T[P]>;
   } &
-    RootQuerySelector<T>;
+  RootQuerySelector<T>;
 
   /**
    * Filter query to select the documents that match the query
@@ -2032,21 +2042,21 @@ declare module 'mongoose' {
 
     /** @see https://docs.mongodb.com/manual/reference/operator/update-bitwise/ */
     $bit?: {
-        [key: string]: { [key in 'and' | 'or' | 'xor']?: number };
+      [key: string]: { [key in 'and' | 'or' | 'xor']?: number };
     };
   };
 
   type UpdateWithAggregationPipeline = UpdateAggregationStage[];
   type UpdateAggregationStage = { $addFields: any } |
-    { $set: any } |
-    { $project: any } |
-    { $unset: any } |
-    { $replaceRoot: any } |
-    { $replaceWith: any };
+  { $set: any } |
+  { $project: any } |
+  { $unset: any } |
+  { $replaceRoot: any } |
+  { $replaceWith: any };
 
   type __UpdateDefProperty<T> =
     [Extract<T, mongodb.ObjectId>] extends [never] ? T :
-    T | string;
+      T | string;
   type _UpdateQueryDef<T> = {
     [K in keyof T]?: __UpdateDefProperty<T[K]>;
   };
@@ -2062,28 +2072,28 @@ declare module 'mongoose' {
 
   export type DocumentDefinition<T> = {
     [K in keyof Omit<T, Exclude<keyof Document, '_id' | 'id' | '__v'>>]:
-      [Extract<T[K], mongodb.ObjectId>] extends [never]
+    [Extract<T[K], mongodb.ObjectId>] extends [never]
       ? T[K] extends TreatAsPrimitives
         ? T[K]
         : LeanDocumentElement<T[K]>
       : T[K] | string;
-    };
+  };
 
   export type FlattenMaps<T> = {
     [K in keyof T]: T[K] extends Map<any, any>
       ? AnyObject : T[K] extends TreatAsPrimitives
-      ? T[K] : FlattenMaps<T[K]>;
+        ? T[K] : FlattenMaps<T[K]>;
   };
 
   type actualPrimitives = string | boolean | number | bigint | symbol | null | undefined;
   type TreatAsPrimitives = actualPrimitives |
-    NativeDate | RegExp | symbol | Error | BigInt | Types.ObjectId;
+  NativeDate | RegExp | symbol | Error | BigInt | Types.ObjectId;
 
   type LeanType<T> =
     0 extends (1 & T) ? T : // any
-    T extends TreatAsPrimitives ? T : // primitives
-    T extends Types.Subdocument ? Omit<LeanDocument<T>, '$isSingleNested' | 'ownerDocument' | 'parent'> : // subdocs
-    LeanDocument<T>; // Documents and everything else
+      T extends TreatAsPrimitives ? T : // primitives
+        T extends Types.Subdocument ? Omit<LeanDocument<T>, '$isSingleNested' | 'ownerDocument' | 'parent'> : // subdocs
+          LeanDocument<T>; // Documents and everything else
 
   type LeanArray<T extends unknown[]> = T extends unknown[][] ? LeanArray<T[number]>[] : LeanType<T[number]>[];
 
@@ -2096,8 +2106,8 @@ declare module 'mongoose' {
   // This is required for PopulatedDoc.
   type LeanDocumentElement<T> =
     T extends unknown[] ? LeanArray<T> : // Array
-    T extends Document ? LeanDocument<T> : // Subdocument
-    T;
+      T extends Document ? LeanDocument<T> : // Subdocument
+        T;
 
   export type SchemaDefinitionType<T> = T extends Document ? Omit<T, Exclude<keyof Document, '_id' | 'id' | '__v'>> : T;
 
@@ -2110,160 +2120,13 @@ declare module 'mongoose' {
 
   export type LeanDocumentOrArray<T> = 0 extends (1 & T) ? T :
     T extends unknown[] ? LeanDocument<T[number]>[] :
-    T extends Document ? LeanDocument<T> :
-    T;
+      T extends Document ? LeanDocument<T> :
+        T;
 
   export type LeanDocumentOrArrayWithRawType<T, RawDocType> = 0 extends (1 & T) ? T :
     T extends unknown[] ? RawDocType[] :
-    T extends Document ? RawDocType :
-    T;
-
-  class Aggregate<R> {
-    /**
-     * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js
-     * You do not need to call this function explicitly, the JavaScript runtime
-     * will call it for you.
-     */
-    [Symbol.asyncIterator](): AsyncIterableIterator<Unpacked<R>>;
-
-    /**
-     * Sets an option on this aggregation. This function will be deprecated in a
-     * future release. */
-    addCursorFlag(flag: string, value: boolean): this;
-
-    /**
-     * Appends a new $addFields operator to this aggregate pipeline.
-     * Requires MongoDB v3.4+ to work
-     */
-    addFields(arg: PipelineStage.AddFields['$addFields']): this;
-
-    /** Sets the allowDiskUse option for the aggregation query (ignored for < 2.6.0) */
-    allowDiskUse(value: boolean): this;
-
-    /** Appends new operators to this aggregate pipeline */
-    append(...args: any[]): this;
-
-    /**
-     * Executes the query returning a `Promise` which will be
-     * resolved with either the doc(s) or rejected with the error.
-     * Like [`.then()`](#query_Query-then), but only takes a rejection handler.
-     */
-    catch: Promise<R>['catch'];
-
-    /** Adds a collation. */
-    collation(options: mongodb.CollationOptions): this;
-
-    /** Appends a new $count operator to this aggregate pipeline. */
-    count(countName: PipelineStage.Count['$count']): this;
-
-    /**
-     * Sets the cursor option for the aggregation query (ignored for < 2.6.0).
-     */
-    cursor<DocType = any>(options?: Record<string, unknown>): Cursor<DocType>;
-
-    /** Executes the aggregate pipeline on the currently bound Model. */
-    exec(callback?: Callback<R>): Promise<R>;
-
-    /** Execute the aggregation with explain */
-    explain(callback?: Callback): Promise<any>;
-    explain(verbosity?: string, callback?: Callback): Promise<any>;
-
-    /** Combines multiple aggregation pipelines. */
-    facet(options: PipelineStage.Facet['$facet']): this;
-
-    /** Appends new custom $graphLookup operator(s) to this aggregate pipeline, performing a recursive search on a collection. */
-    graphLookup(options: PipelineStage.GraphLookup['$graphLookup']): this;
-
-    /** Appends new custom $group operator to this aggregate pipeline. */
-    group(arg: PipelineStage.Group['$group']): this;
-
-    /** Sets the hint option for the aggregation query (ignored for < 3.6.0) */
-    hint(value: Record<string, unknown> | string): this;
-
-    /**
-     * Appends a new $limit operator to this aggregate pipeline.
-     * @param num maximum number of records to pass to the next stage
-     */
-    limit(num: PipelineStage.Limit['$limit']): this;
-
-    /** Appends new custom $lookup operator to this aggregate pipeline. */
-    lookup(options: PipelineStage.Lookup['$lookup']): this;
-
-    /**
-     * Appends a new custom $match operator to this aggregate pipeline.
-     * @param arg $match operator contents
-     */
-    match(arg: PipelineStage.Match['$match']): this;
-
-    /**
-     * Binds this aggregate to a model.
-     * @param model the model to which the aggregate is to be bound
-     */
-    model(model: any): this;
-
-    /**
-     * Append a new $near operator to this aggregation pipeline
-     * @param arg $near operator contents
-     */
-    near(arg: { near?: number[]; distanceField: string; maxDistance?: number; query?: Record<string, any>; includeLocs?: string; num?: number; uniqueDocs?: boolean }): this;
-
-    /** Returns the current pipeline */
-    pipeline(): any[];
-
-    /** Appends a new $project operator to this aggregate pipeline. */
-    project(arg: PipelineStage.Project['$project']): this;
-
-    /** Sets the readPreference option for the aggregation query. */
-    read(pref: string | mongodb.ReadPreferenceMode, tags?: any[]): this;
-
-    /** Sets the readConcern level for the aggregation query. */
-    readConcern(level: string): this;
-
-    /** Appends a new $redact operator to this aggregate pipeline. */
-    redact(expression: any, thenExpr: string | any, elseExpr: string | any): this;
-
-    /** Appends a new $replaceRoot operator to this aggregate pipeline. */
-    replaceRoot(newRoot: PipelineStage.ReplaceRoot['$replaceRoot']['newRoot'] | string): this;
-
-    /**
-     * Helper for [Atlas Text Search](https://docs.atlas.mongodb.com/reference/atlas-search/tutorial/)'s
-     * `$search` stage.
-     */
-    search(options: PipelineStage.Search['$search']): this;
-
-    /** Lets you set arbitrary options, for middleware or plugins. */
-    option(value: Record<string, unknown>): this;
-
-    /** Appends new custom $sample operator to this aggregate pipeline. */
-    sample(size: number): this;
-
-    /** Sets the session for this aggregation. Useful for [transactions](/docs/transactions.html). */
-    session(session: mongodb.ClientSession | null): this;
-
-    /**
-     * Appends a new $skip operator to this aggregate pipeline.
-     * @param num number of records to skip before next stage
-     */
-    skip(num: number): this;
-
-    /** Appends a new $sort operator to this aggregate pipeline. */
-    sort(arg: string | Record<string, SortValues> | PipelineStage.Sort['$sort']): this;
-
-    /** Provides promise for aggregate. */
-    then: Promise<R>['then'];
-
-    /**
-     * Appends a new $sortByCount operator to this aggregate pipeline. Accepts either a string field name
-     * or a pipeline object.
-     */
-    sortByCount(arg: string | any): this;
-
-    /** Appends new $unionWith operator to this aggregate pipeline. */
-    unionWith(options: any): this;
-
-    /** Appends new custom $unwind operator(s) to this aggregate pipeline. */
-    unwind(...args: PipelineStage.Unwind['$unwind'][]): this;
-  }
+      T extends Document ? RawDocType :
+        T;
 
   class SchemaType {
     /** SchemaType constructor */