@onehat/data/src/Property/Date.js

JS data modeling package with adapters for many storage mediums.

/** @module Property */

import Property from './Property.js';
import Formatters from '../Util/Formatters.js';
import Parsers from '../Util/Parsers.js';
import _ from 'lodash';

/**
 * Class represents a Property that stores a calendar date.
 * @extends Property
 */
export default class DateProperty extends Property {
	
	static defaults = {
		readFormat: 'YYYY-MM-DD',
		displayFormat: 'MMM DD, YYYY',
		submitFormat: 'YYYY-MM-DD',
	};

	constructor(config = {}, entity) {
		config = _.merge({}, DateProperty.defaults, config);
		super(config, entity);
	}

	/**
	 * Returns the default configuration for this PropertyType, going up the hierarchy.
	 * @param {Object} defaults - The default configuration to merge with
	 * @returns {Object} The default configuration
	 */
	static getStaticDefaults(defaults = {}) {
		const superDefaults = super.getStaticDefaults();
		return _.merge({}, superDefaults, DateProperty.defaults, defaults);
	}

	/**
	 * Gets default value.
	 * In this case, if a property is set to have a defaultValue of 'now',
	 * it will default to the current Date.
	 * @return {any} defaultValue
	 */
	getDefaultValue() {
		if (this.defaultValue === 'now') {
			return Parsers.ParseDate();
		}
		return super.getDefaultValue();
	}

	/**
	 * Parses value to moment object
	 * @param {any} value
	 * @return {moment} parsedValue
	 */
	parse(value) {
		if (this.isDestroyed) {
			throw Error('this.parse is no longer valid. Property has been destroyed.');
		}
		
		if (!_.isNil(value) && Parsers.nullDates.indexOf(value) !== -1) {
			value = null;
		}
		
		if (_.isNil(value)) {
			return null;
		}

		let result = Parsers.ParseDate(value, this.readFormat);
		if (!result.isValid()) {
			throw new Error(this.name + ' ' + result.toString());
		}
		return result;
	}

	getDisplayValue() {
		if (this.isDestroyed) {
			throw Error('this.getDisplayValue is no longer valid. Property has been destroyed.');
		}
		return Formatters.FormatDate(this.parsedValue, this.displayFormat);
	}

	getSubmitValue() {
		if (this.isDestroyed) {
			throw Error('this.getSubmitValue is no longer valid. Property has been destroyed.');
		}
		return Formatters.FormatDate(this.parsedValue, this.submitFormat);
	}

	getValueFormattedAs(format) {
		if (this.isDestroyed) {
			throw Error('this.getValueFormattedAs is no longer valid. Property has been destroyed.');
		}
		return Formatters.FormatDate(this.parsedValue, format);
	}

	getMoment() {
		return this.getParsedValue();
	}

	isToday() {
		return this.getMoment().isSame(new Date(), 'day');
	}
};

DateProperty.className = 'Date';
DateProperty.type = 'date';