@barchart/portfolio-api-common 1.0.158 → 1.0.162

package/lib/processing/PositionContainer.js

@@ -292,6 +292,22 @@ module.exports = (() => {
 			}, { });
 		}
 
+		addPortfolio(portfolio) {
+
+		}
+
+		removePortfolio(portfolio) {
+
+		}
+
+		mutatePosition(position, summary) {
+
+		}
+
+		removePosition(position) {
+
+		}
+
 		/**
 		 * Returns a distinct list of all symbols used by the positions
 		 * within the container.

package/lib/processing/PositionGroup.js

@@ -123,7 +123,6 @@ module.exports = (() => {
 			this._dataActual.summaryTotalPrevious = null;
 			this._dataActual.cashTotal = null;
 
-			this._dataFormat.type = null;
 			this._dataFormat.currentPrice = null;
 			this._dataFormat.previousPrice = null;
 			this._dataFormat.basis = null;
@@ -144,6 +143,7 @@ module.exports = (() => {
 			this._dataFormat.summaryTotalPrevious = null;
 			this._dataFormat.summaryTotalPreviousNegative = false;
 			this._dataFormat.cashTotal = null;
+			this._dataFormat.portfolioType = null;
 
 			this._items.forEach((item) => {
 				this._disposeStack.push(item.registerQuoteChangeHandler((quote, sender) => {
@@ -171,8 +171,8 @@ module.exports = (() => {
 						this._dataFormat.quoteTime = this._dataActual.quoteTime;
 						this._dataFormat.quoteVolume = formatNumber(this._dataActual.quoteVolume, 0);
 
-						const quoteChangePositive = is.number(this._dataActual.quoteChange) && this._dataActual.quoteChange > 0;
-						const quoteChangeNegative = is.number(this._dataActual.quoteChange) && this._dataActual.quoteChange < 0;
+						const quoteChangePositive = quote.lastPriceDirection === 'up';
+						const quoteChangeNegative = quote.lastPriceDirection === 'down';
 
 						setTimeout(() => this._dataFormat.quoteChangeDirection = { up: quoteChangePositive, down: quoteChangeNegative }, 0);
 						this._dataFormat.quoteChangeNegative = quoteChangeNegative;
@@ -294,6 +294,16 @@ module.exports = (() => {
 			return this._excluded;
 		}
 
+		addItems(items) {
+
+			this.refresh();
+		}
+
+		removeItems(items) {
+
+			this.refresh();
+		}
+
 		/**
 		 * Sets the list of items which are excluded from group aggregation calculations.
 		 *
@@ -509,14 +519,28 @@ module.exports = (() => {
 		if (group.single) {
 			const item = group._items[0];
 
-			format.type = item.data.type || null;
-
 			actual.quantity = item.position.snapshot.open;
 			actual.basisPrice = item.data.basisPrice;
 
 			format.quantity = formatDecimal(actual.quantity, 2);
 			format.basisPrice = formatCurrency(actual.basisPrice, currency);
 		}
+
+		const groupItems = group._items;
+
+		let portfolioType = null;
+
+		if (groupItems.length > 0) {
+			const portfolio = groupItems[0].portfolio;
+
+			if (groupItems.every(i => i.portfolio.portfolio === portfolio.portfolio)) {
+				if (portfolio.miscellany && portfolio.miscellany.data.type && portfolio.miscellany.data.type.value) {
+					portfolioType = portfolio.miscellany.data.type.value;
+				}
+			}
+		}
+
+		format.portfolioType = portfolioType;
 	}
 
 	function calculatePriceData(group, rates, item, forceRefresh) {

package/lib/processing/PositionItem.js

@@ -61,8 +61,6 @@ module.exports = (() => {
 			this._data.newsExists = false;
 			this._data.fundamental = { };
 
-			this._data.type = null;
-
 			calculateStaticData(this);
 			calculatePriceData(this, null);
 
@@ -237,10 +235,6 @@ module.exports = (() => {
 
 		const data = item._data;
 
-		if (portfolio.miscellany && portfolio.miscellany.data.type && portfolio.miscellany.data.type.value) {
-			data.type = portfolio.miscellany.data.type.value;
-		}
-
 		data.previousPrice = position.previous || null;
 
 		let basis;

package/lib/processing/definitions/PositionLevelDefinition.js

@@ -1,6 +1,9 @@
 const assert = require('@barchart/common-js/lang/assert'),
+	Currency = require('@barchart/common-js/lang/Currency'),
 	is = require('@barchart/common-js/lang/is');
 
+const InstrumentType = require('./../../data/InstrumentType');
+
 module.exports = (() => {
 	'use strict';
 
@@ -15,7 +18,6 @@ module.exports = (() => {
 	 * @param {PositionLevelDefinition~descriptionSelector} descriptionSelector
 	 * @param {PositionLevelDefinition~currencySelector} currencySelector
 	 * @param {Array.<PositionLevelDefinition~RequiredGroup>=} requiredGroups
-	 * @param {Array.<PositionLevelDefinition~RequiredGroup>=} requiredGroups
 	 * @param {Boolean=} single
 	 * @param {Boolean=} aggregateCash
 	 */
