@barchart/portfolio-api-common 1.3.23 → 1.4.2

package/README.md

@@ -8,25 +8,26 @@ A *private* library of shared JavaScript code pertaining to the paper-trading po
 
 Simply put, this project contains code that runs on both the servers (i.e. Serverless applications) and clients (e.g. browser, mobile, etc).
 
-#### [lib/serialization](https://github.com/barchart/portfolio-api-common/tree/master/lib/serialization)
+#### [/lib/serialization](https://github.com/barchart/portfolio-api-common/tree/master/lib/serialization)
 
-Data is passed between client and server in JSON format. However, the code works with more complex types. For example, [Decimal](https://github.com/barchart/barchart-common-js/blob/master/lang/Decimal.js) instances are used in place of [native JavaScript floats](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number). [Day](https://github.com/barchart/barchart-common-js/blob/master/lang/Day.js) instances are used instead of [native JavaScript Dates](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date).
+Data is passed between client and server in JSON format. However, the code works with more complex types. For example, [```Decimal```](https://github.com/barchart/barchart-common-js/blob/master/lang/Decimal.js) instances are used in place of [native JavaScript floats](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) and [```Day```](https://github.com/barchart/barchart-common-js/blob/master/lang/Day.js) instances are used instead of [native JavaScript Dates](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date).
 
-So, before data is exchanged, it must be converted to pure JSON. Conversely, when data is received, as pure JSON, its translated into more complex types before use. This is facilitated by the [Schema](https://github.com/barchart/barchart-common-js/blob/master/serialization/json/Schema.js) definitions which build custom "reviver" functions for [JSON parsing](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse).
+So, before data is exchanged, it must be converted to pure JSON. Conversely, when data is received, as pure JSON, its translated into more complex types before use. This is facilitated by the [```Schema```](https://github.com/barchart/barchart-common-js/blob/master/serialization/json/Schema.js) definitions which build custom "reviver" functions for [JSON parsing](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse).
 
-#### [lib/processing](https://github.com/barchart/portfolio-api-common/tree/master/lib/processing)
+#### [/lib/processing](https://github.com/barchart/portfolio-api-common/tree/master/lib/processing)
 
 For reporting and display purposes, positions can be grouped together (by asset class, by portfolio, by user, etc). This code supports aggregation and gain/loss calculation. It is used by server-generated reports and dynamic user interfaces.
 
 ### Notable Consumers
 
-* [aws-lambda-portfolio](https://github.com/barchart/aws-lambda-portfolio) - Serverless applications (i.e. the servers)
-* [portfolio-client-js](https://github.com/barchart/portfolio-client-js) - JavaScript client SDK for communicating with server API's.
-* [tgam-portfolio-ui-js](https://github.com/barchart/tgam-portfolio-ui-js) - A dynamic, single-page HTML UI.
+* [@barchart/aws-lambda-portfolio](https://github.com/barchart/aws-lambda-portfolio) - Serverless applications (i.e. the backend)
+* [@barchart/portfolio-client-js](https://github.com/barchart/portfolio-client-js) - JavaScript SDK for communicating with the backend
 
 ### Package Managers
 
 This library has been published as a *private* module to NPM as [@barchart/portfolio-api-common](https://www.npmjs.com/package/@barchart/portfolio-api-common).
 
-    > npm login
-    > npm install @barchart/portfolio-api-common -S
+```shell
+npm login
+npm install @barchart/portfolio-api-common -S
+```

package/gulpfile.js

@@ -88,7 +88,7 @@ gulp.task('release', gulp.series(
 ));
 
 gulp.task('lint', () => {
-	return gulp.src([ './**/*.js', './test/specs/**/*.js', '!./node_modules/**', '!./docs/**', '!./test/SpecRunner.js' ])
+	return gulp.src([ './**/*.js', './test/specs/**/*.js', '!./node_modules/**', '!./test/SpecRunner.js' ])
 		.pipe(jshint({'esversion': 6}))
 		.pipe(jshint.reporter('default'))
 		.pipe(jshint.reporter('fail'));

package/lib/api/failures/PortfolioFailureType.js

@@ -356,13 +356,13 @@ module.exports = (() => {
 	const transactionCreateFailedInstrumentCorrupt = new FailureType('TRANSACTION_CREATE_FAILED_INSTRUMENT_CORRUPT', 'Unable to create transaction, corporate action history for {U|symbol} cannot be located.');
 
 	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.');
+	const transactionDeleteFailedNoTransaction = new FailureType('TRANSACTION_DELETE_FAILED_NO_TRANSACTION', 'Unable to delete transaction. The referenced transaction does not exist.', false);
 	const transactionDeleteFailedDirectionSwitchOnRewrite = new FailureType('TRANSACTION_DELETE_FAILED_DIRECTION_SWITCH_ON_REWRITE', 'Deleting this transaction would cause your history to be re-written and the position to switch from long to short (i.e. positive to negative) or vice versa.', false);
 	const transactionDeleteFailedPositionLocked = new FailureType('TRANSACTION_DELETE_FAILED_POSITION_LOCKED', 'Unable to delete transaction, your {L|description} history is being recalculated. Please wait a minute or two and retry.');
 	const transactionDeleteFailedTypeReserved = new FailureType('TRANSACTION_DELETE_FAILED_TYPE_RESERVED', 'Unable to delete {U|type.description} transaction, this type of transaction is managed by the system.');
 
 	const transactionEditFailedInvalidDate = new FailureType('TRANSACTION_EDIT_FAILED_INVALID_DATE', 'Unable to edit transaction with given date.');
-	const transactionEditFailedNoTransaction = new FailureType('TRANSACTION_EDIT_FAILED_NO_TRANSACTION', 'Unable to edit transaction. The referenced transaction does not exist.');
+	const transactionEditFailedNoTransaction = new FailureType('TRANSACTION_EDIT_FAILED_NO_TRANSACTION', 'Unable to edit transaction. The referenced transaction does not exist.', false);
 	const transactionEditFailedTypeReserved = new FailureType('TRANSACTION_EDIT_FAILED_TYPE_RESERVED', 'Unable to edit {U|type.description} transaction, this type of transaction is managed by the system.');
 
 	return PortfolioFailureType;

package/lib/data/CorporateActionType.js

@@ -104,6 +104,10 @@ module.exports = (() => {
 		static get SPINOFF() {
 			return spinoff;
 		}
+
+		toString() {
+			return `[CorporateActionType (code=${this.code})]`;
+		}
 	}
 
 	const split = new CorporateActionType('SPLIT', 'Split', false);

package/lib/data/InstrumentType.js

@@ -252,7 +252,7 @@ module.exports = (() => {
 		}
 
 		toString() {
-			return '[InstrumentType]';
+			return `[InstrumentType (code=${this.code})]`;
 		}
 	}
 

package/lib/data/PositionDirection.js

@@ -118,6 +118,10 @@ module.exports = (() => {
 				return even;
 			}
 		}
+
+		toString() {
+			return `[PositionDirection (code=${this.code})]`;
+		}
 	}
 
 	const long = new PositionDirection('LONG', 'Long', 'positive');

package/lib/data/PositionSummaryFrame.js

@@ -175,7 +175,7 @@ module.exports = (() => {
 		}
 
 		toString() {
-			return '[PositionSummaryFrame]';
+			return `[PositionSummaryFrame (code=${this.code})]`;
 		}
 	}
 

package/lib/data/TransactionType.js

@@ -494,7 +494,7 @@ module.exports = (() => {
 		}
 
 		toString() {
-			return '[TransactionType]';
+			return `[TransactionType (code=${this.code})]`;
 		}
 	}
 

package/lib/data/ValuationType.js

@@ -48,7 +48,7 @@ module.exports = (() => {
 		}
 
 		toString() {
-			return '[ValuationType]';
+			return `[ValuationType (code=${this.code})]`;
 		}
 	}
 

package/lib/processing/PositionContainer.js

@@ -161,7 +161,7 @@ module.exports = (() => {
 				const tree = new Tree();
 
 				createGroups.call(this, tree, this._items, treeDefinition, treeDefinition.definitions);
-				
+
 				map[treeDefinition.name] = tree;
 
 				return map;
@@ -493,6 +493,41 @@ module.exports = (() => {
 			return is.object(item) && item.data.locked;
 		}
 
+		/**
+		 * Causes a position to be flagged as calculating.
+		 *
+		 * @public
+		 * @param {Object} position
+		 */
+		setPositionCalculating(position) {
+			if (position) {
+				assert.argumentIsRequired(position, 'position', Object);
+				assert.argumentIsRequired(position.position, 'position.position', String);
+
+				const item = this._items.find(i => i.position.position === position.position);
+
+				if (item) {
+					item.setPositionCalculating(position);
+				}
+			}
+		}
+
+		/**
+		 * Returns a position's calculating status.
+		 *
+		 * @public
+		 * @param {Object} position
+		 * @return {Boolean}
+		 */
+		getPositionCalculating(position) {
+			assert.argumentIsRequired(position, 'position', Object);
+			assert.argumentIsRequired(position.position, 'position.position', String);
+
+			const item = this._items.find(i => i.position.position === position.position);
+
+			return is.object(item) && item.data.calculating;
+		}
+
 		/**
 		 * Performs a batch update of both position quotes and forex quotes,
 		 * triggering updates to position(s) and data aggregation(s).
@@ -545,6 +580,26 @@ module.exports = (() => {
 			}
 		}
 
+		/**
+		 * Returns current price for symbol provided.
+		 *
+		 * @param {String} symbol
+		 * @return {null|Number}
+		 */
+		getCurrentPrice(symbol) {
+			assert.argumentIsRequired(symbol, 'symbol', String);
+
+			let price;
+
+			if (this._symbols.hasOwnProperty(symbol) && this._symbols[symbol].length > 0) {
+				price = this._symbols[symbol][0].currentPrice;
+			} else {
+				price = null;
+			}
+
+			return price;
+		}
+
 		/**
 		 * Sets a historical forex quote.
 		 *

package/lib/processing/PositionGroup.js

@@ -73,6 +73,7 @@ module.exports = (() => {
 			this._dataFormat.hide = false;
 			this._dataFormat.invalid = false;
 			this._dataFormat.locked = false;
+			this._dataFormat.calculating = false;
 			this._dataFormat.newsExists = false;
 			this._dataFormat.quantity = null;
 			this._dataFormat.quantityPrevious = null;
@@ -580,6 +581,7 @@ module.exports = (() => {
 
 		let newsBinding = Disposable.getEmpty();
 		let lockedBinding = Disposable.getEmpty();
+		let calculatingBinding = Disposable.getEmpty();
 
 		if (this._single) {
 			newsBinding = item.registerNewsExistsChangeHandler((exists) => {
@@ -590,6 +592,10 @@ module.exports = (() => {
 			lockedBinding = item.registerLockChangeHandler((locked) => {
 				this._dataFormat.locked = locked;
 			});
+
+			calculatingBinding = item.registerCalculatingChangeHandler((calculating) => {
+				this._dataFormat.calculating = calculating;
+			});
 		}
 
 		this._disposeStack.push(item.registerPortfolioChangeHandler((portfolio) => {
@@ -604,6 +610,7 @@ module.exports = (() => {
 		this._disposeStack.push(fundamentalBinding);
 		this._disposeStack.push(quoteBinding);
 		this._disposeStack.push(lockedBinding);
+		this._disposeStack.push(calculatingBinding);
 		this._disposeStack.push(newsBinding);
 
 		this._disposeStack.push(item.registerPositionItemDisposeHandler(() => {
@@ -611,6 +618,7 @@ module.exports = (() => {
 			quoteBinding.dispose();
 			newsBinding.dispose();
 			lockedBinding.dispose();
+			calculatingBinding.dispose();
 
 			array.remove(this._items, i => i === item);
 			array.remove(this._excludedItems, i => i === item);
@@ -663,7 +671,7 @@ module.exports = (() => {
 		const format = group._dataFormat;
 
 		const currency = group.currency;
-		
+
 		const items = group._consideredItems;
 
 		group._bypassCurrencyTranslation = items.every(item => item.currency === currency);
@@ -794,6 +802,7 @@ module.exports = (() => {
 
 			format.invalid = definition.type === PositionLevelType.POSITION && item.invalid;
 			format.locked = definition.type === PositionLevelType.POSITION && item.data.locked;
+			format.calculating = definition.type === PositionLevelType.POSITION && item.data.calculating;
 		}
 
 		let portfolioType = null;
@@ -899,7 +908,7 @@ module.exports = (() => {
 		actual.marketChangePercent = marketChangePercent;
 
 		format.market = formatCurrency(actual.market, currency);
-		
+
 		if (updates.marketDirection.up || updates.marketDirection.down) {
 			format.marketDirection = unchanged;
 			setTimeout(() => format.marketDirection = updates.marketDirection, 0);

package/lib/processing/PositionItem.js

@@ -68,7 +68,7 @@ module.exports = (() => {
 
 			this._data.quantity = null;
 			this._data.quantityPrevious = null;
-			
+
 			this._data.realized = null;
 			this._data.income = null;
 			this._data.basisPrice = null;
@@ -100,12 +100,14 @@ module.exports = (() => {
 
 			this._data.newsExists = false;
 			this._data.fundamental = { };
+			this._data.calculating = getIsCalculating(position);
 			this._data.locked = getIsLocked(position);
 
 			this._quoteChangedEvent = new Event(this);
 			this._newsExistsChangedEvent = new Event(this);
 			this._fundamentalDataChangedEvent = new Event(this);
 			this._lockChangedEvent = new Event(this);
+			this._calculatingChangedEvent = new Event(this);
 			this._portfolioChangedEvent = new Event(this);
 			this._positionItemDisposeEvent = new Event(this);
 
@@ -203,6 +205,15 @@ module.exports = (() => {
 			return this._previousQuote;
 		}
 
+		/**
+		 * The current price.
+		 *
+		 * @return {null|Number}
+		 */
+		get currentPrice() {
+			return this._currentPrice;
+		}
+
 		updatePortfolio(portfolio) {
 			assert.argumentIsRequired(portfolio, 'portfolio', Object);
 			assert.argumentIsRequired(portfolio.portfolio, 'portfolio.portfolio', String);
@@ -302,6 +313,26 @@ module.exports = (() => {
 			}
 		}
 
+		/**
+		 * Sets a position's calculating status.
+		 *
+		 * @public
+		 * @param {Object} position
+		 */
+		setPositionCalculating(position) {
+			assert.argumentIsRequired(position, 'position', Object);
+
+			if (this.getIsDisposed()) {
+				return;
+			}
+
+			const value = getIsCalculating(position);
+
+			if (this._data.calculating !== value) {
+				this._calculatingChangedEvent.fire(this._data.calculating = value);
+			}
+		}
+
 		/**
 		 * Registers an observer for quote changes, which is fired after internal recalculations
 		 * of position data are complete.
@@ -347,6 +378,17 @@ module.exports = (() => {
 			return this._lockChangedEvent.register(handler);
 		}
 
+		/**
+		 * Registers an observer for position calculating changes.
+		 *
+		 * @public
+		 * @param {Function} handler
+		 * @return {Disposable}
+		 */
+		registerCalculatingChangeHandler(handler) {
+			return this._calculatingChangedEvent.register(handler);
+		}
+
 		/**
 		 * Registers an observer changes to portfolio metadata.
 		 *
@@ -709,6 +751,12 @@ module.exports = (() => {
 		return is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
 	}
 
+	function getIsCalculating(position) {
+		assert.argumentIsRequired(position, 'position', Object);
+
+		return is.object(position.system) && is.object(position.system.calculate) && is.number(position.system.calculate.processors) &&	position.system.calculate.processors > 0;
+	}
+
 	function getSnapshot(position, currentSummary, reporting) {
 		let snapshot;
 

package/lib/serialization/PortfolioSchema.js

@@ -99,6 +99,7 @@ module.exports = (() => {
 		.withField('name', DataType.STRING)
 		.withField('timezone', DataType.forEnum(Timezones, 'Timezone'))
 		.withField('dates.create', DataType.DAY)
+		.withField('dates.access', DataType.TIMESTAMP, true)
 		.withField('defaults.cash', DataType.BOOLEAN, true)
 		.withField('defaults.currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('defaults.reinvest', DataType.BOOLEAN, true)
@@ -109,6 +110,7 @@ module.exports = (() => {
 		.withField('legacy.warnings', DataType.NUMBER, true)
 		.withField('legacy.drops', DataType.NUMBER, true)
 		.withField('miscellany', DataType.AD_HOC, true)
+		.withField('system.calculate.processors', DataType.NUMBER, true)
 		.withField('system.sequence', DataType.NUMBER)
 		.withField('system.version', DataType.STRING)
 		.withField('system.timestamp', DataType.TIMESTAMP)
@@ -121,6 +123,7 @@ module.exports = (() => {
 		.withField('name', DataType.STRING)
 		.withField('timezone', DataType.forEnum(Timezones, 'Timezone'))
 		.withField('dates.create', DataType.DAY)
+		.withField('dates.access', DataType.TIMESTAMP, true)
 		.withField('defaults.cash', DataType.BOOLEAN, true)
 		.withField('defaults.currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('defaults.reinvest', DataType.BOOLEAN, true)
@@ -131,6 +134,7 @@ module.exports = (() => {
 		.withField('legacy.warnings', DataType.NUMBER, true)
 		.withField('legacy.drops', DataType.NUMBER, true)
 		.withField('miscellany', DataType.AD_HOC, true)
+		.withField('system.calculate.processors', DataType.NUMBER, true)
 		.schema
 	);
 

package/lib/serialization/PositionSchema.js

@@ -103,6 +103,7 @@ module.exports = (() => {
 		.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('root', DataType.STRING, true)
 		.schema
 	);
@@ -133,6 +134,7 @@ module.exports = (() => {
 		.withField('snapshot.income', DataType.DECIMAL)
 		.withField('snapshot.value', DataType.DECIMAL)
 		.withField('system.locked', DataType.BOOLEAN, true)
+		.withField('system.calculate.processors', DataType.NUMBER, true)
 		.withField('previous', DataType.NUMBER, true)
 		.schema
 	);

package/lib/serialization/TransactionSchema.js

@@ -130,6 +130,7 @@ module.exports = (() => {
 	const complete = new TransactionSchema(SchemaBuilder.withName('complete')
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
+		.withField('transaction', DataType.STRING)
 		.withField('sequence', DataType.NUMBER)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
@@ -179,6 +180,7 @@ module.exports = (() => {
 	const client = new TransactionSchema(SchemaBuilder.withName('client')
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
+		.withField('transaction', DataType.STRING)
 		.withField('sequence', DataType.NUMBER)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.3.23",
+  "version": "1.4.2",
   "description": "Common code used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",
@@ -9,8 +9,8 @@
   },
   "scripts": {},
   "dependencies": {
-    "@barchart/common-js": "~3.3.0",
-    "uuid": "3.1.0"
+    "@barchart/common-js": "^3.5.1",
+    "uuid": "^3.4.0"
   },
   "devDependencies": {
     "@babel/core": "^7.6.2",
@@ -23,10 +23,9 @@
     "gulp-git": "^2.9.0",
     "gulp-jasmine": "^2.2.1",
     "gulp-jshint": "~2.1.0",
-    "jsdoc": "^3.5.5",
     "jshint": "2.9.5",
     "vinyl-buffer": "^1.0.1",
     "vinyl-source-stream": "^2.0.0"
   },
-  "license": "GPL-3.0"
+  "license": "MIT"
 }