@onehat/data 1.4.14 → 1.5.0

package/cypress/integration/Entity.spec.js

@@ -198,6 +198,17 @@ describe('Entity', function() {
 			expect(_.isEqual(this.entity.submitValues, expected)).to.be.true;
 		});
 
+		it('getSubmitValuesMapped & submitValuesMapped', function() {
+			const result = this.entity.getSubmitValuesMapped(),
+				expected = {
+					foo: 1,
+					bar: 'one',
+					'baz.test.val': true,
+				};
+			expect(_.isEqual(result, expected)).to.be.true;
+			expect(_.isEqual(this.entity.submitValuesMapped, expected)).to.be.true;
+		});
+
 		it('getDisplayValues & displayValues', function() {
 			const result = this.entity.getDisplayValues(),
 				expected = {
@@ -258,20 +269,48 @@ describe('Entity', function() {
 		});
 
 		it('getReverseMappedRawValue', function() {
-			const definition = {
-				name: 'foo',
-				mapping: 'a.b.c',
-				type: 'int',
-			},
-			Property = PropertyTypes[definition.type];
-			const property = new Property(definition, 'fakeEntity');
+			const definition1 = {
+					name: 'foo',
+					mapping: 'a.b.c',
+					type: 'int',
+				},
+				Property1 = PropertyTypes[definition1.type];
+			const property1 = new Property1(definition1, 'fakeEntity');
+
+			property1.setValue('47');
+			
+			const reverseMapped1 = Entity.getReverseMappedRawValue(property1),
+				expected1 = { a: { b: { c: '47' }, }, };
+			
+			expect(_.isEqual(reverseMapped1, expected1)).to.be.true;
+
+
+			// Now, with no mapping
+			const definition2 = {
+					name: 'foo',
+					type: 'int',
+				},
+				Property2 = PropertyTypes[definition2.type];
+			const property2 = new Property2(definition2, 'fakeEntity');
 
-			property.setValue('47');
+			property2.setValue('47');
 			
-			const reverseMapped = Entity.getReverseMappedRawValue(property),
-				expected = { a: { b: { c: '47' }, }, };
+			const reverseMapped2 = Entity.getReverseMappedRawValue(property2),
+				expected2 = { foo: '47' };
 			
-			expect(_.isEqual(reverseMapped, expected)).to.be.true;
+			expect(_.isEqual(reverseMapped2, expected2)).to.be.true;
+		});
+
+		it('getReverseMappedRawValues', function() {
+			const result = this.entity.getReverseMappedRawValues();
+			expect(_.isEqual(result, this.data)).to.be.true;
+		});
+
+		it('build a new entity from an existing one using getDataForNewEntity', function() {
+			const entity = new Entity(this.schema, this.entity.getDataForNewEntity());
+			entity.initialize();
+
+			expect(_.isEqual(entity.submitValues, this.entity.submitValues)).to.be.true;
 		});
 
 		it('getChanged', function() {

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

@@ -108,6 +108,10 @@ describe('Property', function() {
 			const property = entity.getProperty('bar');
 			expect(property.isDisplayProperty).to.be.true;
 		});
+	
+		it('getMapping', function() {
+			expect(this.property.getMapping()).to.be.eq('id');
+		});
 
 	});
 

package/package.json

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

package/src/Entity.js

@@ -457,6 +457,36 @@ class Entity extends EventEmitter {
 		return this.getSubmitValues();
 	}
 
+	/**
+	 * Gets an object of properties/values for this Entity,
+	 * and returns them with the mapped names
+	 * Values are the "submit" values, not the "raw" or "parsed" or "display" values.
+	 * @return {object} propertyValues
+	 */
+	getSubmitValuesMapped = () => {
+		if (this.isDestroyed) {
+			throw Error('this.getSubmitValuesMapped is no longer valid. Entity has been destroyed.');
+		}
+		
+		let propertyValues = {};
+		_.forOwn(this.properties, (property) => {
+			const name = property.hasMapping ? property.getMapping() : property.name;
+			propertyValues[name] = property.getSubmitValue();
+		});
+		return propertyValues;
+	}
+
+	/**
+	 * Gets "submit" values for this Entity, and returns them with the mapped names
+	 * @return {object} values
+	 */
+	get submitValuesMapped() {
+		if (this.isDestroyed) {
+			throw Error('this.submitValuesMapped is no longer valid. Entity has been destroyed.');
+		}
+		return this.getSubmitValuesMapped();
+	}
+
 	/**
 	 * Gets an object of values for this Entity,
 	 * Values are the "display" values, not the "raw" or "parsed" or "submit" values.
@@ -569,6 +599,11 @@ class Entity extends EventEmitter {
 	 * @static
 	 */
 	static getReverseMappedRawValue(property) {
+		if (!property.hasMapping) {
+			const obj = {};
+			obj[property.name] = property.rawValue;
+			return obj;
+		}
 		const mapStack = property.mapping.split('.'),
 			rawValue = property.getRawValue();
 
@@ -591,6 +626,37 @@ class Entity extends EventEmitter {
 		return value;
 	}
 
+	/**
+	 * Builds up an object of original values for this entity, from which another entity could be easily created
+	 * @return {object} value - An object representing the 'path' to the raw value.
+	 * e.g. With a mapping of 'a.b.c' and a property rawValue of '47', the 
+	 * following object will be returned:{ a: { b: { c: '47' }, }, }
+	 */
+	getReverseMappedRawValues = () => {
+		if (this.isDestroyed) {
+			throw Error('this.getReverseMappedRawValues is no longer valid. Entity has been destroyed.');
+		}
+		
+		let propertyValues = {};
+		_.forOwn(this.properties, (property) => {
+			const reverseMapped = Entity.getReverseMappedRawValue(property);
+			_.assign(propertyValues, reverseMapped);
+		});
+		return propertyValues;
+	}
+
+	/**
+	 * Convenience function
+	 * Build a new entity with this data
+	 */
+	getDataForNewEntity = () => {
+		if (this.isDestroyed) {
+			throw Error('this.getDataForNewEntity is no longer valid. Entity has been destroyed.');
+		}
+		
+		return this.getReverseMappedRawValues();
+	}
+
 	/**
 	 * Gets the values that have changed since last time saved
 	 * @return {array|boolean} diff - Array of property names that have changed, or false

package/src/Property/Property.js

@@ -405,6 +405,17 @@ export default class Property extends EventEmitter {
 		return this.__proto__.constructor.className;
 	}
 
+	/**
+	 * Gets the mapped name of this Property.
+	 * @return {string} name
+	 */
+	getMapping = () => {
+		if (this.isDestroyed) {
+			throw Error('this.getMappedName is no longer valid. Property has been destroyed.');
+		}
+		return this.mapping;
+	}
+
 	/**
 	 * Destroy this object.
 	 * - Removes all circular references to parent objects