@onehat/data 1.8.11 → 1.8.14

package/cypress/integration/Entity.spec.js

@@ -631,6 +631,22 @@ describe('Entity', function() {
 			lateLastModified = this.entity.lastModified;
 			expect(earlyLastModified < lateLastModified).to.be.true;
 		});
+	
+		it('freeze', function() {
+			this.entity.freeze();
+			expect(this.entity.isFrozen).to.be.true;
+
+			this.entity.destroy();
+			expect(this.entity.isDestroyed).to.be.false;
+
+			let isError = false;
+			try {
+				this.entity.foo = 2;
+			} catch(e) {
+				isError = true;
+			}
+			expect(isError).to.be.true;
+		});
 	});
 
 	describe('events', function() {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@onehat/data",
-	"version": "1.8.11",
+	"version": "1.8.14",
 	"description": "JS data modeling package with adapters for many storage mediums.",
 	"main": "src/index.js",
 	"type": "module",

package/src/Entity.js

@@ -135,6 +135,12 @@ class Entity extends EventEmitter {
 		 */
 		this.lastModified = null;
 
+		/**
+		 * @member {string} isFrozen - Prevent the entity from being destroyed, but don't let it be changed either.
+		 */
+		this.isFrozen = false;
+		
+
 		// This ES6 Proxy allows us to create magic getters and setters for all property values.
 		// However, these getters and setters are *not* available within the Entity itself.
 		this._proxy = new Proxy(this, {
@@ -151,6 +157,9 @@ class Entity extends EventEmitter {
 				return Reflect.get(target, name, receiver);
 			},
 			set (target, name, value, receiver) {
+				if (this.isFrozen) {
+					throw Error('Entity is frozen.');
+				}
 				if (!Reflect.has(target, name)) {
 					target.setValue(name, value);
 				} else {
@@ -1011,6 +1020,9 @@ class Entity extends EventEmitter {
 	 * @return {boolean} isChanged - Whether id was actually changed
 	 */
 	setId = (id, force = false) => {
+		if (this.isFrozen) {
+			throw Error('Entity is frozen.');
+		}
 		let isChanged = false;
 		const idProperty = this.getIdProperty();
 
@@ -1045,6 +1057,9 @@ class Entity extends EventEmitter {
 	 * @return {boolean} isChanged - Whether any values were actually changed
 	 */
 	setValue = (propertyName, rawValue) => {
+		if (this.isFrozen) {
+			throw Error('Entity is frozen.');
+		}
 		if (this.isDestroyed) {
 			throw Error('this.setValue is no longer valid. Entity has been destroyed.');
 		}
@@ -1061,6 +1076,9 @@ class Entity extends EventEmitter {
 	 * @return {boolean} isChanged - Whether any values were actually changed
 	 */
 	 setRawValues = (rawData) => {
+		if (this.isFrozen) {
+			throw Error('Entity is frozen.');
+		}
 		if (this.isDestroyed) {
 			throw Error('this.setRawValues is no longer valid. Entity has been destroyed.');
 		}
@@ -1095,6 +1113,9 @@ class Entity extends EventEmitter {
 	 * @fires change
 	 */
 	setValues = (data) => {
+		if (this.isFrozen) {
+			throw Error('Entity is frozen.');
+		}
 		if (this.isDestroyed) {
 			throw Error('this.setValues is no longer valid. Entity has been destroyed.');
 		}
@@ -1156,6 +1177,9 @@ class Entity extends EventEmitter {
 	 * @fires save
 	 */
 	save = () => {
+		if (this.isFrozen) {
+			throw Error('Entity is frozen.');
+		}
 		if (this.isDestroyed) {
 			throw Error('this.save is no longer valid. Entity has been destroyed.');
 		}
@@ -1169,6 +1193,9 @@ class Entity extends EventEmitter {
 	 * Marks an entity as having been saved to storage medium.
 	 */
 	markSaved = () => {
+		if (this.isFrozen) {
+			throw Error('Entity is frozen.');
+		}
 		if (this.isDestroyed) {
 			throw Error('this.markSaved is no longer valid. Entity has been destroyed.');
 		}
@@ -1184,6 +1211,9 @@ class Entity extends EventEmitter {
 	 * @param {boolean} bool - How it should be marked. Defaults to true.
 	 */
 	markDeleted = (bool = true) => {
+		if (this.isFrozen) {
+			throw Error('Entity is frozen.');
+		}
 		if (this.isDestroyed) {
 			throw Error('this.markDeleted is no longer valid. Entity has been destroyed.');
 		}
@@ -1195,6 +1225,9 @@ class Entity extends EventEmitter {
 	 * @fires delete
 	 */
 	delete = () => {
+		if (this.isFrozen) {
+			throw Error('Entity is frozen.');
+		}
 		if (this.isDestroyed) {
 			throw Error('this.delete is no longer valid. Entity has been destroyed.');
 		}
@@ -1211,6 +1244,9 @@ class Entity extends EventEmitter {
 	 * @fires delete
 	 */
 	undelete = () => {
+		if (this.isFrozen) {
+			throw Error('Entity is frozen.');
+		}
 		if (this.isDestroyed) {
 			throw Error('this.undelete is no longer valid. Entity has been destroyed.');
 		}
@@ -1227,6 +1263,9 @@ class Entity extends EventEmitter {
 	 * @param {boolean} bool - How it should be marked. Defaults to true.
 	 */
 	markStaged = (bool = true) => {
+		if (this.isFrozen) {
+			throw Error('Entity is frozen.');
+		}
 		if (this.isDestroyed) {
 			throw Error('this.markStaged is no longer valid. Entity has been destroyed.');
 		}
@@ -1240,6 +1279,13 @@ class Entity extends EventEmitter {
 		this.markStaged(true);
 	}
 
+	/**
+	 * Prevent the entity from being destroyed, but don't let it be changed either.
+	 */
+	freeze = () => {
+		this.isFrozen = true;
+	}
+
 	/**
 	 * Destroy this object.
 	 * - Removes all circular references to parent objects
@@ -1248,6 +1294,9 @@ class Entity extends EventEmitter {
 	 * @fires destroy
 	 */
 	destroy = () => {
+		if (this.isFrozen) {
+			return;
+		}
 		this._id = this.id; // save id, so we can query it later--even on a destroyed entity
 
 		// parent objects

package/src/Repository/Repository.js

@@ -716,10 +716,12 @@ export default class Repository extends EventEmitter {
 			isChanged = true;
 			this.filters = filters;
 			this.resetPagination();
-			this.emit('changeFilters');
+			let ret;
 			if (this._onChangeFilters) {
-				return this._onChangeFilters();
+				ret = this._onChangeFilters();
 			}
+			this.emit('changeFilters');
+			return ret;
 		}
 		return isChanged;
 	}

package/src/Util/Parsers.js

@@ -1,7 +1,7 @@
 import moment from 'moment';
 import momentAlt from 'relative-time-parser'; // Notice this version of moment is imported from 'relative-time-parser', and may be out of sync with our general 'moment' package
 import accounting from 'accounting-js';
-import * as chrono from 'chrono-node';
+// import * as chrono from 'chrono-node';
 import _ from 'lodash';
 
 class Parsers {
@@ -90,16 +90,16 @@ class Parsers {
 			result = moment(value, format);
 		} catch(err) {}
 		
-		if (!result || !result.isValid()) {
-			// try using chrono
-			const parsed = chrono.parse(value);
-			if (parsed && parsed[0] && parsed[0].date) {
-				const dateString = parsed[0].date();
-				try {
-					result = moment(dateString);
-				} catch(err) {}
-			}
-		}
+		// if ((!result || !result.isValid() && chrono)) {
+		// 	// try using chrono
+		// 	const parsed = chrono.parse(value);
+		// 	if (parsed && parsed[0] && parsed[0].date) {
+		// 		const dateString = parsed[0].date();
+		// 		try {
+		// 			result = moment(dateString);
+		// 		} catch(err) {}
+		// 	}
+		// }
 		return result;
 	}