@barchart/portfolio-api-common 1.0.239 → 1.0.243

package/lib/data/TransactionType.js

@@ -37,7 +37,7 @@ module.exports = (() => {
 			this._income = income;
 			this._opening = opening;
 			this._closing = closing;
-			this._fee = fee
+			this._fee = fee;
 		}
 
 		/**

package/lib/formatters/TransactionFormatter.js

@@ -118,7 +118,7 @@ module.exports = (() => {
 	formatters.set(TransactionType.DIVIDEND, (t) => {
 		return {
 			shares: t.snapshot.open,
-			total: t.dividend.amout,
+			total: t.dividend.amount,
 			rate: t.dividend.rate
 		};
 	});

package/lib/processing/PositionContainer.js

@@ -132,7 +132,9 @@ module.exports = (() => {
 			this._forexQuotes = this._forexSymbols.map((symbol) => {
 				return Rate.fromPair(Decimal.ONE, symbol);
 			});
-			
+
+			this._nodes = { };
+
 			this._trees = this._definitions.reduce((map, treeDefinition) => {
 				const tree = new Tree();
 
@@ -247,7 +249,7 @@ module.exports = (() => {
 				Object.keys(this._trees).forEach((key) => {
 					this._trees[key].walk((group, groupNode) => {
 						if (group.definition.type === PositionLevelType.PORTFOLIO && group.key === PositionLevelDefinition.getKeyForPortfolioGroup(portfolio)) {
-							groupNode.sever();
+							severGroupNode.call(this, groupNode);
 						}
 					}, true, false);
 				});
@@ -510,6 +512,32 @@ module.exports = (() => {
 			return findNode(this._trees[name], keys).getChildren().map(node => node.getValue());
 		}
 
+		/**
+		 * Returns the immediate parent {@link PositionGroup} of a {@link PositionGroup}.
+		 *
+		 * @public
+		 * @param {PositionGroup} position
+		 * @returns {PositionGroup|null}
+		 */
+		getParentGroup(group) {
+			assert.argumentIsRequired(group, 'group', PositionGroup, 'PositionGroup');
+
+			return findParentGroup.call(this, group, candidate => true);
+		}
+
+		/**
+		 * Returns the a parent {@link PositionGroup} which represents a portfolio.
+		 *
+		 * @public
+		 * @param {PositionGroup} position
+		 * @returns {PositionGroup|null}
+		 */
+		getParentGroupForPortfolio(group) {
+			assert.argumentIsRequired(group, 'group', PositionGroup, 'PositionGroup');
+
+			return findParentGroup.call(this, group, candidate => candidate.definition.type === PositionLevelType.PORTFOLIO);
+		}
+
 		/**
 		 * Returns all portfolios in the container.
 		 *
@@ -603,6 +631,22 @@ module.exports = (() => {
 		return keys.reduce((tree, key) => tree.findChild(group => group.key === key), tree);
 	}
 
+	function findParentGroup(group, predicate) {
+		const groupNode = this._nodes[group.id];
+
+		let returnRef = null;
+
+		if (groupNode) {
+			const resultNode = groupNode.findParent(candidate => predicate(candidate));
+
+			if (resultNode) {
+				returnRef = resultNode.getValue();
+			}
+		}
+
+		return returnRef;
+	}
+
 	function extractSymbolForBarchart(position) {
 		if (position.instrument && position.instrument.symbol && position.instrument.symbol.barchart) {
 			return position.instrument.symbol.barchart;
@@ -694,8 +738,6 @@ module.exports = (() => {
 			return;
 		}
 
-		const parent = parentTree.getValue() || null;
-
 		const levelDefinition = levelDefinitions[0];
 
 		const populatedObjects = array.groupBy(items, levelDefinition.keySelector);
@@ -703,7 +745,7 @@ module.exports = (() => {
 			const items = populatedObjects[key];
 			const first = items[0];
 
-			list.push(new PositionGroup(this, parent, levelDefinition, items, levelDefinition.currencySelector(first), key, levelDefinition.descriptionSelector(first), levelDefinition.aggregateCash));
+			list.push(new PositionGroup(this, levelDefinition, items, levelDefinition.currencySelector(first), key, levelDefinition.descriptionSelector(first), levelDefinition.aggregateCash));
 
 			return list;
 		}, [ ]);
@@ -716,7 +758,7 @@ module.exports = (() => {
 			});
 
 		const empty = missingGroups.map((group) => {
-			return new PositionGroup(this, parent, levelDefinition, [ ], group.currency, group.key, group.description);
+			return new PositionGroup(this, levelDefinition, [ ], group.currency, group.key, group.description);
 		});
 
 		const compositeGroups = populatedGroups.concat(empty);
@@ -754,6 +796,8 @@ module.exports = (() => {
 		compositeGroups.forEach((group) => {
 			const childTree = parentTree.addChild(group);
 
+			this._nodes[group.id] = childTree;
+
 			initializeGroupObservers.call(this, childTree, treeDefinition);
 
 			createGroups.call(this, childTree, group.items, treeDefinition, array.dropLeft(levelDefinitions));
@@ -881,7 +925,7 @@ module.exports = (() => {
 		Object.keys(this._trees).forEach((key) => {
 			this._trees[key].walk((group, groupNode) => {
 				if (group.definition.type === PositionLevelType.POSITION && group.key === positionItem.position.position) {
-					groupNode.sever();
+					severGroupNode.call(this, groupNode);
 				}
 			}, true, false);
 		});
@@ -889,5 +933,10 @@ module.exports = (() => {
 		positionItem.dispose();
 	}
 
+	function severGroupNode(groupNodeToSever) {
+		groupNodeToSever.sever();
+		groupNodeToSever.walk(group => delete this._nodes[group.id], false, true);
+	}
+
 	return PositionContainer;
 })();

package/lib/processing/PositionGroup.js

@@ -25,7 +25,6 @@ module.exports = (() => {
 	 *
 	 * @public
 	 * @param {PositionContainer} container
-	 * @param {PositionGroup|null} parent
 	 * @param {LevelDefinition} definition
 	 * @param {Array.<PositionItem>} items
 	 * @param {Currency} currency
@@ -34,12 +33,11 @@ module.exports = (() => {
 	 * @param {Boolean=} aggregateCash
 	 */
 	class PositionGroup {
-		constructor(container, parent, definition, items, currency, key, description, aggregateCash) {
+		constructor(container, definition, items, currency, key, description, aggregateCash) {
 			this._id = counter++;
 
 			this._definition = definition;
 			this._container = container;
-			this._parent = parent || null;
 
 			this._items = items;
 			this._currency = currency || Currency.CAD;
@@ -122,6 +120,7 @@ module.exports = (() => {
 			this._dataActual.income = null;
 			this._dataActual.market = null;
 			this._dataActual.marketPercent = null;
+			this._dataActual.marketPercentPortfolio = null;
 			this._dataActual.unrealized = null;
 			this._dataActual.unrealizedToday = null;
 			this._dataActual.total = null;
@@ -137,6 +136,7 @@ module.exports = (() => {
 			this._dataFormat.income = null;
 			this._dataFormat.market = null;
 			this._dataFormat.marketPercent = null;
+			this._dataFormat.marketPercentPortfolio = null;
 			this._dataFormat.marketDirection = null;
 			this._dataFormat.unrealized = null;
 			this._dataFormat.unrealizedPercent = null;
@@ -146,7 +146,7 @@ module.exports = (() => {
 			this._dataFormat.total = null;
 			this._dataFormat.totalNegative = false;
 			this._dataFormat.summaryTotalCurrent = null;
-			this._dataActual.summaryTotalCurrentNegative = false;
+			this._dataFormat.summaryTotalCurrentNegative = false;
 			this._dataFormat.summaryTotalPrevious = null;
 			this._dataFormat.summaryTotalPreviousNegative = false;
 			this._dataFormat.summaryTotalPrevious2 = null;
@@ -670,7 +670,6 @@ module.exports = (() => {
 			return;
 		}
 
-		const parent = group._parent;
 		const currency = group.currency;
 
 		const actual = group._dataActual;
@@ -761,38 +760,44 @@ module.exports = (() => {
 			return;
 		}
 
-		const parent = group._parent;
-		const excluded = group._excluded;
-
 		const actual = group._dataActual;
 		const format = group._dataFormat;
-		
-		let marketPercent;
-		
-		if (parent !== null && !excluded) {
-			const parentData = parent._dataActual;
+		const excluded = group._excluded;
+
+		const portfolioParent = group._container.getParentGroupForPortfolio(group);
+
+		const calculatePercent = (parent) => {
+			let marketPercent;
+
+			if (parent !== null && !excluded) {
+				const parentData = parent._dataActual;
+
+				if (parentData.marketAbsolute !== null && !parentData.marketAbsolute.getIsZero()) {
+					let numerator;
 
-			if (parentData.marketAbsolute !== null && !parentData.marketAbsolute.getIsZero()) {
-				let numerator;
+					if (group.currency !== parent.currency) {
+						numerator = Rate.convert(actual.marketAbsolute, group.currency, parent.currency, ...rates);
+					} else {
+						numerator = actual.marketAbsolute;
+					}
 
-				if (group.currency !== parent.currency) {
-					numerator = Rate.convert(actual.marketAbsolute, group.currency, parent.currency, ...rates);
+					marketPercent = numerator.divide(parentData.marketAbsolute);
 				} else {
-					numerator = actual.marketAbsolute;
+					marketPercent = null;
 				}
-
-				marketPercent = numerator.divide(parentData.marketAbsolute);
 			} else {
 				marketPercent = null;
 			}
-		} else {
-			marketPercent = null;
-		}
 
-		actual.marketPercent = marketPercent;
-		
+			return marketPercent;
+		};
+
+		actual.marketPercent = calculatePercent(group._container.getParentGroup(group));
 		format.marketPercent = formatPercent(actual.marketPercent, 2);
-		
+
+		actual.marketPercentPortfolio = calculatePercent(group._container.getParentGroupForPortfolio(group));
+		format.marketPercentPortfolio = formatPercent(actual.marketPercentPortfolio, 2);
+
 		if (!silent) {
 			group._marketPercentChangeEvent.fire(group);
 		}

package/package.json

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

package/test/SpecRunner.js

@@ -482,7 +482,7 @@ module.exports = (() => {
 			this._income = income;
 			this._opening = opening;
 			this._closing = closing;
-			this._fee = fee
+			this._fee = fee;
 		}
 
 		/**
@@ -931,7 +931,9 @@ module.exports = (() => {
 			this._forexQuotes = this._forexSymbols.map((symbol) => {
 				return Rate.fromPair(Decimal.ONE, symbol);
 			});
-			
+
+			this._nodes = { };
+
 			this._trees = this._definitions.reduce((map, treeDefinition) => {
 				const tree = new Tree();
 
@@ -1046,7 +1048,7 @@ module.exports = (() => {
 				Object.keys(this._trees).forEach((key) => {
 					this._trees[key].walk((group, groupNode) => {
 						if (group.definition.type === PositionLevelType.PORTFOLIO && group.key === PositionLevelDefinition.getKeyForPortfolioGroup(portfolio)) {
-							groupNode.sever();
+							severGroupNode.call(this, groupNode);
 						}
 					}, true, false);
 				});
@@ -1309,6 +1311,32 @@ module.exports = (() => {
 			return findNode(this._trees[name], keys).getChildren().map(node => node.getValue());
 		}
 
+		/**
+		 * Returns the immediate parent {@link PositionGroup} of a {@link PositionGroup}.
+		 *
+		 * @public
+		 * @param {PositionGroup} position
+		 * @returns {PositionGroup|null}
+		 */
+		getParentGroup(group) {
+			assert.argumentIsRequired(group, 'group', PositionGroup, 'PositionGroup');
+
+			return findParentGroup.call(this, group, candidate => true);
+		}
+
+		/**
+		 * Returns the a parent {@link PositionGroup} which represents a portfolio.
+		 *
+		 * @public
+		 * @param {PositionGroup} position
+		 * @returns {PositionGroup|null}
+		 */
+		getParentGroupForPortfolio(group) {
+			assert.argumentIsRequired(group, 'group', PositionGroup, 'PositionGroup');
+
+			return findParentGroup.call(this, group, candidate => candidate.definition.type === PositionLevelType.PORTFOLIO);
+		}
+
 		/**
 		 * Returns all portfolios in the container.
 		 *
@@ -1402,6 +1430,22 @@ module.exports = (() => {
 		return keys.reduce((tree, key) => tree.findChild(group => group.key === key), tree);
 	}
 
+	function findParentGroup(group, predicate) {
+		const groupNode = this._nodes[group.id];
+
+		let returnRef = null;
+
+		if (groupNode) {
+			const resultNode = groupNode.findParent(candidate => predicate(candidate));
+
+			if (resultNode) {
+				returnRef = resultNode.getValue();
+			}
+		}
+
+		return returnRef;
+	}
+
 	function extractSymbolForBarchart(position) {
 		if (position.instrument && position.instrument.symbol && position.instrument.symbol.barchart) {
 			return position.instrument.symbol.barchart;
@@ -1493,8 +1537,6 @@ module.exports = (() => {
 			return;
 		}
 
-		const parent = parentTree.getValue() || null;
-
 		const levelDefinition = levelDefinitions[0];
 
 		const populatedObjects = array.groupBy(items, levelDefinition.keySelector);
@@ -1502,7 +1544,7 @@ module.exports = (() => {
 			const items = populatedObjects[key];
 			const first = items[0];
 
-			list.push(new PositionGroup(this, parent, levelDefinition, items, levelDefinition.currencySelector(first), key, levelDefinition.descriptionSelector(first), levelDefinition.aggregateCash));
+			list.push(new PositionGroup(this, levelDefinition, items, levelDefinition.currencySelector(first), key, levelDefinition.descriptionSelector(first), levelDefinition.aggregateCash));
 
 			return list;
 		}, [ ]);
@@ -1515,7 +1557,7 @@ module.exports = (() => {
 			});
 
 		const empty = missingGroups.map((group) => {
-			return new PositionGroup(this, parent, levelDefinition, [ ], group.currency, group.key, group.description);
+			return new PositionGroup(this, levelDefinition, [ ], group.currency, group.key, group.description);
 		});
 
 		const compositeGroups = populatedGroups.concat(empty);
@@ -1553,6 +1595,8 @@ module.exports = (() => {
 		compositeGroups.forEach((group) => {
 			const childTree = parentTree.addChild(group);
 
+			this._nodes[group.id] = childTree;
+
 			initializeGroupObservers.call(this, childTree, treeDefinition);
 
 			createGroups.call(this, childTree, group.items, treeDefinition, array.dropLeft(levelDefinitions));
@@ -1680,7 +1724,7 @@ module.exports = (() => {
 		Object.keys(this._trees).forEach((key) => {
 			this._trees[key].walk((group, groupNode) => {
 				if (group.definition.type === PositionLevelType.POSITION && group.key === positionItem.position.position) {
-					groupNode.sever();
+					severGroupNode.call(this, groupNode);
 				}
 			}, true, false);
 		});
@@ -1688,6 +1732,11 @@ module.exports = (() => {
 		positionItem.dispose();
 	}
 
+	function severGroupNode(groupNodeToSever) {
+		groupNodeToSever.sever();
+		groupNodeToSever.walk(group => delete this._nodes[group.id], false, true);
+	}
+
 	return PositionContainer;
 })();
 
@@ -1719,7 +1768,6 @@ module.exports = (() => {
 	 *
 	 * @public
 	 * @param {PositionContainer} container
-	 * @param {PositionGroup|null} parent
 	 * @param {LevelDefinition} definition
 	 * @param {Array.<PositionItem>} items
 	 * @param {Currency} currency
@@ -1728,12 +1776,11 @@ module.exports = (() => {
 	 * @param {Boolean=} aggregateCash
 	 */
 	class PositionGroup {
-		constructor(container, parent, definition, items, currency, key, description, aggregateCash) {
+		constructor(container, definition, items, currency, key, description, aggregateCash) {
 			this._id = counter++;
 
 			this._definition = definition;
 			this._container = container;
-			this._parent = parent || null;
 
 			this._items = items;
 			this._currency = currency || Currency.CAD;
@@ -1816,6 +1863,7 @@ module.exports = (() => {
 			this._dataActual.income = null;
 			this._dataActual.market = null;
 			this._dataActual.marketPercent = null;
+			this._dataActual.marketPercentPortfolio = null;
 			this._dataActual.unrealized = null;
 			this._dataActual.unrealizedToday = null;
 			this._dataActual.total = null;
@@ -1831,6 +1879,7 @@ module.exports = (() => {
 			this._dataFormat.income = null;
 			this._dataFormat.market = null;
 			this._dataFormat.marketPercent = null;
+			this._dataFormat.marketPercentPortfolio = null;
 			this._dataFormat.marketDirection = null;
 			this._dataFormat.unrealized = null;
 			this._dataFormat.unrealizedPercent = null;
@@ -1840,7 +1889,7 @@ module.exports = (() => {
 			this._dataFormat.total = null;
 			this._dataFormat.totalNegative = false;
 			this._dataFormat.summaryTotalCurrent = null;
-			this._dataActual.summaryTotalCurrentNegative = false;
+			this._dataFormat.summaryTotalCurrentNegative = false;
 			this._dataFormat.summaryTotalPrevious = null;
 			this._dataFormat.summaryTotalPreviousNegative = false;
 			this._dataFormat.summaryTotalPrevious2 = null;
@@ -2364,7 +2413,6 @@ module.exports = (() => {
 			return;
 		}
 
-		const parent = group._parent;
 		const currency = group.currency;
 
 		const actual = group._dataActual;
@@ -2455,38 +2503,44 @@ module.exports = (() => {
 			return;
 		}
 
-		const parent = group._parent;
-		const excluded = group._excluded;
-
 		const actual = group._dataActual;
 		const format = group._dataFormat;
-		
-		let marketPercent;
-		
-		if (parent !== null && !excluded) {
-			const parentData = parent._dataActual;
+		const excluded = group._excluded;
+
+		const portfolioParent = group._container.getParentGroupForPortfolio(group);
+
+		const calculatePercent = (parent) => {
+			let marketPercent;
+
+			if (parent !== null && !excluded) {
+				const parentData = parent._dataActual;
 
-			if (parentData.marketAbsolute !== null && !parentData.marketAbsolute.getIsZero()) {
-				let numerator;
+				if (parentData.marketAbsolute !== null && !parentData.marketAbsolute.getIsZero()) {
+					let numerator;
 
-				if (group.currency !== parent.currency) {
-					numerator = Rate.convert(actual.marketAbsolute, group.currency, parent.currency, ...rates);
+					if (group.currency !== parent.currency) {
+						numerator = Rate.convert(actual.marketAbsolute, group.currency, parent.currency, ...rates);
+					} else {
+						numerator = actual.marketAbsolute;
+					}
+
+					marketPercent = numerator.divide(parentData.marketAbsolute);
 				} else {
-					numerator = actual.marketAbsolute;
+					marketPercent = null;
 				}
-
-				marketPercent = numerator.divide(parentData.marketAbsolute);
 			} else {
 				marketPercent = null;
 			}
-		} else {
-			marketPercent = null;
-		}
 
-		actual.marketPercent = marketPercent;
-		
+			return marketPercent;
+		};
+
+		actual.marketPercent = calculatePercent(group._container.getParentGroup(group));
 		format.marketPercent = formatPercent(actual.marketPercent, 2);
-		
+
+		actual.marketPercentPortfolio = calculatePercent(group._container.getParentGroupForPortfolio(group));
+		format.marketPercentPortfolio = formatPercent(actual.marketPercentPortfolio, 2);
+
 		if (!silent) {
 			group._marketPercentChangeEvent.fire(group);
 		}