@barchart/portfolio-api-common 1.2.88 → 1.2.92

package/lib/data/PositionSummaryFrame.js

@@ -86,6 +86,19 @@ module.exports = (() => {
 			return this._rangeCalculator(getFilteredTransactions(transactions));
 		}
 
+		/**
+		 * Returns the range which contains a given date and all subsequent ranges.
+		 *
+		 * @public
+		 * @param {Day} date
+		 * @return {Array.<PositionSummaryRange>}
+		 */
+		getRangesFromDate(date) {
+			const transaction = { date: date, snapshot: { open: Decimal.ONE } };
+
+			return this.getRanges([ transaction ]);
+		}
+
 		/**
 		 * Returns the start date for a frame, a given number of periods ago.
 		 *
@@ -158,6 +171,16 @@ module.exports = (() => {
 	 * @property {Day} end
 	 */
 
+	/**
+	 * The start and and date for a {@link PositionSummaryFrame} along with the frame type.
+	 *
+	 * @typedef PositionSummaryDefinition
+	 * @type {Object}
+	 * @property {Day} start
+	 * @property {Day} end
+	 * @property {PositionSummaryFrame} frame
+	 */
+
 	function getRange(start, end) {
 		return {
 			start: start,

package/lib/processing/PositionContainer.js

@@ -42,7 +42,7 @@ module.exports = (() => {
 	 * @param {Array.<Object>} portfolios - The portfolios.
 	 * @param {Array.<Object>} positions - The positions (for all of the portfolios).
 	 * @param {Array.<Object>} summaries - The positions summaries (for all of the positions).
-	 * @param {PositionSummaryFrame} - If specified, locks the current (and previous) periods to a specific frame, use for reporting.
+	 * @param {PositionSummaryFrame=} - If specified, locks the current (and previous) periods to a specific frame, use for reporting.
 	 */
 	class PositionContainer {
 		constructor(definitions, portfolios, positions, summaries, frame) {
@@ -284,12 +284,12 @@ module.exports = (() => {
 
 			const existingBarchartSymbols = this.getPositionSymbols(false);
 
-			let similiarPositionItem;
+			let similarPositionItem;
 
-			if (is.object(position.instrument.symbol) && is.string(position.instrument.symbol.barchart)) {
-				similiarPositionItem = this._items.find(item => is.object(item.position.instrument.symbol) && item.position.instrument.symbol.barchart === position.instrument.symbol.barchart) || null;
+			if (extractSymbolForBarchart(position)) {
+				similarPositionItem = this._items.find(item => extractSymbolForBarchart(item.position) === extractSymbolForBarchart(position)) || null;
 			} else {
-				similiarPositionItem = null;
+				similarPositionItem = null;
 			}
 
 			removePositionItem.call(this, this._items.find(item => item.position.position === position.position));
@@ -339,13 +339,13 @@ module.exports = (() => {
 				this._positionSymbolAddedEvent.fire(addedBarchartSymbol);
 			}
 
-			if (similiarPositionItem !== null) {
-				if (similiarPositionItem.previousQuote) {
-					item.setQuote(similiarPositionItem.previousQuote);
+			if (similarPositionItem !== null) {
+				if (similarPositionItem.previousQuote) {
+					item.setQuote(similarPositionItem.previousQuote);
 				}
 
-				if (similiarPositionItem.quote) {
-					item.setQuote(similiarPositionItem.quote);
+				if (similarPositionItem.quote) {
+					item.setQuote(similarPositionItem.quote);
 				}
 			}
 

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

@@ -65,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;
@@ -380,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/lib/serialization/PositionSummaryDefinitionSchema.js

@@ -0,0 +1,58 @@
+const DataType = require('@barchart/common-js/serialization/json/DataType'),
+	Enum = require('@barchart/common-js/lang/Enum'),
+	Schema = require('@barchart/common-js/serialization/json/Schema'),
+	SchemaBuilder = require('@barchart/common-js/serialization/json/builders/SchemaBuilder');
+
+const PositionSummaryFrame = require('./../data/PositionSummaryFrame');
+
+module.exports = (() => {
+	'use strict';
+
+	/**
+	 * The schemas which can be used to represent position summary objects.
+	 *
+	 * @public
+	 * @extends {Enum}
+	 */
+	class PositionSummaryDefinitionSchema extends Enum {
+		constructor(schema) {
+			super(schema.name, schema.name);
+
+			this._schema = schema;
+		}
+
+		/**
+		 * The actual {@link Schema}.
+		 *
+		 * @public
+		 * @returns {Schema}
+		 */
+		get schema() {
+			return this._schema;
+		}
+
+		/**
+		 * The complete position summary definition schema.
+		 *
+		 * @static
+		 * @public
+		 * @returns {PositionSummaryDefinitionSchema}
+		 */
+		static get COMPLETE() {
+			return complete;
+		}
+
+		toString() {
+			return '[PositionSummaryDefinitionSchema]';
+		}
+	}
+
+	const complete = new PositionSummaryDefinitionSchema(SchemaBuilder.withName('complete')
+		.withField('start', DataType.DAY)
+		.withField('end', DataType.DAY)
+		.withField('frame', DataType.forEnum(PositionSummaryFrame, 'PositionSummaryFrame'))
+		.schema
+	);
+
+	return PositionSummaryDefinitionSchema;
+})();

package/lib/serialization/PositionSummarySchema.js

@@ -1,5 +1,4 @@
-const Currency = require('@barchart/common-js/lang/Currency'),
-	DataType = require('@barchart/common-js/serialization/json/DataType'),
+const DataType = require('@barchart/common-js/serialization/json/DataType'),
 	Enum = require('@barchart/common-js/lang/Enum'),
 	Schema = require('@barchart/common-js/serialization/json/Schema'),
 	SchemaBuilder = require('@barchart/common-js/serialization/json/builders/SchemaBuilder');

package/package.json

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

package/test/SpecRunner.js

@@ -477,6 +477,19 @@ module.exports = (() => {
 			return this._rangeCalculator(getFilteredTransactions(transactions));
 		}
 
+		/**
+		 * Returns the range which contains a given date and all subsequent ranges.
+		 *
+		 * @public
+		 * @param {Day} date
+		 * @return {Array.<PositionSummaryRange>}
+		 */
+		getRangesFromDate(date) {
+			const transaction = { date: date, snapshot: { open: Decimal.ONE } };
+
+			return this.getRanges([ transaction ]);
+		}
+
 		/**
 		 * Returns the start date for a frame, a given number of periods ago.
 		 *
@@ -549,6 +562,16 @@ module.exports = (() => {
 	 * @property {Day} end
 	 */
 
+	/**
+	 * The start and and date for a {@link PositionSummaryFrame} along with the frame type.
+	 *
+	 * @typedef PositionSummaryDefinition
+	 * @type {Object}
+	 * @property {Day} start
+	 * @property {Day} end
+	 * @property {PositionSummaryFrame} frame
+	 */
+
 	function getRange(start, end) {
 		return {
 			start: start,
@@ -1421,7 +1444,7 @@ module.exports = (() => {
 	 * @param {Array.<Object>} portfolios - The portfolios.
 	 * @param {Array.<Object>} positions - The positions (for all of the portfolios).
 	 * @param {Array.<Object>} summaries - The positions summaries (for all of the positions).
-	 * @param {PositionSummaryFrame} - If specified, locks the current (and previous) periods to a specific frame, use for reporting.
+	 * @param {PositionSummaryFrame=} - If specified, locks the current (and previous) periods to a specific frame, use for reporting.
 	 */
 	class PositionContainer {
 		constructor(definitions, portfolios, positions, summaries, frame) {
@@ -1663,12 +1686,12 @@ module.exports = (() => {
 
 			const existingBarchartSymbols = this.getPositionSymbols(false);
 
-			let similiarPositionItem;
+			let similarPositionItem;
 
-			if (is.object(position.instrument.symbol) && is.string(position.instrument.symbol.barchart)) {
-				similiarPositionItem = this._items.find(item => is.object(item.position.instrument.symbol) && item.position.instrument.symbol.barchart === position.instrument.symbol.barchart) || null;
+			if (extractSymbolForBarchart(position)) {
+				similarPositionItem = this._items.find(item => extractSymbolForBarchart(item.position) === extractSymbolForBarchart(position)) || null;
 			} else {
-				similiarPositionItem = null;
+				similarPositionItem = null;
 			}
 
 			removePositionItem.call(this, this._items.find(item => item.position.position === position.position));
@@ -1718,13 +1741,13 @@ module.exports = (() => {
 				this._positionSymbolAddedEvent.fire(addedBarchartSymbol);
 			}
 
-			if (similiarPositionItem !== null) {
-				if (similiarPositionItem.previousQuote) {
-					item.setQuote(similiarPositionItem.previousQuote);
+			if (similarPositionItem !== null) {
+				if (similarPositionItem.previousQuote) {
+					item.setQuote(similarPositionItem.previousQuote);
 				}
 
-				if (similiarPositionItem.quote) {
-					item.setQuote(similiarPositionItem.quote);
+				if (similarPositionItem.quote) {
+					item.setQuote(similarPositionItem.quote);
 				}
 			}
 
@@ -2515,6 +2538,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;
@@ -2538,6 +2565,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;
 
@@ -2773,8 +2804,6 @@ module.exports = (() => {
 				return;
 			}
 
-			const descriptionSelector = this._definition.descriptionSelector;
-
 			this._description = PositionLevelDefinition.getDescriptionForPortfolioGroup(portfolio);
 
 			this._dataActual.description = this._description;
@@ -3019,7 +3048,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;
@@ -3036,6 +3065,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));
@@ -3050,6 +3081,8 @@ module.exports = (() => {
 			summaryTotalCurrent: Decimal.ZERO,
 			summaryTotalPrevious: Decimal.ZERO,
 			summaryTotalPrevious2: Decimal.ZERO,
+			endingPrevious: Decimal.ZERO,
+			endingPrevious2: Decimal.ZERO,
 			cashTotal: Decimal.ZERO
 		});
 
@@ -3060,6 +3093,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);
@@ -3071,6 +3106,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);
@@ -3120,7 +3157,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;
@@ -3167,7 +3204,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) {
@@ -3187,6 +3242,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);
 	}
 
@@ -3319,6 +3377,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;
@@ -3634,9 +3695,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;