@barchart/portfolio-api-common 1.2.77 → 1.2.81

package/lib/processing/PositionContainer.js

@@ -6,6 +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/is'),
 	Rate = require('@barchart/common-js/lang/Rate'),
 	Tree = require('@barchart/common-js/collections/Tree');
 
@@ -370,6 +371,12 @@ 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);
@@ -378,9 +385,7 @@ module.exports = (() => {
 				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(PositionItem.getIsLocked(position));
 				}
 			}
 		}

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 = PositionItem.getIsLocked(position);
 
 			calculateStaticData(this);
 			calculatePriceData(this, null);
@@ -337,6 +337,19 @@ module.exports = (() => {
 			this._positionItemDisposeEvent.clear();
 		}
 
+		/**
+		 * Given a position object, returns its lock (for editing) status.
+		 *
+		 * @public
+		 * @param {Object{}} position
+		 * @returns {Boolean}
+		 */
+		static getIsLocked(position) {
+			assert.argumentIsRequired(position, 'position');
+
+			return is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
+		}
+
 		toString() {
 			return '[PositionItem]';
 		}

package/package.json

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

package/test/SpecRunner.js

@@ -1385,6 +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/is'),
 	Rate = require('@barchart/common-js/lang/Rate'),
 	Tree = require('@barchart/common-js/collections/Tree');
 
@@ -1749,6 +1750,12 @@ 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);
@@ -1757,9 +1764,7 @@ module.exports = (() => {
 				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(PositionItem.getIsLocked(position));
 				}
 			}
 		}
@@ -2335,7 +2340,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'),
@@ -3277,7 +3282,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 = PositionItem.getIsLocked(position);
 
 			calculateStaticData(this);
 			calculatePriceData(this, null);
@@ -3544,6 +3549,19 @@ module.exports = (() => {
 			this._positionItemDisposeEvent.clear();
 		}
 
+		/**
+		 * Given a position object, returns its lock (for editing) status.
+		 *
+		 * @public
+		 * @param {Object{}} position
+		 * @returns {Boolean}
+		 */
+		static getIsLocked(position) {
+			assert.argumentIsRequired(position, 'position');
+
+			return is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
+		}
+
 		toString() {
 			return '[PositionItem]';
 		}