@barchart/portfolio-client-js 1.2.38 → 1.2.41

package/example/example.js

@@ -62,13 +62,13 @@ module.exports = function () {
 				return '[Configuration]';
 			}
 		}], [{
-			key: 'localHost',
+			key: 'developmentHost',
 			get: function get() {
-				return '127.0.0.1';
+				return 'ldnddf3nsh.execute-api.us-east-1.amazonaws.com/dev';
 			}
 
 			/**
-    * The host of the development system.
+    * The host of the staging system.
     *
     * @public
     * @static
@@ -76,13 +76,13 @@ module.exports = function () {
     */
 
 		}, {
-			key: 'developmentHost',
+			key: 'stagingHost',
 			get: function get() {
-				return 'ldnddf3nsh.execute-api.us-east-1.amazonaws.com/dev';
+				return '24ok2r76k6.execute-api.us-east-1.amazonaws.com/stage';
 			}
 
 			/**
-    * The host of the staging system.
+    * The host of the production system.
     *
     * @public
     * @static
@@ -90,23 +90,23 @@ module.exports = function () {
     */
 
 		}, {
-			key: 'stagingHost',
+			key: 'productionHost',
 			get: function get() {
-				return '24ok2r76k6.execute-api.us-east-1.amazonaws.com/stage';
+				return 'o77obtxxr4.execute-api.us-east-1.amazonaws.com/prod';
 			}
 
 			/**
-    * The host of the production system.
+    * The host of the internal admin system.
     *
     * @public
     * @static
-    * @returns {String}
+    * @return {String}
     */
 
 		}, {
-			key: 'productionHost',
+			key: 'adminHost',
 			get: function get() {
-				return 'o77obtxxr4.execute-api.us-east-1.amazonaws.com/prod';
+				return '38moiq7ek9.execute-api.us-east-1.amazonaws.com/admin';
 			}
 		}]);
 
@@ -984,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
@@ -1003,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
@@ -1022,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
@@ -1041,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, requestInterceptor));
 				});
 			}
 		}]);
@@ -1216,8 +1216,6 @@ function _inherits(subClass, superClass) { if (typeof superClass !== "function"
 
 var assert = require('@barchart/common-js/lang/assert'),
     Disposable = require('@barchart/common-js/lang/Disposable'),
-    Enum = require('@barchart/common-js/lang/Enum'),
-    is = require('@barchart/common-js/lang/is'),
     Scheduler = require('@barchart/common-js/timing/Scheduler');
 
 var EndpointBuilder = require('@barchart/common-js/api/http/builders/EndpointBuilder'),
@@ -1411,7 +1409,7 @@ module.exports = function () {
 		}], [{
 			key: 'forDevelopment',
 			value: function forDevelopment(userId, userLegacyId) {
-				return start(new JwtGateway(_forDevelopment(userId, userLegacyId), 60000));
+				return start(new JwtGateway(_forDevelopment(userId, userLegacyId), 180000));
 			}
 
 			/**
@@ -1498,6 +1496,39 @@ module.exports = function () {
 					return jwtGateway.toRequestInterceptor();
 				});
 			}
+
+			/**
+    * Creates and starts a new {@link JwtGateway} for use in the internal admin environment.
+    *
+    * @public
+    * @static
+    * @param {String} userId - The identifier of the user to impersonate.
+    * @param {String} userLegacyId - The legacy identifier of the user to impersonate.
+    * @returns {Promise.<JwtGateway>}
+    */
+
+		}, {
+			key: 'forAdmin',
+			value: function forAdmin(userId, userLegacyId) {
+				return start(new JwtGateway(_forAdmin(userId, userLegacyId), 180000));
+			}
+
+			/**
+    * Creates and starts a new {@link RequestInterceptor} for use in the internal admin environment.
+    *
+    * @public
+    * @static
+    * @param {String} userId - The identifier of the user to impersonate.
+    * @returns {Promise.<RequestInterceptor>}
+    */
+
+		}, {
+			key: 'forAdminClient',
+			value: function forAdminClient(userId, userLegacyId) {
+				return JwtGateway.forAdmin(userId, userLegacyId).then(function (jwtGateway) {
+					return jwtGateway.toRequestInterceptor();
+				});
+			}
 		}]);
 
 		return JwtGateway;
@@ -1539,10 +1570,18 @@ module.exports = function () {
 		}).withRequestInterceptor(externalRequestInterceptor).withResponseInterceptor(ResponseInterceptor.DATA).endpoint;
 	}
 
+	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) {
+			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');
+		}).withResponseInterceptor(ResponseInterceptor.DATA).endpoint;
+	}
+
 	return JwtGateway;
 }();
 
