@barchart/portfolio-api-common 1.2.91 → 1.2.95

package/lib/data/PositionSummaryFrame.js

@@ -8,7 +8,7 @@ module.exports = (() => {
 	'use strict';
 
 	/**
-	 * An enumeration used to define timeframes for position summaries.
+	 * An enumeration used to define time frames for position summaries.
 	 *
 	 * @public
 	 * @extends {Enum}
@@ -94,22 +94,44 @@ module.exports = (() => {
 		 * @return {Array.<PositionSummaryRange>}
 		 */
 		getRangesFromDate(date) {
+			assert.argumentIsRequired(date, 'date', Day, 'Day');
+
 			const transaction = { date: date, snapshot: { open: Decimal.ONE } };
 
 			return this.getRanges([ transaction ]);
 		}
 
+		/**
+		 * Returns the range immediately prior to the range containing the
+		 * date supplied.
+		 *
+		 * @public
+		 * @param {Day} date
+		 * @param {Number} periods
+		 */
+		getPriorRanges(date, periods) {
+			assert.argumentIsRequired(date, 'date', Day, 'Day');
+			assert.argumentIsRequired(periods, 'periods', Number, 'Number');
+
+			const transactionOne = { date: this.getStartDate((periods - 1), date), snapshot: { open: Decimal.ONE } };
+			const transactionTwo = { date: date, snapshot: { open: Decimal.ZERO } };
+
+			return this._rangeCalculator([ transactionOne, transactionTwo ]);
+		}
+
 		/**
 		 * Returns the start date for a frame, a given number of periods ago.
 		 *
 		 * @public
 		 * @param {Number} periods
+		 * @param {Day=} start
 		 * @returns {Day}
 		 */
-		getStartDate(periods) {
+		getStartDate(periods, start) {
 			assert.argumentIsRequired(periods, 'periods', Number);
+			assert.argumentIsOptional(start, 'start', Day, 'Day');
 
-			return this._startDateCalculator(periods);
+			return this._startDateCalculator(periods, start);
 		}
 
 		/**
@@ -171,6 +193,16 @@ module.exports = (() => {
 	 * @property {Day} end
 	 */
 
+	/**
+	 * The start and and date for a {@link PositionSummaryFrame} along with the frame type.
+	 *
+	 * @typedef PositionSummaryDefinition
+	 * @type {Object}
+	 * @property {Day} start
+	 * @property {Day} end
+	 * @property {PositionSummaryFrame} frame
+	 */
+
 	function getRange(start, end) {
 		return {
 			start: start,
@@ -232,29 +264,29 @@ module.exports = (() => {
 		return ranges;
 	}
 
-	function getYearlyStartDate(periods) {
-		const today = Day.getToday();
+	function getYearlyStartDate(periods, date) {
+		const today = date || Day.getToday();
 
-		return Day.getToday()
+		return today
 			.subtractMonths(today.month - 1)
 			.subtractDays(today.day)
 			.subtractYears(periods);
 	}
 
-	function getQuarterlyStartDate(periods) {
+	function getQuarterlyStartDate(periods, date) {
 		return null;
 	}
 
-	function getMonthlyStartDate(periods) {
+	function getMonthlyStartDate(periods, date) {
 		return null;
 	}
 
-	function getYearToDateStartDate(periods) {
+	function getYearToDateStartDate(periods, date) {
 		return null;
 	}
 
 	function getYearlyRangeDescription(start, end) {
-		return end.year.toString();
+		return `Year ended ${end.year.toString()}`;
 	}
 
 	function getQuarterlyRangeDescription(start, end) {

package/lib/processing/PositionGroup.js

@@ -75,12 +75,14 @@ module.exports = (() => {
 			this._dataFormat.locked = false;
 			this._dataFormat.newsExists = false;
 			this._dataFormat.quantity = null;
+			this._dataFormat.quantityPrevious = null;
 			this._dataFormat.basisPrice = null;
 
 			this._dataActual.key = this._key;
 			this._dataActual.description = this._description;
 			this._dataActual.newsExists = false;
 			this._dataActual.quantity = null;
+			this._dataActual.quantityPrevious = null;
 			this._dataActual.basisPrice = null;
 
 			if (this._single && items.length === 1) {
@@ -130,10 +132,10 @@ module.exports = (() => {
 			this._dataActual.summaryTotalCurrent = null;
 			this._dataActual.summaryTotalPrevious = null;
 			this._dataActual.summaryTotalPrevious2 = null;
-			this._dataActual.endingPrevious = null;
-			this._dataActual.endingPrevious2 = null;
-			this._dataActual.endingChange = null;
-			this._dataActual.endingChangePercent = null;
+			this._dataActual.marketPrevious = null;
+			this._dataActual.marketPrevious2 = null;
+			this._dataActual.marketChange = null;
+			this._dataActual.marketChangePercent = null;
 			this._dataActual.cashTotal = null;
 
 			this._dataFormat.currentPrice = null;
@@ -157,10 +159,10 @@ module.exports = (() => {
 			this._dataFormat.summaryTotalPreviousNegative = false;
 			this._dataFormat.summaryTotalPrevious2 = null;
 			this._dataFormat.summaryTotalPrevious2Negative = false;
-			this._dataFormat.endingPrevious = null;
-			this._dataFormat.endingPrevious2 = null;
-			this._dataFormat.endingChange = null;
-			this._dataFormat.endingChangePercent = null;
+			this._dataFormat.marketPrevious = null;
+			this._dataFormat.marketPrevious2 = null;
+			this._dataFormat.marketChange = null;
+			this._dataFormat.marketChangePercent = null;
 			this._dataFormat.cashTotal = null;
 			this._dataFormat.portfolioType = null;
 
@@ -657,8 +659,8 @@ module.exports = (() => {
 			updates.summaryTotalCurrent = updates.summaryTotalCurrent.add(translate(item, item.data.summaryTotalCurrent));
 			updates.summaryTotalPrevious = updates.summaryTotalPrevious.add(translate(item, item.data.summaryTotalPrevious));
 			updates.summaryTotalPrevious2 = updates.summaryTotalPrevious2.add(translate(item, item.data.summaryTotalPrevious2));
-			updates.endingPrevious = updates.endingPrevious.add(translate(item, item.data.endingPrevious));
-			updates.endingPrevious2 = updates.endingPrevious2.add(translate(item, item.data.endingPrevious2));
+			updates.marketPrevious = updates.marketPrevious.add(translate(item, item.data.marketPrevious));
+			updates.marketPrevious2 = updates.marketPrevious2.add(translate(item, item.data.marketPrevious2));
 
 			if (item.position.instrument.type === InstrumentType.CASH) {
 				updates.cashTotal = updates.cashTotal.add(translate(item, item.data.market));
@@ -673,8 +675,8 @@ module.exports = (() => {
 			summaryTotalCurrent: Decimal.ZERO,
 			summaryTotalPrevious: Decimal.ZERO,
 			summaryTotalPrevious2: Decimal.ZERO,
-			endingPrevious: Decimal.ZERO,
-			endingPrevious2: Decimal.ZERO,
+			marketPrevious: Decimal.ZERO,
+			marketPrevious2: Decimal.ZERO,
 			cashTotal: Decimal.ZERO
 		});
 
@@ -685,8 +687,8 @@ module.exports = (() => {
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
 		actual.summaryTotalPrevious = updates.summaryTotalPrevious;
 		actual.summaryTotalPrevious2 = updates.summaryTotalPrevious2;
-		actual.endingPrevious = updates.endingPrevious;
-		actual.endingPrevious2 = updates.endingPrevious2;
+		actual.marketPrevious = updates.marketPrevious;
+		actual.marketPrevious2 = updates.marketPrevious2;
 		actual.cashTotal = updates.cashTotal;
 
 		format.basis = formatCurrency(actual.basis, currency);
@@ -698,8 +700,8 @@ module.exports = (() => {
 		format.summaryTotalPreviousNegative = updates.summaryTotalPrevious.getIsNegative();
 		format.summaryTotalPrevious2 = formatCurrency(updates.summaryTotalPrevious2, currency);
 		format.summaryTotalPrevious2Negative = updates.summaryTotalPrevious2.getIsNegative();
-		format.endingPrevious = formatCurrency(updates.endingPrevious, currency);
-		format.endingPrevious2 = formatCurrency(updates.endingPrevious2, currency);
+		format.marketPrevious = formatCurrency(updates.marketPrevious, currency);
+		format.marketPrevious2 = formatCurrency(updates.marketPrevious2, currency);
 		format.cashTotal = formatCurrency(updates.cashTotal, currency);
 
 		calculateUnrealizedPercent(group);
@@ -708,9 +710,13 @@ module.exports = (() => {
 			const item = group._items[0];
 
 			actual.quantity = item.position.snapshot.open;
+			actual.quantityPrevious = item.data.quantityPrevious;
+			
 			actual.basisPrice = item.data.basisPrice;
 
 			format.quantity = formatDecimal(actual.quantity, 2);
+			format.quantityPrevious = formatDecimal(actual.quantityPrevious, 2);
+			
 			format.basisPrice = formatCurrency(actual.basisPrice, currency);
 
 			format.invalid = definition.type === PositionLevelType.POSITION && item.invalid;
@@ -797,23 +803,23 @@ module.exports = (() => {
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
 		actual.total = updates.unrealized.add(actual.realized).add(actual.income);
 
-		let endingChange = updates.market.subtract(actual.endingPrevious);
-		let endingChangePercent;
+		let marketChange = updates.market.subtract(actual.marketPrevious);
+		let marketChangePercent;
 
-		if (actual.endingPrevious.getIsZero()) {
-			if (endingChange.getIsPositive()) {
-				endingChangePercent = Decimal.ONE;
-			} else if (endingChange.getIsNegative()) {
-				endingChangePercent = Decimal.NEGATIVE_ONE;
+		if (actual.marketPrevious.getIsZero()) {
+			if (marketChange.getIsPositive()) {
+				marketChangePercent = Decimal.ONE;
+			} else if (marketChange.getIsNegative()) {
+				marketChangePercent = Decimal.NEGATIVE_ONE;
 			} else {
-				endingChangePercent = Decimal.ZERO;
+				marketChangePercent = Decimal.ZERO;
 			}
 		} else {
-			endingChangePercent = endingChange.divide(actual.endingPrevious);
+			marketChangePercent = marketChange.divide(actual.marketPrevious);
 		}
 
-		actual.endingChange = endingChange;
-		actual.endingChangePercent = endingChangePercent;
+		actual.marketChange = marketChange;
+		actual.marketChangePercent = marketChangePercent;
 
 		format.market = formatCurrency(actual.market, currency);
 		
@@ -834,8 +840,8 @@ module.exports = (() => {
 		format.total = formatCurrency(actual.total, currency);
 		format.totalNegative = actual.total.getIsNegative();
 
-		format.endingChange = formatCurrency(actual.endingChange, currency);
-		format.endingChangePercent = formatPercent(actual.endingChangePercent, 2);
+		format.marketChange = formatCurrency(actual.marketChange, currency);
+		format.marketChangePercent = formatPercent(actual.marketChangePercent, 2);
 
 		calculateUnrealizedPercent(group);
 	}

package/lib/processing/PositionItem.js

@@ -65,9 +65,12 @@ module.exports = (() => {
 			this._data.summaryTotalPrevious = null;
 			this._data.summaryTotalPrevious2 = null;
 
-			this._data.endingPrevious = null;
-			this._data.endingPrevious2 = null;
+			this._data.marketPrevious = null;
+			this._data.marketPrevious2 = null;
 
+			this._data.quantityPrevious = null;
+			this._data.quantityPrevious2 = null;
+			
 			this._data.realized = null;
 			this._data.income = null;
 			this._data.basisPrice = null;
@@ -391,8 +394,10 @@ module.exports = (() => {
 		data.summaryTotalPrevious = calculateSummaryTotal(previousSummary1, previousSummary2);
 		data.summaryTotalPrevious2 = calculateSummaryTotal(previousSummary2, previousSummary3);
 
-		data.endingPrevious = previousSummary1 === null ? Decimal.ZERO : previousSummary1.end.value;
-		data.endingPrevious2 = previousSummary2 === null ? Decimal.ZERO : previousSummary2.end.value;
+		data.marketPrevious = previousSummary1 === null ? Decimal.ZERO : previousSummary1.end.value;
+		data.marketPrevious2 = previousSummary2 === null ? Decimal.ZERO : previousSummary2.end.value;
+
+		data.quantityPrevious = previousSummary1 === null ? Decimal.ZERO : previousSummary1.end.open;
 
 		if (snapshot.open.getIsZero()) {
 			data.basisPrice = Decimal.ZERO;

package/lib/processing/definitions/PositionTreeDefinition.js

@@ -11,6 +11,7 @@ module.exports = (() => {
 	 * @public
 	 * @param {String} name
 	 * @param {Array.<PositionLevelDefinition>} definitions
+	 * @oaram {Array.<String>=} exclusionDependencies
 	 */
 	class PositionTreeDefinitions {
 		constructor(name, definitions, exclusionDependencies) {

package/lib/serialization/PositionSummaryDefinitionSchema.js

@@ -0,0 +1,58 @@
+const DataType = require('@barchart/common-js/serialization/json/DataType'),
+	Enum = require('@barchart/common-js/lang/Enum'),
+	Schema = require('@barchart/common-js/serialization/json/Schema'),
+	SchemaBuilder = require('@barchart/common-js/serialization/json/builders/SchemaBuilder');
+
+const PositionSummaryFrame = require('./../data/PositionSummaryFrame');
+
+module.exports = (() => {
+	'use strict';
+
+	/**
+	 * The schemas which can be used to represent position summary objects.
+	 *
+	 * @public
+	 * @extends {Enum}
+	 */
+	class PositionSummaryDefinitionSchema extends Enum {
+		constructor(schema) {
+			super(schema.name, schema.name);
+
+			this._schema = schema;
+		}
+
+		/**
+		 * The actual {@link Schema}.
+		 *
+		 * @public
+		 * @returns {Schema}
+		 */
+		get schema() {
+			return this._schema;
+		}
+
+		/**
+		 * The complete position summary definition schema.
+		 *
+		 * @static
+		 * @public
+		 * @returns {PositionSummaryDefinitionSchema}
+		 */
+		static get COMPLETE() {
+			return complete;
+		}
+
+		toString() {
+			return '[PositionSummaryDefinitionSchema]';
+		}
+	}
+
+	const complete = new PositionSummaryDefinitionSchema(SchemaBuilder.withName('complete')
+		.withField('start', DataType.DAY)
+		.withField('end', DataType.DAY)
+		.withField('frame', DataType.forEnum(PositionSummaryFrame, 'PositionSummaryFrame'))
+		.schema
+	);
+
+	return PositionSummaryDefinitionSchema;
+})();

package/lib/serialization/PositionSummarySchema.js

@@ -1,5 +1,4 @@
-const Currency = require('@barchart/common-js/lang/Currency'),
-	DataType = require('@barchart/common-js/serialization/json/DataType'),
+const DataType = require('@barchart/common-js/serialization/json/DataType'),
 	Enum = require('@barchart/common-js/lang/Enum'),
 	Schema = require('@barchart/common-js/serialization/json/Schema'),
 	SchemaBuilder = require('@barchart/common-js/serialization/json/builders/SchemaBuilder');

package/package.json

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

package/test/SpecRunner.js

@@ -399,7 +399,7 @@ module.exports = (() => {
 	'use strict';
 
 	/**
-	 * An enumeration used to define timeframes for position summaries.
+	 * An enumeration used to define time frames for position summaries.
 	 *
 	 * @public
 	 * @extends {Enum}
@@ -485,22 +485,44 @@ module.exports = (() => {
 		 * @return {Array.<PositionSummaryRange>}
 		 */
 		getRangesFromDate(date) {
+			assert.argumentIsRequired(date, 'date', Day, 'Day');
+
 			const transaction = { date: date, snapshot: { open: Decimal.ONE } };
 
 			return this.getRanges([ transaction ]);
 		}
 
+		/**
+		 * Returns the range immediately prior to the range containing the
+		 * date supplied.
+		 *
+		 * @public
+		 * @param {Day} date
+		 * @param {Number} periods
+		 */
+		getPriorRanges(date, periods) {
+			assert.argumentIsRequired(date, 'date', Day, 'Day');
+			assert.argumentIsRequired(periods, 'periods', Number, 'Number');
+
+			const transactionOne = { date: this.getStartDate((periods - 1), date), snapshot: { open: Decimal.ONE } };
+			const transactionTwo = { date: date, snapshot: { open: Decimal.ZERO } };
+
+			return this._rangeCalculator([ transactionOne, transactionTwo ]);
+		}
+
 		/**
 		 * Returns the start date for a frame, a given number of periods ago.
 		 *
 		 * @public
 		 * @param {Number} periods
+		 * @param {Day=} start
 		 * @returns {Day}
 		 */
-		getStartDate(periods) {
+		getStartDate(periods, start) {
 			assert.argumentIsRequired(periods, 'periods', Number);
+			assert.argumentIsOptional(start, 'start', Day, 'Day');
 
-			return this._startDateCalculator(periods);
+			return this._startDateCalculator(periods, start);
 		}
 
 		/**
@@ -562,6 +584,16 @@ module.exports = (() => {
 	 * @property {Day} end
 	 */
 
+	/**
+	 * The start and and date for a {@link PositionSummaryFrame} along with the frame type.
+	 *
+	 * @typedef PositionSummaryDefinition
+	 * @type {Object}
+	 * @property {Day} start
+	 * @property {Day} end
+	 * @property {PositionSummaryFrame} frame
+	 */
+
 	function getRange(start, end) {
 		return {
 			start: start,
@@ -623,29 +655,29 @@ module.exports = (() => {
 		return ranges;
 	}
 
-	function getYearlyStartDate(periods) {
-		const today = Day.getToday();
+	function getYearlyStartDate(periods, date) {
+		const today = date || Day.getToday();
 
-		return Day.getToday()
+		return today
 			.subtractMonths(today.month - 1)
 			.subtractDays(today.day)
 			.subtractYears(periods);
 	}
 
-	function getQuarterlyStartDate(periods) {
+	function getQuarterlyStartDate(periods, date) {
 		return null;
 	}
 
-	function getMonthlyStartDate(periods) {
+	function getMonthlyStartDate(periods, date) {
 		return null;
 	}
 
-	function getYearToDateStartDate(periods) {
+	function getYearToDateStartDate(periods, date) {
 		return null;
 	}
 
 	function getYearlyRangeDescription(start, end) {
-		return end.year.toString();
+		return `Year ended ${end.year.toString()}`;
 	}
 
 	function getQuarterlyRangeDescription(start, end) {
@@ -2473,12 +2505,14 @@ module.exports = (() => {
 			this._dataFormat.locked = false;
 			this._dataFormat.newsExists = false;
 			this._dataFormat.quantity = null;
+			this._dataFormat.quantityPrevious = null;
 			this._dataFormat.basisPrice = null;
 
 			this._dataActual.key = this._key;
 			this._dataActual.description = this._description;
 			this._dataActual.newsExists = false;
 			this._dataActual.quantity = null;
+			this._dataActual.quantityPrevious = null;
 			this._dataActual.basisPrice = null;
 
 			if (this._single && items.length === 1) {
@@ -2528,10 +2562,10 @@ module.exports = (() => {
 			this._dataActual.summaryTotalCurrent = null;
 			this._dataActual.summaryTotalPrevious = null;
 			this._dataActual.summaryTotalPrevious2 = null;
-			this._dataActual.endingPrevious = null;
-			this._dataActual.endingPrevious2 = null;
-			this._dataActual.endingChange = null;
-			this._dataActual.endingChangePercent = null;
+			this._dataActual.marketPrevious = null;
+			this._dataActual.marketPrevious2 = null;
+			this._dataActual.marketChange = null;
+			this._dataActual.marketChangePercent = null;
 			this._dataActual.cashTotal = null;
 
 			this._dataFormat.currentPrice = null;
@@ -2555,10 +2589,10 @@ module.exports = (() => {
 			this._dataFormat.summaryTotalPreviousNegative = false;
 			this._dataFormat.summaryTotalPrevious2 = null;
 			this._dataFormat.summaryTotalPrevious2Negative = false;
-			this._dataFormat.endingPrevious = null;
-			this._dataFormat.endingPrevious2 = null;
-			this._dataFormat.endingChange = null;
-			this._dataFormat.endingChangePercent = null;
+			this._dataFormat.marketPrevious = null;
+			this._dataFormat.marketPrevious2 = null;
+			this._dataFormat.marketChange = null;
+			this._dataFormat.marketChangePercent = null;
 			this._dataFormat.cashTotal = null;
 			this._dataFormat.portfolioType = null;
 
@@ -3055,8 +3089,8 @@ module.exports = (() => {
 			updates.summaryTotalCurrent = updates.summaryTotalCurrent.add(translate(item, item.data.summaryTotalCurrent));
 			updates.summaryTotalPrevious = updates.summaryTotalPrevious.add(translate(item, item.data.summaryTotalPrevious));
 			updates.summaryTotalPrevious2 = updates.summaryTotalPrevious2.add(translate(item, item.data.summaryTotalPrevious2));
-			updates.endingPrevious = updates.endingPrevious.add(translate(item, item.data.endingPrevious));
-			updates.endingPrevious2 = updates.endingPrevious2.add(translate(item, item.data.endingPrevious2));
+			updates.marketPrevious = updates.marketPrevious.add(translate(item, item.data.marketPrevious));
+			updates.marketPrevious2 = updates.marketPrevious2.add(translate(item, item.data.marketPrevious2));
 
 			if (item.position.instrument.type === InstrumentType.CASH) {
 				updates.cashTotal = updates.cashTotal.add(translate(item, item.data.market));
@@ -3071,8 +3105,8 @@ module.exports = (() => {
 			summaryTotalCurrent: Decimal.ZERO,
 			summaryTotalPrevious: Decimal.ZERO,
 			summaryTotalPrevious2: Decimal.ZERO,
-			endingPrevious: Decimal.ZERO,
-			endingPrevious2: Decimal.ZERO,
+			marketPrevious: Decimal.ZERO,
+			marketPrevious2: Decimal.ZERO,
 			cashTotal: Decimal.ZERO
 		});
 
@@ -3083,8 +3117,8 @@ module.exports = (() => {
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
 		actual.summaryTotalPrevious = updates.summaryTotalPrevious;
 		actual.summaryTotalPrevious2 = updates.summaryTotalPrevious2;
-		actual.endingPrevious = updates.endingPrevious;
-		actual.endingPrevious2 = updates.endingPrevious2;
+		actual.marketPrevious = updates.marketPrevious;
+		actual.marketPrevious2 = updates.marketPrevious2;
 		actual.cashTotal = updates.cashTotal;
 
 		format.basis = formatCurrency(actual.basis, currency);
@@ -3096,8 +3130,8 @@ module.exports = (() => {
 		format.summaryTotalPreviousNegative = updates.summaryTotalPrevious.getIsNegative();
 		format.summaryTotalPrevious2 = formatCurrency(updates.summaryTotalPrevious2, currency);
 		format.summaryTotalPrevious2Negative = updates.summaryTotalPrevious2.getIsNegative();
-		format.endingPrevious = formatCurrency(updates.endingPrevious, currency);
-		format.endingPrevious2 = formatCurrency(updates.endingPrevious2, currency);
+		format.marketPrevious = formatCurrency(updates.marketPrevious, currency);
+		format.marketPrevious2 = formatCurrency(updates.marketPrevious2, currency);
 		format.cashTotal = formatCurrency(updates.cashTotal, currency);
 
 		calculateUnrealizedPercent(group);
@@ -3106,9 +3140,13 @@ module.exports = (() => {
 			const item = group._items[0];
 
 			actual.quantity = item.position.snapshot.open;
+			actual.quantityPrevious = item.data.quantityPrevious;
+			
 			actual.basisPrice = item.data.basisPrice;
 
 			format.quantity = formatDecimal(actual.quantity, 2);
+			format.quantityPrevious = formatDecimal(actual.quantityPrevious, 2);
+			
 			format.basisPrice = formatCurrency(actual.basisPrice, currency);
 
 			format.invalid = definition.type === PositionLevelType.POSITION && item.invalid;
@@ -3195,23 +3233,23 @@ module.exports = (() => {
 		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
 		actual.total = updates.unrealized.add(actual.realized).add(actual.income);
 
-		let endingChange = updates.market.subtract(actual.endingPrevious);
-		let endingChangePercent;
+		let marketChange = updates.market.subtract(actual.marketPrevious);
+		let marketChangePercent;
 
-		if (actual.endingPrevious.getIsZero()) {
-			if (endingChange.getIsPositive()) {
-				endingChangePercent = Decimal.ONE;
-			} else if (endingChange.getIsNegative()) {
-				endingChangePercent = Decimal.NEGATIVE_ONE;
+		if (actual.marketPrevious.getIsZero()) {
+			if (marketChange.getIsPositive()) {
+				marketChangePercent = Decimal.ONE;
+			} else if (marketChange.getIsNegative()) {
+				marketChangePercent = Decimal.NEGATIVE_ONE;
 			} else {
-				endingChangePercent = Decimal.ZERO;
+				marketChangePercent = Decimal.ZERO;
 			}
 		} else {
-			endingChangePercent = endingChange.divide(actual.endingPrevious);
+			marketChangePercent = marketChange.divide(actual.marketPrevious);
 		}
 
-		actual.endingChange = endingChange;
-		actual.endingChangePercent = endingChangePercent;
+		actual.marketChange = marketChange;
+		actual.marketChangePercent = marketChangePercent;
 
 		format.market = formatCurrency(actual.market, currency);
 		
@@ -3232,8 +3270,8 @@ module.exports = (() => {
 		format.total = formatCurrency(actual.total, currency);
 		format.totalNegative = actual.total.getIsNegative();
 
-		format.endingChange = formatCurrency(actual.endingChange, currency);
-		format.endingChangePercent = formatPercent(actual.endingChangePercent, 2);
+		format.marketChange = formatCurrency(actual.marketChange, currency);
+		format.marketChangePercent = formatPercent(actual.marketChangePercent, 2);
 
 		calculateUnrealizedPercent(group);
 	}
@@ -3367,9 +3405,12 @@ module.exports = (() => {
 			this._data.summaryTotalPrevious = null;
 			this._data.summaryTotalPrevious2 = null;
 
-			this._data.endingPrevious = null;
-			this._data.endingPrevious2 = null;
+			this._data.marketPrevious = null;
+			this._data.marketPrevious2 = null;
 
+			this._data.quantityPrevious = null;
+			this._data.quantityPrevious2 = null;
+			
 			this._data.realized = null;
 			this._data.income = null;
 			this._data.basisPrice = null;
@@ -3693,8 +3734,10 @@ module.exports = (() => {
 		data.summaryTotalPrevious = calculateSummaryTotal(previousSummary1, previousSummary2);
 		data.summaryTotalPrevious2 = calculateSummaryTotal(previousSummary2, previousSummary3);
 
-		data.endingPrevious = previousSummary1 === null ? Decimal.ZERO : previousSummary1.end.value;
-		data.endingPrevious2 = previousSummary2 === null ? Decimal.ZERO : previousSummary2.end.value;
+		data.marketPrevious = previousSummary1 === null ? Decimal.ZERO : previousSummary1.end.value;
+		data.marketPrevious2 = previousSummary2 === null ? Decimal.ZERO : previousSummary2.end.value;
+
+		data.quantityPrevious = previousSummary1 === null ? Decimal.ZERO : previousSummary1.end.open;
 
 		if (snapshot.open.getIsZero()) {
 			data.basisPrice = Decimal.ZERO;
@@ -4184,6 +4227,7 @@ module.exports = (() => {
 	 * @public
 	 * @param {String} name
 	 * @param {Array.<PositionLevelDefinition>} definitions
+	 * @oaram {Array.<String>=} exclusionDependencies
 	 */
 	class PositionTreeDefinitions {
 		constructor(name, definitions, exclusionDependencies) {
@@ -17622,6 +17666,38 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			});
 		});
 	});
+
+	describe('and prior ranges are calculated', () => {
+		describe('for YEARLY ranges', () => {
+			describe('from 2017-10-10, including one previous ranges', () => {
+				let ranges;
+
+				beforeEach(() => {
+					ranges = PositionSummaryFrame.YEARLY.getPriorRanges(new Day(2015, 4, 20), 1);
+				});
+
+				it('should return two ranges', () => {
+					expect(ranges.length).toEqual(2);
+				});
+
+				it('the first range should begin on 2013-12-31', () => {
+					expect(ranges[0].start.getIsEqual(new Day(2013, 12, 31))).toEqual(true);
+				});
+
+				it('the first range should end on 2014-12-31', () => {
+					expect(ranges[0].end.getIsEqual(new Day(2014, 12, 31))).toEqual(true);
+				});
+
+				it('the second range should begin on 2014-12-31', () => {
+					expect(ranges[1].start.getIsEqual(new Day(2014, 12, 31))).toEqual(true);
+				});
+
+				it('the second range should end on 2015-12-31', () => {
+					expect(ranges[1].end.getIsEqual(new Day(2015, 12, 31))).toEqual(true);
+				});
+			});
+		});
+	});
 });
 
 },{"./../../../lib/data/PositionSummaryFrame":3,"./../../../lib/data/TransactionType":4,"@barchart/common-js/lang/Day":21,"@barchart/common-js/lang/Decimal":22}],53:[function(require,module,exports){

package/test/specs/data/PositionSummaryFrameSpec.js

@@ -422,4 +422,36 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 			});
 		});
 	});
+
+	describe('and prior ranges are calculated', () => {
+		describe('for YEARLY ranges', () => {
+			describe('from 2017-10-10, including one previous ranges', () => {
+				let ranges;
+
+				beforeEach(() => {
+					ranges = PositionSummaryFrame.YEARLY.getPriorRanges(new Day(2015, 4, 20), 1);
+				});
+
+				it('should return two ranges', () => {
+					expect(ranges.length).toEqual(2);
+				});
+
+				it('the first range should begin on 2013-12-31', () => {
+					expect(ranges[0].start.getIsEqual(new Day(2013, 12, 31))).toEqual(true);
+				});
+
+				it('the first range should end on 2014-12-31', () => {
+					expect(ranges[0].end.getIsEqual(new Day(2014, 12, 31))).toEqual(true);
+				});
+
+				it('the second range should begin on 2014-12-31', () => {
+					expect(ranges[1].start.getIsEqual(new Day(2014, 12, 31))).toEqual(true);
+				});
+
+				it('the second range should end on 2015-12-31', () => {
+					expect(ranges[1].end.getIsEqual(new Day(2015, 12, 31))).toEqual(true);
+				});
+			});
+		});
+	});
 });