@barchart/portfolio-api-common 1.3.20 → 1.3.21

package/.jshintrc

@@ -1,3 +1,5 @@
 {
-  "validthis": true
+  "esversion": 6,
+  "validthis": true,
+  "-W018": true
 }

package/gulpfile.js

@@ -11,7 +11,6 @@ const browserify = require('browserify'),
 	glob = require('glob'),
 	jasmine = require('gulp-jasmine'),
 	jshint = require('gulp-jshint'),
-	replace = require('gulp-replace'),
 	source = require('vinyl-source-stream');
 
 function getVersionFromPackage() {
@@ -30,8 +29,8 @@ gulp.task('ensure-clean-working-directory', (cb) => {
 
 gulp.task('bump-version', () => {
 	return gulp.src([ './package.json' ])
-	.pipe(bump({ type: 'patch' }))
-	.pipe(gulp.dest('./'));
+		.pipe(bump({ type: 'patch' }))
+		.pipe(gulp.dest('./'));
 });
 
 gulp.task('document', (cb) => {

package/lib/api/failures/PortfolioFailureType.js

@@ -88,7 +88,7 @@ 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.
@@ -101,6 +101,18 @@ module.exports = (() => {
 			return transactionCreateFailedInvalidDate;
 		}
 
+		/**
+		 * The target instrument is invalid.
+		 * Can be used in Merger and Acquisition.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_TARGET_INSTRUMENT_MISSING() {
+			return transactionCreateFailedTargetInstrumentMissing;
+		}
+
 		/**
 		 * @public
 		 * @static
@@ -153,6 +165,29 @@ module.exports = (() => {
 			return transactionCreateFailedValuationNegative;
 		}
 
+		/**
+		 * A "terminal" transaction must be the last transaction is the history.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_INVALID_TERMINATION() {
+			return transactionCreateFailedInvalidTermination;
+		}
+
+		/**
+		 * A transaction cannot be created after the termination date of
+		 * the instrument.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_AFTER_TERMINATION() {
+			return transactionCreateFailedAfterTermination;
+		}
+
 		/**
 		 * The transaction (of this type) cannot be created by a user, instead,
 		 * it is created and managed by the system (e.g. dividends).
@@ -255,7 +290,7 @@ module.exports = (() => {
 		static get TRANSACTION_DELETE_FAILED_POSITION_LOCKED() {
 			return transactionDeleteFailedPositionLocked;
 		}
-		
+
 		/**
 		 * The transaction date is invalid.
 		 * For example edit opening transaction after delist date.
@@ -306,11 +341,14 @@ 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?', false);
 	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 transactionCreateFailedTargetInstrumentMissing = new FailureType('TRANSACTION_CREATE_FAILED_TARGET_INSTRUMENT_MISSING', 'Unable to create transaction. The target instrument does not exist.');
 	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.', false);
 	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.', false);
 	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.', false);
 	const transactionCreateFailedValuationNegative = new FailureType('TRANSACTION_CREATE_FAILED_VALUATION_NEGATIVE', 'Unable to process operation, valuations cannot be negative.', false);
+	const transactionCreateFailedInvalidTermination = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_TERMINATION', 'Unable to process operation, a {U|transactionType.description} must be the final transaction in the position history.', false);
+	const transactionCreateFailedAfterTermination = new FailureType('TRANSACTION_CREATE_FAILED_AFTER_TERMINATION', 'Unable to process operation, one or more transactions would exist after {L|termination}, the final day of trading for this instrument', false);
 
 	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.');

package/lib/data/CorporateActionType.js

@@ -82,6 +82,28 @@ module.exports = (() => {
 		static get DELIST() {
 			return delist;
 		}
+
+		/**
+		 * A merging.
+		 *
+		 * @public
+		 * @static
+		 * @returns {CorporateActionType}
+		 */
+		static get MERGER() {
+			return merger;
+		}
+
+		/**
+		 * A spinoff.
+		 *
+		 * @public
+		 * @static
+		 * @returns {CorporateActionType}
+		 */
+		static get SPINOFF() {
+			return spinoff;
+		}
 	}
 
 	const split = new CorporateActionType('SPLIT', 'Split', false);
@@ -90,6 +112,8 @@ module.exports = (() => {
 	const symbolChange = new CorporateActionType('SYMBOL_CHANGE', 'Symbol Change', false);
 	const nameChange = new CorporateActionType('NAME_CHANGE', 'Name Change', false);
 	const delist = new CorporateActionType('DELIST', 'Delist', false);
+	const merger = new CorporateActionType('MERGER', 'Merger', false);
+	const spinoff = new CorporateActionType('SPINOFF', 'Spinoff', false);
 
 	return CorporateActionType;
 })();

package/lib/data/TransactionType.js

@@ -21,11 +21,14 @@ module.exports = (() => {
 	 * @param {Boolean} fee
 	 * @param {Boolean} corporateAction
 	 * @param {Boolean} initial
+	 * @param {Boolean} terminal
 	 * @param {Boolean} significant
-	 * @param {Boolean} system
+	 * @param {Boolean} chaining
+	 * @param {Boolean} chained
+	 * @param {Boolean} transfer
  	 */
 	class TransactionType extends Enum {
-		constructor(code, description, display, sequence, purchase, sale, income, opening, closing, fee, corporateAction, initial, significant) {
+		constructor(code, description, display, sequence, purchase, sale, income, opening, closing, fee, corporateAction, initial, terminal, significant, chaining, chained, transfer) {
 			super(code, description);
 
 			assert.argumentIsRequired(display, 'display', String);
@@ -38,7 +41,11 @@ module.exports = (() => {
 			assert.argumentIsRequired(fee, 'fee', Boolean);
 			assert.argumentIsRequired(corporateAction, 'corporateAction', Boolean);
 			assert.argumentIsRequired(initial, 'initial', Boolean);
+			assert.argumentIsRequired(terminal, 'terminal', Boolean);
 			assert.argumentIsRequired(significant, 'significant', Boolean);
+			assert.argumentIsRequired(chaining, 'chaining', Boolean);
+			assert.argumentIsRequired(chained, 'chained', Boolean);
+			assert.argumentIsRequired(transfer, 'transfer', Boolean);
 
 			this._display = display;
 			this._sequence = sequence;
@@ -50,7 +57,11 @@ module.exports = (() => {
 			this._fee = fee;
 			this._corporateAction = corporateAction;
 			this._initial = initial;
+			this._terminal = terminal;
 			this._significant = significant;
+			this._chaining = chaining;
+			this._chained = chained;
+			this._transfer = transfer;
 		}
 
 		/**
@@ -167,6 +178,16 @@ module.exports = (() => {
 			return this._initial;
 		}
 
+		/**
+		 * Indicates if the transaction must be the last
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get terminal() {
+			return this._terminal;
+		}
+
 		/**
 		 * Significant transactions cannot be discarded during transaction re-write.
 		 *
@@ -177,6 +198,37 @@ module.exports = (() => {
 			return this._significant;
 		}
 
+		/**
+		 * Chain transactions cause another position to be created.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get chaining() {
+			return this._chaining;
+		}
+
+		/**
+		 * Chained transactions are created from another position.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get chained() {
+			return this._chained;
+		}
+
+		/**
+		 * Indicates if the transaction should cause gains and losses to be
+		 * transferred from the original (chaining) position.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get transfer() {
+			return this._transfer;
+		}
+
 		/**
 		 * A purchase.
 		 *
@@ -352,7 +404,7 @@ module.exports = (() => {
 		static get DEBIT() {
 			return debit;
 		}
-  
+
 		/**
 		 * A system-generated transaction, indicating the security has stopped active trading.
 		 *
@@ -397,34 +449,84 @@ module.exports = (() => {
 			return income;
 		}
 
+		/**
+		 * A merger opening.
+		 *
+		 * @public
+		 * @static
+		 * @returns {TransactionType}
+		 */
+		static get MERGER_OPEN() {
+			return mergerOpen;
+		}
+
+		/**
+		 * A merger closing.
+		 *
+		 * @public
+		 * @static
+		 * @returns {TransactionType}
+		 */
+		static get MERGER_CLOSE() {
+			return mergerClose;
+		}
+
+		/**
+		 * A spin-off.
+		 *
+		 * @public
+		 * @static
+		 * @returns {TransactionType}
+		 */
+		static get SPINOFF() {
+			return spinoff;
+		}
+
+		/**
+		 * A spin-off opening.
+		 *
+		 * @public
+		 * @static
+		 * @returns {TransactionType}
+		 */
+		static get SPINOFF_OPEN() {
+			return spinoffOpen;
+		}
+
 		toString() {
 			return '[TransactionType]';
 		}
 	}
 
-	const buy = new TransactionType('B', 'Buy', 'Buy', 0, true, false, false, true, false, false, false, true, true);
-	const sell = new TransactionType('S', 'Sell', 'Sell', 0, false, true, false, false, true, false, false, false, true);
-	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', 0, true, false, false, false, true, false, false, false, true);
-	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', 0, false, true, false, true, false, false, false, true, true);
-	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', 1, false, false, true, false, false, false, true, false, false);
-	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', 1, false, false, false, true, false, false, true, false, false);
-	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', 1, false, false, false, true, false, false, true, false, false);
-	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', 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);
-	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', 1, false, false, false, true, false, false, true, false, false);
-
-	const deposit = new TransactionType('D', 'Deposit', 'Deposit', 0, false, false, false, false, false, false, false, true, true);
-	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', 0, false, false, false, false, false, false, false, true, true);
-	const debit = new TransactionType('DR', 'Debit', 'Debit', 0, false, false, false, false, false, false, false, true, true);
-	const credit = new TransactionType('CR', 'Credit', 'Credit', 0, false, false, false, false, false, false, false, true, true);
-
-	const valuation = new TransactionType('V', 'Valuation', 'Valuation', 0, false, false, false, false, false, false, false, false, false);
-	const income = new TransactionType('I', 'Income', 'Income', 0, false, false, true, false, false, false, false, false, false);
+	const buy = new TransactionType('B', 'Buy', 'Buy', 0, true, false, false, true, false, false, false, true, false, true, false, false, false);
+	const sell = new TransactionType('S', 'Sell', 'Sell', 0, false, true, false, false, true, false, false, false, false, true, false, false, false);
+	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', 0, true, false, false, false, true, false, false, false, false, true, false, false, false);
+	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', 0, false, true, false, true, false, false, false, true, false, true, false, false, false);
+	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', 1, false, false, true, false, false, false, true, false, false, false, false, false, false);
+	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', 1, false, false, false, true, false, false, true, false, false, false, false, false, false);
+	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', 1, false, false, false, true, false, false, true, false, false, false, false, false, false);
+	const split = new TransactionType('SP', 'Split', 'Split', 1, false, false, false, true, false, false, true, false, false, false, false, false, false);
+	const fee = new TransactionType('F', 'Fee', 'Fee', 0, false, false, false, false, false, true, false, false, false, false, false, false, false);
+	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', 0, false, false, false, false, true, false, false, false, false, false, false, false, false);
+	const delist = new TransactionType('DL', 'Delist', 'Delist', 1, false, false, false, false, false, false, true, false, true, false, false, false, false);
+
+	const mergerOpen = new TransactionType('MO', 'Merger Open', 'Merger Open', 1, false, false, false, true, false, false, true, true, false, true, false, true, true);
+	const mergerClose = new TransactionType('MC', 'Merger Close', 'Merger Close', 1, false, false, false, false, true, false, true, false, true, false, true, false, false);
+
+	const spinoff = new TransactionType('SPF', 'Spinoff', 'Spinoff', 1, false, false, false, false, false, false, true, false, false, false, true, false, false);
+	const spinoffOpen = new TransactionType('SPFO', 'Spinoff Open', 'Spinoff Open', 1, false, false, false, true, false, false, true, true, false, true, false, false, false);
+
+	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', 1, false, false, true, false, false, false, true, false, false, false, false, false, false);
+	const distributionReinvest = new TransactionType('DY', 'Distribution (Reinvested)', 'Distribution Reinvest', 1, false, false, false, true, false, false, true, false, false, false, false, false, false);
+	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', 1, false, false, false, true, false, false, true, false, false, false, false, false, false);
+
+	const deposit = new TransactionType('D', 'Deposit', 'Deposit', 0, false, false, false, false, false, false, false, true, false, true, false, false, false);
+	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', 0, false, false, false, false, false, false, false, true, false, true, false, false, false);
+	const debit = new TransactionType('DR', 'Debit', 'Debit', 0, false, false, false, false, false, false, false, true, false, true, false, false, false);
+	const credit = new TransactionType('CR', 'Credit', 'Credit', 0, false, false, false, false, false, false, false, true, false, true, false, false, false);
+
+	const valuation = new TransactionType('V', 'Valuation', 'Valuation', 0, false, false, false, false, false, false, false, false, false, false, false, false, false);
+	const income = new TransactionType('I', 'Income', 'Income', 0, false, false, true, false, false, false, false, false, false, false, false, false, false);
 
 	return TransactionType;
 })();

package/lib/data/TransactionValidator.js

@@ -186,7 +186,7 @@ module.exports = (() => {
 		static validateInitialTransactionType(transactionType) {
 			return transactionType.initial;
 		}
-		
+
 		/**
 		 * Determines if a position for a given instrument type can exist in
 		 * the given direction.
@@ -246,6 +246,10 @@ module.exports = (() => {
 	associateTypes(InstrumentType.EQUITY, TransactionType.DIVIDEND_STOCK, false);
 	associateTypes(InstrumentType.EQUITY, TransactionType.SPLIT, false);
 	associateTypes(InstrumentType.EQUITY, TransactionType.DELIST, false);
+	associateTypes(InstrumentType.EQUITY, TransactionType.MERGER_OPEN, false);
+	associateTypes(InstrumentType.EQUITY, TransactionType.MERGER_CLOSE, false);
+	associateTypes(InstrumentType.EQUITY, TransactionType.SPINOFF, false);
+	associateTypes(InstrumentType.EQUITY, TransactionType.SPINOFF_OPEN, false);
 
 	associateTypes(InstrumentType.FUND, TransactionType.BUY, true, [ PositionDirection.LONG, PositionDirection.EVEN ]);
 	associateTypes(InstrumentType.FUND, TransactionType.SELL, true, [ PositionDirection.LONG ]);
@@ -255,6 +259,10 @@ module.exports = (() => {
 	associateTypes(InstrumentType.FUND, TransactionType.DISTRIBUTION_REINVEST, false);
 	associateTypes(InstrumentType.FUND, TransactionType.DISTRIBUTION_FUND, false);
 	associateTypes(InstrumentType.FUND, TransactionType.DELIST, false);
+	associateTypes(InstrumentType.FUND, TransactionType.MERGER_OPEN, false);
+	associateTypes(InstrumentType.FUND, TransactionType.MERGER_CLOSE, false);
+	associateTypes(InstrumentType.FUND, TransactionType.SPINOFF, false);
+	associateTypes(InstrumentType.FUND, TransactionType.SPINOFF_OPEN, false);
 
 	associateTypes(InstrumentType.OTHER, TransactionType.BUY, true, [ PositionDirection.LONG, PositionDirection.EVEN ]);
 	associateTypes(InstrumentType.OTHER, TransactionType.SELL, true, [ PositionDirection.LONG ]);

package/lib/formatters/TransactionFormatter.js

@@ -326,6 +326,38 @@ module.exports = (() => {
 		f.description = t.description;
 	};
 
+	const mergerFormatter = (t, f) => {
+		f.boughtSold = t.quantity;
+
+		let rate;
+
+		if (!t.merger.denominator.getIsZero()) {
+			rate = t.merger.numerator.divide(t.merger.denominator);
+		} else {
+			rate = '';
+		}
+
+		f.rate = rate;
+
+		f.shares = t.snapshot.open.subtract(t.quantity);
+	};
+
+	const spinoffFormatter = (t, f) => {
+		f.boughtSold = t.quantity;
+
+		let rate;
+
+		if (!t.spinoff.denominator.getIsZero()) {
+			rate = t.spinoff.numerator.divide(t.spinoff.denominator);
+		} else {
+			rate = '';
+		}
+
+		f.rate = rate;
+
+		f.shares = t.snapshot.open.subtract(t.quantity);
+	};
+
 	const formatters = new Map();
 
 	formatters.set(TransactionType.BUY, [ basicFormatter, buySellFormatter, averageCostFormatter ]);
@@ -348,6 +380,10 @@ module.exports = (() => {
 	formatters.set(TransactionType.WITHDRAWAL, [ basicFormatter, cashFormatter ]);
 	formatters.set(TransactionType.DEBIT, [ basicFormatter, cashFormatter, debitFormatter ]);
 	formatters.set(TransactionType.CREDIT, [ basicFormatter, cashFormatter, creditFormatter ]);
+	formatters.set(TransactionType.MERGER_OPEN, [ basicFormatter ]);
+	formatters.set(TransactionType.MERGER_CLOSE, [ basicFormatter, mergerFormatter ]);
+	formatters.set(TransactionType.SPINOFF, [ basicFormatter, spinoffFormatter ]);
+	formatters.set(TransactionType.SPINOFF_OPEN, [ basicFormatter ]);
 
 	function getInstrumentTypePriority(type) {
 		if (type === InstrumentType.CASH) {

package/lib/serialization/TransactionSchema.js

@@ -113,7 +113,7 @@ module.exports = (() => {
 		static get VALUATION() {
 			return valuation;
 		}
-		
+
 		static get DELIST() {
 			return delist;
 		}
@@ -162,6 +162,10 @@ module.exports = (() => {
 		.withField('split.denominator', DataType.DECIMAL, true)
 		.withField('split.effective', DataType.DAY, true)
 		.withField('split.reference', DataType.STRING, true)
+		.withField('merger.numerator', DataType.DECIMAL, true)
+		.withField('merger.denominator', DataType.DECIMAL, true)
+		.withField('spinoff.numerator', DataType.DECIMAL, true)
+		.withField('spinoff.denominator', DataType.DECIMAL, true)
 		.withField('charge.amount', DataType.DECIMAL, true)
 		.withField('income.amount', DataType.DECIMAL, true)
 		.withField('valuation.rate', DataType.DECIMAL, true)
@@ -201,6 +205,10 @@ module.exports = (() => {
 		.withField('split.denominator', DataType.DECIMAL, true)
 		.withField('split.effective', DataType.DAY, true)
 		.withField('split.reference', DataType.STRING, true)
+		.withField('merger.numerator', DataType.DECIMAL, true)
+		.withField('merger.denominator', DataType.DECIMAL, true)
+		.withField('spinoff.numerator', DataType.DECIMAL, true)
+		.withField('spinoff.denominator', DataType.DECIMAL, true)
 		.withField('charge.amount', DataType.DECIMAL, true)
 		.withField('income.amount', DataType.DECIMAL, true)
 		.withField('valuation.rate', DataType.DECIMAL, true)
@@ -326,7 +334,7 @@ module.exports = (() => {
 		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
-	
+
 	const delist = new TransactionSchema(SchemaBuilder.withName(TransactionType.DELIST.code)
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
@@ -336,7 +344,7 @@ module.exports = (() => {
 		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
-  
+
   const income = new TransactionSchema(SchemaBuilder.withName(TransactionType.INCOME.code)
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.3.20",
+  "version": "1.3.21",
   "description": "Common classes used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",
@@ -24,7 +24,6 @@
     "gulp-jasmine": "^2.2.1",
     "gulp-jsdoc3": "^1.0.1",
     "gulp-jshint": "~2.1.0",
-    "gulp-replace": "^0.5.4",
     "jsdoc": "^3.5.5",
     "jshint": "2.9.5",
     "vinyl-buffer": "^1.0.1",

package/test/SpecRunner.js

@@ -774,11 +774,14 @@ module.exports = (() => {
 	 * @param {Boolean} fee
 	 * @param {Boolean} corporateAction
 	 * @param {Boolean} initial
+	 * @param {Boolean} terminal
 	 * @param {Boolean} significant
-	 * @param {Boolean} system
+	 * @param {Boolean} chaining
+	 * @param {Boolean} chained
+	 * @param {Boolean} transfer
  	 */
 	class TransactionType extends Enum {
-		constructor(code, description, display, sequence, purchase, sale, income, opening, closing, fee, corporateAction, initial, significant) {
+		constructor(code, description, display, sequence, purchase, sale, income, opening, closing, fee, corporateAction, initial, terminal, significant, chaining, chained, transfer) {
 			super(code, description);
 
 			assert.argumentIsRequired(display, 'display', String);
@@ -791,7 +794,11 @@ module.exports = (() => {
 			assert.argumentIsRequired(fee, 'fee', Boolean);
 			assert.argumentIsRequired(corporateAction, 'corporateAction', Boolean);
 			assert.argumentIsRequired(initial, 'initial', Boolean);
+			assert.argumentIsRequired(terminal, 'terminal', Boolean);
 			assert.argumentIsRequired(significant, 'significant', Boolean);
+			assert.argumentIsRequired(chaining, 'chaining', Boolean);
+			assert.argumentIsRequired(chained, 'chained', Boolean);
+			assert.argumentIsRequired(transfer, 'transfer', Boolean);
 
 			this._display = display;
 			this._sequence = sequence;
@@ -803,7 +810,11 @@ module.exports = (() => {
 			this._fee = fee;
 			this._corporateAction = corporateAction;
 			this._initial = initial;
+			this._terminal = terminal;
 			this._significant = significant;
+			this._chaining = chaining;
+			this._chained = chained;
+			this._transfer = transfer;
 		}
 
 		/**
@@ -920,6 +931,16 @@ module.exports = (() => {
 			return this._initial;
 		}
 
+		/**
+		 * Indicates if the transaction must be the last
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get terminal() {
+			return this._terminal;
+		}
+
 		/**
 		 * Significant transactions cannot be discarded during transaction re-write.
 		 *
@@ -930,6 +951,37 @@ module.exports = (() => {
 			return this._significant;
 		}
 
+		/**
+		 * Chain transactions cause another position to be created.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get chaining() {
+			return this._chaining;
+		}
+
+		/**
+		 * Chained transactions are created from another position.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get chained() {
+			return this._chained;
+		}
+
+		/**
+		 * Indicates if the transaction should cause gains and losses to be
+		 * transferred from the original (chaining) position.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get transfer() {
+			return this._transfer;
+		}
+
 		/**
 		 * A purchase.
 		 *
@@ -1105,7 +1157,7 @@ module.exports = (() => {
 		static get DEBIT() {
 			return debit;
 		}
-  
+
 		/**
 		 * A system-generated transaction, indicating the security has stopped active trading.
 		 *
@@ -1150,34 +1202,84 @@ module.exports = (() => {
 			return income;
 		}
 
+		/**
+		 * A merger opening.
+		 *
+		 * @public
+		 * @static
+		 * @returns {TransactionType}
+		 */
+		static get MERGER_OPEN() {
+			return mergerOpen;
+		}
+
+		/**
+		 * A merger closing.
+		 *
+		 * @public
+		 * @static
+		 * @returns {TransactionType}
+		 */
+		static get MERGER_CLOSE() {
+			return mergerClose;
+		}
+
+		/**
+		 * A spin-off.
+		 *
+		 * @public
+		 * @static
+		 * @returns {TransactionType}
+		 */
+		static get SPINOFF() {
+			return spinoff;
+		}
+
+		/**
+		 * A spin-off opening.
+		 *
+		 * @public
+		 * @static
+		 * @returns {TransactionType}
+		 */
+		static get SPINOFF_OPEN() {
+			return spinoffOpen;
+		}
+
 		toString() {
 			return '[TransactionType]';
 		}
 	}
 
-	const buy = new TransactionType('B', 'Buy', 'Buy', 0, true, false, false, true, false, false, false, true, true);
-	const sell = new TransactionType('S', 'Sell', 'Sell', 0, false, true, false, false, true, false, false, false, true);
-	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', 0, true, false, false, false, true, false, false, false, true);
-	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', 0, false, true, false, true, false, false, false, true, true);
-	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', 1, false, false, true, false, false, false, true, false, false);
-	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', 1, false, false, false, true, false, false, true, false, false);
-	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', 1, false, false, false, true, false, false, true, false, false);
-	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', 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);
-	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', 1, false, false, false, true, false, false, true, false, false);
-
-	const deposit = new TransactionType('D', 'Deposit', 'Deposit', 0, false, false, false, false, false, false, false, true, true);
-	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', 0, false, false, false, false, false, false, false, true, true);
-	const debit = new TransactionType('DR', 'Debit', 'Debit', 0, false, false, false, false, false, false, false, true, true);
-	const credit = new TransactionType('CR', 'Credit', 'Credit', 0, false, false, false, false, false, false, false, true, true);
-
-	const valuation = new TransactionType('V', 'Valuation', 'Valuation', 0, false, false, false, false, false, false, false, false, false);
-	const income = new TransactionType('I', 'Income', 'Income', 0, false, false, true, false, false, false, false, false, false);
+	const buy = new TransactionType('B', 'Buy', 'Buy', 0, true, false, false, true, false, false, false, true, false, true, false, false, false);
+	const sell = new TransactionType('S', 'Sell', 'Sell', 0, false, true, false, false, true, false, false, false, false, true, false, false, false);
+	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', 0, true, false, false, false, true, false, false, false, false, true, false, false, false);
+	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', 0, false, true, false, true, false, false, false, true, false, true, false, false, false);
+	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', 1, false, false, true, false, false, false, true, false, false, false, false, false, false);
+	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', 1, false, false, false, true, false, false, true, false, false, false, false, false, false);
+	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', 1, false, false, false, true, false, false, true, false, false, false, false, false, false);
+	const split = new TransactionType('SP', 'Split', 'Split', 1, false, false, false, true, false, false, true, false, false, false, false, false, false);
+	const fee = new TransactionType('F', 'Fee', 'Fee', 0, false, false, false, false, false, true, false, false, false, false, false, false, false);
+	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', 0, false, false, false, false, true, false, false, false, false, false, false, false, false);
+	const delist = new TransactionType('DL', 'Delist', 'Delist', 1, false, false, false, false, false, false, true, false, true, false, false, false, false);
+
+	const mergerOpen = new TransactionType('MO', 'Merger Open', 'Merger Open', 1, false, false, false, true, false, false, true, true, false, true, false, true, true);
+	const mergerClose = new TransactionType('MC', 'Merger Close', 'Merger Close', 1, false, false, false, false, true, false, true, false, true, false, true, false, false);
+
+	const spinoff = new TransactionType('SPF', 'Spinoff', 'Spinoff', 1, false, false, false, false, false, false, true, false, false, false, true, false, false);
+	const spinoffOpen = new TransactionType('SPFO', 'Spinoff Open', 'Spinoff Open', 1, false, false, false, true, false, false, true, true, false, true, false, false, false);
+
+	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', 1, false, false, true, false, false, false, true, false, false, false, false, false, false);
+	const distributionReinvest = new TransactionType('DY', 'Distribution (Reinvested)', 'Distribution Reinvest', 1, false, false, false, true, false, false, true, false, false, false, false, false, false);
+	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', 1, false, false, false, true, false, false, true, false, false, false, false, false, false);
+
+	const deposit = new TransactionType('D', 'Deposit', 'Deposit', 0, false, false, false, false, false, false, false, true, false, true, false, false, false);
+	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', 0, false, false, false, false, false, false, false, true, false, true, false, false, false);
+	const debit = new TransactionType('DR', 'Debit', 'Debit', 0, false, false, false, false, false, false, false, true, false, true, false, false, false);
+	const credit = new TransactionType('CR', 'Credit', 'Credit', 0, false, false, false, false, false, false, false, true, false, true, false, false, false);
+
+	const valuation = new TransactionType('V', 'Valuation', 'Valuation', 0, false, false, false, false, false, false, false, false, false, false, false, false, false);
+	const income = new TransactionType('I', 'Income', 'Income', 0, false, false, true, false, false, false, false, false, false, false, false, false, false);
 
 	return TransactionType;
 })();
@@ -1371,7 +1473,7 @@ module.exports = (() => {
 		static validateInitialTransactionType(transactionType) {
 			return transactionType.initial;
 		}
-		
+
 		/**
 		 * Determines if a position for a given instrument type can exist in
 		 * the given direction.
@@ -1431,6 +1533,10 @@ module.exports = (() => {
 	associateTypes(InstrumentType.EQUITY, TransactionType.DIVIDEND_STOCK, false);
 	associateTypes(InstrumentType.EQUITY, TransactionType.SPLIT, false);
 	associateTypes(InstrumentType.EQUITY, TransactionType.DELIST, false);
+	associateTypes(InstrumentType.EQUITY, TransactionType.MERGER_OPEN, false);
+	associateTypes(InstrumentType.EQUITY, TransactionType.MERGER_CLOSE, false);
+	associateTypes(InstrumentType.EQUITY, TransactionType.SPINOFF, false);
+	associateTypes(InstrumentType.EQUITY, TransactionType.SPINOFF_OPEN, false);
 
 	associateTypes(InstrumentType.FUND, TransactionType.BUY, true, [ PositionDirection.LONG, PositionDirection.EVEN ]);
 	associateTypes(InstrumentType.FUND, TransactionType.SELL, true, [ PositionDirection.LONG ]);
@@ -1440,6 +1546,10 @@ module.exports = (() => {
 	associateTypes(InstrumentType.FUND, TransactionType.DISTRIBUTION_REINVEST, false);
 	associateTypes(InstrumentType.FUND, TransactionType.DISTRIBUTION_FUND, false);
 	associateTypes(InstrumentType.FUND, TransactionType.DELIST, false);
+	associateTypes(InstrumentType.FUND, TransactionType.MERGER_OPEN, false);
+	associateTypes(InstrumentType.FUND, TransactionType.MERGER_CLOSE, false);
+	associateTypes(InstrumentType.FUND, TransactionType.SPINOFF, false);
+	associateTypes(InstrumentType.FUND, TransactionType.SPINOFF_OPEN, false);
 
 	associateTypes(InstrumentType.OTHER, TransactionType.BUY, true, [ PositionDirection.LONG, PositionDirection.EVEN ]);
 	associateTypes(InstrumentType.OTHER, TransactionType.SELL, true, [ PositionDirection.LONG ]);
@@ -4853,7 +4963,7 @@ module.exports = (() => {
 		static get VALUATION() {
 			return valuation;
 		}
-		
+
 		static get DELIST() {
 			return delist;
 		}
@@ -4902,6 +5012,10 @@ module.exports = (() => {
 		.withField('split.denominator', DataType.DECIMAL, true)
 		.withField('split.effective', DataType.DAY, true)
 		.withField('split.reference', DataType.STRING, true)
+		.withField('merger.numerator', DataType.DECIMAL, true)
+		.withField('merger.denominator', DataType.DECIMAL, true)
+		.withField('spinoff.numerator', DataType.DECIMAL, true)
+		.withField('spinoff.denominator', DataType.DECIMAL, true)
 		.withField('charge.amount', DataType.DECIMAL, true)
 		.withField('income.amount', DataType.DECIMAL, true)
 		.withField('valuation.rate', DataType.DECIMAL, true)
@@ -4941,6 +5055,10 @@ module.exports = (() => {
 		.withField('split.denominator', DataType.DECIMAL, true)
 		.withField('split.effective', DataType.DAY, true)
 		.withField('split.reference', DataType.STRING, true)
+		.withField('merger.numerator', DataType.DECIMAL, true)
+		.withField('merger.denominator', DataType.DECIMAL, true)
+		.withField('spinoff.numerator', DataType.DECIMAL, true)
+		.withField('spinoff.denominator', DataType.DECIMAL, true)
 		.withField('charge.amount', DataType.DECIMAL, true)
 		.withField('income.amount', DataType.DECIMAL, true)
 		.withField('valuation.rate', DataType.DECIMAL, true)
@@ -5066,7 +5184,7 @@ module.exports = (() => {
 		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
-	
+
 	const delist = new TransactionSchema(SchemaBuilder.withName(TransactionType.DELIST.code)
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
@@ -5076,7 +5194,7 @@ module.exports = (() => {
 		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
-  
+
   const income = new TransactionSchema(SchemaBuilder.withName(TransactionType.INCOME.code)
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
@@ -17467,7 +17585,7 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 				}
 			];
 
-			ranges = PositionSummaryFrame.YTD.getRanges(transactions);;
+			ranges = PositionSummaryFrame.YTD.getRanges(transactions);
 		});
 
 		it('should have one range', () => {

package/test/specs/data/PositionSummaryFrameSpec.js

@@ -432,7 +432,7 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 				}
 			];
 
-			ranges = PositionSummaryFrame.YTD.getRanges(transactions);;
+			ranges = PositionSummaryFrame.YTD.getRanges(transactions);
 		});
 
 		it('should have one range', () => {