mongoose 8.23.1 → 8.24.0

package/lib/aggregate.js

@@ -1027,7 +1027,7 @@ Aggregate.prototype.search = function(options) {
  *
  *     MyModel.aggregate().match({ test: 1 }).pipeline(); // [{ $match: { test: 1 } }]
  *
- * @return {Array} The current pipeline similar to the operation that will be executed
+ * @return {PipelineStage[]} The current pipeline similar to the operation that will be executed
  * @api public
  */
 
@@ -1035,6 +1035,29 @@ Aggregate.prototype.pipeline = function() {
   return this._pipeline;
 };
 
+/**
+ * Returns the current pipeline as a `$unionWith`-safe pipeline.
+ * Throws if this pipeline contains `$out` or `$merge`.
+ *
+ * #### Example:
+ *
+ *     const base = MyModel.aggregate().match({ test: 1 });
+ *     base.pipelineForUnionWith(); // [{ $match: { test: 1 } }]
+ *
+ * @return {PipelineStage[]} The current pipeline with `$unionWith` stage restrictions
+ * @api public
+ */
+
+Aggregate.prototype.pipelineForUnionWith = function pipelineForUnionWith() {
+  for (const stage of this._pipeline) {
+    if (stage?.$out != null || stage?.$merge != null) {
+      throw new MongooseError('Aggregate pipeline for $unionWith cannot include `$out` or `$merge` stages');
+    }
+  }
+
+  return this._pipeline;
+};
+
 /**
  * Executes the aggregate pipeline on the currently bound Model.
  *

package/lib/cursor/changeStream.js

@@ -114,7 +114,20 @@ class ChangeStream extends EventEmitter {
     if (this.errored) {
       throw new MongooseError('Cannot call hasNext() on errored ChangeStream');
     }
-    return this.driverChangeStream.hasNext(cb);
+
+    if (this.driverChangeStream != null) {
+      return this.driverChangeStream.hasNext(cb);
+    }
+
+    return this.$driverChangeStreamPromise.then(
+      () => this.driverChangeStream.hasNext(cb),
+      err => {
+        if (cb != null) {
+          return cb(err);
+        }
+        throw err;
+      }
+    );
   }
 
   next(cb) {
@@ -135,7 +148,20 @@ class ChangeStream extends EventEmitter {
         };
       }
 
-      let maybePromise = this.driverChangeStream.next(cb);
+      let maybePromise;
+      if (this.driverChangeStream != null) {
+        maybePromise = this.driverChangeStream.next(cb);
+      } else {
+        maybePromise = this.$driverChangeStreamPromise.then(
+          () => this.driverChangeStream.next(cb),
+          err => {
+            if (cb != null) {
+              return cb(err);
+            }
+            throw err;
+          }
+        );
+      }
       if (maybePromise && typeof maybePromise.then === 'function') {
         maybePromise = maybePromise.then(data => {
           if (data.fullDocument != null) {
@@ -147,7 +173,19 @@ class ChangeStream extends EventEmitter {
       return maybePromise;
     }
 
-    return this.driverChangeStream.next(cb);
+    if (this.driverChangeStream != null) {
+      return this.driverChangeStream.next(cb);
+    }
+
+    return this.$driverChangeStreamPromise.then(
+      () => this.driverChangeStream.next(cb),
+      err => {
+        if (cb != null) {
+          return cb(err);
+        }
+        throw err;
+      }
+    );
   }
 
   addListener(event, handler) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.23.1",
+  "version": "8.24.0",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -36,9 +36,9 @@
     "@typescript-eslint/eslint-plugin": "^8.19.1",
     "@typescript-eslint/parser": "^8.19.1",
     "acquit": "1.4.0",
-    "acquit-ignore": "0.2.1",
+    "acquit-ignore": "0.2.2",
     "acquit-require": "0.1.1",
-    "ajv": "8.17.1",
+    "ajv": "8.20.0",
     "assert-browserify": "2.0.0",
     "babel-loader": "8.2.5",
     "broken-link-checker": "^0.7.8",
@@ -70,7 +70,7 @@
     "tsd": "0.33.0",
     "typescript": "5.9.3",
     "uuid": "11.1.0",
-    "webpack": "5.102.1"
+    "webpack": "5.106.2"
   },
   "directories": {
     "lib": "./lib/mongoose"

package/types/aggregate.d.ts

@@ -123,6 +123,9 @@ declare module 'mongoose' {
     /** Returns the current pipeline */
     pipeline(): PipelineStage[];
 
+    /** Returns the current pipeline typed for use in `$unionWith` */
+    pipelineForUnionWith(): PipelineStage.UnionWithPipelineStage[];
+
     /** Appends a new $project operator to this aggregate pipeline. */
     project(arg: PipelineStage.Project['$project'] | string): this;
 

package/types/inferrawdoctype.d.ts

@@ -72,7 +72,7 @@ declare module 'mongoose' {
         : // If the type key isn't callable, then this is an array of objects, in which case
           // we need to call InferRawDocType to correctly infer its type.
           Array<InferRawDocType<Item>>
-      : IsSchemaTypeFromBuiltinClass<Item> extends true ? ResolveRawPathType<Item, { enum: Options['enum'] }, TypeKey>[]
+      : IsSchemaTypeFromBuiltinClass<Item> extends true ? ResolveRawPathType<Item, { enum: Exclude<Options['enum'], undefined> }, TypeKey>[]
       : IsItRecordAndNotAny<Item> extends true ?
         Item extends Record<string, never> ?
           ObtainRawDocumentPathType<Item, TypeKey>[]

package/types/inferschematype.d.ts

@@ -287,7 +287,7 @@ type ResolvePathType<
         : // If the type key isn't callable, then this is an array of objects, in which case
           // we need to call ObtainDocumentType to correctly infer its type.
           Types.DocumentArray<ObtainDocumentType<Item, any, { typeKey: TypeKey }>>
-      : IsSchemaTypeFromBuiltinClass<Item> extends true ? ResolvePathType<Item, { enum: Options['enum'] }, TypeKey>[]
+      : IsSchemaTypeFromBuiltinClass<Item> extends true ? ResolvePathType<Item, { enum: Exclude<Options['enum'], undefined> }, TypeKey>[]
       : IsItRecordAndNotAny<Item> extends true ?
         Item extends Record<string, never> ?
           ObtainDocumentPathType<Item, TypeKey>[]

package/types/pipelinestage.d.ts

@@ -115,6 +115,7 @@ declare module 'mongoose' {
     }
 
     export type FacetPipelineStage = Exclude<PipelineStage, PipelineStage.CollStats | PipelineStage.Facet | PipelineStage.GeoNear | PipelineStage.IndexStats | PipelineStage.Out | PipelineStage.Merge | PipelineStage.PlanCacheStats>;
+    export type UnionWithPipelineStage = Exclude<PipelineStage, PipelineStage.Out | PipelineStage.Merge>;
 
     export interface GeoNear {
       /** [`$geoNear` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/geoNear/) */
@@ -303,8 +304,8 @@ declare module 'mongoose' {
       /** [`$unionWith` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/unionWith/) */
       $unionWith:
       | string
-      | { coll: string; pipeline?: Exclude<PipelineStage, PipelineStage.Out | PipelineStage.Merge>[] }
-      | { coll?: string; pipeline: Exclude<PipelineStage, PipelineStage.Out | PipelineStage.Merge>[] }
+      | { coll: string; pipeline?: UnionWithPipelineStage[] }
+      | { coll?: string; pipeline: UnionWithPipelineStage[] }
     }
 
     export interface Unset {

package/types/schematypes.d.ts

@@ -110,7 +110,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?: DefaultType<T> | ((this: EnforcedDocType, doc: any) => DefaultType<T> | null | undefined) | null;
+    default?: DefaultType<T> | ((this: EnforcedDocType, doc: any) => DefaultType<T> | null | undefined) | null | undefined;
 
     /**
      * The model that `populate()` should use if populating this path.