@onehat/data 1.17.0 → 1.17.3

package/src/Repository/Repository.js

@@ -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) {
@@ -991,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) {
@@ -1052,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);
 		};
 		
@@ -1459,10 +1465,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 +1827,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 +1937,92 @@ 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!');
+			return false;
+		}
+		return true;
+	}
+
+
+
+
 
 
 	//    ____        __  _

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 @@
-{}

package/src/Entity/TreeNode.js

@@ -1,190 +0,0 @@
-/** @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;