@barchart/portfolio-api-common 1.0.192 → 1.0.196

package/lib/api/failures/PortfolioFailureType.js

@@ -0,0 +1,33 @@
+const FailureType = require('@barchart/common-js/api/failures/FailureType');
+
+module.exports = (() => {
+	'use strict';
+
+	/**
+	 * A static container for portfolio-specific {@link FailureType} items.
+	 *
+	 * @public
+	 */
+	class PortfolioFailureType {
+		constructor() {
+		}
+
+		/**
+		 * The transaction would occur before an existing transaction.
+		 *
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_OUT_OF_SEQUENCE() {
+			return transactionCreateFailedOutOfSequence;
+		}
+
+		toString() {
+			return '[PortfolioFailureType]';
+		}
+	}
+
+	const transactionCreateFailedOutOfSequence = new FailureType('TRANSACTION_CREATE_FAILED_OUT_OF_SEQUENCE', 'Unable to create transaction, the transaction date is out-of-sequence (i.e. it would occur before an existing transaction). Please confirm your intent to re-write transaction history.');
+
+	return PortfolioFailureType;
+})();

package/lib/processing/PositionContainer.js

@@ -5,6 +5,7 @@ const array = require('@barchart/common-js/lang/array'),
 	Currency = require('@barchart/common-js/lang/Currency'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
 	DisposableStack = require('@barchart/common-js/collections/specialized/DisposableStack'),
+	Event = require('@barchart/common-js/messaging/Event'),
 	is = require('@barchart/common-js/lang/is'),
 	Rate = require('@barchart/common-js/lang/Rate'),
 	Tree = require('@barchart/common-js/collections/Tree');
@@ -48,6 +49,9 @@ module.exports = (() => {
 
 			this._groupBindings = { };
 
+			this._positionSymbolAddedEvent = new Event(this);
+			this._positionSymbolRemovedEvent = new Event(this);
+
 			this._portfolios = portfolios.reduce((map, portfolio) => {
 				map[portfolio.portfolio] = portfolio;
 
@@ -241,7 +245,9 @@ module.exports = (() => {
 			}
 
 			this.startTransaction(() => {
-				this.removePosition(position);
+				const existingBarchartSymbols = this.getPositionSymbols(false);
+
+				removePositionItem.call(this, this._items.find((item) => item.position.position === position.position));
 
 				summaries.forEach((summary) => {
 					addSummaryCurrent(this._summariesCurrent, summary, this._currentSummaryFrame, this._currentSummaryRange);
@@ -281,6 +287,12 @@ module.exports = (() => {
 				};
 
 				this._definitions.forEach(definition => createGroupOrInjectItem(this._trees[definition.name], definition, definition.definitions));
+
+				const addedBarchartSymbol = extractSymbolForBarchart(item.position);
+
+				if (addedBarchartSymbol !== null && !existingBarchartSymbols.some(existingBarchartSymbol => existingBarchartSymbol === addedBarchartSymbol)) {
+					this._positionSymbolAddedEvent.fire(addedBarchartSymbol);
+				}
 			});
 		}
 
@@ -529,6 +541,31 @@ module.exports = (() => {
 			namesToUse.forEach((name) => this._trees[name].walk(group => group.setSuspended(false), false, false));
 		}
 
+		/**
+		 * Registers an observer for symbol addition (this occurs when a new position is added
+		 * for a symbol that does not already exist in the container). This event only fires
+		 * after the constructor completes (and initial positions have been added).
+		 *
+		 * @public
+		 * @param {Function} handler
+		 * @returns {Disposable}
+		 */
+		registerPositionSymbolAddedHandler(handler) {
+			return this._positionSymbolAddedEvent.register(handler);
+		}
+
+		/**
+		 * Registers an observer for symbol removal (this occurs when the last position for a
+		 * symbol is removed from the container).
+		 *
+		 * @public
+		 * @param {Function} handler
+		 * @returns {Disposable}
+		 */
+		registerPositionSymbolRemovedHandler(handler) {
+			return this._positionSymbolRemovedEvent.register(handler);
+		}
+
 		toString() {
 			return '[PositionContainer]';
 		}

package/package.json

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

package/test/SpecRunner.js

@@ -721,6 +721,7 @@ const array = require('@barchart/common-js/lang/array'),
 	Currency = require('@barchart/common-js/lang/Currency'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
 	DisposableStack = require('@barchart/common-js/collections/specialized/DisposableStack'),
+	Event = require('@barchart/common-js/messaging/Event'),
 	is = require('@barchart/common-js/lang/is'),
 	Rate = require('@barchart/common-js/lang/Rate'),
 	Tree = require('@barchart/common-js/collections/Tree');
@@ -764,6 +765,9 @@ module.exports = (() => {
 
 			this._groupBindings = { };
 
+			this._positionSymbolAddedEvent = new Event(this);
+			this._positionSymbolRemovedEvent = new Event(this);
+
 			this._portfolios = portfolios.reduce((map, portfolio) => {
 				map[portfolio.portfolio] = portfolio;
 
@@ -957,7 +961,9 @@ module.exports = (() => {
 			}
 
 			this.startTransaction(() => {
-				this.removePosition(position);
+				const existingBarchartSymbols = this.getPositionSymbols(false);
+
+				removePositionItem.call(this, this._items.find((item) => item.position.position === position.position));
 
 				summaries.forEach((summary) => {
 					addSummaryCurrent(this._summariesCurrent, summary, this._currentSummaryFrame, this._currentSummaryRange);
@@ -997,6 +1003,12 @@ module.exports = (() => {
 				};
 
 				this._definitions.forEach(definition => createGroupOrInjectItem(this._trees[definition.name], definition, definition.definitions));
+
+				const addedBarchartSymbol = extractSymbolForBarchart(item.position);
+
+				if (addedBarchartSymbol !== null && !existingBarchartSymbols.some(existingBarchartSymbol => existingBarchartSymbol === addedBarchartSymbol)) {
+					this._positionSymbolAddedEvent.fire(addedBarchartSymbol);
+				}
 			});
 		}
 
@@ -1245,6 +1257,31 @@ module.exports = (() => {
 			namesToUse.forEach((name) => this._trees[name].walk(group => group.setSuspended(false), false, false));
 		}
 
+		/**
+		 * Registers an observer for symbol addition (this occurs when a new position is added
+		 * for a symbol that does not already exist in the container). This event only fires
+		 * after the constructor completes (and initial positions have been added).
+		 *
+		 * @public
+		 * @param {Function} handler
+		 * @returns {Disposable}
+		 */
+		registerPositionSymbolAddedHandler(handler) {
+			return this._positionSymbolAddedEvent.register(handler);
+		}
+
+		/**
+		 * Registers an observer for symbol removal (this occurs when the last position for a
+		 * symbol is removed from the container).
+		 *
+		 * @public
+		 * @param {Function} handler
+		 * @returns {Disposable}
+		 */
+		registerPositionSymbolRemovedHandler(handler) {
+			return this._positionSymbolRemovedEvent.register(handler);
+		}
+
 		toString() {
 			return '[PositionContainer]';
 		}
@@ -1532,7 +1569,7 @@ module.exports = (() => {
 	return PositionContainer;
 })();
 
-},{"./../data/PositionSummaryFrame":2,"./PositionGroup":5,"./PositionItem":6,"./definitions/PositionLevelDefinition":7,"./definitions/PositionLevelType":8,"./definitions/PositionTreeDefinition":9,"@barchart/common-js/collections/Tree":11,"@barchart/common-js/collections/sorting/ComparatorBuilder":12,"@barchart/common-js/collections/sorting/comparators":13,"@barchart/common-js/collections/specialized/DisposableStack":14,"@barchart/common-js/lang/Currency":15,"@barchart/common-js/lang/Decimal":17,"@barchart/common-js/lang/Rate":20,"@barchart/common-js/lang/array":21,"@barchart/common-js/lang/assert":22,"@barchart/common-js/lang/is":24}],5:[function(require,module,exports){
+},{"./../data/PositionSummaryFrame":2,"./PositionGroup":5,"./PositionItem":6,"./definitions/PositionLevelDefinition":7,"./definitions/PositionLevelType":8,"./definitions/PositionTreeDefinition":9,"@barchart/common-js/collections/Tree":11,"@barchart/common-js/collections/sorting/ComparatorBuilder":12,"@barchart/common-js/collections/sorting/comparators":13,"@barchart/common-js/collections/specialized/DisposableStack":14,"@barchart/common-js/lang/Currency":15,"@barchart/common-js/lang/Decimal":17,"@barchart/common-js/lang/Rate":20,"@barchart/common-js/lang/array":21,"@barchart/common-js/lang/assert":22,"@barchart/common-js/lang/is":24,"@barchart/common-js/messaging/Event":26}],5:[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'),