Merge branch '8.18' into vkarpov15/gh-10894

Author: vkarpov15

CHANGELOG.md

@@ -1,3 +1,19 @@
+8.17.2 / 2025-08-18
+===================
+ * fix: avoid Model.validate() hanging when all paths fail casting #15580 #15579 [piotracalski](https://github.com/piotracalski)
+ * types(document): better support for flattenObjectIds and versionKey options for toObject() and toJSON() #15582 #15578
+ * docs: fix docs jsdoc tags and add UUID to be listed #15585
+ * docs(document): fix code sample that errors with "Cannot set properties of undefined" #15589
+
+8.17.1 / 2025-08-07
+===================
+ * fix(query): propagate read preference and read concern to populate if read() called after populate() #15567 #15553
+ * fix(model): call correct function in autoSearchIndex #15569 #15565
+ * fix(model): allow setting statics option on discriminator schema #15568 #15556
+ * fix(model): remove unnecessary conversion of undefined -> null in findById #15566 #15551
+ * types: allow passing in projections without as const #15564 #15557
+ * types: support maxLength and minLength in SchemaTypeOptions #15570 #4720
+
 8.17.0 / 2025-07-30
 ===================
  * feat: upgrade mongodb -> 6.18.0 #15552

docs/source/api.js

@@ -29,6 +29,7 @@ const files = [
   'lib/schema/number.js',
   'lib/schema/objectId.js',
   'lib/schema/string.js',
+  'lib/schema/uuid.js',
   'lib/options/schemaTypeOptions.js',
   'lib/options/schemaArrayOptions.js',
   'lib/options/schemaBufferOptions.js',
@@ -42,7 +43,8 @@ const files = [
   'lib/types/buffer.js',
   'lib/types/decimal128.js',
   'lib/types/map.js',
-  'lib/types/array/methods/index.js'
+  'lib/types/array/methods/index.js',
+  'lib/types/uuid.js'
 ];
 
 /** @type {Map.<string, DocsObj>} */

docs/typescript/schemas.md

@@ -30,7 +30,7 @@ There are a few caveats for using automatic type inference:
 
 1. You need to set `strictNullChecks: true` or `strict: true` in your `tsconfig.json`. Or, if you're setting flags at the command line, `--strictNullChecks` or `--strict`. There are [known issues](https://github.com/Automattic/mongoose/issues/12420) with automatic type inference with strict mode disabled.
 2. You need to define your schema in the `new Schema()` call. Don't assign your schema definition to a temporary variable. Doing something like `const schemaDefinition = { name: String }; const schema = new Schema(schemaDefinition);` will not work.
-3. Mongoose adds `createdAt` and `updatedAt` to your schema if you specify the `timestamps` option in your schema, *except* if you also specify `methods`, `virtuals`, or `statics`. There is a [known issue](https://github.com/Automattic/mongoose/issues/12807) with type inference with timestamps and methods/virtuals/statics options. If you use methods, virtuals, and statics, you're responsible for adding `createdAt` and `updatedAt` to your schema definition.
+3. Mongoose adds `createdAt` and `updatedAt` to your schema if you specify the `timestamps` option in your schema.
 
 If you must define your schema separately, use [as const](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions) (`const schemaDefinition = { ... } as const;`) to prevent *type widening*. TypeScript will automatically widen types like `required: false` to `required: boolean`, which will cause Mongoose to assume the field is required. Using `as const` forces TypeScript to retain these types.
 

lib/document.js

@@ -4070,15 +4070,17 @@ Document.prototype.$__toObjectShallow = function $__toObjectShallow(schemaFields
  *
  * If you want to skip transformations, use `transform: false`:
  *
- *     schema.options.toObject.hide = '_id';
- *     schema.options.toObject.transform = function (doc, ret, options) {
- *       if (options.hide) {
- *         options.hide.split(' ').forEach(function (prop) {
- *           delete ret[prop];
- *         });
+ *     schema.options.toObject = {
+ *       hide: '_id',
+ *       transform: function(doc, ret, options) {
+ *         if (options.hide) {
+ *           options.hide.split(' ').forEach(function(prop) {
+ *             delete ret[prop];
+ *           });
+ *         }
+ *         return ret;
  *       }
- *       return ret;
- *     }
+ *     };
  *
  *     const doc = new Doc({ _id: 'anId', secret: 47, name: 'Wreck-it Ralph' });
  *     doc.toObject();                                        // { secret: 47, name: 'Wreck-it Ralph' }

lib/error/messages.js

@@ -43,5 +43,5 @@ msg.Date.max = 'Path `{PATH}` ({VALUE}) is after maximum allowed value ({MAX}).'
 msg.String = {};
 msg.String.enum = '`{VALUE}` is not a valid enum value for path `{PATH}`.';
 msg.String.match = 'Path `{PATH}` is invalid ({VALUE}).';
-msg.String.minlength = 'Path `{PATH}` (`{VALUE}`) is shorter than the minimum allowed length ({MINLENGTH}).';
-msg.String.maxlength = 'Path `{PATH}` (`{VALUE}`) is longer than the maximum allowed length ({MAXLENGTH}).';
+msg.String.minlength = 'Path `{PATH}` (`{VALUE}`, length {LENGTH}) is shorter than the minimum allowed length ({MINLENGTH}).';
+msg.String.maxlength = 'Path `{PATH}` (`{VALUE}`, length {LENGTH}) is longer than the maximum allowed length ({MAXLENGTH}).';

lib/model.js

@@ -4304,6 +4304,10 @@ Model.validate = async function validate(obj, pathsOrOptions, context) {
   let remaining = paths.size;
 
   return new Promise((resolve, reject) => {
+    if (remaining === 0) {
+      return settle();
+    }
+
     for (const path of paths) {
       const schemaType = schema.path(path);
       if (schemaType == null) {
@@ -4328,13 +4332,17 @@ Model.validate = async function validate(obj, pathsOrOptions, context) {
       }, context, { path: path });
     }
 
+    function settle() {
+      if (error) {
+        reject(error);
+      } else {
+        resolve(obj);
+      }
+    }
+
     function _checkDone() {
       if (--remaining <= 0) {
-        if (error) {
-          reject(error);
-        } else {
-          resolve(obj);
-        }
+        return settle();
       }
     }
   });

lib/schema/array.js

@@ -654,6 +654,8 @@ function cast$elemMatch(val, context) {
  * For example, `$conditionalHandlers.$all` is the function Mongoose calls to cast `$all` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaArray
+ * @instance
  * @api public
  */
 

lib/schema/bigint.js

@@ -100,7 +100,7 @@ SchemaBigInt.get = SchemaType.get;
  *
  * @param {Function} caster
  * @return {Function}
- * @function get
+ * @function cast
  * @static
  * @api public
  */
@@ -190,6 +190,8 @@ const $conditionalHandlers = {
  * For example, `$conditionalHandlers.$in` is the function Mongoose calls to cast `$in` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaBigInt
+ * @instance
  * @api public
  */
 

lib/schema/boolean.js

@@ -105,7 +105,7 @@ SchemaBoolean.get = SchemaType.get;
  *
  * @param {Function} caster
  * @return {Function}
- * @function get
+ * @function cast
  * @static
  * @api public
  */
@@ -242,6 +242,8 @@ const $conditionalHandlers = { ...SchemaType.prototype.$conditionalHandlers };
  * For example, `$conditionalHandlers.$in` is the function Mongoose calls to cast `$in` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaBoolean
+ * @instance
  * @api public
  */
 

lib/schema/buffer.js

@@ -276,6 +276,8 @@ const $conditionalHandlers = {
  * For example, `$conditionalHandlers.$exists` is the function Mongoose calls to cast `$exists` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaBuffer
+ * @instance
  * @api public
  */