@barchart/portfolio-api-common 1.2.86 → 1.2.90

package/lib/processing/PositionContainer.js

@@ -284,6 +284,14 @@ module.exports = (() => {
 
 			const existingBarchartSymbols = this.getPositionSymbols(false);
 
+			let similarPositionItem;
+
+			if (extractSymbolForBarchart(position)) {
+				similarPositionItem = this._items.find(item => extractSymbolForBarchart(item.position) === extractSymbolForBarchart(position)) || null;
+			} else {
+				similarPositionItem = null;
+			}
+
 			removePositionItem.call(this, this._items.find(item => item.position.position === position.position));
 
 			summaries.forEach((summary) => {
@@ -331,6 +339,16 @@ module.exports = (() => {
 				this._positionSymbolAddedEvent.fire(addedBarchartSymbol);
 			}
 
+			if (similarPositionItem !== null) {
+				if (similarPositionItem.previousQuote) {
+					item.setQuote(similarPositionItem.previousQuote);
+				}
+
+				if (similarPositionItem.quote) {
+					item.setQuote(similarPositionItem.quote);
+				}
+			}
+
 			recalculatePercentages.call(this);
 		}
 
@@ -915,7 +933,7 @@ module.exports = (() => {
 		}
 	}
 
-	function createPositionItem(position) {
+	function createPositionItem(position, currentQuote, previousQuote) {
 		const portfolio = this._portfolios[position.portfolio];
 
 		let returnRef;

package/lib/processing/PositionGroup.js

@@ -130,6 +130,10 @@ module.exports = (() => {
 			this._dataActual.summaryTotalCurrent = null;
 			this._dataActual.summaryTotalPrevious = null;
 			this._dataActual.summaryTotalPrevious2 = null;
+			this._dataActual.endingPrevious = null;
+			this._dataActual.endingPrevious2 = null;
+			this._dataActual.endingChange = null;
+			this._dataActual.endingChangePercent = null;
 			this._dataActual.cashTotal = null;
 
 			this._dataFormat.currentPrice = null;
@@ -153,6 +157,10 @@ module.exports = (() => {
 			this._dataFormat.summaryTotalPreviousNegative = false;
 			this._dataFormat.summaryTotalPrevious2 = null;
 			this._dataFormat.summaryTotalPrevious2Negative = false;
+			this._dataFormat.endingPrevious = null;
+			this._dataFormat.endingPrevious2 = null;
+			this._dataFormat.endingChange = null;
+			this._dataFormat.endingChangePercent = null;
 			this._dataFormat.cashTotal = null;
 			this._dataFormat.portfolioType = null;
 
@@ -388,8 +396,6 @@ module.exports = (() => {
 				return;
 			}
 
-			const descriptionSelector = this._definition.descriptionSelector;
-
 			this._description = PositionLevelDefinition.getDescriptionForPortfolioGroup(portfolio);
 
 			this._dataActual.description = this._description;
@@ -634,7 +640,7 @@ module.exports = (() => {
 		const translate = (item, value) => {
 			let translated;
 
-			if (item.currency !== currency) {
+			if (item.currency !== currency && !value.getIsZero()) {
 				translated = Rate.convert(value, item.currency, currency, ...rates);
 			} else {
 				translated = value;
@@ -651,6 +657,8 @@ module.exports = (() => {
 			updates.summaryTotalCurrent = updates.summaryTotalCurrent.add(translate(item, item.data.summaryTotalCurrent));
 			updates.summaryTotalPrevious = updates.summaryTotalPrevious.add(translate(item, item.data.summaryTotalPrevious));
 			updates.summaryTotalPrevious2 = updates.summaryTotalPrevious2.add(translate(item, item.data.summaryTotalPrevious2));
+			updates.endingPrevious = updates.endingPrevious.add(translate(item, item.data.endingPrevious));
+			updates.endingPrevious2 = updates.endingPrevious2.add(translate(item, item.data.endingPrevious2));
 
 			if (item.position.instrument.type === InstrumentType.CASH) {
 				updates.cashTotal = updates.cashTotal.add(translate(item, item.data.market));
@@ -665,6 +673,8 @@ module.exports = (() => {
 			summaryTotalCurrent: Decimal.ZERO,
 			summaryTotalPrevious: Decimal.ZERO,
 			summaryTotalPrevious2: Decimal.ZERO,
+			endingPrevious: Decimal.ZERO,
+			endingPrevious2: Decimal.ZERO,
 			cashTotal: Decimal.ZERO
 		});
 
@@ -675,6 +685,8 @@ module.exports = (() => {
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
 		actual.summaryTotalPrevious = updates.summaryTotalPrevious;
 		actual.summaryTotalPrevious2 = updates.summaryTotalPrevious2;
+		actual.endingPrevious = updates.endingPrevious;
+		actual.endingPrevious2 = updates.endingPrevious2;
 		actual.cashTotal = updates.cashTotal;
 
 		format.basis = formatCurrency(actual.basis, currency);
@@ -686,6 +698,8 @@ module.exports = (() => {
 		format.summaryTotalPreviousNegative = updates.summaryTotalPrevious.getIsNegative();
 		format.summaryTotalPrevious2 = formatCurrency(updates.summaryTotalPrevious2, currency);
 		format.summaryTotalPrevious2Negative = updates.summaryTotalPrevious2.getIsNegative();
+		format.endingPrevious = formatCurrency(updates.endingPrevious, currency);
+		format.endingPrevious2 = formatCurrency(updates.endingPrevious2, currency);
 		format.cashTotal = formatCurrency(updates.cashTotal, currency);
 
 		calculateUnrealizedPercent(group);
@@ -735,7 +749,7 @@ module.exports = (() => {
 		const translate = (item, value) => {
 			let translated;
 
-			if (item.currency !== currency) {
+			if (item.currency !== currency && !value.getIsZero()) {
 				translated = Rate.convert(value, item.currency, currency, ...rates);
 			} else {
 				translated = value;
@@ -782,7 +796,25 @@ module.exports = (() => {
 		actual.unrealizedToday = updates.unrealizedToday;
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
 		actual.total = updates.unrealized.add(actual.realized).add(actual.income);
-		
+
+		let endingChange = updates.market.subtract(actual.endingPrevious);
+		let endingChangePercent;
+
+		if (actual.endingPrevious.getIsZero()) {
+			if (endingChange.getIsPositive()) {
+				endingChangePercent = Decimal.ONE;
+			} else if (endingChange.getIsNegative()) {
+				endingChangePercent = Decimal.NEGATIVE_ONE;
+			} else {
+				endingChangePercent = Decimal.ZERO;
+			}
+		} else {
+			endingChangePercent = endingChange.divide(actual.endingPrevious);
+		}
+
+		actual.endingChange = endingChange;
+		actual.endingChangePercent = endingChangePercent;
+
 		format.market = formatCurrency(actual.market, currency);
 		
 		if (updates.marketDirection.up || updates.marketDirection.down) {
@@ -802,6 +834,9 @@ module.exports = (() => {
 		format.total = formatCurrency(actual.total, currency);
 		format.totalNegative = actual.total.getIsNegative();
 
+		format.endingChange = formatCurrency(actual.endingChange, currency);
+		format.endingChangePercent = formatPercent(actual.endingChangePercent, 2);
+
 		calculateUnrealizedPercent(group);
 	}
 

package/lib/processing/PositionItem.js

@@ -41,6 +41,7 @@ module.exports = (() => {
 			this._data.basis = null;
 
 			this._currentQuote = null;
+			this._previousQuote = null;
 			this._currentPrice = null;
 
 			this._data.currentPrice = null;
@@ -64,6 +65,9 @@ module.exports = (() => {
 			this._data.summaryTotalPrevious = null;
 			this._data.summaryTotalPrevious2 = null;
 
+			this._data.endingPrevious = null;
+			this._data.endingPrevious2 = null;
+
 			this._data.realized = null;
 			this._data.income = null;
 			this._data.basisPrice = null;
@@ -154,7 +158,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * The current quote for the symbol of the encapsulated position.
+		 * The most recent quote for the symbol of the encapsulated position.
 		 *
 		 * @public
 		 * @returns {null|Object}
@@ -163,6 +167,16 @@ module.exports = (() => {
 			return this._currentQuote;
 		}
 
+		/**
+		 * The second most recent quote for the symbol of the encapsulated position.
+		 *
+		 * @public
+		 * @returns {null|Object}
+		 */
+		get previousQuote() {
+			return this._previousQuote;
+		}
+
 		updatePortfolio(portfolio) {
 			assert.argumentIsRequired(portfolio, 'portfolio', Object);
 			assert.argumentIsRequired(portfolio.portfolio, 'portfolio.portfolio', String);
@@ -200,6 +214,7 @@ module.exports = (() => {
 				this._currentPricePrevious = this._currentPrice;
 				this._currentPrice = quote.lastPrice;
 
+				this._previousQuote = this._currentQuote;
 				this._currentQuote = quote;
 
 				this._quoteChangedEvent.fire(this._currentQuote);
@@ -368,9 +383,16 @@ module.exports = (() => {
 
 		data.income = snapshot.income;
 
-		data.summaryTotalCurrent = calculateSummaryTotal(item.currentSummary, getPreviousSummary(previousSummaries, 1));
-		data.summaryTotalPrevious = calculateSummaryTotal(getPreviousSummary(previousSummaries, 1), getPreviousSummary(previousSummaries, 2));
-		data.summaryTotalPrevious2 = calculateSummaryTotal(getPreviousSummary(previousSummaries, 2), getPreviousSummary(previousSummaries, 3));
+		const previousSummary1 = getPreviousSummary(previousSummaries, 1);
+		const previousSummary2 = getPreviousSummary(previousSummaries, 2);
+		const previousSummary3 = getPreviousSummary(previousSummaries, 3);
+
+		data.summaryTotalCurrent = calculateSummaryTotal(item.currentSummary, previousSummary1);
+		data.summaryTotalPrevious = calculateSummaryTotal(previousSummary1, previousSummary2);
+		data.summaryTotalPrevious2 = calculateSummaryTotal(previousSummary2, previousSummary3);
+
+		data.endingPrevious = previousSummary1 === null ? Decimal.ZERO : previousSummary1.end.value;
+		data.endingPrevious2 = previousSummary2 === null ? Decimal.ZERO : previousSummary2.end.value;
 
 		if (snapshot.open.getIsZero()) {
 			data.basisPrice = Decimal.ZERO;

package/package.json

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

package/test/SpecRunner.js

@@ -1663,6 +1663,14 @@ module.exports = (() => {
 
 			const existingBarchartSymbols = this.getPositionSymbols(false);
 
+			let similarPositionItem;
+
+			if (extractSymbolForBarchart(position)) {
+				similarPositionItem = this._items.find(item => extractSymbolForBarchart(item.position) === extractSymbolForBarchart(position)) || null;
+			} else {
+				similarPositionItem = null;
+			}
+
 			removePositionItem.call(this, this._items.find(item => item.position.position === position.position));
 
 			summaries.forEach((summary) => {
@@ -1710,6 +1718,16 @@ module.exports = (() => {
 				this._positionSymbolAddedEvent.fire(addedBarchartSymbol);
 			}
 
+			if (similarPositionItem !== null) {
+				if (similarPositionItem.previousQuote) {
+					item.setQuote(similarPositionItem.previousQuote);
+				}
+
+				if (similarPositionItem.quote) {
+					item.setQuote(similarPositionItem.quote);
+				}
+			}
+
 			recalculatePercentages.call(this);
 		}
 
@@ -2294,7 +2312,7 @@ module.exports = (() => {
 		}
 	}
 
-	function createPositionItem(position) {
+	function createPositionItem(position, currentQuote, previousQuote) {
 		const portfolio = this._portfolios[position.portfolio];
 
 		let returnRef;
@@ -2497,6 +2515,10 @@ module.exports = (() => {
 			this._dataActual.summaryTotalCurrent = null;
 			this._dataActual.summaryTotalPrevious = null;
 			this._dataActual.summaryTotalPrevious2 = null;
+			this._dataActual.endingPrevious = null;
+			this._dataActual.endingPrevious2 = null;
+			this._dataActual.endingChange = null;
+			this._dataActual.endingChangePercent = null;
 			this._dataActual.cashTotal = null;
 
 			this._dataFormat.currentPrice = null;
@@ -2520,6 +2542,10 @@ module.exports = (() => {
 			this._dataFormat.summaryTotalPreviousNegative = false;
 			this._dataFormat.summaryTotalPrevious2 = null;
 			this._dataFormat.summaryTotalPrevious2Negative = false;
+			this._dataFormat.endingPrevious = null;
+			this._dataFormat.endingPrevious2 = null;
+			this._dataFormat.endingChange = null;
+			this._dataFormat.endingChangePercent = null;
 			this._dataFormat.cashTotal = null;
 			this._dataFormat.portfolioType = null;
 
@@ -2755,8 +2781,6 @@ module.exports = (() => {
 				return;
 			}
 
-			const descriptionSelector = this._definition.descriptionSelector;
-
 			this._description = PositionLevelDefinition.getDescriptionForPortfolioGroup(portfolio);
 
 			this._dataActual.description = this._description;
@@ -3001,7 +3025,7 @@ module.exports = (() => {
 		const translate = (item, value) => {
 			let translated;
 
-			if (item.currency !== currency) {
+			if (item.currency !== currency && !value.getIsZero()) {
 				translated = Rate.convert(value, item.currency, currency, ...rates);
 			} else {
 				translated = value;
@@ -3018,6 +3042,8 @@ module.exports = (() => {
 			updates.summaryTotalCurrent = updates.summaryTotalCurrent.add(translate(item, item.data.summaryTotalCurrent));
 			updates.summaryTotalPrevious = updates.summaryTotalPrevious.add(translate(item, item.data.summaryTotalPrevious));
 			updates.summaryTotalPrevious2 = updates.summaryTotalPrevious2.add(translate(item, item.data.summaryTotalPrevious2));
+			updates.endingPrevious = updates.endingPrevious.add(translate(item, item.data.endingPrevious));
+			updates.endingPrevious2 = updates.endingPrevious2.add(translate(item, item.data.endingPrevious2));
 
 			if (item.position.instrument.type === InstrumentType.CASH) {
 				updates.cashTotal = updates.cashTotal.add(translate(item, item.data.market));
@@ -3032,6 +3058,8 @@ module.exports = (() => {
 			summaryTotalCurrent: Decimal.ZERO,
 			summaryTotalPrevious: Decimal.ZERO,
 			summaryTotalPrevious2: Decimal.ZERO,
+			endingPrevious: Decimal.ZERO,
+			endingPrevious2: Decimal.ZERO,
 			cashTotal: Decimal.ZERO
 		});
 
@@ -3042,6 +3070,8 @@ module.exports = (() => {
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
 		actual.summaryTotalPrevious = updates.summaryTotalPrevious;
 		actual.summaryTotalPrevious2 = updates.summaryTotalPrevious2;
+		actual.endingPrevious = updates.endingPrevious;
+		actual.endingPrevious2 = updates.endingPrevious2;
 		actual.cashTotal = updates.cashTotal;
 
 		format.basis = formatCurrency(actual.basis, currency);
@@ -3053,6 +3083,8 @@ module.exports = (() => {
 		format.summaryTotalPreviousNegative = updates.summaryTotalPrevious.getIsNegative();
 		format.summaryTotalPrevious2 = formatCurrency(updates.summaryTotalPrevious2, currency);
 		format.summaryTotalPrevious2Negative = updates.summaryTotalPrevious2.getIsNegative();
+		format.endingPrevious = formatCurrency(updates.endingPrevious, currency);
+		format.endingPrevious2 = formatCurrency(updates.endingPrevious2, currency);
 		format.cashTotal = formatCurrency(updates.cashTotal, currency);
 
 		calculateUnrealizedPercent(group);
@@ -3102,7 +3134,7 @@ module.exports = (() => {
 		const translate = (item, value) => {
 			let translated;
 
-			if (item.currency !== currency) {
+			if (item.currency !== currency && !value.getIsZero()) {
 				translated = Rate.convert(value, item.currency, currency, ...rates);
 			} else {
 				translated = value;
@@ -3149,7 +3181,25 @@ module.exports = (() => {
 		actual.unrealizedToday = updates.unrealizedToday;
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
 		actual.total = updates.unrealized.add(actual.realized).add(actual.income);
-		
+
+		let endingChange = updates.market.subtract(actual.endingPrevious);
+		let endingChangePercent;
+
+		if (actual.endingPrevious.getIsZero()) {
+			if (endingChange.getIsPositive()) {
+				endingChangePercent = Decimal.ONE;
+			} else if (endingChange.getIsNegative()) {
+				endingChangePercent = Decimal.NEGATIVE_ONE;
+			} else {
+				endingChangePercent = Decimal.ZERO;
+			}
+		} else {
+			endingChangePercent = endingChange.divide(actual.endingPrevious);
+		}
+
+		actual.endingChange = endingChange;
+		actual.endingChangePercent = endingChangePercent;
+
 		format.market = formatCurrency(actual.market, currency);
 		
 		if (updates.marketDirection.up || updates.marketDirection.down) {
@@ -3169,6 +3219,9 @@ module.exports = (() => {
 		format.total = formatCurrency(actual.total, currency);
 		format.totalNegative = actual.total.getIsNegative();
 
+		format.endingChange = formatCurrency(actual.endingChange, currency);
+		format.endingChangePercent = formatPercent(actual.endingChangePercent, 2);
+
 		calculateUnrealizedPercent(group);
 	}
 
@@ -3277,6 +3330,7 @@ module.exports = (() => {
 			this._data.basis = null;
 
 			this._currentQuote = null;
+			this._previousQuote = null;
 			this._currentPrice = null;
 
 			this._data.currentPrice = null;
@@ -3300,6 +3354,9 @@ module.exports = (() => {
 			this._data.summaryTotalPrevious = null;
 			this._data.summaryTotalPrevious2 = null;
 
+			this._data.endingPrevious = null;
+			this._data.endingPrevious2 = null;
+
 			this._data.realized = null;
 			this._data.income = null;
 			this._data.basisPrice = null;
@@ -3390,7 +3447,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * The current quote for the symbol of the encapsulated position.
+		 * The most recent quote for the symbol of the encapsulated position.
 		 *
 		 * @public
 		 * @returns {null|Object}
@@ -3399,6 +3456,16 @@ module.exports = (() => {
 			return this._currentQuote;
 		}
 
+		/**
+		 * The second most recent quote for the symbol of the encapsulated position.
+		 *
+		 * @public
+		 * @returns {null|Object}
+		 */
+		get previousQuote() {
+			return this._previousQuote;
+		}
+
 		updatePortfolio(portfolio) {
 			assert.argumentIsRequired(portfolio, 'portfolio', Object);
 			assert.argumentIsRequired(portfolio.portfolio, 'portfolio.portfolio', String);
@@ -3436,6 +3503,7 @@ module.exports = (() => {
 				this._currentPricePrevious = this._currentPrice;
 				this._currentPrice = quote.lastPrice;
 
+				this._previousQuote = this._currentQuote;
 				this._currentQuote = quote;
 
 				this._quoteChangedEvent.fire(this._currentQuote);
@@ -3604,9 +3672,16 @@ module.exports = (() => {
 
 		data.income = snapshot.income;
 
-		data.summaryTotalCurrent = calculateSummaryTotal(item.currentSummary, getPreviousSummary(previousSummaries, 1));
-		data.summaryTotalPrevious = calculateSummaryTotal(getPreviousSummary(previousSummaries, 1), getPreviousSummary(previousSummaries, 2));
-		data.summaryTotalPrevious2 = calculateSummaryTotal(getPreviousSummary(previousSummaries, 2), getPreviousSummary(previousSummaries, 3));
+		const previousSummary1 = getPreviousSummary(previousSummaries, 1);
+		const previousSummary2 = getPreviousSummary(previousSummaries, 2);
+		const previousSummary3 = getPreviousSummary(previousSummaries, 3);
+
+		data.summaryTotalCurrent = calculateSummaryTotal(item.currentSummary, previousSummary1);
+		data.summaryTotalPrevious = calculateSummaryTotal(previousSummary1, previousSummary2);
+		data.summaryTotalPrevious2 = calculateSummaryTotal(previousSummary2, previousSummary3);
+
+		data.endingPrevious = previousSummary1 === null ? Decimal.ZERO : previousSummary1.end.value;
+		data.endingPrevious2 = previousSummary2 === null ? Decimal.ZERO : previousSummary2.end.value;
 
 		if (snapshot.open.getIsZero()) {
 			data.basisPrice = Decimal.ZERO;