@barchart/portfolio-api-common 1.4.2 → 1.5.1

package/.jshintrc

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

package/.releases/1.5.0.md

@@ -0,0 +1,3 @@
+**New Features**
+
+* Added new ```Schema``` for results of a query by symbol.

package/.releases/1.5.1.md

@@ -0,0 +1,3 @@
+**Configuration Changes**
+
+* The failure message for corrupt corporate actions (e.g. two instruments with same symbol) was updated to indicate an expected time to correction (of 24 to 48 hours).

package/gulpfile.js

@@ -4,12 +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'),
 	source = require('vinyl-source-stream');
 
 function getVersionFromPackage() {
@@ -26,10 +27,31 @@ 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('commit-changes', () => {
@@ -81,6 +103,7 @@ gulp.task('execute-tests', gulp.series(
 gulp.task('release', gulp.series(
 	'ensure-clean-working-directory',
 	'execute-tests',
+	'bump-choice',
 	'bump-version',
 	'commit-changes',
 	'push-changes',
@@ -89,7 +112,7 @@ gulp.task('release', gulp.series(
 
 gulp.task('lint', () => {
 	return gulp.src([ './**/*.js', './test/specs/**/*.js', '!./node_modules/**', '!./test/SpecRunner.js' ])
-		.pipe(jshint({'esversion': 6}))
+		.pipe(jshint({'esversion': 9}))
 		.pipe(jshint.reporter('default'))
 		.pipe(jshint.reporter('fail'));
 });

package/lib/api/failures/PortfolioFailureType.js

@@ -353,7 +353,7 @@ module.exports = (() => {
 	const transactionCreateFailedTypeReserved = new FailureType('TRANSACTION_CREATE_FAILED_TYPE_RESERVED', 'Unable to create {U|type.description} transaction, this type of transaction is managed by the system.');
 	const transactionCreateFailedReinvestPriceUnavailable = new FailureType('TRANSACTION_CREATE_FAILED_REINVEST_PRICE_UNAVAILABLE', 'Unable to create transaction, a dividend was paid on {L|day}; however no historical price is available for this day. To successfully create this transaction, please turn off dividend reinvestment for this position.');
 	const transactionCreateFailedPositionLocked = new FailureType('TRANSACTION_CREATE_FAILED_POSITION_LOCKED', 'Unable to create transaction, your {L|description} history is being recalculated. Please re-enter this transaction in a minute or two.');
-	const transactionCreateFailedInstrumentCorrupt = new FailureType('TRANSACTION_CREATE_FAILED_INSTRUMENT_CORRUPT', 'Unable to create transaction, corporate action history for {U|symbol} cannot be located.');
+	const transactionCreateFailedInstrumentCorrupt = new FailureType('TRANSACTION_CREATE_FAILED_INSTRUMENT_CORRUPT', 'Unable to create transaction, corporate action history for {U|symbol} cannot be located. The issue should be corrected within 24 to 48 hours.');
 
 	const transactionDeleteFailedOutOfSequence = new FailureType('TRANSACTION_DELETE_FAILED_OUT_OF_SEQUENCE', 'Deleting any transaction, except for the most recent, will cause transaction history to be re-written. Please confirm your intent to re-write transaction history (which could take some time and alter the historical results for this position).');
 	const transactionDeleteFailedNoTransaction = new FailureType('TRANSACTION_DELETE_FAILED_NO_TRANSACTION', 'Unable to delete transaction. The referenced transaction does not exist.', false);

package/lib/processing/PositionItem.js

@@ -40,14 +40,14 @@ module.exports = (() => {
 
 			this._reporting = reporting;
 
-			this._data = { };
-
-			this._data.basis = null;
-
 			this._currentQuote = null;
 			this._previousQuote = null;
 			this._currentPrice = null;
 
+			this._data = { };
+
+			this._data.basis = null;
+
 			this._data.currentPrice = null;
 			this._data.currentPricePrevious = null;
 

package/lib/serialization/PositionSchema.js

@@ -67,6 +67,17 @@ module.exports = (() => {
 			return update;
 		}
 
+		/**
+		 * Result item for query of positions by symbol.
+		 *
+		 * @static
+		 * @public
+		 * @returns {PositionSchema}
+		 */
+		static get SIMPLE() {
+			return simple;
+		}
+
 		toString() {
 			return '[PositionSchema]';
 		}
@@ -102,8 +113,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
 	);
@@ -133,8 +144,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
 	);
@@ -152,5 +163,17 @@ module.exports = (() => {
 		.schema
 	);
 
+	const simple = new PositionSchema(SchemaBuilder.withName('simple')
+		.withField('user', DataType.STRING)
+		.withField('portfolio', DataType.STRING)
+		.withField('instrument.id', DataType.STRING)
+		.withField('instrument.name', DataType.STRING)
+		.withField('instrument.symbol.barchart', DataType.STRING, true)
+		.withField('instrument.symbol.display', DataType.STRING, true)
+		.withField('position', DataType.STRING)
+		.withField('open', DataType.BOOLEAN, true)
+		.schema
+	);
+
 	return PositionSchema;
 })();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.4.2",
+  "version": "1.5.1",
   "description": "Common code used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",
@@ -19,11 +19,11 @@
     "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-jshint": "~2.1.0",
-    "jshint": "2.9.5",
+    "gulp-jshint": "^2.1.0",
+    "gulp-prompt": "^1.2.0",
+    "jshint": "^2.10.3",
     "vinyl-buffer": "^1.0.1",
     "vinyl-source-stream": "^2.0.0"
   },