@barchart/portfolio-api-common 1.0.236 → 1.0.240

package/lib/api/failures/PortfolioFailureType.js

@@ -23,6 +23,17 @@ module.exports = (() => {
 			return positionCreateFailedNoPortfolio;
 		}
 
+		/**
+		 * The referenced position does not exist.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_NO_POSITION() {
+			return transactionCreateFailedNoPosition;
+		}
+
 		/**
 		 * The transaction would occur before an existing transaction.
 		 *
@@ -94,6 +105,7 @@ module.exports = (() => {
 
 	const positionCreateFailedNoPortfolio = new FailureType('POSITION_CREATE_FAILED_NO_PORTFOLIO', 'Unable to create transaction. The referenced portfolio does not exist. Has it been deleted?');
 
+	const transactionCreateFailedNoPosition = new FailureType('TRANSACTION_CREATE_FAILED_NO_POSITION', 'Unable to create transaction. The referenced position does not exist. Has it been deleted?');
 	const transactionCreateFailedOutOfSequence = new FailureType('TRANSACTION_CREATE_FAILED_OUT_OF_SEQUENCE', 'Unable to process transaction, because the transaction date is out-of-sequence. In other words, it would occur before an existing transaction. Please confirm your intent to re-write transaction history (which could take some time and alter the historical results for this position).');
 	const transactionCreateFailedTypeInvalidForInstrument = new FailureType('TRANSACTION_CREATE_FAILED_TYPE_INVALID_FOR_INSTRUMENT', 'Unable to process transaction, {L|transactionType.description} transactions cannot be used with {L|instrumentType.description} positions.');
 	const transactionCreateFailedTypeInvalidForDirection = new FailureType('TRANSACTION_CREATE_FAILED_TYPE_INVALID_FOR_DIRECTION', 'Unable to process transaction, a {L|positionDirection.description} position would be created (i.e. you would have {L|positionDirection.sign} shares/units). {u|instrumentType.description} positions cannot have {L|positionDirection.description} positions.');

package/lib/formatters/TransactionFormatter.js

@@ -27,7 +27,7 @@ module.exports = (() => {
 		 * @static
 		 * @param {Array<Object>} transactions
 		 * @param {Array<Object>} positions
-		 * @param {Boolean=} append
+		 * @param {Boolean=} append - Warning, if true, the transaction array will be mutated.
 		 * @returns {Array}
 		 */
 		static format(transactions, positions, append) {
@@ -36,18 +36,22 @@ module.exports = (() => {
 			assert.argumentIsOptional(append, 'append', Boolean);
 
 			const instruments = positions.reduce((map, p) => {
-				map[p.position] = p.instrument;
+				const instrument = Object.assign({ }, p.instrument || { });
+
+				delete instrument.id;
+
+				map[p.position] = instrument;
 
 				return map;
 			}, { });
 
 			return transactions.reduce((list, transaction) => {
 				const position = transaction.position;
+				const position = transaction.position;
 
 				if (instruments.hasOwnProperty(position)) {
-					transaction.instrument = instruments[position];
-
-					let formatted = getBasicTransaction(transaction);
+					let instrument = instruments[position];
+					let formatted = getBasicTransaction(transaction, instrument);
 
 					if (formatters.has(transaction.type)) {
 						const formatterFunction = formatters.get(transaction.type);
@@ -55,7 +59,7 @@ module.exports = (() => {
 
 						Object.keys(formattedTransaction).map((key) => {
 							if (!is.undefined(formattedTransaction[key]) && formattedTransaction[key] instanceof Decimal) {
-								const precision = transaction.instrument.currency.precision;
+								const precision = instrument.currency.precision;
 
 								formattedTransaction[key] = formatter.numberToString(formattedTransaction[key].toFloat(), precision, ',');
 							}
@@ -86,20 +90,14 @@ module.exports = (() => {
 		}
 	}
 
-	const getBasicTransaction = (t) => {
-		const basic = {
+	const getBasicTransaction = (t, i) => {
+		return {
 			date: t.date,
 			type: t.type.display,
 			sequence: t.sequence,
-			instrument: t.instrument,
+			instrument: i,
 			position: t.position
 		};
-
-		if (basic.instrument) {
-			delete basic.instrument.id;
-		}
-
-		return basic;
 	};
 
 	const formatters = new Map();
@@ -121,7 +119,7 @@ module.exports = (() => {
 	formatters.set(TransactionType.DIVIDEND, (t) => {
 		return {
 			shares: t.snapshot.open,
-			total: t.dividend.amout,
+			total: t.dividend.amount,
 			rate: t.dividend.rate
 		};
 	});

package/package.json

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