@barchart/portfolio-api-common 1.3.22 → 1.3.23

package/.jshintrc

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

package/README.md

@@ -1,5 +1,7 @@
 # @barchart/portfolio-api-common
 
+[![AWS CodeBuild](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiSXBJTDZKWVFmSGVOSG9XQUgwbzB3Um5BZ0JsN2h1U3NQNWNhZTRHMlJKTVpEVVlVMENPaEFmR0NYS29rSStZWmZ5M1d0YVh2eXErVGhiekFtdHBpVmhJPSIsIml2UGFyYW1ldGVyU3BlYyI6ImROM3ZLMURwaXFyekltdDYiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)](https://github.com/barchart/portfolio-api-common)
+
 A *private* library of shared JavaScript code pertaining to the paper-trading portfolio system.
 
 ### Overview

package/buildspec.yml

@@ -0,0 +1,15 @@
+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

@@ -5,7 +5,6 @@ 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'),
@@ -14,7 +13,7 @@ const browserify = require('browserify'),
 	source = require('vinyl-source-stream');
 
 function getVersionFromPackage() {
-    return JSON.parse(fs.readFileSync('./package.json', 'utf8')).version;
+	return JSON.parse(fs.readFileSync('./package.json', 'utf8')).version;
 }
 
 gulp.task('ensure-clean-working-directory', (cb) => {
@@ -33,35 +32,26 @@ gulp.task('bump-version', () => {
 		.pipe(gulp.dest('./'));
 });
 
-gulp.task('document', (cb) => {
-	exec('jsdoc . -c jsdoc.json -r -d docs', (error, stdout, stderr) => {
-		console.log(stdout);
-		console.log(stderr);
-
-		cb();
-	});
-});
-
 gulp.task('commit-changes', () => {
-    return gulp.src([ './', './test/', './package.json' ])
-        .pipe(git.add())
-        .pipe(git.commit('Release. Bump version number'));
+	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);
+	git.push('origin', 'master', cb);
 });
 
 gulp.task('create-tag', (cb) => {
-    const version = getVersionFromPackage();
+	const version = getVersionFromPackage();
 
-    git.tag(version, 'Release ' + version, (error) => {
-        if (error) {
-            return cb(error);
-        }
+	git.tag(version, 'Release ' + version, (error) => {
+		if (error) {
+			return cb(error);
+		}
 
-        git.push('origin', 'master', { args: '--tags' }, cb);
-    });
+		git.push('origin', 'master', { args: '--tags' }, cb);
+	});
 });
 
 gulp.task('build-test-bundle', () => {
@@ -73,13 +63,13 @@ gulp.task('build-test-bundle', () => {
 });
 
 gulp.task('execute-browser-tests', () => {
-    return gulp.src('test/SpecRunner.js')
-        .pipe(jasmine());
+	return gulp.src('test/SpecRunner.js')
+		.pipe(jasmine());
 });
 
 gulp.task('execute-node-tests', () => {
-    return gulp.src(['test/specs/**/*.js'])
-        .pipe(jasmine());
+	return gulp.src(['test/specs/**/*.js'])
+		.pipe(jasmine());
 });
 
 gulp.task('execute-tests', gulp.series(
@@ -91,7 +81,6 @@ gulp.task('execute-tests', gulp.series(
 gulp.task('release', gulp.series(
 	'ensure-clean-working-directory',
 	'execute-tests',
-	'document',
 	'bump-version',
 	'commit-changes',
 	'push-changes',
@@ -99,9 +88,10 @@ gulp.task('release', gulp.series(
 ));
 
 gulp.task('lint', () => {
-    return gulp.src([ './**/*.js', './test/specs/**/*.js', '!./node_modules/**', '!./docs/**', '!./test/SpecRunner.js' ])
-        .pipe(jshint({'esversion': 6}))
-        .pipe(jshint.reporter('default'));
+	return gulp.src([ './**/*.js', './test/specs/**/*.js', '!./node_modules/**', '!./docs/**', '!./test/SpecRunner.js' ])
+		.pipe(jshint({'esversion': 6}))
+		.pipe(jshint.reporter('default'))
+		.pipe(jshint.reporter('fail'));
 });
 
 gulp.task('test', gulp.series('execute-tests'));

package/lib/data/TransactionValidator.js

@@ -70,20 +70,20 @@ module.exports = (() => {
 			return transactions.every((t) => {
 				let valid = true;
 
-				if (is.object(t.reference) && is.string(t.reference.root) && is.number(t.reference.sequence)) {
+				if (is.object(t.reference) && is.string(t.reference.root) && is.string(t.reference.transaction)) {
 					const root = t.reference.root;
-					const sequence = t.reference.sequence;
+					const transaction = t.reference.transaction;
 
 					if (!references.hasOwnProperty(root)) {
 						references[root] = [ ];
 					}
 
-					const sequences = references[root];
+					const transactions = references[root];
 
-					if (sequences.some(s => s === sequence)) {
+					if (transactions.some(t => t === transaction)) {
 						valid = false;
 					} else {
-						sequences.push(sequence);
+						transactions.push(transaction);
 					}
 				}
 

package/lib/serialization/TransactionSchema.js

@@ -138,7 +138,7 @@ module.exports = (() => {
 		.withField('quantity', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.withField('reference.position', DataType.STRING, true)
-		.withField('reference.sequence', DataType.NUMBER, true)
+		.withField('reference.transaction', DataType.STRING, true)
 		.withField('snapshot.open', DataType.DECIMAL)
 		.withField('snapshot.direction', DataType.forEnum(PositionDirection, 'PositionDirection'))
 		.withField('snapshot.buys', DataType.DECIMAL)
@@ -187,7 +187,7 @@ module.exports = (() => {
 		.withField('quantity', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.withField('reference.position', DataType.STRING, true)
-		.withField('reference.sequence', DataType.NUMBER, true)
+		.withField('reference.transaction', DataType.NUMBER, true)
 		.withField('snapshot.open', DataType.DECIMAL)
 		.withField('snapshot.direction', DataType.forEnum(PositionDirection, 'PositionDirection'))
 		.withField('snapshot.buys', DataType.DECIMAL)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.3.22",
-  "description": "Common classes used by the Portfolio system",
+  "version": "1.3.23",
+  "description": "Common code used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",
     "email": "bryan.ingle@barchart.com",
@@ -22,7 +22,6 @@
     "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",
     "jsdoc": "^3.5.5",
     "jshint": "2.9.5",

package/test/SpecRunner.js

@@ -1357,20 +1357,20 @@ module.exports = (() => {
 			return transactions.every((t) => {
 				let valid = true;
 
-				if (is.object(t.reference) && is.string(t.reference.root) && is.number(t.reference.sequence)) {
+				if (is.object(t.reference) && is.string(t.reference.root) && is.string(t.reference.transaction)) {
 					const root = t.reference.root;
-					const sequence = t.reference.sequence;
+					const transaction = t.reference.transaction;
 
 					if (!references.hasOwnProperty(root)) {
 						references[root] = [ ];
 					}
 
-					const sequences = references[root];
+					const transactions = references[root];
 
-					if (sequences.some(s => s === sequence)) {
+					if (transactions.some(t => t === transaction)) {
 						valid = false;
 					} else {
-						sequences.push(sequence);
+						transactions.push(transaction);
 					}
 				}
 
@@ -4988,7 +4988,7 @@ module.exports = (() => {
 		.withField('quantity', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.withField('reference.position', DataType.STRING, true)
-		.withField('reference.sequence', DataType.NUMBER, true)
+		.withField('reference.transaction', DataType.STRING, true)
 		.withField('snapshot.open', DataType.DECIMAL)
 		.withField('snapshot.direction', DataType.forEnum(PositionDirection, 'PositionDirection'))
 		.withField('snapshot.buys', DataType.DECIMAL)
@@ -5037,7 +5037,7 @@ module.exports = (() => {
 		.withField('quantity', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.withField('reference.position', DataType.STRING, true)
-		.withField('reference.sequence', DataType.NUMBER, true)
+		.withField('reference.transaction', DataType.NUMBER, true)
 		.withField('snapshot.open', DataType.DECIMAL)
 		.withField('snapshot.direction', DataType.forEnum(PositionDirection, 'PositionDirection'))
 		.withField('snapshot.buys', DataType.DECIMAL)
@@ -7488,6 +7488,7 @@ module.exports = (() => {
      * item's value. If no matching item can be found, a null value is returned.
      *
      * @public
+     * @static
      * @param {Function} type - The enumeration type.
      * @param {String} code - The enumeration item's code.
      * @returns {*|null}
@@ -7501,6 +7502,7 @@ module.exports = (() => {
      * Returns all of the enumeration's items (given an enumeration type).
      *
      * @public
+     * @static
      * @param {Function} type - The enumeration to list.
      * @returns {Array}
      */
@@ -17842,8 +17844,8 @@ describe('When validating transaction order', () => {
 describe('When validating transaction references', () => {
 	'use strict';
 
-	const build = (root, sequence) => {
-		return { reference: { root: root, sequence: sequence } };
+	const build = (root, transaction) => {
+		return { reference: { root: root, transaction: transaction } };
 	};
 
 	it('An array of zero transactions should be valid', () => {
@@ -17855,11 +17857,11 @@ describe('When validating transaction references', () => {
 	});
 
 	it('An array with distinct references should be valid', () => {
-		expect(TransactionValidator.validateReferences([ build('a', 1), build('a', 2), build('b', 1) ])).toEqual(true);
+		expect(TransactionValidator.validateReferences([ build('a', 'x'), build('a', 'y'), build('b', 'y') ])).toEqual(true);
 	});
 
 	it('An array with non-distinct references should be not valid', () => {
-		expect(TransactionValidator.validateReferences([ build('a', 1), build('a', 2), build('b', 1), build('a', 2) ])).toEqual(false);
+		expect(TransactionValidator.validateReferences([ build('a', 'x'), build('a', 'y'), build('b', 'x'), build('a', 'y') ])).toEqual(false);
 	});
 });
 

package/test/specs/data/TransactionValidatorSpec.js

@@ -58,8 +58,8 @@ describe('When validating transaction order', () => {
 describe('When validating transaction references', () => {
 	'use strict';
 
-	const build = (root, sequence) => {
-		return { reference: { root: root, sequence: sequence } };
+	const build = (root, transaction) => {
+		return { reference: { root: root, transaction: transaction } };
 	};
 
 	it('An array of zero transactions should be valid', () => {
@@ -71,11 +71,11 @@ describe('When validating transaction references', () => {
 	});
 
 	it('An array with distinct references should be valid', () => {
-		expect(TransactionValidator.validateReferences([ build('a', 1), build('a', 2), build('b', 1) ])).toEqual(true);
+		expect(TransactionValidator.validateReferences([ build('a', 'x'), build('a', 'y'), build('b', 'y') ])).toEqual(true);
 	});
 
 	it('An array with non-distinct references should be not valid', () => {
-		expect(TransactionValidator.validateReferences([ build('a', 1), build('a', 2), build('b', 1), build('a', 2) ])).toEqual(false);
+		expect(TransactionValidator.validateReferences([ build('a', 'x'), build('a', 'y'), build('b', 'x'), build('a', 'y') ])).toEqual(false);
 	});
 });