@barchart/portfolio-api-common 1.9.1 → 1.10.0

package/.releases/1.10.0.md

@@ -0,0 +1,3 @@
+**New Features**
+
+* Added a new `PortfolioFailureType` for negative quantity.

package/lib/api/failures/PortfolioFailureType.js

@@ -154,6 +154,17 @@ module.exports = (() => {
 			return transactionCreateFailedInvalidInitialType;
 		}
 
+		/**
+		 * A transaction quantity cannot have a negative amount.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_QUANTITY_NEGATIVE() {
+			return transactionCreateFailedQuantityNegative;
+		}
+
 		/**
 		 * A valuation transaction cannot have a negative rate (or amount).
 		 *
@@ -348,7 +359,7 @@ module.exports = (() => {
 		static get TRANSACTION_EDIT_FAILED_TYPE_CHANGED() {
 			return transactionEditFailedTypeChanged;
 		}
-		
+
 		/**
 		 * Conversion of transaction type is unsupported.
 		 *
@@ -371,7 +382,7 @@ module.exports = (() => {
 		static get TRANSACTION_SWITCH_FAILED_INVALID_REINVEST() {
 			return transactionSwitchFailedInvalidReinvest;
 		}
-		
+
 		toString() {
 			return '[PortfolioFailureType]';
 		}
@@ -392,6 +403,7 @@ module.exports = (() => {
 	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.', false);
 	const transactionCreateFailedInvalidDirectionSwitch = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_DIRECTION_SWITCH', 'Unable to process transaction, the transaction would switch the position from {L|currentDirection.description} to {L|proposedDirection.description} (i.e. {L|currentDirection.sign} to {L|proposedDirection.sign} shares/units). This is not allowed. Please close the current position (i.e. zero it out) and then enter a second transaction.', false);
 	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.', false);
+	const transactionCreateFailedQuantityNegative = new FailureType('TRANSACTION_CREATE_FAILED_QUANTITY_NEGATIVE', 'Unable to process transaction, quantity cannot be negative.');
 	const transactionCreateFailedValuationNegative = new FailureType('TRANSACTION_CREATE_FAILED_VALUATION_NEGATIVE', 'Unable to process operation, valuations cannot be negative.', false);
 	const transactionCreateFailedInvalidTermination = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_TERMINATION', 'Unable to process operation, a {U|transactionType.description} must be the final transaction in the position history.', false);
 	const transactionCreateFailedAfterTermination = new FailureType('TRANSACTION_CREATE_FAILED_AFTER_TERMINATION', 'Unable to process operation, one or more transactions would exist after {L|termination}, the final day of trading for this instrument', false);

package/package.json

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

package/test/SpecRunner.js

@@ -5694,7 +5694,7 @@ module.exports = (() => {
 
 
     push(item) {
-      this._array.unshift(item);
+      this._array.push(item);
 
       return item;
     }
@@ -5711,7 +5711,7 @@ module.exports = (() => {
         throw new Error('Stack is empty');
       }
 
-      return this._array.shift();
+      return this._array.pop();
     }
     /**
      * Returns the next item in the stack (without removing it). Throws if the stack is empty.
@@ -5726,7 +5726,7 @@ module.exports = (() => {
         throw new Error('Stack is empty');
       }
 
-      return this._array[0];
+      return this._array[this._array.length - 1];
     }
     /**
      * Returns true if the queue is empty; otherwise false.
@@ -5750,10 +5750,12 @@ module.exports = (() => {
     scan(action) {
       assert.argumentIsRequired(action, 'action', Function);
 
-      this._array.forEach(x => action(x));
+      for (let i = this._array.length - 1; i >= 0; i--) {
+        action(this._array[i]);
+      }
     }
     /**
-     * Outputs an array of the stacks's items; without affecting the
+     * Outputs an array of the stack's items; without affecting the
      * queue's internal state;
      *
      * @public
@@ -5762,7 +5764,7 @@ module.exports = (() => {
 
 
     toArray() {
-      return this._array.slice(0);
+      return this._array.slice(0).reverse();
     }
 
     toString() {
@@ -17621,8 +17623,8 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			ranges = PositionSummaryFrame.YEARLY.getRanges(transactions);
 		});
 
-		it('should have four ranges (assuming the current year is 2020)', () => {
-			expect(ranges.length).toEqual(5);
+		it('should have six ranges (assuming the current year is 2021)', () => {
+			expect(ranges.length).toEqual(6);
 		});
 
 		it('the first range should be from 12-31-2014 to 12-31-2015', () => {
@@ -18008,7 +18010,7 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
-	describe('and a year-to-date position summary ranges are processed for a transaction set that opened last year and has not yet closed (assuming its 2020)', () => {
+	describe('and a year-to-date position summary ranges are processed for a transaction set that opened last year and has not yet closed (assuming its 2021)', () => {
 		let ranges;
 
 		beforeEach(() => {
@@ -18029,9 +18031,9 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges.length).toEqual(1);
 		});
 
-		it('the first range should be from 12-31-2019 to 12-31-2020', () => {
-			expect(ranges[0].start.format()).toEqual('2019-12-31');
-			expect(ranges[0].end.format()).toEqual('2020-12-31');
+		it('the first range should be from 12-31-2020 to 12-31-2021', () => {
+			expect(ranges[0].start.format()).toEqual('2020-12-31');
+			expect(ranges[0].end.format()).toEqual('2021-12-31');
 		});
 	});
 
@@ -18041,14 +18043,14 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		beforeEach(() => {
 			const transactions = [
 				{
-					date: new Day(2020, 1, 1),
+					date: new Day(2021, 1, 1),
 					snapshot: {
 						open: new Decimal(1)
 					},
 					type: TransactionType.BUY
 				},
 				{
-					date: new Day(2020, 1, 2),
+					date: new Day(2021, 1, 2),
 					snapshot: {
 						open: new Decimal(0)
 					},
@@ -18063,9 +18065,9 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges.length).toEqual(1);
 		});
 
-		it('the first range should be from 12-31-2019 to 12-31-2020', () => {
-			expect(ranges[0].start.format()).toEqual('2019-12-31');
-			expect(ranges[0].end.format()).toEqual('2020-12-31');
+		it('the first range should be from 12-31-2020 to 12-31-2021', () => {
+			expect(ranges[0].start.format()).toEqual('2020-12-31');
+			expect(ranges[0].end.format()).toEqual('2021-12-31');
 		});
 	});
 

package/test/specs/data/PositionSummaryFrameSpec.js

@@ -31,8 +31,8 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			ranges = PositionSummaryFrame.YEARLY.getRanges(transactions);
 		});
 
-		it('should have four ranges (assuming the current year is 2020)', () => {
-			expect(ranges.length).toEqual(5);
+		it('should have six ranges (assuming the current year is 2021)', () => {
+			expect(ranges.length).toEqual(6);
 		});
 
 		it('the first range should be from 12-31-2014 to 12-31-2015', () => {
@@ -418,7 +418,7 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
-	describe('and a year-to-date position summary ranges are processed for a transaction set that opened last year and has not yet closed (assuming its 2020)', () => {
+	describe('and a year-to-date position summary ranges are processed for a transaction set that opened last year and has not yet closed (assuming its 2021)', () => {
 		let ranges;
 
 		beforeEach(() => {
@@ -439,9 +439,9 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges.length).toEqual(1);
 		});
 
-		it('the first range should be from 12-31-2019 to 12-31-2020', () => {
-			expect(ranges[0].start.format()).toEqual('2019-12-31');
-			expect(ranges[0].end.format()).toEqual('2020-12-31');
+		it('the first range should be from 12-31-2020 to 12-31-2021', () => {
+			expect(ranges[0].start.format()).toEqual('2020-12-31');
+			expect(ranges[0].end.format()).toEqual('2021-12-31');
 		});
 	});
 
@@ -451,14 +451,14 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		beforeEach(() => {
 			const transactions = [
 				{
-					date: new Day(2020, 1, 1),
+					date: new Day(2021, 1, 1),
 					snapshot: {
 						open: new Decimal(1)
 					},
 					type: TransactionType.BUY
 				},
 				{
-					date: new Day(2020, 1, 2),
+					date: new Day(2021, 1, 2),
 					snapshot: {
 						open: new Decimal(0)
 					},
@@ -473,9 +473,9 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges.length).toEqual(1);
 		});
 
-		it('the first range should be from 12-31-2019 to 12-31-2020', () => {
-			expect(ranges[0].start.format()).toEqual('2019-12-31');
-			expect(ranges[0].end.format()).toEqual('2020-12-31');
+		it('the first range should be from 12-31-2020 to 12-31-2021', () => {
+			expect(ranges[0].start.format()).toEqual('2020-12-31');
+			expect(ranges[0].end.format()).toEqual('2021-12-31');
 		});
 	});