@onehat/data 1.16.10 → 1.17.0

package/cypress/integration/Entity.spec.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

@@ -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/package.json

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

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';
 
@@ -103,6 +103,11 @@ class Entity extends EventEmitter {
 		 */
 		this.properties = [];
 
+		/**
+		 * @member {boolean} isTreeNode - Whether this Entity is a TreeNode
+		 */
+		this.isTreeNode = false;
+
 		/**
 		 * @member {boolean} isPersisted - Whether this object has been persisted in a storage medium
 		 * @public
@@ -217,7 +222,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 +316,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);
 			
@@ -748,7 +754,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 +813,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 +834,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 +879,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 +933,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) {

package/src/Entity/TreeNode.js

@@ -0,0 +1,190 @@
+/** @module Entity */
+
+import Entity from './Entity.js';
+import _ from 'lodash';
+
+/**
+ * Class represents a TreeNode which adds Tree methods to Entity
+ * TreeNode is hierarchical, so other TreeNodes can appear in this.children
+ * 
+ * @extends Entity
+ */
+class TreeNode extends Entity {
+	constructor(schema, rawData = {}, repository = null, originalIsMapped = false, isDelayedSave = false, isRemotePhantomMode = false, isRoot = false) {
+		super(...arguments);
+
+		if (!schema.model.parentIdProperty) {
+			throw new Error('parentIdProperty cannot be empty');
+		}
+
+		/**
+		 * @member {boolean} isTreeNode - Whether this Entity is a TreeNode
+		 */
+		this.isTreeNode = true;
+
+		/**
+		 * @member {boolean} isRoot - Whether this TreeNode is the root TreeNode
+		 */
+		this.isRoot = isRoot;
+
+		/**
+		 * @member {TreeNode} parent - The parent TreeNode for this TreeNode
+		 */
+		this.parent = null;
+
+		/**
+		 * @member {array} children - Contains any children of this TreeNode
+		 */
+		this.children = [];
+		
+		/**
+		 * @member {boolean} isChildrenLoaded - Whether child TreeNodes have loaded for this TreeNode
+		 */
+		this.isChildrenLoaded = false;
+
+
+		// UI State
+		this.isVisible = false;
+
+		this.isExpanded = false;
+	}
+
+	/**
+	 * 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 = () => {
+		if (this.isDestroyed) {
+			throw Error('this.getParentIdProperty is no longer valid. TreeNode has been destroyed.');
+		}
+		const parentIdProperty = this.getSchema().model.parentIdProperty;
+		if (!parentIdProperty) {
+			throw new Error('No parentIdProperty found for ' + schema.name);
+		}
+		return this.getProperty(parentIdProperty);
+	}
+
+	/**
+	 * Gets the parentId for this TreeNode.
+	 * @return {any} parentId - The parentId
+	 */
+	getParentId = () => {
+		if (this.isDestroyed) {
+			throw Error('this.getParentId is no longer valid. TreeNode has been destroyed.');
+		}
+		return this.geParentIdProperty().getSubmitValue();
+	}
+
+	/**
+	 * Getter of the parentId for this TreeNode.
+	 * @return {any} parentId - The parentId
+	 */
+	get parentId() {
+		return this.getParentId();
+	}
+
+	/**
+	 * Getter of hasParent
+	 * Returns true if this.parent is truthy
+	 * @return {boolean} hasParent
+	 */
+	get hasParent() {
+		return !!this.parent;
+	}
+
+	getParent = () => {
+		if (this.isDestroyed) {
+			throw Error('this.getParent is no longer valid. TreeNode has been destroyed.');
+		}
+		return this.parent;
+	}
+
+	/**
+	 * Getter of hasChildren
+	 * @return {boolean} hasParent
+	 */
+	get hasChildren() {
+		return !_.isEmpty(this.children);
+	}
+
+	getChildren = async () => {
+		if (this.isDestroyed) {
+			throw Error('this.getChildren is no longer valid. TreeNode has been destroyed.');
+		}
+		if (!this.isChildrenLoaded) {
+			await this.loadChildren();
+		}
+		return this.children;
+	}
+
+	loadChidren = async () => {
+		if (this.isDestroyed) {
+			throw Error('this.loadChidren is no longer valid. TreeNode has been destroyed.');
+		}
+		this.children = await this.repository.loadChildTreeNodes(this); // populates the children with a reference to this in child.parent
+		this.isChildrenLoaded = true;
+	}
+
+	getPrevousSibling = async () => {
+		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;
+	}
+
+	getNextSibling = async () => {
+		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;
+	}
+
+	getChildAt = (ix) => {
+		if (this.isDestroyed) {
+			throw Error('this.getChildAt is no longer valid. TreeNode has been destroyed.');
+		}
+		return this.children[ix];
+	}
+
+	getFirstChild = () => {
+		if (this.isDestroyed) {
+			throw Error('this.getFirstChild is no longer valid. TreeNode has been destroyed.');
+		}
+		return this.children[0];
+	}
+
+	getLastChild = () => {
+		if (this.isDestroyed) {
+			throw Error('this.getLastChild is no longer valid. TreeNode has been destroyed.');
+		}
+		return this.children.slice(-1)[0]
+	}
+
+}
+
+export default TreeNode;

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/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/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,