@onehat/data 1.6.13 → 1.7.3

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

@@ -63,6 +63,43 @@ describe('Repository Base', function() {
 			})
 			expect(repository.id).to.be.not.eq('foo');
 		});
+
+		it('_createMethods', async function() {
+
+			// There is no test method by default
+			expect(this.repository.testMethod).to.not.exist;
+
+			// Set up custom repository with testMethod
+			const schema1 = new Schema({
+					name: 'baz',
+					model: {
+						idProperty: 'key',
+						displayProperty: 'value',
+						properties: [
+							{ name: 'key', type: 'int' },
+							{ name: 'value' },
+						],
+					},
+					repository: {
+						type: 'null',
+						methods: {
+							testMethod: function() {
+								this.bar = 'test me';
+							},
+						},
+					},
+				}),
+				repository = new this.Repository({
+					schema: schema1,
+					data: [],
+				});
+			await repository.initialize();
+			schema1.setBoundRepository(repository);
+
+			// Perform testMethod test
+			repository.testMethod();
+			expect(repository.bar).to.be.eq('test me');
+		});
 	});
 
 	describe('loading', function() {

package/package.json

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

package/src/Entity.js

@@ -165,12 +165,11 @@ class Entity extends EventEmitter {
 			throw Error('this._createMethods is no longer valid. Entity has been destroyed.');
 		}
 		const methodDefinitions = this.schema.entity.methods;
-		if (_.isEmpty(methodDefinitions)) {
-			return;
+		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
+			});
 		}
-		_.each(methodDefinitions, (method, name) => {
-			this[name] = method; // NOTE: Methods must be defined in schema as "function() {}", not as "() => {}" so "this" will be assigned correctly
-		});
 	}
 
 	/**
@@ -257,15 +256,17 @@ class Entity extends EventEmitter {
 	 * This is mainly for updating Entity with new data 
 	 * from remote storage medium.
 	 * Assumes (and sets) isPersisted === true.
+	 * Assumes (and sets) isTempId === false.
 	 * @param {array} originalData - Raw data to load into entity.
 	 */
 	loadOriginalData = (originalData) => {
 		if (this.isDestroyed) {
 			throw Error('this.loadOriginalData is no longer valid. Entity has been destroyed.');
 		}
-		this._originalData = originalData || {};
 		this.isPersisted = true;
+		this._originalData = originalData || {};
 		this.reset();
+		this.getIdProperty().isTempId = false;
 	}
 
 	/**

package/src/Property/Integer.js

@@ -57,7 +57,6 @@ export default class IntegerProperty extends Property {
 		}
 		return id;
 	}
-
 	
 };
 

package/src/Repository/Ajax.js

@@ -28,10 +28,13 @@ class AjaxRepository extends Repository {
 			 * @member {object} api - List of relative URIs to API endpoints.
 			 */
 			api: {
-				add: null,
 				get: null,
+				add: null,
 				edit: null,
 				delete: null,
+				batchAdd: null,
+				batchEdit: null,
+				batchDelete: null,
 				baseURL: '', // e.g. 'https://example.com/myapp/'
 			},
 
