@barchart/portfolio-api-common 7.1.1 → 7.3.0

package/lib/formatters/TransactionFormatter.js

@@ -171,10 +171,13 @@ module.exports = (() => {
 	};
 
 	const buySellFormatter = (t, f) => {
+		const ambiguous = is.object(t.snaptrade) && is.boolean(t.snaptrade.ambiguous) && t.snaptrade.ambiguous;
+
 		f.boughtSold = t.quantity;
 		f.price = t.trade.price;
 		f.fee = t.fee;
 		f.total = t.amount;
+		f.ambiguous = ambiguous;
 
 		if (t.description) {
 			f.description = t.description;
@@ -183,6 +186,7 @@ module.exports = (() => {
 		f.raw.total = getRawForDecimal(f.total);
 		f.raw.price = getRawForDecimal(f.price);
 		f.raw.boughtSold = getRawForDecimal(f.boughtSold);
+		f.raw.ambiguous = ambiguous;
 	};
 
 	const dividendFormatter = (t, f) => {

package/lib/providers/InstrumentProvider.js

@@ -60,16 +60,44 @@ module.exports = (() => {
 						return Promise.reject(`Instrument lookup for [ ${symbol} ] failed, the instrument does not exist`);
 					}
 
-					const instrument = result.instrument;
+					normalizeInstrument(result.instrument);
 
-					if (instrument.symbolType === 18) {
-						const match = instrument.name.match(regex.crypto.token) || null;
+					return result;
+				});
+		}
+
+		/**
+		 * Returns a promise for metadata for multiple instruments.
+		 *
+		 * @public
+		 * @async
+		 * @param {String[]} symbols
+		 * @returns {Promise<Object>}
+		 */
+		async getInstruments(symbols) {
+			assert.argumentIsArray(symbols, 'symbols', String);
+			assert.argumentIsValid(symbols.length, 'symbols.length', x => x > 0, 'is greater than zero');
 
-						if (match !== null) {
-							instrument.name = match[1];
-							instrument.currency = 'USD';
-							instrument.symbolType = 999;
-						}
+			const symbolList = symbols.join(',');
+
+			return promise.timeout(Gateway.invoke(instrumentsLookupEndpoint, { symbols: symbolList }), this._waitInMilliseconds, 'instrument lookup')
+				.catch((e) => {
+					let message;
+
+					if (is.string(e) && e === 'timeout') {
+						message = `Instrument lookup for [ ${symbolList} ] failed due to timed out`;
+					} else {
+						message = `Instrument lookup for [ ${symbolList} ] failed due to an unspecified error`;
+					}
+
+					return Promise.reject(message);
+				}).then((result) => {
+					if (result.instruments === null) {
+						return Promise.reject(`Instrument lookup for [ ${symbolList} ] failed, no instruments were returned`);
+					}
+
+					if (is.array(result.instruments)) {
+						result.instruments.forEach(normalizeInstrument);
 					}
 
 					return result;
@@ -94,5 +122,32 @@ module.exports = (() => {
 		.withErrorInterceptor(ErrorInterceptor.GENERAL)
 		.endpoint;
 
+	const instrumentsLookupEndpoint = EndpointBuilder.for('query-instruments', 'query instruments')
+		.withVerb(VerbType.GET)
+		.withProtocol(ProtocolType.HTTPS)
+		.withHost('instruments-prod.aws.barchart.com')
+		.withPort(443)
+		.withPathBuilder((pb) => {
+			pb.withLiteralParameter('instruments', 'instruments');
+		})
+		.withQueryBuilder((qb) => {
+			qb.withVariableParameter('symbols', 'symbols', 'symbols');
+		})
+		.withResponseInterceptor(ResponseInterceptor.DATA)
+		.withErrorInterceptor(ErrorInterceptor.GENERAL)
+		.endpoint;
+
+	function normalizeInstrument(instrument) {
+		if (instrument && instrument.symbolType === 18) {
+			const match = instrument.name.match(regex.crypto.token) || null;
+
+			if (match !== null) {
+				instrument.name = match[1];
+				instrument.currency = 'USD';
+				instrument.symbolType = 999;
+			}
+		}
+	}
+
 	return InstrumentProvider;
-})();
+})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "7.1.1",
+  "version": "7.3.0",
   "description": "Common JavaScript code used by Barchart's Portfolio Service",
   "author": {
     "name": "Bryan Ingle",