@barchart/portfolio-api-common 1.2.117 → 1.2.118

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/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'),
@@ -217,6 +218,23 @@ module.exports = (() => {
 		static validateDirectionSwitch(instrumentType, currentDirection, proposedDirection) {
 			return currentDirection === null || instrumentType.canSwitchDirection || (currentDirection.closed || proposedDirection.closed || currentDirection.positive === proposedDirection.positive);
 		}
+		
+		/**
+		 * Assuming the transaction list is ordered by sequence, validates that
+		 * no opening transactions exist after delisting date.
+		 *
+		 * @static
+		 * @public
+		 * @param {Array.<Object>} transactions
+		 * @returns {Boolean}
+		 */
+		static validateDelisting(transactions) {
+			assert.argumentIsArray(transactions, 'transactions');
+
+			const delistIndex = transactions.findIndex(t =>  t.type === TransactionType.DELIST);
+
+			return delistIndex < 0 || !transactions.some((t, i) => delistIndex < i && t.type.opening);
+		}
 
 		toString() {
 			return '[TransactionValidator]';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.2.117",
+  "version": "1.2.118",
   "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'),
@@ -1386,6 +1386,23 @@ module.exports = (() => {
 		static validateDirectionSwitch(instrumentType, currentDirection, proposedDirection) {
 			return currentDirection === null || instrumentType.canSwitchDirection || (currentDirection.closed || proposedDirection.closed || currentDirection.positive === proposedDirection.positive);
 		}
+		
+		/**
+		 * Assuming the transaction list is ordered by sequence, validates that
+		 * no opening transactions exist after delisting date.
+		 *
+		 * @static
+		 * @public
+		 * @param {Array.<Object>} transactions
+		 * @returns {Boolean}
+		 */
+		static validateDelisting(transactions) {
+			assert.argumentIsArray(transactions, 'transactions');
+
+			const delistIndex = transactions.findIndex(t =>  t.type === TransactionType.DELIST);
+
+			return delistIndex < 0 || !transactions.some((t, i) => delistIndex < i && t.type.opening);
+		}
 
 		toString() {
 			return '[TransactionValidator]';
@@ -1464,7 +1481,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'),
@@ -18150,7 +18167,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', () => {
@@ -18222,6 +18239,28 @@ describe('When validating transaction references', () => {
 	});
 });
 
+describe('When validating transactions which could include instrument delisting', () => {
+	const build = (type) => {
+		return { type: type };
+	};
+
+	it('An array without a DELSIT transaction should be valid', () => {
+		expect(TransactionValidator.validateDelisting([ build(TransactionType.BUY), build(TransactionType.SELL) ])).toEqual(true);
+	});
+
+	it('An array with a final DELSIT transaction should be valid', () => {
+		expect(TransactionValidator.validateDelisting([ build(TransactionType.BUY), build(TransactionType.SELL), build(TransactionType.DELIST) ])).toEqual(true);
+	});
+
+	it('An array with a closing transaction after a DELIST transaction should be valid', () => {
+		expect(TransactionValidator.validateDelisting([ build(TransactionType.BUY), build(TransactionType.SELL), build(TransactionType.DELIST), build(TransactionType.SELL) ])).toEqual(true);
+	});
+
+	it('An array with an opening transaction after a DELIST transaction should not be valid', () => {
+		expect(TransactionValidator.validateDelisting([ build(TransactionType.BUY), build(TransactionType.SELL), build(TransactionType.DELIST), build(TransactionType.BUY) ])).toEqual(false);
+	});
+});
+
 describe('When requesting all the user-initiated transaction types', () => {
 	'use strict';
 

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', () => {
@@ -79,6 +79,28 @@ describe('When validating transaction references', () => {
 	});
 });
 
+describe('When validating transactions which could include instrument delisting', () => {
+	const build = (type) => {
+		return { type: type };
+	};
+
+	it('An array without a DELSIT transaction should be valid', () => {
+		expect(TransactionValidator.validateDelisting([ build(TransactionType.BUY), build(TransactionType.SELL) ])).toEqual(true);
+	});
+
+	it('An array with a final DELSIT transaction should be valid', () => {
+		expect(TransactionValidator.validateDelisting([ build(TransactionType.BUY), build(TransactionType.SELL), build(TransactionType.DELIST) ])).toEqual(true);
+	});
+
+	it('An array with a closing transaction after a DELIST transaction should be valid', () => {
+		expect(TransactionValidator.validateDelisting([ build(TransactionType.BUY), build(TransactionType.SELL), build(TransactionType.DELIST), build(TransactionType.SELL) ])).toEqual(true);
+	});
+
+	it('An array with an opening transaction after a DELIST transaction should not be valid', () => {
+		expect(TransactionValidator.validateDelisting([ build(TransactionType.BUY), build(TransactionType.SELL), build(TransactionType.DELIST), build(TransactionType.BUY) ])).toEqual(false);
+	});
+});
+
 describe('When requesting all the user-initiated transaction types', () => {
 	'use strict';