@barchart/portfolio-api-common 1.0.98 → 1.0.102

package/lib/processing/PositionContainer.js

@@ -136,16 +136,22 @@ module.exports = (() => {
 					const levelDefinition = levelDefinitions[0];
 
 					const populatedObjects = array.groupBy(items, levelDefinition.keySelector);
-					const populatedGroups = Object.keys(populatedObjects).map(key => populatedObjects[key]).map((items) => {
+					const populatedGroups = Object.keys(populatedObjects).reduce((list, key) => {
+						const items = populatedObjects[key];
 						const first = items[0];
 
-						return new PositionGroup(this, parent, items, levelDefinition.currencySelector(first), levelDefinition.descriptionSelector(first), levelDefinition.single && items.length === 1);
-					});
+						list.push(new PositionGroup(this, parent, items, levelDefinition.currencySelector(first), key, levelDefinition.descriptionSelector(first), levelDefinition.single && items.length === 1));
+
+						return list;
+					}, [ ]);
 
-					const missingGroups = array.difference(levelDefinition.requiredGroups.map(group => group.description), populatedGroups.map(group => group.description));
+					const missingGroups = array.difference(levelDefinition.requiredGroups.map(group => group.key), populatedGroups.map(group => group.key))
+						.map((key) => {
+							return levelDefinition.requiredGroups.find(g => g.key === key);
+						});
 
-					const empty = missingGroups.map((description) => {
-						return new PositionGroup(this, parent, [ ], levelDefinition.requiredGroups.find(group => group.description === description).currency, description);
+					const empty = missingGroups.map((group) => {
+						return new PositionGroup(this, parent, [ ], group.currency, group.key, group.description);
 					});
 
 					const compositeGroups = populatedGroups.concat(empty);
@@ -268,11 +274,7 @@ module.exports = (() => {
 	}
 
 	function findNode(tree, keys) {
-		return keys.reduce((tree, key) => {
-			tree = tree.findChild(group => group.description === key);
-
-			return tree;
-		}, tree);
+		return keys.reduce((tree, key) => tree.findChild(group => group.key === key), tree);
 	}
 
 	function getSummaryArray(ranges) {

package/lib/processing/PositionGroup.js

@@ -12,13 +12,14 @@ module.exports = (() => {
 	 * @public
 	 */
 	class PositionGroup {
-		constructor(container, parent, items, currency, description, single) {
+		constructor(container, parent, items, currency, key, description, single) {
 			this._container = container;
 			this._parent = parent || null;
 
 			this._items = items;
 			this._currency = currency || Currency.CAD;
 
+			this._key = key;
 			this._description = description;
 
 			this._single = is.boolean(single) && single;
@@ -30,9 +31,16 @@ module.exports = (() => {
 
 			this._dataFormat = { };
 			this._dataActual = { };
-			
+
+			this._dataFormat.key = this._key;
 			this._dataFormat.description = this._description;
-			
+
+			if (this._single) {
+				this._dataFormat.instrument = items[0].position.instrument;
+			} else {
+				this._dataFormat.instrument = null;
+			}
+
 			this._dataActual.currentPrice = null;
 			this._dataActual.previousPrice = null;
 			this._dataActual.basis = null;
@@ -79,16 +87,20 @@ module.exports = (() => {
 			this.refresh();
 		}
 
-		get items() {
-			return this._items;
+		get key() {
+			return this._key;
+		}
+
+		get description() {
+			return this._description;
 		}
 
 		get currency() {
 			return this._currency;
 		}
 
-		get description() {
-			return this._description;
+		get items() {
+			return this._items;
 		}
 
 		get data() {

package/lib/processing/definitions/PositionLevelDefinition.js

@@ -14,7 +14,7 @@ module.exports = (() => {
 	 * @param {PositionLevelDefinition~keySelector} keySelector
 	 * @param {PositionLevelDefinition~descriptionSelector} descriptionSelector
 	 * @param {PositionLevelDefinition~currencySelector} currencySelector
-	 * @param {Array.<String>=} requiredGroups
+	 * @param {Array.<PositionLevelDefinition~RequiredGroup>=} requiredGroups
 	 * @param {Boolean=} single
 	 */
 	class PositionLevelDefinition {
@@ -139,5 +139,16 @@ module.exports = (() => {
 	 * @returns {Currency}
 	 */
 
+	/**
+	 * The data required to construct a group.
+	 *
+	 * @public
+	 * @typedef PositionLevelDefinition~RequiredGroup
+	 * @type {Object}
+	 * @property {String} key
+	 * @property {String} description
+	 * @property {Currency} currency
+	 */
+
 	return PositionLevelDefinition;
 })();

package/package.json

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

package/test/SpecRunner.js

@@ -852,16 +852,22 @@ module.exports = (() => {
 					const levelDefinition = levelDefinitions[0];
 
 					const populatedObjects = array.groupBy(items, levelDefinition.keySelector);
-					const populatedGroups = Object.keys(populatedObjects).map(key => populatedObjects[key]).map((items) => {
+					const populatedGroups = Object.keys(populatedObjects).reduce((list, key) => {
+						const items = populatedObjects[key];
 						const first = items[0];
 
-						return new PositionGroup(this, parent, items, levelDefinition.currencySelector(first), levelDefinition.descriptionSelector(first), levelDefinition.single && items.length === 1);
-					});
+						list.push(new PositionGroup(this, parent, items, levelDefinition.currencySelector(first), key, levelDefinition.descriptionSelector(first), levelDefinition.single && items.length === 1));
+
+						return list;
+					}, [ ]);
 
-					const missingGroups = array.difference(levelDefinition.requiredGroups.map(group => group.description), populatedGroups.map(group => group.description));
+					const missingGroups = array.difference(levelDefinition.requiredGroups.map(group => group.key), populatedGroups.map(group => group.key))
+						.map((key) => {
+							return levelDefinition.requiredGroups.find(g => g.key === key);
+						});
 
-					const empty = missingGroups.map((description) => {
-						return new PositionGroup(this, parent, [ ], levelDefinition.requiredGroups.find(group => group.description === description).currency, description);
+					const empty = missingGroups.map((group) => {
+						return new PositionGroup(this, parent, [ ], group.currency, group.key, group.description);
 					});
 
 					const compositeGroups = populatedGroups.concat(empty);
@@ -984,11 +990,7 @@ module.exports = (() => {
 	}
 
 	function findNode(tree, keys) {
-		return keys.reduce((tree, key) => {
-			tree = tree.findChild(group => group.description === key);
-
-			return tree;
-		}, tree);
+		return keys.reduce((tree, key) => tree.findChild(group => group.key === key), tree);
 	}
 
 	function getSummaryArray(ranges) {
@@ -1013,13 +1015,14 @@ module.exports = (() => {
 	 * @public
 	 */
 	class PositionGroup {
-		constructor(container, parent, items, currency, description, single) {
+		constructor(container, parent, items, currency, key, description, single) {
 			this._container = container;
 			this._parent = parent || null;
 
 			this._items = items;
 			this._currency = currency || Currency.CAD;
 
+			this._key = key;
 			this._description = description;
 
 			this._single = is.boolean(single) && single;
@@ -1031,9 +1034,16 @@ module.exports = (() => {
 
 			this._dataFormat = { };
 			this._dataActual = { };
-			
+
+			this._dataFormat.key = this._key;
 			this._dataFormat.description = this._description;
-			
+
+			if (this._single) {
+				this._dataFormat.instrument = items[0].position.instrument;
+			} else {
+				this._dataFormat.instrument = null;
+			}
+
 			this._dataActual.currentPrice = null;
 			this._dataActual.previousPrice = null;
 			this._dataActual.basis = null;
@@ -1080,16 +1090,20 @@ module.exports = (() => {
 			this.refresh();
 		}
 
-		get items() {
-			return this._items;
+		get key() {
+			return this._key;
+		}
+
+		get description() {
+			return this._description;
 		}
 
 		get currency() {
 			return this._currency;
 		}
 
-		get description() {
-			return this._description;
+		get items() {
+			return this._items;
 		}
 
 		get data() {
@@ -1570,7 +1584,7 @@ module.exports = (() => {
 	 * @param {PositionLevelDefinition~keySelector} keySelector
 	 * @param {PositionLevelDefinition~descriptionSelector} descriptionSelector
 	 * @param {PositionLevelDefinition~currencySelector} currencySelector
-	 * @param {Array.<String>=} requiredGroups
+	 * @param {Array.<PositionLevelDefinition~RequiredGroup>=} requiredGroups
 	 * @param {Boolean=} single
 	 */
 	class PositionLevelDefinition {
@@ -1695,6 +1709,17 @@ module.exports = (() => {
 	 * @returns {Currency}
 	 */
 
+	/**
+	 * The data required to construct a group.
+	 *
+	 * @public
+	 * @typedef PositionLevelDefinition~RequiredGroup
+	 * @type {Object}
+	 * @property {String} key
+	 * @property {String} description
+	 * @property {Currency} currency
+	 */
+
 	return PositionLevelDefinition;
 })();
 
@@ -6178,18 +6203,18 @@ describe('When a position container data is gathered', () => {
 		beforeEach(() => {
 			portfolios = [
 				{
-					portfolio: 'a',
+					portfolio: 'My First Portfolio',
 					name: 'a'
 				}, {
-					portfolio: 'b',
+					portfolio: 'My Second Portfolio',
 					name: 'b'
 				}
 			];
 
 			positions = [
-				getPosition('a', 'AAPL'),
-				getPosition('b', 'AAPL'),
-				getPosition('b', 'TSLA')
+				getPosition('My First Portfolio', 'AAPL'),
+				getPosition('My Second Portfolio', 'AAPL'),
+				getPosition('My Second Portfolio', 'TSLA')
 			];
 
 			summaries = [ ];
@@ -6203,7 +6228,7 @@ describe('When a position container data is gathered', () => {
 			beforeEach(() => {
 				definitions = [
 					new PositionTreeDefinition(name = 'the only tree', [
-						new PositionLevelDefinition('Total', x => true, x => 'Total', x => Currency.CAD),
+						new PositionLevelDefinition('Total', x => 'totals', x => 'Total', x => Currency.CAD),
 						new PositionLevelDefinition('Portfolio', x => x.portfolio.portfolio, x => x.portfolio.name, x => Currency.CAD),
 						new PositionLevelDefinition('Position', x => x.position.position, x => x.position.instrument.symbol.barchart, x =>  x.position.instrument.currency)
 					])
@@ -6217,27 +6242,27 @@ describe('When a position container data is gathered', () => {
 			});
 
 			it('the "Total" group should have two children groups', () => {
-				expect(container.getGroups(name, [ 'Total' ]).length).toEqual(2);
+				expect(container.getGroups(name, [ 'totals' ]).length).toEqual(2);
 			});
 
 			it('the "Total" group should have three items', () => {
-				expect(container.getGroup(name, [ 'Total' ]).items.length).toEqual(3);
+				expect(container.getGroup(name, [ 'totals' ]).items.length).toEqual(3);
 			});
 
 			it('The "a" portfolio group should have one child group', () => {
-				expect(container.getGroups(name, [ 'Total', 'a' ]).length).toEqual(1);
+				expect(container.getGroups(name, [ 'totals', 'My First Portfolio' ]).length).toEqual(1);
 			});
 
 			it('the "a" portfolio group should have one item', () => {
-				expect(container.getGroup(name, [ 'Total', 'a' ]).items.length).toEqual(1);
+				expect(container.getGroup(name, [ 'totals', 'My First Portfolio' ]).items.length).toEqual(1);
 			});
 
 			it('The "b" portfolio group should have two child groups', () => {
-				expect(container.getGroups(name, [ 'Total', 'b' ]).length).toEqual(2);
+				expect(container.getGroups(name, [ 'totals', 'My Second Portfolio' ]).length).toEqual(2);
 			});
 
 			it('the "b" portfolio group should have two items', () => {
-				expect(container.getGroup(name, [ 'Total', 'b' ]).items.length).toEqual(2);
+				expect(container.getGroup(name, [ 'totals', 'My Second Portfolio' ]).items.length).toEqual(2);
 			});
 		});
 	});

package/test/specs/processing/PositionContainerSpec.js

@@ -41,18 +41,18 @@ describe('When a position container data is gathered', () => {
 		beforeEach(() => {
 			portfolios = [
 				{
-					portfolio: 'a',
+					portfolio: 'My First Portfolio',
 					name: 'a'
 				}, {
-					portfolio: 'b',
+					portfolio: 'My Second Portfolio',
 					name: 'b'
 				}
 			];
 
 			positions = [
-				getPosition('a', 'AAPL'),
-				getPosition('b', 'AAPL'),
-				getPosition('b', 'TSLA')
+				getPosition('My First Portfolio', 'AAPL'),
+				getPosition('My Second Portfolio', 'AAPL'),
+				getPosition('My Second Portfolio', 'TSLA')
 			];
 
 			summaries = [ ];
@@ -66,7 +66,7 @@ describe('When a position container data is gathered', () => {
 			beforeEach(() => {
 				definitions = [
 					new PositionTreeDefinition(name = 'the only tree', [
-						new PositionLevelDefinition('Total', x => true, x => 'Total', x => Currency.CAD),
+						new PositionLevelDefinition('Total', x => 'totals', x => 'Total', x => Currency.CAD),
 						new PositionLevelDefinition('Portfolio', x => x.portfolio.portfolio, x => x.portfolio.name, x => Currency.CAD),
 						new PositionLevelDefinition('Position', x => x.position.position, x => x.position.instrument.symbol.barchart, x =>  x.position.instrument.currency)
 					])
@@ -80,27 +80,27 @@ describe('When a position container data is gathered', () => {
 			});
 
 			it('the "Total" group should have two children groups', () => {
-				expect(container.getGroups(name, [ 'Total' ]).length).toEqual(2);
+				expect(container.getGroups(name, [ 'totals' ]).length).toEqual(2);
 			});
 
 			it('the "Total" group should have three items', () => {
-				expect(container.getGroup(name, [ 'Total' ]).items.length).toEqual(3);
+				expect(container.getGroup(name, [ 'totals' ]).items.length).toEqual(3);
 			});
 
 			it('The "a" portfolio group should have one child group', () => {
-				expect(container.getGroups(name, [ 'Total', 'a' ]).length).toEqual(1);
+				expect(container.getGroups(name, [ 'totals', 'My First Portfolio' ]).length).toEqual(1);
 			});
 
 			it('the "a" portfolio group should have one item', () => {
-				expect(container.getGroup(name, [ 'Total', 'a' ]).items.length).toEqual(1);
+				expect(container.getGroup(name, [ 'totals', 'My First Portfolio' ]).items.length).toEqual(1);
 			});
 
 			it('The "b" portfolio group should have two child groups', () => {
-				expect(container.getGroups(name, [ 'Total', 'b' ]).length).toEqual(2);
+				expect(container.getGroups(name, [ 'totals', 'My Second Portfolio' ]).length).toEqual(2);
 			});
 
 			it('the "b" portfolio group should have two items', () => {
-				expect(container.getGroup(name, [ 'Total', 'b' ]).items.length).toEqual(2);
+				expect(container.getGroup(name, [ 'totals', 'My Second Portfolio' ]).items.length).toEqual(2);
 			});
 		});
 	});