@@ -118,6 +120,67 @@ module.exports = (() => {
 			return this._aggregateCash;
 		}
 
+		/**
+		 * Builds a {@link PositionLevelDefinition~RequiredGroup} for a portfolio.
+		 *
+		 * @public
+		 * @static
+		 * @param {Object} portfolio
+		 * @return {PositionLevelDefinition~RequiredGroup}
+		 */
+		static buildRequiredGroupForPortfolio(portfolio) {
+			return {
+				key: PositionLevelDefinition.getKeyForPortfolioGroup(portfolio),
+				description: PositionLevelDefinition.getDescriptionForPortfolioGroup(portfolio),
+				currency: Currency.CAD
+			};
+		}
+
+
+		static getKeyForPortfolioGroup(portfolio) {
+			assert.argumentIsRequired(portfolio, 'portfolio', Object);
+
+			return portfolio.portfolio;
+		}
+
+		static getDescriptionForPortfolioGroup(portfolio) {
+			assert.argumentIsRequired(portfolio, 'portfolio', Object);
+
+			return portfolio.name;
+		}
+
+		/**
+		 * Builds a {@link PositionLevelDefinition~RequiredGroup} for an asset class.
+		 *
+		 * @public
+		 * @static
+		 * @param {InstrumentType} type
+		 * @param {Currency} currency
+		 * @return {PositionLevelDefinition~RequiredGroup}
+		 */
+		static buildRequiredGroupForAssetClass(type, currency) {
+			return {
+				key: PositionLevelDefinition.getKeyForAssetClassGroup(type, currency),
+				description: PositionLevelDefinition.getDescriptionForAssetClassGroup(type, currency),
+				currency: currency
+			}
+		}
+
+
+		static getKeyForAssetClassGroup(type, currency) {
+			assert.argumentIsRequired(type, 'type', InstrumentType, 'InstrumentType');
+			assert.argumentIsRequired(currency, 'currency', Currency, 'Currency');
+
+			return `${type.code}|${currency.code}`;
+		}
+
+		static getDescriptionForAssetClassGroup(type, currency) {
+			assert.argumentIsRequired(type, 'type', InstrumentType, 'InstrumentType');
+			assert.argumentIsRequired(currency, 'currency', Currency, 'Currency');
+
+			return `${type.alternateDescription}${currency.code === 'CAD' ? '' : ` (${currency.alternateDescription})`}`;
+		}
+
 		toString() {
 			return '[PositionLevelDefinition]';
 		}

package/package.json

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

package/test/SpecRunner.js

@@ -1008,6 +1008,22 @@ module.exports = (() => {
 			}, { });
 		}
 
