@onehat/data 1.17.2 → 1.17.3

package/cypress/e2e/Config.cy.js

@@ -155,7 +155,7 @@ describe('Config options', function() {
 
 	});
 
-	it.only('Replace this.method with config.method', function() {
+	it('Replace this.method with config.method', function() {
 		
 		class Base {
 			constructor(config = {}) {

package/cypress/e2e/Entity.cy.js

@@ -471,11 +471,11 @@ describe('Entity', function() {
 		});
 
 		it('hash', function() {
-			expect(this.entity.hash).to.be.eq(4635951664292355);
+			expect(this.entity.hash).to.be.eq(5365087438356619);
 
 			// change a property & check again
 			this.entity.foo = 3;
-			expect(this.entity.hash).to.be.eq(1510366977941323);
+			expect(this.entity.hash).to.be.eq(358445507972157);
 		});
 
 	});
@@ -900,4 +900,86 @@ describe('Entity', function() {
 		});
 	});
 
+	describe('tree', function() {
+
+		// Needed for all tree tests...
+		const
+			schema = new Schema({
+				name: 'nodes',
+				model: {
+					idProperty: 'id',
+					displayProperty: 'display',
+					parentIdProperty: 'parent_id',
+					depthProperty: 'depth',
+					hasChildrenProperty: 'hasChildren',
+					isTree: true,
+					isClosureTable: true,
+					properties: [
+						{ name: 'id', type: 'int' },
+						{ name: 'display' },
+						{ name: 'parent_id', type: 'int' },
+						{ name: 'depth', type: 'int' },
+						{ name: 'hasChildren', type: 'bool' },
+					],
+				},
+			}),
+			data = {
+				id: 2,
+				display: 'Child 1',
+				parent_id: 1,
+				depth: 1,
+				hasChildren: true,
+			},
+			creatEntity = async () => {
+				const entity = new Entity(schema, data);
+				entity.initialize();
+				return entity;
+			},
+			destoryEntity = (entity) => {
+				entity.destroy();
+			};
+
+		it('magic properties', function() {
+			(async () => {
+				const entity = await creatEntity();
+
+				expect(entity.parentId).to.be.eq(1);
+				expect(entity.depth).to.be.eq(1);
+				expect(entity.hasChildren).to.be.true;
+				
+				destoryEntity(entity);
+			})();
+		});
+
+		it('parents/children', function() {
+			(async () => {
+				const entity = await creatEntity();
+				
+				const parent = this.entity;
+				entity.parent = parent;
+				expect(entity.parent).to.be.eq(parent);
+				
+				const children = [this.entity];
+				entity.children = children;
+				expect(entity.children).to.be.eq(children);
+
+				destoryEntity(entity);
+			})();
+		});
+
+		it('ensureTree', function() {
+			(async () => {
+				const entity = await creatEntity();
+				
+				expect(entity.ensureTree()).to.be.true;
+
+				entity.isTree = false;
+				expect(entity.ensureTree()).to.be.false;
+
+				destoryEntity(entity);
+			})();
+		});
+
+	});
+
 });

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

