feat(schema): add BigInt support, upgrade mongodb -> 5.3.0

.eslintrc.js

@@ -116,7 +116,8 @@ module.exports = {
   },
   env: {
     node: true,
-    es6: true
+    es6: true,
+    es2020: true
   },
   rules: {
     'comma-style': 'error',

lib/cast/bigint.js

@@ -0,0 +1,31 @@
+'use strict';
+
+const assert = require('assert');
+
+/**
+ * Given a value, cast it to a BigInt, or throw an `Error` if the value
+ * cannot be casted. `null` and `undefined` are considered valid.
+ *
+ * @param {Any} value
+ * @return {Number}
+ * @throws {Error} if `value` is not one of the allowed values
+ * @api private
+ */
+
+module.exports = function castBigInt(val) {
+  if (val == null) {
+    return val;
+  }
+  if (val === '') {
+    return null;
+  }
+  if (typeof val === 'bigint') {
+    return val;
+  }
+
+  if (typeof val === 'string' || typeof val === 'number') {
+    return BigInt(val);
+  }
+
+  assert.ok(false);
+};

lib/schema/bigint.js

@@ -0,0 +1,221 @@
+'use strict';
+
+/*!
+ * Module dependencies.
+ */
+
+const CastError = require('../error/cast');
+const SchemaType = require('../schematype');
+const castBigInt = require('../cast/bigint');
+const utils = require('../utils');
+
+/**
+ * BigInt SchemaType constructor.
+ *
+ * @param {String} path
+ * @param {Object} options
+ * @inherits SchemaType
+ * @api public
+ */
+
+function SchemaBigInt(path, options) {
+  SchemaType.call(this, path, options, 'BigInt');
+}
+
+/**
+ * This schema type's name, to defend against minifiers that mangle
+ * function names.
+ *
+ * @api public
+ */
+SchemaBigInt.schemaName = 'BigInt';
+
+SchemaBigInt.defaultOptions = {};
+
+/*!
+ * Inherits from SchemaType.
+ */
+SchemaBigInt.prototype = Object.create(SchemaType.prototype);
+SchemaBigInt.prototype.constructor = SchemaBigInt;
+
+/*!
+ * ignore
+ */
+
+SchemaBigInt._cast = castBigInt;
+
+/**
+ * Sets a default option for all BigInt instances.
+ *
+ * #### Example:
+ *
+ *     // Make all bigints required by default
+ *     mongoose.Schema.BigInt.set('required', true);
+ *
+ * @param {String} option The option you'd like to set the value for
+ * @param {Any} value value for option
+ * @return {undefined}
+ * @function set
+ * @static
+ * @api public
+ */
+
+SchemaBigInt.set = SchemaType.set;
+
+/**
+ * Get/set the function used to cast arbitrary values to booleans.
+ *
+ * #### Example:
+ *
+ *     // Make Mongoose cast empty string '' to false.
+ *     const original = mongoose.Schema.Boolean.cast();
+ *     mongoose.Schema.Boolean.cast(v => {
+ *       if (v === '') {
+ *         return false;
+ *       }
+ *       return original(v);
+ *     });
+ *
+ *     // Or disable casting entirely
+ *     mongoose.Schema.Boolean.cast(false);
+ *
+ * @param {Function} caster
+ * @return {Function}
+ * @function get
+ * @static
+ * @api public
+ */
+
+SchemaBigInt.cast = function cast(caster) {
+  if (arguments.length === 0) {
+    return this._cast;
+  }
+  if (caster === false) {
+    caster = this._defaultCaster;
+  }
+  this._cast = caster;
+
+  return this._cast;
+};
+
+/*!
+ * ignore
+ */
+
+SchemaBigInt._checkRequired = v => v != null;
+
+/**
+ * Override the function the required validator uses to check whether a value
+ * passes the `required` check.
+ *
+ * @param {Function} fn
+ * @return {Function}
+ * @function checkRequired
+ * @static
+ * @api public
+ */
+
+SchemaBigInt.checkRequired = SchemaType.checkRequired;
+
+/**
+ * Check if the given value satisfies a required validator.
+ *
+ * @param {Any} value
+ * @return {Boolean}
+ * @api public
+ */
+
+SchemaBigInt.prototype.checkRequired = function(value) {
+  return this.constructor._checkRequired(value);
+};
+
+/**
+ * Casts to bigint
+ *
+ * @param {Object} value
+ * @param {Object} model this value is optional
+ * @api private
+ */
+
+SchemaBigInt.prototype.cast = function(value) {
+  let castBigInt;
+  if (typeof this._castFunction === 'function') {
+    castBigInt = this._castFunction;
+  } else if (typeof this.constructor.cast === 'function') {
+    castBigInt = this.constructor.cast();
+  } else {
+    castBigInt = SchemaBigInt.cast();
+  }
+
+  try {
+    return castBigInt(value);
+  } catch (error) {
+    throw new CastError('BigInt', value, this.path, error, this);
+  }
+};
+
+/*!
+ * ignore
+ */
+
+SchemaBigInt.$conditionalHandlers = utils.options(SchemaType.prototype.$conditionalHandlers, {
+  $gt: handleSingle,
+  $gte: handleSingle,
+  $lt: handleSingle,
+  $lte: handleSingle
+});
+
+/*!
+ * ignore
+ */
+
+function handleSingle(val, context) {
+  return this.castForQuery(null, val, context);
+}
+
+/**
+ * Casts contents for queries.
+ *
+ * @param {String} $conditional
+ * @param {any} val
+ * @api private
+ */
+
+SchemaBigInt.prototype.castForQuery = function($conditional, val, context) {
+  let handler;
+  if ($conditional != null) {
+    handler = SchemaBigInt.$conditionalHandlers[$conditional];
+
+    if (handler) {
+      return handler.call(this, val);
+    }
+
+    return this.applySetters(null, val, context);
+  }
+
+  return this.applySetters(val, context);
+};
+
+/**
+ *
+ * @api private
+ */
+
+SchemaBigInt.prototype._castNullish = function _castNullish(v) {
+  if (typeof v === 'undefined') {
+    return v;
+  }
+  const castBigInt = typeof this.constructor.cast === 'function' ?
+    this.constructor.cast() :
+    SchemaBigInt.cast();
+  if (castBigInt == null) {
+    return v;
+  }
+  return v;
+};
+
+/*!
+ * Module exports.
+ */
+
+module.exports = SchemaBigInt;

lib/schema/index.js

@@ -5,30 +5,19 @@
 
 'use strict';
 
-exports.String = require('./string');
-
-exports.Number = require('./number');
-
-exports.Boolean = require('./boolean');
-
-exports.DocumentArray = require('./documentarray');
-
-exports.Subdocument = require('./SubdocumentPath');
-
 exports.Array = require('./array');
-
+exports.Boolean = require('./boolean');
+exports.BigInt = require('./bigint');
 exports.Buffer = require('./buffer');
-
 exports.Date = require('./date');
-
-exports.ObjectId = require('./objectid');
-
-exports.Mixed = require('./mixed');
-
 exports.Decimal128 = exports.Decimal = require('./decimal128');
-
+exports.DocumentArray = require('./documentarray');
 exports.Map = require('./map');
-
+exports.Mixed = require('./mixed');
+exports.Number = require('./number');
+exports.ObjectId = require('./objectid');
+exports.String = require('./string');
+exports.Subdocument = require('./SubdocumentPath');
 exports.UUID = require('./uuid');
 
 // alias

package.json

@@ -19,9 +19,9 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "bson": "^5.0.1",
+    "bson": "^5.2.0",
     "kareem": "2.5.1",
-    "mongodb": "5.1.0",
+    "mongodb": "5.3.0",
     "mpath": "0.9.0",
     "mquery": "5.0.0",
     "ms": "2.1.3",