@barchart/portfolio-api-common 1.0.48 → 1.0.52

package/lib/processing/PositionContainer.js

@@ -1,4 +1,7 @@
 const array = require('@barchart/common-js/lang/array'),
+	ComparatorBuilder = require('@barchart/common-js/collections/sorting/ComparatorBuilder'),
+	comparators = require('@barchart/common-js/collections/sorting/comparators'),
+	Currency = require('@barchart/common-js/lang/Currency'),
 	assert = require('@barchart/common-js/lang/assert'),
 	is = require('@barchart/common-js/lang/is'),
 	Tree = require('@barchart/common-js/collections/Tree');
@@ -49,8 +52,8 @@ module.exports = (() => {
 				let position = item.position;
 				let symbol = null;
 
-				if (position.instrument && position.instrument.symbol && position.instrument.barchart) {
-					symbol = position.instrument.barchart;
+				if (position.instrument && position.instrument.symbol && position.instrument.symbol.barchart) {
+					symbol = position.instrument.symbol.barchart;
 
 					if (!map.hasOwnProperty(symbol)) {
 						map[symbol] = [ ];
@@ -62,7 +65,7 @@ module.exports = (() => {
 				return map;
 			}, { });
 
-			this._definitions = definitions || [ new PositionGroupDefinition('Totals', i => true, i => 'Totals', [ 'Totals' ]) ];
+			this._definitions = definitions;
 
 			this._tree = new Tree();
 
@@ -77,17 +80,47 @@ module.exports = (() => {
 				const populatedGroups = array.batchBy(items, currentDefinition.keySelector).map((items) => {
 					const first = items[0];
 
-					return new PositionGroup(items, currentDefinition.descriptionSelector(first), currentDefinition.single && items.length === 1);
+					return new PositionGroup(items, currentDefinition.currencySelector(first), currentDefinition.descriptionSelector(first), currentDefinition.single && items.length === 1);
 				});
 
-				const missingGroups = array.difference(currentDefinition.requiredGroups, populatedGroups.map(group => group.description));
+				const missingGroups = array.difference(Object.keys(currentDefinition.requiredGroups), populatedGroups.map(group => group.description));
 
 				const empty = missingGroups.map((description) => {
-					return new PositionGroup([ ], description);
+					return new PositionGroup([ ], currentDefinition.requiredGroups[description].currency, description);
 				});
 
 				const compositeGroups = populatedGroups.concat(empty);
 
+				let builder;
+
+				if (currentDefinition.requiredGroups.length !== 0) {
+					const ordering = currentDefinition.requiredGroups.reduce((map, group, index) => {
+						map[group] = index;
+
+						return map;
+					}, { });
+
+					const getIndex = (description) => {
+						if (ordering.hasOwnProperty(description)) {
+							return ordering[description];
+						} else {
+							return Number.MAX_VALUE;
+						}
+					};
+
+					builder = ComparatorBuilder.startWith((a, b) => {
+						return comparators.compareNumbers(getIndex(a.description), getIndex(b.description));
+					}).thenBy((a, b) => {
+						return comparators.compareStrings(a.description, b.description);
+					});
+				} else {
+					builder = ComparatorBuilder.startWith((a, b) => {
+						return comparators.compareStrings(a.description, b.description);
+					});
+				}
+
+				compositeGroups.sort(builder.toComparator());
+
 				compositeGroups.forEach((group) => {
 					const child = tree.addChild(group);
 

package/lib/processing/PositionGroup.js

@@ -11,9 +11,11 @@ module.exports = (() => {
 	 * @public
 	 */
 	class PositionGroup {
-		constructor(items, description, single) {
-			this._description = description;
+		constructor(items, currency, description, single) {
 			this._items = items;
+			this._currency = currency;
+
+			this._description = description;
 
 			this._single = is.boolean(single) && single;
 
@@ -44,13 +46,21 @@ module.exports = (() => {
 						this._dataFormat.current = null;
 					}
 
-					calculateVariablePriceData(this, item, price);
+					calculateVariablePriceData(this, item);
 				});
 			});
 
 			calculateStaticData(this);
 		}
 
+		get items() {
+			return this._items;
+		}
+
+		get currency() {
+			return this._currency;
+		}
+
 		get description() {
 			return this._description;
 		}
@@ -59,10 +69,6 @@ module.exports = (() => {
 			return this._dataFormat;
 		}
 
-		get items() {
-			return this._items;
-		}
-
 		get single() {
 			return this._single;
 		}
@@ -105,7 +111,7 @@ module.exports = (() => {
 		formatted.basis = format(updates.basis, Currency.USD);
 	}
 
-	function calculateVariablePriceData(group, item, price) {
+	function calculateVariablePriceData(group, item) {
 
 	}
 

package/lib/processing/PositionGroupDefinition.js

@@ -8,11 +8,12 @@ module.exports = (() => {
 	 * @public
 	 */
 	class PositionGroupDefinition {
-		constructor(name, keySelector, descriptionSelector, requiredGroups, single) {
+		constructor(name, keySelector, descriptionSelector, currencySelector, requiredGroups, single) {
 			this._name = name;
 
 			this._keySelector = keySelector;
 			this._descriptionSelector = descriptionSelector;
+			this._currencySelector = currencySelector;
 
 			this._requiredGroups = requiredGroups || [ ];
 			this._single = is.boolean(single) && single;
@@ -30,6 +31,10 @@ module.exports = (() => {
 			return this._descriptionSelector;
 		}
 
+		get currencySelector() {
+			return this._currencySelector;
+		}
+
 		get requiredGroups() {
 			return this._requiredGroups;
 		}

package/lib/processing/PositionItem.js

@@ -1,4 +1,5 @@
 const assert = require('@barchart/common-js/lang/assert'),
+	Decimal = require('@barchart/common-js/lang/Decimal'),
 	Event = require('@barchart/common-js/messaging/Event'),
 	is = require('@barchart/common-js/lang/is');
 
@@ -21,6 +22,18 @@ module.exports = (() => {
 
 			const snapshot = this._position.snapshot;
 
+			this._data.basis = snapshot.basis || Decimal.ZERO;
+
+			/*
+			let market;
+
+			if (position.previous) {
+				market = snapshot.open.multiply(position.previous);
+			} else {
+				market = snapshot.value;
+			}
+			*/
+
 			this._priceChangeEvent = new Event(this);
 		}
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.0.48",
+  "version": "1.0.52",
   "description": "Common classes used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",

package/test/SpecRunner.js

@@ -514,6 +514,9 @@ module.exports = (() => {
 
 },{"@barchart/common-js/lang/Enum":14,"@barchart/common-js/lang/assert":16}],3:[function(require,module,exports){
 const array = require('@barchart/common-js/lang/array'),
+	ComparatorBuilder = require('@barchart/common-js/collections/sorting/ComparatorBuilder'),
+	comparators = require('@barchart/common-js/collections/sorting/comparators'),
+	Currency = require('@barchart/common-js/lang/Currency'),
 	assert = require('@barchart/common-js/lang/assert'),
 	is = require('@barchart/common-js/lang/is'),
 	Tree = require('@barchart/common-js/collections/Tree');
@@ -564,8 +567,8 @@ module.exports = (() => {
 				let position = item.position;
 				let symbol = null;
 
-				if (position.instrument && position.instrument.symbol && position.instrument.barchart) {
-					symbol = position.instrument.barchart;
+				if (position.instrument && position.instrument.symbol && position.instrument.symbol.barchart) {
+					symbol = position.instrument.symbol.barchart;
 
 					if (!map.hasOwnProperty(symbol)) {
 						map[symbol] = [ ];
@@ -577,7 +580,7 @@ module.exports = (() => {
 				return map;
 			}, { });
 
-			this._definitions = definitions || [ new PositionGroupDefinition('Totals', i => true, i => 'Totals', [ 'Totals' ]) ];
+			this._definitions = definitions;
 
 			this._tree = new Tree();
 
@@ -592,17 +595,47 @@ module.exports = (() => {
 				const populatedGroups = array.batchBy(items, currentDefinition.keySelector).map((items) => {
 					const first = items[0];
 
-					return new PositionGroup(items, currentDefinition.descriptionSelector(first), currentDefinition.single && items.length === 1);
+					return new PositionGroup(items, currentDefinition.currencySelector(first), currentDefinition.descriptionSelector(first), currentDefinition.single && items.length === 1);
 				});
 
-				const missingGroups = array.difference(currentDefinition.requiredGroups, populatedGroups.map(group => group.description));
+				const missingGroups = array.difference(Object.keys(currentDefinition.requiredGroups), populatedGroups.map(group => group.description));
 
 				const empty = missingGroups.map((description) => {
-					return new PositionGroup([ ], description);
+					return new PositionGroup([ ], currentDefinition.requiredGroups[description].currency, description);
 				});
 
 				const compositeGroups = populatedGroups.concat(empty);
 
+				let builder;
+
+				if (currentDefinition.requiredGroups.length !== 0) {
+					const ordering = currentDefinition.requiredGroups.reduce((map, group, index) => {
+						map[group] = index;
+
+						return map;
+					}, { });
+
+					const getIndex = (description) => {
+						if (ordering.hasOwnProperty(description)) {
+							return ordering[description];
+						} else {
+							return Number.MAX_VALUE;
+						}
+					};
+
+					builder = ComparatorBuilder.startWith((a, b) => {
+						return comparators.compareNumbers(getIndex(a.description), getIndex(b.description));
+					}).thenBy((a, b) => {
+						return comparators.compareStrings(a.description, b.description);
+					});
+				} else {
+					builder = ComparatorBuilder.startWith((a, b) => {
+						return comparators.compareStrings(a.description, b.description);
+					});
+				}
+
+				compositeGroups.sort(builder.toComparator());
+
 				compositeGroups.forEach((group) => {
 					const child = tree.addChild(group);
 
@@ -651,7 +684,7 @@ module.exports = (() => {
 	return PositionContainer;
 })();
 
-},{"./PositionGroup":4,"./PositionGroupDefinition":5,"./PositionItem":6,"@barchart/common-js/collections/Tree":7,"@barchart/common-js/lang/array":15,"@barchart/common-js/lang/assert":16,"@barchart/common-js/lang/is":18}],4:[function(require,module,exports){
+},{"./PositionGroup":4,"./PositionGroupDefinition":5,"./PositionItem":6,"@barchart/common-js/collections/Tree":7,"@barchart/common-js/collections/sorting/ComparatorBuilder":8,"@barchart/common-js/collections/sorting/comparators":9,"@barchart/common-js/lang/Currency":10,"@barchart/common-js/lang/array":15,"@barchart/common-js/lang/assert":16,"@barchart/common-js/lang/is":18}],4:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
 	Currency = require('@barchart/common-js/lang/Currency'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
@@ -665,9 +698,11 @@ module.exports = (() => {
 	 * @public
 	 */
 	class PositionGroup {
-		constructor(items, description, single) {
-			this._description = description;
+		constructor(items, currency, description, single) {
 			this._items = items;
+			this._currency = currency;
+
+			this._description = description;
 
 			this._single = is.boolean(single) && single;
 
@@ -698,13 +733,21 @@ module.exports = (() => {
 						this._dataFormat.current = null;
 					}
 
-					calculateVariablePriceData(this, item, price);
+					calculateVariablePriceData(this, item);
 				});
 			});
 
 			calculateStaticData(this);
 		}
 
+		get items() {
+			return this._items;
+		}
+
+		get currency() {
+			return this._currency;
+		}
+
 		get description() {
 			return this._description;
 		}
@@ -713,10 +756,6 @@ module.exports = (() => {
 			return this._dataFormat;
 		}
 
-		get items() {
-			return this._items;
-		}
-
 		get single() {
 			return this._single;
 		}
@@ -759,7 +798,7 @@ module.exports = (() => {
 		formatted.basis = format(updates.basis, Currency.USD);
 	}
 
-	function calculateVariablePriceData(group, item, price) {
+	function calculateVariablePriceData(group, item) {
 
 	}
 
@@ -777,11 +816,12 @@ module.exports = (() => {
 	 * @public
 	 */
 	class PositionGroupDefinition {
-		constructor(name, keySelector, descriptionSelector, requiredGroups, single) {
+		constructor(name, keySelector, descriptionSelector, currencySelector, requiredGroups, single) {
 			this._name = name;
 
 			this._keySelector = keySelector;
 			this._descriptionSelector = descriptionSelector;
+			this._currencySelector = currencySelector;
 
 			this._requiredGroups = requiredGroups || [ ];
 			this._single = is.boolean(single) && single;
@@ -799,6 +839,10 @@ module.exports = (() => {
 			return this._descriptionSelector;
 		}
 
+		get currencySelector() {
+			return this._currencySelector;
+		}
+
 		get requiredGroups() {
 			return this._requiredGroups;
 		}
@@ -813,6 +857,7 @@ module.exports = (() => {
 
 },{"@barchart/common-js/lang/assert":16,"@barchart/common-js/lang/is":18}],6:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
+	Decimal = require('@barchart/common-js/lang/Decimal'),
 	Event = require('@barchart/common-js/messaging/Event'),
 	is = require('@barchart/common-js/lang/is');
 
@@ -835,6 +880,18 @@ module.exports = (() => {
 
 			const snapshot = this._position.snapshot;
 
+			this._data.basis = snapshot.basis || Decimal.ZERO;
+
+			/*
+			let market;
+
+			if (position.previous) {
+				market = snapshot.open.multiply(position.previous);
+			} else {
+				market = snapshot.value;
+			}
+			*/
+
 			this._priceChangeEvent = new Event(this);
 		}
 
@@ -872,7 +929,7 @@ module.exports = (() => {
 	return PositionItem;
 })();
 
-},{"@barchart/common-js/lang/assert":16,"@barchart/common-js/lang/is":18,"@barchart/common-js/messaging/Event":19}],7:[function(require,module,exports){
+},{"@barchart/common-js/lang/Decimal":12,"@barchart/common-js/lang/assert":16,"@barchart/common-js/lang/is":18,"@barchart/common-js/messaging/Event":19}],7:[function(require,module,exports){
 'use strict';
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
@@ -5313,9 +5370,9 @@ describe('When a position container data is gathered', () => {
 
 			beforeEach(() => {
 				definitions = [
-					new PositionGroupDefinition('Total', x => true, x => 'Total'),
-					new PositionGroupDefinition('Portfolio', x => x.portfolio.portfolio, x => x.portfolio.name),
-					new PositionGroupDefinition('Position', x => x.position.position, x => x.position.instrument.symbol.barchart)
+					new PositionGroupDefinition('Total', x => true, x => 'Total', x => Currency.CAD),
+					new PositionGroupDefinition('Portfolio', x => x.portfolio.portfolio, x => x.portfolio.name, x => Currency.CAD),
+					new PositionGroupDefinition('Position', x => x.position.position, x => x.position.instrument.symbol.barchart, x =>  x.position.instrument.currency)
 				];
 
 				try {

package/test/specs/processing/PositionContainerSpec.js

@@ -56,9 +56,9 @@ describe('When a position container data is gathered', () => {
 
 			beforeEach(() => {
 				definitions = [
-					new PositionGroupDefinition('Total', x => true, x => 'Total'),
-					new PositionGroupDefinition('Portfolio', x => x.portfolio.portfolio, x => x.portfolio.name),
-					new PositionGroupDefinition('Position', x => x.position.position, x => x.position.instrument.symbol.barchart)
+					new PositionGroupDefinition('Total', x => true, x => 'Total', x => Currency.CAD),
+					new PositionGroupDefinition('Portfolio', x => x.portfolio.portfolio, x => x.portfolio.name, x => Currency.CAD),
+					new PositionGroupDefinition('Position', x => x.position.position, x => x.position.instrument.symbol.barchart, x =>  x.position.instrument.currency)
 				];
 
 				try {