@barchart/portfolio-client-js 1.4.7 → 2.0.0

package/.releases/2.0.0.md

@@ -0,0 +1,10 @@
+**Breaking Changes**
+
+
+* The mechanism for passing JSON Web Tokens to the ```PortfolioGateway``` has changed. Consumers are now required to provide ```JwtProvider``` instances instead of a ```RequestInterceptor``` instances. Here are the specifics:
+  * The ```RequestInterceptor``` argument was replaced with a ```JwtProvider``` argument on static factory functions (e.g. ```PortfolioGateway.forProduction```).
+  * The ```RequestInterceptor``` argument was removed from the ```PortfolioGateway``` constructor.
+  * The ```PortfolioGateway.start``` function was renamed to ```PortfolioGateway.connect``` and now has a ```JwtProvider``` argument.
+  * The ```JwtGateway``` and ```JwtEndpoint``` classes were removed.
+  * Static factory functions for impersonating users in the ```test``` and ```development``` environments were added. See ```JwtProvider.forTest``` and ```JwtProvider.forDevelopment```.
+* Removed ```PortfolioGateway.batchTransactions``` function.

package/gulpfile.js

@@ -65,7 +65,7 @@ gulp.task('embed-version', () => {
 });
 
 gulp.task('commit-changes', () => {
-	return gulp.src([ './', './test/', './package.json', './lib/index.js', './example/example.js', './test/SpecRunner.js' ])
+	return gulp.src([ './', './test/', './package.json', './lib/index.js', './test/SpecRunner.js' ])
 		.pipe(git.add())
 		.pipe(git.commit('Release. Bump version number'));
 });
@@ -86,14 +86,6 @@ gulp.task('create-tag', (cb) => {
 	});
 });
 
-gulp.task('build-example-bundle', () => {
-	return browserify([ './lib/index.js', './example/js/startup.js', ])
-		.bundle()
-		.pipe(source('example.js'))
-		.pipe(buffer())
-		.pipe(gulp.dest('./example'));
-});
-
 gulp.task('build-test-bundle', () => {
 	return browserify({ entries: glob.sync('test/specs/**/*.js') })
 		.bundle()
@@ -124,14 +116,13 @@ gulp.task('release', gulp.series(
 	'bump-choice',
 	'bump-version',
 	'embed-version',
-	'build-example-bundle',
 	'commit-changes',
 	'push-changes',
 	'create-tag'
 ));
 
 gulp.task('lint', () => {
-	return gulp.src([ './**/*.js', './test/specs/**/*.js', '!./node_modules/**', '!./docs/**', '!./test/SpecRunner.js', '!./example/example.js' ])
+	return gulp.src([ './**/*.js', './test/specs/**/*.js', '!./node_modules/**', '!./docs/**', '!./test/SpecRunner.js' ])
 		.pipe(jshint({ esversion: 9 }))
 		.pipe(jshint.reporter('default'))
 		.pipe(jshint.reporter('fail'));

package/lib/common/Configuration.js

@@ -11,24 +11,8 @@ module.exports = (() => {
 
 		}
 
-		static getBrokerageHost(host) {
-			if (host === Configuration.developmentHost) {
-				return '7enbtpamgg.execute-api.us-east-1.amazonaws.com/dev';
-			} else if (host === Configuration.stagingHost) {
-				return 'i98b1sdxp6.execute-api.us-east-1.amazonaws.com/stage';
-			} else if (host === Configuration.productionHost) {
-				return 'xos40seq3e.execute-api.us-east-1.amazonaws.com/prod';
-			} else if (host === Configuration.adminHost) {
-				return 'q1x45oxon1.execute-api.us-east-1.amazonaws.com/admin';
-			} else if (host === Configuration.demoHost) {
-				return 'b9132ukaob.execute-api.us-east-1.amazonaws.com/demo';
-			} else {
-				return '';
-			}
-		}
-
 		/**
-		 * The host of the development system.
+		 * The hostname of the REST API for the development environment (intended for Barchart use only).
 		 *
 		 * @public
 		 * @static
@@ -39,7 +23,18 @@ module.exports = (() => {
 		}
 
 		/**
-		 * The host of the staging system.
+		 * The hostname of the REST API for the test environment (public use allowed).
+		 *
+		 * @public
+		 * @static
+		 * @returns {String}
+		 */
+		static get testHost() {
+			return 'portfolio-test.aws.barchart.com';
+		}
+
+		/**
+		 * The hostname of the REST API for the staging environment (public use allowed).
 		 *
 		 * @public
 		 * @static
@@ -50,18 +45,18 @@ module.exports = (() => {
 		}
 
 		/**
-		 * The host of the public demo system.
+		 * The hostname of the REST API for the demo environment (intended for Barchart use only).
 		 *
 		 * @public
 		 * @static
-		 * @return {String}
+		 * @returns {String}
 		 */
 		static get demoHost() {
 			return 'portfolio-demo.aws.barchart.com';
 		}
 
 		/**
-		 * The host of the production system.
+		 * The hostname of the REST API for the production environment (public use allowed).
 		 *
 		 * @public
 		 * @static
@@ -72,16 +67,44 @@ module.exports = (() => {
 		}
 
 		/**
-		 * The host of the internal admin system.
+		 * The hostname of the REST API for the admin environment (intended for Barchart use only).
 		 *
 		 * @public
 		 * @static
-		 * @return {String}
+		 * @returns {String}
 		 */
 		static get adminHost() {
 			return 'portfolio-admin.aws.barchart.com';
 		}
 
+		/**
+		 * The hostname of REST API which generates impersonation tokens for non-secure
+		 * test and demo environments.
+		 *
+		 * @public
+		 * @static
+		 * @returns {string}
+		 */
+		static get getJwtImpersonationHost() {
+			return 'jwt-public-prod.aws.barchart.com';
+		}
+
+		static getBrokerageHost(host) {
+			if (host === Configuration.developmentHost) {
+				return '7enbtpamgg.execute-api.us-east-1.amazonaws.com/dev';
+			} else if (host === Configuration.stagingHost) {
+				return 'i98b1sdxp6.execute-api.us-east-1.amazonaws.com/stage';
+			} else if (host === Configuration.productionHost) {
+				return 'xos40seq3e.execute-api.us-east-1.amazonaws.com/prod';
+			} else if (host === Configuration.adminHost) {
+				return 'q1x45oxon1.execute-api.us-east-1.amazonaws.com/admin';
+			} else if (host === Configuration.demoHost) {
+				return 'b9132ukaob.execute-api.us-east-1.amazonaws.com/demo';
+			} else {
+				return '';
+			}
+		}
+
 		toString() {
 			return '[Configuration]';
 		}