@barchart/portfolio-api-common 1.2.71 → 1.2.75

package/lib/api/failures/PortfolioFailureType.js

@@ -230,7 +230,7 @@ module.exports = (() => {
 	const transactionCreateFailedInvalidInitialType = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_INITIAL_TYPE', 'Unable to process operation because the first transaction would to be a {U|transactionType.description}, which is not allowed -- since {U|transactionType.description} transactions cannot open a position.');
 	const transactionCreateFailedTypeReserved = new FailureType('TRANSACTION_CREATE_FAILED_TYPE_RESERVED', 'Unable to create {U|type.description} transaction, this type of transaction is managed by the system.');
 	const transactionCreateFailedReinvestPriceUnavailable = new FailureType('TRANSACTION_CREATE_FAILED_REINVEST_PRICE_UNAVAILABLE', 'Unable to create transaction, a dividend was paid on {L|day}; however no historical price is available for this day. To successfully create this transaction, please turn off dividend reinvestment for this position.');
-	const transactionCreateFailedPositionLocked = new FailureType('TRANSACTION_CREATE_FAILED_POSITION_LOCKED', 'Unable to create transaction, are being recalculated for this position (or the linked cash position). Please re-enter the transaction in a minute or two.');
+	const transactionCreateFailedPositionLocked = new FailureType('TRANSACTION_CREATE_FAILED_POSITION_LOCKED', 'Unable to create transaction, your {L|description} history is being recalculated. Please re-enter this transaction in a minute or two.');
 
 	const transactionDeleteFailedOutOfSequence = new FailureType('TRANSACTION_DELETE_FAILED_OUT_OF_SEQUENCE', 'Deleting any transaction, except for the most recent, will cause transaction history to be re-written. Please confirm your intent to re-write transaction history (which could take some time and alter the historical results for this position).');
 	const transactionDeleteFailedNoTransaction = new FailureType('TRANSACTION_DELETE_FAILED_NO_TRANSACTION', 'Unable to delete transaction. The referenced transaction does not exist.');

package/lib/data/TransactionValidator.js

@@ -104,7 +104,7 @@ module.exports = (() => {
 			assert.argumentIsArray(transactions, 'transactions');
 			assert.argumentIsOptional(strict, 'strict', Boolean);
 
-			return transactions.findIndex((t, i, a) => TransactionValidator.getSortSequence(t) !== (i + 1) || (i !== 0 && t.date.getIsBefore(a[ i - 1 ].date)) || (i !== 0 && is.boolean(strict) && strict && t.date.getIsEqual(a[i - 1].date) && t.type.sequence < a[i - 1].type.sequence));
+			return transactions.findIndex((t, i, a) => t.sequence !== (i + 1) || (i !== 0 && t.date.getIsBefore(a[ i - 1 ].date)) || (i !== 0 && is.boolean(strict) && strict && t.date.getIsEqual(a[i - 1].date) && t.type.sequence < a[i - 1].type.sequence));
 		}
 
 		/**

package/lib/formatters/TransactionFormatter.js

@@ -33,10 +33,9 @@ module.exports = (() => {
 		 * @param {Boolean=} descending
 		 * @returns {Array}
 		 */
-		static format(transactions, positions, mutate, descending) {
+		static format(transactions, positions, descending) {
 			assert.argumentIsArray(transactions, 'transactions');
 			assert.argumentIsArray(positions, 'positions');
-			assert.argumentIsOptional(mutate, 'mutate', Boolean);
 			assert.argumentIsOptional(descending, 'descending', Boolean);
 
 			const instruments = positions.reduce((map, p) => {

package/lib/processing/PositionContainer.js

@@ -370,6 +370,19 @@ module.exports = (() => {
 			return array.unique(symbols);
 		}
 
+		setPositionLock(position) {
+			assert.argumentIsRequired(position, 'position', Object);
+			assert.argumentIsRequired(position.position, 'position.position', String);
+
+			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);
+			}
+		}
+
 		/**
 		 * Performs a batch update of both position quotes and forex quotes,
 		 * triggering updates to position(s) and data aggregation(s).

package/lib/processing/PositionGroup.js

@@ -72,6 +72,7 @@ module.exports = (() => {
 			this._dataFormat.description = this._description;
 			this._dataFormat.hide = false;
 			this._dataFormat.invalid = false;
+			this._dataFormat.locked = false;
 			this._dataFormat.newsExists = false;
 			this._dataFormat.quantity = null;
 			this._dataFormat.basisPrice = null;
@@ -541,12 +542,17 @@ module.exports = (() => {
 		});
 
 		let newsBinding = Disposable.getEmpty();
+		let lockedBinding = Disposable.getEmpty();
 
 		if (this._single) {
 			newsBinding = item.registerNewsExistsChangeHandler((exists) => {
 				this._dataActual.newsExists = exists;
 				this._dataFormat.newsExists = exists;
 			});
+
+			lockedBinding = item.registerLockChangeHandler((locked) => {
+				this._dataFormat.locked = locked;
+			});
 		}
 
 		this._disposeStack.push(item.registerPortfolioChangeHandler((portfolio) => {
@@ -558,14 +564,16 @@ module.exports = (() => {
 			this._dataFormat.description = this._description;
 		}));
 
+		this._disposeStack.push(fundamentalBinding);
 		this._disposeStack.push(quoteBinding);
+		this._disposeStack.push(lockedBinding);
 		this._disposeStack.push(newsBinding);
-		this._disposeStack.push(fundamentalBinding);
 
 		this._disposeStack.push(item.registerPositionItemDisposeHandler(() => {
+			fundamentalBinding.dispose();
 			quoteBinding.dispose();
 			newsBinding.dispose();
-			fundamentalBinding.dispose();
+			lockedBinding.dispose();
 
 			array.remove(this._items, i => i === item);
 			array.remove(this._excludedItems, i => i === item);
@@ -692,6 +700,7 @@ module.exports = (() => {
 			format.basisPrice = formatCurrency(actual.basisPrice, currency);
 
 			format.invalid = definition.type === PositionLevelType.POSITION && item.invalid;
+			format.locked = definition.type === PositionLevelType.POSITION && item.data.locked;
 		}
 
 		const groupItems = group._items;

package/lib/processing/PositionItem.js

@@ -70,13 +70,15 @@ module.exports = (() => {
 
 			this._data.newsExists = false;
 			this._data.fundamental = { };
+			this._data.locked = is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
 
 			calculateStaticData(this);
 			calculatePriceData(this, null);
 
 			this._quoteChangedEvent = new Event(this);
 			this._newsExistsChangedEvent = new Event(this);
-			this._fundamentalDataChangeEvent = new Event(this);
+			this._fundamentalDataChangedEvent = new Event(this);
+			this._lockChangedEvent = new Event(this);
 			this._portfolioChangedEvent = new Event(this);
 			this._positionItemDisposeEvent = new Event(this);
 		}
@@ -204,6 +206,25 @@ module.exports = (() => {
 			}
 		}
 
+		/**
+		 * Sets a flag which indicates if news article(s) exist for the encapsulated position's
+		 * symbol.
+		 *
+		 * @public
+		 * @param {Boolean} value
+		 */
+		setNewsArticleExists(value) {
+			assert.argumentIsRequired(value, 'value', Boolean);
+
+			if (this.getIsDisposed()) {
+				return;
+			}
+
+			if (this._data.newsExists !== value) {
+				this._newsExistsChangedEvent.fire(this._data.newsExists = value);
+			}
+		}
+
 		/**
 		 * Sets fundamental data for the position.
 		 *
@@ -217,25 +238,24 @@ module.exports = (() => {
 				return;
 			}
 
-			this._fundamentalDataChangeEvent.fire(this._data.fundamental = data);
+			this._fundamentalDataChangedEvent.fire(this._data.fundamental = data);
 		}
 
 		/**
-		 * Sets a flag which indicates if news article(s) exist for the encapsulated position's
-		 * symbol.
+		 * Sets position lock status.
 		 *
 		 * @public
 		 * @param {Boolean} value
 		 */
-		setNewsArticleExists(value) {
+		setPositionLock(value) {
 			assert.argumentIsRequired(value, 'value', Boolean);
 
 			if (this.getIsDisposed()) {
 				return;
 			}
 
-			if (this._data.newsExists !== value) {
-				this._newsExistsChangedEvent.fire(this._data.newsExists = value);
+			if (this._data.locked !== value) {
+				this._lockChangedEvent.fire(this._data.locked = value);
 			}
 		}
 
@@ -251,6 +271,17 @@ module.exports = (() => {
 			return this._quoteChangedEvent.register(handler);
 		}
 
+		/**
+		 * Registers an observer changes to the status of news existence.
+		 *
+		 * @public
+		 * @param {Function} handler
+		 * @returns {Disposable}
+		 */
+		registerNewsExistsChangeHandler(handler) {
+			return this._newsExistsChangedEvent.register(handler);
+		}
+
 		/**
 		 * Registers an observer for fundamental data changes.
 		 *
@@ -259,18 +290,18 @@ module.exports = (() => {
 		 * @returns {Disposable}
 		 */
 		registerFundamentalDataChangeHandler(handler) {
-			return this._fundamentalDataChangeEvent.register(handler);
+			return this._fundamentalDataChangedEvent.register(handler);
 		}
 
 		/**
-		 * Registers an observer changes to the status of news existence.
+		 * Registers an observer for position lock changes.
 		 *
 		 * @public
 		 * @param {Function} handler
 		 * @returns {Disposable}
 		 */
-		registerNewsExistsChangeHandler(handler) {
-			return this._newsExistsChangedEvent.register(handler);
+		registerLockChangeHandler(handler) {
+			return this._lockChangedEvent.register(handler);
 		}
 
 		/**
@@ -300,7 +331,8 @@ module.exports = (() => {
 
 			this._quoteChangedEvent.clear();
 			this._newsExistsChangedEvent.clear();
-			this._fundamentalDataChangeEvent.clear();
+			this._fundamentalDataChangedEvent.clear();
+			this._lockChangedEvent.clear();
 			this._portfolioChangedEvent.clear();
 			this._positionItemDisposeEvent.clear();
 		}

package/lib/serialization/PositionSchema.js

@@ -102,6 +102,7 @@ module.exports = (() => {
 		.withField('legacy.portfolio', DataType.STRING, true)
 		.withField('legacy.position', DataType.STRING, true)
 		.withField('system.version', DataType.NUMBER, true)
+		.withField('system.locked', DataType.BOOLEAN, true)
 		.withField('root', DataType.STRING, true)
 		.schema
 	);
@@ -131,6 +132,7 @@ module.exports = (() => {
 		.withField('snapshot.basis', DataType.DECIMAL)
 		.withField('snapshot.income', DataType.DECIMAL)
 		.withField('snapshot.value', DataType.DECIMAL)
+		.withField('system.locked', DataType.BOOLEAN, true)
 		.withField('previous', DataType.NUMBER, true)
 		.schema
 	);

package/package.json

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

package/test/SpecRunner.js

@@ -1187,7 +1187,7 @@ module.exports = (() => {
 			assert.argumentIsArray(transactions, 'transactions');
 			assert.argumentIsOptional(strict, 'strict', Boolean);
 
-			return transactions.findIndex((t, i, a) => TransactionValidator.getSortSequence(t) !== (i + 1) || (i !== 0 && t.date.getIsBefore(a[ i - 1 ].date)) || (i !== 0 && is.boolean(strict) && strict && t.date.getIsEqual(a[i - 1].date) && t.type.sequence < a[i - 1].type.sequence));
+			return transactions.findIndex((t, i, a) => t.sequence !== (i + 1) || (i !== 0 && t.date.getIsBefore(a[ i - 1 ].date)) || (i !== 0 && is.boolean(strict) && strict && t.date.getIsEqual(a[i - 1].date) && t.type.sequence < a[i - 1].type.sequence));
 		}
 
 		/**
@@ -1749,6 +1749,19 @@ module.exports = (() => {
 			return array.unique(symbols);
 		}
 
+		setPositionLock(position) {
+			assert.argumentIsRequired(position, 'position', Object);
+			assert.argumentIsRequired(position.position, 'position.position', String);
+
+			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);
+			}
+		}
+
 		/**
 		 * Performs a batch update of both position quotes and forex quotes,
 		 * triggering updates to position(s) and data aggregation(s).
@@ -2393,6 +2406,7 @@ module.exports = (() => {
 			this._dataFormat.description = this._description;
 			this._dataFormat.hide = false;
 			this._dataFormat.invalid = false;
+			this._dataFormat.locked = false;
 			this._dataFormat.newsExists = false;
 			this._dataFormat.quantity = null;
 			this._dataFormat.basisPrice = null;
@@ -2862,12 +2876,17 @@ module.exports = (() => {
 		});
 
 		let newsBinding = Disposable.getEmpty();
+		let lockedBinding = Disposable.getEmpty();
 
 		if (this._single) {
 			newsBinding = item.registerNewsExistsChangeHandler((exists) => {
 				this._dataActual.newsExists = exists;
 				this._dataFormat.newsExists = exists;
 			});
+
+			lockedBinding = item.registerLockChangeHandler((locked) => {
+				this._dataFormat.locked = locked;
+			});
 		}
 
 		this._disposeStack.push(item.registerPortfolioChangeHandler((portfolio) => {
@@ -2879,14 +2898,16 @@ module.exports = (() => {
 			this._dataFormat.description = this._description;
 		}));
 
+		this._disposeStack.push(fundamentalBinding);
 		this._disposeStack.push(quoteBinding);
+		this._disposeStack.push(lockedBinding);
 		this._disposeStack.push(newsBinding);
-		this._disposeStack.push(fundamentalBinding);
 
 		this._disposeStack.push(item.registerPositionItemDisposeHandler(() => {
+			fundamentalBinding.dispose();
 			quoteBinding.dispose();
 			newsBinding.dispose();
-			fundamentalBinding.dispose();
+			lockedBinding.dispose();
 
 			array.remove(this._items, i => i === item);
 			array.remove(this._excludedItems, i => i === item);
@@ -3013,6 +3034,7 @@ module.exports = (() => {
 			format.basisPrice = formatCurrency(actual.basisPrice, currency);
 
 			format.invalid = definition.type === PositionLevelType.POSITION && item.invalid;
+			format.locked = definition.type === PositionLevelType.POSITION && item.data.locked;
 		}
 
 		const groupItems = group._items;
@@ -3251,13 +3273,15 @@ module.exports = (() => {
 
 			this._data.newsExists = false;
 			this._data.fundamental = { };
+			this._data.locked = is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
 
 			calculateStaticData(this);
 			calculatePriceData(this, null);
 
 			this._quoteChangedEvent = new Event(this);
 			this._newsExistsChangedEvent = new Event(this);
-			this._fundamentalDataChangeEvent = new Event(this);
+			this._fundamentalDataChangedEvent = new Event(this);
+			this._lockChangedEvent = new Event(this);
 			this._portfolioChangedEvent = new Event(this);
 			this._positionItemDisposeEvent = new Event(this);
 		}
@@ -3385,6 +3409,25 @@ module.exports = (() => {
 			}
 		}
 
+		/**
+		 * Sets a flag which indicates if news article(s) exist for the encapsulated position's
+		 * symbol.
+		 *
+		 * @public
+		 * @param {Boolean} value
+		 */
+		setNewsArticleExists(value) {
+			assert.argumentIsRequired(value, 'value', Boolean);
+
+			if (this.getIsDisposed()) {
+				return;
+			}
+
+			if (this._data.newsExists !== value) {
+				this._newsExistsChangedEvent.fire(this._data.newsExists = value);
+			}
+		}
+
 		/**
 		 * Sets fundamental data for the position.
 		 *
@@ -3398,25 +3441,24 @@ module.exports = (() => {
 				return;
 			}
 
-			this._fundamentalDataChangeEvent.fire(this._data.fundamental = data);
+			this._fundamentalDataChangedEvent.fire(this._data.fundamental = data);
 		}
 
 		/**
-		 * Sets a flag which indicates if news article(s) exist for the encapsulated position's
-		 * symbol.
+		 * Sets position lock status.
 		 *
 		 * @public
 		 * @param {Boolean} value
 		 */
-		setNewsArticleExists(value) {
+		setPositionLock(value) {
 			assert.argumentIsRequired(value, 'value', Boolean);
 
 			if (this.getIsDisposed()) {
 				return;
 			}
 
-			if (this._data.newsExists !== value) {
-				this._newsExistsChangedEvent.fire(this._data.newsExists = value);
+			if (this._data.locked !== value) {
+				this._lockChangedEvent.fire(this._data.locked = value);
 			}
 		}
 
@@ -3432,6 +3474,17 @@ module.exports = (() => {
 			return this._quoteChangedEvent.register(handler);
 		}
 
+		/**
+		 * Registers an observer changes to the status of news existence.
+		 *
+		 * @public
+		 * @param {Function} handler
+		 * @returns {Disposable}
+		 */
+		registerNewsExistsChangeHandler(handler) {
+			return this._newsExistsChangedEvent.register(handler);
+		}
+
 		/**
 		 * Registers an observer for fundamental data changes.
 		 *
@@ -3440,18 +3493,18 @@ module.exports = (() => {
 		 * @returns {Disposable}
 		 */
 		registerFundamentalDataChangeHandler(handler) {
-			return this._fundamentalDataChangeEvent.register(handler);
+			return this._fundamentalDataChangedEvent.register(handler);
 		}
 
 		/**
-		 * Registers an observer changes to the status of news existence.
+		 * Registers an observer for position lock changes.
 		 *
 		 * @public
 		 * @param {Function} handler
 		 * @returns {Disposable}
 		 */
-		registerNewsExistsChangeHandler(handler) {
-			return this._newsExistsChangedEvent.register(handler);
+		registerLockChangeHandler(handler) {
+			return this._lockChangedEvent.register(handler);
 		}
 
 		/**
@@ -3481,7 +3534,8 @@ module.exports = (() => {
 
 			this._quoteChangedEvent.clear();
 			this._newsExistsChangedEvent.clear();
-			this._fundamentalDataChangeEvent.clear();
+			this._fundamentalDataChangedEvent.clear();
+			this._lockChangedEvent.clear();
 			this._portfolioChangedEvent.clear();
 			this._positionItemDisposeEvent.clear();
 		}
@@ -5920,12 +5974,11 @@ module.exports = function () {
 			}
 
 			/**
-    * Converts a string (which matches the output of {@link Day#format} into
-    * a {@link Day} instance.
+    * Clones a {@link Day} instance.
     *
     * @public
     * @static
-    * @param {String} value
+    * @param {Day} value
     * @returns {Day}
     */
 
@@ -5966,6 +6019,24 @@ module.exports = function () {
 				return this._day;
 			}
 		}], [{
+			key: 'clone',
+			value: function clone(value) {
+				assert.argumentIsRequired(value, 'value', Day, 'Day');
+
+				return new Day(value.year, value.month, value.day);
+			}
+
+			/**
+    * Converts a string (which matches the output of {@link Day#format} into
+    * a {@link Day} instance.
+    *
+    * @public
+    * @static
+    * @param {String} value
+    * @returns {Day}
+    */
+
+		}, {
 			key: 'parse',
 			value: function parse(value) {
 				assert.argumentIsRequired(value, 'value', String);
@@ -6476,10 +6547,11 @@ module.exports = function () {
 			}
 
 			/**
-    * Parses the value emitted by {@link Decimal#toJSON}.
+    * Clones a {@link Decimal} instance.
     *
     * @public
-    * @param {String} value
+    * @static
+    * @param {Decimal} value
     * @returns {Decimal}
     */
 
@@ -6489,6 +6561,22 @@ module.exports = function () {
 				return '[Decimal]';
 			}
 		}], [{
+			key: 'clone',
+			value: function clone(value) {
+				assert.argumentIsRequired(value, 'value', Decimal, 'Decimal');
+
+				return new Decimal(value._big);
+			}
+
+			/**
+    * Parses the value emitted by {@link Decimal#toJSON}.
+    *
+    * @public
+    * @param {String} value
+    * @returns {Decimal}
+    */
+
+		}, {
 			key: 'parse',
 			value: function parse(value) {
 				return new Decimal(value);
@@ -7510,10 +7598,11 @@ module.exports = function () {
 			}
 
 			/**
-    * Parses the value emitted by {@link Timestamp#toJSON}.
+    * Clones a {@link Timestamp} instance.
     *
     * @public
-    * @param {Number} value
+    * @static
+    * @param {Timestamp} value
     * @returns {Timestamp}
     */
 
@@ -7549,6 +7638,22 @@ module.exports = function () {
 				return this._moment;
 			}
 		}], [{
+			key: 'clone',
+			value: function clone(value) {
+				assert.argumentIsRequired(value, 'value', Timestamp, 'Timestamp');
+
+				return new Timestamp(value._timestamp, value._timezone);
+			}
+
+			/**
+    * Parses the value emitted by {@link Timestamp#toJSON}.
+    *
+    * @public
+    * @param {Number} value
+    * @returns {Timestamp}
+    */
+
+		}, {
 			key: 'parse',
 			value: function parse(value) {
 				return new Timestamp(value);