@barchart/portfolio-api-common 1.0.271 → 1.2.2

package/lib/data/TransactionValidator.js

@@ -19,18 +19,31 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Given a set of transaction, ensures that sequence numbers and dates
+		 * Given a set of transaction, ensures that all sequence numbers and dates
 		 * are properly ordered.
 		 *
 		 * @public
 		 * @static
 		 * @param {Array.<Object>} transactions
-		 * @return {boolean}
+		 * @return {Boolean}
 		 */
 		static validateOrder(transactions) {
+			return TransactionValidator.getInvalidIndex(transactions) < 0;
+		}
+
+		/**
+		 * Given a set of transaction, returns the index of the first transaction that with an invalid
+		 * sequence number or date.
+		 *
+		 * @public
+		 * @static
+		 * @param {Array.<Object>} transactions
+		 * @return {Number}
+		 */
+		static getInvalidIndex(transactions) {
 			assert.argumentIsArray(transactions, 'transactions');
 
-			return transactions.every((t, i) => t.sequence === (i + 1) && (i === 0 || !t.date.getIsBefore(transactions[i - 1].date)));
+			return transactions.findIndex((t, i) => t.sequence !== (i + 1) || (i !== 0 && t.date.getIsBefore(transactions[i - 1].date)));
 		}
 
 		/**

package/lib/serialization/PositionSchema.js

@@ -103,6 +103,7 @@ module.exports = (() => {
 		.withField('legacy.portfolio', DataType.STRING, true)
 		.withField('legacy.position', DataType.STRING, true)
 		.withField('system.version', DataType.NUMBER, true)
+		.withField('root', DataType.STRING, true)
 		.schema
 	);
 

package/package.json

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

package/test/SpecRunner.js

@@ -977,18 +977,31 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Given a set of transaction, ensures that sequence numbers and dates
+		 * Given a set of transaction, ensures that all sequence numbers and dates
 		 * are properly ordered.
 		 *
 		 * @public
 		 * @static
 		 * @param {Array.<Object>} transactions
-		 * @return {boolean}
+		 * @return {Boolean}
 		 */
 		static validateOrder(transactions) {
+			return TransactionValidator.getInvalidIndex(transactions) < 0;
+		}
+
+		/**
+		 * Given a set of transaction, returns the index of the first transaction that with an invalid
+		 * sequence number or date.
+		 *
+		 * @public
+		 * @static
+		 * @param {Array.<Object>} transactions
+		 * @return {Number}
+		 */
+		static getInvalidIndex(transactions) {
 			assert.argumentIsArray(transactions, 'transactions');
 
-			return transactions.every((t, i) => t.sequence === (i + 1) && (i === 0 || !t.date.getIsBefore(transactions[i - 1].date)));
+			return transactions.findIndex((t, i) => t.sequence !== (i + 1) || (i !== 0 && t.date.getIsBefore(transactions[i - 1].date)));
 		}
 
 		/**
@@ -6493,8 +6506,8 @@ module.exports = function () {
 		unique: function unique(a) {
 			assert.argumentIsArray(a, 'a');
 
-			return a.filter(function (item, index, array) {
-				return array.indexOf(item) === index;
+			return this.uniqueBy(a, function (item) {
+				return item;
 			});
 		},
 
@@ -6505,7 +6518,7 @@ module.exports = function () {
    *
    * @static
    * @param {Array} a
-   * @param {Function} keySelector - The function, when applied to an item yields a unique key.
+   * @param {Function} keySelector - A function that returns a unique key for an item.
    * @returns {Array}
    */
 		uniqueBy: function uniqueBy(a, keySelector) {
@@ -6523,12 +6536,12 @@ module.exports = function () {
 
 		/**
    * Splits array into groups and returns an object (where the properties have
-   * arrays). Unlike the indexBy function, there can be many items
-   * which share the same key.
+   * arrays). Unlike the indexBy function, there can be many items which share
+   * the same key.
    *
    * @static
    * @param {Array} a
-   * @param {Function} keySelector - The function, when applied to an item yields a key.
+   * @param {Function} keySelector - A function that returns a unique key for an item.
    * @returns {Object}
    */
 		groupBy: function groupBy(a, keySelector) {
@@ -6555,7 +6568,7 @@ module.exports = function () {
    *
    * @static
    * @param {Array} a
-   * @param {Function} keySelector - The function, when applied to an item yields a key.
+   * @param {Function} keySelector - A function that returns a unique key for an item.
    * @returns {Array}
    */
 		batchBy: function batchBy(a, keySelector) {
@@ -6584,12 +6597,11 @@ module.exports = function () {
 
 		/**
    * Splits array into groups and returns an object (where the properties are items from the
-   * original array). Unlike the groupBy, Only one item can have a given key
-   * value.
+   * original array). Unlike the groupBy, only one item can have a given key value.
    *
    * @static
    * @param {Array} a
-   * @param {Function} keySelector - The function, when applied to an item yields a unique key.
+   * @param {Function} keySelector - A function that returns a unique key for an item.
    * @returns {Object}
    */
 		indexBy: function indexBy(a, keySelector) {
@@ -6755,14 +6767,31 @@ module.exports = function () {
    * @returns {Array}
    */
 		difference: function difference(a, b) {
+			return this.differenceBy(a, b, function (item) {
+				return item;
+			});
+		},
+
+
+		/**
+   * Set difference operation, where the uniqueness is determined by a delegate.
+   *
+   * @static
+   * @param {Array} a
+   * @param {Array} b
+   * @param {Function} keySelector - A function that returns a unique key for an item.
+   * @returns {Array}
+   */
+		differenceBy: function differenceBy(a, b, keySelector) {
 			assert.argumentIsArray(a, 'a');
 			assert.argumentIsArray(b, 'b');
+			assert.argumentIsRequired(keySelector, 'keySelector', Function);
 
 			var returnRef = [];
 
 			a.forEach(function (candidate) {
 				var exclude = b.some(function (comparison) {
-					return candidate === comparison;
+					return keySelector(candidate) === keySelector(comparison);
 				});
 
 				if (!exclude) {
@@ -6785,7 +6814,23 @@ module.exports = function () {
    * @returns {Array}
    */
 		differenceSymmetric: function differenceSymmetric(a, b) {
-			return this.union(this.difference(a, b), this.difference(b, a));
+			return this.differenceSymmetricBy(a, b, function (item) {
+				return item;
+			});
+		},
+
+
+		/**
+   * Set symmetric difference operation, where the uniqueness is determined by a delegate.
+   *
+   * @static
+   * @param {Array} a
+   * @param {Array} b
+   * @param {Function} keySelector - A function that returns a unique key for an item.
+   * @returns {Array}
+   */
+		differenceSymmetricBy: function differenceSymmetricBy(a, b, keySelector) {
+			return this.unionBy(this.differenceBy(a, b, keySelector), this.differenceBy(b, a, keySelector), keySelector);
 		},
 
 
@@ -6798,14 +6843,31 @@ module.exports = function () {
    * @returns {Array}
    */
 		union: function union(a, b) {
+			return this.unionBy(a, b, function (item) {
+				return item;
+			});
+		},
+
+
+		/**
+   * Set union operation, where the uniqueness is determined by a delegate.
+   *
+   * @static
+   * @param {Array} a
+   * @param {Array} b
+   * @param {Function} keySelector - A function that returns a unique key for an item.
+   * @returns {Array}
+   */
+		unionBy: function unionBy(a, b, keySelector) {
 			assert.argumentIsArray(a, 'a');
 			assert.argumentIsArray(b, 'b');
+			assert.argumentIsRequired(keySelector, 'keySelector', Function);
 
 			var returnRef = a.slice();
 
 			b.forEach(function (candidate) {
 				var exclude = returnRef.some(function (comparison) {
-					return candidate === comparison;
+					return keySelector(candidate) === keySelector(comparison);
 				});
 
 				if (!exclude) {
@@ -6826,6 +6888,22 @@ module.exports = function () {
    * @returns {Array}
    */
 		intersection: function intersection(a, b) {
+			return this.intersectionBy(a, b, function (item) {
+				return item;
+			});
+		},
+
+
+		/**
+   * Set intersection operation, where the uniqueness is determined by a delegate.
+   *
+   * @static
+   * @param {Array} a
+   * @param {Array} b
+   * @param {Function} keySelector - A function that returns a unique key for an item.
+   * @returns {Array}
+   */
+		intersectionBy: function intersectionBy(a, b, keySelector) {
 			assert.argumentIsArray(a, 'a');
 			assert.argumentIsArray(b, 'b');
 
@@ -6833,7 +6911,7 @@ module.exports = function () {
 
 			a.forEach(function (candidate) {
 				var include = b.some(function (comparison) {
-					return candidate === comparison;
+					return keySelector(candidate) === comparison;
 				});
 
 				if (include) {
@@ -6852,16 +6930,20 @@ module.exports = function () {
    * @public
    * @param {Array} a
    * @param {Function} predicate
+   * @returns {Boolean}
    */
 		remove: function remove(a, predicate) {
 			assert.argumentIsArray(a, 'a');
 			assert.argumentIsRequired(predicate, 'predicate', Function);
 
 			var index = a.findIndex(predicate);
+			var found = !(index < 0);
 
-			if (!(index < 0)) {
+			if (found) {
 				a.splice(index, 1);
 			}
+
+			return found;
 		}
 	};
 }();