@barchart/portfolio-api-common 1.2.3 → 1.2.7

package/lib/data/InstrumentType.js

@@ -155,8 +155,8 @@ module.exports = (() => {
 		/**
 		 * Generates an identifier for the instrument.
 		 *
-		 * @static
 		 * @public
+		 * @static
 		 * @param {Object} instrument
 		 * @returns {String}
 		 */
@@ -164,6 +164,25 @@ module.exports = (() => {
 			return map[instrument.type.code].generateIdentifier(instrument);
 		}
 
+		/**
+		 *
+		 * @public
+		 * @static
+		 * @param code
+		 * @return {InstrumentType}
+		 */
+		static fromSymbolType(code) {
+			assert.argumentIsRequired(code, 'code', Number);
+
+			if (code === 1 || code === 6 || code === 7) {
+				return InstrumentType.EQUITY;
+			} else if (code === 5 || code == 15) {
+				return InstrumentType.FUND;
+			} else {
+				throw new Error('Unable to determine InstrumentType for [', code, ']');
+			}
+		}
+
 		toString() {
 			return '[InstrumentType]';
 		}

package/lib/processing/PositionGroup.js

@@ -71,6 +71,7 @@ module.exports = (() => {
 			this._dataFormat.key = this._key;
 			this._dataFormat.description = this._description;
 			this._dataFormat.hide = false;
+			this._dataFormat.invalid = false;
 			this._dataFormat.newsExists = false;
 			this._dataFormat.quantity = null;
 			this._dataFormat.basisPrice = null;
@@ -412,7 +413,7 @@ module.exports = (() => {
 		 * @public
 		 */
 		refresh() {
-			calculateStaticData(this, this._rates);
+			calculateStaticData(this, this._rates, this._definition);
 			calculatePriceData(this, this._rates, null, true);
 		}
 
@@ -458,9 +459,6 @@ module.exports = (() => {
 			if (this._single) {
 				const precision = sender.position.instrument.currency.precision;
 
-				this._dataActual.invalid = this._definition.type === PositionLevelType.POSITION && item.invalid;
-				this._dataFormat.invalid = this._dataActual.invalid;
-
 				this._dataActual.currentPrice = quote.lastPrice;
 				this._dataFormat.currentPrice = formatNumber(this._dataActual.currentPrice, precision);
 
@@ -617,7 +615,7 @@ module.exports = (() => {
 		return formatDecimal(decimal, currency.precision);
 	}
 
-	function calculateStaticData(group, rates) {
+	function calculateStaticData(group, rates, definition) {
 		const actual = group._dataActual;
 		const format = group._dataFormat;
 
@@ -694,6 +692,8 @@ module.exports = (() => {
 
 			format.quantity = formatDecimal(actual.quantity, 2);
 			format.basisPrice = formatCurrency(actual.basisPrice, currency);
+
+			format.invalid = definition.type === PositionLevelType.POSITION && item.invalid;
 		}
 
 		const groupItems = group._items;

package/lib/processing/PositionItem.js

@@ -111,6 +111,16 @@ module.exports = (() => {
 			return this._currency;
 		}
 
+		/**
+		 * Indicates if the position's symbol is invalid.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get invalid() {
+			return this._invalid;
+		}
+
 		/**
 		 * The year-to-date position summary of the encapsulated position.
 		 *

package/lib/serialization/PositionSchema.js

@@ -138,6 +138,11 @@ module.exports = (() => {
 	const update = new PositionSchema(SchemaBuilder.withName('update')
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
+		.withField('mapping.name', DataType.STRING, true)
+		.withField('mapping.type', DataType.forEnum(InstrumentType, 'InstrumentType'), true)
+		.withField('mapping.currency', DataType.forEnum(Currency, 'Currency'), true)
+		.withField('mapping.symbol.barchart', DataType.STRING, true)
+		.withField('mapping.symbol.display', DataType.STRING, true)
 		.withField('reinvest', DataType.BOOLEAN, true)
 		.schema
 	);

package/package.json

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

package/test/SpecRunner.js

@@ -156,8 +156,8 @@ module.exports = (() => {
 		/**
 		 * Generates an identifier for the instrument.
 		 *
-		 * @static
 		 * @public
+		 * @static
 		 * @param {Object} instrument
 		 * @returns {String}
 		 */
@@ -165,6 +165,25 @@ module.exports = (() => {
 			return map[instrument.type.code].generateIdentifier(instrument);
 		}
 
+		/**
+		 *
+		 * @public
+		 * @static
+		 * @param code
+		 * @return {InstrumentType}
+		 */
+		static fromSymbolType(code) {
+			assert.argumentIsRequired(code, 'code', Number);
+
+			if (code === 1 || code === 6 || code === 7) {
+				return InstrumentType.EQUITY;
+			} else if (code === 5 || code == 15) {
+				return InstrumentType.FUND;
+			} else {
+				throw new Error('Unable to determine InstrumentType for [', code, ']');
+			}
+		}
+
 		toString() {
 			return '[InstrumentType]';
 		}
@@ -2173,6 +2192,7 @@ module.exports = (() => {
 			this._dataFormat.key = this._key;
 			this._dataFormat.description = this._description;
 			this._dataFormat.hide = false;
+			this._dataFormat.invalid = false;
 			this._dataFormat.newsExists = false;
 			this._dataFormat.quantity = null;
 			this._dataFormat.basisPrice = null;
@@ -2514,7 +2534,7 @@ module.exports = (() => {
 		 * @public
 		 */
 		refresh() {
-			calculateStaticData(this, this._rates);
+			calculateStaticData(this, this._rates, this._definition);
 			calculatePriceData(this, this._rates, null, true);
 		}
 
@@ -2560,9 +2580,6 @@ module.exports = (() => {
 			if (this._single) {
 				const precision = sender.position.instrument.currency.precision;
 
-				this._dataActual.invalid = this._definition.type === PositionLevelType.POSITION && item.invalid;
-				this._dataFormat.invalid = this._dataActual.invalid;
-
 				this._dataActual.currentPrice = quote.lastPrice;
 				this._dataFormat.currentPrice = formatNumber(this._dataActual.currentPrice, precision);
 
@@ -2719,7 +2736,7 @@ module.exports = (() => {
 		return formatDecimal(decimal, currency.precision);
 	}
 
-	function calculateStaticData(group, rates) {
+	function calculateStaticData(group, rates, definition) {
 		const actual = group._dataActual;
 		const format = group._dataFormat;
 
@@ -2796,6 +2813,8 @@ module.exports = (() => {
 
 			format.quantity = formatDecimal(actual.quantity, 2);
 			format.basisPrice = formatCurrency(actual.basisPrice, currency);
+
+			format.invalid = definition.type === PositionLevelType.POSITION && item.invalid;
 		}
 
 		const groupItems = group._items;
@@ -3075,6 +3094,16 @@ module.exports = (() => {
 			return this._currency;
 		}
 
+		/**
+		 * Indicates if the position's symbol is invalid.
+		 *
+		 * @public
+		 * @returns {Boolean}
+		 */
+		get invalid() {
+			return this._invalid;
+		}
+
 		/**
 		 * The year-to-date position summary of the encapsulated position.
 		 *