@barchart/portfolio-api-common 1.6.0 → 1.7.0

package/.releases/1.6.0.md

@@ -1,3 +1,3 @@
 **New Features**
 
-* Added a new `FailureItem` for attempting tp edit a transaction's type.
+* Added a new `PortfolioFailureType` for attempting to edit a transaction's type.

package/.releases/1.7.0.md

@@ -0,0 +1,3 @@
+**New Features**
+
+* Added a new `PortfolioFailureType` for attempting to reinvest a dividend when the position is short.

package/lib/api/failures/PortfolioFailureType.js

@@ -212,6 +212,18 @@ module.exports = (() => {
 			return transactionCreateFailedReinvestPriceUnavailable;
 		}
 
+		/**
+		 * The transaction failed because a dividends cannot be re-invested
+		 * for short positions.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_REINVEST_INVALID() {
+			return transactionCreateFailedReinvestInvalid;
+		}
+
 		/**
 		 * The transaction failed because a related position is locked.
 		 *
@@ -364,6 +376,7 @@ module.exports = (() => {
 
 	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 transactionCreateFailedReinvestInvalid = new FailureType('TRANSACTION_CREATE_FAILED_REINVEST_INVALID', 'Unable to create transaction, short positions do not allow dividends to be reinvested.');
 	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.');
 	const transactionCreateFailedInstrumentCorrupt = new FailureType('TRANSACTION_CREATE_FAILED_INSTRUMENT_CORRUPT', 'Unable to create transaction, corporate action history for {U|symbol} cannot be located. The issue should be corrected within 24 to 48 hours.');
 

package/package.json

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