@barchart/portfolio-api-common 1.2.102 → 1.2.106

package/lib/processing/PositionContainer.js

@@ -498,6 +498,18 @@ module.exports = (() => {
 			}
 		}
 
+		/**
+		 * Sets a historical forex quote.
+		 *
+		 * @public
+		 * @param {Object} forexQuote
+		 * @param {Day} date
+		 */
+		setHistoricalForexQuote(forexQuote, date) {
+			assert.argumentIsRequired(forexQuote, 'forexQuote', Object);
+			assert.argumentIsRequired(date, 'date', Day, 'Day');
+		}
+
 		/**
 		 * Returns all forex symbols that are required to do currency translations.
 		 *

package/lib/processing/PositionGroup.js

@@ -166,6 +166,18 @@ module.exports = (() => {
 			this._dataFormat.cashTotal = null;
 			this._dataFormat.portfolioType = null;
 
+			this._dataActual.periodPrice = null;
+			this._dataActual.periodPricePrevious = null;
+			this._dataActual.periodRealized = null;
+			this._dataActual.periodUnrealized = null;
+			this._dataActual.periodIncome = null;
+
+			this._dataFormat.periodPrice = null;
+			this._dataFormat.periodPricePrevious = null;
+			this._dataFormat.periodRealized = null;
+			this._dataFormat.periodUnrealized = null;
+			this._dataFormat.periodIncome = null;
+
 			this._items.forEach((item) => {
 				bindItem.call(this, item);
 			});
@@ -662,6 +674,10 @@ module.exports = (() => {
 			updates.marketPrevious = updates.marketPrevious.add(translate(item, item.data.marketPrevious));
 			updates.marketPrevious2 = updates.marketPrevious2.add(translate(item, item.data.marketPrevious2));
 
+			updates.periodRealized = updates.periodRealized.add(translate(item, item.data.periodRealized));
+			updates.periodUnrealized = updates.periodUnrealized.add(translate(item, item.data.periodUnrealized));
+			updates.periodIncome = updates.periodIncome.add(translate(item, item.data.periodIncome));
+
 			if (item.position.instrument.type === InstrumentType.CASH) {
 				updates.cashTotal = updates.cashTotal.add(translate(item, item.data.market));
 			}
@@ -677,7 +693,10 @@ module.exports = (() => {
 			summaryTotalPrevious2: Decimal.ZERO,
 			marketPrevious: Decimal.ZERO,
 			marketPrevious2: Decimal.ZERO,
-			cashTotal: Decimal.ZERO
+			periodRealized: Decimal.ZERO,
+			periodUnrealized: Decimal.ZERO,
+			periodIncome: Decimal.ZERO,
+			cashTotal: Decimal.ZERO,
 		});
 
 		actual.basis = updates.basis;
@@ -689,6 +708,9 @@ module.exports = (() => {
 		actual.summaryTotalPrevious2 = updates.summaryTotalPrevious2;
 		actual.marketPrevious = updates.marketPrevious;
 		actual.marketPrevious2 = updates.marketPrevious2;
+		actual.periodRealized = updates.periodRealized;
+		actual.periodUnrealized = updates.periodUnrealized;
+		actual.periodIncome = updates.periodIncome;
 		actual.cashTotal = updates.cashTotal;
 
 		format.basis = formatCurrency(actual.basis, currency);
@@ -702,6 +724,9 @@ module.exports = (() => {
 		format.summaryTotalPrevious2Negative = updates.summaryTotalPrevious2.getIsNegative();
 		format.marketPrevious = formatCurrency(updates.marketPrevious, currency);
 		format.marketPrevious2 = formatCurrency(updates.marketPrevious2, currency);
+		format.periodRealized = formatCurrency(updates.periodRealized, currency);
+		format.periodUnrealized = formatCurrency(updates.periodUnrealized, currency);
+		format.periodIncome = formatCurrency(updates.periodIncome, currency);
 		format.cashTotal = formatCurrency(updates.cashTotal, currency);
 
 		calculateUnrealizedPercent(group);
@@ -714,11 +739,17 @@ module.exports = (() => {
 			
 			actual.basisPrice = item.data.basisPrice;
 
+			actual.periodPrice = item.data.periodPrice;
+			actual.periodPricePrevious = item.data.periodPricePrevious;
+
 			format.quantity = formatDecimal(actual.quantity, 2);
 			format.quantityPrevious = formatDecimal(actual.quantityPrevious, 2);
-			
+
 			format.basisPrice = formatCurrency(actual.basisPrice, currency);
 
+			format.periodPrice = formatCurrency(actual.periodPrice, currency);
+			format.periodPricePrevious = formatCurrency(actual.periodPricePrevious, currency);
+
 			format.invalid = definition.type === PositionLevelType.POSITION && item.invalid;
 			format.locked = definition.type === PositionLevelType.POSITION && item.data.locked;
 		}

package/lib/processing/PositionItem.js

@@ -78,6 +78,13 @@ module.exports = (() => {
 			this._data.income = null;
 			this._data.basisPrice = null;
 
+			this._data.periodRealized = null;
+			this._data.periodUnrealized = null;
+			this._data.periodIncome = null;
+
+			this._data.periodPrice = null;
+			this._data.periodPricePrevious = null;
+
 			this._data.newsExists = false;
 			this._data.fundamental = { };
 			this._data.locked = getIsLocked(position);
@@ -367,8 +374,14 @@ module.exports = (() => {
 
 	function calculateStaticData(item) {
 		const position = item.position;
-		const snapshot = getSnapshot(position, item.currentSummary, item._reporting);
-		const previousSummaries = item.previousSummaries;
+
+		const currentSummary = item.currentSummary;
+
+		const previousSummary1 = getPreviousSummary(item.previousSummaries, 1);
+		const previousSummary2 = getPreviousSummary(item.previousSummaries, 2);
+		const previousSummary3 = getPreviousSummary(item.previousSummaries, 3);
+
+		const snapshot = getSnapshot(position, currentSummary, item._reporting);
 
 		const data = item._data;
 
@@ -389,24 +402,35 @@ module.exports = (() => {
 
 		data.income = snapshot.income;
 
-		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.marketPrevious = previousSummary1 === null ? Decimal.ZERO : previousSummary1.end.value;
 		data.marketPrevious2 = previousSummary2 === null ? Decimal.ZERO : previousSummary2.end.value;
-
 		data.quantityPrevious = previousSummary1 === null ? Decimal.ZERO : previousSummary1.end.open;
 
+		data.periodRealized = calculateRealizedPeriod(item.currentSummary, previousSummary1);
+		data.periodUnrealized = calculateUnrealizedPeriod(item.currentSummary, previousSummary1);
+		data.periodIncome = calculateIncomePeriod(item.currentSummary, previousSummary1);
+
 		if (snapshot.open.getIsZero()) {
 			data.basisPrice = Decimal.ZERO;
 		} else {
 			data.basisPrice = basis.divide(snapshot.open);
 		}
+
+		if (currentSummary && !currentSummary.end.open.getIsZero()) {
+			data.periodPrice = currentSummary.end.value.divide(currentSummary.end.open);
+		} else {
+			data.periodPrice = null;
+		}
+
+		if (previousSummary1 && !previousSummary1.end.open.getIsZero()) {
+			data.periodPricePrevious = previousSummary1.end.value.divide(previousSummary1.end.open);
+		} else {
+			data.periodPricePrevious = null;
+		}
 	}
 
 	function calculatePriceData(item, price) {
@@ -543,6 +567,48 @@ module.exports = (() => {
 		return returnRef;
 	}
 
+	function calculateRealizedPeriod(currentSummary, previousSummary) {
+		let returnRef;
+
+		if (currentSummary) {
+			const period = currentSummary.period;
+
+			returnRef = period.realized;
+		} else {
+			returnRef = Decimal.ZERO;
+		}
+
+		return returnRef;
+	}
+
+	function calculateUnrealizedPeriod(currentSummary, previousSummary) {
+		let returnRef;
+
+		if (currentSummary) {
+			const period = currentSummary.period;
+
+			returnRef = period.unrealized.subtract(previousSummary !== null ? previousSummary.period.unrealized : Decimal.ZERO);
+		} else {
+			returnRef = Decimal.ZERO;
+		}
+
+		return returnRef;
+	}
+
+	function calculateIncomePeriod(currentSummary, previousSummary) {
+		let returnRef;
+
+		if (currentSummary) {
+			const period = currentSummary.period;
+
+			returnRef = period.income;
+		} else {
+			returnRef = Decimal.ZERO;
+		}
+
+		return returnRef;
+	}
+
 	function getPreviousSummary(previousSummaries, count) {
 		const index = previousSummaries.length - count;
 

package/package.json

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

package/test/SpecRunner.js

@@ -1922,6 +1922,18 @@ module.exports = (() => {
 			}
 		}
 
+		/**
+		 * Sets a historical forex quote.
+		 *
+		 * @public
+		 * @param {Object} forexQuote
+		 * @param {Day} date
+		 */
+		setHistoricalForexQuote(forexQuote, date) {
+			assert.argumentIsRequired(forexQuote, 'forexQuote', Object);
+			assert.argumentIsRequired(date, 'date', Day, 'Day');
+		}
+
 		/**
 		 * Returns all forex symbols that are required to do currency translations.
 		 *
@@ -2610,6 +2622,18 @@ module.exports = (() => {
 			this._dataFormat.cashTotal = null;
 			this._dataFormat.portfolioType = null;
 
+			this._dataActual.periodPrice = null;
+			this._dataActual.periodPricePrevious = null;
+			this._dataActual.periodRealized = null;
+			this._dataActual.periodUnrealized = null;
+			this._dataActual.periodIncome = null;
+
+			this._dataFormat.periodPrice = null;
+			this._dataFormat.periodPricePrevious = null;
+			this._dataFormat.periodRealized = null;
+			this._dataFormat.periodUnrealized = null;
+			this._dataFormat.periodIncome = null;
+
 			this._items.forEach((item) => {
 				bindItem.call(this, item);
 			});
@@ -3106,6 +3130,10 @@ module.exports = (() => {
 			updates.marketPrevious = updates.marketPrevious.add(translate(item, item.data.marketPrevious));
 			updates.marketPrevious2 = updates.marketPrevious2.add(translate(item, item.data.marketPrevious2));
 
+			updates.periodRealized = updates.periodRealized.add(translate(item, item.data.periodRealized));
+			updates.periodUnrealized = updates.periodUnrealized.add(translate(item, item.data.periodUnrealized));
+			updates.periodIncome = updates.periodIncome.add(translate(item, item.data.periodIncome));
+
 			if (item.position.instrument.type === InstrumentType.CASH) {
 				updates.cashTotal = updates.cashTotal.add(translate(item, item.data.market));
 			}
@@ -3121,7 +3149,10 @@ module.exports = (() => {
 			summaryTotalPrevious2: Decimal.ZERO,
 			marketPrevious: Decimal.ZERO,
 			marketPrevious2: Decimal.ZERO,
-			cashTotal: Decimal.ZERO
+			periodRealized: Decimal.ZERO,
+			periodUnrealized: Decimal.ZERO,
+			periodIncome: Decimal.ZERO,
+			cashTotal: Decimal.ZERO,
 		});
 
 		actual.basis = updates.basis;
@@ -3133,6 +3164,9 @@ module.exports = (() => {
 		actual.summaryTotalPrevious2 = updates.summaryTotalPrevious2;
 		actual.marketPrevious = updates.marketPrevious;
 		actual.marketPrevious2 = updates.marketPrevious2;
+		actual.periodRealized = updates.periodRealized;
+		actual.periodUnrealized = updates.periodUnrealized;
+		actual.periodIncome = updates.periodIncome;
 		actual.cashTotal = updates.cashTotal;
 
 		format.basis = formatCurrency(actual.basis, currency);
@@ -3146,6 +3180,9 @@ module.exports = (() => {
 		format.summaryTotalPrevious2Negative = updates.summaryTotalPrevious2.getIsNegative();
 		format.marketPrevious = formatCurrency(updates.marketPrevious, currency);
 		format.marketPrevious2 = formatCurrency(updates.marketPrevious2, currency);
+		format.periodRealized = formatCurrency(updates.periodRealized, currency);
+		format.periodUnrealized = formatCurrency(updates.periodUnrealized, currency);
+		format.periodIncome = formatCurrency(updates.periodIncome, currency);
 		format.cashTotal = formatCurrency(updates.cashTotal, currency);
 
 		calculateUnrealizedPercent(group);
@@ -3158,11 +3195,17 @@ module.exports = (() => {
 			
 			actual.basisPrice = item.data.basisPrice;
 
+			actual.periodPrice = item.data.periodPrice;
+			actual.periodPricePrevious = item.data.periodPricePrevious;
+
 			format.quantity = formatDecimal(actual.quantity, 2);
 			format.quantityPrevious = formatDecimal(actual.quantityPrevious, 2);
-			
+
 			format.basisPrice = formatCurrency(actual.basisPrice, currency);
 
+			format.periodPrice = formatCurrency(actual.periodPrice, currency);
+			format.periodPricePrevious = formatCurrency(actual.periodPricePrevious, currency);
+
 			format.invalid = definition.type === PositionLevelType.POSITION && item.invalid;
 			format.locked = definition.type === PositionLevelType.POSITION && item.data.locked;
 		}
@@ -3432,6 +3475,13 @@ module.exports = (() => {
 			this._data.income = null;
 			this._data.basisPrice = null;
 
+			this._data.periodRealized = null;
+			this._data.periodUnrealized = null;
+			this._data.periodIncome = null;
+
+			this._data.periodPrice = null;
+			this._data.periodPricePrevious = null;
+
 			this._data.newsExists = false;
 			this._data.fundamental = { };
 			this._data.locked = getIsLocked(position);
@@ -3721,8 +3771,14 @@ module.exports = (() => {
 
 	function calculateStaticData(item) {
 		const position = item.position;
-		const snapshot = getSnapshot(position, item.currentSummary, item._reporting);
-		const previousSummaries = item.previousSummaries;
+
+		const currentSummary = item.currentSummary;
+
+		const previousSummary1 = getPreviousSummary(item.previousSummaries, 1);
+		const previousSummary2 = getPreviousSummary(item.previousSummaries, 2);
+		const previousSummary3 = getPreviousSummary(item.previousSummaries, 3);
+
+		const snapshot = getSnapshot(position, currentSummary, item._reporting);
 
 		const data = item._data;
 
@@ -3743,24 +3799,35 @@ module.exports = (() => {
 
 		data.income = snapshot.income;
 
-		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.marketPrevious = previousSummary1 === null ? Decimal.ZERO : previousSummary1.end.value;
 		data.marketPrevious2 = previousSummary2 === null ? Decimal.ZERO : previousSummary2.end.value;
-
 		data.quantityPrevious = previousSummary1 === null ? Decimal.ZERO : previousSummary1.end.open;
 
+		data.periodRealized = calculateRealizedPeriod(item.currentSummary, previousSummary1);
+		data.periodUnrealized = calculateUnrealizedPeriod(item.currentSummary, previousSummary1);
+		data.periodIncome = calculateIncomePeriod(item.currentSummary, previousSummary1);
+
 		if (snapshot.open.getIsZero()) {
 			data.basisPrice = Decimal.ZERO;
 		} else {
 			data.basisPrice = basis.divide(snapshot.open);
 		}
+
+		if (currentSummary && !currentSummary.end.open.getIsZero()) {
+			data.periodPrice = currentSummary.end.value.divide(currentSummary.end.open);
+		} else {
+			data.periodPrice = null;
+		}
+
+		if (previousSummary1 && !previousSummary1.end.open.getIsZero()) {
+			data.periodPricePrevious = previousSummary1.end.value.divide(previousSummary1.end.open);
+		} else {
+			data.periodPricePrevious = null;
+		}
 	}
 
 	function calculatePriceData(item, price) {
@@ -3897,6 +3964,48 @@ module.exports = (() => {
 		return returnRef;
 	}
 
+	function calculateRealizedPeriod(currentSummary, previousSummary) {
+		let returnRef;
+
+		if (currentSummary) {
+			const period = currentSummary.period;
+
+			returnRef = period.realized;
+		} else {
+			returnRef = Decimal.ZERO;
+		}
+
+		return returnRef;
+	}
+
+	function calculateUnrealizedPeriod(currentSummary, previousSummary) {
+		let returnRef;
+
+		if (currentSummary) {
+			const period = currentSummary.period;
+
+			returnRef = period.unrealized.subtract(previousSummary !== null ? previousSummary.period.unrealized : Decimal.ZERO);
+		} else {
+			returnRef = Decimal.ZERO;
+		}
+
+		return returnRef;
+	}
+
+	function calculateIncomePeriod(currentSummary, previousSummary) {
+		let returnRef;
+
+		if (currentSummary) {
+			const period = currentSummary.period;
+
+			returnRef = period.income;
+		} else {
+			returnRef = Decimal.ZERO;
+		}
+
+		return returnRef;
+	}
+
 	function getPreviousSummary(previousSummaries, count) {
 		const index = previousSummaries.length - count;
 
@@ -6186,11 +6295,12 @@ module.exports = function () {
 			}
 
 			/**
-    * Clones a {@link Day} instance.
+    * Converts a string (which matches the output of {@link Day#format} into
+    * a {@link Day} instance.
     *
     * @public
     * @static
-    * @param {Day} value
+    * @param {String} value
     * @returns {Day}
     */
 
