@barchart/portfolio-api-common 1.2.5 → 1.2.9

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 || code === 11) {
+				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/formatters/TransactionFormatter.js

@@ -93,6 +93,7 @@ module.exports = (() => {
 		return {
 			date: t.date,
 			type: t.type.display,
+			code: t.type.code,
 			sequence: t.sequence,
 			instrument: i,
 			position: t.position

package/lib/processing/PositionItem.js

@@ -115,7 +115,7 @@ module.exports = (() => {
 		 * Indicates if the position's symbol is invalid.
 		 *
 		 * @public
-		 * @returns {Object}
+		 * @returns {Boolean}
 		 */
 		get invalid() {
 			return this._invalid;

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.5",
+  "version": "1.2.9",
   "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 || code === 11) {
+				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]';
 		}
@@ -3079,7 +3098,7 @@ module.exports = (() => {
 		 * Indicates if the position's symbol is invalid.
 		 *
 		 * @public
-		 * @returns {Object}
+		 * @returns {Boolean}
 		 */
 		get invalid() {
 			return this._invalid;