@barchart/portfolio-api-common 1.0.231 → 1.0.235

package/lib/data/TransactionType.js

@@ -17,9 +17,10 @@ module.exports = (() => {
 	 * @param {Boolean} income
 	 * @param {Boolean} opening
 	 * @param {Boolean} closing
+	 * @param {Boolean} fee
 	 */
 	class TransactionType extends Enum {
-		constructor(code, description, display, purchase, sale, income, opening, closing) {
+		constructor(code, description, display, purchase, sale, income, opening, closing, fee) {
 			super(code, description);
 
 			assert.argumentIsRequired(display, 'display', String);
@@ -28,6 +29,7 @@ module.exports = (() => {
 			assert.argumentIsRequired(income, 'income', Boolean);
 			assert.argumentIsRequired(opening, 'opening', Boolean);
 			assert.argumentIsRequired(closing, 'closing', Boolean);
+			assert.argumentIsRequired(fee, 'fee', Boolean);
 
 			this._display = display;
 			this._purchase = purchase;
@@ -35,6 +37,7 @@ module.exports = (() => {
 			this._income = income;
 			this._opening = opening;
 			this._closing = closing;
+			this._fee = fee
 		}
 
 		/**
@@ -58,7 +61,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Indicates if the trade was a purchase.
+		 * Indicates if the transaction was a purchase.
 		 *
 		 * @public
 		 * @returns {Boolean}
@@ -68,7 +71,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Indicates if the trade was a sale.
+		 * Indicates if the transaction was a sale.
 		 *
 		 * @public
 		 * @returns {Boolean}
@@ -88,7 +91,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Indicates if the transactions opens the position (i.e. increases its
+		 * Indicates if the transaction opens the position (i.e. increases its
 		 * magnitude).
 		 *
 		 * @public
@@ -99,7 +102,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Indicates if the transactions closes the position (i.e. decreases its
+		 * Indicates if the transaction closes the position (i.e. decreases its
 		 * magnitude).
 		 *
 		 * @public
@@ -109,6 +112,17 @@ module.exports = (() => {
 			return this._closing;
 		}
 
+		/**
+		 * Indicates if the transaction is a chart that neither opens nor
+		 * closes the position.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get fee() {
+			return this._fee;
+		}
+
 		/**
 		 * A purchase.
 		 *
@@ -312,27 +326,27 @@ module.exports = (() => {
 		}
 	}
 
-	const buy = new TransactionType('B', 'Buy', 'Buy', true, false, false, true,  false);
-	const sell = new TransactionType('S', 'Sell', 'Sell', false, true, false, false, true);
-	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', true, false, false, false, true);
-	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', false, true, false, true, false);
-	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', false, false, true, false, false);
-	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', false, false, false, true, false);
-	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', false, false, false, true, false);
-	const split = new TransactionType('SP', 'Split', 'Split', false, false, false, true, false);
-	const fee = new TransactionType('F', 'Fee', 'Fee', false, false, false, true, false);
-	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, false);
-
-	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false);
-	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false);
-
-	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, false, false);
-	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', false, false, false, false, false);
-	const debit = new TransactionType('DR', 'Debit', 'Debit', false, false, false, false, false);
-	const credit = new TransactionType('CR', 'Credit', 'Credit', false, false, false, false, false);
-
-	const valuation = new TransactionType('V', 'Valuation', 'Valuation', false, false, false, false, false);
-	const income = new TransactionType('I', 'Income', 'Income', false, false, true, false, false);
+	const buy = new TransactionType('B', 'Buy', 'Buy', true, false, false, true,  false, false);
+	const sell = new TransactionType('S', 'Sell', 'Sell', false, true, false, false, true, false);
+	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', true, false, false, false, true, false);
+	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', false, true, false, true, false, false);
+	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', false, false, true, false, false, false);
+	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', false, false, false, true, false, false);
+	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', false, false, false, true, false, false);
+	const split = new TransactionType('SP', 'Split', 'Split', false, false, false, true, false, false);
+	const fee = new TransactionType('F', 'Fee', 'Fee', false, false, false, false, false, true);
+	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, true, false);
+
+	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false, false);
+	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false, false);
+
+	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, false, false, false);
+	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', false, false, false, false, false, false);
+	const debit = new TransactionType('DR', 'Debit', 'Debit', false, false, false, false, false, false);
+	const credit = new TransactionType('CR', 'Credit', 'Credit', false, false, false, false, false, false);
+
+	const valuation = new TransactionType('V', 'Valuation', 'Valuation', false, false, false, false, false, false);
+	const income = new TransactionType('I', 'Income', 'Income', false, false, true, false, false, false);
 
 	return TransactionType;
 })();

package/lib/processing/PositionContainer.js

@@ -73,7 +73,7 @@ module.exports = (() => {
 			}, { });
 
 			this._previousSummaryFrame = PositionSummaryFrame.YEARLY;
-			this._previousSummaryRanges = this._previousSummaryFrame.getRecentRanges(0);
+			this._previousSummaryRanges = this._previousSummaryFrame.getRecentRanges(1);
 
 			this._summariesPrevious = summaries.reduce((map, summary) => {
 				addSummaryPrevious(map, summary, this._previousSummaryFrame, this._previousSummaryRanges);

package/lib/processing/PositionGroup.js

@@ -127,6 +127,7 @@ module.exports = (() => {
 			this._dataActual.total = null;
 			this._dataActual.summaryTotalCurrent = null;
 			this._dataActual.summaryTotalPrevious = null;
+			this._dataActual.summaryTotalPrevious2 = null;
 			this._dataActual.cashTotal = null;
 
 			this._dataFormat.currentPrice = null;
@@ -148,6 +149,8 @@ module.exports = (() => {
 			this._dataActual.summaryTotalCurrentNegative = false;
 			this._dataFormat.summaryTotalPrevious = null;
 			this._dataFormat.summaryTotalPreviousNegative = false;
+			this._dataFormat.summaryTotalPrevious2 = null;
+			this._dataFormat.summaryTotalPrevious2Negative = false;
 			this._dataFormat.cashTotal = null;
 			this._dataFormat.portfolioType = null;
 
@@ -595,6 +598,7 @@ module.exports = (() => {
 			updates.income = updates.income.add(translate(item, item.data.income));
 			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));
 
 			if (item.position.instrument.type === InstrumentType.CASH) {
 				updates.cashTotal = updates.cashTotal.add(translate(item, item.data.market));
@@ -608,6 +612,7 @@ module.exports = (() => {
 			income: Decimal.ZERO,
 			summaryTotalCurrent: Decimal.ZERO,
 			summaryTotalPrevious: Decimal.ZERO,
+			summaryTotalPrevious2: Decimal.ZERO,
 			cashTotal: Decimal.ZERO
 		});
 
@@ -617,6 +622,7 @@ module.exports = (() => {
 		actual.income = updates.income;
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
 		actual.summaryTotalPrevious = updates.summaryTotalPrevious;
+		actual.summaryTotalPrevious2 = updates.summaryTotalPrevious2;
 		actual.cashTotal = updates.cashTotal;
 
 		format.basis = formatCurrency(actual.basis, currency);
@@ -626,6 +632,8 @@ module.exports = (() => {
 		format.summaryTotalCurrent = formatCurrency(updates.summaryTotalCurrent, currency);
 		format.summaryTotalPrevious = formatCurrency(updates.summaryTotalPrevious, currency);
 		format.summaryTotalPreviousNegative = updates.summaryTotalPrevious.getIsNegative();
+		format.summaryTotalPrevious2 = formatCurrency(updates.summaryTotalPrevious2, currency);
+		format.summaryTotalPrevious2Negative = updates.summaryTotalPrevious2.getIsNegative();
 		format.cashTotal = formatCurrency(updates.cashTotal, currency);
 
 		calculateUnrealizedPercent(group);

package/lib/processing/PositionItem.js

@@ -1,5 +1,4 @@
-const array = require('@barchart/common-js/lang/array'),
-	assert = require('@barchart/common-js/lang/assert'),
+const assert = require('@barchart/common-js/lang/assert'),
 	Currency = require('@barchart/common-js/lang/Currency'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
 	Disposable = require('@barchart/common-js/lang/Disposable'),
@@ -59,6 +58,7 @@ module.exports = (() => {
 			this._data.summaryTotalCurrentChange = null;
 
 			this._data.summaryTotalPrevious = null;
+			this._data.summaryTotalPrevious2 = null;
 
 			this._data.realized = null;
 			this._data.income = null;
@@ -318,7 +318,8 @@ module.exports = (() => {
 		data.income = snapshot.income;
 
 		data.summaryTotalCurrent = calculateSummaryTotal(item.currentSummary);
-		data.summaryTotalPrevious = calculateSummaryTotal(array.last(previousSummaries));
+		data.summaryTotalPrevious = calculateSummaryTotal(getPreviousSummary(previousSummaries, 1));
+		data.summaryTotalPrevious2 = calculateSummaryTotal(getPreviousSummary(previousSummaries, 2));
 
 		if (snapshot.open.getIsZero()) {
 			data.basisPrice = Decimal.ZERO;
@@ -439,5 +440,19 @@ module.exports = (() => {
 		return returnRef;
 	}
 
+	function getPreviousSummary(previousSummaries, count) {
+		const index = previousSummaries.length - count;
+
+		let summary;
+
+		if (!(index < 0)) {
+			summary = previousSummaries[index];
+		} else {
+			summary = null;
+		}
+
+		return summary;
+	}
+
 	return PositionItem;
 })();