@onehat/data 1.7.14 → 1.8.0

package/cypress/integration/Entity.spec.js

@@ -476,15 +476,40 @@ describe('Entity', function() {
 		it('setValues', function() {
 			expect(this.entity.foo).to.be.eq(1);
 			expect(this.entity.bar).to.be.eq('one');
+			expect(this.entity.baz).to.be.eq(true);
 			expect(this.entity.isDirty).to.be.false;
 	
 			this.entity.setValues({
 				foo: 2,
 				bar: 'two',
+				baz: false,
 			});
 			
 			expect(this.entity.foo).to.be.eq(2);
 			expect(this.entity.bar).to.be.eq('two');
+			expect(this.entity.baz).to.be.eq(false);
+			expect(this.entity.isDirty).to.be.true;
+		});
+
+		it('setRawValues', function() {
+			expect(this.entity.foo).to.be.eq(1);
+			expect(this.entity.bar).to.be.eq('one');
+			expect(this.entity.baz).to.be.eq(true);
+			expect(this.entity.isDirty).to.be.false;
+	
+			this.entity.setRawValues({
+				foo: 2,
+				bar: 'two',
+				baz: {
+					test: {
+						val: false,
+					},
+				},
+			});
+			
+			expect(this.entity.foo).to.be.eq(2);
+			expect(this.entity.bar).to.be.eq('two');
+			expect(this.entity.baz).to.be.eq(false);
 			expect(this.entity.isDirty).to.be.true;
 		});
 
@@ -580,6 +605,21 @@ describe('Entity', function() {
 			this.entity.markStaged(false);
 			expect(this.entity.isStaged).to.be.false;
 		});
+	
+		it('setValue changed lastModified', function() {
+			let earlyLastModified,
+				lateLastModified;
+
+			earlyLastModified = this.entity.lastModified;
+			this.entity.setValue('foo', '125');
+			lateLastModified = this.entity.lastModified;
+			expect(earlyLastModified < lateLastModified).to.be.true;
+
+			earlyLastModified = this.entity.lastModified;
+			this.entity.foo = '126';
+			lateLastModified = this.entity.lastModified;
+			expect(earlyLastModified < lateLastModified).to.be.true;
+		});
 	});
 
 	describe('events', function() {

package/cypress/integration/Repository/Repository.spec.js

@@ -553,6 +553,30 @@ describe('Repository Base', function() {
 			expect(didFireAdd).to.be.true;
 		});
 
+		it('add already existing', async function() {
+			const value = 'another one';
+			await this.repository.add({ key: 6, value: 'six' });
+			await this.repository.add({ key: 6, value });
+			expect(_.size(this.repository.entities)).to.be.eq(6);
+
+			const entity = this.repository.getById(6);
+			expect(entity.value).to.be.eq(value);
+		})
+
+		it('add with an existing id', async function() {
+			this.repository.autoSave = false;
+
+			// ID suppied; should not be temp ID or phantom
+			const entity = await this.repository.add({ key: 6, value: 'six' });
+			expect(entity.isTempId).to.be.false;
+			expect(entity.isPhantom).to.be.false;
+
+			// No ID suppled. Make it phantom and temp ID
+			const entity2 = await this.repository.add({ value: 'seven' });
+			expect(entity2.isTempId).to.be.true;
+			expect(entity2.isPhantom).to.be.true;
+		});
+
 		it('createStandaloneEntity', async function() {
 			const entity = await this.repository.createStandaloneEntity({ key: 6, value: 'six' });
 			expect(entity.id).to.be.eq(6);

package/package.json

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

package/src/Entity.js

@@ -2,6 +2,7 @@
 
 import EventEmitter from '@onehat/events';
 import PropertyTypes from './Property';
+import moment from 'moment';
 import _ from 'lodash';
 
 /**
@@ -129,6 +130,11 @@ class Entity extends EventEmitter {
 		 */
 		this.isDestroyed = false;
 
+		/**
+		 * @member {string} lastModified - Last time this entity was modified
+		 */
+		this.lastModified = null;
+
 		// This ES6 Proxy allows us to create magic getters and setters for all property values.
 		// However, these getters and setters are *not* available within the Entity itself.
 		this._proxy = new Proxy(this, {
@@ -325,6 +331,7 @@ class Entity extends EventEmitter {
 		if (this.isDeleted) {
 			this.undelete();
 		}
+		this.setLastModified();
 
 		this.emit('reset', this._proxy);
 	}
@@ -399,6 +406,10 @@ class Entity extends EventEmitter {
 		}
 		return value;
 	}
+	
+	setLastModified = () => {
+		this.lastModified = moment(new Date()).format('YYYY-MM-DD HH:mm:ss.SSSS');
+	}
 
 
 	//    ______     __  __
@@ -990,6 +1001,7 @@ class Entity extends EventEmitter {
 		}
 		
 		idProperty.isTempId = false;
+		this.setLastModified();
 
 		return isChanged;
 	}
@@ -1010,23 +1022,58 @@ class Entity extends EventEmitter {
 		propertyValues[propertyName] = rawValue;
 		return this.setValues(propertyValues);
 	}
+	
+	/**
+	 * Sets Property values
+	 * @param {object} rawData - Raw data object. These are prior to mapping, 
+	 * similar to what you'd use to create a brand new Entity. Make sure *all*
+	 * values are here, not just a few.
+	 * @return {boolean} isChanged - Whether any values were actually changed
+	 */
+	 setRawValues = (rawData) => {
+		if (this.isDestroyed) {
+			throw Error('this.setRawValues is no longer valid. Entity has been destroyed.');
+		}
+
+		const [dependentProperties, nonDependentProperties] = _.partition(this.properties, (property) => {
+			return property.hasDepends;
+		});
+		const mappedData = {};
+		function setMappedValue(property) {
+			let rawValue;
+			if (property.hasMapping) {
+				rawValue = Entity.getMappedValue(property.mapping, rawData);
+			} else {
+				rawValue = rawData[property.name];
+			}
+			if (_.isNil(rawValue)) {
+				rawValue = property.getDefaultValue();
+			}
+			mappedData[property.name] = rawValue;
+		}
+		
+		_.each(nonDependentProperties, setMappedValue);
+		_.each(dependentProperties, setMappedValue);
+
+		return this.setValues(mappedData);
+	}
 
 	/**
 	 * Sets Property values
-	 * @param {object} rawData - Raw data object. Keys are Property names, Values are Property values.
+	 * @param {object} data - Raw data object. Keys are Property names, Values are Property values.
 	 * @return {boolean} isChanged - Whether any values were actually changed
 	 * @fires change
 	 */
-	setValues = (rawData) => {
+	setValues = (data) => {
 		if (this.isDestroyed) {
 			throw Error('this.setValues is no longer valid. Entity has been destroyed.');
 		}
-		if (_.indexOf(rawData, this.getIdProperty().name) !== -1) {
+		if (_.indexOf(data, this.getIdProperty().name) !== -1) {
 			throw new Error('Cannot change id via entity.setValues(). Must use entity.setId() first.');
 		}
 
 		let isChanged = false;
-		_.each(rawData, (value, propertyName) => {
+		_.each(data, (value, propertyName) => {
 			const property = this.getProperty(propertyName);
 			property.pauseEvents(); // We don't need property_change to fire
 			if (property.setValue(value)) {
@@ -1034,6 +1081,7 @@ class Entity extends EventEmitter {
 			}
 			property.resumeEvents();
 		});
+		this.setLastModified();
 
 		if (isChanged) {
 			this._recalculateDependentProperties();

package/src/Repository/Ajax.js

@@ -362,7 +362,7 @@ class AjaxRepository extends Repository {
 			throw new Error('No "get" api endpoint defined.');
 		}
 		this.emit('beforeLoad'); // TODO: canceling beforeLoad will cancel the load operation
-		this.isLoading = true;
+		this.markLoading();
 
 
 		if (!_.isNil(params) && _.isObject(params)) {
@@ -407,9 +407,9 @@ class AjaxRepository extends Repository {
 						// Set the total records that pass filter
 						this.total = total;
 						this._setPaginationVars();
-				
-						this.isLoading = false;
-						this.isLoaded = true;
+
+						this.markLoaded();
+
 						this.emit('changeData', this.entities);
 						this.emit('load', this);
 					})
@@ -432,7 +432,7 @@ class AjaxRepository extends Repository {
 			throw new Error('No "get" api endpoint defined.');
 		}
 		this.emit('beforeLoad'); // TODO: canceling beforeLoad will cancel the load operation
-		this.isLoading = true;
+		this.markLoading();
 
 		const params = this._getReloadEntityParams(entity);
 		if (this.debugMode) {
@@ -460,8 +460,8 @@ class AjaxRepository extends Repository {
 						entity.loadOriginalData(updatedData, true);
 						entity.emit('reload', entity);
 						
-						this.isLoading = false;
-						this.isLoaded = true;
+						this.markLoaded();
+
 						this.emit('changeData', this.entities);
 						this.emit('load', this);
 						this.emit('reloadEntity', entity);

package/src/Repository/Memory.js

@@ -95,7 +95,7 @@ class MemoryRepository extends Repository {
 		}
 
 		this.emit('beforeLoad');
-		this.isLoading = true;
+		this.markLoading();
 
 
 		const isDirectLoad = !_.isNil(data);
@@ -143,8 +143,7 @@ class MemoryRepository extends Repository {
 			await this._saveToStorage(entities);
 		}
 
-		this.isLoading = false;
-		this.isLoaded = true;
+		this.markLoaded();
 		this._recalculate(); // fires changeData if needed
 		this.emit('load', entities, this);
 		return entities;
@@ -444,6 +443,21 @@ class MemoryRepository extends Repository {
 		})
 	}
 	/* */
+	
+	removeEntity(entity) { // standard function notation
+		const id = entity.id;
+
+		super.removeEntity(entity);
+
+		if (this.hasSorters) {
+			this._applySorters();
+		}
+		if (this.hasFilters) {
+			this._applyFilters();
+		}
+		delete this._keyedEntities[id];
+	}
+
 
 
 

package/src/Repository/Null.js

@@ -46,7 +46,7 @@ class NullRepository extends Repository {
 			throw Error('this.load is no longer valid. Repository has been destroyed.');
 		}
 		this.emit('beforeLoad');
-		this.isLoading = true;
+		this.markLoading();
 
 		if (data) {
 			let entities = data;
@@ -65,8 +65,7 @@ class NullRepository extends Repository {
 
 		this._updateSize();
 
-		this.isLoading = false;
-		this.isLoaded = true;
+		this.markLoaded();
 		this.emit('changeData', this.entities);
 		this.emit('load', this);
 	}

package/src/Repository/Repository.js

@@ -5,6 +5,7 @@ import Entity from '../Entity';
 import {
 	v4 as uuid,
 } from 'uuid';
+import moment from 'moment';
 import _ from 'lodash';
 
 /**
@@ -194,6 +195,11 @@ export default class Repository extends EventEmitter {
 		 */
 		this.isLoading = false;
 
+		/**
+		 * @member {string} lastLoaded - Last time this repository was loaded
+		 */
+		this.lastLoaded = null;
+
 		/**
 		 * @member {Boolean} isSaving - State: whether or not entities are currently being saved
 		 */
@@ -268,8 +274,9 @@ export default class Repository extends EventEmitter {
 		this._createMethods();
 		this._createStatics();
 
-		if (this.schema.repository.init) {
-			await this.schema.repository.init.call(this);
+		const init = this.schema.repository.init || this.originalConfig.init; // The latter is mainly for lfr repositories
+		if (init) {
+			await init.call(this);
 		}
 
 		this.isInitialized = true;
@@ -284,7 +291,7 @@ export default class Repository extends EventEmitter {
 		if (this.isDestroyed) {
 			throw Error('this._createMethods is no longer valid. Repository has been destroyed.');
 		}
-		const methodDefinitions = this.schema.repository.methods;
+		const methodDefinitions = this.schema.repository.methods || this.originalConfig.methods; // The latter is mainly for lfr repositories
 		if (!_.isEmpty(methodDefinitions)) {
 			_.each(methodDefinitions, (method, name) => {
 				this[name] = method; // NOTE: Methods must be defined in schema as "function() {}", not as "() => {}" so "this" will be assigned correctly
@@ -300,7 +307,7 @@ export default class Repository extends EventEmitter {
 		if (this.isDestroyed) {
 			throw Error('this._createStatics is no longer valid. Entity has been destroyed.');
 		}
-		const staticsDefinitions = this.schema.repository.statics;
+		const staticsDefinitions = this.schema.repository.statics || this.originalConfig.statics; // The latter is mainly for lfr repositories
 		if (!_.isEmpty(staticsDefinitions)) {
 			_.each(staticsDefinitions, (value, key) => {
 				this[key] = value;
@@ -323,6 +330,22 @@ export default class Repository extends EventEmitter {
 		throw new Error('load must be implemented by Repository subclass');
 	}
 
+	/**
+	 * Marks this repository as loading
+	 */
+	markLoading = () => {
+		this.isLoading = true;
+	}
+
+	/**
+	 * Marks this repository as loaded
+	 */
+	markLoaded = () => {
+		this.isLoading = false;
+		this.isLoaded = true;
+		this.lastLoaded = moment(new Date()).format('YYYY-MM-DD HH:mm:ss.SSSS');
+	}
+
 	/**
 	 * Reload data from storage medium, using previous settings.
 	 * Subclasses may override this to provide additional 
@@ -900,6 +923,19 @@ export default class Repository extends EventEmitter {
 			throw Error('this.add is no longer valid. Repository has been destroyed.');
 		}
 		
+		// Does it already exist? If so, edit the existing
+		const idProperty = this.getSchema().model.idProperty;
+		if (data.hasOwnProperty(idProperty)) {
+			if (this.isInRepository(data[idProperty])) {
+				const existing = this.getById(data[idProperty]);
+				existing.setRawValues(data);
+				if (this.autoSave && !existing.isPersisted) {
+					await this.save(existing);
+				}
+				return existing;
+			}
+		}
+
 		let entity = data;
 		if (!(data instanceof Entity)) {
 			// Create the new entity
@@ -1595,7 +1631,7 @@ export default class Repository extends EventEmitter {
 	 * Mainly used for phantom Entities
 	 * Helper for delete()
 	 */
-	removeEntity = async (entity) => {
+	removeEntity(entity) { // standard function notation so it can be called by child class
 		this.entities = _.filter(this.entities, e => e !== entity);
 		entity.destroy();
 	}