@barchart/portfolio-api-common 1.0.254 → 1.0.258

package/lib/api/failures/PortfolioFailureType.js

@@ -120,6 +120,17 @@ module.exports = (() => {
 			return transactionDeleteFailedNoTransaction;
 		}
 
+		/**
+		 * Unable to delete, the position's direction would switch.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_DELETE_FAILED_DIRECTION_SWITCH_ON_REWRITE() {
+			return transactionDeleteFailedDirectionSwitchOnRewrite;
+		}
+
 		toString() {
 			return '[PortfolioFailureType]';
 		}
@@ -138,6 +149,7 @@ module.exports = (() => {
 
 	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.');
+	const transactionDeleteFailedDirectionSwitchOnRewrite = new FailureType('TRANSACTION_DELETE_FAILED_DIRECTION_SWITCH_ON_REWRITE', 'Deleting this transaction would cause your history to be re-written and the position to switch from long to short (i.e. positive to negative) or vice versa.');
 
 	return PortfolioFailureType;
 })();

package/lib/processing/PositionGroup.js

@@ -495,18 +495,61 @@ module.exports = (() => {
 			calculatePriceData(this, this._container.getForexQuotes(), sender, false);
 		});
 
+		let fundamentalBinding = item.registerFundamentalDataChangeHandler((data, sender) => {
+			if (this._single) {
+				this._dataFormat.fundamental = data;
+			} else {
+				const fundamentalFields = [ 'percentChange1m', 'percentChange1y', 'percentChange3m', 'percentChangeYtd' ];
+
+				const fundamentalData = this.items.reduce((sums, item, i) => {
+					if (item.data && item.data.fundamental && item.data.fundamental.raw) {
+						const fundamental = item.data.fundamental.raw;
+
+						fundamentalFields.forEach((fieldName) => {
+							const summary = sums[fieldName];
+							const value = fundamental[fieldName];
+
+							if (is.number(value)) {
+								summary.total = sums[fieldName].total + value;
+								summary.count = sums[fieldName].count + 1;
+							}
+
+							if ((i + 1) == this.items.length) {
+								let averageFormat;
+
+								if (summary.count > 0) {
+									averageFormat = formatPercent(new Decimal(summary.total / summary.count), 2, true);
+								} else {
+									averageFormat = '--';
+								}
+
+								summary.averageFormat = averageFormat;
+							}
+						});
+					}
+
+					return sums;
+				}, fundamentalFields.reduce((sums, fieldName) => {
+					sums[fieldName] = { total: 0, count: 0, averageFormat: '--' };
+
+					return sums;
+				}, { }));
+
+				this._dataFormat.fundamental = fundamentalFields.reduce((sums, fieldName) => {
+					sums[fieldName] = fundamentalData[fieldName].averageFormat;
+
+					return sums;
+				}, { });
+			}
+		});
+
 		let newsBinding = Disposable.getEmpty();
-		let fundamentalBinding = Disposable.getEmpty();
 
 		if (this._single) {
 			newsBinding = item.registerNewsExistsChangeHandler((exists, sender) => {
 				this._dataActual.newsExists = exists;
 				this._dataFormat.newsExists = exists;
 			});
-
-			fundamentalBinding = item.registerFundamentalDataChangeHandler((data, sender) => {
-				this._dataFormat.fundamental = data;
-			});
 		}
 
 		this._disposeStack.push(item.registerPortfolioChangeHandler((portfolio, sender) => {
@@ -553,9 +596,17 @@ module.exports = (() => {
 		}
 	}
 
-	function formatPercent(decimal, precision) {
+	function formatPercent(decimal, precision, plus) {
 		if (decimal !== null) {
-			return formatDecimal(decimal.multiply(100), precision) + '%';
+			let prefix;
+
+			if (is.boolean(plus) && plus && !Decimal.getIsNegative(decimal)) {
+				prefix = '+';
+			} else {
+				prefix = '';
+			}
+
+			return `${prefix}${formatDecimal(decimal.multiply(100), precision)}%`;
 		} else {
 			return '—';
 		}
@@ -730,7 +781,7 @@ module.exports = (() => {
 		actual.unrealized = updates.unrealized;
 		actual.unrealizedToday = updates.unrealizedToday;
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
-		actual.total = updates.unrealizedToday.add(actual.realized).add(actual.income);
+		actual.total = updates.unrealized.add(actual.realized).add(actual.income);
 		
 		format.market = formatCurrency(actual.market, currency);
 		

package/package.json

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

package/test/SpecRunner.js

@@ -2252,18 +2252,61 @@ module.exports = (() => {
 			calculatePriceData(this, this._container.getForexQuotes(), sender, false);
 		});
 
+		let fundamentalBinding = item.registerFundamentalDataChangeHandler((data, sender) => {
+			if (this._single) {
+				this._dataFormat.fundamental = data;
+			} else {
+				const fundamentalFields = [ 'percentChange1m', 'percentChange1y', 'percentChange3m', 'percentChangeYtd' ];
+
+				const fundamentalData = this.items.reduce((sums, item, i) => {
+					if (item.data && item.data.fundamental && item.data.fundamental.raw) {
+						const fundamental = item.data.fundamental.raw;
+
+						fundamentalFields.forEach((fieldName) => {
+							const summary = sums[fieldName];
+							const value = fundamental[fieldName];
+
+							if (is.number(value)) {
+								summary.total = sums[fieldName].total + value;
+								summary.count = sums[fieldName].count + 1;
+							}
+
+							if ((i + 1) == this.items.length) {
+								let averageFormat;
+
+								if (summary.count > 0) {
+									averageFormat = formatPercent(new Decimal(summary.total / summary.count), 2, true);
+								} else {
+									averageFormat = '--';
+								}
+
+								summary.averageFormat = averageFormat;
+							}
+						});
+					}
+
+					return sums;
+				}, fundamentalFields.reduce((sums, fieldName) => {
+					sums[fieldName] = { total: 0, count: 0, averageFormat: '--' };
+
+					return sums;
+				}, { }));
+
+				this._dataFormat.fundamental = fundamentalFields.reduce((sums, fieldName) => {
+					sums[fieldName] = fundamentalData[fieldName].averageFormat;
+
+					return sums;
+				}, { });
+			}
+		});
+
 		let newsBinding = Disposable.getEmpty();
-		let fundamentalBinding = Disposable.getEmpty();
 
 		if (this._single) {
 			newsBinding = item.registerNewsExistsChangeHandler((exists, sender) => {
 				this._dataActual.newsExists = exists;
 				this._dataFormat.newsExists = exists;
 			});
-
-			fundamentalBinding = item.registerFundamentalDataChangeHandler((data, sender) => {
-				this._dataFormat.fundamental = data;
-			});
 		}
 
 		this._disposeStack.push(item.registerPortfolioChangeHandler((portfolio, sender) => {
@@ -2310,9 +2353,17 @@ module.exports = (() => {
 		}
 	}
 
-	function formatPercent(decimal, precision) {
+	function formatPercent(decimal, precision, plus) {
 		if (decimal !== null) {
-			return formatDecimal(decimal.multiply(100), precision) + '%';
+			let prefix;
+
+			if (is.boolean(plus) && plus && !Decimal.getIsNegative(decimal)) {
+				prefix = '+';
+			} else {
+				prefix = '';
+			}
+
+			return `${prefix}${formatDecimal(decimal.multiply(100), precision)}%`;
 		} else {
 			return '—';
 		}
@@ -2487,7 +2538,7 @@ module.exports = (() => {
 		actual.unrealized = updates.unrealized;
 		actual.unrealizedToday = updates.unrealizedToday;
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
-		actual.total = updates.unrealizedToday.add(actual.realized).add(actual.income);
+		actual.total = updates.unrealized.add(actual.realized).add(actual.income);
 		
 		format.market = formatCurrency(actual.market, currency);