@barchart/portfolio-api-common 1.0.219 → 1.0.220

package/lib/data/PositionDirection.js

@@ -118,20 +118,6 @@ module.exports = (() => {
 				return even;
 			}
 		}
-
-		/**
-		 * Returns true of the direction switched (from long to short, or
-		 * short to long).
-		 *
-		 * @public
-		 * @static
-		 * @param {PositionDirection} a
-		 * @param {PositionDirection} b
-		 * @returns {Boolean}
-		 */
-		static switched(a, b) {
-			return !a.closed && !b.closed && a.positive !== b.positive;
-		}
 	}
 
 	const long = new PositionDirection('LONG', 'Long', 'positive');

package/lib/data/{TypeValidator.js → TransactionValidator.js}

@@ -1,6 +1,7 @@
 const assert = require('@barchart/common-js/lang/assert');
 
 const InstrumentType = require('./InstrumentType'),
+	PositionDirection = require('./PositionDirection'),
 	TransactionType = require('./TransactionType');
 
 module.exports = (() => {
@@ -11,7 +12,7 @@ module.exports = (() => {
 	 *
 	 * @public
 	 */
-	class TypeValidator {
+	class TransactionValidator {
 		constructor() {
 
 		}
@@ -39,22 +40,57 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Checks to see is an transaction type is applicable to an instrument type.
+		 * Checks to see if an transaction type is applicable to an instrument type.
 		 *
 		 * @static
 		 * @public
 		 * @param {InstrumentType} instrumentType
+		 * @param {TransactionType} transactionType
 		 * @param {Boolean=} userInitiated
 		 * @return {Boolean}
 		 */
-		static validateTransactionTypeFor(instrumentType, transactionType, userInitiated) {
-			const transactionTypes = TypeValidator.getTransactionTypesFor(instrumentType, userInitiated);
+		static validateTransactionType(instrumentType, transactionType, userInitiated) {
+			assert.argumentIsRequired(transactionType, 'transactionType', TransactionType, 'TransactionType');
+
+			const transactionTypes = TransactionValidator.getTransactionTypesFor(instrumentType, userInitiated);
 
 			return transactionType.some(t => t === transactionType);
 		}
 
+		/**
+		 * Checks to see if a position for a given instrument type can exist in
+		 * the given direction.
+		 *
+		 * @static
+		 * @public
+		 * @param {InstrumentType} instrumentType
+		 * @param {PositionDirection} direction
+		 * @return {Boolean}
+		 */
+		static validateDirection(transactionType, direction) {
+			assert.argumentIsRequired(transactionType, 'transactionType', TransactionType, 'TransactionType');
+			assert.argumentIsRequired(direction, 'direction', PositionDirection, 'PositionDirection');
+
+			return validDirections[transactionType.code].some(d => d === direction);
+		}
+
+		/**
+		 * Checks to see if the position switches direction and if the direction switch
+		 * is valid.
+		 *
+		 * @static
+		 * @public
+		 * @param {InstrumentType} instrumentType
+		 * @param {PositionDirection|null|undefined} currentDirection
+		 * @param {PositionDirection} proposedDirection
+		 * @return {Boolean}
+		 */
+		static validateDirectionSwitch(instrumentType, currentDirection, proposedDirection) {
+			return currentDirection === null || instrumentType.canSwitchDirection || (!currentDirection.closed && !proposedDirection.closed && currentDirection.positive !== proposedDirection.positive);
+		}
+
 		toString() {
-			return '[TypeValidator]';
+			return '[TransactionValidator]';
 		}
 	}
 
@@ -99,5 +135,31 @@ module.exports = (() => {
 	associateTypes(InstrumentType.CASH, TransactionType.DEBIT, false);
 	associateTypes(InstrumentType.CASH, TransactionType.CREDIT, false);
 
-	return TypeValidator;
+	const validDirections = { };
+
+	function associateDirections(instrumentType, positionDirection) {
+		const instrumentTypeCode = instrumentType.code;
+
+		if (!validDirections.hasOwnProperty(instrumentTypeCode)) {
+			validDirections[instrumentTypeCode] = [ ];
+		}
+
+		validDirections[instrumentTypeCode].push(positionDirection);
+	}
+
+	associateTypes(InstrumentType.EQUITY, PositionDirection.EVEN);
+	associateTypes(InstrumentType.EQUITY, PositionDirection.LONG);
+	associateTypes(InstrumentType.EQUITY, PositionDirection.SHORT);
+
+	associateTypes(InstrumentType.FUND, PositionDirection.EVEN);
+	associateTypes(InstrumentType.FUND, PositionDirection.LONG);
+
+	associateTypes(InstrumentType.OTHER, PositionDirection.EVEN);
+	associateTypes(InstrumentType.OTHER, PositionDirection.LONG);
+
+	associateTypes(InstrumentType.CASH, PositionDirection.EVEN);
+	associateTypes(InstrumentType.CASH, PositionDirection.LONG);
+	associateTypes(InstrumentType.CASH, PositionDirection.SHORT);
+
+	return TransactionValidator;
 })();

package/package.json

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