@onehat/data 1.10.0 → 1.10.2

package/cypress/integration/Entity.spec.js

@@ -1,4 +1,5 @@
 import Joi from 'Joi';
+import * as yup from 'yup';
 import Entity from '../../src/Entity.js';
 import Schema from '../../src/Schema/index.js';
 import PropertyTypes from '../../src/Property/index.js';
@@ -746,37 +747,148 @@ describe('Entity', function() {
 
 	describe('validators', function() {
 
-		it('whole validation process', function() {
-			let didFire = false;
-			this.entity.on('changeValidity', (entity) => {
-				didFire = true;
-			});
+		it('Yup integration', function() {
+			(async () => {
+
+				// Recreate everything from beforeEach()
+				const schema = new Schema({
+						name: 'baz',
+						model: {
+							idProperty: 'foo',
+							displayProperty: 'bar',
+							properties: [
+								{ name: 'foo', type: 'int' },
+								{ name: 'bar' },
+								{ name: 'baz', mapping: 'baz.test.val', type: 'bool', defaultValue: null, },
+							],
+							validator: yup.object({
+								foo: yup.number()
+										.integer(),
+								bar: yup.string()
+										.required(),
+								baz: yup.mixed(),
+							}),
+						},
+						entity: {
+							methods: {
+								testMethod: function() {
+									this.azx = 'test me';
+								},
+							},
+							statics: {
+								azx: null,
+							},
+						},
+					}),
+					data = {
+						foo: 1,
+						bar: 'one',
+						baz: {
+							test: {
+								val: true,
+							},
+						},
+					},
+					entity = new Entity(schema, data);
+				entity.initialize();
+				// END recreate
 
-			// 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;
+				let didFire = false;
+				entity.on('changeValidity', (entity) => {
+					didFire = 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/);
+				// Initial condition
+				expect(entity.isValid).to.be.null;
+				await entity.validate();
+				expect(entity.isValid).to.be.true;
+				expect(didFire).to.be.true;
+
+				// Set a property to be invalid
+				entity.bar = null;
+				await entity.validate();
+				expect(entity.isValid).to.be.false;
+				expect(entity.validationError).to.match(/bar must be a `string`/);
+
+				// Restore validity
+				entity.bar = 'test';
+				await entity.validate();
+				expect(entity.isValid).to.be.true;
+				expect(!entity.validationError).to.be.true;
+				
+			})();
+		});
+
+		it('Joi integration', function() {
+			(async () => {
+
+				// Recreate everything from beforeEach()
+				const schema = new Schema({
+						name: 'baz',
+						model: {
+							idProperty: 'foo',
+							displayProperty: 'bar',
+							properties: [
+								{ name: 'foo', type: 'int' },
+								{ name: 'bar' },
+								{ name: 'baz', mapping: 'baz.test.val', type: 'bool', defaultValue: null, },
+							],
+							validator: Joi.object({
+								foo: Joi.number()
+										.integer(),
+								bar: Joi.string()
+										.required(),
+								baz: Joi.any(),
+							}),
+						},
+						entity: {
+							methods: {
+								testMethod: function() {
+									this.azx = 'test me';
+								},
+							},
+							statics: {
+								azx: null,
+							},
+						},
+					}),
+					data = {
+						foo: 1,
+						bar: 'one',
+						baz: {
+							test: {
+								val: true,
+							},
+						},
+					},
+					entity = new Entity(schema, data);
+				entity.initialize();
+				// END recreate
+
+				let didFire = false;
+				entity.on('changeValidity', (entity) => {
+					didFire = true;
+				});
 
-			// Restore validity
-			this.entity.bar = 'test';
-			expect(this.entity.isValid).to.be.true;
-			expect(this.entity.validationError).to.be.null;
+				// Initial condition
+				expect(entity.isValid).to.be.null;
+				await entity.validate();
+				expect(entity.isValid).to.be.true;
+				expect(didFire).to.be.true;
+
+				// Set a property to be invalid
+				entity.bar = null;
+				await entity.validate();
+				expect(entity.isValid).to.be.false;
+				expect(entity.validationError).to.match(/"bar" must be a string/);
+
+				// Restore validity
+				entity.bar = 'test';
+				await entity.validate();
+				expect(entity.isValid).to.be.true;
+				expect(!entity.validationError).to.be.true;
+				
+			})();
 		});
 	});
 

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

@@ -1,4 +1,3 @@
-import Joi from 'Joi';
 import PropertyTypes from '../../../src/Property/index.js';
 import Entity from '../../../src/Entity.js';
 import Schema from '../../../src/Schema/index.js';
@@ -234,51 +233,4 @@ 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.10.0",
+	"version": "1.10.2",
 	"description": "JS data modeling package with adapters for many storage mediums.",
 	"main": "src/index.js",
 	"type": "module",
@@ -41,7 +41,6 @@
 		"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",
@@ -64,6 +63,9 @@
 		"cypress": "5.2.0",
 		"ink-docstrap": "^1.3.2",
 		"jsdoc": "^4.0.0",
-		"webpack": "^5.75.0"
+		"webpack": "^5.75.0",
+		"joi": "^17.7.0",
+		"yup": "^0.32.11"
+
 	}
 }

package/src/Entity.js

@@ -297,7 +297,7 @@ class Entity extends EventEmitter {
 	 */
 	_onPropertyChange = () => {
 		this._recalculateDependentProperties();
-		this.validate();
+		this.isValid = null;
 		this.emit('change', this._proxy);
 	}
 
@@ -1148,7 +1148,7 @@ class Entity extends EventEmitter {
 
 		if (isChanged) {
 			this._recalculateDependentProperties();
-			this.validate();
+			this.isValid = null;
 			this.emit('change', this._proxy);
 		}
 		return isChanged;
@@ -1310,18 +1310,26 @@ class Entity extends EventEmitter {
 	 * Gets whether or not the Entity validates according to schema's validation rules
 	 * @return {boolean} isValid
 	 */
-	validate = () => {
+	validate = async () => {
 		if (this.isDestroyed) {
 			throw Error('this.validate is no longer valid. Entity has been destroyed.');
 		}
 
+		const submitValues = this.submitValues;
 		let isValid = null,
+			validationResult,
 			error;
 
 		if (this.schema.model.validator) {
-			const validationResult = this.schema.model.validator.validate(this.submitValues);
-			error = validationResult && validationResult.error || null;
-			isValid = !error;
+			const validator = this.schema.model.validator;
+			try {
+				validationResult = await validator.validate(submitValues);
+				error = validationResult.error; // Joi would populate 'error' if validation error. Yup would throw Error
+				isValid = !error; // 'error' would be truthy if Joi error occurs, would never *get* here if an error with Yup
+			} catch(e) {
+				error = e; // yup error only
+				isValid = false;
+			}
 			if (this.validationError !== error) {
 				this.validationError = error;
 			}

package/src/Property/Property.js

@@ -160,17 +160,6 @@ export default class Property extends EventEmitter {
 		 * @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;
 		
 	}
 
@@ -369,7 +358,6 @@ export default class Property extends EventEmitter {
 		if (isChanged) {
 			this.rawValue = rawValue;
 			this.parsedValue = newValue;
-			this.validate();
 			this.emit('change', this, oldValue, newValue);
 		}
 
@@ -446,43 +434,6 @@ 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/Schema.js

@@ -73,7 +73,7 @@ export default class Schema extends EventEmitter {
 				sorters: [],
 
 				/**
-				 * @member {object} validators - A JOI schema. See JOI docs for more info (https://joi.dev)
+				 * @member {object} validators - A validator schema. Could use Joi (https://joi.dev), Yup (https://github.com/jquense/yup), or another comparable library
 				 */
 				validator: null,