@barchart/portfolio-api-common 1.2.26 → 1.2.30

package/lib/api/failures/PortfolioFailureType.js

@@ -119,6 +119,18 @@ module.exports = (() => {
 			return transactionCreateFailedInvalidInitialType;
 		}
 
+		/**
+		 * The transaction (of this type) cannot be created by a user, instead,
+		 * it is created and managed by the system (e.g. dividends).
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_TYPE_RESERVED() {
+			return transactionCreateFailedTypeReserved;
+		}
+
 		/**
 		 * Deleting any transaction except for the most recent requires
 		 * re-writing transaction history.
@@ -153,6 +165,29 @@ module.exports = (() => {
 			return transactionDeleteFailedDirectionSwitchOnRewrite;
 		}
 
+		/**
+		 * Unable to edit, the transaction doesn't exist.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_EDIT_FAILED_NO_TRANSACTION() {
+			return transactionEditFailedNoTransaction;
+		}
+
+		/**
+		 * The transaction (of this type) cannot be edited by a user, instead,
+		 * it is managed by the system (e.g. dividends).
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_EDIT_FAILED_TYPE_RESERVED() {
+			return transactionEditFailedTypeReserved;
+		}
+
 		toString() {
 			return '[PortfolioFailureType]';
 		}
@@ -170,10 +205,14 @@ module.exports = (() => {
 	const transactionCreateFailedTypeInvalidForDirection = new FailureType('TRANSACTION_CREATE_FAILED_TYPE_INVALID_FOR_DIRECTION', 'Unable to process transaction, a {L|positionDirection.description} position would be created (i.e. you would have {L|positionDirection.sign} shares/units). {u|instrumentType.description} positions cannot have {L|positionDirection.description} positions.');
 	const transactionCreateFailedInvalidDirectionSwitch = new FailureType('TRANSACTION_CREATE_FAILED_INVALID_DIRECTION_SWITCH', 'Unable to process transaction, the transaction would switch the position from {L|currentDirection.description} to {L|proposedDirection.description} (i.e. {L|currentDirection.sign} to {L|proposedDirection.sign} shares/units). This is not allowed. Please close the current position (i.e. zero it out) and then enter a second transaction.');
 	const transactionCreateFailedInvalidInitialType = new FailureType('TRANSACTION_CREATE_FAILED_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 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.');
 	const transactionDeleteFailedDirectionSwitchOnRewrite = new FailureType('TRANSACTION_DELETE_FAILED_DIRECTION_SWITCH_ON_REWRITE', 'Deleting this transaction would cause your history to be re-written and the position to switch from long to short (i.e. positive to negative) or vice versa.');
 
+	const transactionEditFailedNoTransaction = new FailureType('TRANSACTION_EDIT_FAILED_NO_TRANSACTION', 'Unable to edit transaction. The referenced transaction does not exist.');
+	const transactionEditFailedTypeReserved = new FailureType('TRANSACTION_EDIT_FAILED_TYPE_RESERVED', 'Unable to edit {U|type.description} transaction, this type of transaction is managed by the system.');
+
 	return PortfolioFailureType;
 })();

package/lib/data/InstrumentType.js

@@ -47,7 +47,7 @@ module.exports = (() => {
 		 * A human-readable description.
 		 *
 		 * @public
-		 * @return {String}
+		 * @returns {String}
 		 */
 		get alternateDescription() {
 			return this._alternateDescription;
@@ -182,7 +182,7 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param code
-		 * @return {InstrumentType}
+		 * @returns {InstrumentType}
 		 */
 		static fromSymbolType(code) {
 			assert.argumentIsRequired(code, 'code', Number);

package/lib/data/PositionSummaryFrame.js

@@ -42,7 +42,7 @@ module.exports = (() => {
 		 * exist for a position.
 		 *
 		 * @public
-		 * @return {Boolean}
+		 * @returns {Boolean}
 		 */
 		get unique() {
 			return this._unique;
@@ -53,8 +53,8 @@ module.exports = (() => {
 		 * start and end dates.
 		 *
 		 * @public
-		 * @return {PositionSummaryRange} range
-		 * @return {String}
+		 * @returns {PositionSummaryRange} range
+		 * @returns {String}
 		 */
 		describeRange(range) {
 			return this._descriptionCalculator(range.start, range.end);

package/lib/data/TransactionValidator.js

@@ -25,7 +25,7 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {Array.<Object>} transactions
-		 * @return {Boolean}
+		 * @returns {Boolean}
 		 */
 		static validateOrder(transactions) {
 			return TransactionValidator.getInvalidIndex(transactions) < 0;
@@ -38,7 +38,7 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {Array.<Object>} transactions
-		 * @return {Number}
+		 * @returns {Number}
 		 */
 		static getInvalidIndex(transactions) {
 			assert.argumentIsArray(transactions, 'transactions');
@@ -54,7 +54,7 @@ module.exports = (() => {
 		 * @param {InstrumentType} instrumentType
 		 * @param {Boolean=} userInitiated
 		 * @pararm {PositionDirection=} currentDirection
-		 * @return {Array.<TransactionType>}
+		 * @returns {Array.<TransactionType>}
 		 */
 		static getTransactionTypesFor(instrumentType, userInitiated, currentDirection) {
 			assert.argumentIsRequired(instrumentType, 'instrumentType', InstrumentType, 'InstrumentType');
@@ -79,7 +79,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @return {Array.<TransactionType>}
+		 * @returns {Array.<TransactionType>}
 		 */
 		static getUserInitiatedTransactionTypes() {
 			return array.unique(Object.keys(validTransactionTypes).reduce((types, key) => {
@@ -103,7 +103,7 @@ module.exports = (() => {
 		 * @param {InstrumentType} instrumentType
 		 * @param {TransactionType} transactionType
 		 * @param {Boolean=} userInitiated
-		 * @return {Boolean}
+		 * @returns {Boolean}
 		 */
 		static validateTransactionType(instrumentType, transactionType, userInitiated) {
 			assert.argumentIsRequired(transactionType, 'transactionType', TransactionType, 'TransactionType');
@@ -131,7 +131,7 @@ module.exports = (() => {
 		 * @public
 		 * @param {InstrumentType} instrumentType
 		 * @param {PositionDirection} direction
-		 * @return {Boolean}
+		 * @returns {Boolean}
 		 */
 		static validateDirection(instrumentType, direction) {
 			assert.argumentIsRequired(instrumentType, 'instrumentType', InstrumentType, 'InstrumentType');
@@ -149,7 +149,7 @@ module.exports = (() => {
 		 * @param {InstrumentType} instrumentType
 		 * @param {PositionDirection|null|undefined} currentDirection
 		 * @param {PositionDirection} proposedDirection
-		 * @return {Boolean}
+		 * @returns {Boolean}
 		 */
 		static validateDirectionSwitch(instrumentType, currentDirection, proposedDirection) {
 			return currentDirection === null || instrumentType.canSwitchDirection || (currentDirection.closed || proposedDirection.closed || currentDirection.positive === proposedDirection.positive);

package/lib/processing/PositionContainer.js

@@ -555,7 +555,7 @@ module.exports = (() => {
 		 * Returns all portfolios in the container.
 		 *
 		 * @public
-		 * @return {Array.<Object>}
+		 * @returns {Array.<Object>}
 		 */
 		getPortfolios() {
 			return Object.keys(this._portfolios).map(id => this._portfolios[id]);
@@ -566,7 +566,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {String} portfolio
-		 * @return {Array.<Object>}
+		 * @returns {Array.<Object>}
 		 */
 		getPositions(portfolio) {
 			assert.argumentIsRequired(portfolio, 'portfolio', String);
@@ -583,7 +583,7 @@ module.exports = (() => {
 		 * @public
 		 * @param {String} portfolio
 		 * @param {String} position
-		 * @return {Object|null}
+		 * @returns {Object|null}
 		 */
 		getPosition(portfolio, position) {
 			assert.argumentIsRequired(position, 'position', String);

package/lib/processing/PositionGroup.js

@@ -441,7 +441,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Function} handler
-		 * @return {Disposable}
+		 * @returns {Disposable}
 		 */
 		registerGroupExcludedChangeHandler(handler) {
 			return this._groupExcludedChangeEvent.register(handler);

package/lib/processing/PositionItem.js

@@ -189,7 +189,7 @@ module.exports = (() => {
 			}
 
 			if (this._currentPricePrevious !== quote.lastPrice) {
-				if (this._data.previousPrice === null && quote.previousPrice) {
+				if (quote.previousPrice) {
 					this._data.previousPrice = quote.previousPrice;
 				}
 

package/lib/processing/definitions/PositionLevelDefinition.js

@@ -67,7 +67,7 @@ module.exports = (() => {
 		 * A general description of the type of items grouped together.
 		 *
 		 * @public
-		 * @return {PositionLevelType}
+		 * @returns {PositionLevelType}
 		 */
 		get type() {
 			return this._type;
@@ -160,7 +160,7 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {Object} portfolio
-		 * @return {PositionLevelDefinition~RequiredGroup}
+		 * @returns {PositionLevelDefinition~RequiredGroup}
 		 */
 		static buildRequiredGroupForPortfolio(portfolio) {
 			return {
@@ -203,7 +203,7 @@ module.exports = (() => {
 		 * @static
 		 * @param {InstrumentType} type
 		 * @param {Currency} currency
-		 * @return {PositionLevelDefinition~RequiredGroup}
+		 * @returns {PositionLevelDefinition~RequiredGroup}
 		 */
 		static buildRequiredGroupForAssetClass(type, currency) {
 			return {

package/lib/processing/definitions/PositionTreeDefinition.js

@@ -54,7 +54,7 @@ module.exports = (() => {
 		 * group (from the current tree) is excluded.
 		 *
 		 * @public
-		 * @return {Array.<String>}
+		 * @returns {Array.<String>}
 		 */
 		get exclusionDependencies() {
 			return this._exclusionDependencies;

package/lib/serialization/TransactionSchema.js

@@ -248,6 +248,7 @@ module.exports = (() => {
 	const buy = new TransactionSchema(SchemaBuilder.withName(TransactionType.BUY.code)
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
+		.withField('sequence', DataType.NUMBER, true)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('instrument.name', DataType.STRING, true)
 		.withField('instrument.type', DataType.forEnum(InstrumentType, 'InstrumentType'), true)
@@ -266,6 +267,7 @@ module.exports = (() => {
 	const sell = new TransactionSchema(SchemaBuilder.withName(TransactionType.SELL.code)
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
+		.withField('sequence', DataType.NUMBER, true)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
@@ -278,6 +280,7 @@ module.exports = (() => {
 	const buyShort = new TransactionSchema(SchemaBuilder.withName(TransactionType.BUY_SHORT.code)
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
+		.withField('sequence', DataType.NUMBER, true)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
@@ -291,6 +294,7 @@ module.exports = (() => {
 	const sellShort = new TransactionSchema(SchemaBuilder.withName(TransactionType.SELL_SHORT.code)
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
+		.withField('sequence', DataType.NUMBER, true)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('instrument.name', DataType.STRING, true)
 		.withField('instrument.type', DataType.forEnum(InstrumentType, 'InstrumentType'), true)
@@ -385,6 +389,7 @@ module.exports = (() => {
 	const fee = new TransactionSchema(SchemaBuilder.withName(TransactionType.FEE.code)
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
+		.withField('sequence', DataType.NUMBER, true)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('fee', DataType.DECIMAL)
@@ -395,6 +400,7 @@ module.exports = (() => {
 	const feeUnits = new TransactionSchema(SchemaBuilder.withName(TransactionType.FEE_UNITS.code)
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
+		.withField('sequence', DataType.NUMBER, true)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('fee', DataType.DECIMAL)
@@ -406,6 +412,7 @@ module.exports = (() => {
 	const deposit = new TransactionSchema(SchemaBuilder.withName(TransactionType.DEPOSIT.code)
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
+		.withField('sequence', DataType.NUMBER, true)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('instrument.type', DataType.forEnum(InstrumentType, 'InstrumentType'), true)
 		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'), true)
@@ -419,6 +426,7 @@ module.exports = (() => {
 	const withdrawal = new TransactionSchema(SchemaBuilder.withName(TransactionType.WITHDRAWAL.code)
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
+		.withField('sequence', DataType.NUMBER, true)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('instrument.type', DataType.forEnum(InstrumentType, 'InstrumentType'), true)
 		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'), true)
@@ -454,6 +462,7 @@ module.exports = (() => {
 	const valuation = new TransactionSchema(SchemaBuilder.withName(TransactionType.VALUATION.code)
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
+		.withField('sequence', DataType.NUMBER, true)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('value', DataType.DECIMAL)
@@ -464,6 +473,7 @@ module.exports = (() => {
 	const income = new TransactionSchema(SchemaBuilder.withName(TransactionType.INCOME.code)
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
+		.withField('sequence', DataType.NUMBER, true)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('income', DataType.DECIMAL)

package/package.json

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

package/test/SpecRunner.js

@@ -48,7 +48,7 @@ module.exports = (() => {
 		 * A human-readable description.
 		 *
 		 * @public
-		 * @return {String}
+		 * @returns {String}
 		 */
 		get alternateDescription() {
 			return this._alternateDescription;
@@ -183,7 +183,7 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param code
-		 * @return {InstrumentType}
+		 * @returns {InstrumentType}
 		 */
 		static fromSymbolType(code) {
 			assert.argumentIsRequired(code, 'code', Number);
@@ -392,7 +392,7 @@ module.exports = (() => {
 		 * exist for a position.
 		 *
 		 * @public
-		 * @return {Boolean}
+		 * @returns {Boolean}
 		 */
 		get unique() {
 			return this._unique;
@@ -403,8 +403,8 @@ module.exports = (() => {
 		 * start and end dates.
 		 *
 		 * @public
-		 * @return {PositionSummaryRange} range
-		 * @return {String}
+		 * @returns {PositionSummaryRange} range
+		 * @returns {String}
 		 */
 		describeRange(range) {
 			return this._descriptionCalculator(range.start, range.end);
@@ -1053,7 +1053,7 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {Array.<Object>} transactions
-		 * @return {Boolean}
+		 * @returns {Boolean}
 		 */
 		static validateOrder(transactions) {
 			return TransactionValidator.getInvalidIndex(transactions) < 0;
@@ -1066,7 +1066,7 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {Array.<Object>} transactions
-		 * @return {Number}
+		 * @returns {Number}
 		 */
 		static getInvalidIndex(transactions) {
 			assert.argumentIsArray(transactions, 'transactions');
@@ -1082,7 +1082,7 @@ module.exports = (() => {
 		 * @param {InstrumentType} instrumentType
 		 * @param {Boolean=} userInitiated
 		 * @pararm {PositionDirection=} currentDirection
-		 * @return {Array.<TransactionType>}
+		 * @returns {Array.<TransactionType>}
 		 */
 		static getTransactionTypesFor(instrumentType, userInitiated, currentDirection) {
 			assert.argumentIsRequired(instrumentType, 'instrumentType', InstrumentType, 'InstrumentType');
@@ -1107,7 +1107,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @return {Array.<TransactionType>}
+		 * @returns {Array.<TransactionType>}
 		 */
 		static getUserInitiatedTransactionTypes() {
 			return array.unique(Object.keys(validTransactionTypes).reduce((types, key) => {
@@ -1131,7 +1131,7 @@ module.exports = (() => {
 		 * @param {InstrumentType} instrumentType
 		 * @param {TransactionType} transactionType
 		 * @param {Boolean=} userInitiated
-		 * @return {Boolean}
+		 * @returns {Boolean}
 		 */
 		static validateTransactionType(instrumentType, transactionType, userInitiated) {
 			assert.argumentIsRequired(transactionType, 'transactionType', TransactionType, 'TransactionType');
@@ -1159,7 +1159,7 @@ module.exports = (() => {
 		 * @public
 		 * @param {InstrumentType} instrumentType
 		 * @param {PositionDirection} direction
-		 * @return {Boolean}
+		 * @returns {Boolean}
 		 */
 		static validateDirection(instrumentType, direction) {
 			assert.argumentIsRequired(instrumentType, 'instrumentType', InstrumentType, 'InstrumentType');
@@ -1177,7 +1177,7 @@ module.exports = (() => {
 		 * @param {InstrumentType} instrumentType
 		 * @param {PositionDirection|null|undefined} currentDirection
 		 * @param {PositionDirection} proposedDirection
-		 * @return {Boolean}
+		 * @returns {Boolean}
 		 */
 		static validateDirectionSwitch(instrumentType, currentDirection, proposedDirection) {
 			return currentDirection === null || instrumentType.canSwitchDirection || (currentDirection.closed || proposedDirection.closed || currentDirection.positive === proposedDirection.positive);
@@ -1817,7 +1817,7 @@ module.exports = (() => {
 		 * Returns all portfolios in the container.
 		 *
 		 * @public
-		 * @return {Array.<Object>}
+		 * @returns {Array.<Object>}
 		 */
 		getPortfolios() {
 			return Object.keys(this._portfolios).map(id => this._portfolios[id]);
@@ -1828,7 +1828,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {String} portfolio
-		 * @return {Array.<Object>}
+		 * @returns {Array.<Object>}
 		 */
 		getPositions(portfolio) {
 			assert.argumentIsRequired(portfolio, 'portfolio', String);
@@ -1845,7 +1845,7 @@ module.exports = (() => {
 		 * @public
 		 * @param {String} portfolio
 		 * @param {String} position
-		 * @return {Object|null}
+		 * @returns {Object|null}
 		 */
 		getPosition(portfolio, position) {
 			assert.argumentIsRequired(position, 'position', String);
@@ -2646,7 +2646,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Function} handler
-		 * @return {Disposable}
+		 * @returns {Disposable}
 		 */
 		registerGroupExcludedChangeHandler(handler) {
 			return this._groupExcludedChangeEvent.register(handler);
@@ -3254,7 +3254,7 @@ module.exports = (() => {
 			}
 
 			if (this._currentPricePrevious !== quote.lastPrice) {
-				if (this._data.previousPrice === null && quote.previousPrice) {
+				if (quote.previousPrice) {
 					this._data.previousPrice = quote.previousPrice;
 				}
 
@@ -3629,7 +3629,7 @@ module.exports = (() => {
 		 * A general description of the type of items grouped together.
 		 *
 		 * @public
-		 * @return {PositionLevelType}
+		 * @returns {PositionLevelType}
 		 */
 		get type() {
 			return this._type;
@@ -3722,7 +3722,7 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {Object} portfolio
-		 * @return {PositionLevelDefinition~RequiredGroup}
+		 * @returns {PositionLevelDefinition~RequiredGroup}
 		 */
 		static buildRequiredGroupForPortfolio(portfolio) {
 			return {
@@ -3765,7 +3765,7 @@ module.exports = (() => {
 		 * @static
 		 * @param {InstrumentType} type
 		 * @param {Currency} currency
-		 * @return {PositionLevelDefinition~RequiredGroup}
+		 * @returns {PositionLevelDefinition~RequiredGroup}
 		 */
 		static buildRequiredGroupForAssetClass(type, currency) {
 			return {
@@ -3926,7 +3926,7 @@ module.exports = (() => {
 		 * group (from the current tree) is excluded.
 		 *
 		 * @public
-		 * @return {Array.<String>}
+		 * @returns {Array.<String>}
 		 */
 		get exclusionDependencies() {
 			return this._exclusionDependencies;