@barchart/portfolio-api-common 1.2.117 → 1.2.122

package/lib/api/failures/PortfolioFailureType.js

@@ -88,6 +88,18 @@ module.exports = (() => {
 		static get TRANSACTION_CREATE_FAILED_OUT_OF_SEQUENCE() {
 			return transactionCreateFailedOutOfSequence;
 		}
+		
+		/**
+		 * The transaction date is invalid.
+		 * For example create opening transaction after delist date.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_INVALID_DATE() {
+			return transactionCreateFailedInvalidDate;
+		}
 
 		/**
 		 * @public
@@ -164,6 +176,18 @@ module.exports = (() => {
 		static get TRANSACTION_CREATE_FAILED_POSITION_LOCKED() {
 			return transactionCreateFailedPositionLocked;
 		}
+		
+		/**
+		 * The transaction (of this type) cannot be deleted by a user, instead,
+		 * it is created and managed by the system (e.g. dividends).
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_DELETE_FAILED_TYPE_RESERVED() {
+			return transactionDeleteFailedTypeReserved;
+		}
 
 		/**
 		 * Deleting any transaction except for the most recent requires
@@ -209,6 +233,18 @@ module.exports = (() => {
 		static get TRANSACTION_DELETE_FAILED_POSITION_LOCKED() {
 			return transactionDeleteFailedPositionLocked;
 		}
+		
+		/**
+		 * The transaction date is invalid.
+		 * For example edit opening transaction after delist date.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_EDIT_FAILED_INVALID_DATE() {
+			return transactionEditFailedInvalidDate;
+		}
 
 		/**
 		 * Unable to edit, the transaction doesn't exist.
@@ -247,10 +283,12 @@ module.exports = (() => {
 
 	const transactionCreateFailedNoPosition = new FailureType('TRANSACTION_CREATE_FAILED_NO_POSITION', 'Unable to create transaction. The referenced position does not exist. Has it been deleted?');
 	const transactionCreateFailedOutOfSequence = new FailureType('TRANSACTION_CREATE_FAILED_OUT_OF_SEQUENCE', 'Unable to process transaction, because the transaction date is out-of-sequence. In other words, it would occur before an existing transaction. Please confirm your intent to re-write transaction history (which could take some time and alter the historical results for this position).');
+	const transactionCreateFailedInvalidDate = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_DATE', 'Unable to process transaction with given date.');
 	const transactionCreateFailedTypeInvalidForInstrument = new FailureType('TRANSACTION_CREATE_FAILED_TYPE_INVALID_FOR_INSTRUMENT', 'Unable to process transaction, {L|transactionType.description} transactions cannot be used with {L|instrumentType.description} positions.');
 	const transactionCreateFailedTypeInvalidForDirection = new FailureType('TRANSACTION_CREATE_FAILED_TYPE_INVALID_FOR_DIRECTION', 'Unable to process transaction, a {L|positionDirection.description} position would be created (i.e. you would have {L|positionDirection.sign} shares/units). {u|instrumentType.description} positions cannot have {L|positionDirection.description} positions.');
 	const transactionCreateFailedInvalidDirectionSwitch = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_DIRECTION_SWITCH', 'Unable to process transaction, the transaction would switch the position from {L|currentDirection.description} to {L|proposedDirection.description} (i.e. {L|currentDirection.sign} to {L|proposedDirection.sign} shares/units). This is not allowed. Please close the current position (i.e. zero it out) and then enter a second transaction.');
 	const transactionCreateFailedInvalidInitialType = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_INITIAL_TYPE', 'Unable to process operation because the first transaction would to be a {U|transactionType.description}, which is not allowed -- since {U|transactionType.description} transactions cannot open a position.');
+
 	const transactionCreateFailedTypeReserved = new FailureType('TRANSACTION_CREATE_FAILED_TYPE_RESERVED', 'Unable to create {U|type.description} transaction, this type of transaction is managed by the system.');
 	const transactionCreateFailedReinvestPriceUnavailable = new FailureType('TRANSACTION_CREATE_FAILED_REINVEST_PRICE_UNAVAILABLE', 'Unable to create transaction, a dividend was paid on {L|day}; however no historical price is available for this day. To successfully create this transaction, please turn off dividend reinvestment for this position.');
 	const transactionCreateFailedPositionLocked = new FailureType('TRANSACTION_CREATE_FAILED_POSITION_LOCKED', 'Unable to create transaction, your {L|description} history is being recalculated. Please re-enter this transaction in a minute or two.');
@@ -259,9 +297,11 @@ module.exports = (() => {
 	const transactionDeleteFailedNoTransaction = new FailureType('TRANSACTION_DELETE_FAILED_NO_TRANSACTION', 'Unable to delete transaction. The referenced transaction does not exist.');
 	const transactionDeleteFailedDirectionSwitchOnRewrite = new FailureType('TRANSACTION_DELETE_FAILED_DIRECTION_SWITCH_ON_REWRITE', 'Deleting this transaction would cause your history to be re-written and the position to switch from long to short (i.e. positive to negative) or vice versa.');
 	const transactionDeleteFailedPositionLocked = new FailureType('TRANSACTION_DELETE_FAILED_POSITION_LOCKED', 'Unable to delete transaction, your {L|description} history is being recalculated. Please wait a minute or two and retry.');
+	const transactionDeleteFailedTypeReserved = new FailureType('TRANSACTION_DELETE_FAILED_TYPE_RESERVED', 'Unable to delete {U|type.description} transaction, this type of transaction is managed by the system.');
 
+	const transactionEditFailedInvalidDate = new FailureType('TRANSACTION_EDIT_FAILED_INVALID_DATE', 'Unable to edit transaction with given date.');
 	const transactionEditFailedNoTransaction = new FailureType('TRANSACTION_EDIT_FAILED_NO_TRANSACTION', 'Unable to edit transaction. The referenced transaction does not exist.');
 	const transactionEditFailedTypeReserved = new FailureType('TRANSACTION_EDIT_FAILED_TYPE_RESERVED', 'Unable to edit {U|type.description} transaction, this type of transaction is managed by the system.');
 
 	return PortfolioFailureType;
-})();
+})();

package/lib/data/CorporateActionType.js

@@ -11,13 +11,10 @@ module.exports = (() => {
 	 * @extends {Enum}
 	 * @param {String} code
 	 * @param {String} description
-	 * @param {Boolean} internal
 	 */
 	class CorporateActionType extends Enum {
-		constructor(code, description, internal) {
+		constructor(code, description) {
 			super(code, description);
-
-			this._internal = is.boolean(internal) && internal;
 		}
 
 		/**
@@ -76,14 +73,14 @@ module.exports = (() => {
 		}
 
 		/**
-		 * A fictitious event, used for internal system purposes.
+		 * A delisting.
 		 *
 		 * @public
 		 * @static
 		 * @returns {CorporateActionType}
 		 */
-		static get JOB() {
-			return job;
+		static get DELIST() {
+			return delist;
 		}
 	}
 
@@ -91,7 +88,7 @@ module.exports = (() => {
 	const nameChange = new CorporateActionType('NAME_CHANGE', 'Name Change', false);
 	const dividend = new CorporateActionType('DIVIDEND', 'Dividend', false);
 	const split = new CorporateActionType('SPLIT', 'Split', false);
-	const job = new CorporateActionType('JOB', 'Job', true);
+	const delist = new CorporateActionType('DELIST', 'Delist', false);
 
 	return CorporateActionType;
 })();

package/lib/data/TransactionType.js

@@ -22,7 +22,6 @@ module.exports = (() => {
 	 * @param {Boolean} corporateAction
 	 * @param {Boolean} initial
 	 * @param {Boolean} significant
-	 * @param {Boolean} eod
  	 */
 	class TransactionType extends Enum {
 		constructor(code, description, display, sequence, purchase, sale, income, opening, closing, fee, corporateAction, initial, significant) {
@@ -352,7 +351,7 @@ module.exports = (() => {
 		static get DEBIT() {
 			return debit;
 		}
-    
+  
 		/**
 		 * A system-generated transaction, indicating the security has stopped active trading.
 		 *
@@ -412,7 +411,7 @@ module.exports = (() => {
 	const split = new TransactionType('SP', 'Split', 'Split', 1, false, false, false, true, false, false, true, false, false);
 	const fee = new TransactionType('F', 'Fee', 'Fee', 0, false, false, false, false, false, true, false, false, false);
 	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', 0, false, false, false, false, true, false, false, false, false);
-	const delist = new TransactionType('DL', 'Delist', 'Delist', 0, false, false, false, false, false, false, false, false, false);
+	const delist = new TransactionType('DL', 'Delist', 'Delist', 1, false, false, false, false, false, false, true, false, false);
 
 	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', 1, false, false, true, false, false, false, true, false, false);
 	const distributionReinvest = new TransactionType('DY', 'Distribution (Reinvested)', 'Distribution Reinvest', 1, false, false, false, true, false, false, true, false, false);

package/lib/data/TransactionValidator.js

@@ -1,6 +1,7 @@
 const assert = require('@barchart/common-js/lang/assert'),
 	array = require('@barchart/common-js/lang/array'),
-	is = require('@barchart/common-js/lang/is');
+	is = require('@barchart/common-js/lang/is'),
+	Day = require('@barchart/common-js/lang/Day');
 
 const InstrumentType = require('./InstrumentType'),
 	PositionDirection = require('./PositionDirection'),

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);
+		} 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.117",
+  "version": "1.2.122",
   "description": "Common classes used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",

package/test/SpecRunner.js

@@ -759,7 +759,6 @@ module.exports = (() => {
 	 * @param {Boolean} corporateAction
 	 * @param {Boolean} initial
 	 * @param {Boolean} significant
-	 * @param {Boolean} eod
  	 */
 	class TransactionType extends Enum {
 		constructor(code, description, display, sequence, purchase, sale, income, opening, closing, fee, corporateAction, initial, significant) {
@@ -1089,7 +1088,7 @@ module.exports = (() => {
 		static get DEBIT() {
 			return debit;
 		}
-    
+  
 		/**
 		 * A system-generated transaction, indicating the security has stopped active trading.
 		 *
@@ -1149,7 +1148,7 @@ module.exports = (() => {
 	const split = new TransactionType('SP', 'Split', 'Split', 1, false, false, false, true, false, false, true, false, false);
 	const fee = new TransactionType('F', 'Fee', 'Fee', 0, false, false, false, false, false, true, false, false, false);
 	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', 0, false, false, false, false, true, false, false, false, false);
-	const delist = new TransactionType('DL', 'Delist', 'Delist', 0, false, false, false, false, false, false, false, false, false);
+	const delist = new TransactionType('DL', 'Delist', 'Delist', 1, false, false, false, false, false, false, true, false, false);
 
 	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', 1, false, false, true, false, false, false, true, false, false);
 	const distributionReinvest = new TransactionType('DY', 'Distribution (Reinvested)', 'Distribution Reinvest', 1, false, false, false, true, false, false, true, false, false);
@@ -1169,7 +1168,8 @@ module.exports = (() => {
 },{"@barchart/common-js/lang/Enum":24,"@barchart/common-js/lang/assert":29}],5:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
 	array = require('@barchart/common-js/lang/array'),
-	is = require('@barchart/common-js/lang/is');
+	is = require('@barchart/common-js/lang/is'),
+	Day = require('@barchart/common-js/lang/Day');
 
 const InstrumentType = require('./InstrumentType'),
 	PositionDirection = require('./PositionDirection'),
@@ -1464,7 +1464,7 @@ module.exports = (() => {
 	return TransactionValidator;
 })();
 
-},{"./InstrumentType":1,"./PositionDirection":2,"./TransactionType":4,"@barchart/common-js/lang/array":28,"@barchart/common-js/lang/assert":29,"@barchart/common-js/lang/is":33}],6:[function(require,module,exports){
+},{"./InstrumentType":1,"./PositionDirection":2,"./TransactionType":4,"@barchart/common-js/lang/Day":21,"@barchart/common-js/lang/array":28,"@barchart/common-js/lang/assert":29,"@barchart/common-js/lang/is":33}],6:[function(require,module,exports){
 const array = require('@barchart/common-js/lang/array'),
 	assert = require('@barchart/common-js/lang/assert'),
 	ComparatorBuilder = require('@barchart/common-js/collections/sorting/ComparatorBuilder'),
@@ -17622,8 +17622,8 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			ranges = PositionSummaryFrame.YEARLY.getRanges(transactions);
 		});
 
-		it('should have three ranges (assuming the current year is 2018)', () => {
-			expect(ranges.length).toEqual(3);
+		it('should have four ranges (assuming the current year is 2019)', () => {
+			expect(ranges.length).toEqual(4);
 		});
 
 		it('the first range should be from 12-31-2014 to 12-31-2015', () => {
@@ -17640,6 +17640,11 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges[2].start.format()).toEqual('2016-12-31');
 			expect(ranges[2].end.format()).toEqual('2017-12-31');
 		});
+
+		it('the fourth range should be from 12-31-2017 to 12-31-2018', () => {
+			expect(ranges[3].start.format()).toEqual('2017-12-31');
+			expect(ranges[3].end.format()).toEqual('2018-12-31');
+		});
 	});
 
 	describe('and yearly position summary ranges are processed for a transaction set closes the same year', () => {
@@ -17715,7 +17720,7 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
-	describe('and yearly position summary ranges are processed for a transaction set closes in the current next year -- assuming its 2018', () => {
+	describe('and yearly position summary ranges are processed for a transaction set that opens in 2015 and closes in 2017', () => {
 		let ranges;
 
 		beforeEach(() => {
@@ -17739,7 +17744,7 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			ranges = PositionSummaryFrame.YEARLY.getRanges(transactions);
 		});
 
-		it('should have two ranges', () => {
+		it('should have three ranges', () => {
 			expect(ranges.length).toEqual(3);
 		});
 
@@ -17759,7 +17764,7 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
-	describe('and yearly position summary ranges are processed for a transaction set closed in 2016, but has after-the-fact superfluous valuations in 2017 and 2018', () => {
+	describe('and yearly position summary ranges are processed for a transaction set that opens in 2019 and closes in 2016, but has after-the-fact superfluous valuations in 2017 and 2018', () => {
 		let ranges;
 
 		beforeEach(() => {
@@ -17812,7 +17817,7 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
-	describe('and a year-to-date position summary ranges are processed for a transaction set that closed last year', () => {
+	describe('and a year-to-date position summary ranges are processed for a transaction set that closed in 2017', () => {
 		let ranges;
 
 		beforeEach(() => {
@@ -17841,13 +17846,13 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
-	describe('and a year-to-date position summary ranges are processed for a transaction set that opened this year and has not yet closed', () => {
+	describe('and a year-to-date position summary ranges are processed for a transaction set that opened this year and has not yet closed (assuming its 2019)', () => {
 		let ranges;
 
 		beforeEach(() => {
 			const transactions = [
 				{
-					date: new Day(2018, 1, 1),
+					date: new Day(2019, 1, 1),
 					snapshot: {
 						open: new Decimal(100)
 					},
@@ -17862,26 +17867,26 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges.length).toEqual(1);
 		});
 
-		it('the first range should be from 12-31-2017 to 12-31-2015', () => {
-			expect(ranges[0].start.format()).toEqual('2017-12-31');
-			expect(ranges[0].end.format()).toEqual('2018-12-31');
+		it('the first range should be from 12-31-2018 to 12-31-2019', () => {
+			expect(ranges[0].start.format()).toEqual('2018-12-31');
+			expect(ranges[0].end.format()).toEqual('2019-12-31');
 		});
 	});
 
-	describe('and a year-to-date position summary ranges are processed for a transaction set that opened and closed this year', () => {
+	describe('and a year-to-date position summary ranges are processed for a transaction set that that opened and closed in 2019', () => {
 		let ranges;
 
 		beforeEach(() => {
 			const transactions = [
 				{
-					date: new Day(2018, 1, 1),
+					date: new Day(2019, 1, 1),
 					snapshot: {
 						open: new Decimal(1)
 					},
 					type: TransactionType.BUY
 				},
 				{
-					date: new Day(2018, 1, 2),
+					date: new Day(2019, 1, 2),
 					snapshot: {
 						open: new Decimal(0)
 					},
@@ -17896,62 +17901,20 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges.length).toEqual(1);
 		});
 
-		it('the first range should be from 12-31-2017 to 12-31-2015', () => {
-			expect(ranges[0].start.format()).toEqual('2017-12-31');
-			expect(ranges[0].end.format()).toEqual('2018-12-31');
-		});
-	});
-
-	describe('and month position summary ranges are processed for a transaction set that does not close', () => {
-		let ranges;
-
-		beforeEach(() => {
-			const transactions = [
-				{
-					date: new Day(2018, 10, 20),
-					snapshot: {
-						open: new Decimal(1)
-					},
-					type: TransactionType.BUY
-				},
-				{
-					date: new Day(2018, 11, 21),
-					snapshot: {
-						open: new Decimal(1)
-					},
-					type: TransactionType.BUY
-				}
-			];
-
-			ranges = PositionSummaryFrame.MONTHLY.getRanges(transactions);
-		});
-
-		it('should have three ranges (assuming the current year is 2018 and the current month is December)', () => {
-			expect(ranges.length).toEqual(3);
-		});
-
-		it('the first range should be from 2018-09-30 to 2018-10-31', () => {
-			expect(ranges[0].start.format()).toEqual('2018-09-30');
-			expect(ranges[0].end.format()).toEqual('2018-10-31');
-		});
-
-		it('the second range should be from 2018-10-31 to 2018-11-30', () => {
-		  expect(ranges[1].start.format()).toEqual('2018-10-31');
-		  expect(ranges[1].end.format()).toEqual('2018-11-30');
-		});
-
-		it('the third range should be from 2018-10-31 to 2018-11-30', () => {
-			expect(ranges[2].start.format()).toEqual('2018-11-30');
-			expect(ranges[2].end.format()).toEqual('2018-12-31');
+		it('the first range should be from 12-31-2018 to 12-31-2019', () => {
+			expect(ranges[0].start.format()).toEqual('2018-12-31');
+			expect(ranges[0].end.format()).toEqual('2019-12-31');
 		});
 	});
 
 	describe('and getting the start date for yearly frames', () => {
-		describe('for one year ago', function() {
+		describe('for one year ago', () => {
 			let start;
+			let today;
 
 			beforeEach(() => {
 				start = PositionSummaryFrame.YEARLY.getStartDate(1);
+				today = new Date();
 			});
 
 			it('should be in December', () => {
@@ -17963,15 +17926,17 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			});
 
 			it('should be two years ago', () => {
-				expect(start.year).toEqual(Day.getToday().year - 2);
+				expect(start.year).toEqual(today.getFullYear() - 2);
 			});
 		});
 
-		describe('for two years ago', function() {
+		describe('for two years ago', () => {
 			let start;
+			let today;
 
 			beforeEach(() => {
 				start = PositionSummaryFrame.YEARLY.getStartDate(2);
+				today = new Date();
 			});
 
 			it('should be in December', () => {
@@ -17982,61 +17947,12 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 				expect(start.day).toEqual(31);
 			});
 
-			it('should be two years ago', () => {
-				expect(start.year).toEqual(Day.getToday().year - 3);
+			it('should be three years ago', () => {
+				expect(start.year).toEqual(today.getFullYear() - 3);
 			});
 		});
 	});
 
-
-
-
-	////
-
-	describe('and getting the start date for monthly frames', () => {
-		describe('for one month ago', function () {
-			let start;
-
-			beforeEach(() => {
-				start = PositionSummaryFrame.MONTHLY.getStartDate(1);
-			});
-
-			it('should be on the last day of month', () => {
-				const today = Day.getToday();
-				
-				expect(start.day).toEqual(Day.getDaysInMonth(today.year, today.month - 2));
-			});
-
-			it('should be month ago', () => {
-				expect(start.month).toEqual(Day.getToday().month - 2);
-			});
-		});
-    
-    describe('for three months ago', function () {
-      let start;
-      
-      beforeEach(() => {
-        start = PositionSummaryFrame.MONTHLY.getStartDate(3);
-      });
-      
-      it('should be on the last day of month', () => {
-        const today = Day.getToday();
-        
-        expect(start.day).toEqual(Day.getDaysInMonth(today.year, today.month - 4));
-      });
-      
-      it('should be 3 month ago', () => {
-        expect(start.month).toEqual(Day.getToday().month - 4);
-      });
-    });
-	});
-
-	////
-
-
-
-
-
 	describe('and recent ranges are calculated', () => {
 		let todayYear;
 		let todayMonth;
@@ -18150,7 +18066,7 @@ describe('When validating transaction order', () => {
 	'use strict';
 
 	const build = (sequence, day, type) => {
-		return { sequence: sequence, date: Day.parse(day), type: (type || TransactionType.BUY ) };
+		return { sequence: sequence, date: Day.parse(day), type: (type || TransactionType.BUY) };
 	};
 
 	it('An array of zero transactions should be valid', () => {

package/test/specs/data/PositionSummaryFrameSpec.js

@@ -31,8 +31,8 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			ranges = PositionSummaryFrame.YEARLY.getRanges(transactions);
 		});
 
-		it('should have three ranges (assuming the current year is 2018)', () => {
-			expect(ranges.length).toEqual(3);
+		it('should have four ranges (assuming the current year is 2019)', () => {
+			expect(ranges.length).toEqual(4);
 		});
 
 		it('the first range should be from 12-31-2014 to 12-31-2015', () => {
@@ -49,6 +49,11 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges[2].start.format()).toEqual('2016-12-31');
 			expect(ranges[2].end.format()).toEqual('2017-12-31');
 		});
+
+		it('the fourth range should be from 12-31-2017 to 12-31-2018', () => {
+			expect(ranges[3].start.format()).toEqual('2017-12-31');
+			expect(ranges[3].end.format()).toEqual('2018-12-31');
+		});
 	});
 
 	describe('and yearly position summary ranges are processed for a transaction set closes the same year', () => {
@@ -124,7 +129,7 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
-	describe('and yearly position summary ranges are processed for a transaction set closes in the current next year -- assuming its 2018', () => {
+	describe('and yearly position summary ranges are processed for a transaction set that opens in 2015 and closes in 2017', () => {
 		let ranges;
 
 		beforeEach(() => {
@@ -148,7 +153,7 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			ranges = PositionSummaryFrame.YEARLY.getRanges(transactions);
 		});
 
-		it('should have two ranges', () => {
+		it('should have three ranges', () => {
 			expect(ranges.length).toEqual(3);
 		});
 
@@ -168,7 +173,7 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
-	describe('and yearly position summary ranges are processed for a transaction set closed in 2016, but has after-the-fact superfluous valuations in 2017 and 2018', () => {
+	describe('and yearly position summary ranges are processed for a transaction set that opens in 2019 and closes in 2016, but has after-the-fact superfluous valuations in 2017 and 2018', () => {
 		let ranges;
 
 		beforeEach(() => {
@@ -221,7 +226,7 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
-	describe('and a year-to-date position summary ranges are processed for a transaction set that closed last year', () => {
+	describe('and a year-to-date position summary ranges are processed for a transaction set that closed in 2017', () => {
 		let ranges;
 
 		beforeEach(() => {
@@ -250,13 +255,13 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
-	describe('and a year-to-date position summary ranges are processed for a transaction set that opened this year and has not yet closed', () => {
+	describe('and a year-to-date position summary ranges are processed for a transaction set that opened this year and has not yet closed (assuming its 2019)', () => {
 		let ranges;
 
 		beforeEach(() => {
 			const transactions = [
 				{
-					date: new Day(2018, 1, 1),
+					date: new Day(2019, 1, 1),
 					snapshot: {
 						open: new Decimal(100)
 					},
@@ -271,26 +276,26 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges.length).toEqual(1);
 		});
 
-		it('the first range should be from 12-31-2017 to 12-31-2015', () => {
-			expect(ranges[0].start.format()).toEqual('2017-12-31');
-			expect(ranges[0].end.format()).toEqual('2018-12-31');
+		it('the first range should be from 12-31-2018 to 12-31-2019', () => {
+			expect(ranges[0].start.format()).toEqual('2018-12-31');
+			expect(ranges[0].end.format()).toEqual('2019-12-31');
 		});
 	});
 
-	describe('and a year-to-date position summary ranges are processed for a transaction set that opened and closed this year', () => {
+	describe('and a year-to-date position summary ranges are processed for a transaction set that that opened and closed in 2019', () => {
 		let ranges;
 
 		beforeEach(() => {
 			const transactions = [
 				{
-					date: new Day(2018, 1, 1),
+					date: new Day(2019, 1, 1),
 					snapshot: {
 						open: new Decimal(1)
 					},
 					type: TransactionType.BUY
 				},
 				{
-					date: new Day(2018, 1, 2),
+					date: new Day(2019, 1, 2),
 					snapshot: {
 						open: new Decimal(0)
 					},
@@ -305,62 +310,20 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges.length).toEqual(1);
 		});
 
-		it('the first range should be from 12-31-2017 to 12-31-2015', () => {
-			expect(ranges[0].start.format()).toEqual('2017-12-31');
-			expect(ranges[0].end.format()).toEqual('2018-12-31');
-		});
-	});
-
-	describe('and month position summary ranges are processed for a transaction set that does not close', () => {
-		let ranges;
-
-		beforeEach(() => {
-			const transactions = [
-				{
-					date: new Day(2018, 10, 20),
-					snapshot: {
-						open: new Decimal(1)
-					},
-					type: TransactionType.BUY
-				},
-				{
-					date: new Day(2018, 11, 21),
-					snapshot: {
-						open: new Decimal(1)
-					},
-					type: TransactionType.BUY
-				}
-			];
-
-			ranges = PositionSummaryFrame.MONTHLY.getRanges(transactions);
-		});
-
-		it('should have three ranges (assuming the current year is 2018 and the current month is December)', () => {
-			expect(ranges.length).toEqual(3);
-		});
-
-		it('the first range should be from 2018-09-30 to 2018-10-31', () => {
-			expect(ranges[0].start.format()).toEqual('2018-09-30');
-			expect(ranges[0].end.format()).toEqual('2018-10-31');
-		});
-
-		it('the second range should be from 2018-10-31 to 2018-11-30', () => {
-		  expect(ranges[1].start.format()).toEqual('2018-10-31');
-		  expect(ranges[1].end.format()).toEqual('2018-11-30');
-		});
-
-		it('the third range should be from 2018-10-31 to 2018-11-30', () => {
-			expect(ranges[2].start.format()).toEqual('2018-11-30');
-			expect(ranges[2].end.format()).toEqual('2018-12-31');
+		it('the first range should be from 12-31-2018 to 12-31-2019', () => {
+			expect(ranges[0].start.format()).toEqual('2018-12-31');
+			expect(ranges[0].end.format()).toEqual('2019-12-31');
 		});
 	});
 
 	describe('and getting the start date for yearly frames', () => {
-		describe('for one year ago', function() {
+		describe('for one year ago', () => {
 			let start;
+			let today;
 
 			beforeEach(() => {
 				start = PositionSummaryFrame.YEARLY.getStartDate(1);
+				today = new Date();
 			});
 
 			it('should be in December', () => {
@@ -372,15 +335,17 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			});
 
 			it('should be two years ago', () => {
-				expect(start.year).toEqual(Day.getToday().year - 2);
+				expect(start.year).toEqual(today.getFullYear() - 2);
 			});
 		});
 
-		describe('for two years ago', function() {
+		describe('for two years ago', () => {
 			let start;
+			let today;
 
 			beforeEach(() => {
 				start = PositionSummaryFrame.YEARLY.getStartDate(2);
+				today = new Date();
 			});
 
 			it('should be in December', () => {
@@ -391,61 +356,12 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 				expect(start.day).toEqual(31);
 			});
 
-			it('should be two years ago', () => {
-				expect(start.year).toEqual(Day.getToday().year - 3);
+			it('should be three years ago', () => {
+				expect(start.year).toEqual(today.getFullYear() - 3);
 			});
 		});
 	});
 
-
-
-
-	////
-
-	describe('and getting the start date for monthly frames', () => {
-		describe('for one month ago', function () {
-			let start;
-
-			beforeEach(() => {
-				start = PositionSummaryFrame.MONTHLY.getStartDate(1);
-			});
-
-			it('should be on the last day of month', () => {
-				const today = Day.getToday();
-				
-				expect(start.day).toEqual(Day.getDaysInMonth(today.year, today.month - 2));
-			});
-
-			it('should be month ago', () => {
-				expect(start.month).toEqual(Day.getToday().month - 2);
-			});
-		});
-    
-    describe('for three months ago', function () {
-      let start;
-      
-      beforeEach(() => {
-        start = PositionSummaryFrame.MONTHLY.getStartDate(3);
-      });
-      
-      it('should be on the last day of month', () => {
-        const today = Day.getToday();
-        
-        expect(start.day).toEqual(Day.getDaysInMonth(today.year, today.month - 4));
-      });
-      
-      it('should be 3 month ago', () => {
-        expect(start.month).toEqual(Day.getToday().month - 4);
-      });
-    });
-	});
-
-	////
-
-
-
-
-
 	describe('and recent ranges are calculated', () => {
 		let todayYear;
 		let todayMonth;

package/test/specs/data/TransactionValidatorSpec.js

@@ -7,7 +7,7 @@ describe('When validating transaction order', () => {
 	'use strict';
 
 	const build = (sequence, day, type) => {
-		return { sequence: sequence, date: Day.parse(day), type: (type || TransactionType.BUY ) };
+		return { sequence: sequence, date: Day.parse(day), type: (type || TransactionType.BUY) };
 	};
 
 	it('An array of zero transactions should be valid', () => {