@barchart/portfolio-api-common 1.2.103 → 1.2.107

package/lib/processing/PositionContainer.js

@@ -104,7 +104,7 @@ module.exports = (() => {
 			}, { });
 
 			this._items = positions.reduce((items, position) => {
-				const item = createPositionItem.call(this, position);
+				const item = createPositionItem.call(this, position, reportFrame ? true : false);
 
 				if (item) {
 					items.push(item);
@@ -313,7 +313,7 @@ module.exports = (() => {
 				addSummaryPrevious(this._summariesPrevious, summary, this._previousSummaryFrame, this._previousSummaryRanges);
 			});
 
-			const item = createPositionItem.call(this, position);
+			const item = createPositionItem.call(this, position, false);
 
 			addBarchartSymbol(this._symbols, item);
 			addDisplaySymbol(this._symbolsDisplay, item);
@@ -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.
 		 *
@@ -947,7 +959,7 @@ module.exports = (() => {
 		}
 	}
 
-	function createPositionItem(position, currentQuote, previousQuote) {
+	function createPositionItem(position, requireCurrentSummary) {
 		const portfolio = this._portfolios[position.portfolio];
 
 		let returnRef;
@@ -956,7 +968,11 @@ module.exports = (() => {
 			const currentSummary = this._summariesCurrent[ position.position ] || null;
 			const previousSummaries = this._summariesPrevious[ position.position ] || getSummaryArray(this._previousSummaryRanges);
 
-			returnRef = new PositionItem(portfolio, position, currentSummary, previousSummaries, this._reporting);
+			if (!requireCurrentSummary || currentSummary !== null) {
+				returnRef = new PositionItem(portfolio, position, currentSummary, previousSummaries, this._reporting);
+			} else {
+				returnRef = null;
+			}
 		} else {
 			returnRef = null;
 		}

package/lib/processing/PositionGroup.js

@@ -166,10 +166,14 @@ 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;
@@ -704,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);
@@ -717,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);
@@ -729,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,8 +78,12 @@ module.exports = (() => {
 			this._data.income = null;
 			this._data.basisPrice = null;
 
-			this._data.realizedPeriod = null;
-			this._data.unrealizedPeriod = 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 = { };
@@ -370,13 +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 previousSummary1 = getPreviousSummary(previousSummaries, 1);
-		const previousSummary2 = getPreviousSummary(previousSummaries, 2);
-		const previousSummary3 = getPreviousSummary(previousSummaries, 3);
+		const snapshot = getSnapshot(position, currentSummary, item._reporting);
 
 		const data = item._data;
 
@@ -414,6 +419,18 @@ module.exports = (() => {
 		} 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) {
@@ -556,7 +573,7 @@ module.exports = (() => {
 		if (currentSummary) {
 			const period = currentSummary.period;
 
-			returnRef = period.unrealized;
+			returnRef = period.realized;
 		} else {
 			returnRef = Decimal.ZERO;
 		}

package/package.json

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

package/test/SpecRunner.js

@@ -1528,7 +1528,7 @@ module.exports = (() => {
 			}, { });
 
 			this._items = positions.reduce((items, position) => {
-				const item = createPositionItem.call(this, position);
+				const item = createPositionItem.call(this, position, reportFrame ? true : false);
 
 				if (item) {
 					items.push(item);
@@ -1737,7 +1737,7 @@ module.exports = (() => {
 				addSummaryPrevious(this._summariesPrevious, summary, this._previousSummaryFrame, this._previousSummaryRanges);
 			});
 
-			const item = createPositionItem.call(this, position);
+			const item = createPositionItem.call(this, position, false);
 
 			addBarchartSymbol(this._symbols, item);
 			addDisplaySymbol(this._symbolsDisplay, item);
@@ -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.
 		 *
@@ -2371,7 +2383,7 @@ module.exports = (() => {
 		}
 	}
 
-	function createPositionItem(position, currentQuote, previousQuote) {
+	function createPositionItem(position, requireCurrentSummary) {
 		const portfolio = this._portfolios[position.portfolio];
 
 		let returnRef;
@@ -2380,7 +2392,11 @@ module.exports = (() => {
 			const currentSummary = this._summariesCurrent[ position.position ] || null;
 			const previousSummaries = this._summariesPrevious[ position.position ] || getSummaryArray(this._previousSummaryRanges);
 
-			returnRef = new PositionItem(portfolio, position, currentSummary, previousSummaries, this._reporting);
+			if (!requireCurrentSummary || currentSummary !== null) {
+				returnRef = new PositionItem(portfolio, position, currentSummary, previousSummaries, this._reporting);
+			} else {
+				returnRef = null;
+			}
 		} else {
 			returnRef = null;
 		}
@@ -2610,10 +2626,14 @@ 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;
@@ -3148,6 +3168,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);
@@ -3161,6 +3184,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);
@@ -3173,11 +3199,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;
 		}
@@ -3447,8 +3479,12 @@ module.exports = (() => {
 			this._data.income = null;
 			this._data.basisPrice = null;
 
-			this._data.realizedPeriod = null;
-			this._data.unrealizedPeriod = 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 = { };
@@ -3739,13 +3775,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(previousSummaries, 1);
-		const previousSummary2 = getPreviousSummary(previousSummaries, 2);
-		const previousSummary3 = getPreviousSummary(previousSummaries, 3);
+		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;
 
@@ -3783,6 +3820,18 @@ module.exports = (() => {
 		} 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) {
@@ -3925,7 +3974,7 @@ module.exports = (() => {
 		if (currentSummary) {
 			const period = currentSummary.period;
 
-			returnRef = period.unrealized;
+			returnRef = period.realized;
 		} else {
 			returnRef = Decimal.ZERO;
 		}
@@ -6250,12 +6299,11 @@ module.exports = function () {
 			}
 
 			/**
-    * Converts a string (which matches the output of {@link Day#format} into
-    * a {@link Day} instance.
+    * Clones a {@link Day} instance.
     *
     * @public
     * @static
-    * @param {String} value
+    * @param {Day} value
     * @returns {Day}
     */
 
@@ -6296,6 +6344,24 @@ 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);
@@ -6612,15 +6678,17 @@ module.exports = function () {
     *
     * @public
     * @param {Boolean=} approximate
+    * @param {Number=} places
     * @returns {Boolean}
     */
 
 		}, {
 			key: 'getIsZero',
-			value: function getIsZero(approximate) {
+			value: function getIsZero(approximate, places) {
 				assert.argumentIsOptional(approximate, 'approximate', Boolean);
+				assert.argumentIsOptional(places, 'places', Number);
 
-				return this._big.eq(zero) || is.boolean(approximate) && approximate && this.round(20, RoundingMode.NORMAL).getIsZero();
+				return this._big.eq(zero) || is.boolean(approximate) && approximate && this.round(places || Big.DP, RoundingMode.NORMAL).getIsZero();
 			}
 
 			/**
@@ -6719,6 +6787,43 @@ 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.
@@ -6767,10 +6872,11 @@ module.exports = function () {
 			}
 
 			/**
-    * Parses the value emitted by {@link Decimal#toJSON}.
+    * Clones a {@link Decimal} instance.
     *
     * @public
-    * @param {String} value
+    * @static
+    * @param {Decimal} value
     * @returns {Decimal}
     */
 
@@ -6780,6 +6886,22 @@ 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);
@@ -7801,10 +7923,11 @@ module.exports = function () {
 			}
 
 			/**
-    * Parses the value emitted by {@link Timestamp#toJSON}.
+    * Clones a {@link Timestamp} instance.
     *
     * @public
-    * @param {Number} value
+    * @static
+    * @param {Timestamp} value
     * @returns {Timestamp}
     */
 
@@ -7840,6 +7963,22 @@ 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);