@barchart/portfolio-api-common 4.0.0 → 5.0.0

package/lib/data/PositionSummaryFrame.js

@@ -213,7 +213,7 @@ module.exports = (() => {
 	 */
 
 	/**
-	 * The start and and date for a {@link PositionSummaryFrame} along with the frame type.
+	 * The start and end date for a {@link PositionSummaryFrame} along with the frame type.
 	 *
 	 * @typedef PositionSummaryDefinition
 	 * @type {Object}

package/lib/processing/PositionContainer.js

@@ -623,6 +623,22 @@ module.exports = (() => {
 			}
 		}
 
+		/**
+		 * Sets the reference date (today).
+		 *
+		 * @public
+		 * @param {Day} referenceDate
+		 */
+		setReferenceDate(referenceDate) {
+			assert.argumentIsRequired(referenceDate, 'referenceDate', Day, 'Day');
+
+			this._referenceDate = referenceDate;
+
+			this._items.forEach((item) => {
+				item.setReferenceDate(this._referenceDate);
+			});
+		}
+
 		/**
 		 * Returns current price for symbol provided.
 		 *

package/lib/processing/PositionGroup.js

@@ -4,7 +4,6 @@ const array = require('@barchart/common-js/lang/array'),
 	CurrencyTranslator = require('@barchart/common-js/lang/CurrencyTranslator'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
 	Disposable = require('@barchart/common-js/lang/Disposable'),
-	DisposableStack = require('@barchart/common-js/collections/specialized/DisposableStack'),
 	Event = require('@barchart/common-js/messaging/Event'),
 	formatter = require('@barchart/common-js/lang/formatter'),
 	is = require('@barchart/common-js/lang/is');
@@ -63,8 +62,6 @@ module.exports = (() => {
 			this._groupExcludedChangeEvent = new Event(this);
 			this._showClosedPositionsChangeEvent = new Event(this);
 
-			this._disposeStack = new DisposableStack();
-
 			this._excludedItems = [ ];
 			this._excludedItemMap = { };
 			this._consideredItems = this._items.slice(0);
@@ -598,52 +595,54 @@ module.exports = (() => {
 			calculatePriceData(this, sender, false);
 		});
 
-		let fundamentalBinding = item.registerFundamentalDataChangeHandler((data) => {
+		const fundamentalBinding = item.registerFundamentalDataChangeHandler((data) => {
 			if (this._single) {
 				this._dataFormat.fundamental = data;
-			} else {
-				const fundamentalFields = [ 'percentChange1m', 'percentChange1y', 'percentChange3m', 'percentChangeYtd' ];
 
-				const fundamentalData = this.items.reduce((sums, item, i) => {
-					if (item.data && item.data.fundamental && item.data.fundamental.raw) {
-						const fundamental = item.data.fundamental.raw;
+				return;
+			}
 
-						fundamentalFields.forEach((fieldName) => {
-							const summary = sums[fieldName];
-							const value = fundamental[fieldName];
+			const fundamentalFields = [ 'percentChange1m', 'percentChange1y', 'percentChange3m', 'percentChangeYtd' ];
 
-							if (is.number(value)) {
-								summary.total = sums[fieldName].total + value;
-								summary.count = sums[fieldName].count + 1;
-							}
+			const fundamentalData = this.items.reduce((sums, item, i) => {
+				if (item.data && item.data.fundamental && item.data.fundamental.raw) {
+					const fundamental = item.data.fundamental.raw;
 
-							if ((i + 1) == this.items.length) {
-								let averageFormat;
+					fundamentalFields.forEach((fieldName) => {
+						const summary = sums[fieldName];
+						const value = fundamental[fieldName];
 
-								if (summary.count > 0) {
-									averageFormat = formatPercent(new Decimal(summary.total / summary.count), 2, true);
-								} else {
-									averageFormat = '—';
-								}
+						if (is.number(value)) {
+							summary.total = sums[fieldName].total + value;
+							summary.count = sums[fieldName].count + 1;
+						}
 
-								summary.averageFormat = averageFormat;
+						if ((i + 1) == this.items.length) {
+							let averageFormat;
+
+							if (summary.count > 0) {
+								averageFormat = formatPercent(new Decimal(summary.total / summary.count), 2, true);
+							} else {
+								averageFormat = '—';
 							}
-						});
-					}
 
-					return sums;
-				}, fundamentalFields.reduce((sums, fieldName) => {
-					sums[fieldName] = { total: 0, count: 0, averageFormat: '—' };
+							summary.averageFormat = averageFormat;
+						}
+					});
+				}
 
-					return sums;
-				}, { }));
+				return sums;
+			}, fundamentalFields.reduce((sums, fieldName) => {
+				sums[fieldName] = { total: 0, count: 0, averageFormat: '—' };
 
-				this._dataFormat.fundamental = fundamentalFields.reduce((sums, fieldName) => {
-					sums[fieldName] = fundamentalData[fieldName].averageFormat;
+				return sums;
+			}, { }));
 
-					return sums;
-				}, { });
-			}
+			this._dataFormat.fundamental = fundamentalFields.reduce((sums, fieldName) => {
+				sums[fieldName] = fundamentalData[fieldName].averageFormat;
+
+				return sums;
+			}, { });
 		});
 
 		let newsBinding = Disposable.getEmpty();
@@ -665,7 +664,7 @@ module.exports = (() => {
 			});
 		}
 
-		this._disposeStack.push(item.registerPortfolioChangeHandler((portfolio) => {
+		const portfolioChangeBinding = item.registerPortfolioChangeHandler((portfolio) => {
 			const descriptionSelector = this._definition.descriptionSelector;
 
 			this._description = descriptionSelector(this._items[0]);
@@ -680,21 +679,27 @@ module.exports = (() => {
 			const currencySelector = this._definition.currencySelector;
 
 			this.changeCurrency(currencySelector({ portfolio }));
-		}));
+		});
 
-		this._disposeStack.push(fundamentalBinding);
-		this._disposeStack.push(quoteBinding);
-		this._disposeStack.push(lockedBinding);
-		this._disposeStack.push(calculatingBinding);
-		this._disposeStack.push(newsBinding);
+		const referenceDateBinding = item.registerReferenceDateChangeHandler(() => {
+			this.refresh();
+		});
 
-		this._disposeStack.push(item.registerPositionItemDisposeHandler(() => {
-			fundamentalBinding.dispose();
+		let disposalBinding = null;
+
+		disposalBinding = item.registerPositionItemDisposeHandler(() => {
 			quoteBinding.dispose();
+			fundamentalBinding.dispose();
+
 			newsBinding.dispose();
 			lockedBinding.dispose();
 			calculatingBinding.dispose();
 
+			portfolioChangeBinding.dispose();
+			referenceDateBinding.dispose();
+
+			disposalBinding.dispose();
+
 			array.remove(this._items, i => i === item);
 			array.remove(this._excludedItems, i => i === item);
 			array.remove(this._consideredItems, i => i === item);
@@ -702,7 +707,7 @@ module.exports = (() => {
 			delete this._excludedItemMap[item.position.position];
 
 			this.refresh();
-		}));
+		});
 	}
 
 	function formatNumber(number, precision) {

package/lib/processing/PositionItem.js

@@ -120,6 +120,7 @@ module.exports = (() => {
 			this._lockChangedEvent = new Event(this);
 			this._calculatingChangedEvent = new Event(this);
 			this._portfolioChangedEvent = new Event(this);
+			this._referenceDateChangedEvent = new Event(this);
 			this._positionItemDisposeEvent = new Event(this);
 
 			calculateStaticData(this, this._referenceDate);
@@ -254,14 +255,13 @@ module.exports = (() => {
 				return;
 			}
 
-			if (this._currentPricePrevious !== quote.lastPrice || force) {
+			if (this._currentPrice !== quote.lastPrice || force) {
 				if (quote.previousPrice) {
 					this._data.previousPrice = quote.previousPrice;
 				}
 
-				calculatePriceData(this, quote.lastPrice, quote.lastDay instanceof Day && quote.lastDay.getIsEqual(this._referenceDate));
+				calculatePriceData(this, quote.lastPrice, getQuoteIsToday(quote, this._referenceDate));
 
-				this._currentPricePrevious = this._currentPrice;
 				this._currentPrice = quote.lastPrice;
 
 				this._previousQuote = this._currentQuote;
@@ -346,6 +346,31 @@ module.exports = (() => {
 			}
 		}
 
+		/**
+		 * Sets the reference date (today).
+		 *
+		 * @public
+		 * @param {Day} referenceDate
+		 */
+		setReferenceDate(referenceDate) {
+			assert.argumentIsRequired(referenceDate, 'referenceDate', Day, 'Day');
+
+			if (this.getIsDisposed()) {
+				return;
+			}
+
+			if (this._referenceDate.getIsEqual(referenceDate)) {
+				return;
+			}
+
+			this._referenceDate = referenceDate;
+
+			calculateStaticData(this, this._referenceDate);
+			calculatePriceData(this, this._currentPrice, getQuoteIsToday(this._currentQuote, this._referenceDate));
+
+			this._referenceDateChangedEvent.fire(this._referenceDate);
+		}
+
 		/**
 		 * Registers an observer for quote changes, which is fired after internal recalculations
 		 * of position data are complete.
@@ -403,7 +428,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Registers an observer changes to portfolio metadata.
+		 * Registers an observer for changes to portfolio metadata.
 		 *
 		 * @public
 		 * @param {Function} handler
@@ -413,6 +438,17 @@ module.exports = (() => {
 			return this._portfolioChangedEvent.register(handler);
 		}
 
+		/**
+		 * Registers an observer for changes to the reference date (today).
+		 *
+		 * @public
+		 * @param {Function} handler
+		 * @returns {Disposable}
+		 */
+		registerReferenceDateChangeHandler(handler) {
+			return this._referenceDateChangedEvent.register(handler);
+		}
+
 		/**
 		 * Registers an observer for object disposal.
 		 *
@@ -431,7 +467,9 @@ module.exports = (() => {
 			this._newsExistsChangedEvent.clear();
 			this._fundamentalDataChangedEvent.clear();
 			this._lockChangedEvent.clear();
+			this._calculatingChangedEvent.clear();
 			this._portfolioChangedEvent.clear();
+			this._referenceDateChangedEvent.clear();
 			this._positionItemDisposeEvent.clear();
 		}
 
@@ -846,5 +884,9 @@ module.exports = (() => {
 		return snapshot;
 	}
 
+	function getQuoteIsToday(quote, referenceDate) {
+		return quote && quote.lastDay instanceof Day && referenceDate instanceof Day && quote.lastDay.getIsEqual(referenceDate);
+	}
+
 	return PositionItem;
 })();

package/lib/serialization/PositionSchema.js

@@ -93,6 +93,7 @@ module.exports = (() => {
 		.withField('instrument.type', DataType.forEnum(InstrumentType, 'InstrumentType'))
 		.withField('instrument.code', DataType.forEnum(UnitCode, 'UnitCode'), true)
 		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'))
+		.withField('instrument.exchange', DataType.STRING, true)
 		.withField('instrument.delist', DataType.DAY, true)
 		.withField('instrument.future.expiration', DataType.DAY, true)
 		.withField('instrument.future.tick', DataType.DECIMAL, true)
@@ -142,6 +143,7 @@ module.exports = (() => {
 		.withField('instrument.type', DataType.forEnum(InstrumentType, 'InstrumentType'))
 		.withField('instrument.code', DataType.forEnum(UnitCode, 'UnitCode'), true)
 		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'))
+		.withField('instrument.exchange', DataType.STRING, true)
 		.withField('instrument.delist', DataType.DAY, true)
 		.withField('instrument.future.expiration', DataType.DAY, true)
 		.withField('instrument.future.tick', DataType.DECIMAL, true)

package/package.json

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