@barchart/portfolio-api-common 1.2.65 → 1.2.69

package/lib/api/failures/PortfolioFailureType.js

@@ -143,6 +143,17 @@ module.exports = (() => {
 			return transactionCreateFailedReinvestPriceUnavailable;
 		}
 
+		/**
+		 * The transaction failed because the position has been locked.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_POSITION_LOCKED() {
+			return transactionCreateFailedPositionLocked;
+		}
+
 		/**
 		 * Deleting any transaction except for the most recent requires
 		 * re-writing transaction history.
@@ -219,6 +230,7 @@ module.exports = (() => {
 	const transactionCreateFailedInvalidInitialType = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_INITIAL_TYPE', 'Unable to process operation because the first transaction would to be a {U|transactionType.description}, which is not allowed -- since {U|transactionType.description} transactions cannot open a position.');
 	const transactionCreateFailedTypeReserved = new FailureType('TRANSACTION_CREATE_FAILED_TYPE_RESERVED', 'Unable to create {U|type.description} transaction, this type of transaction is managed by the system.');
 	const transactionCreateFailedReinvestPriceUnavailable = new FailureType('TRANSACTION_CREATE_FAILED_REINVEST_PRICE_UNAVAILABLE', 'Unable to create transaction, a dividend was paid on {L|day}; however no historical price is available for this day. To successfully create this transaction, please turn off dividend reinvestment for this position.');
+	const transactionCreateFailedPositionLocked = new FailureType('TRANSACTION_CREATE_FAILED_POSITION_LOCKED', 'Unable to create transaction, are being recalculated for this position (or the linked cash position). Please re-enter the transaction in a minute or two.');
 
 	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 transactionDeleteFailedNoTransaction = new FailureType('TRANSACTION_DELETE_FAILED_NO_TRANSACTION', 'Unable to delete transaction. The referenced transaction does not exist.');

package/lib/data/InstrumentType.js

@@ -21,10 +21,11 @@ module.exports = (() => {
 	 * @param {Boolean} hasCorporateActions
 	 * @param {Boolean} closeFractional
 	 * @param {Boolean} roundQuantity
+	 * @param {Boolean} strictOrdering
 	 * @param {Function} generator
 	 */
 	class InstrumentType extends Enum {
-		constructor(code, description, alternateDescription, canReinvest, canShort, canSwitchDirection, usesSymbols, hasCorporateActions, closeFractional, roundQuantity, generator) {
+		constructor(code, description, alternateDescription, canReinvest, canShort, canSwitchDirection, usesSymbols, hasCorporateActions, closeFractional, roundQuantity, strictOrdering, generator) {
 			super(code, description);
 
 			assert.argumentIsRequired(alternateDescription, 'alternateDescription', String);
@@ -35,6 +36,7 @@ module.exports = (() => {
 			assert.argumentIsRequired(hasCorporateActions, 'hasCorporateActions', Boolean);
 			assert.argumentIsRequired(closeFractional, 'closeFractional', Boolean);
 			assert.argumentIsRequired(roundQuantity, 'roundQuantity', Boolean);
+			assert.argumentIsRequired(roundQuantity, 'strictOrdering', Boolean);
 			assert.argumentIsRequired(generator, 'generator', Function);
 
 			this._alternateDescription = alternateDescription;
@@ -45,6 +47,7 @@ module.exports = (() => {
 			this._hasCorporateActions = hasCorporateActions;
 			this._closeFractional = closeFractional;
 			this._roundQuantity = roundQuantity;
+			this._strictOrdering = strictOrdering;
 
 			this._generator = generator;
 		}
@@ -121,6 +124,17 @@ module.exports = (() => {
 			return this._closeFractional;
 		}
 
+		/**
+		 * Indicates if transaction sequences must be honored before calculating position
+		 * totals.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get strictOrdering() {
+			return this._strictOrdering;
+		}
+
 		/**
 		 * Indicates transaction quantities should be rounded.
 		 *
@@ -228,10 +242,10 @@ module.exports = (() => {
 		}
 	}
 
-	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false, true, false, false, false, false, (instrument) => `BARCHART-${instrument.type.code}-${instrument.currency.code}`);
-	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true, false, true, true, true, true,  (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
-	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, false, false, true, true, false, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
-	const other = new InstrumentType('OTHER', 'other', 'Other', false, false, false, false, false, false, true, (instrument) => `BARCHART-${instrument.type.code}-${uuid.v4()}`);
+	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false, true, false, false, false, false, false, (instrument) => `BARCHART-${instrument.type.code}-${instrument.currency.code}`);
+	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true, false, true, true, true, true, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
+	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, false, false, true, true, false, true, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
+	const other = new InstrumentType('OTHER', 'other', 'Other', false, false, false, false, false, false, true, true, (instrument) => `BARCHART-${instrument.type.code}-${uuid.v4()}`);
 
 	const map = { };
 

package/lib/data/TransactionValidator.js

@@ -19,6 +19,25 @@ module.exports = (() => {
 
 		}
 
+		/**
+		 * Determines the desired sequence number for a transaction.
+		 *
+		 * @public
+		 * @param {Object} transaction
+		 * @return {Number}
+		 */
+		static getSortSequence(transaction) {
+			let effective;
+
+			if (is.number(transaction.resequence)) {
+				effective = transaction.resequence;
+			} else {
+				effective = transaction.sequence;
+			}
+
+			return effective;
+		}
+
 		/**
 		 * Given an array of transactions, ensures that all sequence numbers and dates
 		 * are properly ordered.
@@ -85,7 +104,7 @@ module.exports = (() => {
 			assert.argumentIsArray(transactions, 'transactions');
 			assert.argumentIsOptional(strict, 'strict', Boolean);
 
-			return transactions.findIndex((t, i, a) => t.sequence !== (i + 1) || (i !== 0 && t.date.getIsBefore(a[ i - 1 ].date)) || (i !== 0 && is.boolean(strict) && strict && t.date.getIsEqual(a[i - 1].date) && t.type.sequence < a[i - 1].type.sequence));
+			return transactions.findIndex((t, i, a) => TransactionValidator.getSortSequence(t) !== (i + 1) || (i !== 0 && t.date.getIsBefore(a[ i - 1 ].date)) || (i !== 0 && is.boolean(strict) && strict && t.date.getIsEqual(a[i - 1].date) && t.type.sequence < a[i - 1].type.sequence));
 		}
 
 		/**

package/lib/formatters/TransactionFormatter.js

@@ -31,12 +31,14 @@ module.exports = (() => {
 		 * @param {Array.<Object>} transactions
 		 * @param {Array.<Object>} positions
 		 * @param {Boolean=} mutate
+		 * @param {Boolean=} descending
 		 * @returns {Array}
 		 */
-		static format(transactions, positions, mutate) {
+		static format(transactions, positions, mutate, descending) {
 			assert.argumentIsArray(transactions, 'transactions');
 			assert.argumentIsArray(positions, 'positions');
 			assert.argumentIsOptional(mutate, 'mutate', Boolean);
+			assert.argumentIsOptional(descending, 'descending', Boolean);
 
 			const instruments = positions.reduce((map, p) => {
 				const instrument = Object.assign({ }, p.instrument || { });
@@ -84,6 +86,14 @@ module.exports = (() => {
 				return list;
 			}, [ ]);
 
+			let comparator;
+
+			if (is.boolean(descending) && descending) {
+				comparator = comparatorDescending;
+			} else {
+				comparator = comparatorAscending;
+			}
+
 			a.sort(comparator);
 
 			a.forEach((t) => {
@@ -99,9 +109,21 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {Array.<Object>} transactions
+		 * @param {Boolean=} descending
 		 * @returns {Array}
 		 */
-		sort(transactions) {
+		sort(transactions, descending) {
+			assert.argumentIsArray(transactions, 'transactions');
+			assert.argumentIsOptional(descending, 'descending', Boolean);
+
+			let comparator;
+
+			if (is.boolean(descending) && descending) {
+				comparator = comparatorDescending;
+			} else {
+				comparator = comparatorAscending;
+			}
+
 			return transactions.sort(comparator);
 		}
 
@@ -277,15 +299,14 @@ module.exports = (() => {
 		}
 	}
 
-	const comparator = ComparatorBuilder.startWith((a, b) => {
-		return Day.compareDays(a.date, b.date);
-	}).thenBy((a, b) => {
-		return comparators.compareNumbers(getInstrumentTypePriority(a.instrument.type), getInstrumentTypePriority(b.instrument.type));
-	}).thenBy((a, b) => {
-		return comparators.compareStrings(a.instrument.id, b.instrument.id);
-	}).thenBy((a, b) => {
-		return comparators.compareNumbers(a.sequence, b.sequence);
-	}).toComparator();
+	const comparatorAscending = ComparatorBuilder.startWith((a, b) => Day.compareDays(a.date, b.date))
+		.thenBy((a, b) => comparators.compareNumbers(getInstrumentTypePriority(a.instrument.type), getInstrumentTypePriority(b.instrument.type))
+		.thenBy((a, b) => comparators.compareStrings(a.instrument.id, b.instrument.id))
+		.thenBy((a, b) => comparators.compareNumbers(a.sequence, b.sequence))
+		.toComparator();
+
+	const comparatorDescending = ComparatorBuilder.startWith((a, b) => comparatorAscending(b, a))
+		.toComparator();
 
 	return TransactionFormatter;
 })();

package/package.json

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

package/test/SpecRunner.js

@@ -22,10 +22,11 @@ module.exports = (() => {
 	 * @param {Boolean} hasCorporateActions
 	 * @param {Boolean} closeFractional
 	 * @param {Boolean} roundQuantity
+	 * @param {Boolean} strictOrdering
 	 * @param {Function} generator
 	 */
 	class InstrumentType extends Enum {
-		constructor(code, description, alternateDescription, canReinvest, canShort, canSwitchDirection, usesSymbols, hasCorporateActions, closeFractional, roundQuantity, generator) {
+		constructor(code, description, alternateDescription, canReinvest, canShort, canSwitchDirection, usesSymbols, hasCorporateActions, closeFractional, roundQuantity, strictOrdering, generator) {
 			super(code, description);
 
 			assert.argumentIsRequired(alternateDescription, 'alternateDescription', String);
@@ -36,6 +37,7 @@ module.exports = (() => {
 			assert.argumentIsRequired(hasCorporateActions, 'hasCorporateActions', Boolean);
 			assert.argumentIsRequired(closeFractional, 'closeFractional', Boolean);
 			assert.argumentIsRequired(roundQuantity, 'roundQuantity', Boolean);
+			assert.argumentIsRequired(roundQuantity, 'strictOrdering', Boolean);
 			assert.argumentIsRequired(generator, 'generator', Function);
 
 			this._alternateDescription = alternateDescription;
@@ -46,6 +48,7 @@ module.exports = (() => {
 			this._hasCorporateActions = hasCorporateActions;
 			this._closeFractional = closeFractional;
 			this._roundQuantity = roundQuantity;
+			this._strictOrdering = strictOrdering;
 
 			this._generator = generator;
 		}
@@ -122,6 +125,17 @@ module.exports = (() => {
 			return this._closeFractional;
 		}
 
+		/**
+		 * Indicates if transaction sequences must be honored before calculating position
+		 * totals.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get strictOrdering() {
+			return this._strictOrdering;
+		}
+
 		/**
 		 * Indicates transaction quantities should be rounded.
 		 *
@@ -229,10 +243,10 @@ module.exports = (() => {
 		}
 	}
 
-	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false, true, false, false, false, false, (instrument) => `BARCHART-${instrument.type.code}-${instrument.currency.code}`);
-	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true, false, true, true, true, true,  (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
-	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, false, false, true, true, false, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
-	const other = new InstrumentType('OTHER', 'other', 'Other', false, false, false, false, false, false, true, (instrument) => `BARCHART-${instrument.type.code}-${uuid.v4()}`);
+	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false, true, false, false, false, false, false, (instrument) => `BARCHART-${instrument.type.code}-${instrument.currency.code}`);
+	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true, false, true, true, true, true, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
+	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, false, false, true, true, false, true, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
+	const other = new InstrumentType('OTHER', 'other', 'Other', false, false, false, false, false, false, true, true, (instrument) => `BARCHART-${instrument.type.code}-${uuid.v4()}`);
 
 	const map = { };
 
@@ -1088,6 +1102,25 @@ module.exports = (() => {
 
 		}
 
+		/**
+		 * Determines the desired sequence number for a transaction.
+		 *
+		 * @public
+		 * @param {Object} transaction
+		 * @return {Number}
+		 */
+		static getSortSequence(transaction) {
+			let effective;
+
+			if (is.number(transaction.resequence)) {
+				effective = transaction.resequence;
+			} else {
+				effective = transaction.sequence;
+			}
+
+			return effective;
+		}
+
 		/**
 		 * Given an array of transactions, ensures that all sequence numbers and dates
 		 * are properly ordered.
@@ -1154,7 +1187,7 @@ module.exports = (() => {
 			assert.argumentIsArray(transactions, 'transactions');
 			assert.argumentIsOptional(strict, 'strict', Boolean);
 
-			return transactions.findIndex((t, i, a) => t.sequence !== (i + 1) || (i !== 0 && t.date.getIsBefore(a[ i - 1 ].date)) || (i !== 0 && is.boolean(strict) && strict && t.date.getIsEqual(a[i - 1].date) && t.type.sequence < a[i - 1].type.sequence));
+			return transactions.findIndex((t, i, a) => TransactionValidator.getSortSequence(t) !== (i + 1) || (i !== 0 && t.date.getIsBefore(a[ i - 1 ].date)) || (i !== 0 && is.boolean(strict) && strict && t.date.getIsEqual(a[i - 1].date) && t.type.sequence < a[i - 1].type.sequence));
 		}
 
 		/**