@barchart/portfolio-api-common 1.0.36 → 1.0.37

package/lib/data/PositionSummaryFrame.js

@@ -15,14 +15,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) {
@@ -31,6 +33,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.
 		 *
@@ -76,10 +84,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 {
@@ -142,6 +150,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) {

package/lib/serialization/PositionSummarySchema.js

@@ -56,15 +56,6 @@ module.exports = (() => {
 			return client;
 		}
 
-		/**
-		 * @static
-		 * @public
-		 * @returns {PositionSummarySchema}
-		 */
-		static get DISPLAY() {
-			return display;
-		}
-
 		toString() {
 			return '[PositionSummarySchema]';
 		}
@@ -132,37 +123,5 @@ module.exports = (() => {
 		.schema
 	);
 
-	const display = new PositionSummarySchema(SchemaBuilder.withName('display')
-		.withField('user', DataType.STRING)
-		.withField('portfolio', DataType.STRING)
-		.withField('position', DataType.STRING)
-		.withField('instrument.id', DataType.STRING)
-		.withField('instrument.name', DataType.STRING)
-		.withField('instrument.type', DataType.STRING)
-		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'))
-		.withField('instrument.delist', DataType.DAY, true)
-		.withField('instrument.symbol.barchart', DataType.STRING, true)
-		.withField('instrument.symbol.display', DataType.STRING, true)
-		.withField('frame', DataType.forEnum(PositionSummaryFrame, 'PositionSummaryFrame'))
-		.withField('start.date', DataType.DAY)
-		.withField('start.sequence', DataType.NUMBER)
-		.withField('start.open', DataType.DECIMAL)
-		.withField('start.basis', DataType.DECIMAL)
-		.withField('start.value', DataType.DECIMAL)
-		.withField('end.date', DataType.DAY)
-		.withField('end.sequence', DataType.NUMBER)
-		.withField('end.open', DataType.DECIMAL)
-		.withField('end.basis', DataType.DECIMAL)
-		.withField('end.value', DataType.DECIMAL)
-		.withField('period.buys', DataType.DECIMAL)
-		.withField('period.sells', DataType.DECIMAL)
-		.withField('period.income', DataType.DECIMAL)
-		.withField('period.realized', DataType.DECIMAL)
-		.withField('period.unrealized', DataType.DECIMAL)
-		.withField('additional.name', DataType.STRING)
-		.withField('additional.close', DataType.NUMBER)
-		.schema
-	);
-
 	return PositionSummarySchema;
 })();

package/package.json

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

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) {
@@ -3963,6 +3992,48 @@ 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":5,"@barchart/common-js/lang/Decimal":6}]},{},[12]);

package/test/specs/data/PositionSummaryFrameSpec.js

@@ -310,4 +310,46 @@ 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);
+			});
+		});
+	});
 });