@barchart/portfolio-client-js 1.2.19 → 1.2.20

package/lib/gateway/PortfolioGateway.js

@@ -2,7 +2,9 @@ const assert = require('@barchart/common-js/lang/assert'),
 	Day = require('@barchart/common-js/lang/Day'),
 	Disposable = require('@barchart/common-js/lang/Disposable'),
 	Enum = require('@barchart/common-js/lang/Enum'),
-	is = require('@barchart/common-js/lang/is');
+	is = require('@barchart/common-js/lang/is'),
+	promise = require('@barchart/common-js/lang/promise'),
+	Scheduler = require('@barchart/common-js/timing/Sceduler');
 
 const TransactionType = require('@barchart/portfolio-api-common/lib/data/TransactionType');
 
@@ -57,6 +59,8 @@ module.exports = (() => {
 				requestInterceptorToUse = RequestInterceptor.EMPTY;
 			}
 
+			this._positionObservers = { };
+
 			this._readPortfoliosEndpoint = EndpointBuilder.for('read-portfolios', 'read portfolios')
 				.withVerb(VerbType.GET)
 				.withProtocol(protocolType)
@@ -330,7 +334,7 @@ module.exports = (() => {
 		 * Returns a description of the environment (e.g. development or production).
 		 *
 		 * @public
-		 * @return {*}
+		 * @returns {*}
 		 */
 		get environment() {
 			return this._environment;
@@ -368,7 +372,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {String=} portfolio
-		 * @return {Promise.<Portfolio[]>}
+		 * @returns {Promise.<Portfolio[]>}
 		 */
 		readPortfolios(portfolio) {
 			return Promise.resolve()
@@ -386,7 +390,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Object} portfolio
-		 * @return {Promise.<Portfolio>}
+		 * @returns {Promise.<Portfolio>}
 		 */
 		createPortfolio(portfolio) {
 			return Promise.resolve()
@@ -404,7 +408,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Object} portfolio
-		 * @return {Promise.<Portfolio>}
+		 * @returns {Promise.<Portfolio>}
 		 */
 		importPortfolio(portfolio, transactions) {
 			return Promise.resolve()
@@ -423,7 +427,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Object} portfolio
-		 * @return {Promise.<Portfolio>}
+		 * @returns {Promise.<Portfolio>}
 		 */
 		updatePortfolio(portfolio) {
 			return Promise.resolve()
@@ -441,7 +445,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {String} portfolio - ID of the portfolio to update
-		 * @return {Promise.<Portfolio>}
+		 * @returns {Promise.<Portfolio>}
 		 */
 		deletePortfolio(portfolio) {
 			return Promise.resolve()
@@ -481,7 +485,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Object} position
-		 * @return {Promise.<Position>}
+		 * @returns {Promise.<Position>}
 		 */
 		updatePosition(position) {
 			return Promise.resolve()
@@ -494,6 +498,45 @@ module.exports = (() => {
 				});
 		}
 
+		/**
+		 * Returns a promise which resolves as soon as the position's lock status
+		 * changes to false.
+		 * 
+		 * @public
+		 * @param {String} portfolio
+		 * @param {String} position
+		 * @returns {Promise}
+		 */
+		observePosition(portfolio, position) {
+			return promise.build((resolveCallback, rejectCallback) => {
+				assert.argumentIsOptional(portfolio, 'portfolio', String);
+				assert.argumentIsOptional(position, 'position', String);
+
+				const scheduleCheck = (delay) => {
+					setTimeout(() => {
+						return 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) && is.boolean(p.system.locked)) {
+										scheduleCheck(5000);
+									} else {
+										resolveCallback(p);
+									}
+								} else {
+									resolveCallback(null);
+								}
+							}).catch((e) => {
+								scheduleCheck(delay + 5000);
+							});
+					}, delay);
+				};
+
+				scheduleCheck(2500);
+			});
+		}
+
 		/**
 		 * Retrieves positions for a user, a user's portfolio, or a single position.
 		 *

package/lib/index.js

@@ -7,6 +7,6 @@ module.exports = (() => {
 	return {
 		JwtGateway: JwtGateway,
 		PortfolioGateway: PortfolioGateway,
-		version: '1.2.19'
+		version: '1.2.20'
 	};
 })();

package/package.json

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