@onehat/data 1.20.9 → 1.21.0

package/src/Property/Property.js

@@ -12,6 +12,133 @@ import _ from 'lodash';
  */
 export default class Property extends EventEmitter {
 
+	static defaults = {
+
+		/**
+		 * @member {string} name - Could be anything, but OneHat's convention is to use
+		 * the model name pluralized and underscored, followed by two underscores, 
+		 * followed by the field name singular and underscored (e.g. 'groups_users__id')
+		 * This convention allows us to have multiple models' data in a single Entity, all flattened
+		 */
+		name: null,
+
+		/**
+		 * @member {boolean} allowNull - Is the property required to have a value? 
+		 * Defaults to true.
+		 */
+		allowNull: true,
+
+		/**
+		 * @member {function} parse - Custom parse function that overrides 
+		 * Property.parse.
+		 * Takes one argument:
+		 * - rawValue {any} - The raw value to parse
+		 * 
+		 * Note: If you use standard function notation for the parse function,
+		 * then the Property and Entity (with all other parsed properties and original data)
+		 * are available inside the function as:
+		 * - Property: this
+		 * - Entity: this.getEntity()
+		 * - Original Data: this.getEntity().getOriginalData()
+		 * 
+		 * Returns 'parsedValue'
+		 * @private
+		 */
+		// parse: null,
+
+		/**
+		 * @member {(string|string[])} depends - Other properties this property 
+		 * depends upon for its custom "parse" function. 
+		 * @private
+		 */
+		depends: null,
+		
+		/**
+		 * @member {string} mapping - JS dot-notation path
+		 * (e.g. "user.username") for how to access the rawValue which will be 
+		 * given to parse(), based on an Entity's _originalData object.
+		 * @private
+		 * @readonly
+		 */
+		mapping: null,
+		
+		/**
+		 * @member {boolean} submitAsString - Whether to submit value as a string, rather than a primitive or complex type
+		 */
+		submitAsString: false,
+
+		/**
+		 * @member {boolean} isSortable - Whether this property type is sortable
+		 */
+		isSortable: true,
+		
+		/**
+		 * @member {boolean} isTempId - Whether this property's ID is temporary
+		 */
+		isTempId: false,
+
+		// ##################################################################
+		// #### These next properties are only for OneBuild repositories ####
+		// ##################################################################
+
+		/**
+		 * @member {boolean} isVirtual - Whether this property represents a virtual field on server
+		 */
+		isVirtual: false,
+		
+		/**
+		 * @member {string} title - The human-readable title for this property
+		 */
+		title: null,
+		
+		/**
+		 * @member {string} tooltip - The human-readable tooltip for this property
+		 */
+		tooltip: null,
+		
+		/**
+		 * @member {string} fieldGroup - The field group for this property
+		 */
+		fieldGroup: null,
+
+		/**
+		 * @member {boolean} isForeignModel - Whether this property belongs to a foreign model
+		 */
+		isForeignModel: false,
+		
+		/**
+		 * @member {object} filterType - The UI filter type of this property
+		 */
+		filterType: null,
+
+		/**
+		 * @member {boolean} isFilteringDisabled - Whether this property is disabled for UI filtering
+		 */
+		isFilteringDisabled: false,
+		
+		/**
+		 * @member {object} viewerType - The UI viewer type of this property
+		 */
+		viewerType: null,
+		
+		/**
+		 * @member {object} editorType - The UI editor type of this property
+		 */
+		editorType: null,
+
+		/**
+		 * @member {boolean} isEditingDisabled - Whether this property is disabled for UI editing
+		 */
+		isEditingDisabled: false,
+
+		/**
+		 * @member {any} defaultValue - Default value for this property if none is supplied
+		 * @private
+		 */
+		defaultValue: null,
+
+	};
+
 	/**
 	 * @constructor
 	 * @param {object} config - Object with key/value pairs that define this Property
@@ -19,133 +146,7 @@ export default class Property extends EventEmitter {
 	constructor(config = {}, entity) {
 		super(...arguments);
 		
-		const defaults = {
-			/**
-			 * @member {string} name - Could be anything, but OneHat's convention is to use
-			 * the model name pluralized and underscored, followed by two underscores, 
-			 * followed by the field name singular and underscored (e.g. 'groups_users__id')
-			 * This convention allows us to have multiple models' data in a single Entity, all flattened
-			 */
-			name: null,
-
-			/**
-			 * @member {boolean} allowNull - Is the property required to have a value? 
-			 * Defaults to true.
-			 */
-			allowNull: true,
-
-			/**
-			 * @member {function} parse - Custom parse function that overrides 
-			 * Property.parse.
-			 * Takes one argument:
-			 * - rawValue {any} - The raw value to parse
-			 * 
-			 * Note: If you use standard function notation for the parse function,
-			 * then the Property and Entity (with all other parsed properties and original data)
-			 * are available inside the function as:
-			 * - Property: this
-			 * - Entity: this.getEntity()
-			 * - Original Data: this.getEntity().getOriginalData()
-			 * 
-			 * Returns 'parsedValue'
-			 * @private
-			 */
-			// parse: null,
-
-			/**
-			 * @member {(string|string[])} depends - Other properties this property 
-			 * depends upon for its custom "parse" function. 
-			 * @private
-			 */
-			depends: null,
-			
-			/**
-			 * @member {string} mapping - JS dot-notation path
-			 * (e.g. "user.username") for how to access the rawValue which will be 
-			 * given to parse(), based on an Entity's _originalData object.
-			 * @private
-			 * @readonly
-			 */
-			mapping: null,
-			
-			/**
-			 * @member {any} defaultValue - Default value for this property if none is supplied
-			 * @private
-			 */
-			defaultValue: null,
-			
-			/**
-			 * @member {boolean} submitAsString - Whether to submit value as a string, rather than a primitive or complex type
-			 */
-			submitAsString: false,
-
-			/**
-			 * @member {boolean} isSortable - Whether this property type is sortable
-			 */
-			isSortable: true,
-			
-			/**
-			 * @member {boolean} isTempId - Whether this property's ID is temporary
-			 */
-			isTempId: false,
-
-			// ##################################################################
-			// #### These next properties are only for OneBuild repositories ####
-			// ##################################################################
-
-			/**
-			 * @member {boolean} isVirtual - Whether this property represents a virtual field on server
-			 */
-			isVirtual: false,
-			
-			/**
-			 * @member {string} title - The human-readable title for this property
-			 */
-			title: null,
-			
-			/**
-			 * @member {string} tooltip - The human-readable tooltip for this property
-			 */
-			tooltip: null,
-			
-			/**
-			 * @member {string} fieldGroup - The field group for this property
-			 */
-			fieldGroup: null,
-
-			/**
-			 * @member {boolean} isForeignModel - Whether this property belongs to a foreign model
-			 */
-			isForeignModel: false,
-			
-			/**
-			 * @member {object} filterType - The UI filter type of this property
-			 */
-			filterType: null,
-
-			/**
-			 * @member {boolean} isFilteringDisabled - Whether this property is disabled for UI filtering
-			 */
-			isFilteringDisabled: false,
-			
-			/**
-			 * @member {object} viewerType - The UI viewer type of this property
-			 */
-			viewerType: null,
-			
-			/**
-			 * @member {object} editorType - The UI editor type of this property
-			 */
-			editorType: null,
-
-			/**
-			 * @member {boolean} isEditingDisabled - Whether this property is disabled for UI editing
-			 */
-			isEditingDisabled: false,
-
-		};
-		
-		_.merge(this, defaults, config);
+		_.merge(this, Property.defaults, config);
 		this._originalConfig = config;
 
 		this.registerEvents([
@@ -186,6 +187,15 @@ export default class Property extends EventEmitter {
 	// / /_/ /  __/ /_/ /_/  __/ /  (__  )
 	// \____/\___/\__/\__/\___/_/  /____/
 
+	/**
+	 * 
+	 * @param {object} defaults - Optional defaults to merge with Property.defaults
+	 * @returns {object} Merged defaults
+	 */
+	static getStaticDefaults(defaults = {}) {
+		return _.merge({}, Property.defaults, defaults);
+	}
+
 
 	/**
 	 * Gets default value. Can be overridden to get dynamic default value.
@@ -206,7 +216,7 @@ export default class Property extends EventEmitter {
 	 * Gets "raw" value
 	 * @return {any} rawValue
 	 */
-	getRawValue = () => {
+	getRawValue() {
 		if (this.isDestroyed) {
 			throw Error('this.getRawValue is no longer valid. Property has been destroyed.');
 		}
@@ -217,7 +227,7 @@ export default class Property extends EventEmitter {
 	 * Gets "raw" value in its parsed form
 	 * @return {any} rawValue
 	 */
-	getParsedRawValue = () => {
+	getParsedRawValue() {
 		if (this.isDestroyed) {
 			throw Error('this.getParsedRawValue is no longer valid. Property has been destroyed.');
 		}
@@ -228,7 +238,7 @@ export default class Property extends EventEmitter {
 	 * Gets "parsed" value, without any formatting applied
 	 * @return {any} parsedValue
 	 */
-	getParsedValue = () => {
+	getParsedValue() {
 		if (this.isDestroyed) {
 			throw Error('this.getParsedValue is no longer valid. Property has been destroyed.');
 		}
@@ -239,7 +249,7 @@ export default class Property extends EventEmitter {
 	 * Gets parsed value, formatted for submission to server
 	 * @return {any} parsedValue
 	 */
-	getSubmitValue = () => {
+	getSubmitValue() {
 		if (this.isDestroyed) {
 			throw Error('this.getSubmitValue is no longer valid. Property has been destroyed.');
 		}
@@ -264,7 +274,7 @@ export default class Property extends EventEmitter {
 	 * Gets parsed value, formatted for displaying to user
 	 * @return {any} _displayValue
 	 */
-	getDisplayValue = () => {
+	getDisplayValue() {
 		if (this.isDestroyed) {
 			throw Error('this.getDisplayValue is no longer valid. Property has been destroyed.');
 		}
@@ -373,7 +383,7 @@ export default class Property extends EventEmitter {
 	 * @param {any} rawValue - Value to parse
 	 * @return {boolean} isChanged - Whether or not the parsedValue was changed
 	 */
-	setValue = (rawValue) => {
+	setValue(rawValue) {
 		if (this.isDestroyed) {
 			throw Error('this.setValue is no longer valid. Property has been destroyed.');
 		}
@@ -408,7 +418,7 @@ export default class Property extends EventEmitter {
 	 * @param {any} value - Value to parse
 	 * @return {any} value - Parsed value. NOTE: for the Property base class, no parsing actually takes place!
 	 */
-	parse = (value) => {
+	parse(value) {
 		if (this.isDestroyed) {
 			throw Error('this.parse is no longer valid. Property has been destroyed.');
 		}
@@ -432,7 +442,7 @@ export default class Property extends EventEmitter {
 	 * Sets value of submitAsString
 	 * @param {boolean} bool - New value of submitAsString
 	 */
-	setSubmitAsString = (bool) => {
+	setSubmitAsString(bool) {
 		if (this.isDestroyed) {
 			throw Error('this.setSubmitAsString is no longer valid. Property has been destroyed.');
 		}
@@ -443,7 +453,7 @@ export default class Property extends EventEmitter {
 	 * Gets the Entity object
 	 * @return {object} _entity - Entity
 	 */
-	getEntity = () => {
+	getEntity() {
 		if (this.isDestroyed) {
 			throw Error('this.getEntity is no longer valid. Property has been destroyed.');
 		}
@@ -454,7 +464,7 @@ export default class Property extends EventEmitter {
 	 * Gets the className of this Property type.
 	 * @return {string} className
 	 */
-	getClassName = () => {
+	getClassName() {
 		if (this.isDestroyed) {
 			throw Error('this.getClassName is no longer valid. Property has been destroyed.');
 		}
@@ -465,7 +475,7 @@ export default class Property extends EventEmitter {
 	 * Gets the mapped name of this Property.
 	 * @return {string} name
 	 */
-	getMapping = () => {
+	getMapping() {
 		if (this.isDestroyed) {
 			throw Error('this.getMapping is no longer valid. Property has been destroyed.');
 		}
@@ -479,7 +489,7 @@ export default class Property extends EventEmitter {
 	 * - Removes event listeners
 	 * @fires destroy
 	 */
-	destroy = () => {
+	destroy() {
 		// parent objects
 		this._entity = null;
 
@@ -495,7 +505,7 @@ export default class Property extends EventEmitter {
 		this.removeAllListeners();
 	}
 
-	toString = () => {
+	toString() {
 		if (this.isDestroyed) {
 			throw Error('this.toString is no longer valid. Property has been destroyed.');
 		}

package/src/Property/String.js

@@ -12,11 +12,6 @@ const TEMP_PREFIX = 'TEMP-';
  */
 export default class StringProperty extends Property {
 
-	constructor(config = {}) {
-		super(...arguments);
-		_.merge(this, config);
-	}
-
 	/**
 	 * Parses value to string.
 	 * - Strings will pass through unaltered.
@@ -25,14 +20,14 @@ export default class StringProperty extends Property {
 	 * @param {any} value
 	 * @return {string} parsedValue
 	 */
-	parse = (value) => {
+	parse(value) {
 		if (this.isDestroyed) {
 			throw Error('this.parse is no longer valid. Property has been destroyed.');
 		}
 		return Parsers.ParseString(value);
 	}
 
-	newId = () => {
+	newId() {
 		let id,
 			hasId = false;
 

package/src/Property/Time.js

@@ -9,16 +9,25 @@ import _ from 'lodash';
  */
 export default class TimeProperty extends DateProperty {
 
-	constructor(config = {}) {
-		super(...arguments);
+	static defaults = {
+		readFormat: 'HH:mm:ss',
+		displayFormat: 'HH:mm:ss',
+		submitFormat: 'HH:mm:ss',
+	};
 
-		const defaults = {
-			readFormat: 'HH:mm:ss',
-			displayFormat: 'HH:mm:ss',
-			submitFormat: 'HH:mm:ss',
-		};
+	constructor(config = {}, entity) {
+		config = _.merge({}, TimeProperty.defaults, config);
+		super(config, entity);
+	}
 
-		_.merge(this, defaults, config);
+	/**
+	 * 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, TimeProperty.defaults, defaults);
 	}
 	
 };

package/src/Property/Uuid.js

@@ -14,11 +14,6 @@ import _ from 'lodash';
  * @extends Property
  */
 export default class UuidProperty extends Property {
-	
-	constructor(config = {}) {
-		super(...arguments);
-		_.merge(this, config);
-	}
 
 	/**
 	 * Gets default value.
@@ -36,21 +31,21 @@ export default class UuidProperty extends Property {
 	/**
 	 * Generates a new UUID
 	 */
-	newId = () => {
+	newId() {
 		return uuid();
 	}
 
 	/**
 	 * Validates a UUID
 	 */
-	isValid = (value) => {
+	isValid(value) {
 		return validate(value);
 	}
 
 	/**
 	 * Determines whether a given UUID is empty (i.e. all zeros)
 	 */
-	isEmpty = (value) => {
+	isEmpty(value) {
 		if (_.isNil(value)) {
 			value = this.submitValue;
 		}

package/src/Property/index.js

@@ -11,6 +11,7 @@ import IntegerProperty from './Integer.js';
 import JsonProperty, { TagProperty } from './Json.js';
 import PercentProperty from './Percent.js';
 import PercentIntProperty from './PercentInt.js';
+import Property from './Property.js';
 import StringProperty from './String.js';
 import TimeProperty from './Time.js';
 import UuidProperty from './Uuid.js';
@@ -27,6 +28,7 @@ const PropertyTypes = {
 	[JsonProperty.type]: JsonProperty,
 	[PercentProperty.type]: PercentProperty,
 	[PercentIntProperty.type]: PercentIntProperty,
+	[Property.type]: Property,
 	[StringProperty.type]: StringProperty,
 	[TagProperty.type]: TagProperty,
 	[TimeProperty.type]: TimeProperty,