@onehat/data 1.11.5 → 1.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@onehat/data",
-	"version": "1.11.5",
+	"version": "1.12.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/Offline.js

@@ -169,17 +169,16 @@ class OfflineRepository extends MemoryRepository {
 		// Attempt to add
 		super._doAdd(entity);
 
-		const storageResult = this._storageSetValue(entity.id, entity.getOriginalData());
-		storageResult
-			.then(() => {
-				this._addToIndex(entity.id);
-			})
-			.catch(() => {
-				// Revert to clone
-				delete this._keyedEntities[entity.id];
-				entity.destroy();
-				this._keyedEntities[clone.id] = clone;
-			});
+		let storageResult;
+		try {
+			storageResult = await this._storageSetValue(entity.id, entity.getOriginalData());
+			this._addToIndex(entity.id);
+		} catch (e) {
+			// Revert to clone
+			delete this._keyedEntities[entity.id];
+			entity.destroy();
+			this._keyedEntities[clone.id] = clone;
+		}
 
 		return storageResult;
 	}
@@ -206,15 +205,16 @@ class OfflineRepository extends MemoryRepository {
 
 		// Attempt to edit
 		super._doEdit(entity);
-		const storageResult = this._storageSetValue(entity.id, entity.getOriginalData());
-		
-		storageResult
-			.catch(() => {
-				// Revert to clone
-				entity.isPersisted = clone.isPersisted;
-				entity._originalData = clone._originalData;
-				entity._originalDataParsed = clone._originalDataParsed;
-			});
+
+		let storageResult;
+		try {
+			storageResult = await this._storageSetValue(entity.id, entity.getOriginalData());
+		} catch (e) {
+			// Revert to clone
+			entity.isPersisted = clone.isPersisted;
+			entity._originalData = clone._originalData;
+			entity._originalDataParsed = clone._originalDataParsed;
+		}
 
 		return storageResult;
 	}
@@ -228,16 +228,16 @@ class OfflineRepository extends MemoryRepository {
 
 		// Attempt to delete
 		super._doDelete(entity);
-		const storageResult = this._storageDeleteValue(entity.id);
-
-		storageResult
-			.then(() => {
-				this._deleteFromIndex(entity.id);
-			})
-			.catch(() => {
-				// Revert to clone
-				this._keyedEntities[clone.id] = clone;
-			});
+
+
+		let storageResult;
+		try {
+			storageResult = await this._storageDeleteValue(entity.id);
+			this._deleteFromIndex(entity.id);
+		} catch (e) {
+			// Revert to clone
+			this._keyedEntities[clone.id] = clone;
+		}
 
 		return storageResult;
 	}

package/src/Repository/Repository.js

@@ -923,10 +923,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 +948,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 +960,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 +974,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 +1025,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;