@onehat/data 1.18.8 → 1.18.10

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

@@ -1139,7 +1139,7 @@ describe('Repository Base', function() {
 					parent_id: null,
 					depth: 0,
 					hasChildren: true,
-					isChildrenLoaded: true,
+					areChildrenLoaded: true,
 				},
 				{
 					id: 2,
@@ -1147,21 +1147,21 @@ describe('Repository Base', function() {
 					parent_id: 1,
 					depth: 1,
 					hasChildren: true,
-					isChildrenLoaded: true,
+					areChildrenLoaded: true,
 				},
 				{
 					id: 3,
 					display: 'Child 2',
 					parent_id: 1,
 					depth: 1,
-					isChildrenLoaded: true,
+					areChildrenLoaded: true,
 				},
 				{
 					id: 4,
 					display: 'Grandchild',
 					parent_id: 2,
 					depth: 2,
-					isChildrenLoaded: true,
+					areChildrenLoaded: true,
 				},
 			],
 			creatRepository = async () => {

package/package.json

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

package/src/Entity/Entity.js

@@ -121,21 +121,24 @@ class Entity extends EventEmitter {
 
 		/**
 		 * @member {TreeNode} parent - The parent TreeNode for this TreeNode
+		 * @public
 		 * For trees only
 		 */
 		this.parent = null;
 
 		/**
 		 * @member {array} children - Contains any children of this TreeNode
+		 * @public
 		 * For trees only
 		 */
 		this.children = this._originalData.children && !_.isEmpty(this._originalData.children) ? this._originalData.children : [];
 
 		/**
-		 * @member {boolean} isChildrenLoaded - Whether child TreeNodes have loaded for this TreeNode
+		 * @member {boolean} areChildrenLoaded - Whether child TreeNodes have loaded for this TreeNode
+		 * @public
 		 * For trees only
 		 */
-		this.isChildrenLoaded = this._originalData.isChildrenLoaded || false;
+		this.areChildrenLoaded = this._originalData.areChildrenLoaded || false;
 
 		/**
 		 * @member {boolean} isPersisted - Whether this object has been persisted in a storage medium
@@ -374,7 +377,7 @@ class Entity extends EventEmitter {
 	 * Assumes (and sets) isTempId === false.
 	 * @param {array} originalData - Raw data to load into entity.
 	 */
-	loadOriginalData = (originalData, assembleTreeNodes = true) => {
+	loadOriginalData = (originalData) => {
 		if (this.isDestroyed) {
 			throw Error('this.loadOriginalData is no longer valid. Entity has been destroyed.');
 		}
@@ -383,10 +386,6 @@ class Entity extends EventEmitter {
 		this._originalData = originalData || {};
 		this.reset();
 		this.getIdProperty().isTempId = false;
-
-		if (this.isTree && this.repository && assembleTreeNodes) {
-			this.repository.assembleTreeNodes(); // rebuilds them all
-		}
 	}
 
 	/**
@@ -1603,6 +1602,10 @@ class Entity extends EventEmitter {
 			throw Error('this.getHasChildren is no longer valid. TreeNode has been destroyed.');
 		}
 
+		if (!_.isEmpty(this.children)) {
+			return true; // In case the hasChildrenProperty is stale. i.e. That property came from server, and we now have children here
+		}
+
 		return this.getHasChildrenProperty().getSubmitValue();
 	}
 
@@ -1639,7 +1642,7 @@ class Entity extends EventEmitter {
 		if (this.isDestroyed) {
 			throw Error('this.getChildren is no longer valid. TreeNode has been destroyed.');
 		}
-		if (!this.isChildrenLoaded) {
+		if (!this.areChildrenLoaded) {
 			await this.loadChildren();
 		}
 		return this.children;
@@ -1667,12 +1670,13 @@ class Entity extends EventEmitter {
 		if (this.isDestroyed) {
 			throw Error('this.loadChildren is no longer valid. TreeNode has been destroyed.');
 		}
-		if (!this.repository?.loadChildren) {
-			throw Error('repository.loadChildren is not defined.');	
+		if (!this.repository?.loadChildNodes) {
+			throw Error('repository.loadChildNodes is not defined.');	
 		}
 
-		this.children = await this.repository.loadChildren(this, depth); // populates the children with a reference to this in child.parent
-		this.isChildrenLoaded = true;
+		const children = await this.repository.loadChildNodes(this, depth);
+		this.areChildrenLoaded = true;
+		return children;
 	}
 
 	/**

package/src/Repository/Ajax.js

@@ -385,6 +385,9 @@ class AjaxRepository extends Repository {
 	 * @fires beforeLoad,changeData,load,error
 	 */
 	load = async (params, callback = null) => {
+		if (this.isTree && this.getRootNodes) {
+			return this.getRootNodes();
+		}
 		if (this.isDestroyed) {
 			this.throwError('this.load is no longer valid. Repository has been destroyed.');
 			return;
@@ -431,10 +434,6 @@ class AjaxRepository extends Repository {
 							this._relayEntityEvents(entity);
 							return entity;
 						});
-
-						if (this.isTree) {
-							this.assembleTreeNodes();
-						}
 				
 						// Set the total records that pass filter
 						this.total = total;
@@ -442,6 +441,9 @@ class AjaxRepository extends Repository {
 
 						this.markLoaded();
 
+						if (this.isTree) {
+							this.assembleTreeNodes();
+						}
 						this.emit('changeData', this.entities);
 						this.emit('load', this);
 
@@ -584,6 +586,10 @@ class AjaxRepository extends Repository {
 						if (entity.isRemotePhantomMode) {
 							entity.isRemotePhantom = true;
 						}
+
+						if (this.isTree) {
+							this.assembleTreeNodes();
+						}
 					});
 	}
 	
@@ -637,11 +643,12 @@ class AjaxRepository extends Repository {
 						// Reload each entity with new data
 						// TODO: Check this
 						_.each(entities, (entity, ix) => {
-							entity.loadOriginalData(root[ix], false); // false to not assembleTreeNodes
+							entity.loadOriginalData(root[ix]);
 							if (entity.isRemotePhantomMode) {
 								entity.isRemotePhantom = true;
 							}
 						});
+
 						if (this.isTree) {
 							this.assembleTreeNodes();
 						}
@@ -690,6 +697,10 @@ class AjaxRepository extends Repository {
 						if (entity.isRemotePhantomMode && entity.isRemotePhantom) {
 							entity.isRemotePhantom = false;
 						}
+
+						if (this.isTree) {
+							this.assembleTreeNodes();
+						}
 					});
 	}
 
@@ -743,11 +754,12 @@ class AjaxRepository extends Repository {
 						// Reload each entity with new data
 						// TODO: Check this
 						_.each(entities, (entity, ix) => {
-							entity.loadOriginalData(root[ix], false); // false to not assembleTreeNodes
+							entity.loadOriginalData(root[ix]);
 							if (entity.isRemotePhantomMode && entity.isRemotePhantom) {
 								entity.isRemotePhantom = false;
 							}
 						});
+
 						if (this.isTree) {
 							this.assembleTreeNodes();
 						}
@@ -800,6 +812,10 @@ class AjaxRepository extends Repository {
 						const id = entity.id;
 						this.entities = _.filter(this.entities, (entity) => entity.id !== id);
 						entity.destroy();
+
+						if (this.isTree) {
+							this.assembleTreeNodes();
+						}
 					});
 	}
 
@@ -856,6 +872,10 @@ class AjaxRepository extends Repository {
 							}
 							return !deleteIt;
 						});
+
+						if (this.isTree) {
+							this.assembleTreeNodes();
+						}
 					});
 	}
 
