@barchart/portfolio-api-common 1.2.61 → 1.2.65

package/lib/formatters/PositionSummaryFormatter.js

@@ -4,7 +4,6 @@ const array = require('@barchart/common-js/lang/array'),
 	formatter = require('@barchart/common-js/lang/formatter');
 
 module.exports = (() => {
-
 	/**
 	 * Static utilities for formatting position summary records (into groups based on
 	 * instrument type)

package/lib/serialization/PortfolioSchema.js

@@ -1,8 +1,6 @@
-const assert = require('@barchart/common-js/lang/assert'),
-	Currency = require('@barchart/common-js/lang/Currency'),
+const Currency = require('@barchart/common-js/lang/Currency'),
 	DataType = require('@barchart/common-js/serialization/json/DataType'),
 	Enum = require('@barchart/common-js/lang/Enum'),
-	is = require('@barchart/common-js/lang/is'),
 	Schema = require('@barchart/common-js/serialization/json/Schema'),
 	SchemaBuilder = require('@barchart/common-js/serialization/json/builders/SchemaBuilder'),
 	Timezones = require('@barchart/common-js/lang/Timezones');

package/lib/serialization/PositionSchema.js

@@ -1,8 +1,6 @@
-const assert = require('@barchart/common-js/lang/assert'),
-	Currency = require('@barchart/common-js/lang/Currency'),
+const Currency = require('@barchart/common-js/lang/Currency'),
 	DataType = require('@barchart/common-js/serialization/json/DataType'),
 	Enum = require('@barchart/common-js/lang/Enum'),
-	is = require('@barchart/common-js/lang/is'),
 	Schema = require('@barchart/common-js/serialization/json/Schema'),
 	SchemaBuilder = require('@barchart/common-js/serialization/json/builders/SchemaBuilder');
 

package/lib/serialization/PositionSummarySchema.js

@@ -1,8 +1,6 @@
-const assert = require('@barchart/common-js/lang/assert'),
-	Currency = require('@barchart/common-js/lang/Currency'),
+const Currency = require('@barchart/common-js/lang/Currency'),
 	DataType = require('@barchart/common-js/serialization/json/DataType'),
 	Enum = require('@barchart/common-js/lang/Enum'),
-	is = require('@barchart/common-js/lang/is'),
 	Schema = require('@barchart/common-js/serialization/json/Schema'),
 	SchemaBuilder = require('@barchart/common-js/serialization/json/builders/SchemaBuilder');
 
@@ -66,13 +64,6 @@ module.exports = (() => {
 		.withField('user', DataType.STRING)
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
-		.withField('instrument.id', DataType.STRING)
-		.withField('instrument.name', DataType.STRING)
-		.withField('instrument.type', DataType.STRING)
-		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'))
-		.withField('instrument.delist', DataType.DAY, true)
-		.withField('instrument.symbol.barchart', DataType.STRING, true)
-		.withField('instrument.symbol.display', DataType.STRING, true)
 		.withField('frame', DataType.forEnum(PositionSummaryFrame, 'PositionSummaryFrame'))
 		.withField('start.date', DataType.DAY)
 		.withField('start.sequence', DataType.NUMBER)
@@ -100,13 +91,6 @@ module.exports = (() => {
 		.withField('user', DataType.STRING)
 		.withField('portfolio', DataType.STRING)
 		.withField('position', DataType.STRING)
-		.withField('instrument.id', DataType.STRING)
-		.withField('instrument.name', DataType.STRING)
-		.withField('instrument.type', DataType.STRING)
-		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'))
-		.withField('instrument.delist', DataType.DAY, true)
-		.withField('instrument.symbol.barchart', DataType.STRING, true)
-		.withField('instrument.symbol.display', DataType.STRING, true)
 		.withField('frame', DataType.forEnum(PositionSummaryFrame, 'PositionSummaryFrame'))
 		.withField('start.date', DataType.DAY)
 		.withField('start.sequence', DataType.NUMBER)

package/package.json

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

package/test/SpecRunner.js

@@ -5179,8 +5179,8 @@ module.exports = function () {
    * Compares two strings (in ascending order), using {@link String#localeCompare}.
    *
    * @static
-   * @param {Number} a
-   * @param {Number} b
+   * @param {String} a
+   * @param {String} b
    * @returns {Number}
    */
 		compareStrings: function compareStrings(a, b) {
@@ -5870,7 +5870,7 @@ module.exports = function () {
     * @returns {String}
     */
 			value: function format() {
-				return this._year + '-' + leftPad(this._month) + '-' + leftPad(this._day);
+				return leftPad(this._year, 4, '0') + '-' + leftPad(this._month, 2, '0') + '-' + leftPad(this._day, 2, '0');
 			}
 
 			/**
@@ -5987,7 +5987,7 @@ module.exports = function () {
     *
     * @static
     * @public
-    * @return {Day}
+    * @returns {Day}
     */
 
 		}, {
@@ -6079,8 +6079,11 @@ module.exports = function () {
 
 	var dayRegex = /^([0-9]{4}).?([0-9]{2}).?([0-9]{2})$/;
 
-	function leftPad(value) {
-		return value < 10 ? '0' + value : '' + value;
+	function leftPad(value, digits, character) {
+		var string = value.toString();
+		var padding = digits - string.length;
+
+		return '' + character.repeat(padding) + string;
 	}
 
 	var comparator = ComparatorBuilder.startWith(function (a, b) {
@@ -6246,15 +6249,17 @@ module.exports = function () {
     *
     * @public
     * @param {Boolean=} approximate
+    * @param {Number=} places
     * @returns {Boolean}
     */
 
 		}, {
 			key: 'getIsZero',
-			value: function getIsZero(approximate) {
+			value: function getIsZero(approximate, places) {
 				assert.argumentIsOptional(approximate, 'approximate', Boolean);
+				assert.argumentIsOptional(places, 'places', Number);
 
-				return this._big.eq(zero) || is.boolean(approximate) && approximate && this.round(20, RoundingMode.NORMAL).getIsZero();
+				return this._big.eq(zero) || is.boolean(approximate) && approximate && this.round(places || Big.DP, RoundingMode.NORMAL).getIsZero();
 			}
 
 			/**
@@ -6353,6 +6358,43 @@ module.exports = function () {
 				return this._big.eq(getBig(other));
 			}
 
+			/**
+    * Returns true if the current instance is an integer (i.e. has no decimal
+    * component).
+    *
+    * @public
+    * @return {Boolean}
+    */
+
+		}, {
+			key: 'getIsInteger',
+			value: function getIsInteger() {
+				return this.getIsEqual(this.round(0));
+			}
+
+			/**
+    * Returns the number of decimal places used.
+    *
+    * @public
+    * @returns {Number}
+    */
+
+		}, {
+			key: 'getDecimalPlaces',
+			value: function getDecimalPlaces() {
+				var matches = this.toFixed().match(/-?\d*\.(\d*)/);
+
+				var returnVal = void 0;
+
+				if (matches === null) {
+					returnVal = 0;
+				} else {
+					returnVal = matches[1].length;
+				}
+
+				return returnVal;
+			}
+
 			/**
     * Emits a floating point value that approximates the value of the current
     * instance.
@@ -6435,7 +6477,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @return {Boolean}
+    * @returns {Boolean}
     */
 			value: function getIsZero(instance) {
 				assert.argumentIsRequired(instance, 'instance', Decimal, 'Decimal');
@@ -6448,7 +6490,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @return {Boolean}
+    * @returns {Boolean}
     */
 
 		}, {
@@ -6464,7 +6506,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @return {Boolean}
+    * @returns {Boolean}
     */
 
 		}, {
@@ -6480,7 +6522,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @return {Boolean}
+    * @returns {Boolean}
     */
 
 		}, {
@@ -6496,7 +6538,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @return {Boolean}
+    * @returns {Boolean}
     */
 
 		}, {
@@ -6512,7 +6554,7 @@ module.exports = function () {
     *
     * @public
     * @param {Decimal} instance
-    * @return {Boolean}
+    * @returns {Boolean}
     */
 
 		}, {
@@ -6902,6 +6944,7 @@ module.exports = function () {
 		/**
    * The unique code.
    *
+   * @public
    * @returns {String}
    */
 
@@ -6914,6 +6957,7 @@ module.exports = function () {
     * Returns true if the provided {@link Enum} argument is equal
     * to the instance.
     *
+    * @public
     * @param {Enum} other
     * @returns {boolean}
     */
@@ -6938,6 +6982,7 @@ 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}
@@ -6957,6 +7002,7 @@ module.exports = function () {
 			/**
     * The description.
     *
+    * @public
     * @returns {String}
     */
 
@@ -6976,6 +7022,7 @@ module.exports = function () {
 			/**
     * Returns all of the enumeration's items (given an enumeration type).
     *
+    * @public
     * @param {Function} type - The enumeration to list.
     * @returns {Array}
     */
@@ -7433,7 +7480,7 @@ module.exports = function () {
     * Parses the value emitted by {@link Timestamp#toJSON}.
     *
     * @public
-    * @param {String} value
+    * @param {Number} value
     * @returns {Timestamp}
     */
 
@@ -8069,7 +8116,7 @@ module.exports = function () {
 
 				if (typeof itemConstraint === 'function' && itemConstraint !== Function) {
 					itemValidator = function itemValidator(value, index) {
-						return value instanceof itemConstraint || itemConstraint(value, variableName + '[' + index + ']');
+						return itemConstraint.prototype !== undefined && value instanceof itemConstraint || itemConstraint(value, variableName + '[' + index + ']');
 					};
 				} else {
 					itemValidator = function itemValidator(value, index) {
@@ -8179,7 +8226,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}
    */
@@ -8205,7 +8252,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 {*}
    */
@@ -8240,7 +8287,8 @@ 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 {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=} separator - The separator (defaults to a period character).
    */
 		write: function write(target, propertyNames, value, separator) {
@@ -8266,7 +8314,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) {
@@ -9519,7 +9567,7 @@ module.exports = function () {
 			}
 
 			/**
-    * Generates a function suitable for use by JSON.parse.
+    * Generates a function suitable for use by {@link JSON.parse}.
     *
     * @public
     * @returns {Function}
@@ -13644,9 +13692,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, '');
@@ -14449,7 +14497,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, ' ').trim();
+        return s.replace(/\([^)]*\)|[\n\t]/g, ' ').replace(/(\s\s+)/g, ' ').replace(/^\s\s*/, '').replace(/\s\s*$/, '');
     }
 
     function checkWeekday(weekdayStr, parsedInput, config) {
@@ -16628,7 +16676,7 @@ moment.tz.load(require('./data/packed/latest.json'));
     // Side effect imports
 
 
-    hooks.version = '2.22.1';
+    hooks.version = '2.22.2';
 
     setHookCallback(createLocal);