@barchart/portfolio-api-common 1.0.269 → 1.2.0

package/lib/api/failures/PortfolioFailureType.js

@@ -23,6 +23,17 @@ module.exports = (() => {
 			return portfolioUpdateFailedNoPortfolio;
 		}
 
+		/**
+		 * The portfolio does not exist.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get PORTFOLIO_DELETE_FAILED_NO_PORTFOLIO() {
+			return portfolioDeleteFailedNoPortfolio;
+		}
+
 		/**
 		 * The portfolio does not exist.
 		 *
@@ -136,7 +147,8 @@ module.exports = (() => {
 		}
 	}
 
-	const portfolioUpdateFailedNoPortfolio = new FailureType('PORTFOLIO_UPDATED_FAILED_NO_PORTFOLIO', 'Unable to update portfolio. The portfolio does not exist, has it been deleted?');
+	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 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?');

package/lib/data/TransactionValidator.js

@@ -1,5 +1,5 @@
 const assert = require('@barchart/common-js/lang/assert'),
-	array = require('@barchart/common-js/lang/array')
+	array = require('@barchart/common-js/lang/array');
 
 const InstrumentType = require('./InstrumentType'),
 	PositionDirection = require('./PositionDirection'),
@@ -25,22 +25,12 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {Array.<Object>} transactions
-		 * @param {Boolean=} partial - If true, sequence validation starts with the array's first transaction.
 		 * @return {boolean}
 		 */
-		static validateOrder(transactions, partial) {
+		static validateOrder(transactions) {
 			assert.argumentIsArray(transactions, 'transactions');
-			assert.argumentIsOptional(partial, 'partial', Boolean);
 
-			let startSequence;
-
-			if (partial && transactions.length !== 0) {
-				startSequence = array.first(transactions).sequence;
-			} else {
-				startSequence = 1;
-			}
-
-			return transactions.every((t, i) => t.sequence === (i + startSequence) && (i === 0 || !t.date.getIsBefore(transactions[i - 1].date)));
+			return transactions.every((t, i) => t.sequence === (i + 1) && (i === 0 || !t.date.getIsBefore(transactions[i - 1].date)));
 		}
 
 		/**

package/lib/processing/PositionContainer.js

@@ -410,7 +410,7 @@ module.exports = (() => {
 						}
 
 						Object.keys(this._trees).forEach((key) => {
-							this._trees[key].walk(group => group.setForexRates(this._forexQuotes), true, false)
+							this._trees[key].walk(group => group.setForexRates(this._forexQuotes), true, false);
 						});
 
 						recalculatePercentages.call(this);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.0.269",
+  "version": "1.2.0",
   "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'),
@@ -957,7 +957,7 @@ module.exports = (() => {
 
 },{"@barchart/common-js/lang/Enum":21,"@barchart/common-js/lang/assert":24}],5:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
-	array = require('@barchart/common-js/lang/array')
+	array = require('@barchart/common-js/lang/array');
 
 const InstrumentType = require('./InstrumentType'),
 	PositionDirection = require('./PositionDirection'),
@@ -983,22 +983,12 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {Array.<Object>} transactions
-		 * @param {Boolean=} partial - If true, sequence validation starts with the array's first transaction.
 		 * @return {boolean}
 		 */
-		static validateOrder(transactions, partial) {
+		static validateOrder(transactions) {
 			assert.argumentIsArray(transactions, 'transactions');
-			assert.argumentIsOptional(partial, 'partial', Boolean);
 
-			let startSequence;
-
-			if (partial && transactions.length !== 0) {
-				startSequence = array.first(transactions).sequence;
-			} else {
-				startSequence = 1;
-			}
-
-			return transactions.every((t, i) => t.sequence === (i + startSequence) && (i === 0 || !t.date.getIsBefore(transactions[i - 1].date)));
+			return transactions.every((t, i) => t.sequence === (i + 1) && (i === 0 || !t.date.getIsBefore(transactions[i - 1].date)));
 		}
 
 		/**
@@ -1566,7 +1556,7 @@ module.exports = (() => {
 						}
 
 						Object.keys(this._trees).forEach((key) => {
-							this._trees[key].walk(group => group.setForexRates(this._forexQuotes), true, false)
+							this._trees[key].walk(group => group.setForexRates(this._forexQuotes), true, false);
 						});
 
 						recalculatePercentages.call(this);
@@ -3961,31 +3951,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;
@@ -4086,23 +4059,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.
@@ -4207,33 +4163,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.
     *
@@ -5524,20 +5453,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.
     *
@@ -5552,20 +5467,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.
     *
@@ -5765,9 +5666,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;
@@ -6228,10 +6129,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';
@@ -6411,7 +6314,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;
 
@@ -6421,10 +6329,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;
 					});
@@ -6475,7 +6379,7 @@ module.exports = function () {
 	return Rate;
 }();
 
-},{"./Currency":17,"./Decimal":19,"./assert":24,"./memoize":27}],23:[function(require,module,exports){
+},{"./Currency":17,"./Decimal":19,"./Enum":21,"./assert":24,"./is":26,"./memoize":27}],23:[function(require,module,exports){
 'use strict';
 
 var assert = require('./assert'),
@@ -6852,26 +6756,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);
-			}
 		}
 	};
 }();
@@ -9103,14 +8987,6 @@ describe('When validating transaction order', () => {
 	it('An array of transactions with ordered sequences, on the reversed days should not be valid', () => {
 		expect(TransactionValidator.validateOrder([ build(1, '2018-05-02'), build(2, '2018-05-01'), build(3, '2018-04-30') ])).toEqual(false);
 	});
-
-	it('A partial array of transactions with ordered sequences (starting after one), on the same day should be valid', () => {
-		expect(TransactionValidator.validateOrder([ build(3, '2018-04-30'), build(4, '2018-04-30'), build(5, '2018-04-30') ], true)).toEqual(true);
-	});
-
-	it('A partial array of transactions with gap in sequences (starting after one), on the same day should be not valid', () => {
-		expect(TransactionValidator.validateOrder([ build(3, '2018-04-30'), build(5, '2018-04-30'), build(6, '2018-04-30') ], true)).toEqual(false);
-	});
 });
 
 },{"./../../../lib/data/TransactionValidator":5,"@barchart/common-js/lang/Day":18}],37:[function(require,module,exports){

package/test/specs/data/TransactionValidatorSpec.js

@@ -40,12 +40,4 @@ describe('When validating transaction order', () => {
 	it('An array of transactions with ordered sequences, on the reversed days should not be valid', () => {
 		expect(TransactionValidator.validateOrder([ build(1, '2018-05-02'), build(2, '2018-05-01'), build(3, '2018-04-30') ])).toEqual(false);
 	});
-
-	it('A partial array of transactions with ordered sequences (starting after one), on the same day should be valid', () => {
-		expect(TransactionValidator.validateOrder([ build(3, '2018-04-30'), build(4, '2018-04-30'), build(5, '2018-04-30') ], true)).toEqual(true);
-	});
-
-	it('A partial array of transactions with gap in sequences (starting after one), on the same day should be not valid', () => {
-		expect(TransactionValidator.validateOrder([ build(3, '2018-04-30'), build(5, '2018-04-30'), build(6, '2018-04-30') ], true)).toEqual(false);
-	});
 });