@barchart/portfolio-api-common 1.2.12 → 1.2.16

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.
 		 *

package/lib/formatters/TransactionFormatter.js

@@ -197,8 +197,18 @@ module.exports = (() => {
 	});
 
 	formatters.set(TransactionType.VALUATION, (t) => {
+		let rate;
+
+		if (t.valuation.rate) {
+			rate = t.valuation.rate;
+		} else if (t.snapshot.open.getIsZero()) {
+			rate = null;
+		} else {
+			rate = t.valuation.value.divide(t.snapshot.open)
+		}
+
 		return {
-			price: t.valuation.value
+			price: rate
 		};
 	});
 

package/lib/processing/PositionItem.js

@@ -406,32 +406,57 @@ module.exports = (() => {
 
 		const summary = item.currentSummary;
 
-		if (summary && price) {
-			const period = summary.period;
+		let priceToUse;
 
-			let unrealized = summary.end.open.multiply(price).add(summary.end.basis);
-			let unrealizedChange;
+		if (price) {
+			priceToUse = price;
+		} else {
 
-			if (data.unrealizedToday !== null) {
-				unrealizedChange = unrealized.subtract(data.unrealized);
+		}
+
+		if (summary) {
+			let priceToUse;
+
+			if (price) {
+				priceToUse = price;
+			} else if (!summary.end.open.getIsZero()) {
+				priceToUse = summary.end.value.divide(summary.end.open);
 			} else {
-				unrealizedChange = Decimal.ZERO;
+				priceToUse = null;
 			}
 
-			let summaryTotalCurrent = period.realized.add(period.income).add(unrealized);
-			let summaryTotalCurrentChange;
+			if (priceToUse !== null) {
+				const period = summary.period;
 
-			if (data.summaryTotalCurrent !== null) {
-				summaryTotalCurrentChange = summaryTotalCurrent.subtract(data.summaryTotalCurrent);
-			}  else {
-				summaryTotalCurrentChange = Decimal.ZERO;
-			}
+				let unrealized = summary.end.open.multiply(priceToUse).add(summary.end.basis);
+				let unrealizedChange;
+
+				if (data.unrealizedToday !== null) {
+					unrealizedChange = unrealized.subtract(data.unrealized);
+				} else {
+					unrealizedChange = Decimal.ZERO;
+				}
+
+				let summaryTotalCurrent = period.realized.add(period.income).add(unrealized);
+				let summaryTotalCurrentChange;
+
+				if (data.summaryTotalCurrent !== null) {
+					summaryTotalCurrentChange = summaryTotalCurrent.subtract(data.summaryTotalCurrent);
+				} else {
+					summaryTotalCurrentChange = Decimal.ZERO;
+				}
 
-			data.summaryTotalCurrent = summaryTotalCurrent;
-			data.summaryTotalCurrentChange = summaryTotalCurrentChange;
+				data.summaryTotalCurrent = summaryTotalCurrent;
+				data.summaryTotalCurrentChange = summaryTotalCurrentChange;
 
-			data.unrealized = unrealized;
-			data.unrealizedChange = unrealizedChange;
+				data.unrealized = unrealized;
+				data.unrealizedChange = unrealizedChange;
+			} else {
+				data.summaryTotalCurrentChange = Decimal.ZERO;
+
+				data.unrealized = Decimal.ZERO;
+				data.unrealizedChange = Decimal.ZERO;
+			}
 		} else {
 			data.summaryTotalCurrentChange = Decimal.ZERO;
 

package/package.json

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

package/test/SpecRunner.js

@@ -1062,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.
 		 *
@@ -3402,32 +3424,57 @@ module.exports = (() => {
 
 		const summary = item.currentSummary;
 
-		if (summary && price) {
-			const period = summary.period;
+		let priceToUse;
 
-			let unrealized = summary.end.open.multiply(price).add(summary.end.basis);
-			let unrealizedChange;
+		if (price) {
+			priceToUse = price;
+		} else {
 
-			if (data.unrealizedToday !== null) {
-				unrealizedChange = unrealized.subtract(data.unrealized);
+		}
+
+		if (summary) {
+			let priceToUse;
+
+			if (price) {
+				priceToUse = price;
+			} else if (!summary.end.open.getIsZero()) {
+				priceToUse = summary.end.value.divide(summary.end.open);
 			} else {
-				unrealizedChange = Decimal.ZERO;
+				priceToUse = null;
 			}
 
-			let summaryTotalCurrent = period.realized.add(period.income).add(unrealized);
-			let summaryTotalCurrentChange;
+			if (priceToUse !== null) {
+				const period = summary.period;
 
-			if (data.summaryTotalCurrent !== null) {
-				summaryTotalCurrentChange = summaryTotalCurrent.subtract(data.summaryTotalCurrent);
-			}  else {
-				summaryTotalCurrentChange = Decimal.ZERO;
-			}
+				let unrealized = summary.end.open.multiply(priceToUse).add(summary.end.basis);
+				let unrealizedChange;
+
+				if (data.unrealizedToday !== null) {
+					unrealizedChange = unrealized.subtract(data.unrealized);
+				} else {
+					unrealizedChange = Decimal.ZERO;
+				}
+
+				let summaryTotalCurrent = period.realized.add(period.income).add(unrealized);
+				let summaryTotalCurrentChange;
 
-			data.summaryTotalCurrent = summaryTotalCurrent;
-			data.summaryTotalCurrentChange = summaryTotalCurrentChange;
+				if (data.summaryTotalCurrent !== null) {
+					summaryTotalCurrentChange = summaryTotalCurrent.subtract(data.summaryTotalCurrent);
+				} else {
+					summaryTotalCurrentChange = Decimal.ZERO;
+				}
+
+				data.summaryTotalCurrent = summaryTotalCurrent;
+				data.summaryTotalCurrentChange = summaryTotalCurrentChange;
+
+				data.unrealized = unrealized;
+				data.unrealizedChange = unrealizedChange;
+			} else {
+				data.summaryTotalCurrentChange = Decimal.ZERO;
 
-			data.unrealized = unrealized;
-			data.unrealizedChange = unrealizedChange;
+				data.unrealized = Decimal.ZERO;
+				data.unrealizedChange = Decimal.ZERO;
+			}
 		} else {
 			data.summaryTotalCurrentChange = Decimal.ZERO;
 
@@ -9226,6 +9273,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);
+	});
+});