@barchart/portfolio-api-common 1.3.13 → 1.3.17

package/lib/api/failures/PortfolioFailureType.js

@@ -285,14 +285,14 @@ module.exports = (() => {
 		}
 	}
 
-	const portfolioUpdateFailedNoPortfolio = new FailureType('PORTFOLIO_UPDATE_FAILED_NO_PORTFOLIO', 'Unable to update portfolio. The portfolio does not exist, has it been deleted?');
-	const portfolioDeleteFailedNoPortfolio = new FailureType('PORTFOLIO_DELETE_FAILED_NO_PORTFOLIO', 'Unable to delete portfolio. The portfolio does not exist, has it already been deleted?');
+	const portfolioUpdateFailedNoPortfolio = new FailureType('PORTFOLIO_UPDATE_FAILED_NO_PORTFOLIO', 'Unable to update portfolio. The portfolio does not exist, has it been deleted?', false);
+	const portfolioDeleteFailedNoPortfolio = new FailureType('PORTFOLIO_DELETE_FAILED_NO_PORTFOLIO', 'Unable to delete portfolio. The portfolio does not exist, has it already been deleted?', false);
 
-	const positionCreateFailedNoPortfolio = new FailureType('POSITION_CREATE_FAILED_NO_PORTFOLIO', 'Unable to create transaction. The portfolio does not exist, has it been deleted?');
-	const positionUpdateFailedNoPosition = new FailureType('POSITION_UPDATE_FAILED_NO_POSITION', 'Unable to update preferences for position. The position does not exist, has it been deleted?');
+	const positionCreateFailedNoPortfolio = new FailureType('POSITION_CREATE_FAILED_NO_PORTFOLIO', 'Unable to create transaction. The portfolio does not exist, has it been deleted?', false);
+	const positionUpdateFailedNoPosition = new FailureType('POSITION_UPDATE_FAILED_NO_POSITION', 'Unable to update preferences for position. The position does not exist, has it been deleted?', false);
 	const positionDeleteFailedPositionLocked = new FailureType('POSITION_DELETE_FAILED_POSITION_LOCKED', 'Unable to delete position, your {L|description} history is being recalculated. Please wait a minute or two and retry.');
 
-	const transactionCreateFailedNoPosition = new FailureType('TRANSACTION_CREATE_FAILED_NO_POSITION', 'Unable to create transaction. The referenced position 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?', false);
 	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 transactionCreateFailedInvalidDate = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_DATE', 'Unable to process transaction with given date.');
 	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.');

package/lib/formatters/TransactionFormatter.js

