mongoose 8.22.1 → 8.23.1

package/lib/document.js

@@ -4149,6 +4149,7 @@ Document.prototype.$__toObjectShallow = function $__toObjectShallow(schemaFields
  * @param {Boolean} [options.versionKey=true] if false, exclude the version key (`__v` by default) from the output
  * @param {Boolean} [options.flattenMaps=false] if true, convert Maps to POJOs. Useful if you want to `JSON.stringify()` the result of `toObject()`.
  * @param {Boolean} [options.flattenObjectIds=false] if true, convert any ObjectIds in the result to 24 character hex strings.
+ * @param {Boolean} [options.flattenUUIDs=false] if true, convert any UUIDs in the result to 36-character UUID strings in 8-4-4-4-12 format.
  * @param {Boolean} [options.useProjection=false] - If true, omits fields that are excluded in this document's projection. Unless you specified a projection, this will omit any field that has `select: false` in the schema.
  * @param {Boolean} [options.schemaFieldsOnly=false] - If true, the resulting object will only have fields that are defined in the document's schema. By default, `toObject()` returns all fields in the underlying document from MongoDB, including ones that are not listed in the schema.
  * @return {Object} document as a plain old JavaScript object (POJO). This object may contain ObjectIds, Maps, Dates, mongodb.Binary, Buffers, and other non-POJO values.
@@ -4421,6 +4422,7 @@ function omitDeselectedFields(self, json) {
  * @param {Object} options
  * @param {Boolean} [options.flattenMaps=true] if true, convert Maps to [POJOs](https://masteringjs.io/tutorials/fundamentals/pojo). Useful if you want to `JSON.stringify()` the result.
  * @param {Boolean} [options.flattenObjectIds=false] if true, convert any ObjectIds in the result to 24 character hex strings.
+ * @param {Boolean} [options.flattenUUIDs=false] if true, convert any UUIDs in the result to 36-character UUID strings in 8-4-4-4-12 format.
  * @param {Boolean} [options.schemaFieldsOnly=false] - If true, the resulting object will only have fields that are defined in the document's schema. By default, `toJSON()` returns all fields in the underlying document from MongoDB, including ones that are not listed in the schema.
  * @return {Object}
  * @see Document#toObject https://mongoosejs.com/docs/api/document.html#Document.prototype.toObject()

package/lib/helpers/clone.js

@@ -13,6 +13,9 @@ const symbols = require('./symbols');
 const trustedSymbol = require('./query/trusted').trustedSymbol;
 const BSON = require('bson');
 
+const Binary = BSON.Binary;
+const UUID = BSON.UUID;
+
 /**
  * Object clone with Mongoose natives support.
  *
@@ -45,6 +48,14 @@ function clone(obj, options, isArrayChild) {
 
   if (isMongooseObject(obj)) {
     if (options) {
+      if (options.flattenUUIDs) {
+        if (obj instanceof Binary && obj._subtype === Binary.SUBTYPE_UUID) {
+          return obj.toString();
+        }
+        if (obj?.isMongooseBuffer && obj._subtype === Binary.SUBTYPE_UUID) {
+          return obj.toUUID().toString();
+        }
+      }
       if (options.retainDocuments && obj.$__ != null) {
         const clonedDoc = obj.$clone();
         if (obj.__index != null) {
@@ -111,6 +122,13 @@ function clone(obj, options, isArrayChild) {
     return Decimal.fromString(obj.toString());
   }
 
+  if (obj instanceof UUID) {
+    if (options?.flattenUUIDs) {
+      return obj.toJSON();
+    }
+    return new UUID(obj.buffer);
+  }
+
   // object created with Object.create(null)
   if (!objConstructor && isObject(obj)) {
     return cloneObject(obj, options, isArrayChild);

package/lib/helpers/setDefaultsOnInsert.js

@@ -25,7 +25,7 @@ module.exports = function(filter, schema, castedDoc, options) {
   }
 
   const keys = Object.keys(castedDoc || {});
-  const updatedKeys = {};
+  const updatedKeys = Object.create(null);
   const updatedValues = {};
   const numKeys = keys.length;
 
@@ -58,6 +58,20 @@ module.exports = function(filter, schema, castedDoc, options) {
       }
     }
     updatedKeys[path] = true;
+    if (path.indexOf('.') === -1) {
+      continue;
+    }
+    // Also mark all parent prefixes so child-path lookups are O(1).
+    // e.g. 'extraProps.location' also marks 'extraProps'
+    const pieces = schema.paths[path] ?
+    // If the SchemaType already split for us, use that to avoid the extra overhead
+      schema.paths[path].splitPath() :
+      path.split('.');
+    let cur = pieces[0];
+    for (let j = 1; j < pieces.length; ++j) {
+      updatedKeys[cur] = true;
+      cur += '.' + pieces[j];
+    }
   }
 
   if (options && options.overwrite && !hasDollarUpdate) {

package/lib/model.js

@@ -3490,7 +3490,7 @@ Model.bulkWrite = async function bulkWrite(ops, options) {
       sort((v1, v2) => v1.index - v2.index).
       map(v => v.error);
 
-    const validOps = validOpIndexes.sort().map(index => ops[index]);
+    const validOps = validOpIndexes.sort((a, b) => a - b).map(index => ops[index]);
 
     if (validOps.length === 0) {
       if (options.throwOnValidationError && validationErrors.length) {

package/lib/options.js

@@ -13,5 +13,6 @@ exports.internalToObjectOptions = {
   flattenDecimals: false,
   useProjection: false,
   versionKey: true,
-  flattenObjectIds: false
+  flattenObjectIds: false,
+  flattenUUIDs: false
 };

package/lib/schema/string.js

@@ -474,12 +474,14 @@ SchemaString.prototype.maxlength = function(value, message) {
 
   if (value !== null && value !== undefined) {
     let msg = message || MongooseError.messages.String.maxlength;
-    msg = msg.replace(/{MAXLENGTH}/, value);
+    if (typeof msg !== 'function') {
+      msg = msg.replace(/{MAXLENGTH}/, value);
+    }
     this.validators.push({
       validator: this.maxlengthValidator = function(v) {
         return v === null || v.length <= value;
       },
-      message: msg,
+      message: formatMaxLengthValidatorMessage(msg),
       type: 'maxlength',
       maxlength: value
     });
@@ -731,3 +733,18 @@ SchemaString.prototype.autoEncryptionType = function autoEncryptionType() {
  */
 
 module.exports = SchemaString;
+
+function formatMaxLengthValidatorMessage(msg) {
+  return function(props, doc) {
+    if (typeof msg === 'function') {
+      return MongooseError.ValidatorError.prototype.formatMessage(msg, props, doc);
+    }
+
+    if (typeof msg === 'string' && typeof props.value === 'string' && props.value.length > 30) {
+      props = Object.assign({}, props, {
+        value: props.value.slice(0, 30) + '...'
+      });
+    }
+    return MongooseError.ValidatorError.prototype.formatMessage(msg, props, doc);
+  };
+}

package/lib/schemaType.js

@@ -1381,9 +1381,6 @@ SchemaType.prototype.doValidate = function(value, fn, scope, options) {
     validatorProperties.value = value;
     if (typeof value === 'string') {
       validatorProperties.length = value.length;
-      if (validatorProperties.value.length > 30) {
-        validatorProperties.value = validatorProperties.value.slice(0, 30) + '...';
-      }
     }
 
     if (validator instanceof RegExp) {
@@ -1508,9 +1505,6 @@ SchemaType.prototype.doValidateSync = function(value, scope, options) {
     validatorProperties.value = value;
     if (typeof value === 'string') {
       validatorProperties.length = value.length;
-      if (validatorProperties.value.length > 30) {
-        validatorProperties.value = validatorProperties.value.slice(0, 30) + '...';
-      }
     }
     let ok = false;
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.22.1",
+  "version": "8.23.1",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",

package/types/document.d.ts

@@ -258,33 +258,13 @@ declare module 'mongoose' {
     toBSON(): Require_id<DocType>;
 
     /** The return value of this method is used in calls to JSON.stringify(doc). */
-    toJSON(options: ToObjectOptions & { versionKey: false, virtuals: true, flattenObjectIds: true }): Omit<ObjectIdToString<FlattenMaps<Require_id<DocType & TVirtuals>>>, '__v'>;
-    toJSON(options: ToObjectOptions & { virtuals: true, flattenObjectIds: true }): ObjectIdToString<FlattenMaps<Default__v<Require_id<DocType & TVirtuals>, ResolveSchemaOptions<TSchemaOptions>>>>;
-    toJSON(options: ToObjectOptions & { versionKey: false, virtuals: true }): Omit<Require_id<DocType & TVirtuals>, '__v'>;
-    toJSON(options: ToObjectOptions & { versionKey: false, flattenObjectIds: true }): ObjectIdToString<FlattenMaps<Omit<Require_id<DocType>, '__v'>>>;
-    toJSON(options: ToObjectOptions & { virtuals: true }): Default__v<Require_id<DocType & TVirtuals>, ResolveSchemaOptions<TSchemaOptions>>;
-    toJSON(options: ToObjectOptions & { versionKey: false }): Omit<Require_id<DocType & TVirtuals>, '__v'>;
-    toJSON(options?: ToObjectOptions & { flattenMaps?: true, flattenObjectIds?: false }): FlattenMaps<Default__v<Require_id<DocType>, ResolveSchemaOptions<TSchemaOptions>>>;
-    toJSON(options: ToObjectOptions & { flattenObjectIds: false }): FlattenMaps<Default__v<Require_id<DocType>, ResolveSchemaOptions<TSchemaOptions>>>;
-    toJSON(options: ToObjectOptions & { flattenObjectIds: true }): ObjectIdToString<FlattenMaps<Default__v<Require_id<DocType>, ResolveSchemaOptions<TSchemaOptions>>>>;
-    toJSON(options: ToObjectOptions & { flattenMaps: false }): Default__v<Require_id<DocType>, ResolveSchemaOptions<TSchemaOptions>>;
-    toJSON(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: true }): ObjectIdToString<Default__v<Require_id<DocType>, ResolveSchemaOptions<TSchemaOptions>>>;
-
-    toJSON<T = Default__v<Require_id<DocType>, TSchemaOptions>>(options?: ToObjectOptions & { flattenMaps?: true, flattenObjectIds?: false }): FlattenMaps<T>;
-    toJSON<T = Default__v<Require_id<DocType>, TSchemaOptions>>(options: ToObjectOptions & { flattenObjectIds: false }): FlattenMaps<T>;
-    toJSON<T = Default__v<Require_id<DocType>, TSchemaOptions>>(options: ToObjectOptions & { flattenObjectIds: true }): ObjectIdToString<FlattenMaps<T>>;
-    toJSON<T = Default__v<Require_id<DocType>, TSchemaOptions>>(options: ToObjectOptions & { flattenMaps: false }): T;
-    toJSON<T = Default__v<Require_id<DocType>, TSchemaOptions>>(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: true }): ObjectIdToString<T>;
+    toJSON<O extends ToObjectOptions>(options: O): ToObjectReturnType<DocType, TVirtuals, O, TSchemaOptions>;
+    toJSON(): Default__v<Require_id<FlattenMaps<DocType>>, TSchemaOptions>;
+    toJSON<T>(options?: ToObjectOptions): Default__v<Require_id<T>, ResolveSchemaOptions<TSchemaOptions>>;
 
     /** Converts this document into a plain-old JavaScript object ([POJO](https://masteringjs.io/tutorials/fundamentals/pojo)). */
-    toObject(options: ToObjectOptions & { versionKey: false, virtuals: true, flattenObjectIds: true }): Omit<ObjectIdToString<Require_id<DocType & TVirtuals>>, '__v'>;
-    toObject(options: ToObjectOptions & { virtuals: true, flattenObjectIds: true }): ObjectIdToString<Default__v<Require_id<DocType & TVirtuals>, ResolveSchemaOptions<TSchemaOptions>>>;
-    toObject(options: ToObjectOptions & { versionKey: false, flattenObjectIds: true }): Omit<ObjectIdToString<Require_id<DocType & TVirtuals>>, '__v'>;
-    toObject(options: ToObjectOptions & { versionKey: false, virtuals: true }): Omit<Require_id<DocType & TVirtuals>, '__v'>;
-    toObject(options: ToObjectOptions & { virtuals: true }): Default__v<Require_id<DocType & TVirtuals>, ResolveSchemaOptions<TSchemaOptions>>;
-    toObject(options: ToObjectOptions & { versionKey: false }): Omit<Require_id<DocType & TVirtuals>, '__v'>;
-    toObject(options: ToObjectOptions & { flattenObjectIds: true }): ObjectIdToString<Default__v<Require_id<DocType & TVirtuals>, ResolveSchemaOptions<TSchemaOptions>>>;
-    toObject(options?: ToObjectOptions): Default__v<Require_id<DocType>, ResolveSchemaOptions<TSchemaOptions>>;
+    toObject<O extends ToObjectOptions>(options: O): ToObjectReturnType<DocType, TVirtuals, O, TSchemaOptions>;
+    toObject(): Default__v<Require_id<DocType>, TSchemaOptions>;
     toObject<T>(options?: ToObjectOptions): Default__v<Require_id<T>, ResolveSchemaOptions<TSchemaOptions>>;
 
     /** Clears the modified state on the specified path. */

package/types/index.d.ts

@@ -230,6 +230,8 @@ declare module 'mongoose' {
     flattenMaps?: boolean;
     /** if true, convert any ObjectIds in the result to 24 character hex strings. */
     flattenObjectIds?: boolean;
+    /** if true, convert any UUIDs in the result to 36 character hex strings. */
+    flattenUUIDs?: boolean;
     /** apply all getters (path and virtual getters) */
     getters?: boolean;
     /** remove empty objects (defaults to true) */
@@ -854,6 +856,35 @@ declare module 'mongoose' {
                     : BufferToBinary<T[K]>;
           } : T;
 
+  /**
+   * Converts any UUID properties into strings for JSON serialization
+   */
+  export type UUIDToString<T> = T extends Types.UUID
+    ? string
+    : T extends mongodb.UUID
+      ? string
+      : T extends Document
+        ? T
+        : T extends TreatAsPrimitives
+          ? T
+          : T extends Record<string, any> ? {
+            [K in keyof T]: T[K] extends Types.UUID
+              ? string
+              : T[K] extends mongodb.UUID
+                ? string
+                : T[K] extends Types.DocumentArray<infer ItemType>
+                    ? Types.DocumentArray<UUIDToString<ItemType>>
+                    : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
+                      ? HydratedSingleSubdocument<UUIDToString<SubdocType>>
+                      : UUIDToString<T[K]>;
+          } : T;
+
+  /**
+   * Alias for UUIDToString for backwards compatibility.
+   * @deprecated Use UUIDToString instead.
+   */
+  export type UUIDToJSON<T> = UUIDToString<T>;
+
   /**
    * Converts any ObjectId properties into strings for JSON serialization
    */
@@ -913,12 +944,85 @@ declare module 'mongoose' {
     FlattenMaps<
       BufferToJSON<
         ObjectIdToString<
-          DateToString<T>
+          UUIDToString<
+            DateToString<T>
+          >
         >
       >
     >
   >;
 
+  /**
+   * Helper types for computing toObject/toJSON return types based on options.
+   * These compose transforms conditionally to avoid combinatorial explosion of overloads.
+   */
+  type ApplyVirtuals<T, TVirtuals, O> =
+    O extends { virtuals: true } ? T & TVirtuals : T;
+
+  type GetVersionKeyName<TSchemaOptions> =
+    TSchemaOptions extends { versionKey: infer VK }
+      ? VK extends string ? VK : '__v'
+      : '__v';
+
+  type ApplyVersionKey<T, O, TSchemaOptions = {}> =
+    O extends { versionKey: false } ? Omit<T, GetVersionKeyName<TSchemaOptions>> : T;
+
+  /**
+   * Single-pass type that applies all flatten transforms (flattenMaps, flattenObjectIds, flattenUUIDs)
+   * in one recursive traversal. This avoids TypeScript's "union type too complex" error that occurs
+   * when nesting separate recursive transform types.
+   *
+   * By handling all transforms in one pass, we correctly handle ObjectIds/UUIDs nested inside Maps
+   * since we recurse into Map values during the same traversal that converts ObjectIds/UUIDs.
+   */
+  type ApplyFlattenTransforms<T, O> =
+    // Handle ObjectId first (before TreatAsPrimitives since ObjectId is in TreatAsPrimitives)
+    T extends mongodb.ObjectId
+      ? O extends { flattenObjectIds: true } ? string : T
+    // Handle UUID (both Types.UUID and mongodb.UUID)
+    : T extends Types.UUID
+      ? O extends { flattenUUIDs: true } ? string : T
+    : T extends mongodb.UUID
+      ? O extends { flattenUUIDs: true } ? string : T
+    // Handle Map - flatten to Record and recurse into values
+    : T extends Map<any, infer V>
+      ? O extends { flattenMaps: true }
+        ? Record<string, ApplyFlattenTransforms<V, O>>
+        : T
+    // Don't recurse into Documents
+    : T extends Document
+      ? T
+    // Don't modify primitives
+    : T extends TreatAsPrimitives
+      ? T
+    // Handle DocumentArray - recurse into items
+    : T extends Types.DocumentArray<infer ItemType>
+      ? Types.DocumentArray<ApplyFlattenTransforms<ItemType, O>>
+    // Handle Subdocument - recurse into subdoc type
+    : T extends Types.Subdocument<unknown, unknown, infer SubdocType>
+      ? HydratedSingleSubdocument<ApplyFlattenTransforms<SubdocType, O>>
+    // Handle regular objects - recurse into properties
+    : T extends Record<string, any>
+      ? { [K in keyof T]: ApplyFlattenTransforms<T[K], O> }
+    : T;
+
+  /**
+   * Computes the return type of toObject/toJSON based on the provided options.
+   * Uses a single-pass transform for flatten operations to correctly handle all combinations.
+   */
+  export type ToObjectReturnType<DocType, TVirtuals, O extends ToObjectOptions, TSchemaOptions = {}> =
+    ApplyVersionKey<
+      Default__v<
+        ApplyFlattenTransforms<
+          ApplyVirtuals<Require_id<DocType>, TVirtuals, O>,
+          O
+        >,
+        TSchemaOptions
+      >,
+      O,
+      TSchemaOptions
+    >;
+
   /**
    * Separate type is needed for properties of union type (for example, Types.DocumentArray | undefined) to apply conditional check to each member of it
    * https://www.typescriptlang.org/docs/handbook/2/conditional-types.html#distributive-conditional-types

package/types/inferschematype.d.ts

@@ -103,7 +103,12 @@ declare module 'mongoose' {
       }[alias]
     : unknown;
 
-  type ResolveSchemaOptions<T> = MergeType<DefaultSchemaOptions, T>;
+  type TypesAreEqual<A, B> = [A] extends [B] ? [B] extends [A] ? true : false : false;
+
+  type ResolveSchemaOptions<T> =
+    keyof T extends never ? DefaultSchemaOptions :
+    TypesAreEqual<T, DefaultSchemaOptions> extends true ? DefaultSchemaOptions :
+    MergeType<DefaultSchemaOptions, T>;
 
   type ApplySchemaOptions<T, O = DefaultSchemaOptions> = ResolveTimestamps<T, O>;