@barchart/portfolio-client-js 3.3.1 → 4.0.0

package/.releases/3.0.0.md

@@ -1,6 +1,5 @@
 **Breaking Changes**
 
-
 * The mechanism for passing JSON Web Tokens to the ```PortfolioGateway``` has changed. Consumers are now required to provide ```JwtProvider``` instances instead of a ```RequestInterceptor``` instances. Here are the specifics:
   * The ```RequestInterceptor``` argument was replaced with a ```JwtProvider``` argument on static factory functions (e.g. ```PortfolioGateway.forProduction```).
   * The ```RequestInterceptor``` argument was removed from the ```PortfolioGateway``` constructor.

package/.releases/3.3.0.md

@@ -1,3 +1,3 @@
 **New Features**
 
-* Added ```product``` to the ```PortfolioGateway```.
+* Added optional ```product``` argument to the ```PortfolioGateway``` constructor.

package/.releases/3.4.0.md

@@ -0,0 +1,3 @@
+**New Features**
+
+* Added ```PortfolioGateway.readMarketValue``` function.

package/.releases/3.4.1.md

@@ -0,0 +1,3 @@
+**Bug Fix**
+
+* Fixed ```PortfolioGateway.readMarketValue``` function.

package/.releases/4.0.0.md

@@ -0,0 +1,6 @@
+**Breaking Changes**
+
+* Renamed ```PortfolioGateway.readPositionsValues``` function to ```PortfolioGateway.readPositionValuations```.
+* Renamed ```PortfolioGateway.readMarketValue``` function to ```PortfolioGateway.queryPositionValuations```.
+* Renamed ```PortfolioGateway.observePositionCalculating``` function to ```PortfolioGateway.observeValuationsForPosition```.
+* Renamed ```PortfolioGateway.observePortfolioCalculating``` function to ```PortfolioGateway.observeValuationsForPortfolio```.

package/lib/gateway/PortfolioGateway.js

@@ -44,7 +44,7 @@ module.exports = (() => {
 	 * @param {String} host - The hostname of the Portfolio web service.
 	 * @param {Number} port - The TCP port number of the Portfolio web service.
 	 * @param {String} environment - A description of the environment we're connecting to.
-	 * @param {String=} product - A product code which uses the gateway.
+	 * @param {String=} product - A code for the product which is using the gateway.
 	 * @extends {Disposable}
 	 */
 	class PortfolioGateway extends Disposable {
@@ -231,7 +231,7 @@ module.exports = (() => {
 				.withErrorInterceptor(ErrorInterceptor.GENERAL)
 				.endpoint;
 
-			this._readPositionsValuesEndpoint = EndpointBuilder.for('read-positions-values', 'read positions values')
+			this._readPositionValuationsEndpoint = EndpointBuilder.for('read-position-valuations', 'read position valuations')
 				.withVerb(VerbType.GET)
 				.withProtocol(protocolType)
 				.withHost(host)
@@ -250,6 +250,23 @@ module.exports = (() => {
 				.withErrorInterceptor(ErrorInterceptor.GENERAL)
 				.endpoint;
 
+			this._queryPositionValuationsEndpoint = EndpointBuilder.for('query-position-valuations', 'query position valuations')
+				.withVerb(VerbType.GET)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('values', 'values');
+				})
+				.withQueryBuilder((qb) => {
+					qb.withVariableParameter('symbol', 'symbol', 'symbol', false);
+				})
+				.withRequestInterceptor(requestInterceptor)
+				.withResponseInterceptor(ResponseInterceptor.DATA)
+				.withErrorInterceptor(ErrorInterceptor.GENERAL)
+				.endpoint;
+
 			this._readTransactionsEndpoint = EndpointBuilder.for('read-transactions', 'read transactions')
 				.withVerb(VerbType.GET)
 				.withProtocol(protocolType)
@@ -677,104 +694,6 @@ module.exports = (() => {
 			});
 		}
 
-		/**
-		 * Returns a promise which resolves as soon as the position's calculating finishes.
-		 *
-		 * @public
-		 * @param {String} portfolio
-		 * @param {String} position
-		 * @returns {Array}
-		 */
-		observePositionCalculating(portfolio, position) {
-			let disposed = false;
-
-			const query = 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);
-			});
-
-			const dispose = () => {
-				disposed = true;
-			};
-
-			return [ query, dispose ];
-		}
-
-		/**
-		 * Returns a promise which resolves as soon as the portfolio calculating finishes.
-		 *
-		 * @public
-		 * @param {String} portfolio
-		 * @returns {Array}
-		 */
-		observePortfolioCalculating(portfolio) {
-			let disposed = false;
-
-			const query = 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);
-			});
-
-			const dispose = () => {
-				disposed = true;
-			};
-
-			return [ query, dispose ];
-		}
-
 		/**
 		 * Retrieves positions for a user, a user's portfolio, or a single position.
 		 *
@@ -847,14 +766,14 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Retrieves positions values for the entire portfolio or single position.
+		 * Retrieves end-of-day position valuations for the entire portfolio or single position.
 		 *
 		 * @public
 		 * @param {String} portfolio
 		 * @param {String=} position
 		 * @returns {Promise<Object[]>}
 		 */
-		readPositionsValues(portfolio, position) {
+		readPositionValuations(portfolio, position) {
 			return Promise.resolve()
 				.then(() => {
 					checkStart.call(this);
@@ -867,10 +786,128 @@ module.exports = (() => {
 					payload.portfolio = portfolio;
 					payload.position = position || '*';
 
-					return Gateway.invoke(this._readPositionsValuesEndpoint, payload);
+					return Gateway.invoke(this._readPositionValuationsEndpoint, payload);
+				});
+		}
+
+		/**
+		 * Queries end-of-day position valuations across all user portfolios.
+		 *
+		 * @public
+		 * @param {String} symbol
+		 * @return {Promise<Object[]>}
+		 */
+		queryPositionValuations(symbol) {
+			return Promise.resolve()
+				.then(() => {
+					assert.argumentIsRequired(symbol, 'symbol', String);
+
+					return Gateway.invoke(this._queryPositionValuationsEndpoint, { symbol });
 				});
 		}
 
+		/**
+		 * 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.
 		 *

package/lib/index.js

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

package/package.json

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