@barchart/portfolio-api-common 1.9.1 → 1.11.2

package/lib/api/failures/PortfolioFailureType.js

@@ -154,6 +154,17 @@ module.exports = (() => {
 			return transactionCreateFailedInvalidInitialType;
 		}
 
+		/**
+		 * A transaction quantity cannot have a negative amount.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_QUANTITY_NEGATIVE() {
+			return transactionCreateFailedQuantityNegative;
+		}
+
 		/**
 		 * A valuation transaction cannot have a negative rate (or amount).
 		 *
@@ -348,7 +359,7 @@ module.exports = (() => {
 		static get TRANSACTION_EDIT_FAILED_TYPE_CHANGED() {
 			return transactionEditFailedTypeChanged;
 		}
-		
+
 		/**
 		 * Conversion of transaction type is unsupported.
 		 *
@@ -371,7 +382,7 @@ module.exports = (() => {
 		static get TRANSACTION_SWITCH_FAILED_INVALID_REINVEST() {
 			return transactionSwitchFailedInvalidReinvest;
 		}
-		
+
 		toString() {
 			return '[PortfolioFailureType]';
 		}
@@ -392,6 +403,7 @@ module.exports = (() => {
 	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.', false);
+	const transactionCreateFailedQuantityNegative = new FailureType('TRANSACTION_CREATE_FAILED_QUANTITY_NEGATIVE', 'Unable to process transaction, quantity cannot be negative.');
 	const transactionCreateFailedValuationNegative = new FailureType('TRANSACTION_CREATE_FAILED_VALUATION_NEGATIVE', 'Unable to process operation, valuations cannot be negative.', false);
 	const transactionCreateFailedInvalidTermination = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_TERMINATION', 'Unable to process operation, a {U|transactionType.description} must be the final transaction in the position history.', false);
 	const transactionCreateFailedAfterTermination = new FailureType('TRANSACTION_CREATE_FAILED_AFTER_TERMINATION', 'Unable to process operation, one or more transactions would exist after {L|termination}, the final day of trading for this instrument', false);

package/lib/formatters/TransactionFormatter.js

@@ -159,12 +159,34 @@ module.exports = (() => {
 		let shares;
 
 		if (!t.dividend.rate.getIsZero()) {
-			shares = t.dividend.amount.divide(t.dividend.rate);
+			if (t.dividend.native) {
+				shares = t.dividend.native.divide(t.dividend.rate);
+			} else {
+				shares = t.dividend.amount.divide(t.dividend.rate);
+			}
 		} else {
 			shares = '';
 		}
 
+		if (shares) {
+			const rounded = shares.round(0);
+
+			if (rounded.subtract(shares).absolute().getIsLessThan(0.01)) {
+				shares = rounded;
+			} else {
+				shares = shares.round(2);
+			}
+		}
+
 		f.shares = shares;
+
+		if (t.dividend.currency) {
+			f.currency = t.dividend.currency;
+		}
+
+		if (t.dividend.native) {
+			f.native = t.dividend.native;
+		}
 	};
 
 	const distributionCashFormatter = (t, f) => {
@@ -174,12 +196,34 @@ module.exports = (() => {
 		let shares;
 
 		if (!t.dividend.rate.getIsZero()) {
-			shares = t.dividend.amount.divide(t.dividend.rate);
+			if (t.dividend.native) {
+				shares = t.dividend.native.divide(t.dividend.rate);
+			} else {
+				shares = t.dividend.amount.divide(t.dividend.rate);
+			}
 		} else {
 			shares = '';
 		}
 
+		if (shares) {
+			const rounded = shares.round(0);
+
+			if (rounded.subtract(shares).absolute().getIsLessThan(0.01)) {
+				shares = rounded;
+			} else {
+				shares = shares.round(2);
+			}
+		}
+
 		f.shares = shares;
+
+		if (t.dividend.currency) {
+			f.currency = t.dividend.currency;
+		}
+
+		if (t.dividend.native) {
+			f.native = t.dividend.native;
+		}
 	};
 
 	const dividendReinvestFormatter = (t, f) => {
@@ -189,6 +233,10 @@ module.exports = (() => {
 			f.fee = t.fee;
 		}
 
+		if (t.dividend.currency) {
+			f.currency = t.dividend.currency;
+		}
+
 		f.price = t.dividend.price;
 		f.rate = t.dividend.rate;
 
@@ -202,6 +250,10 @@ module.exports = (() => {
 			f.fee = t.fee;
 		}
 
+		if (t.dividend.currency) {
+			f.currency = t.dividend.currency;
+		}
+
 		f.price = t.dividend.price;
 		f.rate = t.dividend.rate;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.9.1",
+  "version": "1.11.2",
   "description": "Common code used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",

package/.jshintrc

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

package/.releases/1.5.0.md

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

package/.releases/1.5.1.md

@@ -1,3 +0,0 @@
-**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/.releases/1.5.2.md

@@ -1,4 +0,0 @@
-**Technical Enhancements**
-
-* Added a `transaction` field into `basicFormatter` function for the `TransactionFormatter` class.
-* Changed the way to add and remove a portfolio in `PositionContainer` to support reactive changes.

package/.releases/1.6.0.md

@@ -1,3 +0,0 @@
-**New Features**
-
-* Added a new `PortfolioFailureType` for attempting to edit a transaction's type.

package/.releases/1.7.0.md

@@ -1,3 +0,0 @@
-**New Features**
-
-* Added a new `PortfolioFailureType` for attempting to reinvest a dividend when the position is short.

package/.releases/1.8.0.md

@@ -1,3 +0,0 @@
-**New Features**
-
-* Added a new `PortfolioFailureType` for attempts to switch to dividend reinvestment when the position is short.

package/.releases/1.9.0.md

@@ -1,4 +0,0 @@
-**New Features**
-
-* Added `close` field to the `Sell` transaction schema.
-* Added `close` field to the `Buy Short` transaction schema.

package/.releases/1.9.1.md

@@ -1,4 +0,0 @@
-**Bug Fixes**
-
-* Made `quantity` field optional for the `Sell` transaction schema.
-* Made `quantity` field optional for the `Buy Short` transaction schema.

package/buildspec.yml

@@ -1,15 +0,0 @@
-version: 0.2
-
-phases:
-  install:
-    runtime-versions:
-      nodejs: 12.x
-
-  pre_build:
-    commands:
-      - npm install
-
-  build:
-    commands:
-      - ./node_modules/.bin/gulp lint
-      - ./node_modules/.bin/gulp test

package/gulpfile.js

@@ -1,122 +0,0 @@
-const gulp = require('gulp');
-
-const fs = require('fs');
-
-const browserify = require('browserify'),
-	buffer = require('vinyl-buffer'),
-	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() {
-	return JSON.parse(fs.readFileSync('./package.json', 'utf8')).version;
-}
-
-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-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', () => {
-	return gulp.src([ './', './test/', './package.json' ])
-		.pipe(git.add())
-		.pipe(git.commit('Release. Bump version number'));
-});
-
-gulp.task('push-changes', (cb) => {
-	git.push('origin', 'master', cb);
-});
-
-gulp.task('create-tag', (cb) => {
-	const version = getVersionFromPackage();
-
-	git.tag(version, 'Release ' + version, (error) => {
-		if (error) {
-			return cb(error);
-		}
-
-		git.push('origin', 'master', { args: '--tags' }, cb);
-	});
-});
-
-gulp.task('build-test-bundle', () => {
-	return browserify({ entries: glob.sync('test/specs/**/*.js') })
-		.bundle()
-		.pipe(source('SpecRunner.js'))
-		.pipe(buffer())
-		.pipe(gulp.dest('test'));
-});
-
-gulp.task('execute-browser-tests', () => {
-	return gulp.src('test/SpecRunner.js')
-		.pipe(jasmine());
-});
-
-gulp.task('execute-node-tests', () => {
-	return gulp.src(['test/specs/**/*.js'])
-		.pipe(jasmine());
-});
-
-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',
-	'bump-choice',
-	'bump-version',
-	'commit-changes',
-	'push-changes',
-	'create-tag'
-));
-
-gulp.task('lint', () => {
-	return gulp.src([ './**/*.js', './test/specs/**/*.js', '!./node_modules/**', '!./test/SpecRunner.js' ])
-		.pipe(jshint({'esversion': 9}))
-		.pipe(jshint.reporter('default'))
-		.pipe(jshint.reporter('fail'));
-});
-
-gulp.task('test', gulp.series('execute-tests'));
-
-gulp.task('default', gulp.series('lint'));