@barchart/portfolio-api-common 1.0.195 → 1.0.199

package/lib/api/failures/PortfolioFailureType.js

@@ -0,0 +1,71 @@
+const FailureType = require('@barchart/common-js/api/failures/FailureType');
+
+module.exports = (() => {
+	'use strict';
+
+	/**
+	 * A static container for portfolio-specific {@link FailureType} items.
+	 *
+	 * @public
+	 */
+	class PortfolioFailureType {
+		constructor() {
+		}
+
+		/**
+		 * The transaction would occur before an existing transaction.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_OUT_OF_SEQUENCE() {
+			return transactionCreateFailedOutOfSequence;
+		}
+
+		/**
+		 * The transaction would cause the position to change (from long to
+		 * short, or vice versa).
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_DIRECTION_SWITCH() {
+			return transactionCreateFailedDirectionSwitch;
+		}
+
+		static get TRANSACTION_CREATE_REWRITE_UNSUPPORTED() {
+			return transactionCreateRewriteUnsupported;
+		}
+
+		/**
+		 * Deleting any transaction except for the most recent requires
+		 * re-writing transaction history.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_DELETE_FAILED_OUT_OF_SEQUENCE() {
+			return transactionDeleteFailedOutOfSequence;
+		}
+
+		static get TRANSACTION_DELETE_UNSUPPORTED() {
+			return transactionDeleteUnsupported;
+		}
+
+		toString() {
+			return '[PortfolioFailureType]';
+		}
+	}
+
+	const transactionCreateFailedOutOfSequence = new FailureType('TRANSACTION_CREATE_FAILED_OUT_OF_SEQUENCE', 'Unable to create 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 transactionCreateFailedDirectionSwitch = new FailureType('TRANSACTION_CREATE_FAILED_DIRECTION_SWITCH', 'Unable to create transaction, because the position direction would be switched (from long to short or vice versa). Please close the position (to a zero balance) first, then enter a second transaction.');
+	const transactionCreateRewriteUnsupported = new FailureType('TRANSACTION_CREATE_REWRITE_UNSUPPORTED', 'Unable to re-write transaction history. This operation is not currently supported (but will be implemented soon).');
+
+	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 transactionDeleteUnsupported = new FailureType('TRANSACTION_DELETE_UNSUPPORTED', 'Unable to delete transaction. This operation is not currently supported (but will be implemented soon).');
+
+	return PortfolioFailureType;
+})();

package/lib/processing/PositionContainer.js

@@ -24,6 +24,11 @@ module.exports = (() => {
 
 	const DEFAULT_CURRENCY = Currency.CAD;
 
+	const REQUIRED_CURRENCIES = [
+		Currency.CAD,
+		Currency.USD
+	];
+
 	/**
 	 * A container for positions which groups the positions into one or more
 	 * trees for aggregation and display purposes. For example, positions could be
@@ -114,7 +119,9 @@ module.exports = (() => {
 				return map;
 			}, { });
 
-			this._forexSymbols = Object.keys(this._currencies).reduce((symbols, code) => {
+			const forexCurrencyCodes = array.unique(Object.keys(this._currencies).concat(REQUIRED_CURRENCIES.map(c => c.code)));
+
+			this._forexSymbols = forexCurrencyCodes.reduce((symbols, code) => {
 				if (code !== DEFAULT_CURRENCY.code) {
 					symbols.push(`^${DEFAULT_CURRENCY.code}${code}`);
 				}

package/package.json

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

package/test/SpecRunner.js

@@ -740,6 +740,11 @@ module.exports = (() => {
 
 	const DEFAULT_CURRENCY = Currency.CAD;
 
+	const REQUIRED_CURRENCIES = [
+		Currency.CAD,
+		Currency.USD
+	];
+
 	/**
 	 * A container for positions which groups the positions into one or more
 	 * trees for aggregation and display purposes. For example, positions could be
@@ -830,7 +835,9 @@ module.exports = (() => {
 				return map;
 			}, { });
 
-			this._forexSymbols = Object.keys(this._currencies).reduce((symbols, code) => {
+			const forexCurrencyCodes = array.unique(Object.keys(this._currencies).concat(REQUIRED_CURRENCIES.map(c => c.code)));
+
+			this._forexSymbols = forexCurrencyCodes.reduce((symbols, code) => {
 				if (code !== DEFAULT_CURRENCY.code) {
 					symbols.push(`^${DEFAULT_CURRENCY.code}${code}`);
 				}