@barchart/portfolio-client-js 5.0.1 → 5.1.0

package/.releases/5.0.1.md

@@ -0,0 +1,3 @@
+**Other**
+
+* Correct internal implementation of SDK to address breaking changes to remote API.

package/.releases/5.1.0.md

@@ -0,0 +1,8 @@
+**New Features**
+
+* Added `PortfolioGateway.switchTransaction` function, allowing the reinvestment choice for a single dividend or distribution to be changed.
+* Added `readPositionValuationsAvailability` method.
+
+**Other**
+
+* Removed legacy `observeValuationsForPortfolio` and `observeValuationsForPositions` methods.

package/lib/gateway/PortfolioGateway.js

@@ -231,6 +231,24 @@ module.exports = (() => {
 				.withErrorInterceptor(ErrorInterceptor.GENERAL)
 				.endpoint;
 
+			this._readPositionValuationsAvailabilityEndpoint = EndpointBuilder.for('read-position-valuations-availability', 'read position valuations availability')
+				.withVerb(VerbType.GET)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
+						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
+						.withLiteralParameter('values', 'values')
+						.withLiteralParameter('availability', 'availability');
+				})
+				.withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE)
+				.withRequestInterceptor(requestInterceptor)
+				.withResponseInterceptor(responseInterceptorForDeserialization)
+				.withErrorInterceptor(ErrorInterceptor.GENERAL)
+				.endpoint;
+
 			this._readPositionValuationsEndpoint = EndpointBuilder.for('read-position-valuations', 'read position valuations')
 				.withVerb(VerbType.GET)
 				.withProtocol(protocolType)
@@ -332,6 +350,29 @@ module.exports = (() => {
 				.withErrorInterceptor(ErrorInterceptor.GENERAL)
 				.endpoint;
 
+			this._switchTransactionEndpoint = EndpointBuilder.for('switch-transaction', 'switch transaction')
+				.withVerb(VerbType.POST)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('portfolios', 'portfolios')
+						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
+						.withLiteralParameter('positions', 'positions')
+						.withVariableParameter('position', 'position', 'position', false)
+						.withLiteralParameter('transactions', 'transactions')
+						.withVariableParameter('sequence', 'sequence', 'sequence', false);
+				})
+				.withQueryBuilder((qb) => {
+					qb.withVariableParameter('switch', 'switch', 'switch', false, x => x.code);
+				})
+				.withBody()
+				.withRequestInterceptor(requestInterceptor)
+				.withResponseInterceptor(responseInterceptorForPositionMutateDeserialization)
+				.withErrorInterceptor(ErrorInterceptor.GENERAL)
+				.endpoint;
+
 			this._deleteTransactionEndpoint = EndpointBuilder.for('delete-transaction', 'delete transaction')
 				.withVerb(VerbType.DELETE)
 				.withProtocol(protocolType)
@@ -434,7 +475,7 @@ module.exports = (() => {
 				})
 				.withRequestInterceptor(requestInterceptor)
 				.withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE)
-				.withResponseInterceptor(responseInterceptorForVersion)
+				.withResponseInterceptor(responseInterceptorForDeserialization)
 				.withErrorInterceptor(ErrorInterceptor.GENERAL)
 				.endpoint;
 
@@ -762,6 +803,28 @@ module.exports = (() => {
 				});
 		}
 
