@onehat/data 1.8.9 → 1.8.12

package/cypress/integration/Entity.spec.js

@@ -232,6 +232,17 @@ describe('Entity', function() {
 			expect(_.isEqual(this.entity.rawValues, expected)).to.be.true;
 		});
 
+		it('getParsedRawValues & parsedRawValues', function() {
+			const result = this.entity.getParsedRawValues(),
+				expected = {
+					foo: 1,
+					bar: 'one',
+					baz: true,
+				};
+			expect(_.isEqual(result, expected)).to.be.true;
+			expect(_.isEqual(this.entity.parsedRawValues, expected)).to.be.true;
+		});
+
 		it('getParsedValues & parsedValues', function() {
 			const result = this.entity.getParsedValues(),
 				expected = {
@@ -620,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.9",
+	"version": "1.8.12",
 	"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 {
@@ -584,7 +593,7 @@ class Entity extends EventEmitter {
 	 */
 	getRawValues = () => {
 		if (this.isDestroyed) {
-			throw Error('this.getSubmitValues is no longer valid. Entity has been destroyed.');
+			throw Error('this.getRawValues is no longer valid. Entity has been destroyed.');
 		}
 		let propertyValues = {};
 		_.forOwn(this.properties, (property) => {
@@ -604,6 +613,33 @@ class Entity extends EventEmitter {
 		return this.getRawValues();
 	}
 
+	/**
+	 * Gets an object of values for this Entity,
+	 * Values are the "raw" values in their parsed form, not the "parsed" or "submit" or "display" values.
+	 * @return {object} propertyValues
+	 */
+	getParsedRawValues = () => {
+		if (this.isDestroyed) {
+			throw Error('this.getParsedRawValues is no longer valid. Entity has been destroyed.');
+		}
+		let propertyValues = {};
+		_.forOwn(this.properties, (property) => {
+			propertyValues[property.name] = property.getParsedRawValue();
+		});
+		return propertyValues;
+	}
+
+	/**
+	 * Gets "raw" values in their parsed form for this Entity.
+	 * @return {object} values
+	 */
+	get parsedRawValues() {
+		if (this.isDestroyed) {
+			throw Error('this.parsedRawValues is no longer valid. Entity has been destroyed.');
+		}
+		return this.getParsedRawValues();
+	}
+
 	/**
 	 * Gets an object of values for this Entity,
 	 * Values are the "parsed" values, not the "raw" or "submit" or "display" values.
@@ -726,7 +762,7 @@ class Entity extends EventEmitter {
 	 */
 	getChanged = () => {
 		const original = this._originalDataParsed,
-			current = this.getRawValues(),
+			current = this.getParsedRawValues(),
 			diff = Object.keys(original).reduce((result, key) => { // from https://stackoverflow.com/a/40610459/9163076
 				if (current && !current.hasOwnProperty(key)) {
 					result.push(key);
@@ -984,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();
 
@@ -1018,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.');
 		}
@@ -1034,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.');
 		}
@@ -1068,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.');
 		}
@@ -1129,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.');
 		}
@@ -1142,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.');
 		}
@@ -1157,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.');
 		}
@@ -1168,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.');
 		}
@@ -1184,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.');
 		}
@@ -1200,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.');
 		}
@@ -1213,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
@@ -1221,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/Property/Property.js

@@ -183,7 +183,7 @@ export default class Property extends EventEmitter {
 	}
 
 	/**
-	 * Gets "raw" value, prior to any parsing
+	 * Gets "raw" value
 	 * @return {any} rawValue
 	 */
 	getRawValue = () => {
@@ -193,6 +193,17 @@ export default class Property extends EventEmitter {
 		return this.rawValue;
 	}
 
+	/**
+	 * Gets "raw" value in its parsed form
+	 * @return {any} rawValue
+	 */
+	getParsedRawValue = () => {
+		if (this.isDestroyed) {
+			throw Error('this.getParsedRawValue is no longer valid. Property has been destroyed.');
+		}
+		return this.parse(this.rawValue);
+	}
+
 	/**
 	 * Gets "parsed" value, without any formatting applied
 	 * @return {any} parsedValue

package/src/Repository/LocalFromRemote/LocalFromRemote.js

@@ -285,7 +285,7 @@ class LocalFromRemoteRepository extends EventEmitter {
 	/**
 	 * Syncs local and remote repositories, based on operation mode.
 	 */
-	sync = async (entity) => {
+	sync = async (entity, callback = null) => {
 		try {
 			if (!this.isOnline) {
 				this._doAutoSync(true);
@@ -405,6 +405,9 @@ class LocalFromRemoteRepository extends EventEmitter {
 		} finally {
 			this.isSyncing = false;
 			this.emit('endSync', this);
+			if (callback) {
+				callback();
+			}
 		}
 	
 	}