@barchart/portfolio-api-common 1.5.2 → 1.9.0

package/.releases/1.6.0.md

@@ -0,0 +1,3 @@
+**New Features**
+
+* Added a new `PortfolioFailureType` for attempting to edit a transaction's type.

package/.releases/1.7.0.md

@@ -0,0 +1,3 @@
+**New Features**
+
+* Added a new `PortfolioFailureType` for attempting to reinvest a dividend when the position is short.

package/.releases/1.8.0.md

@@ -0,0 +1,3 @@
+**New Features**
+
+* Added a new `PortfolioFailureType` for attempts to switch to dividend reinvestment when the position is short.

package/.releases/1.9.0.md

@@ -0,0 +1,4 @@
+**New Features**
+
+* Added `close` field to the `Sell` transaction schema.
+* Added `close` field to the `Buy Short` transaction schema.

package/lib/api/failures/PortfolioFailureType.js

@@ -212,6 +212,18 @@ module.exports = (() => {
 			return transactionCreateFailedReinvestPriceUnavailable;
 		}
 
+		/**
+		 * The transaction failed because a dividends cannot be re-invested
+		 * for short positions.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_CREATE_FAILED_REINVEST_INVALID() {
+			return transactionCreateFailedReinvestInvalid;
+		}
+
 		/**
 		 * The transaction failed because a related position is locked.
 		 *
@@ -326,6 +338,40 @@ module.exports = (() => {
 			return transactionEditFailedTypeReserved;
 		}
 
+		/**
+		 * A transaction's type cannot be changed.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_EDIT_FAILED_TYPE_CHANGED() {
+			return transactionEditFailedTypeChanged;
+		}
+		
+		/**
+		 * Conversion of transaction type is unsupported.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_SWITCH_FAILED_INVALID_CONVERSION() {
+			return transactionSwitchFailedInvalidConversion;
+		}
+
+		/**
+		 * Conversion of transaction type is not allowed. Dividends (or distributions)
+		 * cannot be reinvested when the position is short.
+		 *
+		 * @public
+		 * @static
+		 * @returns {FailureType}
+		 */
+		static get TRANSACTION_SWITCH_FAILED_INVALID_REINVEST() {
+			return transactionSwitchFailedInvalidReinvest;
+		}
+		
 		toString() {
 			return '[PortfolioFailureType]';
 		}
@@ -352,6 +398,7 @@ module.exports = (() => {
 
 	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 transactionCreateFailedReinvestInvalid = new FailureType('TRANSACTION_CREATE_FAILED_REINVEST_INVALID', 'Unable to create transaction, short positions do not allow dividends to be reinvested.');
 	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 transactionCreateFailedInstrumentCorrupt = new FailureType('TRANSACTION_CREATE_FAILED_INSTRUMENT_CORRUPT', 'Unable to create transaction, corporate action history for {U|symbol} cannot be located. The issue should be corrected within 24 to 48 hours.');
 
@@ -364,6 +411,10 @@ module.exports = (() => {
 	const transactionEditFailedInvalidDate = new FailureType('TRANSACTION_EDIT_FAILED_INVALID_DATE', 'Unable to edit transaction with given date.');
 	const transactionEditFailedNoTransaction = new FailureType('TRANSACTION_EDIT_FAILED_NO_TRANSACTION', 'Unable to edit transaction. The referenced transaction does not exist.', false);
 	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.');
+	const transactionEditFailedTypeChanged = new FailureType('TRANSACTION_EDIT_FAILED_TYPE_CHANGED', 'Changing a transaction type is forbidden. You must delete the existing transaction and then create a new transaction.');
+
+	const transactionSwitchFailedInvalidConversion = new FailureType('TRANSACTION_SWITCH_FAILED_INVALID_CONVERSION', 'Unable to convert transaction from {U|existing.description} to {U|desired.description}. This conversion is not supported.');
+	const transactionSwitchFailedInvalidReinvest = new FailureType('TRANSACTION_SWITCH_FAILED_INVALID_REINVEST', 'Unable to convert transaction from {U|existing.description} to {U|desired.description}. Reinvestment is not supported for short positions.');
 
 	return PortfolioFailureType;
 })();

package/lib/data/TransactionValidator.js

@@ -1,7 +1,6 @@
 const assert = require('@barchart/common-js/lang/assert'),
 	array = require('@barchart/common-js/lang/array'),
-	is = require('@barchart/common-js/lang/is'),
-	Day = require('@barchart/common-js/lang/Day');
+	is = require('@barchart/common-js/lang/is');
 
 const InstrumentType = require('./InstrumentType'),
 	PositionDirection = require('./PositionDirection'),

package/lib/serialization/TransactionSchema.js

@@ -250,6 +250,7 @@ module.exports = (() => {
 		.withField('quantity', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.withField('force', DataType.BOOLEAN, true)
+		.withField('close', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -263,6 +264,7 @@ module.exports = (() => {
 		.withField('quantity', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.withField('force', DataType.BOOLEAN, true)
+		.withField('close', DataType.BOOLEAN, true)
 		.schema
 	);
 

package/package.json

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

package/test/SpecRunner.js

@@ -1291,8 +1291,7 @@ module.exports = (() => {
 },{"@barchart/common-js/lang/Enum":26,"@barchart/common-js/lang/assert":31}],5:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
 	array = require('@barchart/common-js/lang/array'),
-	is = require('@barchart/common-js/lang/is'),
-	Day = require('@barchart/common-js/lang/Day');
+	is = require('@barchart/common-js/lang/is');
 
 const InstrumentType = require('./InstrumentType'),
 	PositionDirection = require('./PositionDirection'),
@@ -1595,7 +1594,7 @@ module.exports = (() => {
 	return TransactionValidator;
 })();
 
-},{"./InstrumentType":1,"./PositionDirection":2,"./TransactionType":4,"@barchart/common-js/lang/Day":23,"@barchart/common-js/lang/array":30,"@barchart/common-js/lang/assert":31,"@barchart/common-js/lang/is":35}],6:[function(require,module,exports){
+},{"./InstrumentType":1,"./PositionDirection":2,"./TransactionType":4,"@barchart/common-js/lang/array":30,"@barchart/common-js/lang/assert":31,"@barchart/common-js/lang/is":35}],6:[function(require,module,exports){
 const Enum = require('@barchart/common-js/lang/Enum');
 
 module.exports = (() => {
@@ -5460,6 +5459,7 @@ module.exports = (() => {
 		.withField('quantity', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.withField('force', DataType.BOOLEAN, true)
+		.withField('close', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -5473,6 +5473,7 @@ module.exports = (() => {
 		.withField('quantity', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.withField('force', DataType.BOOLEAN, true)
+		.withField('close', DataType.BOOLEAN, true)
 		.schema
 	);
 
@@ -8582,7 +8583,8 @@ module.exports = (() => {
     },
 
     /**
-     * Set difference operation (using strict equality).
+     * Set difference operation, returning any item in "a" that is not
+     * contained in "b" (using strict equality).
      *
      * @static
      * @param {Array} a
@@ -8594,7 +8596,8 @@ module.exports = (() => {
     },
 
     /**
-     * Set difference operation, where the uniqueness is determined by a delegate.
+     * Set difference operation, returning any item in "a" that is not
+     * contained in "b" (where the uniqueness is determined by a delegate).
      *
      * @static
      * @param {Array} a
@@ -9497,6 +9500,7 @@ module.exports = (() => {
   /**
    * An implementation of the observer pattern.
    *
+   * @public
    * @param {*} sender - The object which owns the event.
    * @extends {Disposable}
    */
@@ -9570,6 +9574,7 @@ module.exports = (() => {
     /**
      * Returns true, if no handlers are currently registered.
      *
+     * @public
      * @returns {boolean}
      */