@barchart/portfolio-api-common 1.0.27 → 1.0.32

package/lib/formatters/PositionSummaryFormatter.js

@@ -0,0 +1,71 @@
+const array = require('@barchart/common-js/lang/array'),
+	assert = require('@barchart/common-js/lang/assert'),
+	Decimal = require('@barchart/common-js/lang/Decimal'),
+	formatter = require('@barchart/common-js/lang/formatter');
+
+module.exports = (() => {
+
+	/**
+	 * Formats Position Summary records into groups based on instrument type
+	 *
+	 */
+	class PositionSummaryFormatter{
+
+		/**
+		 * The formatter
+		 *
+		 * @param {Array} summaries
+		 * @returns {Object}
+		 */
+		static format(summaries) {
+			assert.argumentIsRequired(summaries, 'summaries', Object);
+
+			const summaryGroups = array.groupBy(summaries, summary => summary.instrument.type.code);
+
+			const total = {
+				start: Decimal.ZERO,
+				change: Decimal.ZERO,
+				end: Decimal.ZERO
+			};
+
+			const formattedSummaryGroups = Object.keys(summaryGroups).map((group) => {
+				const positions = summaryGroups[group];
+
+				let start = Decimal.ZERO;
+				let end = Decimal.ZERO;
+
+				positions.map((position) => {
+					start = start.add(position.start.value);
+					end = end.add(position.end.value);
+				});
+
+				const change = end.subtract(start);
+
+				total.start = total.start.add(start);
+				total.change = total.change.add(change);
+				total.end = total.end.add(end);
+
+				return summaryGroups[group] = {
+					name: group,
+					start: formatNumber(start.toFloat()),
+					end: formatNumber(end.toFloat()),
+					change: formatNumber(change.toFloat())
+				};
+			});
+
+			Object.keys(total).map(key => total[key] = formatNumber(total[key].toFloat()));
+
+			return {
+				groups: formattedSummaryGroups,
+				total
+			};
+		}
+	}
+
+	const formatNumber = (float) => {
+		return formatter.numberToString(float, 2, ',');
+	};
+
+	return PositionSummaryFormatter;
+
+})();

package/lib/serialization/TransactionSchema.js

@@ -272,6 +272,11 @@ module.exports = (() => {
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
+		.withField('instrument.name', DataType.STRING, true)
+		.withField('instrument.type', DataType.STRING, true)
+		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'), true)
+		.withField('instrument.symbol.barchart', DataType.STRING, true)
+		.withField('instrument.symbol.display', DataType.STRING, true)
 		.withField('date', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
 		.withField('quantity', DataType.DECIMAL)
@@ -283,11 +288,6 @@ module.exports = (() => {
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('instrument.name', DataType.STRING, true)
-		.withField('instrument.type', DataType.STRING, true)
-		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'), true)
-		.withField('instrument.symbol.barchart', DataType.STRING, true)
-		.withField('instrument.symbol.display', DataType.STRING, true)
 		.withField('date', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
 		.withField('quantity', DataType.DECIMAL)
@@ -301,8 +301,7 @@ module.exports = (() => {
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('rate', DataType.DECIMAL)
-		.withField('open', DataType.DECIMAL, true)
-		.withField('effective', DataType.DAY, true)
+		.withField('effective', DataType.DAY)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
 	);
@@ -313,8 +312,7 @@ module.exports = (() => {
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('rate', DataType.DECIMAL)
-		.withField('open', DataType.DECIMAL, true)
-		.withField('effective', DataType.DAY, true)
+		.withField('effective', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
@@ -326,8 +324,7 @@ module.exports = (() => {
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('rate', DataType.DECIMAL)
-		.withField('open', DataType.DECIMAL, true)
-		.withField('effective', DataType.DAY, true)
+		.withField('effective', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
@@ -339,8 +336,7 @@ module.exports = (() => {
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('rate', DataType.DECIMAL)
-		.withField('open', DataType.DECIMAL, true)
-		.withField('effective', DataType.DAY, true)
+		.withField('effective', DataType.DAY)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
 	);
@@ -351,8 +347,8 @@ module.exports = (() => {
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('rate', DataType.DECIMAL)
-		.withField('open', DataType.DECIMAL, true)
-		.withField('effective', DataType.DAY, true)
+		.withField('effective', DataType.DAY)
+		.withField('price', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
 	);
@@ -364,7 +360,7 @@ module.exports = (() => {
 		.withField('date', DataType.DAY)
 		.withField('numerator', DataType.DECIMAL)
 		.withField('denominator', DataType.DECIMAL)
-		.withField('effective', DataType.DAY, true)
+		.withField('effective', DataType.DAY)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
 	);

package/package.json

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