@barchart/portfolio-client-js 2.0.1 → 3.2.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 ability to query positions by symbol. See the ```PortfolioGateway.``` function.

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

@@ -84,7 +84,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
 				})
 				.withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE)
@@ -99,7 +100,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios');
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios');
 				})
 				.withBody('portfolio')
 				.withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE)
@@ -115,7 +117,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
 				})
 				.withBody('portfolio')
@@ -132,7 +135,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
 				})
 				.withRequestInterceptor(requestInterceptor)
@@ -145,13 +149,16 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.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)
@@ -165,7 +172,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withVariableParameter('position', 'position', 'position', false);
@@ -183,7 +191,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withVariableParameter('position', 'position', 'position', false);
@@ -200,7 +209,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('summaries', 'summaries')
 						.withVariableParameter('position', 'position', 'position',  false);
@@ -222,7 +232,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withVariableParameter('position', 'position', 'position',  false)
@@ -240,7 +251,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withVariableParameter('position', 'position', 'position', false)
@@ -261,7 +273,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withVariableParameter('position', 'position', 'position', false)
@@ -282,7 +295,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withVariableParameter('position', 'position', 'position', false)
@@ -304,7 +318,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withVariableParameter('position', 'position', 'position', false)
@@ -327,7 +342,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withVariableParameter('position', 'position', 'position', true)
@@ -353,7 +369,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('wealthscope', 'wealthscope')
 						.withLiteralParameter('token', 'token');
@@ -370,7 +387,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('reports', 'reports')
 						.withLiteralParameter('brokerage', 'brokerage')
@@ -391,7 +409,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('system', 'system')
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('system', 'system')
 						.withLiteralParameter('version', 'version');
 				})
 				.withRequestInterceptor(requestInterceptor)
@@ -543,7 +562,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
@@ -564,6 +583,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.
 		 *
@@ -1073,19 +1124,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).
 		 *
@@ -1110,6 +1148,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

@@ -7,6 +7,6 @@ module.exports = (() => {
 	return {
 		JwtGateway: JwtGateway,
 		PortfolioGateway: PortfolioGateway,
-		version: '2.0.1'
+		version: '3.2.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": "2.0.1",
+  "version": "3.2.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",