@onehat/data 1.19.40 → 1.20.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@onehat/data",
-	"version": "1.19.40",
+	"version": "1.20.0",
 	"description": "JS data modeling package with adapters for many storage mediums.",
 	"main": "src/index.js",
 	"type": "module",
@@ -47,6 +47,7 @@
 		"moment": "^2.29.4",
 		"natsort": "^2.0.3",
 		"numeral": "^2.0.6",
+		"object-hash": "^3.0.0",
 		"qs": "^6.11.2",
 		"relative-time-parser": "^1.0.15",
 		"uuid": "^9.0.1"

package/src/Entity/Entity.js

@@ -3,6 +3,7 @@
 import EventEmitter from '@onehat/events';
 import PropertyTypes from '../Property/index.js';
 import moment from 'moment';
+import hash from 'object-hash';
 import _ from 'lodash';
 
 /**
@@ -104,6 +105,11 @@ class Entity extends EventEmitter {
 		 */
 		this.properties = [];
 
+		/**
+		 * @member {string} hash - A hash of this.submitValues, so we can detect changes
+		 */
+		this.hash = null;
+
 		/**
 		 * @member {boolean} isTree - Whether this Entity is a TreeNode
 		 */
@@ -254,11 +260,22 @@ class Entity extends EventEmitter {
 		return this._proxy; // Return the Proxy, not 'this'
 	}
 
+	/**
+	 * Decorator for parent emit() method so we can rehash
+	 */
+	emit(name) { // NOTE: Purposefully do not use an arrow-function, so we have access to arguments
+		
+		this.rehash();
+		
+		return super.emit(...arguments);
+	}
+
 	initialize() {
 		this.properties = this._createProperties();
 		this._createMethods();
 		this._createStatics();
 		this.reset();
+		this.rehash();
 		this.isInitialized = true;
 	}
 
@@ -1022,47 +1039,6 @@ class Entity extends EventEmitter {
 		return !_.isEqualWith(this._originalDataParsed, this.getParsedValues());
 	}
 
-	/**
-	 * Gets the a hash of the current submitValues.
-	 * This allows easy detection of changes in data.
-	 * @return {integer} hash
-	 */
-	getHash = () => {
-		if (this.isDestroyed) {
-			throw Error('this.getHash is no longer valid. Entity has been destroyed.');
-		}
-
-		const str = JSON.stringify(_.merge({}, this.submitValues, {
-			// include Entity state in hash
-			isDestroyed: this.isDestroyed,
-			isPhantom: this.isPhantom,
-			isDirty: this.isDirty,
-			isTempId: this.isTempId,
-		}));
-
-		// from https://github.com/bryc/code/blob/master/jshash/experimental/cyrb53.js
-		const seed = 0;
-		let h1 = 0xdeadbeef ^ seed, h2 = 0x41c6ce57 ^ seed;
-		for (let i = 0, ch; i < str.length; i++) {
-			ch = str.charCodeAt(i);
-			h1 = Math.imul(h1 ^ ch, 2654435761);
-			h2 = Math.imul(h2 ^ ch, 1597334677);
-		}
-		h1 = Math.imul(h1 ^ (h1>>>16), 2246822507) ^ Math.imul(h2 ^ (h2>>>13), 3266489909);
-		h2 = Math.imul(h2 ^ (h2>>>16), 2246822507) ^ Math.imul(h1 ^ (h1>>>13), 3266489909);
-		const hash = 4294967296 * (2097151 & h2) + (h1>>>0);
-
-		return hash;
-	}
-
-	/**
-	 * Getter of the hash for this Entity.
-	 * @return {integer} hash
-	 */
-	get hash() {
-		return this.getHash();
-	}
-
 	/**
 	 * Gets the original data object for this Entity.
 	 * This is either what was persisted to storage medium, or what was
@@ -1817,6 +1793,22 @@ class Entity extends EventEmitter {
 		return true;
 	}
 
+	/**
+	 * Sets the hash of the current submitValues and state.
+	 * This allows easy detection of changes in data.
+	 * @return {integer} hash
+	 */
+	rehash = () => {
+		const toHash = JSON.stringify(_.merge({}, this.submitValues, {
+			// include Entity state in hash
+			isDestroyed: this.isDestroyed,
+			isPhantom: this.isPhantom,
+			isDirty: this.isDirty,
+			isTempId: this.isTempId,
+		}));
+		this.hash = hash(toHash);
+	}
+
 
 	/**
 	 * Destroy this object.

package/src/Property/Boolean.js

@@ -53,6 +53,13 @@ export default class BooleanProperty extends Property {
 		return Parsers.ParseBool(this.parsedValue); // Use a Parser instead of a Formatter to make sure we submit it as an actual boolean primitive value
 	}
 
+	toggle = () => {
+		if (this.isDestroyed) {
+			throw Error('this.toggle is no longer valid. Property has been destroyed.');
+		}
+		this.parsedValue = !this.parsedValue;
+	}
+
 };
 
 BooleanProperty.className = 'Boolean';

package/src/Repository/OneBuild.js

@@ -611,6 +611,7 @@ class OneBuildRepository extends AjaxRepository {
 
 				
 				// Don't emit events for root nodes...
+				this.rehash();
 				this.emit('load', this);
 				// this.emit('changeData', this.entities);
 
@@ -693,6 +694,7 @@ class OneBuildRepository extends AjaxRepository {
 				
 				this._setPaginationVars();
 
+				this.rehash();
 				// this.emit('changeData', this.entities);
 				this.emit('load', this);
 
@@ -773,6 +775,7 @@ class OneBuildRepository extends AjaxRepository {
 				
 				this._setPaginationVars();
 
+				this.rehash();
 				// this.emit('changeData', this.entities);
 				this.emit('load', this);
 

package/src/Repository/Repository.js

@@ -8,6 +8,7 @@ import {
 } from 'uuid';
 import moment from 'moment';
 import { waitUntil } from 'async-wait-until';
+import hash from 'object-hash';
 import _ from 'lodash';
 
 /**
@@ -113,6 +114,11 @@ export default class Repository extends EventEmitter {
 			 */
 			isShowingMore: false,
 
+			/**
+			 * @member {string} hash - A hash of this.entities, so we can detect changes
+			 */
+			hash: null,
+
 			/**
 			 * @member {number} pageSize - Max number of entities per page
 			 * Example: For "Showing 21-30 of 45" This would be 10
@@ -284,6 +290,19 @@ export default class Repository extends EventEmitter {
 		]);
 	}
 
+	/**
+	 * Decorator for parent emit() method
+	 * so we can rehash on changeData events
+	 */
+	emit(name) { // NOTE: Purposefully do not use an arrow-function, so we have access to arguments
+		
+		if (name === 'changeData') {
+			this.rehash();
+		}
+
+		return super.emit(...arguments);
+	}
+
 	/**
 	 * Initializes the Repository.
 	 * - Applies default sorters
@@ -318,6 +337,7 @@ export default class Repository extends EventEmitter {
 		if (init) {
 			await init.call(this);
 		}
+		this.rehash();
 
 		this.isInitialized = true;
 		this.emit('initialize');
@@ -2123,6 +2143,11 @@ export default class Repository extends EventEmitter {
 		_.merge(this, options);
 	}
 
+	rehash = () => {
+		const hashes = _.map(this.entities, (entity) => entity.hash);
+		this.hash = hash(hashes);
+	}
+
 	unmapData = (mappedData) => {
 		const propertiesDef = this.schema?.model?.properties;
 		if (!propertiesDef) {