@onehat/data 1.8.33 → 1.8.35

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

@@ -210,6 +210,19 @@ describe('MemoryRepository', function() {
 			expect(result.value).to.be.eq('four');
 		});
 
+		it.only('getIxById', function() {
+			this.repository.setPage(1);
+			this.repository.setPageSize(2);
+			let ix = this.repository.getIxById(1);
+			expect(ix).to.be.eq(0);
+
+			ix = this.repository.getIxById(2);
+			expect(ix).to.be.eq(1);
+
+			ix = this.repository.getIxById(3);
+			expect(ix).to.be.undefined;
+		});
+
 		it('getBy', function() {
 			const results = this.repository.getBy((entity) => {
 				return entity.id > 2;

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

@@ -229,6 +229,16 @@ describe('Repository Base', function() {
 			expect(didFireChangeSorters).to.be.true;
 		});
 
+		it('getSortField', function() {
+			const sortField = this.repository.getSortField();
+			expect(sortField).to.be.eq('value');
+		});
+
+		it('getSortDirection', function() {
+			const sortDirection = this.repository.getSortDirection();
+			expect(sortDirection).to.be.eq('ASC');
+		});
+
 	});
 
 	describe('filtering', function() {
@@ -652,6 +662,14 @@ describe('Repository Base', function() {
 			expect(result.value).to.be.eq('three');
 		});
 
+		it('getIxById', function() {
+			let ix = this.repository.getIxById(1);
+			expect(ix).to.be.eq(0);
+
+			ix = this.repository.getIxById(3);
+			expect(ix).to.be.eq(2);
+		});
+
 		it('getBy', function() {
 			const result = this.repository.getBy(entity => entity.id === 2 || entity.id === 3);
 			expect(result.length).to.be.eq(2);

package/package.json

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

package/src/Repository/Memory.js

@@ -416,6 +416,24 @@ class MemoryRepository extends Repository {
 		return this._keyedEntities[id] ? this._keyedEntities[id] : null;
 	}
 
+	/**
+	 * Get a single Entity's index by its id.
+	 * Overrides Repository method, to limite results to only the current page.
+	 * @param {integer} id - id of record to retrieve
+	 * @return {integer} The numerical index, or undefined
+	 */
+	getIxById = (id) => {
+		if (this.isDestroyed) {
+			throw Error('this.getIxById is no longer valid. Repository has been destroyed.');
+		}
+
+		const ix = this.getEntitiesOnPage().findIndex((entity) => entity.id === id);
+		if (ix >= 0) {
+			return ix;
+		}
+		return undefined;
+	}
+
 	/**
 	 * Override Repository.getEntities, so we can get an array of 
 	 * all *active* Entities, with sorting and filtering applied.

package/src/Repository/Repository.js

@@ -305,7 +305,7 @@ export default class Repository extends EventEmitter {
 	 */
 	 _createStatics = () => {
 		if (this.isDestroyed) {
-			throw Error('this._createStatics is no longer valid. Entity has been destroyed.');
+			throw Error('this._createStatics is no longer valid. Repository has been destroyed.');
 		}
 		const staticsDefinitions = this.schema.repository.statics || this.originalConfig.statics; // The latter is mainly for lfr repositories
 		if (!_.isEmpty(staticsDefinitions)) {
@@ -1166,6 +1166,23 @@ export default class Repository extends EventEmitter {
 		return this.getFirstBy(entity => entity.id === id);
 	}
 
+	/**
+	 * Get a single Entity's index by its id.
+	 * @param {integer} id - id of record to retrieve
+	 * @return {integer} The numerical index, or undefined
+	 */
+	getIxById = (id) => {
+		if (this.isDestroyed) {
+			throw Error('this.getIxById is no longer valid. Repository has been destroyed.');
+		}
+
+		const ix = this.entities.findIndex((entity) => entity.id === id);
+		if (ix >= 0) {
+			return ix;
+		}
+		return undefined;
+	}
+
 	/**
 	 * Get an array of Entities by supplied filter function
 	 * @param {function} filter - Filter function to apply to all entities
@@ -1310,11 +1327,39 @@ export default class Repository extends EventEmitter {
 	 */
 	getSchema = () => {
 		if (this.isDestroyed) {
-			throw Error('this.getSchema is no longer valid. Entity has been destroyed.');
+			throw Error('this.getSchema is no longer valid. Repository has been destroyed.');
 		}
 		return this.schema;
 	}
 
+	/**
+	 * Gets the sort field, if only one sorter is applied.
+	 * @return {Schema} schema
+	 */
+	getSortField = () => {
+		if (this.isDestroyed) {
+			throw Error('this.getSortField is no longer valid. Repository has been destroyed.');
+		}
+		if (!this.allowsMultiSort || this.sorters.length < 1) {
+			return null;
+		}
+		return this.sorters[0].name;
+	}
+
+	/**
+	 * Gets the sort direction, if only one sorter is applied.
+	 * @return {Schema} schema
+	 */
+	getSortDirection = () => {
+		if (this.isDestroyed) {
+			throw Error('this.getSortDirection is no longer valid. Repository has been destroyed.');
+		}
+		if (!this.allowsMultiSort || this.sorters.length < 1) {
+			return null;
+		}
+		return this.sorters[0].direction;
+	}
+
 	/**
 	 * Gets the associated Repository
 	 * @param {string} repositoryName - Name of the Repository to retrieve
@@ -1322,7 +1367,7 @@ export default class Repository extends EventEmitter {
 	 */
 	getAssociatedRepository = (repositoryName) => {
 		if (this.isDestroyed) {
-			throw Error('this.getAssociatedRepository is no longer valid. Entity has been destroyed.');
+			throw Error('this.getAssociatedRepository is no longer valid. Repository has been destroyed.');
 		}
 
 		const schema = this.getSchema();