@@ -155,14 +155,30 @@ module.exports = (() => {
 		f.total = t.dividend.amount;
 		f.rate = t.dividend.rate;
 
-		f.shares = t.dividend.amount.divide(t.dividend.rate);
+		let shares;
+
+		if (!t.dividend.rate.getIsZero()) {
+			shares = t.dividend.amount.divide(t.dividend.rate);
+		} else {
+			shares = '';
+		}
+
+		f.shares = shares;
 	};
 
 	const distributionCashFormatter = (t, f) => {
 		f.total = t.dividend.amount;
 		f.rate = t.dividend.rate;
 
-		f.shares = t.dividend.amount.divide(t.dividend.rate);
+		let shares;
+
+		if (!t.dividend.rate.getIsZero()) {
+			shares = t.dividend.amount.divide(t.dividend.rate);
+		} else {
+			shares = '';
+		}
+
+		f.shares = shares;
 	};
 
 	const dividendReinvestFormatter = (t, f) => {
@@ -199,12 +215,20 @@ module.exports = (() => {
 		}
 
 		if (t.dividend) {
+			let rate;
+
 			if (t.dividend.numerator && t.dividend.denominator) {
-				f.rate = t.dividend.numerator.divide(t.dividend.denominator);
+				if (!t.dividend.denominator.getIsZero()) {
+					rate = t.dividend.numerator.divide(t.dividend.denominator);
+				} else {
+					rate = '';
+				}
 			} else if (t.dividend.rate) {
-				f.rate = t.dividend.rate;
+				rate = t.dividend.rate;
 			}
 
+			f.rate = rate;
+
 			if (t.dividend.price) {
 				f.price = t.dividend.price;
 			}
@@ -221,12 +245,20 @@ module.exports = (() => {
 		}
 
 		if (t.dividend) {
+			let rate;
+
 			if (t.dividend.numerator && t.dividend.denominator) {
-				f.rate = t.dividend.numerator.divide(t.dividend.denominator);
+				if (!t.dividend.denominator.getIsZero()) {
+					rate = t.dividend.numerator.divide(t.dividend.denominator);
+				} else {
+					rate = '';
+				}
 			} else if (t.dividend.rate) {
-				f.rate = t.dividend.rate;
+				rate = t.dividend.rate;
 			}
 
+			f.rate = rate;
+
 			if (t.dividend.price) {
 				f.price = t.dividend.price;
 			}
@@ -251,7 +283,15 @@ module.exports = (() => {
 	const splitFormatter = (t, f) => {
 		f.boughtSold = t.quantity;
 
-		f.rate = t.split.numerator.divide(t.split.denominator);
+		let rate;
+
+		if (!t.split.denominator.getIsZero()) {
+			rate = t.split.numerator.divide(t.split.denominator);
+		} else {
+			rate = '';
+		}
+
+		f.rate = rate;
 
 		f.shares = t.snapshot.open.subtract(t.quantity);
 	};
@@ -264,7 +304,11 @@ module.exports = (() => {
 		} else if (t.snapshot.open.getIsZero()) {
 			rate = null;
 		} else {
-			rate = t.valuation.value.divide(t.snapshot.open);
+			if (!t.snapshot.open.getIsZero()) {
+				rate = t.valuation.value.divide(t.snapshot.open);
+			} else {
+				rate = '';
+			}
 		}
 
 		f.price = rate;

package/lib/processing/PositionGroup.js

@@ -997,7 +997,7 @@ module.exports = (() => {
 		const format = group._dataFormat;
 
 		const numerator = actual.unrealized;
-		const denominator = actual.basis;
+		const denominator = actual.basis.absolute();
 
 		if (denominator.getIsZero()) {
 			actual.unrealizedPercent = Decimal.ZERO;

package/package.json

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

package/test/SpecRunner.js

@@ -3565,7 +3565,7 @@ module.exports = (() => {
 		const format = group._dataFormat;
 
 		const numerator = actual.unrealized;
-		const denominator = actual.basis;
+		const denominator = actual.basis.absolute();
 
 		if (denominator.getIsZero()) {
 			actual.unrealizedPercent = Decimal.ZERO;
@@ -17027,8 +17027,8 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			ranges = PositionSummaryFrame.YEARLY.getRanges(transactions);
 		});
 
-		it('should have four ranges (assuming the current year is 2019)', () => {
-			expect(ranges.length).toEqual(4);
+		it('should have four ranges (assuming the current year is 2020)', () => {
+			expect(ranges.length).toEqual(5);
 		});
 
 		it('the first range should be from 12-31-2014 to 12-31-2015', () => {
@@ -17050,6 +17050,11 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges[3].start.format()).toEqual('2017-12-31');
 			expect(ranges[3].end.format()).toEqual('2018-12-31');
 		});
+
+		it('the fifth range should be from 12-31-2018 to 12-31-2019', () => {
+			expect(ranges[4].start.format()).toEqual('2018-12-31');
+			expect(ranges[4].end.format()).toEqual('2019-12-31');
+		});
 	});
 
 	describe('and yearly position summary ranges are processed for a transaction set closes the same year', () => {
@@ -17409,7 +17414,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 this year and has not yet closed (assuming its 2019)', () => {
+	describe('and a year-to-date position summary ranges are processed for a transaction set that opened this year and has not yet closed (assuming its 2020)', () => {
 		let ranges;
 
 		beforeEach(() => {
@@ -17430,26 +17435,26 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges.length).toEqual(1);
 		});
 
-		it('the first range should be from 12-31-2018 to 12-31-2019', () => {
-			expect(ranges[0].start.format()).toEqual('2018-12-31');
-			expect(ranges[0].end.format()).toEqual('2019-12-31');
+		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');
 		});
 	});
 
-	describe('and a year-to-date position summary ranges are processed for a transaction set that that opened and closed in 2019', () => {
+	describe('and a year-to-date position summary ranges are processed for a transaction set that that opened and closed in 2020', () => {
 		let ranges;
 
 		beforeEach(() => {
 			const transactions = [
 				{
-					date: new Day(2019, 1, 1),
+					date: new Day(2020, 1, 1),
 					snapshot: {
 						open: new Decimal(1)
 					},
 					type: TransactionType.BUY
 				},
 				{
-					date: new Day(2019, 1, 2),
+					date: new Day(2020, 1, 2),
 					snapshot: {
 						open: new Decimal(0)
 					},
@@ -17464,9 +17469,9 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges.length).toEqual(1);
 		});
 
-		it('the first range should be from 12-31-2018 to 12-31-2019', () => {
-			expect(ranges[0].start.format()).toEqual('2018-12-31');
-			expect(ranges[0].end.format()).toEqual('2019-12-31');
+		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');
 		});
 	});
 

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 2019)', () => {
-			expect(ranges.length).toEqual(4);
+		it('should have four ranges (assuming the current year is 2020)', () => {
+			expect(ranges.length).toEqual(5);
 		});
 
 		it('the first range should be from 12-31-2014 to 12-31-2015', () => {
@@ -54,6 +54,11 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges[3].start.format()).toEqual('2017-12-31');
 			expect(ranges[3].end.format()).toEqual('2018-12-31');
 		});
+
+		it('the fifth range should be from 12-31-2018 to 12-31-2019', () => {
+			expect(ranges[4].start.format()).toEqual('2018-12-31');
+			expect(ranges[4].end.format()).toEqual('2019-12-31');
+		});
 	});
 
 	describe('and yearly position summary ranges are processed for a transaction set closes the same year', () => {
@@ -413,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 this year and has not yet closed (assuming its 2019)', () => {
+	describe('and a year-to-date position summary ranges are processed for a transaction set that opened this year and has not yet closed (assuming its 2020)', () => {
 		let ranges;
 
 		beforeEach(() => {
@@ -434,26 +439,26 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges.length).toEqual(1);
 		});
 
-		it('the first range should be from 12-31-2018 to 12-31-2019', () => {
-			expect(ranges[0].start.format()).toEqual('2018-12-31');
-			expect(ranges[0].end.format()).toEqual('2019-12-31');
+		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');
 		});
 	});
 
-	describe('and a year-to-date position summary ranges are processed for a transaction set that that opened and closed in 2019', () => {
+	describe('and a year-to-date position summary ranges are processed for a transaction set that that opened and closed in 2020', () => {
 		let ranges;
 
 		beforeEach(() => {
 			const transactions = [
 				{
-					date: new Day(2019, 1, 1),
+					date: new Day(2020, 1, 1),
 					snapshot: {
 						open: new Decimal(1)
 					},
 					type: TransactionType.BUY
 				},
 				{
-					date: new Day(2019, 1, 2),
+					date: new Day(2020, 1, 2),
 					snapshot: {
 						open: new Decimal(0)
 					},
@@ -468,9 +473,9 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges.length).toEqual(1);
 		});
 
-		it('the first range should be from 12-31-2018 to 12-31-2019', () => {
-			expect(ranges[0].start.format()).toEqual('2018-12-31');
-			expect(ranges[0].end.format()).toEqual('2019-12-31');
+		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');
 		});
 	});