@barchart/portfolio-client-js 1.4.4 → 1.5.0

package/.jshintrc

@@ -1,5 +1,5 @@
 {
-  "esversion": 6,
+  "esversion": 9,
   "validthis": true,
   "-W018": true
-}
+}

package/example/example.js

@@ -1169,6 +1169,9 @@ module.exports = (() => {
       }).withQueryBuilder(qb => {
         qb.withVariableParameter('frames', 'frames', 'frames', true, frames => frames.map(f => f.code).join());
       }).withRequestInterceptor(requestInterceptorToUse).withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE).withResponseInterceptor(responseInterceptorForBrokerageReportAvailabilityDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
+      this._readVersionEndpoint = EndpointBuilder.for('read-api-version', 'read api version').withVerb(VerbType.GET).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(pb => {
+        pb.withLiteralParameter('system', 'system').withLiteralParameter('version', 'version');
+      }).withRequestInterceptor(requestInterceptorToUse).withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE).withResponseInterceptor(responseInterceptorForVersion).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
       this._brokerageReportUrlGenerator = (user, portfolio, frame, end) => {
         return `https://${Configuration.getBrokerageHost(host)}/reports/portfolios/${portfolio}/frames/${frame.code}/date/${end.format()}/${user}`;
@@ -1838,6 +1841,19 @@ module.exports = (() => {
         return Gateway.invoke(this._readBrokerageReportAvailabilityEndpoint, payload);
       });
     }
