@barchart/portfolio-api-common 1.0.235 → 1.0.239

package/lib/api/failures/PortfolioFailureType.js

@@ -23,6 +23,17 @@ module.exports = (() => {
 			return positionCreateFailedNoPortfolio;
 		}
 
+		/**
+		 * The referenced position does not exist.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_NO_POSITION() {
+			return transactionCreateFailedNoPosition;
+		}
+
 		/**
 		 * The transaction would occur before an existing transaction.
 		 *
@@ -94,6 +105,7 @@ module.exports = (() => {
 
 	const positionCreateFailedNoPortfolio = new FailureType('POSITION_CREATE_FAILED_NO_PORTFOLIO', 'Unable to create transaction. The referenced portfolio 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?');
 	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 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.');
 	const transactionCreateFailedTypeInvalidForDirection = new FailureType('TRANSACTION_CREATE_FAILED_TYPE_INVALID_FOR_DIRECTION', 'Unable to process transaction, a {L|positionDirection.description} position would be created (i.e. you would have {L|positionDirection.sign} shares/units). {u|instrumentType.description} positions cannot have {L|positionDirection.description} positions.');

package/lib/formatters/TransactionFormatter.js

@@ -27,7 +27,7 @@ module.exports = (() => {
 		 * @static
 		 * @param {Array<Object>} transactions
 		 * @param {Array<Object>} positions
-		 * @param {Boolean=} append
+		 * @param {Boolean=} append - Warning, if true, the transaction array will be mutated.
 		 * @returns {Array}
 		 */
 		static format(transactions, positions, append) {
@@ -36,7 +36,11 @@ module.exports = (() => {
 			assert.argumentIsOptional(append, 'append', Boolean);
 
 			const instruments = positions.reduce((map, p) => {
-				map[p.position] = p.instrument;
+				const instrument = Object.assign({ }, p.instrument || { });
+
+				delete instrument.id;
+
+				map[p.position] = instrument;
 
 				return map;
 			}, { });
@@ -45,9 +49,8 @@ module.exports = (() => {
 				const position = transaction.position;
 
 				if (instruments.hasOwnProperty(position)) {
-					transaction.instrument = instruments[position];
-
-					let formatted = getBasicTransaction(transaction);
+					let instrument = instruments[position];
+					let formatted = getBasicTransaction(transaction, instrument);
 
 					if (formatters.has(transaction.type)) {
 						const formatterFunction = formatters.get(transaction.type);
@@ -55,7 +58,7 @@ module.exports = (() => {
 
 						Object.keys(formattedTransaction).map((key) => {
 							if (!is.undefined(formattedTransaction[key]) && formattedTransaction[key] instanceof Decimal) {
-								const precision = transaction.instrument.currency.precision;
+								const precision = instrument.currency.precision;
 
 								formattedTransaction[key] = formatter.numberToString(formattedTransaction[key].toFloat(), precision, ',');
 							}
@@ -86,20 +89,14 @@ module.exports = (() => {
 		}
 	}
 
-	const getBasicTransaction = (t) => {
-		const basic = {
+	const getBasicTransaction = (t, i) => {
+		return {
 			date: t.date,
 			type: t.type.display,
 			sequence: t.sequence,
-			instrument: t.instrument,
+			instrument: i,
 			position: t.position
 		};
-
-		if (basic.instrument) {
-			delete basic.instrument.id;
-		}
-
-		return basic;
 	};
 
 	const formatters = new Map();
@@ -170,6 +167,7 @@ module.exports = (() => {
 
 	formatters.set(TransactionType.FEE, (t) => {
 		return {
+			fee: t.charge.amount,
 			total: t.charge.amount
 		};
 	});

package/package.json

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

package/test/SpecRunner.js

@@ -1,4 +1,4 @@
-(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){
+(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){
 const uuid = require('uuid');
 
 const assert = require('@barchart/common-js/lang/assert'),
@@ -3516,14 +3516,31 @@ module.exports = function () {
 		}
 
 		/**
-   * Returns the parent node. If this is the root node, a null value is returned.
+   * Gets the root node.
    *
    * @public
-   * @returns {Tree|null}
+   * @returns {Tree}
    */
 
 
 		_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;
@@ -3624,6 +3641,23 @@ 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.
@@ -5018,6 +5052,20 @@ 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.
     *
@@ -5032,6 +5080,20 @@ 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.
     *
@@ -5231,9 +5293,9 @@ module.exports = function () {
 				assert.argumentIsRequired(a, 'a', Decimal, 'Decimal');
 				assert.argumentIsRequired(b, 'b', Decimal, 'Decimal');
 
-				if (a._big.gt(b)) {
+				if (a._big.gt(b._big)) {
 					return 1;
-				} else if (a._big.lt(b)) {
+				} else if (a._big.lt(b._big)) {
 					return -1;
 				} else {
 					return 0;
@@ -5694,12 +5756,10 @@ 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'),
-    Enum = require('./Enum');
+    Decimal = require('./Decimal');
 
 module.exports = function () {
 	'use strict';
@@ -5879,12 +5939,7 @@ module.exports = function () {
 				assert.argumentIsRequired(amount, 'amount', Decimal, 'Decimal');
 				assert.argumentIsRequired(currency, 'currency', Currency, 'Currency');
 				assert.argumentIsRequired(desiredCurrency, 'desiredCurrency', Currency, 'Currency');
-
-				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');
+				//assert.argumentIsArray(rates, 'rates', Rate, 'Rate');
 
 				var converted = void 0;
 
@@ -5894,6 +5949,10 @@ 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;
 					});
@@ -5944,7 +6003,7 @@ module.exports = function () {
 	return Rate;
 }();
 
-},{"./Currency":15,"./Decimal":17,"./Enum":19,"./assert":22,"./is":24,"./memoize":25}],21:[function(require,module,exports){
+},{"./Currency":15,"./Decimal":17,"./assert":22,"./memoize":25}],21:[function(require,module,exports){
 'use strict';
 
 var assert = require('./assert'),
@@ -6321,6 +6380,26 @@ 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);
+			}
 		}
 	};
 }();