@barchart/portfolio-api-common 1.0.161 → 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

@@ -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.
 		 *

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.161",
+  "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.
@@ -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.
 		 *
@@ -2295,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';
 
@@ -2311,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
 	 */
@@ -2414,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]';
 		}
@@ -2463,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');