@barchart/portfolio-api-common 1.2.57 → 1.2.61

package/lib/data/InstrumentType.js

@@ -19,11 +19,12 @@ module.exports = (() => {
 	 * @param {Boolean} canSwitchDirection
 	 * @param {Boolean} usesSymbols
 	 * @param {Boolean} hasCorporateActions
-	 * @param {Number} closeFractional
+	 * @param {Boolean} closeFractional
+	 * @param {Boolean} roundQuantity
 	 * @param {Function} generator
 	 */
 	class InstrumentType extends Enum {
-		constructor(code, description, alternateDescription, canReinvest, canShort, canSwitchDirection, usesSymbols, hasCorporateActions, closeFractional, generator) {
+		constructor(code, description, alternateDescription, canReinvest, canShort, canSwitchDirection, usesSymbols, hasCorporateActions, closeFractional, roundQuantity, generator) {
 			super(code, description);
 
 			assert.argumentIsRequired(alternateDescription, 'alternateDescription', String);
@@ -33,6 +34,7 @@ module.exports = (() => {
 			assert.argumentIsRequired(usesSymbols, 'usesSymbols', Boolean);
 			assert.argumentIsRequired(hasCorporateActions, 'hasCorporateActions', Boolean);
 			assert.argumentIsRequired(closeFractional, 'closeFractional', Boolean);
+			assert.argumentIsRequired(roundQuantity, 'roundQuantity', Boolean);
 			assert.argumentIsRequired(generator, 'generator', Function);
 
 			this._alternateDescription = alternateDescription;
@@ -42,6 +44,7 @@ module.exports = (() => {
 			this._usesSymbols = usesSymbols;
 			this._hasCorporateActions = hasCorporateActions;
 			this._closeFractional = closeFractional;
+			this._roundQuantity = roundQuantity;
 
 			this._generator = generator;
 		}
@@ -118,6 +121,16 @@ module.exports = (() => {
 			return this._closeFractional;
 		}
 
+		/**
+		 * Indicates transaction quantities should be rounded.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get roundQuantity() {
+			return this._roundQuantity;
+		}
+
 		/**
 		 * Generates an identifier for the instrument.
 		 *
@@ -215,10 +228,10 @@ module.exports = (() => {
 		}
 	}
 
-	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false, true, false, false, false, (instrument) => `BARCHART-${instrument.type.code}-${instrument.currency.code}`);
-	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true, false, true, true, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
-	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, false, false, true, true, false, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
-	const other = new InstrumentType('OTHER', 'other', 'Other', false, false, false, false, false, false, (instrument) => `BARCHART-${instrument.type.code}-${uuid.v4()}`);
+	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false, true, false, false, false, false, (instrument) => `BARCHART-${instrument.type.code}-${instrument.currency.code}`);
+	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true, false, true, true, true, true,  (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
+	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, false, false, true, true, false, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
+	const other = new InstrumentType('OTHER', 'other', 'Other', false, false, false, false, false, false, true, (instrument) => `BARCHART-${instrument.type.code}-${uuid.v4()}`);
 
 	const map = { };
 

package/lib/data/PositionSummaryFrame.js

@@ -2,8 +2,7 @@ const array = require('@barchart/common-js/lang/array'),
 	assert = require('@barchart/common-js/lang/assert'),
 	Day = require('@barchart/common-js/lang/Day'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
-	Enum = require('@barchart/common-js/lang/Enum'),
-	is = require('@barchart/common-js/lang/is');
+	Enum = require('@barchart/common-js/lang/Enum');
 
 module.exports = (() => {
 	'use strict';

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/lib/data/ValuationType.js

@@ -1,5 +1,4 @@
-const assert = require('@barchart/common-js/lang/assert'),
-	Enum = require('@barchart/common-js/lang/Enum');
+const Enum = require('@barchart/common-js/lang/Enum');
 
 module.exports = (() => {
 	'use strict';

package/lib/processing/PositionContainer.js

@@ -6,7 +6,6 @@ const array = require('@barchart/common-js/lang/array'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
 	DisposableStack = require('@barchart/common-js/collections/specialized/DisposableStack'),
 	Event = require('@barchart/common-js/messaging/Event'),
-	is = require('@barchart/common-js/lang/is'),
 	Rate = require('@barchart/common-js/lang/Rate'),
 	Tree = require('@barchart/common-js/collections/Tree');
 

package/lib/processing/PositionItem.js

@@ -311,7 +311,6 @@ module.exports = (() => {
 	}
 
 	function calculateStaticData(item) {
-		const portfolio = item.portfolio;
 		const position = item.position;
 		const snapshot = item.position.snapshot;
 		const previousSummaries = item.previousSummaries;
@@ -335,9 +334,9 @@ module.exports = (() => {
 
 		data.income = snapshot.income;
 
-		data.summaryTotalCurrent = calculateSummaryTotal(item.currentSummary);
-		data.summaryTotalPrevious = calculateSummaryTotal(getPreviousSummary(previousSummaries, 1));
-		data.summaryTotalPrevious2 = calculateSummaryTotal(getPreviousSummary(previousSummaries, 2));
+		data.summaryTotalCurrent = calculateSummaryTotal(item.currentSummary, getPreviousSummary(previousSummaries, 1));
+		data.summaryTotalPrevious = calculateSummaryTotal(getPreviousSummary(previousSummaries, 1), getPreviousSummary(previousSummaries, 2));
+		data.summaryTotalPrevious2 = calculateSummaryTotal(getPreviousSummary(previousSummaries, 2), getPreviousSummary(previousSummaries, 3));
 
 		if (snapshot.open.getIsZero()) {
 			data.basisPrice = Decimal.ZERO;
@@ -349,6 +348,7 @@ module.exports = (() => {
 	function calculatePriceData(item, price) {
 		const position = item.position;
 		const snapshot = item.position.snapshot;
+		const previousSummaries = item.previousSummaries;
 
 		const data = item._data;
 
@@ -408,25 +408,27 @@ module.exports = (() => {
 		data.unrealizedToday = unrealizedToday;
 		data.unrealizedTodayChange = unrealizedTodayChange;
 
-		const summary = item.currentSummary;
+		const currentSummary = item.currentSummary;
+
+		if (currentSummary && position.instrument.type !== InstrumentType.CASH) {
+			const previousSummary = getPreviousSummary(previousSummaries, 1);
 
-		if (summary && position.instrument.type !== InstrumentType.CASH) {
 			let priceToUse;
 
 			if (price) {
 				priceToUse = price;
 			} else if (data.previousPrice) {
 				priceToUse = new Decimal(data.previousPrice);
-			} else if (!summary.end.open.getIsZero()) {
-				priceToUse = summary.end.value.divide(summary.end.open);
+			} else if (!currentSummary.end.open.getIsZero()) {
+				priceToUse = currentSummary.end.value.divide(currentSummary.end.open);
 			} else {
 				priceToUse = null;
 			}
 
 			if (priceToUse !== null) {
-				const period = summary.period;
+				const period = currentSummary.period;
 
-				let unrealized = summary.end.open.multiply(priceToUse).add(summary.end.basis);
+				let unrealized = currentSummary.end.open.multiply(priceToUse).add(currentSummary.end.basis);
 				let unrealizedChange;
 
 				if (data.unrealized !== null) {
@@ -435,7 +437,7 @@ module.exports = (() => {
 					unrealizedChange = Decimal.ZERO;
 				}
 
-				let summaryTotalCurrent = period.realized.add(period.income).add(unrealized);
+				let summaryTotalCurrent = period.realized.add(period.income).add(unrealized).subtract(previousSummary !== null ? previousSummary.period.unrealized : Decimal.ZERO);
 				let summaryTotalCurrentChange;
 
 				if (data.summaryTotalCurrent !== null) {
@@ -463,13 +465,13 @@ module.exports = (() => {
 		}
 	}
 
-	function calculateSummaryTotal(summary) {
+	function calculateSummaryTotal(currentSummary, previousSummary) {
 		let returnRef;
 
-		if (summary) {
-			const period = summary.period;
+		if (currentSummary) {
+			const period = currentSummary.period;
 
-			returnRef = period.realized.add(period.income).add(period.unrealized);
+			returnRef = period.realized.add(period.income).add(period.unrealized).subtract(previousSummary !== null ? previousSummary.period.unrealized : Decimal.ZERO);
 		} else {
 			returnRef = Decimal.ZERO;
 		}

package/package.json

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

package/test/SpecRunner.js

@@ -20,11 +20,12 @@ module.exports = (() => {
 	 * @param {Boolean} canSwitchDirection
 	 * @param {Boolean} usesSymbols
 	 * @param {Boolean} hasCorporateActions
-	 * @param {Number} closeFractional
+	 * @param {Boolean} closeFractional
+	 * @param {Boolean} roundQuantity
 	 * @param {Function} generator
 	 */
 	class InstrumentType extends Enum {
-		constructor(code, description, alternateDescription, canReinvest, canShort, canSwitchDirection, usesSymbols, hasCorporateActions, closeFractional, generator) {
+		constructor(code, description, alternateDescription, canReinvest, canShort, canSwitchDirection, usesSymbols, hasCorporateActions, closeFractional, roundQuantity, generator) {
 			super(code, description);
 
 			assert.argumentIsRequired(alternateDescription, 'alternateDescription', String);
@@ -34,6 +35,7 @@ module.exports = (() => {
 			assert.argumentIsRequired(usesSymbols, 'usesSymbols', Boolean);
 			assert.argumentIsRequired(hasCorporateActions, 'hasCorporateActions', Boolean);
 			assert.argumentIsRequired(closeFractional, 'closeFractional', Boolean);
+			assert.argumentIsRequired(roundQuantity, 'roundQuantity', Boolean);
 			assert.argumentIsRequired(generator, 'generator', Function);
 
 			this._alternateDescription = alternateDescription;
@@ -43,6 +45,7 @@ module.exports = (() => {
 			this._usesSymbols = usesSymbols;
 			this._hasCorporateActions = hasCorporateActions;
 			this._closeFractional = closeFractional;
+			this._roundQuantity = roundQuantity;
 
 			this._generator = generator;
 		}
@@ -119,6 +122,16 @@ module.exports = (() => {
 			return this._closeFractional;
 		}
 
+		/**
+		 * Indicates transaction quantities should be rounded.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get roundQuantity() {
+			return this._roundQuantity;
+		}
+
 		/**
 		 * Generates an identifier for the instrument.
 		 *
@@ -216,10 +229,10 @@ module.exports = (() => {
 		}
 	}
 
-	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false, true, false, false, false, (instrument) => `BARCHART-${instrument.type.code}-${instrument.currency.code}`);
-	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true, false, true, true, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
-	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, false, false, true, true, false, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
-	const other = new InstrumentType('OTHER', 'other', 'Other', false, false, false, false, false, false, (instrument) => `BARCHART-${instrument.type.code}-${uuid.v4()}`);
+	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false, true, false, false, false, false, (instrument) => `BARCHART-${instrument.type.code}-${instrument.currency.code}`);
+	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true, false, true, true, true, true,  (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
+	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, false, false, true, true, false, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
+	const other = new InstrumentType('OTHER', 'other', 'Other', false, false, false, false, false, false, true, (instrument) => `BARCHART-${instrument.type.code}-${uuid.v4()}`);
 
 	const map = { };
 
@@ -366,8 +379,7 @@ const array = require('@barchart/common-js/lang/array'),
 	assert = require('@barchart/common-js/lang/assert'),
 	Day = require('@barchart/common-js/lang/Day'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
-	Enum = require('@barchart/common-js/lang/Enum'),
-	is = require('@barchart/common-js/lang/is');
+	Enum = require('@barchart/common-js/lang/Enum');
 
 module.exports = (() => {
 	'use strict';
@@ -634,7 +646,7 @@ module.exports = (() => {
 	return PositionSummaryFrame;
 })();
 
-},{"@barchart/common-js/lang/Day":21,"@barchart/common-js/lang/Decimal":22,"@barchart/common-js/lang/Enum":24,"@barchart/common-js/lang/array":28,"@barchart/common-js/lang/assert":29,"@barchart/common-js/lang/is":33}],4:[function(require,module,exports){
+},{"@barchart/common-js/lang/Day":21,"@barchart/common-js/lang/Decimal":22,"@barchart/common-js/lang/Enum":24,"@barchart/common-js/lang/array":28,"@barchart/common-js/lang/assert":29}],4:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
 	Enum = require('@barchart/common-js/lang/Enum');
 
@@ -1083,10 +1095,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 +1147,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));
 		}
 
 		/**
@@ -1340,7 +1352,6 @@ const array = require('@barchart/common-js/lang/array'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
 	DisposableStack = require('@barchart/common-js/collections/specialized/DisposableStack'),
 	Event = require('@barchart/common-js/messaging/Event'),
-	is = require('@barchart/common-js/lang/is'),
 	Rate = require('@barchart/common-js/lang/Rate'),
 	Tree = require('@barchart/common-js/collections/Tree');
 
@@ -2274,7 +2285,7 @@ module.exports = (() => {
 	return PositionContainer;
 })();
 
-},{"./../data/PositionSummaryFrame":3,"./PositionGroup":7,"./PositionItem":8,"./definitions/PositionLevelDefinition":9,"./definitions/PositionLevelType":10,"./definitions/PositionTreeDefinition":11,"@barchart/common-js/collections/Tree":15,"@barchart/common-js/collections/sorting/ComparatorBuilder":16,"@barchart/common-js/collections/sorting/comparators":17,"@barchart/common-js/collections/specialized/DisposableStack":18,"@barchart/common-js/lang/Currency":20,"@barchart/common-js/lang/Decimal":22,"@barchart/common-js/lang/Rate":26,"@barchart/common-js/lang/array":28,"@barchart/common-js/lang/assert":29,"@barchart/common-js/lang/is":33,"@barchart/common-js/messaging/Event":35}],7:[function(require,module,exports){
+},{"./../data/PositionSummaryFrame":3,"./PositionGroup":7,"./PositionItem":8,"./definitions/PositionLevelDefinition":9,"./definitions/PositionLevelType":10,"./definitions/PositionTreeDefinition":11,"@barchart/common-js/collections/Tree":15,"@barchart/common-js/collections/sorting/ComparatorBuilder":16,"@barchart/common-js/collections/sorting/comparators":17,"@barchart/common-js/collections/specialized/DisposableStack":18,"@barchart/common-js/lang/Currency":20,"@barchart/common-js/lang/Decimal":22,"@barchart/common-js/lang/Rate":26,"@barchart/common-js/lang/array":28,"@barchart/common-js/lang/assert":29,"@barchart/common-js/messaging/Event":35}],7:[function(require,module,exports){
 const array = require('@barchart/common-js/lang/array'),
 	assert = require('@barchart/common-js/lang/assert'),
 	Currency = require('@barchart/common-js/lang/Currency'),
@@ -3448,7 +3459,6 @@ module.exports = (() => {
 	}
 
 	function calculateStaticData(item) {
-		const portfolio = item.portfolio;
 		const position = item.position;
 		const snapshot = item.position.snapshot;
 		const previousSummaries = item.previousSummaries;
@@ -3472,9 +3482,9 @@ module.exports = (() => {
 
 		data.income = snapshot.income;
 
-		data.summaryTotalCurrent = calculateSummaryTotal(item.currentSummary);
-		data.summaryTotalPrevious = calculateSummaryTotal(getPreviousSummary(previousSummaries, 1));
-		data.summaryTotalPrevious2 = calculateSummaryTotal(getPreviousSummary(previousSummaries, 2));
+		data.summaryTotalCurrent = calculateSummaryTotal(item.currentSummary, getPreviousSummary(previousSummaries, 1));
+		data.summaryTotalPrevious = calculateSummaryTotal(getPreviousSummary(previousSummaries, 1), getPreviousSummary(previousSummaries, 2));
+		data.summaryTotalPrevious2 = calculateSummaryTotal(getPreviousSummary(previousSummaries, 2), getPreviousSummary(previousSummaries, 3));
 
 		if (snapshot.open.getIsZero()) {
 			data.basisPrice = Decimal.ZERO;
@@ -3486,6 +3496,7 @@ module.exports = (() => {
 	function calculatePriceData(item, price) {
 		const position = item.position;
 		const snapshot = item.position.snapshot;
+		const previousSummaries = item.previousSummaries;
 
 		const data = item._data;
 
@@ -3545,25 +3556,27 @@ module.exports = (() => {
 		data.unrealizedToday = unrealizedToday;
 		data.unrealizedTodayChange = unrealizedTodayChange;
 
-		const summary = item.currentSummary;
+		const currentSummary = item.currentSummary;
+
+		if (currentSummary && position.instrument.type !== InstrumentType.CASH) {
+			const previousSummary = getPreviousSummary(previousSummaries, 1);
 
-		if (summary && position.instrument.type !== InstrumentType.CASH) {
 			let priceToUse;
 
 			if (price) {
 				priceToUse = price;
 			} else if (data.previousPrice) {
 				priceToUse = new Decimal(data.previousPrice);
-			} else if (!summary.end.open.getIsZero()) {
-				priceToUse = summary.end.value.divide(summary.end.open);
+			} else if (!currentSummary.end.open.getIsZero()) {
+				priceToUse = currentSummary.end.value.divide(currentSummary.end.open);
 			} else {
 				priceToUse = null;
 			}
 
 			if (priceToUse !== null) {
-				const period = summary.period;
+				const period = currentSummary.period;
 
-				let unrealized = summary.end.open.multiply(priceToUse).add(summary.end.basis);
+				let unrealized = currentSummary.end.open.multiply(priceToUse).add(currentSummary.end.basis);
 				let unrealizedChange;
 
 				if (data.unrealized !== null) {
@@ -3572,7 +3585,7 @@ module.exports = (() => {
 					unrealizedChange = Decimal.ZERO;
 				}
 
-				let summaryTotalCurrent = period.realized.add(period.income).add(unrealized);
+				let summaryTotalCurrent = period.realized.add(period.income).add(unrealized).subtract(previousSummary !== null ? previousSummary.period.unrealized : Decimal.ZERO);
 				let summaryTotalCurrentChange;
 
 				if (data.summaryTotalCurrent !== null) {
@@ -3600,13 +3613,13 @@ module.exports = (() => {
 		}
 	}
 
-	function calculateSummaryTotal(summary) {
+	function calculateSummaryTotal(currentSummary, previousSummary) {
 		let returnRef;
 
-		if (summary) {
-			const period = summary.period;
+		if (currentSummary) {
+			const period = currentSummary.period;
 
-			returnRef = period.realized.add(period.income).add(period.unrealized);
+			returnRef = period.realized.add(period.income).add(period.unrealized).subtract(previousSummary !== null ? previousSummary.period.unrealized : Decimal.ZERO);
 		} else {
 			returnRef = Decimal.ZERO;
 		}
@@ -5166,8 +5179,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 +5870,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 +5987,7 @@ module.exports = function () {
     *
     * @static
     * @public
-    * @returns {Day}
+    * @return {Day}
     */
 
 		}, {
@@ -6066,11 +6079,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 +6435,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 			value: function getIsZero(instance) {
 				assert.argumentIsRequired(instance, 'instance', Decimal, 'Decimal');
@@ -6438,7 +6448,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 
 		}, {
@@ -6454,7 +6464,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 
 		}, {
@@ -6470,7 +6480,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 
 		}, {
@@ -6486,7 +6496,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 
 		}, {
@@ -6502,7 +6512,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 
 		}, {
@@ -6892,7 +6902,6 @@ module.exports = function () {
 		/**
    * The unique code.
    *
-   * @public
    * @returns {String}
    */
 
@@ -6905,7 +6914,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 +6938,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 +6957,6 @@ module.exports = function () {
 			/**
     * The description.
     *
-    * @public
     * @returns {String}
     */
 
@@ -6970,7 +6976,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 +7433,7 @@ module.exports = function () {
     * Parses the value emitted by {@link Timestamp#toJSON}.
     *
     * @public
-    * @param {Number} value
+    * @param {String} value
     * @returns {Timestamp}
     */
 
@@ -8064,7 +8069,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 +8179,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 +8205,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 +8240,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 +8266,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 +9519,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 +13644,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 +14449,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 +16628,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 +17260,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);