# all files / keystone/fields/types/date/ DateType.js

87.18% Statements 68/78
69.62% Branches 55/79
87.5% Functions 7/8
89.47% Lines 68/76

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    1561×
    1×
    1×
    1×
    1×

    1×
    4×
    4×
    4×
    4×
    4×
    4×

    4×
    4×
    4×
    1×

    3×

    1×

    1×

    1×
    10×
    10×
    6×
    1×
    1×
    1×
    1×

    4×
    4×

    4×
    4×
    4×
    4×
    1×
    3×
    1×

    2×

    10×
    1×

    10×

    1×
    3×
    3×

    1×
    5×
    5×
    5×

    1×
    24×

    24×
    4×

    20×

    1×
    12×
    12×
    12×
    9×

    12×

    1×

    1×
    4×
    4×

    2×

    2×
    1×

    2×

    4×

    1×
     var FieldType = require('../Type');
    var moment = require('moment');
    var util = require('util');
    var utils = require('keystone-utils');
    var TextType = require('../text/TextType');

    /**
     * Date FieldType Constructor
     * @extends Field
     * @api public
     */
    function date (list, path, options) {
    	this._nativeType = Date;
    	this._underscoreMethods = ['format', 'moment', 'parse'];
    	this._fixedSize = 'medium';
    	this._properties = ['formatString', 'yearRange', 'isUTC', 'inputFormat'];
    	this.parseFormatString = options.inputFormat || 'YYYY-MM-DD';
    	this.formatString = (options.format === false) ? false : (options.format || 'Do MMM YYYY');

    	this.yearRange = options.yearRange;
    	this.isUTC = options.utc || false;
    	if (this.formatString && typeof this.formatString !== 'string') {
    		throw new Error('FieldType.Date: options.format must be a string.');
    	}
    	date.super_.call(this, list, path, options);
    }
    util.inherits(date, FieldType);

    date.prototype.validateRequiredInput = TextType.prototype.validateRequiredInput;

    /**
     * Add filters to a query
     */
    date.prototype.addFilterToQuery = function (filter, query) {
    	query = query || {};
    	if (filter.mode === 'between') {
    		if (filter.after && filter.before) {
    			filter.after = moment(filter.after);
    			filter.before = moment(filter.before);
    			Eif (filter.after.isValid() && filter.before.isValid()) {
    				query[this.path] = {
    					$gte: filter.after.startOf('day').toDate(),
    					$lte: filter.before.endOf('day').toDate(),
    				};
    			}
    		}
    	} else Eif (filter.value) {
    		var day = {
    			moment: moment(filter.value),
    		};
    		day.start = day.moment.startOf('day').toDate();
    		day.end = moment(filter.value).endOf('day').toDate();
    		Eif (day.moment.isValid()) {
    			if (filter.mode === 'after') {
    				query[this.path] = { $gt: day.end };
    			} else if (filter.mode === 'before') {
    				query[this.path] = { $lt: day.start };
    			} else {
    				query[this.path] = { $gte: day.start, $lte: day.end };
    			}
    		}
    	}
    	if (filter.inverted) {
    		query[this.path] = { $not: query[this.path] };
    	}
    	return query;
    };

    /**
     * Formats the field value
     */
    date.prototype.format = function (item, format) {
    	Eif (format || this.formatString) {
    		return item.get(this.path) ? this.moment(item).format(format || this.formatString) : '';
    	} else {
    		return item.get(this.path) || '';
    	}
    };

    /**
     * Returns a new `moment` object with the field value
     */
    date.prototype.moment = function (item) {
    	var m = moment(item.get(this.path));
    	Iif (this.isUTC) m.utc();
    	return m;
    };

    /**
     * Parses input with the correct moment version (normal or utc) and uses
     * either the provided input format or the default for the field
     */
    date.prototype.parse = function (value, format, strict) {
    	var m = this.isUTC ? moment.utc : moment;
    	// TODO Check should maybe be if (typeof value === 'string')
    	// use the parseFormatString. Ever relevant?
    	if (typeof value === 'number' || value instanceof Date) {
    		return m(value);
    	} else {
    		return m(value, format || this.parseFormatString, strict);
    	}
    };

    /**
     * Asynchronously confirms that the provided date is valid
     */
    date.prototype.validateInput = function (data, callback) {
    	var value = this.getValueFromData(data);
    	var result = true;
    	if (value) {
    		result = this.parse(value).isValid();
    	}
    	utils.defer(callback, result);
    };

    /**
     * Checks that a valid date has been provided in a data object
     * An empty value clears the stored value and is considered valid
     *
     * Deprecated
     */
    date.prototype.inputIsValid = function (data, required, item) {
    	if (!(this.path in data) && item && item.get(this.path)) return true;
    	var newValue = moment(data[this.path], this.parseFormatString);
    	if (required && (!newValue.isValid())) {
    		return false;
    	} else if (data[this.path] && newValue && !newValue.isValid()) {
    		return false;
    	} else {
    		return true;
    	}
    };

    /**
     * Updates the value for this field in the item from a data object
     */
    date.prototype.updateItem = function (item, data, callback) {
    	var value = this.getValueFromData(data);
    	if (value !== null && value !== '') {
    		// If the value is not null, empty string or undefined, parse it
    		var newValue = this.parse(value);
    		// If it's valid and not the same as the last value, save it
    		if (newValue.isValid() && (!item.get(this.path) || !newValue.isSame(item.get(this.path)))) {
    			item.set(this.path, newValue.toDate());
    		}
    	} else {
    		// If it's null or empty string, clear it out
    		item.set(this.path, null);
    	}
    	process.nextTick(callback);
    };

    /* Export Field Type */
    module.exports = date;