@barchart/portfolio-api-common 1.0.40 → 1.0.45

package/lib/data/InstrumentType.js

@@ -10,16 +10,22 @@ module.exports = (() => {
 	 * @public
 	 * @extends {Enum}
 	 * @param {String} description
+	 * @param {String} alternateDescription
 	 * @param {String} code
 	 * @param {Boolean} canReinvest
 	 */
 	class InstrumentType extends Enum {
-		constructor(code, description, canReinvest) {
+		constructor(code, description, alternateDescription, canReinvest) {
 			super(code, description);
 
+			this._alternateDescription = alternateDescription;
 			this._canReinvest = canReinvest;
 		}
 
+		get alternateDescription() {
+			return this._alternateDescription;
+		}
+
 		/**
 		 * Indicates if the instrument type allows automatic reinvestment.
 		 *
@@ -74,10 +80,10 @@ module.exports = (() => {
 		}
 	}
 
-	const cash = new InstrumentType('CASH', 'cash', false);
-	const equity = new InstrumentType('EQUITY', 'equity', true);
-	const fund = new InstrumentType('FUND', 'mutual fund', true);
-	const other = new InstrumentType('OTHER', 'other', false);
+	const cash = new InstrumentType('CASH', 'cash', 'Cash', false);
+	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true);
+	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true);
+	const other = new InstrumentType('OTHER', 'other', 'Other', false);
 
 	return InstrumentType;
 })();

package/lib/processing/PositionGroup.js

@@ -1,4 +1,5 @@
 const assert = require('@barchart/common-js/lang/assert'),
+	Decimal = require('@barchart/common-js/lang/Decimal'),
 	is = require('@barchart/common-js/lang/is');
 
 module.exports = (() => {
@@ -18,16 +19,21 @@ module.exports = (() => {
 
 			this._data.description = this._description;
 
-			this._data.previous = null;
 			this._data.current = null;
+			this._data.previous = null;
+
+			this._data.basis = null;
+			this._data.market = null;
 
 			this._items.forEach((item) => {
-				item.registerPriceChangeHandler((price, sender) => {
+				item.registerPriceChangeHandler((data, sender) => {
 					if (this._single) {
-						data.current = price;
+						data.current = data.current;
 					} else {
 						data.current = null;
 					}
+
+					calculateVariablePriceData(this, item, price);
 				});
 			});
 
@@ -46,6 +52,10 @@ module.exports = (() => {
 			return this._items;
 		}
 
+		get single() {
+			return this._single;
+		}
+
 		toString() {
 			return '[PositionGroup]';
 		}
@@ -55,10 +65,29 @@ module.exports = (() => {
 		const items = group._items;
 		const data = group._data;
 
-		const updates = items.reduce(function(updates, item) {
+		let updates;
+
+		if (group.single) {
+			const item = items[0];
 
-		}, { });
+			updates.basis = item.basis;
+		} else {
+			updates = items.reduce(function(updates, item) {
+				const position = item.position;
+				const snapshot = item.position.snapshot;
+
+				updates.value = updates.basis.add(snapshot.basis);
+
+				return updates;
+			}, {
+				basis: Decimal.ZERO
+			});
+		}
+
+		data.basis = updates.basis;
+	}
 
+	function calculateVariablePriceData(group, item, price) {
 
 	}
 

package/lib/processing/PositionItem.js

@@ -14,7 +14,13 @@ module.exports = (() => {
 			this._position = position;
 			this._summaries = summaries || [ ];
 
-			this._price = null;
+			this._data = { };
+
+			this._data.current = null;
+			this._data.previous = position.previous || null;
+
+			const snapshot = this._position.snapshot;
+
 			this._priceChangeEvent = new Event(this);
 		}
 
@@ -31,8 +37,10 @@ module.exports = (() => {
 		}
 
 		setPrice(price) {
-			if (this._price !== price) {
-				this._priceChangeEvent.fire(this._price = price);
+			if (this._data.price !== price) {
+				this._data.price = price;
+
+				this._priceChangeEvent.fire(this._data);
 			}
 		}
 

package/lib/serialization/PositionSchema.js

@@ -6,7 +6,8 @@ const assert = require('@barchart/common-js/lang/assert'),
 	Schema = require('@barchart/common-js/serialization/json/Schema'),
 	SchemaBuilder = require('@barchart/common-js/serialization/json/builders/SchemaBuilder');
 
-const ValuationType = require('./../data/ValuationType');
+const InstrumentType = require('./../data/InstrumentType'),
+	ValuationType = require('./../data/ValuationType');
 
 module.exports = (() => {
 	'use strict';
@@ -67,7 +68,7 @@ module.exports = (() => {
 		.withField('sequence', DataType.NUMBER)
 		.withField('instrument.id', DataType.STRING)
 		.withField('instrument.name', DataType.STRING)
-		.withField('instrument.type', DataType.STRING)
+		.withField('instrument.type', DataType.forEnum(InstrumentType, 'InstrumentType'))
 		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('instrument.delist', DataType.DAY, true)
 		.withField('instrument.symbol.barchart', DataType.STRING, true)
@@ -99,7 +100,7 @@ module.exports = (() => {
 		.withField('sequence', DataType.NUMBER)
 		.withField('instrument.id', DataType.STRING)
 		.withField('instrument.name', DataType.STRING)
-		.withField('instrument.type', DataType.STRING)
+		.withField('instrument.type', DataType.forEnum(InstrumentType, 'InstrumentType'))
 		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('instrument.delist', DataType.DAY, true)
 		.withField('instrument.symbol.barchart', DataType.STRING, true)
@@ -117,6 +118,7 @@ module.exports = (() => {
 		.withField('snapshot.basis', DataType.DECIMAL)
 		.withField('snapshot.income', DataType.DECIMAL)
 		.withField('snapshot.value', DataType.DECIMAL)
+		.withField('previous', DataType.DECIMAL, true)
 		.schema
 	);
 

package/package.json

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

package/test/SpecRunner.js

@@ -653,6 +653,7 @@ module.exports = (() => {
 
 },{"./PositionGroup":4,"./PositionGroupDefinition":5,"./PositionItem":6,"@barchart/common-js/collections/Tree":7,"@barchart/common-js/lang/array":14,"@barchart/common-js/lang/assert":15,"@barchart/common-js/lang/is":16}],4:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
+	Decimal = require('@barchart/common-js/lang/Decimal'),
 	is = require('@barchart/common-js/lang/is');
 
 module.exports = (() => {
@@ -672,16 +673,21 @@ module.exports = (() => {
 
 			this._data.description = this._description;
 
-			this._data.previous = null;
 			this._data.current = null;
+			this._data.previous = null;
+
+			this._data.basis = null;
+			this._data.market = null;
 
 			this._items.forEach((item) => {
-				item.registerPriceChangeHandler((price, sender) => {
+				item.registerPriceChangeHandler((data, sender) => {
 					if (this._single) {
-						data.current = price;
+						data.current = data.current;
 					} else {
 						data.current = null;
 					}
+
+					calculateVariablePriceData(this, item, price);
 				});
 			});
 
@@ -700,6 +706,10 @@ module.exports = (() => {
 			return this._items;
 		}
 
+		get single() {
+			return this._single;
+		}
+
 		toString() {
 			return '[PositionGroup]';
 		}
@@ -709,17 +719,36 @@ module.exports = (() => {
 		const items = group._items;
 		const data = group._data;
 
-		const updates = items.reduce(function(updates, item) {
+		let updates;
 
-		}, { });
+		if (group.single) {
+			const item = items[0];
 
+			updates.basis = item.basis;
+		} else {
+			updates = items.reduce(function(updates, item) {
+				const position = item.position;
+				const snapshot = item.position.snapshot;
+
+				updates.value = updates.basis.add(snapshot.basis);
+
+				return updates;
+			}, {
+				basis: Decimal.ZERO
+			});
+		}
+
+		data.basis = updates.basis;
+	}
+
+	function calculateVariablePriceData(group, item, price) {
 
 	}
 
 	return PositionGroup;
 })();
 
-},{"@barchart/common-js/lang/assert":15,"@barchart/common-js/lang/is":16}],5:[function(require,module,exports){
+},{"@barchart/common-js/lang/Decimal":11,"@barchart/common-js/lang/assert":15,"@barchart/common-js/lang/is":16}],5:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
 	is = require('@barchart/common-js/lang/is');
 
@@ -781,7 +810,13 @@ module.exports = (() => {
 			this._position = position;
 			this._summaries = summaries || [ ];
 
-			this._price = null;
+			this._data = { };
+
+			this._data.current = null;
+			this._data.previous = position.previous || null;
+
+			const snapshot = this._position.snapshot;
+
 			this._priceChangeEvent = new Event(this);
 		}
 
@@ -798,8 +833,10 @@ module.exports = (() => {
 		}
 
 		setPrice(price) {
-			if (this._price !== price) {
-				this._priceChangeEvent.fire(this._price = price);
+			if (this._data.price !== price) {
+				this._data.price = price;
+
+				this._priceChangeEvent.fire(this._data);
 			}
 		}
 
@@ -4992,12 +5029,31 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 });
 
 },{"./../../../lib/data/PositionSummaryFrame":1,"./../../../lib/data/TransactionType":2,"@barchart/common-js/lang/Day":10,"@barchart/common-js/lang/Decimal":11}],20:[function(require,module,exports){
+const Decimal = require('@barchart/common-js/lang/Decimal');
+
 const PositionContainer = require('./../../../lib/processing/PositionContainer'),
 	PositionGroupDefinition = require('./../../../lib/processing/PositionGroupDefinition');
 
 describe('When a position container data is gathered', () => {
 	'use strict';
 
+	let positionCounter = 0;
+
+	function getPosition(portfolio, symbol) {
+		return {
+			portfolio: portfolio,
+			position: (positionCounter++).toString(),
+			instrument: {
+				symbol: {
+					barchart: symbol
+				}
+			},
+			snapshot: {
+				basis: new Decimal(123)
+			}
+		}
+	}
+
 	describe('for two portfolios, each with the same position, and the second portfolio with an additonal position', () => {
 		let portfolios;
 		let positions;
@@ -5015,31 +5071,9 @@ describe('When a position container data is gathered', () => {
 			];
 
 			positions = [
-				{
-					portfolio: 'a',
-					position: '1',
-					instrument: {
-						symbol: {
-							barchart: 'AAPL'
-						}
-					},
-				}, {
-					portfolio: 'b',
-					position: '2',
-					instrument: {
-						symbol: {
-							barchart: 'AAPL'
-						}
-					}
-				}, {
-					portfolio: 'b',
-					position: '3',
-					instrument: {
-						symbol: {
-							barchart: 'TSLA'
-						}
-					}
-				}
+				getPosition('a', 'AAPL'),
+				getPosition('b', 'AAPL'),
+				getPosition('b', 'TSLA')
 			];
 
 			summaries = [ ];
@@ -5090,4 +5124,4 @@ describe('When a position container data is gathered', () => {
 	});
 });
 
-},{"./../../../lib/processing/PositionContainer":3,"./../../../lib/processing/PositionGroupDefinition":5}]},{},[19,20]);
+},{"./../../../lib/processing/PositionContainer":3,"./../../../lib/processing/PositionGroupDefinition":5,"@barchart/common-js/lang/Decimal":11}]},{},[19,20]);

package/test/specs/processing/PositionContainerSpec.js

@@ -1,9 +1,28 @@
+const Decimal = require('@barchart/common-js/lang/Decimal');
+
 const PositionContainer = require('./../../../lib/processing/PositionContainer'),
 	PositionGroupDefinition = require('./../../../lib/processing/PositionGroupDefinition');
 
 describe('When a position container data is gathered', () => {
 	'use strict';
 
+	let positionCounter = 0;
+
+	function getPosition(portfolio, symbol) {
+		return {
+			portfolio: portfolio,
+			position: (positionCounter++).toString(),
+			instrument: {
+				symbol: {
+					barchart: symbol
+				}
+			},
+			snapshot: {
+				basis: new Decimal(123)
+			}
+		}
+	}
+
 	describe('for two portfolios, each with the same position, and the second portfolio with an additonal position', () => {
 		let portfolios;
 		let positions;
@@ -21,31 +40,9 @@ describe('When a position container data is gathered', () => {
 			];
 
 			positions = [
-				{
-					portfolio: 'a',
-					position: '1',
-					instrument: {
-						symbol: {
-							barchart: 'AAPL'
-						}
-					},
-				}, {
-					portfolio: 'b',
-					position: '2',
-					instrument: {
-						symbol: {
-							barchart: 'AAPL'
-						}
-					}
-				}, {
-					portfolio: 'b',
-					position: '3',
-					instrument: {
-						symbol: {
-							barchart: 'TSLA'
-						}
-					}
-				}
+				getPosition('a', 'AAPL'),
+				getPosition('b', 'AAPL'),
+				getPosition('b', 'TSLA')
 			];
 
 			summaries = [ ];