@barchart/portfolio-client-js 1.2.39 → 1.2.42

package/example/example.js

@@ -62,20 +62,6 @@ module.exports = function () {
 				return '[Configuration]';
 			}
 		}], [{
-			key: 'localHost',
-			get: function get() {
-				return '127.0.0.1';
-			}
-
-			/**
-    * The host of the development system.
-    *
-    * @public
-    * @static
-    * @returns {String}
-    */
-
-		}, {
 			key: 'developmentHost',
 			get: function get() {
 				return 'ldnddf3nsh.execute-api.us-east-1.amazonaws.com/dev';
@@ -998,17 +984,17 @@ module.exports = function () {
 				return this._environment;
 			}
 		}], [{
-			key: 'forLocal',
-			value: function forLocal(requestInterceptor) {
+			key: 'forDevelopment',
+			value: function forDevelopment(requestInterceptor) {
 				return Promise.resolve(requestInterceptor).then(function (requestInterceptor) {
 					assert.argumentIsOptional(requestInterceptor, 'requestInterceptor', RequestInterceptor, 'RequestInterceptor');
 
-					return start(new PortfolioGateway('http', Configuration.localHost, 3000, requestInterceptor));
+					return start(new PortfolioGateway('https', Configuration.developmentHost, 443, 'development', requestInterceptor));
 				});
 			}
 
 			/**
-    * Creates and starts a new {@link PortfolioGateway} for use in the development environment.
+    * Creates and starts a new {@link PortfolioGateway} for use in the staging environment.
     *
     * @public
     * @static
@@ -1017,17 +1003,17 @@ module.exports = function () {
     */
 
 		}, {
-			key: 'forDevelopment',
-			value: function forDevelopment(requestInterceptor) {
+			key: 'forStaging',
+			value: function forStaging(requestInterceptor) {
 				return Promise.resolve(requestInterceptor).then(function (requestInterceptor) {
 					assert.argumentIsOptional(requestInterceptor, 'requestInterceptor', RequestInterceptor, 'RequestInterceptor');
 
-					return start(new PortfolioGateway('https', Configuration.developmentHost, 443, 'development', requestInterceptor));
+					return start(new PortfolioGateway('https', Configuration.stagingHost, 443, 'staging', requestInterceptor));
 				});
 			}
 
 			/**
-    * Creates and starts a new {@link PortfolioGateway} for use in the staging environment.
+    * Creates and starts a new {@link PortfolioGateway} for use in the production environment.
     *
     * @public
     * @static
@@ -1036,17 +1022,17 @@ module.exports = function () {
     */
 
 		}, {
-			key: 'forStaging',
-			value: function forStaging(requestInterceptor) {
+			key: 'forProduction',
+			value: function forProduction(requestInterceptor) {
 				return Promise.resolve(requestInterceptor).then(function (requestInterceptor) {
 					assert.argumentIsOptional(requestInterceptor, 'requestInterceptor', RequestInterceptor, 'RequestInterceptor');
 
-					return start(new PortfolioGateway('https', Configuration.stagingHost, 443, 'staging', requestInterceptor));
+					return start(new PortfolioGateway('https', Configuration.productionHost, 443, 'production', requestInterceptor));
 				});
 			}
 
 			/**
-    * Creates and starts a new {@link PortfolioGateway} for use in the production environment.
+    * Creates and starts a new {@link PortfolioGateway} for use in the administration environment.
     *
     * @public
     * @static
@@ -1055,12 +1041,12 @@ module.exports = function () {
     */
 
 		}, {
-			key: 'forProduction',
-			value: function forProduction(requestInterceptor) {
+			key: 'forAdmin',
+			value: function forAdmin(requestInterceptor) {
 				return Promise.resolve(requestInterceptor).then(function (requestInterceptor) {
 					assert.argumentIsOptional(requestInterceptor, 'requestInterceptor', RequestInterceptor, 'RequestInterceptor');
 
-					return start(new PortfolioGateway('https', Configuration.productionHost, 443, 'production', requestInterceptor));
+					return start(new PortfolioGateway('https', Configuration.adminHost, 443, 'admin', requestInterceptor));
 				});
 			}
 		}]);
@@ -1585,10 +1571,18 @@ module.exports = function () {
 	}
 
 	function _forAdmin(userId, legacyUserId) {
-		return EndpointBuilder.for('read-jwt-token-for-development', 'lookup user identity').withVerb(VerbType.GET).withProtocol(ProtocolType.HTTPS).withHost(Configuration.adminHost).withPathBuilder(function (pb) {
+		return EndpointBuilder.for('read-jwt-token-for-admin', 'lookup user identity').withVerb(VerbType.GET).withProtocol(ProtocolType.HTTPS).withHost(Configuration.adminHost).withPathBuilder(function (pb) {
 			pb.withLiteralParameter('token', 'token').withLiteralParameter('barchart', 'barchart').withLiteralParameter('generator', 'generator');
 		}).withQueryBuilder(function (qb) {
-			qb.withLiteralParameter('user', 'userId', userId).withLiteralParameter('legacy user', 'userLegacyId', legacyUserId).withLiteralParameter('user context', 'userContext', 'TGAM').withLiteralParameter('user permission level', 'userPermissions', 'registered');
+			if (userId) {
+				qb.withLiteralParameter('user', 'userId', userId);
+			}
+
+			if (legacyUserId) {
+				qb.withLiteralParameter('legacy user', 'userLegacyId', legacyUserId);
+			}
+
+			qb.withLiteralParameter('user context', 'userContext', 'TGAM').withLiteralParameter('user permission level', 'userPermissions', 'registered');
 		}).withResponseInterceptor(ResponseInterceptor.DATA).endpoint;
 	}
 
@@ -1607,7 +1601,7 @@ module.exports = function () {
 	return {
 		JwtGateway: JwtGateway,
 		PortfolioGateway: PortfolioGateway,
-		version: '1.2.39'
+		version: '1.2.42'
 	};
 }();
 

package/lib/common/Configuration.js

@@ -11,17 +11,6 @@ module.exports = (() => {
 
 		}
 
-		/**
-		 * The host of the development system.
-		 *
-		 * @public
-		 * @static
-		 * @returns {String}
-		 */
-		static get localHost() {
-			return '127.0.0.1';
-		}
-
 		/**
 		 * The host of the development system.
 		 *

package/lib/gateway/PortfolioGateway.js

@@ -954,63 +954,63 @@ module.exports = (() => {
 		 * @param {RequestInterceptor=|Promise.<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
 		 * @returns {Promise.<PortfolioGateway>}
 		 */
-		static forLocal(requestInterceptor) {
+		static forDevelopment(requestInterceptor) {
 			return Promise.resolve(requestInterceptor)
 				.then((requestInterceptor) => {
 					assert.argumentIsOptional(requestInterceptor, 'requestInterceptor', RequestInterceptor, 'RequestInterceptor');
 
-					return start(new PortfolioGateway('http', Configuration.localHost, 3000, requestInterceptor));
+					return start(new PortfolioGateway('https', Configuration.developmentHost, 443, 'development', requestInterceptor));
 				});
 		}
 
 		/**
-		 * Creates and starts a new {@link PortfolioGateway} for use in the development environment.
+		 * Creates and starts a new {@link PortfolioGateway} for use in the staging environment.
 		 *
 		 * @public
 		 * @static
 		 * @param {RequestInterceptor=|Promise.<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
 		 * @returns {Promise.<PortfolioGateway>}
 		 */
-		static forDevelopment(requestInterceptor) {
+		static forStaging(requestInterceptor) {
 			return Promise.resolve(requestInterceptor)
 				.then((requestInterceptor) => {
 					assert.argumentIsOptional(requestInterceptor, 'requestInterceptor', RequestInterceptor, 'RequestInterceptor');
 
-					return start(new PortfolioGateway('https', Configuration.developmentHost, 443, 'development', requestInterceptor));
+					return start(new PortfolioGateway('https', Configuration.stagingHost, 443, 'staging', requestInterceptor));
 				});
 		}
 
 		/**
-		 * Creates and starts a new {@link PortfolioGateway} for use in the staging environment.
+		 * Creates and starts a new {@link PortfolioGateway} for use in the production environment.
 		 *
 		 * @public
 		 * @static
 		 * @param {RequestInterceptor=|Promise.<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
 		 * @returns {Promise.<PortfolioGateway>}
 		 */
-		static forStaging(requestInterceptor) {
+		static forProduction(requestInterceptor) {
 			return Promise.resolve(requestInterceptor)
 				.then((requestInterceptor) => {
 					assert.argumentIsOptional(requestInterceptor, 'requestInterceptor', RequestInterceptor, 'RequestInterceptor');
 
-					return start(new PortfolioGateway('https', Configuration.stagingHost, 443, 'staging', requestInterceptor));
+					return start(new PortfolioGateway('https', Configuration.productionHost, 443, 'production', requestInterceptor));
 				});
 		}
 
 		/**
-		 * Creates and starts a new {@link PortfolioGateway} for use in the production environment.
+		 * Creates and starts a new {@link PortfolioGateway} for use in the administration environment.
 		 *
 		 * @public
 		 * @static
 		 * @param {RequestInterceptor=|Promise.<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
 		 * @returns {Promise.<PortfolioGateway>}
 		 */
-		static forProduction(requestInterceptor) {
+		static forAdmin(requestInterceptor) {
 			return Promise.resolve(requestInterceptor)
 				.then((requestInterceptor) => {
 					assert.argumentIsOptional(requestInterceptor, 'requestInterceptor', RequestInterceptor, 'RequestInterceptor');
 
-					return start(new PortfolioGateway('https', Configuration.productionHost, 443, 'production', requestInterceptor));
+					return start(new PortfolioGateway('https', Configuration.adminHost, 443, 'admin', requestInterceptor));
 				});
 		}
 

package/lib/gateway/jwt/JwtGateway.js

@@ -335,23 +335,29 @@ module.exports = (() => {
 	}
 
 	function forAdmin(userId, legacyUserId) {
-		return EndpointBuilder.for('read-jwt-token-for-development', 'lookup user identity')
-		.withVerb(VerbType.GET)
-		.withProtocol(ProtocolType.HTTPS)
-		.withHost(Configuration.adminHost)
-		.withPathBuilder((pb) => {
-			pb.withLiteralParameter('token', 'token')
-			.withLiteralParameter('barchart', 'barchart')
-			.withLiteralParameter('generator', 'generator');
-		})
-		.withQueryBuilder((qb) => {
-			qb.withLiteralParameter('user', 'userId', userId)
-			.withLiteralParameter('legacy user', 'userLegacyId', legacyUserId)
-			.withLiteralParameter('user context', 'userContext', 'TGAM')
-			.withLiteralParameter('user permission level', 'userPermissions', 'registered');
-		})
-		.withResponseInterceptor(ResponseInterceptor.DATA)
-		.endpoint;
+		return EndpointBuilder.for('read-jwt-token-for-admin', 'lookup user identity')
+			.withVerb(VerbType.GET)
+			.withProtocol(ProtocolType.HTTPS)
+			.withHost(Configuration.adminHost)
+			.withPathBuilder((pb) => {
+				pb.withLiteralParameter('token', 'token')
+					.withLiteralParameter('barchart', 'barchart')
+					.withLiteralParameter('generator', 'generator');
+			})
+			.withQueryBuilder((qb) => {
+				if (userId) {
+					qb.withLiteralParameter('user', 'userId', userId);
+				}
+
+				if (legacyUserId) {
+					qb.withLiteralParameter('legacy user', 'userLegacyId', legacyUserId);
+				}
+
+				qb.withLiteralParameter('user context', 'userContext', 'TGAM')
+					.withLiteralParameter('user permission level', 'userPermissions', 'registered');
+			})
+			.withResponseInterceptor(ResponseInterceptor.DATA)
+			.endpoint;
 	}
 
 	return JwtGateway;

package/lib/index.js

@@ -7,6 +7,6 @@ module.exports = (() => {
 	return {
 		JwtGateway: JwtGateway,
 		PortfolioGateway: PortfolioGateway,
-		version: '1.2.39'
+		version: '1.2.42'
 	};
 })();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-client-js",
-  "version": "1.2.39",
+  "version": "1.2.42",
   "description": "JavaScript library for interfacing with Barchart's Portfolio API",
   "author": {
     "name": "Bryan Ingle",