@onehat/data 1.5.2 → 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,
@@ -44,7 +51,7 @@ describe('Entity', function() {
 			expect(this.entity.id).to.be.eq(1);
 		});
 
-		it('createId, isTempId', function() {
+		it('createTempId, isTempId', function() {
 			const schema = new Schema({
 					name: 'baz',
 					model: {
@@ -62,35 +69,15 @@ describe('Entity', function() {
 				entity = new Entity(schema, data);
 			entity.initialize();
 			expect(entity.id).to.be.null;
+			expect(entity.isTempId).to.be.false;
 
-			entity.createId();
+			entity.createTempId();
 			expect(entity.id).to.be.not.null;
-			expect(Entity.isTempId(entity.id)).to.be.true;
-
+			expect(entity.isTempId).to.be.true;
 
-
-			const schema2 = new Schema({
-					name: 'baz',
-					model: {
-						idProperty: 'foo',
-						displayProperty: 'bar',
-						properties: [
-							{ name: 'foo', type: 'uuid' }, // MOD
-							{ name: 'bar' },
-						],
-					},
-				}),
-				entity2 = new Entity(schema2, data);
-			
-			entity2.initialize();
-			expect(entity2.id).to.be.null;
-
-			entity2.createId();
-			expect(entity2.id).to.be.not.null;
-			const idProperty = entity2.getIdProperty();
-			expect(Entity.isTempId(entity2.id)).to.be.false;
+			entity.markSaved();
+			expect(entity.isTempId).to.be.false;
 		});
-		
 	
 		it('clone', function() {
 			const entity = this.entity;
@@ -119,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 = {
@@ -407,6 +399,12 @@ describe('Entity', function() {
 			const entity = new Entity(this.schema, {});
 			entity.initialize();
 			expect(entity.isPhantom).to.be.true;
+
+			entity.createTempId();
+			expect(entity.isPhantom).to.be.true;
+			
+			entity.markSaved();
+			expect(entity.isPhantom).to.be.false;
 		});
 
 		it('isDirty', function() {
@@ -469,6 +467,15 @@ describe('Entity', function() {
 			expect(this.entity.isDirty).to.be.true;
 		});
 
+		it('setId', function() {
+			expect(this.entity.foo).to.be.eq(1);
+			expect(this.entity.isTempId).to.be.false;
+			
+			this.entity.setId(2);
+			expect(this.entity.foo).to.be.eq(2);
+			expect(this.entity.isTempId).to.be.false;
+		});
+
 		it('_recalculateDependentProperties', function() {
 			const schema = new Schema({
 					name: 'baz',
@@ -508,6 +515,7 @@ describe('Entity', function() {
 			
 			entity.bar = 'Test';
 			entity.markSaved();
+			expect(entity.isTempId).to.be.false;
 
 			expect(entity.isPersisted).to.be.true;
 			const expected = {

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

@@ -19,6 +19,14 @@ describe('IntegerProperty', function() {
 			expect(className).to.be.eq('Integer');
 		});
 
+		it('newId', function() {
+			const id1 = this.property.newId();
+			expect(id1.valueOf()).to.be.eq(this.property.idStartsAt);
+
+			const id2 = this.property.newId();
+			expect(id2.valueOf()).to.be.eq(this.property.idStartsAt +1);
+		});
+
 		// it('default value', function() {
 		// 	const property = this.property,
 		// 		rawValue = property.getDefaultValue();

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

@@ -112,6 +112,20 @@ describe('Property', function() {
 		it('getMapping', function() {
 			expect(this.property.getMapping()).to.be.eq('id');
 		});
+	
+		it('getMapping', function() {
+			expect(this.property.getMapping()).to.be.eq('id');
+		});
+	
+		it('isTempId', function() {
+			const definition = {
+					type: 'int',
+					isTempId: true,
+				},
+				Property = PropertyTypes[definition.type];
+			const property = new Property(definition);
+			expect(property.isTempId).to.be.true;
+		});
 
 	});
 

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

@@ -10,9 +10,21 @@ describe('StringProperty', function() {
 		this.property = new Property(definition);
 	});
 
-	it('className', function() {
-		const className = this.property.getClassName();
-		expect(className).to.be.eq('String');
+	describe('general', function() {
+
+		it('className', function() {
+			const className = this.property.getClassName();
+			expect(className).to.be.eq('String');
+		});
+
+		it('newId', function() {
+			const id1 = this.property.newId();
+			expect(id1.valueOf()).to.be.eq('TEMP-1');
+
+			const id2 = this.property.newId();
+			expect(id2.valueOf()).to.be.eq('TEMP-2');
+		});
+
 	});
 
 	describe('parse', function() {

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);
@@ -622,11 +639,18 @@ describe('Repository Base', function() {
 			expect(_.isEqual(entity, deleted[0])).to.be.true;
 		});
 
-		it('isInRepository', function() {
+		it('isInRepository, hasId', function() {
 			this.repository.setAutoSave(false);
-			const entity = this.repository.getByIx(0),
-				result = this.repository.isInRepository(entity);
-			
+			const id = 1,
+				entity = this.repository.getById(id);
+
+			let result = this.repository.isInRepository(entity);
+			expect(result).to.be.true;
+
+			result = this.repository.isInRepository(id);
+			expect(result).to.be.true;
+
+			result = this.repository.hasId(id);
 			expect(result).to.be.true;
 		});
 
@@ -661,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', () => {
@@ -674,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

@@ -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.5.2",
+	"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

@@ -4,8 +4,6 @@ import EventEmitter from '@onehat/events';
 import PropertyTypes from './Property';
 import _ from 'lodash';
 
-const TEMP_PREFIX = 'TEMP-';
-
 /**
  * Class represents a single Entity (i.e. a record)
  * which is a collection of Properties with current values.
@@ -152,37 +150,48 @@ class Entity extends EventEmitter {
 
 	initialize = () => {
 		this.properties = this._createProperties();
+		this._createMethods();
 		this.reset();
 		this.isInitialized = true;
 	}
 
 	/**
-	 * Generates a new unique id and assigns it to this entity.
-	 * If the idProperty is of type 'uuid', then it generates a new UUID.
-	 * If not, then it generates a temp id.
+	 * Creates the methods for this Entity, based on Schema.
+	 * @private
 	 */
-	createId = () => {
+	_createMethods = () => {
 		if (this.isDestroyed) {
-			throw Error('this.generateTempId is no longer valid. Entity has been destroyed.');
+			throw Error('this._createMethods is no longer valid. Entity has been destroyed.');
 		}
-		if (!_.isNil(this.id)) {
-			throw new Error('Entity id already exists.');
+		const methodDefinitions = this.schema.entity.methods;
+		if (_.isEmpty(methodDefinitions)) {
+			return;
 		}
-		const idProperty = this.getIdProperty(),
-			id = (idProperty.type === 'uuid') ? idProperty.newId() : _.uniqueId(TEMP_PREFIX);
-		this.setId(id);
+		_.each(methodDefinitions, (method, name) => {
+			this[name] = method; // NOTE: Methods must be defined in schema as "function() {}", not as "() => {}" so "this" will be assigned correctly
+		});
 	}
 
 	/**
-	 * Determines whether submitted id is a "temp" id.
-	 * @param {any} id
-	 * @return {boolean} isTempId
+	 * Generates a new unique id and assigns it to this entity.
 	 */
-	static isTempId(id) {
-		if (_.isString(id) && id.match(new RegExp('^' + TEMP_PREFIX))) {
-			return true;
+	createTempId = () => {
+		if (this.isDestroyed) {
+			throw Error('this.createTempId is no longer valid. Entity has been destroyed.');
 		}
-		return false;
+		if (!_.isNil(this.id)) {
+			throw new Error('Entity id already exists.');
+		}
+
+		const idProperty = this.getIdProperty();
+		
+		if (!idProperty.newId) {
+			throw new Error('idProperty.newId() does not exist');
+		}
+
+		this.setId(idProperty.newId());
+
+		idProperty.isTempId = true;
 	}
 
 	/**
@@ -739,6 +748,14 @@ class Entity extends EventEmitter {
 		return this.getId();
 	}
 
+	/**
+	 * Is this Entity's idProperty using a temporary ID?
+	 * @return {boolean} isTempId
+	 */
+	get isTempId() {
+		return this.getIdProperty().isTempId;
+	}
+
 	/**
 	 * Gets the "Display" Property object for this Entity.
 	 * This is the Property whose value can easily identify the whole Entity itself.
@@ -793,13 +810,13 @@ class Entity extends EventEmitter {
 		const idProperty = this.getIdProperty(),
 			id = idProperty.getSubmitValue();
 
-		// No id
+		// No ID
 		if (_.isNil(id)) {
 			return true;
 		}
 
-		// Temp id
-		if (Entity.isTempId(id)) {
+		// ID is temporary
+		if (idProperty.isTempId) {
 			return true;
 		}
 
@@ -851,23 +868,25 @@ class Entity extends EventEmitter {
 	 */
 	setId = (id, force = false) => {
 		let isChanged = false;
-		const property = this.getIdProperty();
+		const idProperty = this.getIdProperty();
 
-		property.pauseEvents(); // We don't need property_change to fire
-		if (property.setValue(id)) {
+		idProperty.pauseEvents(); // We don't need property_change to fire
+		if (idProperty.setValue(id)) {
 			isChanged = true;
 		}
-		property.resumeEvents();
+		idProperty.resumeEvents();
 
 		if (isChanged || force) {
 			// Set this id on the _originalData* objects
-			if (property.hasMapping) {
-				_.merge(this._originalData, Entity.getReverseMappedRawValue(property));
+			if (idProperty.hasMapping) {
+				_.merge(this._originalData, Entity.getReverseMappedRawValue(idProperty));
 			} else {
-				this._originalData[property.name] = property.getRawValue();
+				this._originalData[idProperty.name] = idProperty.getRawValue();
 			}
-			this._originalDataParsed[property.name] = property.getParsedValue();
+			this._originalDataParsed[idProperty.name] = idProperty.getParsedValue();
 		}
+		
+		idProperty.isTempId = false;
 
 		return isChanged;
 	}
@@ -973,6 +992,7 @@ class Entity extends EventEmitter {
 			throw Error('this.markSaved is no longer valid. Entity has been destroyed.');
 		}
 		this.isPersisted = true;
+		this.getIdProperty().isTempId = false;
 		this._originalData = this._getReconstructedOriginalData();
 		this._originalDataParsed = this.getParsedValues();
 	}

package/src/Property/Integer.js

@@ -4,6 +4,8 @@ import Property from './Property';
 import Parsers from '../Util/Parsers';
 import _ from 'lodash';
 
+let lastId = 0;
+
 /**
  * Class represents a Property that stores an integer value.
  * @extends Property
@@ -15,6 +17,7 @@ export default class IntegerProperty extends Property {
 
 		const defaults = {
 			// defaultValue: 0,
+			idStartsAt: 100 * 1000 * 1000 * 1000, // 100 billion
 		};
 		
 		_.merge(this, defaults, config);
@@ -29,6 +32,32 @@ export default class IntegerProperty extends Property {
 		}
 		return Parsers.ParseInt(value);
 	}
+
+	/**
+	 * Generates a new id
+	 * Mainly for temporary, in-memory usage
+	 */
+	newId = () => {
+		let id,
+			hasId = false;
+
+		const entity = this.getEntity(),
+			repository = entity && entity.repository;
+
+		if (lastId < this.idStartsAt) {
+			lastId = this.idStartsAt;
+		}
+
+		id = lastId++;
+		hasId = repository ? repository.hasId(id) : false;
+
+		while(hasId) {
+			id = lastId++;
+			hasId = repository.hasId(id);
+		}
+		return id;
+	}
+
 	
 };
 

package/src/Property/Property.js

@@ -83,6 +83,12 @@ export default class Property extends EventEmitter {
 			 * @member {boolean} isSortable - Whether this property type is sortable
 			 */
 			isSortable: true,
+			
+			/**
+			 * @member {boolean} isTempId - Whether this property's ID is temporary
+			 */
+			isTempId: false,
+
 
 
 			// OneBuild META attributes, just bring these over wholesale for now

package/src/Property/String.js

@@ -4,6 +4,8 @@ import Property from './Property';
 import Parsers from '../Util/Parsers';
 import _ from 'lodash';
 
+const TEMP_PREFIX = 'TEMP-';
+
 /**
  * Class represents a Property that stores string data.
  * @extends Property
@@ -29,6 +31,23 @@ export default class StringProperty extends Property {
 		}
 		return Parsers.ParseString(value);
 	}
+
+	newId = () => {
+		let id,
+			hasId = false;
+
+		const entity = this.getEntity(),
+			repository = entity && entity.repository;
+
+		id = _.uniqueId(TEMP_PREFIX);
+		hasId = repository ? repository.hasId(id) : false;
+
+		while(hasId) {
+			id = _.uniqueId(TEMP_PREFIX);
+			hasId = repository.hasId(id);
+		}
+		return id;
+	}
 };
 
 StringProperty.className = 'String';

package/src/Repository/Ajax.js

@@ -395,7 +395,7 @@ class AjaxRepository extends Repository {
 						});
 				
 						// Set the total records that pass filter
-						this.total = total;				
+						this.total = total;
 						this._setPaginationVars();
 				
 						this.isLoading = false;
@@ -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/Memory.js

@@ -134,7 +134,7 @@ class MemoryRepository extends Repository {
 		// Add to internal store
 		_.each(entities, (entity) => {
 			if (entity.isPhantom) {
-				entity.createId();
+				entity.createTempId();
 			}
 			this._keyedEntities[entity.id] = entity;
 		});

package/src/Repository/Repository.js

@@ -865,8 +865,8 @@ export default class Repository extends EventEmitter {
 		this.entities.push(entity);
 
 		// Create id if needed
-		if (entity.isPhantom) {
-			entity.createId(); // either a UUID or a temp id
+		if (entity.isPhantom) { // i.e. idProperty has no value
+			entity.createTempId();
 		}
 
 		this.emit('add', entity);
@@ -893,7 +893,7 @@ export default class Repository extends EventEmitter {
 		const entity = Repository._createEntity(this.schema, data, this, isPersisted, originalIsMapped);
 
 		if (entity.isPhantom) {
-			entity.createId(); // either a UUID or a temp id
+			entity.createTempId();
 		}
 
 		return entity;
@@ -972,6 +972,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 +1073,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 +1101,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 +1112,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 +1123,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 +1136,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 +1149,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) {
@@ -1168,6 +1176,15 @@ export default class Repository extends EventEmitter {
 		return !_.isNil(this.getById(idOrEntity));
 	}
 
+	/**
+	 * Convenience function
+	 * Alias for isInRepository
+	 * NOTE: It only searches in memory. Doesn't query server
+	 */
+	hasId = (id) => {
+		return this.isInRepository(id);
+	}
+
 	/**
 	 * Queues up batch operations for saving
 	 * new, edited, and deleted entities to storage medium.
@@ -1357,7 +1374,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
 	 */
@@ -1373,7 +1390,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);
@@ -1383,6 +1405,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