@barchart/portfolio-api-common 9.0.1 → 9.1.0

package/lib/processing/PositionContainer.js

@@ -31,6 +31,7 @@ module.exports = (() => {
 		Currency.AUD,
 		Currency.CAD,
 		Currency.CHF,
+		Currency.CZK,
 		Currency.DKK,
 		Currency.GBP,
 		Currency.GBX,
@@ -225,11 +226,11 @@ module.exports = (() => {
 					this._suspendedPositionQuotes = new Map();
 					this._suspendedForexQuotes = new Map();
 
-					this.setQuotes(positionQuotes, forexQuotes);
-
 					Object.keys(this._trees).forEach((key) => {
 						this._trees[key].walk(group => group.resumeCalculations(), false, false);
 					});
+
+					this.setQuotes(positionQuotes, forexQuotes);
 				}
 			});
 

package/lib/processing/PositionGroup.js

@@ -223,6 +223,18 @@ module.exports = (() => {
 			this._dataFormat.periodPercentPrevious = null;
 			this._dataFormat.periodPercentPrevious2 = null;
 
+			this._dataActual.todayQuote = null;
+			this._dataActual.todayExchange = null;
+
+			this._dataFormat.todayQuote = null;
+			this._dataFormat.todayExchange = null;
+
+			this._dataActual.todayPrice = null;
+			this._dataActual.todayPricePrevious = null;
+
+			this._dataFormat.todayPrice = null;
+			this._dataFormat.todayPricePrevious = null;
+
 			this._items.forEach((item) => {
 				bindItem.call(this, item);
 			});
@@ -695,7 +707,7 @@ module.exports = (() => {
 							summary.count = sums[fieldName].count + 1;
 						}
 
-						if ((i + 1) == this.items.length) {
+						if ((i + 1) === this.items.length) {
 							let averageFormat;
 
 							if (summary.count > 0) {
@@ -893,7 +905,7 @@ module.exports = (() => {
 			return currencyTranslator.translate(value, item.currency, currency);
 		};
 
-		let updates = items.reduce((updates, item) => {
+		const updates = items.reduce((updates, item) => {
 			updates.basis = updates.basis.add(translate(item, item.data.basis));
 
 			if (item.position.instrument.type === InstrumentType.FUTURE) {
@@ -1061,6 +1073,15 @@ module.exports = (() => {
 			}
 		}
 
+		format.todayQuote = '—';
+		format.todayExchange = '—';
+
+		format.todayPrice = '—';
+		format.todayPricePrevious = '—';
+
+		format.unrealizedToday = '—';
+		format.gainToday = '—';
+
 		format.portfolioType = portfolioType;
 	}
 
@@ -1214,6 +1235,26 @@ module.exports = (() => {
 		if (group.single && item) {
 			actual.unrealizedPrice = item.data.unrealizedPrice;
 			format.unrealizedPrice = formatFractionSpecial(actual.unrealizedPrice, currency, item.position.instrument);
+
+			actual.todayQuote = item.data.todayQuote;
+			actual.todayExchange = item.data.todayExchange;
+
+			format.todayQuote = actual.todayQuote === null ? '—' : actual.todayQuote.format();
+			format.todayExchange = actual.todayExchange === null ? '—' : actual.todayExchange.format();
+
+			actual.todayPrice = item.data.todayPrice;
+			actual.todayPricePrevious = item.data.todayPricePrevious;
+
+			format.todayPrice = actual.todayPrice === null ? '—' : formatFractionSpecial(actual.todayPrice, currency, item.position.instrument);
+			format.todayPricePrevious = actual.todayPricePrevious === null ? '—' : formatFractionSpecial(actual.todayPricePrevious, currency, item.position.instrument);
+
+			if (actual.todayPrice === null) {
+				format.unrealizedToday = '—';
+
+				if (actual.realizedToday !== null && actual.realizedToday.getIsEqual(Decimal.ZERO)) {
+					format.gainToday = '—';
+				}
+			}
 		}
 	}
 

package/lib/processing/PositionItem.js

@@ -67,6 +67,12 @@ module.exports = (() => {
 			this._data.marketAbsolute = null;
 			this._data.marketAbsoluteChange = null;
 
+			this._data.todayQuote = null;
+			this._data.todayExchange = null;
+
+			this._data.todayPrice = null;
+			this._data.todayPricePrevious = null;
+
 			this._data.realizedToday = null;
 			this._data.realizedTodayChange = null;
 
@@ -612,6 +618,9 @@ module.exports = (() => {
 		data.marketAbsolute = marketAbsolute;
 		data.marketAbsoluteChange = marketAbsoluteChange;
 
+		data.todayQuote = day || null;
+		data.todayExchange = today || null;
+
 		let unrealizedToday;
 		let unrealizedTodayChange;
 
@@ -640,10 +649,21 @@ module.exports = (() => {
 		data.unrealizedToday = unrealizedToday;
 		data.unrealizedTodayChange = unrealizedTodayChange;
 
+		if (priceIsToday && price) {
+			data.todayPrice = price;
+
+			if (data.previousPrice) {
+				data.todayPricePrevious = data.previousPrice;
+			}
+		} else {
+			data.todayPrice = null;
+			data.todayPricePrevious = null;
+		}
+
 		let realizedToday;
 		let realizedTodayChange;
 
-		if (position.latest && position.latest.gain && position.latest.date && day && position.latest.date.getIsEqual(day)) {
+		if (position.latest && position.latest.gain && position.latest.date && today && position.latest.date.getIsEqual(today)) {
 			realizedToday = position.latest.gain;
 		} else {
 			realizedToday = Decimal.ZERO;

package/lib/processing/definitions/PositionLevelDefinition.js

@@ -32,7 +32,7 @@ module.exports = (() => {
 			assert.argumentIsRequired(currencySelector, 'currencySelector', Function);
 
 			if (requiredGroups) {
-				assert.argumentIsArray(requiredGroups, 'requiredGroups', String);
+				assert.argumentIsArray(requiredGroups, 'requiredGroups', validateRequiredGroup, 'RequiredGroup');
 			}
 
 			assert.argumentIsOptional(requiredGroupGenerator, 'requiredGroupGenerator', Function);
@@ -106,11 +106,11 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Indicates the required groups (i.e. descriptions). The allows for the creation of empty
+		 * Indicates the required groups. This allows for the creation of empty
 		 * groups.
 		 *
 		 * @public
-		 * @returns {String[]}
+		 * @returns {PositionLevelDefinition~RequiredGroup[]}
 		 */
 		get requiredGroups() {
 			return this._requiredGroups;
@@ -147,6 +147,8 @@ module.exports = (() => {
 			const requiredGroup = this._requiredGroupGenerator(input);
 
 			if (requiredGroup !== null) {
+				validateRequiredGroup(requiredGroup, 'requiredGroup');
+
 				this._requiredGroups.push(requiredGroup);
 			}
 
@@ -255,6 +257,13 @@ module.exports = (() => {
 		}
 	}
 
+	function validateRequiredGroup(requiredGroup, variableName) {
+		assert.argumentIsRequired(requiredGroup, variableName, Object);
+		assert.argumentIsRequired(requiredGroup.key, `${variableName}.key`, String);
+		assert.argumentIsRequired(requiredGroup.description, `${variableName}.description`, String);
+		assert.argumentIsRequired(requiredGroup.currency, `${variableName}.currency`, Currency, 'Currency');
+	}
+
 	/**
 	 * A callback used to determine the eligibility for membership of a {@link PositionItem}
 	 * within a group.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "9.0.1",
+  "version": "9.1.0",
   "description": "Common JavaScript code used by Barchart's Portfolio Service",
   "author": {
     "name": "Bryan Ingle",