@onehat/data 1.17.0 → 1.17.3

package/src/Entity/Entity.js

@@ -104,9 +104,37 @@ class Entity extends EventEmitter {
 		this.properties = [];
 
 		/**
-		 * @member {boolean} isTreeNode - Whether this Entity is a TreeNode
+		 * @member {boolean} isTree - Whether this Entity is a TreeNode
 		 */
-		this.isTreeNode = false;
+		this.isTree = schema.model.isTree || false;
+
+		if (this.isTree && !schema.model.parentIdProperty) {
+			throw new Error('parentIdProperty cannot be empty for a TreeNode');
+		}
+		if (this.isTree && this.repository?.isClosureTable && !schema.model.depthProperty) {
+			throw new Error('depthProperty cannot be empty for a Closure Table TreeNode');
+		}
+		if (this.isTree && !schema.model.hasChildrenProperty) {
+			throw new Error('hasChildrenProperty cannot be empty for a TreeNode');
+		}
+
+		/**
+		 * @member {TreeNode} parent - The parent TreeNode for this TreeNode
+		 * For trees only
+		 */
+		this.parent = null;
+
+		/**
+		 * @member {array} children - Contains any children of this TreeNode
+		 * 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
+		 * For trees only
+		 */
+		this.isChildrenLoaded = this._originalData.isChildrenLoaded || false;
 
 		/**
 		 * @member {boolean} isPersisted - Whether this object has been persisted in a storage medium
@@ -350,7 +378,7 @@ class Entity extends EventEmitter {
 	 * Assumes (and sets) isTempId === false.
 	 * @param {array} originalData - Raw data to load into entity.
 	 */
-	loadOriginalData = (originalData) => {
+	loadOriginalData = (originalData, assembleTreeNodes = true) => {
 		if (this.isDestroyed) {
 			throw Error('this.loadOriginalData is no longer valid. Entity has been destroyed.');
 		}
@@ -358,6 +386,10 @@ 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
+		}
 	}
 
 	/**
@@ -1432,6 +1464,328 @@ class Entity extends EventEmitter {
 	}
 
 
+
+	//   ______
+	//  /_  __/_______  ___  _____
+	//   / / / ___/ _ \/ _ \/ ___/
+	//  / / / /  /  __/  __(__  )
+	// /_/ /_/   \___/\___/____/
+
+	/**
+	 * Gets the "parentId" Property object for this TreeNode.
+	 * This is the Property whose value represents the id for the parent TreeNode.
+	 * @return {Property} parentId Property
+	 */
+	getParentIdProperty = () => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			throw Error('this.getParentIdProperty is no longer valid. TreeNode has been destroyed.');
+		}
+
+		const parentIdProperty = this.getSchema().model.parentIdProperty;
+		return this.getProperty(parentIdProperty);
+	}
+
+	/**
+	 * Gets the parentId for this TreeNode.
+	 * It does this by getting the parentId property's submitValue.
+	 * It doesn't look at some value created by client on the TreeNode.
+	 * @return {any} parentId - The parentId
+	 */
+	getParentId = () => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			throw Error('this.getParentId is no longer valid. TreeNode has been destroyed.');
+		}
+		
+		return this.getParentIdProperty().getSubmitValue();
+	}
+
+	/**
+	 * Getter of parentId for this TreeNode.
+	 * @return {any} parentId - The parentId
+	 */
+	get parentId() {
+		return this.getParentId();
+	}
+
+	/**
+	 * Getter of hasParent
+	 * Returns true if this node has a parentId
+	 * @return {boolean} hasParent
+	 */
+	get hasParent() {
+		this.ensureTree();
+
+		return !!this.parentId;
+	}
+
+	/**
+	 * Getter of isRoot
+	 * Returns true if this node has no parent
+	 * @return {boolean} hasParent
+	 */
+	get isRoot() {
+		this.ensureTree();
+
+		return !this.hasParent;
+	}
+
+	/**
+	 * Gets the "depth" Property object for this TreeNode.
+	 * This is the Property whose value represents the depth of the TreeNode.
+	 * @return {Property} parentId Property
+	 */
+	getDepthProperty = () => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			throw Error('this.getDepthProperty is no longer valid. TreeNode has been destroyed.');
+		}
+
+		const depthProperty = this.getSchema().model.depthProperty;
+		return this.getProperty(depthProperty);
+	}
+
+	/**
+	 * Gets the depth for this TreeNode.
+	 * It does this by getting the depth property's submitValue.
+	 * @return {any} depth - The depth
+	 */
+	getDepth = () => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			throw Error('this.getDepth is no longer valid. TreeNode has been destroyed.');
+		}
+		
+		return this.getDepthProperty().getSubmitValue();
+	}
+
+	/**
+	 * Getter of depth for this TreeNode.
+	 * @return {any} depth - The depth
+	 */
+	get depth() {
+		return this.getDepth();
+	}
+
+	/**
+	 * Gets the "hasChildren" Property object for this TreeNode.
+	 * This is the Property whose value represents whether this TreeNode has any children.
+	 * @return {Property} parentId Property
+	 */
+	getHasChildrenProperty = () => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			throw Error('this.getHasChildrenProperty is no longer valid. TreeNode has been destroyed.');
+		}
+
+		const hasChildrenProperty = this.getSchema().model.hasChildrenProperty;
+		return this.getProperty(hasChildrenProperty);
+	}
+
+	/**
+	 * Gets the hasChildren value for this TreeNode.
+	 * It does this by getting the hasChildren property's submitValue.
+	 * It doesn't look at some value created by client on the TreeNode.
+	 * @return {any} parentId - The parentId
+	 */
+	getHasChildren = () => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			throw Error('this.getHasChildren is no longer valid. TreeNode has been destroyed.');
+		}
+
+		return this.getHasChildrenProperty().getSubmitValue();
+	}
+
+	/**
+	 * Getter of hasChildren for this TreeNode.
+	 * @return {any} parentId - The parentId
+	 */
+	get hasChildren() {
+		return this.getHasChildren();
+	}
+
+	/**
+	 * Getter of parent TreeNode for this TreeNode.
+	 * @return {TreeNode} parent - The parent TreeNode
+	 */
+	getParent = () => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			throw Error('this.getParent is no longer valid. TreeNode has been destroyed.');
+		}
+
+		if (!this.hasParent) {
+			return null;
+		}
+		return this.parent;
+	}
+
+	/**
+	 * Getter of child TreeNodes for this TreeNode.
+	 * @return {array} children - The children
+	 */
+	getChildren = async () => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			throw Error('this.getChildren is no longer valid. TreeNode has been destroyed.');
+		}
+		if (!this.isChildrenLoaded) {
+			await this.loadChildren();
+		}
+		return this.children;
+	}
+
+	/**
+	 * Whether the supplied TreeNode is a child of this TreeNode.
+	 * @return {boolean} hasThisChild
+	 */
+	hasThisChild = async (treeNode) => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			throw Error('this.hasThisChild is no longer valid. TreeNode has been destroyed.');
+		}
+
+		const children = await this.getChildren();
+		return  _.includes(children, treeNode);
+	}
+
+	/**
+	 * Loads the children of this TreeNode from repository.
+	 */
+	loadChildren = async (depth) => {
+		this.ensureTree();
+		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.');	
+		}
+
+		this.children = await this.repository.loadChildren(this, depth); // populates the children with a reference to this in child.parent
+		this.isChildrenLoaded = true;
+	}
+
+	/**
+	 * Alias for loadChildren
+	 */
+	reloadChildren = () => { // alias
+		return this.loadChildren();
+	}
+
+	/**
+	 * Gets the previous sibling of this TreeNode from repository.
+	 * @return {TreeNode} sibling
+	 */
+	getPrevousSibling = async () => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			throw Error('this.getPrevousSibling is no longer valid. TreeNode has been destroyed.');
+		}
+
+		const 
+			parent = this.getParent(),
+			siblings = await parent.getChildren();
+		let previous = null;
+		_.each(siblings, (treeNode) => {
+			if (treeNode.id === this.id) {
+				return false;
+			}
+			previous = treeNode;
+		})
+		return previous;
+	}
+
+	/**
+	 * Gets the next sibling of this TreeNode from repository.
+	 * @return {TreeNode} sibling
+	 */
+	getNextSibling = async () => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			throw Error('this.getNextSibling is no longer valid. TreeNode has been destroyed.');
+		}
+
+		const 
+			parent = this.getParent(),
+			siblings = await parent.getChildren();
+		let returnNext = false,
+			next = null;
+		_.each(siblings, (treeNode) => {
+			if (returnNext) {
+				next = treeNode;
+				return false;
+			}
+			if (treeNode.id === this.id) {
+				returnNext = true;
+			}
+		})
+		return next;
+	}
+
+	/**
+	 * Gets the child of this TreeNode at index ix from repository.
+	 * @return {TreeNode} child
+	 */
+	getChildAt = (ix) => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			throw Error('this.getChildAt is no longer valid. TreeNode has been destroyed.');
+		}
+
+		if (!this.children[ix]) {
+			return null;
+		}
+		return this.children[ix];
+	}
+
+	/**
+	 * Gets the first child of this TreeNode from repository.
+	 * @return {TreeNode} child
+	 */
+	getFirstChild = () => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			throw Error('this.getFirstChild is no longer valid. TreeNode has been destroyed.');
+		}
+
+		if (!this.children[0]) {
+			return null;
+		}
+		return this.children[0];
+	}
+
+	/**
+	 * Gets the last child of this TreeNode from repository.
+	 * @return {TreeNode} child
+	 */
+	getLastChild = () => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			throw Error('this.getLastChild is no longer valid. TreeNode has been destroyed.');
+		}
+
+		const child = this.children.slice(-1)[0];
+		if (!child) {
+			return null;
+		}
+		return child;
+	}
+
+	/**
+	 * Helper to make sure this Repository is a tree
+	 * @private
+	 */
+	ensureTree = async () => {
+		if (!this.isTree) {
+			this.throwError('This Entity is not a tree!');
+			return false;
+		}
+		return true;
+	}
+
+
 	/**
 	 * Destroy this object.
 	 * - Removes all circular references to parent objects

package/src/Repository/Ajax.js

@@ -430,6 +430,10 @@ class AjaxRepository extends Repository {
 							this._relayEntityEvents(entity);
 							return entity;
 						});
+
+						if (this.isTree) {
+							this.assembleTreeNodes();
+						}
 				
 						// Set the total records that pass filter
 						this.total = total;
@@ -492,7 +496,7 @@ class AjaxRepository extends Repository {
 						}
 
 						const updatedData = root[0];
-						entity.loadOriginalData(updatedData, true);
+						entity.loadOriginalData(updatedData);
 						entity.emit('reload', entity);
 						
 						this.markLoaded();
@@ -638,11 +642,14 @@ class AjaxRepository extends Repository {
 						// Reload each entity with new data
 						// TODO: Check this
 						_.each(entities, (entity, ix) => {
-							entity.loadOriginalData(root[ix]);
+							entity.loadOriginalData(root[ix], false); // false to not assembleTreeNodes
 							if (entity.isRemotePhantomMode) {
 								entity.isRemotePhantom = true;
 							}
 						});
+						if (this.isTree) {
+							this.assembleTreeNodes();
+						}
 					});
 	}
 
@@ -748,11 +755,14 @@ class AjaxRepository extends Repository {
 						// Reload each entity with new data
 						// TODO: Check this
 						_.each(entities, (entity, ix) => {
-							entity.loadOriginalData(root[ix]);
+							entity.loadOriginalData(root[ix], false); // false to not assembleTreeNodes
 							if (entity.isRemotePhantomMode && entity.isRemotePhantom) {
 								entity.isRemotePhantom = false;
 							}
 						});
+						if (this.isTree) {
+							this.assembleTreeNodes();
+						}
 					});
 	}
 

package/src/Repository/Memory.js

@@ -511,13 +511,9 @@ class MemoryRepository extends Repository {
 
 		super.removeEntity(entity);
 
-		if (this.hasSorters) {
-			this._applySorters();
-		}
-		if (this.hasFilters) {
-			this._applyFilters();
-		}
 		delete this._keyedEntities[id];
+
+		this._recalculate();
 	}
 
 

package/src/Repository/OneBuild.js

@@ -404,6 +404,86 @@ class OneBuildRepository extends AjaxRepository {
 			});
 	}
 
+
+	//   ______
+	//  /_  __/_______  ___  _____
+	//   / / / ___/ _ \/ _ \/ ___/
+	//  / / / /  /  __/  __(__  )
+	// /_/ /_/   \___/\___/____/
+
+	/**
+	 * Gets the root nodes of this tree.
+	 */
+	getRootNodes = async (getChildren = false, depth) => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			this.throwError('this.setRootNode is no longer valid. Repository has been destroyed.');
+			return;
+		}
+
+		// Clear all entities, if any exist
+		_.each(this.entities, (entity) => {
+			entity.destroy();
+		});
+		this.entities = [];
+		
+		// TODO: Load root nodes (and possibly their children)
+
+
+	}
+
+	/**
+	 * Loads the children of the supplied treeNode
+	 */
+	loadChildren = async (treeNode, depth = 1) => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			this.throwError('this.setRootNode 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);
+			});
+		}
+
+
+		// TODO: load children here
+
+
+		
+	}
+
+	/**
+	 * Alias for loadChildren
+	 */
+	reloadChildren = (treeNode, depth) => {
+		return this.loadChildren(treeNode, depth);
+	}
+
+	/**
+	 * Moves the supplied treeNode to a new position on the tree
+	 */
+	moveTreeNode = async (treeNode, newParentId) => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			this.throwError('this.moveTreeNode is no longer valid. Repository has been destroyed.');
+			return;
+		}
+
+		// TODO: move node here
+
+
+		
+	}
+
 }