@onehat/data 1.6.0 → 1.6.5

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/Repository/Repository.spec.js

@@ -581,6 +581,23 @@ describe('Repository Base', function() {
 			expect(result.value).to.be.eq('three');
 		});
 
+		it('getById', function() {
+			const result = this.repository.getById(3);
+			expect(result.value).to.be.eq('three');
+		});
+
+		it('getBy', function() {
+			const result = this.repository.getBy(entity => entity.id === 2 || entity.id === 3);
+			expect(result.length).to.be.eq(2);
+			expect(result[0].value).to.be.eq('two');
+			expect(result[1].value).to.be.eq('three');
+		});
+
+		it('getFirstBy', function() {
+			const result = this.repository.getFirstBy(entity => entity.id === 3);
+			expect(result.value).to.be.eq('three');
+		});
+
 		it('getByRange', function() {
 			const result = this.repository.getByRange(1, 4);
 			expect(_.size(result)).to.be.eq(4);
@@ -668,6 +685,11 @@ describe('Repository Base', function() {
 
 	describe('deleting', function() {
 
+		it('clear', function() {
+			this.repository.clear();
+			expect(this.repository.entities.length).to.be.eq(0);
+		});
+
 		it('delete', function() {
 			let didFire = false;
 			this.repository.on('delete', () => {
@@ -681,6 +703,13 @@ describe('Repository Base', function() {
 			expect(didFire).to.be.true;
 		});
 
+		it('delete() / removeEntity', async function() {
+			this.repository.setAutoSave(false);
+			const entity = await this.repository.add({ value: 'six' });
+			this.repository.delete(entity);
+			expect(this.repository.entities.length).to.be.eq(5);
+		});
+
 
 		// I'm going to skip these, as they're just combinations of other, tested functions
 		// deleteByIx

package/cypress/integration/Schema.spec.js

@@ -10,6 +10,8 @@ describe('Schema', function() {
 	it('schema is valid', function() {
 		expect(this.schema instanceof Schema).to.be.true;
 		expect(this.schema.name).to.be.eq('GroupsUsers');
+		expect(this.schema.model.associations.hasOne).to.be.an('array');
+		expect(this.schema.entity.methods.testMethod).to.be.a('function');
 		expect(this.schema.repository.type).to.be.eq('onebuild');
 	});
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@onehat/data",
-	"version": "1.6.0",
+	"version": "1.6.5",
 	"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.
 	 */
@@ -833,6 +851,31 @@ class Entity extends EventEmitter {
 		return this._originalData;
 	}
 
+	/**
+	 * Gets the associated Repository
+	 * @param {string} repositoryName - Name of the Repository to retrieve
+	 * @return {boolean} hasProperty
+	 */
+	getAssociatedRepository = (repositoryName) => {
+		if (this.isDestroyed) {
+			throw Error('this.getAssociatedRepository is no longer valid. Entity has been destroyed.');
+		}
+
+		const schema = this.getSchema();
+		if (!schema.associations.hasOne.includes(repositoryName) &&
+			!schema.associations.hasMany.includes(repositoryName) &&
+			!schema.associations.belongsTo.includes(repositoryName) &&
+			!schema.associations.belongsToMany.includes(repositoryName)
+			) {
+			throw Error(repositoryName + ' is not associated with ' + this.getRepository().name);
+		}
+		const repository = this.getRepository();
+		if (!repository.oneHatData) {
+			throw Error('No global oneHatData object');
+		}
+		return repository.oneHatData.getRepository(repositoryName);
+	}
+
 
 
 	//    _____      __  __

package/src/OneHatData.js

@@ -254,8 +254,8 @@ export class OneHatData extends EventEmitter {
 			}
 
 			// Apply the general config settings to each specific one
-			const localConfig = _.assign({}, generalConfig, config.local),
-				remoteConfig = _.assign({}, generalConfig, config.remote);
+			const localConfig = _.merge({}, generalConfig, config.local),
+				remoteConfig = _.merge({}, generalConfig, config.remote);
 			
 			// Actually create the local and remote repositories
 			config.local = await this.createRepository(localConfig);
@@ -263,7 +263,7 @@ export class OneHatData extends EventEmitter {
 		}
 
 		const Repository = this._repositoryTypes[config.type],
-			repository = new Repository(config);
+			repository = new Repository(config, this);
 		await repository.initialize();
 		
 		return repository;

package/src/Repository/Ajax.js

@@ -370,7 +370,7 @@ class AjaxRepository extends Repository {
 		}
 
 		const repository = this;
-		const data = _.assign({}, this._baseParams, this._params);
+		const data = _.merge({}, this._baseParams, this._params);
 		
 		return this._send(this.methods.get, this.api.get, data)
 					.then(result => {
@@ -678,15 +678,6 @@ class AjaxRepository extends Repository {
 			}));
 	}
 
-	/**
-	 * Deletes all locally cached entities in repository,
-	 * usually, the current "page".
-	 * Does not actually affect anything on the server.
-	 */
-	clear = async () => {
-		this._destroyEntities();
-	}
-
 }
 
 AjaxRepository.className = 'Ajax';

package/src/Repository/Repository.js

@@ -23,7 +23,7 @@ export default class Repository extends EventEmitter {
 	 * - name {string} - Optional. Defaults to schema.name
 	 * - schema - Schema object
 	 */
-	constructor(config = {}) {
+	constructor(config = {}, oneHatData = null) {
 		super(...arguments);
 		
 		const { schema } = config;
@@ -214,6 +214,11 @@ export default class Repository extends EventEmitter {
 		 */
 		this.isDestroyed = false;
 
+		/**
+		 * @member {boolean} oneHatData - The global @onehat/data object
+		 */
+		this.oneHatData = oneHatData;
+
 		this.registerEvents([
 			'add',
 			'beforeSave',
@@ -972,6 +977,15 @@ export default class Repository extends EventEmitter {
 		this.entities = [];
 	}
 
+	/**
+	 * Deletes all locally cached entities in repository,
+	 * usually, the current "page".
+	 * Does not actually affect anything on the server.
+	 */
+	clear = async () => {
+		this._destroyEntities();
+	}
+
 	/**
 	 * Gets an array of "submit" values objects for the entities
 	 * @return {array} map - 
@@ -1064,20 +1078,19 @@ export default class Repository extends EventEmitter {
 	/**
 	 * Get a single Entity by its id
 	 * @param {integer} id - id of record to retrieve
-	 * @return {Entity} The Entity with matching id
+	 * @return {Entity} The Entity with matching id, or undefined
 	 */
 	getById = (id) => {
 		if (this.isDestroyed) {
 			throw Error('this.getById is no longer valid. Repository has been destroyed.');
 		}
-		const result = this.getBy((entity) => entity.id === id);
-		return result.length > 0 ? result[0] : null;
+		return this.getFirstBy(entity => entity.id === id);
 	}
 
 	/**
 	 * Get an array of Entities by supplied filter function
 	 * @param {function} filter - Filter function to apply to all entities
-	 * @return {Entity[]} Entities that passed through filter
+	 * @return {Entity[]} Entities that passed through filter, or []
 	 */
 	getBy = (filter) => {
 		if (this.isDestroyed) {
@@ -1093,7 +1106,7 @@ export default class Repository extends EventEmitter {
 	 * filters into account. Defaults to false.
 	 * 
 	 * @param {function} filter - Filter function to search by
-	 * @return {Entity} First Entity found
+	 * @return {Entity} First Entity found, or undefined
 	 */
 	getFirstBy = (filter) => {
 		if (this.isDestroyed) {
@@ -1104,7 +1117,7 @@ export default class Repository extends EventEmitter {
 
 	/**
 	 * Get all phantom (unsaved) Entities
-	 * @return {Entity[]} Array of phantom Entities
+	 * @return {Entity[]} Array of phantom Entities, or []
 	 */
 	getPhantom = () => {
 		if (this.isDestroyed) {
@@ -1115,7 +1128,7 @@ export default class Repository extends EventEmitter {
 
 	/**
 	 * Get all Entities not yet persisted to a storage medium
-	 * @return {Entity[]} Array of dirty Entities
+	 * @return {Entity[]} Array of dirty Entities, or []
 	 */
 	getNonPersisted = () => {
 		if (this.isDestroyed) {
@@ -1128,7 +1141,7 @@ export default class Repository extends EventEmitter {
 
 	/**
 	 * Get all dirty (having unsaved changes) Entities
-	 * @return {Entity[]} Array of dirty Entities
+	 * @return {Entity[]} Array of dirty Entities, or []
 	 */
 	getDirty = () => {
 		if (this.isDestroyed) {
@@ -1141,7 +1154,7 @@ export default class Repository extends EventEmitter {
 
 	/**
 	 * Get all deleted Entities
-	 * @return {Entity[]} Array of deleted Entities
+	 * @return {Entity[]} Array of deleted Entities, or []
 	 */
 	getDeleted = () => {
 		if (this.isDestroyed) {
@@ -1366,7 +1379,7 @@ export default class Repository extends EventEmitter {
 	
 	/**
 	 * Marks entities for deletion from storage medium.
-	 * Actual deletion takes place in save()
+	 * Actual deletion takes place in save(), unless isPhantom
 	 * @param {object|array} entities - one or more entities to delete
 	 * @fires delete
 	 */
@@ -1382,7 +1395,12 @@ export default class Repository extends EventEmitter {
 			return;
 		}
 		_.each(entities, (entity) => {
-			entity.markDeleted(); // Entity is still there, it's just marked for deletion
+			if (entity.isPhantom) {
+				// Just auto-remove it. Don't bother saving to storage medium.
+				this.removeEntity(entity);
+			} else {
+				entity.markDeleted(); // Entity is still there, it's just marked for deletion
+			}
 		});
 
 		this.emit('delete', entities);
@@ -1392,6 +1410,16 @@ export default class Repository extends EventEmitter {
 		}
 	}
 
+	/**
+	 * Removes an Entity from the current page
+	 * Mainly used for phantom Entities
+	 * Helper for delete()
+	 */
+	 removeEntity = async (entity) => {
+		this.entities = _.filter(this.entities, e => e !== entity);
+		entity.destroy();
+	}
+
 	/**
 	 * Deletes a single Entity by its index (zero-indexed) on the current page
 	 * @param {integer} ix - Index

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
@@ -104,7 +109,7 @@ export default class Schema extends EventEmitter {
 
 		};
 
-		this._originalConfig = _.assign({}, defaults, config);
+		this._originalConfig = _.merge({}, defaults, config);
 		_.merge(this, this._originalConfig);
 
 		/**