+		addPortfolio(portfolio) {
+
+		}
+
+		removePortfolio(portfolio) {
+
+		}
+
+		mutatePosition(position, summary) {
+
+		}
+
+		removePosition(position) {
+
+		}
+
 		/**
 		 * Returns a distinct list of all symbols used by the positions
 		 * within the container.
@@ -1368,7 +1384,6 @@ module.exports = (() => {
 			this._dataActual.summaryTotalPrevious = null;
 			this._dataActual.cashTotal = null;
 
-			this._dataFormat.type = null;
 			this._dataFormat.currentPrice = null;
 			this._dataFormat.previousPrice = null;
 			this._dataFormat.basis = null;
@@ -1389,6 +1404,7 @@ module.exports = (() => {
 			this._dataFormat.summaryTotalPrevious = null;
 			this._dataFormat.summaryTotalPreviousNegative = false;
 			this._dataFormat.cashTotal = null;
+			this._dataFormat.portfolioType = null;
 
 			this._items.forEach((item) => {
 				this._disposeStack.push(item.registerQuoteChangeHandler((quote, sender) => {
@@ -1416,8 +1432,8 @@ module.exports = (() => {
 						this._dataFormat.quoteTime = this._dataActual.quoteTime;
 						this._dataFormat.quoteVolume = formatNumber(this._dataActual.quoteVolume, 0);
 
-						const quoteChangePositive = is.number(this._dataActual.quoteChange) && this._dataActual.quoteChange > 0;
-						const quoteChangeNegative = is.number(this._dataActual.quoteChange) && this._dataActual.quoteChange < 0;
+						const quoteChangePositive = quote.lastPriceDirection === 'up';
+						const quoteChangeNegative = quote.lastPriceDirection === 'down';
 
 						setTimeout(() => this._dataFormat.quoteChangeDirection = { up: quoteChangePositive, down: quoteChangeNegative }, 0);
 						this._dataFormat.quoteChangeNegative = quoteChangeNegative;
@@ -1539,6 +1555,16 @@ module.exports = (() => {
 			return this._excluded;
 		}
 
+		addItems(items) {
+
+			this.refresh();
+		}
+
+		removeItems(items) {
+
+			this.refresh();
+		}
+
 		/**
 		 * Sets the list of items which are excluded from group aggregation calculations.
 		 *
@@ -1754,14 +1780,28 @@ module.exports = (() => {
 		if (group.single) {
 			const item = group._items[0];
 
-			format.type = item.data.type || null;
-
 			actual.quantity = item.position.snapshot.open;
 			actual.basisPrice = item.data.basisPrice;
 
 			format.quantity = formatDecimal(actual.quantity, 2);
 			format.basisPrice = formatCurrency(actual.basisPrice, currency);
 		}
+
+		const groupItems = group._items;
+
+		let portfolioType = null;
+
+		if (groupItems.length > 0) {
+			const portfolio = groupItems[0].portfolio;
+
+			if (groupItems.every(i => i.portfolio.portfolio === portfolio.portfolio)) {
+				if (portfolio.miscellany && portfolio.miscellany.data.type && portfolio.miscellany.data.type.value) {
+					portfolioType = portfolio.miscellany.data.type.value;
+				}
+			}
+		}
+
+		format.portfolioType = portfolioType;
 	}
 
 	function calculatePriceData(group, rates, item, forceRefresh) {
@@ -1975,8 +2015,6 @@ module.exports = (() => {
 			this._data.newsExists = false;
 			this._data.fundamental = { };
 
-			this._data.type = null;
-
 			calculateStaticData(this);
 			calculatePriceData(this, null);
 
@@ -2151,10 +2189,6 @@ module.exports = (() => {
 
 		const data = item._data;
 
-		if (portfolio.miscellany && portfolio.miscellany.data.type && portfolio.miscellany.data.type.value) {
-			data.type = portfolio.miscellany.data.type.value;
-		}
-
 		data.previousPrice = position.previous || null;
 
 		let basis;
@@ -2287,8 +2321,11 @@ module.exports = (() => {
 
 },{"./../data/InstrumentType":1,"@barchart/common-js/lang/Currency":14,"@barchart/common-js/lang/Decimal":16,"@barchart/common-js/lang/array":20,"@barchart/common-js/lang/assert":21,"@barchart/common-js/lang/is":23,"@barchart/common-js/messaging/Event":25}],7:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
+	Currency = require('@barchart/common-js/lang/Currency'),
 	is = require('@barchart/common-js/lang/is');
 
+const InstrumentType = require('./../../data/InstrumentType');
+
 module.exports = (() => {
 	'use strict';
 
@@ -2303,7 +2340,6 @@ module.exports = (() => {
 	 * @param {PositionLevelDefinition~descriptionSelector} descriptionSelector
 	 * @param {PositionLevelDefinition~currencySelector} currencySelector
 	 * @param {Array.<PositionLevelDefinition~RequiredGroup>=} requiredGroups
-	 * @param {Array.<PositionLevelDefinition~RequiredGroup>=} requiredGroups
 	 * @param {Boolean=} single
 	 * @param {Boolean=} aggregateCash
 	 */
