mongoose 7.6.0 → 7.6.2

package/lib/model.js

@@ -1060,40 +1060,45 @@ Model.prototype.$__deleteOne = function $__deleteOne(options, cb) {
 };
 
 /**
- * Returns another Model instance.
+ * Returns the model instance used to create this document if no `name` specified.
+ * If `name` specified, returns the model with the given `name`.
  *
  * #### Example:
  *
- *     const doc = new Tank;
- *     await doc.model('User').findById(id);
+ *     const doc = new Tank({});
+ *     doc.$model() === Tank; // true
+ *     await doc.$model('User').findById(id);
  *
- * @param {String} name model name
- * @method model
+ * @param {String} [name] model name
+ * @method $model
  * @api public
  * @return {Model}
  */
 
-Model.prototype.model = function model(name) {
+Model.prototype.$model = function $model(name) {
+  if (arguments.length === 0) {
+    return this.constructor;
+  }
   return this[modelDbSymbol].model(name);
 };
 
 /**
- * Returns another Model instance.
+ * Returns the model instance used to create this document if no `name` specified.
+ * If `name` specified, returns the model with the given `name`.
  *
  * #### Example:
  *
- *     const doc = new Tank;
- *     await doc.model('User').findById(id);
+ *     const doc = new Tank({});
+ *     doc.$model() === Tank; // true
+ *     await doc.$model('User').findById(id);
  *
- * @param {String} name model name
- * @method $model
+ * @param {String} [name] model name
+ * @method model
  * @api public
  * @return {Model}
  */
 
-Model.prototype.$model = function $model(name) {
-  return this[modelDbSymbol].model(name);
-};
+Model.prototype.model = Model.prototype.$model;
 
 /**
  * Returns a document with `_id` only if at least one document exists in the database that matches
@@ -3780,6 +3785,7 @@ Model.buildBulkWriteOperations = function buildBulkWriteOperations(documents, op
   }
 
   setDefaultOptions();
+  const discriminatorKey = this.schema.options.discriminatorKey;
 
   const writeOperations = documents.reduce((accumulator, document, i) => {
     if (!options.skipValidation) {
@@ -3810,6 +3816,12 @@ Model.buildBulkWriteOperations = function buildBulkWriteOperations(documents, op
 
       _applyCustomWhere(document, where);
 
+      // Set the discriminator key, so bulk write casting knows which
+      // schema to use re: gh-13907
+      if (document[discriminatorKey] != null && !(discriminatorKey in where)) {
+        where[discriminatorKey] = document[discriminatorKey];
+      }
+
       document.$__version(where, delta);
       const writeOperation = { updateOne: { filter: where, update: changes } };
       utils.injectTimestampsOption(writeOperation.updateOne, options.timestamps);
@@ -4752,8 +4764,6 @@ Model.compile = function compile(name, schema, collectionName, connection, base)
 
   schema._preCompile();
 
-  model.prototype.$__setSchema(schema);
-
   const _userProvidedOptions = schema._userProvidedOptions || {};
 
   const collectionOptions = {
@@ -4766,13 +4776,16 @@ Model.compile = function compile(name, schema, collectionName, connection, base)
     collectionOptions.autoCreate = schema.options.autoCreate;
   }
 
-  model.prototype.collection = connection.collection(
+  const collection = connection.collection(
     collectionName,
     collectionOptions
   );
 
-  model.prototype.$collection = model.prototype.collection;
-  model.prototype[modelCollectionSymbol] = model.prototype.collection;
+  model.prototype.collection = collection;
+  model.prototype.$collection = collection;
+  model.prototype[modelCollectionSymbol] = collection;
+
+  model.prototype.$__setSchema(schema);
 
   // apply methods and statics
   applyMethods(model, schema);
@@ -4781,8 +4794,8 @@ Model.compile = function compile(name, schema, collectionName, connection, base)
   applyStaticHooks(model, schema.s.hooks, schema.statics);
 
   model.schema = model.prototype.$__schema;
-  model.collection = model.prototype.collection;
-  model.$__collection = model.collection;
+  model.collection = collection;
+  model.$__collection = collection;
 
   // Create custom query constructor
   model.Query = function() {

package/lib/query.js

@@ -1680,7 +1680,7 @@ Query.prototype.setOptions = function(options, overwrite) {
 
 const printRawResultDeprecationWarning = util.deprecate(
   function printRawResultDeprecationWarning() {},
-  'The `rawResult` option for Mongoose queries is deprecated. Use `includeResultMetadata: false` as a replacement for `rawResult: true`.'
+  'The `rawResult` option for Mongoose queries is deprecated. Use `includeResultMetadata: true` as a replacement for `rawResult: true`.'
 );
 
 /*!

package/lib/schema/SubdocumentPath.js

@@ -55,6 +55,12 @@ function SubdocumentPath(schema, path, options) {
   this.$isSingleNested = true;
   this.base = schema.base;
   SchemaType.call(this, path, options, 'Embedded');
+
+  if (schema._applyDiscriminators != null) {
+    for (const disc of schema._applyDiscriminators.keys()) {
+      this.discriminator(disc, schema._applyDiscriminators.get(disc));
+    }
+  }
 }
 
 /*!

package/lib/schema/documentarray.js

@@ -88,6 +88,12 @@ function DocumentArrayPath(key, schema, options, schemaOptions) {
 
   this.$embeddedSchemaType.caster = this.Constructor;
   this.$embeddedSchemaType.schema = this.schema;
+
+  if (schema._applyDiscriminators != null) {
+    for (const disc of schema._applyDiscriminators.keys()) {
+      this.discriminator(disc, schema._applyDiscriminators.get(disc));
+    }
+  }
 }
 
 /**

package/lib/schema.js

@@ -37,6 +37,8 @@ const isPOJO = utils.isPOJO;
 
 let id = 0;
 
+const numberRE = /^\d+$/;
+
 /**
  * Schema constructor.
  *
@@ -723,19 +725,6 @@ Schema.prototype.add = function add(obj, prefix) {
         for (const key in val[0].discriminators) {
           schemaType.discriminator(key, val[0].discriminators[key]);
         }
-      } else if (val[0] != null && val[0].instanceOfSchema && val[0]._applyDiscriminators instanceof Map) {
-        const applyDiscriminators = val[0]._applyDiscriminators;
-        const schemaType = this.path(prefix + key);
-        for (const disc of applyDiscriminators.keys()) {
-          schemaType.discriminator(disc, applyDiscriminators.get(disc));
-        }
-      }
-      else if (val != null && val.instanceOfSchema && val._applyDiscriminators instanceof Map) {
-        const applyDiscriminators = val._applyDiscriminators;
-        const schemaType = this.path(prefix + key);
-        for (const disc of applyDiscriminators.keys()) {
-          schemaType.discriminator(disc, applyDiscriminators.get(disc));
-        }
       }
     } else if (Object.keys(val).length < 1) {
       // Special-case: {} always interpreted as Mixed path so leaf at this node
@@ -1017,7 +1006,7 @@ Schema.prototype.path = function(path, obj) {
 
     // subpaths?
     return /\.\d+\.?.*$/.test(path)
-      ? getPositionalPath(this, path)
+      ? getPositionalPath(this, path, cleanPath)
       : undefined;
   }
 
@@ -1634,7 +1623,7 @@ Schema.prototype.pathType = function(path) {
   }
 
   if (/\.\d+\.|\.\d+$/.test(path)) {
-    return getPositionalPathType(this, path);
+    return getPositionalPathType(this, path, cleanPath);
   }
   return 'adhocOrUndefined';
 };
@@ -1678,7 +1667,7 @@ Schema.prototype.setupTimestamp = function(timestamps) {
  * @api private
  */
 
-function getPositionalPathType(self, path) {
+function getPositionalPathType(self, path, cleanPath) {
   const subpaths = path.split(/\.(\d+)\.|\.(\d+)$/).filter(Boolean);
   if (subpaths.length < 2) {
     return self.paths.hasOwnProperty(subpaths[0]) ?
@@ -1729,7 +1718,7 @@ function getPositionalPathType(self, path) {
     val = val.schema.path(subpath);
   }
 
-  self.subpaths[path] = val;
+  self.subpaths[cleanPath] = val;
   if (val) {
     return 'real';
   }
@@ -1744,9 +1733,9 @@ function getPositionalPathType(self, path) {
  * ignore
  */
 
-function getPositionalPath(self, path) {
-  getPositionalPathType(self, path);
-  return self.subpaths[path];
+function getPositionalPath(self, path, cleanPath) {
+  getPositionalPathType(self, path, cleanPath);
+  return self.subpaths[cleanPath];
 }
 
 /**
@@ -2638,6 +2627,9 @@ Schema.prototype._getSchema = function(path) {
       // Re: gh-5628, because `schema.path()` doesn't take $ into account.
       parts[i] = '0';
     }
+    if (numberRE.test(parts[i])) {
+      parts[i] = '$';
+    }
   }
   return search(parts, _this);
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "7.6.0",
+  "version": "7.6.2",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -19,7 +19,7 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "bson": "^5.4.0",
+    "bson": "^5.5.0",
     "kareem": "2.5.1",
     "mongodb": "5.9.0",
     "mpath": "0.9.0",
@@ -39,7 +39,6 @@
     "axios": "1.1.3",
     "babel-loader": "8.2.5",
     "benchmark": "2.1.4",
-    "bluebird": "3.7.2",
     "broken-link-checker": "^0.7.8",
     "buffer": "^5.6.0",
     "cheerio": "1.0.0-rc.12",
@@ -130,14 +129,6 @@
   },
   "homepage": "https://mongoosejs.com",
   "browser": "./dist/browser.umd.js",
-  "mocha": {
-    "extension": [
-      "test.js"
-    ],
-    "watch-files": [
-      "test/**/*.js"
-    ]
-  },
   "config": {
     "mongodbMemoryServer": {
       "disablePostinstall": true

package/types/document.d.ts

@@ -75,6 +75,7 @@ declare module 'mongoose' {
 
     /** Returns the model with the given name on this document's associated connection. */
     $model<ModelType = Model<unknown>>(name: string): ModelType;
+    $model<ModelType = Model<DocType>>(): ModelType;
 
     /**
      * A string containing the current operation that Mongoose is executing
@@ -191,6 +192,10 @@ declare module 'mongoose' {
     markModified<T extends keyof DocType>(path: T, scope?: any): void;
     markModified(path: string, scope?: any): void;
 
+    /** Returns the model with the given name on this document's associated connection. */
+    model<ModelType = Model<unknown>>(name: string): ModelType;
+    model<ModelType = Model<DocType>>(): ModelType;
+
     /** Returns the list of paths that have been modified. */
     modifiedPaths(options?: { includeChildren?: boolean }): Array<string>;
 

package/types/inferschematype.d.ts

@@ -219,7 +219,7 @@ type ResolvePathType<PathValueType, Options extends SchemaTypeOptions<PathValueT
                                           PathValueType extends 'bigint' | 'BigInt' | typeof Schema.Types.BigInt ? bigint :
                                             PathValueType extends 'uuid' | 'UUID' | typeof Schema.Types.UUID ? Buffer :
                                               IfEquals<PathValueType, Schema.Types.UUID> extends true ? Buffer :
-                                                PathValueType extends MapConstructor ? Map<string, ResolvePathType<Options['of']>> :
+                                                PathValueType extends MapConstructor | 'Map' ? Map<string, ResolvePathType<Options['of']>> :
                                                   IfEquals<PathValueType, typeof Schema.Types.Map> extends true ? Map<string, ResolvePathType<Options['of']>> :
                                                     PathValueType extends ArrayConstructor ? any[] :
                                                       PathValueType extends typeof Schema.Types.Mixed ? any:

package/types/models.d.ts

@@ -32,7 +32,9 @@ declare module 'mongoose' {
     PopulateOption,
     SessionOption {
     limit?: number;
+    // @deprecated, use includeResultMetadata instead
     rawResult?: boolean;
+    includeResultMetadata?: boolean;
     ordered?: boolean;
     lean?: boolean;
     throwOnValidationError?: boolean;
@@ -360,6 +362,34 @@ declare module 'mongoose' {
     init(): Promise<THydratedDocumentType>;
 
     /** Inserts one or more new documents as a single `insertMany` call to the MongoDB server. */
+    insertMany(
+      docs: Array<TRawDocType>
+    ): Promise<Array<THydratedDocumentType>>;
+    insertMany(
+      docs: Array<TRawDocType>,
+      options: InsertManyOptions & { lean: true; }
+    ): Promise<Array<Require_id<TRawDocType>>>;
+    insertMany(
+      doc: Array<TRawDocType>,
+      options: InsertManyOptions & { ordered: false; rawResult: true; }
+    ): Promise<mongodb.InsertManyResult<Require_id<TRawDocType>> & {
+      mongoose: {
+        validationErrors: (CastError | Error.ValidatorError)[];
+        results: Array<
+          Error |
+          Object |
+          THydratedDocumentType
+        >
+      }
+    }>;
+    insertMany(
+      docs: Array<TRawDocType>,
+      options: InsertManyOptions & { lean: true, rawResult: true; }
+    ): Promise<mongodb.InsertManyResult<Require_id<TRawDocType>>>;
+    insertMany(
+      docs: Array<TRawDocType>,
+      options: InsertManyOptions & { rawResult: true; }
+    ): Promise<mongodb.InsertManyResult<Require_id<THydratedDocumentType>>>;
     insertMany<DocContents = TRawDocType>(
       docs: Array<DocContents | TRawDocType>,
       options: InsertManyOptions & { lean: true; }
@@ -373,7 +403,7 @@ declare module 'mongoose' {
       options: InsertManyOptions & { ordered: false; rawResult: true; }
     ): Promise<mongodb.InsertManyResult<Require_id<DocContents>> & {
       mongoose: {
-        validationErrors: Error[];
+        validationErrors: (CastError | Error.ValidatorError)[];
         results: Array<
           Error |
           Object |

package/types/query.d.ts

@@ -124,9 +124,14 @@ declare module 'mongoose' {
     overwriteDiscriminatorKey?: boolean;
     projection?: ProjectionType<DocType>;
     /**
+     * @deprecated use includeResultMetadata instead.
      * if true, returns the raw result from the MongoDB driver
      */
     rawResult?: boolean;
+    /**
+     * if ture, includes meta data for the result from the MongoDB driver
+     */
+    includeResultMetadata?: boolean;
     readPreference?: string | mongodb.ReadPreferenceMode;
     /**
      * An alias for the `new` option. `returnOriginal: false` is equivalent to `new: true`.

package/.eslintrc.js

@@ -1,236 +0,0 @@
-'use strict';
-
-module.exports = {
-  extends: [
-    'eslint:recommended'
-  ],
-  ignorePatterns: [
-    'tools',
-    'dist',
-    'website.js',
-    'test/files/*',
-    'benchmarks',
-    '*.min.js',
-    '**/docs/js/native.js',
-    '!.*',
-    'node_modules',
-    '.git'
-  ],
-  overrides: [
-    {
-      files: [
-        '**/*.{ts,tsx}',
-        '**/*.md/*.ts',
-        '**/*.md/*.typescript'
-      ],
-      extends: [
-        'plugin:@typescript-eslint/eslint-recommended',
-        'plugin:@typescript-eslint/recommended'
-      ],
-      plugins: [
-        '@typescript-eslint'
-      ],
-      rules: {
-        '@typescript-eslint/triple-slash-reference': 'off',
-        '@typescript-eslint/no-non-null-assertion': 'off',
-        '@typescript-eslint/no-empty-function': 'off',
-        'spaced-comment': [
-          'error',
-          'always',
-          {
-            block: {
-              markers: [
-                '!'
-              ],
-              balanced: true
-            },
-            markers: [
-              '/'
-            ]
-          }
-        ],
-        '@typescript-eslint/no-explicit-any': 'off',
-        '@typescript-eslint/ban-types': 'off',
-        '@typescript-eslint/no-unused-vars': 'off',
-        '@typescript-eslint/explicit-module-boundary-types': 'off',
-        '@typescript-eslint/indent': [
-          'warn',
-          2,
-          {
-            SwitchCase: 1,
-            ignoredNodes: ['TSTypeParameterInstantiation']
-          }
-        ],
-        '@typescript-eslint/prefer-optional-chain': 'error',
-        '@typescript-eslint/brace-style': 'error',
-        '@typescript-eslint/no-dupe-class-members': 'error',
-        '@typescript-eslint/no-redeclare': 'error',
-        '@typescript-eslint/type-annotation-spacing': 'error',
-        '@typescript-eslint/object-curly-spacing': [
-          'error',
-          'always'
-        ],
-        '@typescript-eslint/semi': 'error',
-        '@typescript-eslint/space-before-function-paren': [
-          'error',
-          'never'
-        ],
-        '@typescript-eslint/space-infix-ops': 'off'
-      }
-    },
-    {
-      files: [
-        '**/docs/js/**/*.js'
-      ],
-      env: {
-        node: false,
-        browser: true
-      }
-    }
-    // // eslint-plugin-markdown has been disabled because of out-standing issues, see https://github.com/eslint/eslint-plugin-markdown/issues/214
-    // {
-    //   files: ['**/*.md'],
-    //   processor: 'markdown/markdown'
-    // },
-    // {
-    //   files: ['**/*.md/*.js', '**/*.md/*.javascript', '**/*.md/*.ts', '**/*.md/*.typescript'],
-    //   parserOptions: {
-    //     ecmaFeatures: {
-    //       impliedStrict: true
-    //     },
-    //     sourceType: 'module', // required to allow "import" statements
-    //     ecmaVersion: 'latest' // required to allow top-level await
-    //   },
-    //   rules: {
-    //     'no-undef': 'off',
-    //     'no-unused-expressions': 'off',
-    //     'no-unused-vars': 'off',
-    //     'no-redeclare': 'off',
-    //     '@typescript-eslint/no-redeclare': 'off'
-    //   }
-    // }
-  ],
-  plugins: [
-    'mocha-no-only'
-    // 'markdown'
-  ],
-  parserOptions: {
-    ecmaVersion: 2020
-  },
-  env: {
-    node: true,
-    es6: true,
-    es2020: true
-  },
-  rules: {
-    'comma-style': 'error',
-    indent: [
-      'error',
-      2,
-      {
-        SwitchCase: 1,
-        VariableDeclarator: 2
-      }
-    ],
-    'keyword-spacing': 'error',
-    'no-whitespace-before-property': 'error',
-    'no-buffer-constructor': 'warn',
-    'no-console': 'off',
-    'no-constant-condition': 'off',
-    'no-multi-spaces': 'error',
-    'func-call-spacing': 'error',
-    'no-trailing-spaces': 'error',
-    'no-undef': 'error',
-    'no-unneeded-ternary': 'error',
-    'no-const-assign': 'error',
-    'no-useless-rename': 'error',
-    'no-dupe-keys': 'error',
-    'space-in-parens': [
-      'error',
-      'never'
-    ],
-    'spaced-comment': [
-      'error',
-      'always',
-      {
-        block: {
-          markers: [
-            '!'
-          ],
-          balanced: true
-        }
-      }
-    ],
-    'key-spacing': [
-      'error',
-      {
-        beforeColon: false,
-        afterColon: true
-      }
-    ],
-    'comma-spacing': [
-      'error',
-      {
-        before: false,
-        after: true
-      }
-    ],
-    'array-bracket-spacing': 1,
-    'arrow-spacing': [
-      'error',
-      {
-        before: true,
-        after: true
-      }
-    ],
-    'object-curly-spacing': [
-      'error',
-      'always'
-    ],
-    'comma-dangle': [
-      'error',
-      'never'
-    ],
-    'no-unreachable': 'error',
-    quotes: [
-      'error',
-      'single'
-    ],
-    'quote-props': [
-      'error',
-      'as-needed'
-    ],
-    semi: 'error',
-    'no-extra-semi': 'error',
-    'semi-spacing': 'error',
-    'no-spaced-func': 'error',
-    'no-throw-literal': 'error',
-    'space-before-blocks': 'error',
-    'space-before-function-paren': [
-      'error',
-      'never'
-    ],
-    'space-infix-ops': 'error',
-    'space-unary-ops': 'error',
-    'no-var': 'warn',
-    'prefer-const': 'warn',
-    strict: [
-      'error',
-      'global'
-    ],
-    'no-restricted-globals': [
-      'error',
-      {
-        name: 'context',
-        message: 'Don\'t use Mocha\'s global context'
-      }
-    ],
-    'no-prototype-builtins': 'off',
-    'mocha-no-only/mocha-no-only': [
-      'error'
-    ],
-    'no-empty': 'off',
-    'eol-last': 'warn',
-    'no-multiple-empty-lines': ['warn', { max: 2 }]
-  }
-};

package/.markdownlint-cli2.cjs

@@ -1,69 +0,0 @@
-'use strict';
-// this file is named ".cjs" instead of ".js" because markdownlint-cli2 only looks for ".cjs" or ".mjs"
-
-// use aliases instead of "MD000" naming
-
-module.exports = {
-  ignores: [
-    // the following are ignored because they are just redirects
-    'History.md',
-    'SECURITY.md',
-    'migrating_to_5.md', // this does not affect "docs/migrating_to_5.md"
-
-    // ignored for now, but should be changes later
-    '.github/PULL_REQUEST_TEMPLATE.md',
-
-    // ignore changelog because it uses different heading style than other documents and older versions use different formatting
-    'CHANGELOG.md',
-
-    // exclude node_modules because it isnt excluded by default
-    'node_modules'
-  ]
-};
-
-module.exports.config = {
-  // disable default rules
-  default: false,
-
-  // alt-text for images
-  accessibility: true,
-  // consistent blank lines
-  blank_lines: true,
-  // consistent unordered lists
-  bullet: { style: 'asterisk' },
-  // consistent and read-able code
-  code: true,
-  // consistent emphasis characters
-  emphasis: { style: 'asterisk' },
-  // ensure consistent header usage
-  headers: { style: 'atx' },
-  // ensure consistent "hr" usage
-  hr: { style: '---' },
-  // disable disalloing html tags, because
-  // mongoose currently uses html tags directly for heading ID's and style
-  html: false,
-  // consistent indentation
-  indentation: true,
-  // consistent links and good links
-  links: true,
-  // enabled by "links"
-  // mongoose currently does not wrap plain links in "<>"
-  'no-bare-urls': false,
-  // consistent ordered lists
-  ol: true,
-  // consistent whitespace usage
-  whitespace: true
-
-  // atx: undefined, // covered by "headers"
-  // atx_closed: undefined, // covered by "headers"
-  // blockquote: true, // covered by "whitespace"
-  // hard_tab: undefined, // covered by "whitespace"
-  // headings: undefined, // covered by "headers"
-  // images: true, // covered by "accessibility" and "links"
-  // language: undefined, // covered by "code"
-  // line_length: undefined, // mongoose currently uses a mix of max-line-length and relying on editor auto-wrap
-  // spaces: undefined, // covered by "atx", "atx_closed", "headers"
-  // spelling: undefined, // mongoose currently only uses short-form language specifiers and so does not need this
-  // ul: undefined, // covered by "whitespace" and "bullet"
-  // url: undefined, // covered by "links"
-};