@barchart/portfolio-api-common 1.0.102 → 1.0.106

package/lib/processing/PositionContainer.js

@@ -213,12 +213,12 @@ module.exports = (() => {
 			return Object.keys(this._symbols);
 		}
 
-		setPositionPrice(symbol, price) {
-			assert.argumentIsOptional(symbol, 'symbol', String);
-			assert.argumentIsOptional(price, 'price', Number);
+		setPositionQuote(symbol, quote) {
+			assert.argumentIsRequired(symbol, 'symbol', String);
+			assert.argumentIsRequired(quote, 'quote', Object);
 
-			if (this._symbols.hasOwnProperty(symbol) && is.number(price)) {
-				this._symbols[symbol].forEach(item => item.setPrice(price));
+			if (this._symbols.hasOwnProperty(symbol)) {
+				this._symbols[symbol].forEach(item => item.setQuote(quote));
 			}
 		}
 
@@ -234,9 +234,9 @@ module.exports = (() => {
 			}, [ ]);
 		}
 
-		setForexPrice(symbol, price) {
-			assert.argumentIsOptional(symbol, 'symbol', String);
-			assert.argumentIsOptional(price, 'price', Number);
+		setForexQuote(symbol, quote) {
+			assert.argumentIsRequired(symbol, 'symbol', String);
+			assert.argumentIsRequired(quote, 'quote', Object);
 
 			return;
 		}

package/lib/processing/PositionGroup.js

@@ -35,12 +35,23 @@ module.exports = (() => {
 			this._dataFormat.key = this._key;
 			this._dataFormat.description = this._description;
 
+			this._dataFormat.quantity = null;
+
 			if (this._single) {
 				this._dataFormat.instrument = items[0].position.instrument;
 			} else {
 				this._dataFormat.instrument = null;
 			}
 
+			this._dataFormat.quoteLast = null;
+			this._dataFormat.quoteOpen = null;
+			this._dataFormat.quoteHigh = null;
+			this._dataFormat.quoteLow = null;
+			this._dataFormat.quoteChange = null;
+			this._dataFormat.quoteChangePercent = null;
+			this._dataFormat.quoteTime = null;
+			this._dataFormat.quoteVolume = null;
+
 			this._dataActual.currentPrice = null;
 			this._dataActual.previousPrice = null;
 			this._dataActual.basis = null;
@@ -71,10 +82,21 @@ module.exports = (() => {
 			this._dataFormat.summaryTotalPreviousNegative = false;
 
 			this._items.forEach((item) => {
-				item.registerPriceChangeHandler((data, sender) => {
+				item.registerQuoteChangeHandler((quote, sender) => {
 					if (this._single) {
-						this._dataActual.currentPrice = data.currentPrice;
-						this._dataFormat.currentPrice = formatCurrency(data.currentPrice, sender.position.instrument.currency);
+						const precision = sender.position.instrument.currency.precision;
+
+						this._dataActual.currentPrice = sender.data.currentPrice;
+						this._dataFormat.currentPrice = formatNumber(this._dataActual.currentPrice, precision);
+
+						this._dataFormat.quoteLast = formatNumber(quote.previousPrice, precision);
+						this._dataFormat.quoteOpen = formatNumber(quote.openPrice, precision);
+						this._dataFormat.quoteHigh = formatNumber(quote.highPrice, precision);
+						this._dataFormat.quoteLow = formatNumber(quote.lowPrice, precision);
+						this._dataFormat.quoteChange = formatNumber(quote.priceChange, precision);
+						this._dataFormat.quoteChangePercent = formatPercent(quote.percentChange, 2);
+						this._dataFormat.quoteTime = quote.timeDisplay;
+						this._dataFormat.quoteVolume = formatNumber(quote.volume, 0);
 					} else {
 						this._dataActual.currentPrice = null;
 						this._dataFormat.currentPrice = null;
@@ -163,9 +185,17 @@ module.exports = (() => {
 		}
 	}
 
-	function formatNumber(decimal, precision) {
+	function formatNumber(number, precision) {
+		if (is.number(number)) {
+			return formatter.numberToString(number, precision, ',', false);
+		} else {
+			return '—';
+		}
+	}
+
+	function formatDecimal(decimal, precision) {
 		if (decimal !== null) {
-			return formatter.numberToString(decimal.toFloat(), precision, ',', false);
+			return formatNumber(decimal.toFloat(), precision);
 		} else {
 			return '—';
 		}
@@ -173,14 +203,14 @@ module.exports = (() => {
 
 	function formatPercent(decimal, precision) {
 		if (decimal !== null) {
-			return formatNumber(decimal.multiply(100), precision);
+			return formatDecimal(decimal.multiply(100), precision);
 		} else {
 			return '—';
 		}
 	}
 
 	function formatCurrency(decimal, currency) {
-		return formatNumber(decimal, currency.precision);
+		return formatDecimal(decimal, currency.precision);
 	}
 
 	function calculateStaticData(group) {
@@ -223,6 +253,10 @@ module.exports = (() => {
 		format.summaryTotalCurrent = formatCurrency(updates.summaryTotalCurrent, currency);
 		format.summaryTotalPrevious = formatCurrency(updates.summaryTotalPrevious, currency);
 		format.summaryTotalPreviousNegative = updates.summaryTotalPrevious.getIsNegative();
+
+		if (group.single) {
+			format.quantity = formatDecimal(group.position.snapshot.open, 2);
+		}
 	}
 
 	function calculatePriceData(group, item, forceRefresh) {

package/lib/processing/PositionItem.js

@@ -16,7 +16,7 @@ module.exports = (() => {
 		constructor(portfolio, position, currentSummary, previousSummaries) {
 			this._portfolio = portfolio;
 			this._position = position;
-			
+
 			this._currentSummary = currentSummary || null;
 			this._previousSummaries = previousSummaries || [ ];
 
@@ -24,6 +24,9 @@ module.exports = (() => {
 
 			this._data.basis = null;
 
+			this._currentQuote = null;
+			this._previousQuote = null;
+
 			this._data.currentPrice = null;
 			this._data.previousPrice = null;
 
@@ -46,7 +49,7 @@ module.exports = (() => {
 			calculateStaticData(this);
 			calculatePriceData(this, null);
 
-			this._priceChangeEvent = new Event(this);
+			this._quoteChangedEvent = new Event(this);
 			this._excludedChangeEvent = new Event(this);
 		}
 
@@ -70,17 +73,24 @@ module.exports = (() => {
 			return this._data;
 		}
 
+		get quote() {
+			return this._currentQuote;
+		}
+
 		get excluded() {
 			return this._excluded;
 		}
 
-		setPrice(price) {
-			assert.argumentIsRequired(price, 'price', Number);
+		setQuote(quote) {
+			assert.argumentIsRequired(quote, 'quote', Object);
 
 			if (this._data.price !== price) {
-				calculatePriceData(this, this._data.currentPrice = price);
+				this._previousQuote = this._currentQuote;
+				this._currentQuote = quote;
+
+				calculatePriceData(this, this._currentQuote.lastPrice);
 
-				this._priceChangeEvent.fire(this._data);
+				this._quoteChangedEvent.fire(this._data, this._currentQuote);
 			}
 		}
 
@@ -92,8 +102,8 @@ module.exports = (() => {
 			}
 		}
 
-		registerPriceChangeHandler(handler) {
-			this._priceChangeEvent.register(handler);
+		registerQuoteChangeHandler(handler) {
+			this._quoteChangedEvent.register(handler);
 		}
 
 		registerExcludedChangeHandler(handler) {

package/package.json

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

package/test/SpecRunner.js

@@ -929,12 +929,12 @@ module.exports = (() => {
 			return Object.keys(this._symbols);
 		}
 
-		setPositionPrice(symbol, price) {
-			assert.argumentIsOptional(symbol, 'symbol', String);
-			assert.argumentIsOptional(price, 'price', Number);
+		setPositionQuote(symbol, quote) {
+			assert.argumentIsRequired(symbol, 'symbol', String);
+			assert.argumentIsRequired(quote, 'quote', Object);
 
-			if (this._symbols.hasOwnProperty(symbol) && is.number(price)) {
-				this._symbols[symbol].forEach(item => item.setPrice(price));
+			if (this._symbols.hasOwnProperty(symbol)) {
+				this._symbols[symbol].forEach(item => item.setQuote(quote));
 			}
 		}
 
@@ -950,9 +950,9 @@ module.exports = (() => {
 			}, [ ]);
 		}
 
-		setForexPrice(symbol, price) {
-			assert.argumentIsOptional(symbol, 'symbol', String);
-			assert.argumentIsOptional(price, 'price', Number);
+		setForexQuote(symbol, quote) {
+			assert.argumentIsRequired(symbol, 'symbol', String);
+			assert.argumentIsRequired(quote, 'quote', Object);
 
 			return;
 		}
@@ -1038,12 +1038,23 @@ module.exports = (() => {
 			this._dataFormat.key = this._key;
 			this._dataFormat.description = this._description;
 
+			this._dataFormat.quantity = null;
+
 			if (this._single) {
 				this._dataFormat.instrument = items[0].position.instrument;
 			} else {
 				this._dataFormat.instrument = null;
 			}
 
+			this._dataFormat.quoteLast = null;
+			this._dataFormat.quoteOpen = null;
+			this._dataFormat.quoteHigh = null;
+			this._dataFormat.quoteLow = null;
+			this._dataFormat.quoteChange = null;
+			this._dataFormat.quoteChangePercent = null;
+			this._dataFormat.quoteTime = null;
+			this._dataFormat.quoteVolume = null;
+
 			this._dataActual.currentPrice = null;
 			this._dataActual.previousPrice = null;
 			this._dataActual.basis = null;
@@ -1074,10 +1085,21 @@ module.exports = (() => {
 			this._dataFormat.summaryTotalPreviousNegative = false;
 
 			this._items.forEach((item) => {
-				item.registerPriceChangeHandler((data, sender) => {
+				item.registerQuoteChangeHandler((quote, sender) => {
 					if (this._single) {
-						this._dataActual.currentPrice = data.currentPrice;
-						this._dataFormat.currentPrice = formatCurrency(data.currentPrice, sender.position.instrument.currency);
+						const precision = sender.position.instrument.currency.precision;
+
+						this._dataActual.currentPrice = sender.data.currentPrice;
+						this._dataFormat.currentPrice = formatNumber(this._dataActual.currentPrice, precision);
+
+						this._dataFormat.quoteLast = formatNumber(quote.previousPrice, precision);
+						this._dataFormat.quoteOpen = formatNumber(quote.openPrice, precision);
+						this._dataFormat.quoteHigh = formatNumber(quote.highPrice, precision);
+						this._dataFormat.quoteLow = formatNumber(quote.lowPrice, precision);
+						this._dataFormat.quoteChange = formatNumber(quote.priceChange, precision);
+						this._dataFormat.quoteChangePercent = formatPercent(quote.percentChange, 2);
+						this._dataFormat.quoteTime = quote.timeDisplay;
+						this._dataFormat.quoteVolume = formatNumber(quote.volume, 0);
 					} else {
 						this._dataActual.currentPrice = null;
 						this._dataFormat.currentPrice = null;
@@ -1166,9 +1188,17 @@ module.exports = (() => {
 		}
 	}
 
-	function formatNumber(decimal, precision) {
+	function formatNumber(number, precision) {
+		if (is.number(number)) {
+			return formatter.numberToString(number, precision, ',', false);
+		} else {
+			return '—';
+		}
+	}
+
+	function formatDecimal(decimal, precision) {
 		if (decimal !== null) {
-			return formatter.numberToString(decimal.toFloat(), precision, ',', false);
+			return formatNumber(decimal.toFloat(), precision);
 		} else {
 			return '—';
 		}
@@ -1176,14 +1206,14 @@ module.exports = (() => {
 
 	function formatPercent(decimal, precision) {
 		if (decimal !== null) {
-			return formatNumber(decimal.multiply(100), precision);
+			return formatDecimal(decimal.multiply(100), precision);
 		} else {
 			return '—';
 		}
 	}
 
 	function formatCurrency(decimal, currency) {
-		return formatNumber(decimal, currency.precision);
+		return formatDecimal(decimal, currency.precision);
 	}
 
 	function calculateStaticData(group) {
@@ -1226,6 +1256,10 @@ module.exports = (() => {
 		format.summaryTotalCurrent = formatCurrency(updates.summaryTotalCurrent, currency);
 		format.summaryTotalPrevious = formatCurrency(updates.summaryTotalPrevious, currency);
 		format.summaryTotalPreviousNegative = updates.summaryTotalPrevious.getIsNegative();
+
+		if (group.single) {
+			format.quantity = formatDecimal(group.position.snapshot.open, 2);
+		}
 	}
 
 	function calculatePriceData(group, item, forceRefresh) {
@@ -1362,7 +1396,7 @@ module.exports = (() => {
 		constructor(portfolio, position, currentSummary, previousSummaries) {
 			this._portfolio = portfolio;
 			this._position = position;
-			
+
 			this._currentSummary = currentSummary || null;
 			this._previousSummaries = previousSummaries || [ ];
 
@@ -1370,6 +1404,9 @@ module.exports = (() => {
 
 			this._data.basis = null;
 
+			this._currentQuote = null;
+			this._previousQuote = null;
+
 			this._data.currentPrice = null;
 			this._data.previousPrice = null;
 
@@ -1392,7 +1429,7 @@ module.exports = (() => {
 			calculateStaticData(this);
 			calculatePriceData(this, null);
 
-			this._priceChangeEvent = new Event(this);
+			this._quoteChangedEvent = new Event(this);
 			this._excludedChangeEvent = new Event(this);
 		}
 
@@ -1416,17 +1453,24 @@ module.exports = (() => {
 			return this._data;
 		}
 
+		get quote() {
+			return this._currentQuote;
+		}
+
 		get excluded() {
 			return this._excluded;
 		}
 
-		setPrice(price) {
-			assert.argumentIsRequired(price, 'price', Number);
+		setQuote(quote) {
+			assert.argumentIsRequired(quote, 'quote', Object);
 
 			if (this._data.price !== price) {
-				calculatePriceData(this, this._data.currentPrice = price);
+				this._previousQuote = this._currentQuote;
+				this._currentQuote = quote;
+
+				calculatePriceData(this, this._currentQuote.lastPrice);
 
-				this._priceChangeEvent.fire(this._data);
+				this._quoteChangedEvent.fire(this._data, this._currentQuote);
 			}
 		}
 
@@ -1438,8 +1482,8 @@ module.exports = (() => {
 			}
 		}
 
-		registerPriceChangeHandler(handler) {
-			this._priceChangeEvent.register(handler);
+		registerQuoteChangeHandler(handler) {
+			this._quoteChangedEvent.register(handler);
 		}
 
 		registerExcludedChangeHandler(handler) {