@barchart/portfolio-api-common 1.0.84 → 1.0.89

package/lib/data/TransactionType.js

@@ -11,6 +11,7 @@ module.exports = (() => {
 	 * @extends {Enum}
 	 * @param {String} code
 	 * @param {String} description
+	 * @param {String} display
 	 * @param {Boolean} purchase
 	 * @param {Boolean} sale
 	 * @param {Boolean} income
@@ -18,15 +19,17 @@ module.exports = (() => {
 	 * @param {Boolean} closing
 	 */
 	class TransactionType extends Enum {
-		constructor(code, description, purchase, sale, income, opening, closing) {
+		constructor(code, description, display, purchase, sale, income, opening, closing) {
 			super(code, description);
 
+			assert.argumentIsRequired(display, 'display', String);
 			assert.argumentIsRequired(purchase, 'purchase', Boolean);
 			assert.argumentIsRequired(sale, 'sale', Boolean);
 			assert.argumentIsRequired(income, 'income', Boolean);
 			assert.argumentIsRequired(opening, 'opening', Boolean);
 			assert.argumentIsRequired(closing, 'closing', Boolean);
 
+			this._display = display;
 			this._purchase = purchase;
 			this._sale = sale;
 			this._income = income;
@@ -34,6 +37,16 @@ module.exports = (() => {
 			this._closing = closing;
 		}
 
+		/**
+		 * A human-readable description of the transaction type.
+		 *
+		 * @public
+		 * @returns {String}
+		 */
+		get display() {
+			return this._display;
+		}
+
 		/**
 		 * Indicates if the transaction was a trade.
 		 *
@@ -299,27 +312,27 @@ module.exports = (() => {
 		}
 	}
 
-	const buy = new TransactionType('B', 'Buy', true, false, false, true,  false);
-	const sell = new TransactionType('S', 'Sell', false, true, false, false, true);
-	const buyShort = new TransactionType('BS', 'Buy To Cover', true, false, false, false, true);
-	const sellShort = new TransactionType('SS', 'Sell Short',  false, true, false, true, false);
-	const dividend = new TransactionType('DV', 'Dividend', false, false, true, false, false);
-	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', false, false, false, true, false);
-	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', false, false, false, true, false);
-	const split = new TransactionType('SP', 'Split', false, false, false, true, false);
-	const fee = new TransactionType('F', 'Fee', false, false, false, true, false);
-	const feeUnits = new TransactionType('FU', 'Fee', false, false, false, false, false);
-
-	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', false, false, true, false, false);
-	const distributionFund = new TransactionType('DF', 'Distribution (Units)', false, false, false, true, false);
-
-	const deposit = new TransactionType('D', 'Deposit', false, false, false, true, false);
-	const withdrawal = new TransactionType('W', 'Withdrawal', false, false, false, false, true);
-	const debit = new TransactionType('DR', 'Debit', false, false, false, false, true);
-	const credit = new TransactionType('CR', 'Credit', false, false, false, true, false);
-
-	const valuation = new TransactionType('V', 'Valuation', false, false, false, false, false);
-	const income = new TransactionType('I', 'Income', false, false, true, false, false);
+	const buy = new TransactionType('B', 'Buy', 'Buy', true, false, false, true,  false);
+	const sell = new TransactionType('S', 'Sell', 'Sell', false, true, false, false, true);
+	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', true, false, false, false, true);
+	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', false, true, false, true, false);
+	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', false, false, true, false, false);
+	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', false, false, false, true, false);
+	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', false, false, false, true, false);
+	const split = new TransactionType('SP', 'Split', 'Split', false, false, false, true, false);
+	const fee = new TransactionType('F', 'Fee', 'Fee', false, false, false, true, false);
+	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, false);
+
+	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false);
+	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false);
+
+	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, true, false);
+	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', false, false, false, false, true);
+	const debit = new TransactionType('DR', 'Debit', 'Debit', false, false, false, false, true);
+	const credit = new TransactionType('CR', 'Credit', 'Credit', false, false, false, true, false);
+
+	const valuation = new TransactionType('V', 'Valuation', 'Valuation', false, false, false, false, false);
+	const income = new TransactionType('I', 'Income', 'Income', false, false, true, false, false);
 
 	return TransactionType;
 })();

package/lib/formatters/TransactionFormatter.js

@@ -35,9 +35,9 @@ module.exports = (() => {
 
 			const positionMap = {};
 
-			positions.map((p) => positionMap[p.position] = p.instrument);
+			positions.map(p => positionMap[p.position] = p.instrument);
 
-			return transactions.filter((t) => positionMap[t.position]).map((transaction) => {
+			return transactions.filter(t => positionMap[t.position]).map((transaction) => {
 				transaction.instrument = positionMap[transaction.position];
 
 				let formatted = getBasicTransaction(transaction);
@@ -76,7 +76,7 @@ module.exports = (() => {
 	const getBasicTransaction = (t) => {
 		const basic = {
 			date: t.date,
-			type: t.type,
+			type: t.type.display,
 			sequence: t.sequence,
 			instrument: t.instrument
 		};
@@ -98,6 +98,7 @@ module.exports = (() => {
 			total: t.amount
 		};
 	};
+
 	formatters.set(TransactionType.BUY, buySellFormatter);
 	formatters.set(TransactionType.SELL, buySellFormatter);
 	formatters.set(TransactionType.BUY_SHORT, buySellFormatter);

package/lib/processing/PositionContainer.js

@@ -153,6 +153,10 @@ module.exports = (() => {
 				compositeGroups.forEach((group) => {
 					const child = tree.addChild(group);
 
+					group.registerMarketPercentChangeHandler(() => {
+						this._tree.walk((childGroup) => childGroup.refreshMarketPercent());
+					});
+
 					createGroups(child, group.items, additionalDefinitions);
 				});
 			};

package/lib/processing/PositionGroup.js

@@ -1,6 +1,7 @@
 const assert = require('@barchart/common-js/lang/assert'),
 	Currency = require('@barchart/common-js/lang/Currency'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
+	Event = require('@barchart/common-js/messaging/Event'),
 	formatter = require('@barchart/common-js/lang/formatter'),
 	is = require('@barchart/common-js/lang/is');
 
@@ -25,6 +26,8 @@ module.exports = (() => {
 			this._excluded = false;
 			this._suspended = false;
 
+			this._marketPercentChangeEvent = new Event(this);
+
 			this._dataFormat = { };
 			this._dataActual = { };
 			
@@ -135,6 +138,14 @@ module.exports = (() => {
 			calculatePriceData(this, null, true);
 		}
 
+		refreshMarketPercent() {
+			calculateMarketPercent(this, true);
+		}
+
+		registerMarketPercentChangeHandler(handler) {
+			this._marketPercentChangeEvent.register(handler);
+		}
+
 		toString() {
 			return '[PositionGroup]';
 		}
@@ -252,12 +263,11 @@ module.exports = (() => {
 		}
 
 		actual.market = updates.market;
-		actual.marketPercent = updates.marketPercent;
 		actual.unrealizedToday = updates.unrealizedToday;
 		actual.total = updates.unrealizedToday.add(actual.realized).add(actual.income);
+		
 		format.market = formatCurrency(actual.market, currency);
-		format.marketPercent = formatPercent(actual.marketPercent, 2);
-
+		
 		if (updates.marketDirection.up || updates.marketDirection.down) {
 			format.marketDirection = unchanged;
 			setTimeout(() => format.marketDirection = updates.marketDirection, 0);
@@ -267,10 +277,41 @@ module.exports = (() => {
 		format.unrealizedTodayNegative = actual.unrealizedToday.getIsNegative();
 		format.total = formatCurrency(actual.total, currency);
 		format.totalNegative = actual.total.getIsNegative();
+		
+		calculateMarketPercent(group, false);
 	}
 
-	function calculatePercent() {
+	function calculateMarketPercent(group, silent) {
+		if (group.suspended) {
+			return;
+		}
+
+		const parent = group._parent;
+
+		const actual = group._dataActual;
+		const format = group._dataFormat;
+		
+		let marketPercent;
+		
+		if (parent !== null) {
+			const parentData = parent._dataActual;
+
+			if (parentData.market !== null && !parentData.market.getIsZero()) {
+				marketPercent = actual.market.divide(parentData.market);
+			} else {
+				marketPercent = null;
+			}
+		} else {
+			marketPercent = null;
+		}
 
+		actual.marketPercent = marketPercent;
+		
+		format.marketPercent = formatPercent(actual.marketPercent, 2);
+		
+		if (!silent) {
+			group._marketPercentChangeEvent.fire(group);
+		}
 	}
 
 	const unchanged = { up: false, down: false };

package/lib/serialization/TransactionSchema.js

@@ -159,7 +159,7 @@ module.exports = (() => {
 		}
 
 		toString() {
-			return '[TransactionSchema]';
+			return `[TransactionSchema (code=${this.code})]`;
 		}
 	}
 

package/package.json

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

package/test/SpecRunner.js

@@ -388,6 +388,7 @@ module.exports = (() => {
 	 * @extends {Enum}
 	 * @param {String} code
 	 * @param {String} description
+	 * @param {String} display
 	 * @param {Boolean} purchase
 	 * @param {Boolean} sale
 	 * @param {Boolean} income
@@ -395,15 +396,17 @@ module.exports = (() => {
 	 * @param {Boolean} closing
 	 */
 	class TransactionType extends Enum {
-		constructor(code, description, purchase, sale, income, opening, closing) {
+		constructor(code, description, display, purchase, sale, income, opening, closing) {
 			super(code, description);
 
+			assert.argumentIsRequired(display, 'display', String);
 			assert.argumentIsRequired(purchase, 'purchase', Boolean);
 			assert.argumentIsRequired(sale, 'sale', Boolean);
 			assert.argumentIsRequired(income, 'income', Boolean);
 			assert.argumentIsRequired(opening, 'opening', Boolean);
 			assert.argumentIsRequired(closing, 'closing', Boolean);
 
+			this._display = display;
 			this._purchase = purchase;
 			this._sale = sale;
 			this._income = income;
@@ -411,6 +414,16 @@ module.exports = (() => {
 			this._closing = closing;
 		}
 
+		/**
+		 * A human-readable description of the transaction type.
+		 *
+		 * @public
+		 * @returns {String}
+		 */
+		get display() {
+			return this._display;
+		}
+
 		/**
 		 * Indicates if the transaction was a trade.
 		 *
@@ -676,27 +689,27 @@ module.exports = (() => {
 		}
 	}
 
-	const buy = new TransactionType('B', 'Buy', true, false, false, true,  false);
-	const sell = new TransactionType('S', 'Sell', false, true, false, false, true);
-	const buyShort = new TransactionType('BS', 'Buy To Cover', true, false, false, false, true);
-	const sellShort = new TransactionType('SS', 'Sell Short',  false, true, false, true, false);
-	const dividend = new TransactionType('DV', 'Dividend', false, false, true, false, false);
-	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', false, false, false, true, false);
-	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', false, false, false, true, false);
-	const split = new TransactionType('SP', 'Split', false, false, false, true, false);
-	const fee = new TransactionType('F', 'Fee', false, false, false, true, false);
-	const feeUnits = new TransactionType('FU', 'Fee', false, false, false, false, false);
+	const buy = new TransactionType('B', 'Buy', 'Buy', true, false, false, true,  false);
+	const sell = new TransactionType('S', 'Sell', 'Sell', false, true, false, false, true);
+	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', true, false, false, false, true);
+	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', false, true, false, true, false);
+	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', false, false, true, false, false);
+	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', false, false, false, true, false);
+	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', false, false, false, true, false);
+	const split = new TransactionType('SP', 'Split', 'Split', false, false, false, true, false);
+	const fee = new TransactionType('F', 'Fee', 'Fee', false, false, false, true, false);
+	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, false);
 
-	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', false, false, true, false, false);
-	const distributionFund = new TransactionType('DF', 'Distribution (Units)', false, false, false, true, false);
+	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false);
+	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false);
 
-	const deposit = new TransactionType('D', 'Deposit', false, false, false, true, false);
-	const withdrawal = new TransactionType('W', 'Withdrawal', false, false, false, false, true);
-	const debit = new TransactionType('DR', 'Debit', false, false, false, false, true);
-	const credit = new TransactionType('CR', 'Credit', false, false, false, true, false);
+	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, true, false);
+	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', false, false, false, false, true);
+	const debit = new TransactionType('DR', 'Debit', 'Debit', false, false, false, false, true);
+	const credit = new TransactionType('CR', 'Credit', 'Credit', false, false, false, true, false);
 
-	const valuation = new TransactionType('V', 'Valuation', false, false, false, false, false);
-	const income = new TransactionType('I', 'Income', false, false, true, false, false);
+	const valuation = new TransactionType('V', 'Valuation', 'Valuation', false, false, false, false, false);
+	const income = new TransactionType('I', 'Income', 'Income', false, false, true, false, false);
 
 	return TransactionType;
 })();
@@ -857,6 +870,10 @@ module.exports = (() => {
 				compositeGroups.forEach((group) => {
 					const child = tree.addChild(group);
 
+					group.registerMarketPercentChangeHandler(() => {
+						this._tree.walk((childGroup) => childGroup.refreshMarketPercent());
+					});
+
 					createGroups(child, group.items, additionalDefinitions);
 				});
 			};
@@ -940,6 +957,7 @@ module.exports = (() => {
 const assert = require('@barchart/common-js/lang/assert'),
 	Currency = require('@barchart/common-js/lang/Currency'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
+	Event = require('@barchart/common-js/messaging/Event'),
 	formatter = require('@barchart/common-js/lang/formatter'),
 	is = require('@barchart/common-js/lang/is');
 
@@ -964,6 +982,8 @@ module.exports = (() => {
 			this._excluded = false;
 			this._suspended = false;
 
+			this._marketPercentChangeEvent = new Event(this);
+
 			this._dataFormat = { };
 			this._dataActual = { };
 			
@@ -1074,6 +1094,14 @@ module.exports = (() => {
 			calculatePriceData(this, null, true);
 		}
 
+		refreshMarketPercent() {
+			calculateMarketPercent(this, true);
+		}
+
+		registerMarketPercentChangeHandler(handler) {
+			this._marketPercentChangeEvent.register(handler);
+		}
+
 		toString() {
 			return '[PositionGroup]';
 		}
@@ -1191,12 +1219,11 @@ module.exports = (() => {
 		}
 
 		actual.market = updates.market;
-		actual.marketPercent = updates.marketPercent;
 		actual.unrealizedToday = updates.unrealizedToday;
 		actual.total = updates.unrealizedToday.add(actual.realized).add(actual.income);
+		
 		format.market = formatCurrency(actual.market, currency);
-		format.marketPercent = formatPercent(actual.marketPercent, 2);
-
+		
 		if (updates.marketDirection.up || updates.marketDirection.down) {
 			format.marketDirection = unchanged;
 			setTimeout(() => format.marketDirection = updates.marketDirection, 0);
@@ -1206,10 +1233,41 @@ module.exports = (() => {
 		format.unrealizedTodayNegative = actual.unrealizedToday.getIsNegative();
 		format.total = formatCurrency(actual.total, currency);
 		format.totalNegative = actual.total.getIsNegative();
+		
+		calculateMarketPercent(group, false);
 	}
 
-	function calculatePercent() {
+	function calculateMarketPercent(group, silent) {
+		if (group.suspended) {
+			return;
+		}
 
+		const parent = group._parent;
+
+		const actual = group._dataActual;
+		const format = group._dataFormat;
+		
+		let marketPercent;
+		
+		if (parent !== null) {
+			const parentData = parent._dataActual;
+
+			if (parentData.market !== null && !parentData.market.getIsZero()) {
+				marketPercent = actual.market.divide(parentData.market);
+			} else {
+				marketPercent = null;
+			}
+		} else {
+			marketPercent = null;
+		}
+
+		actual.marketPercent = marketPercent;
+		
+		format.marketPercent = formatPercent(actual.marketPercent, 2);
+		
+		if (!silent) {
+			group._marketPercentChangeEvent.fire(group);
+		}
 	}
 
 	const unchanged = { up: false, down: false };
@@ -1217,7 +1275,7 @@ module.exports = (() => {
 	return PositionGroup;
 })();
 
-},{"@barchart/common-js/lang/Currency":11,"@barchart/common-js/lang/Decimal":13,"@barchart/common-js/lang/assert":17,"@barchart/common-js/lang/formatter":18,"@barchart/common-js/lang/is":19}],6:[function(require,module,exports){
+},{"@barchart/common-js/lang/Currency":11,"@barchart/common-js/lang/Decimal":13,"@barchart/common-js/lang/assert":17,"@barchart/common-js/lang/formatter":18,"@barchart/common-js/lang/is":19,"@barchart/common-js/messaging/Event":20}],6:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
 	is = require('@barchart/common-js/lang/is');
 
@@ -5871,10 +5929,10 @@ describe('When a position container data is gathered', () => {
 				income: new Decimal(0),
 				gain: new Decimal(0)
 			}
-		}
+		};
 	}
 
-	describe('for two portfolios, each with the same position, and the second portfolio with an additonal position', () => {
+	describe('for two portfolios, each with the same position, and the second portfolio with an addition position', () => {
 		let portfolios;
 		let positions;
 		let summaries;

package/test/specs/processing/PositionContainerSpec.js

@@ -29,10 +29,10 @@ describe('When a position container data is gathered', () => {
 				income: new Decimal(0),
 				gain: new Decimal(0)
 			}
-		}
+		};
 	}
 
-	describe('for two portfolios, each with the same position, and the second portfolio with an additonal position', () => {
+	describe('for two portfolios, each with the same position, and the second portfolio with an addition position', () => {
 		let portfolios;
 		let positions;
 		let summaries;