@barchart/portfolio-api-common 1.2.144 → 1.3.1

package/lib/processing/PositionGroup.js

@@ -691,9 +691,9 @@ module.exports = (() => {
 			updates.marketPrevious = updates.marketPrevious.add(translate(item, item.data.marketPrevious));
 			updates.marketPrevious2 = updates.marketPrevious2.add(translate(item, item.data.marketPrevious2));
 
+			updates.periodIncome = updates.periodIncome.add(translate(item, item.data.periodIncome));
 			updates.periodRealized = updates.periodRealized.add(translate(item, item.data.periodRealized));
 			updates.periodUnrealized = updates.periodUnrealized.add(translate(item, item.data.periodUnrealized));
-			updates.periodIncome = updates.periodIncome.add(translate(item, item.data.periodIncome));
 
 			if (item.position.instrument.type === InstrumentType.CASH) {
 				updates.cashTotal = updates.cashTotal.add(translate(item, item.data.market));
@@ -715,9 +715,9 @@ module.exports = (() => {
 			summaryTotalPrevious2: Decimal.ZERO,
 			marketPrevious: Decimal.ZERO,
 			marketPrevious2: Decimal.ZERO,
+			periodIncome: Decimal.ZERO,
 			periodRealized: Decimal.ZERO,
 			periodUnrealized: Decimal.ZERO,
-			periodIncome: Decimal.ZERO,
 			cashTotal: Decimal.ZERO,
 			totalDivisor: Decimal.ZERO,
 			periodDivisorCurrent: Decimal.ZERO,
@@ -734,9 +734,9 @@ module.exports = (() => {
 		actual.summaryTotalPrevious2 = updates.summaryTotalPrevious2;
 		actual.marketPrevious = updates.marketPrevious;
 		actual.marketPrevious2 = updates.marketPrevious2;
+		actual.periodIncome = updates.periodIncome;
 		actual.periodRealized = updates.periodRealized;
 		actual.periodUnrealized = updates.periodUnrealized;
-		actual.periodIncome = updates.periodIncome;
 		actual.cashTotal = updates.cashTotal;
 		actual.totalDivisor = updates.totalDivisor;
 		actual.periodDivisorCurrent = updates.periodDivisorCurrent;
@@ -755,9 +755,9 @@ module.exports = (() => {
 		format.summaryTotalPrevious2Negative = updates.summaryTotalPrevious2.getIsNegative();
 		format.marketPrevious = formatCurrency(updates.marketPrevious, currency);
 		format.marketPrevious2 = formatCurrency(updates.marketPrevious2, currency);
+		format.periodIncome = formatCurrency(updates.periodIncome, currency);
 		format.periodRealized = formatCurrency(updates.periodRealized, currency);
 		format.periodUnrealized = formatCurrency(updates.periodUnrealized, currency);
-		format.periodIncome = formatCurrency(updates.periodIncome, currency);
 		format.cashTotal = formatCurrency(updates.cashTotal, currency);
 
 		calculateRealizedPercent(group);
@@ -846,6 +846,7 @@ module.exports = (() => {
 				updates.unrealized = updates.unrealized.add(translate(item, item.data.unrealized));
 				updates.unrealizedToday = updates.unrealizedToday.add(translate(item, item.data.unrealizedToday));
 				updates.summaryTotalCurrent = updates.summaryTotalCurrent.add(translate(item, item.data.periodGain));
+				updates.periodUnrealized = updates.periodUnrealized.add(translate(item, item.data.periodUnrealized));
 
 				return updates;
 			}, {
@@ -854,7 +855,8 @@ module.exports = (() => {
 				marketDirection: unchanged,
 				unrealized: Decimal.ZERO,
 				unrealizedToday: Decimal.ZERO,
-				summaryTotalCurrent: Decimal.ZERO
+				summaryTotalCurrent: Decimal.ZERO,
+				periodUnrealized: Decimal.ZERO
 			});
 		} else {
 			updates = {
@@ -863,7 +865,8 @@ module.exports = (() => {
 				marketDirection: { up: item.data.marketChange.getIsPositive(), down: item.data.marketChange.getIsNegative() },
 				unrealized: actual.unrealized.add(translate(item, item.data.unrealizedChange)),
 				unrealizedToday: actual.unrealizedToday.add(translate(item, item.data.unrealizedTodayChange)),
-				summaryTotalCurrent: actual.summaryTotalCurrent.add(translate(item, item.data.periodGainChange))
+				summaryTotalCurrent: actual.summaryTotalCurrent.add(translate(item, item.data.periodGainChange)),
+				periodUnrealized: actual.periodUnrealized.add(translate(item, item.data.periodUnrealizedChange))
 			};
 		}
 
@@ -872,6 +875,7 @@ module.exports = (() => {
 		actual.unrealized = updates.unrealized;
 		actual.unrealizedToday = updates.unrealizedToday;
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
+		actual.periodUnrealized = updates.periodUnrealized;
 
 		actual.total = updates.unrealized.add(actual.realized).add(actual.income);
 		actual.totalPercent = calculateGainPercent(actual.total, actual.totalDivisor);
@@ -910,6 +914,8 @@ module.exports = (() => {
 		format.summaryTotalCurrent = formatCurrency(actual.summaryTotalCurrent, currency);
 		format.summaryTotalCurrentNegative = actual.summaryTotalCurrent.getIsNegative();
 
+		format.periodUnrealized = formatCurrency(actual.periodUnrealized, currency);
+
 		format.total = formatCurrency(actual.total, currency);
 		format.totalNegative = actual.total.getIsNegative();
 		format.totalPercent = formatPercent(actual.totalPercent, 2);
@@ -922,10 +928,6 @@ module.exports = (() => {
 
 		actual.periodPercent = calculateGainPercent(actual.summaryTotalCurrent, actual.periodDivisorCurrent);
 		format.periodPercent = formatPercent(actual.periodPercent, 2);
-
-		if (group.single && item) {
-			actual.periodUnrealized = item.data.periodUnrealized;
-		}
 	}
 
 	function calculateMarketPercent(group, rates, parentGroup, portfolioGroup) {
@@ -978,28 +980,32 @@ module.exports = (() => {
 		const openBasis = actual.basis;
 		const totalBasis = actual.totalDivisor;
 
-		const closedBasis = totalBasis.subtract(openBasis);
+		const numerator = actual.realized;
+		const denominator = totalBasis.subtract(openBasis);
 
-		if (closedBasis.getIsZero()) {
-			actual.realizedPercent = null;
-			format.realizedPercent = '—';
+		if (denominator.getIsZero()) {
+			actual.realizedPercent = Decimal.ZERO;
 		} else {
-			actual.realizedPercent = actual.realized.divide(closedBasis);
-			format.realizedPercent = formatPercent(actual.realizedPercent, 2);
+			actual.realizedPercent = numerator.divide(denominator);
 		}
+
+		format.realizedPercent = formatPercent(actual.realizedPercent, 2);
 	}
 
 	function calculateUnrealizedPercent(group) {
 		const actual = group._dataActual;
 		const format = group._dataFormat;
 
-		if (actual.basis.getIsZero()) {
-			actual.unrealizedPercent = null;
-			format.unrealizedPercent = '—';
+		const numerator = actual.unrealized;
+		const denominator = actual.basis;
+
+		if (denominator.getIsZero()) {
+			actual.unrealizedPercent = Decimal.ZERO;
 		} else {
-			actual.unrealizedPercent = actual.unrealized.divide(actual.basis);
-			format.unrealizedPercent = formatPercent(actual.unrealizedPercent, 2);
+			actual.unrealizedPercent = numerator.divide(denominator);
 		}
+
+		format.unrealizedPercent = formatPercent(actual.unrealizedPercent, 2);
 	}
 
 	function calculateGainPercent(gain, basis) {

package/lib/processing/PositionItem.js

@@ -75,7 +75,9 @@ module.exports = (() => {
 
 			this._data.periodIncome = null;
 			this._data.periodRealized = null;
+
 			this._data.periodUnrealized = null;
+			this._data.periodUnrealizedChange = null;
 
 			this._data.periodPrice = null;
 			this._data.periodPricePrevious = null;
@@ -420,14 +422,14 @@ module.exports = (() => {
 		data.marketPrevious2 = previousSummary2 === null ? Decimal.ZERO : previousSummary2.end.value;
 		data.quantityPrevious = previousSummary1 === null ? Decimal.ZERO : previousSummary1.end.open;
 
-		data.periodIncome = currentSummary !== null ? currentSummary.period.income : Decimal.ZERO;
-		data.periodRealized = currentSummary !== null ? currentSummary.period.realized : Decimal.ZERO;
-		data.periodUnrealized = currentSummary !== null ? currentSummary.period.unrealized : Decimal.ZERO;
-
 		data.periodGain = calculatePeriodGain(position.instrument.type, data.initiate, currentSummary, previousSummary1);
 		data.periodGainPrevious = calculatePeriodGain(position.instrument.type, data.initiate, previousSummary1, previousSummary2);
 		data.periodGainPrevious2 = calculatePeriodGain(position.instrument.type, data.initiate, previousSummary2, previousSummary3);
 
+		data.periodIncome = currentSummary !== null ? currentSummary.period.income : Decimal.ZERO;
+		data.periodRealized = currentSummary !== null ? currentSummary.period.realized : Decimal.ZERO;
+		data.periodUnrealized = calculatePeriodUnrealized(position.instrument.type, data.periodGain, data.periodRealized, data.periodIncome);
+
 		data.periodDivisor = calculatePeriodDivisor(position.instrument.type, data.initiate, currentSummary, previousSummary1);
 		data.periodDivisorPrevious = calculatePeriodDivisor(position.instrument.type, data.initiate, previousSummary1, previousSummary2);
 		data.periodDivisorPrevious2 = calculatePeriodDivisor(position.instrument.type, data.initiate, previousSummary2, previousSummary3);
@@ -450,7 +452,7 @@ module.exports = (() => {
 			data.periodPricePrevious = null;
 		}
 
-		data.totalDivisor = calculateTotalDivisor(position.instrument.type, data.initiate, currentSummary);
+		data.totalDivisor = calculateTotalDivisor(position.instrument.type, data.initiate, currentSummary, position);
 	}
 
 	function calculatePriceData(item, price) {
@@ -555,6 +557,18 @@ module.exports = (() => {
 
 				data.periodGain = periodGain;
 				data.periodGainChange = periodGainChange;
+
+				let periodUnrealized = calculatePeriodUnrealized(position.instrument.type, data.periodGain, data.periodRealized, data.periodIncome);
+				let periodUnrealizedChange;
+
+				if (data.periodUnrealized !== null) {
+					periodUnrealizedChange = periodUnrealized.subtract(data.periodUnrealized);
+				} else {
+					periodUnrealizedChange = Decimal.ZERO;
+				}
+
+				data.periodUnrealized = periodUnrealized;
+				data.periodUnrealizedChange = periodUnrealizedChange;
 			} else {
 				data.unrealized = Decimal.ZERO;
 				data.unrealizedChange = Decimal.ZERO;
@@ -645,14 +659,30 @@ module.exports = (() => {
 		return returnRef;
 	}
 
-	function calculateTotalDivisor(type, direction, finalSummary) {
+	function calculatePeriodUnrealized(type, periodGain, periodRealized, periodIncome) {
 		let returnRef;
 
+		if (type !== InstrumentType.CASH) {
+			returnRef = periodRealized.add(periodIncome).subtract(periodGain).opposite();
+		} else {
+			returnRef = Decimal.ZERO;
+		}
+
+		return returnRef;
+	}
+
+	function calculateTotalDivisor(type, direction, finalSummary, position) {
+		let returnRef;
+
+		// 2019-06-05, BRI. We should be reading from the summary -- in case we are
+		// running for a previous period. However, the summary does not have buy and
+		// sell totals for the entire history. Could be added.
+
 		if (finalSummary && type !== InstrumentType.CASH) {
 			if (direction === PositionDirection.SHORT) {
-				returnRef = finalSummary.period.sells;
+				returnRef = position.snapshot.sells;
 			} else {
-				returnRef = finalSummary.period.buys.opposite();
+				returnRef = position.snapshot.buys.opposite();
 			}
 		} else {
 			returnRef = Decimal.ZERO;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.2.144",
+  "version": "1.3.1",
   "description": "Common classes used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",
@@ -9,7 +9,7 @@
   },
   "scripts": {},
   "dependencies": {
-    "@barchart/common-js": "~3.2.0",
+    "@barchart/common-js": "~3.3.0",
     "uuid": "3.1.0"
   },
   "devDependencies": {

package/test/SpecRunner.js

@@ -3213,9 +3213,9 @@ module.exports = (() => {
 			updates.marketPrevious = updates.marketPrevious.add(translate(item, item.data.marketPrevious));
 			updates.marketPrevious2 = updates.marketPrevious2.add(translate(item, item.data.marketPrevious2));
 
+			updates.periodIncome = updates.periodIncome.add(translate(item, item.data.periodIncome));
 			updates.periodRealized = updates.periodRealized.add(translate(item, item.data.periodRealized));
 			updates.periodUnrealized = updates.periodUnrealized.add(translate(item, item.data.periodUnrealized));
-			updates.periodIncome = updates.periodIncome.add(translate(item, item.data.periodIncome));
 
 			if (item.position.instrument.type === InstrumentType.CASH) {
 				updates.cashTotal = updates.cashTotal.add(translate(item, item.data.market));
@@ -3237,9 +3237,9 @@ module.exports = (() => {
 			summaryTotalPrevious2: Decimal.ZERO,
 			marketPrevious: Decimal.ZERO,
 			marketPrevious2: Decimal.ZERO,
+			periodIncome: Decimal.ZERO,
 			periodRealized: Decimal.ZERO,
 			periodUnrealized: Decimal.ZERO,
-			periodIncome: Decimal.ZERO,
 			cashTotal: Decimal.ZERO,
 			totalDivisor: Decimal.ZERO,
 			periodDivisorCurrent: Decimal.ZERO,
@@ -3256,9 +3256,9 @@ module.exports = (() => {
 		actual.summaryTotalPrevious2 = updates.summaryTotalPrevious2;
 		actual.marketPrevious = updates.marketPrevious;
 		actual.marketPrevious2 = updates.marketPrevious2;
+		actual.periodIncome = updates.periodIncome;
 		actual.periodRealized = updates.periodRealized;
 		actual.periodUnrealized = updates.periodUnrealized;
-		actual.periodIncome = updates.periodIncome;
 		actual.cashTotal = updates.cashTotal;
 		actual.totalDivisor = updates.totalDivisor;
 		actual.periodDivisorCurrent = updates.periodDivisorCurrent;
@@ -3277,9 +3277,9 @@ module.exports = (() => {
 		format.summaryTotalPrevious2Negative = updates.summaryTotalPrevious2.getIsNegative();
 		format.marketPrevious = formatCurrency(updates.marketPrevious, currency);
 		format.marketPrevious2 = formatCurrency(updates.marketPrevious2, currency);
+		format.periodIncome = formatCurrency(updates.periodIncome, currency);
 		format.periodRealized = formatCurrency(updates.periodRealized, currency);
 		format.periodUnrealized = formatCurrency(updates.periodUnrealized, currency);
-		format.periodIncome = formatCurrency(updates.periodIncome, currency);
 		format.cashTotal = formatCurrency(updates.cashTotal, currency);
 
 		calculateRealizedPercent(group);
@@ -3368,6 +3368,7 @@ module.exports = (() => {
 				updates.unrealized = updates.unrealized.add(translate(item, item.data.unrealized));
 				updates.unrealizedToday = updates.unrealizedToday.add(translate(item, item.data.unrealizedToday));
 				updates.summaryTotalCurrent = updates.summaryTotalCurrent.add(translate(item, item.data.periodGain));
+				updates.periodUnrealized = updates.periodUnrealized.add(translate(item, item.data.periodUnrealized));
 
 				return updates;
 			}, {
@@ -3376,7 +3377,8 @@ module.exports = (() => {
 				marketDirection: unchanged,
 				unrealized: Decimal.ZERO,
 				unrealizedToday: Decimal.ZERO,
-				summaryTotalCurrent: Decimal.ZERO
+				summaryTotalCurrent: Decimal.ZERO,
+				periodUnrealized: Decimal.ZERO
 			});
 		} else {
 			updates = {
@@ -3385,7 +3387,8 @@ module.exports = (() => {
 				marketDirection: { up: item.data.marketChange.getIsPositive(), down: item.data.marketChange.getIsNegative() },
 				unrealized: actual.unrealized.add(translate(item, item.data.unrealizedChange)),
 				unrealizedToday: actual.unrealizedToday.add(translate(item, item.data.unrealizedTodayChange)),
-				summaryTotalCurrent: actual.summaryTotalCurrent.add(translate(item, item.data.periodGainChange))
+				summaryTotalCurrent: actual.summaryTotalCurrent.add(translate(item, item.data.periodGainChange)),
+				periodUnrealized: actual.periodUnrealized.add(translate(item, item.data.periodUnrealizedChange))
 			};
 		}
 
@@ -3394,6 +3397,7 @@ module.exports = (() => {
 		actual.unrealized = updates.unrealized;
 		actual.unrealizedToday = updates.unrealizedToday;
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
+		actual.periodUnrealized = updates.periodUnrealized;
 
 		actual.total = updates.unrealized.add(actual.realized).add(actual.income);
 		actual.totalPercent = calculateGainPercent(actual.total, actual.totalDivisor);
@@ -3432,6 +3436,8 @@ module.exports = (() => {
 		format.summaryTotalCurrent = formatCurrency(actual.summaryTotalCurrent, currency);
 		format.summaryTotalCurrentNegative = actual.summaryTotalCurrent.getIsNegative();
 
+		format.periodUnrealized = formatCurrency(actual.periodUnrealized, currency);
+
 		format.total = formatCurrency(actual.total, currency);
 		format.totalNegative = actual.total.getIsNegative();
 		format.totalPercent = formatPercent(actual.totalPercent, 2);
@@ -3444,10 +3450,6 @@ module.exports = (() => {
 
 		actual.periodPercent = calculateGainPercent(actual.summaryTotalCurrent, actual.periodDivisorCurrent);
 		format.periodPercent = formatPercent(actual.periodPercent, 2);
-
-		if (group.single && item) {
-			actual.periodUnrealized = item.data.periodUnrealized;
-		}
 	}
 
 	function calculateMarketPercent(group, rates, parentGroup, portfolioGroup) {
@@ -3500,28 +3502,32 @@ module.exports = (() => {
 		const openBasis = actual.basis;
 		const totalBasis = actual.totalDivisor;
 
-		const closedBasis = totalBasis.subtract(openBasis);
+		const numerator = actual.realized;
+		const denominator = totalBasis.subtract(openBasis);
 
-		if (closedBasis.getIsZero()) {
-			actual.realizedPercent = null;
-			format.realizedPercent = '—';
+		if (denominator.getIsZero()) {
+			actual.realizedPercent = Decimal.ZERO;
 		} else {
-			actual.realizedPercent = actual.realized.divide(closedBasis);
-			format.realizedPercent = formatPercent(actual.realizedPercent, 2);
+			actual.realizedPercent = numerator.divide(denominator);
 		}
+
+		format.realizedPercent = formatPercent(actual.realizedPercent, 2);
 	}
 
 	function calculateUnrealizedPercent(group) {
 		const actual = group._dataActual;
 		const format = group._dataFormat;
 
-		if (actual.basis.getIsZero()) {
-			actual.unrealizedPercent = null;
-			format.unrealizedPercent = '—';
+		const numerator = actual.unrealized;
+		const denominator = actual.basis;
+
+		if (denominator.getIsZero()) {
+			actual.unrealizedPercent = Decimal.ZERO;
 		} else {
-			actual.unrealizedPercent = actual.unrealized.divide(actual.basis);
-			format.unrealizedPercent = formatPercent(actual.unrealizedPercent, 2);
+			actual.unrealizedPercent = numerator.divide(denominator);
 		}
+
+		format.unrealizedPercent = formatPercent(actual.unrealizedPercent, 2);
 	}
 
 	function calculateGainPercent(gain, basis) {
@@ -3611,7 +3617,9 @@ module.exports = (() => {
 
 			this._data.periodIncome = null;
 			this._data.periodRealized = null;
+
 			this._data.periodUnrealized = null;
+			this._data.periodUnrealizedChange = null;
 
 			this._data.periodPrice = null;
 			this._data.periodPricePrevious = null;
@@ -3956,14 +3964,14 @@ module.exports = (() => {
 		data.marketPrevious2 = previousSummary2 === null ? Decimal.ZERO : previousSummary2.end.value;
 		data.quantityPrevious = previousSummary1 === null ? Decimal.ZERO : previousSummary1.end.open;
 
-		data.periodIncome = currentSummary !== null ? currentSummary.period.income : Decimal.ZERO;
-		data.periodRealized = currentSummary !== null ? currentSummary.period.realized : Decimal.ZERO;
-		data.periodUnrealized = currentSummary !== null ? currentSummary.period.unrealized : Decimal.ZERO;
-
 		data.periodGain = calculatePeriodGain(position.instrument.type, data.initiate, currentSummary, previousSummary1);
 		data.periodGainPrevious = calculatePeriodGain(position.instrument.type, data.initiate, previousSummary1, previousSummary2);
 		data.periodGainPrevious2 = calculatePeriodGain(position.instrument.type, data.initiate, previousSummary2, previousSummary3);
 
+		data.periodIncome = currentSummary !== null ? currentSummary.period.income : Decimal.ZERO;
+		data.periodRealized = currentSummary !== null ? currentSummary.period.realized : Decimal.ZERO;
+		data.periodUnrealized = calculatePeriodUnrealized(position.instrument.type, data.periodGain, data.periodRealized, data.periodIncome);
+
 		data.periodDivisor = calculatePeriodDivisor(position.instrument.type, data.initiate, currentSummary, previousSummary1);
 		data.periodDivisorPrevious = calculatePeriodDivisor(position.instrument.type, data.initiate, previousSummary1, previousSummary2);
 		data.periodDivisorPrevious2 = calculatePeriodDivisor(position.instrument.type, data.initiate, previousSummary2, previousSummary3);
@@ -3986,7 +3994,7 @@ module.exports = (() => {
 			data.periodPricePrevious = null;
 		}
 
-		data.totalDivisor = calculateTotalDivisor(position.instrument.type, data.initiate, currentSummary);
+		data.totalDivisor = calculateTotalDivisor(position.instrument.type, data.initiate, currentSummary, position);
 	}
 
 	function calculatePriceData(item, price) {
@@ -4091,6 +4099,18 @@ module.exports = (() => {
 
 				data.periodGain = periodGain;
 				data.periodGainChange = periodGainChange;
+
+				let periodUnrealized = calculatePeriodUnrealized(position.instrument.type, data.periodGain, data.periodRealized, data.periodIncome);
+				let periodUnrealizedChange;
+
+				if (data.periodUnrealized !== null) {
+					periodUnrealizedChange = periodUnrealized.subtract(data.periodUnrealized);
+				} else {
+					periodUnrealizedChange = Decimal.ZERO;
+				}
+
+				data.periodUnrealized = periodUnrealized;
+				data.periodUnrealizedChange = periodUnrealizedChange;
 			} else {
 				data.unrealized = Decimal.ZERO;
 				data.unrealizedChange = Decimal.ZERO;
@@ -4181,14 +4201,30 @@ module.exports = (() => {
 		return returnRef;
 	}
 
-	function calculateTotalDivisor(type, direction, finalSummary) {
+	function calculatePeriodUnrealized(type, periodGain, periodRealized, periodIncome) {
 		let returnRef;
 
+		if (type !== InstrumentType.CASH) {
+			returnRef = periodRealized.add(periodIncome).subtract(periodGain).opposite();
+		} else {
+			returnRef = Decimal.ZERO;
+		}
+
+		return returnRef;
+	}
+
+	function calculateTotalDivisor(type, direction, finalSummary, position) {
+		let returnRef;
+
+		// 2019-06-05, BRI. We should be reading from the summary -- in case we are
+		// running for a previous period. However, the summary does not have buy and
+		// sell totals for the entire history. Could be added.
+
 		if (finalSummary && type !== InstrumentType.CASH) {
 			if (direction === PositionDirection.SHORT) {
-				returnRef = finalSummary.period.sells;
+				returnRef = position.snapshot.sells;
 			} else {
-				returnRef = finalSummary.period.buys.opposite();
+				returnRef = position.snapshot.buys.opposite();
 			}
 		} else {
 			returnRef = Decimal.ZERO;
@@ -5249,7 +5285,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 () {
@@ -6395,7 +6431,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}
@@ -6547,7 +6596,7 @@ module.exports = function () {
 				return this._month;
 			}
 
-			/**
+			/**day
     * The day of the month.
     *
     * @public
@@ -6568,7 +6617,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
@@ -6839,6 +6888,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.
@@ -7003,6 +7070,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).
@@ -8686,8 +8775,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){
@@ -9208,7 +9351,7 @@ module.exports = function () {
    * @static
    * @public
    * @param {*} candidate
-   * @returns {*|boolean}
+   * @returns {boolean}
    */
 		negative: function negative(candidate) {
 			return this.number(candidate) && candidate < 0;
@@ -18465,7 +18608,9 @@ describe('When a position container data is gathered', () => {
 				value: new Decimal(456),
 				open: new Decimal(1),
 				income: new Decimal(0),
-				gain: new Decimal(0)
+				gain: new Decimal(0),
+				buys: new Decimal(50),
+				sells: new Decimal(0)
 			}
 		};
 	}

package/test/specs/processing/PositionContainerSpec.js

@@ -30,7 +30,9 @@ describe('When a position container data is gathered', () => {
 				value: new Decimal(456),
 				open: new Decimal(1),
 				income: new Decimal(0),
-				gain: new Decimal(0)
+				gain: new Decimal(0),
+				buys: new Decimal(50),
+				sells: new Decimal(0)
 			}
 		};
 	}