@barchart/portfolio-api-common 1.2.90 → 1.2.94

package/lib/data/PositionSummaryFrame.js

@@ -86,17 +86,52 @@ module.exports = (() => {
 			return this._rangeCalculator(getFilteredTransactions(transactions));
 		}
 
+		/**
+		 * Returns the range which contains a given date and all subsequent ranges.
+		 *
+		 * @public
+		 * @param {Day} date
+		 * @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);
 		}
 
 		/**
@@ -158,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,
@@ -219,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/PositionContainer.js

@@ -42,7 +42,7 @@ module.exports = (() => {
 	 * @param {Array.<Object>} portfolios - The portfolios.
 	 * @param {Array.<Object>} positions - The positions (for all of the portfolios).
 	 * @param {Array.<Object>} summaries - The positions summaries (for all of the positions).
-	 * @param {PositionSummaryFrame} - If specified, locks the current (and previous) periods to a specific frame, use for reporting.
+	 * @param {PositionSummaryFrame=} - If specified, locks the current (and previous) periods to a specific frame, use for reporting.
 	 */
 	class PositionContainer {
 		constructor(definitions, portfolios, positions, summaries, frame) {

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.90",
+  "version": "1.2.94",
   "description": "Common classes used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",

package/test/SpecRunner.js

@@ -477,17 +477,52 @@ module.exports = (() => {
 			return this._rangeCalculator(getFilteredTransactions(transactions));
 		}
 
+		/**
+		 * Returns the range which contains a given date and all subsequent ranges.
+		 *
+		 * @public
+		 * @param {Day} date
+		 * @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);
 		}
 
 		/**
@@ -549,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,
@@ -610,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) {
@@ -1421,7 +1466,7 @@ module.exports = (() => {
 	 * @param {Array.<Object>} portfolios - The portfolios.
 	 * @param {Array.<Object>} positions - The positions (for all of the portfolios).
 	 * @param {Array.<Object>} summaries - The positions summaries (for all of the positions).
-	 * @param {PositionSummaryFrame} - If specified, locks the current (and previous) periods to a specific frame, use for reporting.
+	 * @param {PositionSummaryFrame=} - If specified, locks the current (and previous) periods to a specific frame, use for reporting.
 	 */
 	class PositionContainer {
 		constructor(definitions, portfolios, positions, summaries, frame) {
@@ -4171,6 +4216,7 @@ module.exports = (() => {
 	 * @public
 	 * @param {String} name
 	 * @param {Array.<PositionLevelDefinition>} definitions
+	 * @oaram {Array.<String>=} exclusionDependencies
 	 */
 	class PositionTreeDefinitions {
 		constructor(name, definitions, exclusionDependencies) {
@@ -17609,6 +17655,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);
+				});
+			});
+		});
+	});
 });