+    /**
+     * 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).
      *
@@ -2052,6 +2068,13 @@ module.exports = (() => {
       console.error('Error deserializing data', e);
     }
   });
+  const responseInterceptorForVersion = ResponseInterceptor.fromDelegate((response, ignored) => {
+    try {
+      return JSON.parse(response.data).version;
+    } catch (e) {
+      console.error('Error deserializing data', e);
+    }
+  });
 
   function start(gateway) {
     return gateway.start().then(() => {
@@ -2473,7 +2496,7 @@ module.exports = (() => {
   return {
     JwtGateway: JwtGateway,
     PortfolioGateway: PortfolioGateway,
-    version: '1.4.4'
+    version: '1.5.0'
   };
 })();
 
@@ -7043,8 +7066,11 @@ const moment = require('moment-timezone');
 
 module.exports = (() => {
   'use strict';
+
+  const MILLISECONDS_PER_SECOND = 1000;
   /**
-   * A data structure encapsulates (and lazy loads) a moment (see https://momentjs.com/).
+   * An immutable data structure that encapsulates (and lazy loads)
+   * a moment (see https://momentjs.com/).
    *
    * @public
    * @param {Number} timestamp
@@ -7060,7 +7086,7 @@ module.exports = (() => {
       this._moment = null;
     }
     /**
-     * The timestamp.
+     * The timestamp (milliseconds since epoch).
      *
      * @public
      * @returns {Number}
@@ -7089,6 +7115,34 @@ module.exports = (() => {
 
       return this._moment;
     }
+    /**
+     * Returns a new {@link Timestamp} instance shifted forward (or backward)
+     * by a specific number of seconds.
+     *
+     * @public
+     * @param {Number} milliseconds
+     * @returns {Timestamp}
+     */
+
+
+    add(milliseconds) {
+      assert.argumentIsRequired(milliseconds, 'seconds', Number);
+      return new Timestamp(this._timestamp + milliseconds, this._timezone);
+    }
+    /**
+     * Returns a new {@link Timestamp} instance shifted forward (or backward)
+     * by a specific number of seconds.
+     *
+     * @public
+     * @param {Number} seconds
+     * @returns {Timestamp}
+     */
+
+
+    addSeconds(seconds) {
+      assert.argumentIsRequired(seconds, 'seconds', Number);
+      return this.add(seconds * MILLISECONDS_PER_SECOND);
+    }
     /**
      * Returns the JSON representation.
      *
@@ -11473,8 +11527,8 @@ module.exports = (() => {
 		.withField('legacy.portfolio', DataType.STRING, true)
 		.withField('legacy.position', DataType.STRING, true)
 		.withField('system.version', DataType.NUMBER, true)
-		.withField('system.locked', DataType.BOOLEAN, true)
 		.withField('system.calculate.processors', DataType.NUMBER, true)
+		.withField('system.locked', DataType.BOOLEAN, true)
 		.withField('root', DataType.STRING, true)
 		.schema
 	);
@@ -11504,8 +11558,8 @@ module.exports = (() => {
 		.withField('snapshot.basis', DataType.DECIMAL)
 		.withField('snapshot.income', DataType.DECIMAL)
 		.withField('snapshot.value', DataType.DECIMAL)
-		.withField('system.locked', DataType.BOOLEAN, true)
 		.withField('system.calculate.processors', DataType.NUMBER, true)
+		.withField('system.locked', DataType.BOOLEAN, true)
 		.withField('previous', DataType.NUMBER, true)
 		.schema
 	);

package/gulpfile.js

@@ -4,13 +4,13 @@ const fs = require('fs');
 
 const browserify = require('browserify'),
 	buffer = require('vinyl-buffer'),
-	bump = require('gulp-bump'),
 	exec = require('child_process').exec,
 	git = require('gulp-git'),
 	gitStatus = require('git-get-status'),
 	glob = require('glob'),
 	jasmine = require('gulp-jasmine'),
 	jshint = require('gulp-jshint'),
+	prompt = require('gulp-prompt'),
 	replace = require('gulp-replace'),
 	source = require('vinyl-source-stream');
 
@@ -28,10 +28,32 @@ gulp.task('ensure-clean-working-directory', (cb) => {
 	});
 });
 
-gulp.task('bump-version', () => {
-	return gulp.src([ './package.json' ])
-		.pipe(bump({ type: 'patch' }))
-		.pipe(gulp.dest('./'));
+
+gulp.task('bump-choice', (cb) => {
+	const processor = prompt.prompt({
+		type: 'list',
+		name: 'bump',
+		message: 'What type of bump would you like to do?',
+		choices: ['patch', 'minor', 'major'],
+	}, (res) => {
+		global.bump = res.bump;
+
+		return cb();
+	});
+
+	return gulp.src(['./package.json']).pipe(processor);
+});
+
+gulp.task('bump-version', (cb) => {
+	exec(`npm version ${global.bump || 'patch'} --no-git-tag-version`, {
+		cwd: './'
+	}, (error) => {
+		if (error) {
+			cb(error);
+		}
+
+		cb();
+	});
 });
 
 gulp.task('embed-version', () => {
@@ -99,6 +121,7 @@ gulp.task('execute-tests', gulp.series(
 gulp.task('release', gulp.series(
 	'ensure-clean-working-directory',
 	'execute-tests',
+	'bump-choice',
 	'bump-version',
 	'embed-version',
 	'build-example-bundle',
@@ -109,7 +132,7 @@ gulp.task('release', gulp.series(
 
 gulp.task('lint', () => {
 	return gulp.src([ './**/*.js', './test/specs/**/*.js', '!./node_modules/**', '!./docs/**', '!./test/SpecRunner.js', '!./example/example.js' ])
-		.pipe(jshint({'esversion': 6}))
+		.pipe(jshint({ esversion: 9 }))
 		.pipe(jshint.reporter('default'))
 		.pipe(jshint.reporter('fail'));
 });

package/lib/gateway/PortfolioGateway.js

@@ -385,6 +385,21 @@ module.exports = (() => {
 				.withErrorInterceptor(ErrorInterceptor.GENERAL)
 				.endpoint;
 
+			this._readVersionEndpoint = EndpointBuilder.for('read-api-version', 'read api version')
+				.withVerb(VerbType.GET)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('system', 'system')
+						.withLiteralParameter('version', 'version');
+				})
+				.withRequestInterceptor(requestInterceptorToUse)
+				.withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE)
+				.withResponseInterceptor(responseInterceptorForVersion)
+				.withErrorInterceptor(ErrorInterceptor.GENERAL)
+				.endpoint;
+
 			this._brokerageReportUrlGenerator = (user, portfolio, frame, end) => {
 				return `https://${Configuration.getBrokerageHost(host)}/reports/portfolios/${portfolio}/frames/${frame.code}/date/${end.format()}/${user}`;
 			};
@@ -1088,6 +1103,19 @@ 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).
 		 *
@@ -1323,6 +1351,14 @@ module.exports = (() => {
 		}
 	});
 
+	const responseInterceptorForVersion = ResponseInterceptor.fromDelegate((response, ignored) => {
+		try {
+			return JSON.parse(response.data).version;
+		} catch (e) {
+			console.error('Error deserializing data', e);
+		}
+	});
+
 	function start(gateway) {
 		return gateway.start()
 			.then(() => {

package/lib/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-client-js",
-  "version": "1.4.4",
+  "version": "1.5.0",
   "description": "JavaScript library for interfacing with Barchart's Portfolio API",
   "author": {
     "name": "Bryan Ingle",
@@ -22,7 +22,7 @@
   ],
   "dependencies": {
     "@barchart/common-js": "^3.5.1",
-    "@barchart/portfolio-api-common": "^1.4.1"
+    "@barchart/portfolio-api-common": "^1.4.4"
   },
   "devDependencies": {
     "@babel/core": "^7.6.2",
@@ -31,13 +31,13 @@
     "git-get-status": "^1.0.5",
     "glob": "^6.0.1",
     "gulp": "^4.0.2",
-    "gulp-bump": "~1.0.0",
     "gulp-git": "^2.9.0",
     "gulp-jasmine": "^2.2.1",
     "gulp-jsdoc3": "^1.0.1",
     "gulp-jshint": "~2.1.0",
     "gulp-replace": "^0.5.4",
-    "jshint": "2.9.5",
+    "gulp-prompt": "^1.2.0",
+    "jshint": "^2.10.3",
     "vinyl-buffer": "^1.0.1",
     "vinyl-source-stream": "^2.0.0"
   },