@@ -91,7 +91,7 @@ describe('OneBuildRepository', function() {
 			r.setValuelessParam('conditions[field IS NOT NULL]');
 
 			expect(r._params.conditions.field).to.be.eq(1);
-			expect(r._params.conditions[0]).to.be.eq('field IS NOT NULL');
+			expect(r._params.conditions.undefined).to.be.eq('field IS NOT NULL');
 		});
 
 		it('clearParams', function() {

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

@@ -281,7 +281,7 @@ describe('MemoryRepository', function() {
 			expect(_.size(this.repository.getRawValues())).to.be.eq(5);
 			expect(_.size(this.repository.getOriginalData())).to.be.eq(5);
 			expect(_.size(this.repository.getParsedValues())).to.be.eq(5);
-			expect(this.repository.getByIx(2).value).to.be.eq('five');
+			expect(this.repository.getByIx(4).value).to.be.eq('five');
 			expect(_.size(this.repository.getNonPersisted())).to.be.eq(0);
 			expect(_.size(this.repository.getPhantom())).to.be.eq(0);
 			expect(_.size(this.repository.getDirty())).to.be.eq(0);

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

@@ -66,12 +66,21 @@ describe('OneBuildRepository', function() {
 	it('401', function() {
 		cy.wrap((async () => {
 
-			let loggedOut = false;
+			let loggedOut = false,
+				isError = false;
 			this.oneHatData.on('logout', function() { // NOTE: We are listening to the global oneHatData object, not just the individual repository
 				loggedOut = true;
 			});
-			await this.repository.load();
-			expect(loggedOut).to.be.true;
+			try {
+				await this.repository.load();
+			} catch(e) {
+				isError = true;
+			}
+			if (!isError) {
+				expect(loggedOut).to.be.true;
+			} else {
+				throw Error('404 error! Maybe set baseUrl?')
+			}
 
 		})());
 	});

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

@@ -1050,7 +1050,7 @@ describe('Repository Base', function() {
 
 	});
 
-	describe('options', function() {
+	describe('misc', function() {
 		it('setOptions', function() {
 
 			this.repository.setOptions({
@@ -1061,11 +1061,232 @@ describe('Repository Base', function() {
 			
 			expect(this.repository.api.baseURL).to.be.eq('test123');
 		});
+
+		it('toString', function() {
+			const str = this.repository.toString();
+			expect(str).to.be.eq('NullRepository {bar} - foo');
+		});
 	});
 
-	it('toString', function() {
-		const str = this.repository.toString();
-		expect(str).to.be.eq('NullRepository {bar} - foo');
+	describe('tree', function() {
+
+		// Needed for all tree tests...
+		const
+			schema = new Schema({
+				name: 'nodes',
+				model: {
+					idProperty: 'id',
+					displayProperty: 'display',
+					parentIdProperty: 'parent_id',
+					depthProperty: 'depth',
+					hasChildrenProperty: 'hasChildren',
+					isTree: true,
+					isClosureTable: true,
+					properties: [
+						{ name: 'id', type: 'int', },
+						{ name: 'display', },
+						{ name: 'parent_id', type: 'int', },
+						{ name: 'depth', type: 'int', },
+						{ name: 'hasChildren', type: 'bool', },
+					],
+				},
+				repository: 'memory',
+			}),
+			Repository = RepositoryTypes.memory,
+			data = [
+				{
+					id: 1,
+					display: 'Root',
+					parent_id: null,
+					depth: 0,
+					hasChildren: true,
+					isChildrenLoaded: true,
+				},
+				{
+					id: 2,
+					display: 'Child 1',
+					parent_id: 1,
+					depth: 1,
+					hasChildren: true,
+					isChildrenLoaded: true,
+				},
+				{
+					id: 3,
+					display: 'Child 2',
+					parent_id: 1,
+					depth: 1,
+					isChildrenLoaded: true,
+				},
+				{
+					id: 4,
+					display: 'Grandchild',
+					parent_id: 2,
+					depth: 2,
+					isChildrenLoaded: true,
+				},
+			],
+			creatRepository = async () => {
+				const repository = new Repository({
+					id: 'tree',
+					schema,
+					isAutoLoad: true,
+					isAutoSave: true,
+					isPaginated: true,
+					data,
+				});
+				await repository.initialize();
+				return repository;
+			},
+			destoryRepository = (repository) => {
+				repository.destroy();
+			};
+
+		it('TreeNode (Entity) tests', function() {
+			(async () => {
+				const repository = await creatRepository();
+				repository.assembleTreeNodes();
+
+				const
+					id1 = repository.getById(1),
+					id2 = repository.getById(2),
+					id3 = repository.getById(3),
+					id4 = repository.getById(4);
+
+				// hasChildren
+				expect(id2.hasChildren).to.be.true;
+				expect(id4.hasChildren).to.be.false;
+
+				// getParent
+				expect(id2.getParent()).to.be.eq(id1);
+				expect(id1.getParent()).to.be.null;
+
+				// getChildren
+				let children = await id2.getChildren();
+				expect(children).to.be.eql([id4]);
+				
+				children = await id3.getChildren();
+				expect(children).to.be.empty;
+				
+				// hasThisChild
+				let hasThisChild = await id2.hasThisChild(id3);
+				expect(hasThisChild).to.be.false;
+				
+				hasThisChild = await id2.hasThisChild(id4);
+				expect(hasThisChild).to.be.true;
+
+				// loadChildren (& reloadChildren)
+				// this needs to be on OneBuild spec
+
+				// getPrevousSibling
+				let sibling = await id2.getPrevousSibling();
+				expect(sibling).to.be.null;
+
+				sibling = await id3.getPrevousSibling();
+				expect(sibling).to.be.eq(id2);
+
+				sibling = await id3.getNextSibling();
+				expect(sibling).to.be.null;
+
+				sibling = await id2.getNextSibling();
+				expect(sibling).to.be.eq(id3);
+
+				// getChildAt
+				let child = await id1.getChildAt(0);
+				expect(child).to.be.eq(id2);
+				
+				child = await id1.getChildAt(1);
+				expect(child).to.be.eq(id3);
+				
+				child = await id1.getChildAt(2);
+				expect(child).to.be.null;
+				
+				// getFirstChild
+				child = await id1.getFirstChild();
+				expect(child).to.be.eq(id2);
+
+				child = await id4.getFirstChild();
+				expect(child).to.be.null;
+				
+				// getLastChild
+				child = await id1.getLastChild();
+				expect(child).to.be.eq(id3);
+
+				child = await id4.getLastChild();
+				expect(child).to.be.null;
+				
+				destoryRepository(repository);
+			})();
+		});
+
+		it('getRootNodes', function() {
+			(async () => {
+				const repository = await creatRepository();
+				repository.assembleTreeNodes();
+
+				const
+					id1 = repository.getById(1);
+
+				const rootNodes = repository.getRootNodes();
+				expect(rootNodes).to.be.eql([id1]);
+				
+				destoryRepository(repository);
+			})();
+		});
+
+		it('assembleTreeNodes', function() {
+			(async () => {
+				const repository = await creatRepository();
+
+				const
+					id1 = repository.getById(1),
+					id2 = repository.getById(2),
+					id3 = repository.getById(3),
+					id4 = repository.getById(4);
+
+				// Verify no children or parents
+				expect(id2.parent).to.be.null;
+				expect(id2.children).to.be.empty;
+
+				repository.assembleTreeNodes();
+
+				// Now check that they are populated
+				expect(id2.parent).to.be.eq(id1);
+				expect(id2.children).to.be.eql([id4]);
+
+				// Re-assemble them
+				repository.assembleTreeNodes();
+
+				// check them again
+				expect(id2.parent).to.be.eq(id1);
+				expect(id2.children).to.be.eql([id4]);
+				
+				destoryRepository(repository);
+			})();
+		});
+
+		it('removeTreeNode', function() {
+			(async () => {
+				const repository = await creatRepository();
+				repository.assembleTreeNodes();
+
+				const
+					id1 = repository.getById(1),
+					id2 = repository.getById(2),
+					id3 = repository.getById(3),
+					id4 = repository.getById(4);
+
+				const before = repository.getEntities();
+				expect(before.length).to.be.eq(4);
+
+				repository.removeTreeNode(id2);
+
+				const after = repository.getEntities();
+				expect(after.length).to.be.eq(2);
+				
+				destoryRepository(repository);
+			})();
+		});
+
 	});
 
 });

package/package.json

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

package/src/Entity/Entity.js

@@ -35,7 +35,7 @@ class Entity extends EventEmitter {
 	 * @param {boolean} originalIsMapped - Has data already been mapped according to schema?
 	 * @param {boolean} isDelayedSave - Should the repository skip autosave when immediately adding the record?
 	 */
-	constructor(schema, rawData = {}, repository = null, originalIsMapped = false, isDelayedSave = false, isRemotePhantomMode = false, isRoot = false) {
+	constructor(schema, rawData = {}, repository = null, originalIsMapped = false, isDelayedSave = false, isRemotePhantomMode = false) {
 		super(...arguments);
 
 		if (!schema) {
@@ -118,12 +118,6 @@ class Entity extends EventEmitter {
 			throw new Error('hasChildrenProperty cannot be empty for a TreeNode');
 		}
 
-		/**
-		 * @member {boolean} isRoot - Whether this TreeNode is the root TreeNode
-		 * For trees only
-		 */
-		this.isRoot = false;
-
 		/**
 		 * @member {TreeNode} parent - The parent TreeNode for this TreeNode
 		 * For trees only
@@ -1504,7 +1498,7 @@ class Entity extends EventEmitter {
 			throw Error('this.getParentId is no longer valid. TreeNode has been destroyed.');
 		}
 		
-		return this.geParentIdProperty().getSubmitValue();
+		return this.getParentIdProperty().getSubmitValue();
 	}
 
 	/**
@@ -1517,13 +1511,24 @@ class Entity extends EventEmitter {
 
 	/**
 	 * Getter of hasParent
-	 * Returns true if this is not a root node
+	 * Returns true if this node has a parentId
 	 * @return {boolean} hasParent
 	 */
 	get hasParent() {
 		this.ensureTree();
 
-		return !this.isRoot;
+		return !!this.parentId;
+	}
+
+	/**
+	 * Getter of isRoot
+	 * Returns true if this node has no parent
+	 * @return {boolean} hasParent
+	 */
+	get isRoot() {
+		this.ensureTree();
+
+		return !this.hasParent;
 	}
 
 	/**
@@ -1626,13 +1631,26 @@ class Entity extends EventEmitter {
 		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.
 	 */
@@ -1669,9 +1687,9 @@ class Entity extends EventEmitter {
 		const 
 			parent = this.getParent(),
 			siblings = await parent.getChildren();
-		let previous;
+		let previous = null;
 		_.each(siblings, (treeNode) => {
-			if (treeNode === this) {
+			if (treeNode.id === this.id) {
 				return false;
 			}
 			previous = treeNode;
@@ -1699,7 +1717,7 @@ class Entity extends EventEmitter {
 				next = treeNode;
 				return false;
 			}
-			if (treeNode === this) {
+			if (treeNode.id === this.id) {
 				returnNext = true;
 			}
 		})
@@ -1716,6 +1734,9 @@ class Entity extends EventEmitter {
 			throw Error('this.getChildAt is no longer valid. TreeNode has been destroyed.');
 		}
 
+		if (!this.children[ix]) {
+			return null;
+		}
 		return this.children[ix];
 	}
 
@@ -1729,6 +1750,9 @@ class Entity extends EventEmitter {
 			throw Error('this.getFirstChild is no longer valid. TreeNode has been destroyed.');
 		}
 
+		if (!this.children[0]) {
+			return null;
+		}
 		return this.children[0];
 	}
 
@@ -1742,7 +1766,11 @@ class Entity extends EventEmitter {
 			throw Error('this.getLastChild is no longer valid. TreeNode has been destroyed.');
 		}
 
-		return this.children.slice(-1)[0]
+		const child = this.children.slice(-1)[0];
+		if (!child) {
+			return null;
+		}
+		return child;
 	}
 
 	/**
@@ -1751,8 +1779,10 @@ class Entity extends EventEmitter {
 	 */
 	ensureTree = async () => {
 		if (!this.isTree) {
-			this.throwError('This Repository is not a tree!');
+			this.throwError('This Entity is not a tree!');
+			return false;
 		}
+		return true;
 	}
 
 

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/Repository.js

@@ -995,7 +995,7 @@ export default class Repository extends EventEmitter {
 			entity = Repository._createEntity(this.schema, data, this, isPersisted, originalIsMapped, isDelayedSave, this.isRemotePhantomMode);
 		}
 		this._relayEntityEvents(entity);
-		this.entities.unshift(entity);
+		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) {
@@ -1056,11 +1056,13 @@ export default class Repository extends EventEmitter {
 	addMultiple = async (allData, isPersisted = false, originalIsMapped = false) => {
 
 		let entities = [],
-			i;
+			i,
+			data,
+			entity;
 
 		for (i = 0; i < allData.length; i++) {
-			const data = allData[i],
-				entity = await this.add(data, isPersisted, originalIsMapped);
+			data = allData[i];
+			entity = await this.add(data, isPersisted, originalIsMapped);
 			entities.push(entity);
 		};
 		
@@ -2013,7 +2015,9 @@ export default class Repository extends EventEmitter {
 	ensureTree = async () => {
 		if (!this.isTree) {
 			this.throwError('This Repository is not a tree!');
+			return false;
 		}
+		return true;
 	}