mongoose 6.3.4 → 6.3.7

package/lib/schema/objectid.js

@@ -9,6 +9,7 @@ const SchemaType = require('../schematype');
 const castObjectId = require('../cast/objectid');
 const getConstructorName = require('../helpers/getConstructorName');
 const oid = require('../types/objectid');
+const isBsonType = require('../helpers/isBsonType');
 const utils = require('../utils');
 
 const CastError = SchemaType.CastError;
@@ -113,7 +114,7 @@ ObjectId.prototype.auto = function(turnOn) {
  * ignore
  */
 
-ObjectId._checkRequired = v => v instanceof oid;
+ObjectId._checkRequired = v => isBsonType(v, 'ObjectID');
 
 /*!
  * ignore
@@ -161,7 +162,7 @@ ObjectId.cast = function cast(caster) {
  */
 
 ObjectId._defaultCaster = v => {
-  if (!(v instanceof oid)) {
+  if (!(isBsonType(v, 'ObjectID'))) {
     throw new Error(v + ' is not an instance of ObjectId');
   }
   return v;
@@ -221,7 +222,7 @@ ObjectId.prototype.checkRequired = function checkRequired(value, doc) {
  */
 
 ObjectId.prototype.cast = function(value, doc, init) {
-  if (!(value instanceof oid) && SchemaType._isRef(this, value, doc, init)) {
+  if (!(isBsonType(value, 'ObjectID')) && SchemaType._isRef(this, value, doc, init)) {
     // wait! we may need to cast this to a document
     if ((getConstructorName(value) || '').toLowerCase() === 'objectid') {
       return new oid(value.toHexString());

package/lib/schema/string.js

@@ -4,12 +4,12 @@
  * Module dependencies.
  */
 
-const { BSONRegExp } = require('bson');
 const SchemaType = require('../schematype');
 const MongooseError = require('../error/index');
 const SchemaStringOptions = require('../options/SchemaStringOptions');
 const castString = require('../cast/string');
 const utils = require('../utils');
+const isBsonType = require('../helpers/isBsonType');
 
 const CastError = SchemaType.CastError;
 
@@ -677,7 +677,7 @@ SchemaString.prototype.castForQuery = function($conditional, val) {
     return handler.call(this, val);
   }
   val = $conditional;
-  if (Object.prototype.toString.call(val) === '[object RegExp]' || val instanceof BSONRegExp) {
+  if (Object.prototype.toString.call(val) === '[object RegExp]' || isBsonType(val, 'BSONRegExp')) {
     return val;
   }
 

package/lib/schema.js

@@ -473,9 +473,39 @@ Schema.prototype.defaultOptions = function(options) {
   return options;
 };
 
+/**
+ * Inherit a Schema by applying a discriminator on an existing Schema.
+ *
+ *
+ * ####Example:
+ *
+ *     const options = { discriminatorKey: 'kind' };
+ *
+ *     const eventSchema = new mongoose.Schema({ time: Date }, options);
+ *     const Event = mongoose.model('Event', eventSchema);
+ *
+ *     // ClickedLinkEvent is a special type of Event that has
+ *     // a URL.
+ *     const ClickedLinkEvent = Event.discriminator('ClickedLink',
+ *     new mongoose.Schema({ url: String }, options));
+ *
+ *     // When you create a generic event, it can't have a URL field...
+ *     const genericEvent = new Event({ time: Date.now(), url: 'google.com' });
+ *     assert.ok(!genericEvent.url);
+ *     // But a ClickedLinkEvent can
+ *     const clickedEvent = new ClickedLinkEvent({ time: Date.now(), url: 'google.com' });
+ *     assert.ok(clickedEvent.url);
+ *
+ * @param {String} name the name of the discriminator
+ * @param {Schema} schema the Schema of the discriminated Schema
+ * @return {Schema} the Schema instance
+ * @api public
+ */
+
 Schema.prototype.discriminator = function(name, schema) {
-  this._applyDiscriminators = {};
-  this._applyDiscriminators[name] = schema;
+  this._applyDiscriminators = Object.assign(this._applyDiscriminators || {}, { [name]: schema });
+
+  return this;
 };
 
 /**
@@ -1172,6 +1202,7 @@ Schema.prototype.interpretAsType = function(path, obj, options) {
   }
 
   if (type && type.instanceOfSchema) {
+
     return new MongooseTypes.Subdocument(type, path, obj);
   }
 

package/lib/schematype.js

@@ -1181,6 +1181,7 @@ SchemaType.prototype._castNullish = function _castNullish(v) {
 
 SchemaType.prototype.applySetters = function(value, scope, init, priorVal, options) {
   let v = this._applySetters(value, scope, init, priorVal, options);
+
   if (v == null) {
     return this._castNullish(v);
   }

package/lib/types/DocumentArray/methods/index.js

@@ -2,11 +2,11 @@
 
 const ArrayMethods = require('../../array/methods');
 const Document = require('../../../document');
-const ObjectId = require('../../objectid');
 const castObjectId = require('../../../cast/objectid');
 const getDiscriminatorByValue = require('../../../helpers/discriminator/getDiscriminatorByValue');
 const internalToObjectOptions = require('../../../options').internalToObjectOptions;
 const utils = require('../../../utils');
+const isBsonType = require('../../../helpers/isBsonType');
 
 const arrayParentSymbol = require('../../../helpers/symbols').arrayParentSymbol;
 const arrayPathSymbol = require('../../../helpers/symbols').arrayPathSymbol;
@@ -66,7 +66,7 @@ const methods = {
     // only objects are permitted so we can safely assume that
     // non-objects are to be interpreted as _id
     if (Buffer.isBuffer(value) ||
-        value instanceof ObjectId || !utils.isObject(value)) {
+        isBsonType(value, 'ObjectID') || !utils.isObject(value)) {
       value = { _id: value };
     }
 
@@ -134,7 +134,7 @@ const methods = {
         if (sid == _id._id) {
           return val;
         }
-      } else if (!(id instanceof ObjectId) && !(_id instanceof ObjectId)) {
+      } else if (!isBsonType(id, 'ObjectID') && !isBsonType(_id, 'ObjectID')) {
         if (id == _id || utils.deepEqual(id, _id)) {
           return val;
         }

package/lib/types/array/methods/index.js

@@ -3,10 +3,10 @@
 const Document = require('../../../document');
 const ArraySubdocument = require('../../ArraySubdocument');
 const MongooseError = require('../../../error/mongooseError');
-const ObjectId = require('../../objectid');
 const cleanModifiedSubpaths = require('../../../helpers/document/cleanModifiedSubpaths');
 const internalToObjectOptions = require('../../../options').internalToObjectOptions;
 const utils = require('../../../utils');
+const isBsonType = require('../../../helpers/isBsonType');
 
 const arrayAtomicsSymbol = require('../../../helpers/symbols').arrayAtomicsSymbol;
 const arrayParentSymbol = require('../../../helpers/symbols').arrayParentSymbol;
@@ -227,7 +227,7 @@ const methods = {
       // only objects are permitted so we can safely assume that
       // non-objects are to be interpreted as _id
       if (Buffer.isBuffer(value) ||
-          value instanceof ObjectId || !utils.isObject(value)) {
+          isBsonType(value, 'ObjectID') || !utils.isObject(value)) {
         value = { _id: value };
       }
 
@@ -469,7 +469,7 @@ const methods = {
    */
 
   indexOf(obj, fromIndex) {
-    if (obj instanceof ObjectId) {
+    if (isBsonType(obj, 'ObjectID')) {
       obj = obj.toString();
     }
 

package/lib/types/map.js

@@ -1,13 +1,13 @@
 'use strict';
 
 const Mixed = require('../schema/mixed');
-const ObjectId = require('./objectid');
 const clone = require('../helpers/clone');
 const deepEqual = require('../utils').deepEqual;
 const getConstructorName = require('../helpers/getConstructorName');
 const handleSpreadDoc = require('../helpers/document/handleSpreadDoc');
 const util = require('util');
 const specialProperties = require('../helpers/specialProperties');
+const isBsonType = require('../helpers/isBsonType');
 
 const populateModelSymbol = require('../helpers/symbols').populateModelSymbol;
 
@@ -43,7 +43,7 @@ class MongooseMap extends Map {
   }
 
   get(key, options) {
-    if (key instanceof ObjectId) {
+    if (isBsonType(key, 'ObjectID')) {
       key = key.toString();
     }
 
@@ -55,7 +55,7 @@ class MongooseMap extends Map {
   }
 
   set(key, value) {
-    if (key instanceof ObjectId) {
+    if (isBsonType(key, 'ObjectID')) {
       key = key.toString();
     }
 
@@ -117,7 +117,7 @@ class MongooseMap extends Map {
   }
 
   delete(key) {
-    if (key instanceof ObjectId) {
+    if (isBsonType(key, 'ObjectID')) {
       key = key.toString();
     }
 

package/lib/utils.js

@@ -6,7 +6,6 @@
 
 const ms = require('ms');
 const mpath = require('mpath');
-const Decimal = require('./types/decimal128');
 const ObjectId = require('./types/objectid');
 const PopulateOptions = require('./options/PopulateOptions');
 const clone = require('./helpers/clone');
@@ -307,7 +306,7 @@ exports.merge = function merge(to, from, options, path) {
             to[key] = from[key].clone();
           }
           continue;
-        } else if (from[key] instanceof ObjectId) {
+        } else if (isBsonType(from[key], 'ObjectID')) {
           to[key] = new ObjectId(from[key]);
           continue;
         }
@@ -481,7 +480,7 @@ exports.tick = function tick(callback) {
  */
 
 exports.isMongooseType = function(v) {
-  return v instanceof ObjectId || v instanceof Decimal || v instanceof Buffer;
+  return isBsonType(v, 'ObjectID') || isBsonType(v, 'Decimal128') || v instanceof Buffer;
 };
 
 exports.isMongooseObject = isMongooseObject;
@@ -795,7 +794,7 @@ exports.array.unique = function(arr) {
       }
       ret.push(item);
       primitives.add(item);
-    } else if (item instanceof ObjectId) {
+    } else if (isBsonType(item, 'ObjectID')) {
       if (ids.has(item.toString())) {
         continue;
       }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "6.3.4",
+  "version": "6.3.7",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -28,10 +28,9 @@
     "sift": "16.0.0"
   },
   "devDependencies": {
-    "@babel/core": "7.17.10",
-    "@babel/preset-env": "7.17.10",
-    "@typescript-eslint/eslint-plugin": "5.21.0",
-    "@typescript-eslint/parser": "5.21.0",
+    "@babel/core": "7.18.2",
+    "@typescript-eslint/eslint-plugin": "5.27.0",
+    "@typescript-eslint/parser": "5.27.0",
     "acquit": "1.2.1",
     "acquit-ignore": "0.2.0",
     "acquit-require": "0.1.1",
@@ -41,30 +40,31 @@
     "benchmark": "2.1.4",
     "bluebird": "3.7.2",
     "buffer": "^5.6.0",
-    "cheerio": "1.0.0-rc.10",
+    "cheerio": "1.0.0-rc.11",
     "crypto-browserify": "3.12.0",
     "dox": "0.3.1",
-    "eslint": "8.14.0",
+    "eslint": "8.16.0",
     "eslint-plugin-mocha-no-only": "1.1.1",
     "highlight.js": "11.5.1",
     "lodash.isequal": "4.5.0",
     "lodash.isequalwith": "4.4.0",
-    "marked": "4.0.14",
+    "marked": "4.0.16",
     "mkdirp": "^1.0.4",
     "mocha": "10.0.0",
     "moment": "2.x",
-    "mongodb-memory-server": "8.5.2",
+    "mongodb-memory-server": "8.6.0",
     "ncp": "^2.0.0",
     "nyc": "15.1.0",
     "pug": "3.0.2",
     "q": "1.5.1",
     "serve-handler": "6.1.3",
-    "sinon": "13.0.2",
+    "sinon": "14.0.0",
     "stream-browserify": "3.0.0",
+    "ts-benchmark": "^1.0.2",
     "tsd": "0.20.0",
-    "typescript": "4.6.4",
+    "typescript": "4.7.2",
     "uuid": "8.3.2",
-    "webpack": "5.72.0"
+    "webpack": "5.72.1"
   },
   "directories": {
     "lib": "./lib/mongoose"
@@ -96,8 +96,10 @@
     "test": "mocha --exit ./test/*.test.js",
     "test-rs": "START_REPLICA_SET=1 mocha --timeout 30000 --exit ./test/*.test.js",
     "test-tsd": "node ./test/types/check-types-filename && tsd",
-    "tdd": "mocha ./test/*.test.js ./test/typescript/main.test.js --inspect --watch --recursive --watch-files ./**/*.js",
-    "test-coverage": "nyc --reporter=html --reporter=text npm test"
+    "tdd": "mocha ./test/*.test.js --inspect --watch --recursive --watch-files ./**/*.{js,ts}",
+    "test-coverage": "nyc --reporter=html --reporter=text npm test",
+    "ts-benchmark": "ts-benchmark -p ./benchmarks/typescript/simple -f 17 18 29 32",
+    "ts-benchmark-watch": "ts-benchmark -p ./benchmarks/typescript/simple -w ./types -i -s -f 17 18 29 32 -b master"
   },
   "main": "./index.js",
   "types": "./types/index.d.ts",
@@ -143,4 +145,4 @@
       "target": "ES2017"
     }
   }
-}
+}

package/types/aggregate.d.ts

@@ -1,7 +1,8 @@
 declare module 'mongoose' {
   import mongodb = require('mongodb');
 
-  interface AggregateOptions {
+  interface AggregateOptions extends
+    SessionOption {
     /**
      * If true, the MongoDB server will use the hard drive to store data during this aggregation.
      */
@@ -56,8 +57,6 @@ declare module 'mongoose' {
      * The preferred read preference.
      */
     readPreference?: mongodb.ReadPreferenceLike;
-    /** The ClientSession for this aggregation */
-    session?: mongodb.ClientSession;
     /**
      * Specifies the write concern.
      */
@@ -65,7 +64,7 @@ declare module 'mongoose' {
     [key: string]: any;
   }
 
-  class Aggregate<R> {
+  class Aggregate<R> implements SessionOperation {
     /**
      * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js
      * You do not need to call this function explicitly, the JavaScript runtime

package/types/callback.d.ts

@@ -0,0 +1,8 @@
+declare module 'mongoose' {
+  type CallbackError = NativeError | null;
+
+  type Callback<T = any> = (error: CallbackError, result: T) => void;
+
+  type CallbackWithoutResult = (error: CallbackError) => void;
+  type CallbackWithoutResultAndOptionalError = (error?: CallbackError) => void;
+}

package/types/collection.d.ts

@@ -0,0 +1,46 @@
+declare module 'mongoose' {
+  import mongodb = require('mongodb');
+
+  /*
+   * section collection.js
+   * http://mongoosejs.com/docs/api.html#collection-js
+   */
+  interface CollectionBase<T extends mongodb.Document> extends mongodb.Collection<T> {
+    /*
+     * Abstract methods. Some of these are already defined on the
+     * mongodb.Collection interface so they've been commented out.
+     */
+    ensureIndex(...args: any[]): any;
+    findAndModify(...args: any[]): any;
+    getIndexes(...args: any[]): any;
+
+    /** The collection name */
+    collectionName: string;
+    /** The Connection instance */
+    conn: Connection;
+    /** The collection name */
+    name: string;
+  }
+
+  /*
+   * section drivers/node-mongodb-native/collection.js
+   * http://mongoosejs.com/docs/api.html#drivers-node-mongodb-native-collection-js
+   */
+  interface Collection<T extends mongodb.Document = mongodb.Document> extends CollectionBase<T> {
+    /**
+     * Collection constructor
+     * @param name name of the collection
+     * @param conn A MongooseConnection instance
+     * @param opts optional collection options
+     */
+    // eslint-disable-next-line @typescript-eslint/no-misused-new
+    new(name: string, conn: Connection, opts?: any): Collection<T>;
+    /** Formatter for debug print args */
+    $format(arg: any, color?: boolean, shell?: boolean): string;
+    /** Debug print helper */
+    $print(name: string, i: string | number, args: any[], color?: boolean, shell?: boolean): void;
+    /** Retrieves information about this collections indexes. */
+    getIndexes(): ReturnType<mongodb.Collection<T>['indexInformation']>;
+  }
+  let Collection: Collection;
+}