@barchart/portfolio-client-js 3.0.0 → 3.3.0

package/.releases/3.1.0.md

@@ -0,0 +1,3 @@
+**New Features**
+
+* Added ```JwtProvider.forAdmin``` function.

package/.releases/3.2.0.md

@@ -0,0 +1,3 @@
+**New Features**
+
+* Added ```PortfolioGateway.queryPositionsForSymbol``` function.

package/.releases/3.3.0.md

@@ -0,0 +1,3 @@
+**New Features**
+
+* Added ```product``` to the ```PortfolioGateway```.

package/example/node/example.js

@@ -0,0 +1,59 @@
+const PortfolioGateway = require('./../../lib/gateway/PortfolioGateway'),
+	JwtProvider = require('./../../lib/security/JwtProvider');
+
+console.info(`Example: Node.js example script started.`);
+
+let portfolioGateway = null;
+
+process.on('SIGINT', () => {
+	console.info('Example: Processing SIGINT');
+
+	if (portfolioGateway !== null) {
+		portfolioGateway.dispose();
+	}
+
+	process.exit();
+});
+
+process.on('unhandledRejection', (error) => {
+	console.error('Unhandled Promise Rejection', error);
+});
+
+process.on('uncaughtException', (error) => {
+	console.error('Unhandled Error', error);
+});
+
+const userId = process.argv[2];
+const contextId = process.argv[3];
+
+const symbol = process.argv[4];
+
+if (typeof(userId) !== 'string' || userId.length === 0) {
+	console.error('A user identifier must be specified. Usage example: "node example.js user-123"');
+	process.exit();
+}
+
+console.info(`Example: Initializing PortfolioGateway, connecting to test environment as [ ${userId} ] [ ${contextId} ].`);
+
+PortfolioGateway.forDevelopment(JwtProvider.forDevelopment(userId, contextId))
+	.then((gateway) => {
+		portfolioGateway = gateway;
+
+		console.info(`Example: Retrieving portfolio(s) for [ ${userId} ] [ ${contextId} ].`);
+
+		return portfolioGateway.readPortfolios()
+			.then((portfolios) => {
+				console.info(`Example: Retrieved [ ${portfolios.length} ] portfolio(s) for [ ${userId} ] [ ${contextId} ].`);
+			});
+	}).then(() => {
+		console.info(`Example: Querying positions(s) for [ ${userId} ] [ ${contextId} ] [ ${symbol} ].`);
+
+		return portfolioGateway.queryPositionsForSymbol(symbol)
+			.then((portfolios) => {
+				console.info(`Example: Retrieved [ ${portfolios.length} ] portion(s) for [ ${userId} ] [ ${contextId} ] [ ${symbol} ].`);
+			});
+	}).then(() => {
+		portfolioGateway.dispose();
+
+		console.info(`Example: Node.js example script completed normally.`);
+	});

package/lib/gateway/PortfolioGateway.js

