@barchart/portfolio-api-common 1.3.14 → 1.3.18

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/serialization/PositionSummarySchema.js

@@ -54,6 +54,18 @@ module.exports = (() => {
 			return client;
 		}
 
+		/**
+		 * Reduced schema that only includes frames and dates -- allowing consumer
+		 * to detect existence (or non-existence) of summary.
+		 *
+		 * @static
+		 * @public
+		 * @returns {PositionSummarySchema}
+		 */
+		static get EXISTS() {
+			return exists;
+		}
+
 		toString() {
 			return '[PositionSummarySchema]';
 		}
@@ -111,5 +123,15 @@ module.exports = (() => {
 		.schema
 	);
 
+	const exists = new PositionSummarySchema(SchemaBuilder.withName('complete')
+		.withField('user', DataType.STRING)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
+		.withField('frame', DataType.forEnum(PositionSummaryFrame, 'PositionSummaryFrame'))
+		.withField('start.date', DataType.DAY)
+		.withField('end.date', DataType.DAY)
+		.schema
+	);
+
 	return PositionSummarySchema;
 })();

package/package.json

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