You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
390 lines
9.9 KiB
390 lines
9.9 KiB
/*!
|
|
* Module requirements.
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
const MongooseError = require('../error/index');
|
|
const SchemaDateOptions = require('../options/SchemaDateOptions');
|
|
const SchemaType = require('../schematype');
|
|
const castDate = require('../cast/date');
|
|
const utils = require('../utils');
|
|
|
|
const CastError = SchemaType.CastError;
|
|
|
|
/**
|
|
* Date SchemaType constructor.
|
|
*
|
|
* @param {String} key
|
|
* @param {Object} options
|
|
* @inherits SchemaType
|
|
* @api public
|
|
*/
|
|
|
|
function SchemaDate(key, options) {
|
|
SchemaType.call(this, key, options, 'Date');
|
|
}
|
|
|
|
/**
|
|
* 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.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 {*} value - value for option
|
|
* @return {undefined}
|
|
* @function set
|
|
* @static
|
|
* @api public
|
|
*/
|
|
|
|
SchemaDate.set = SchemaType.set;
|
|
|
|
/**
|
|
* 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 get
|
|
* @static
|
|
* @api public
|
|
*/
|
|
|
|
SchemaDate.cast = function cast(caster) {
|
|
if (arguments.length === 0) {
|
|
return this._cast;
|
|
}
|
|
if (caster === false) {
|
|
caster = v => {
|
|
if (v != null && !(v instanceof Date)) {
|
|
throw new Error();
|
|
}
|
|
return v;
|
|
};
|
|
}
|
|
this._cast = caster;
|
|
|
|
return this._cast;
|
|
};
|
|
|
|
/**
|
|
* 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 [guille](https://github.com/guille/) 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
|
|
* var 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 (!this._index || this._index.constructor.name !== '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 (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() :
|
|
SchemaDate.checkRequired();
|
|
return _checkRequired(value);
|
|
};
|
|
|
|
/**
|
|
* Sets a minimum date validator.
|
|
*
|
|
* ####Example:
|
|
*
|
|
* var s = new Schema({ d: { type: Date, min: Date('1970-01-01') })
|
|
* var M = db.model('M', s)
|
|
* var 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
|
|
* var min = [Date('1970-01-01'), 'The value of path `{PATH}` ({VALUE}) is beneath the limit ({MIN}).'];
|
|
* var schema = new Schema({ d: { type: Date, min: min })
|
|
* var M = mongoose.model('M', schema);
|
|
* var 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 #error_messages_MongooseError-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:
|
|
*
|
|
* var s = new Schema({ d: { type: Date, max: Date('2014-01-01') })
|
|
* var M = db.model('M', s)
|
|
* var 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
|
|
* var max = [Date('2014-01-01'), 'The value of path `{PATH}` ({VALUE}) exceeds the limit ({MAX}).'];
|
|
* var schema = new Schema({ d: { type: Date, max: max })
|
|
* var M = mongoose.model('M', schema);
|
|
* var 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 #error_messages_MongooseError-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) {
|
|
const castDate = typeof this.constructor.cast === 'function' ?
|
|
this.constructor.cast() :
|
|
SchemaDate.cast();
|
|
try {
|
|
return castDate(value);
|
|
} catch (error) {
|
|
throw new CastError('date', value, this.path, error, this);
|
|
}
|
|
};
|
|
|
|
/*!
|
|
* Date Query casting.
|
|
*
|
|
* @api private
|
|
*/
|
|
|
|
function handleSingle(val) {
|
|
return this.cast(val);
|
|
}
|
|
|
|
SchemaDate.prototype.$conditionalHandlers =
|
|
utils.options(SchemaType.prototype.$conditionalHandlers, {
|
|
$gt: handleSingle,
|
|
$gte: handleSingle,
|
|
$lt: handleSingle,
|
|
$lte: handleSingle
|
|
});
|
|
|
|
|
|
/**
|
|
* Casts contents for queries.
|
|
*
|
|
* @param {String} $conditional
|
|
* @param {any} [value]
|
|
* @api private
|
|
*/
|
|
|
|
SchemaDate.prototype.castForQuery = function($conditional, val) {
|
|
if (arguments.length !== 2) {
|
|
return this._castForQuery($conditional);
|
|
}
|
|
|
|
const handler = this.$conditionalHandlers[$conditional];
|
|
|
|
if (!handler) {
|
|
throw new Error('Can\'t use ' + $conditional + ' with Date.');
|
|
}
|
|
|
|
return handler.call(this, val);
|
|
};
|
|
|
|
/*!
|
|
* Module exports.
|
|
*/
|
|
|
|
module.exports = SchemaDate;
|
|
|