@barchart/portfolio-api-common 1.2.48 → 1.2.49

package/lib/formatters/TransactionFormatter.js

@@ -146,13 +146,18 @@ module.exports = (() => {
 	});
 
 	formatters.set(TransactionType.DIVIDEND_STOCK, (t) => {
-		const rate = (is.object(t.dividend) && is.string(t.dividend.rate)) || '';
-
-		return {
+		const data = {
 			boughtSold: t.quantity,
-			shares: t.snapshot.open.subtract(t.quantity),
-			rate: rate
+			fee: t.fee
 		};
+
+		if (t.dividend && t.dividend.rate && t.dividend.price) {
+			data.shares = t.snapshot.open.subtract(t.quantity);
+			data.price = t.dividend.price;
+			data.rate = t.dividend.rate;
+		}
+
+		return data;
 	});
 
 	formatters.set(TransactionType.DIVIDEND_REINVEST, (t) => {
@@ -174,10 +179,18 @@ module.exports = (() => {
 	});
 
 	formatters.set(TransactionType.DISTRIBUTION_FUND, (t) => {
-		return {
-			shares: t.quantity,
+		const data = {
+			boughtSold: t.quantity,
 			fee: t.fee
 		};
+
+		if (t.dividend && t.dividend.rate && t.dividend.price) {
+			data.shares = t.snapshot.open.subtract(t.quantity);
+			data.price = t.dividend.price;
+			data.rate = t.dividend.rate;
+		}
+
+		return data;
 	});
 
 	formatters.set(TransactionType.DISTRIBUTION_REINVEST, (t) => {

package/package.json

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

package/test/SpecRunner.js

@@ -5134,8 +5134,8 @@ module.exports = function () {
    * Compares two strings (in ascending order), using {@link String#localeCompare}.
    *
    * @static
-   * @param {String} a
-   * @param {String} b
+   * @param {Number} a
+   * @param {Number} b
    * @returns {Number}
    */
 		compareStrings: function compareStrings(a, b) {
@@ -5825,7 +5825,7 @@ module.exports = function () {
     * @returns {String}
     */
 			value: function format() {
-				return leftPad(this._year, 4, '0') + '-' + leftPad(this._month, 2, '0') + '-' + leftPad(this._day, 2, '0');
+				return this._year + '-' + leftPad(this._month) + '-' + leftPad(this._day);
 			}
 
 			/**
@@ -5942,7 +5942,7 @@ module.exports = function () {
     *
     * @static
     * @public
-    * @returns {Day}
+    * @return {Day}
     */
 
 		}, {
@@ -6034,11 +6034,8 @@ module.exports = function () {
 
 	var dayRegex = /^([0-9]{4}).?([0-9]{2}).?([0-9]{2})$/;
 
-	function leftPad(value, digits, character) {
-		var string = value.toString();
-		var padding = digits - string.length;
-
-		return '' + character.repeat(padding) + string;
+	function leftPad(value) {
+		return value < 10 ? '0' + value : '' + value;
 	}
 
 	var comparator = ComparatorBuilder.startWith(function (a, b) {
@@ -6393,7 +6390,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 			value: function getIsZero(instance) {
 				assert.argumentIsRequired(instance, 'instance', Decimal, 'Decimal');
@@ -6406,7 +6403,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 
 		}, {
@@ -6422,7 +6419,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 
 		}, {
@@ -6438,7 +6435,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 
 		}, {
@@ -6454,7 +6451,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 
 		}, {
@@ -6470,7 +6467,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @returns {Boolean}
+    * @return {Boolean}
     */
 
 		}, {
@@ -6860,7 +6857,6 @@ module.exports = function () {
 		/**
    * The unique code.
    *
-   * @public
    * @returns {String}
    */
 
@@ -6873,7 +6869,6 @@ module.exports = function () {
     * Returns true if the provided {@link Enum} argument is equal
     * to the instance.
     *
-    * @public
     * @param {Enum} other
     * @returns {boolean}
     */
@@ -6898,7 +6893,6 @@ module.exports = function () {
     * Looks up a enumeration item; given the enumeration type and the enumeration
     * item's value. If no matching item can be found, a null value is returned.
     *
-    * @public
     * @param {Function} type - The enumeration type.
     * @param {String} code - The enumeration item's code.
     * @returns {*|null}
@@ -6918,7 +6912,6 @@ module.exports = function () {
 			/**
     * The description.
     *
-    * @public
     * @returns {String}
     */
 
@@ -6938,7 +6931,6 @@ module.exports = function () {
 			/**
     * Returns all of the enumeration's items (given an enumeration type).
     *
-    * @public
     * @param {Function} type - The enumeration to list.
     * @returns {Array}
     */
@@ -7396,7 +7388,7 @@ module.exports = function () {
     * Parses the value emitted by {@link Timestamp#toJSON}.
     *
     * @public
-    * @param {Number} value
+    * @param {String} value
     * @returns {Timestamp}
     */
 
@@ -8032,7 +8024,7 @@ module.exports = function () {
 
 				if (typeof itemConstraint === 'function' && itemConstraint !== Function) {
 					itemValidator = function itemValidator(value, index) {
-						return itemConstraint.prototype !== undefined && value instanceof itemConstraint || itemConstraint(value, variableName + '[' + index + ']');
+						return value instanceof itemConstraint || itemConstraint(value, variableName + '[' + index + ']');
 					};
 				} else {
 					itemValidator = function itemValidator(value, index) {
@@ -8142,7 +8134,7 @@ module.exports = function () {
    *
    * @static
    * @param {Object} target - The object to check for existence of the property.
-   * @param {String|Array.<String>} propertyNames - The property to check -- either a string with separators, or an array of strings (already split by separator).
+   * @param {String|Array<String>} propertyNames - The property to check -- either a string with separators, or an array of strings (already split by separator).
    * @param {String=} separator - The separator (defaults to a period character).
    * @returns {boolean}
    */
@@ -8168,7 +8160,7 @@ module.exports = function () {
    *
    * @static
    * @param {Object} target - The object to read from.
-   * @param {String|Array.<String>} propertyNames - The property to read -- either a string with separators, or an array of strings (already split by separator).
+   * @param {String|Array<String>} propertyNames - The property to read -- either a string with separators, or an array of strings (already split by separator).
    * @param {String=} separator - The separator (defaults to a period character).
    * @returns {*}
    */
@@ -8203,8 +8195,7 @@ module.exports = function () {
    *
    * @static
    * @param {Object} target - The object to write to.
-   * @param {String|Array.<String>} propertyNames - The property to write -- either a string with separators, or an array of strings (already split by separator).
-   * @param {*} value - The value to assign.
+   * @param {String|Array<String>} propertyNames - The property to write -- either a string with separators, or an array of strings (already split by separator).
    * @param {String=} separator - The separator (defaults to a period character).
    */
 		write: function write(target, propertyNames, value, separator) {
@@ -8230,7 +8221,7 @@ module.exports = function () {
    *
    * @static
    * @param {Object} target - The object to erase a property from.
-   * @param {String|Array.<String>} propertyNames - The property to write -- either a string with separators, or an array of strings (already split by separator).
+   * @param {String|Array<String>} propertyNames - The property to write -- either a string with separators, or an array of strings (already split by separator).
    * @param {String=} separator - The separator (defaults to a period character).
    */
 		erase: function erase(target, propertyNames, separator) {
@@ -9483,7 +9474,7 @@ module.exports = function () {
 			}
 
 			/**
-    * Generates a function suitable for use by {@link JSON.parse}.
+    * Generates a function suitable for use by JSON.parse.
     *
     * @public
     * @returns {Function}
@@ -13608,9 +13599,9 @@ moment.tz.load(require('./data/packed/latest.json'));
 
             mom = createUTC([2000, 1]).day(i);
             if (strict && !this._fullWeekdaysParse[i]) {
-                this._fullWeekdaysParse[i] = new RegExp('^' + this.weekdays(mom, '').replace('.', '\\.?') + '$', 'i');
-                this._shortWeekdaysParse[i] = new RegExp('^' + this.weekdaysShort(mom, '').replace('.', '\\.?') + '$', 'i');
-                this._minWeekdaysParse[i] = new RegExp('^' + this.weekdaysMin(mom, '').replace('.', '\\.?') + '$', 'i');
+                this._fullWeekdaysParse[i] = new RegExp('^' + this.weekdays(mom, '').replace('.', '\.?') + '$', 'i');
+                this._shortWeekdaysParse[i] = new RegExp('^' + this.weekdaysShort(mom, '').replace('.', '\.?') + '$', 'i');
+                this._minWeekdaysParse[i] = new RegExp('^' + this.weekdaysMin(mom, '').replace('.', '\.?') + '$', 'i');
             }
             if (!this._weekdaysParse[i]) {
                 regex = '^' + this.weekdays(mom, '') + '|^' + this.weekdaysShort(mom, '') + '|^' + this.weekdaysMin(mom, '');
@@ -14413,7 +14404,7 @@ moment.tz.load(require('./data/packed/latest.json'));
 
     function preprocessRFC2822(s) {
         // Remove comments and folding whitespace and replace multiple-spaces with a single space
-        return s.replace(/\([^)]*\)|[\n\t]/g, ' ').replace(/(\s\s+)/g, ' ').replace(/^\s\s*/, '').replace(/\s\s*$/, '');
+        return s.replace(/\([^)]*\)|[\n\t]/g, ' ').replace(/(\s\s+)/g, ' ').trim();
     }
 
     function checkWeekday(weekdayStr, parsedInput, config) {
@@ -16592,7 +16583,7 @@ moment.tz.load(require('./data/packed/latest.json'));
     // Side effect imports
 
 
-    hooks.version = '2.22.2';
+    hooks.version = '2.22.1';
 
     setHookCallback(createLocal);