@barchart/portfolio-api-common 1.0.229 → 1.0.233

package/lib/api/failures/PortfolioFailureType.js

@@ -76,8 +76,15 @@ module.exports = (() => {
 			return transactionDeleteFailedOutOfSequence;
 		}
 
-		static get TRANSACTION_DELETE_UNSUPPORTED() {
-			return transactionDeleteUnsupported;
+		/**
+		 * Unable to delete, the transaction cannot be found.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_DELETE_FAILED_NO_TRANSACTION() {
+			return transactionDeleteFailedNoTransaction;
 		}
 
 		toString() {
@@ -93,7 +100,7 @@ module.exports = (() => {
 	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 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 transactionDeleteUnsupported = new FailureType('TRANSACTION_DELETE_UNSUPPORTED', 'Unable to delete transaction. This operation is not currently supported (but will be implemented soon).');
+	const transactionDeleteFailedNoTransaction = new FailureType('TRANSACTION_DELETE_FAILED_NO_TRANSACTION', 'Unable to delete transaction. The referenced transaction does not exist.');
 
 	return PortfolioFailureType;
 })();

package/lib/data/TransactionType.js

@@ -17,9 +17,10 @@ module.exports = (() => {
 	 * @param {Boolean} income
 	 * @param {Boolean} opening
 	 * @param {Boolean} closing
+	 * @param {Boolean} fee
 	 */
 	class TransactionType extends Enum {
-		constructor(code, description, display, purchase, sale, income, opening, closing) {
+		constructor(code, description, display, purchase, sale, income, opening, closing, fee) {
 			super(code, description);
 
 			assert.argumentIsRequired(display, 'display', String);
@@ -28,6 +29,7 @@ module.exports = (() => {
 			assert.argumentIsRequired(income, 'income', Boolean);
 			assert.argumentIsRequired(opening, 'opening', Boolean);
 			assert.argumentIsRequired(closing, 'closing', Boolean);
+			assert.argumentIsRequired(fee, 'fee', Boolean);
 
 			this._display = display;
 			this._purchase = purchase;
@@ -35,6 +37,7 @@ module.exports = (() => {
 			this._income = income;
 			this._opening = opening;
 			this._closing = closing;
+			this._fee = fee
 		}
 
 		/**
@@ -109,6 +112,17 @@ module.exports = (() => {
 			return this._closing;
 		}
 
+		/**
+		 * Indicates if the transactions is a fee (which neither opens or closes) the
+		 * position.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get fee() {
+			return this._fee;
+		}
+
 		/**
 		 * A purchase.
 		 *
@@ -312,27 +326,27 @@ module.exports = (() => {
 		}
 	}
 
-	const buy = new TransactionType('B', 'Buy', 'Buy', true, false, false, true,  false);
-	const sell = new TransactionType('S', 'Sell', 'Sell', false, true, false, false, true);
-	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', true, false, false, false, true);
-	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', false, true, false, true, false);
-	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', false, false, true, false, false);
-	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', false, false, false, true, false);
-	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', false, false, false, true, false);
-	const split = new TransactionType('SP', 'Split', 'Split', false, false, false, true, false);
-	const fee = new TransactionType('F', 'Fee', 'Fee', false, false, false, true, false);
-	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, false);
-
-	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false);
-	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false);
-
-	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, false, false);
-	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', false, false, false, false, false);
-	const debit = new TransactionType('DR', 'Debit', 'Debit', false, false, false, false, false);
-	const credit = new TransactionType('CR', 'Credit', 'Credit', false, false, false, false, false);
-
-	const valuation = new TransactionType('V', 'Valuation', 'Valuation', false, false, false, false, false);
-	const income = new TransactionType('I', 'Income', 'Income', false, false, true, false, false);
+	const buy = new TransactionType('B', 'Buy', 'Buy', true, false, false, true,  false, false);
+	const sell = new TransactionType('S', 'Sell', 'Sell', false, true, false, false, true, false);
+	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', true, false, false, false, true, false);
+	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', false, true, false, true, false, false);
+	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', false, false, true, false, false, false);
+	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', false, false, false, true, false, false);
+	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', false, false, false, true, false, false);
+	const split = new TransactionType('SP', 'Split', 'Split', false, false, false, true, false, false);
+	const fee = new TransactionType('F', 'Fee', 'Fee', false, false, false, true, false, true);
+	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, true, false);
+
+	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false, false);
+	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false, false);
+
+	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, false, false, false);
+	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', false, false, false, false, false, false);
+	const debit = new TransactionType('DR', 'Debit', 'Debit', false, false, false, false, false, false);
+	const credit = new TransactionType('CR', 'Credit', 'Credit', false, false, false, false, false, false);
+
+	const valuation = new TransactionType('V', 'Valuation', 'Valuation', false, false, false, false, false, false);
+	const income = new TransactionType('I', 'Income', 'Income', false, false, true, false, false, false);
 
 	return TransactionType;
 })();