@@ -2406,6 +2442,67 @@ module.exports = (() => {
 			return this._aggregateCash;
 		}
 
+		/**
+		 * Builds a {@link PositionLevelDefinition~RequiredGroup} for a portfolio.
+		 *
+		 * @public
+		 * @static
+		 * @param {Object} portfolio
+		 * @return {PositionLevelDefinition~RequiredGroup}
+		 */
+		static buildRequiredGroupForPortfolio(portfolio) {
+			return {
+				key: PositionLevelDefinition.getKeyForPortfolioGroup(portfolio),
+				description: PositionLevelDefinition.getDescriptionForPortfolioGroup(portfolio),
+				currency: Currency.CAD
+			};
+		}
+
+
+		static getKeyForPortfolioGroup(portfolio) {
+			assert.argumentIsRequired(portfolio, 'portfolio', Object);
+
+			return portfolio.portfolio;
+		}
+
+		static getDescriptionForPortfolioGroup(portfolio) {
+			assert.argumentIsRequired(portfolio, 'portfolio', Object);
+
+			return portfolio.name;
+		}
+
+		/**
+		 * Builds a {@link PositionLevelDefinition~RequiredGroup} for an asset class.
+		 *
+		 * @public
+		 * @static
+		 * @param {InstrumentType} type
+		 * @param {Currency} currency
+		 * @return {PositionLevelDefinition~RequiredGroup}
+		 */
+		static buildRequiredGroupForAssetClass(type, currency) {
+			return {
+				key: PositionLevelDefinition.getKeyForAssetClassGroup(type, currency),
+				description: PositionLevelDefinition.getDescriptionForAssetClassGroup(type, currency),
+				currency: currency
+			}
+		}
+
+
+		static getKeyForAssetClassGroup(type, currency) {
+			assert.argumentIsRequired(type, 'type', InstrumentType, 'InstrumentType');
+			assert.argumentIsRequired(currency, 'currency', Currency, 'Currency');
+
+			return `${type.code}|${currency.code}`;
+		}
+
+		static getDescriptionForAssetClassGroup(type, currency) {
+			assert.argumentIsRequired(type, 'type', InstrumentType, 'InstrumentType');
+			assert.argumentIsRequired(currency, 'currency', Currency, 'Currency');
+
+			return `${type.alternateDescription}${currency.code === 'CAD' ? '' : ` (${currency.alternateDescription})`}`;
+		}
+
 		toString() {
 			return '[PositionLevelDefinition]';
 		}
@@ -2455,7 +2552,7 @@ module.exports = (() => {
 	return PositionLevelDefinition;
 })();
 
-},{"@barchart/common-js/lang/assert":21,"@barchart/common-js/lang/is":23}],8:[function(require,module,exports){
+},{"./../../data/InstrumentType":1,"@barchart/common-js/lang/Currency":14,"@barchart/common-js/lang/assert":21,"@barchart/common-js/lang/is":23}],8:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert');
 
 const PositionLevelDefinition = require('./PositionLevelDefinition');