@@ -34,7 +34,7 @@ module.exports = (() => {
 
 	const REST_API_SECURE_PROTOCOL = 'https';
 	const REST_API_SECURE_PORT = 443;
-	
+
 	/**
 	 * The **central component of the SDK**. It is responsible for connecting to Barchart's
 	 * Portfolio Service. It can be used to query, edit, and delete portfolios.
@@ -44,19 +44,20 @@ module.exports = (() => {
 	 * @param {String} host - The hostname of the Portfolio web service.
 	 * @param {Number} port - The TCP port number of the Portfolio web service.
 	 * @param {String} environment - A description of the environment we're connecting to.
+	 * @param {String=} product - A product code which uses the gateway.
 	 * @extends {Disposable}
 	 */
 	class PortfolioGateway extends Disposable {
-		constructor(protocol, host, port, environment) {
+		constructor(protocol, host, port, environment, product) {
 			super();
 
 			this._environment = environment;
 
 			this._jwtProvider = null;
-			
+
 			this._started = false;
 			this._startPromise = null;
-			
+
 			const requestInterceptor = RequestInterceptor.fromDelegate((options, endpoint) => {
 				return Promise.resolve()
 					.then(() => {
@@ -65,6 +66,10 @@ module.exports = (() => {
 								options.headers = options.headers || {};
 								options.headers.Authorization = `Bearer ${token}`;
 
+								if (is.string(product) && product.length > 0) {
+									options.headers['X-Barchart-Product'] = product;
+								}
+
 								return options;
 							});
 					}).catch((e) => {
@@ -156,7 +161,9 @@ module.exports = (() => {
 						.withVariableParameter('position', 'position', 'position', false);
 				})
 				.withQueryBuilder((qb) => {
-					qb.withVariableParameter('includePreviousPrice', 'includePreviousPrice', 'includePreviousPrice', true);
+					qb.withVariableParameter('open', 'open', 'open', true)
+						.withVariableParameter('symbol', 'symbol', 'symbol', true)
+						.withVariableParameter('includePreviousPrice', 'includePreviousPrice', 'includePreviousPrice', true);
 				})
 				.withRequestInterceptor(requestInterceptor)
 				.withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE)
@@ -560,7 +567,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Retrieves positions for a user, a user's portfolio, or a single position.
+		 * Retrieves all positions for a user, a user's portfolio, or a single position.
 		 *
 		 * @public
 		 * @param {String=} portfolio
@@ -581,6 +588,38 @@ module.exports = (() => {
 				});
 		}
 
+		/**
+		 * Queries positions.
+		 *
+		 * @public
+		 * @param {String} symbol
+		 * @param {Boolean=} open
+		 * @param {PositionSchema=} schema
+		 * @returns {Promise<Position[]>}
+		 */
+		queryPositionsForSymbol(symbol, open, schema) {
+			return Promise.resolve()
+				.then(() => {
+					checkStart.call(this);
+
+					assert.argumentIsRequired(symbol, 'symbol', String);
+					assert.argumentIsOptional(open, 'open', Boolean);
+
+					const payload = { };
+
+					payload.portfolio = '*';
+					payload.position = '*';
+
+					payload.symbol = symbol;
+
+					if (open) {
+						payload.open = open;
+					}
+
+					return Gateway.invoke(this._readPositionsEndpoint, payload);
+				});
+		}
+
 		/**
 		 * Updates a position.
 		 *
@@ -1090,19 +1129,6 @@ module.exports = (() => {
 				});
 		}
 
-		/**
-		 * Returns current API version of portfolio.
-		 *
-		 * @public
-		 * @returns {Promise<Object>}
-		 */
-		readVersion() {
-			return Promise.resolve()
-				.then(() => {
-					return Gateway.invoke(this._readVersionEndpoint);
-				});
-		}
-
 		/**
 		 * Generates a URL suitable for downloading a brokerage report (as a PDF).
 		 *
@@ -1127,6 +1153,33 @@ module.exports = (() => {
 				});
 		}
 
+		/**
+		 * Queries existing positions for a specific symbol.
+		 *
+		 * @public
+		 * @param {String} symbol
+		 * @returns {Promise<Array>}
+		 */
+		querySymbol(symbol) {
+			return Promise.resolve()
+				.then(() => {
+					return [ ];
+				});
+		}
+
+		/**
+		 * Returns current API version of portfolio.
+		 *
+		 * @public
+		 * @returns {Promise<Object>}
+		 */
+		readVersion() {
+			return Promise.resolve()
+				.then(() => {
+					return Gateway.invoke(this._readVersionEndpoint);
+				});
+		}
+
 		/**
 		 * Creates and starts a new {@link PortfolioGateway} for use in the public test environment.
 		 *

package/lib/index.js

@@ -1,12 +1,12 @@
-const JwtGateway = require('./security/JwtGateway'),
+const JwtProvider = require('./security/JwtProvider'),
 	PortfolioGateway = require('./gateway/PortfolioGateway');
 
 module.exports = (() => {
 	'use strict';
 
 	return {
-		JwtGateway: JwtGateway,
+		JwtProvider: JwtProvider,
 		PortfolioGateway: PortfolioGateway,
-		version: '3.0.0'
+		version: '3.3.0'
 	};
-})();
+})();

package/lib/security/JwtProvider.js

@@ -136,6 +136,22 @@ module.exports = (() => {
 			return getJwtProviderForImpersonation(Configuration.getJwtImpersonationHost, 'dev', userId, contextId, permissions);
 		}
 
+		/**
+		 * Builds a {@link JwtProvider} which will generate tokens impersonating the specified
+		 * user. The "admin" environment is for Barchart use only and access is restricted
+		 * to Barchart's internal network.
+		 *
+		 * @public
+		 * @static
+		 * @param {String} userId - The user identifier to impersonate.
+		 * @param {String} contextId - The context identifier of the user to impersonate.
+		 * @param {String=} permissions - The desired permission level.
+		 * @returns {JwtProvider}
+		 */
+		static forAdmin(userId, contextId, permissions) {
+			return getJwtProviderForImpersonation(Configuration.getJwtImpersonationHost, 'admin', userId, contextId, permissions);
+		}
+
 		_onDispose() {
 			this._scheduler.dispose();
 			this._scheduler = null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-client-js",
-  "version": "3.0.0",
+  "version": "3.3.0",
   "description": "JavaScript library for interfacing with Barchart's Portfolio API",
   "author": {
     "name": "Bryan Ingle",
@@ -22,7 +22,7 @@
   ],
   "dependencies": {
     "@barchart/common-js": "^3.15.0",
-    "@barchart/portfolio-api-common": "^1.4.4"
+    "@barchart/portfolio-api-common": "^1.5.0"
   },
   "devDependencies": {
     "@babel/core": "^7.11.1",