@onehat/data 1.6.8 → 1.6.12

package/cypress/integration/Entity.spec.js

@@ -137,6 +137,12 @@ describe('Entity', function() {
 			expect(this.entity.bar).to.be.eq('one');
 			expect(this.entity.isDirty).to.be.false;
 			expect(_.isEqual(this.entity.getParsedValues(), originalData)).to.be.true;
+
+			this.entity.delete();
+			expect(this.entity.isDeleted).to.be.true;
+
+			this.entity.reset();
+			expect(this.entity.isDeleted).to.be.false;
 		});
 
 		it('getMappedValue', function() {
@@ -533,6 +539,9 @@ describe('Entity', function() {
 		it('markDeleted', function() {
 			this.entity.markDeleted();
 			expect(this.entity.isDeleted).to.be.true;
+
+			this.entity.markDeleted(false);
+			expect(this.entity.isDeleted).to.be.false;
 		});
 
 		it('delete', function() {
@@ -540,6 +549,11 @@ describe('Entity', function() {
 			expect(this.entity.isDeleted).to.be.true;
 		});
 
+		it('undelete', function() {
+			this.entity.delete();
+			this.entity.undelete();
+			expect(this.entity.isDeleted).to.be.false;
+		});
 	});
 
 	describe('events', function() {
@@ -594,6 +608,20 @@ describe('Entity', function() {
 			expect(didFire).to.be.true;
 		});
 
+		it('undelete', function() {
+			this.entity.delete();
+			expect(this.entity.isDeleted).to.be.true;
+
+			let didFire = false;
+			this.entity.on('undelete', () => {
+				didFire = true;
+			});
+			this.entity.undelete();
+
+			expect(didFire).to.be.true;
+			expect(this.entity.isDeleted).to.be.false;
+		});
+
 		it('destroy', function() {
 			let didFire = false;
 			this.entity.on('destroy', () => {

package/cypress/integration/Repository/Repository.spec.js

@@ -630,6 +630,15 @@ describe('Repository Base', function() {
 			expect(_.isEqual(entity, dirty[0])).to.be.true;
 		});
 
+		it('isDirty', function() {
+			expect(this.repository.isDirty).to.be.false;
+
+			this.repository.setAutoSave(false);
+			const entity = this.repository.getByIx(0);
+			entity.value = 'test';	
+			expect(this.repository.isDirty).to.be.true;
+		});
+
 		it('getDeleted', function() {
 			this.repository.setAutoSave(false);
 			const entity = this.repository.getByIx(0);
@@ -718,6 +727,11 @@ describe('Repository Base', function() {
 		// deleteById
 		// deleteDirty
 		// deletePhantom
+		// undeleteByIx
+		// undeleteByRange
+		// undeleteBy
+		// undeleteById
+		// undeleteDeleted
 
 	});
 

package/package.json

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

package/src/Entity.js

@@ -52,6 +52,7 @@ class Entity extends EventEmitter {
 			'reload',
 			'save',
 			'delete',
+			'undelete',
 			'destroy',
 		]);
 		
@@ -286,7 +287,7 @@ class Entity extends EventEmitter {
 
 	/**
 	 * Resets the Entity to a state as if it had just been created,
-	 * all based on _originalData.
+	 * Gets data to restore from _originalData.
 	 */
 	reset = () => {
 		if (this.isDestroyed) {
@@ -297,6 +298,10 @@ class Entity extends EventEmitter {
 		this._resetPropertyValues();
 		this._originalDataParsed = this.getParsedValues();
 
+		if (this.isDeleted) {
+			this.undelete();
+		}
+
 		this.emit('reset', this._proxy);
 	}
 
@@ -1047,18 +1052,17 @@ class Entity extends EventEmitter {
 
 	/**
 	 * Marks an entity as having been saved to storage medium.
+	 * @param {boolean} bool - How it should be marked. Defaults to true.
 	 */
-	markDeleted = () => {
+	markDeleted = (bool = true) => {
 		if (this.isDestroyed) {
 			throw Error('this.markDeleted is no longer valid. Entity has been destroyed.');
 		}
-		this.isDeleted = true;
+		this.isDeleted = bool;
 	}
 
 	/**
 	 * Tells the Repository to delete this entity from the storage medium.
-	 * @param {function} onSuccess - Optional function to execute when save operation successfully completes.
-	 * @param {function} onFailure - Optional function to execute when save operation successfully completes.
 	 * @fires delete
 	 */
 	delete = () => {
@@ -1072,6 +1076,23 @@ class Entity extends EventEmitter {
 		}
 	}
 
+	/**
+	 * Marks a deleted entity as undeleted.
+	 * Only works when autoSave is off for the containing repository
+	 * @fires delete
+	 */
+	undelete = () => {
+		if (this.isDestroyed) {
+			throw Error('this.undelete is no longer valid. Entity has been destroyed.');
+		}
+		const repository = this.getRepository();
+		if (repository && repository.autoSave) {
+			throw Error('Cannot undelete entities on an autoSave repository.');
+		}
+		this.markDeleted(false);
+		this.emit('undelete', this._proxy);
+	}
+
 	/**
 	 * Destroy this object.
 	 * - Removes all circular references to parent objects

package/src/Repository/Repository.js

@@ -1181,6 +1181,18 @@ export default class Repository extends EventEmitter {
 		return !_.isNil(this.getById(idOrEntity));
 	}
 
+	/**
+	 * Getter of isDirty for this Repository.
+	 * Returns true if any Entities within it are dirty
+	 * @return {boolean} isDirty
+	 */
+	get isDirty() {
+		if (this.isDestroyed) {
+			throw Error('this.isDirty is no longer valid. Repository has been destroyed.');
+		}
+		return !!this.getDirty().length;
+	}
+
 	/**
 	 * Convenience function
 	 * Alias for isInRepository
@@ -1478,6 +1490,52 @@ export default class Repository extends EventEmitter {
 		await this.delete(this.getPhantom());
 	}
 
+	/**
+	 * Undelete a single Entity by its index (zero-indexed) on the current page
+	 * @param {integer} ix - Index
+	 * @return {object} entity - Entity
+	 */
+	undeleteByIx = async (ix) => {
+		await this.undelete(this.getByIx(ix));
+	}
+	
+	/**
+	 * Undelete multiple Entities by their range of indices 
+	 * (zero-indexed) on the current page
+	 * @param {integer} startIx - Index
+	 * @param {integer} endIx - Index (inclusive)
+	 * @return {array} entities - Array of Entities
+	 */
+	undeleteByRange = async (startIx, endIx) => {
+		await this.undelete(this.getByRange(startIx, endIx));
+	}
+
+	/**
+	 * Undelete multiple Entities by supplied filter function
+	 * @param {function} fn - Filter function to apply to all entities
+	 * @return {Entity[]} Entities that passed through filter
+	 */
+	undeleteBy = async (filter) => {
+		await this.undelete(this.getBy(filter));
+	}
+
+	/**
+	 * Undelete a single Entity by its id
+	 * @param {integer} id - id of record to retrieve
+	 * @return {Entity} The Entity with matching id
+	 */
+	undeleteById = async (id) => {
+		await this.undelete(this.getById(id));
+	}
+
+	/**
+	 * Undelete all deleted Entities
+	 * @return {Entity[]} Entities that passed through filter
+	 */
+	undeleteDeleted = async () => {
+		await this.undelete(this.getDeleted());
+	}
+