@barchart/portfolio-api-common 1.0.255 → 1.0.259

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 '—';
 		}
@@ -626,7 +677,7 @@ module.exports = (() => {
 		actual.cashTotal = updates.cashTotal;
 
 		format.basis = formatCurrency(actual.basis, currency);
-		format.realized = formatCurrency(actual.basis, currency);
+		format.realized = formatCurrency(actual.realized, currency);
 		format.unrealized = formatCurrency(actual.unrealized, currency);
 		format.income = formatCurrency(actual.income, currency);
 		format.summaryTotalCurrent = formatCurrency(updates.summaryTotalCurrent, currency);

package/package.json

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

package/test/SpecRunner.js

@@ -1,4 +1,4 @@
-(function(){function r(e,n,t){function o(i,f){if(!n[i]){if(!e[i]){var c="function"==typeof require&&require;if(!f&&c)return c(i,!0);if(u)return u(i,!0);var a=new Error("Cannot find module '"+i+"'");throw a.code="MODULE_NOT_FOUND",a}var p=n[i]={exports:{}};e[i][0].call(p.exports,function(r){var n=e[i][1][r];return o(n||r)},p,p.exports,r,e,n,t)}return n[i].exports}for(var u="function"==typeof require&&require,i=0;i<t.length;i++)o(t[i]);return o}return r})()({1:[function(require,module,exports){
+(function(){function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s}return e})()({1:[function(require,module,exports){
 const uuid = require('uuid');
 
 const assert = require('@barchart/common-js/lang/assert'),
@@ -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 '—';
 		}
@@ -2383,7 +2434,7 @@ module.exports = (() => {
 		actual.cashTotal = updates.cashTotal;
 
 		format.basis = formatCurrency(actual.basis, currency);
-		format.realized = formatCurrency(actual.basis, currency);
+		format.realized = formatCurrency(actual.realized, currency);
 		format.unrealized = formatCurrency(actual.unrealized, currency);
 		format.income = formatCurrency(actual.income, currency);
 		format.summaryTotalCurrent = formatCurrency(updates.summaryTotalCurrent, currency);
@@ -3584,31 +3635,14 @@ module.exports = function () {
 		}
 
 		/**
-   * Gets the root node.
+   * Returns the parent node. If this is the root node, a null value is returned.
    *
    * @public
-   * @returns {Tree}
+   * @returns {Tree|null}
    */
 
 
 		_createClass(Tree, [{
-			key: 'getRoot',
-			value: function getRoot() {
-				if (this.getIsRoot()) {
-					return this;
-				} else {
-					return this._parent.getRoot();
-				}
-			}
-
-			/**
-    * Returns the parent node. If this is the root node, a null value is returned.
-    *
-    * @public
-    * @returns {Tree|null}
-    */
-
-		}, {
 			key: 'getParent',
 			value: function getParent() {
 				return this._parent;
@@ -3709,23 +3743,6 @@ module.exports = function () {
 				}
 			}
 
-			/**
-    * Removes the current node from the parent tree. Use on a root node
-    * has no effect.
-    *
-    * @public
-    */
-
-		}, {
-			key: 'sever',
-			value: function sever() {
-				if (this.getIsRoot()) {
-					return;
-				}
-
-				this.getParent().removeChild(this);
-			}
-
 			/**
     * Searches the children nodes for the first child node that matches the
     * predicate.
@@ -3830,33 +3847,6 @@ module.exports = function () {
 				}
 			}
 
-			/**
-    * Climbs the tree, evaluating each parent until a predicate is matched. Once matched,
-    * the {@link Tree} node is returned. Otherwise, if the predicate cannot be matched,
-    * a null value is returned.
-    *
-    * @public
-    * @param {Tree~nodePredicate} predicate - A predicate that tests each child node. The predicate takes two arguments -- the node's value, and the node itself.
-    * @param {boolean=} includeCurrentNode - If true, the predicate will be applied to the current node.
-    * @returns {Tree|null}
-    */
-
-		}, {
-			key: 'findParent',
-			value: function findParent(predicate, includeCurrentNode) {
-				var returnRef = void 0;
-
-				if (is.boolean(includeCurrentNode) && includeCurrentNode && predicate(this.getValue(), this)) {
-					returnRef = this;
-				} else if (this._parent !== null) {
-					returnRef = this._parent.findParent(predicate, true);
-				} else {
-					returnRef = null;
-				}
-
-				return returnRef;
-			}
-
 			/**
     * Creates a representation of the tree using JavaScript objects and arrays.
     *
@@ -5147,20 +5137,6 @@ module.exports = function () {
 				return this._big.gt(getBig(other));
 			}
 
-			/**
-    * Returns true if the current instance is greater than or equal to the value.
-    *
-    * @public
-    * @param {Decimal|Number|String} other - The value to compare.
-    * @returns {Boolean}
-    */
-
-		}, {
-			key: 'getIsGreaterThanOrEqual',
-			value: function getIsGreaterThanOrEqual(other) {
-				return this._big.gte(getBig(other));
-			}
-
 			/**
     * Returns true if the current instance is less than the value.
     *
@@ -5175,20 +5151,6 @@ module.exports = function () {
 				return this._big.lt(getBig(other));
 			}
 
-			/**
-    * Returns true if the current instance is less than or equal to the value.
-    *
-    * @public
-    * @param {Decimal|Number|String} other - The value to compare.
-    * @returns {Boolean}
-    */
-
-		}, {
-			key: 'getIsLessThanOrEqual',
-			value: function getIsLessThanOrEqual(other) {
-				return this._big.lte(getBig(other));
-			}
-
 			/**
     * Returns true if the current instance is equal to the value.
     *
@@ -5388,9 +5350,9 @@ module.exports = function () {
 				assert.argumentIsRequired(a, 'a', Decimal, 'Decimal');
 				assert.argumentIsRequired(b, 'b', Decimal, 'Decimal');
 
-				if (a._big.gt(b._big)) {
+				if (a._big.gt(b)) {
 					return 1;
-				} else if (a._big.lt(b._big)) {
+				} else if (a._big.lt(b)) {
 					return -1;
 				} else {
 					return 0;
@@ -5851,10 +5813,12 @@ var _createClass = function () { function defineProperties(target, props) { for
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
 var assert = require('./assert'),
+    is = require('./is'),
     memoize = require('./memoize');
 
 var Currency = require('./Currency'),
-    Decimal = require('./Decimal');
+    Decimal = require('./Decimal'),
+    Enum = require('./Enum');
 
 module.exports = function () {
 	'use strict';
@@ -6034,7 +5998,12 @@ module.exports = function () {
 				assert.argumentIsRequired(amount, 'amount', Decimal, 'Decimal');
 				assert.argumentIsRequired(currency, 'currency', Currency, 'Currency');
 				assert.argumentIsRequired(desiredCurrency, 'desiredCurrency', Currency, 'Currency');
-				//assert.argumentIsArray(rates, 'rates', Rate, 'Rate');
+
+				for (var _len = arguments.length, rates = Array(_len > 3 ? _len - 3 : 0), _key = 3; _key < _len; _key++) {
+					rates[_key - 3] = arguments[_key];
+				}
+
+				assert.argumentIsArray(rates, 'rates', Rate, 'Rate');
 
 				var converted = void 0;
 
@@ -6044,10 +6013,6 @@ module.exports = function () {
 					var numerator = desiredCurrency;
 					var denominator = currency;
 
-					for (var _len = arguments.length, rates = Array(_len > 3 ? _len - 3 : 0), _key = 3; _key < _len; _key++) {
-						rates[_key - 3] = arguments[_key];
-					}
-
 					var rate = rates.find(function (r) {
 						return r.numerator === numerator && r.denominator === denominator || r.numerator === denominator && r.denominator === numerator;
 					});
@@ -6098,7 +6063,7 @@ module.exports = function () {
 	return Rate;
 }();
 
-},{"./Currency":15,"./Decimal":17,"./assert":22,"./memoize":25}],21:[function(require,module,exports){
+},{"./Currency":15,"./Decimal":17,"./Enum":19,"./assert":22,"./is":24,"./memoize":25}],21:[function(require,module,exports){
 'use strict';
 
 var assert = require('./assert'),
@@ -6475,26 +6440,6 @@ module.exports = function () {
 			});
 
 			return returnRef;
-		},
-
-
-		/**
-   * Removes the first item from an array which matches a predicate.
-   *
-   * @static
-   * @public
-   * @param {Array} a
-   * @param {Function} predicate
-   */
-		remove: function remove(a, predicate) {
-			assert.argumentIsArray(a, 'a');
-			assert.argumentIsRequired(predicate, 'predicate', Function);
-
-			var index = a.findIndex(predicate);
-
-			if (!(index < 0)) {
-				a.splice(index, 1);
-			}
 		}
 	};
 }();