@barchart/portfolio-api-common 1.0.28 → 1.0.33

package/lib/data/TransactionType.js

@@ -313,10 +313,10 @@ module.exports = (() => {
 	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', false, false, true, false, false);
 	const distributionFund = new TransactionType('DF', 'Distribution (Units)', false, false, false, true, false);
 
-	const deposit = new TransactionType('D', 'Deposit', false, false, false, false, false);
-	const withdrawal = new TransactionType('W', 'Withdrawal', false, false, false, false, false);
-	const debit = new TransactionType('DR', 'Debit', false, false, false, false, false);
-	const credit = new TransactionType('CR', 'Credit', false, false, false, false, false);
+	const deposit = new TransactionType('D', 'Deposit', false, false, false, true, false);
+	const withdrawal = new TransactionType('W', 'Withdrawal', false, false, false, false, true);
+	const debit = new TransactionType('DR', 'Debit', false, false, false, false, true);
+	const credit = new TransactionType('CR', 'Credit', false, false, false, true, false);
 
 	const valuation = new TransactionType('V', 'Valuation', false, false, false, false, false);
 	const income = new TransactionType('I', 'Income', false, false, true, false, false);

package/lib/formatters/PositionSummaryFormatter.js

@@ -1,4 +1,4 @@
-const array = require('@barchart/common-js/lang/array')
+const array = require('@barchart/common-js/lang/array'),
 	assert = require('@barchart/common-js/lang/assert'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
 	formatter = require('@barchart/common-js/lang/formatter');
@@ -6,14 +6,17 @@ const array = require('@barchart/common-js/lang/array')
 module.exports = (() => {
 
 	/**
-	 * Formats Position Summary records into groups based on instrument type
+	 * Static utilities for formatting position summary records (into groups based on
+	 * instrument type)
 	 *
+	 * @public
 	 */
 	class PositionSummaryFormatter{
-
 		/**
 		 * The formatter
 		 *
+		 * @public
+		 * @static
 		 * @param {Array} summaries
 		 * @returns {Object}
 		 */
@@ -67,5 +70,4 @@ module.exports = (() => {
 	};
 
 	return PositionSummaryFormatter;
-
 })();

package/lib/serialization/TransactionSchema.js

@@ -272,6 +272,11 @@ module.exports = (() => {
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
+		.withField('instrument.name', DataType.STRING, true)
+		.withField('instrument.type', DataType.STRING, true)
+		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'), true)
+		.withField('instrument.symbol.barchart', DataType.STRING, true)
+		.withField('instrument.symbol.display', DataType.STRING, true)
 		.withField('date', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
 		.withField('quantity', DataType.DECIMAL)
@@ -283,11 +288,6 @@ module.exports = (() => {
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('instrument.name', DataType.STRING, true)
-		.withField('instrument.type', DataType.STRING, true)
-		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'), true)
-		.withField('instrument.symbol.barchart', DataType.STRING, true)
-		.withField('instrument.symbol.display', DataType.STRING, true)
 		.withField('date', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
 		.withField('quantity', DataType.DECIMAL)
@@ -301,8 +301,7 @@ module.exports = (() => {
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('rate', DataType.DECIMAL)
-		.withField('open', DataType.DECIMAL, true)
-		.withField('effective', DataType.DAY, true)
+		.withField('effective', DataType.DAY)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
 	);
@@ -313,8 +312,7 @@ module.exports = (() => {
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('rate', DataType.DECIMAL)
-		.withField('open', DataType.DECIMAL, true)
-		.withField('effective', DataType.DAY, true)
+		.withField('effective', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
@@ -326,8 +324,7 @@ module.exports = (() => {
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('rate', DataType.DECIMAL)
-		.withField('open', DataType.DECIMAL, true)
-		.withField('effective', DataType.DAY, true)
+		.withField('effective', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
@@ -339,8 +336,7 @@ module.exports = (() => {
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('rate', DataType.DECIMAL)
-		.withField('open', DataType.DECIMAL, true)
-		.withField('effective', DataType.DAY, true)
+		.withField('effective', DataType.DAY)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
 	);
@@ -351,8 +347,8 @@ module.exports = (() => {
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
 		.withField('date', DataType.DAY)
 		.withField('rate', DataType.DECIMAL)
-		.withField('open', DataType.DECIMAL, true)
-		.withField('effective', DataType.DAY, true)
+		.withField('effective', DataType.DAY)
+		.withField('price', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
 	);
@@ -364,7 +360,7 @@ module.exports = (() => {
 		.withField('date', DataType.DAY)
 		.withField('numerator', DataType.DECIMAL)
 		.withField('denominator', DataType.DECIMAL)
-		.withField('effective', DataType.DAY, true)
+		.withField('effective', DataType.DAY)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
 	);

package/package.json

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

package/test/SpecRunner.js

@@ -631,6 +631,37 @@ module.exports = function () {
 				return Day.compareDays(this, other) > 0;
 			}
 
+			/**
+    * Indicates the current day falls between two other days, inclusive
+    * of the range boundaries.
+    *
+    * @public
+    * @param {Day=} first
+    * @param {Day=} last
+    * @param {boolean=} exclusive
+    * @returns {boolean}
+    */
+
+		}, {
+			key: 'getIsContained',
+			value: function getIsContained(first, last) {
+				assert.argumentIsOptional(first, 'first', Day, 'Day');
+				assert.argumentIsOptional(last, 'last', Day, 'Day');
+
+				var notAfter = void 0;
+				var notBefore = void 0;
+
+				if (first && last && first.getIsAfter(last)) {
+					notBefore = false;
+					notAfter = false;
+				} else {
+					notAfter = !(last instanceof Day) || !this.getIsAfter(last);
+					notBefore = !(first instanceof Day) || !this.getIsBefore(first);
+				}
+
+				return notAfter && notBefore;
+			}
+
 			/**
     * Indicates if another {@link Day} occurs after the current instance.
     *