@onehat/data 1.8.34 → 1.9.0

package/cypress/integration/Async.spec.js

@@ -1,4 +1,4 @@
-import { OneHatData } from '../../src/OneHatData';
+import { OneHatData } from '../../src/OneHatData.js';
 
 describe('Async playground', function() {
 

package/cypress/integration/Entity.spec.js

@@ -1,6 +1,6 @@
-import Entity from '../../src/Entity';
-import Schema from '../../src/Schema';
-import PropertyTypes from '../../src/Property';
+import Entity from '../../src/Entity.js';
+import Schema from '../../src/Schema/index.js';
+import PropertyTypes from '../../src/Property/index.js';
 
 
 describe('Entity', function() {

package/cypress/integration/OneHatData.spec.js

@@ -1,9 +1,9 @@
-import { OneHatData } from '../../src/OneHatData';
-import GroupsDefinition from '../fixtures/Definitions/Groups';
-import GroupsUsersDefinition from '../fixtures/Definitions/GroupsUsers';
-import UsersDefinition from '../fixtures/Definitions/Users';
-import groupsUserData from '../fixtures/Data/GroupsUser';
-import KeyValues from '../../src/Schema/KeyValues';
+import { OneHatData } from '../../src/OneHatData.js';
+import GroupsDefinition from '../fixtures/Definitions/Groups.js';
+import GroupsUsersDefinition from '../fixtures/Definitions/GroupsUsers.js';
+import UsersDefinition from '../fixtures/Definitions/Users.js';
+import groupsUserData from '../fixtures/Data/GroupsUser.js';
+import KeyValues from '../../src/Schema/KeyValues.js';
 
 
 // NOTE: Cypress can't handle async functions for beforeEach,

package/cypress/integration/Property/Base64.spec.js

@@ -1,4 +1,4 @@
-import PropertyTypes from '../../../src/Property';
+import PropertyTypes from '../../../src/Property/index.js';
 
 describe('Base64Property', function() {
 

package/cypress/integration/Property/Boolean.spec.js

@@ -1,4 +1,4 @@
-import PropertyTypes from '../../../src/Property';
+import PropertyTypes from '../../../src/Property/index.js';
 
 describe('BooleanProperty', function() {
 	

package/cypress/integration/Property/Currency.spec.js

@@ -1,4 +1,4 @@
-import PropertyTypes from '../../../src/Property';
+import PropertyTypes from '../../../src/Property/index.js';
 
 describe('CurrencyProperty', function() {
 	

package/cypress/integration/Property/Date.spec.js

@@ -1,4 +1,4 @@
-import PropertyTypes from '../../../src/Property';
+import PropertyTypes from '../../../src/Property/index.js';
 
 describe('DateProperty', function() {
 	

package/cypress/integration/Property/DateTime.spec.js

@@ -1,4 +1,4 @@
-import PropertyTypes from '../../../src/Property';
+import PropertyTypes from '../../../src/Property/index.js';
 
 describe('DateTimeProperty', function() {
 	

package/cypress/integration/Property/Float.spec.js

@@ -1,4 +1,4 @@
-import PropertyTypes from '../../../src/Property';
+import PropertyTypes from '../../../src/Property/index.js';
 
 describe('FloatProperty', function() {
 	

package/cypress/integration/Property/Integer.spec.js

@@ -1,4 +1,4 @@
-import PropertyTypes from '../../../src/Property';
+import PropertyTypes from '../../../src/Property/index.js';
 
 describe('IntegerProperty', function() {
 	beforeEach(function() {

package/cypress/integration/Property/Json.spec.js

@@ -1,4 +1,4 @@
-import PropertyTypes from '../../../src/Property';
+import PropertyTypes from '../../../src/Property/index.js';
 import _ from 'lodash';
 
 describe('JsonProperty', function() {

package/cypress/integration/Property/Percent.spec.js

@@ -1,4 +1,4 @@
-import PropertyTypes from '../../../src/Property';
+import PropertyTypes from '../../../src/Property/index.js';
 
 describe('PercentProperty', function() {
 	

package/cypress/integration/Property/PercentInt.spec.js

@@ -1,4 +1,4 @@
-import PropertyTypes from '../../../src/Property';
+import PropertyTypes from '../../../src/Property/index.js';
 
 describe('PercentProperty', function() {
 	

package/cypress/integration/Property/Property.spec.js

@@ -1,6 +1,6 @@
-import PropertyTypes from '../../../src/Property';
-import Entity from '../../../src/Entity';
-import Schema from '../../../src/Schema';
+import PropertyTypes from '../../../src/Property/index.js';
+import Entity from '../../../src/Entity.js';
+import Schema from '../../../src/Schema/index.js';
 
 describe('Property', function() {
 	beforeEach(function() {

package/cypress/integration/Property/String.spec.js

@@ -1,4 +1,4 @@
-import PropertyTypes from '../../../src/Property';
+import PropertyTypes from '../../../src/Property/index.js';
 
 describe('StringProperty', function() {
 	

package/cypress/integration/Property/Time.spec.js

@@ -1,4 +1,4 @@
-import PropertyTypes from '../../../src/Property';
+import PropertyTypes from '../../../src/Property/index.js';
 
 describe('TimeProperty', function() {
 	

package/cypress/integration/Property/Uuid.spec.js

@@ -1,4 +1,4 @@
-import PropertyTypes from '../../../src/Property';
+import PropertyTypes from '../../../src/Property/index.js';
 
 describe('UuidProperty', function() {
 

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

@@ -1,5 +1,5 @@
-import RepositoryTypes from '../../../src/Repository';
-import Schema from '../../../src/Schema';
+import RepositoryTypes from '../../../src/Repository/index.js';
+import Schema from '../../../src/Schema/index.js';
 
 describe('OneBuildRepository', function() {
 	beforeEach(function() {

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

@@ -2,9 +2,9 @@ import {
 	default as LocalFromRemoteRepository,
 	MODE_LOCAL_MIRROR,
 	MODE_COMMAND_QUEUE,
-} from '../../../src/Repository/LocalFromRemote';
-import MemoryRepository from '../../../src/Repository/Memory';
-import Schema from '../../../src/Schema';
+} from '../../../src/Repository/LocalFromRemote/index.js';
+import MemoryRepository from '../../../src/Repository/Memory.js';
+import Schema from '../../../src/Schema/index.js';
 import momentAlt from 'relative-time-parser';
 
 describe('LocalFromRemote', function() {

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

@@ -1,5 +1,5 @@
-import RepositoryTypes from '../../../src/Repository';
-import Schema from '../../../src/Schema';
+import RepositoryTypes from '../../../src/Repository/index.js';
+import Schema from '../../../src/Schema/index.js';
 
 describe('MemoryRepository', function() {
 	beforeEach(function() {
@@ -108,6 +108,32 @@ describe('MemoryRepository', function() {
 			expect(result3).to.be.eq(1);
 		});
 
+		it('natsort', function() {
+			const entities = this.repository.getEntitiesOnPage();
+			entities[0].value = 'foo1';
+			entities[1].value = 'foo12';
+			entities[2].value = 'foo2';
+
+			const before = this.repository.getRawValues();
+			expect(before[0].value).to.be.eq('foo1');
+			expect(before[1].value).to.be.eq('foo12');
+			expect(before[2].value).to.be.eq('foo2');
+			expect(before[3].value).to.be.eq('four');
+			expect(before[4].value).to.be.eq('five');
+
+			this.repository.sort({
+				name: 'value',
+				direction: 'ASC',
+				fn: 'natsort',
+			});
+			const after = this.repository.getRawValues();
+			expect(after[0].value).to.be.eq('five');
+			expect(after[1].value).to.be.eq('foo1');
+			expect(after[2].value).to.be.eq('foo2');
+			expect(after[3].value).to.be.eq('foo12');
+			expect(after[4].value).to.be.eq('four');
+		});
+
 	});
 
 	describe('filtering', function() {
@@ -210,7 +236,7 @@ describe('MemoryRepository', function() {
 			expect(result.value).to.be.eq('four');
 		});
 
-		it.only('getIxById', function() {
+		it('getIxById', function() {
 			this.repository.setPage(1);
 			this.repository.setPageSize(2);
 			let ix = this.repository.getIxById(1);

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

@@ -1,7 +1,7 @@
-import { OneHatData } from '../../../src/OneHatData';
-import UsersDefinition from '../../fixtures/Definitions/Users';
-import GroupsDefinition from '../../fixtures/Definitions/Groups';
-import UserData from '../../fixtures/Data/User';
+import { OneHatData } from '../../../src/OneHatData.js';
+import UsersDefinition from '../../fixtures/Definitions/Users.js';
+import GroupsDefinition from '../../fixtures/Definitions/Groups.js';
+import UserData from '../../fixtures/Data/User.js';
 
 const baseURL = Cypress.env('baseURL'),
 	creds = {

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

@@ -1,5 +1,5 @@
-import RepositoryTypes from '../../../src/Repository';
-import Schema from '../../../src/Schema';
+import RepositoryTypes from '../../../src/Repository/index.js';
+import Schema from '../../../src/Schema/index.js';
 
 describe('Repository Base', function() {
 	beforeEach(function() {
@@ -9,8 +9,9 @@ describe('Repository Base', function() {
 				idProperty: 'key',
 				displayProperty: 'value',
 				properties: [
-					{ name: 'key', type: 'int' },
-					{ name: 'value' },
+					{ name: 'key', type: 'int', },
+					{ name: 'value', },
+					{ name: 'json', type: 'json', },
 				],
 				associations: {
 					hasMany: [
@@ -215,6 +216,7 @@ describe('Repository Base', function() {
 				expected = {
 					direction: 'ASC',
 					name: 'value',
+					fn: 'default',
 				};
 			expect(_.isEqual(sorters[0], expected)).to.be.true;
 		});
@@ -229,6 +231,38 @@ describe('Repository Base', function() {
 			expect(didFireChangeSorters).to.be.true;
 		});
 
+		it('sort by non-existant field', function() {
+			let didError = false;
+			try {
+				this.repository.sort('foo');
+			} catch(err) {
+				expect(err).to.match(/Sorting property does not exist/);
+				didError = true;
+			}
+			expect(didError).to.be.true;
+		});
+
+		it('sort by non-sortable field', function() {
+			let didError = false;
+			try {
+				this.repository.sort('json');
+			} catch(err) {
+				expect(err).to.match(/Sorting property type is not sortable/);
+				didError = true;
+			}		
+			expect(didError).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() {

package/cypress/integration/Schema.spec.js

@@ -1,5 +1,5 @@
-import Schema from '../../src/Schema';
-import GroupsUsersDefinition from '../fixtures/Definitions/GroupsUsers';
+import Schema from '../../src/Schema/index.js';
+import GroupsUsersDefinition from '../fixtures/Definitions/GroupsUsers.js';
 
 
 describe('Schema', function() {

package/cypress/support/index.js

@@ -1,2 +1,2 @@
 // https://on.cypress.io/configuration
-import './commands';
+import './commands.js';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@onehat/data",
-	"version": "1.8.34",
+	"version": "1.9.0",
 	"description": "JS data modeling package with adapters for many storage mediums.",
 	"main": "src/index.js",
 	"type": "module",
@@ -37,28 +37,29 @@
 	"dependencies": {
 		"@onehat/events": "^1.6.5",
 		"accounting-js": "^1.1.1",
-		"axios": "^1.2.0",
-		"chrono-node": "^2.4.1",
-		"fast-xml-parser": "^4.0.11",
+		"axios": "^1.2.1",
+		"chrono-node": "^2.4.2",
+		"fast-xml-parser": "^4.0.12",
 		"he": "^1.2.0",
-		"js-base64": "^3.7.2",
+		"js-base64": "^3.7.3",
 		"lodash": "^4.17.21",
 		"moment": "^2.29.4",
+		"natsort": "^2.0.3",
 		"numeral": "^2.0.6",
 		"qs": "^6.11.0",
 		"relative-time-parser": "^1.0.15",
 		"uuid": "^9.0.0"
 	},
 	"devDependencies": {
-		"@babel/core": "^7.20.2",
-		"@babel/node": "^7.20.2",
+		"@babel/core": "^7.20.5",
+		"@babel/node": "^7.20.5",
 		"@babel/plugin-proposal-class-properties": "^7.18.6",
 		"@babel/plugin-transform-runtime": "^7.19.6",
 		"@babel/preset-env": "^7.20.2",
 		"@babel/register": "^7.18.9",
-		"@babel/runtime": "^7.20.0",
-		"@cypress/webpack-preprocessor": "^5.11.0",
-		"babel-loader": "^9.1.0",
+		"@babel/runtime": "^7.20.6",
+		"@cypress/webpack-preprocessor": "^5.16.0",
+		"babel-loader": "^8.0.2",
 		"cypress": "5.2.0",
 		"ink-docstrap": "^1.3.2",
 		"jsdoc": "^4.0.0",

package/src/Repository/Memory.js

@@ -2,6 +2,7 @@
 
 import Repository from './Repository.js';
 import Entity from '../Entity.js';
+import natsort from 'natsort';
 import _ from 'lodash';
 
 const MEM_PREFIX = 'MEM-';
@@ -212,6 +213,13 @@ class MemoryRepository extends Repository {
 			if (_.isFunction(sorter)) {
 				return sorter;
 			}
+			if (sorter.fn && sorter.fn !== 'default') {
+				if (sorter.fn === 'natsort') {
+					return MemoryRepository._getNatSort(sorter);
+				} else if (_.isFunction(sorter.fn)) {
+					return sorter.fn;
+				}
+			}
 			return MemoryRepository._getCompareFunction(sorter);
 		});
 		
@@ -234,6 +242,27 @@ class MemoryRepository extends Repository {
 		this.isSorted = true;
 	}
 
+	/**
+	 * Helper for _applySorters().
+	 * Takes a sorter object and returns a valid compare function for use with Array.prototype.sort
+	 * @param {object} sorter - Object with two properties: 'name' & 'direction'
+	 * @return {function} - Compare function
+	 * @private
+	 * @static
+	 */
+	static _getNatSort = (sorter) => {
+		const
+			name = sorter.name,
+			direction = sorter.direction.toUpperCase(),
+			sortFn = natsort.default({ desc: direction !== 'ASC', });
+		return (entity1, entity2) => {
+			const
+				a = entity1[name],
+				b = entity2[name];
+			return sortFn(a, b);
+		};
+	}
+
 	/**
 	 * Helper for _applySorters().
 	 * Takes a sorter object and returns a valid compare function for use with Array.prototype.sort
@@ -243,10 +272,12 @@ class MemoryRepository extends Repository {
 	 * @static
 	 */
 	static _getCompareFunction = (sorter) => {
-		const name = sorter.name,
+		const
+			name = sorter.name,
 			direction = sorter.direction.toUpperCase();
 		return (entity1, entity2) => {
-			const a = entity1[name],
+			const
+				a = entity1[name],
 				b = entity2[name];
 			if (a === b) {
 				return 0;

package/src/Repository/Repository.js

@@ -1,7 +1,8 @@
 /** @module Repository */
 
 import EventEmitter from '@onehat/events';
-import Entity from '../Entity.js';
+import Entity from '../Entity.js'
+import PropertyTypes from '../Property/index.js';
 import {
 	v4 as uuid,
 } from 'uuid';
@@ -305,7 +306,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)) {
@@ -420,6 +421,9 @@ export default class Repository extends EventEmitter {
 	 * - repository.sort(); // Reverts back to default sort. To actually *clear* all sorters, use this.clearSort()
 	 * - repository.sort('last_name'); // sort by one property, ASC
 	 * - repository.sort('last_name', 'ASC'); // sort by one property
+	 * - repository.sort('last_name', 'ASC', 'natsort'); // sort by one property with specific function
+	 * - repository.sort('last_name', 'ASC', (a, b) => { ... })); // sort by one property with custom function
+	 * - repository.sort((a, b) => { ... }); // sort by custom function
 	 * - repository.sort({ // sort by one property, object notation
 	 * 		name: 'last_name',
 	 * 		direction: 'ASC',
@@ -428,6 +432,7 @@ export default class Repository extends EventEmitter {
 	 * 		{
 	 * 			name: 'last_name',
 	 * 			direction: 'ASC',
+	 * 			fn: 'natsort',
 	 * 		},
 	 * 		{
 	 * 			name: 'first_name',
@@ -438,7 +443,7 @@ export default class Repository extends EventEmitter {
 	 * 
 	 * @return this
 	 */
-	sort = (arg1 = null, arg2 = null) => {
+	sort = (arg1 = null, arg2 = 'ASC', arg3 = null) => {
 		if (this.isDestroyed) {
 			throw Error('this.sort is no longer valid. Repository has been destroyed.');
 		}
@@ -446,18 +451,18 @@ export default class Repository extends EventEmitter {
 		let sorters = [];
 		if (_.isNil(arg1)) {
 			sorters = this.getDefaultSorters();
-		} else if (_.isArray(arg1)) {
-			sorters = arg1;
-		} else if (_.isObject(arg1)) { // includes functions
-			sorters = [arg1];
 		} else if (_.isString(arg1)) {
-			if (_.isNil(arg2)) {
-				arg2 = 'ASC';
-			}
 			sorters = [{
 				name: arg1,
 				direction: arg2,
+				fn: arg3,
 			}];
+		} else if (_.isPlainObject(arg1)) {
+			sorters = [arg1];
+		} else if (_.isArray(arg1)) {
+			sorters = arg1;
+		} else if (_.isFunction(arg1)) {
+			sorters = [arg1];
 		}
 
 		this.setSorters(sorters);
@@ -480,7 +485,8 @@ export default class Repository extends EventEmitter {
 			} else if (!_.isNil(this.schema.model.displayProperty)) {
 				sorters = [{
 					name: this.schema.model.displayProperty,
-					direction: 'ASC'
+					direction: 'ASC',
+					fn: 'default',
 				}];
 			}
 		}
@@ -508,16 +514,14 @@ export default class Repository extends EventEmitter {
 				if (_.isFunction(sorter)) {
 					return; // skip
 				}
-				// This is kind of a hack!
-				// We get the first entity (assuming any exist) and check its properties.
-				// TODO: refactor this so we can check even if no entities exist
-				const entity = this.entities[0];
-				if (entity) {
-					const property = entity.getProperty(sorter.name);
-					if (!property) {
-						throw new Error('Sorting property does not exist.');
-					}
-					if (!property.isSortable) {
+				const propertyDefinition = _.find(this.schema.model.properties, (property) => property.name === sorter.name);
+				if (!propertyDefinition) {
+					throw new Error('Sorting property does not exist.');
+				}
+				const propertyType = propertyDefinition.type;
+				if (propertyType && PropertyTypes[propertyType]) {
+					const propertyInstance = new PropertyTypes[propertyType]();
+					if (!propertyInstance.isSortable) {
 						throw new Error('Sorting property type is not sortable.');
 					}
 				}
@@ -1327,11 +1331,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
@@ -1339,7 +1371,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();

package/src/Schema/Schema.js

@@ -65,9 +65,10 @@ export default class Schema extends EventEmitter {
 
 				/**
 				 * @member {object[]} sorters - Array of sorter definitions.
-				 * Each definition is an object with two keys:
+				 * Each definition is an object with two or three keys:
 				 * - *name* - Name of Property to sort by.
 				 * - *direction* - 'ASC'|'DESC'
+				 * - *fn* (optional) - The sort function to use. Can be either a name like 'nasort', 'default', or a sorting fn
 				 */
 				sorters: [],