@barchart/portfolio-api-common 1.0.70 → 1.0.74

package/lib/data/InstrumentType.js

@@ -13,15 +13,23 @@ module.exports = (() => {
 	 * @param {String} alternateDescription
 	 * @param {String} code
 	 * @param {Boolean} canReinvest
+	 * @param {Boolean} usesSymbols
 	 */
 	class InstrumentType extends Enum {
-		constructor(code, description, alternateDescription, canReinvest) {
+		constructor(code, description, alternateDescription, canReinvest, usesSymbols) {
 			super(code, description);
 
 			this._alternateDescription = alternateDescription;
 			this._canReinvest = canReinvest;
+			this._usesSymbols = usesSymbols;
 		}
 
+		/**
+		 * A human-readable description.
+		 *
+		 * @public
+		 * @return {String}
+		 */
 		get alternateDescription() {
 			return this._alternateDescription;
 		}
@@ -29,16 +37,28 @@ module.exports = (() => {
 		/**
 		 * Indicates if the instrument type allows automatic reinvestment.
 		 *
+		 * @public
 		 * @returns {Boolean}
 		 */
 		get canReinvest() {
 			return this._canReinvest;
 		}
 
+		/**
+		 * Indicates if an instrument of this type can be represented by a symbol.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get usesSymbols() {
+			return this._usesSymbols;
+		}
+
 		/**
 		 * Cash.
 		 *
 		 * @public
+		 * @static
 		 * @returns {InstrumentType}
 		 */
 		static get CASH() {
@@ -49,6 +69,7 @@ module.exports = (() => {
 		 * An equity issue.
 		 *
 		 * @public
+		 * @static
 		 * @returns {InstrumentType}
 		 */
 		static get EQUITY() {
@@ -59,6 +80,7 @@ module.exports = (() => {
 		 * A mutual fund.
 		 *
 		 * @public
+		 * @static
 		 * @returns {InstrumentType}
 		 */
 		static get FUND() {
@@ -69,6 +91,7 @@ module.exports = (() => {
 		 * An undefined asset (e.g. a house, or a collectible, or a salvaged alien spaceship).
 		 *
 		 * @public
+		 * @static
 		 * @returns {InstrumentType}
 		 */
 		static get OTHER() {
@@ -80,10 +103,10 @@ module.exports = (() => {
 		}
 	}
 
-	const cash = new InstrumentType('CASH', 'cash', 'Cash', false);
-	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true);
-	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true);
-	const other = new InstrumentType('OTHER', 'other', 'Other', false);
+	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false);
+	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true);
+	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, true);
+	const other = new InstrumentType('OTHER', 'other', 'Other', false, false);
 
 	return InstrumentType;
 })();

package/lib/data/PositionSummaryFrame.js

@@ -239,7 +239,7 @@ module.exports = (() => {
 	}
 
 	function getYearToDateRangeDescription(startDate, endDate) {
-		return '';
+		return `${endDate.year.toString()} YTD`;
 	}
 
 	function getFilteredTransactions(transactions) {

package/lib/processing/PositionContainer.js

@@ -109,13 +109,13 @@ module.exports = (() => {
 				const populatedGroups = Object.keys(populatedObjects).map(key => populatedObjects[key]).map((items) => {
 					const first = items[0];
 
-					return new PositionGroup(parent, items, currentDefinition.currencySelector(first), currentDefinition.descriptionSelector(first), currentDefinition.single && items.length === 1);
+					return new PositionGroup(this, parent, items, currentDefinition.currencySelector(first), currentDefinition.descriptionSelector(first), currentDefinition.single && items.length === 1);
 				});
 
 				const missingGroups = array.difference(currentDefinition.requiredGroups.map(group => group.description), populatedGroups.map(group => group.description));
 
 				const empty = missingGroups.map((description) => {
-					return new PositionGroup(parent, [ ], currentDefinition.requiredGroups.find(group => group.description === description).currency, description);
+					return new PositionGroup(this, parent, [ ], currentDefinition.requiredGroups.find(group => group.description === description).currency, description);
 				});
 
 				const compositeGroups = populatedGroups.concat(empty);
@@ -186,10 +186,20 @@ module.exports = (() => {
 			}, [ ]);
 		}
 
-		setExchangeRage(symbol, price) {
+		setExchangeRate(symbol, price) {
 
 		}
 
+		startTransaction(executor) {
+			assert.argumentIsRequired(executor, 'executor', Function);
+
+			this._tree.walk(group => group.setSuspended(true), false, false);
+
+			executor(this);
+
+			this._tree.walk(group => group.setSuspended(false), false, false);
+		}
+
 		getGroup(keys) {
 			const node = keys.reduce((tree, key) => {
 				tree = tree.findChild(group => group.description === key);

package/lib/processing/PositionGroup.js

@@ -11,7 +11,8 @@ module.exports = (() => {
 	 * @public
 	 */
 	class PositionGroup {
-		constructor(parent, items, currency, description, single) {
+		constructor(container, parent, items, currency, description, single) {
+			this._container = container;
 			this._parent = parent || null;
 
 			this._items = items;
@@ -21,6 +22,9 @@ module.exports = (() => {
 
 			this._single = is.boolean(single) && single;
 
+			this._excluded = false;
+			this._suspended = false;
+
 			this._dataFormat = { };
 			this._dataActual = { };
 			
@@ -62,12 +66,11 @@ module.exports = (() => {
 						this._dataFormat.currentPrice = null;
 					}
 
-					calculatePriceData(this, sender);
+					calculatePriceData(this, sender, false);
 				});
 			});
 
-			calculateStaticData(this);
-			calculatePriceData(this);
+			this.refresh();
 		}
 
 		get items() {
@@ -90,6 +93,41 @@ module.exports = (() => {
 			return this._single;
 		}
 
+		get suspended() {
+			return this._suspended;
+		}
+
+		get excluded() {
+			return this._excluded;
+		}
+
+		setExcluded(value) {
+			assert.argumentIsRequired(value, 'value', Boolean);
+
+			if (this._excluded !== value) {
+				this._container.startTransaction(() => {
+					this._items.forEach((item) => {
+						item.setExcluded(value);
+					});
+				});
+			}
+		}
+
+		setSuspended(value) {
+			assert.argumentIsRequired(value, 'value', Boolean);
+
+			if (this._suspended !== value) {
+				if (this._suspended = value) {
+					this.refresh();
+				}
+			}
+		}
+
+		refresh() {
+			calculateStaticData(this);
+			calculatePriceData(this, null, true);
+		}
+
 		toString() {
 			return '[PositionGroup]';
 		}
@@ -116,6 +154,10 @@ module.exports = (() => {
 	}
 
 	function calculateStaticData(group) {
+		if (group.suspended) {
+			return;
+		}
+
 		const actual = group._dataActual;
 		const format = group._dataFormat;
 
@@ -152,7 +194,11 @@ module.exports = (() => {
 		format.summaryTwoTotal = formatCurrency(updates.summaryTwoTotal, currency);
 	}
 
-	function calculatePriceData(group, item) {
+	function calculatePriceData(group, item, forceRefresh) {
+		if (group.suspended) {
+			return;
+		}
+
 		const parent = group._parent;
 
 		const actual = group._dataActual;
@@ -160,14 +206,11 @@ module.exports = (() => {
 
 		const currency = group.currency;
 
+		const refresh = (is.boolean(forceRefresh) && forceRefresh) || (actual.market === null || actual.unrealizedToday === null || actual.total === null);
+
 		let updates;
 
-		if (actual.market !== null && actual.unrealizedToday !== null && actual.total !== null) {
-			updates = {
-				market: actual.market.add(item.data.marketChange),
-				unrealizedToday: actual.unrealizedToday.add(item.data.unrealizedTodayChange)
-			};
-		} else {
+		if (refresh) {
 			const items = group._items;
 
 			updates = items.reduce((updates, item) => {
@@ -177,8 +220,14 @@ module.exports = (() => {
 				return updates;
 			}, {
 				market: Decimal.ZERO,
+
 				unrealizedToday: Decimal.ZERO
 			});
+		} else {
+			updates = {
+				market: actual.market.add(item.data.marketChange),
+				unrealizedToday: actual.unrealizedToday.add(item.data.unrealizedTodayChange)
+			};
 		}
 		
 		if (parent !== null) {

package/lib/processing/PositionItem.js

@@ -33,10 +33,13 @@ module.exports = (() => {
 			this._data.realized = null;
 			this._data.income = null;
 
+			this._excluded = false;
+
 			calculateStaticData(this);
 			calculatePriceData(this, null);
 
 			this._priceChangeEvent = new Event(this);
+			this._excludedChangeEvent = new Event(this);
 		}
 
 		get portfolio() {
@@ -55,7 +58,13 @@ module.exports = (() => {
 			return this._data;
 		}
 
+		get excluded() {
+			return this._excluded;
+		}
+
 		setPrice(price) {
+			assert.argumentIsRequired(price, 'price', Number);
+
 			if (this._data.price !== price) {
 				calculatePriceData(this, this._data.currentPrice = price);
 
@@ -63,12 +72,22 @@ module.exports = (() => {
 			}
 		}
 
-		registerPriceChangeHandler(handler) {
-			assert.argumentIsRequired(handler, 'handler', Function);
+		setExcluded(value) {
+			assert.argumentIsRequired(value, 'value', Boolean);
 
+			if (this._excluded !== value) {
+				this._excludedChangeEvent.fire(this, this._excluded = value);
+			}
+		}
+
+		registerPriceChangeHandler(handler) {
 			this._priceChangeEvent.register(handler);
 		}
 
+		registerExcludedChangeHandler(handler) {
+			this._excludedChangeEvent.register(handler);
+		}
+
 		toString() {
 			return '[PositionItem]';
 		}
@@ -99,7 +118,7 @@ module.exports = (() => {
 		const getSummaryTotal = (index) => {
 			let summaryTotal;
 
-			if (summaries.length > (index + 1) && summaries[index] !== null) {
+			if (summaries.length > index && summaries[index] !== null) {
 				const period = summaries[index].period;
 
 				summaryTotal = period.realized.add(period.unrealized).add(period.income);

package/lib/serialization/PortfolioSchema.js

@@ -155,6 +155,7 @@ module.exports = (() => {
 	);
 
 	const update = new PortfolioSchema(SchemaBuilder.withName('update')
+		.withField('portfolio', DataType.STRING)
 		.withField('name', DataType.STRING)
 		.withField('timezone', DataType.forEnum(Timezones, 'Timezone'), true)
 		.withField('defaults.currency', DataType.forEnum(Currency, 'Currency'), true)

package/lib/serialization/TransactionSchema.js

@@ -391,8 +391,6 @@ module.exports = (() => {
 		.withField('instrument.name', DataType.STRING, true)
 		.withField('instrument.type', DataType.STRING, true)
 		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'), true)
-		.withField('instrument.symbol.barchart', DataType.STRING, true)
-		.withField('instrument.symbol.display', DataType.STRING, true)
 		.withField('date', DataType.DAY)
 		.withField('amount', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)

package/package.json

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

package/test/SpecRunner.js

@@ -14,15 +14,23 @@ module.exports = (() => {
 	 * @param {String} alternateDescription
 	 * @param {String} code
 	 * @param {Boolean} canReinvest
+	 * @param {Boolean} usesSymbols
 	 */
 	class InstrumentType extends Enum {
-		constructor(code, description, alternateDescription, canReinvest) {
+		constructor(code, description, alternateDescription, canReinvest, usesSymbols) {
 			super(code, description);
 
 			this._alternateDescription = alternateDescription;
 			this._canReinvest = canReinvest;
+			this._usesSymbols = usesSymbols;
 		}
 
+		/**
+		 * A human-readable description.
+		 *
+		 * @public
+		 * @return {String}
+		 */
 		get alternateDescription() {
 			return this._alternateDescription;
 		}
@@ -30,16 +38,28 @@ module.exports = (() => {
 		/**
 		 * Indicates if the instrument type allows automatic reinvestment.
 		 *
+		 * @public
 		 * @returns {Boolean}
 		 */
 		get canReinvest() {
 			return this._canReinvest;
 		}
 
+		/**
+		 * Indicates if an instrument of this type can be represented by a symbol.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get usesSymbols() {
+			return this._usesSymbols;
+		}
+
 		/**
 		 * Cash.
 		 *
 		 * @public
+		 * @static
 		 * @returns {InstrumentType}
 		 */
 		static get CASH() {
@@ -50,6 +70,7 @@ module.exports = (() => {
 		 * An equity issue.
 		 *
 		 * @public
+		 * @static
 		 * @returns {InstrumentType}
 		 */
 		static get EQUITY() {
@@ -60,6 +81,7 @@ module.exports = (() => {
 		 * A mutual fund.
 		 *
 		 * @public
+		 * @static
 		 * @returns {InstrumentType}
 		 */
 		static get FUND() {
@@ -70,6 +92,7 @@ module.exports = (() => {
 		 * An undefined asset (e.g. a house, or a collectible, or a salvaged alien spaceship).
 		 *
 		 * @public
+		 * @static
 		 * @returns {InstrumentType}
 		 */
 		static get OTHER() {
@@ -81,10 +104,10 @@ module.exports = (() => {
 		}
 	}
 
-	const cash = new InstrumentType('CASH', 'cash', 'Cash', false);
-	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true);
-	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true);
-	const other = new InstrumentType('OTHER', 'other', 'Other', false);
+	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false);
+	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true);
+	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, true);
+	const other = new InstrumentType('OTHER', 'other', 'Other', false, false);
 
 	return InstrumentType;
 })();
@@ -331,7 +354,7 @@ module.exports = (() => {
 	}
 
 	function getYearToDateRangeDescription(startDate, endDate) {
-		return '';
+		return `${endDate.year.toString()} YTD`;
 	}
 
 	function getFilteredTransactions(transactions) {
@@ -786,13 +809,13 @@ module.exports = (() => {
 				const populatedGroups = Object.keys(populatedObjects).map(key => populatedObjects[key]).map((items) => {
 					const first = items[0];
 
-					return new PositionGroup(parent, items, currentDefinition.currencySelector(first), currentDefinition.descriptionSelector(first), currentDefinition.single && items.length === 1);
+					return new PositionGroup(this, parent, items, currentDefinition.currencySelector(first), currentDefinition.descriptionSelector(first), currentDefinition.single && items.length === 1);
 				});
 
 				const missingGroups = array.difference(currentDefinition.requiredGroups.map(group => group.description), populatedGroups.map(group => group.description));
 
 				const empty = missingGroups.map((description) => {
-					return new PositionGroup(parent, [ ], currentDefinition.requiredGroups.find(group => group.description === description).currency, description);
+					return new PositionGroup(this, parent, [ ], currentDefinition.requiredGroups.find(group => group.description === description).currency, description);
 				});
 
 				const compositeGroups = populatedGroups.concat(empty);
@@ -863,10 +886,20 @@ module.exports = (() => {
 			}, [ ]);
 		}
 
-		setExchangeRage(symbol, price) {
+		setExchangeRate(symbol, price) {
 
 		}
 
+		startTransaction(executor) {
+			assert.argumentIsRequired(executor, 'executor', Function);
+
+			this._tree.walk(group => group.setSuspended(true), false, false);
+
+			executor(this);
+
+			this._tree.walk(group => group.setSuspended(false), false, false);
+		}
+
 		getGroup(keys) {
 			const node = keys.reduce((tree, key) => {
 				tree = tree.findChild(group => group.description === key);
@@ -913,7 +946,8 @@ module.exports = (() => {
 	 * @public
 	 */
 	class PositionGroup {
-		constructor(parent, items, currency, description, single) {
+		constructor(container, parent, items, currency, description, single) {
+			this._container = container;
 			this._parent = parent || null;
 
 			this._items = items;
@@ -923,6 +957,9 @@ module.exports = (() => {
 
 			this._single = is.boolean(single) && single;
 
+			this._excluded = false;
+			this._suspended = false;
+
 			this._dataFormat = { };
 			this._dataActual = { };
 			
@@ -964,12 +1001,11 @@ module.exports = (() => {
 						this._dataFormat.currentPrice = null;
 					}
 
-					calculatePriceData(this, sender);
+					calculatePriceData(this, sender, false);
 				});
 			});
 
-			calculateStaticData(this);
-			calculatePriceData(this);
+			this.refresh();
 		}
 
 		get items() {
@@ -992,6 +1028,41 @@ module.exports = (() => {
 			return this._single;
 		}
 
+		get suspended() {
+			return this._suspended;
+		}
+
+		get excluded() {
+			return this._excluded;
+		}
+
+		setExcluded(value) {
+			assert.argumentIsRequired(value, 'value', Boolean);
+
+			if (this._excluded !== value) {
+				this._container.startTransaction(() => {
+					this._items.forEach((item) => {
+						item.setExcluded(value);
+					});
+				});
+			}
+		}
+
+		setSuspended(value) {
+			assert.argumentIsRequired(value, 'value', Boolean);
+
+			if (this._suspended !== value) {
+				if (this._suspended = value) {
+					this.refresh();
+				}
+			}
+		}
+
+		refresh() {
+			calculateStaticData(this);
+			calculatePriceData(this, null, true);
+		}
+
 		toString() {
 			return '[PositionGroup]';
 		}
@@ -1018,6 +1089,10 @@ module.exports = (() => {
 	}
 
 	function calculateStaticData(group) {
+		if (group.suspended) {
+			return;
+		}
+
 		const actual = group._dataActual;
 		const format = group._dataFormat;
 
@@ -1054,7 +1129,11 @@ module.exports = (() => {
 		format.summaryTwoTotal = formatCurrency(updates.summaryTwoTotal, currency);
 	}
 
-	function calculatePriceData(group, item) {
+	function calculatePriceData(group, item, forceRefresh) {
+		if (group.suspended) {
+			return;
+		}
+
 		const parent = group._parent;
 
 		const actual = group._dataActual;
@@ -1062,14 +1141,11 @@ module.exports = (() => {
 
 		const currency = group.currency;
 
+		const refresh = (is.boolean(forceRefresh) && forceRefresh) || (actual.market === null || actual.unrealizedToday === null || actual.total === null);
+
 		let updates;
 
-		if (actual.market !== null && actual.unrealizedToday !== null && actual.total !== null) {
-			updates = {
-				market: actual.market.add(item.data.marketChange),
-				unrealizedToday: actual.unrealizedToday.add(item.data.unrealizedTodayChange)
-			};
-		} else {
+		if (refresh) {
 			const items = group._items;
 
 			updates = items.reduce((updates, item) => {
@@ -1079,8 +1155,14 @@ module.exports = (() => {
 				return updates;
 			}, {
 				market: Decimal.ZERO,
+
 				unrealizedToday: Decimal.ZERO
 			});
+		} else {
+			updates = {
+				market: actual.market.add(item.data.marketChange),
+				unrealizedToday: actual.unrealizedToday.add(item.data.unrealizedTodayChange)
+			};
 		}
 		
 		if (parent !== null) {
@@ -1196,10 +1278,13 @@ module.exports = (() => {
 			this._data.realized = null;
 			this._data.income = null;
 
+			this._excluded = false;
+
 			calculateStaticData(this);
 			calculatePriceData(this, null);
 
 			this._priceChangeEvent = new Event(this);
+			this._excludedChangeEvent = new Event(this);
 		}
 
 		get portfolio() {
@@ -1218,7 +1303,13 @@ module.exports = (() => {
 			return this._data;
 		}
 
+		get excluded() {
+			return this._excluded;
+		}
+
 		setPrice(price) {
+			assert.argumentIsRequired(price, 'price', Number);
+
 			if (this._data.price !== price) {
 				calculatePriceData(this, this._data.currentPrice = price);
 
@@ -1226,12 +1317,22 @@ module.exports = (() => {
 			}
 		}
 
-		registerPriceChangeHandler(handler) {
-			assert.argumentIsRequired(handler, 'handler', Function);
+		setExcluded(value) {
+			assert.argumentIsRequired(value, 'value', Boolean);
+
+			if (this._excluded !== value) {
+				this._excludedChangeEvent.fire(this, this._excluded = value);
+			}
+		}
 
+		registerPriceChangeHandler(handler) {
 			this._priceChangeEvent.register(handler);
 		}
 
+		registerExcludedChangeHandler(handler) {
+			this._excludedChangeEvent.register(handler);
+		}
+
 		toString() {
 			return '[PositionItem]';
 		}
@@ -1262,7 +1363,7 @@ module.exports = (() => {
 		const getSummaryTotal = (index) => {
 			let summaryTotal;
 
-			if (summaries.length > (index + 1) && summaries[index] !== null) {
+			if (summaries.length > index && summaries[index] !== null) {
 				const period = summaries[index].period;
 
 				summaryTotal = period.realized.add(period.unrealized).add(period.income);