@onehat/data 1.4.6 → 1.4.10

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

@@ -30,6 +30,43 @@ describe('OneBuildRepository', function() {
 	});
 
 	describe('Params', function() {
+
+		it('setParam', function() {
+			const r = this.repository;
+			r.setParam('test', 1);
+
+			expect(r._params.test).to.be.eq(1);
+		});
+
+		it('setParams', function() {
+			const r = this.repository;
+			r.setParams({
+				test1: 1,
+				test2: 2,
+			});
+
+			expect(r._params.test1).to.be.eq(1);
+			expect(r._params.test2).to.be.eq(2);
+		});
+
+		it('setBaseParam', function() {
+			const r = this.repository;
+			r.setBaseParam('test', 1);
+
+			expect(r._baseParams.test).to.be.eq(1);
+		});
+
+		it('setBaseParams', function() {
+			const r = this.repository;
+			r.setBaseParams({
+				test1: 1,
+				test2: 2,
+			});
+
+			expect(r._baseParams.test1).to.be.eq(1);
+			expect(r._baseParams.test2).to.be.eq(2);
+		});
+
 		it('setValuelessParam', function() {
 			const r = this.repository;
 			r.setParam('conditions[field]', 1);
@@ -38,6 +75,24 @@ describe('OneBuildRepository', function() {
 			expect(r._params.conditions.field).to.be.eq(1);
 			expect(r._params.conditions[0]).to.be.eq('field IS NOT NULL');
 		});
+
+		it('clearParams', function() {
+			const r = this.repository;
+			r.setParams({
+				test1: 1,
+				test2: 2,
+			});
+			r.setBaseParams({
+				test1: 1,
+				test2: 2,
+			});
+
+			r.clearParams(false, true);
+
+			expect(r._params).to.be.empty;
+			expect(r._baseParams).to.be.empty;
+		});
+
 	});
 
 	describe('custom', function() {

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

@@ -372,6 +372,19 @@ describe('Repository Base', function() {
 			expect(didFireChangeFilters).to.be.true;
 		});
 
+		it('changing filters resets pagination', function() {
+			this.repository.isPaginated = true;
+			this.repository.setPageSize(1);
+			this.repository.setPage(3);
+
+			this.repository.setFilters({
+				b: '1',
+				c: '2',
+			});
+
+			expect(this.repository.page).to.be.eq(1);
+		});
+
 	});
 
 	describe('pagination', function() {
@@ -471,6 +484,18 @@ describe('Repository Base', function() {
 			expect(results.pageTotal).to.be.eq(1);
 		});
 
+		it('reset pagination', function() {
+			expect(this.repository.page).to.be.eq(1);
+			
+			this.repository.isPaginated = true;
+			this.repository.setPageSize(1);
+			this.repository.setPage(3);
+			expect(this.repository.page).to.be.eq(3);
+
+			this.repository.resetPagination();
+			expect(this.repository.page).to.be.eq(1);
+		});
+
 	});
 
 	describe('creating', function() {

package/package.json

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

package/src/Integration/ReactNative/Repository/AsyncStorage.js

@@ -1,7 +1,12 @@
+/**
+ * This file is categorized as "Proprietary Framework Code"
+ * and is subject to the terms and conditions defined in
+ * file 'LICENSE.txt', which is part of this source code package.
+ */
 /** @module Repository */
 
 import OfflineRepository from '@onehat/data/src/Repository/Offline.js';
-import AsyncStorage from '@react-native-community/async-storage';
+import AsyncStorage from '@react-native-async-storage/async-storage';
 import _ from 'lodash';
 
 /**
@@ -37,10 +42,12 @@ class AsyncStorageRepository extends OfflineRepository {
 					value = result; // Invalid JSON, just return raw result
 				}
 			}
+			
 			return value;
 		} catch (error) {
 			if (this.debugMode) {
 				const msg = error && error.message;
+				console.log('_storageGetValue error', msg);
 				debugger;
 			}
 		}
@@ -60,7 +67,7 @@ class AsyncStorageRepository extends OfflineRepository {
 			const results = await AsyncStorage.multiGet(this._namespace(keys));
 
 			if (this.debugMode) {
-				console.log(this.name, 'AsyncStorage.multiGet results', name, results);
+				console.log(this.name, 'AsyncStorage.multiGet results', results);
 			}
 
 			let values = [];
@@ -72,7 +79,17 @@ class AsyncStorageRepository extends OfflineRepository {
 					} catch (e) {
 						parsed = value; // Invalid JSON, just return raw result
 					}
-					values.push(parsed);
+					if (parsed === null) {
+						// Values should be stored as JSON, so it should be either {} or []. If it's null, that means the AsyncStorage can't find the record
+						// Delete the index to this record
+						const re = new RegExp('^' + this.name + '\-' + '(.*)'),
+							matches = key.match(re);
+debugger;
+						const id = parseInt(matches, 10);
+						this._deleteFromIndex(id);
+					} else {
+						values.push(parsed);
+					}
 				})
 			}
 
@@ -84,6 +101,7 @@ class AsyncStorageRepository extends OfflineRepository {
 		} catch (error) {
 			if (this.debugMode) {
 				const msg = error && error.message;
+				console.log('_storageGetMultiple error', msg);
 				debugger;
 			}
 		}
@@ -103,6 +121,7 @@ class AsyncStorageRepository extends OfflineRepository {
 		} catch (error) {
 			if (this.debugMode) {
 				const msg = error && error.message;
+				console.log('_storageSetValue error', msg);
 				debugger;
 			}
 		}
@@ -126,11 +145,16 @@ class AsyncStorageRepository extends OfflineRepository {
 				console.log(this.name, 'AsyncStorage.multiSet', keys);
 			}
 
+			if (_.isEmpty(converted)) {
+				return;
+			}
+
 			return await AsyncStorage.multiSet(converted);
 
 		} catch (error) {
 			if (this.debugMode) {
 				const msg = error && error.message;
+				console.log('_storageSetMultiple error', msg);
 				debugger;
 			}
 		}
@@ -151,6 +175,7 @@ class AsyncStorageRepository extends OfflineRepository {
 		} catch (error) {
 			if (this.debugMode) {
 				const msg = error && error.message;
+				console.log('_storageDeleteValue error', msg);
 				debugger;
 			}
 		}
@@ -171,6 +196,7 @@ class AsyncStorageRepository extends OfflineRepository {
 		} catch (error) {
 			if (this.debugMode) {
 				const msg = error && error.message;
+				console.log('_storageDeleteMultiple error', msg);
 				debugger;
 			}
 		}

package/src/Integration/ReactNative/Repository/SecureStore.js

@@ -1,94 +1,99 @@
-import OfflineRepository from '@onehat/data/src/Repository/Offline';
-import * as SecureStore from 'expo-secure-store'; // see: https://docs.expo.io/versions/latest/sdk/securestore/
-import _ from 'lodash';
-
 /**
- * Repository representing Expo's SecureStore
- * Uses expo-secure-store package
+ * This file is categorized as "Proprietary Framework Code"
+ * and is subject to the terms and conditions defined in
+ * file 'LICENSE.txt', which is part of this source code package.
  */
-class SecureStoreRepository extends OfflineRepository {
-
-	constructor(config = {}) {
-		super(...arguments);
-		_.merge(this, config);
-	}
-
-	_storageGetValue = async (name) => {
-		try {
-			
-			if (this.debugMode) {
-				console.log(this.name, 'SecureStore.get', name);
-			}
-
-			const result = await SecureStore.getItemAsync(this._namespace(name));
-
-			if (this.debugMode) {
-				console.log(this.name, 'SecureStore.get results', name, result);
-			}
-
-			let value;
-			if (!_.isNil(result)) {
-				try {
-					value = JSON.parse(result);
-				} catch (e) {
-					value = result; // Invalid JSON, just return raw result
-				}
-			}
-			return value;
-		} catch (error) {
-			if (this.debugMode) {
-				const msg = error && error.message;
-				debugger;
-			}
-		}
-	}
-
-	_storageSetValue = async (name, value) => {
-		try {
-			if (!_.isString(value)) {
-				value = JSON.stringify(value);
-			}
-			if (this.debugMode) {
-				console.log(this.name, 'SecureStore.set', name, value);
-			}
-
-			const result = await SecureStore.setItemAsync(this._namespace(name), value);
-
-			// if (this.debugMode) {
-			// 	console.log(this.name, 'SecureStore.set results', name, result);
-			// }
-			return result;
-		} catch (error) {
-			if (this.debugMode) {
-				const msg = error && error.message;
-				debugger;
-			}
-		}
-	}
-
-	_storageDeleteValue = async (name) => {
-		try {
-			if (this.debugMode) {
-				console.log(this.name, 'SecureStore.delete', name);
-			}
-
-			const result = await SecureStore.deleteItemAsync(this._namespace(name));
-
-			// if (this.debugMode) {
-			// 	console.log(this.name, 'SecureStore.delete results', name, result);
-			// }
-			return result;
-		} catch (error) {
-			if (this.debugMode) {
-				const msg = error && error.message;
-				debugger;
-			}
-		}
-	}
-
-};
-
-SecureStoreRepository.className = 'SecureStore';
-SecureStoreRepository.type = 'secure';
-
-export default SecureStoreRepository;
+ import OfflineRepository from '@onehat/data/src/Repository/Offline.js';
+ import * as SecureStore from 'expo-secure-store'; // see: https://docs.expo.io/versions/latest/sdk/securestore/
+ import _ from 'lodash';
+ 
+ /**
+  * Repository representing Expo's SecureStore
+  * Uses expo-secure-store package
+  */
+ class SecureStoreRepository extends OfflineRepository {
+ 
+	 constructor(config = {}) {
+		 super(...arguments);
+		 _.merge(this, config);
+	 }
+ 
+	 _storageGetValue = async (name) => {
+		 try {
+			 
+			 if (this.debugMode) {
+				 console.log(this.name, 'SecureStore.get', name);
+			 }
+ 
+			 const result = await SecureStore.getItemAsync(this._namespace(name));
+ 
+			 if (this.debugMode) {
+				 console.log(this.name, 'SecureStore.get results', name, result);
+			 }
+ 
+			 let value;
+			 if (!_.isNil(result)) {
+				 try {
+					 value = JSON.parse(result);
+				 } catch (e) {
+					 value = result; // Invalid JSON, just return raw result
+				 }
+			 }
+			 return value;
+		 } catch (error) {
+			 if (this.debugMode) {
+				 const msg = error && error.message;
+				 debugger;
+			 }
+		 }
+	 }
+ 
+	 _storageSetValue = async (name, value) => {
+		 try {
+			 if (!_.isString(value)) {
+				 value = JSON.stringify(value);
+			 }
+			 if (this.debugMode) {
+				 console.log(this.name, 'SecureStore.set', name, value);
+			 }
+ 
+			 const result = await SecureStore.setItemAsync(this._namespace(name), value);
+ 
+			 // if (this.debugMode) {
+			 // 	console.log(this.name, 'SecureStore.set results', name, result);
+			 // }
+			 return result;
+		 } catch (error) {
+			 if (this.debugMode) {
+				 const msg = error && error.message;
+				 debugger;
+			 }
+		 }
+	 }
+ 
+	 _storageDeleteValue = async (name) => {
+		 try {
+			 if (this.debugMode) {
+				 console.log(this.name, 'SecureStore.delete', name);
+			 }
+ 
+			 const result = await SecureStore.deleteItemAsync(this._namespace(name));
+ 
+			 // if (this.debugMode) {
+			 // 	console.log(this.name, 'SecureStore.delete results', name, result);
+			 // }
+			 return result;
+		 } catch (error) {
+			 if (this.debugMode) {
+				 const msg = error && error.message;
+				 debugger;
+			 }
+		 }
+	 }
+ 
+ };
+ 
+ SecureStoreRepository.className = 'SecureStore';
+ SecureStoreRepository.type = 'secure';
+ 
+ export default SecureStoreRepository;

package/src/Repository/Ajax.js

@@ -87,9 +87,9 @@ class AjaxRepository extends Repository {
 			headers: {},
 
 			/**
-			 * @member {object} baseParams - Params that will be applied to every request
+			 * @member {object} _baseParams - Params that will be applied to every request
 			 */
-			baseParams: {},
+			_baseParams: {},
 			
 		};
 		_.merge(this, defaults, config);
@@ -202,8 +202,7 @@ class AjaxRepository extends Repository {
 	setParam = (name, value, isBaseParam = false) => {
 		const re = /^([^\[]+)\[([^\]]+)\](.*)$/,
 			matches = name.match(re),
-			paramsToChange = isBaseParam ? this.baseParams : this._params;
-		
+			paramsToChange = isBaseParam ? this._baseParams : this._params;
 		
 		if (matches) { // name has array notation like 'conditions[username]'
 			const first = matches[1],
@@ -234,7 +233,7 @@ class AjaxRepository extends Repository {
 	setValuelessParam = (name, isBaseParam = false) => {
 		const re = /^([^\[]+)\[([^\]]+)\](.*)$/,
 			matches = name.match(re),
-			paramsToChange = isBaseParam ? this.baseParams : this._params;
+			paramsToChange = isBaseParam ? this._baseParams : this._params;
 		
 		if (matches) { // name has array notation like 'conditions[username]'
 			const first = matches[1],
@@ -262,24 +261,35 @@ class AjaxRepository extends Repository {
 		});
 	}
 
+	/**
+	 * Sets base query param
+	 * @param {string} name - Param name to set.
+	 * @param {any} value - Param value to set.
+	 */
+	setBaseParam = (name, value) => {
+		this.setParam(name, value, true);
+	}
+
 	/**
 	 * Sets base query params. These params are sent on every request.
 	 * @param {object} params - Base params to set. Key is parameter name, value is parameter value
 	 */
 	setBaseParams = (params) => {
 		_.each(params, (value, name) => {
-			this.setParam(name, value, true);
+			this.setBaseParam(name, value);
 		});
 	}
 
 	/**
-	 * Manually clears all existing (non-base) params
-	 * including sorting, filtering, and pagination.
+	 * Manually clears all (non-base) params including filtering.
 	 * *Not intended for normal usage,* but rather for testing.
 	 * @param {boolean} reload - Whether to reload repository. Defaults to false.
 	 */
-	clearParams = (reload = false) => {
+	clearParams = (reload = false, clearBase = false) => {
 		this._params = {};
+		if (clearBase) {
+			this._baseParams = {};
+		}
 		if (reload && this.isLoaded) {
 			return this.reload();
 		}
@@ -292,8 +302,8 @@ class AjaxRepository extends Repository {
 	 */
 	_onChangeSorters = () => {
 		const sorter = this.sorters[0];
-		this.setParam(this.paramSort, sorter.name);
-		this.setParam(this.paramDirection, sorter.direction);
+		this.setBaseParam(this.paramSort, sorter.name);
+		this.setBaseParam(this.paramDirection, sorter.direction);
 		
 		if (this.isLoaded) {
 			return this.reload();
@@ -319,8 +329,8 @@ class AjaxRepository extends Repository {
 	 * Refreshes entities.
 	 */
 	_onChangePagination = () => {
-		this.setParam(this.paramPageNum, this.page);
-		this.setParam(this.paramPageSize, this.pageSize);
+		this.setBaseParam(this.paramPageNum, this.page);
+		this.setBaseParam(this.paramPageSize, this.pageSize);
 
 		if (this.isLoaded) {
 			return this.reload();
@@ -360,7 +370,7 @@ class AjaxRepository extends Repository {
 		}
 
 		const repository = this;
-		const data = _.assign({}, this.baseParams, this._params);
+		const data = _.assign({}, this._baseParams, this._params);
 		
 		return this._send(this.methods.get, this.api.get, data)
 					.then(result => {
@@ -462,7 +472,7 @@ class AjaxRepository extends Repository {
 		const params = {
 			id: entity.id,
 		};
-		return _.assign({}, this.baseParams, params);
+		return _.assign({}, this._baseParams, params);
 	}
 
 	/**

package/src/Repository/Offline.js

@@ -23,13 +23,8 @@ class OfflineRepository extends MemoryRepository {
 
 	async initialize() {
 		this.pauseEvents(); // Queue 'initialize' event from super
-		await super.initialize();
 
-		this._index = await this._getIndex();
-		if (!this._index) {
-			await this._setIndex([]);
-			this._index = [];
-		}
+		await super.initialize(); // Initializes index in _loadFromStorage()
 
 		this.resumeEvents(true); // Now fire it!
 	}
@@ -80,7 +75,14 @@ class OfflineRepository extends MemoryRepository {
 	 */
 	_loadFromStorage = async () => {
 		try {
-			const ids = await this._getIndex(),
+
+			this._index = await this._getIndex();
+			if (!this._index) {
+				await this._setIndex([]);
+				this._index = [];
+			}
+
+			const ids = this._index,
 				total = ids && ids.length ? ids.length : 0,
 				results = [];
 			

package/src/Repository/Repository.js

@@ -648,6 +648,7 @@ export default class Repository extends EventEmitter {
 		if (!_.isEqual(this.filters, filters)) {
 			isChanged = true;
 			this.filters = filters;
+			this.resetPagination();
 			this.emit('changeFilters');
 			if (this._onChangeFilters) {
 				return this._onChangeFilters();
@@ -666,6 +667,17 @@ export default class Repository extends EventEmitter {
 	// /_/    \__,_/\__, /_/_/ /_/\__,_/\__/\___/
 	//             /____/
 
+	/**
+	 * Resets the pagination to page one
+	 * @fires changePageSize
+	 */
+	resetPagination = (pageSize) => {
+		if (this.isDestroyed) {
+			throw Error('this.resetPagination is no longer valid. Repository has been destroyed.');
+		}
+		this.setPage(1);
+	}
+
 	/**
 	 * Sets the pageSize
 	 * @fires changePageSize
@@ -1328,6 +1340,9 @@ export default class Repository extends EventEmitter {
 		if (!_.isArray(entities)) {
 			entities = [entities];
 		}
+		if (!entities.length) {
+			return;
+		}
 		_.each(entities, (entity) => {
 			entity.markDeleted(); // Entity is still there, it's just marked for deletion
 		});