@barchart/portfolio-api-common 1.2.18 → 1.2.22

package/lib/api/failures/PortfolioFailureType.js

@@ -169,7 +169,7 @@ module.exports = (() => {
 	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_INITIAL_TYPE', 'Unable to process initial transaction, the first transaction would be a {L|transactionType.description}. This is not allowed.');
+	const transactionCreateFailedInvalidInitialType = new FailureType('TRANSACTION_CREATE_FAILED_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 transactionDeleteFailedOutOfSequence = new FailureType('TRANSACTION_DELETE_FAILED_OUT_OF_SEQUENCE', 'Deleting any transaction, except for the most recent, will cause transaction history to be re-written. Please confirm your intent to re-write transaction history (which could take some time and alter the historical results for this position).');
 	const transactionDeleteFailedNoTransaction = new FailureType('TRANSACTION_DELETE_FAILED_NO_TRANSACTION', 'Unable to delete transaction. The referenced transaction does not exist.');

package/lib/data/InstrumentType.js

@@ -18,10 +18,11 @@ module.exports = (() => {
 	 * @param {Boolean} canShort
 	 * @param {Boolean} canSwitchDirection
 	 * @param {Boolean} usesSymbols
-	 * @param {Function} usesSymbols
+	 * @param {Boolean} hasCorporateActions
+	 * @param {Function} generator
 	 */
 	class InstrumentType extends Enum {
-		constructor(code, description, alternateDescription, canReinvest, canShort, canSwitchDirection, usesSymbols, generator) {
+		constructor(code, description, alternateDescription, canReinvest, canShort, canSwitchDirection, usesSymbols, hasCorporateActions, generator) {
 			super(code, description);
 
 			assert.argumentIsRequired(alternateDescription, 'alternateDescription', String);
@@ -29,6 +30,7 @@ module.exports = (() => {
 			assert.argumentIsRequired(canShort, 'canShort', Boolean);
 			assert.argumentIsRequired(canSwitchDirection, 'canSwitchDirection', Boolean);
 			assert.argumentIsRequired(usesSymbols, 'usesSymbols', Boolean);
+			assert.argumentIsRequired(hasCorporateActions, 'hasCorporateActions', Boolean);
 			assert.argumentIsRequired(generator, 'generator', Function);
 
 			this._alternateDescription = alternateDescription;
@@ -36,6 +38,7 @@ module.exports = (() => {
 			this._canShort = canShort;
 			this._canSwitchDirection = canSwitchDirection;
 			this._usesSymbols = usesSymbols;
+			this._hasCorporateActions = hasCorporateActions;
 
 			this._generator = generator;
 		}
@@ -91,6 +94,16 @@ module.exports = (() => {
 			return this._usesSymbols;
 		}
 
+		/**
+		 * Indicates if corporate actions are possible for this type of instrument.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get hasCorporateActions() {
+			return this._hasCorporateActions;
+		}
+
 		/**
 		 * Generates an identifier for the instrument.
 		 *
@@ -188,10 +201,10 @@ module.exports = (() => {
 		}
 	}
 
-	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false, true, false, (instrument) => `BARCHART-${instrument.type.code}-${instrument.currency.code}`);
-	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true, false, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
-	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, false, false, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
-	const other = new InstrumentType('OTHER', 'other', 'Other', false, false, false, false, (instrument) => `BARCHART-${instrument.type.code}-${uuid.v4()}`);
+	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false, true, false, false, (instrument) => `BARCHART-${instrument.type.code}-${instrument.currency.code}`);
+	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true, false, true, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
+	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, false, false, true, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
+	const other = new InstrumentType('OTHER', 'other', 'Other', false, false, false, false, false, (instrument) => `BARCHART-${instrument.type.code}-${uuid.v4()}`);
 
 	const map = { };
 

package/lib/data/TransactionType.js

@@ -19,10 +19,11 @@ module.exports = (() => {
 	 * @param {Boolean} closing
 	 * @param {Boolean} fee
 	 * @param {Boolean} corporateAction
-	 * @param {Boolean} corporateAction
+	 * @param {Boolean} initial
+	 * @param {Boolean} significant
 	 */
 	class TransactionType extends Enum {
-		constructor(code, description, display, purchase, sale, income, opening, closing, fee, corporateAction, initial) {
+		constructor(code, description, display, purchase, sale, income, opening, closing, fee, corporateAction, initial, significant) {
 			super(code, description);
 
 			assert.argumentIsRequired(display, 'display', String);
@@ -34,6 +35,7 @@ module.exports = (() => {
 			assert.argumentIsRequired(fee, 'fee', Boolean);
 			assert.argumentIsRequired(corporateAction, 'corporateAction', Boolean);
 			assert.argumentIsRequired(initial, 'initial', Boolean);
+			assert.argumentIsRequired(significant, 'significant', Boolean);
 
 			this._display = display;
 			this._purchase = purchase;
@@ -44,6 +46,7 @@ module.exports = (() => {
 			this._fee = fee;
 			this._corporateAction = corporateAction;
 			this._initial = initial;
+			this._significant = significant;
 		}
 
 		/**
@@ -149,6 +152,16 @@ module.exports = (() => {
 			return this._initial;
 		}
 
+		/**
+		 * Significant transactions cannot be discarded during transaction re-write.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get significant() {
+			return this._significant;
+		}
+
 		/**
 		 * A purchase.
 		 *
@@ -363,28 +376,28 @@ module.exports = (() => {
 		}
 	}
 
-	const buy = new TransactionType('B', 'Buy', 'Buy', true, false, false, true, false, false, false, true);
-	const sell = new TransactionType('S', 'Sell', 'Sell', false, true, false, false, true, false, false, false);
-	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', true, false, false, false, true, false, false, false);
-	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', false, true, false, true, false, false, false, true);
-	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', false, false, true, false, false, false, true, false);
-	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', false, false, false, true, false, false, true, false);
-	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', false, false, false, true, false, false, true, false);
-	const split = new TransactionType('SP', 'Split', 'Split', false, false, false, true, false, false, true, false);
-	const fee = new TransactionType('F', 'Fee', 'Fee', false, false, false, false, false, true, false, false);
-	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, true, false, false, false);
-
-	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false, false, true, false);
-	const distributionReinvest = new TransactionType('DY', 'Distribution (Reinvested)', 'Distribution Reinvest', false, false, false, true, false, false, true, false);
-	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false, false, true, false);
-
-	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, false, false, false, false, true);
-	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', false, false, false, false, false, false, false, true);
-	const debit = new TransactionType('DR', 'Debit', 'Debit', false, false, false, false, false, false, false, true);
-	const credit = new TransactionType('CR', 'Credit', 'Credit', false, false, false, false, false, false, false, true);
-
-	const valuation = new TransactionType('V', 'Valuation', 'Valuation', false, false, false, false, false, false, false, false);
-	const income = new TransactionType('I', 'Income', 'Income', false, false, true, false, false, false, false, false);
+	const buy = new TransactionType('B', 'Buy', 'Buy', true, false, false, true, false, false, false, true, true);
+	const sell = new TransactionType('S', 'Sell', 'Sell', false, true, false, false, true, false, false, false, true);
+	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', true, false, false, false, true, false, false, false, true);
+	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', false, true, false, true, false, false, false, true, true);
+	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', false, false, true, false, false, false, true, false, false);
+	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', false, false, false, true, false, false, true, false, false);
+	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', false, false, false, true, false, false, true, false, false);
+	const split = new TransactionType('SP', 'Split', 'Split', false, false, false, true, false, false, true, false, false);
+	const fee = new TransactionType('F', 'Fee', 'Fee', false, false, false, false, false, true, false, false, false);
+	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, true, false, false, false, false);
+
+	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false, false, true, false, false);
+	const distributionReinvest = new TransactionType('DY', 'Distribution (Reinvested)', 'Distribution Reinvest', false, false, false, true, false, false, true, false, false);
+	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false, false, true, false, false);
+
+	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, false, false, false, false, true, true);
+	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', false, false, false, false, false, false, false, true, true);
+	const debit = new TransactionType('DR', 'Debit', 'Debit', false, false, false, false, false, false, false, true, true);
+	const credit = new TransactionType('CR', 'Credit', 'Credit', false, false, false, false, false, false, false, true, true);
+
+	const valuation = new TransactionType('V', 'Valuation', 'Valuation', false, false, false, false, false, false, false, false, false);
+	const income = new TransactionType('I', 'Income', 'Income', false, false, true, false, false, false, false, false, false);
 
 	return TransactionType;
 })();

package/lib/data/TransactionValidator.js

@@ -120,7 +120,7 @@ module.exports = (() => {
 		 * @param {TransactionType} transactionType
 		 */
 		static validateInitialTransactionType(transactionType) {
-			return transactionType.inital;
+			return transactionType.initial;
 		}
 		
 		/**

package/lib/formatters/TransactionFormatter.js

@@ -204,7 +204,7 @@ module.exports = (() => {
 		} else if (t.snapshot.open.getIsZero()) {
 			rate = null;
 		} else {
-			rate = t.valuation.value.divide(t.snapshot.open)
+			rate = t.valuation.value.divide(t.snapshot.open);
 		}
 
 		return {

package/package.json

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

package/test/SpecRunner.js

@@ -19,10 +19,11 @@ module.exports = (() => {
 	 * @param {Boolean} canShort
 	 * @param {Boolean} canSwitchDirection
 	 * @param {Boolean} usesSymbols
-	 * @param {Function} usesSymbols
+	 * @param {Boolean} hasCorporateActions
+	 * @param {Function} generator
 	 */
 	class InstrumentType extends Enum {
-		constructor(code, description, alternateDescription, canReinvest, canShort, canSwitchDirection, usesSymbols, generator) {
+		constructor(code, description, alternateDescription, canReinvest, canShort, canSwitchDirection, usesSymbols, hasCorporateActions, generator) {
 			super(code, description);
 
 			assert.argumentIsRequired(alternateDescription, 'alternateDescription', String);
@@ -30,6 +31,7 @@ module.exports = (() => {
 			assert.argumentIsRequired(canShort, 'canShort', Boolean);
 			assert.argumentIsRequired(canSwitchDirection, 'canSwitchDirection', Boolean);
 			assert.argumentIsRequired(usesSymbols, 'usesSymbols', Boolean);
+			assert.argumentIsRequired(hasCorporateActions, 'hasCorporateActions', Boolean);
 			assert.argumentIsRequired(generator, 'generator', Function);
 
 			this._alternateDescription = alternateDescription;
@@ -37,6 +39,7 @@ module.exports = (() => {
 			this._canShort = canShort;
 			this._canSwitchDirection = canSwitchDirection;
 			this._usesSymbols = usesSymbols;
+			this._hasCorporateActions = hasCorporateActions;
 
 			this._generator = generator;
 		}
@@ -92,6 +95,16 @@ module.exports = (() => {
 			return this._usesSymbols;
 		}
 
+		/**
+		 * Indicates if corporate actions are possible for this type of instrument.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get hasCorporateActions() {
+			return this._hasCorporateActions;
+		}
+
 		/**
 		 * Generates an identifier for the instrument.
 		 *
@@ -189,10 +202,10 @@ module.exports = (() => {
 		}
 	}
 
-	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false, true, false, (instrument) => `BARCHART-${instrument.type.code}-${instrument.currency.code}`);
-	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true, false, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
-	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, false, false, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
-	const other = new InstrumentType('OTHER', 'other', 'Other', false, false, false, false, (instrument) => `BARCHART-${instrument.type.code}-${uuid.v4()}`);
+	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false, true, false, false, (instrument) => `BARCHART-${instrument.type.code}-${instrument.currency.code}`);
+	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true, false, true, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
+	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, false, false, true, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
+	const other = new InstrumentType('OTHER', 'other', 'Other', false, false, false, false, false, (instrument) => `BARCHART-${instrument.type.code}-${uuid.v4()}`);
 
 	const map = { };
 
@@ -629,10 +642,11 @@ module.exports = (() => {
 	 * @param {Boolean} closing
 	 * @param {Boolean} fee
 	 * @param {Boolean} corporateAction
-	 * @param {Boolean} corporateAction
+	 * @param {Boolean} initial
+	 * @param {Boolean} significant
 	 */
 	class TransactionType extends Enum {
-		constructor(code, description, display, purchase, sale, income, opening, closing, fee, corporateAction, initial) {
+		constructor(code, description, display, purchase, sale, income, opening, closing, fee, corporateAction, initial, significant) {
 			super(code, description);
 
 			assert.argumentIsRequired(display, 'display', String);
@@ -644,6 +658,7 @@ module.exports = (() => {
 			assert.argumentIsRequired(fee, 'fee', Boolean);
 			assert.argumentIsRequired(corporateAction, 'corporateAction', Boolean);
 			assert.argumentIsRequired(initial, 'initial', Boolean);
+			assert.argumentIsRequired(significant, 'significant', Boolean);
 
 			this._display = display;
 			this._purchase = purchase;
@@ -654,6 +669,7 @@ module.exports = (() => {
 			this._fee = fee;
 			this._corporateAction = corporateAction;
 			this._initial = initial;
+			this._significant = significant;
 		}
 
 		/**
@@ -759,6 +775,16 @@ module.exports = (() => {
 			return this._initial;
 		}
 
+		/**
+		 * Significant transactions cannot be discarded during transaction re-write.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get significant() {
+			return this._significant;
+		}
+
 		/**
 		 * A purchase.
 		 *
@@ -973,28 +999,28 @@ module.exports = (() => {
 		}
 	}
 
-	const buy = new TransactionType('B', 'Buy', 'Buy', true, false, false, true, false, false, false, true);
-	const sell = new TransactionType('S', 'Sell', 'Sell', false, true, false, false, true, false, false, false);
-	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', true, false, false, false, true, false, false, false);
-	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', false, true, false, true, false, false, false, true);
-	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', false, false, true, false, false, false, true, false);
-	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', false, false, false, true, false, false, true, false);
-	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', false, false, false, true, false, false, true, false);
-	const split = new TransactionType('SP', 'Split', 'Split', false, false, false, true, false, false, true, false);
-	const fee = new TransactionType('F', 'Fee', 'Fee', false, false, false, false, false, true, false, false);
-	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, true, false, false, false);
-
-	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false, false, true, false);
-	const distributionReinvest = new TransactionType('DY', 'Distribution (Reinvested)', 'Distribution Reinvest', false, false, false, true, false, false, true, false);
-	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false, false, true, false);
-
-	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, false, false, false, false, true);
-	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', false, false, false, false, false, false, false, true);
-	const debit = new TransactionType('DR', 'Debit', 'Debit', false, false, false, false, false, false, false, true);
-	const credit = new TransactionType('CR', 'Credit', 'Credit', false, false, false, false, false, false, false, true);
-
-	const valuation = new TransactionType('V', 'Valuation', 'Valuation', false, false, false, false, false, false, false, false);
-	const income = new TransactionType('I', 'Income', 'Income', false, false, true, false, false, false, false, false);
+	const buy = new TransactionType('B', 'Buy', 'Buy', true, false, false, true, false, false, false, true, true);
+	const sell = new TransactionType('S', 'Sell', 'Sell', false, true, false, false, true, false, false, false, true);
+	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', true, false, false, false, true, false, false, false, true);
+	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', false, true, false, true, false, false, false, true, true);
+	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', false, false, true, false, false, false, true, false, false);
+	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', false, false, false, true, false, false, true, false, false);
+	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', false, false, false, true, false, false, true, false, false);
+	const split = new TransactionType('SP', 'Split', 'Split', false, false, false, true, false, false, true, false, false);
+	const fee = new TransactionType('F', 'Fee', 'Fee', false, false, false, false, false, true, false, false, false);
+	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, true, false, false, false, false);
+
+	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false, false, true, false, false);
+	const distributionReinvest = new TransactionType('DY', 'Distribution (Reinvested)', 'Distribution Reinvest', false, false, false, true, false, false, true, false, false);
+	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false, false, true, false, false);
+
+	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, false, false, false, false, true, true);
+	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', false, false, false, false, false, false, false, true, true);
+	const debit = new TransactionType('DR', 'Debit', 'Debit', false, false, false, false, false, false, false, true, true);
+	const credit = new TransactionType('CR', 'Credit', 'Credit', false, false, false, false, false, false, false, true, true);
+
+	const valuation = new TransactionType('V', 'Valuation', 'Valuation', false, false, false, false, false, false, false, false, false);
+	const income = new TransactionType('I', 'Income', 'Income', false, false, true, false, false, false, false, false, false);
 
 	return TransactionType;
 })();
@@ -1122,7 +1148,7 @@ module.exports = (() => {
 		 * @param {TransactionType} transactionType
 		 */
 		static validateInitialTransactionType(transactionType) {
-			return transactionType.inital;
+			return transactionType.initial;
 		}
 		
 		/**