@barchart/portfolio-api-common 1.2.78 → 1.2.82

package/lib/processing/PositionContainer.js

@@ -6,7 +6,7 @@ const array = require('@barchart/common-js/lang/array'),
 	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/array'),
+	is = require('@barchart/common-js/lang/is'),
 	Rate = require('@barchart/common-js/lang/Rate'),
 	Tree = require('@barchart/common-js/collections/Tree');
 
@@ -371,21 +371,39 @@ module.exports = (() => {
 			return array.unique(symbols);
 		}
 
+		/**
+		 * Causes a position to be flagged as locked (for editing).
+		 *
+		 * @public
+		 * @param {Object} position
+		 */
 		setPositionLock(position) {
 			if (position) {
 				assert.argumentIsRequired(position, 'position', Object);
 				assert.argumentIsRequired(position.position, 'position.position', String);
 
-				const item = this._items.find((i) => i.position.position === position.position);
+				const item = this._items.find(i => i.position.position === position.position);
 
 				if (item) {
-					const locked = is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
-
-					item.setPositionLock(locked);
+					item.setPositionLock(position);
 				}
 			}
 		}
 
+		/**
+		 * Returns all positions which are currently locked (for editing).
+		 *
+		 * @public
+		 * @returns {Array.<Object>}
+		 */
+		getLockedPositions() {
+			return this._items.filter((i) => {
+				return i.data.locked;
+			}).map((i) => {
+				return i.position;
+			});
+		}
+
 		/**
 		 * Performs a batch update of both position quotes and forex quotes,
 		 * triggering updates to position(s) and data aggregation(s).

package/lib/processing/PositionItem.js

@@ -70,7 +70,7 @@ module.exports = (() => {
 
 			this._data.newsExists = false;
 			this._data.fundamental = { };
-			this._data.locked = is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
+			this._data.locked = getIsLocked(position);
 
 			calculateStaticData(this);
 			calculatePriceData(this, null);
@@ -242,18 +242,20 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Sets position lock status.
+		 * Sets a position's lock status.
 		 *
 		 * @public
-		 * @param {Boolean} value
+		 * @param {Object} position
 		 */
-		setPositionLock(value) {
-			assert.argumentIsRequired(value, 'value', Boolean);
+		setPositionLock(position) {
+			assert.argumentIsRequired(position, 'position');
 
 			if (this.getIsDisposed()) {
 				return;
 			}
 
+			const value = getIsLocked(position);
+
 			if (this._data.locked !== value) {
 				this._lockChangedEvent.fire(this._data.locked = value);
 			}
@@ -525,5 +527,11 @@ module.exports = (() => {
 		return summary;
 	}
 
+	function getIsLocked(position) {
+		assert.argumentIsRequired(position, 'position');
+
+		return is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
+	}
+
 	return PositionItem;
 })();

package/package.json

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

package/test/SpecRunner.js

@@ -1385,7 +1385,7 @@ const array = require('@barchart/common-js/lang/array'),
 	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/array'),
+	is = require('@barchart/common-js/lang/is'),
 	Rate = require('@barchart/common-js/lang/Rate'),
 	Tree = require('@barchart/common-js/collections/Tree');
 
@@ -1750,21 +1750,39 @@ module.exports = (() => {
 			return array.unique(symbols);
 		}
 
+		/**
+		 * Causes a position to be flagged as locked (for editing).
+		 *
+		 * @public
+		 * @param {Object} position
+		 */
 		setPositionLock(position) {
 			if (position) {
 				assert.argumentIsRequired(position, 'position', Object);
 				assert.argumentIsRequired(position.position, 'position.position', String);
 
-				const item = this._items.find((i) => i.position.position === position.position);
+				const item = this._items.find(i => i.position.position === position.position);
 
 				if (item) {
-					const locked = is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
-
-					item.setPositionLock(locked);
+					item.setPositionLock(position);
 				}
 			}
 		}
 
+		/**
+		 * Returns all positions which are currently locked (for editing).
+		 *
+		 * @public
+		 * @returns {Array.<Object>}
+		 */
+		getLockedPositions() {
+			return this._items.filter((i) => {
+				return i.data.locked;
+			}).map((i) => {
+				return i.position;
+			});
+		}
+
 		/**
 		 * Performs a batch update of both position quotes and forex quotes,
 		 * triggering updates to position(s) and data aggregation(s).
@@ -2336,7 +2354,7 @@ module.exports = (() => {
 	return PositionContainer;
 })();
 
-},{"./../data/PositionSummaryFrame":3,"./PositionGroup":7,"./PositionItem":8,"./definitions/PositionLevelDefinition":9,"./definitions/PositionLevelType":10,"./definitions/PositionTreeDefinition":11,"@barchart/common-js/collections/Tree":15,"@barchart/common-js/collections/sorting/ComparatorBuilder":16,"@barchart/common-js/collections/sorting/comparators":17,"@barchart/common-js/collections/specialized/DisposableStack":18,"@barchart/common-js/lang/Currency":20,"@barchart/common-js/lang/Decimal":22,"@barchart/common-js/lang/Rate":26,"@barchart/common-js/lang/array":28,"@barchart/common-js/lang/assert":29,"@barchart/common-js/messaging/Event":35}],7:[function(require,module,exports){
+},{"./../data/PositionSummaryFrame":3,"./PositionGroup":7,"./PositionItem":8,"./definitions/PositionLevelDefinition":9,"./definitions/PositionLevelType":10,"./definitions/PositionTreeDefinition":11,"@barchart/common-js/collections/Tree":15,"@barchart/common-js/collections/sorting/ComparatorBuilder":16,"@barchart/common-js/collections/sorting/comparators":17,"@barchart/common-js/collections/specialized/DisposableStack":18,"@barchart/common-js/lang/Currency":20,"@barchart/common-js/lang/Decimal":22,"@barchart/common-js/lang/Rate":26,"@barchart/common-js/lang/array":28,"@barchart/common-js/lang/assert":29,"@barchart/common-js/lang/is":33,"@barchart/common-js/messaging/Event":35}],7:[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'),
@@ -3278,7 +3296,7 @@ module.exports = (() => {
 
 			this._data.newsExists = false;
 			this._data.fundamental = { };
-			this._data.locked = is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
+			this._data.locked = getIsLocked(position);
 
 			calculateStaticData(this);
 			calculatePriceData(this, null);
@@ -3450,18 +3468,20 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Sets position lock status.
+		 * Sets a position's lock status.
 		 *
 		 * @public
-		 * @param {Boolean} value
+		 * @param {Object} position
 		 */
-		setPositionLock(value) {
-			assert.argumentIsRequired(value, 'value', Boolean);
+		setPositionLock(position) {
+			assert.argumentIsRequired(position, 'position');
 
 			if (this.getIsDisposed()) {
 				return;
 			}
 
+			const value = getIsLocked(position);
+
 			if (this._data.locked !== value) {
 				this._lockChangedEvent.fire(this._data.locked = value);
 			}
@@ -3733,6 +3753,12 @@ module.exports = (() => {
 		return summary;
 	}
 
+	function getIsLocked(position) {
+		assert.argumentIsRequired(position, 'position');
+
+		return is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
+	}
+
 	return PositionItem;
 })();