@onehat/data 1.11.6 → 1.13.0

package/package.json

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

package/src/Entity.js

@@ -34,7 +34,7 @@ class Entity extends EventEmitter {
 	 * @param {Repository} repository
 	 * @param {boolean} - Has rawData already been mapped according to schema?
 	 */
-	constructor(schema, rawData = {}, repository = null, originalIsMapped = false) {
+	constructor(schema, rawData = {}, repository = null, originalIsMapped = false, isDelayedSave = false) {
 		super(...arguments);
 
 		if (!schema) {
@@ -110,6 +110,7 @@ class Entity extends EventEmitter {
 		
 		/**
 		 * @member {Boolean} isInitialized - State: whether or not this entity has been completely initialized
+		 * @public
 		 */
 		this.isInitialized = false;
 
@@ -127,28 +128,37 @@ class Entity extends EventEmitter {
 
 		/**
 		 * @member {boolean} isDestroyed - Whether this object has been destroyed
-		 * @private
+		 * @public
 		 */
 		this.isDestroyed = false;
 
 		/**
-		 * @member {string} lastModified - Last time this entity was modified
+		 * @member {boolean} isFrozen - Prevent the entity from being saved, so an editor can change it before it gets saved to remote storage.
+		 * @public
+		 */
+		this.isDelayedSave = isDelayedSave;
+
+		/**
+		 * @member {boolean} lastModified - Last time this entity was modified
+		 * @public
 		 */
 		this.lastModified = null;
 
 		/**
-		 * @member {string} isFrozen - Prevent the entity from being destroyed, but don't let it be changed either.
+		 * @member {boolean} isFrozen - Prevent the entity from being destroyed, but don't let it be changed either.
+		 * @public
 		 */
 		this.isFrozen = false;
 
 		/**
 		 * @member {boolean} isValid - Whether this Entity passes validation
-		 * @private
+		 * @public
 		 */
 		this.isValid = null;
 
 		/**
 		 * @member {object} validationError - Any error in last validation.
+		 * @public
 		 */
 		this.validationError = null;
 		

package/src/Repository/Repository.js

@@ -479,9 +479,15 @@ export default class Repository extends EventEmitter {
 			throw Error('this.getDefaultSorters is no longer valid. Repository has been destroyed.');
 		}
 		let sorters = [];
-		if (this.schema && this.schema.model) {
+		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,
@@ -923,10 +929,11 @@ export default class Repository extends EventEmitter {
 	 * @param {object} data - Either raw data object or Entity. If raw data, keys are Property names, Values are Property values.
 	 * @param {boolean} isPersisted - Whether the new entity should be marked as already being persisted in storage medium.
 	 * @param {boolean} originalIsMapped - Has data already been mapped according to schema?
+	 * @param {boolean} isDelayedSave - Should the repository skip autosave when immediately adding the record?
 	 * @return {object} entity - new Entity object
 	 * @fires add
 	 */
-	add = async (data, isPersisted = false, originalIsMapped = false) => {
+	add = async (data, isPersisted = false, originalIsMapped = false, isDelayedSave = false) => {
 		if (this.isDestroyed) {
 			throw Error('this.add is no longer valid. Repository has been destroyed.');
 		}
@@ -947,7 +954,7 @@ export default class Repository extends EventEmitter {
 		let entity = data;
 		if (!(data instanceof Entity)) {
 			// Create the new entity
-			entity = Repository._createEntity(this.schema, data, this, isPersisted, originalIsMapped);
+			entity = Repository._createEntity(this.schema, data, this, isPersisted, originalIsMapped, isDelayedSave);
 		}
 		this._relayEntityEvents(entity);
 		this.entities.push(entity);
@@ -959,7 +966,7 @@ export default class Repository extends EventEmitter {
 
 		this.emit('add', entity);
 
-		if (this.isAutoSave && !entity.isPersisted) {
+		if (this.isAutoSave && !entity.isPersisted && !entity.isDelayedSave) {
 			await this.save(entity);
 		}
 
@@ -973,12 +980,12 @@ export default class Repository extends EventEmitter {
 	 * @param {boolean} originalIsMapped - Has data already been mapped according to schema?
 	 * @return {object} entity - new Entity object
 	 */
-	createStandaloneEntity = async (data, isPersisted = false, originalIsMapped = false) => {
+	createStandaloneEntity = async (data, isPersisted = false, originalIsMapped = false, isDelayedSave = false) => {
 		if (this.isDestroyed) {
 			throw Error('this.createStandaloneEntity is no longer valid. Repository has been destroyed.');
 		}
 		
-		const entity = Repository._createEntity(this.schema, data, this, isPersisted, originalIsMapped);
+		const entity = Repository._createEntity(this.schema, data, this, isPersisted, originalIsMapped, isDelayedSave);
 
 		if (entity.isPhantom) {
 			entity.createTempId();
@@ -1024,8 +1031,8 @@ export default class Repository extends EventEmitter {
 	 * @return {object} entity - new Entity object
 	 * @private
 	 */
-	static _createEntity = (schema, rawData, repository = null, isPersisted = false, originalIsMapped = false) => {
-		const entity = new Entity(schema, rawData, repository, originalIsMapped);
+	static _createEntity = (schema, rawData, repository = null, isPersisted = false, originalIsMapped = false, isDelayedSave = false) => {
+		const entity = new Entity(schema, rawData, repository, originalIsMapped, isDelayedSave);
 		entity.initialize();
 		entity.isPersisted = isPersisted;
 		return entity;

package/src/Schema/Schema.js

@@ -58,6 +58,12 @@ export default class Schema extends EventEmitter {
 				 */
 				displayProperty: null,
 
+				/**
+				 * @member {string} sortProperty - name of sort Property (e.g. 'users__sort_order')
+				 * if sortProperty has a value and sorters is left blank, an automatic sorter with this property will be created.
+				 */
+				sortProperty: null,
+
 				/**
 				 * @member {array} properties - Array of Property definition objects
 				 */