@barchart/portfolio-api-common 7.5.0 → 8.0.0

package/lib/processing/PositionContainer.js

@@ -6,6 +6,7 @@ const array = require('@barchart/common-js/lang/array'),
 	CurrencyTranslator = require('@barchart/common-js/lang/CurrencyTranslator'),
 	Day = require('@barchart/common-js/lang/Day'),
 	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'),
 	is = require('@barchart/common-js/lang/is'),
@@ -86,6 +87,11 @@ module.exports = (() => {
 
 			this._groupBindings = { };
 
+			this._calculationSuspensions = new Set();
+
+			this._suspendedForexQuotes = new Map();
+			this._suspendedPositionQuotes = new Map();
+
 			this._reporting = reportFrame instanceof PositionSummaryFrame;
 			this._useBarchartPriceFormattingRules = false;
 
@@ -201,6 +207,48 @@ module.exports = (() => {
 			recalculatePercentages.call(this);
 		}
 
+		/**
+		 * Suspends recalculation of aggregated position data.
+		 *
+		 * @public
+		 * @returns {Disposable}
+		 */
+		suspendCalculations() {
+			const token = { };
+
+			const disposable = Disposable.fromAction(() => {
+				if (this._calculationSuspensions.delete(token) && this._calculationSuspensions.size === 0) {
+					const positionQuotes = [ ...this._suspendedPositionQuotes.entries() ];
+					const forexQuotes = [ ...this._suspendedForexQuotes.entries() ];
+
+					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._calculationSuspensions.add(token);
+
+			if (this._calculationSuspensions.size === 1) {
+				Object.keys(this._trees).forEach((key) => {
+					this._trees[key].walk(group => group.suspendCalculations(), false, false);
+				});
+
+				recalculatePercentages.call(this);
+			}
+
+			return disposable;
+		}
+
+		getCalculationsSuspended() {
+			return this._calculationSuspensions.size !== 0;
+		}
+
 		/**
 		 * Returns Barchart's user identifier for the container's portfolios. If
 		 * the container has no portfolios, a null value is returned.
@@ -209,18 +257,16 @@ module.exports = (() => {
 		 * @returns {String|null}
 		 */
 		getBarchartUserId() {
-			let returnRef = null;
-
 			const keys = Object.keys(this._portfolios);
 
 			if (keys.length > 0) {
 				const firstKey = keys[0];
 				const firstPortfolio = this._portfolios[firstKey];
 
-				returnRef = firstPortfolio.user;
+				return firstPortfolio.user;
 			}
 
-			return returnRef;
+			return null;
 		}
 
 		/**
@@ -232,8 +278,6 @@ module.exports = (() => {
 		 * @returns {String|null}
 		 */
 		getCustomerUserId() {
-			let returnRef = null;
-
 			const keys = Object.keys(this._portfolios);
 
 			if (keys.length > 0) {
@@ -241,11 +285,11 @@ module.exports = (() => {
 				const firstPortfolio = this._portfolios[firstKey];
 
 				if (firstPortfolio.legacy && firstPortfolio.legacy.user) {
-					returnRef = firstPortfolio.legacy.user;
+					return firstPortfolio.legacy.user;
 				}
 			}
 
-			return returnRef;
+			return null;
 		}
 
 		/**
@@ -402,14 +446,13 @@ module.exports = (() => {
 				return;
 			}
 
-			const existingBarchartSymbols = this.getPositionSymbols(false);
+			const existingBarchartSymbols = this.getPositionSymbols(false, false);
 
-			let exchange;
+			let exchangeCode = extractExchangeCode(position);
+			let exchange = null;
 
-			if (extractExchangeCode(position)) {
-				const code = extractExchangeCode(position);
-
-				exchange = this._exchanges[code] || null;
+			if (exchangeCode !== null) {
+				exchange = this._exchanges[exchangeCode] || null;
 			}
 
 			let currentQuote = null;
@@ -471,7 +514,7 @@ module.exports = (() => {
 				this._positionSymbolAddedEvent.fire(addedBarchartSymbol);
 			}
 
-			if (exchange) {
+			if (exchange !== null) {
 				item.setExchangeStatus(exchange);
 			}
 
@@ -519,7 +562,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Boolean} display - If true, all "display" symbols are returned; otherwise Barchart symbols are returned.
-		 * @param {Boolean} excludeExpired - If true, only non-expired symbols are filtered.
+		 * @param {Boolean} excludeExpired - If true, only symbols for non-expired positions will be returned.
 		 * @returns {String[]}
 		 */
 		getPositionSymbols(display, excludeExpired) {
@@ -634,6 +677,22 @@ module.exports = (() => {
 			assert.argumentIsArray(forexQuotes, 'forexQuotes');
 			assert.argumentIsOptional(force, 'force', Boolean);
 
+			if (this.getCalculationsSuspended()) {
+				forexQuotes.forEach((quote) => {
+					const symbol = quote.symbol;
+
+					this._suspendedForexQuotes.set(symbol, quote);
+				});
+
+				positionQuotes.forEach((quote) => {
+					const symbol = quote.symbol;
+
+					this._suspendedPositionQuotes.set(symbol, quote);
+				});
+
+				return;
+			}
+
 			if (forexQuotes.length !== 0) {
 				forexQuotes.forEach((quote) => {
 					const symbol = quote.symbol;
@@ -947,41 +1006,39 @@ module.exports = (() => {
 	function findParentGroup(group, predicate) {
 		const groupNode = this._nodes[group.id];
 
-		let returnRef = null;
-
 		if (groupNode) {
 			const resultNode = groupNode.findParent((candidateGroup, candidateNode) => !candidateNode.getIsRoot() && predicate(candidateGroup));
 
 			if (resultNode) {
-				returnRef = resultNode.getValue();
+				return resultNode.getValue();
 			}
 		}
 
-		return returnRef;
+		return null;
 	}
 
 	function extractSymbolForBarchart(position) {
 		if (position.instrument && position.instrument.symbol && position.instrument.symbol.barchart) {
 			return position.instrument.symbol.barchart;
-		} else {
-			return null;
 		}
+
+		return null;
 	}
 
 	function extractSymbolForDisplay(position) {
 		if (position.instrument && position.instrument.symbol && position.instrument.symbol.display) {
 			return position.instrument.symbol.display;
-		} else {
-			return null;
 		}
+
+		return null;
 	}
 
 	function extractExchangeCode(position) {
 		if (position.instrument && position.instrument.exchange) {
 			return position.instrument.exchange;
-		} else {
-			return null;
 		}
+
+		return null;
 	}
 
 	function addGroupBinding(group, dispoable) {
@@ -1056,7 +1113,7 @@ module.exports = (() => {
 			const items = populatedObjects[key];
 			const first = items[0];
 
-			const group = new PositionGroup(levelDefinition, items, levelDefinition.currencySelector(first), currencyTranslator, key, levelDefinition.descriptionSelector(first), levelDefinition.aggregateCash);
+			const group = new PositionGroup(levelDefinition, items, levelDefinition.currencySelector(first), currencyTranslator, key, levelDefinition.descriptionSelector(first), this.getCalculationsSuspended());
 
 			group.setBarchartPriceFormattingRules(this._useBarchartPriceFormattingRules);
 
@@ -1072,15 +1129,15 @@ module.exports = (() => {
 				return requiredGroupsToUse.find(g => g.key === key);
 			});
 
-		const empty = missingGroups.map((group) => {
-			const eg = new PositionGroup(levelDefinition, [ ], group.currency, currencyTranslator, group.key, group.description);
+		const emptyGroups = missingGroups.map((group) => {
+			const empty = new PositionGroup(levelDefinition, [ ], group.currency, currencyTranslator, group.key, group.description, this.getCalculationsSuspended());
 
-			eg.setBarchartPriceFormattingRules(this._useBarchartPriceFormattingRules);
+			empty.setBarchartPriceFormattingRules(this._useBarchartPriceFormattingRules);
 
-			return eg;
+			return empty;
 		});
 
-		const compositeGroups = populatedGroups.concat(empty);
+		const compositeGroups = populatedGroups.concat(emptyGroups);
 
 		let builder;
 
@@ -1201,22 +1258,16 @@ module.exports = (() => {
 	function createPositionItem(position, requireCurrentSummary) {
 		const portfolio = this._portfolios[position.portfolio];
 
-		let returnRef;
-
 		if (portfolio) {
 			const currentSummary = this._summariesCurrent[ position.position ] || null;
 			const previousSummaries = this._summariesPrevious[ position.position ] || getSummaryArray(this._previousSummaryRanges);
 
 			if (!requireCurrentSummary || currentSummary !== null) {
-				returnRef = new PositionItem(portfolio, position, currentSummary, previousSummaries, this._reporting, this._reportDate);
-			} else {
-				returnRef = null;
+				return new PositionItem(portfolio, position, currentSummary, previousSummaries, this._reporting, this._reportDate);
 			}
-		} else {
-			returnRef = null;
 		}
 
-		return returnRef;
+		return null;
 	}
 
 	function removePositionItem(positionItem) {
@@ -1258,6 +1309,10 @@ module.exports = (() => {
 	}
 
 	function recalculatePercentages() {
+		if (this.getCalculationsSuspended()) {
+			return;
+		}
+
 		Object.keys(this._trees).forEach((key) => {
 			this._trees[key].walk(group => group.refreshMarketPercent(), false, false);
 		});
@@ -1297,4 +1352,4 @@ module.exports = (() => {
 	 */
 
 	return PositionContainer;
-})();
+})();

package/lib/processing/PositionGroup.js

@@ -32,10 +32,10 @@ module.exports = (() => {
 	 * @param {CurrencyTranslator} currencyTranslator
 	 * @param {String} key
 	 * @param {String} description
-	 * @param {Boolean=} aggregateCash
+	 * @param {Boolean} calculationsSuspended
 	 */
 	class PositionGroup {
-		constructor(definition, items, currency, currencyTranslator, key, description, aggregateCash) {
+		constructor(definition, items, currency, currencyTranslator, key, description, calculationsSuspended) {
 			this._id = counter++;
 
 			this._definition = definition;
@@ -57,7 +57,7 @@ module.exports = (() => {
 			this._single = this._definition.single;
 			this._homogeneous = this._definition.homogeneous;
 
-			this._aggregateCash = is.boolean(aggregateCash) && aggregateCash;
+			this._calculationsSuspended = calculationsSuspended;
 
 			this._excluded = false;
 			this._showClosedPositions = false;
@@ -342,6 +342,28 @@ module.exports = (() => {
 			return this._excluded;
 		}
 
+		/**
+		 * Suspends recalculation of aggregated group data.
+		 *
+		 * @public
+		 */
+		suspendCalculations() {
+			this._calculationsSuspended = true;
+		}
+
+		/**
+		 * Resumes recalculation of aggregated group data.
+		 *
+		 * @public
+		 */
+		resumeCalculations() {
+			if (this._calculationsSuspended) {
+				this._calculationsSuspended = false;
+
+				this.refresh();
+			}
+		}
+
 		/**
 		 * Changes the group currency.
 		 *
@@ -512,17 +534,25 @@ module.exports = (() => {
 		 * @public
 		 */
 		refresh() {
+			if (this._calculationsSuspended) {
+				return;
+			}
+
 			calculateStaticData(this, this._definition);
 			calculatePriceData(this,null, true);
 		}
 
 		/**
-		 * Causes the percent of the position, with respect to the parent container's
+		 * Causes the percent of the group, with respect to the parent group's
 		 * total, to be recalculated.
 		 *
 		 * @public
 		 */
 		refreshMarketPercent() {
+			if (this._calculationsSuspended) {
+				return;
+			}
+
 			calculateMarketPercent(this, this._parentGroup, this._portfolioGroup);
 		}
 
@@ -600,6 +630,10 @@ module.exports = (() => {
 
 	function bindItem(item) {
 		const quoteBinding = item.registerQuoteChangeHandler((quote, sender) => {
+			if (this._calculationsSuspended) {
+				return;
+			}
+
 			if (this._single || (this._homogeneous && item === this._items[0])) {
 				const instrument = sender.position.instrument;
 				const currency = instrument.currency;
@@ -1144,6 +1178,7 @@ module.exports = (() => {
 
 		if (updates.marketDirection.up || updates.marketDirection.down) {
 			format.marketDirection = unchanged;
+
 			setTimeout(() => format.marketDirection = updates.marketDirection, 0);
 		}
 

package/lib/processing/definitions/PositionLevelDefinition.js

@@ -21,11 +21,10 @@ module.exports = (() => {
 	 * @param {PositionLevelDefinition~descriptionSelector} descriptionSelector
 	 * @param {PositionLevelDefinition~currencySelector} currencySelector
 	 * @param {PositionLevelDefinition~RequiredGroup[]=} requiredGroups
-	 * @param {Boolean=} aggregateCash
 	 * @param {Function=} requiredGroupGenerator
 	 */
 	class PositionLevelDefinition {
-		constructor(name, type, keySelector, descriptionSelector, currencySelector, requiredGroups, aggregateCash, requiredGroupGenerator) {
+		constructor(name, type, keySelector, descriptionSelector, currencySelector, requiredGroups, requiredGroupGenerator) {
 			assert.argumentIsRequired(name, 'name', String);
 			assert.argumentIsRequired(type, 'type', PositionLevelType, 'PositionLevelType');
 			assert.argumentIsRequired(keySelector, 'keySelector', Function);
@@ -36,7 +35,6 @@ module.exports = (() => {
 				assert.argumentIsArray(requiredGroups, 'requiredGroups', String);
 			}
 
-			assert.argumentIsOptional(aggregateCash, 'aggregateCash', Boolean);
 			assert.argumentIsOptional(requiredGroupGenerator, 'requiredGroupGenerator', Function);
 
 			this._name = name;
@@ -51,8 +49,6 @@ module.exports = (() => {
 			this._single = type === PositionLevelType.POSITION;
 			this._homogeneous = type === PositionLevelType.INSTRUMENT;
 
-			this._aggregateCash = is.boolean(aggregateCash) && aggregateCash;
-
 			this._requiredGroupGenerator = requiredGroupGenerator || (input => null);
 		}
 
@@ -140,16 +136,6 @@ module.exports = (() => {
 			return this._homogeneous;
 		}
 
-		/**
-		 * Indicates if the grouping level should aggregate cash positions.
-		 *
-		 * @public
-		 * @returns {Boolean}
-		 */
-		get aggregateCash() {
-			return this._aggregateCash;
-		}
-
 		/**
 		 * Given an input, potentially creates a new {@link PositionLevelDefinition~RequiredGroup}.
 		 *

package/lib/serialization/PortfolioSchema.js

@@ -5,6 +5,7 @@ const Currency = require('@barchart/common-js/lang/Currency'),
 	Timezones = require('@barchart/common-js/lang/Timezones');
 
 const SnapTradeLinkStatus = require('./../data/SnapTradeLinkStatus'),
+	SnapTradeLinkMode = require('./../data/SnapTradeLinkMode'),
 	ValuationType = require('./../data/ValuationType');
 
 module.exports = (() => {
@@ -96,96 +97,123 @@ module.exports = (() => {
 	const complete = new PortfolioSchema(SchemaBuilder.withName('complete')
 		.withField('user', DataType.STRING)
 		.withField('portfolio', DataType.STRING)
+
 		.withField('name', DataType.STRING)
 		.withField('timezone', DataType.forEnum(Timezones, 'Timezone'))
+		.withField('miscellany', DataType.AD_HOC, true)
+		.withField('email', DataType.AD_HOC, true)
+
 		.withField('dates.create', DataType.DAY)
 		.withField('dates.access', DataType.TIMESTAMP, true)
+
 		.withField('defaults.cash', DataType.BOOLEAN, true)
 		.withField('defaults.currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('defaults.reinvest', DataType.BOOLEAN, true)
 		.withField('defaults.valuation', DataType.forEnum(ValuationType, 'ValuationType'))
+
+		.withField('legacy.system', DataType.STRING, true)
+		.withField('legacy.user', DataType.STRING, true)
+		.withField('legacy.portfolio', DataType.STRING, true)
+		.withField('legacy.warnings', DataType.NUMBER, true)
+		.withField('legacy.drops', DataType.NUMBER, true)
+
 		.withField('snaptrade.connection', DataType.STRING, true)
 		.withField('snaptrade.account', DataType.STRING, true)
 		.withField('snaptrade.broken', DataType.BOOLEAN, true)
 		.withField('snaptrade.timestamp', DataType.TIMESTAMP, true)
+
+		.withField('snaptrade.brokerage.display', DataType.STRING, true)
+		.withField('snaptrade.brokerage.logo', DataType.STRING, true)
+
+		.withField('snaptrade.link.mode', DataType.forEnum(SnapTradeLinkMode, 'SnapTradeLinkMode'), true)
 		.withField('snaptrade.link.status', DataType.forEnum(SnapTradeLinkStatus, 'SnapTradeLinkStatus'), true)
 		.withField('snaptrade.link.progress', DataType.NUMBER, true)
 		.withField('snaptrade.link.timestamp', DataType.TIMESTAMP, true)
-		.withField('snaptrade.brokerage.display', DataType.STRING, true)
-		.withField('snaptrade.brokerage.logo', DataType.STRING, true)
-		.withField('legacy.system', DataType.STRING, true)
-		.withField('legacy.user', DataType.STRING, true)
-		.withField('legacy.portfolio', DataType.STRING, true)
-		.withField('legacy.warnings', DataType.NUMBER, true)
-		.withField('legacy.drops', DataType.NUMBER, true)
-		.withField('miscellany', DataType.AD_HOC, true)
-		.withField('email', DataType.AD_HOC, true)
-		.withField('system.calculate.processors', DataType.NUMBER, true)
+
 		.withField('system.sequence', DataType.NUMBER)
 		.withField('system.version', DataType.STRING)
 		.withField('system.timestamp', DataType.TIMESTAMP)
+		.withField('system.calculate.processors', DataType.NUMBER, true)
+
 		.schema
 	);
 
 	const client = new PortfolioSchema(SchemaBuilder.withName('client')
 		.withField('user', DataType.STRING)
 		.withField('portfolio', DataType.STRING)
+
 		.withField('name', DataType.STRING)
 		.withField('timezone', DataType.forEnum(Timezones, 'Timezone'))
+		.withField('miscellany', DataType.AD_HOC, true)
+		.withField('email', DataType.AD_HOC, true)
+
 		.withField('dates.create', DataType.DAY)
 		.withField('dates.access', DataType.TIMESTAMP, true)
+
 		.withField('defaults.cash', DataType.BOOLEAN, true)
 		.withField('defaults.currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('defaults.reinvest', DataType.BOOLEAN, true)
 		.withField('defaults.valuation', DataType.forEnum(ValuationType, 'ValuationType'))
+
+		.withField('legacy.system', DataType.STRING, true)
+		.withField('legacy.user', DataType.STRING, true)
+		.withField('legacy.portfolio', DataType.STRING, true)
+		.withField('legacy.warnings', DataType.NUMBER, true)
+		.withField('legacy.drops', DataType.NUMBER, true)
+
 		.withField('snaptrade.connection', DataType.STRING, true)
 		.withField('snaptrade.account', DataType.STRING, true)
 		.withField('snaptrade.broken', DataType.BOOLEAN, true)
 		.withField('snaptrade.timestamp', DataType.TIMESTAMP, true)
+
+		.withField('snaptrade.brokerage.display', DataType.STRING, true)
+		.withField('snaptrade.brokerage.logo', DataType.STRING, true)
+
+		.withField('snaptrade.link.mode', DataType.forEnum(SnapTradeLinkMode, 'SnapTradeLinkMode'), true)
 		.withField('snaptrade.link.status', DataType.forEnum(SnapTradeLinkStatus, 'SnapTradeLinkStatus'), true)
 		.withField('snaptrade.link.progress', DataType.NUMBER, true)
 		.withField('snaptrade.link.timestamp', DataType.TIMESTAMP, true)
-		.withField('snaptrade.brokerage.display', DataType.STRING, true)
-		.withField('snaptrade.brokerage.logo', DataType.STRING, true)
-		.withField('legacy.system', DataType.STRING, true)
-		.withField('legacy.user', DataType.STRING, true)
-		.withField('legacy.portfolio', DataType.STRING, true)
-		.withField('legacy.warnings', DataType.NUMBER, true)
-		.withField('legacy.drops', DataType.NUMBER, true)
-		.withField('miscellany', DataType.AD_HOC, true)
-		.withField('email', DataType.AD_HOC, true)
+
 		.withField('system.calculate.processors', DataType.NUMBER, true)
+
 		.schema
 	);
 
 	const name = new PortfolioSchema(SchemaBuilder.withName('name')
 		.withField('user', DataType.STRING)
 		.withField('portfolio', DataType.STRING)
+
 		.withField('name', DataType.STRING)
+
 		.schema
 	);
 
 	const create = new PortfolioSchema(SchemaBuilder.withName('create')
 		.withField('name', DataType.STRING)
 		.withField('timezone', DataType.forEnum(Timezones, 'Timezone'))
+		.withField('miscellany', DataType.AD_HOC, true)
+		.withField('email', DataType.AD_HOC, true)
+
 		.withField('defaults.cash', DataType.BOOLEAN, true)
 		.withField('defaults.currency', DataType.forEnum(Currency, 'Currency'), true)
 		.withField('defaults.reinvest', DataType.BOOLEAN, true)
 		.withField('defaults.valuation', DataType.forEnum(ValuationType, 'ValuationType'), true)
-		.withField('miscellany', DataType.AD_HOC, true)
-		.withField('email', DataType.AD_HOC, true)
+
 		.schema
 	);
 
 	const update = new PortfolioSchema(SchemaBuilder.withName('update')
 		.withField('portfolio', DataType.STRING)
-		.withField('name', DataType.STRING)
+
 		.withField('timezone', DataType.forEnum(Timezones, 'Timezone'), true)
+		.withField('name', DataType.STRING)
+		.withField('miscellany', DataType.AD_HOC, true)
+		.withField('email', DataType.AD_HOC, true)
+
 		.withField('defaults.cash', DataType.BOOLEAN, true)
 		.withField('defaults.currency', DataType.forEnum(Currency, 'Currency'), true)
 		.withField('defaults.reinvest', DataType.BOOLEAN, true)
-		.withField('miscellany', DataType.AD_HOC, true)
-		.withField('email', DataType.AD_HOC, true)
+
 		.schema
 	);
 

package/package.json

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