@depup/mongoose 9.1.3-depup.0

package/lib/schema/date.js

@@ -0,0 +1,467 @@
+/*!
+ * Module requirements.
+ */
+
+'use strict';
+
+const MongooseError = require('../error/index');
+const SchemaDateOptions = require('../options/schemaDateOptions');
+const SchemaType = require('../schemaType');
+const castDate = require('../cast/date');
+const createJSONSchemaTypeDefinition = require('../helpers/createJSONSchemaTypeDefinition');
+const getConstructorName = require('../helpers/getConstructorName');
+const utils = require('../utils');
+
+const CastError = SchemaType.CastError;
+
+/**
+ * Date SchemaType constructor.
+ *
+ * @param {String} key
+ * @param {Object} options
+ * @param {Object} schemaOptions
+ * @param {Schema} parentSchema
+ * @inherits SchemaType
+ * @api public
+ */
+
+function SchemaDate(key, options, _schemaOptions, parentSchema) {
+  SchemaType.call(this, key, options, 'Date', parentSchema);
+}
+
+/**
+ * This schema type's name, to defend against minifiers that mangle
+ * function names.
+ *
+ * @api public
+ */
+SchemaDate.schemaName = 'Date';
+
+SchemaDate.defaultOptions = {};
+
+/*!
+ * Inherits from SchemaType.
+ */
+SchemaDate.prototype = Object.create(SchemaType.prototype);
+SchemaDate.prototype.constructor = SchemaDate;
+SchemaDate.prototype.OptionsConstructor = SchemaDateOptions;
+
+/*!
+ * ignore
+ */
+
+SchemaDate._cast = castDate;
+
+/**
+ * Sets a default option for all Date instances.
+ *
+ * #### Example:
+ *
+ *     // Make all dates have `required` of true by default.
+ *     mongoose.Schema.Types.Date.set('required', true);
+ *
+ *     const User = mongoose.model('User', new Schema({ test: Date }));
+ *     new User({ }).validateSync().errors.test.message; // Path `test` is required.
+ *
+ * @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
+ */
+
+SchemaDate.set = SchemaType.set;
+
+SchemaDate.setters = [];
+
+/**
+ * Attaches a getter for all Date instances
+ *
+ * #### Example:
+ *
+ *     // Always convert Dates to string
+ *     mongoose.Schema.Types.Date.get(v => v.toString());
+ *
+ *     const Model = mongoose.model('Test', new Schema({ date: { type: Date, default: () => new Date() } }));
+ *     typeof (new Model({}).date); // 'string'
+ *
+ * @param {Function} getter
+ * @return {this}
+ * @function get
+ * @static
+ * @api public
+ */
+
+SchemaDate.get = SchemaType.get;
+
+/**
+ * Get/set the function used to cast arbitrary values to dates.
+ *
+ * #### Example:
+ *
+ *     // Mongoose converts empty string '' into `null` for date types. You
+ *     // can create a custom caster to disable it.
+ *     const original = mongoose.Schema.Types.Date.cast();
+ *     mongoose.Schema.Types.Date.cast(v => {
+ *       assert.ok(v !== '');
+ *       return original(v);
+ *     });
+ *
+ *     // Or disable casting entirely
+ *     mongoose.Schema.Types.Date.cast(false);
+ *
+ * @param {Function} caster
+ * @return {Function}
+ * @function cast
+ * @static
+ * @api public
+ */
+
+SchemaDate.cast = function cast(caster) {
+  if (arguments.length === 0) {
+    return this._cast;
+  }
+  if (caster === false) {
+    caster = this._defaultCaster;
+  }
+  this._cast = caster;
+
+  return this._cast;
+};
+
+/*!
+ * ignore
+ */
+
+SchemaDate._defaultCaster = v => {
+  if (v != null && !(v instanceof Date)) {
+    throw new Error();
+  }
+  return v;
+};
+
+/**
+ * Declares a TTL index (rounded to the nearest second) for _Date_ types only.
+ *
+ * This sets the `expireAfterSeconds` index option available in MongoDB >= 2.1.2.
+ * This index type is only compatible with Date types.
+ *
+ * #### Example:
+ *
+ *     // expire in 24 hours
+ *     new Schema({ createdAt: { type: Date, expires: 60*60*24 }});
+ *
+ * `expires` utilizes the `ms` module from [vercel](https://github.com/vercel/ms) allowing us to use a friendlier syntax:
+ *
+ * #### Example:
+ *
+ *     // expire in 24 hours
+ *     new Schema({ createdAt: { type: Date, expires: '24h' }});
+ *
+ *     // expire in 1.5 hours
+ *     new Schema({ createdAt: { type: Date, expires: '1.5h' }});
+ *
+ *     // expire in 7 days
+ *     const schema = new Schema({ createdAt: Date });
+ *     schema.path('createdAt').expires('7d');
+ *
+ * @param {Number|String} when
+ * @added 3.0.0
+ * @return {SchemaType} this
+ * @api public
+ */
+
+SchemaDate.prototype.expires = function(when) {
+  if (getConstructorName(this._index) !== 'Object') {
+    this._index = {};
+  }
+
+  this._index.expires = when;
+  utils.expires(this._index);
+  return this;
+};
+
+/*!
+ * ignore
+ */
+
+SchemaDate._checkRequired = v => v instanceof Date;
+
+/**
+ * Override the function the required validator uses to check whether a string
+ * passes the `required` check.
+ *
+ * #### Example:
+ *
+ *     // Allow empty strings to pass `required` check
+ *     mongoose.Schema.Types.String.checkRequired(v => v != null);
+ *
+ *     const M = mongoose.model({ str: { type: String, required: true } });
+ *     new M({ str: '' }).validateSync(); // `null`, validation passes!
+ *
+ * @param {Function} fn
+ * @return {Function}
+ * @function checkRequired
+ * @static
+ * @api public
+ */
+
+SchemaDate.checkRequired = SchemaType.checkRequired;
+
+/**
+ * Check if the given value satisfies a required validator. To satisfy
+ * a required validator, the given value must be an instance of `Date`.
+ *
+ * @param {Any} value
+ * @param {Document} doc
+ * @return {Boolean}
+ * @api public
+ */
+
+SchemaDate.prototype.checkRequired = function(value, doc) {
+  if (typeof value === 'object' && SchemaType._isRef(this, value, doc, true)) {
+    return value != null;
+  }
+
+  // `require('util').inherits()` does **not** copy static properties, and
+  // plugins like mongoose-float use `inherits()` for pre-ES6.
+  const _checkRequired = typeof this.constructor.checkRequired === 'function' ?
+    this.constructor.checkRequired() :
+    SchemaDate.checkRequired();
+  return _checkRequired(value);
+};
+
+/**
+ * Sets a minimum date validator.
+ *
+ * #### Example:
+ *
+ *     const s = new Schema({ d: { type: Date, min: Date('1970-01-01') })
+ *     const M = db.model('M', s)
+ *     const m = new M({ d: Date('1969-12-31') })
+ *     m.save(function (err) {
+ *       console.error(err) // validator error
+ *       m.d = Date('2014-12-08');
+ *       m.save() // success
+ *     })
+ *
+ *     // custom error messages
+ *     // We can also use the special {MIN} token which will be replaced with the invalid value
+ *     const min = [Date('1970-01-01'), 'The value of path `{PATH}` ({VALUE}) is beneath the limit ({MIN}).'];
+ *     const schema = new Schema({ d: { type: Date, min: min })
+ *     const M = mongoose.model('M', schema);
+ *     const s= new M({ d: Date('1969-12-31') });
+ *     s.validate(function (err) {
+ *       console.log(String(err)) // ValidationError: The value of path `d` (1969-12-31) is before the limit (1970-01-01).
+ *     })
+ *
+ * @param {Date} value minimum date
+ * @param {String} [message] optional custom error message
+ * @return {SchemaType} this
+ * @see Customized Error Messages https://mongoosejs.com/docs/api/error.html#Error.messages
+ * @api public
+ */
+
+SchemaDate.prototype.min = function(value, message) {
+  if (this.minValidator) {
+    this.validators = this.validators.filter(function(v) {
+      return v.validator !== this.minValidator;
+    }, this);
+  }
+
+  if (value) {
+    let msg = message || MongooseError.messages.Date.min;
+    if (typeof msg === 'string') {
+      msg = msg.replace(/{MIN}/, (value === Date.now ? 'Date.now()' : value.toString()));
+    }
+    const _this = this;
+    this.validators.push({
+      validator: this.minValidator = function(val) {
+        let _value = value;
+        if (typeof value === 'function' && value !== Date.now) {
+          _value = _value.call(this);
+        }
+        const min = (_value === Date.now ? _value() : _this.cast(_value));
+        return val === null || val.valueOf() >= min.valueOf();
+      },
+      message: msg,
+      type: 'min',
+      min: value
+    });
+  }
+
+  return this;
+};
+
+/**
+ * Sets a maximum date validator.
+ *
+ * #### Example:
+ *
+ *     const s = new Schema({ d: { type: Date, max: Date('2014-01-01') })
+ *     const M = db.model('M', s)
+ *     const m = new M({ d: Date('2014-12-08') })
+ *     m.save(function (err) {
+ *       console.error(err) // validator error
+ *       m.d = Date('2013-12-31');
+ *       m.save() // success
+ *     })
+ *
+ *     // custom error messages
+ *     // We can also use the special {MAX} token which will be replaced with the invalid value
+ *     const max = [Date('2014-01-01'), 'The value of path `{PATH}` ({VALUE}) exceeds the limit ({MAX}).'];
+ *     const schema = new Schema({ d: { type: Date, max: max })
+ *     const M = mongoose.model('M', schema);
+ *     const s= new M({ d: Date('2014-12-08') });
+ *     s.validate(function (err) {
+ *       console.log(String(err)) // ValidationError: The value of path `d` (2014-12-08) exceeds the limit (2014-01-01).
+ *     })
+ *
+ * @param {Date} maximum date
+ * @param {String} [message] optional custom error message
+ * @return {SchemaType} this
+ * @see Customized Error Messages https://mongoosejs.com/docs/api/error.html#Error.messages
+ * @api public
+ */
+
+SchemaDate.prototype.max = function(value, message) {
+  if (this.maxValidator) {
+    this.validators = this.validators.filter(function(v) {
+      return v.validator !== this.maxValidator;
+    }, this);
+  }
+
+  if (value) {
+    let msg = message || MongooseError.messages.Date.max;
+    if (typeof msg === 'string') {
+      msg = msg.replace(/{MAX}/, (value === Date.now ? 'Date.now()' : value.toString()));
+    }
+    const _this = this;
+    this.validators.push({
+      validator: this.maxValidator = function(val) {
+        let _value = value;
+        if (typeof _value === 'function' && _value !== Date.now) {
+          _value = _value.call(this);
+        }
+        const max = (_value === Date.now ? _value() : _this.cast(_value));
+        return val === null || val.valueOf() <= max.valueOf();
+      },
+      message: msg,
+      type: 'max',
+      max: value
+    });
+  }
+
+  return this;
+};
+
+/**
+ * Casts to date
+ *
+ * @param {Object} value to cast
+ * @api private
+ */
+
+SchemaDate.prototype.cast = function(value) {
+  let castDate;
+  if (typeof this._castFunction === 'function') {
+    castDate = this._castFunction;
+  } else if (typeof this.constructor.cast === 'function') {
+    castDate = this.constructor.cast();
+  } else {
+    castDate = SchemaDate.cast();
+  }
+
+  try {
+    return castDate(value);
+  } catch (error) {
+    throw new CastError('date', value, this.path, error, this);
+  }
+};
+
+/**
+ * Date Query casting.
+ *
+ * @param {Any} val
+ * @api private
+ */
+
+function handleSingle(val) {
+  return this.cast(val);
+}
+
+const $conditionalHandlers = {
+  ...SchemaType.prototype.$conditionalHandlers,
+  $gt: handleSingle,
+  $gte: handleSingle,
+  $lt: handleSingle,
+  $lte: handleSingle
+};
+
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$gte` is the function Mongoose calls to cast `$gte` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @memberOf SchemaDate
+ * @instance
+ * @api public
+ */
+
+Object.defineProperty(SchemaDate.prototype, '$conditionalHandlers', {
+  enumerable: false,
+  value: $conditionalHandlers
+});
+
+/**
+ * Casts contents for queries.
+ *
+ * @param {String} $conditional
+ * @param {any} [value]
+ * @api private
+ */
+
+SchemaDate.prototype.castForQuery = function($conditional, val, context) {
+  if ($conditional == null) {
+    try {
+      return this.applySetters(val, context);
+    } catch (err) {
+      if (err instanceof CastError && err.path === this.path && this.$fullPath != null) {
+        err.path = this.$fullPath;
+      }
+      throw err;
+    }
+  }
+
+  const handler = this.$conditionalHandlers[$conditional];
+
+  if (!handler) {
+    throw new Error('Can\'t use ' + $conditional + ' with Date.');
+  }
+
+  return handler.call(this, val);
+};
+
+/**
+ * Returns this schema type's representation in a JSON schema.
+ *
+ * @param [options]
+ * @param [options.useBsonType=false] If true, return a representation with `bsonType` for use with MongoDB's `$jsonSchema`.
+ * @returns {Object} JSON schema properties
+ */
+
+SchemaDate.prototype.toJSONSchema = function toJSONSchema(options) {
+  const isRequired = this.options.required && typeof this.options.required !== 'function';
+  return createJSONSchemaTypeDefinition('string', 'date', options?.useBsonType, isRequired);
+};
+
+SchemaDate.prototype.autoEncryptionType = function autoEncryptionType() {
+  return 'date';
+};
+
+/*!
+ * Module exports.
+ */
+
+module.exports = SchemaDate;

package/lib/schema/decimal128.js

@@ -0,0 +1,263 @@
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const SchemaType = require('../schemaType');
+const CastError = SchemaType.CastError;
+const castDecimal128 = require('../cast/decimal128');
+const createJSONSchemaTypeDefinition = require('../helpers/createJSONSchemaTypeDefinition');
+const isBsonType = require('../helpers/isBsonType');
+
+/**
+ * Decimal128 SchemaType constructor.
+ *
+ * @param {String} key
+ * @param {Object} options
+ * @param {Object} schemaOptions
+ * @param {Schema} parentSchema
+ * @inherits SchemaType
+ * @api public
+ */
+
+function SchemaDecimal128(key, options, _schemaOptions, parentSchema) {
+  SchemaType.call(this, key, options, 'Decimal128', parentSchema);
+}
+
+/**
+ * This schema type's name, to defend against minifiers that mangle
+ * function names.
+ *
+ * @api public
+ */
+SchemaDecimal128.schemaName = 'Decimal128';
+
+SchemaDecimal128.defaultOptions = {};
+
+/*!
+ * Inherits from SchemaType.
+ */
+SchemaDecimal128.prototype = Object.create(SchemaType.prototype);
+SchemaDecimal128.prototype.constructor = SchemaDecimal128;
+
+/*!
+ * ignore
+ */
+
+SchemaDecimal128._cast = castDecimal128;
+
+/**
+ * Sets a default option for all Decimal128 instances.
+ *
+ * #### Example:
+ *
+ *     // Make all decimal 128s have `required` of true by default.
+ *     mongoose.Schema.Types.Decimal128.set('required', true);
+ *
+ *     const User = mongoose.model('User', new Schema({ test: mongoose.Decimal128 }));
+ *     new User({ }).validateSync().errors.test.message; // Path `test` is required.
+ *
+ * @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
+ */
+
+SchemaDecimal128.set = SchemaType.set;
+
+SchemaDecimal128.setters = [];
+
+/**
+ * Attaches a getter for all Decimal128 instances
+ *
+ * #### Example:
+ *
+ *     // Automatically convert Decimal128s to Numbers
+ *     mongoose.Schema.Types.Decimal128.get(v => v == null ? v : Number(v));
+ *
+ * @param {Function} getter
+ * @return {this}
+ * @function get
+ * @static
+ * @api public
+ */
+
+SchemaDecimal128.get = SchemaType.get;
+
+/**
+ * Get/set the function used to cast arbitrary values to decimals.
+ *
+ * #### Example:
+ *
+ *     // Make Mongoose only refuse to cast numbers as decimal128
+ *     const original = mongoose.Schema.Types.Decimal128.cast();
+ *     mongoose.Decimal128.cast(v => {
+ *       assert.ok(typeof v !== 'number');
+ *       return original(v);
+ *     });
+ *
+ *     // Or disable casting entirely
+ *     mongoose.Decimal128.cast(false);
+ *
+ * @param {Function} [caster]
+ * @return {Function}
+ * @function get
+ * @static
+ * @api public
+ */
+
+SchemaDecimal128.cast = function cast(caster) {
+  if (arguments.length === 0) {
+    return this._cast;
+  }
+  if (caster === false) {
+    caster = this._defaultCaster;
+  }
+  this._cast = caster;
+
+  return this._cast;
+};
+
+/*!
+ * ignore
+ */
+
+SchemaDecimal128._defaultCaster = v => {
+  if (v != null && !isBsonType(v, 'Decimal128')) {
+    throw new Error();
+  }
+  return v;
+};
+
+/*!
+ * ignore
+ */
+
+SchemaDecimal128._checkRequired = v => isBsonType(v, 'Decimal128');
+
+/**
+ * Override the function the required validator uses to check whether a string
+ * passes the `required` check.
+ *
+ * @param {Function} fn
+ * @return {Function}
+ * @function checkRequired
+ * @static
+ * @api public
+ */
+
+SchemaDecimal128.checkRequired = SchemaType.checkRequired;
+
+/**
+ * Check if the given value satisfies a required validator.
+ *
+ * @param {Any} value
+ * @param {Document} doc
+ * @return {Boolean}
+ * @api public
+ */
+
+SchemaDecimal128.prototype.checkRequired = function checkRequired(value, doc) {
+  if (SchemaType._isRef(this, value, doc, true)) {
+    return !!value;
+  }
+
+  // `require('util').inherits()` does **not** copy static properties, and
+  // plugins like mongoose-float use `inherits()` for pre-ES6.
+  const _checkRequired = typeof this.constructor.checkRequired === 'function' ?
+    this.constructor.checkRequired() :
+    SchemaDecimal128.checkRequired();
+
+  return _checkRequired(value);
+};
+
+/**
+ * Casts to Decimal128
+ *
+ * @param {Object} value
+ * @param {Object} doc
+ * @param {Boolean} init whether this is an initialization cast
+ * @api private
+ */
+
+SchemaDecimal128.prototype.cast = function(value, doc, init, prev, options) {
+  if (SchemaType._isRef(this, value, doc, init)) {
+    if (isBsonType(value, 'Decimal128')) {
+      return value;
+    }
+
+    return this._castRef(value, doc, init, options);
+  }
+
+  let castDecimal128;
+  if (typeof this._castFunction === 'function') {
+    castDecimal128 = this._castFunction;
+  } else if (typeof this.constructor.cast === 'function') {
+    castDecimal128 = this.constructor.cast();
+  } else {
+    castDecimal128 = SchemaDecimal128.cast();
+  }
+
+  try {
+    return castDecimal128(value);
+  } catch (error) {
+    throw new CastError('Decimal128', value, this.path, error, this);
+  }
+};
+
+/*!
+ * ignore
+ */
+
+function handleSingle(val) {
+  return this.cast(val);
+}
+
+const $conditionalHandlers = {
+  ...SchemaType.prototype.$conditionalHandlers,
+  $gt: handleSingle,
+  $gte: handleSingle,
+  $lt: handleSingle,
+  $lte: handleSingle
+};
+
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$lte` is the function Mongoose calls to cast `$lte` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @memberOf SchemaDecimal128
+ * @instance
+ * @api public
+ */
+
+Object.defineProperty(SchemaDecimal128.prototype, '$conditionalHandlers', {
+  enumerable: false,
+  value: $conditionalHandlers
+});
+
+/**
+ * Returns this schema type's representation in a JSON schema.
+ *
+ * @param [options]
+ * @param [options.useBsonType=false] If true, return a representation with `bsonType` for use with MongoDB's `$jsonSchema`.
+ * @returns {Object} JSON schema properties
+ */
+
+SchemaDecimal128.prototype.toJSONSchema = function toJSONSchema(options) {
+  const isRequired = this.options.required && typeof this.options.required !== 'function';
+  return createJSONSchemaTypeDefinition('string', 'decimal', options?.useBsonType, isRequired);
+};
+
+SchemaDecimal128.prototype.autoEncryptionType = function autoEncryptionType() {
+  return 'decimal';
+};
+
+/*!
+ * Module exports.
+ */
+
+module.exports = SchemaDecimal128;