@barchart/portfolio-api-common 1.2.45 → 1.2.49

package/lib/api/failures/PortfolioFailureType.js

@@ -131,6 +131,18 @@ module.exports = (() => {
 			return transactionCreateFailedTypeReserved;
 		}
 
+		/**
+		 * The transaction failed because a dividend would be reinvested on
+		 * a day for which no historical price is available.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_REINVEST_PRICE_UNAVAILABLE() {
+			return transactionCreateFailedReinvestPriceUnavailable;
+		}
+
 		/**
 		 * Deleting any transaction except for the most recent requires
 		 * re-writing transaction history.
@@ -206,6 +218,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 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 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/TransactionValidator.js

@@ -92,7 +92,7 @@ module.exports = (() => {
 		 * @public
 		 * @param {InstrumentType} instrumentType
 		 * @param {Boolean=} userInitiated
-		 * @pararm {PositionDirection=} currentDirection
+		 * @param {PositionDirection=} currentDirection
 		 * @returns {Array.<TransactionType>}
 		 */
 		static getTransactionTypesFor(instrumentType, userInitiated, currentDirection) {
@@ -156,7 +156,9 @@ module.exports = (() => {
 		 * Determines if a transaction type is valid as the first transaction of
 		 * a position.
 		 *
+		 * @public
 		 * @param {TransactionType} transactionType
+		 * @returns {Boolean}
 		 */
 		static validateInitialTransactionType(transactionType) {
 			return transactionType.initial;

package/lib/formatters/TransactionFormatter.js

@@ -146,13 +146,18 @@ module.exports = (() => {
 	});
 
 	formatters.set(TransactionType.DIVIDEND_STOCK, (t) => {
-		const rate = (is.object(t.dividend) && is.string(t.dividend.rate)) || '';
-
-		return {
+		const data = {
 			boughtSold: t.quantity,
-			shares: t.snapshot.open.subtract(t.quantity),
-			rate: rate
+			fee: t.fee
 		};
+
+		if (t.dividend && t.dividend.rate && t.dividend.price) {
+			data.shares = t.snapshot.open.subtract(t.quantity);
+			data.price = t.dividend.price;
+			data.rate = t.dividend.rate;
+		}
+
+		return data;
 	});
 
 	formatters.set(TransactionType.DIVIDEND_REINVEST, (t) => {
@@ -174,15 +179,22 @@ module.exports = (() => {
 	});
 
 	formatters.set(TransactionType.DISTRIBUTION_FUND, (t) => {
-		return {
-			shares: t.snapshot.open.subtract(t.quantity),
+		const data = {
+			boughtSold: t.quantity,
 			fee: t.fee
 		};
+
+		if (t.dividend && t.dividend.rate && t.dividend.price) {
+			data.shares = t.snapshot.open.subtract(t.quantity);
+			data.price = t.dividend.price;
+			data.rate = t.dividend.rate;
+		}
+
+		return data;
 	});
 
 	formatters.set(TransactionType.DISTRIBUTION_REINVEST, (t) => {
 		return {
-			boughtSold: t.quantity,
 			shares: t.snapshot.open.subtract(t.quantity),
 			price: t.dividend.price,
 			fee: t.fee,

package/lib/serialization/TransactionSchema.js

@@ -1,5 +1,4 @@
-const assert = require('@barchart/common-js/lang/assert'),
-	is = require('@barchart/common-js/lang/is'),
+const is = require('@barchart/common-js/lang/is'),
 	Currency = require('@barchart/common-js/lang/Currency'),
 	DataType = require('@barchart/common-js/serialization/json/DataType'),
 	Enum = require('@barchart/common-js/lang/Enum'),

package/package.json

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