@onehat/data 1.13.6 → 1.14.0

package/cypress/integration/OneHatData.spec.js

@@ -358,6 +358,22 @@ describe('OneHatData', function() {
 		})();
 	});
 
+	it('setIsOnline', function() {
+		(async function() {
+			await beforeEach();
+
+			const oneHatData = this.oneHatData;
+
+			oneHatData.setIsOnline(true);
+			expect(oneHatData.isOnline).to.be.true;
+
+			oneHatData.setIsOnline(false);
+			expect(oneHatData.isOnline).to.be.false;
+
+			afterEach();
+		})();
+	});
+
 	it('isEntity', async function() {
 		(async function() {
 			await beforeEach();

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

@@ -112,7 +112,7 @@ describe('OneBuildRepository', function() {
 			expect(_.size(this.repository.entities)).to.be.eq(1);
 		});
 
-		it.only('sortInMemory', function() {
+		it('sortInMemory', function() {
 
 			const repository = this.repository;
 
@@ -138,6 +138,17 @@ describe('OneBuildRepository', function() {
 			expect(entities[3].key).to.be.eq(4);
 			expect(entities[4].key).to.be.eq(5);
 		});
+
+		it('setIsOnline', function() {
+
+			const repository = this.repository;
+
+			repository.setIsOnline(true);
+			expect(repository.isOnline).to.be.true;
+
+			repository.setIsOnline(false);
+			expect(repository.isOnline).to.be.false;
+		});
 		
 	});
 

package/package.json

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

package/src/OneHatData.js

@@ -67,6 +67,14 @@ export class OneHatData extends EventEmitter {
 		 */
 		this.isDestroyed = false;
 
+		/**
+		 * @member {boolean} isOnline - Whether the remote Internet connection is active.
+		 * This must be managed by outside software, calling setIsOnline at appropriate times.
+		 * @private
+		 */
+		this.isOnline = true;
+
+
 		this.registerEvents([
 			'createRepository',
 			'deleteRepository',
@@ -605,6 +613,18 @@ export class OneHatData extends EventEmitter {
 		return this.repositories && this.repositories.hasOwnProperty(id);
 	}
 
+	/**
+	 * Sets isOnline for all remote repositories.
+	 * Remote repositories won't submit queries if !isOnline
+	 */
+	setIsOnline = (isOnline) => {
+		this.isOnline = !!isOnline;
+		const remoteRepositories = oneHatData.getRepositoriesBy((repository) => !!repository.setIsOnline);
+		_.each(remoteRepositories, (repository) => {
+			repository.setIsOnline(isOnline);
+		});
+	}
+
 
 
 	//     ____       __     __

package/src/Repository/Ajax.js

@@ -93,6 +93,13 @@ class AjaxRepository extends Repository {
 			 * @member {object} _baseParams - Params that will be applied to every request
 			 */
 			_baseParams: {},
+
+			/**
+			 * @member {boolean} isOnline - Whether the remote storage medium is available.
+			 * This must be managed by outside software, calling setIsOnline at appropriate times.
+			 * @private
+			 */
+			isOnline: true,
 			
 		};
 		_.merge(this, defaults, config);
@@ -800,6 +807,11 @@ class AjaxRepository extends Repository {
 			return;
 		}
 
+		if (!this.isOnline) {
+			this.throwError('Offline');
+			return;
+		}
+
 		const options = {
 				url,
 				method,
@@ -884,6 +896,10 @@ class AjaxRepository extends Repository {
 						}));
 	}
 
+	setIsOnline = (isOnline) => {
+		this.isOnline = !!isOnline; // force convert type to boolean
+	}
+
 }
 
 AjaxRepository.className = 'Ajax';

package/src/Repository/OneBuild.js

@@ -99,6 +99,11 @@ class OneBuildRepository extends AjaxRepository {
 			return;
 		}
 
+		if (!this.isOnline) {
+			this.throwError('Offline');
+			return;
+		}
+
 		const options = {
 				url,
 				method,
@@ -242,6 +247,12 @@ class OneBuildRepository extends AjaxRepository {
 	 * @return {Promise}
 	 */
 	reorder = (dragRecord, dropRecord, dropPosition) => {
+
+		if (!this.isOnline) {
+			this.throwError('Offline');
+			return;
+		}
+		
 		const data = {
 			url: 'reorder',
 			data: qs.stringify({
@@ -284,6 +295,11 @@ class OneBuildRepository extends AjaxRepository {
 	 */
 	login = (creds) => {
 
+		if (!this.isOnline) {
+			this.throwError('Offline');
+			return;
+		}
+
 		const data = {
 			url: 'apiLogin',
 			data: qs.stringify(creds),
@@ -317,9 +333,16 @@ class OneBuildRepository extends AjaxRepository {
 	 * @return {Promise}
 	 */
 	logout = () => {
+
+		if (!this.isOnline) {
+			this.throwError('Offline');
+			return;
+		}
+
 		if (this.debugMode) {
 			console.log('logout');
 		}
+
 		return this.axios({
 				url: 'Users/apiLogout',
 				method: 'POST',
@@ -341,6 +364,12 @@ class OneBuildRepository extends AjaxRepository {
 	}
 
 	forgotPassword = (email = null, username = null) => {
+
+		if (!this.isOnline) {
+			this.throwError('Offline');
+			return;
+		}
+
 		const data = {
 			url: 'forgotPassword',
 			data: qs.stringify({