@barchart/portfolio-api-common 1.0.114 → 1.0.118

package/lib/processing/PositionGroup.js

@@ -59,6 +59,7 @@ module.exports = (() => {
 			this._dataActual.income = null;
 			this._dataActual.market = null;
 			this._dataActual.marketPercent = null;
+			this._dataActual.unrealized = null;
 			this._dataActual.unrealizedToday = null;
 			this._dataActual.total = null;
 			this._dataActual.summaryTotalCurrent = null;
@@ -72,6 +73,9 @@ module.exports = (() => {
 			this._dataFormat.market = null;
 			this._dataFormat.marketPercent = null;
 			this._dataFormat.marketDirection = null;
+			this._dataFormat.unrealized = null;
+			this._dataFormat.unrealizedPercent = null;
+			this._dataFormat.unrealizedNegative = false;
 			this._dataFormat.unrealizedToday = null;
 			this._dataFormat.unrealizedTodayNegative = false;
 			this._dataFormat.total = null;
@@ -203,7 +207,7 @@ module.exports = (() => {
 
 	function formatPercent(decimal, precision) {
 		if (decimal !== null) {
-			return formatDecimal(decimal.multiply(100), precision);
+			return formatDecimal(decimal.multiply(100), precision) + '%';
 		} else {
 			return '—';
 		}
@@ -228,6 +232,7 @@ module.exports = (() => {
 		let updates = items.reduce((updates, item) => {
 			updates.basis = updates.basis.add(item.data.basis);
 			updates.realized = updates.realized.add(item.data.realized);
+			updates.unrealized = updates.unrealized.add(item.data.unrealized);
 			updates.income = updates.income.add(item.data.income);
 			updates.summaryTotalCurrent = updates.summaryTotalCurrent.add(item.data.summaryTotalCurrent);
 			updates.summaryTotalPrevious = updates.summaryTotalPrevious.add(item.data.summaryTotalPrevious);
@@ -236,6 +241,7 @@ module.exports = (() => {
 		}, {
 			basis: Decimal.ZERO,
 			realized: Decimal.ZERO,
+			unrealized: Decimal.ZERO,
 			income: Decimal.ZERO,
 			summaryTotalCurrent: Decimal.ZERO,
 			summaryTotalPrevious: Decimal.ZERO
@@ -243,19 +249,26 @@ module.exports = (() => {
 
 		actual.basis = updates.basis;
 		actual.realized = updates.realized;
+		actual.unrealized = updates.unrealized;
 		actual.income = updates.income;
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
 		actual.summaryTotalPrevious = updates.summaryTotalPrevious;
 
 		format.basis = formatCurrency(actual.basis, currency);
 		format.realized = formatCurrency(actual.basis, currency);
+		format.unrealized = formatCurrency(actual.unrealized, currency);
 		format.income = formatCurrency(actual.income, currency);
 		format.summaryTotalCurrent = formatCurrency(updates.summaryTotalCurrent, currency);
 		format.summaryTotalPrevious = formatCurrency(updates.summaryTotalPrevious, currency);
 		format.summaryTotalPreviousNegative = updates.summaryTotalPrevious.getIsNegative();
 
+		calculateUnrealizedPercent(group);
+
 		if (group.single) {
-			format.quantity = formatDecimal(group._items[0].position.snapshot.open, 2);
+			const item = group._items[0];
+
+			format.quantity = formatDecimal(item.position.snapshot.open, 2);
+			format.basisPrice = formatCurrency(item.basisPrice, currency);
 		}
 	}
 
@@ -280,6 +293,7 @@ module.exports = (() => {
 
 			updates = items.reduce((updates, item) => {
 				updates.market = updates.market.add(item.data.market);
+				updates.unrealized = updates.unrealized.add(item.data.unrealized);
 				updates.unrealizedToday = updates.unrealizedToday.add(item.data.unrealizedToday);
 				updates.summaryTotalCurrent = updates.summaryTotalCurrent.add(item.data.summaryTotalCurrent);
 
@@ -287,6 +301,7 @@ module.exports = (() => {
 			}, {
 				market: Decimal.ZERO,
 				marketDirection: unchanged,
+				unrealized: Decimal.ZERO,
 				unrealizedToday: Decimal.ZERO,
 				summaryTotalCurrent: Decimal.ZERO
 
@@ -295,6 +310,7 @@ module.exports = (() => {
 			updates = {
 				market: actual.market.add(item.data.marketChange),
 				marketDirection: { up: item.data.marketChange.getIsPositive(), down: item.data.marketChange.getIsNegative() },
+				unrealized: actual.unrealized.add(item.data.unrealizedChange),
 				unrealizedToday: actual.unrealizedToday.add(item.data.unrealizedTodayChange),
 				summaryTotalCurrent: actual.summaryTotalCurrent.add(item.data.summaryTotalCurrentChange)
 			};
@@ -313,6 +329,7 @@ module.exports = (() => {
 		}
 
 		actual.market = updates.market;
+		actual.unrealized = updates.unrealized;
 		actual.unrealizedToday = updates.unrealizedToday;
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
 		actual.total = updates.unrealizedToday.add(actual.realized).add(actual.income);
@@ -324,6 +341,9 @@ module.exports = (() => {
 			setTimeout(() => format.marketDirection = updates.marketDirection, 0);
 		}
 
+		format.unrealized = formatCurrency(actual.unrealized, currency);
+		format.unrealizedNegative = actual.unrealized.getIsNegative();
+
 		format.unrealizedToday = formatCurrency(actual.unrealizedToday, currency);
 		format.unrealizedTodayNegative = actual.unrealizedToday.getIsNegative();
 
@@ -334,6 +354,7 @@ module.exports = (() => {
 		format.totalNegative = actual.total.getIsNegative();
 		
 		calculateMarketPercent(group, false);
+		calculateUnrealizedPercent(group);
 	}
 
 	function calculateMarketPercent(group, silent) {
@@ -369,6 +390,19 @@ module.exports = (() => {
 		}
 	}
 
+	function calculateUnrealizedPercent(group) {
+		const actual = group._dataActual;
+		const format = group._dataFormat;
+
+		if (actual.basis.getIsZero()) {
+			actual.unrealizedPercent = null;
+			format.unrealizedPercent = '—';
+		} else {
+			actual.unrealizedPercent = actual.unrealized.divide(actual.basis);
+			format.unrealizedPercent = formatPercent(actual.unrealizedPercent, 2);
+		}
+	}
+
 	const unchanged = { up: false, down: false };
 
 	return PositionGroup;

package/lib/processing/PositionItem.js

@@ -36,14 +36,18 @@ module.exports = (() => {
 			this._data.unrealizedToday = null;
 			this._data.unrealizedTodayChange = null;
 
-			this._data.realized = null;
-			this._data.income = null;
+			this._data.unrealized = null;
+			this._data.unrealizedChange = null;
 			
 			this._data.summaryTotalCurrent = null;
 			this._data.summaryTotalCurrentChange = null;
 
 			this._data.summaryTotalPrevious = null;
 
+			this._data.realized = null;
+			this._data.income = null;
+			this._data.basisPrice = null;
+
 			this._excluded = false;
 
 			calculateStaticData(this);
@@ -138,10 +142,18 @@ module.exports = (() => {
 		data.basis = basis;
 
 		data.realized = snapshot.gain;
+		data.unrealized = Decimal.ZERO;
+
 		data.income = snapshot.income;
 
 		data.summaryTotalCurrent = calculateSummaryTotal(item.currentSummary);
 		data.summaryTotalPrevious = calculateSummaryTotal(array.last(previousSummaries));
+
+		if (snapshot.open.getIsZero()) {
+			data.basisPrice = Decimal.ZERO;
+		} else {
+			data.basisPrice = basis.divide(snapshot.open);
+		}
 	}
 
 	function calculatePriceData(item, price) {
@@ -174,7 +186,7 @@ module.exports = (() => {
 
 		data.market = market;
 		data.marketChange = marketChange;
-		
+
 		let unrealizedToday;
 		let unrealizedTodayChange;
 
@@ -199,9 +211,16 @@ module.exports = (() => {
 		if (summary && price) {
 			const period = summary.period;
 
-			let unrealizedCurrent = summary.end.open.multiply(price).add(summary.end.basis);
+			let unrealized = summary.end.open.multiply(price).add(summary.end.basis);
+			let unrealizedChange;
+
+			if (data.unrealizedToday !== null) {
+				unrealizedChange = unrealized.subtract(data.unrealized);
+			} else {
+				unrealizedChange = Decimal.ZERO;
+			}
 
-			let summaryTotalCurrent = period.realized.add(period.income).add(unrealizedCurrent);
+			let summaryTotalCurrent = period.realized.add(period.income).add(unrealized);
 			let summaryTotalCurrentChange;
 
 			if (data.summaryTotalCurrent !== null) {
@@ -212,8 +231,14 @@ module.exports = (() => {
 
 			data.summaryTotalCurrent = summaryTotalCurrent;
 			data.summaryTotalCurrentChange = summaryTotalCurrentChange;
+
+			data.unrealized = unrealized;
+			data.unrealizedChange = unrealizedChange;
 		} else {
 			data.summaryTotalCurrentChange = Decimal.ZERO;
+
+			data.unrealized = Decimal.ZERO;
+			data.unrealizedChange = Decimal.ZERO;
 		}
 	}
 	

package/package.json

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

package/test/SpecRunner.js

@@ -1064,6 +1064,7 @@ module.exports = (() => {
 			this._dataActual.income = null;
 			this._dataActual.market = null;
 			this._dataActual.marketPercent = null;
+			this._dataActual.unrealized = null;
 			this._dataActual.unrealizedToday = null;
 			this._dataActual.total = null;
 			this._dataActual.summaryTotalCurrent = null;
@@ -1077,6 +1078,9 @@ module.exports = (() => {
 			this._dataFormat.market = null;
 			this._dataFormat.marketPercent = null;
 			this._dataFormat.marketDirection = null;
+			this._dataFormat.unrealized = null;
+			this._dataFormat.unrealizedPercent = null;
+			this._dataFormat.unrealizedNegative = false;
 			this._dataFormat.unrealizedToday = null;
 			this._dataFormat.unrealizedTodayNegative = false;
 			this._dataFormat.total = null;
@@ -1208,7 +1212,7 @@ module.exports = (() => {
 
 	function formatPercent(decimal, precision) {
 		if (decimal !== null) {
-			return formatDecimal(decimal.multiply(100), precision);
+			return formatDecimal(decimal.multiply(100), precision) + '%';
 		} else {
 			return '—';
 		}
@@ -1233,6 +1237,7 @@ module.exports = (() => {
 		let updates = items.reduce((updates, item) => {
 			updates.basis = updates.basis.add(item.data.basis);
 			updates.realized = updates.realized.add(item.data.realized);
+			updates.unrealized = updates.unrealized.add(item.data.unrealized);
 			updates.income = updates.income.add(item.data.income);
 			updates.summaryTotalCurrent = updates.summaryTotalCurrent.add(item.data.summaryTotalCurrent);
 			updates.summaryTotalPrevious = updates.summaryTotalPrevious.add(item.data.summaryTotalPrevious);
@@ -1241,6 +1246,7 @@ module.exports = (() => {
 		}, {
 			basis: Decimal.ZERO,
 			realized: Decimal.ZERO,
+			unrealized: Decimal.ZERO,
 			income: Decimal.ZERO,
 			summaryTotalCurrent: Decimal.ZERO,
 			summaryTotalPrevious: Decimal.ZERO
@@ -1248,19 +1254,26 @@ module.exports = (() => {
 
 		actual.basis = updates.basis;
 		actual.realized = updates.realized;
+		actual.unrealized = updates.unrealized;
 		actual.income = updates.income;
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
 		actual.summaryTotalPrevious = updates.summaryTotalPrevious;
 
 		format.basis = formatCurrency(actual.basis, currency);
 		format.realized = formatCurrency(actual.basis, currency);
+		format.unrealized = formatCurrency(actual.unrealized, currency);
 		format.income = formatCurrency(actual.income, currency);
 		format.summaryTotalCurrent = formatCurrency(updates.summaryTotalCurrent, currency);
 		format.summaryTotalPrevious = formatCurrency(updates.summaryTotalPrevious, currency);
 		format.summaryTotalPreviousNegative = updates.summaryTotalPrevious.getIsNegative();
 
+		calculateUnrealizedPercent(group);
+
 		if (group.single) {
-			format.quantity = formatDecimal(group._items[0].position.snapshot.open, 2);
+			const item = group._items[0];
+
+			format.quantity = formatDecimal(item.position.snapshot.open, 2);
+			format.basisPrice = formatCurrency(item.basisPrice, currency);
 		}
 	}
 
@@ -1285,6 +1298,7 @@ module.exports = (() => {
 
 			updates = items.reduce((updates, item) => {
 				updates.market = updates.market.add(item.data.market);
+				updates.unrealized = updates.unrealized.add(item.data.unrealized);
 				updates.unrealizedToday = updates.unrealizedToday.add(item.data.unrealizedToday);
 				updates.summaryTotalCurrent = updates.summaryTotalCurrent.add(item.data.summaryTotalCurrent);
 
@@ -1292,6 +1306,7 @@ module.exports = (() => {
 			}, {
 				market: Decimal.ZERO,
 				marketDirection: unchanged,
+				unrealized: Decimal.ZERO,
 				unrealizedToday: Decimal.ZERO,
 				summaryTotalCurrent: Decimal.ZERO
 
@@ -1300,6 +1315,7 @@ module.exports = (() => {
 			updates = {
 				market: actual.market.add(item.data.marketChange),
 				marketDirection: { up: item.data.marketChange.getIsPositive(), down: item.data.marketChange.getIsNegative() },
+				unrealized: actual.unrealized.add(item.data.unrealizedChange),
 				unrealizedToday: actual.unrealizedToday.add(item.data.unrealizedTodayChange),
 				summaryTotalCurrent: actual.summaryTotalCurrent.add(item.data.summaryTotalCurrentChange)
 			};
@@ -1318,6 +1334,7 @@ module.exports = (() => {
 		}
 
 		actual.market = updates.market;
+		actual.unrealized = updates.unrealized;
 		actual.unrealizedToday = updates.unrealizedToday;
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
 		actual.total = updates.unrealizedToday.add(actual.realized).add(actual.income);
@@ -1329,6 +1346,9 @@ module.exports = (() => {
 			setTimeout(() => format.marketDirection = updates.marketDirection, 0);
 		}
 
+		format.unrealized = formatCurrency(actual.unrealized, currency);
+		format.unrealizedNegative = actual.unrealized.getIsNegative();
+
 		format.unrealizedToday = formatCurrency(actual.unrealizedToday, currency);
 		format.unrealizedTodayNegative = actual.unrealizedToday.getIsNegative();
 
@@ -1339,6 +1359,7 @@ module.exports = (() => {
 		format.totalNegative = actual.total.getIsNegative();
 		
 		calculateMarketPercent(group, false);
+		calculateUnrealizedPercent(group);
 	}
 
 	function calculateMarketPercent(group, silent) {
@@ -1374,6 +1395,19 @@ module.exports = (() => {
 		}
 	}
 
+	function calculateUnrealizedPercent(group) {
+		const actual = group._dataActual;
+		const format = group._dataFormat;
+
+		if (actual.basis.getIsZero()) {
+			actual.unrealizedPercent = null;
+			format.unrealizedPercent = '—';
+		} else {
+			actual.unrealizedPercent = actual.unrealized.divide(actual.basis);
+			format.unrealizedPercent = formatPercent(actual.unrealizedPercent, 2);
+		}
+	}
+
 	const unchanged = { up: false, down: false };
 
 	return PositionGroup;
@@ -1418,14 +1452,18 @@ module.exports = (() => {
 			this._data.unrealizedToday = null;
 			this._data.unrealizedTodayChange = null;
 
-			this._data.realized = null;
-			this._data.income = null;
+			this._data.unrealized = null;
+			this._data.unrealizedChange = null;
 			
 			this._data.summaryTotalCurrent = null;
 			this._data.summaryTotalCurrentChange = null;
 
 			this._data.summaryTotalPrevious = null;
 
+			this._data.realized = null;
+			this._data.income = null;
+			this._data.basisPrice = null;
+
 			this._excluded = false;
 
 			calculateStaticData(this);
@@ -1520,10 +1558,18 @@ module.exports = (() => {
 		data.basis = basis;
 
 		data.realized = snapshot.gain;
+		data.unrealized = Decimal.ZERO;
+
 		data.income = snapshot.income;
 
 		data.summaryTotalCurrent = calculateSummaryTotal(item.currentSummary);
 		data.summaryTotalPrevious = calculateSummaryTotal(array.last(previousSummaries));
+
+		if (snapshot.open.getIsZero()) {
+			data.basisPrice = Decimal.ZERO;
+		} else {
+			data.basisPrice = basis.divide(snapshot.open);
+		}
 	}
 
 	function calculatePriceData(item, price) {
@@ -1556,7 +1602,7 @@ module.exports = (() => {
 
 		data.market = market;
 		data.marketChange = marketChange;
-		
+
 		let unrealizedToday;
 		let unrealizedTodayChange;
 
@@ -1581,9 +1627,16 @@ module.exports = (() => {
 		if (summary && price) {
 			const period = summary.period;
 
-			let unrealizedCurrent = summary.end.open.multiply(price).add(summary.end.basis);
+			let unrealized = summary.end.open.multiply(price).add(summary.end.basis);
+			let unrealizedChange;
 
-			let summaryTotalCurrent = period.realized.add(period.income).add(unrealizedCurrent);
+			if (data.unrealizedToday !== null) {
+				unrealizedChange = unrealized.subtract(data.unrealized);
+			} else {
+				unrealizedChange = Decimal.ZERO;
+			}
+
+			let summaryTotalCurrent = period.realized.add(period.income).add(unrealized);
 			let summaryTotalCurrentChange;
 
 			if (data.summaryTotalCurrent !== null) {
@@ -1594,8 +1647,14 @@ module.exports = (() => {
 
 			data.summaryTotalCurrent = summaryTotalCurrent;
 			data.summaryTotalCurrentChange = summaryTotalCurrentChange;
+
+			data.unrealized = unrealized;
+			data.unrealizedChange = unrealizedChange;
 		} else {
 			data.summaryTotalCurrentChange = Decimal.ZERO;
+
+			data.unrealized = Decimal.ZERO;
+			data.unrealizedChange = Decimal.ZERO;
 		}
 	}