@barchart/portfolio-api-common 1.0.197 → 1.0.201

package/lib/api/failures/PortfolioFailureType.js

@@ -15,6 +15,7 @@ module.exports = (() => {
 		/**
 		 * The transaction would occur before an existing transaction.
 		 *
+		 * @public
 		 * @static
 		 * @returns {FailureType}
 		 */
@@ -22,12 +23,49 @@ module.exports = (() => {
 			return transactionCreateFailedOutOfSequence;
 		}
 
+		/**
+		 * The transaction would cause the position to change (from long to
+		 * short, or vice versa).
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_DIRECTION_SWITCH() {
+			return transactionCreateFailedDirectionSwitch;
+		}
+
+		static get TRANSACTION_CREATE_REWRITE_UNSUPPORTED() {
+			return transactionCreateRewriteUnsupported;
+		}
+
+		/**
+		 * Deleting any transaction except for the most recent requires
+		 * re-writing transaction history.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_DELETE_FAILED_OUT_OF_SEQUENCE() {
+			return transactionDeleteFailedOutOfSequence;
+		}
+
+		static get TRANSACTION_DELETE_UNSUPPORTED() {
+			return transactionDeleteUnsupported;
+		}
+
 		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.');
+	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.');
+	const transactionCreateRewriteUnsupported = new FailureType('TRANSACTION_CREATE_REWRITE_UNSUPPORTED', 'Unable to re-write transaction history. This operation is not currently supported (but will be implemented soon).');
+
+	const transactionDeleteFailedOutOfSequence = new FailureType('TRANSACTION_DELETE_FAILED_OUT_OF_SEQUENCE', 'Deleting any transaction, except for the most recent, will cause transaction history to be re-written. Please confirm your intent to re-write transaction history (which could take some time and alter the historical results for this position).');
+	const transactionDeleteUnsupported = new FailureType('TRANSACTION_DELETE_UNSUPPORTED', 'Unable to delete transaction. This operation is not currently supported (but will be implemented soon).');
 
 	return PortfolioFailureType;
 })();

package/lib/processing/PositionContainer.js

@@ -206,6 +206,21 @@ module.exports = (() => {
 			}
 		}
 
+		/**
+		 * Updates the portfolio data. For example, a portfolio's name might change.
+		 *
+		 * @public
+		 * @param {Object} portfolio
+		 */
+		updatePortfolio(portfolio) {
+			assert.argumentIsRequired(portfolio, 'portfolio', Object);
+			assert.argumentIsRequired(portfolio.portfolio, 'portfolio.portfolio', String);
+
+			this.startTransaction(() => {
+				getPositionItemsForPortfolio(this._items, portfolio.portfolio).forEach(item => item.updatePortfolio(portfolio));
+			});
+		}
+
 		/**
 		 * Removes an existing portfolio, and all of it's positions, from the container. This
 		 * also triggers removal of the portfolio and it's positions from any applicable

package/lib/processing/PositionGroup.js

@@ -463,6 +463,12 @@ module.exports = (() => {
 			});
 		}
 
+		this._disposeStack.push(item.registerPortfolioChangeHandler((portfolio, sender) => {
+			const descriptionSelector = this._definition.descriptionSelector;
+
+			this._description = descriptionSelector(this._items[0]);
+		}));
+
 		this._disposeStack.push(quoteBinding);
 		this._disposeStack.push(newsBinding);
 		this._disposeStack.push(fundamentalBinding);

package/lib/processing/PositionItem.js

@@ -73,6 +73,7 @@ module.exports = (() => {
 			this._quoteChangedEvent = new Event(this);
 			this._newsExistsChangedEvent = new Event(this);
 			this._fundamentalDataChangeEvent = new Event(this);
+			this._portfolioChangedEvent = new Event(this);
 			this._positionItemDisposeEvent = new Event(this);
 		}
 
@@ -146,6 +147,19 @@ module.exports = (() => {
 			return this._currentQuote;
 		}
 
+		updatePortfolio(portfolio) {
+			assert.argumentIsRequired(portfolio, 'portfolio', Object);
+			assert.argumentIsRequired(portfolio.portfolio, 'portfolio.portfolio', String);
+
+			if (portfolio.portfolio !== this._portfolio.portfolio) {
+				throw new Error('Unable to move position into new portfolio.');
+			}
+
+			if (this._portfolio !== portfolio) {
+				this._portfolioChangedEvent.fire(this._portfolio = portfolio);
+			}
+		}
+
 		/**
 		 * Sets the current quote -- causing position-level data (e.g. market value) to
 		 * be recalculated.
@@ -241,6 +255,17 @@ module.exports = (() => {
 			return this._newsExistsChangedEvent.register(handler);
 		}
 
+		/**
+		 * Registers an observer changes to portfolio metadata.
+		 *
+		 * @public
+		 * @param {Function} handler
+		 * @returns {Disposable}
+		 */
+		registerPortfolioChangeHandler(handler) {
+			return this._portfolioChangedEvent.register(handler);
+		}
+
 		/**
 		 * Registers an observer for object disposal.
 		 *
@@ -258,6 +283,7 @@ module.exports = (() => {
 			this._quoteChangedEvent.clear();
 			this._newsExistsChangedEvent.clear();
 			this._fundamentalDataChangeEvent.clear();
+			this._portfolioChangedEvent.clear();
 			this._positionItemDisposeEvent.clear();
 		}
 

package/lib/serialization/TransactionSchema.js

@@ -254,6 +254,7 @@ module.exports = (() => {
 		.withField('price', DataType.DECIMAL)
 		.withField('quantity', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -265,6 +266,7 @@ module.exports = (() => {
 		.withField('price', DataType.DECIMAL)
 		.withField('quantity', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -276,6 +278,7 @@ module.exports = (() => {
 		.withField('price', DataType.DECIMAL)
 		.withField('quantity', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -292,6 +295,7 @@ module.exports = (() => {
 		.withField('price', DataType.DECIMAL)
 		.withField('quantity', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -303,6 +307,7 @@ module.exports = (() => {
 		.withField('rate', DataType.DECIMAL)
 		.withField('effective', DataType.DAY)
 		.withField('fee', DataType.DECIMAL, true)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -315,6 +320,7 @@ module.exports = (() => {
 		.withField('effective', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -327,6 +333,7 @@ module.exports = (() => {
 		.withField('effective', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -338,6 +345,7 @@ module.exports = (() => {
 		.withField('rate', DataType.DECIMAL)
 		.withField('effective', DataType.DAY)
 		.withField('fee', DataType.DECIMAL, true)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -350,6 +358,7 @@ module.exports = (() => {
 		.withField('effective', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -362,6 +371,7 @@ module.exports = (() => {
 		.withField('denominator', DataType.DECIMAL)
 		.withField('effective', DataType.DAY)
 		.withField('fee', DataType.DECIMAL, true)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -371,6 +381,7 @@ module.exports = (() => {
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('fee', DataType.DECIMAL)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -381,6 +392,7 @@ module.exports = (() => {
 		.withField('date', DataType.DAY)
 		.withField('fee', DataType.DECIMAL)
 		.withField('price', DataType.DECIMAL)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -393,6 +405,7 @@ module.exports = (() => {
 		.withField('date', DataType.DAY)
 		.withField('amount', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -403,6 +416,7 @@ module.exports = (() => {
 		.withField('date', DataType.DAY)
 		.withField('amount', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -413,6 +427,7 @@ module.exports = (() => {
 		.withField('date', DataType.DAY)
 		.withField('amount', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -423,6 +438,7 @@ module.exports = (() => {
 		.withField('date', DataType.DAY)
 		.withField('amount', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -433,6 +449,7 @@ module.exports = (() => {
 		.withField('date', DataType.DAY)
 		.withField('value', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -443,6 +460,7 @@ module.exports = (() => {
 		.withField('date', DataType.DAY)
 		.withField('income', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
+		.withField('force', DataType.BOOLEAN, true)
 		.schema
 	);
 

package/package.json

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

package/test/SpecRunner.js

@@ -922,6 +922,21 @@ module.exports = (() => {
 			}
 		}
 
+		/**
+		 * Updates the portfolio data. For example, a portfolio's name might change.
+		 *
+		 * @public
+		 * @param {Object} portfolio
+		 */
+		updatePortfolio(portfolio) {
+			assert.argumentIsRequired(portfolio, 'portfolio', Object);
+			assert.argumentIsRequired(portfolio.portfolio, 'portfolio.portfolio', String);
+
+			this.startTransaction(() => {
+				getPositionItemsForPortfolio(this._items, portfolio.portfolio).forEach(item => item.updatePortfolio(portfolio));
+			});
+		}
+
 		/**
 		 * Removes an existing portfolio, and all of it's positions, from the container. This
 		 * also triggers removal of the portfolio and it's positions from any applicable
@@ -2042,6 +2057,12 @@ module.exports = (() => {
 			});
 		}
 
+		this._disposeStack.push(item.registerPortfolioChangeHandler((portfolio, sender) => {
+			const descriptionSelector = this._definition.descriptionSelector;
+
+			this._description = descriptionSelector(this._items[0]);
+		}));
+
 		this._disposeStack.push(quoteBinding);
 		this._disposeStack.push(newsBinding);
 		this._disposeStack.push(fundamentalBinding);
@@ -2411,6 +2432,7 @@ module.exports = (() => {
 			this._quoteChangedEvent = new Event(this);
 			this._newsExistsChangedEvent = new Event(this);
 			this._fundamentalDataChangeEvent = new Event(this);
+			this._portfolioChangedEvent = new Event(this);
 			this._positionItemDisposeEvent = new Event(this);
 		}
 
@@ -2484,6 +2506,19 @@ module.exports = (() => {
 			return this._currentQuote;
 		}
 
+		updatePortfolio(portfolio) {
+			assert.argumentIsRequired(portfolio, 'portfolio', Object);
+			assert.argumentIsRequired(portfolio.portfolio, 'portfolio.portfolio', String);
+
+			if (portfolio.portfolio !== this._portfolio.portfolio) {
+				throw new Error('Unable to move position into new portfolio.');
+			}
+
+			if (this._portfolio !== portfolio) {
+				this._portfolioChangedEvent.fire(this._portfolio = portfolio);
+			}
+		}
+
 		/**
 		 * Sets the current quote -- causing position-level data (e.g. market value) to
 		 * be recalculated.
@@ -2579,6 +2614,17 @@ module.exports = (() => {
 			return this._newsExistsChangedEvent.register(handler);
 		}
 
+		/**
+		 * Registers an observer changes to portfolio metadata.
+		 *
+		 * @public
+		 * @param {Function} handler
+		 * @returns {Disposable}
+		 */
+		registerPortfolioChangeHandler(handler) {
+			return this._portfolioChangedEvent.register(handler);
+		}
+
 		/**
 		 * Registers an observer for object disposal.
 		 *
@@ -2596,6 +2642,7 @@ module.exports = (() => {
 			this._quoteChangedEvent.clear();
 			this._newsExistsChangedEvent.clear();
 			this._fundamentalDataChangeEvent.clear();
+			this._portfolioChangedEvent.clear();
 			this._positionItemDisposeEvent.clear();
 		}