@@ -6231,24 +6341,6 @@ module.exports = function () {
 				return this._day;
 			}
 		}], [{
-			key: 'clone',
-			value: function clone(value) {
-				assert.argumentIsRequired(value, 'value', Day, 'Day');
-
-				return new Day(value.year, value.month, value.day);
-			}
-
-			/**
-    * Converts a string (which matches the output of {@link Day#format} into
-    * a {@link Day} instance.
-    *
-    * @public
-    * @static
-    * @param {String} value
-    * @returns {Day}
-    */
-
-		}, {
 			key: 'parse',
 			value: function parse(value) {
 				assert.argumentIsRequired(value, 'value', String);
@@ -6565,17 +6657,15 @@ module.exports = function () {
     *
     * @public
     * @param {Boolean=} approximate
-    * @param {Number=} places
     * @returns {Boolean}
     */
 
 		}, {
 			key: 'getIsZero',
-			value: function getIsZero(approximate, places) {
+			value: function getIsZero(approximate) {
 				assert.argumentIsOptional(approximate, 'approximate', Boolean);
-				assert.argumentIsOptional(places, 'places', Number);
 
-				return this._big.eq(zero) || is.boolean(approximate) && approximate && this.round(places || Big.DP, RoundingMode.NORMAL).getIsZero();
+				return this._big.eq(zero) || is.boolean(approximate) && approximate && this.round(20, RoundingMode.NORMAL).getIsZero();
 			}
 
 			/**
@@ -6674,43 +6764,6 @@ module.exports = function () {
 				return this._big.eq(getBig(other));
 			}
 
-			/**
-    * Returns true if the current instance is an integer (i.e. has no decimal
-    * component).
-    *
-    * @public
-    * @return {Boolean}
-    */
-
-		}, {
-			key: 'getIsInteger',
-			value: function getIsInteger() {
-				return this.getIsEqual(this.round(0));
-			}
-
-			/**
-    * Returns the number of decimal places used.
-    *
-    * @public
-    * @returns {Number}
-    */
-
-		}, {
-			key: 'getDecimalPlaces',
-			value: function getDecimalPlaces() {
-				var matches = this.toFixed().match(/-?\d*\.(\d*)/);
-
-				var returnVal = void 0;
-
-				if (matches === null) {
-					returnVal = 0;
-				} else {
-					returnVal = matches[1].length;
-				}
-
-				return returnVal;
-			}
-
 			/**
     * Emits a floating point value that approximates the value of the current
     * instance.
@@ -6759,11 +6812,10 @@ module.exports = function () {
 			}
 
 			/**
-    * Clones a {@link Decimal} instance.
+    * Parses the value emitted by {@link Decimal#toJSON}.
     *
     * @public
-    * @static
-    * @param {Decimal} value
+    * @param {String} value
     * @returns {Decimal}
     */
 
@@ -6773,22 +6825,6 @@ module.exports = function () {
 				return '[Decimal]';
 			}
 		}], [{
-			key: 'clone',
-			value: function clone(value) {
-				assert.argumentIsRequired(value, 'value', Decimal, 'Decimal');
-
-				return new Decimal(value._big);
-			}
-
-			/**
-    * Parses the value emitted by {@link Decimal#toJSON}.
-    *
-    * @public
-    * @param {String} value
-    * @returns {Decimal}
-    */
-
-		}, {
 			key: 'parse',
 			value: function parse(value) {
 				return new Decimal(value);
@@ -7810,11 +7846,10 @@ module.exports = function () {
 			}
 
 			/**
-    * Clones a {@link Timestamp} instance.
+    * Parses the value emitted by {@link Timestamp#toJSON}.
     *
     * @public
-    * @static
-    * @param {Timestamp} value
+    * @param {Number} value
     * @returns {Timestamp}
     */
 
@@ -7850,22 +7885,6 @@ module.exports = function () {
 				return this._moment;
 			}
 		}], [{
-			key: 'clone',
-			value: function clone(value) {
-				assert.argumentIsRequired(value, 'value', Timestamp, 'Timestamp');
-
-				return new Timestamp(value._timestamp, value._timezone);
-			}
-
-			/**
-    * Parses the value emitted by {@link Timestamp#toJSON}.
-    *
-    * @public
-    * @param {Number} value
-    * @returns {Timestamp}
-    */
-
-		}, {
 			key: 'parse',
 			value: function parse(value) {
 				return new Timestamp(value);