@onehat/data 1.15.7 → 1.16.1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@onehat/data",
-	"version": "1.15.7",
+	"version": "1.16.1",
 	"description": "JS data modeling package with adapters for many storage mediums.",
 	"main": "src/index.js",
 	"type": "module",
@@ -63,7 +63,7 @@
 		"cypress": "5.2.0",
 		"ink-docstrap": "^1.3.2",
 		"jsdoc": "^4.0.0",
-		"webpack": "^5.75.0",
+		"webpack": "^5.76.0",
 		"joi": "^17.7.0",
 		"yup": "^0.32.11"
 

package/src/Entity.js

@@ -32,9 +32,10 @@ class Entity extends EventEmitter {
 	 * @param {Schema} schema - Schema object
 	 * @param {object} rawData - Raw data object. Keys are Property names, Values are Property values.
 	 * @param {Repository} repository
-	 * @param {boolean} - Has rawData already been mapped according to schema?
+	 * @param {boolean} originalIsMapped - Has data already been mapped according to schema?
+	 * @param {boolean} isDelayedSave - Should the repository skip autosave when immediately adding the record?
 	 */
-	constructor(schema, rawData = {}, repository = null, originalIsMapped = false, isDelayedSave = false) {
+	constructor(schema, rawData = {}, repository = null, originalIsMapped = false, isDelayedSave = false, isRemotePhantomMode = false) {
 		super(...arguments);
 
 		if (!schema) {
@@ -133,11 +134,26 @@ class Entity extends EventEmitter {
 		this.isDestroyed = false;
 
 		/**
-		 * @member {boolean} isFrozen - Prevent the entity from being saved, so an editor can change it before it gets saved to remote storage.
+		 * @member {boolean} isFrozen - Prevent the entity from being autoSaved on add, so an editor can change it before it gets saved to remote storage.
 		 * @public
 		 */
 		this.isDelayedSave = isDelayedSave;
 
+		/**
+		 * @member {boolean} isRemotePhantomMode - Whether this Entity uses the "alternate" CRUD mode, with tempIds from server (see OneBuild repository)
+		 * On a Repository, this mode overrides repository.isAutoSave, entity.isPersisted, && entity.isDelayedSave.
+		 * On an Entity, this mode affects the isPhantom getter.
+		 * @readonly
+		 */
+		this.isRemotePhantomMode = isRemotePhantomMode;
+
+		/**
+		 * @member {boolean} isRemotePhantom - Whether this entity is actually phantom on server; used only when this.isRemotePhantomMode.
+		 * If this.isRemotePhantomMode, isRemotePhantom defaults to true for all new Entities.
+		 * @public
+		 */
+		this.isRemotePhantom = this.isRemotePhantomMode;
+
 		/**
 		 * @member {boolean} lastModified - Last time this entity was modified
 		 * @public
@@ -945,9 +961,15 @@ class Entity extends EventEmitter {
 		if (this.isDestroyed) {
 			throw Error('this.isPhantom is no longer valid. Entity has been destroyed.');
 		}
-		const idProperty = this.getIdProperty(),
-			id = idProperty.getSubmitValue();
 
+		if (this.isRemotePhantomMode) {
+			return this.isRemotePhantom;
+		}
+		
+		const
+			idProperty = this.getIdProperty(),
+			id = idProperty.getSubmitValue();
+		
 		// No ID
 		if (_.isNil(id)) {
 			return true;

package/src/Repository/Ajax.js

@@ -533,10 +533,15 @@ class AjaxRepository extends Repository {
 
 		this._operations.add = true;
 
-		const method = this.methods.add,
+		const
+			method = this.methods.add,
 			url = this.api.add,
 			data = entity.getSubmitValues();
 
+		if (entity.isRemotePhantomMode) {
+			data.isRemotePhantom = true;
+		}
+
 		return this._send(method, url, data)
 					.then(result => {
 						if (this.debugMode) {
@@ -555,6 +560,9 @@ class AjaxRepository extends Repository {
 						}
 
 						entity.loadOriginalData(root[0]);
+						if (entity.isRemotePhantomMode) {
+							entity.isRemotePhantom = true;
+						}
 					});
 	}
 	
@@ -573,10 +581,17 @@ class AjaxRepository extends Repository {
 
 		this._operations.add = true;
 
-		const method = this.methods.add,
+		const
+			method = this.methods.add,
 			url = this.api.batchAdd,
 			data = {
-				entities: _.map(entities, entity => entity.submitValues),
+				entities: _.map(entities, entity => {
+					const values = entity.submitValues;
+					if (entity.isRemotePhantomMode) {
+						values.isRemotePhantom = true;
+					}
+					return values;
+				}),
 			};
 
 		return this._send(method, url, data)
@@ -600,6 +615,9 @@ class AjaxRepository extends Repository {
 						// TODO: Check this
 						_.each(entities, (entity, ix) => {
 							entity.loadOriginalData(root[ix]);
+							if (entity.isRemotePhantomMode) {
+								entity.isRemotePhantom = true;
+							}
 						});
 					});
 	}
@@ -617,10 +635,15 @@ class AjaxRepository extends Repository {
 
 		this._operations.edit = true;
 
-		const method = this.methods.edit,
+		const
+			method = this.methods.edit,
 			url = this.api.edit,
 			data = entity.getSubmitValues();
 
+		if (entity.isRemotePhantomMode) {
+			data.isRemotePhantom = false;
+		}
+
 		return this._send(method, url, data)
 					.then(result => {
 						if (this.debugMode) {
@@ -639,6 +662,9 @@ class AjaxRepository extends Repository {
 						}
 
 						entity.loadOriginalData(root[0]);
+						if (entity.isRemotePhantomMode && entity.isRemotePhantom) {
+							entity.isRemotePhantom = false;
+						}
 					});
 	}
 
@@ -657,10 +683,17 @@ class AjaxRepository extends Repository {
 
 		this._operations.edit = true;
 
-		const method = this.methods.edit,
+		const
+			method = this.methods.edit,
 			url = this.api.batchEdit,
 			data = {
-				entities: _.map(entities, entity => entity.submitValues),
+				entities: _.map(entities, entity => {
+					const values = entity.submitValues;
+					if (entity.isRemotePhantomMode) {
+						values.isRemotePhantom = false;
+					}
+					return values;
+				}),
 			};
 
 		return this._send(method, url, data)
@@ -684,6 +717,9 @@ class AjaxRepository extends Repository {
 						// TODO: Check this
 						_.each(entities, (entity, ix) => {
 							entity.loadOriginalData(root[ix]);
+							if (entity.isRemotePhantomMode && entity.isRemotePhantom) {
+								entity.isRemotePhantom = false;
+							}
 						});
 					});
 	}
@@ -701,7 +737,8 @@ class AjaxRepository extends Repository {
 
 		this._operations.delete = true;
 
-		const method = this.methods.delete,
+		const
+			method = this.methods.delete,
 			url = this.api.delete,
 			data = { id: entity.id, };
 
@@ -744,7 +781,8 @@ class AjaxRepository extends Repository {
 
 		this._operations.delete = true;
 
-		const method = this.methods.delete,
+		const
+			method = this.methods.delete,
 			url = this.api.batchDelete,
 			ids = _.map(entities, entity => entity.id),
 			data = { ids, };

package/src/Repository/Repository.js

@@ -86,6 +86,17 @@ export default class Repository extends EventEmitter {
 			 */
 			isRemoteSort: false,
 
+			/**
+			 * @member {boolean} isRemotePhantomMode - Whether this Repository uses the "alternate" CRUD mode.
+			 * In this CRUD mode, records are *immediately* saved to server when added to Repository,
+			 * but still marked as "phantom" until the their first "edit" operation takes place.
+			 * 
+			 * This mode overrides repository.isAutoSave, entity.isPersisted, && entity.isDelayedSave.
+			 * 
+			 * @readonly
+			 */
+			isRemotePhantomMode: false,
+
 			/**
 			 * @member {boolean} isPaginated - Whether this Repository is paginated
 			 */
@@ -297,7 +308,7 @@ export default class Repository extends EventEmitter {
 		const methodDefinitions = this.schema.repository.methods || this.originalConfig.methods; // The latter is mainly for lfr repositories
 		if (!_.isEmpty(methodDefinitions)) {
 			_.each(methodDefinitions, (method, name) => {
-				this[name] = method; // NOTE: Methods must be defined in schema as "function() {}", not as "() => {}" so "this" will be assigned correctly
+				this[name] = method; // NOTE: Methods must be defined in schema as "function() {}", not as "() => {}" so scope of "this" will be correct
 			});
 		}
 	}
@@ -977,19 +988,19 @@ 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, isDelayedSave);
+			entity = Repository._createEntity(this.schema, data, this, isPersisted, originalIsMapped, isDelayedSave, this.isRemotePhantomMode);
 		}
 		this._relayEntityEvents(entity);
 		this.entities.push(entity);
 
 		// Create id if needed
-		if (entity.isPhantom) { // i.e. idProperty has no value
+		if (!this.isRemotePhantomMode && entity.isPhantom) {
 			entity.createTempId();
 		}
 
 		this.emit('add', entity);
 
-		if (this.isAutoSave && !entity.isPersisted && !entity.isDelayedSave) {
+		if (this.isRemotePhantomMode || (this.isAutoSave && !entity.isPersisted && !entity.isDelayedSave)) {
 			await this.save(entity);
 		}
 
@@ -998,9 +1009,11 @@ export default class Repository extends EventEmitter {
 
 	/**
 	 * Creates a new static Entity that does NOT persist in storage medium.
+	 * Used when we want to work with an entity, but don't want that entity to appear in a repository.
 	 * @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
 	 */
 	createStandaloneEntity = async (data, isPersisted = false, originalIsMapped = false, isDelayedSave = false) => {
@@ -1008,8 +1021,12 @@ export default class Repository extends EventEmitter {
 			this.throwError('this.createStandaloneEntity is no longer valid. Repository has been destroyed.');
 			return;
 		}
+		if (this.isRemotePhantomMode) {
+			this.throwError('This repository uses isRemotePhantomMode, and therefore cannot create standalone entities.');
+			return;
+		}
 		
-		const entity = Repository._createEntity(this.schema, data, this, isPersisted, originalIsMapped, isDelayedSave);
+		const entity = Repository._createEntity(this.schema, data, this, isPersisted, originalIsMapped, isDelayedSave, this.isRemotePhantomMode);
 
 		if (entity.isPhantom) {
 			entity.createTempId();
@@ -1029,6 +1046,7 @@ export default class Repository extends EventEmitter {
 	 * Convenience function to create multiple new Entities in storage medium.
 	 * @param {array} data - Array of data objects or Entities. 
 	 * @param {boolean} isPersisted - Whether the new entities should be marked as already being persisted in storage medium.
+	 * @param {boolean} originalIsMapped - Has data already been mapped according to schema?
 	 * @return {array} entities - new Entity objects
 	 */
 	addMultiple = async (allData, isPersisted = false, originalIsMapped = false) => {
@@ -1052,11 +1070,13 @@ export default class Repository extends EventEmitter {
 	 * @param {object} rawData - Raw data object. Keys are Property names, Values are Property values.
 	 * @param {boolean} repository - Optional repository to connect the entity to.
 	 * @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
 	 * @private
 	 */
-	static _createEntity = (schema, rawData, repository = null, isPersisted = false, originalIsMapped = false, isDelayedSave = false) => {
-		const entity = new Entity(schema, rawData, repository, originalIsMapped, isDelayedSave);
+	static _createEntity = (schema, rawData, repository = null, isPersisted = false, originalIsMapped = false, isDelayedSave = false, isRemotePhantomMode = false) => {
+		const entity = new Entity(schema, rawData, repository, originalIsMapped, isDelayedSave, isRemotePhantomMode);
 		entity.initialize();
 		entity.isPersisted = isPersisted;
 		return entity;