-},{"./../../common/Configuration":2,"@barchart/common-js/api/failures/FailureReason":6,"@barchart/common-js/api/failures/FailureType":8,"@barchart/common-js/api/http/Gateway":9,"@barchart/common-js/api/http/builders/EndpointBuilder":10,"@barchart/common-js/api/http/definitions/Endpoint":12,"@barchart/common-js/api/http/definitions/ProtocolType":15,"@barchart/common-js/api/http/definitions/VerbType":16,"@barchart/common-js/api/http/interceptors/RequestInterceptor":21,"@barchart/common-js/api/http/interceptors/ResponseInterceptor":22,"@barchart/common-js/lang/Disposable":31,"@barchart/common-js/lang/Enum":32,"@barchart/common-js/lang/assert":37,"@barchart/common-js/lang/is":40,"@barchart/common-js/timing/Scheduler":50}],5:[function(require,module,exports){
+},{"./../../common/Configuration":2,"@barchart/common-js/api/failures/FailureReason":6,"@barchart/common-js/api/failures/FailureType":8,"@barchart/common-js/api/http/Gateway":9,"@barchart/common-js/api/http/builders/EndpointBuilder":10,"@barchart/common-js/api/http/definitions/Endpoint":12,"@barchart/common-js/api/http/definitions/ProtocolType":15,"@barchart/common-js/api/http/definitions/VerbType":16,"@barchart/common-js/api/http/interceptors/RequestInterceptor":21,"@barchart/common-js/api/http/interceptors/ResponseInterceptor":22,"@barchart/common-js/lang/Disposable":31,"@barchart/common-js/lang/assert":37,"@barchart/common-js/timing/Scheduler":50}],5:[function(require,module,exports){
 'use strict';
 
 var JwtGateway = require('./gateway/jwt/JwtGateway'),
@@ -1554,7 +1593,7 @@ module.exports = function () {
 	return {
 		JwtGateway: JwtGateway,
 		PortfolioGateway: PortfolioGateway,
-		version: '1.2.38'
+		version: '1.2.41'
 	};
 }();
 

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.
 		 *
@@ -55,6 +44,17 @@ module.exports = (() => {
 			return 'o77obtxxr4.execute-api.us-east-1.amazonaws.com/prod';
 		}
 
+		/**
+		 * The host of the internal admin system.
+		 *
+		 * @public
+		 * @static
+		 * @return {String}
+		 */
+		static get adminHost() {
+			return '38moiq7ek9.execute-api.us-east-1.amazonaws.com/admin';
+		}
+
 		toString() {
 			return '[Configuration]';
 		}

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, requestInterceptor));
 				});
 		}
 

package/lib/gateway/jwt/JwtGateway.js

@@ -1,7 +1,5 @@
 const assert = require('@barchart/common-js/lang/assert'),
 	Disposable = require('@barchart/common-js/lang/Disposable'),
-	Enum = require('@barchart/common-js/lang/Enum'),
-	is = require('@barchart/common-js/lang/is'),
 	Scheduler = require('@barchart/common-js/timing/Scheduler');
 
 const EndpointBuilder = require('@barchart/common-js/api/http/builders/EndpointBuilder'),
@@ -164,7 +162,7 @@ module.exports = (() => {
 		 * @returns {Promise.<JwtGateway>}
 		 */
 		static forDevelopment(userId, userLegacyId) {
-			return start(new JwtGateway(forDevelopment(userId, userLegacyId), 60000));
+			return start(new JwtGateway(forDevelopment(userId, userLegacyId), 180000));
 		}
 
 		/**
@@ -240,6 +238,34 @@ module.exports = (() => {
 				});
 		}
 
+		/**
+		 * Creates and starts a new {@link JwtGateway} for use in the internal admin environment.
+		 *
+		 * @public
+		 * @static
+		 * @param {String} userId - The identifier of the user to impersonate.
+		 * @param {String} userLegacyId - The legacy identifier of the user to impersonate.
+		 * @returns {Promise.<JwtGateway>}
+		 */
+		static forAdmin(userId, userLegacyId) {
+			return start(new JwtGateway(forAdmin(userId, userLegacyId), 180000));
+		}
+
+		/**
+		 * Creates and starts a new {@link RequestInterceptor} for use in the internal admin environment.
+		 *
+		 * @public
+		 * @static
+		 * @param {String} userId - The identifier of the user to impersonate.
+		 * @returns {Promise.<RequestInterceptor>}
+		 */
+		static forAdminClient(userId, userLegacyId) {
+			return JwtGateway.forAdmin(userId, userLegacyId)
+				.then((jwtGateway) => {
+					return jwtGateway.toRequestInterceptor();
+				});
+		}
+
 		_onDispose() {
 			return;
 		}
@@ -308,5 +334,25 @@ module.exports = (() => {
 			.endpoint;
 	}
 
+	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 JwtGateway;
 })();

package/lib/index.js

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

package/package.json

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