@barchart/portfolio-api-common 1.2.95 → 1.2.99

package/lib/processing/PositionContainer.js

@@ -42,20 +42,27 @@ 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=} reportFrame - If specified, locks the current (and previous) periods to a specific frame, use for reporting.
+	 * @param {Day=} reportDate - The end date for the report frame.
 	 */
 	class PositionContainer {
-		constructor(definitions, portfolios, positions, summaries, frame) {
+		constructor(definitions, portfolios, positions, summaries, reportFrame, reportDate) {
 			assert.argumentIsArray(definitions, 'definitions', PositionTreeDefinition, 'PositionTreeDefinition');
 			assert.argumentIsArray(portfolios, 'portfolios');
 			assert.argumentIsArray(positions, 'positions');
 			assert.argumentIsArray(summaries, 'summaries');
-			assert.argumentIsOptional(frame, 'frame', PositionSummaryFrame, 'PositionSummaryFrame');
+			assert.argumentIsOptional(reportFrame, 'reportFrame', PositionSummaryFrame, 'PositionSummaryFrame');
+
+			if (reportFrame) {
+				assert.argumentIsRequired(reportDate, 'reportDate', Day, 'Day');
+			}
 
 			this._definitions = definitions;
 
 			this._groupBindings = { };
 
+			this._reporting = reportFrame instanceof PositionSummaryFrame;
+
 			this._positionSymbolAddedEvent = new Event(this);
 			this._positionSymbolRemovedEvent = new Event(this);
 
@@ -65,15 +72,21 @@ module.exports = (() => {
 				return map;
 			}, { });
 
-			this._currentSummaryFrame = frame || PositionSummaryFrame.YTD;
-			this._currentSummaryRange = array.last(this._currentSummaryFrame.getRecentRanges(0));
+			if (reportFrame) {
+				this._currentSummaryFrame = reportFrame;
+				this._currentSummaryRange = array.last(this._currentSummaryFrame.getPriorRanges(reportDate, 0));
 
-			this._previousSummaryFrame = frame || PositionSummaryFrame.YEARLY;
-			this._previousSummaryRanges = this._previousSummaryFrame.getRecentRanges(3);
+				this._previousSummaryFrame = reportFrame;
+				this._previousSummaryRanges = this._currentSummaryFrame.getPriorRanges(reportDate, 3);
 
-			if (this._currentSummaryFrame === this._previousSummaryFrame) {
 				this._previousSummaryRanges.pop();
 			} else {
+				this._currentSummaryFrame = PositionSummaryFrame.YTD;
+				this._currentSummaryRange = array.first(this._currentSummaryFrame.getRecentRanges(0));
+
+				this._previousSummaryFrame = PositionSummaryFrame.YEARLY;
+				this._previousSummaryRanges = this._previousSummaryFrame.getRecentRanges(3);
+
 				this._previousSummaryRanges.shift();
 			}
 
@@ -942,7 +955,7 @@ module.exports = (() => {
 			const currentSummary = this._summariesCurrent[ position.position ] || null;
 			const previousSummaries = this._summariesPrevious[ position.position ] || getSummaryArray(this._previousSummaryRanges);
 
-			returnRef = new PositionItem(portfolio, position, currentSummary, previousSummaries);
+			returnRef = new PositionItem(portfolio, position, currentSummary, previousSummaries, this._reporting);
 		} else {
 			returnRef = null;
 		}

package/lib/processing/PositionItem.js

@@ -20,9 +20,10 @@ module.exports = (() => {
 	 * @param {Object} position
 	 * @param {Object} currentSummary
 	 * @param {Array.<Object>} previousSummaries
+	 * @param {Boolean} reporting
 	 */
 	class PositionItem extends Disposable {
-		constructor(portfolio, position, currentSummary, previousSummaries) {
+		constructor(portfolio, position, currentSummary, previousSummaries, reporting) {
 			super();
 
 			this._portfolio = portfolio;
@@ -36,6 +37,8 @@ module.exports = (() => {
 			this._currentSummary = currentSummary || null;
 			this._previousSummaries = previousSummaries || [ ];
 
+			this._reporting = reporting;
+
 			this._data = { };
 
 			this._data.basis = null;
@@ -364,7 +367,7 @@ module.exports = (() => {
 
 	function calculateStaticData(item) {
 		const position = item.position;
-		const snapshot = item.position.snapshot;
+		const snapshot = getSnapshot(position, item.currentSummary, item._reporting);
 		const previousSummaries = item.previousSummaries;
 
 		const data = item._data;
@@ -408,7 +411,7 @@ module.exports = (() => {
 
 	function calculatePriceData(item, price) {
 		const position = item.position;
-		const snapshot = item.position.snapshot;
+		const snapshot = getSnapshot(position, item.currentSummary, item._reporting);
 		const previousSummaries = item.previousSummaries;
 
 		const data = item._data;
@@ -560,5 +563,27 @@ module.exports = (() => {
 		return is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
 	}
 
+	function getSnapshot(position, currentSummary, reporting) {
+		let snapshot;
+
+		if (reporting) {
+			snapshot = { };
+
+			snapshot.date = currentSummary.end.date;
+			snapshot.open = currentSummary.end.open;
+			snapshot.direction = currentSummary.end.direction;
+			snapshot.buys = currentSummary.period.buys;
+			snapshot.sells = currentSummary.period.sells;
+			snapshot.gain = currentSummary.period.realized;
+			snapshot.basis = currentSummary.end.basis;
+			snapshot.income = currentSummary.period.income;
+			snapshot.value = currentSummary.end.value;
+		} else {
+			snapshot = position.snapshot;
+		}
+
+		return snapshot;
+	}
+
 	return PositionItem;
 })();

package/lib/serialization/{PositionSummaryDefinitionSchema.js → reports/BrokerageReportAvailabilitySchema.js}

@@ -3,18 +3,18 @@ const DataType = require('@barchart/common-js/serialization/json/DataType'),
 	Schema = require('@barchart/common-js/serialization/json/Schema'),
 	SchemaBuilder = require('@barchart/common-js/serialization/json/builders/SchemaBuilder');
 
-const PositionSummaryFrame = require('./../data/PositionSummaryFrame');
+const PositionSummaryFrame = require('./../../data/PositionSummaryFrame');
 
 module.exports = (() => {
 	'use strict';
 
 	/**
-	 * The schemas which can be used to represent position summary objects.
+	 * Schema used to represent availability of a brokerage report.
 	 *
 	 * @public
 	 * @extends {Enum}
 	 */
-	class PositionSummaryDefinitionSchema extends Enum {
+	class BrokerageReportAvailabilitySchema extends Enum {
 		constructor(schema) {
 			super(schema.name, schema.name);
 
@@ -36,23 +36,23 @@ module.exports = (() => {
 		 *
 		 * @static
 		 * @public
-		 * @returns {PositionSummaryDefinitionSchema}
+		 * @returns {BrokerageReportAvailabilitySchema}
 		 */
 		static get COMPLETE() {
 			return complete;
 		}
 
 		toString() {
-			return '[PositionSummaryDefinitionSchema]';
+			return '[BrokerageReportAvailabilitySchema]';
 		}
 	}
 
-	const complete = new PositionSummaryDefinitionSchema(SchemaBuilder.withName('complete')
+	const complete = new BrokerageReportAvailabilitySchema(SchemaBuilder.withName('complete')
 		.withField('start', DataType.DAY)
 		.withField('end', DataType.DAY)
 		.withField('frame', DataType.forEnum(PositionSummaryFrame, 'PositionSummaryFrame'))
 		.schema
 	);
 
-	return PositionSummaryDefinitionSchema;
+	return BrokerageReportAvailabilitySchema;
 })();

package/package.json

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

package/test/SpecRunner.js

@@ -1466,20 +1466,27 @@ 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=} reportFrame - If specified, locks the current (and previous) periods to a specific frame, use for reporting.
+	 * @param {Day=} reportDate - The end date for the report frame.
 	 */
 	class PositionContainer {
-		constructor(definitions, portfolios, positions, summaries, frame) {
+		constructor(definitions, portfolios, positions, summaries, reportFrame, reportDate) {
 			assert.argumentIsArray(definitions, 'definitions', PositionTreeDefinition, 'PositionTreeDefinition');
 			assert.argumentIsArray(portfolios, 'portfolios');
 			assert.argumentIsArray(positions, 'positions');
 			assert.argumentIsArray(summaries, 'summaries');
-			assert.argumentIsOptional(frame, 'frame', PositionSummaryFrame, 'PositionSummaryFrame');
+			assert.argumentIsOptional(reportFrame, 'reportFrame', PositionSummaryFrame, 'PositionSummaryFrame');
+
+			if (reportFrame) {
+				assert.argumentIsRequired(reportDate, 'reportDate', Day, 'Day');
+			}
 
 			this._definitions = definitions;
 
 			this._groupBindings = { };
 
+			this._reporting = reportFrame instanceof PositionSummaryFrame;
+
 			this._positionSymbolAddedEvent = new Event(this);
 			this._positionSymbolRemovedEvent = new Event(this);
 
@@ -1489,15 +1496,21 @@ module.exports = (() => {
 				return map;
 			}, { });
 
-			this._currentSummaryFrame = frame || PositionSummaryFrame.YTD;
-			this._currentSummaryRange = array.last(this._currentSummaryFrame.getRecentRanges(0));
+			if (reportFrame) {
+				this._currentSummaryFrame = reportFrame;
+				this._currentSummaryRange = array.last(this._currentSummaryFrame.getPriorRanges(reportDate, 0));
 
-			this._previousSummaryFrame = frame || PositionSummaryFrame.YEARLY;
-			this._previousSummaryRanges = this._previousSummaryFrame.getRecentRanges(3);
+				this._previousSummaryFrame = reportFrame;
+				this._previousSummaryRanges = this._currentSummaryFrame.getPriorRanges(reportDate, 3);
 
-			if (this._currentSummaryFrame === this._previousSummaryFrame) {
 				this._previousSummaryRanges.pop();
 			} else {
+				this._currentSummaryFrame = PositionSummaryFrame.YTD;
+				this._currentSummaryRange = array.first(this._currentSummaryFrame.getRecentRanges(0));
+
+				this._previousSummaryFrame = PositionSummaryFrame.YEARLY;
+				this._previousSummaryRanges = this._previousSummaryFrame.getRecentRanges(3);
+
 				this._previousSummaryRanges.shift();
 			}
 
@@ -2366,7 +2379,7 @@ module.exports = (() => {
 			const currentSummary = this._summariesCurrent[ position.position ] || null;
 			const previousSummaries = this._summariesPrevious[ position.position ] || getSummaryArray(this._previousSummaryRanges);
 
-			returnRef = new PositionItem(portfolio, position, currentSummary, previousSummaries);
+			returnRef = new PositionItem(portfolio, position, currentSummary, previousSummaries, this._reporting);
 		} else {
 			returnRef = null;
 		}
@@ -3360,9 +3373,10 @@ module.exports = (() => {
 	 * @param {Object} position
 	 * @param {Object} currentSummary
 	 * @param {Array.<Object>} previousSummaries
+	 * @param {Boolean} reporting
 	 */
 	class PositionItem extends Disposable {
-		constructor(portfolio, position, currentSummary, previousSummaries) {
+		constructor(portfolio, position, currentSummary, previousSummaries, reporting) {
 			super();
 
 			this._portfolio = portfolio;
@@ -3376,6 +3390,8 @@ module.exports = (() => {
 			this._currentSummary = currentSummary || null;
 			this._previousSummaries = previousSummaries || [ ];
 
+			this._reporting = reporting;
+
 			this._data = { };
 
 			this._data.basis = null;
@@ -3704,7 +3720,7 @@ module.exports = (() => {
 
 	function calculateStaticData(item) {
 		const position = item.position;
-		const snapshot = item.position.snapshot;
+		const snapshot = getSnapshot(position, item.currentSummary, item._reporting);
 		const previousSummaries = item.previousSummaries;
 
 		const data = item._data;
@@ -3748,7 +3764,7 @@ module.exports = (() => {
 
 	function calculatePriceData(item, price) {
 		const position = item.position;
-		const snapshot = item.position.snapshot;
+		const snapshot = getSnapshot(position, item.currentSummary, item._reporting);
 		const previousSummaries = item.previousSummaries;
 
 		const data = item._data;
@@ -3900,6 +3916,28 @@ module.exports = (() => {
 		return is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
 	}
 
+	function getSnapshot(position, currentSummary, reporting) {
+		let snapshot;
+
+		if (reporting) {
+			snapshot = { };
+
+			snapshot.date = currentSummary.end.date;
+			snapshot.open = currentSummary.end.open;
+			snapshot.direction = currentSummary.end.direction;
+			snapshot.buys = currentSummary.period.buys;
+			snapshot.sells = currentSummary.period.sells;
+			snapshot.gain = currentSummary.period.realized;
+			snapshot.basis = currentSummary.end.basis;
+			snapshot.income = currentSummary.period.income;
+			snapshot.value = currentSummary.end.value;
+		} else {
+			snapshot = position.snapshot;
+		}
+
+		return snapshot;
+	}
+
 	return PositionItem;
 })();