@onehat/data 1.6.3 → 1.6.4

package/cypress/fixtures/Definitions/GroupsUsers.js

@@ -27,6 +27,14 @@ const GroupsUsers = {
 
 	},
 
+	entity: {
+		methods: {
+			testMethod: function() {
+				this.users__login_count = this.users__login_count +1;
+			},
+		},
+	},
+
 	repository: 'onebuild',
 
 };

package/cypress/integration/Entity.spec.js

@@ -17,6 +17,13 @@ describe('Entity', function() {
 					{ name: 'baz', mapping: 'baz.test.val', type: 'bool', defaultValue: null, },
 				],
 			},
+			entity: {
+				methods: {
+					testMethod: function() {
+						this.bar = 'test me';
+					},
+				},
+			},
 		});
 		this.data = {
 			foo: 1,
@@ -71,7 +78,6 @@ describe('Entity', function() {
 			entity.markSaved();
 			expect(entity.isTempId).to.be.false;
 		});
-		
 	
 		it('clone', function() {
 			const entity = this.entity;
@@ -100,6 +106,11 @@ describe('Entity', function() {
 			expect(entity.properties.bar.name).to.be.eq('bar');
 			expect(entity.properties.baz.name).to.be.eq('baz');
 		});
+
+		it('_createMethods', function() {
+			this.entity.testMethod();
+			expect(this.entity.bar).to.be.eq('test me');
+		});
 		
 		it('loadOriginalData', function() {
 			const data = {

package/cypress/integration/Schema.spec.js

@@ -11,6 +11,7 @@ describe('Schema', function() {
 		expect(this.schema instanceof Schema).to.be.true;
 		expect(this.schema.name).to.be.eq('GroupsUsers');
 		expect(this.schema.repository.type).to.be.eq('onebuild');
+		expect(this.schema.entity.methods.testMethod).to.be.a('function');
 	});
 
 	it('clone', function() {

package/package.json

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

package/src/Entity.js

@@ -150,10 +150,28 @@ class Entity extends EventEmitter {
 
 	initialize = () => {
 		this.properties = this._createProperties();
+		this._createMethods();
 		this.reset();
 		this.isInitialized = true;
 	}
 
+	/**
+	 * Creates the methods for this Entity, based on Schema.
+	 * @private
+	 */
+	_createMethods = () => {
+		if (this.isDestroyed) {
+			throw Error('this._createMethods is no longer valid. Entity has been destroyed.');
+		}
+		const methodDefinitions = this.schema.entity.methods;
+		if (_.isEmpty(methodDefinitions)) {
+			return;
+		}
+		_.each(methodDefinitions, (method, name) => {
+			this[name] = method; // NOTE: Methods must be defined in schema as "function() {}", not as "() => {}" so "this" will be assigned correctly
+		});
+	}
+
 	/**
 	 * Generates a new unique id and assigns it to this entity.
 	 */

package/src/Repository/Repository.js

@@ -1411,8 +1411,8 @@ export default class Repository extends EventEmitter {
 	 * Helper for delete()
 	 */
 	 removeEntity = async (entity) => {
-		 this.entities = _.filter(this.entities, e => e !== entity);
-		 entity.destroy();
+		this.entities = _.filter(this.entities, e => e !== entity);
+		entity.destroy();
 	}
 
 	/**

package/src/Schema/Schema.js

@@ -5,11 +5,12 @@ import _ from 'lodash';
 
 /**
  * Class represents the Schema definition for Model and Source
- * This is basically just a big config object, used to instantiate a Model and Source.
+ * This is basically just a big config object, used to instantiate an Entity, and Repository.
  * Usage:
  * - const schema = new Schema({
  * 		name: 'Users',
  * 		model: {},
+ * 		entity: {},
  * 		repository: {},
  * });
  * 
@@ -96,6 +97,10 @@ export default class Schema extends EventEmitter {
 					belongsToMany: [],
 				},
 			},
+			
+			entity: {
+				methods: {}, // NOTE: Methods must be defined as "function() {}", not as "() => {}" so "this" will be assigned correctly
+			},
 
 			/**
 			 * @member {object|string} repository - Config for Repository