@@ -39,8 +42,8 @@ class AjaxRepository extends Repository {
 			 * @member {object} methods - List of methods for all four CRUD operations
 			 */
 			methods: {
-				add: 'POST',
 				get: 'GET',
+				add: 'POST',
 				edit: 'POST',
 				delete: 'POST',
 			},
@@ -235,9 +238,10 @@ class AjaxRepository extends Repository {
 			matches = name.match(re),
 			paramsToChange = isBaseParam ? this._baseParams : this._params;
 		
+		let first, second;
 		if (matches) { // name has array notation like 'conditions[username]'
-			const first = matches[1],
-				second = matches[2];
+			first = matches[1],
+			second = matches[2];
 			if (paramsToChange && !paramsToChange.hasOwnProperty(first)) {
 				paramsToChange[first] = [];
 			}
@@ -498,7 +502,7 @@ class AjaxRepository extends Repository {
 	 * @returns {promise} - Axios Promise.
 	 * @private
 	 */
-	_doAdd(entity) {
+	_doAdd(entity) { // standard function notation
 		if (!this.api.add) {
 			throw new Error('No "add" api endpoint defined.');
 		}
@@ -528,13 +532,57 @@ class AjaxRepository extends Repository {
 						entity.loadOriginalData(root[0]);
 					});
 	}
+	
+	/**
+	 * Helper for save.
+	 * Add multiple entities to storage medium
+	 * @param {array} entities - Entities
+	 * @returns {promise} - Axios Promise.
+	 * @private
+	 */
+	_doBatchAdd(entities) { // standard function notation
+		if (!this.api.batchAdd) {
+			throw new Error('No "batchAdd" api endpoint defined.');
+		}
+
+		this._operations.add = true;
+
+		const method = this.methods.add,
+			url = this.api.batchAdd,
+			data = {
+				entities: _.map(entities, entity => entity.submitValues),
+			};
+
+		return this._send(method, url, data)
+					.then(result => {
+						if (this.debugMode) {
+							console.log(this.api.batchAdd + ' result', result);
+						}
+						const {
+							root,
+							success,
+							total,
+							message
+						} = this._processServerResponse(result);
+
+						if (!success) {
+							throw new Error(message);
+						}
+
+						// Reload each entity with new data
+						// TODO: Check this
+						_.each(entities, (entity, ix) => {
+							entity.loadOriginalData(root[ix]);
+						});
+					});
+	}
 
 	/**
 	 * Helper for save.
 	 * @returns {promise} - Axios Promise.
 	 * @private
 	 */
-	_doEdit(entity) {
+	_doEdit(entity) { // standard function notation
 		if (!this.api.edit) {
 			throw new Error('No "edit" api endpoint defined.');
 		}
@@ -565,12 +613,56 @@ class AjaxRepository extends Repository {
 					});
 	}
 
+	/**
+	 * Helper for save.
+	 * Edit multiple entities in storage medium
+	 * @param {array} entities - Entities
+	 * @returns {promise} - Axios Promise.
+	 * @private
+	 */
+	_doBatchEdit(entities) { // standard function notation
+		if (!this.api.batchEdit) {
+			throw new Error('No "batchEdit" api endpoint defined.');
+		}
+
+		this._operations.edit = true;
+
+		const method = this.methods.edit,
+			url = this.api.batchEdit,
+			data = {
+				entities: _.map(entities, entity => entity.submitValues),
+			};
+
+		return this._send(method, url, data)
+					.then(result => {
+						if (this.debugMode) {
+							console.log(this.api.batchEdit + ' result', result);
+						}
+						const {
+							root,
+							success,
+							total,
+							message
+						} = this._processServerResponse(result);
+
+						if (!success) {
+							throw new Error(message);
+						}
+
+						// Reload each entity with new data
+						// TODO: Check this
+						_.each(entities, (entity, ix) => {
+							entity.loadOriginalData(root[ix]);
+						});
+					});
+	}
+
 	/**
 	 * Helper for save.
 	 * @returns {promise} - Axios Promise.
 	 * @private
 	 */
-	_doDelete(entity) {
+	_doDelete(entity) { // standard function notation
 		if (!this.api.delete) {
 			throw new Error('No "delete" api endpoint defined.');
 		}
@@ -604,9 +696,65 @@ class AjaxRepository extends Repository {
 					});
 	}
 
+	/**
+	 * Helper for save.
+	 * Delete multiple entities from storage medium
+	 * @param {array} entities - Entities
+	 * @returns {promise} - Axios Promise.
+	 * @private
+	 */
+	_doBatchDelete(entities) { // standard function notation
+		if (!this.api.batchDelete) {
+			throw new Error('No "batchDelete" api endpoint defined.');
+		}
+
+		this._operations.delete = true;
+
+		const method = this.methods.delete,
+			url = this.api.batchDelete,
+			ids = _.map(entities, entity => entity.id),
+			data = { ids, };
+
+		return this._send(method, url, data)
+					.then(result => {
+						if (this.debugMode) {
+							console.log(this.api.batchDelete + ' result', result);
+						}
+						const {
+							root,
+							success,
+							total,
+							message
+						} = this._processServerResponse(result);
+						
+						if (!success) {
+							throw new Error(message);
+						}
+
+						// Delete it from this.entities
+						this.entities = _.filter(this.entities, (entity) => {
+							const deleteIt = ids.includes(entity.id);
+							if (deleteIt) {
+								entity.destroy();
+							}
+							return !deleteIt;
+						});
+					});
+	}
+
+	/**
+	 * Helper for save.
+	 * Tells repository to delete entity without ever having saved it 
+	 * to storage medium
+	 * @private
+	 */
 	_doDeleteNonPersisted(entity) {
 		this.entities = _.filter(this.entities, (item) => {
-			return item !== entity;
+			const match = item === entity;
+			if (match) {
+				entity.destroy();
+			}
+			return !match;
 		});
 
 		return true;
@@ -687,19 +835,19 @@ class AjaxRepository extends Repository {
 	 */
 	_finalizeSave = (promises) => {
 		return this.axios.all(promises)
-			.then(this.axios.spread((...batchOperationResults) => {
-				// All requests are now complete
-
-				this.isSaving = false;
-				this.emit('save', batchOperationResults);
-
-				// Do we need to reload?
-				if (this._operations.add || this._operations.delete) {
-					this.reload();
-				} else {
-					this.emit('changeData', this.entities);
-				}
-			}));
+						.then(this.axios.spread((...batchOperationResults) => {
+							// All requests are now complete
+
+							this.isSaving = false;
+							this.emit('save', batchOperationResults);
+
+							// Do we need to reload?
+							if (this._operations.add || this._operations.delete) {
+								this.reload();
+							} else {
+								this.emit('changeData', this.entities);
+							}
+						}));
 	}
 
 }

package/src/Repository/OneBuild.js

@@ -35,10 +35,13 @@ class OneBuildRepository extends AjaxRepository {
 			autoSave: true,
 
 			api: {
-				add: this.name + '/extAdd',
 				get: this.name + '/get',
-				edit: this.name + '/extEdit',
-				delete: this.name + '/extDelete',
+				add: this.name + '/add',
+				edit: this.name + '/edit',
+				delete: this.name + '/delete',
+				batchAdd: this.name + '/batchAdd',
+				batchEdit: this.name + '/batchEdit',
+				batchDelete: this.name + '/batchDelete',
 			},
 
 			methods: {
@@ -51,6 +54,8 @@ class OneBuildRepository extends AjaxRepository {
 			messageProperty: 'message',
 
 			allowsMultiSort: true,
+			// batchAsSynchronous: true, // Add directly to schema for now
+			// combineBatch: true,
 
 			// writer: {
 			// 	type: 'json',

package/src/Repository/Repository.js

@@ -265,10 +265,28 @@ export default class Repository extends EventEmitter {
 			await this.sort();
 		}
 
+		this._createMethods();
+
 		this.isInitialized = true;
 		this.emit('initialize');
 	}
 
+	/**
+	 * Creates the methods for this Repository, based on Schema.
+	 * @private
+	 */
+	_createMethods = () => {
+		if (this.isDestroyed) {
+			throw Error('this._createMethods is no longer valid. Repository has been destroyed.');
+		}
+		const methodDefinitions = this.schema.repository.methods;
+		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
+			});
+		}
+	}
+
 
 	//     __                    __
 	//    / /   ____  ____ _____/ /
@@ -1243,23 +1261,26 @@ export default class Repository extends EventEmitter {
 
 			const batchOrder = this.batchOrder.split(',');
 
-			let n;
+			let n,
+				i,
+				entity,
+				entities,
+				operation,
+				result;
 			for (n = 0; n < batchOrder.length; n++) {
-				const operation = batchOrder[n];
-				let entities;
+				operation = batchOrder[n];
 				switch(operation) {
 					case 'add':
 						entities = this.getNonPersisted();
-						if (this.combineBatch) {
+						if (_.size(entities) > 0) {
+							if (this.combineBatch) {
 
-							// TODO: Implement combined batch processing
-							throw new Error('Combined batch processing not yet implemented');
-
-						} else {
-							if (_.size(entities) > 0) {
-								let i;
+								result = this.batchAsSynchronous ? await this._doBatchAdd(entities) : this._doBatchAdd(entities);
+								results.push(result);
+		
+							} else {
 								for (i = 0; i < entities.length; i++) {
-									const entity = entities[i];
+									entity = entities[i];
 	
 									if (entity.isDeleted) {
 										// This entity is new, but it's also marked for deletion
@@ -1267,26 +1288,23 @@ export default class Repository extends EventEmitter {
 										continue;
 									}
 	
-									const result = this.batchAsSynchronous ? await this._doAdd(entity) : this._doAdd(entity);
+									result = this.batchAsSynchronous ? await this._doAdd(entity) : this._doAdd(entity);
 									results.push(result);
 								}
 							}
 						}
-			
-			
 						break;
 					case 'edit':
 						entities = this.getDirty();
-						if (this.combineBatch) {
+						if (_.size(entities) > 0) {
+							if (this.combineBatch) {
 
-							// TODO: Implement combined batch processing
-							throw new Error('Combined batch processing not yet implemented');
+								result = this.batchAsSynchronous ? await this._doBatchEdit(entities) : this._doBatchEdit(entities);
+								results.push(result);
 
-						} else {
-							if (_.size(entities) > 0) {
-								let i;
+							} else {
 								for (i = 0; i < entities.length; i++) {
-									const entity = entities[i];
+									entity = entities[i];
 
 									if (entity.isDeleted) {
 										// This entity is new, but it's also marked for deletion
@@ -1294,7 +1312,7 @@ export default class Repository extends EventEmitter {
 										continue;
 									}
 
-									const result = this.batchAsSynchronous ? await this._doEdit(entity) : this._doEdit(entity);
+									result = this.batchAsSynchronous ? await this._doEdit(entity) : this._doEdit(entity);
 									results.push(result);
 								}
 							}
@@ -1302,18 +1320,16 @@ export default class Repository extends EventEmitter {
 						break;
 					case 'delete':
 						entities = this.getDeleted();
-						if (this.combineBatch) {
+						if (_.size(entities) > 0) {
+							if (this.combineBatch) {
 
-							// TODO: Implement combined batch processing
-							throw new Error('Combined batch processing not yet implemented');
+								result = this.batchAsSynchronous ? await this._doBatchDelete(entities) : this._doBatchDelete(entities);
+								results.push(result);
 
-						} else {
-							if (_.size(entities) > 0) {
-								let i;
+							} else {
 								for (i = 0; i < entities.length; i++) {
-									const entity = entities[i];
+									entity = entities[i];
 
-									let result;
 									if (!entity.isPersisted) {
 										result = this.batchAsSynchronous ? await this._doDeleteNonPersisted(entity) : this._doDeleteNonPersisted(entity);
 									} else {
@@ -1331,8 +1347,20 @@ export default class Repository extends EventEmitter {
 		return await this._finalizeSave(results);
 	}
 
+	
+	/**
+	 * Helper for save.
+	 * Add multiple entities to storage medium
+	 * @param {array} entities - Entities
+	 * @private
+	 * @abstract
+	 */
+	_doBatchAdd(entities) { // standard function notation
+		throw new Error('_doBatchAdd must be implemented by Repository subclass');
+	}
+
 	/**
-	 * Helper for save().
+	 * Helper for save.
 	 * Add entity to storage medium
 	 * @param {object} entity - Entity
 	 * @private
@@ -1343,7 +1371,18 @@ export default class Repository extends EventEmitter {
 	}
 
 	/**
-	 * Helper for save().
+	 * Helper for save.
+	 * Edit multiple entities in storage medium
+	 * @param {array} entities - Entities
+	 * @private
+	 * @abstract
+	 */
+	_doBatchEdit(entities) { // standard function notation
+		throw new Error('_doBatchEdit must be implemented by Repository subclass');
+	}
+
+	/**
+	 * Helper for save.
 	 * Mark entity as saved
 	 * @param {object} entity - Entity
 	 * @private
@@ -1354,7 +1393,18 @@ export default class Repository extends EventEmitter {
 	}
 
 	/**
-	 * Helper for save().
+	 * Helper for save.
+	 * Delete multiple entities from storage medium
+	 * @param {array} entities - Entities
+	 * @private
+	 * @abstract
+	 */
+	_doBatchDelete(entities) { // standard function notation
+		throw new Error('_doBatchDelete must be implemented by Repository subclass');
+	}
+
+	/**
+	 * Helper for save.
 	 * Delete entity from storage medium
 	 * @param {object} entity - Entity
 	 * @private
@@ -1365,8 +1415,8 @@ export default class Repository extends EventEmitter {
 	}
 
 	/**
-	 * Helper for save().
-	 * Tells storage medium to delete entity without ever having saved it 
+	 * Helper for save.
+	 * Tells repository to delete entity without ever having saved it 
 	 * to storage medium
 	 * @private
 	 */