@barchart/portfolio-api-common 1.2.120 → 1.2.125

package/lib/data/PositionSummaryFrame.js

@@ -64,7 +64,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Number} periods
-		 * @returns {Array.<PositionSummaryRange>}
+		 * @returns {PositionSummaryRange[]}
 		 */
 		getRecentRanges(periods) {
 			const startDate = this.getStartDate(periods);
@@ -77,8 +77,8 @@ module.exports = (() => {
 		 * Returns the ranges for the set of {@link Transaction} objects.
 		 *
 		 * @public
-		 * @param {Array.<Transaction>} transactions
-		 * @returns {Array.<PositionSummaryRange>}
+		 * @param {Transaction[]} transactions
+		 * @returns {PositionSummaryRange[]}
 		 */
 		getRanges(transactions) {
 			assert.argumentIsArray(transactions, 'transactions');
@@ -91,7 +91,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Day} date
-		 * @return {Array.<PositionSummaryRange>}
+		 * @return {PositionSummaryRange[]}
 		 */
 		getRangesFromDate(date) {
 			assert.argumentIsRequired(date, 'date', Day, 'Day');
@@ -180,8 +180,8 @@ module.exports = (() => {
 	}
 
 	const yearly = new PositionSummaryFrame('YEARLY', 'year', false, getYearlyRanges, getYearlyStartDate, getYearlyRangeDescription);
-	const quarterly = new PositionSummaryFrame('QUARTER', 'quarter', false, getQuarterlyRanges, getQuarterlyStartDate, getQuarterlyRangeDescription);
-	const monthly = new PositionSummaryFrame('MONTH', 'month', false, getMonthlyRanges, getMonthlyStartDate, getMonthlyRangeDescription);
+	const quarterly = new PositionSummaryFrame('QUARTERLY', 'quarter', false, getQuarterlyRanges, getQuarterlyStartDate, getQuarterlyRangeDescription);
+	const monthly = new PositionSummaryFrame('MONTHLY', 'month', false, getMonthlyRanges, getMonthlyStartDate, getMonthlyRangeDescription);
 	const ytd = new PositionSummaryFrame('YTD', 'year-to-date', true, getYearToDateRanges, getYearToDateStartDate, getYearToDateRangeDescription);
 
 	/**
@@ -241,32 +241,32 @@ module.exports = (() => {
 	}
 
 	function getMonthlyRanges(transactions) {
-    const ranges = [ ];
-    
-    if (!transactions.length) {
-    	return ranges;
+		const ranges = [ ];
+
+		if (!transactions.length) {
+			return ranges;
 		}
 
 		const first = array.first(transactions);
 		const last = array.last(transactions);
 
 		const firstDate = first.date;
+
 		let lastDate;
 
-		lastDate = last.snapshot.open.getIsZero()
-			? new Day(last.date.year, last.date.month, last.date.day).addMonths(1)
-			: Day.getToday();
+		if (last.snapshot.open.getIsZero()) {
+			lastDate = new Day(last.date.year, last.date.month, last.date.day).addMonths(1);
+		} else {
+			lastDate = Day.getToday();
+		}
+
 		lastDate = lastDate.getEndOfMonth();
 
-		for (
-			let end = firstDate.getEndOfMonth();
-			end.format() <= lastDate.format();
-			end = end.addMonths(1).getEndOfMonth()
-		) {
+		for (let end = firstDate.getEndOfMonth(); end.format() <= lastDate.format(); end = end.addMonths(1).getEndOfMonth()) {
 			ranges.push(getRange(end.subtractMonths(1).getEndOfMonth(), end));
 		}
-    
-    return ranges;
+
+		return ranges;
 	}
 
 	function getYearToDateRanges(transactions) {
@@ -303,8 +303,8 @@ module.exports = (() => {
 	}
 
 	function getMonthlyStartDate(periods, date) {
-    const today = date || Day.getToday();
-    
+		const today = date || Day.getToday();
+
 		return today
 			.subtractMonths(periods)
 			.subtractDays(today.day);
@@ -323,7 +323,7 @@ module.exports = (() => {
 	}
 
 	function getMonthlyRangeDescription(start, end) {
-		return '';
+		return `Month ended ${end.format()}`;
 	}
 
 	function getYearToDateRangeDescription(start, end) {

package/lib/formatters/TransactionFormatter.js

@@ -46,32 +46,33 @@ module.exports = (() => {
 				return map;
 			}, { });
 
-			const a = transactions.reduce((list, transaction) => {
+			const list = transactions.reduce((accumulator, transaction) => {
 				const position = transaction.position;
 
 				if (instruments.hasOwnProperty(position)) {
 					let instrument = instruments[position];
-					let formatted = getBasicTransaction(transaction, instrument);
+					let formatted = { instrument: instrument };
 
-					if (formatters.has(transaction.type)) {
-						const formatterFunction = formatters.get(transaction.type);
-						const formattedTransaction = formatterFunction(transaction);
+					const formatterFunctions = formatters.get(transaction.type);
 
-						Object.keys(formattedTransaction).map((key) => {
-							if (!is.undefined(formattedTransaction[key]) && formattedTransaction[key] instanceof Decimal) {
-								const precision = instrument.currency.precision;
+					formatterFunctions.forEach((formatterFunction) => {
+						formatterFunction(transaction, formatted);
+					});
 
-								formattedTransaction[key] = formatter.numberToString(formattedTransaction[key].toFloat(), precision, ',');
-							}
-						});
+					Object.keys(formatted).forEach((key) => {
+						const value = formatted[key];
 
-						formatted = Object.assign({}, formatted, formattedTransaction);
-					}
+						if (value instanceof Decimal) {
+							const precision = instrument.currency.precision;
 
-					list.push(formatted);
+							formatted[key] = formatter.numberToString(value.toFloat(), precision, ',');
+						}
+					});
+
+					accumulator.push(formatted);
 				}
 
-				return list;
+				return accumulator;
 			}, [ ]);
 
 			let comparator;
@@ -82,13 +83,13 @@ module.exports = (() => {
 				comparator = comparatorAscending;
 			}
 
-			a.sort(comparator);
+			list.sort(comparator);
 
-			a.forEach((t) => {
+			list.forEach((t) => {
 				delete t.instrument.id;
 			});
 
-			return a;
+			return list;
 		}
 
 		/**
@@ -120,126 +121,105 @@ module.exports = (() => {
 		}
 	}
 
-	const getBasicTransaction = (t, i) => {
-		return {
-			date: t.date,
-			type: t.type.display,
-			code: t.type.code,
-			sequence: t.sequence,
-			instrument: i,
-			position: t.position
-		};
+	const basicFormatter = (t, f) => {
+		f.date = t.date;
+		f.type = t.type.display;
+		f.code = t.type.code;
+		f.sequence = t.sequence;
+		f.position = t.position;
 	};
 
-	const formatters = new Map();
-	
-	const buySellFormatter = (t) => {
-		return {
-			boughtSold: t.quantity,
-			price: t.trade.price,
-			fee: t.fee,
-			total: t.amount
-		};
+	const averageCostFormatter = (t, f) => {
+		const basis = t.snapshot.basis;
+		const open = t.snapshot.open;
+
+		let average;
+
+		if (basis && open && !open.getIsZero()) {
+			average = basis.divide(open).absolute();
+		} else {
+			average = '';
+		}
+
+		f.average = average;
 	};
 
-	formatters.set(TransactionType.BUY, buySellFormatter);
-	formatters.set(TransactionType.SELL, buySellFormatter);
-	formatters.set(TransactionType.BUY_SHORT, buySellFormatter);
-	formatters.set(TransactionType.SELL_SHORT, buySellFormatter);
-
-	formatters.set(TransactionType.DIVIDEND, (t) => {
-		return {
-			shares: t.snapshot.open,
-			total: t.dividend.amount,
-			rate: t.dividend.rate
-		};
-	});
-
-	formatters.set(TransactionType.DIVIDEND_STOCK, (t) => {
-		const data = {
-			boughtSold: t.quantity,
-			fee: t.fee
-		};
+	const buySellFormatter = (t, f) => {
+		f.boughtSold = t.quantity;
+		f.price = t.trade.price;
+		f.fee = t.fee;
+		f.total = t.amount;
+	};
+
+	const dividendFormatter = (t, f) => {
+		f.shares = t.snapshot.open;
+		f.total = t.dividend.amount;
+		f.rate = t.dividend.rate;
+	};
+
+	const dividendStockFormatter = (t, f) => {
+		f.boughtSold = t.quantity;
+		f.fee = t.fee;
 
 		if (t.dividend && t.dividend.rate && t.dividend.price) {
-			data.shares = t.snapshot.open.subtract(t.quantity);
-			data.price = t.dividend.price;
-			data.rate = t.dividend.rate;
+			f.shares = t.snapshot.open.subtract(t.quantity);
+			f.price = t.dividend.price;
+			f.rate = t.dividend.rate;
 		}
+	};
+
+	const dividendReinvestFormatter = (t, f) => {
+		f.boughtSold = t.quantity;
+		f.shares = t.snapshot.open.subtract(t.quantity);
+		f.price = t.dividend.price;
+		f.fee = t.fee;
+		f.rate = t.dividend.rate;
+	};
+
+	const distributionCashFormatter = (t, f) => {
+		f.shares = t.snapshot.open;
+		f.total = t.dividend.amount;
+		f.rate = t.dividend.rate;
+	};
 
-		return data;
-	});
-
-	formatters.set(TransactionType.DIVIDEND_REINVEST, (t) => {
-		return {
-			boughtSold: t.quantity,
-			shares: t.snapshot.open.subtract(t.quantity),
-			price: t.dividend.price,
-			fee: t.fee,
-			rate: t.dividend.rate
-		};
-	});
-
-	formatters.set(TransactionType.DISTRIBUTION_CASH, (t) => {
-		return {
-			shares: t.snapshot.open,
-			total: t.dividend.amount,
-			rate: t.dividend.rate
-		};
-	});
-
-	formatters.set(TransactionType.DISTRIBUTION_FUND, (t) => {
-		const data = {
-			boughtSold: t.quantity,
-			fee: t.fee
-		};
+	const distributionFundFormatter = (t, f) => {
+		f.boughtSold =t.quantity;
+		f.fee = t.fee;
 
 		if (t.dividend && t.dividend.rate && t.dividend.price) {
-			data.shares = t.snapshot.open.subtract(t.quantity);
-			data.price = t.dividend.price;
-			data.rate = t.dividend.rate;
+			f.shares = t.snapshot.open.subtract(t.quantity);
+			f.price = t.dividend.price;
+			f.rate = t.dividend.rate;
 		}
+	};
 
-		return data;
-	});
-
-	formatters.set(TransactionType.DISTRIBUTION_REINVEST, (t) => {
-		return {
-			boughtSold: t.quantity,
-			shares: t.snapshot.open.subtract(t.quantity),
-			price: t.dividend.price,
-			fee: t.fee,
-			rate: t.dividend.rate
-		};
-	});
-
-	formatters.set(TransactionType.INCOME, (t) => {
-		return {
-			total: t.income.amount
-		};
-	});
-
-	formatters.set(TransactionType.FEE, (t) => {
-		return {
-			fee: t.charge.amount,
-			total: t.charge.amount
-		};
-	});
-
-	formatters.set(TransactionType.FEE_UNITS, (t) => {
-		return {
-			boughtSold: t.quantity
-		};
-	});
-
-	formatters.set(TransactionType.SPLIT, (t) => {
-		return {
-			shares: t.quantity,
-			rate: t.split.numerator.divide(t.split.denominator)
-		};
-	});
-
-	formatters.set(TransactionType.VALUATION, (t) => {
+	const distributionReinvestFormatter = (t, f) => {
+		f.boughtSold = t.quantity;
+		f.shares = t.snapshot.open.subtract(t.quantity);
+		f.price = t.dividend.price;
+		f.fee = t.fee;
+		f.rate = t.dividend.rate;
+	};
+
+	const incomeFormatter = (t, f) => {
+		f.total = t.income.amount;
+	};
+
+	const feeFormatter = (t, f) => {
+		f.fee = t.charge.amount;
+		f.total = t.charge.amount;
+	};
+
+	const feeUnitsFormatter = (t, f) => {
+		f.boughtSold = t.quantity;
+	};
+
+	const splitFormatter = (t, f) => {
+		f.shares = t.quantity;
+		f.rate = t.split.numerator.divide(t.split.denominator);
+	};
+
+	const valuationFormatter = (t, f) => {
 		let rate;
 
 		if (t.valuation.rate) {
@@ -250,39 +230,43 @@ module.exports = (() => {
 			rate = t.valuation.value.divide(t.snapshot.open);
 		}
 
-		return {
-			price: rate
-		};
-	});
-	
-	formatters.set(TransactionType.DELIST, () => {
-		return { };
-	});
-
-	const cashFormatter = (t) => {
-		return {
-			total: t.quantity
-		};
+		f.price = rate;
 	};
 
-	formatters.set(TransactionType.DEPOSIT, cashFormatter);
-	formatters.set(TransactionType.WITHDRAWAL, cashFormatter);
-
-	formatters.set(TransactionType.DEBIT, (t) => {
-		const formatted = cashFormatter(t);
-
-		formatted.description = t.description;
+	const cashFormatter = (t, f) => {
+		f.total = t.quantity;
+	};
 
-		return formatted;
-	});
+	const debitFormatter = (t, f) => {
+		f.description = t.description;
+	};
 
-	formatters.set(TransactionType.CREDIT, (t) => {
-		const formatted = cashFormatter(t);
+	const creditFormatter = (t, f) => {
+		f.description = t.description;
+	};
 
-		formatted.description = t.description;
+	const formatters = new Map();
 
-		return formatted;
-	});
+	formatters.set(TransactionType.BUY, [ basicFormatter, buySellFormatter, averageCostFormatter ]);
+	formatters.set(TransactionType.SELL, [ basicFormatter, buySellFormatter, averageCostFormatter ]);
+	formatters.set(TransactionType.BUY_SHORT, [ basicFormatter, buySellFormatter, averageCostFormatter ]);
+	formatters.set(TransactionType.SELL_SHORT, [ basicFormatter, buySellFormatter, averageCostFormatter ]);
+	formatters.set(TransactionType.DIVIDEND, [ basicFormatter, dividendFormatter, averageCostFormatter ]);
+	formatters.set(TransactionType.DIVIDEND_STOCK, [ basicFormatter, dividendStockFormatter, averageCostFormatter ]);
+	formatters.set(TransactionType.DIVIDEND_REINVEST, [ basicFormatter, dividendReinvestFormatter, averageCostFormatter ]);
+	formatters.set(TransactionType.DISTRIBUTION_CASH, [ basicFormatter, distributionCashFormatter, averageCostFormatter ]);
+	formatters.set(TransactionType.DISTRIBUTION_FUND, [ basicFormatter, distributionFundFormatter, averageCostFormatter ]);
+	formatters.set(TransactionType.DISTRIBUTION_REINVEST, [ basicFormatter, distributionReinvestFormatter, averageCostFormatter ]);
+	formatters.set(TransactionType.INCOME, [ basicFormatter, incomeFormatter, averageCostFormatter ]);
+	formatters.set(TransactionType.FEE, [ basicFormatter, feeFormatter, averageCostFormatter ]);
+	formatters.set(TransactionType.FEE_UNITS, [ basicFormatter, feeUnitsFormatter, averageCostFormatter ]);
+	formatters.set(TransactionType.SPLIT, [ basicFormatter, splitFormatter, averageCostFormatter ]);
+	formatters.set(TransactionType.VALUATION, [ basicFormatter, valuationFormatter, averageCostFormatter ]);
+	formatters.set(TransactionType.DELIST, [ basicFormatter, averageCostFormatter ]);
+	formatters.set(TransactionType.DEPOSIT, [ basicFormatter, cashFormatter ]);
+	formatters.set(TransactionType.WITHDRAWAL, [ basicFormatter, cashFormatter ]);
+	formatters.set(TransactionType.DEBIT, [ basicFormatter, cashFormatter, debitFormatter ]);
+	formatters.set(TransactionType.CREDIT, [ basicFormatter, cashFormatter, creditFormatter ]);
 
 	function getInstrumentTypePriority(type) {
 		if (type === InstrumentType.CASH) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.2.120",
+  "version": "1.2.125",
   "description": "Common classes used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",
@@ -23,9 +23,10 @@
     "gulp-bump": "~1.0.0",
     "gulp-git": "~1.6.0",
     "gulp-jasmine": "^2.2.1",
-    "gulp-jshint": "~1.11.2",
+    "gulp-jshint": "~2.1.0",
     "gulp-util": "^3.0.7",
     "jsdoc": "^3.5.5",
+    "jshint": "2.9.5",
     "run-sequence": "~1.1.4",
     "vinyl-buffer": "^1.0.0",
     "vinyl-source-stream": "^1.1.0"