@barchart/portfolio-api-common 1.3.24 → 1.4.3

package/test/SpecRunner.js

@@ -253,7 +253,7 @@ module.exports = (() => {
 		}
 
 		toString() {
-			return '[InstrumentType]';
+			return `[InstrumentType (code=${this.code})]`;
 		}
 	}
 
@@ -393,6 +393,10 @@ module.exports = (() => {
 				return even;
 			}
 		}
+
+		toString() {
+			return `[PositionDirection (code=${this.code})]`;
+		}
 	}
 
 	const long = new PositionDirection('LONG', 'Long', 'positive');
@@ -580,7 +584,7 @@ module.exports = (() => {
 		}
 
 		toString() {
-			return '[PositionSummaryFrame]';
+			return `[PositionSummaryFrame (code=${this.code})]`;
 		}
 	}
 
@@ -1247,7 +1251,7 @@ module.exports = (() => {
 		}
 
 		toString() {
-			return '[TransactionType]';
+			return `[TransactionType (code=${this.code})]`;
 		}
 	}
 
@@ -1755,7 +1759,7 @@ module.exports = (() => {
 				const tree = new Tree();
 
 				createGroups.call(this, tree, this._items, treeDefinition, treeDefinition.definitions);
-				
+
 				map[treeDefinition.name] = tree;
 
 				return map;
@@ -2087,6 +2091,41 @@ module.exports = (() => {
 			return is.object(item) && item.data.locked;
 		}
 
+		/**
+		 * Causes a position to be flagged as calculating.
+		 *
+		 * @public
+		 * @param {Object} position
+		 */
+		setPositionCalculating(position) {
+			if (position) {
+				assert.argumentIsRequired(position, 'position', Object);
+				assert.argumentIsRequired(position.position, 'position.position', String);
+
+				const item = this._items.find(i => i.position.position === position.position);
+
+				if (item) {
+					item.setPositionCalculating(position);
+				}
+			}
+		}
+
+		/**
+		 * Returns a position's calculating status.
+		 *
+		 * @public
+		 * @param {Object} position
+		 * @return {Boolean}
+		 */
+		getPositionCalculating(position) {
+			assert.argumentIsRequired(position, 'position', Object);
+			assert.argumentIsRequired(position.position, 'position.position', String);
+
+			const item = this._items.find(i => i.position.position === position.position);
+
+			return is.object(item) && item.data.calculating;
+		}
+
 		/**
 		 * Performs a batch update of both position quotes and forex quotes,
 		 * triggering updates to position(s) and data aggregation(s).
@@ -2139,6 +2178,26 @@ module.exports = (() => {
 			}
 		}
 
+		/**
+		 * Returns current price for symbol provided.
+		 *
+		 * @param {String} symbol
+		 * @return {null|Number}
+		 */
+		getCurrentPrice(symbol) {
+			assert.argumentIsRequired(symbol, 'symbol', String);
+
+			let price;
+
+			if (this._symbols.hasOwnProperty(symbol) && this._symbols[symbol].length > 0) {
+				price = this._symbols[symbol][0].currentPrice;
+			} else {
+				price = null;
+			}
+
+			return price;
+		}
+
 		/**
 		 * Sets a historical forex quote.
 		 *
@@ -2749,6 +2808,7 @@ module.exports = (() => {
 			this._dataFormat.hide = false;
 			this._dataFormat.invalid = false;
 			this._dataFormat.locked = false;
+			this._dataFormat.calculating = false;
 			this._dataFormat.newsExists = false;
 			this._dataFormat.quantity = null;
 			this._dataFormat.quantityPrevious = null;
@@ -3256,6 +3316,7 @@ module.exports = (() => {
 
 		let newsBinding = Disposable.getEmpty();
 		let lockedBinding = Disposable.getEmpty();
+		let calculatingBinding = Disposable.getEmpty();
 
 		if (this._single) {
 			newsBinding = item.registerNewsExistsChangeHandler((exists) => {
@@ -3266,6 +3327,10 @@ module.exports = (() => {
 			lockedBinding = item.registerLockChangeHandler((locked) => {
 				this._dataFormat.locked = locked;
 			});
+
+			calculatingBinding = item.registerCalculatingChangeHandler((calculating) => {
+				this._dataFormat.calculating = calculating;
+			});
 		}
 
 		this._disposeStack.push(item.registerPortfolioChangeHandler((portfolio) => {
@@ -3280,6 +3345,7 @@ module.exports = (() => {
 		this._disposeStack.push(fundamentalBinding);
 		this._disposeStack.push(quoteBinding);
 		this._disposeStack.push(lockedBinding);
+		this._disposeStack.push(calculatingBinding);
 		this._disposeStack.push(newsBinding);
 
 		this._disposeStack.push(item.registerPositionItemDisposeHandler(() => {
@@ -3287,6 +3353,7 @@ module.exports = (() => {
 			quoteBinding.dispose();
 			newsBinding.dispose();
 			lockedBinding.dispose();
+			calculatingBinding.dispose();
 
 			array.remove(this._items, i => i === item);
 			array.remove(this._excludedItems, i => i === item);
@@ -3339,7 +3406,7 @@ module.exports = (() => {
 		const format = group._dataFormat;
 
 		const currency = group.currency;
-		
+
 		const items = group._consideredItems;
 
 		group._bypassCurrencyTranslation = items.every(item => item.currency === currency);
@@ -3470,6 +3537,7 @@ module.exports = (() => {
 
 			format.invalid = definition.type === PositionLevelType.POSITION && item.invalid;
 			format.locked = definition.type === PositionLevelType.POSITION && item.data.locked;
+			format.calculating = definition.type === PositionLevelType.POSITION && item.data.calculating;
 		}
 
 		let portfolioType = null;
@@ -3575,7 +3643,7 @@ module.exports = (() => {
 		actual.marketChangePercent = marketChangePercent;
 
 		format.market = formatCurrency(actual.market, currency);
-		
+
 		if (updates.marketDirection.up || updates.marketDirection.down) {
 			format.marketDirection = unchanged;
 			setTimeout(() => format.marketDirection = updates.marketDirection, 0);
@@ -3764,7 +3832,7 @@ module.exports = (() => {
 
 			this._data.quantity = null;
 			this._data.quantityPrevious = null;
-			
+
 			this._data.realized = null;
 			this._data.income = null;
 			this._data.basisPrice = null;
@@ -3796,12 +3864,14 @@ module.exports = (() => {
 
 			this._data.newsExists = false;
 			this._data.fundamental = { };
+			this._data.calculating = getIsCalculating(position);
 			this._data.locked = getIsLocked(position);
 
 			this._quoteChangedEvent = new Event(this);
 			this._newsExistsChangedEvent = new Event(this);
 			this._fundamentalDataChangedEvent = new Event(this);
 			this._lockChangedEvent = new Event(this);
+			this._calculatingChangedEvent = new Event(this);
 			this._portfolioChangedEvent = new Event(this);
 			this._positionItemDisposeEvent = new Event(this);
 
@@ -3899,6 +3969,15 @@ module.exports = (() => {
 			return this._previousQuote;
 		}
 
+		/**
+		 * The current price.
+		 *
+		 * @return {null|Number}
+		 */
+		get currentPrice() {
+			return this._currentPrice;
+		}
+
 		updatePortfolio(portfolio) {
 			assert.argumentIsRequired(portfolio, 'portfolio', Object);
 			assert.argumentIsRequired(portfolio.portfolio, 'portfolio.portfolio', String);
@@ -3998,6 +4077,26 @@ module.exports = (() => {
 			}
 		}
 
+		/**
+		 * Sets a position's calculating status.
+		 *
+		 * @public
+		 * @param {Object} position
+		 */
+		setPositionCalculating(position) {
+			assert.argumentIsRequired(position, 'position', Object);
+
+			if (this.getIsDisposed()) {
+				return;
+			}
+
+			const value = getIsCalculating(position);
+
+			if (this._data.calculating !== value) {
+				this._calculatingChangedEvent.fire(this._data.calculating = value);
+			}
+		}
+
 		/**
 		 * Registers an observer for quote changes, which is fired after internal recalculations
 		 * of position data are complete.
@@ -4043,6 +4142,17 @@ module.exports = (() => {
 			return this._lockChangedEvent.register(handler);
 		}
 
+		/**
+		 * Registers an observer for position calculating changes.
+		 *
+		 * @public
+		 * @param {Function} handler
+		 * @return {Disposable}
+		 */
+		registerCalculatingChangeHandler(handler) {
+			return this._calculatingChangedEvent.register(handler);
+		}
+
 		/**
 		 * Registers an observer changes to portfolio metadata.
 		 *
@@ -4405,6 +4515,12 @@ module.exports = (() => {
 		return is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
 	}
 
+	function getIsCalculating(position) {
+		assert.argumentIsRequired(position, 'position', Object);
+
+		return is.object(position.system) && is.object(position.system.calculate) && is.number(position.system.calculate.processors) &&	position.system.calculate.processors > 0;
+	}
+
 	function getSnapshot(position, currentSummary, reporting) {
 		let snapshot;
 
@@ -8826,7 +8942,7 @@ module.exports = (() => {
 
   return {
     /**
-     * Returns true, if the argument is a number. NaN will return false.
+     * Returns true if the argument is a number. NaN will return false.
      *
      * @static
      * @public
@@ -8838,7 +8954,7 @@ module.exports = (() => {
     },
 
     /**
-     * Returns true, if the argument is NaN.
+     * Returns true if the argument is NaN.
      *
      * @static
      * @public
@@ -8850,7 +8966,7 @@ module.exports = (() => {
     },
 
     /**
-     * Returns true, if the argument is a valid 32-bit integer.
+     * Returns true if the argument is a valid 32-bit integer.
      *
      * @static
      * @public
@@ -8862,7 +8978,7 @@ module.exports = (() => {
     },
 
     /**
-     * Returns true, if the argument is a valid integer (which can exceed 32 bits); however,
+     * Returns true if the argument is a valid integer (which can exceed 32 bits); however,
      * the check can fail above the value of Number.MAX_SAFE_INTEGER.
      *
      * @static
@@ -8875,7 +8991,7 @@ module.exports = (() => {
     },
 
     /**
-     * Returns true, if the argument is a number that is positive.
+     * Returns true if the argument is a number that is positive.
      *
      * @static
      * @public
@@ -8887,7 +9003,7 @@ module.exports = (() => {
     },
 
     /**
-     * Returns true, if the argument is a number that is negative.
+     * Returns true if the argument is a number that is negative.
      *
      * @static
      * @public
@@ -8899,7 +9015,19 @@ module.exports = (() => {
     },
 
     /**
-     * Returns true, if the argument is a string.
+     * Returns true if the argument is iterable.
+     *
+     * @static
+     * @public
+     * @param {*} candidate
+     * @returns {boolean}
+     */
+    iterable(candidate) {
+      return !this.null(candidate) && !this.undefined(candidate) && this.fn(candidate[Symbol.iterator]);
+    },
+
+    /**
+     * Returns true if the argument is a string.
      *
      * @static
      * @public
@@ -8911,7 +9039,7 @@ module.exports = (() => {
     },
 
     /**
-     * Returns true, if the argument is a JavaScript Date instance.
+     * Returns true if the argument is a JavaScript Date instance.
      *
      * @static
      * @public
@@ -8923,7 +9051,7 @@ module.exports = (() => {
     },
 
     /**
-     * Returns true, if the argument is a function.
+     * Returns true if the argument is a function.
      *
      * @static
      * @public
@@ -8935,7 +9063,7 @@ module.exports = (() => {
     },
 
     /**
-     * Returns true, if the argument is an array.
+     * Returns true if the argument is an array.
      *
      * @static
      * @public
@@ -8947,7 +9075,7 @@ module.exports = (() => {
     },
 
     /**
-     * Returns true, if the argument is a Boolean value.
+     * Returns true if the argument is a Boolean value.
      *
      * @static
      * @public
@@ -8959,7 +9087,7 @@ module.exports = (() => {
     },
 
     /**
-     * Returns true, if the argument is an object.
+     * Returns true if the argument is an object.
      *
      * @static
      * @public
@@ -8971,7 +9099,7 @@ module.exports = (() => {
     },
 
     /**
-     * Returns true, if the argument is a null value.
+     * Returns true if the argument is a null value.
      *
      * @static
      * @public
@@ -8983,7 +9111,7 @@ module.exports = (() => {
     },
 
     /**
-     * Returns true, if the argument is an undefined value.
+     * Returns true if the argument is an undefined value.
      *
      * @static
      * @public
@@ -8994,6 +9122,18 @@ module.exports = (() => {
       return candidate === undefined;
     },
 
+    /**
+     * Returns true if the argument is a zero-length string.
+     *
+     * @static
+     * @public
+     * @param {*} candidate
+     * @returns {boolean}
+     */
+    zeroLengthString(candidate) {
+      return this.string(candidate) && candidate.length === 0;
+    },
+
     /**
      * Given two classes, determines if the "child" class extends
      * the "parent" class (without instantiation).
@@ -9033,11 +9173,11 @@ module.exports = (() => {
     simple(fn) {
       const cache = {};
       return x => {
-        if (cache.hasOwnProperty(x)) {
-          return cache[x];
-        } else {
-          return cache[x] = fn(x);
+        if (!cache.hasOwnProperty(x)) {
+          cache[x] = fn(x);
         }
+
+        return cache[x];
       };
     },
 
@@ -10172,9 +10312,9 @@ module.exports = (() => {
 
 },{"./../../../lang/assert":29,"./../../../lang/is":33,"./../Component":36,"./../DataType":37,"./../Field":38,"./../Schema":39,"./ComponentBuilder":40}],42:[function(require,module,exports){
 /*
- *  big.js v5.0.3
+ *  big.js v5.2.2
  *  A small, fast, easy-to-use library for arbitrary-precision decimal arithmetic.
- *  Copyright (c) 2017 Michael Mclaughlin <M8ch88l@gmail.com>
+ *  Copyright (c) 2018 Michael Mclaughlin <M8ch88l@gmail.com>
  *  https://github.com/MikeMcl/big.js/LICENCE
  */
 ;(function (GLOBAL) {
@@ -10280,7 +10420,7 @@ module.exports = (() => {
     Big.RM = RM;
     Big.NE = NE;
     Big.PE = PE;
-    Big.version = '5.0.2';
+    Big.version = '5.2.2';
 
     return Big;
   }
@@ -10364,7 +10504,7 @@ module.exports = (() => {
         more = xc[i] > 5 || xc[i] == 5 &&
           (more || i < 0 || xc[i + 1] !== UNDEFINED || xc[i - 1] & 1);
       } else if (rm === 3) {
-        more = more || xc[i] !== UNDEFINED || i < 0;
+        more = more || !!xc[0];
       } else {
         more = false;
         if (rm !== 0) throw Error(INVALID_RM);
@@ -10831,7 +10971,7 @@ module.exports = (() => {
     xc = xc.slice();
 
     // Prepend zeros to equalise exponents.
-    // Note: Faster to use reverse then do unshifts.
+    // Note: reverse faster than unshifts.
     if (a = xe - ye) {
       if (a > 0) {
         ye = xe;
@@ -10903,18 +11043,19 @@ module.exports = (() => {
 
 
   /*
-   * Return a new Big whose value is the value of this Big rounded to a maximum of dp decimal
-   * places using rounding mode rm.
+   * Return a new Big whose value is the value of this Big rounded using rounding mode rm
+   * to a maximum of dp decimal places, or, if dp is negative, to an integer which is a
+   * multiple of 10**-dp.
    * If dp is not specified, round to 0 decimal places.
    * If rm is not specified, use Big.RM.
    *
-   * dp? {number} Integer, 0 to MAX_DP inclusive.
+   * dp? {number} Integer, -MAX_DP to MAX_DP inclusive.
    * rm? 0, 1, 2 or 3 (ROUND_DOWN, ROUND_HALF_UP, ROUND_HALF_EVEN, ROUND_UP)
    */
   P.round = function (dp, rm) {
     var Big = this.constructor;
     if (dp === UNDEFINED) dp = 0;
-    else if (dp !== ~~dp || dp < 0 || dp > MAX_DP) throw Error(INVALID_DP);
+    else if (dp !== ~~dp || dp < -MAX_DP || dp > MAX_DP) throw Error(INVALID_DP);
     return round(new Big(this), dp, rm === UNDEFINED ? Big.RM : rm);
   };
 
@@ -10938,17 +11079,18 @@ module.exports = (() => {
     if (s < 0) throw Error(NAME + 'No square root');
 
     // Estimate.
-    s = Math.sqrt(x.toString());
+    s = Math.sqrt(x + '');
 
     // Math.sqrt underflow/overflow?
-    // Re-estimate: pass x to Math.sqrt as integer, then adjust the result exponent.
+    // Re-estimate: pass x coefficient to Math.sqrt as integer, then adjust the result exponent.
     if (s === 0 || s === 1 / 0) {
       c = x.c.join('');
       if (!(c.length + e & 1)) c += '0';
-      r = new Big(Math.sqrt(c).toString());
-      r.e = ((e + 1) / 2 | 0) - (e < 0 || e & 1);
+      s = Math.sqrt(c);
+      e = ((e + 1) / 2 | 0) - (e < 0 || e & 1);
+      r = new Big((s == 1 / 0 ? '1e' : (s = s.toExponential()).slice(0, s.indexOf('e') + 1)) + e);
     } else {
-      r = new Big(s.toString());
+      r = new Big(s);
     }
 
     e = r.e + (Big.DP += 4);
@@ -16972,43 +17114,48 @@ for (var i = 0; i < 256; ++i) {
 function bytesToUuid(buf, offset) {
   var i = offset || 0;
   var bth = byteToHex;
-  return bth[buf[i++]] + bth[buf[i++]] +
-          bth[buf[i++]] + bth[buf[i++]] + '-' +
-          bth[buf[i++]] + bth[buf[i++]] + '-' +
-          bth[buf[i++]] + bth[buf[i++]] + '-' +
-          bth[buf[i++]] + bth[buf[i++]] + '-' +
-          bth[buf[i++]] + bth[buf[i++]] +
-          bth[buf[i++]] + bth[buf[i++]] +
-          bth[buf[i++]] + bth[buf[i++]];
+  // join used to fix memory issue caused by concatenation: https://bugs.chromium.org/p/v8/issues/detail?id=3175#c4
+  return ([
+    bth[buf[i++]], bth[buf[i++]],
+    bth[buf[i++]], bth[buf[i++]], '-',
+    bth[buf[i++]], bth[buf[i++]], '-',
+    bth[buf[i++]], bth[buf[i++]], '-',
+    bth[buf[i++]], bth[buf[i++]], '-',
+    bth[buf[i++]], bth[buf[i++]],
+    bth[buf[i++]], bth[buf[i++]],
+    bth[buf[i++]], bth[buf[i++]]
+  ]).join('');
 }
 
 module.exports = bytesToUuid;
 
 },{}],49:[function(require,module,exports){
-(function (global){
 // Unique ID creation requires a high quality random # generator.  In the
 // browser this is a little complicated due to unknown quality of Math.random()
 // and inconsistent support for the `crypto` API.  We do the best we can via
 // feature-detection
-var rng;
 
-var crypto = global.crypto || global.msCrypto; // for IE 11
-if (crypto && crypto.getRandomValues) {
+// getRandomValues needs to be invoked in a context where "this" is a Crypto
+// implementation. Also, find the complete implementation of crypto on IE11.
+var getRandomValues = (typeof(crypto) != 'undefined' && crypto.getRandomValues && crypto.getRandomValues.bind(crypto)) ||
+                      (typeof(msCrypto) != 'undefined' && typeof window.msCrypto.getRandomValues == 'function' && msCrypto.getRandomValues.bind(msCrypto));
+
+if (getRandomValues) {
   // WHATWG crypto RNG - http://wiki.whatwg.org/wiki/Crypto
   var rnds8 = new Uint8Array(16); // eslint-disable-line no-undef
-  rng = function whatwgRNG() {
-    crypto.getRandomValues(rnds8);
+
+  module.exports = function whatwgRNG() {
+    getRandomValues(rnds8);
     return rnds8;
   };
-}
-
-if (!rng) {
+} else {
   // Math.random()-based (RNG)
   //
   // If all else fails, use Math.random().  It's fast, but is of unspecified
   // quality.
   var rnds = new Array(16);
-  rng = function() {
+
+  module.exports = function mathRNG() {
     for (var i = 0, r; i < 16; i++) {
       if ((i & 0x03) === 0) r = Math.random() * 0x100000000;
       rnds[i] = r >>> ((i & 0x03) << 3) & 0xff;
@@ -17018,9 +17165,6 @@ if (!rng) {
   };
 }
 
-module.exports = rng;
-
-}).call(this,typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : {})
 },{}],50:[function(require,module,exports){
 var rng = require('./lib/rng');
 var bytesToUuid = require('./lib/bytesToUuid');
@@ -17030,30 +17174,40 @@ var bytesToUuid = require('./lib/bytesToUuid');
 // Inspired by https://github.com/LiosK/UUID.js
 // and http://docs.python.org/library/uuid.html
 
-// random #'s we need to init node and clockseq
-var _seedBytes = rng();
-
-// Per 4.5, create and 48-bit node id, (47 random bits + multicast bit = 1)
-var _nodeId = [
-  _seedBytes[0] | 0x01,
-  _seedBytes[1], _seedBytes[2], _seedBytes[3], _seedBytes[4], _seedBytes[5]
-];
-
-// Per 4.2.2, randomize (14 bit) clockseq
-var _clockseq = (_seedBytes[6] << 8 | _seedBytes[7]) & 0x3fff;
+var _nodeId;
+var _clockseq;
 
 // Previous uuid creation time
-var _lastMSecs = 0, _lastNSecs = 0;
+var _lastMSecs = 0;
+var _lastNSecs = 0;
 
-// See https://github.com/broofa/node-uuid for API details
+// See https://github.com/uuidjs/uuid for API details
 function v1(options, buf, offset) {
   var i = buf && offset || 0;
   var b = buf || [];
 
   options = options || {};
-
+  var node = options.node || _nodeId;
   var clockseq = options.clockseq !== undefined ? options.clockseq : _clockseq;
 
+  // node and clockseq need to be initialized to random values if they're not
+  // specified.  We do this lazily to minimize issues related to insufficient
+  // system entropy.  See #189
+  if (node == null || clockseq == null) {
+    var seedBytes = rng();
+    if (node == null) {
+      // Per 4.5, create and 48-bit node id, (47 random bits + multicast bit = 1)
+      node = _nodeId = [
+        seedBytes[0] | 0x01,
+        seedBytes[1], seedBytes[2], seedBytes[3], seedBytes[4], seedBytes[5]
+      ];
+    }
+    if (clockseq == null) {
+      // Per 4.2.2, randomize (14 bit) clockseq
+      clockseq = _clockseq = (seedBytes[6] << 8 | seedBytes[7]) & 0x3fff;
+    }
+  }
+
   // UUID timestamps are 100 nano-second units since the Gregorian epoch,
   // (1582-10-15 00:00).  JSNumbers aren't precise enough for this, so
   // time is handled internally as 'msecs' (integer milliseconds) and 'nsecs'
@@ -17113,7 +17267,6 @@ function v1(options, buf, offset) {
   b[i++] = clockseq & 0xff;
 
   // `node`
-  var node = options.node || _nodeId;
   for (var n = 0; n < 6; ++n) {
     b[i + n] = node[n];
   }
@@ -17131,7 +17284,7 @@ function v4(options, buf, offset) {
   var i = buf && offset || 0;
 
   if (typeof(options) == 'string') {
-    buf = options == 'binary' ? new Array(16) : null;
+    buf = options === 'binary' ? new Array(16) : null;
     options = null;
   }
   options = options || {};

package/jsdoc.json

@@ -1,8 +0,0 @@
-{
-    "source": {
-        "include": [ "." ],
-        "exclude": [ "./node_modules", "./test" ],
-        "includePattern": ".+\\.js(doc|x)?$",
-        "excludePattern": "(^|\\/|\\\\)_"
-    }
-}