@onehat/data 1.16.10 → 1.17.2

package/cypress/{integration/Entity.spec.js → e2e/Entity.cy.js}

@@ -1,6 +1,6 @@
 import Joi from 'Joi';
 import * as yup from 'yup';
-import Entity from '../../src/Entity.js';
+import Entity from '../../src/Entity/Entity.js';
 import Schema from '../../src/Schema/index.js';
 import PropertyTypes from '../../src/Property/index.js';
 

package/cypress/{integration/Property/Property.spec.js → e2e/Property/Property.cy.js}

@@ -1,5 +1,5 @@
 import PropertyTypes from '../../../src/Property/index.js';
-import Entity from '../../../src/Entity.js';
+import Entity from '../../../src/Entity/Entity.js';
 import Schema from '../../../src/Schema/index.js';
 
 describe('Property', function() {

package/cypress/plugins/index.js

@@ -1,32 +1,2 @@
-const webpack = require('@cypress/webpack-preprocessor'),
-	webpackOptions = {
-		mode: 'development',
-		devtool: 'cheap-module-source-map', // See https://survivejs.com/webpack/building/source-maps/
-		module: {
-			rules: [
-				{
-					test: /\.(js|jsx|mjs)$/,
-					exclude: /node_modules\/(?!(@onehat)\/).*/,
-					loader: 'babel-loader',
-					options: {
-						cacheDirectory: false,
-						presets: [
-							'@babel/preset-env'
-						],
-						plugins: [
-							'@babel/plugin-proposal-class-properties',
-							'@babel/plugin-transform-runtime'
-						],
-						sourceType: 'unambiguous',
-					},
-				}
-			]
-		}
-	};
-
-module.exports = (on, config) => {
-	on('file:preprocessor', webpack({
-		webpackOptions,
-		watchOptions: {}, 
-	}));
-};
+module.exports = (on) => {
+}

package/cypress.config.js

@@ -0,0 +1,42 @@
+import { defineConfig } from "cypress";
+import webpackPreprocessor from "@cypress/webpack-preprocessor";
+import Webpack from "webpack";
+
+export default defineConfig({
+	e2e: {
+		experimentalRunAllSpecs: true,
+		chromeWebSecurity: false,
+		setupNodeEvents(on) {
+			const options = webpackPreprocessor.defaultOptions;
+			if (!options.module) {
+				options.module = {
+					rules: [],
+				}
+			}
+			if (!options.module.rules) {
+				options.module.rules = [];
+			}
+			options.module.rules.push({
+				test: /\.(js|jsx|mjs)$/,
+				exclude: [/node_modules\/(?!(@onehat)\/).*/],
+				use: [{
+					loader: 'babel-loader',
+					options: {
+						cacheDirectory: false,
+						presets: [
+							'@babel/preset-env'
+						],
+						plugins: [
+							'@babel/plugin-transform-class-properties',
+							'@babel/plugin-transform-runtime'
+						],
+						sourceType: 'unambiguous',
+					},
+				}],
+
+			});
+
+			on('file:preprocessor', webpackPreprocessor(options));
+		},
+	}
+});

package/package.json

@@ -1,11 +1,12 @@
 {
 	"name": "@onehat/data",
-	"version": "1.16.10",
+	"version": "1.17.2",
 	"description": "JS data modeling package with adapters for many storage mediums.",
 	"main": "src/index.js",
 	"type": "module",
 	"scripts": {
-		"test": "npx cypress open --config-file ../cypress.json",
+		"test": "npx cypress open",
+		"test2": "DEBUG=cypress:* npx cypress open",
 		"docs": "jsdoc -c ./jsdoc.json -t ./node_modules/ink-docstrap/template -R README.md"
 	},
 	"repository": {
@@ -35,37 +36,36 @@
 	},
 	"homepage": "https://github.com/OneHatRepo/data#readme",
 	"dependencies": {
-		"@onehat/events": "^1.6.5",
+		"@onehat/events": "^1.6.6",
 		"accounting-js": "^1.1.1",
-		"axios": "^1.2.1",
-		"chrono-node": "^2.4.2",
-		"fast-xml-parser": "^4.0.12",
+		"axios": "^1.4.0",
+		"chrono-node": "^2.6.3",
+		"fast-xml-parser": "^4.2.2",
 		"he": "^1.2.0",
-		"js-base64": "^3.7.3",
+		"js-base64": "^3.7.5",
 		"lodash": "^4.17.21",
 		"moment": "^2.29.4",
 		"natsort": "^2.0.3",
 		"numeral": "^2.0.6",
-		"qs": "^6.11.0",
+		"qs": "^6.11.2",
 		"relative-time-parser": "^1.0.15",
 		"uuid": "^9.0.0"
 	},
 	"devDependencies": {
-		"@babel/core": "^7.20.5",
-		"@babel/node": "^7.20.5",
-		"@babel/plugin-proposal-class-properties": "^7.18.6",
+		"@babel/core": "^7.22.1",
+		"@babel/node": "^7.22.1",
+		"@babel/plugin-transform-class-properties": "^7.22.3",
 		"@babel/plugin-transform-runtime": "^7.19.6",
-		"@babel/preset-env": "^7.20.2",
-		"@babel/register": "^7.18.9",
-		"@babel/runtime": "^7.20.6",
-		"@cypress/webpack-preprocessor": "^5.16.0",
-		"babel-loader": "^8.0.2",
-		"cypress": "5.2.0",
+		"@babel/preset-env": "^7.22.4",
+		"@babel/register": "^7.21.0",
+		"@babel/runtime": "^7.22.3",
+		"@cypress/webpack-preprocessor": "^5.17.1",
+		"babel-loader": "^9.1.2",
+		"cypress": "12.13.0",
 		"ink-docstrap": "^1.3.2",
-		"jsdoc": "^4.0.0",
-		"webpack": "^5.76.0",
-		"joi": "^17.7.0",
-		"yup": "^0.32.11"
-
+		"joi": "^17.9.2",
+		"jsdoc": "^4.0.2",
+		"webpack": "^5.85.0",
+		"yup": "^1.2.0"
 	}
 }

package/src/{Entity.js → Entity/Entity.js}

@@ -1,7 +1,7 @@
 /** @module Entity */
 
 import EventEmitter from '@onehat/events';
-import PropertyTypes from './Property/index.js';
+import PropertyTypes from '../Property/index.js';
 import moment from 'moment';
 import _ from 'lodash';
 
@@ -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) {
+	constructor(schema, rawData = {}, repository = null, originalIsMapped = false, isDelayedSave = false, isRemotePhantomMode = false, isRoot = false) {
 		super(...arguments);
 
 		if (!schema) {
@@ -103,6 +103,45 @@ class Entity extends EventEmitter {
 		 */
 		this.properties = [];
 
+		/**
+		 * @member {boolean} isTree - Whether this Entity is a TreeNode
+		 */
+		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 {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
+		 */
+		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
 		 * @public
@@ -217,7 +256,7 @@ class Entity extends EventEmitter {
 		return this._proxy; // Return the Proxy, not 'this'
 	}
 
-	initialize = () => {
+	initialize() {
 		this.properties = this._createProperties();
 		this._createMethods();
 		this._createStatics();
@@ -311,7 +350,8 @@ class Entity extends EventEmitter {
 				definition = _.clone(definition); // Clone it so you don't alter original in schema
 				definition.mapping = definition.name;
 			}
-			const Property = PropertyTypes[type],
+			const
+				Property = PropertyTypes[type],
 				property = new Property(definition, this._proxy);
 			property.on('change', this._onPropertyChange);
 			
@@ -344,7 +384,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.');
 		}
@@ -352,6 +392,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
+		}
 	}
 
 	/**
@@ -748,7 +792,8 @@ class Entity extends EventEmitter {
 			obj[property.name] = property.rawValue;
 			return obj;
 		}
-		const mapStack = property.mapping.split('.'),
+		const
+			mapStack = property.mapping.split('.'),
 			rawValue = property.getRawValue();
 
 		// Build up the hierarchy
@@ -806,7 +851,8 @@ class Entity extends EventEmitter {
 	 * @return {array|boolean} diff - Array of property names that have changed, or false
 	 */
 	getChanged = () => {
-		const original = this._originalDataParsed,
+		const
+			original = this._originalDataParsed,
 			current = this.getParsedRawValues(),
 			diff = Object.keys(original).reduce((result, key) => { // from https://stackoverflow.com/a/40610459/9163076
 				if (current && !current.hasOwnProperty(key)) {
@@ -826,7 +872,8 @@ class Entity extends EventEmitter {
 	 * @return {object} changedPropertyValues - Object representing each changed field and both its original and current value
 	 */
 	getChangedValues = () => {
-		const original = this._originalDataParsed,
+		const
+			original = this._originalDataParsed,
 			current = this.getRawValues(),
 			names = this.getChanged();
 		const changedPropertyValues = {};
@@ -870,9 +917,7 @@ class Entity extends EventEmitter {
 		if (this.isDestroyed) {
 			throw Error('this.getIdProperty is no longer valid. Entity has been destroyed.');
 		}
-		const schema = this.getSchema(),
-			model = schema.model,
-			idProperty = model && model.idProperty ? model.idProperty : null;
+		const idProperty = this.getSchema().model?.idProperty || null;
 		if (!idProperty) {
 			throw new Error('No idProperty found for ' + schema.name);
 		}
@@ -926,7 +971,8 @@ class Entity extends EventEmitter {
 		if (this.isDestroyed) {
 			throw Error('this.getDisplayProperty is no longer valid. Entity has been destroyed.');
 		}
-		const schema = this.getSchema(),
+		const
+			schema = this.getSchema(),
 			model = schema.model,
 			displayProperty = model && model.displayProperty ? model.displayProperty : null;
 		if (!displayProperty) {
@@ -1424,6 +1470,292 @@ 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.geParentIdProperty().getSubmitValue();
+	}
+
+	/**
+	 * Getter of parentId for this TreeNode.
+	 * @return {any} parentId - The parentId
+	 */
+	get parentId() {
+		return this.getParentId();
+	}
+
+	/**
+	 * Getter of hasParent
+	 * Returns true if this is not a root node
+	 * @return {boolean} hasParent
+	 */
+	get hasParent() {
+		this.ensureTree();
+
+		return !this.isRoot;
+	}
+
+	/**
+	 * 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;
+	}
+
+	/**
+	 * 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;
+		_.each(siblings, (treeNode) => {
+			if (treeNode === this) {
+				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 === this) {
+				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.');
+		}
+
+		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.');
+		}
+
+		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.');
+		}
+
+		return this.children.slice(-1)[0]
+	}
+
+	/**
+	 * Helper to make sure this Repository is a tree
+	 * @private
+	 */
+	ensureTree = async () => {
+		if (!this.isTree) {
+			this.throwError('This Repository is not a tree!');
+		}
+	}
+
+
 	/**
 	 * Destroy this object.
 	 * - Removes all circular references to parent objects

package/src/OneHatData.js

@@ -2,7 +2,7 @@
 
 import EventEmitter from '@onehat/events';
 import CoreRepositoryTypes from './Repository/index.js';
-import Entity from './Entity.js';
+import Entity from './Entity/Entity.js';
 import {
 	MODE_LOCAL_MIRROR,
 	MODE_COMMAND_QUEUE,

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

@@ -1,7 +1,7 @@
 /** @module Repository */
 
 import Repository from './Repository.js';
-import Entity from '../Entity.js';
+import Entity from '../Entity/Entity.js';
 import natsort from 'natsort';
 import _ from 'lodash';
 

package/src/Repository/Null.js

@@ -1,7 +1,7 @@
 /** @module Repository */
 
 import Repository from './Repository.js';
-import Entity from '../Entity.js';
+import Entity from '../Entity/Entity.js';
 import _ from 'lodash';
 
 /**

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
+
+
+		
+	}
+
 }
 
 

package/src/Repository/Repository.js

@@ -1,7 +1,7 @@
 /** @module Repository */
 
 import EventEmitter from '@onehat/events';
-import Entity from '../Entity.js'
+import Entity from '../Entity/Entity.js'
 import PropertyTypes from '../Property/index.js';
 import {
 	v4 as uuid,
@@ -108,7 +108,7 @@ export default class Repository extends EventEmitter {
 			 */
 			pageSize: 10,
 
-			sorters: (schema && schema.model && schema.model.sorters) ? schema.model.sorters : [],
+			sorters: schema.model.sorters || [],
 
 			/**
 			 * @member {string} batchOrder - Comma-separated ordering of add, edit, and delete batch operations
@@ -189,22 +189,28 @@ export default class Repository extends EventEmitter {
 		this.total = 0;
 
 		/**
-		 * @member {Boolean} isFiltered - State: whether or not any filters are currently applied to entities
+		 * @member {boolean} isFiltered - State: whether or not any filters are currently applied to entities
 		 */
 		this.isFiltered = false;
 		
 		/**
-		 * @member {Boolean} isInitialized - State: whether or not this repository has been completely initialized
+		 * @member {boolean} isInitialized - State: whether or not this repository has been completely initialized
 		 */
 		this.isInitialized = false;
 
 		/**
-		 * @member {Boolean} isLoaded - State: whether or not entities have been loaded at least once
+		 * @member {boolean} isTree - Whether this Repository contains TreeNodes
+		 * @readonly
+		 */
+		this.isTree = schema.model.isTree || false;
+
+		/**
+		 * @member {boolean} isLoaded - State: whether or not entities have been loaded at least once
 		 */
 		this.isLoaded = false;
 
 		/**
-		 * @member {Boolean} isLoading - State: whether or not entities are currently being loaded
+		 * @member {boolean} isLoading - State: whether or not entities are currently being loaded
 		 */
 		this.isLoading = false;
 
@@ -214,12 +220,12 @@ export default class Repository extends EventEmitter {
 		this.lastLoaded = null;
 
 		/**
-		 * @member {Boolean} isSaving - State: whether or not entities are currently being saved
+		 * @member {boolean} isSaving - State: whether or not entities are currently being saved
 		 */
 		this.isSaving = false;
 
 		/**
-		 * @member {Boolean} isSorted - State: whether or not any sorting is currently applied to entities
+		 * @member {boolean} isSorted - State: whether or not any sorting is currently applied to entities
 		 */
 		this.isSorted = false;
 
@@ -412,7 +418,7 @@ export default class Repository extends EventEmitter {
 	// /____/\____/_/   \__/
 
 	/**
-	 * @member {Boolean} hasSorters - Whether or not any sorters are applied
+	 * @member {boolean} hasSorters - Whether or not any sorters are applied
 	 */
 	get hasSorters() {
 		if (this.isDestroyed) {
@@ -501,22 +507,20 @@ export default class Repository extends EventEmitter {
 			return;
 		}
 		let sorters = [];
-		if (this.schema?.model) {
-			if (_.size(this.schema.model.sorters) > 0) {
-				sorters = this.schema.model.sorters
-			} else if (!_.isNil(this.schema.model.sortProperty)) {
-				sorters = [{
-					name: this.schema.model.sortProperty,
-					direction: 'ASC',
-					fn: 'default',
-				}];
-			} else if (!_.isNil(this.schema.model.displayProperty)) {
-				sorters = [{
-					name: this.schema.model.displayProperty,
-					direction: 'ASC',
-					fn: 'default',
-				}];
-			}
+		if (_.size(this.schema.model.sorters) > 0) {
+			sorters = this.schema.model.sorters
+		} else if (!_.isNil(this.schema.model.sortProperty)) {
+			sorters = [{
+				name: this.schema.model.sortProperty,
+				direction: 'ASC',
+				fn: 'default',
+			}];
+		} else if (!_.isNil(this.schema.model.displayProperty)) {
+			sorters = [{
+				name: this.schema.model.displayProperty,
+				direction: 'ASC',
+				fn: 'default',
+			}];
 		}
 		return sorters;
 	}
@@ -576,7 +580,7 @@ export default class Repository extends EventEmitter {
 	// /_/   /_/_/\__/\___/_/
 
 	/**
-	 * @member {Boolean} hasFilters - Whether or not any filters are applied
+	 * @member {boolean} hasFilters - Whether or not any filters are applied
 	 */
 	get hasFilters() {
 		if (this.isDestroyed) {
@@ -1459,10 +1463,10 @@ export default class Repository extends EventEmitter {
 		}
 
 		const schema = this.getSchema();
-		if (!schema.model.associations.hasOne.includes(repositoryName) &&
-			!schema.model.associations.hasMany.includes(repositoryName) &&
-			!schema.model.associations.belongsTo.includes(repositoryName) &&
-			!schema.model.associations.belongsToMany.includes(repositoryName)
+		if (!schema.model.associations?.hasOne.includes(repositoryName) &&
+			!schema.model.associations?.hasMany.includes(repositoryName) &&
+			!schema.model.associations?.belongsTo.includes(repositoryName) &&
+			!schema.model.associations?.belongsToMany.includes(repositoryName)
 			) {
 			this.throwError(repositoryName + ' is not associated with this schema');
 			return;
@@ -1821,7 +1825,7 @@ export default class Repository extends EventEmitter {
 	 * Mainly used for phantom Entities
 	 * Helper for delete()
 	 */
-	removeEntity(entity) { // standard function notation so it can be called by child class
+	removeEntity(entity) { // standard function notation so it can be called by child class via super.removeEntity
 		this.entities = _.filter(this.entities, e => e !== entity);
 		entity.destroy();
 	}
@@ -1931,6 +1935,90 @@ export default class Repository extends EventEmitter {
 	}
 
 
+	//   ______
+	//  /_  __/_______  ___  _____
+	//   / / / ___/ _ \/ _ \/ ___/
+	//  / / / /  /  __/  __(__  )
+	// /_/ /_/   \___/\___/____/
+	
+
+	/**
+	 * Gets the root TreeNodes
+	 */
+	getRootNodes = () => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			this.throwError('this.getRootNodes is no longer valid. Repository has been destroyed.');
+			return;
+		}
+
+		// Look through all entities and pull out the root nodes.
+		// Subclasses of Repository will override this method to get root nodes from server
+		const entities = _.filter(this.getEntities(), (entity) => {
+			return entity.isRoot;
+		})
+		return entities;
+	}
+
+	/**
+	 * Populates the TreeNodes with .parent and .children references
+	 */
+	assembleTreeNodes = () => {
+		this.ensureTree();
+		if (this.isDestroyed) {
+			this.throwError('this.assembleTreeNodes is no longer valid. Repository has been destroyed.');
+			return;
+		}
+
+		const treeNodes = this.getEntities();
+
+		// Reset all parent/child relationships
+		_.each(treeNodes, (treeNode) => {
+			treeNode.parent = null;
+			treeNode.children = [];
+		});
+
+		// Rebuild all parent/child relationships
+		_.each(treeNodes, (treeNode) => {
+			const parent = this.getById(treeNode.parentId);
+			if (parent) {
+				treeNode.parent = parent;
+				parent.children.push(treeNode);
+			}
+		});
+	}
+
+	/**
+	 * Removes the treeNode and all of its children from repository
+	 * without deleting anything on the server
+	 */
+	removeTreeNode = (treeNode) => {
+		if (!_.isEmpty(treeNode.children)) {
+			const children = treeNode.children;
+			treeNode.parent = null;
+			treeNode.children = [];
+
+			_.each(children, (child) => {
+				this.removeTreeNode(child);
+			});
+		}
+
+		this.removeEntity(treeNode);
+	}
+
+	/**
+	 * Helper to make sure this Repository is a tree
+	 * @private
+	 */
+	ensureTree = async () => {
+		if (!this.isTree) {
+			this.throwError('This Repository is not a tree!');
+		}
+	}
+
+
+
+
 
 
 	//    ____        __  _

package/src/Schema/Schema.js

@@ -64,6 +64,39 @@ export default class Schema extends EventEmitter {
 				 */
 				sortProperty: null,
 
+				/**
+				 * @member {string} parentIdProperty - name of parent_id Property (e.g. 'categories__parent_id' for Adjacency Lists, and parent_id for Closure Tables)
+				 * For trees only
+				 */
+				parentIdProperty: null,
+
+				/**
+				 * @member {string} depthIdProperty - name of depth Property (e.g. 'categories__depth' for Adjacency Lists, and depth for Closure Tables)
+				 * For trees only
+				 */
+				depthProperty: null,
+
+				/**
+				 * @member {string} hasChildrenProperty - name of hasChildren Property (e.g. 'categories__has_children' for Adjacency Lists, and has_children for Closure Tables)
+				 * For trees only
+				 */
+				hasChildrenProperty: null,
+
+				/**
+				 * @member {boolean} isTree - Whether this model has hierarchical tree data
+				 */
+				isTree: false,
+
+				/**
+				 * @member {boolean} isAdjacencyList - Whether this tree is an Adjacency List
+				 */
+				isAdjacencyList: false,
+
+				/**
+				 * @member {boolean} isClosureTable - Whether this tree is a Closure Table
+				 */
+				isClosureTable: false,
+
 				/**
 				 * @member {array} properties - Array of Property definition objects
 				 */

package/cypress/cypress.json

@@ -1,177 +0,0 @@
-{
-	"title": "JSON schema for https://cypress.io test runner cypress.json file. Details at https://on.cypress.io/configuration",
-	"$schema": "http://json-schema.org/draft-04/schema#",
-	"type": "object",
-	"properties": {
-	  "baseUrl" : {
-		"type": "string",
-		"description": "Url used as prefix for cy.visit() or cy.request() command’s url. Example http://localhost:3030 or https://test.my-domain.com"
-	  },
-	  "env": {
-		"type": "object",
-		"description": "Any values to be set as environment variables",
-		"body": {}
-	  },
-	  "ignoreTestFiles": {
-		"type": ["string", "array"],
-		"items": {
-		  "type": "string"
-		},
-		"description": "A String or Array of glob patterns used to ignore test files that would otherwise be shown in your list of tests. Cypress uses minimatch with the options: {dot: true, matchBase: true}. We suggest using http://globtester.com to test what files would match."
-	  },
-	  "numTestsKeptInMemory": {
-		"type": "number",
-		"default": 50,
-		"description": "The number of tests for which snapshots and command data are kept in memory. Reduce this number if you are experiencing high memory consumption in your browser during a test run."
-	  },
-	  "port": {
-		"type": "number",
-		"default": null,
-		"description": "Port used to host Cypress. Normally this is a randomly generated port"
-	  },
-	  "reporter": {
-		"type": "string",
-		"default": "spec",
-		"description": "The reporter used when running headlessly or in CI. See https://on.cypress.io/reporters"
-	  },
-	  "reporterOptions": {
-		"type": "object",
-		"default": null,
-		"description": "The reporter options used. Supported options depend on the reporter. See https://on.cypress.io/reporters#Reporter-Options"
-	  },
-	  "watchForFileChanges": {
-		"type": "boolean",
-		"default": true,
-		"description": "Whether Cypress will watch and restart tests on test file changes"
-	  },
-	  "defaultCommandTimeout": {
-		"type": "number",
-		"default": 4000,
-		"description": "Time, in milliseconds, to wait until most DOM based commands are considered timed out"
-	  },
-	  "execTimeout": {
-		"type": "number",
-		"default": 60000,
-		"description": "Time, in milliseconds, to wait for a system command to finish executing during a cy.exec() command"
-	  },
-	  "pageLoadTimeout": {
-		"type": "number",
-		"default": 60000,
-		"description": "Time, in milliseconds, to wait for page transition events or cy.visit(), cy.go(), cy.reload() commands to fire their page load events"
-	  },
-	  "requestTimeout": {
-		"type": "number",
-		"default": 5000,
-		"description": "Time, in milliseconds, to wait for an XHR request to go out in a cy.wait() command"
-	  },
-	  "responseTimeout": {
-		"type": "number",
-		"default": 30000,
-		"description": "Time, in milliseconds, to wait until a response in a cy.request(), cy.wait(), cy.fixture(), cy.getCookie(), cy.getCookies(), cy.setCookie(), cy.clearCookie(), cy.clearCookies(), and cy.screenshot() commands"
-	  },
-	  "fileServerFolder":	{
-		"type": "string",
-		"default": "root project folder",
-		"description": "Path to folder where application files will attempt to be served from"
-	  },
-	  "fixturesFolder": {
-		"type": ["string", "boolean"],
-		"default": "cypress/fixtures",
-		"description": "Path to folder containing fixture files (Pass false to disable)"
-	  },
-	  "integrationFolder": {
-		"type": "string",
-		"default": "cypress/integration",
-		"description": "Path to folder containing integration test files"
-	  },
-	  "pluginsFile": {
-		"type": ["string", "boolean"],
-		"default": "cypress/plugins/index.js",
-		"description": "Path to plugins file. (Pass false to disable)"
-	  },
-	  "screenshotsFolder": {
-		"type": "string",
-		"default": "cypress/screenshots",
-		"description": "Path to folder where screenshots will be saved from cy.screenshot() command or after a headless or CI run’s test failure"
-	  },
-	  "supportFile": {
-		"type": ["string", "boolean"],
-		"default": "cypress/support/index.js",
-		"description": "Path to file to load before test files load. This file is compiled and bundled. (Pass false to disable)"
-	  },
-	  "videosFolder":	{
-		"type": "string",
-		"default": "cypress/videos",
-		"description": "Path to folder where videos will be saved after a headless or CI run"
-	  },
-	  "trashAssetsBeforeRuns": {
-		"type": "boolean",
-		"default": true,
-		"description": "Whether Cypress will trash assets within the screenshotsFolder and videosFolder before headless test runs."
-	  },
-	  "videoCompression":	{
-		"type": ["number", "boolean"],
-		"default": 32,
-		"description": "The quality setting for the video compression, in Constant Rate Factor (CRF). The value can be false to disable compression or a value between 0 and 51, where a lower value results in better quality (at the expense of a higher file size)."
-	  },
-	  "video": {
-		"type": "boolean",
-		"default": true,
-		"description": "Whether Cypress will record a video of the test run when running headlessly."
-	  },
-	  "videoUploadOnPasses": {
-		"type": "boolean",
-		"default": true,
-		"description": "Whether Cypress will upload the video to the Dashboard even if all tests are passing. This applies only when recording your runs to the Dashboard. Turn this off if you’d like the video uploaded only when there are failing tests."
-	  },
-	  "chromeWebSecurity": {
-		"type": "boolean",
-		"default": true,
-		"description": "Whether Chrome Web Security for same-origin policy and insecure mixed content is enabled. Read more about this at https://on.cypress.io/web-security"
-	  },
-	  "userAgent": {
-		"type": "string",
-		"default": null,
-		"description": "Enables you to override the default user agent the browser sends in all request headers. User agent values are typically used by servers to help identify the operating system, browser, and browser version. See User-Agent MDN Documentation for example user agent values here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent"
-	  },
-	  "blacklistHosts": {
-		"type": ["string", "array"],
-		"items": {
-		  "type": "string"
-		},
-		"default": null,
-		"description": "A String or Array of hosts that you wish to block traffic for. Please read the notes for examples on using this https://on.cypress.io/configuration#blacklistHosts"
-	  },
-	  "modifyObstructiveCode": {
-		"type": "boolean",
-		"default": true,
-		"description": "Whether Cypress will search for and replace obstructive JS code found in .js or .html files that prevents Cypress from working. Please read the notes for more information on this setting. https://on.cypress.io/configuration#modifyObstructiveCode"
-	  },
-	  "viewportHeight":	{
-		"type": "number",
-		"default": 660,
-		"description": "Default height in pixels for the application under tests’ viewport (Override with cy.viewport() command)"
-	  },
-	  "viewportWidth": {
-		"type": "number",
-		"default": 1000,
-		"description": "Default width in pixels for the application under tests’ viewport. (Override with cy.viewport() command)"
-	  },
-	  "animationDistanceThreshold":	{
-		"type": "number",
-		"default": 5,
-		"description": "The distance in pixels an element must exceed over time to be considered animating"
-	  },
-	  "waitForAnimations": {
-		"type": "boolean",
-		"default": true,
-		"description": "Whether to wait for elements to finish animating before executing commands"
-	  },
-	  "projectId": {
-		"type": "string",
-		"default": null,
-		"description": "A 6 character string to identify this project with Dashboard service. See https://on.cypress.io/dashboard-service#Identification"
-	  }
-	}
-  }
-  

package/cypress.json

@@ -1 +0,0 @@
-{}