@barchart/portfolio-api-common 1.0.160 → 1.0.164

package/lib/processing/PositionContainer.js

@@ -48,17 +48,9 @@ module.exports = (() => {
 			const currentSummaryFrame = PositionSummaryFrame.YTD;
 			const currentSummaryRange = array.last(currentSummaryFrame.getRecentRanges(0));
 
-			this._groupBindings = { };
-
-			const addGroupBinding = (group, dispoable) => {
-				const id = group.id;
-
-				if (!this._groupBindings.hasOwnProperty(id)) {
-					this._groupBindings[id] = new DisposableStack();
-				}
+			this._definitions = definitions;
 
-				this._groupBindings[id].push(dispoable);
-			};
+			this._groupBindings = { };
 
 			this._portfolios = portfolios.reduce((map, portfolio) => {
 				map[portfolio.portfolio] = portfolio;
@@ -164,132 +156,82 @@ module.exports = (() => {
 				return Rate.fromPair(Decimal.ONE, symbol);
 			});
 			
-			this._trees = definitions.reduce((map, treeDefinition) => {
+			this._trees = this._definitions.reduce((map, treeDefinition) => {
 				const tree = new Tree();
 
-				const createGroups = (currentTree, items, levelDefinitions) => {
-					if (levelDefinitions.length === 0) {
-						return;
-					}
-
-					const parent = currentTree.getValue() || null;
-
-					const levelDefinition = levelDefinitions[0];
-
-					const populatedObjects = array.groupBy(items, levelDefinition.keySelector);
-					const populatedGroups = Object.keys(populatedObjects).reduce((list, key) => {
-						const items = populatedObjects[key];
-						const first = items[0];
+				createGroups.call(this, tree, tree, this._items, treeDefinition, treeDefinition.definitions);
+				
+				map[treeDefinition.name] = tree;
 
-						list.push(new PositionGroup(this, parent, items, levelDefinition.currencySelector(first), key, levelDefinition.descriptionSelector(first), levelDefinition.single && items.length === 1, levelDefinition.aggregateCash));
+				return map;
+			}, { });
+		}
 
-						return list;
-					}, [ ]);
+		addPortfolio(portfolio) {
+			assert.argumentIsRequired(portfolio, 'portfolio', Object);
+			assert.argumentIsRequired(portfolio.portfolio, 'portfolio.portfolio', String);
+			assert.argumentIsRequired(portfolio.name, 'portfolio.name', String);
 
-					const missingGroups = array.difference(levelDefinition.requiredGroups.map(group => group.key), populatedGroups.map(group => group.key))
-						.map((key) => {
-							return levelDefinition.requiredGroups.find(g => g.key === key);
-						});
+			const key = portfolio.portfolio;
 
-					const empty = missingGroups.map((group) => {
-						return new PositionGroup(this, parent, [ ], group.currency, group.key, group.description);
-					});
+			if (!this._portfolios.hasOwnProperty(key)) {
+				this._portfolios[key] = portfolio;
 
-					const compositeGroups = populatedGroups.concat(empty);
+				this._definitions.forEach((treeDefinition) => {
+					const tree = this._trees[treeDefinition.name];
+					const levelDefinitions = treeDefinition.definitions;
 
-					let builder;
+					let portfolioRequiredGroup = null;
 
-					if (levelDefinition.requiredGroups.length !== 0) {
-						const ordering = levelDefinition.requiredGroups.reduce((map, group, index) => {
-							map[group.description] = index;
+					let portfolioLevelDefinition = null;
+					let portfolioLevelDefinitionIndex = null;
 
-							return map;
-						}, { });
+					levelDefinitions.forEach((levelDefinition, i) => {
+						if (portfolioRequiredGroup === null) {
+							portfolioRequiredGroup = levelDefinition.generateRequiredGroup(portfolio);
 
-						const getIndex = (description) => {
-							if (ordering.hasOwnProperty(description)) {
-								return ordering[description];
-							} else {
-								return Number.MAX_VALUE;
+							if (portfolioRequiredGroup !== null) {
+								portfolioLevelDefinition = levelDefinition;
+								portfolioLevelDefinitionIndex = i;
 							}
-						};
+						}
+					});
 
-						builder = ComparatorBuilder.startWith((a, b) => {
-							return comparators.compareNumbers(getIndex(a.description), getIndex(b.description));
-						}).thenBy((a, b) => {
-							return comparators.compareStrings(a.description, b.description);
-						});
-					} else {
-						builder = ComparatorBuilder.startWith((a, b) => {
-							return comparators.compareStrings(a.description, b.description);
-						});
-					}
+					if (portfolioRequiredGroup !== null) {
+						let parentTrees = [ ];
 
-					compositeGroups.sort(builder.toComparator());
+						if (portfolioLevelDefinitionIndex === 0) {
+							parentTrees.push(tree);
+						} else {
+							const parentLevelDefinition = levelDefinitions[ portfolioLevelDefinitionIndex - 1 ];
 
-					const initializeGroupObservers = (group, groupTree) => {
-						addGroupBinding(group, group.registerGroupExcludedChangeHandler((excluded, sender) => {
-							groupTree.climb((parentGroup) => {
-								if (parentGroup) {
-									let excludedItems = [];
+							tree.walk((group, groupTree) => {
+								if (group.definition === parentLevelDefinition) {
+									parentTrees.push(groupTree);
+								}
+							});
+						}
 
-									currentTree.walk((childGroup) => {
-										if (childGroup.excluded) {
-											excludedItems = excludedItems.concat(childGroup.items);
-										}
-									}, false, false);
+						const overrideRequiredGroups = [ portfolioRequiredGroup ];
 
-									parentGroup.setExcludedItems(array.unique(excludedItems));
-								}
-							}, false);
-
-							if (treeDefinition.exclusionDependencies.length > 0) {
-								const dependantTrees = treeDefinition.exclusionDependencies.reduce((trees, name) => {
-									if (this._trees.hasOwnProperty(name)) {
-										trees.push(this._trees[name]);
-									}
-
-									return trees;
-								}, [ ]);
-
-								if (dependantTrees.length > 0) {
-									let excludedItems = [ ];
-
-									tree.walk((childGroup) => {
-										if (childGroup.excluded) {
-											excludedItems = excludedItems.concat(childGroup.items);
-										}
-									}, false, false);
-
-									dependantTrees.forEach((dependantTrees) => {
-										dependantTrees.walk((childGroup) => {
-											childGroup.setExcludedItems(excludedItems);
-										}, false, false);
-									});
-								}
-							}
-						}));
-					};
+						parentTrees.forEach((t) => {
+							createGroups.call(this, tree, t, [ ], treeDefinition, levelDefinitions.slice(portfolioLevelDefinitionIndex), overrideRequiredGroups);
+						});
+					}
+				});
+			}
+		}
 
-					compositeGroups.forEach((group) => {
-						const childTree = currentTree.addChild(group);
+		removePortfolio(portfolio) {
 
-						initializeGroupObservers(group, childTree);
+		}
 
-						addGroupBinding(group, group.registerMarketPercentChangeHandler(() => {
-							currentTree.walk((childGroup) => childGroup.refreshMarketPercent());
-						}));
+		mutatePosition(position, summary) {
 
-						createGroups(childTree, group.items, array.dropLeft(levelDefinitions));
-					});
-				};
+		}
 
-				createGroups(tree, this._items, treeDefinition.definitions);
-				
-				map[treeDefinition.name] = tree;
+		removePosition(position) {
 
-				return map;
-			}, { });
 		}
 
 		/**
@@ -523,5 +465,134 @@ module.exports = (() => {
 		}
 	}
 
+	function addGroupBinding(group, dispoable) {
+		const id = group.id;
+
+		if (!this._groupBindings.hasOwnProperty(id)) {
+			this._groupBindings[id] = new DisposableStack();
+		}
+
+		this._groupBindings[id].push(dispoable);
+	}
+
+	function createGroups(parentTree, currentTree, items, treeDefinition, levelDefinitions, overrideRequiredGroups) {
+		if (levelDefinitions.length === 0) {
+			return;
+		}
+
+		const parent = currentTree.getValue() || null;
+
+		const levelDefinition = levelDefinitions[0];
+
+		const populatedObjects = array.groupBy(items, levelDefinition.keySelector);
+		const populatedGroups = Object.keys(populatedObjects).reduce((list, key) => {
+			const items = populatedObjects[key];
+			const first = items[0];
+
+			list.push(new PositionGroup(this, parent, levelDefinition, items, levelDefinition.currencySelector(first), key, levelDefinition.descriptionSelector(first), levelDefinition.single && items.length === 1, levelDefinition.aggregateCash));
+
+			return list;
+		}, [ ]);
+
+		const requiredGroupsToUse = overrideRequiredGroups || levelDefinition.requiredGroups;
+
+		const missingGroups = array.difference(requiredGroupsToUse.map(group => group.key), populatedGroups.map(group => group.key))
+			.map((key) => {
+				return requiredGroupsToUse.find(g => g.key === key);
+			});
+
+		const empty = missingGroups.map((group) => {
+			return new PositionGroup(this, parent, levelDefinition, [ ], group.currency, group.key, group.description);
+		});
+
+		const compositeGroups = populatedGroups.concat(empty);
+
+		let builder;
+
+		if (requiredGroupsToUse.length !== 0) {
+			const ordering = requiredGroupsToUse.reduce((map, group, index) => {
+				map[group.description] = index;
+
+				return map;
+			}, { });
+
+			const getIndex = (description) => {
+				if (ordering.hasOwnProperty(description)) {
+					return ordering[description];
+				} else {
+					return Number.MAX_VALUE;
+				}
+			};
+
+			builder = ComparatorBuilder.startWith((a, b) => {
+				return comparators.compareNumbers(getIndex(a.description), getIndex(b.description));
+			}).thenBy((a, b) => {
+				return comparators.compareStrings(a.description, b.description);
+			});
+		} else {
+			builder = ComparatorBuilder.startWith((a, b) => {
+				return comparators.compareStrings(a.description, b.description);
+			});
+		}
+
+		compositeGroups.sort(builder.toComparator());
+
+		const initializeGroupObservers = (group, groupTree) => {
+			addGroupBinding.call(this, group, group.registerGroupExcludedChangeHandler((excluded, sender) => {
+				groupTree.climb((parentGroup) => {
+					if (parentGroup) {
+						let excludedItems = [];
+
+						currentTree.walk((childGroup) => {
+							if (childGroup.excluded) {
+								excludedItems = excludedItems.concat(childGroup.items);
+							}
+						}, false, false);
+
+						parentGroup.setExcludedItems(array.unique(excludedItems));
+					}
+				}, false);
+
+				if (treeDefinition.exclusionDependencies.length > 0) {
+					const dependantTrees = treeDefinition.exclusionDependencies.reduce((trees, name) => {
+						if (this._trees.hasOwnProperty(name)) {
+							trees.push(this._trees[name]);
+						}
+
+						return trees;
+					}, [ ]);
+
+					if (dependantTrees.length > 0) {
+						let excludedItems = [ ];
+
+						parentTree.walk((childGroup) => {
+							if (childGroup.excluded) {
+								excludedItems = excludedItems.concat(childGroup.items);
+							}
+						}, false, false);
+
+						dependantTrees.forEach((dependantTrees) => {
+							dependantTrees.walk((childGroup) => {
+								childGroup.setExcludedItems(excludedItems);
+							}, false, false);
+						});
+					}
+				}
+			}));
+		};
+
+		compositeGroups.forEach((group) => {
+			const childTree = currentTree.addChild(group);
+
+			initializeGroupObservers(group, childTree);
+
+			addGroupBinding.call(this, group, group.registerMarketPercentChangeHandler(() => {
+				currentTree.walk((childGroup) => childGroup.refreshMarketPercent());
+			}));
+
+			createGroups.call(this, parentTree, childTree, group.items, treeDefinition, array.dropLeft(levelDefinitions));
+		});
+	}
+
 	return PositionContainer;
 })();

package/lib/processing/PositionGroup.js

@@ -22,6 +22,7 @@ module.exports = (() => {
 	 * @public
 	 * @param {PositionContainer} container
 	 * @param {PositionGroup|null} parent
+	 * @param {LevelDefinition} definition
 	 * @param {Array.<PositionItem>} items
 	 * @param {Currency} currency
 	 * @param {String} key
@@ -30,8 +31,10 @@ module.exports = (() => {
 	 * @param {Boolean=} aggregateCash
 	 */
 	class PositionGroup {
-		constructor(container, parent, items, currency, key, description, single, aggregateCash) {
+		constructor(container, parent, definition, items, currency, key, description, single, aggregateCash) {
 			this._id = counter++;
+
+			this._definition = definition;
 			this._container = container;
 			this._parent = parent || null;
 
@@ -209,6 +212,16 @@ module.exports = (() => {
 			return this._id;
 		}
 
+		/**
+		 * The {@link LevelDefinition} which was used to generate this group.
+		 *
+		 * @public
+		 * @returns {LevelDefinition}
+		 */
+		get definition() {
+			return this._definition;
+		}
+
 		/**
 		 * The key of the group.
 		 *
@@ -294,6 +307,16 @@ module.exports = (() => {
 			return this._excluded;
 		}
 
+		addItems(items) {
+
+			this.refresh();
+		}
+
+		removeItems(items) {
+
+			this.refresh();
+		}
+
 		/**
 		 * Sets the list of items which are excluded from group aggregation calculations.
 		 *

package/lib/processing/definitions/PositionLevelDefinition.js

@@ -1,6 +1,9 @@
 const assert = require('@barchart/common-js/lang/assert'),
+	Currency = require('@barchart/common-js/lang/Currency'),
 	is = require('@barchart/common-js/lang/is');
 
+const InstrumentType = require('./../../data/InstrumentType');
+
 module.exports = (() => {
 	'use strict';
 
@@ -15,12 +18,12 @@ module.exports = (() => {
 	 * @param {PositionLevelDefinition~descriptionSelector} descriptionSelector
 	 * @param {PositionLevelDefinition~currencySelector} currencySelector
 	 * @param {Array.<PositionLevelDefinition~RequiredGroup>=} requiredGroups
-	 * @param {Array.<PositionLevelDefinition~RequiredGroup>=} requiredGroups
 	 * @param {Boolean=} single
 	 * @param {Boolean=} aggregateCash
+	 * @param {Function=} injectPositions
 	 */
 	class PositionLevelDefinition {
-		constructor(name, keySelector, descriptionSelector, currencySelector, requiredGroups, single, aggregateCash) {
+		constructor(name, keySelector, descriptionSelector, currencySelector, requiredGroups, single, aggregateCash, requiredGroupGenerator) {
 			assert.argumentIsRequired(name, 'name', String);
 			assert.argumentIsRequired(keySelector, 'keySelector', Function);
 			assert.argumentIsRequired(descriptionSelector, 'descriptionSelector', Function);
@@ -32,6 +35,7 @@ module.exports = (() => {
 
 			assert.argumentIsOptional(single, 'single', Boolean);
 			assert.argumentIsOptional(aggregateCash, 'aggregateCash', Boolean);
+			assert.argumentIsOptional(requiredGroupGenerator, 'requiredGroupGenerator', Function);
 
 			this._name = name;
 
@@ -40,8 +44,11 @@ module.exports = (() => {
 			this._currencySelector = currencySelector;
 
 			this._requiredGroups = requiredGroups || [ ];
+
 			this._single = is.boolean(single) && single;
 			this._aggregateCash = is.boolean(aggregateCash) && aggregateCash;
+
+			this._requiredGroupGenerator = requiredGroupGenerator || (input => null);
 		}
 
 		/**
@@ -118,6 +125,96 @@ module.exports = (() => {
 			return this._aggregateCash;
 		}
 
+		/**
+		 * Given an input, potentially creates a new {@link PositionLevelDefinition~RequiredGroup}.
+		 *
+		 * @public
+		 * @param {*} input
+		 * @returns {PositionLevelDefinition~RequiredGroup|null}
+		 */
+		generateRequiredGroup(input) {
+			const requiredGroup = this._requiredGroupGenerator(input);
+
+			if (requiredGroup !== null) {
+				this._requiredGroups.push(requiredGroup);
+			}
+
+			return requiredGroup;
+		}
+
+		/**
+		 * Builds a {@link PositionLevelDefinition~RequiredGroup} for a portfolio.
+		 *
+		 * @public
+		 * @static
+		 * @param {Object} portfolio
+		 * @return {PositionLevelDefinition~RequiredGroup}
+		 */
+		static buildRequiredGroupForPortfolio(portfolio) {
+			return {
+				key: PositionLevelDefinition.getKeyForPortfolioGroup(portfolio),
+				description: PositionLevelDefinition.getDescriptionForPortfolioGroup(portfolio),
+				currency: Currency.CAD
+			};
+		}
+
+		static getKeyForPortfolioGroup(portfolio) {
+			assert.argumentIsRequired(portfolio, 'portfolio', Object);
+
+			return portfolio.portfolio;
+		}
+
+		static getDescriptionForPortfolioGroup(portfolio) {
+			assert.argumentIsRequired(portfolio, 'portfolio', Object);
+
+			return portfolio.name;
+		}
+
+		static getRequiredGroupGeneratorForPortfolio() {
+			return (portfolio) => {
+				let requiredGroup;
+
+				if (is.object(portfolio) && is.string(portfolio.portfolio) && is.string(portfolio.name)) {
+					requiredGroup = PositionLevelDefinition.buildRequiredGroupForPortfolio(portfolio);
+				} else {
+					requiredGroup = null;
+				}
+
+				return requiredGroup;
+			};
+		}
+
+		/**
+		 * Builds a {@link PositionLevelDefinition~RequiredGroup} for an asset class.
+		 *
+		 * @public
+		 * @static
+		 * @param {InstrumentType} type
+		 * @param {Currency} currency
+		 * @return {PositionLevelDefinition~RequiredGroup}
+		 */
+		static buildRequiredGroupForAssetClass(type, currency) {
+			return {
+				key: PositionLevelDefinition.getKeyForAssetClassGroup(type, currency),
+				description: PositionLevelDefinition.getDescriptionForAssetClassGroup(type, currency),
+				currency: currency
+			};
+		}
+
+		static getKeyForAssetClassGroup(type, currency) {
+			assert.argumentIsRequired(type, 'type', InstrumentType, 'InstrumentType');
+			assert.argumentIsRequired(currency, 'currency', Currency, 'Currency');
+
+			return `${type.code}|${currency.code}`;
+		}
+
+		static getDescriptionForAssetClassGroup(type, currency) {
+			assert.argumentIsRequired(type, 'type', InstrumentType, 'InstrumentType');
+			assert.argumentIsRequired(currency, 'currency', Currency, 'Currency');
+
+			return `${type.alternateDescription}${currency.code === 'CAD' ? '' : ` (${currency.alternateDescription})`}`;
+		}
+
 		toString() {
 			return '[PositionLevelDefinition]';
 		}

package/lib/processing/definitions/PositionTreeDefinition.js

@@ -43,7 +43,7 @@ module.exports = (() => {
 		 * bottom-most level of the tree (i.e. leaf nodes).
 		 *
 		 * @public
-		 * @returns {Array.<PositionTreeDefinition>}
+		 * @returns {Array.<PositionLevelDefinitions>}
 		 */
 		get definitions() {
 			return this._definitions;

package/package.json

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

package/test/SpecRunner.js

@@ -764,17 +764,9 @@ module.exports = (() => {
 			const currentSummaryFrame = PositionSummaryFrame.YTD;
 			const currentSummaryRange = array.last(currentSummaryFrame.getRecentRanges(0));
 
-			this._groupBindings = { };
-
-			const addGroupBinding = (group, dispoable) => {
-				const id = group.id;
-
-				if (!this._groupBindings.hasOwnProperty(id)) {
-					this._groupBindings[id] = new DisposableStack();
-				}
+			this._definitions = definitions;
 
-				this._groupBindings[id].push(dispoable);
-			};
+			this._groupBindings = { };
 
 			this._portfolios = portfolios.reduce((map, portfolio) => {
 				map[portfolio.portfolio] = portfolio;
@@ -880,132 +872,82 @@ module.exports = (() => {
 				return Rate.fromPair(Decimal.ONE, symbol);
 			});
 			
-			this._trees = definitions.reduce((map, treeDefinition) => {
+			this._trees = this._definitions.reduce((map, treeDefinition) => {
 				const tree = new Tree();
 
-				const createGroups = (currentTree, items, levelDefinitions) => {
-					if (levelDefinitions.length === 0) {
-						return;
-					}
+				createGroups.call(this, tree, tree, this._items, treeDefinition, treeDefinition.definitions);
+				
+				map[treeDefinition.name] = tree;
 
-					const parent = currentTree.getValue() || null;
+				return map;
+			}, { });
+		}
 
-					const levelDefinition = levelDefinitions[0];
+		addPortfolio(portfolio) {
+			assert.argumentIsRequired(portfolio, 'portfolio', Object);
+			assert.argumentIsRequired(portfolio.portfolio, 'portfolio.portfolio', String);
+			assert.argumentIsRequired(portfolio.name, 'portfolio.name', String);
 
-					const populatedObjects = array.groupBy(items, levelDefinition.keySelector);
-					const populatedGroups = Object.keys(populatedObjects).reduce((list, key) => {
-						const items = populatedObjects[key];
-						const first = items[0];
+			const key = portfolio.portfolio;
 
-						list.push(new PositionGroup(this, parent, items, levelDefinition.currencySelector(first), key, levelDefinition.descriptionSelector(first), levelDefinition.single && items.length === 1, levelDefinition.aggregateCash));
+			if (!this._portfolios.hasOwnProperty(key)) {
+				this._portfolios[key] = portfolio;
 
-						return list;
-					}, [ ]);
+				this._definitions.forEach((treeDefinition) => {
+					const tree = this._trees[treeDefinition.name];
+					const levelDefinitions = treeDefinition.definitions;
 
-					const missingGroups = array.difference(levelDefinition.requiredGroups.map(group => group.key), populatedGroups.map(group => group.key))
-						.map((key) => {
-							return levelDefinition.requiredGroups.find(g => g.key === key);
-						});
+					let portfolioRequiredGroup = null;
 
-					const empty = missingGroups.map((group) => {
-						return new PositionGroup(this, parent, [ ], group.currency, group.key, group.description);
-					});
+					let portfolioLevelDefinition = null;
+					let portfolioLevelDefinitionIndex = null;
 
-					const compositeGroups = populatedGroups.concat(empty);
+					levelDefinitions.forEach((levelDefinition, i) => {
+						if (portfolioRequiredGroup === null) {
+							portfolioRequiredGroup = levelDefinition.generateRequiredGroup(portfolio);
 
-					let builder;
+							if (portfolioRequiredGroup !== null) {
+								portfolioLevelDefinition = levelDefinition;
+								portfolioLevelDefinitionIndex = i;
+							}
+						}
+					});
 
-					if (levelDefinition.requiredGroups.length !== 0) {
-						const ordering = levelDefinition.requiredGroups.reduce((map, group, index) => {
-							map[group.description] = index;
+					if (portfolioRequiredGroup !== null) {
+						let parentTrees = [ ];
 
-							return map;
-						}, { });
+						if (portfolioLevelDefinitionIndex === 0) {
+							parentTrees.push(tree);
+						} else {
+							const parentLevelDefinition = levelDefinitions[ portfolioLevelDefinitionIndex - 1 ];
 
-						const getIndex = (description) => {
-							if (ordering.hasOwnProperty(description)) {
-								return ordering[description];
-							} else {
-								return Number.MAX_VALUE;
-							}
-						};
+							tree.walk((group, groupTree) => {
+								if (group.definition === parentLevelDefinition) {
+									parentTrees.push(groupTree);
+								}
+							});
+						}
 
-						builder = ComparatorBuilder.startWith((a, b) => {
-							return comparators.compareNumbers(getIndex(a.description), getIndex(b.description));
-						}).thenBy((a, b) => {
-							return comparators.compareStrings(a.description, b.description);
-						});
-					} else {
-						builder = ComparatorBuilder.startWith((a, b) => {
-							return comparators.compareStrings(a.description, b.description);
+						const overrideRequiredGroups = [ portfolioRequiredGroup ];
+
+						parentTrees.forEach((t) => {
+							createGroups.call(this, tree, t, [ ], treeDefinition, levelDefinitions.slice(portfolioLevelDefinitionIndex), overrideRequiredGroups);
 						});
 					}
+				});
+			}
+		}
 
-					compositeGroups.sort(builder.toComparator());
-
-					const initializeGroupObservers = (group, groupTree) => {
-						addGroupBinding(group, group.registerGroupExcludedChangeHandler((excluded, sender) => {
-							groupTree.climb((parentGroup) => {
-								if (parentGroup) {
-									let excludedItems = [];
-
-									currentTree.walk((childGroup) => {
-										if (childGroup.excluded) {
-											excludedItems = excludedItems.concat(childGroup.items);
-										}
-									}, false, false);
-
-									parentGroup.setExcludedItems(array.unique(excludedItems));
-								}
-							}, false);
-
-							if (treeDefinition.exclusionDependencies.length > 0) {
-								const dependantTrees = treeDefinition.exclusionDependencies.reduce((trees, name) => {
-									if (this._trees.hasOwnProperty(name)) {
-										trees.push(this._trees[name]);
-									}
-
-									return trees;
-								}, [ ]);
-
-								if (dependantTrees.length > 0) {
-									let excludedItems = [ ];
-
-									tree.walk((childGroup) => {
-										if (childGroup.excluded) {
-											excludedItems = excludedItems.concat(childGroup.items);
-										}
-									}, false, false);
-
-									dependantTrees.forEach((dependantTrees) => {
-										dependantTrees.walk((childGroup) => {
-											childGroup.setExcludedItems(excludedItems);
-										}, false, false);
-									});
-								}
-							}
-						}));
-					};
+		removePortfolio(portfolio) {
 
-					compositeGroups.forEach((group) => {
-						const childTree = currentTree.addChild(group);
+		}
 
-						initializeGroupObservers(group, childTree);
+		mutatePosition(position, summary) {
 
-						addGroupBinding(group, group.registerMarketPercentChangeHandler(() => {
-							currentTree.walk((childGroup) => childGroup.refreshMarketPercent());
-						}));
+		}
 
-						createGroups(childTree, group.items, array.dropLeft(levelDefinitions));
-					});
-				};
+		removePosition(position) {
 
-				createGroups(tree, this._items, treeDefinition.definitions);
-				
-				map[treeDefinition.name] = tree;
-
-				return map;
-			}, { });
 		}
 
 		/**
@@ -1239,6 +1181,135 @@ module.exports = (() => {
 		}
 	}
 
+	function addGroupBinding(group, dispoable) {
+		const id = group.id;
+
+		if (!this._groupBindings.hasOwnProperty(id)) {
+			this._groupBindings[id] = new DisposableStack();
+		}
+
+		this._groupBindings[id].push(dispoable);
+	}
+
+	function createGroups(parentTree, currentTree, items, treeDefinition, levelDefinitions, overrideRequiredGroups) {
+		if (levelDefinitions.length === 0) {
+			return;
+		}
+
+		const parent = currentTree.getValue() || null;
+
+		const levelDefinition = levelDefinitions[0];
+
+		const populatedObjects = array.groupBy(items, levelDefinition.keySelector);
+		const populatedGroups = Object.keys(populatedObjects).reduce((list, key) => {
+			const items = populatedObjects[key];
+			const first = items[0];
+
+			list.push(new PositionGroup(this, parent, levelDefinition, items, levelDefinition.currencySelector(first), key, levelDefinition.descriptionSelector(first), levelDefinition.single && items.length === 1, levelDefinition.aggregateCash));
+
+			return list;
+		}, [ ]);
+
+		const requiredGroupsToUse = overrideRequiredGroups || levelDefinition.requiredGroups;
+
+		const missingGroups = array.difference(requiredGroupsToUse.map(group => group.key), populatedGroups.map(group => group.key))
+			.map((key) => {
+				return requiredGroupsToUse.find(g => g.key === key);
+			});
+
+		const empty = missingGroups.map((group) => {
+			return new PositionGroup(this, parent, levelDefinition, [ ], group.currency, group.key, group.description);
+		});
+
+		const compositeGroups = populatedGroups.concat(empty);
+
+		let builder;
+
+		if (requiredGroupsToUse.length !== 0) {
+			const ordering = requiredGroupsToUse.reduce((map, group, index) => {
+				map[group.description] = index;
+
+				return map;
+			}, { });
+
+			const getIndex = (description) => {
+				if (ordering.hasOwnProperty(description)) {
+					return ordering[description];
+				} else {
+					return Number.MAX_VALUE;
+				}
+			};
+
+			builder = ComparatorBuilder.startWith((a, b) => {
+				return comparators.compareNumbers(getIndex(a.description), getIndex(b.description));
+			}).thenBy((a, b) => {
+				return comparators.compareStrings(a.description, b.description);
+			});
+		} else {
+			builder = ComparatorBuilder.startWith((a, b) => {
+				return comparators.compareStrings(a.description, b.description);
+			});
+		}
+
+		compositeGroups.sort(builder.toComparator());
+
+		const initializeGroupObservers = (group, groupTree) => {
+			addGroupBinding.call(this, group, group.registerGroupExcludedChangeHandler((excluded, sender) => {
+				groupTree.climb((parentGroup) => {
+					if (parentGroup) {
+						let excludedItems = [];
+
+						currentTree.walk((childGroup) => {
+							if (childGroup.excluded) {
+								excludedItems = excludedItems.concat(childGroup.items);
+							}
+						}, false, false);
+
+						parentGroup.setExcludedItems(array.unique(excludedItems));
+					}
+				}, false);
+
+				if (treeDefinition.exclusionDependencies.length > 0) {
+					const dependantTrees = treeDefinition.exclusionDependencies.reduce((trees, name) => {
+						if (this._trees.hasOwnProperty(name)) {
+							trees.push(this._trees[name]);
+						}
+
+						return trees;
+					}, [ ]);
+
+					if (dependantTrees.length > 0) {
+						let excludedItems = [ ];
+
+						parentTree.walk((childGroup) => {
+							if (childGroup.excluded) {
+								excludedItems = excludedItems.concat(childGroup.items);
+							}
+						}, false, false);
+
+						dependantTrees.forEach((dependantTrees) => {
+							dependantTrees.walk((childGroup) => {
+								childGroup.setExcludedItems(excludedItems);
+							}, false, false);
+						});
+					}
+				}
+			}));
+		};
+
+		compositeGroups.forEach((group) => {
+			const childTree = currentTree.addChild(group);
+
+			initializeGroupObservers(group, childTree);
+
+			addGroupBinding.call(this, group, group.registerMarketPercentChangeHandler(() => {
+				currentTree.walk((childGroup) => childGroup.refreshMarketPercent());
+			}));
+
+			createGroups.call(this, parentTree, childTree, group.items, treeDefinition, array.dropLeft(levelDefinitions));
+		});
+	}
+
 	return PositionContainer;
 })();
 
@@ -1267,6 +1338,7 @@ module.exports = (() => {
 	 * @public
 	 * @param {PositionContainer} container
 	 * @param {PositionGroup|null} parent
+	 * @param {LevelDefinition} definition
 	 * @param {Array.<PositionItem>} items
 	 * @param {Currency} currency
 	 * @param {String} key
@@ -1275,8 +1347,10 @@ module.exports = (() => {
 	 * @param {Boolean=} aggregateCash
 	 */
 	class PositionGroup {
-		constructor(container, parent, items, currency, key, description, single, aggregateCash) {
+		constructor(container, parent, definition, items, currency, key, description, single, aggregateCash) {
 			this._id = counter++;
+
+			this._definition = definition;
 			this._container = container;
 			this._parent = parent || null;
 
@@ -1454,6 +1528,16 @@ module.exports = (() => {
 			return this._id;
 		}
 
+		/**
+		 * The {@link LevelDefinition} which was used to generate this group.
+		 *
+		 * @public
+		 * @returns {LevelDefinition}
+		 */
+		get definition() {
+			return this._definition;
+		}
+
 		/**
 		 * The key of the group.
 		 *
@@ -1539,6 +1623,16 @@ module.exports = (() => {
 			return this._excluded;
 		}
 
+		addItems(items) {
+
+			this.refresh();
+		}
+
+		removeItems(items) {
+
+			this.refresh();
+		}
+
 		/**
 		 * Sets the list of items which are excluded from group aggregation calculations.
 		 *
@@ -2295,8 +2389,11 @@ module.exports = (() => {
 
 },{"./../data/InstrumentType":1,"@barchart/common-js/lang/Currency":14,"@barchart/common-js/lang/Decimal":16,"@barchart/common-js/lang/array":20,"@barchart/common-js/lang/assert":21,"@barchart/common-js/lang/is":23,"@barchart/common-js/messaging/Event":25}],7:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
+	Currency = require('@barchart/common-js/lang/Currency'),
 	is = require('@barchart/common-js/lang/is');
 
+const InstrumentType = require('./../../data/InstrumentType');
+
 module.exports = (() => {
 	'use strict';
 
@@ -2311,12 +2408,12 @@ module.exports = (() => {
 	 * @param {PositionLevelDefinition~descriptionSelector} descriptionSelector
 	 * @param {PositionLevelDefinition~currencySelector} currencySelector
 	 * @param {Array.<PositionLevelDefinition~RequiredGroup>=} requiredGroups
-	 * @param {Array.<PositionLevelDefinition~RequiredGroup>=} requiredGroups
 	 * @param {Boolean=} single
 	 * @param {Boolean=} aggregateCash
+	 * @param {Function=} injectPositions
 	 */
 	class PositionLevelDefinition {
-		constructor(name, keySelector, descriptionSelector, currencySelector, requiredGroups, single, aggregateCash) {
+		constructor(name, keySelector, descriptionSelector, currencySelector, requiredGroups, single, aggregateCash, requiredGroupGenerator) {
 			assert.argumentIsRequired(name, 'name', String);
 			assert.argumentIsRequired(keySelector, 'keySelector', Function);
 			assert.argumentIsRequired(descriptionSelector, 'descriptionSelector', Function);
@@ -2328,6 +2425,7 @@ module.exports = (() => {
 
 			assert.argumentIsOptional(single, 'single', Boolean);
 			assert.argumentIsOptional(aggregateCash, 'aggregateCash', Boolean);
+			assert.argumentIsOptional(requiredGroupGenerator, 'requiredGroupGenerator', Function);
 
 			this._name = name;
 
@@ -2336,8 +2434,11 @@ module.exports = (() => {
 			this._currencySelector = currencySelector;
 
 			this._requiredGroups = requiredGroups || [ ];
+
 			this._single = is.boolean(single) && single;
 			this._aggregateCash = is.boolean(aggregateCash) && aggregateCash;
+
+			this._requiredGroupGenerator = requiredGroupGenerator || (input => null);
 		}
 
 		/**
@@ -2414,6 +2515,96 @@ module.exports = (() => {
 			return this._aggregateCash;
 		}
 
+		/**
+		 * Given an input, potentially creates a new {@link PositionLevelDefinition~RequiredGroup}.
+		 *
+		 * @public
+		 * @param {*} input
+		 * @returns {PositionLevelDefinition~RequiredGroup|null}
+		 */
+		generateRequiredGroup(input) {
+			const requiredGroup = this._requiredGroupGenerator(input);
+
+			if (requiredGroup !== null) {
+				this._requiredGroups.push(requiredGroup);
+			}
+
+			return requiredGroup;
+		}
+
+		/**
+		 * Builds a {@link PositionLevelDefinition~RequiredGroup} for a portfolio.
+		 *
+		 * @public
+		 * @static
+		 * @param {Object} portfolio
+		 * @return {PositionLevelDefinition~RequiredGroup}
+		 */
+		static buildRequiredGroupForPortfolio(portfolio) {
+			return {
+				key: PositionLevelDefinition.getKeyForPortfolioGroup(portfolio),
+				description: PositionLevelDefinition.getDescriptionForPortfolioGroup(portfolio),
+				currency: Currency.CAD
+			};
+		}
+
+		static getKeyForPortfolioGroup(portfolio) {
+			assert.argumentIsRequired(portfolio, 'portfolio', Object);
+
+			return portfolio.portfolio;
+		}
+
+		static getDescriptionForPortfolioGroup(portfolio) {
+			assert.argumentIsRequired(portfolio, 'portfolio', Object);
+
+			return portfolio.name;
+		}
+
+		static getRequiredGroupGeneratorForPortfolio() {
+			return (portfolio) => {
+				let requiredGroup;
+
+				if (is.object(portfolio) && is.string(portfolio.portfolio) && is.string(portfolio.name)) {
+					requiredGroup = PositionLevelDefinition.buildRequiredGroupForPortfolio(portfolio);
+				} else {
+					requiredGroup = null;
+				}
+
+				return requiredGroup;
+			};
+		}
+
+		/**
+		 * Builds a {@link PositionLevelDefinition~RequiredGroup} for an asset class.
+		 *
+		 * @public
+		 * @static
+		 * @param {InstrumentType} type
+		 * @param {Currency} currency
+		 * @return {PositionLevelDefinition~RequiredGroup}
+		 */
+		static buildRequiredGroupForAssetClass(type, currency) {
+			return {
+				key: PositionLevelDefinition.getKeyForAssetClassGroup(type, currency),
+				description: PositionLevelDefinition.getDescriptionForAssetClassGroup(type, currency),
+				currency: currency
+			};
+		}
+
+		static getKeyForAssetClassGroup(type, currency) {
+			assert.argumentIsRequired(type, 'type', InstrumentType, 'InstrumentType');
+			assert.argumentIsRequired(currency, 'currency', Currency, 'Currency');
+
+			return `${type.code}|${currency.code}`;
+		}
+
+		static getDescriptionForAssetClassGroup(type, currency) {
+			assert.argumentIsRequired(type, 'type', InstrumentType, 'InstrumentType');
+			assert.argumentIsRequired(currency, 'currency', Currency, 'Currency');
+
+			return `${type.alternateDescription}${currency.code === 'CAD' ? '' : ` (${currency.alternateDescription})`}`;
+		}
+
 		toString() {
 			return '[PositionLevelDefinition]';
 		}
@@ -2463,7 +2654,7 @@ module.exports = (() => {
 	return PositionLevelDefinition;
 })();
 
-},{"@barchart/common-js/lang/assert":21,"@barchart/common-js/lang/is":23}],8:[function(require,module,exports){
+},{"./../../data/InstrumentType":1,"@barchart/common-js/lang/Currency":14,"@barchart/common-js/lang/assert":21,"@barchart/common-js/lang/is":23}],8:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert');
 
 const PositionLevelDefinition = require('./PositionLevelDefinition');
@@ -2509,7 +2700,7 @@ module.exports = (() => {
 		 * bottom-most level of the tree (i.e. leaf nodes).
 		 *
 		 * @public
-		 * @returns {Array.<PositionTreeDefinition>}
+		 * @returns {Array.<PositionLevelDefinitions>}
 		 */
 		get definitions() {
 			return this._definitions;