@barchart/portfolio-api-common 1.0.205 → 1.0.209

package/lib/api/failures/PortfolioFailureType.js

@@ -71,7 +71,7 @@ module.exports = (() => {
 		}
 	}
 
-	const positionCreateFailedNoPortfolio = new FailureType('POSITION_CREATE_FAILED_OUT_OF_SEQUENCE', 'Unable to create transaction. The referenced portfolio does not exist. Has it been deleted?');
+	const positionCreateFailedNoPortfolio = new FailureType('POSITION_CREATE_FAILED_NO_PORTFOLIO', 'Unable to create transaction. The referenced portfolio does not exist. Has it been deleted?');
 
 	const transactionCreateFailedOutOfSequence = new FailureType('TRANSACTION_CREATE_FAILED_OUT_OF_SEQUENCE', 'Unable to create 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 transactionCreateFailedDirectionSwitch = new FailureType('TRANSACTION_CREATE_FAILED_DIRECTION_SWITCH', 'Unable to create transaction, because the position direction would be switched (from long to short or vice versa). Please close the position (to a zero balance) first, then enter a second transaction.');

package/lib/data/InstrumentType.js

@@ -67,7 +67,7 @@ module.exports = (() => {
 		 * Generates an identifier for the instrument.
 		 *
 		 * @public
-		 * @param instrument
+		 * @param {Object} instrument
 		 * @returns {String}
 		 */
 		generateIdentifier(instrument) {
@@ -129,7 +129,7 @@ module.exports = (() => {
 		 *
 		 * @static
 		 * @public
-		 * @param instrument
+		 * @param {Object} instrument
 		 * @returns {String}
 		 */
 		static generateIdentifier(instrument) {

package/lib/formatters/TransactionFormatter.js

@@ -90,7 +90,8 @@ module.exports = (() => {
 			date: t.date,
 			type: t.type.display,
 			sequence: t.sequence,
-			instrument: t.instrument
+			instrument: t.instrument,
+			position: t.position
 		};
 
 		if (basic.instrument) {

package/lib/processing/PositionContainer.js

@@ -142,6 +142,8 @@ module.exports = (() => {
 
 				return map;
 			}, { });
+
+			Object.keys(this._portfolios).forEach(key => updateEmptyPortfolioGroups.call(this, this._portfolios[key]));
 		}
 
 		/**
@@ -203,6 +205,8 @@ module.exports = (() => {
 						});
 					}
 				});
+
+				updateEmptyPortfolioGroups.call(this, portfolio);
 			}
 		}
 
@@ -218,6 +222,8 @@ module.exports = (() => {
 
 			this.startTransaction(() => {
 				getPositionItemsForPortfolio(this._items, portfolio.portfolio).forEach(item => item.updatePortfolio(portfolio));
+
+				updateEmptyPortfolioGroups.call(this, portfolio);
 			});
 		}
 
@@ -754,6 +760,17 @@ module.exports = (() => {
 		});
 	}
 
+
+	function updateEmptyPortfolioGroups(portfolio) {
+		Object.keys(this._trees).forEach((key) => {
+			this._trees[key].walk((group) => {
+				if (group.definition.type === PositionLevelType.PORTFOLIO && group.key === PositionLevelDefinition.getKeyForPortfolioGroup(portfolio) && group.getIsEmpty()) {
+					group.updatePortfolio(portfolio);
+				}
+			}, true, false);
+		});
+	}
+
 	function getPositionItemsForPortfolio(items, portfolio) {
 		return items.reduce((positionItems, item) => {
 			if (item.position.portfolio === portfolio) {

package/lib/processing/PositionGroup.js

@@ -11,6 +11,9 @@ const array = require('@barchart/common-js/lang/array'),
 
 const InstrumentType = require('./../data/InstrumentType');
 
+const PositionLevelDefinition = require('./definitions/PositionLevelDefinition'),
+	PositionLevelType = require('./definitions/PositionLevelType');
+
 module.exports = (() => {
 	'use strict';
 
@@ -354,6 +357,36 @@ module.exports = (() => {
 			}
 		}
 
+		/**
+		 * Updates the portfolio data. For example, a portfolio's name might change. This
+		 * function only affects {@link PositionLevelType.PORTFOLIO} groups.
+		 *
+		 * @public
+		 * @param {Object} portfolio
+		 */
+		updatePortfolio(portfolio) {
+			if (this._definition.type !== PositionLevelType.PORTFOLIO || this._key !== PositionLevelDefinition.getKeyForPortfolioGroup(portfolio) || !this.getIsEmpty()) {
+				return;
+			}
+
+			const descriptionSelector = this._definition.descriptionSelector;
+
+			this._description = descriptionSelector(this._items[0]);
+
+			this._dataActual.description = this._description;
+			this._dataFormat.description = this._description;
+
+			let portfolioType;
+
+			if (portfolio.miscellany && portfolio.miscellany.data.type && portfolio.miscellany.data.type.value) {
+				portfolioType = portfolio.miscellany.data.type.value;
+			} else {
+				portfolioType = null;
+			}
+
+			this._dataFormat.portfolioType = portfolioType;
+		}
+
 		/**
 		 * Causes all aggregated data to be recalculated (assuming the group has not
 		 * been suspended).
@@ -381,6 +414,16 @@ module.exports = (() => {
 			calculateMarketPercent(this, this._container.getForexQuotes(), true);
 		}
 
+		/**
+		 * Indicates if the group contains any items.
+		 *
+		 * @public
+		 * @returns {boolean}
+		 */
+		getIsEmpty() {
+			return this._items.length === 0;
+		}
+
 		/**
 		 * Adds an observer for change in the market percentage of the group.
 		 *

package/package.json

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

package/test/SpecRunner.js

@@ -68,7 +68,7 @@ module.exports = (() => {
 		 * Generates an identifier for the instrument.
 		 *
 		 * @public
-		 * @param instrument
+		 * @param {Object} instrument
 		 * @returns {String}
 		 */
 		generateIdentifier(instrument) {
@@ -130,7 +130,7 @@ module.exports = (() => {
 		 *
 		 * @static
 		 * @public
-		 * @param instrument
+		 * @param {Object} instrument
 		 * @returns {String}
 		 */
 		static generateIdentifier(instrument) {
@@ -899,6 +899,8 @@ module.exports = (() => {
 
 				return map;
 			}, { });
+
+			Object.keys(this._portfolios).forEach(key => updateEmptyPortfolioGroups.call(this, this._portfolios[key]));
 		}
 
 		/**
@@ -960,6 +962,8 @@ module.exports = (() => {
 						});
 					}
 				});
+
+				updateEmptyPortfolioGroups.call(this, portfolio);
 			}
 		}
 
@@ -975,6 +979,8 @@ module.exports = (() => {
 
 			this.startTransaction(() => {
 				getPositionItemsForPortfolio(this._items, portfolio.portfolio).forEach(item => item.updatePortfolio(portfolio));
+
+				updateEmptyPortfolioGroups.call(this, portfolio);
 			});
 		}
 
@@ -1511,6 +1517,17 @@ module.exports = (() => {
 		});
 	}
 
+
+	function updateEmptyPortfolioGroups(portfolio) {
+		Object.keys(this._trees).forEach((key) => {
+			this._trees[key].walk((group) => {
+				if (group.definition.type === PositionLevelType.PORTFOLIO && group.key === PositionLevelDefinition.getKeyForPortfolioGroup(portfolio) && group.getIsEmpty()) {
+					group.updatePortfolio(portfolio);
+				}
+			}, true, false);
+		});
+	}
+
 	function getPositionItemsForPortfolio(items, portfolio) {
 		return items.reduce((positionItems, item) => {
 			if (item.position.portfolio === portfolio) {
@@ -1646,6 +1663,9 @@ const array = require('@barchart/common-js/lang/array'),
 
 const InstrumentType = require('./../data/InstrumentType');
 
+const PositionLevelDefinition = require('./definitions/PositionLevelDefinition'),
+	PositionLevelType = require('./definitions/PositionLevelType');
+
 module.exports = (() => {
 	'use strict';
 
@@ -1989,6 +2009,36 @@ module.exports = (() => {
 			}
 		}
 
+		/**
+		 * Updates the portfolio data. For example, a portfolio's name might change. This
+		 * function only affects {@link PositionLevelType.PORTFOLIO} groups.
+		 *
+		 * @public
+		 * @param {Object} portfolio
+		 */
+		updatePortfolio(portfolio) {
+			if (this._definition.type !== PositionLevelType.PORTFOLIO || this._key !== PositionLevelDefinition.getKeyForPortfolioGroup(portfolio) || !this.getIsEmpty()) {
+				return;
+			}
+
+			const descriptionSelector = this._definition.descriptionSelector;
+
+			this._description = descriptionSelector(this._items[0]);
+
+			this._dataActual.description = this._description;
+			this._dataFormat.description = this._description;
+
+			let portfolioType;
+
+			if (portfolio.miscellany && portfolio.miscellany.data.type && portfolio.miscellany.data.type.value) {
+				portfolioType = portfolio.miscellany.data.type.value;
+			} else {
+				portfolioType = null;
+			}
+
+			this._dataFormat.portfolioType = portfolioType;
+		}
+
 		/**
 		 * Causes all aggregated data to be recalculated (assuming the group has not
 		 * been suspended).
@@ -2016,6 +2066,16 @@ module.exports = (() => {
 			calculateMarketPercent(this, this._container.getForexQuotes(), true);
 		}
 
+		/**
+		 * Indicates if the group contains any items.
+		 *
+		 * @public
+		 * @returns {boolean}
+		 */
+		getIsEmpty() {
+			return this._items.length === 0;
+		}
+
 		/**
 		 * Adds an observer for change in the market percentage of the group.
 		 *
@@ -2400,7 +2460,7 @@ module.exports = (() => {
 	return PositionGroup;
 })();
 
-},{"./../data/InstrumentType":1,"@barchart/common-js/collections/specialized/DisposableStack":14,"@barchart/common-js/lang/Currency":15,"@barchart/common-js/lang/Decimal":17,"@barchart/common-js/lang/Disposable":18,"@barchart/common-js/lang/Rate":20,"@barchart/common-js/lang/array":21,"@barchart/common-js/lang/assert":22,"@barchart/common-js/lang/formatter":23,"@barchart/common-js/lang/is":24,"@barchart/common-js/messaging/Event":26}],6:[function(require,module,exports){
+},{"./../data/InstrumentType":1,"./definitions/PositionLevelDefinition":7,"./definitions/PositionLevelType":8,"@barchart/common-js/collections/specialized/DisposableStack":14,"@barchart/common-js/lang/Currency":15,"@barchart/common-js/lang/Decimal":17,"@barchart/common-js/lang/Disposable":18,"@barchart/common-js/lang/Rate":20,"@barchart/common-js/lang/array":21,"@barchart/common-js/lang/assert":22,"@barchart/common-js/lang/formatter":23,"@barchart/common-js/lang/is":24,"@barchart/common-js/messaging/Event":26}],6:[function(require,module,exports){
 const array = require('@barchart/common-js/lang/array'),
 	assert = require('@barchart/common-js/lang/assert'),
 	Currency = require('@barchart/common-js/lang/Currency'),