@@ -874,6 +894,10 @@ class AjaxRepository extends Repository {
 			return !match;
 		});
 
+		if (this.isTree) {
+			this.assembleTreeNodes();
+		}
+
 		return true;
 	}
 
@@ -977,7 +1001,10 @@ class AjaxRepository extends Repository {
 
 							// Do we need to reload?
 							if (!this.eventsPaused) {
-								if (this.isRemotePhantomMode && (this._operations.add || this._operations.deletePhantom)) {
+								if (this.isTree) {
+									this.assembleTreeNodes();
+									this.emit('changeData', this.entities);
+								} else if (this.isRemotePhantomMode && (this._operations.add || this._operations.deletePhantom)) {
 									// Do nothing, as we don't want to immediately reload on add for a remote phantom mode record. It won't appear, and it will cause all kinds of trouble!
 									if (this._operations.deletePhantom) {
 										// sweep existing deleted records and remove them

package/src/Repository/OneBuild.js

@@ -106,7 +106,7 @@ class OneBuildRepository extends AjaxRepository {
 		}
 
 		const headers = _.merge({
-							'Content-Type': 'application/json',
+							// 'Content-Type': 'application/json', // Stops axios from using 'application/x-www-form-urlencoded'
 							Accept: 'application/json',
 						}, this.headers);
 
@@ -178,7 +178,11 @@ class OneBuildRepository extends AjaxRepository {
 		});
 
 		if (this.isLoaded && this.isAutoLoad && !this.eventsPaused) {
-			return this.reload();
+			if (this.isTree) {
+				return this.getRootNodes(1);
+			} else {
+				return this.reload();
+			}
 		}
 	}
 
@@ -199,9 +203,15 @@ class OneBuildRepository extends AjaxRepository {
 		
 		if (!this.eventsPaused) {
 			if (this.isLoaded && this.isAutoLoad) {
-				return this.reload().then(() => {
-					this.emit('changeSorters');
-				});
+				if (this.isTree) {
+					return this.getRootNodes(1).then(() => {
+						this.emit('changeSorters');
+					});
+				} else {
+					return this.reload().then(() => {
+						this.emit('changeSorters');
+					});
+				}
 			} else {
 				this.emit('changeSorters');
 			}
@@ -424,9 +434,9 @@ class OneBuildRepository extends AjaxRepository {
 	// /_/ /_/   \___/\___/____/
 
 	/**
-	 * Gets the root nodes of this tree.
+	 * Loads the root nodes of this tree.
 	 */
-	getRootNodes = async (getChildren = false, depth, getChildParams) => {
+	loadRootNodes = (depth) => {
 		this.ensureTree();
 		if (this.isDestroyed) {
 			this.throwError('this.setRootNode is no longer valid. Repository has been destroyed.');
@@ -436,26 +446,12 @@ class OneBuildRepository extends AjaxRepository {
 			this.throwError('Offline');
 			return;
 		}
+
 		this.emit('beforeLoad'); // TODO: canceling beforeLoad will cancel the load operation
 		this.markLoading();
 
-		
-		const data = {
-			url: this.name + '/getRootNodes',
-			data: qs.stringify({
-				getChildren,
-				depth,
-				conditions: getChildParams ? getChildParams() : null 
-			}),
-			method: 'POST',
-			baseURL: this.api.baseURL,
-		};
-
-		if (this.debugMode) {
-			console.log('getRootNodes', data);
-		}
-
-		return this.axios(data)
+		const data = _.merge({ depth }, this._baseParams, this._params);
+		return this._send('POST', this.name + '/getNodes', data)
 			.then((result) => {
 				if (this.debugMode) {
 					console.log('Response for getRootNodes', result);
@@ -474,6 +470,11 @@ class OneBuildRepository extends AjaxRepository {
 					message
 				} = this._processServerResponse(result);
 
+				if (!success) {
+					this.throwError(message);
+					return;
+				}
+
 				this._destroyEntities();
 
 				// Set the current entities
@@ -491,10 +492,10 @@ class OneBuildRepository extends AjaxRepository {
 
 				this.areRootNodesLoaded = true;
 
-				this.markLoaded();
-
-				this.emit('changeData', this.entities);
+				
+				// Don't emit events for root nodes...
 				this.emit('load', this);
+				// this.emit('changeData', this.entities);
 
 				return this.getBy((entity) => {
 					return entity.isRoot;
@@ -506,75 +507,125 @@ class OneBuildRepository extends AjaxRepository {
 	}
 
 	/**
-	 * Searches all nodes for the supplied text.
-	 * This basically takes the search query and returns whatever the server sends
+	 * Loads (or reloads) the children of the supplied treeNode
 	 */
-	searchTree = async (q) => {
+	loadChildNodes = (treeNode, depth = 1) => {
 		this.ensureTree();
 		if (this.isDestroyed) {
-			this.throwError('this.searchTree is no longer valid. Repository has been destroyed.');
+			this.throwError('this.loadChildNodes is no longer valid. Repository has been destroyed.');
 			return;
 		}
 		if (!this.isOnline) {
 			this.throwError('Offline');
 			return;
 		}
-		
-		const data = {
-			url: this.name + '/searchTree',
-			data: qs.stringify({
-				q,
-			}),
-			method: 'POST',
-			baseURL: this.api.baseURL,
-		};
 
-		if (this.debugMode) {
-			console.log('searchTree', data);
+		// If children already exist, remove them from the repository
+		// This way, we can reload just a portion of the tree
+		if (!_.isEmpty(treeNode.children)) {
+			const children = treeNode.children;
+			treeNode.children = [];
+
+			_.each(children, (child) => {
+				this.removeNode(child);
+			});
 		}
+		
+		this.markLoading();
 
-		return this.axios(data)
+		const data = _.merge({ depth, parentId: treeNode.id, }, this._baseParams, this._params);
+		return this._send('POST', this.name + '/getNodes', data)
 			.then((result) => {
 				if (this.debugMode) {
-					console.log('searchTree response', result);
+					console.log('Response for loadChildNodes', result);
 				}
 
-				const response = result.data;
-				if (!response.success) {
-					this.throwError(response.data);
+				if (this.isDestroyed) {
+					// If this repository gets destroyed before it has a chance
+					// to process the Ajax request, just ignore the response.
 					return;
 				}
 
-				return response.data;
+				const {
+					root,
+					success,
+					total,
+					message
+				} = this._processServerResponse(result);
+
+				if (!success) {
+					this.throwError(message);
+					return;
+				}
+				
+				// Set the current entities
+				const children = _.map(root, (data) => {
+					const entity = Repository._createEntity(this.schema, data, this, true);
+					this._relayEntityEvents(entity);
+					return entity;
+				});
+
+				this.entities = this.entities.concat(children);
+
+				this.assembleTreeNodes();
+				
+				this._setPaginationVars();
+
+				// this.emit('changeData', this.entities);
+				this.emit('load', this);
+
+				return children;
+			})
+			.finally(() => {
+				this.markLoading(false);
 			});
 	}
+
 	/**
-	 * Loads the children of the supplied treeNode
+	 * Searches all nodes for the supplied text.
+	 * This basically takes the search query and returns whatever the server sends
 	 */
-	loadChildren = async (treeNode, depth = 1) => {
+	searchNodes = (q) => {
 		this.ensureTree();
 		if (this.isDestroyed) {
-			this.throwError('this.setRootNode is no longer valid. Repository has been destroyed.');
+			this.throwError('this.searchNodes is no longer valid. Repository has been destroyed.');
 			return;
 		}
-
-
-		// If children already exist, remove them from the repository
-		// This way, we can reload just a portion of the tree
-		if (!_.isEmpty(treeNode.children)) {
-			const children = treeNode.children;
-			treeNode.children = [];
-
-			_.each(children, (child) => {
-				this.removeNode(child);
-			});
+		if (!this.isOnline) {
+			this.throwError('Offline');
+			return;
 		}
 
+		const data = _.merge({ q, }, this._baseParams, this._params);
+		return this._send('POST', this.name + '/searchNodes', data)
+			.then((result) => {
+				if (this.debugMode) {
+					console.log('Response for searchNodes', result);
+				}
 
-		// TODO: load children here
+				if (this.isDestroyed) {
+					// If this repository gets destroyed before it has a chance
+					// to process the Ajax request, just ignore the response.
+					return;
+				}
 
+				const {
+					root,
+					success,
+					total,
+					message
+				} = this._processServerResponse(result);
 
-		
+				if (!success) {
+					this.throwError(message);
+					return;
+				}
+
+				return root;
+			})
+			.finally(() => {
+				this.markLoading(false);
+			});
 	}
 
 	/**

package/src/Repository/Repository.js

@@ -282,16 +282,16 @@ export default class Repository extends EventEmitter {
 		
 		// Assign event handlers
 		this.on('entity_change', async (entity) => { // Entity changed its value
-			if (this.isAutoSave) {
+			if (this.isAutoSave && !this.isRemotePhantomMode) {
 				return await this.save(entity);
 			}
 		});
 
 		// Auto load & sort
-		if (this.isAutoLoad) {
+		if (this.isAutoLoad && !this.isTree) {
 			await this.load();
 		}
-		if (!this.isSorted && this.isAutoSort && !this.isRemoteSort) { // load may have sorted, in which case this will be skipped.
+		if (!this.isSorted && this.isAutoSort && !this.isRemoteSort && !this.isTree) { // load may have sorted, in which case this will be skipped.
 			await this.sort();
 		}
 
@@ -999,7 +999,17 @@ export default class Repository extends EventEmitter {
 			entity = Repository._createEntity(this.schema, data, this, isPersisted, isDelayedSave, this.isRemotePhantomMode);
 		}
 		this._relayEntityEvents(entity);
-		this.entities.unshift(entity); // Add to *beginning* of entities array, so the phantom record will appear at the beginning of the current page
+		if (this.isTree && data.parentId) {
+			// Trees need new node to be added as first child of parent
+			const ix = this.getIxById(data.parentId) +1;
+			this.entities = [
+				...this.entities.slice(0, ix),
+				entity,
+				...this.entities.slice(ix)
+			];
+		} else {
+			this.entities.unshift(entity); // Add to *beginning* of entities array, so the phantom record will appear at the beginning of the current page
+		}
 
 		// Create id if needed
 		if (!this.isRemotePhantomMode && entity.isPhantom) {
@@ -1958,6 +1968,7 @@ export default class Repository extends EventEmitter {
 		return entities;
 	}
 
+
 	/**
 	 * Populates the TreeNodes with .parent and .children references
 	 */

package/src/Util/Parsers.js

@@ -1,7 +1,7 @@
 import moment from 'moment';
 import momentAlt from 'relative-time-parser'; // Notice this version of moment is imported from 'relative-time-parser', and may be out of sync with our general 'moment' package
 import accounting from 'accounting-js';
-import * as chrono from 'chrono-node'; // Doesn't yet work in React Native ("SyntaxError: Invalid RegExp: Quantifier has nothing to repeat, js engine: hermes")  Github ticket: https://github.com/facebook/hermes/blob/main/doc/RegExp.md
+// import * as chrono from 'chrono-node'; // Doesn't yet work in React Native ("SyntaxError: Invalid RegExp: Quantifier has nothing to repeat, js engine: hermes")  Github ticket: https://github.com/facebook/hermes/blob/main/doc/RegExp.md
 import _ from 'lodash';
 
 class Parsers {