mongoose 6.9.0 → 6.9.2

package/types/index.d.ts

@@ -493,7 +493,7 @@ declare module 'mongoose' {
   export type SortOrder = -1 | 1 | 'asc' | 'ascending' | 'desc' | 'descending';
 
   type _UpdateQuery<TSchema> = {
-    /** @see https://docs.mongodb.com/manual/reference/operator/update-field/ */
+    /** @see https://www.mongodb.com/docs/manual/reference/operator/update-field/ */
     $currentDate?: AnyKeys<TSchema> & AnyObject;
     $inc?: AnyKeys<TSchema> & AnyObject;
     $min?: AnyKeys<TSchema> & AnyObject;
@@ -504,14 +504,14 @@ declare module 'mongoose' {
     $setOnInsert?: AnyKeys<TSchema> & AnyObject;
     $unset?: AnyKeys<TSchema> & AnyObject;
 
-    /** @see https://docs.mongodb.com/manual/reference/operator/update-array/ */
+    /** @see https://www.mongodb.com/docs/manual/reference/operator/update-array/ */
     $addToSet?: AnyKeys<TSchema> & AnyObject;
     $pop?: AnyKeys<TSchema> & AnyObject;
     $pull?: AnyKeys<TSchema> & AnyObject;
     $push?: AnyKeys<TSchema> & AnyObject;
     $pullAll?: AnyKeys<TSchema> & AnyObject;
 
-    /** @see https://docs.mongodb.com/manual/reference/operator/update-bitwise/ */
+    /** @see https://www.mongodb.com/docs/manual/reference/operator/update-bitwise/ */
     // Needs to be `AnyKeys` for now, because anything stricter makes us incompatible
     // with the MongoDB Node driver's `UpdateFilter` interface (see gh-12595, gh-11911)
     // and using the Node driver's `$bit` definition breaks because their `OnlyFieldsOfType`

package/types/models.d.ts

@@ -140,7 +140,7 @@ declare module 'mongoose' {
     >
     > & ObtainSchemaGeneric<TSchema, 'TStaticMethods'>;
 
-    aggregate<R = any>(pipeline?: PipelineStage[], options?: mongodb.AggregateOptions, callback?: Callback<R[]>): Aggregate<Array<R>>;
+    aggregate<R = any>(pipeline?: PipelineStage[], options?: AggregateOptions, callback?: Callback<R[]>): Aggregate<Array<R>>;
     aggregate<R = any>(pipeline: PipelineStage[], callback?: Callback<R[]>): Aggregate<Array<R>>;
 
     /** Base Mongoose instance the model uses. */
@@ -269,7 +269,7 @@ declare module 'mongoose' {
     hydrate(obj: any, projection?: AnyObject, options?: { setters?: boolean }): HydratedDocument<T, TMethodsAndOverrides, TVirtuals>;
 
     /**
-     * This function is responsible for building [indexes](https://docs.mongodb.com/manual/indexes/),
+     * This function is responsible for building [indexes](https://www.mongodb.com/docs/manual/indexes/),
      * unless [`autoIndex`](http://mongoosejs.com/docs/guide.html#autoIndex) is turned off.
      * Mongoose calls this function automatically when a model is created using
      * [`mongoose.model()`](/docs/api/mongoose.html#mongoose_Mongoose-model) or
@@ -310,7 +310,7 @@ declare module 'mongoose' {
     validate(optional: any, callback?: CallbackWithoutResult): Promise<void>;
     validate(optional: any, pathsToValidate: PathsToValidate, callback?: CallbackWithoutResult): Promise<void>;
 
-    /** Watches the underlying collection for changes using [MongoDB change streams](https://docs.mongodb.com/manual/changeStreams/). */
+    /** Watches the underlying collection for changes using [MongoDB change streams](https://www.mongodb.com/docs/manual/changeStreams/). */
     watch<ResultType extends mongodb.Document = any>(pipeline?: Array<Record<string, unknown>>, options?: mongodb.ChangeStreamOptions & { hydrate?: boolean }): mongodb.ChangeStream<ResultType>;
 
     /** Adds a `$where` clause to this query */

package/types/mongooseoptions.d.ts

@@ -93,7 +93,7 @@ declare module 'mongoose' {
      */
     'timestamps.createdAt.immutable'?: boolean
 
-    /** If set, attaches [maxTimeMS](https://docs.mongodb.com/manual/reference/operator/meta/maxTimeMS/) to every query */
+    /** If set, attaches [maxTimeMS](https://www.mongodb.com/docs/manual/reference/operator/meta/maxTimeMS/) to every query */
     maxTimeMS?: number;
 
     /**

package/types/pipelinestage.d.ts

@@ -1,6 +1,6 @@
 declare module 'mongoose' {
   /**
-     * [Stages reference](https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/#aggregation-pipeline-stages)
+     * [Stages reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation-pipeline/#aggregation-pipeline-stages)
      */
   export type PipelineStage =
     | PipelineStage.AddFields
@@ -39,12 +39,12 @@ declare module 'mongoose' {
 
   export namespace PipelineStage {
     export interface AddFields {
-      /** [`$addFields` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/addFields/) */
+      /** [`$addFields` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/addFields/) */
       $addFields: Record<string, AnyExpression>
     }
 
     export interface Bucket {
-      /** [`$bucket` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/bucket/) */
+      /** [`$bucket` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/bucket/) */
       $bucket: {
         groupBy: Expression;
         boundaries: any[];
@@ -54,7 +54,7 @@ declare module 'mongoose' {
     }
 
     export interface BucketAuto {
-      /** [`$bucketAuto` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/bucketAuto/) */
+      /** [`$bucketAuto` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/bucketAuto/) */
       $bucketAuto: {
         groupBy: Expression | Record<string, Expression>;
         buckets: number;
@@ -64,7 +64,7 @@ declare module 'mongoose' {
     }
 
     export interface CollStats {
-      /** [`$collStats` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/collStats/) */
+      /** [`$collStats` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/collStats/) */
       $collStats: {
         latencyStats?: { histograms?: boolean };
         storageStats?: { scale?: number };
@@ -74,12 +74,12 @@ declare module 'mongoose' {
     }
 
     export interface Count {
-      /** [`$count` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/count/) */
+      /** [`$count` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/count/) */
       $count: string;
     }
 
     export interface Densify{
-      /** [`$densify` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/densify/) */
+      /** [`$densify` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/densify/) */
       $densify: {
         field: string,
         partitionByFields?: string[],
@@ -92,7 +92,7 @@ declare module 'mongoose' {
     }
 
     export interface Fill {
-      /** [`$fill` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/fill/) */
+      /** [`$fill` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/fill/) */
       $fill: {
         partitionBy?: Expression,
         partitionByFields?: string[],
@@ -102,14 +102,14 @@ declare module 'mongoose' {
     }
 
     export interface Facet {
-      /** [`$facet` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/facet/) */
+      /** [`$facet` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/facet/) */
       $facet: Record<string, FacetPipelineStage[]>;
     }
 
     export type FacetPipelineStage = Exclude<PipelineStage, PipelineStage.CollStats | PipelineStage.Facet | PipelineStage.GeoNear | PipelineStage.IndexStats | PipelineStage.Out | PipelineStage.Merge | PipelineStage.PlanCacheStats>;
 
     export interface GeoNear {
-      /** [`$geoNear` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/geoNear/) */
+      /** [`$geoNear` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/geoNear/) */
       $geoNear: {
         near: { type: 'Point'; coordinates: [number, number] } | [number, number];
         distanceField: string;
@@ -120,12 +120,16 @@ declare module 'mongoose' {
         minDistance?: number;
         query?: AnyObject;
         spherical?: boolean;
-        uniqueDocs?: boolean;
+        /**
+         * Deprecated. Use only with MondoDB below 4.2 (removed in 4.2)
+         * @deprecated
+         */
+        num?: number;
       }
     }
 
     export interface GraphLookup {
-      /** [`$graphLookup` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/graphLookup/) */
+      /** [`$graphLookup` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/graphLookup/) */
       $graphLookup: {
         from: string;
         startWith: any
@@ -139,27 +143,27 @@ declare module 'mongoose' {
     }
 
     export interface Group {
-      /** [`$group` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/group) */
+      /** [`$group` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/group) */
       $group: { _id: any } | { [key: string]: AccumulatorOperator }
     }
 
     export interface IndexStats {
-      /** [`$indexStats` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/indexStats/) */
+      /** [`$indexStats` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/indexStats/) */
       $indexStats: Record<string | number | symbol, never>;
     }
 
     export interface Limit {
-      /** [`$limit` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/limit/) */
+      /** [`$limit` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/limit/) */
       $limit: number
     }
 
     export interface ListSessions {
-      /** [`$listSessions` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/listSessions/) */
+      /** [`$listSessions` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/listSessions/) */
       $listSessions: { users?: { user: string; db: string }[] } | { allUsers?: true }
     }
 
     export interface Lookup {
-      /** [`$lookup` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/lookup/) */
+      /** [`$lookup` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/lookup/) */
       $lookup: {
         from: string
         as: string
@@ -171,12 +175,12 @@ declare module 'mongoose' {
     }
 
     export interface Match {
-      /** [`$match` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/match/) */
+      /** [`$match` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/match/) */
       $match: FilterQuery<any>;
     }
 
     export interface Merge {
-      /** [`$merge` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/merge/) */
+      /** [`$merge` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/merge/) */
       $merge: {
         into: string | { db: string; coll: string }
         on?: string | string[]
@@ -187,42 +191,42 @@ declare module 'mongoose' {
     }
 
     export interface Out {
-      /** [`$out` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/out/) */
+      /** [`$out` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/out/) */
       $out: string | { db: string; coll: string }
     }
 
     export interface PlanCacheStats {
-      /** [`$planCacheStats` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/planCacheStats/) */
+      /** [`$planCacheStats` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/planCacheStats/) */
       $planCacheStats: Record<string | number | symbol, never>
     }
 
     export interface Project {
-      /** [`$project` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/project/) */
+      /** [`$project` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/project/) */
       $project: { [field: string]: AnyExpression | Expression | Project['$project'] }
     }
 
     export interface Redact {
-      /** [`$redact` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/redact/) */
+      /** [`$redact` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/redact/) */
       $redact: Expression;
     }
 
     export interface ReplaceRoot {
-      /** [`$replaceRoot` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/replaceRoot/) */
+      /** [`$replaceRoot` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/replaceRoot/) */
       $replaceRoot: { newRoot: AnyExpression }
     }
 
     export interface ReplaceWith {
-      /** [`$replaceWith` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/replaceWith/) */
+      /** [`$replaceWith` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/replaceWith/) */
       $replaceWith: ObjectExpressionOperator | { [field: string]: Expression } | `$${string}`;
     }
 
     export interface Sample {
-      /** [`$sample` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/sample/) */
+      /** [`$sample` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/sample/) */
       $sample: { size: number }
     }
 
     export interface Search {
-      /** [`$search` reference](https://docs.atlas.mongodb.com/reference/atlas-search/query-syntax/) */
+      /** [`$search` reference](https://www.mongodb.com/docs/atlas/atlas-search/query-syntax/) */
       $search: {
         index?: string;
         highlight?: {
@@ -236,12 +240,12 @@ declare module 'mongoose' {
     }
 
     export interface Set {
-      /** [`$set` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/set/) */
+      /** [`$set` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/set/) */
       $set: Record<string, AnyExpression | any>
     }
 
     export interface SetWindowFields {
-      /** [`$setWindowFields` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/setWindowFields/) */
+      /** [`$setWindowFields` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/setWindowFields/) */
       $setWindowFields: {
         partitionBy?: any
         sortBy?: Record<string, 1 | -1>
@@ -259,34 +263,34 @@ declare module 'mongoose' {
     }
 
     export interface Skip {
-      /** [`$skip` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/skip/) */
+      /** [`$skip` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/skip/) */
       $skip: number
     }
 
     export interface Sort {
-      /** [`$sort` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/sort/) */
+      /** [`$sort` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/sort/) */
       $sort: Record<string, 1 | -1 | Expression.Meta>
     }
 
     export interface SortByCount {
-      /** [`$sortByCount` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/sortByCount/) */
+      /** [`$sortByCount` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/sortByCount/) */
       $sortByCount: Expression;
     }
 
     export interface UnionWith {
-      /** [`$unionWith` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/unionWith/) */
+      /** [`$unionWith` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/unionWith/) */
       $unionWith:
       | string
       | { coll: string; pipeline?: Exclude<PipelineStage, PipelineStage.Out | PipelineStage.Merge>[] }
     }
 
     export interface Unset {
-      /** [`$unset` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/unset/) */
+      /** [`$unset` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/unset/) */
       $unset: string | string[]
     }
 
     export interface Unwind {
-      /** [`$unwind` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/unwind/) */
+      /** [`$unwind` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/unwind/) */
       $unwind: string | { path: string; includeArrayIndex?: string; preserveNullAndEmptyArrays?: boolean }
     }
   }

package/types/query.d.ts

@@ -68,22 +68,22 @@ declare module 'mongoose' {
   };
 
   type RootQuerySelector<T> = {
-    /** @see https://docs.mongodb.com/manual/reference/operator/query/and/#op._S_and */
+    /** @see https://www.mongodb.com/docs/manual/reference/operator/query/and/#op._S_and */
     $and?: Array<FilterQuery<T>>;
-    /** @see https://docs.mongodb.com/manual/reference/operator/query/nor/#op._S_nor */
+    /** @see https://www.mongodb.com/docs/manual/reference/operator/query/nor/#op._S_nor */
     $nor?: Array<FilterQuery<T>>;
-    /** @see https://docs.mongodb.com/manual/reference/operator/query/or/#op._S_or */
+    /** @see https://www.mongodb.com/docs/manual/reference/operator/query/or/#op._S_or */
     $or?: Array<FilterQuery<T>>;
-    /** @see https://docs.mongodb.com/manual/reference/operator/query/text */
+    /** @see https://www.mongodb.com/docs/manual/reference/operator/query/text */
     $text?: {
       $search: string;
       $language?: string;
       $caseSensitive?: boolean;
       $diacriticSensitive?: boolean;
     };
-    /** @see https://docs.mongodb.com/manual/reference/operator/query/where/#op._S_where */
+    /** @see https://www.mongodb.com/docs/manual/reference/operator/query/where/#op._S_where */
     $where?: string | Function;
-    /** @see https://docs.mongodb.com/manual/reference/operator/query/comment/#op._S_comment */
+    /** @see https://www.mongodb.com/docs/manual/reference/operator/query/comment/#op._S_comment */
     $comment?: string;
     // we could not find a proper TypeScript generic to support nested queries e.g. 'user.friends.name'
     // this will mark all unrecognized properties as any (including nested queries)
@@ -292,7 +292,7 @@ declare module 'mongoose' {
     exists(val: boolean): this;
 
     /**
-     * Sets the [`explain` option](https://docs.mongodb.com/manual/reference/method/cursor.explain/),
+     * Sets the [`explain` option](https://www.mongodb.com/docs/manual/reference/method/cursor.explain/),
      * which makes this query return detailed execution stats instead of the actual
      * query result. This method is useful for determining what index your queries
      * use.
@@ -468,7 +468,7 @@ declare module 'mongoose' {
     maxScan(val: number): this;
 
     /**
-     * Sets the [maxTimeMS](https://docs.mongodb.com/manual/reference/method/cursor.maxTimeMS/)
+     * Sets the [maxTimeMS](https://www.mongodb.com/docs/manual/reference/method/cursor.maxTimeMS/)
      * option. This will tell the MongoDB server to abort if the query or write op
      * has been running for more than `ms` milliseconds.
      */
@@ -548,7 +548,7 @@ declare module 'mongoose' {
     /**
      * Declare and/or execute this query as a replaceOne() operation. Same as
      * `update()`, except MongoDB will replace the existing document and will
-     * not accept any [atomic](https://docs.mongodb.com/manual/tutorial/model-data-for-atomic-operations/#pattern) operators (`$set`, etc.)
+     * not accept any [atomic](https://www.mongodb.com/docs/manual/tutorial/model-data-for-atomic-operations/#pattern) operators (`$set`, etc.)
      */
     replaceOne(filter?: FilterQuery<DocType>, replacement?: DocType | AnyObject, options?: QueryOptions<DocType> | null, callback?: Callback): QueryWithHelpers<any, DocType, THelpers, RawDocType>;
 
@@ -565,7 +565,7 @@ declare module 'mongoose' {
     selectedInclusively(): boolean;
 
     /**
-     * Sets the [MongoDB session](https://docs.mongodb.com/manual/reference/server-sessions/)
+     * Sets the [MongoDB session](https://www.mongodb.com/docs/manual/reference/server-sessions/)
      * associated with this query. Sessions are how you mark a query as part of a
      * [transaction](/docs/transactions.html).
      */

package/types/schematypes.d.ts

@@ -28,7 +28,7 @@ declare module 'mongoose' {
   /**
    * The Mongoose ObjectId [SchemaType](/docs/schematypes.html). Used for
    * declaring paths in your schema that should be
-   * [MongoDB ObjectIds](https://docs.mongodb.com/manual/reference/method/ObjectId/).
+   * [MongoDB ObjectIds](https://www.mongodb.com/docs/manual/reference/method/ObjectId/).
    * Do not use this to create a new ObjectId instance, use `mongoose.Types.ObjectId`
    * instead.
    */

package/types/session.d.ts

@@ -5,8 +5,8 @@ declare module 'mongoose' {
   type ClientSession = mongodb.ClientSession;
 
   /**
-   * _Requires MongoDB >= 3.6.0._ Starts a [MongoDB session](https://docs.mongodb.com/manual/release-notes/3.6/#client-sessions)
-   * for benefits like causal consistency, [retryable writes](https://docs.mongodb.com/manual/core/retryable-writes/),
+   * _Requires MongoDB >= 3.6.0._ Starts a [MongoDB session](https://www.mongodb.com/docs/manual/release-notes/3.6/#client-sessions)
+   * for benefits like causal consistency, [retryable writes](https://www.mongodb.com/docs/manual/core/retryable-writes/),
    * and [transactions](http://thecodebarbarian.com/a-node-js-perspective-on-mongodb-4-transactions.html).
    */
   function startSession(options: ClientSessionOptions | undefined | null, callback: Callback<ClientSession>): void;
@@ -21,8 +21,8 @@ declare module 'mongoose' {
   interface SessionStarter {
 
     /**
-     * Starts a [MongoDB session](https://docs.mongodb.com/manual/release-notes/3.6/#client-sessions)
-     * for benefits like causal consistency, [retryable writes](https://docs.mongodb.com/manual/core/retryable-writes/),
+     * Starts a [MongoDB session](https://www.mongodb.com/docs/manual/release-notes/3.6/#client-sessions)
+     * for benefits like causal consistency, [retryable writes](https://www.mongodb.com/docs/manual/core/retryable-writes/),
      * and [transactions](http://thecodebarbarian.com/a-node-js-perspective-on-mongodb-4-transactions.html).
      */
     startSession(options: ClientSessionOptions | undefined | null, callback: Callback<ClientSession>): void;