@barchart/portfolio-api-common 1.3.3 → 1.3.7

package/.jshintrc

@@ -0,0 +1,3 @@
+{
+  "validthis": true
+}

package/lib/api/failures/PortfolioFailureType.js

@@ -296,8 +296,8 @@ module.exports = (() => {
 	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 transactionCreateFailedInvalidDate = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_DATE', 'Unable to process transaction with given date.');
 	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.');
-	const transactionCreateFailedInvalidDirectionSwitch = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_DIRECTION_SWITCH', 'Unable to process transaction, the transaction would switch the position from {L|currentDirection.description} to {L|proposedDirection.description} (i.e. {L|currentDirection.sign} to {L|proposedDirection.sign} shares/units). This is not allowed. Please close the current position (i.e. zero it out) and then enter a second transaction.');
+	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.', false);
+	const transactionCreateFailedInvalidDirectionSwitch = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_DIRECTION_SWITCH', 'Unable to process transaction, the transaction would switch the position from {L|currentDirection.description} to {L|proposedDirection.description} (i.e. {L|currentDirection.sign} to {L|proposedDirection.sign} shares/units). This is not allowed. Please close the current position (i.e. zero it out) and then enter a second transaction.', false);
 	const transactionCreateFailedInvalidInitialType = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_INITIAL_TYPE', 'Unable to process operation because the first transaction would to be a {U|transactionType.description}, which is not allowed -- since {U|transactionType.description} transactions cannot open a position.');
 
 	const transactionCreateFailedTypeReserved = new FailureType('TRANSACTION_CREATE_FAILED_TYPE_RESERVED', 'Unable to create {U|type.description} transaction, this type of transaction is managed by the system.');
@@ -307,7 +307,7 @@ module.exports = (() => {
 
 	const transactionDeleteFailedOutOfSequence = new FailureType('TRANSACTION_DELETE_FAILED_OUT_OF_SEQUENCE', 'Deleting any transaction, except for the most recent, will cause transaction history to be re-written. Please confirm your intent to re-write transaction history (which could take some time and alter the historical results for this position).');
 	const transactionDeleteFailedNoTransaction = new FailureType('TRANSACTION_DELETE_FAILED_NO_TRANSACTION', 'Unable to delete transaction. The referenced transaction does not exist.');
-	const transactionDeleteFailedDirectionSwitchOnRewrite = new FailureType('TRANSACTION_DELETE_FAILED_DIRECTION_SWITCH_ON_REWRITE', 'Deleting this transaction would cause your history to be re-written and the position to switch from long to short (i.e. positive to negative) or vice versa.');
+	const transactionDeleteFailedDirectionSwitchOnRewrite = new FailureType('TRANSACTION_DELETE_FAILED_DIRECTION_SWITCH_ON_REWRITE', 'Deleting this transaction would cause your history to be re-written and the position to switch from long to short (i.e. positive to negative) or vice versa.', false);
 	const transactionDeleteFailedPositionLocked = new FailureType('TRANSACTION_DELETE_FAILED_POSITION_LOCKED', 'Unable to delete transaction, your {L|description} history is being recalculated. Please wait a minute or two and retry.');
 	const transactionDeleteFailedTypeReserved = new FailureType('TRANSACTION_DELETE_FAILED_TYPE_RESERVED', 'Unable to delete {U|type.description} transaction, this type of transaction is managed by the system.');
 

package/lib/data/TransactionValidator.js

@@ -45,7 +45,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @param {Array.<Object>} transactions
+		 * @param {Object[]} transactions
 		 * @param {Boolean=} strict
 		 * @returns {Boolean}
 		 */
@@ -59,7 +59,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @param {Array.<Object>} transactions
+		 * @param {Object[]} transactions
 		 * @returns {Boolean}
 		 */
 		static validateReferences(transactions) {
@@ -97,7 +97,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @param {Array.<Object>} transactions
+		 * @param {Object[]} transactions
 		 * @param {Boolean=} strict
 		 * @returns {Number}
 		 */
@@ -116,7 +116,7 @@ module.exports = (() => {
 		 * @param {InstrumentType} instrumentType
 		 * @param {Boolean=} userInitiated
 		 * @param {PositionDirection=} currentDirection
-		 * @returns {Array.<TransactionType>}
+		 * @returns {TransactionType[]}
 		 */
 		static getTransactionTypesFor(instrumentType, userInitiated, currentDirection) {
 			assert.argumentIsRequired(instrumentType, 'instrumentType', InstrumentType, 'InstrumentType');
@@ -141,7 +141,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @returns {Array.<TransactionType>}
+		 * @returns {TransactionType[]}
 		 */
 		static getUserInitiatedTransactionTypes() {
 			return array.unique(Object.keys(validTransactionTypes).reduce((types, key) => {

package/lib/formatters/TransactionFormatter.js

@@ -23,13 +23,12 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Maps transaction objects into new objects whose properties are human-readable (or
-		 * mutates the original objects, adding a "formatted" property to each transaction).
+		 * Maps transaction objects into new objects whose properties are human-readable.
 		 *
 		 * @public
 		 * @static
-		 * @param {Array.<Object>} transactions
-		 * @param {Array.<Object>} positions
+		 * @param {Object[]} transactions
+		 * @param {Object[]} positions
 		 * @param {Boolean=} descending
 		 * @returns {Array}
 		 */
@@ -97,7 +96,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @param {Array.<Object>} transactions
+		 * @param {Object[]} transactions
 		 * @param {Boolean=} descending
 		 * @returns {Array}
 		 */

package/lib/processing/PositionContainer.js

@@ -39,10 +39,10 @@ module.exports = (() => {
 	 * changes) for each level of grouping.
 	 *
 	 * @public
-	 * @param {Array.<PositionTreeDefinition>} definitions
-	 * @param {Array.<Object>} portfolios - The portfolios.
-	 * @param {Array.<Object>} positions - The positions (for all of the portfolios).
-	 * @param {Array.<Object>} summaries - The positions summaries (for all of the positions).
+	 * @param {PositionTreeDefinition[]} definitions
+	 * @param {Object[]} portfolios - The portfolios.
+	 * @param {Object[]} positions - The positions (for all of the portfolios).
+	 * @param {Object[]} summaries - The positions summaries (for all of the positions).
 	 * @param {PositionSummaryFrame=} reportFrame - If specified, locks the current (and previous) periods to a specific frame, use for reporting.
 	 * @param {Day=} reportDate - The end date for the report frame.
 	 */
@@ -172,6 +172,53 @@ module.exports = (() => {
 			recalculatePercentages.call(this);
 		}
 
+		/**
+		 * Returns Barchart's user identifier for the container's portfolios. If
+		 * the container has no portfolios, a null value is returned.
+		 *
+		 * @public
+		 * @returns {String|null}
+		 */
+		getBarchartUserId() {
+			let returnRef = null;
+
+			const keys = Object.keys(this._portfolios);
+
+			if (keys.length > 0) {
+				const firstKey = keys[0];
+				const firstPortfolio = this._portfolios[firstKey];
+
+				returnRef = firstPortfolio.user;
+			}
+
+			return returnRef;
+		}
+
+		/**
+		 * Returns customer's user identifier for the container's portfolios. If
+		 * the container has no portfolios, or if the portfolio(s) are not owned
+		 * by a remote customer, a null value is returned.
+		 *
+		 * @public
+		 * @returns {String|null}
+		 */
+		getCustomerUserId() {
+			let returnRef = null;
+
+			const keys = Object.keys(this._portfolios);
+
+			if (keys.length > 0) {
+				const firstKey = keys[0];
+				const firstPortfolio = this._portfolios[firstKey];
+
+				if (firstPortfolio.legacy && firstPortfolio.legacy.user) {
+					returnRef = firstPortfolio.legacy.user;
+				}
+			}
+
+			return returnRef;
+		}
+
 		/**
 		 * Adds a new portfolio to the container, injecting it into aggregation
 		 * trees, as necessary.
@@ -284,7 +331,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Object} position
-		 * @param {Array.<Object>} summaries
+		 * @param {Object>[]} summaries
 		 */
 		updatePosition(position, summaries) {
 			assert.argumentIsRequired(position, 'position', Object);
@@ -387,7 +434,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Boolean} display - If true, all "display" symbols are returned; otherwise Barchart symbols are returned.
-		 * @returns {Array.<String>}
+		 * @returns {String[]}
 		 */
 		getPositionSymbols(display) {
 			const symbols = this._items.reduce((symbols, item) => {
@@ -451,8 +498,8 @@ module.exports = (() => {
 		 * triggering updates to position(s) and data aggregation(s).
 		 *
 		 * @public
-		 * @param {Array.<Object>} positionQuotes
-		 * @param {Array.<Object>} forexQuotes
+		 * @param {Object[]} positionQuotes
+		 * @param {Object[]} forexQuotes
 		 */
 		setQuotes(positionQuotes, forexQuotes) {
 			assert.argumentIsArray(positionQuotes, 'positionQuotes');
@@ -514,7 +561,7 @@ module.exports = (() => {
 		 * Returns all forex symbols that are required to do currency translations.
 		 *
 		 * @public
-		 * @returns {Array.<String>}
+		 * @returns {String[]}
 		 */
 		getForexSymbols() {
 			return this._forexSymbols;
@@ -524,7 +571,7 @@ module.exports = (() => {
 		 * Returns all current forex quotes.
 		 *
 		 * @public
-		 * @returns {Array.<Object>}
+		 * @returns {Object[]}
 		 */
 		getForexQuotes() {
 			return this._forexQuotes;
@@ -586,7 +633,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {String} name
-		 * @param {Array.<String>} keys
+		 * @param {String[]} keys
 		 * @returns {PositionGroup}
 		 */
 		getGroup(name, keys) {
@@ -602,8 +649,8 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {String} name
-		 * @param {Array.<String>} keys
-		 * @returns {Array.<PositionGroup>}
+		 * @param {String[]} keys
+		 * @returns {PositionGroup[]}
 		 */
 		getGroups(name, keys) {
 			assert.argumentIsRequired(name, 'name', String);
@@ -642,7 +689,7 @@ module.exports = (() => {
 		 * Returns all portfolios in the container.
 		 *
 		 * @public
-		 * @returns {Array.<Object>}
+		 * @returns {Object[]}
 		 */
 		getPortfolios() {
 			return Object.keys(this._portfolios).map(id => this._portfolios[id]);
@@ -653,7 +700,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {String} portfolio
-		 * @returns {Array.<Object>}
+		 * @returns {Object[]}
 		 */
 		getPositions(portfolio) {
 			assert.argumentIsRequired(portfolio, 'portfolio', String);

package/lib/processing/PositionGroup.js

@@ -26,7 +26,7 @@ module.exports = (() => {
 	 * @public
 	 * @param {PositionContainer} container
 	 * @param {LevelDefinition} definition
-	 * @param {Array.<PositionItem>} items
+	 * @param {PositionItem[]} items
 	 * @param {Currency} currency
 	 * @param {String} key
 	 * @param {String} description
@@ -361,7 +361,7 @@ module.exports = (() => {
 		 * Sets the list of items which are excluded from group aggregation calculations.
 		 *
 		 * @public
-		 * @param {Array.<Object>} items
+		 * @param {Object[]} items
 		 */
 		setExcludedItems(items) {
 			this._excludedItems = items;
@@ -382,7 +382,7 @@ module.exports = (() => {
 		 * Causes aggregated data to be recalculated using a new exchange rate.
 		 *
 		 * @public
-		 * @param {Array.<Rate>} rate
+		 * @param {Rate[]} rates
 		 */
 		setForexRates(rates) {
 			this._rates = rates;

package/lib/processing/PositionItem.js

@@ -20,7 +20,7 @@ module.exports = (() => {
 	 * @param {Object} portfolio
 	 * @param {Object} position
 	 * @param {Object} currentSummary
-	 * @param {Array.<Object>} previousSummaries
+	 * @param {Object[]} previousSummaries
 	 * @param {Boolean} reporting
 	 */
 	class PositionItem extends Disposable {

package/lib/processing/definitions/PositionLevelDefinition.js

@@ -19,7 +19,7 @@ module.exports = (() => {
 	 * @param {PositionLevelDefinition~keySelector} keySelector
 	 * @param {PositionLevelDefinition~descriptionSelector} descriptionSelector
 	 * @param {PositionLevelDefinition~currencySelector} currencySelector
-	 * @param {Array.<PositionLevelDefinition~RequiredGroup>=} requiredGroups
+	 * @param {PositionLevelDefinition~RequiredGroup[]=} requiredGroups
 	 * @param {Boolean=} aggregateCash
 	 * @param {Function=} requiredGroupGenerator
 	 */
@@ -160,13 +160,16 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {Object} portfolio
+		 * @param {Currency=} currency
 		 * @returns {PositionLevelDefinition~RequiredGroup}
 		 */
-		static buildRequiredGroupForPortfolio(portfolio) {
+		static buildRequiredGroupForPortfolio(portfolio, currency) {
+			assert.argumentIsOptional(currency, 'currency', Currency, 'Currency');
+
 			return {
 				key: PositionLevelDefinition.getKeyForPortfolioGroup(portfolio),
 				description: PositionLevelDefinition.getDescriptionForPortfolioGroup(portfolio),
-				currency: Currency.CAD
+				currency: (currency || Currency.CAD)
 			};
 		}
 
@@ -182,12 +185,12 @@ module.exports = (() => {
 			return portfolio.name;
 		}
 
-		static getRequiredGroupGeneratorForPortfolio() {
+		static getRequiredGroupGeneratorForPortfolio(currency) {
 			return (portfolio) => {
 				let requiredGroup;
 
 				if (is.object(portfolio) && is.string(portfolio.portfolio) && is.string(portfolio.name)) {
-					requiredGroup = PositionLevelDefinition.buildRequiredGroupForPortfolio(portfolio);
+					requiredGroup = PositionLevelDefinition.buildRequiredGroupForPortfolio(portfolio, currency);
 				} else {
 					requiredGroup = null;
 				}
@@ -203,12 +206,13 @@ module.exports = (() => {
 		 * @static
 		 * @param {InstrumentType} type
 		 * @param {Currency} currency
+		 * @param {Currency=} defaultCurrency
 		 * @returns {PositionLevelDefinition~RequiredGroup}
 		 */
-		static buildRequiredGroupForAssetClass(type, currency) {
+		static buildRequiredGroupForAssetClass(type, currency, defaultCurrency) {
 			return {
 				key: PositionLevelDefinition.getKeyForAssetClassGroup(type, currency),
-				description: PositionLevelDefinition.getDescriptionForAssetClassGroup(type, currency),
+				description: PositionLevelDefinition.getDescriptionForAssetClassGroup(type, currency, defaultCurrency),
 				currency: currency
 			};
 		}
@@ -220,11 +224,12 @@ module.exports = (() => {
 			return `${type.code}|${currency.code}`;
 		}
 
-		static getDescriptionForAssetClassGroup(type, currency) {
+		static getDescriptionForAssetClassGroup(type, currency, defaultCurrency) {
 			assert.argumentIsRequired(type, 'type', InstrumentType, 'InstrumentType');
 			assert.argumentIsRequired(currency, 'currency', Currency, 'Currency');
+			assert.argumentIsOptional(defaultCurrency, 'defaultCurrency', Currency, 'Currency');
 
-			return `${type.alternateDescription}${currency.code === 'CAD' ? '' : ` (${currency.alternateDescription})`}`;
+			return `${type.alternateDescription}${currency === (defaultCurrency || Currency.CAD) ? '' : ` (${currency.alternateDescription})`}`;
 		}
 
 		toString() {

package/lib/processing/definitions/PositionTreeDefinition.js

@@ -10,8 +10,8 @@ module.exports = (() => {
 	 *
 	 * @public
 	 * @param {String} name
-	 * @param {Array.<PositionLevelDefinition>} definitions
-	 * @oaram {Array.<String>=} exclusionDependencies
+	 * @param {PositionLevelDefinition[]} definitions
+	 * @oaram {String[]=} exclusionDependencies
 	 */
 	class PositionTreeDefinitions {
 		constructor(name, definitions, exclusionDependencies) {
@@ -44,7 +44,7 @@ module.exports = (() => {
 		 * bottom-most level of the tree (i.e. leaf nodes).
 		 *
 		 * @public
-		 * @returns {Array.<PositionLevelDefinitions>}
+		 * @returns {PositionLevelDefinitions>[]}
 		 */
 		get definitions() {
 			return this._definitions;
@@ -55,7 +55,7 @@ module.exports = (() => {
 		 * group (from the current tree) is excluded.
 		 *
 		 * @public
-		 * @returns {Array.<String>}
+		 * @returns {String[]}
 		 */
 		get exclusionDependencies() {
 			return this._exclusionDependencies;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.3.3",
+  "version": "1.3.7",
   "description": "Common classes used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",
@@ -21,7 +21,7 @@
     "glob": "^6.0.1",
     "gulp": "~3.9.0",
     "gulp-bump": "~1.0.0",
-    "gulp-git": "~1.6.0",
+    "gulp-git": "^2.5.1",
     "gulp-jasmine": "^2.2.1",
     "gulp-jshint": "~2.1.0",
     "gulp-util": "^3.0.7",

package/test/SpecRunner.js

@@ -1232,7 +1232,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @param {Array.<Object>} transactions
+		 * @param {Object[]} transactions
 		 * @param {Boolean=} strict
 		 * @returns {Boolean}
 		 */
@@ -1246,7 +1246,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @param {Array.<Object>} transactions
+		 * @param {Object[]} transactions
 		 * @returns {Boolean}
 		 */
 		static validateReferences(transactions) {
@@ -1284,7 +1284,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @param {Array.<Object>} transactions
+		 * @param {Object[]} transactions
 		 * @param {Boolean=} strict
 		 * @returns {Number}
 		 */
@@ -1303,7 +1303,7 @@ module.exports = (() => {
 		 * @param {InstrumentType} instrumentType
 		 * @param {Boolean=} userInitiated
 		 * @param {PositionDirection=} currentDirection
-		 * @returns {Array.<TransactionType>}
+		 * @returns {TransactionType[]}
 		 */
 		static getTransactionTypesFor(instrumentType, userInitiated, currentDirection) {
 			assert.argumentIsRequired(instrumentType, 'instrumentType', InstrumentType, 'InstrumentType');
@@ -1328,7 +1328,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @returns {Array.<TransactionType>}
+		 * @returns {TransactionType[]}
 		 */
 		static getUserInitiatedTransactionTypes() {
 			return array.unique(Object.keys(validTransactionTypes).reduce((types, key) => {
@@ -1525,10 +1525,10 @@ module.exports = (() => {
 	 * changes) for each level of grouping.
 	 *
 	 * @public
-	 * @param {Array.<PositionTreeDefinition>} definitions
-	 * @param {Array.<Object>} portfolios - The portfolios.
-	 * @param {Array.<Object>} positions - The positions (for all of the portfolios).
-	 * @param {Array.<Object>} summaries - The positions summaries (for all of the positions).
+	 * @param {PositionTreeDefinition[]} definitions
+	 * @param {Object[]} portfolios - The portfolios.
+	 * @param {Object[]} positions - The positions (for all of the portfolios).
+	 * @param {Object[]} summaries - The positions summaries (for all of the positions).
 	 * @param {PositionSummaryFrame=} reportFrame - If specified, locks the current (and previous) periods to a specific frame, use for reporting.
 	 * @param {Day=} reportDate - The end date for the report frame.
 	 */
@@ -1658,6 +1658,53 @@ module.exports = (() => {
 			recalculatePercentages.call(this);
 		}
 
+		/**
+		 * Returns Barchart's user identifier for the container's portfolios. If
+		 * the container has no portfolios, a null value is returned.
+		 *
+		 * @public
+		 * @returns {String|null}
+		 */
+		getBarchartUserId() {
+			let returnRef = null;
+
+			const keys = Object.keys(this._portfolios);
+
+			if (keys.length > 0) {
+				const firstKey = keys[0];
+				const firstPortfolio = this._portfolios[firstKey];
+
+				returnRef = firstPortfolio.user;
+			}
+
+			return returnRef;
+		}
+
+		/**
+		 * Returns customer's user identifier for the container's portfolios. If
+		 * the container has no portfolios, or if the portfolio(s) are not owned
+		 * by a remote customer, a null value is returned.
+		 *
+		 * @public
+		 * @returns {String|null}
+		 */
+		getCustomerUserId() {
+			let returnRef = null;
+
+			const keys = Object.keys(this._portfolios);
+
+			if (keys.length > 0) {
+				const firstKey = keys[0];
+				const firstPortfolio = this._portfolios[firstKey];
+
+				if (firstPortfolio.legacy && firstPortfolio.legacy.user) {
+					returnRef = firstPortfolio.legacy.user;
+				}
+			}
+
+			return returnRef;
+		}
+
 		/**
 		 * Adds a new portfolio to the container, injecting it into aggregation
 		 * trees, as necessary.
@@ -1770,7 +1817,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Object} position
-		 * @param {Array.<Object>} summaries
+		 * @param {Object>[]} summaries
 		 */
 		updatePosition(position, summaries) {
 			assert.argumentIsRequired(position, 'position', Object);
@@ -1873,7 +1920,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Boolean} display - If true, all "display" symbols are returned; otherwise Barchart symbols are returned.
-		 * @returns {Array.<String>}
+		 * @returns {String[]}
 		 */
 		getPositionSymbols(display) {
 			const symbols = this._items.reduce((symbols, item) => {
@@ -1937,8 +1984,8 @@ module.exports = (() => {
 		 * triggering updates to position(s) and data aggregation(s).
 		 *
 		 * @public
-		 * @param {Array.<Object>} positionQuotes
-		 * @param {Array.<Object>} forexQuotes
+		 * @param {Object[]} positionQuotes
+		 * @param {Object[]} forexQuotes
 		 */
 		setQuotes(positionQuotes, forexQuotes) {
 			assert.argumentIsArray(positionQuotes, 'positionQuotes');
@@ -2000,7 +2047,7 @@ module.exports = (() => {
 		 * Returns all forex symbols that are required to do currency translations.
 		 *
 		 * @public
-		 * @returns {Array.<String>}
+		 * @returns {String[]}
 		 */
 		getForexSymbols() {
 			return this._forexSymbols;
@@ -2010,7 +2057,7 @@ module.exports = (() => {
 		 * Returns all current forex quotes.
 		 *
 		 * @public
-		 * @returns {Array.<Object>}
+		 * @returns {Object[]}
 		 */
 		getForexQuotes() {
 			return this._forexQuotes;
@@ -2072,7 +2119,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {String} name
-		 * @param {Array.<String>} keys
+		 * @param {String[]} keys
 		 * @returns {PositionGroup}
 		 */
 		getGroup(name, keys) {
@@ -2088,8 +2135,8 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {String} name
-		 * @param {Array.<String>} keys
-		 * @returns {Array.<PositionGroup>}
+		 * @param {String[]} keys
+		 * @returns {PositionGroup[]}
 		 */
 		getGroups(name, keys) {
 			assert.argumentIsRequired(name, 'name', String);
@@ -2128,7 +2175,7 @@ module.exports = (() => {
 		 * Returns all portfolios in the container.
 		 *
 		 * @public
-		 * @returns {Array.<Object>}
+		 * @returns {Object[]}
 		 */
 		getPortfolios() {
 			return Object.keys(this._portfolios).map(id => this._portfolios[id]);
@@ -2139,7 +2186,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {String} portfolio
-		 * @returns {Array.<Object>}
+		 * @returns {Object[]}
 		 */
 		getPositions(portfolio) {
 			assert.argumentIsRequired(portfolio, 'portfolio', String);
@@ -2548,7 +2595,7 @@ module.exports = (() => {
 	 * @public
 	 * @param {PositionContainer} container
 	 * @param {LevelDefinition} definition
-	 * @param {Array.<PositionItem>} items
+	 * @param {PositionItem[]} items
 	 * @param {Currency} currency
 	 * @param {String} key
 	 * @param {String} description
@@ -2883,7 +2930,7 @@ module.exports = (() => {
 		 * Sets the list of items which are excluded from group aggregation calculations.
 		 *
 		 * @public
-		 * @param {Array.<Object>} items
+		 * @param {Object[]} items
 		 */
 		setExcludedItems(items) {
 			this._excludedItems = items;
@@ -2904,7 +2951,7 @@ module.exports = (() => {
 		 * Causes aggregated data to be recalculated using a new exchange rate.
 		 *
 		 * @public
-		 * @param {Array.<Rate>} rate
+		 * @param {Rate[]} rates
 		 */
 		setForexRates(rates) {
 			this._rates = rates;
@@ -3562,7 +3609,7 @@ module.exports = (() => {
 	 * @param {Object} portfolio
 	 * @param {Object} position
 	 * @param {Object} currentSummary
-	 * @param {Array.<Object>} previousSummaries
+	 * @param {Object[]} previousSummaries
 	 * @param {Boolean} reporting
 	 */
 	class PositionItem extends Disposable {
@@ -4298,7 +4345,7 @@ module.exports = (() => {
 	 * @param {PositionLevelDefinition~keySelector} keySelector
 	 * @param {PositionLevelDefinition~descriptionSelector} descriptionSelector
 	 * @param {PositionLevelDefinition~currencySelector} currencySelector
-	 * @param {Array.<PositionLevelDefinition~RequiredGroup>=} requiredGroups
+	 * @param {PositionLevelDefinition~RequiredGroup[]=} requiredGroups
 	 * @param {Boolean=} aggregateCash
 	 * @param {Function=} requiredGroupGenerator
 	 */
@@ -4439,13 +4486,16 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {Object} portfolio
+		 * @param {Currency=} currency
 		 * @returns {PositionLevelDefinition~RequiredGroup}
 		 */
-		static buildRequiredGroupForPortfolio(portfolio) {
+		static buildRequiredGroupForPortfolio(portfolio, currency) {
+			assert.argumentIsOptional(currency, 'currency', Currency, 'Currency');
+
 			return {
 				key: PositionLevelDefinition.getKeyForPortfolioGroup(portfolio),
 				description: PositionLevelDefinition.getDescriptionForPortfolioGroup(portfolio),
-				currency: Currency.CAD
+				currency: (currency || Currency.CAD)
 			};
 		}
 
@@ -4461,12 +4511,12 @@ module.exports = (() => {
 			return portfolio.name;
 		}
 
-		static getRequiredGroupGeneratorForPortfolio() {
+		static getRequiredGroupGeneratorForPortfolio(currency) {
 			return (portfolio) => {
 				let requiredGroup;
 
 				if (is.object(portfolio) && is.string(portfolio.portfolio) && is.string(portfolio.name)) {
-					requiredGroup = PositionLevelDefinition.buildRequiredGroupForPortfolio(portfolio);
+					requiredGroup = PositionLevelDefinition.buildRequiredGroupForPortfolio(portfolio, currency);
 				} else {
 					requiredGroup = null;
 				}
@@ -4482,12 +4532,13 @@ module.exports = (() => {
 		 * @static
 		 * @param {InstrumentType} type
 		 * @param {Currency} currency
+		 * @param {Currency=} defaultCurrency
 		 * @returns {PositionLevelDefinition~RequiredGroup}
 		 */
-		static buildRequiredGroupForAssetClass(type, currency) {
+		static buildRequiredGroupForAssetClass(type, currency, defaultCurrency) {
 			return {
 				key: PositionLevelDefinition.getKeyForAssetClassGroup(type, currency),
-				description: PositionLevelDefinition.getDescriptionForAssetClassGroup(type, currency),
+				description: PositionLevelDefinition.getDescriptionForAssetClassGroup(type, currency, defaultCurrency),
 				currency: currency
 			};
 		}
@@ -4499,11 +4550,12 @@ module.exports = (() => {
 			return `${type.code}|${currency.code}`;
 		}
 
-		static getDescriptionForAssetClassGroup(type, currency) {
+		static getDescriptionForAssetClassGroup(type, currency, defaultCurrency) {
 			assert.argumentIsRequired(type, 'type', InstrumentType, 'InstrumentType');
 			assert.argumentIsRequired(currency, 'currency', Currency, 'Currency');
+			assert.argumentIsOptional(defaultCurrency, 'defaultCurrency', Currency, 'Currency');
 
-			return `${type.alternateDescription}${currency.code === 'CAD' ? '' : ` (${currency.alternateDescription})`}`;
+			return `${type.alternateDescription}${currency === (defaultCurrency || Currency.CAD) ? '' : ` (${currency.alternateDescription})`}`;
 		}
 
 		toString() {
@@ -4599,8 +4651,8 @@ module.exports = (() => {
 	 *
 	 * @public
 	 * @param {String} name
-	 * @param {Array.<PositionLevelDefinition>} definitions
-	 * @oaram {Array.<String>=} exclusionDependencies
+	 * @param {PositionLevelDefinition[]} definitions
+	 * @oaram {String[]=} exclusionDependencies
 	 */
 	class PositionTreeDefinitions {
 		constructor(name, definitions, exclusionDependencies) {
@@ -4633,7 +4685,7 @@ module.exports = (() => {
 		 * bottom-most level of the tree (i.e. leaf nodes).
 		 *
 		 * @public
-		 * @returns {Array.<PositionLevelDefinitions>}
+		 * @returns {PositionLevelDefinitions>[]}
 		 */
 		get definitions() {
 			return this._definitions;
@@ -4644,7 +4696,7 @@ module.exports = (() => {
 		 * group (from the current tree) is excluded.
 		 *
 		 * @public
-		 * @returns {Array.<String>}
+		 * @returns {String[]}
 		 */
 		get exclusionDependencies() {
 			return this._exclusionDependencies;
@@ -5283,7 +5335,7 @@ module.exports = function () {
   *
   * @public
   * @param {*} value - The value of the node.
-  * @param {Tree} parent - The parent node. If not supplied, this will be the root node.
+  * @param {Tree=} parent - The parent node. If not supplied, this will be the root node.
   */
 
 	var Tree = function () {
@@ -6429,7 +6481,20 @@ module.exports = function () {
 			}
 
 			/**
-    * Returns a new Day instance for the end of the month of the current instance.
+    * Returns a new {@link Day} instance for the start of the month referenced by the current instance.
+    *
+    * @public
+    * @returns {Day}
+    */
+
+		}, {
+			key: 'getStartOfMonth',
+			value: function getStartOfMonth() {
+				return new Day(this.year, this.month, 1);
+			}
+
+			/**
+    * Returns a new instance for the {@link Day} end of the month referenced by the current instance.
     *
     * @public
     * @returns {Day}
@@ -6581,7 +6646,7 @@ module.exports = function () {
 				return this._month;
 			}
 
-			/**
+			/**day
     * The day of the month.
     *
     * @public
@@ -6602,7 +6667,7 @@ module.exports = function () {
 			}
 
 			/**
-    * Converts a string (which matches the output of {@link Day#format} into
+    * Converts a string (which matches the output of {@link Day#format}) into
     * a {@link Day} instance.
     *
     * @public
@@ -6873,6 +6938,24 @@ module.exports = function () {
 				return new Decimal(this._big.div(getBig(other)));
 			}
 
+			/**
+    * Returns a new {@link Decimal} instance with a value that results
+    * from raising the current instance to the power of the exponent
+    * provided.
+    *
+    * @public
+    * @param {Decimal|Number|String} exponent
+    * @returns {Decimal}
+    */
+
+		}, {
+			key: 'raise',
+			value: function raise(exponent) {
+				assert.argumentIsRequired(exponent, 'exponent', Number);
+
+				return new Decimal(this._big.pow(exponent));
+			}
+
 			/**
     * Returns a new {@link Decimal} with a value resulting from a rounding
     * operation on the current value.
@@ -7037,6 +7120,28 @@ module.exports = function () {
 				return this._big.eq(getBig(other));
 			}
 
+			/**
+    * Returns true is close to another value.
+    *
+    * @public
+    * @param {Decimal|Number|String} other - The value to compare.
+    * @param {Number} places - The significant digits.
+    * @returns {Boolean}
+    */
+
+		}, {
+			key: 'getIsApproximate',
+			value: function getIsApproximate(other, places) {
+				if (places === 0) {
+					return this.getIsEqual(other);
+				}
+
+				var difference = this.subtract(other).absolute();
+				var tolerance = Decimal.ONE.divide(new Decimal(10).raise(places));
+
+				return difference.getIsLessThan(tolerance);
+			}
+
 			/**
     * Returns true if the current instance is an integer (i.e. has no decimal
     * component).
@@ -8720,8 +8825,62 @@ module.exports = function () {
 			}
 
 			return found;
+		},
+
+
+		/**
+   * Inserts an item into an array using a binary search is used to determine the
+   * proper point for insertion and returns the same array.
+   *
+   * @static
+   * @public
+   * @param {Array} a
+   * @param {*} item
+   * @param {Function} comparator
+   * @returns {Array}
+   */
+		insert: function insert(a, item, comparator) {
+			assert.argumentIsArray(a, 'a');
+			assert.argumentIsRequired(comparator, 'comparator', Function);
+
+			if (a.length === 0 || !(comparator(item, a[a.length - 1]) < 0)) {
+				a.push(item);
+			} else if (comparator(item, a[0]) < 0) {
+				a.unshift(item);
+			} else {
+				a.splice(binarySearch(a, item, comparator, 0, a.length - 1), 0, item);
+			}
+
+			return a;
 		}
 	};
+
+	function binarySearch(array, item, comparator, start, end) {
+		var size = end - start;
+
+		var midpointIndex = start + Math.floor(size / 2);
+		var midpointItem = array[midpointIndex];
+
+		var comparison = comparator(item, midpointItem) > 0;
+
+		if (size < 2) {
+			if (comparison > 0) {
+				var finalIndex = array.length - 1;
+
+				if (end === finalIndex && comparator(item, array[finalIndex]) > 0) {
+					return end + 1;
+				} else {
+					return end;
+				}
+			} else {
+				return start;
+			}
+		} else if (comparison > 0) {
+			return binarySearch(array, item, comparator, midpointIndex, end);
+		} else {
+			return binarySearch(array, item, comparator, start, midpointIndex);
+		}
+	}
 }();
 
 },{"./assert":29,"./is":33}],29:[function(require,module,exports){
@@ -8937,9 +9096,10 @@ module.exports = function () {
 		/**
    * Checks to see if an attribute exists on the target object.
    *
+   * @public
    * @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|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}
    */
@@ -8963,9 +9123,10 @@ module.exports = function () {
    * Returns a value from the target object. If the property doesn't exist; undefined
    * is returned.
    *
+   * @public
    * @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|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 {*}
    */
@@ -8998,9 +9159,10 @@ module.exports = function () {
 		/**
    * Writes a value to the target object.
    *
+   * @public
    * @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 {String|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=} separator - The separator (defaults to a period character).
    */
@@ -9025,9 +9187,10 @@ module.exports = function () {
 		/**
    * Erases a property from the target object.
    *
+   * @public
    * @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|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) {
@@ -9242,7 +9405,7 @@ module.exports = function () {
    * @static
    * @public
    * @param {*} candidate
-   * @returns {*|boolean}
+   * @returns {boolean}
    */
 		negative: function negative(candidate) {
 			return this.number(candidate) && candidate < 0;
@@ -9953,6 +10116,20 @@ module.exports = function () {
 				return dataTypeObject;
 			}
 
+			/**
+    * References an array.
+    *
+    * @public
+    * @static
+    * @returns {DataType}
+    */
+
+		}, {
+			key: 'ARRAY',
+			get: function get() {
+				return dataTypeArray;
+			}
+
 			/**
     * References a {@link Decimal} instance.
     *
@@ -10021,6 +10198,7 @@ module.exports = function () {
 	var dataTypeNumber = new DataType('Number', null, null, is.number);
 	var dataTypeBoolean = new DataType('Boolean', null, null, is.boolean);
 	var dataTypeObject = new DataType('Object', null, null, is.object);
+	var dataTypeArray = new DataType('Array', null, null, is.array);
 
 	var dataTypeDecimal = new DataType('Decimal', null, function (x) {
 		return Decimal.parse(x);
@@ -10043,7 +10221,7 @@ module.exports = function () {
 		return x instanceof AdHoc;
 	}, getBuilder(buildAdHoc));
 
-	var dataTypes = [dataTypeString, dataTypeNumber, dataTypeBoolean, dataTypeObject, dataTypeDecimal, dataTypeDay, dataTypeTimestamp, dataTypeAdHoc];
+	var dataTypes = [dataTypeString, dataTypeNumber, dataTypeBoolean, dataTypeObject, dataTypeArray, dataTypeDecimal, dataTypeDay, dataTypeTimestamp, dataTypeAdHoc];
 
 	function getBuilder(builder) {
 		return function (data) {