@barchart/portfolio-api-common 1.0.14 → 1.0.18

package/lib/data/PositionSummaryFrame.js

@@ -1,5 +1,8 @@
-const assert = require('@barchart/common-js/lang/assert'),
-	Enum = require('@barchart/common-js/lang/Enum');
+const array = require('@barchart/common-js/lang/array'),
+	assert = require('@barchart/common-js/lang/assert'),
+	Day = require('@barchart/common-js/lang/Day'),
+	Enum = require('@barchart/common-js/lang/Enum'),
+	is = require('@barchart/common-js/lang/is');
 
 module.exports = (() => {
 	'use strict';
@@ -9,13 +12,23 @@ module.exports = (() => {
 	 *
 	 * @public
 	 * @extends {Enum}
-	 * @param {String} description
 	 * @param {String} code
-	 * @param {Boolean} canReinvest
+	 * @param {String} description
+	 * @param {Function} rangeCalculator
 	 */
 	class PositionSummaryFrame extends Enum {
-		constructor(code, description) {
+		constructor(code, description, rangeCalculator) {
 			super(code, description);
+
+			assert.argumentIsRequired(rangeCalculator, 'rangeCalculator', Function);
+
+			this._rangeCalculator = rangeCalculator;
+		}
+
+		getRanges(transactions) {
+			assert.argumentIsArray(transactions, 'transactions');
+
+			return this._rangeCalculator(transactions);
 		}
 
 		/**
@@ -63,10 +76,71 @@ module.exports = (() => {
 		}
 	}
 
-	const yearly = new PositionSummaryFrame('YEARL', 'year');
-	const quarterly = new PositionSummaryFrame('QUARTER', 'quarter');
-	const monthly = new PositionSummaryFrame('MONTH', 'month');
-	const ytd = new PositionSummaryFrame('YTD', 'year-to-date');
+	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);
+
+	function getRange(start, end) {
+		return {
+			start: start,
+			end: end
+		};
+	}
+
+	function getYearlyRanges(transactions) {
+		const ranges = [ ];
+
+		if (transactions.length !== 0) {
+			const first = array.first(transactions);
+			const last = array.last(transactions);
+
+			const firstDate = first.date;
+			const lastDate = last.date;
+
+			let lastYear;
+
+			if (last.snapshot.open.getIsZero()) {
+				lastYear = last.date.year + 1;
+			} else {
+				lastYear = Day.getToday().year;
+			}
+
+			for (let end = new Day(firstDate.year, 12, 31); end.year < lastYear; end = end.addYears(1)) {
+				ranges.push(getRange(end.subtractYears(1), end));
+			}
+		}
+
+		return ranges;
+	}
+
+	function getQuarterlyRanges(transactions) {
+		return [ ];
+	}
+
+	function getMonthlyRanges(transactions) {
+		return [ ];
+	}
+
+	function getYearToDateRanges(transactions) {
+		const ranges = [ ];
+
+		if (transactions.length !== 0) {
+			const first = array.first(transactions);
+			const last = array.last(transactions);
+
+			const currentYear = Day.getToday().year;
+
+			if (!last.snapshot.open.getIsZero() || last.date.year === currentYear) {
+				let end = new Day(Day.getToday().year, 12, 31);
+				let start = end.subtractYears(1);
+
+				ranges.push(getRange(start, end));
+			}
+		}
+
+		return ranges;
+	}
 
 	return PositionSummaryFrame;
 })();

package/lib/serialization/PortfolioSchema.js

@@ -61,6 +61,7 @@ module.exports = (() => {
 		.withField('legacy.warnings', DataType.NUMBER, true)
 		.withField('legacy.drops', DataType.NUMBER, true)
 		.withField('system.version', DataType.NUMBER, true)
+		.withField('data', DataType.OBJECT, true)
 		.schema
 	);
 
@@ -72,6 +73,7 @@ module.exports = (() => {
 		.withField('defaults.currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('defaults.reinvest', DataType.BOOLEAN, true)
 		.withField('defaults.valuation', DataType.forEnum(ValuationType, 'ValuationType'))
+		.withField('data', DataType.OBJECT, true)
 		.schema
 	);
 
@@ -82,6 +84,7 @@ module.exports = (() => {
 		.withField('defaults.currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('defaults.reinvest', DataType.BOOLEAN, true)
 		.withField('defaults.valuation', DataType.forEnum(ValuationType, 'ValuationType'))
+		.withField('data', DataType.OBJECT, true)
 		.schema
 	);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.0.14",
+  "version": "1.0.18",
   "description": "Common classes used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",
@@ -14,6 +14,7 @@
   "devDependencies": {
     "babel-core": "^6.26.0",
     "babel-preset-es2015": "^6.24.1",
+    "babelify": "^8.0.0",
     "browserify": "^14.5.0",
     "git-get-status": "^1.0.5",
     "glob": "^6.0.1",