+		/**
+		 * Retrieves values availability of the portfolio and it's positions.
+		 *
+		 * @public
+		 * @param {String} portfolio
+		 * @return {Promise<ValuationsAvailabilityResult>}
+		 */
+		readPositionValuationsAvailability(portfolio) {
+			return Promise.resolve()
+				.then(() => {
+					checkStart.call(this);
+
+					assert.argumentIsRequired(portfolio, 'portfolio', String);
+
+					const payload = { };
+
+					payload.portfolio = portfolio;
+
+					return Gateway.invoke(this._readPositionValuationsAvailabilityEndpoint, payload);
+				});
+		}
+
 		/**
 		 * Retrieves end-of-day position valuations for the entire portfolio or single position.
 		 *
@@ -803,108 +866,6 @@ module.exports = (() => {
 				});
 		}
 
-		/**
-		 * Returns an array with two items. The fist item is a promise which resolves
-		 * as soon as a position's end-of-day valuation calculations have finished.
-		 * The seconds is a function which cancels the observation when invoked.
-		 *
-		 * @public
-		 * @param {String} portfolio
-		 * @param {String} position
-		 * @returns {Array}
-		 */
-		observeValuationsForPosition(portfolio, position) {
-			let disposed = false;
-
-			const cancelFunction = () => {
-				disposed = true;
-			};
-
-			const completionPromise = promise.build((resolveCallback) => {
-				assert.argumentIsRequired(portfolio, 'portfolio', String);
-				assert.argumentIsRequired(position, 'position', String);
-
-				const scheduleCheck = (delay) => {
-					if (disposed) {
-						return;
-					}
-
-					setTimeout(() => {
-						Gateway.invoke(this._readPositionsEndpoint, { portfolio: portfolio, position: position, includePreviousPrice: false })
-							.then((positions) => {
-								const p = positions.find(p => p.position === position);
-
-								if (is.object(p)) {
-									if (is.object(p.system) && is.object(p.system.calculate) && is.number(p.system.calculate.processors) && p.system.calculate.processors > 0) {
-										scheduleCheck(delay + 1000);
-									} else {
-										resolveCallback(p);
-									}
-								} else {
-									resolveCallback(null);
-								}
-							}).catch((e) => {
-								scheduleCheck(delay + 5000);
-							});
-					}, delay);
-				};
-
-				scheduleCheck(2500);
-			});
-
-			return [ completionPromise, cancelFunction ];
-		}
-
-		/**
-		 * Returns an array with two items. The fist item is a promise which resolves
-		 * as soon as a portfolio's end-of-day valuation calculations have finished.
-		 * The seconds is a function which cancels the observation when invoked.
-		 *
-		 * @public
-		 * @param {String} portfolio
-		 * @returns {Array}
-		 */
-		observeValuationsForPortfolio(portfolio) {
-			let disposed = false;
-
-			const cancelFunction = () => {
-				disposed = true;
-			};
-
-			const completionPromise = promise.build((resolveCallback) => {
-				assert.argumentIsRequired(portfolio, 'portfolio', String);
-
-				const scheduleCheck = (delay) => {
-					if (disposed) {
-						return;
-					}
-
-					setTimeout(() => {
-						Gateway.invoke(this._readPortfoliosEndpoint, { portfolio: portfolio })
-							.then((portfolios) => {
-								const p = portfolios[0];
-
-								if (is.object(p)) {
-									if (is.object(p.system) && is.object(p.system.calculate) && is.number(p.system.calculate.processors) && p.system.calculate.processors > 0) {
-										scheduleCheck(delay + 1000);
-									} else {
-										resolveCallback(p);
-									}
-								} else {
-									resolveCallback(null);
-								}
-							}).catch((e) => {
-							scheduleCheck(delay + 5000);
-						});
-					}, delay);
-				};
-
-				scheduleCheck(2500);
-			});
-
-			return [ completionPromise, cancelFunction ];
-		}
-
 		/**
 		 * Deletes a position.
 		 *
@@ -974,6 +935,34 @@ module.exports = (() => {
 				});
 		}
 
+		/**
+		 * Switch the reinvestment strategy for a single transaction.
+		 *
+		 * @public
+		 * @param {Object} transaction
+		 * @param {TransactionType} type
+		 * @returns {Promise<TransactionMutateResult>}
+		 */
+		switchTransaction(transaction, type) {
+			return Promise.resolve()
+				.then(() => {
+					checkStart.call(this);
+
+					assert.argumentIsRequired(transaction, 'transaction', Object);
+					assert.argumentIsRequired(transaction.portfolio, 'transaction.portfolio', String);
+					assert.argumentIsRequired(transaction.position, 'transaction.position', String);
+					assert.argumentIsRequired(transaction.sequence, 'transaction.sequence', Number);
+					assert.argumentIsRequired(type, type, TransactionType, 'TransactionType');
+
+					const schema = getTransactionSchema(transaction);
+					const payload = schema.schema.format(transaction);
+
+					payload.switch = type;
+
+					return Gateway.invoke(this._switchTransactionEndpoint, payload);
+				});
+		}
+
 		/**
 		 * Deletes a transaction.
 		 *
@@ -1456,7 +1445,7 @@ module.exports = (() => {
 		}
 	});
 
-	const responseInterceptorForVersion = ResponseInterceptor.fromDelegate((response, ignored) => {
+	const responseInterceptorForDeserialization = ResponseInterceptor.fromDelegate((response, ignored) => {
 		try {
 			return JSON.parse(response.data);
 		} catch (e) {
@@ -1524,5 +1513,14 @@ module.exports = (() => {
 	 * @property {Boolean} replaced - If true, the position (and position summaries) need to be replaced.
 	 */
 
+	/**
+	 * The result of valuations availability.
+	 *
+	 * @typedef ValuationsAvailabilityResult
+	 * @type {Object}
+	 * @property {Boolean} available - If true, portfolio valuations are up-to-date and ready.
+	 * @property {String[]} positions - Array of position id's that are in recalculation state.
+	 */
+
  	return PortfolioGateway;
 })();

package/lib/index.js

@@ -7,6 +7,6 @@ module.exports = (() => {
 	return {
 		JwtProvider: JwtProvider,
 		PortfolioGateway: PortfolioGateway,
-		version: '5.0.1'
+		version: '5.1.0'
 	};
 })();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-client-js",
-  "version": "5.0.1",
+  "version": "5.1.0",
   "description": "JavaScript library for interfacing with Barchart's Portfolio API",
   "author": {
     "name": "Bryan Ingle",

package/.releases/5.0.0.md

@@ -1,3 +0,0 @@
-**Breaking Changes**
-
-* The HTTP path structure of the remote service changed. No fucntional changes were made to the SDK.