@onehat/data 1.23.2 → 1.23.5

package/cypress/e2e/Repository/Repository.cy.js

@@ -942,6 +942,7 @@ describe('Repository Base', function() {
 
 	describe('deleting', function() {
 
+
 		it('clear', function() {
 			this.repository.clear();
 			expect(this.repository.entities.length).to.be.eq(0);
@@ -967,6 +968,21 @@ describe('Repository Base', function() {
 			expect(this.repository.entities.length).to.be.eq(5);
 		});
 
+		it('removeById', function() {
+			const entity = this.repository.entities[0];
+			const id = entity.id;
+			this.repository.removeById(id);
+			expect(this.repository.entities.includes(entity)).to.be.false;
+		});
+
+		it('removeDestroyedEntities', function() {
+			const entity = this.repository.entities[0];
+			expect(this.repository.entities.includes(entity)).to.be.true;
+			entity.destroy();
+			this.repository.removeDestroyedEntities();
+			expect(this.repository.entities.includes(entity)).to.be.false;
+		});
+
 
 		// I'm going to skip these, as they're just combinations of other, tested functions
 		// deleteByIx

package/package.json

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

package/src/Repository/Ajax.js

@@ -225,6 +225,7 @@ class AjaxRepository extends Repository {
 	 * @param {string} name - Param name to set.
 	 * @param {any} value - Param value to set.
 	 * @param {boolean} isBaseParam - Whether param is a base param (to be sent on every request).
+	 * @returns {boolean} - Returns true if the param was changed, false otherwise.
 	 */
 	setParam(name, value, isBaseParam = false) {
 		const
@@ -235,25 +236,45 @@ class AjaxRepository extends Repository {
 		if (matches) { // name has array notation like 'conditions[username]'
 			const
 				first = matches[1],
-				second = matches[2];
-			if (paramsToChange && !paramsToChange.hasOwnProperty(first)) {
-				paramsToChange[first] = {};
-			}
-			if (_.isNil(value) && paramsToChange[first] && paramsToChange[first].hasOwnProperty(second)) {
+				second = matches[2],
+				hasFirst = paramsToChange && paramsToChange.hasOwnProperty(first),
+				hasSecond = hasFirst && paramsToChange[first] && paramsToChange[first].hasOwnProperty(second);
+
+			if (_.isNil(value)) {
+				if (!hasSecond) {
+					return false;
+				}
 				delete paramsToChange[first][second];
 				if (_.isEmpty(paramsToChange[first])) {
 					delete paramsToChange[first];
 				}
-				return;
+				return true;
+			}
+
+			if (!hasFirst) {
+				paramsToChange[first] = {};
+			}
+
+			if (hasSecond && _.isEqual(paramsToChange[first][second], value)) {
+				return false;
 			}
 			paramsToChange[first][second] = value;
-			return;
+			return true;
 		}
-		if (_.isNil(value) && paramsToChange && paramsToChange.hasOwnProperty(name)) {
+		if (_.isNil(value)) {
+			if (!paramsToChange || !paramsToChange.hasOwnProperty(name)) {
+				return false;
+			}
 			delete paramsToChange[name];
-			return;
+			return true;
+		}
+
+		if (paramsToChange && paramsToChange.hasOwnProperty(name) && _.isEqual(paramsToChange[name], value)) {
+			return false;
 		}
+
 		paramsToChange[name] = value;
+		return true;
 	}
 
 	/**
@@ -261,6 +282,7 @@ class AjaxRepository extends Repository {
 	 * Sets a single query param.
 	 * @param {string} name - Param name to set.
 	 * @param {boolean} isBaseParam - Whether param is a base param (to be sent on every request).
+	 * @returns {boolean} - Returns true if the param was changed, false otherwise.
 	 */
 	setValuelessParam(name, isBaseParam = false) {
 		const
@@ -273,27 +295,37 @@ class AjaxRepository extends Repository {
 			first = matches[1],
 			second = matches[2];
 			if (paramsToChange && !paramsToChange.hasOwnProperty(first)) {
-				paramsToChange[first] = [];
+				paramsToChange[first] = {};
 			}
-			if (paramsToChange[first] && paramsToChange[first].hasOwnProperty(second)) {
-				delete paramsToChange[first][second];
-				return;
+			if (paramsToChange[first] && paramsToChange[first].hasOwnProperty(second) && paramsToChange[first][second] === true) {
+				return false;
 			}
-			paramsToChange[first][ paramsToChange[first].length ] = second;
-			return;
+			paramsToChange[first][second] = true;
+			return true;
 		}
-		paramsToChange[paramsToChange.length] = second;
+
+		if (paramsToChange && paramsToChange.hasOwnProperty(name) && paramsToChange[name] === true) {
+			return false;
+		}
+
+		paramsToChange[name] = true;
+		return true;
 	}
 
 	/**
 	 * Sets query params
 	 * @param {object} params - Params to set. Key is parameter name, value is parameter value
+	 * @returns {boolean} - Returns true if any param was changed, false otherwise.
 	 */
 	setParams(params) {
 		const oThis = this;
+		let isChanged = false;
 		_.each(params, (value, name) => {
-			oThis.setParam(name, value);
+			if (oThis.setParam(name, value)) {
+				isChanged = true;
+			}
 		});
+		return isChanged;
 	}
 
 	/**
@@ -407,20 +439,26 @@ class AjaxRepository extends Repository {
 	 * Sets base query param
 	 * @param {string} name - Param name to set.
 	 * @param {any} value - Param value to set.
+	 * @returns {boolean} - Returns true if the base param was changed, false otherwise.
 	 */
 	setBaseParam(name, value) {
-		this.setParam(name, value, true);
+		return this.setParam(name, value, true);
 	}
 
 	/**
 	 * Sets base query params. These params are sent on every request.
 	 * @param {object} params - Base params to set. Key is parameter name, value is parameter value
+	 * @returns {boolean} - Returns true if any base param was changed, false otherwise.
 	 */
 	setBaseParams(params) {
 		const oThis = this;
+		let isChanged = false;
 		_.each(params, (value, name) => {
-			oThis.setBaseParam(name, value);
+			if (oThis.setBaseParam(name, value)) {
+				isChanged = true;
+			}
 		});
+		return isChanged;
 	}
 
 	/**
@@ -442,39 +480,51 @@ class AjaxRepository extends Repository {
 	 * Sets sort and direction params.
 	 * Only one sorter is allowed with this Repository type.
 	 * Refreshes entities.
+	 * @returns {boolean} - Returns true if the sort params were changed, false otherwise.
 	 */
 	_onChangeSorters() {
 		const sorter = this.sorters[0];
-		this.setBaseParam(this.paramSort, sorter.name);
-		this.setBaseParam(this.paramDirection, sorter.direction);
+		let isChanged = false;
+		isChanged = this.setBaseParam(this.paramSort, sorter.name) || isChanged;
+		isChanged = this.setBaseParam(this.paramDirection, sorter.direction) || isChanged;
 		
 		if (this.isLoaded && !this.eventsPaused) {
 			return this.reload();
 		}
+
+		return isChanged;
 	}
 
 	/**
 	 * Sets filter params.
 	 * Refreshes entities.
+	 * @returns {boolean} - Returns true if the filter params were changed, false otherwise.
 	 */
 	_onChangeFilters() {
 		const oThis = this;
+		let isChanged = false;
 		_.each(this.filters, (value, name) => {
-			oThis.setParam(name, value);
+			if (oThis.setParam(name, value)) {
+				isChanged = true;
+			}
 		});
 
 		if (this.isLoaded && !this.eventsPaused) {
 			return this.reload();
 		}
+
+		return isChanged;
 	}
 
 	/**
 	 * Sets pagination params.
 	 * Refreshes entities.
+	 * @returns {boolean} - Returns true if the pagination params were changed, false otherwise.
 	 */
 	_onChangePagination() {
-		this.setBaseParam(this.paramPageNum, this.isPaginated ? this.page : null);
-		this.setBaseParam(this.paramPageSize, this.isPaginated ? this.pageSize : null);
+		let isChanged = false;
+		isChanged = this.setBaseParam(this.paramPageNum, this.isPaginated ? this.page : null) || isChanged;
+		isChanged = this.setBaseParam(this.paramPageSize, this.isPaginated ? this.pageSize : null) || isChanged;
 
 		if (this.isLoaded && !this.eventsPaused) {
 			const
@@ -495,6 +545,8 @@ class AjaxRepository extends Repository {
 				return this.reload();
 			}
 		}
+
+		return isChanged;
 	}
 	
 

package/src/Repository/OneBuild.js

@@ -183,6 +183,7 @@ class OneBuildRepository extends AjaxRepository {
 	 * Sets "conditions" param.
 	 * OneBuild uses a single, multi-dimentional param for filtering.
 	 * Refreshes entities.
+	 * @returns {boolean} - Returns true if the filter params were changed, false otherwise.
 	 */
 	_onChangeFilters() {
 		// Clear existing "conditions" params
@@ -193,11 +194,16 @@ class OneBuildRepository extends AjaxRepository {
 		}
 
 		const oThis = this;
+		let isChanged = false;
 		_.each(this.filters, (filter, ix) => {
 			if (_.includes(nonConditionFilters, filter.name)) {
-				oThis.setParam(filter.name, filter.value);
+				if (oThis.setParam(filter.name, filter.value)) {
+					isChanged = true;
+				}
 			} else {
-				oThis.setParam('conditions[' + filter.name + ']', filter.value);
+				if (oThis.setParam('conditions[' + filter.name + ']', filter.value)) {
+					isChanged = true;
+				}
 			}
 		});
 
@@ -208,21 +214,25 @@ class OneBuildRepository extends AjaxRepository {
 				return this.reload();
 			}
 		}
+
+		return isChanged;
 	}
 
 	/**
 	 * Sets "order" param.
 	 * OneBuild uses a single order param, rather than separate name & direction params.
 	 * Refreshes entities.
+	 * @returns {boolean} - Returns true if the sort params were changed, false otherwise.
 	 */
 	_onChangeSorters() {
 		let sorterStrings = [];
+		let isChanged = false;
 		_.each(this.sorters, (sorter) => {
 			sorterStrings.push(sorter.name + ' ' + sorter.direction);
 		});
 
 		if (!_.isEmpty(sorterStrings)) {
-			this.setBaseParam('order', sorterStrings.join(','));
+			isChanged = this.setBaseParam('order', sorterStrings.join(',')) || isChanged;
 		}
 		
 		if (!this.eventsPaused) {
@@ -240,6 +250,8 @@ class OneBuildRepository extends AjaxRepository {
 				this.emit('changeSorters');
 			}
 		}
+
+		return isChanged;
 	}
 
 	/**
@@ -418,33 +430,69 @@ class OneBuildRepository extends AjaxRepository {
 			this.throwError('this.getSingleEntityFromServer is no longer valid. Repository has been destroyed.');
 			return;
 		}
+		return this.getMultipleEntitiesFromServer([id])
+					.then(entities => {
+						if (!entities || entities.length === 0) {
+							return null;
+						}
+						return entities[0];
+					});
+	}
+
+	async getMultipleEntitiesFromServer(ids) {
+		if (this.isDestroyed) {
+			this.throwError('this.getMultipleEntitiesFromServer is no longer valid. Repository has been destroyed.');
+			return;
+		}
 		if (!this.api.get) {
 			this.throwError('No "get" api endpoint defined.');
 			return;
 		}
 
-		if (!id) {
+		if (!ids || !Array.isArray(ids) || ids.length === 0) {
 			return null;
 		}
 
+		const entitiesById = new Map();
+		_.each(this.entities, (entity) => {
+			entitiesById.set(entity.id, entity);
+		});
+
+		const idsToFetch = [];
+		const idsToFetchSet = new Set();
+		_.each(ids, (id) => {
+			if (entitiesById.has(id)) {
+				return;
+			}
+			if (idsToFetchSet.has(id)) {
+				return;
+			}
+			idsToFetchSet.add(id);
+			idsToFetch.push(id);
+		});
+
+		if (!idsToFetch.length) {
+			return [];
+		}
+
 		this.markLoading();
 
 		const idPropertyName = this.getSchema().model.idProperty;
 		const params = {};
-		params['conditions[' + idPropertyName + ']'] = id;
+		params['conditions[' + idPropertyName + ' IN]'] = idsToFetch;
 
 		const
 			url = this.getModel() + '/' + this.api.get,
 			data = _.merge(params, this._baseParams);
 
 		if (this.debugMode) {
-			console.log('getSingleEntityFromServer', data);
+			console.log('getMultipleEntitiesFromServer', data);
 		}
 
 		return this._send(this.methods.get, url, data)
 					.then(result => {
 						if (this.debugMode) {
-							console.log('Response for getSingleEntityFromServer for ' + this.name, result);
+							console.log('Response for getMultipleEntitiesFromServer for ' + this.name, result);
 						}
 
 						if (this.isDestroyed) {
@@ -461,18 +509,48 @@ class OneBuildRepository extends AjaxRepository {
 						} = this._processServerResponse(result);
 
 						if (!root[0]) {
-							return null;
+							return [];
+						}
+
+						const newEntities = [];
+						_.each(root, (item) => {
+							const entity = this.createStandaloneEntity(item);
+
+							if (entitiesById.has(entity.id)) {
+								// If an entity with the same ID already exists, we don't want to add a duplicate.
+								entity.destroy();
+								return;
+							}
+
+							entity.isPersisted = true;
+							entity.isRemotePhantom = false;
+							this._relayEntityEvents(entity);
+							entitiesById.set(entity.id, entity);
+							newEntities.push(entity);
+						});
+
+						// Add any new entities to the repository's main entities array.
+						if (newEntities.length) {
+							this.entities = this.entities.concat(newEntities);
 						}
+						if (this.isTree) {
+							this.assembleTreeNodes();
+							// pagination vars shouldn't be affected by the loading of additional entities
+						}
+
+						// I don't want to do the following because there might be event handler
+						// side-effects of loading these!
+						// this.markLoaded();
+						// this.rehash();
+						// this.emit('load', this);
 
-						const entity = this.createStandaloneEntity(root[0]);
-						entity.isPersisted = true;
-						entity.isRemotePhantom = false;
-						return entity;
+						return newEntities;
 					})
 					.finally(() => {
 						this.markLoading(false);
 					});
 
+
 	}
 
 	async getLastModifiedDate() {

package/src/Repository/Repository.js

@@ -2074,6 +2074,24 @@ export default class Repository extends EventEmitter {
 		}
 	}
 
+	/**
+	 * Removes an Entity from the current page by ID
+	 */
+	removeById(id) {
+		const entity = this.getById(id);
+		if (entity) {
+			this.removeEntity(entity);
+		}
+	}
+
+	/**
+	 * Removes all entities that have been destroyed from the current page.
+	 * This is an optimized version of removeById, specifically targeting destroyed entities.
+	 */
+	removeDestroyedEntities() {
+		this.entities = _.filter(this.entities, (entity) => !entity.isDestroyed);
+	}
+
 	/**
 	 * Deletes a single Entity by its index (zero-indexed) on the current page
 	 * @param {integer} ix - Index