@barchart/portfolio-api-common 1.2.57 → 1.2.58

package/lib/data/TransactionValidator.js

@@ -26,10 +26,11 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {Array.<Object>} transactions
+		 * @param {Boolean=} strict
 		 * @returns {Boolean}
 		 */
-		static validateOrder(transactions) {
-			return TransactionValidator.getInvalidIndex(transactions) < 0;
+		static validateOrder(transactions, strict) {
+			return TransactionValidator.getInvalidIndex(transactions, strict) < 0;
 		}
 
 		/**
@@ -77,15 +78,14 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {Array.<Object>} transactions
+		 * @param {Boolean=} strict
 		 * @returns {Number}
 		 */
-		static getInvalidIndex(transactions) {
+		static getInvalidIndex(transactions, strict) {
 			assert.argumentIsArray(transactions, 'transactions');
+			assert.argumentIsOptional(strict, 'strict', Boolean);
 
-			return transactions.findIndex((t, i) => t.sequence !== (i + 1) || (i !== 0 && t.date.getIsBefore(transactions[i - 1].date)))
-
-			//return transactions.findIndex((t, i, a) => t.sequence !== (i + 1) || (i !== 0 && t.date.getIsBefore(a[ i - 1 ].date)));
-			//return transactions.findIndex((t, i, a) => t.sequence !== (i + 1) || (i !== 0 && t.date.getIsBefore(a[ i - 1 ].date)) || (i !== 0 && t.date.getIsEqual(a[i - 1].date) && t.type.sequence < a[i - 1].type.sequence));
+			return transactions.findIndex((t, i, a) => t.sequence !== (i + 1) || (i !== 0 && t.date.getIsBefore(a[ i - 1 ].date)) || (i !== 0 && is.boolean(strict) && strict && t.date.getIsEqual(a[i - 1].date) && t.type.sequence < a[i - 1].type.sequence));
 		}
 
 		/**

package/package.json

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

package/test/SpecRunner.js

@@ -1083,10 +1083,11 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {Array.<Object>} transactions
+		 * @param {Boolean=} strict
 		 * @returns {Boolean}
 		 */
-		static validateOrder(transactions) {
-			return TransactionValidator.getInvalidIndex(transactions) < 0;
+		static validateOrder(transactions, strict) {
+			return TransactionValidator.getInvalidIndex(transactions, strict) < 0;
 		}
 
 		/**
@@ -1134,15 +1135,14 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {Array.<Object>} transactions
+		 * @param {Boolean=} strict
 		 * @returns {Number}
 		 */
-		static getInvalidIndex(transactions) {
+		static getInvalidIndex(transactions, strict) {
 			assert.argumentIsArray(transactions, 'transactions');
+			assert.argumentIsOptional(strict, 'strict', Boolean);
 
-			return transactions.findIndex((t, i) => t.sequence !== (i + 1) || (i !== 0 && t.date.getIsBefore(transactions[i - 1].date)))
-
-			//return transactions.findIndex((t, i, a) => t.sequence !== (i + 1) || (i !== 0 && t.date.getIsBefore(a[ i - 1 ].date)));
-			//return transactions.findIndex((t, i, a) => t.sequence !== (i + 1) || (i !== 0 && t.date.getIsBefore(a[ i - 1 ].date)) || (i !== 0 && t.date.getIsEqual(a[i - 1].date) && t.type.sequence < a[i - 1].type.sequence));
+			return transactions.findIndex((t, i, a) => t.sequence !== (i + 1) || (i !== 0 && t.date.getIsBefore(a[ i - 1 ].date)) || (i !== 0 && is.boolean(strict) && strict && t.date.getIsEqual(a[i - 1].date) && t.type.sequence < a[i - 1].type.sequence));
 		}
 
 		/**
@@ -5166,8 +5166,8 @@ module.exports = function () {
    * Compares two strings (in ascending order), using {@link String#localeCompare}.
    *
    * @static
-   * @param {String} a
-   * @param {String} b
+   * @param {Number} a
+   * @param {Number} b
    * @returns {Number}
    */
 		compareStrings: function compareStrings(a, b) {
@@ -5857,7 +5857,7 @@ module.exports = function () {
     * @returns {String}
     */
 			value: function format() {
-				return leftPad(this._year, 4, '0') + '-' + leftPad(this._month, 2, '0') + '-' + leftPad(this._day, 2, '0');
+				return this._year + '-' + leftPad(this._month) + '-' + leftPad(this._day);
 			}
 
 			/**
@@ -5974,7 +5974,7 @@ module.exports = function () {
     *
     * @static
     * @public
-    * @returns {Day}
+    * @return {Day}
     */
 
 		}, {
@@ -6066,11 +6066,8 @@ module.exports = function () {
 
 	var dayRegex = /^([0-9]{4}).?([0-9]{2}).?([0-9]{2})$/;
 
-	function leftPad(value, digits, character) {
-		var string = value.toString();
-		var padding = digits - string.length;
-
-		return '' + character.repeat(padding) + string;
+	function leftPad(value) {
+		return value < 10 ? '0' + value : '' + value;
 	}
 
 	var comparator = ComparatorBuilder.startWith(function (a, b) {
@@ -6425,7 +6422,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 			value: function getIsZero(instance) {
 				assert.argumentIsRequired(instance, 'instance', Decimal, 'Decimal');
@@ -6438,7 +6435,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 
 		}, {
@@ -6454,7 +6451,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 
 		}, {
@@ -6470,7 +6467,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 
 		}, {
@@ -6486,7 +6483,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 
 		}, {
@@ -6502,7 +6499,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 
 		}, {
@@ -6892,7 +6889,6 @@ module.exports = function () {
 		/**
    * The unique code.
    *
-   * @public
    * @returns {String}
    */
 
@@ -6905,7 +6901,6 @@ module.exports = function () {
     * Returns true if the provided {@link Enum} argument is equal
     * to the instance.
     *
-    * @public
     * @param {Enum} other
     * @returns {boolean}
     */
@@ -6930,7 +6925,6 @@ module.exports = function () {
     * Looks up a enumeration item; given the enumeration type and the enumeration
     * item's value. If no matching item can be found, a null value is returned.
     *
-    * @public
     * @param {Function} type - The enumeration type.
     * @param {String} code - The enumeration item's code.
     * @returns {*|null}
@@ -6950,7 +6944,6 @@ module.exports = function () {
 			/**
     * The description.
     *
-    * @public
     * @returns {String}
     */
 
@@ -6970,7 +6963,6 @@ module.exports = function () {
 			/**
     * Returns all of the enumeration's items (given an enumeration type).
     *
-    * @public
     * @param {Function} type - The enumeration to list.
     * @returns {Array}
     */
@@ -7428,7 +7420,7 @@ module.exports = function () {
     * Parses the value emitted by {@link Timestamp#toJSON}.
     *
     * @public
-    * @param {Number} value
+    * @param {String} value
     * @returns {Timestamp}
     */
 
@@ -8064,7 +8056,7 @@ module.exports = function () {
 
 				if (typeof itemConstraint === 'function' && itemConstraint !== Function) {
 					itemValidator = function itemValidator(value, index) {
-						return itemConstraint.prototype !== undefined && value instanceof itemConstraint || itemConstraint(value, variableName + '[' + index + ']');
+						return value instanceof itemConstraint || itemConstraint(value, variableName + '[' + index + ']');
 					};
 				} else {
 					itemValidator = function itemValidator(value, index) {
@@ -8174,7 +8166,7 @@ module.exports = function () {
    *
    * @static
    * @param {Object} target - The object to check for existence of the property.
-   * @param {String|Array.<String>} propertyNames - The property to check -- either a string with separators, or an array of strings (already split by separator).
+   * @param {String|Array<String>} propertyNames - The property to check -- either a string with separators, or an array of strings (already split by separator).
    * @param {String=} separator - The separator (defaults to a period character).
    * @returns {boolean}
    */
@@ -8200,7 +8192,7 @@ module.exports = function () {
    *
    * @static
    * @param {Object} target - The object to read from.
-   * @param {String|Array.<String>} propertyNames - The property to read -- either a string with separators, or an array of strings (already split by separator).
+   * @param {String|Array<String>} propertyNames - The property to read -- either a string with separators, or an array of strings (already split by separator).
    * @param {String=} separator - The separator (defaults to a period character).
    * @returns {*}
    */
@@ -8235,8 +8227,7 @@ module.exports = function () {
    *
    * @static
    * @param {Object} target - The object to write to.
-   * @param {String|Array.<String>} propertyNames - The property to write -- either a string with separators, or an array of strings (already split by separator).
-   * @param {*} value - The value to assign.
+   * @param {String|Array<String>} propertyNames - The property to write -- either a string with separators, or an array of strings (already split by separator).
    * @param {String=} separator - The separator (defaults to a period character).
    */
 		write: function write(target, propertyNames, value, separator) {
@@ -8262,7 +8253,7 @@ module.exports = function () {
    *
    * @static
    * @param {Object} target - The object to erase a property from.
-   * @param {String|Array.<String>} propertyNames - The property to write -- either a string with separators, or an array of strings (already split by separator).
+   * @param {String|Array<String>} propertyNames - The property to write -- either a string with separators, or an array of strings (already split by separator).
    * @param {String=} separator - The separator (defaults to a period character).
    */
 		erase: function erase(target, propertyNames, separator) {
@@ -9515,7 +9506,7 @@ module.exports = function () {
 			}
 
 			/**
-    * Generates a function suitable for use by {@link JSON.parse}.
+    * Generates a function suitable for use by JSON.parse.
     *
     * @public
     * @returns {Function}
@@ -13640,9 +13631,9 @@ moment.tz.load(require('./data/packed/latest.json'));
 
             mom = createUTC([2000, 1]).day(i);
             if (strict && !this._fullWeekdaysParse[i]) {
-                this._fullWeekdaysParse[i] = new RegExp('^' + this.weekdays(mom, '').replace('.', '\\.?') + '$', 'i');
-                this._shortWeekdaysParse[i] = new RegExp('^' + this.weekdaysShort(mom, '').replace('.', '\\.?') + '$', 'i');
-                this._minWeekdaysParse[i] = new RegExp('^' + this.weekdaysMin(mom, '').replace('.', '\\.?') + '$', 'i');
+                this._fullWeekdaysParse[i] = new RegExp('^' + this.weekdays(mom, '').replace('.', '\.?') + '$', 'i');
+                this._shortWeekdaysParse[i] = new RegExp('^' + this.weekdaysShort(mom, '').replace('.', '\.?') + '$', 'i');
+                this._minWeekdaysParse[i] = new RegExp('^' + this.weekdaysMin(mom, '').replace('.', '\.?') + '$', 'i');
             }
             if (!this._weekdaysParse[i]) {
                 regex = '^' + this.weekdays(mom, '') + '|^' + this.weekdaysShort(mom, '') + '|^' + this.weekdaysMin(mom, '');
@@ -14445,7 +14436,7 @@ moment.tz.load(require('./data/packed/latest.json'));
 
     function preprocessRFC2822(s) {
         // Remove comments and folding whitespace and replace multiple-spaces with a single space
-        return s.replace(/\([^)]*\)|[\n\t]/g, ' ').replace(/(\s\s+)/g, ' ').replace(/^\s\s*/, '').replace(/\s\s*$/, '');
+        return s.replace(/\([^)]*\)|[\n\t]/g, ' ').replace(/(\s\s+)/g, ' ').trim();
     }
 
     function checkWeekday(weekdayStr, parsedInput, config) {
@@ -16624,7 +16615,7 @@ moment.tz.load(require('./data/packed/latest.json'));
     // Side effect imports
 
 
-    hooks.version = '2.22.2';
+    hooks.version = '2.22.1';
 
     setHookCallback(createLocal);
 
@@ -17256,15 +17247,17 @@ describe('When validating transaction order', () => {
 		expect(TransactionValidator.validateOrder([ build(1, '2018-04-30'), build(2, '2018-04-30'), build(3, '2018-04-30') ])).toEqual(true);
 	});
 
-/*
 	it('An array of transactions with ordered sequences, on the same day should be valid, where a dividend occurs last, should be valid', () => {
 		expect(TransactionValidator.validateOrder([ build(1, '2018-04-30'), build(2, '2018-04-30', TransactionType.DIVIDEND) ])).toEqual(true);
 	});
 
-	it('An array of transactions with ordered sequences, on the same day should be valid, where a dividend occurs first, should not be valid', () => {
-		expect(TransactionValidator.validateOrder([ build(1, '2018-04-30', TransactionType.DIVIDEND), build(2, '2018-04-30') ])).toEqual(false);
+	it('An array of transactions with ordered sequences, on the same day should be valid, where a dividend occurs first, in strict mode, should not be valid', () => {
+		expect(TransactionValidator.validateOrder([ build(1, '2018-04-30', TransactionType.DIVIDEND), build(2, '2018-04-30') ], true)).toEqual(false);
+	});
+
+	it('An array of transactions with ordered sequences, on the same day should be valid, where a dividend occurs first, in non-strict mode, should be valid', () => {
+		expect(TransactionValidator.validateOrder([ build(1, '2018-04-30', TransactionType.DIVIDEND), build(2, '2018-04-30') ], false)).toEqual(true);
 	});
-*/
 
 	it('An array of transactions with ordered sequences, on the sequential days should be valid', () => {
 		expect(TransactionValidator.validateOrder([ build(1, '2018-04-30'), build(2, '2018-05-01'), build(3, '2018-05-02', TransactionType.DIVIDEND) ])).toEqual(true);

package/test/specs/data/TransactionValidatorSpec.js

@@ -18,15 +18,17 @@ describe('When validating transaction order', () => {
 		expect(TransactionValidator.validateOrder([ build(1, '2018-04-30'), build(2, '2018-04-30'), build(3, '2018-04-30') ])).toEqual(true);
 	});
 
-/*
 	it('An array of transactions with ordered sequences, on the same day should be valid, where a dividend occurs last, should be valid', () => {
 		expect(TransactionValidator.validateOrder([ build(1, '2018-04-30'), build(2, '2018-04-30', TransactionType.DIVIDEND) ])).toEqual(true);
 	});
 
-	it('An array of transactions with ordered sequences, on the same day should be valid, where a dividend occurs first, should not be valid', () => {
-		expect(TransactionValidator.validateOrder([ build(1, '2018-04-30', TransactionType.DIVIDEND), build(2, '2018-04-30') ])).toEqual(false);
+	it('An array of transactions with ordered sequences, on the same day should be valid, where a dividend occurs first, in strict mode, should not be valid', () => {
+		expect(TransactionValidator.validateOrder([ build(1, '2018-04-30', TransactionType.DIVIDEND), build(2, '2018-04-30') ], true)).toEqual(false);
+	});
+
+	it('An array of transactions with ordered sequences, on the same day should be valid, where a dividend occurs first, in non-strict mode, should be valid', () => {
+		expect(TransactionValidator.validateOrder([ build(1, '2018-04-30', TransactionType.DIVIDEND), build(2, '2018-04-30') ], false)).toEqual(true);
 	});
-*/
 
 	it('An array of transactions with ordered sequences, on the sequential days should be valid', () => {
 		expect(TransactionValidator.validateOrder([ build(1, '2018-04-30'), build(2, '2018-05-01'), build(3, '2018-05-02', TransactionType.DIVIDEND) ])).toEqual(true);