@onehat/data 1.17.0 → 1.17.2

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.17.0",
+	"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/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) {
+	constructor(schema, rawData = {}, repository = null, originalIsMapped = false, isDelayedSave = false, isRemotePhantomMode = false, isRoot = false) {
 		super(...arguments);
 
 		if (!schema) {
@@ -104,9 +104,43 @@ 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 {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
@@ -350,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.');
 		}
@@ -358,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
+		}
 	}
 
 	/**
@@ -1432,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/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/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
+
+
+		
+	}
+
 }