@barchart/portfolio-api-common 1.0.202 → 1.0.206

package/lib/api/failures/PortfolioFailureType.js

@@ -12,6 +12,17 @@ module.exports = (() => {
 		constructor() {
 		}
 
+		/**
+		 * The portfolio referenced does not exist.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get POSITION_CREATE_FAILED_NO_PORTFOLIO() {
+			return positionCreateFailedNoPortfolio;
+		}
+
 		/**
 		 * The transaction would occur before an existing transaction.
 		 *
@@ -60,6 +71,8 @@ module.exports = (() => {
 		}
 	}
 
+	const positionCreateFailedNoPortfolio = new FailureType('POSITION_CREATE_FAILED_OUT_OF_SEQUENCE', 'Unable to create transaction. The referenced portfolio does not exist. Has it been deleted?');
+
 	const transactionCreateFailedOutOfSequence = new FailureType('TRANSACTION_CREATE_FAILED_OUT_OF_SEQUENCE', 'Unable to create transaction, because the transaction date is out-of-sequence. In other words, it would occur before an existing transaction. Please confirm your intent to re-write transaction history (which could take some time and alter the historical results for this position).');
 	const transactionCreateFailedDirectionSwitch = new FailureType('TRANSACTION_CREATE_FAILED_DIRECTION_SWITCH', 'Unable to create transaction, because the position direction would be switched (from long to short or vice versa). Please close the position (to a zero balance) first, then enter a second transaction.');
 	const transactionCreateRewriteUnsupported = new FailureType('TRANSACTION_CREATE_REWRITE_UNSUPPORTED', 'Unable to re-write transaction history. This operation is not currently supported (but will be implemented soon).');

package/lib/data/InstrumentType.js

@@ -1,3 +1,5 @@
+const uuid = require('uuid');
+
 const assert = require('@barchart/common-js/lang/assert'),
 	Enum = require('@barchart/common-js/lang/Enum');
 
@@ -16,16 +18,19 @@ module.exports = (() => {
 	 * @param {Boolean} usesSymbols
 	 */
 	class InstrumentType extends Enum {
-		constructor(code, description, alternateDescription, canReinvest, usesSymbols) {
+		constructor(code, description, alternateDescription, canReinvest, usesSymbols, generator) {
 			super(code, description);
 
 			assert.argumentIsRequired(alternateDescription, 'alternateDescription', String);
 			assert.argumentIsRequired(canReinvest, 'canReinvest', Boolean);
 			assert.argumentIsRequired(usesSymbols, 'usesSymbols', Boolean);
+			assert.argumentIsRequired(generator, 'generator', Function);
 
 			this._alternateDescription = alternateDescription;
 			this._canReinvest = canReinvest;
 			this._usesSymbols = usesSymbols;
+
+			this._generator = generator;
 		}
 
 		/**
@@ -58,6 +63,23 @@ module.exports = (() => {
 			return this._usesSymbols;
 		}
 
+		/**
+		 * Generates an identifier for the instrument.
+		 *
+		 * @public
+		 * @param instrument
+		 * @returns {String}
+		 */
+		generateIdentifier(instrument) {
+			assert.argumentIsRequired(instrument, 'instrument');
+
+			if (instrument.type !== this) {
+				throw new Error('Unable to generate instrument identifier for incompatible type.');
+			}
+
+			return this._generator(instrument);
+		}
+
 		/**
 		 * Cash.
 		 *
@@ -102,15 +124,34 @@ module.exports = (() => {
 			return other;
 		}
 
+		/**
+		 * Generates an identifier for the instrument.
+		 *
+		 * @static
+		 * @public
+		 * @param instrument
+		 * @returns {String}
+		 */
+		static generateIdentifier(instrument) {
+			return map[instrument.type.code].generateIdentifier(instrument);
+		}
+
 		toString() {
 			return '[InstrumentType]';
 		}
 	}
 
-	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false);
-	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true);
-	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, true);
-	const other = new InstrumentType('OTHER', 'other', 'Other', false, false);
+	const cash = new InstrumentType('CASH', 'cash', 'Cash', false, false, (instrument) => `BARCHART-${instrument.type.code}-${instrument.currency.code}`);
+	const equity = new InstrumentType('EQUITY', 'equity', 'Equities', true, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
+	const fund = new InstrumentType('FUND', 'mutual fund', 'Funds', true, true, (instrument) => `BARCHART-${instrument.type.code}-${instrument.symbol.barchart}`);
+	const other = new InstrumentType('OTHER', 'other', 'Other', false, false, (instrument) => `BARCHART-${instrument.type.code}-${uuid.v4()}`);
+
+	const map = { };
+
+	map[cash.code] = cash;
+	map[equity.code] = equity;
+	map[fund.code] = fund;
+	map[other.code] = other;
 
 	return InstrumentType;
 })();

package/lib/formatters/TransactionFormatter.js

@@ -90,7 +90,8 @@ module.exports = (() => {
 			date: t.date,
 			type: t.type.display,
 			sequence: t.sequence,
-			instrument: t.instrument
+			instrument: t.instrument,
+			position: t.position
 		};
 
 		if (basic.instrument) {

package/lib/serialization/TransactionSchema.js

@@ -448,7 +448,6 @@ module.exports = (() => {
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('value', DataType.DECIMAL)
-		.withField('fee', DataType.DECIMAL, true)
 		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);