@onehat/data 1.7.6 → 1.7.10

package/cypress/integration/Entity.spec.js

@@ -347,6 +347,18 @@ describe('Entity', function() {
 			expect(_.isEqual(result, expected)).to.be.true;
 		});
 
+		it('getChangedValues', function() {
+			this.entity.foo = 2;
+			const result = this.entity.getChangedValues(),
+				expected = {
+					foo: {
+						original: 1,
+						current: 2,
+					},
+				};
+			expect(_.isEqual(result, expected)).to.be.true;
+		});
+
 		it('data', function() {
 			const result = this.entity.data,
 				expected = {

package/package.json

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

package/src/Entity.js

@@ -158,6 +158,7 @@ class Entity extends EventEmitter {
 	initialize = () => {
 		this.properties = this._createProperties();
 		this._createMethods();
+		this._createStatics();
 		this.reset();
 		this.isInitialized = true;
 	}
@@ -170,14 +171,30 @@ class Entity extends EventEmitter {
 		if (this.isDestroyed) {
 			throw Error('this._createMethods is no longer valid. Entity has been destroyed.');
 		}
-		const methodDefinitions = this.schema.entity.methods;
-		if (!_.isEmpty(methodDefinitions)) {
-			_.each(methodDefinitions, (method, name) => {
+		const methodsDefinitions = this.schema.entity.methods;
+		if (!_.isEmpty(methodsDefinitions)) {
+			_.each(methodsDefinitions, (method, name) => {
 				this[name] = method; // NOTE: Methods must be defined in schema as "function() {}", not as "() => {}" so "this" will be assigned correctly
 			});
 		}
 	}
 
+	/**
+	 * Creates the static properties for this Entity, based on Schema.
+	 * @private
+	 */
+	 _createStatics = () => {
+		if (this.isDestroyed) {
+			throw Error('this._createStatics is no longer valid. Entity has been destroyed.');
+		}
+		const staticsDefinitions = this.schema.entity.statics;
+		if (!_.isEmpty(staticsDefinitions)) {
+			_.each(staticsDefinitions, (value, key) => {
+				this[key] = value;
+			});
+		}
+	}
+
 	/**
 	 * Generates a new unique id and assigns it to this entity.
 	 */
@@ -694,21 +711,39 @@ class Entity extends EventEmitter {
 	 * @return {array|boolean} diff - Array of property names that have changed, or false
 	 */
 	getChanged = () => {
-		const obj1 = this._originalDataParsed,
-			obj2 = this.getRawValues(),
-			diff = Object.keys(obj1).reduce((result, key) => { // from https://stackoverflow.com/a/40610459/9163076
-				if (obj2 && !obj2.hasOwnProperty(key)) {
+		const original = this._originalDataParsed,
+			current = this.getRawValues(),
+			diff = Object.keys(original).reduce((result, key) => { // from https://stackoverflow.com/a/40610459/9163076
+				if (current && !current.hasOwnProperty(key)) {
 					result.push(key);
-				} else if (_.isEqual(obj1[key], obj2[key])) {
+				} else if (_.isEqual(original[key], current[key])) {
 					const resultKeyIndex = result.indexOf(key);
 					result.splice(resultKeyIndex, 1);
 				}
 				return result;
-			}, Object.keys(obj2));
+			}, Object.keys(current));
 	
 		return !_.isEmpty(diff) ? diff : false;
 	}
 
+	/**
+	 * Gets a comprehensive analysis of what has changed since the last save
+	 * @return {object} changedPropertyValues - Object representing each changed field and both its original and current value
+	 */
+	getChangedValues = () => {
+		const original = this._originalDataParsed,
+			current = this.getRawValues(),
+			names = this.getChanged();
+		const changedPropertyValues = {};
+		_.each(names, (name) => {
+			changedPropertyValues[name] = {
+				original: original[name],
+				current: current[name],
+			};
+		});
+		return changedPropertyValues;
+	}
+
 	/**
 	 * Alias for this.submitValues
 	 */

package/src/Repository/Ajax.js

@@ -834,6 +834,9 @@ class AjaxRepository extends Repository {
 	 * @private
 	 */
 	_finalizeSave = (promises) => {
+		if (!promises.length) {
+			return;
+		}
 		return this.axios.all(promises)
 						.then(this.axios.spread((...batchOperationResults) => {
 							// All requests are now complete

package/src/Repository/Repository.js

@@ -1331,6 +1331,13 @@ export default class Repository extends EventEmitter {
 		return this.isInRepository(id);
 	}
 
+	/**
+	 * Convenience function
+	 */
+	saveStaged = () => {
+		return this.save(null, true);
+	}
+
 	/**
 	 * Queues up batch operations for saving
 	 * new, edited, and deleted entities to storage medium.
@@ -1391,7 +1398,9 @@ export default class Repository extends EventEmitter {
 							if (this.combineBatch) {
 
 								result = this.batchAsSynchronous ? await this._doBatchAdd(entities) : this._doBatchAdd(entities);
-								results.push(result);
+								if (result) {
+									results.push(result);
+								}
 		
 							} else {
 								for (i = 0; i < entities.length; i++) {
@@ -1404,7 +1413,9 @@ export default class Repository extends EventEmitter {
 									}
 	
 									result = this.batchAsSynchronous ? await this._doAdd(entity) : this._doAdd(entity);
-									results.push(result);
+									if (result) {
+										results.push(result);
+									}
 								}
 							}
 						}
@@ -1418,7 +1429,9 @@ export default class Repository extends EventEmitter {
 							if (this.combineBatch) {
 
 								result = this.batchAsSynchronous ? await this._doBatchEdit(entities) : this._doBatchEdit(entities);
-								results.push(result);
+								if (result) {
+									results.push(result);
+								}
 
 							} else {
 								for (i = 0; i < entities.length; i++) {
@@ -1431,7 +1444,9 @@ export default class Repository extends EventEmitter {
 									}
 
 									result = this.batchAsSynchronous ? await this._doEdit(entity) : this._doEdit(entity);
-									results.push(result);
+									if (result) {
+										results.push(result);
+									}
 								}
 							}
 						}
@@ -1445,7 +1460,9 @@ export default class Repository extends EventEmitter {
 							if (this.combineBatch) {
 
 								result = this.batchAsSynchronous ? await this._doBatchDelete(entities) : this._doBatchDelete(entities);
-								results.push(result);
+								if (result) {
+									results.push(result);
+								}
 
 							} else {
 								for (i = 0; i < entities.length; i++) {
@@ -1456,7 +1473,9 @@ export default class Repository extends EventEmitter {
 									} else {
 										result = this.batchAsSynchronous ? await this._doDelete(entity) : this._doDelete(entity);
 									}
-									results.push(result);
+									if (result) {
+										results.push(result);
+									}
 								}
 							}
 						}

package/src/Schema/Schema.js

@@ -100,6 +100,7 @@ export default class Schema extends EventEmitter {
 			
 			entity: {
 				methods: {}, // NOTE: Methods must be defined as "function() {}", not as "() => {}" so "this" will be assigned correctly
+				statics: {},
 			},
 
 			/**