@barchart/portfolio-api-common 1.0.231 → 1.0.235

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.0.231",
+  "version": "1.0.235",
   "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'),
@@ -462,9 +462,10 @@ module.exports = (() => {
 	 * @param {Boolean} income
 	 * @param {Boolean} opening
 	 * @param {Boolean} closing
+	 * @param {Boolean} fee
 	 */
 	class TransactionType extends Enum {
-		constructor(code, description, display, purchase, sale, income, opening, closing) {
+		constructor(code, description, display, purchase, sale, income, opening, closing, fee) {
 			super(code, description);
 
 			assert.argumentIsRequired(display, 'display', String);
@@ -473,6 +474,7 @@ module.exports = (() => {
 			assert.argumentIsRequired(income, 'income', Boolean);
 			assert.argumentIsRequired(opening, 'opening', Boolean);
 			assert.argumentIsRequired(closing, 'closing', Boolean);
+			assert.argumentIsRequired(fee, 'fee', Boolean);
 
 			this._display = display;
 			this._purchase = purchase;
@@ -480,6 +482,7 @@ module.exports = (() => {
 			this._income = income;
 			this._opening = opening;
 			this._closing = closing;
+			this._fee = fee
 		}
 
 		/**
@@ -503,7 +506,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Indicates if the trade was a purchase.
+		 * Indicates if the transaction was a purchase.
 		 *
 		 * @public
 		 * @returns {Boolean}
@@ -513,7 +516,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Indicates if the trade was a sale.
+		 * Indicates if the transaction was a sale.
 		 *
 		 * @public
 		 * @returns {Boolean}
@@ -533,7 +536,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Indicates if the transactions opens the position (i.e. increases its
+		 * Indicates if the transaction opens the position (i.e. increases its
 		 * magnitude).
 		 *
 		 * @public
@@ -544,7 +547,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Indicates if the transactions closes the position (i.e. decreases its
+		 * Indicates if the transaction closes the position (i.e. decreases its
 		 * magnitude).
 		 *
 		 * @public
@@ -554,6 +557,17 @@ module.exports = (() => {
 			return this._closing;
 		}
 
+		/**
+		 * Indicates if the transaction is a chart that neither opens nor
+		 * closes the position.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get fee() {
+			return this._fee;
+		}
+
 		/**
 		 * A purchase.
 		 *
@@ -757,27 +771,27 @@ module.exports = (() => {
 		}
 	}
 
-	const buy = new TransactionType('B', 'Buy', 'Buy', true, false, false, true,  false);
-	const sell = new TransactionType('S', 'Sell', 'Sell', false, true, false, false, true);
-	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', true, false, false, false, true);
-	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', false, true, false, true, false);
-	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', false, false, true, false, false);
-	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', false, false, false, true, false);
-	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', false, false, false, true, false);
-	const split = new TransactionType('SP', 'Split', 'Split', false, false, false, true, false);
-	const fee = new TransactionType('F', 'Fee', 'Fee', false, false, false, true, false);
-	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, false);
+	const buy = new TransactionType('B', 'Buy', 'Buy', true, false, false, true,  false, false);
+	const sell = new TransactionType('S', 'Sell', 'Sell', false, true, false, false, true, false);
+	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', true, false, false, false, true, false);
+	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', false, true, false, true, false, false);
+	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', false, false, true, false, false, false);
+	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', false, false, false, true, false, false);
+	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', false, false, false, true, false, false);
+	const split = new TransactionType('SP', 'Split', 'Split', false, false, false, true, false, false);
+	const fee = new TransactionType('F', 'Fee', 'Fee', false, false, false, false, false, true);
+	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, true, false);
 
-	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false);
-	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false);
+	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false, false);
+	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false, false);
 
-	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, false, false);
-	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', false, false, false, false, false);
-	const debit = new TransactionType('DR', 'Debit', 'Debit', false, false, false, false, false);
-	const credit = new TransactionType('CR', 'Credit', 'Credit', false, false, false, false, false);
+	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, false, false, false);
+	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', false, false, false, false, false, false);
+	const debit = new TransactionType('DR', 'Debit', 'Debit', false, false, false, false, false, false);
+	const credit = new TransactionType('CR', 'Credit', 'Credit', false, false, false, false, false, false);
 
-	const valuation = new TransactionType('V', 'Valuation', 'Valuation', false, false, false, false, false);
-	const income = new TransactionType('I', 'Income', 'Income', false, false, true, false, false);
+	const valuation = new TransactionType('V', 'Valuation', 'Valuation', false, false, false, false, false, false);
+	const income = new TransactionType('I', 'Income', 'Income', false, false, true, false, false, false);
 
 	return TransactionType;
 })();
@@ -858,7 +872,7 @@ module.exports = (() => {
 			}, { });
 
 			this._previousSummaryFrame = PositionSummaryFrame.YEARLY;
-			this._previousSummaryRanges = this._previousSummaryFrame.getRecentRanges(0);
+			this._previousSummaryRanges = this._previousSummaryFrame.getRecentRanges(1);
 
 			this._summariesPrevious = summaries.reduce((map, summary) => {
 				addSummaryPrevious(map, summary, this._previousSummaryFrame, this._previousSummaryRanges);
@@ -1807,6 +1821,7 @@ module.exports = (() => {
 			this._dataActual.total = null;
 			this._dataActual.summaryTotalCurrent = null;
 			this._dataActual.summaryTotalPrevious = null;
+			this._dataActual.summaryTotalPrevious2 = null;
 			this._dataActual.cashTotal = null;
 
 			this._dataFormat.currentPrice = null;
@@ -1828,6 +1843,8 @@ module.exports = (() => {
 			this._dataActual.summaryTotalCurrentNegative = false;
 			this._dataFormat.summaryTotalPrevious = null;
 			this._dataFormat.summaryTotalPreviousNegative = false;
+			this._dataFormat.summaryTotalPrevious2 = null;
+			this._dataFormat.summaryTotalPrevious2Negative = false;
 			this._dataFormat.cashTotal = null;
 			this._dataFormat.portfolioType = null;
 
@@ -2275,6 +2292,7 @@ module.exports = (() => {
 			updates.income = updates.income.add(translate(item, item.data.income));
 			updates.summaryTotalCurrent = updates.summaryTotalCurrent.add(translate(item, item.data.summaryTotalCurrent));
 			updates.summaryTotalPrevious = updates.summaryTotalPrevious.add(translate(item, item.data.summaryTotalPrevious));
+			updates.summaryTotalPrevious2 = updates.summaryTotalPrevious2.add(translate(item, item.data.summaryTotalPrevious2));
 
 			if (item.position.instrument.type === InstrumentType.CASH) {
 				updates.cashTotal = updates.cashTotal.add(translate(item, item.data.market));
@@ -2288,6 +2306,7 @@ module.exports = (() => {
 			income: Decimal.ZERO,
 			summaryTotalCurrent: Decimal.ZERO,
 			summaryTotalPrevious: Decimal.ZERO,
+			summaryTotalPrevious2: Decimal.ZERO,
 			cashTotal: Decimal.ZERO
 		});
 
@@ -2297,6 +2316,7 @@ module.exports = (() => {
 		actual.income = updates.income;
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
 		actual.summaryTotalPrevious = updates.summaryTotalPrevious;
+		actual.summaryTotalPrevious2 = updates.summaryTotalPrevious2;
 		actual.cashTotal = updates.cashTotal;
 
 		format.basis = formatCurrency(actual.basis, currency);
@@ -2306,6 +2326,8 @@ module.exports = (() => {
 		format.summaryTotalCurrent = formatCurrency(updates.summaryTotalCurrent, currency);
 		format.summaryTotalPrevious = formatCurrency(updates.summaryTotalPrevious, currency);
 		format.summaryTotalPreviousNegative = updates.summaryTotalPrevious.getIsNegative();
+		format.summaryTotalPrevious2 = formatCurrency(updates.summaryTotalPrevious2, currency);
+		format.summaryTotalPrevious2Negative = updates.summaryTotalPrevious2.getIsNegative();
 		format.cashTotal = formatCurrency(updates.cashTotal, currency);
 
 		calculateUnrealizedPercent(group);
@@ -2489,8 +2511,7 @@ module.exports = (() => {
 })();
 
 },{"./../data/InstrumentType":1,"./definitions/PositionLevelDefinition":7,"./definitions/PositionLevelType":8,"@barchart/common-js/collections/specialized/DisposableStack":14,"@barchart/common-js/lang/Currency":15,"@barchart/common-js/lang/Decimal":17,"@barchart/common-js/lang/Disposable":18,"@barchart/common-js/lang/Rate":20,"@barchart/common-js/lang/array":21,"@barchart/common-js/lang/assert":22,"@barchart/common-js/lang/formatter":23,"@barchart/common-js/lang/is":24,"@barchart/common-js/messaging/Event":26}],6:[function(require,module,exports){
-const array = require('@barchart/common-js/lang/array'),
-	assert = require('@barchart/common-js/lang/assert'),
+const assert = require('@barchart/common-js/lang/assert'),
 	Currency = require('@barchart/common-js/lang/Currency'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
 	Disposable = require('@barchart/common-js/lang/Disposable'),
@@ -2550,6 +2571,7 @@ module.exports = (() => {
 			this._data.summaryTotalCurrentChange = null;
 
 			this._data.summaryTotalPrevious = null;
+			this._data.summaryTotalPrevious2 = null;
 
 			this._data.realized = null;
 			this._data.income = null;
@@ -2809,7 +2831,8 @@ module.exports = (() => {
 		data.income = snapshot.income;
 
 		data.summaryTotalCurrent = calculateSummaryTotal(item.currentSummary);
-		data.summaryTotalPrevious = calculateSummaryTotal(array.last(previousSummaries));
+		data.summaryTotalPrevious = calculateSummaryTotal(getPreviousSummary(previousSummaries, 1));
+		data.summaryTotalPrevious2 = calculateSummaryTotal(getPreviousSummary(previousSummaries, 2));
 
 		if (snapshot.open.getIsZero()) {
 			data.basisPrice = Decimal.ZERO;
@@ -2930,10 +2953,24 @@ module.exports = (() => {
 		return returnRef;
 	}
 
+	function getPreviousSummary(previousSummaries, count) {
+		const index = previousSummaries.length - count;
+
+		let summary;
+
+		if (!(index < 0)) {
+			summary = previousSummaries[index];
+		} else {
+			summary = null;
+		}
+
+		return summary;
+	}
+
 	return PositionItem;
 })();
 
-},{"./../data/InstrumentType":1,"@barchart/common-js/lang/Currency":15,"@barchart/common-js/lang/Decimal":17,"@barchart/common-js/lang/Disposable":18,"@barchart/common-js/lang/array":21,"@barchart/common-js/lang/assert":22,"@barchart/common-js/lang/is":24,"@barchart/common-js/messaging/Event":26}],7:[function(require,module,exports){
+},{"./../data/InstrumentType":1,"@barchart/common-js/lang/Currency":15,"@barchart/common-js/lang/Decimal":17,"@barchart/common-js/lang/Disposable":18,"@barchart/common-js/lang/assert":22,"@barchart/common-js/lang/is":24,"@barchart/common-js/messaging/Event":26}],7:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
 	Currency = require('@barchart/common-js/lang/Currency'),
 	is = require('@barchart/common-js/lang/is');
@@ -3479,31 +3516,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;
@@ -3604,23 +3624,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.
@@ -5015,20 +5018,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.
     *
@@ -5043,20 +5032,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.
     *
@@ -5256,9 +5231,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;
@@ -5719,10 +5694,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';
@@ -5902,7 +5879,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;
 
@@ -5912,10 +5894,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;
 					});
@@ -5966,7 +5944,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'),
@@ -6343,26 +6321,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);
-			}
 		}
 	};
 }();