@barchart/portfolio-api-common 1.2.9 → 1.2.13

package/lib/data/TransactionType.js

@@ -235,6 +235,17 @@ module.exports = (() => {
 			return distributionFund;
 		}
 
+		/**
+		 * A mutual fund distribution in cash, reinvested.
+		 *
+		 * @public
+		 * @static
+		 * @returns {TransactionType}
+		 */
+		static get DISTRIBUTION_REINVEST() {
+			return distributionReinvest;
+		}
+
 		/**
 		 * A split.
 		 *
@@ -351,6 +362,7 @@ module.exports = (() => {
 	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, true, false, false);
 
 	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false, false, true);
+	const distributionReinvest = new TransactionType('DY', 'Distribution (Reinvested)', 'Distribution Reinvest', false, false, false, true, false, false, true);
 	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false, false, true);
 
 	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, false, false, false, false);

package/lib/data/TransactionValidator.js

@@ -73,6 +73,28 @@ module.exports = (() => {
 			return valid.map(d => d.type);
 		}
 
+		/**
+		 * Returns transaction types which can be initiated by the user, regardless
+		 * of instrument type.
+		 *
+		 * @public
+		 * @static
+		 * @return {Array.<TransactionType>}
+		 */
+		static getUserInitiatedTransactionTypes() {
+			return array.unique(Object.keys(validTransactionTypes).reduce((types, key) => {
+				const instrumentTypes = validTransactionTypes[key];
+
+				instrumentTypes.forEach((data) => {
+					if (data.user) {
+						types.push(data.type);
+					}
+				});
+
+				return types;
+			}, [ ]));
+		}
+
 		/**
 		 * Checks to see if an transaction type is applicable to an instrument type.
 		 *
@@ -155,6 +177,7 @@ module.exports = (() => {
 	associateTypes(InstrumentType.FUND, TransactionType.FEE, true, [ PositionDirection.LONG ]);
 	associateTypes(InstrumentType.FUND, TransactionType.FEE_UNITS, false);
 	associateTypes(InstrumentType.FUND, TransactionType.DISTRIBUTION_CASH, false);
+	associateTypes(InstrumentType.FUND, TransactionType.DISTRIBUTION_REINVEST, false);
 	associateTypes(InstrumentType.FUND, TransactionType.DISTRIBUTION_FUND, false);
 
 	associateTypes(InstrumentType.OTHER, TransactionType.BUY, true, [ PositionDirection.LONG, PositionDirection.EVEN ]);

package/lib/formatters/TransactionFormatter.js

@@ -125,16 +125,25 @@ module.exports = (() => {
 	});
 
 	formatters.set(TransactionType.DIVIDEND_STOCK, (t) => {
-		const shares = t.snapshot.open.subtract(t.quantity);
 		const rate = (is.object(t.dividend) && is.string(t.dividend.rate)) || '';
 
 		return {
 			boughtSold: t.quantity,
-			shares: shares,
+			shares: t.snapshot.open.subtract(t.quantity),
 			rate: rate
 		};
 	});
 
+	formatters.set(TransactionType.DIVIDEND_REINVEST, (t) => {
+		return {
+			boughtSold: t.quantity,
+			shares: t.snapshot.open.subtract(t.quantity),
+			price: t.dividend.price,
+			fee: t.fee,
+			rate: t.dividend.rate
+		};
+	});
+
 	formatters.set(TransactionType.DISTRIBUTION_CASH, (t) => {
 		return {
 			shares: t.snapshot.open,
@@ -143,20 +152,20 @@ module.exports = (() => {
 		};
 	});
 
-	formatters.set(TransactionType.DIVIDEND_REINVEST, (t) => {
+	formatters.set(TransactionType.DISTRIBUTION_FUND, (t) => {
 		return {
 			shares: t.snapshot.open.subtract(t.quantity),
-			price: t.dividend.price,
-			fee: t.fee,
-			total: t.quantity,
-			rate: t.dividend.rate
+			fee: t.fee
 		};
 	});
 
-	formatters.set(TransactionType.DISTRIBUTION_FUND, (t) => {
+	formatters.set(TransactionType.DISTRIBUTION_REINVEST, (t) => {
 		return {
+			boughtSold: t.quantity,
 			shares: t.snapshot.open.subtract(t.quantity),
-			fee: t.fee
+			price: t.dividend.price,
+			fee: t.fee,
+			rate: t.dividend.rate
 		};
 	});
 

package/lib/serialization/TransactionSchema.js

@@ -201,6 +201,7 @@ module.exports = (() => {
 		.withField('split.reference', DataType.STRING, true)
 		.withField('charge.amount', DataType.DECIMAL, true)
 		.withField('income.amount', DataType.DECIMAL, true)
+		.withField('valuation.rate', DataType.DECIMAL, true)
 		.withField('valuation.value', DataType.DECIMAL, true)
 		.withField('system.sequence', DataType.NUMBER)
 		.withField('system.version', DataType.STRING)
@@ -239,6 +240,7 @@ module.exports = (() => {
 		.withField('split.reference', DataType.STRING, true)
 		.withField('charge.amount', DataType.DECIMAL, true)
 		.withField('income.amount', DataType.DECIMAL, true)
+		.withField('valuation.rate', DataType.DECIMAL, true)
 		.withField('valuation.value', DataType.DECIMAL, true)
 		.schema
 	);

package/package.json

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

package/test/SpecRunner.js

@@ -845,6 +845,17 @@ module.exports = (() => {
 			return distributionFund;
 		}
 
+		/**
+		 * A mutual fund distribution in cash, reinvested.
+		 *
+		 * @public
+		 * @static
+		 * @returns {TransactionType}
+		 */
+		static get DISTRIBUTION_REINVEST() {
+			return distributionReinvest;
+		}
+
 		/**
 		 * A split.
 		 *
@@ -961,6 +972,7 @@ module.exports = (() => {
 	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, true, false, false);
 
 	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false, false, true);
+	const distributionReinvest = new TransactionType('DY', 'Distribution (Reinvested)', 'Distribution Reinvest', false, false, false, true, false, false, true);
 	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false, false, true);
 
 	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, false, false, false, false);
@@ -1050,6 +1062,28 @@ module.exports = (() => {
 			return valid.map(d => d.type);
 		}
 
+		/**
+		 * Returns transaction types which can be initiated by the user, regardless
+		 * of instrument type.
+		 *
+		 * @public
+		 * @static
+		 * @return {Array.<TransactionType>}
+		 */
+		static getUserInitiatedTransactionTypes() {
+			return array.unique(Object.keys(validTransactionTypes).reduce((types, key) => {
+				const instrumentTypes = validTransactionTypes[key];
+
+				instrumentTypes.forEach((data) => {
+					if (data.user) {
+						types.push(data.type);
+					}
+				});
+
+				return types;
+			}, [ ]));
+		}
+
 		/**
 		 * Checks to see if an transaction type is applicable to an instrument type.
 		 *
@@ -1132,6 +1166,7 @@ module.exports = (() => {
 	associateTypes(InstrumentType.FUND, TransactionType.FEE, true, [ PositionDirection.LONG ]);
 	associateTypes(InstrumentType.FUND, TransactionType.FEE_UNITS, false);
 	associateTypes(InstrumentType.FUND, TransactionType.DISTRIBUTION_CASH, false);
+	associateTypes(InstrumentType.FUND, TransactionType.DISTRIBUTION_REINVEST, false);
 	associateTypes(InstrumentType.FUND, TransactionType.DISTRIBUTION_FUND, false);
 
 	associateTypes(InstrumentType.OTHER, TransactionType.BUY, true, [ PositionDirection.LONG, PositionDirection.EVEN ]);
@@ -9213,6 +9248,20 @@ describe('When validating transaction order', () => {
 	});
 });
 
+describe('When requesting all the user-initiated transaction types', () => {
+	'use strict';
+
+	let userInitiated;
+
+	beforeEach(() => {
+		userInitiated = TransactionValidator.getUserInitiatedTransactionTypes();
+	});
+
+	it('Only nine types should be returned', () => {
+		expect(userInitiated.length).toEqual(9);
+	});
+});
+
 },{"./../../../lib/data/TransactionValidator":5,"@barchart/common-js/lang/Day":18}],37:[function(require,module,exports){
 const Currency = require('@barchart/common-js/lang/Currency'),
 	Decimal = require('@barchart/common-js/lang/Decimal');

package/test/specs/data/TransactionValidatorSpec.js

@@ -41,3 +41,17 @@ describe('When validating transaction order', () => {
 		expect(TransactionValidator.validateOrder([ build(1, '2018-05-02'), build(2, '2018-05-01'), build(3, '2018-04-30') ])).toEqual(false);
 	});
 });
+
+describe('When requesting all the user-initiated transaction types', () => {
+	'use strict';
+
+	let userInitiated;
+
+	beforeEach(() => {
+		userInitiated = TransactionValidator.getUserInitiatedTransactionTypes();
+	});
+
+	it('Only nine types should be returned', () => {
+		expect(userInitiated.length).toEqual(9);
+	});
+});