@barchart/portfolio-api-common 1.3.16 → 1.3.20

package/README.md

@@ -1,2 +1,7 @@
 # @barchart/portfolio-api-common
 ## Barchart Portfolio API Common Components
+
+Shared code, used by the serverless application and the client-side SDK. See:
+
+* https://github.com/barchart/aws-lambda-portfolio and
+* https://github.com/barchart/portfolio-client-js

package/gulpfile.js

@@ -1,5 +1,7 @@
 const gulp = require('gulp');
 
+const fs = require('fs');
+
 const browserify = require('browserify'),
 	buffer = require('vinyl-buffer'),
 	bump = require('gulp-bump'),
@@ -9,31 +11,30 @@ const browserify = require('browserify'),
 	glob = require('glob'),
 	jasmine = require('gulp-jasmine'),
 	jshint = require('gulp-jshint'),
-	runSequence = require('run-sequence'),
-	source = require('vinyl-source-stream'),
-	util = require('gulp-util');
-
-const fs = require('fs');
+	replace = require('gulp-replace'),
+	source = require('vinyl-source-stream');
 
 function getVersionFromPackage() {
     return JSON.parse(fs.readFileSync('./package.json', 'utf8')).version;
 }
 
-gulp.task('ensure-clean-working-directory', () => {
-	gitStatus(function(err, status) {
+gulp.task('ensure-clean-working-directory', (cb) => {
+	gitStatus((err, status) => {
 		if (err, !status.clean) {
 			throw new Error('Unable to proceed, your working directory is not clean.');
 		}
+
+		cb();
 	});
 });
 
 gulp.task('bump-version', () => {
-    return gulp.src([ './package.json' ])
-        .pipe(bump({ type: 'patch' }).on('error', util.log))
-        .pipe(gulp.dest('./'));
+	return gulp.src([ './package.json' ])
+	.pipe(bump({ type: 'patch' }))
+	.pipe(gulp.dest('./'));
 });
 
-gulp.task('document', function (cb) {
+gulp.task('document', (cb) => {
 	exec('jsdoc . -c jsdoc.json -r -d docs', (error, stdout, stderr) => {
 		console.log(stdout);
 		console.log(stderr);
@@ -55,7 +56,7 @@ gulp.task('push-changes', (cb) => {
 gulp.task('create-tag', (cb) => {
     const version = getVersionFromPackage();
 
-    git.tag(version, 'Release ' + version, function (error) {
+    git.tag(version, 'Release ' + version, (error) => {
         if (error) {
             return cb(error);
         }
@@ -82,41 +83,21 @@ gulp.task('execute-node-tests', () => {
         .pipe(jasmine());
 });
 
-gulp.task('execute-tests', (cb) => {
-    runSequence(
-        'build-test-bundle',
-        'execute-browser-tests',
-        'execute-node-tests',
-
-        function (error) {
-            if (error) {
-                console.log(error.message);
-            }
-
-            cb(error);
-        });
-});
-
-gulp.task('release', (cb) => {
-    runSequence(
-        'ensure-clean-working-directory',
-        'execute-tests',
-		'document',
-        'bump-version',
-        'commit-changes',
-        'push-changes',
-        'create-tag',
-
-        function (error) {
-            if (error) {
-                console.log(error.message);
-            } else {
-                console.log('Release complete');
-            }
-
-            cb(error);
-        });
-});
+gulp.task('execute-tests', gulp.series(
+	'build-test-bundle',
+	'execute-browser-tests',
+	'execute-node-tests'
+));
+
+gulp.task('release', gulp.series(
+	'ensure-clean-working-directory',
+	'execute-tests',
+	'document',
+	'bump-version',
+	'commit-changes',
+	'push-changes',
+	'create-tag'
+));
 
 gulp.task('lint', () => {
     return gulp.src([ './**/*.js', './test/specs/**/*.js', '!./node_modules/**', '!./docs/**', '!./test/SpecRunner.js' ])
@@ -124,6 +105,6 @@ gulp.task('lint', () => {
         .pipe(jshint.reporter('default'));
 });
 
-gulp.task('test', [ 'execute-tests' ]);
+gulp.task('test', gulp.series('execute-tests'));
 
-gulp.task('default', [ 'lint' ]);
+gulp.task('default', gulp.series('lint'));

package/lib/api/failures/PortfolioFailureType.js

@@ -142,6 +142,17 @@ module.exports = (() => {
 			return transactionCreateFailedInvalidInitialType;
 		}
 
+		/**
+		 * A valuation transaction cannot have a negative rate (or amount).
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_VALUATION_NEGATIVE() {
+			return transactionCreateFailedValuationNegative;
+		}
+
 		/**
 		 * The transaction (of this type) cannot be created by a user, instead,
 		 * it is created and managed by the system (e.g. dividends).
@@ -285,20 +296,21 @@ module.exports = (() => {
 		}
 	}
 
-	const portfolioUpdateFailedNoPortfolio = new FailureType('PORTFOLIO_UPDATE_FAILED_NO_PORTFOLIO', 'Unable to update portfolio. The portfolio does not exist, has it been deleted?');
-	const portfolioDeleteFailedNoPortfolio = new FailureType('PORTFOLIO_DELETE_FAILED_NO_PORTFOLIO', 'Unable to delete portfolio. The portfolio does not exist, has it already been deleted?');
+	const portfolioUpdateFailedNoPortfolio = new FailureType('PORTFOLIO_UPDATE_FAILED_NO_PORTFOLIO', 'Unable to update portfolio. The portfolio does not exist, has it been deleted?', false);
+	const portfolioDeleteFailedNoPortfolio = new FailureType('PORTFOLIO_DELETE_FAILED_NO_PORTFOLIO', 'Unable to delete portfolio. The portfolio does not exist, has it already been deleted?', false);
 
-	const positionCreateFailedNoPortfolio = new FailureType('POSITION_CREATE_FAILED_NO_PORTFOLIO', 'Unable to create transaction. The portfolio does not exist, has it been deleted?');
-	const positionUpdateFailedNoPosition = new FailureType('POSITION_UPDATE_FAILED_NO_POSITION', 'Unable to update preferences for position. The position does not exist, has it been deleted?');
+	const positionCreateFailedNoPortfolio = new FailureType('POSITION_CREATE_FAILED_NO_PORTFOLIO', 'Unable to create transaction. The portfolio does not exist, has it been deleted?', false);
+	const positionUpdateFailedNoPosition = new FailureType('POSITION_UPDATE_FAILED_NO_POSITION', 'Unable to update preferences for position. The position does not exist, has it been deleted?', false);
 	const positionDeleteFailedPositionLocked = new FailureType('POSITION_DELETE_FAILED_POSITION_LOCKED', 'Unable to delete position, your {L|description} history is being recalculated. Please wait a minute or two and retry.');
 
-	const transactionCreateFailedNoPosition = new FailureType('TRANSACTION_CREATE_FAILED_NO_POSITION', 'Unable to create transaction. The referenced position does not exist. Has it been deleted?');
+	const transactionCreateFailedNoPosition = new FailureType('TRANSACTION_CREATE_FAILED_NO_POSITION', 'Unable to create transaction. The referenced position does not exist. Has it been deleted?', false);
 	const transactionCreateFailedOutOfSequence = new FailureType('TRANSACTION_CREATE_FAILED_OUT_OF_SEQUENCE', 'Unable to process transaction, because the transaction date is out-of-sequence. In other words, it would occur before an existing transaction. Please confirm your intent to re-write transaction history (which could take some time and alter the historical results for this position).');
 	const transactionCreateFailedInvalidDate = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_DATE', 'Unable to process transaction with given date.');
 	const transactionCreateFailedTypeInvalidForInstrument = new FailureType('TRANSACTION_CREATE_FAILED_TYPE_INVALID_FOR_INSTRUMENT', 'Unable to process transaction, {L|transactionType.description} transactions cannot be used with {L|instrumentType.description} positions.');
 	const transactionCreateFailedTypeInvalidForDirection = new FailureType('TRANSACTION_CREATE_FAILED_TYPE_INVALID_FOR_DIRECTION', 'Unable to process transaction, a {L|positionDirection.description} position would be created (i.e. you would have {L|positionDirection.sign} shares/units). {u|instrumentType.description} positions cannot have {L|positionDirection.description} positions.', false);
 	const transactionCreateFailedInvalidDirectionSwitch = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_DIRECTION_SWITCH', 'Unable to process transaction, the transaction would switch the position from {L|currentDirection.description} to {L|proposedDirection.description} (i.e. {L|currentDirection.sign} to {L|proposedDirection.sign} shares/units). This is not allowed. Please close the current position (i.e. zero it out) and then enter a second transaction.', false);
-	const transactionCreateFailedInvalidInitialType = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_INITIAL_TYPE', 'Unable to process operation because the first transaction would to be a {U|transactionType.description}, which is not allowed -- since {U|transactionType.description} transactions cannot open a position.');
+	const transactionCreateFailedInvalidInitialType = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_INITIAL_TYPE', 'Unable to process operation because the first transaction would to be a {U|transactionType.description}, which is not allowed -- since {U|transactionType.description} transactions cannot open a position.', false);
+	const transactionCreateFailedValuationNegative = new FailureType('TRANSACTION_CREATE_FAILED_VALUATION_NEGATIVE', 'Unable to process operation, valuations cannot be negative.', false);
 
 	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.');

package/lib/data/PositionSummaryFrame.js

@@ -218,7 +218,6 @@ module.exports = (() => {
 			const last = array.last(transactions);
 
 			const firstDate = first.date;
-			const lastDate = last.date;
 
 			let lastYear;
 
@@ -277,13 +276,12 @@ module.exports = (() => {
 		const ranges = [ ];
 
 		if (transactions.length !== 0) {
-			const first = array.first(transactions);
 			const last = array.last(transactions);
 
 			const currentYear = Day.getToday().year;
 
 			if (!last.snapshot.open.getIsZero() || last.date.year === currentYear) {
-				let end = new Day(Day.getToday().year, 12, 31);
+				let end = new Day(currentYear, 12, 31);
 				let start = end.subtractYears(1);
 
 				ranges.push(getRange(start, end));

package/lib/serialization/PositionSummarySchema.js

@@ -54,6 +54,18 @@ module.exports = (() => {
 			return client;
 		}
 
+		/**
+		 * Reduced schema that only includes frames and dates -- allowing consumer
+		 * to detect existence (or non-existence) of summary.
+		 *
+		 * @static
+		 * @public
+		 * @returns {PositionSummarySchema}
+		 */
+		static get EXISTS() {
+			return exists;
+		}
+
 		toString() {
 			return '[PositionSummarySchema]';
 		}
@@ -111,5 +123,15 @@ module.exports = (() => {
 		.schema
 	);
 
+	const exists = new PositionSummarySchema(SchemaBuilder.withName('complete')
+		.withField('user', DataType.STRING)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
+		.withField('frame', DataType.forEnum(PositionSummaryFrame, 'PositionSummaryFrame'))
+		.withField('start.date', DataType.DAY)
+		.withField('end.date', DataType.DAY)
+		.schema
+	);
+
 	return PositionSummarySchema;
 })();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.3.16",
+  "version": "1.3.20",
   "description": "Common classes used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",
@@ -13,23 +13,22 @@
     "uuid": "3.1.0"
   },
   "devDependencies": {
-    "babel-core": "^6.26.0",
-    "babel-preset-es2015": "^6.24.1",
-    "babelify": "^8.0.0",
-    "browserify": "^14.5.0",
+    "@babel/core": "^7.6.2",
+    "babelify": "^10.0.0",
+    "browserify": "^16.5.0",
     "git-get-status": "^1.0.5",
     "glob": "^6.0.1",
-    "gulp": "~3.9.0",
+    "gulp": "^4.0.2",
     "gulp-bump": "~1.0.0",
-    "gulp-git": "^2.5.1",
+    "gulp-git": "^2.9.0",
     "gulp-jasmine": "^2.2.1",
+    "gulp-jsdoc3": "^1.0.1",
     "gulp-jshint": "~2.1.0",
-    "gulp-util": "^3.0.7",
+    "gulp-replace": "^0.5.4",
     "jsdoc": "^3.5.5",
     "jshint": "2.9.5",
-    "run-sequence": "~1.1.4",
-    "vinyl-buffer": "^1.0.0",
-    "vinyl-source-stream": "^1.1.0"
+    "vinyl-buffer": "^1.0.1",
+    "vinyl-source-stream": "^2.0.0"
   },
   "license": "GPL-3.0"
 }