@barchart/portfolio-api-common 1.0.34 → 1.0.39

package/test/SpecRunner.js

@@ -16,14 +16,16 @@ module.exports = (() => {
 	 * @param {String} code
 	 * @param {String} description
 	 * @param {Function} rangeCalculator
+	 * @param {Function} startDateCalculator
 	 */
 	class PositionSummaryFrame extends Enum {
-		constructor(code, description, rangeCalculator) {
+		constructor(code, description, rangeCalculator, startDateCalculator) {
 			super(code, description);
 
 			assert.argumentIsRequired(rangeCalculator, 'rangeCalculator', Function);
 
 			this._rangeCalculator = rangeCalculator;
+			this._startDateCalculator = startDateCalculator;
 		}
 
 		getRanges(transactions) {
@@ -32,6 +34,12 @@ module.exports = (() => {
 			return this._rangeCalculator(getFilteredTransactions(transactions));
 		}
 
+		getStartDate(periods) {
+			assert.argumentIsRequired(periods, 'periods', Number);
+
+			return this._startDateCalculator(periods);
+		}
+
 		/**
 		 * A summary for a calendar year.
 		 *
@@ -77,10 +85,10 @@ module.exports = (() => {
 		}
 	}
 
-	const yearly = new PositionSummaryFrame('YEARLY', 'year', getYearlyRanges);
-	const quarterly = new PositionSummaryFrame('QUARTER', 'quarter', getQuarterlyRanges);
-	const monthly = new PositionSummaryFrame('MONTH', 'month', getMonthlyRanges);
-	const ytd = new PositionSummaryFrame('YTD', 'year-to-date', getYearToDateRanges);
+	const yearly = new PositionSummaryFrame('YEARLY', 'year', getYearlyRanges, getYearlyStartDate);
+	const quarterly = new PositionSummaryFrame('QUARTER', 'quarter', getQuarterlyRanges, getQuarterlyStartDate);
+	const monthly = new PositionSummaryFrame('MONTH', 'month', getMonthlyRanges, getMonthlyStartDate);
+	const ytd = new PositionSummaryFrame('YTD', 'year-to-date', getYearToDateRanges, getYearToDateStartDate);
 
 	function getRange(start, end) {
 		return {
@@ -143,6 +151,27 @@ module.exports = (() => {
 		return ranges;
 	}
 
+	function getYearlyStartDate(periods) {
+		const today = Day.getToday();
+
+		return Day.getToday()
+			.subtractMonths(today.month - 1)
+			.subtractDays(today.day)
+			.subtractYears(periods);
+	}
+
+	function getQuarterlyStartDate(periods) {
+		return null;
+	}
+
+	function getMonthlyStartDate(periods) {
+		return null;
+	}
+
+	function getYearToDateStartDate(periods) {
+		return null;
+	}
+
 	function getFilteredTransactions(transactions) {
 		return transactions.reduce((filtered, transaction) => {
 			if (!transaction.snapshot.open.getIsZero() || transaction.type.closing) {
@@ -156,7 +185,7 @@ module.exports = (() => {
 	return PositionSummaryFrame;
 })();
 
-},{"@barchart/common-js/lang/Day":5,"@barchart/common-js/lang/Enum":7,"@barchart/common-js/lang/array":8,"@barchart/common-js/lang/assert":9,"@barchart/common-js/lang/is":10}],2:[function(require,module,exports){
+},{"@barchart/common-js/lang/Day":10,"@barchart/common-js/lang/Enum":13,"@barchart/common-js/lang/array":14,"@barchart/common-js/lang/assert":15,"@barchart/common-js/lang/is":16}],2:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
 	Enum = require('@barchart/common-js/lang/Enum');
 
@@ -483,7 +512,617 @@ module.exports = (() => {
 	return TransactionType;
 })();
 
-},{"@barchart/common-js/lang/Enum":7,"@barchart/common-js/lang/assert":9}],3:[function(require,module,exports){
+},{"@barchart/common-js/lang/Enum":13,"@barchart/common-js/lang/assert":15}],3:[function(require,module,exports){
+const array = require('@barchart/common-js/lang/array'),
+	assert = require('@barchart/common-js/lang/assert'),
+	is = require('@barchart/common-js/lang/is'),
+	Tree = require('@barchart/common-js/collections/Tree');
+
+const PositionGroup = require('./PositionGroup'),
+	PositionGroupDefinition = require('./PositionGroupDefinition'),
+	PositionItem = require('./PositionItem');
+
+module.exports = (() => {
+	'use strict';
+
+	/**
+	 * @public
+	 */
+	class PositionContainer {
+		constructor(portfolios, positions, summaries, definitions) {
+			this._portfolios = portfolios.reduce((map, portfolio) => {
+				map[portfolio.portfolio] = portfolio;
+
+				return map;
+			}, { });
+
+			this._summaries = summaries.reduce((map, summary) => {
+				const key = summary.position;
+
+				if (!map.hasOwnProperty(key)) {
+					map[key] = [ ];
+				}
+
+				map[key].push(summary);
+
+				return map;
+			}, { });
+
+			this._items = positions.reduce((items, position) => {
+				const portfolio = this._portfolios[position.portfolio];
+
+				if (position) {
+					const summaries = this._summaries[position.position] || [ ];
+
+					items.push(new PositionItem(portfolio, position, summaries));
+				}
+
+				return items;
+			}, [ ]);
+
+			this._symbols = this._items.reduce((map, item) => {
+				let position = item.position;
+				let symbol = null;
+
+				if (position.instrument && position.instrument.symbol && position.instrument.barchart) {
+					symbol = position.instrument.barchart;
+
+					if (!map.hasOwnProperty(symbol)) {
+						map[symbol] = [ ];
+					}
+
+					map[symbol].push(item);
+				}
+
+				return map;
+			}, { });
+
+			this._definitions = definitions || [ new PositionGroupDefinition('Totals', i => true, i => 'Totals', [ 'Totals' ]) ];
+
+			this._tree = new Tree();
+
+			const createGroups = (tree, items, definitions) => {
+				if (definitions.length === 0) {
+					return;
+				}
+
+				const currentDefinition = definitions[0];
+				const additionalDefinitions = array.dropLeft(definitions);
+
+				const populatedGroups = array.batchBy(items, currentDefinition.keySelector).map((items) => {
+					const first = items[0];
+
+					return new PositionGroup(items, currentDefinition.descriptionSelector(first), currentDefinition.single && items.length === 1);
+				});
+
+				const missingGroups = array.difference(currentDefinition.requiredGroups, populatedGroups.map(group => group.description));
+
+				const empty = missingGroups.map((description) => {
+					return new PositionGroup(description, [ ]);
+				});
+
+				const compositeGroups = populatedGroups.concat(empty);
+
+				compositeGroups.forEach((group) => {
+					const child = tree.addChild(group);
+
+					createGroups(child, group.items, additionalDefinitions);
+				});
+			};
+
+			createGroups(this._tree, this._items, this._definitions);
+		}
+
+		setPrice(symbol, price) {
+			if (this._symbols.hasOwnProperty(symbol)) {
+				this._symbols.forEach(item.setPrice(price));
+			}
+		}
+
+		getGroup(keys) {
+			const node = keys.reduce((tree, key) => {
+				tree = tree.findChild((group) => group.description === key);
+
+				return tree;
+			}, this._tree);
+
+			return node.getValue();
+		}
+
+		getGroups(keys) {
+			const node = keys.reduce((tree, key) => {
+				tree = tree.findChild((group) => group.description === key);
+
+				return tree;
+			}, this._tree);
+
+			return node.getChildren().map((node) => node.getValue());
+		}
+
+		toString() {
+			return '[PositionContainer]';
+		}
+	}
+
+	return PositionContainer;
+})();
+
+},{"./PositionGroup":4,"./PositionGroupDefinition":5,"./PositionItem":6,"@barchart/common-js/collections/Tree":7,"@barchart/common-js/lang/array":14,"@barchart/common-js/lang/assert":15,"@barchart/common-js/lang/is":16}],4:[function(require,module,exports){
+const assert = require('@barchart/common-js/lang/assert'),
+	is = require('@barchart/common-js/lang/is');
+
+module.exports = (() => {
+	'use strict';
+
+	/**
+	 * @public
+	 */
+	class PositionGroup {
+		constructor(items, description, single) {
+			this._description = description;
+			this._items = items;
+
+			this._single = is.boolean(single) && single;
+
+			this._data = { };
+
+			this._data.description = this._description;
+
+			this._data.previous = null;
+			this._data.current = null;
+
+			this._items.forEach((item) => {
+				item.registerPriceChangeHandler((price, sender) => {
+					if (this._single) {
+						data.current = price;
+					} else {
+						data.current = null;
+					}
+				});
+			});
+
+			calculateStaticData(this);
+		}
+
+		get description() {
+			return this._description;
+		}
+
+		get data() {
+			return this._data;
+		}
+
+		get items() {
+			return this._items;
+		}
+
+		toString() {
+			return '[PositionGroup]';
+		}
+	}
+
+	function calculateStaticData(group) {
+		const items = group._items;
+		const data = group._data;
+
+		const updates = items.reduce(function(updates, item) {
+
+		}, { });
+
+
+	}
+
+	return PositionGroup;
+})();
+
+},{"@barchart/common-js/lang/assert":15,"@barchart/common-js/lang/is":16}],5:[function(require,module,exports){
+const assert = require('@barchart/common-js/lang/assert'),
+	is = require('@barchart/common-js/lang/is');
+
+module.exports = (() => {
+	'use strict';
+
+	/**
+	 * @public
+	 */
+	class PositionGroupDefinition {
+		constructor(name, keySelector, descriptionSelector, requiredGroups, single) {
+			this._name = name;
+
+			this._keySelector = keySelector;
+			this._descriptionSelector = descriptionSelector;
+
+			this._requiredGroups = requiredGroups || [ ];
+			this._single = is.boolean(single) && single;
+		}
+
+		get name() {
+			return this._name;
+		}
+
+		get keySelector() {
+			return this._keySelector;
+		}
+
+		get descriptionSelector() {
+			return this._descriptionSelector;
+		}
+
+		get requiredGroups() {
+			return this._requiredGroups;
+		}
+
+		toString() {
+			return '[PositionGroupDefinition]';
+		}
+	}
+
+	return PositionGroupDefinition;
+})();
+
+},{"@barchart/common-js/lang/assert":15,"@barchart/common-js/lang/is":16}],6:[function(require,module,exports){
+const assert = require('@barchart/common-js/lang/assert'),
+	Event = require('@barchart/common-js/messaging/Event'),
+	is = require('@barchart/common-js/lang/is');
+
+module.exports = (() => {
+	'use strict';
+
+	/**
+	 * @public
+	 */
+	class PositionItem {
+		constructor(portfolio, position, summaries) {
+			this._portfolio = portfolio;
+			this._position = position;
+			this._summaries = summaries || [ ];
+
+			this._price = null;
+			this._priceChangeEvent = new Event(this);
+		}
+
+		get portfolio() {
+			return this._portfolio;
+		}
+
+		get position() {
+			return this._position;
+		}
+
+		get summaries() {
+			return this._summaries;
+		}
+
+		setPrice(price) {
+			if (this._price !== price) {
+				this._priceChangeEvent.fire(this._price = price);
+			}
+		}
+
+		registerPriceChangeHandler(handler) {
+			assert.argumentIsRequired(handler, 'handler', Function);
+
+			this._priceChangeEvent.register(handler);
+		}
+
+		toString() {
+			return '[PositionItem]';
+		}
+	}
+
+	return PositionItem;
+})();
+
+},{"@barchart/common-js/lang/assert":15,"@barchart/common-js/lang/is":16,"@barchart/common-js/messaging/Event":17}],7:[function(require,module,exports){
+'use strict';
+
+var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+var is = require('./../lang/is');
+
+module.exports = function () {
+	'use strict';
+
+	/**
+  * A tree data structure. Each instance represents a node, holding
+  * an item, a reference to the parent node, and a reference to
+  * children nodes. Children are stored in insertion order.
+  *
+  * @public
+  * @param {*} value - The value of the node.
+  * @param {Tree} parent - The parent node. If not supplied, this will be the root node.
+  */
+
+	var Tree = function () {
+		function Tree(value, parent) {
+			_classCallCheck(this, Tree);
+
+			this._value = value;
+
+			this._parent = parent || null;
+			this._children = [];
+		}
+
+		/**
+   * Returns the parent node. If this is the root node, a null value is returned.
+   *
+   * @public
+   * @returns {Tree|null}
+   */
+
+
+		_createClass(Tree, [{
+			key: 'getParent',
+			value: function getParent() {
+				return this._parent;
+			}
+
+			/**
+    * Returns the collection of children nodes.
+    *
+    * @public
+    * @returns {Array<Tree>}
+    */
+
+		}, {
+			key: 'getChildren',
+			value: function getChildren() {
+				return this._children;
+			}
+
+			/**
+    * Returns the value associated with the current node.
+    *
+    * @public
+    * @returns {*}
+    */
+
+		}, {
+			key: 'getValue',
+			value: function getValue() {
+				return this._value;
+			}
+
+			/**
+    * Returns true if this node has no children; otherwise false.
+    *
+    * @public
+    * @returns {boolean}
+    */
+
+		}, {
+			key: 'getIsLeaf',
+			value: function getIsLeaf() {
+				return this._children.length === 0;
+			}
+
+			/**
+    * Returns true if this node has no parent; otherwise false.
+    *
+    * @public
+    * @returns {boolean}
+    */
+
+		}, {
+			key: 'getIsRoot',
+			value: function getIsRoot() {
+				return this._parent === null;
+			}
+
+			/**
+    * Adds a child node to the current node and returns a reference
+    * to the child node.
+    *
+    * @public
+    * @param {*} value - The value of the child.
+    * @returns {Tree}
+    */
+
+		}, {
+			key: 'addChild',
+			value: function addChild(value) {
+				var returnRef = new Tree(value, this);
+
+				this._children.push(returnRef);
+
+				return returnRef;
+			}
+
+			/**
+    * Removes a child node.
+    *
+    * @public
+    * @param {Tree} node - The child to remove.
+    */
+
+		}, {
+			key: 'removeChild',
+			value: function removeChild(node) {
+				for (var i = this._children.length - 1; !(i < 0); i--) {
+					var child = this._children[i];
+
+					if (child === node) {
+						this._children.splice(i, 1);
+
+						child._parent = null;
+						child._children = [];
+
+						break;
+					}
+				}
+			}
+
+			/**
+    * Searches the children nodes for the first child node that matches the
+    * predicate.
+    *
+    * @public
+    * @param {Tree~nodePredicate} predicate - A predicate that tests each child node. The predicate takes two arguments -- the node's value, and the node itself.
+    * @returns {Tree|null}
+    */
+
+		}, {
+			key: 'findChild',
+			value: function findChild(predicate) {
+				var returnRef = null;
+
+				for (var i = 0; i < this._children.length; i++) {
+					var child = this._children[i];
+
+					if (predicate(child.getValue(), child)) {
+						returnRef = child;
+
+						break;
+					}
+				}
+
+				return returnRef;
+			}
+
+			/**
+    * Searches the tree recursively, starting with the current node.
+    *
+    * @public
+    * @param {Tree~nodePredicate} predicate - A predicate that tests each child node. The predicate takes two arguments -- the node's value, and the node itself.
+    * @param {boolean=} childrenFirst - True, if the tree should be searched depth first.
+    * @param {boolean=} includeCurrentNode - True, if the current node should be checked against the predicate.
+    * @returns {Tree|null}
+    */
+
+		}, {
+			key: 'search',
+			value: function search(predicate, childrenFirst, includeCurrentNode) {
+				var returnRef = null;
+
+				if (returnRef === null && childrenFirst && includeCurrentNode && predicate(this.getValue(), this)) {
+					returnRef = this;
+				}
+
+				for (var i = 0; i < this._children.length; i++) {
+					var child = this._children[i];
+
+					returnRef = child.search(predicate, childrenFirst, true);
+
+					if (returnRef !== null) {
+						break;
+					}
+				}
+
+				if (returnRef === null && !childrenFirst && includeCurrentNode && predicate(this.getValue(), this)) {
+					returnRef = this;
+				}
+
+				return returnRef;
+			}
+
+			/**
+    * Walks the children of the current node, running an action on each node.
+    *
+    * @public
+    * @param {Tree~nodeAction} walkAction - A action to apply to each node. The action takes two arguments -- the node's value, and the node itself.
+    * @param {boolean=} childrenFirst - True if the tree should be walked depth first.
+    * @param {boolean=} includeCurrentNode - True if the current node should be applied to the action.
+    */
+
+		}, {
+			key: 'walk',
+			value: function walk(walkAction, childrenFirst, includeCurrentNode) {
+				var predicate = function predicate(value, node) {
+					walkAction(value, node);
+
+					return false;
+				};
+
+				this.search(predicate, childrenFirst, includeCurrentNode);
+			}
+
+			/**
+    * Climbs the parents of the current node -- current node up to the root node, running an action on each node.
+    *
+    * @public
+    * @param {Tree~nodeAction} climbAction - A action to apply to each node. The action takes two arguments -- the node's value, and the node itself.
+    * @param {boolean=} includeCurrentNode - True if the current node should be applied to the action.
+    */
+
+		}, {
+			key: 'climb',
+			value: function climb(climbAction, includeCurrentNode) {
+				if (includeCurrentNode) {
+					climbAction(this.getValue(), this);
+				}
+
+				if (this._parent !== null) {
+					this._parent.climb(climbAction, true);
+				}
+			}
+
+			/**
+    * Creates a representation of the tree using JavaScript objects and arrays.
+    *
+    * @public
+    * @param {Function=} valueConverter - An optional function for converting the value of each node.
+    * @param {Boolean=} valueConverter - If true, empty children arrays will be excluded from output.
+    * @returns {Object}
+    */
+
+		}, {
+			key: 'toJSObj',
+			value: function toJSObj(valueConverter, omitEmptyChildren) {
+				var valueConverterToUse = void 0;
+
+				if (is.fn(valueConverter)) {
+					valueConverterToUse = valueConverter;
+				} else {
+					valueConverterToUse = function valueConverterToUse(x) {
+						return x;
+					};
+				}
+
+				var converted = {
+					value: valueConverterToUse(this._value)
+				};
+
+				if (!(is.boolean(omitEmptyChildren) && omitEmptyChildren && this._children.length === 0)) {
+					converted.children = this._children.map(function (child) {
+						return child.toJSObj(valueConverter, omitEmptyChildren);
+					});
+				}
+
+				return converted;
+			}
+		}, {
+			key: 'toString',
+			value: function toString() {
+				return '[Tree]';
+			}
+		}]);
+
+		return Tree;
+	}();
+
+	/**
+  * A predicate that is used to check a node (i.e. {@link Tree}).
+  *
+  * @callback Tree~nodePredicate
+  * @param {*} item - The candidate node's item
+  * @param {Tree} node - The candidate node.
+  * @returns {Boolean}
+  */
+
+	/**
+  * An action that is run on a node (i.e. {@link Tree}).
+  *
+  * @callback Tree~nodeAction
+  * @param {*} item - The candidate node's item
+  * @param {Tree} node - The candidate node.
+  */
+
+	return Tree;
+}();
+
+},{"./../lang/is":16}],8:[function(require,module,exports){
 'use strict';
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
@@ -627,7 +1266,7 @@ module.exports = function () {
 	return ComparatorBuilder;
 }();
 
-},{"./../../lang/assert":9,"./comparators":4}],4:[function(require,module,exports){
+},{"./../../lang/assert":15,"./comparators":9}],9:[function(require,module,exports){
 'use strict';
 
 var assert = require('./../../lang/assert');
@@ -702,7 +1341,7 @@ module.exports = function () {
 	};
 }();
 
-},{"./../../lang/assert":9}],5:[function(require,module,exports){
+},{"./../../lang/assert":15}],10:[function(require,module,exports){
 'use strict';
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
@@ -1255,7 +1894,7 @@ module.exports = function () {
 	return Day;
 }();
 
-},{"./../collections/sorting/ComparatorBuilder":3,"./../collections/sorting/comparators":4,"./assert":9,"./is":10}],6:[function(require,module,exports){
+},{"./../collections/sorting/ComparatorBuilder":8,"./../collections/sorting/comparators":9,"./assert":15,"./is":16}],11:[function(require,module,exports){
 'use strict';
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
@@ -1760,82 +2399,231 @@ module.exports = function () {
 		function RoundingMode(value, description) {
 			_classCallCheck(this, RoundingMode);
 
-			var _this = _possibleConstructorReturn(this, (RoundingMode.__proto__ || Object.getPrototypeOf(RoundingMode)).call(this, value.toString(), description));
+			var _this = _possibleConstructorReturn(this, (RoundingMode.__proto__ || Object.getPrototypeOf(RoundingMode)).call(this, value.toString(), description));
+
+			_this._value = value;
+			return _this;
+		}
+
+		/**
+   * The code used by the Big.js library.
+   *
+   * @ignore
+   * @returns {Number}
+   */
+
+
+		_createClass(RoundingMode, [{
+			key: 'toString',
+			value: function toString() {
+				return '[RoundingMode]';
+			}
+		}, {
+			key: 'value',
+			get: function get() {
+				return this._value;
+			}
+
+			/**
+    * Rounds away from zero.
+    *
+    * @public
+    * @returns {RoundingMode}
+    */
+
+		}], [{
+			key: 'UP',
+			get: function get() {
+				return up;
+			}
+
+			/**
+    * Rounds towards zero.
+    *
+    * @public
+    * @returns {RoundingMode}
+    */
+
+		}, {
+			key: 'DOWN',
+			get: function get() {
+				return down;
+			}
+
+			/**
+    * Rounds towards nearest neighbor. If equidistant, rounds away from zero.
+    *
+    * @public
+    * @returns {RoundingMode}
+    */
+
+		}, {
+			key: 'NORMAL',
+			get: function get() {
+				return normal;
+			}
+		}]);
+
+		return RoundingMode;
+	}(Enum);
+
+	var up = new RoundingMode(3, 'up');
+	var down = new RoundingMode(0, 'down');
+	var normal = new RoundingMode(1, 'normal');
+
+	return Decimal;
+}();
+
+},{"./Enum":13,"./assert":15,"./is":16,"big.js":18}],12:[function(require,module,exports){
+'use strict';
+
+var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
+
+function _possibleConstructorReturn(self, call) { if (!self) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return call && (typeof call === "object" || typeof call === "function") ? call : self; }
+
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+var assert = require('./assert');
+
+module.exports = function () {
+	'use strict';
+
+	/**
+  * An object that has an end-of-life process.
+  *
+  * @public
+  * @interface
+  */
+
+	var Disposable = function () {
+		function Disposable() {
+			_classCallCheck(this, Disposable);
 
-			_this._value = value;
-			return _this;
+			this._disposed = false;
 		}
 
 		/**
-   * The code used by the Big.js library.
+   * Invokes end-of-life logic. Once this function has been
+   * invoked, further interaction with the object is not
+   * recommended.
    *
-   * @ignore
-   * @returns {Number}
+   * @public
    */
 
 
-		_createClass(RoundingMode, [{
-			key: 'toString',
-			value: function toString() {
-				return '[RoundingMode]';
+		_createClass(Disposable, [{
+			key: 'dispose',
+			value: function dispose() {
+				if (this._disposed) {
+					return;
+				}
+
+				this._disposed = true;
+
+				this._onDispose();
 			}
+
+			/**
+    * @protected
+    * @abstract
+    * @ignore
+    */
+
 		}, {
-			key: 'value',
-			get: function get() {
-				return this._value;
+			key: '_onDispose',
+			value: function _onDispose() {
+				return;
 			}
 
 			/**
-    * Rounds away from zero.
+    * Returns true if the {@link Disposable#dispose} function has been invoked.
     *
     * @public
-    * @returns {RoundingMode}
+    * @returns {boolean}
     */
 
-		}], [{
-			key: 'UP',
-			get: function get() {
-				return up;
+		}, {
+			key: 'getIsDisposed',
+			value: function getIsDisposed() {
+				return this._disposed || false;
+			}
+		}, {
+			key: 'toString',
+			value: function toString() {
+				return '[Disposable]';
 			}
 
 			/**
-    * Rounds towards zero.
+    * Creates and returns a {@link Disposable} object with end-of-life logic
+    * delegated to a function.
     *
     * @public
-    * @returns {RoundingMode}
+    * @param disposeAction {Function}
+    * @returns {Disposable}
     */
 
-		}, {
-			key: 'DOWN',
-			get: function get() {
-				return down;
+		}], [{
+			key: 'fromAction',
+			value: function fromAction(disposeAction) {
+				assert.argumentIsRequired(disposeAction, 'disposeAction', Function);
+
+				return new DisposableAction(disposeAction);
 			}
 
 			/**
-    * Rounds towards nearest neighbor. If equidistant, rounds away from zero.
+    * Creates and returns a {@link Disposable} object whose end-of-life
+    * logic does nothing.
     *
     * @public
-    * @returns {RoundingMode}
+    * @returns {Disposable}
     */
 
 		}, {
-			key: 'NORMAL',
-			get: function get() {
-				return normal;
+			key: 'getEmpty',
+			value: function getEmpty() {
+				return Disposable.fromAction(function () {
+					return;
+				});
 			}
 		}]);
 
-		return RoundingMode;
-	}(Enum);
+		return Disposable;
+	}();
 
-	var up = new RoundingMode(3, 'up');
-	var down = new RoundingMode(0, 'down');
-	var normal = new RoundingMode(1, 'normal');
+	var DisposableAction = function (_Disposable) {
+		_inherits(DisposableAction, _Disposable);
 
-	return Decimal;
+		function DisposableAction(disposeAction) {
+			_classCallCheck(this, DisposableAction);
+
+			var _this = _possibleConstructorReturn(this, (DisposableAction.__proto__ || Object.getPrototypeOf(DisposableAction)).call(this, disposeAction));
+
+			_this._disposeAction = disposeAction;
+			return _this;
+		}
+
+		_createClass(DisposableAction, [{
+			key: '_onDispose',
+			value: function _onDispose() {
+				this._disposeAction();
+				this._disposeAction = null;
+			}
+		}, {
+			key: 'toString',
+			value: function toString() {
+				return '[DisposableAction]';
+			}
+		}]);
+
+		return DisposableAction;
+	}(Disposable);
+
+	return Disposable;
 }();
 
-},{"./Enum":7,"./assert":9,"./is":10,"big.js":11}],7:[function(require,module,exports){
+},{"./assert":15}],13:[function(require,module,exports){
 'use strict';
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
@@ -1977,7 +2765,7 @@ module.exports = function () {
 	return Enum;
 }();
 
-},{"./assert":9}],8:[function(require,module,exports){
+},{"./assert":15}],14:[function(require,module,exports){
 'use strict';
 
 var assert = require('./assert'),
@@ -2122,6 +2910,26 @@ module.exports = function () {
 		},
 
 
+		/**
+   * Returns a new array containing all but the first item.
+   *
+   * @static
+   * @param {Array} a
+   * @returns {Array}
+   */
+		dropLeft: function dropLeft(a) {
+			assert.argumentIsArray(a, 'a');
+
+			var returnRef = Array.from(a);
+
+			if (returnRef.length !== 0) {
+				returnRef.shift();
+			}
+
+			return returnRef;
+		},
+
+
 		/**
    * Returns a new array containing all but the last item.
    *
@@ -2338,7 +3146,7 @@ module.exports = function () {
 	};
 }();
 
-},{"./assert":9,"./is":10}],9:[function(require,module,exports){
+},{"./assert":15,"./is":16}],15:[function(require,module,exports){
 'use strict';
 
 var is = require('./is');
@@ -2486,7 +3294,7 @@ module.exports = function () {
 	};
 }();
 
-},{"./is":10}],10:[function(require,module,exports){
+},{"./is":16}],16:[function(require,module,exports){
 'use strict';
 
 var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; };
@@ -2507,7 +3315,7 @@ module.exports = function () {
    *
    * @static
    * @public
-   * @param candidate {*}
+   * @param {*} candidate {*}
    * @returns {boolean}
    */
 		number: function number(candidate) {
@@ -2560,7 +3368,7 @@ module.exports = function () {
    *
    * @static
    * @public
-   * @param candidate
+   * @param {*} candidate
    * @returns {boolean}
    */
 		positive: function positive(candidate) {
@@ -2573,7 +3381,7 @@ module.exports = function () {
    *
    * @static
    * @public
-   * @param candidate
+   * @param {*} candidate
    * @returns {*|boolean}
    */
 		negative: function negative(candidate) {
@@ -2586,7 +3394,7 @@ module.exports = function () {
    *
    * @static
    * @public
-   * @param candidate
+   * @param {*} candidate
    * @returns {boolean}
    */
 		string: function string(candidate) {
@@ -2599,7 +3407,7 @@ module.exports = function () {
    *
    * @static
    * @public
-   * @param candidate
+   * @param {*} candidate
    * @returns {boolean}
    */
 		date: function date(candidate) {
@@ -2612,7 +3420,7 @@ module.exports = function () {
    *
    * @static
    * @public
-   * @param candidate
+   * @param {*} candidate
    * @returns {boolean}
    */
 		fn: function fn(candidate) {
@@ -2625,7 +3433,7 @@ module.exports = function () {
    *
    * @static
    * @public
-   * @param candidate
+   * @param {*} candidate
    * @returns {boolean}
    */
 		array: function array(candidate) {
@@ -2638,7 +3446,7 @@ module.exports = function () {
    *
    * @static
    * @public
-   * @param candidate
+   * @param {*} candidate
    * @returns {boolean}
    */
 		boolean: function boolean(candidate) {
@@ -2651,7 +3459,7 @@ module.exports = function () {
    *
    * @static
    * @public
-   * @param candidate
+   * @param {*} candidate
    * @returns {boolean}
    */
 		object: function object(candidate) {
@@ -2664,7 +3472,7 @@ module.exports = function () {
    *
    * @static
    * @public
-   * @param candidate
+   * @param {*} candidate
    * @returns {boolean}
    */
 		null: function _null(candidate) {
@@ -2677,7 +3485,7 @@ module.exports = function () {
    *
    * @static
    * @public
-   * @param candidate
+   * @param {*} candidate
    * @returns {boolean}
    */
 		undefined: function (_undefined) {
@@ -2709,7 +3517,179 @@ module.exports = function () {
 	};
 }();
 
-},{}],11:[function(require,module,exports){
+},{}],17:[function(require,module,exports){
+'use strict';
+
+var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function _possibleConstructorReturn(self, call) { if (!self) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return call && (typeof call === "object" || typeof call === "function") ? call : self; }
+
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
+
+var assert = require('./../lang/assert'),
+    Disposable = require('./../lang/Disposable');
+
+module.exports = function () {
+	'use strict';
+
+	/**
+  * An implementation of the observer pattern.
+  *
+  * @param {*} sender - The object which owns the event.
+  * @extends {Disposable}
+  */
+
+	var Event = function (_Disposable) {
+		_inherits(Event, _Disposable);
+
+		function Event(sender) {
+			_classCallCheck(this, Event);
+
+			var _this = _possibleConstructorReturn(this, (Event.__proto__ || Object.getPrototypeOf(Event)).call(this));
+
+			_this._sender = sender || null;
+
+			_this._observers = [];
+			return _this;
+		}
+
+		/**
+   * Registers an event handler which will receive a notification when
+   * {@link Event#fire} is called.
+   *
+   * @public
+   * @param {Function} handler - The function which will be called each time the event fires. The first argument will be the event data. The second argument will be the event owner (i.e. sender).
+   * @returns {Disposable}
+   */
+
+
+		_createClass(Event, [{
+			key: 'register',
+			value: function register(handler) {
+				var _this2 = this;
+
+				assert.argumentIsRequired(handler, 'handler', Function);
+
+				addRegistration.call(this, handler);
+
+				return Disposable.fromAction(function () {
+					if (_this2.getIsDisposed()) {
+						return;
+					}
+
+					removeRegistration.call(_this2, handler);
+				});
+			}
+
+			/**
+    * Removes registration for an event handler. That is, the handler will
+    * no longer be called if the event fires.
+    *
+    * @public
+    * @param {Function} handler
+    */
+
+		}, {
+			key: 'unregister',
+			value: function unregister(handler) {
+				assert.argumentIsRequired(handler, 'handler', Function);
+
+				removeRegistration.call(this, handler);
+			}
+
+			/**
+    * Removes all handlers from the event.
+    *
+    * @public
+    */
+
+		}, {
+			key: 'clear',
+			value: function clear() {
+				this._observers = [];
+			}
+
+			/**
+    * Triggers the event, calling all previously registered handlers.
+    *
+    * @public
+    * @param {*) data - The data to pass each handler.
+    */
+
+		}, {
+			key: 'fire',
+			value: function fire(data) {
+				var observers = this._observers;
+
+				for (var i = 0; i < observers.length; i++) {
+					var observer = observers[i];
+
+					observer(data, this._sender);
+				}
+			}
+
+			/**
+    * Returns true, if no handlers are currently registered.
+    *
+    * @returns {boolean}
+    */
+
+		}, {
+			key: 'getIsEmpty',
+			value: function getIsEmpty() {
+				return this._observers.length === 0;
+			}
+		}, {
+			key: '_onDispose',
+			value: function _onDispose() {
+				this._observers = null;
+			}
+		}, {
+			key: 'toString',
+			value: function toString() {
+				return '[Event]';
+			}
+		}]);
+
+		return Event;
+	}(Disposable);
+
+	function addRegistration(handler) {
+		var copiedObservers = this._observers.slice();
+
+		copiedObservers.push(handler);
+
+		this._observers = copiedObservers;
+	}
+
+	function removeRegistration(handler) {
+		var indicesToRemove = [];
+
+		for (var i = 0; i < this._observers.length; i++) {
+			var candidate = this._observers[i];
+
+			if (candidate === handler) {
+				indicesToRemove.push(i);
+			}
+		}
+
+		if (indicesToRemove.length > 0) {
+			var copiedObservers = this._observers.slice();
+
+			for (var j = indicesToRemove.length - 1; !(j < 0); j--) {
+				copiedObservers.splice(indicesToRemove[j], 1);
+			}
+
+			this._observers = copiedObservers;
+		}
+	}
+
+	return Event;
+}();
+
+},{"./../lang/Disposable":12,"./../lang/assert":15}],18:[function(require,module,exports){
 /*
  *  big.js v5.0.3
  *  A small, fast, easy-to-use library for arbitrary-precision decimal arithmetic.
@@ -3650,7 +4630,7 @@ module.exports = function () {
   }
 })(this);
 
-},{}],12:[function(require,module,exports){
+},{}],19:[function(require,module,exports){
 const Day = require('@barchart/common-js/lang/Day'),
 	Decimal = require('@barchart/common-js/lang/Decimal');
 
@@ -3963,6 +4943,147 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			expect(ranges[0].end.format()).toEqual('2018-12-31');
 		});
 	});
+
+	describe('and getting the start date for yearly frames', () => {
+		describe('for one year ago', function() {
+			let start;
+
+			beforeEach(() => {
+				start = PositionSummaryFrame.YEARLY.getStartDate(1);
+			});
+
+			it('should be in December', () => {
+				expect(start.month).toEqual(12);
+			});
+
+			it('should be on the 31st', () => {
+				expect(start.day).toEqual(31);
+			});
+
+			it('should be two years ago', () => {
+				expect(start.year).toEqual(Day.getToday().year - 2);
+			});
+		});
+
+		describe('for two years ago', function() {
+			let start;
+
+			beforeEach(() => {
+				start = PositionSummaryFrame.YEARLY.getStartDate(2);
+			});
+
+			it('should be in December', () => {
+				expect(start.month).toEqual(12);
+			});
+
+			it('should be on the 31st', () => {
+				expect(start.day).toEqual(31);
+			});
+
+			it('should be two years ago', () => {
+				expect(start.year).toEqual(Day.getToday().year - 3);
+			});
+		});
+	});
+});
+
+},{"./../../../lib/data/PositionSummaryFrame":1,"./../../../lib/data/TransactionType":2,"@barchart/common-js/lang/Day":10,"@barchart/common-js/lang/Decimal":11}],20:[function(require,module,exports){
+const PositionContainer = require('./../../../lib/processing/PositionContainer'),
+	PositionGroupDefinition = require('./../../../lib/processing/PositionGroupDefinition');
+
+describe('When a position container data is gathered', () => {
+	'use strict';
+
+	describe('for two portfolios, each with the same position, and the second portfolio with an additonal position', () => {
+		let portfolios;
+		let positions;
+		let summaries;
+
+		beforeEach(() => {
+			portfolios = [
+				{
+					portfolio: 'a',
+					name: 'a'
+				}, {
+					portfolio: 'b',
+					name: 'b'
+				}
+			];
+
+			positions = [
+				{
+					portfolio: 'a',
+					position: '1',
+					instrument: {
+						symbol: {
+							barchart: 'AAPL'
+						}
+					},
+				}, {
+					portfolio: 'b',
+					position: '2',
+					instrument: {
+						symbol: {
+							barchart: 'AAPL'
+						}
+					}
+				}, {
+					portfolio: 'b',
+					position: '3',
+					instrument: {
+						symbol: {
+							barchart: 'TSLA'
+						}
+					}
+				}
+			];
+
+			summaries = [ ];
+		});
+
+		describe('and a container is created grouping by total, portfolio, and instrument', () => {
+			let definitions;
+			let container;
+
+			beforeEach(() => {
+				definitions = [
+					new PositionGroupDefinition('Total', x => true, x => 'Total'),
+					new PositionGroupDefinition('Portfolio', x => x.portfolio.portfolio, x => x.portfolio.name),
+					new PositionGroupDefinition('Position', x => x.position.position, x => x.position.instrument.symbol.barchart)
+				];
+
+				try {
+					container = new PositionContainer(portfolios, positions, summaries, definitions);
+				} catch (e) {
+					console.log(e);
+				}
+			});
+
+			it('the "Total" group should have two children groups', () => {
+				expect(container.getGroups([ 'Total' ]).length).toEqual(2);
+			});
+
+			it('the "Total" group should have three items', () => {
+				expect(container.getGroup([ 'Total' ]).items.length).toEqual(3);
+			});
+
+			it('The "a" portfolio group should have one child group', () => {
+				expect(container.getGroups([ 'Total', 'a' ]).length).toEqual(1);
+			});
+
+			it('the "a" portfolio group should have one item', () => {
+				expect(container.getGroup([ 'Total', 'a' ]).items.length).toEqual(1);
+			});
+
+			it('The "b" portfolio group should have two child groups', () => {
+				expect(container.getGroups([ 'Total', 'b' ]).length).toEqual(2);
+			});
+
+			it('the "b" portfolio group should have two items', () => {
+				expect(container.getGroup([ 'Total', 'b' ]).items.length).toEqual(2);
+			});
+		});
+	});
 });
 
-},{"./../../../lib/data/PositionSummaryFrame":1,"./../../../lib/data/TransactionType":2,"@barchart/common-js/lang/Day":5,"@barchart/common-js/lang/Decimal":6}]},{},[12]);
+},{"./../../../lib/processing/PositionContainer":3,"./../../../lib/processing/PositionGroupDefinition":5}]},{},[19,20]);