@onehat/data 1.9.2 → 1.10.0

package/cypress/integration/Entity.spec.js

@@ -1,3 +1,4 @@
+import Joi from 'Joi';
 import Entity from '../../src/Entity.js';
 import Schema from '../../src/Schema/index.js';
 import PropertyTypes from '../../src/Property/index.js';
@@ -16,13 +17,17 @@ describe('Entity', function() {
 					{ name: 'bar' },
 					{ name: 'baz', mapping: 'baz.test.val', type: 'bool', defaultValue: null, },
 				],
+				validator: null,
 			},
 			entity: {
 				methods: {
 					testMethod: function() {
-						this.bar = 'test me';
+						this.azx = 'test me';
 					},
 				},
+				statics: {
+					azx: null,
+				},
 			},
 		});
 		this.data = {
@@ -116,7 +121,7 @@ describe('Entity', function() {
 
 		it('_createMethods', function() {
 			this.entity.testMethod();
-			expect(this.entity.bar).to.be.eq('test me');
+			expect(this.entity.azx).to.be.eq('test me');
 		});
 		
 		it('loadOriginalData', function() {
@@ -737,7 +742,42 @@ describe('Entity', function() {
 			property.setValue('Test');
 			expect(didFire).to.be.true;
 		});
+	});
+
+	describe('validators', function() {
+
+		it('whole validation process', function() {
+			let didFire = false;
+			this.entity.on('changeValidity', (entity) => {
+				didFire = true;
+			});
 
+			// Initial condition
+			expect(this.entity.isValid).to.be.null;
+
+			// Add validators
+			this.schema.model.validator = Joi.object({
+				foo: Joi.number()
+						.integer(),
+				bar: Joi.string()
+						.alphanum()
+						.required(),
+				baz: Joi.any(),
+			});
+			const result = this.entity.validate();
+			expect(result).to.be.true;
+
+			// Set a property to be invalid
+			this.entity.bar = null;
+			expect(didFire).to.be.true;
+			expect(this.entity.isValid).to.be.false;
+			expect(this.entity.validationError).to.match(/"bar" must be a string/);
+
+			// Restore validity
+			this.entity.bar = 'test';
+			expect(this.entity.isValid).to.be.true;
+			expect(this.entity.validationError).to.be.null;
+		});
 	});
 
 });

package/cypress/integration/OneHatData.spec.js

@@ -12,6 +12,15 @@ async function beforeEach() {
 	this.oneHatData = new OneHatData();
 	this.schema = this.oneHatData.createSchema({
 		name: 'bar',
+		model: {
+			idProperty: 'key',
+			displayProperty: 'value',
+			properties: [
+				{ name: 'key', },
+				{ name: 'value', },
+			],
+		},
+		repository: 'memory',
 	});
 	await this.oneHatData.createRepository({
 		id: 'foo',
@@ -334,6 +343,23 @@ describe('OneHatData', function() {
 		})();
 	});
 
+	it('isEntity', async function() {
+		(async function() {
+			debugger;
+			await beforeEach();
+			const oneHatData = this.oneHatData;
+			const repository = oneHatData.getRepository('bar');
+			const entity = await repository.add({ key: 1, value: 'value', });
+
+			expect(isEntity(entity)).to.be.true;
+			expect(isEntity({})).to.be.false;
+			expect(isEntity(2)).to.be.false;
+			expect(isEntity([1,2])).to.be.false;
+
+			afterEach();
+		})();
+	});
+
 	it('destroy', function() {
 		(async function() {
 			await beforeEach();

package/cypress/integration/Property/Property.spec.js

@@ -1,3 +1,4 @@
+import Joi from 'Joi';
 import PropertyTypes from '../../../src/Property/index.js';
 import Entity from '../../../src/Entity.js';
 import Schema from '../../../src/Schema/index.js';
@@ -233,4 +234,51 @@ describe('Property', function() {
 
 	});
 
+	describe('validators', function() {
+
+		it('whole validation process', function() {
+			let didFire = false;
+			this.property.on('changeValidity', (entity) => {
+				didFire = true;
+			});
+
+			// Initial condition
+			expect(this.property.isValid).to.be.null;
+
+			// Add validators
+			const schema = new Schema({
+					name: 'baz',
+					model: {
+						idProperty: 'foo',
+						displayProperty: 'bar',
+						properties: [
+							{ name: 'foo', type: 'int' },
+							{ name: 'bar' },
+						],
+						validator: Joi.object({
+							foo: Joi.number()
+									.integer(),
+						}),
+					},
+				}),
+				entity = new Entity(schema);
+			entity.initialize();
+			const property = entity.getProperty('foo');
+			property.setValue(2);
+
+			const result = property.validate();
+			expect(result).to.be.true;
+
+			// Set a property to be invalid
+			property.setValue(null);
+			expect(property.isValid).to.be.false;
+			expect(property.validationError).to.match(/"foo" must be a number/);
+
+			// Restore validity
+			property.setValue(2);
+			expect(property.isValid).to.be.true;
+			expect(property.validationError).to.be.null;
+		});
+	});
+
 });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@onehat/data",
-	"version": "1.9.2",
+	"version": "1.10.0",
 	"description": "JS data modeling package with adapters for many storage mediums.",
 	"main": "src/index.js",
 	"type": "module",
@@ -41,6 +41,7 @@
 		"chrono-node": "^2.4.2",
 		"fast-xml-parser": "^4.0.12",
 		"he": "^1.2.0",
+		"joi": "^17.7.0",
 		"js-base64": "^3.7.3",
 		"lodash": "^4.17.21",
 		"moment": "^2.29.4",

package/src/Entity.js

@@ -49,6 +49,7 @@ class Entity extends EventEmitter {
 		
 		this.registerEvents([
 			'change',
+			'changeValidity',
 			'reset',
 			'reload',
 			'save',
@@ -139,6 +140,17 @@ class Entity extends EventEmitter {
 		 * @member {string} isFrozen - Prevent the entity from being destroyed, but don't let it be changed either.
 		 */
 		this.isFrozen = false;
+
+		/**
+		 * @member {boolean} isValid - Whether this Entity passes validation
+		 * @private
+		 */
+		this.isValid = null;
+
+		/**
+		 * @member {object} validationError - Any error in last validation.
+		 */
+		this.validationError = null;
 		
 
 		// This ES6 Proxy allows us to create magic getters and setters for all property values.
@@ -268,7 +280,6 @@ class Entity extends EventEmitter {
 			}
 			const Property = PropertyTypes[type],
 				property = new Property(definition, this._proxy);
-			
 			property.on('change', this._onPropertyChange);
 			
 			properties[definition.name] = property;
@@ -286,6 +297,7 @@ class Entity extends EventEmitter {
 	 */
 	_onPropertyChange = () => {
 		this._recalculateDependentProperties();
+		this.validate();
 		this.emit('change', this._proxy);
 	}
 
@@ -1136,6 +1148,7 @@ class Entity extends EventEmitter {
 
 		if (isChanged) {
 			this._recalculateDependentProperties();
+			this.validate();
 			this.emit('change', this._proxy);
 		}
 		return isChanged;
@@ -1286,6 +1299,43 @@ class Entity extends EventEmitter {
 		this.isFrozen = true;
 	}
 
+
+	//  _    __      ___     __      __  _
+	// | |  / /___ _/ (_)___/ /___ _/ /_(_)___  ____
+	// | | / / __ `/ / / __  / __ `/ __/ / __ \/ __ \
+	// | |/ / /_/ / / / /_/ / /_/ / /_/ / /_/ / / / /
+	// |___/\__,_/_/_/\__,_/\__,_/\__/_/\____/_/ /_/
+
+	/**
+	 * Gets whether or not the Entity validates according to schema's validation rules
+	 * @return {boolean} isValid
+	 */
+	validate = () => {
+		if (this.isDestroyed) {
+			throw Error('this.validate is no longer valid. Entity has been destroyed.');
+		}
+
+		let isValid = null,
+			error;
+
+		if (this.schema.model.validator) {
+			const validationResult = this.schema.model.validator.validate(this.submitValues);
+			error = validationResult && validationResult.error || null;
+			isValid = !error;
+			if (this.validationError !== error) {
+				this.validationError = error;
+			}
+		}
+
+		if (this.isValid !== isValid) {
+			this.emit('changeValidity', this._proxy, isValid);
+			this.isValid = isValid;
+		}
+
+		return isValid;
+	}
+
+
 	/**
 	 * Destroy this object.
 	 * - Removes all circular references to parent objects

package/src/OneHatData.js

@@ -2,6 +2,7 @@
 
 import EventEmitter from '@onehat/events';
 import CoreRepositoryTypes from './Repository/index.js';
+import Entity from './Entity.js';
 import {
 	MODE_LOCAL_MIRROR,
 	MODE_COMMAND_QUEUE,
@@ -620,6 +621,24 @@ export class OneHatData extends EventEmitter {
 		return this;
 	}
 
+
+
+
+	//  _    __      ___     __      __     
+	// | |  / /___ _/ (_)___/ /___ _/ /____ 
+	// | | / / __ `/ / / __  / __ `/ __/ _ \
+	// | |/ / /_/ / / / /_/ / /_/ / /_/  __/
+	// |___/\__,_/_/_/\__,_/\__,_/\__/\___/
+
+	/**
+	 * Determines if submitted object is an entity
+	 * @return boolean
+	 */
+	isEntity = (obj) => {
+		return obj?.__proto__?.constructor === Entity;
+	}
+
+
 	/**
 	 * Destroy this object.
 	 * - Removes child objects

package/src/Property/Property.js

@@ -135,6 +135,7 @@ export default class Property extends EventEmitter {
 
 		this.registerEvents([
 			'change',
+			'changeValidity',
 			'destroy',
 		]);
 
@@ -148,17 +149,28 @@ export default class Property extends EventEmitter {
 		 * @member {any} rawValue - The raw value supplied to this property, *before* any parsing was applied
 		 */
 		this.rawValue = null;
-			
+		
 		/**
 		 * @member {any} parsedValue - The value for this property, *after* any parsing was applied
 		 */
 		this.parsedValue = null;
-			
+		
 		/**
 		 * @member {boolean} isDestroyed - Whether this object has been destroyed
 		 * @private
 		 */
 		this.isDestroyed = false;
+
+		/**
+		 * @member {boolean} isValid - Whether this Property passes validation
+		 * @private
+		 */
+		this.isValid = null;
+
+		/**
+		 * @member {object} validationError - Any error in last validation.
+		 */
+		this.validationError = null;
 		
 	}
 
@@ -357,6 +369,7 @@ export default class Property extends EventEmitter {
 		if (isChanged) {
 			this.rawValue = rawValue;
 			this.parsedValue = newValue;
+			this.validate();
 			this.emit('change', this, oldValue, newValue);
 		}
 
@@ -433,6 +446,43 @@ export default class Property extends EventEmitter {
 		return this.mapping;
 	}
 
+	//  _    __      ___     __      __  _
+	// | |  / /___ _/ (_)___/ /___ _/ /_(_)___  ____
+	// | | / / __ `/ / / __  / __ `/ __/ / __ \/ __ \
+	// | |/ / /_/ / / / /_/ / /_/ / /_/ / /_/ / / / /
+	// |___/\__,_/_/_/\__,_/\__,_/\__/_/\____/_/ /_/
+
+	/**
+	 * Gets whether or not the Property validates according to schema's validation rules
+	 * @return {boolean} isValid
+	 */
+	validate = () => {
+		if (this.isDestroyed) {
+			throw Error('this.validate is no longer valid. Entity has been destroyed.');
+		}
+
+		let isValid = null,
+			error;
+
+		if (this._entity?.schema?.model?.validator) {
+			const obj = {};
+			obj[this.name] = this.submitValue;
+			const validationResult = this._entity.schema.model.validator.validate(obj);
+			error = validationResult && validationResult.error || null;
+			isValid = !error;
+			if (this.validationError !== error) {
+				this.validationError = error;
+			}
+		}
+
+		if (this.isValid !== isValid) {
+			this.emit('changeValidity', this._proxy, isValid);
+			this.isValid = isValid;
+		}
+
+		return isValid;
+	}
+
 	/**
 	 * Destroy this object.
 	 * - Removes all circular references to parent objects

package/src/Schema/KeyValues.js

@@ -7,6 +7,13 @@ const KeyValues = new Schema({
 	model: {
 		idProperty: 'key',
 		displayProperty: 'value',
+		sorters: [
+			{
+				name: 'value',
+				direction: 'ASC',
+				fn: 'natsort',
+			}
+		],
 		properties: [
 			{ name: 'key', },
 			{ name: 'value', },

package/src/Schema/Schema.js

@@ -72,6 +72,11 @@ export default class Schema extends EventEmitter {
 				 */
 				sorters: [],
 
+				/**
+				 * @member {object} validators - A JOI schema. See JOI docs for more info (https://joi.dev)
+				 */
+				validator: null,
+
 				/**
 				 * @member {object} associations - List of associated Models
 				 */