@barchart/portfolio-api-common 1.3.23 → 1.4.2

package/test/SpecRunner.js

@@ -253,7 +253,7 @@ module.exports = (() => {
 		}
 
 		toString() {
-			return '[InstrumentType]';
+			return `[InstrumentType (code=${this.code})]`;
 		}
 	}
 
@@ -393,6 +393,10 @@ module.exports = (() => {
 				return even;
 			}
 		}
+
+		toString() {
+			return `[PositionDirection (code=${this.code})]`;
+		}
 	}
 
 	const long = new PositionDirection('LONG', 'Long', 'positive');
@@ -580,7 +584,7 @@ module.exports = (() => {
 		}
 
 		toString() {
-			return '[PositionSummaryFrame]';
+			return `[PositionSummaryFrame (code=${this.code})]`;
 		}
 	}
 
@@ -1247,7 +1251,7 @@ module.exports = (() => {
 		}
 
 		toString() {
-			return '[TransactionType]';
+			return `[TransactionType (code=${this.code})]`;
 		}
 	}
 
@@ -1755,7 +1759,7 @@ module.exports = (() => {
 				const tree = new Tree();
 
 				createGroups.call(this, tree, this._items, treeDefinition, treeDefinition.definitions);
-				
+
 				map[treeDefinition.name] = tree;
 
 				return map;
@@ -2087,6 +2091,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).
@@ -2139,6 +2178,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.
 		 *
@@ -2749,6 +2808,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;
@@ -3256,6 +3316,7 @@ module.exports = (() => {
 
 		let newsBinding = Disposable.getEmpty();
 		let lockedBinding = Disposable.getEmpty();
+		let calculatingBinding = Disposable.getEmpty();
 
 		if (this._single) {
 			newsBinding = item.registerNewsExistsChangeHandler((exists) => {
@@ -3266,6 +3327,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) => {
@@ -3280,6 +3345,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(() => {
@@ -3287,6 +3353,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);
@@ -3339,7 +3406,7 @@ module.exports = (() => {
 		const format = group._dataFormat;
 
 		const currency = group.currency;
-		
+
 		const items = group._consideredItems;
 
 		group._bypassCurrencyTranslation = items.every(item => item.currency === currency);
@@ -3470,6 +3537,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;
@@ -3575,7 +3643,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);
@@ -3764,7 +3832,7 @@ module.exports = (() => {
 
 			this._data.quantity = null;
 			this._data.quantityPrevious = null;
-			
+
 			this._data.realized = null;
 			this._data.income = null;
 			this._data.basisPrice = null;
@@ -3796,12 +3864,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);
 
@@ -3899,6 +3969,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);
@@ -3998,6 +4077,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.
@@ -4043,6 +4142,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.
 		 *
@@ -4405,6 +4515,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;
 
@@ -4980,6 +5096,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)
@@ -5029,6 +5146,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/jsdoc.json

@@ -1,8 +0,0 @@
-{
-    "source": {
-        "include": [ "." ],
-        "exclude": [ "./node_modules", "./test" ],
-        "includePattern": ".+\\.js(doc|x)?$",
-        "excludePattern": "(^|\\/|\\\\)_"
-    }
-}