Release. Bump version number

Author: bryaningl3

docs/_coverpage.md

@@ -1,4 +1,4 @@
-# Barchart Market Data SDK <small>JavaScript 5.23.0</small>
+# Barchart Market Data SDK <small>JavaScript 5.24.0</small>
 
 > Inject real-time market data into your JavaScript applications
 

example/browser/example.js

@@ -2286,7 +2286,7 @@ module.exports = (() => {
 
 
     function getIsExtendedQuoteSymbol(symbol) {
-      return SymbolParser.getIsFuture(symbol);
+      return SymbolParser.getIsFuture(symbol) || SymbolParser.getIsCmdtyStats(symbol);
     }
     /**
      * Breaks an array of symbols into multiple array, each containing no more
@@ -3622,7 +3622,7 @@ module.exports = (() => {
       const futuresSymbols = array.unique(symbolsToUse.filter(s => SymbolParser.getIsFuture(s) && SymbolParser.getIsConcrete(s)).sort());
 
       if (futuresSymbols.length !== 0) {
-        promises.push(retrieveFuturesHiLo(futuresSymbols, username, password).then(results => {
+        promises.push(retrieveFuturesHiLo(futuresSymbols).then(results => {
           results.forEach(result => {
             if (result.hilo) {
               const extension = getOrCreateExtension(result.symbol);
@@ -3637,6 +3637,29 @@ module.exports = (() => {
         }));
       }
 
+      const cmdtyStatsSymbols = array.unique(symbolsToUse.filter(s => SymbolParser.getIsCmdtyStats(s)).sort());
+
+      if (cmdtyStatsSymbols.length !== 0) {
+        promises.push(retrieveCmdtyStatsDates(cmdtyStatsSymbols).then(results => {
+          results.forEach(result => {
+            if (result.quote) {
+              const extension = getOrCreateExtension(result.symbol);
+              const cmdtyStats = {};
+
+              if (result.quote.current) {
+                cmdtyStats.currentDate = result.quote.current.date;
+              }
+
+              if (result.quote.previous) {
+                cmdtyStats.previousDate = result.quote.previous.date;
+              }
+
+              extension.cmdtyStats = cmdtyStats;
+            }
+          });
+        }));
+      }
+
       if (promises.length === 0) {
         return Promise.resolve([]);
       }
@@ -3650,14 +3673,12 @@ module.exports = (() => {
    * Retrieves all-time highs and lows for specific futures contracts.
    *
    * @private
-   * @param symbols
-   * @param username
-   * @param password
+   * @param {String[]} symbols
    * @returns {Promise<Object[]>}
    */
 
 
-  function retrieveFuturesHiLo(symbols, username, password) {
+  function retrieveFuturesHiLo(symbols) {
     return Promise.resolve().then(() => {
       const options = {
         url: `https://instrument-extensions.aws.barchart.com/v1/futures/hilo?&symbols=${encodeURIComponent(symbols.join())}`,
@@ -3668,6 +3689,26 @@ module.exports = (() => {
       });
     });
   }
+  /**
+   * Retrieves current and previous quote dates for cmdtyStats instruments.
+   *
+   * @private
+   * @param {String[]} symbols
+   * @returns {Promise<Object[]>}
+   */
+
+
+  function retrieveCmdtyStatsDates(symbols) {
+    return Promise.resolve().then(() => {
+      const options = {
+        url: `https://instrument-extensions.aws.barchart.com/v1/cmdtyStats/quote?&symbols=${encodeURIComponent(symbols.join())}`,
+        method: 'GET'
+      };
+      return Promise.resolve(axios(options)).then(response => {
+        return response.data || [];
+      });
+    });
+  }
   /**
    * Extended quote information.
    *
@@ -3676,6 +3717,7 @@ module.exports = (() => {
    * @ignore
    * @property {String} symbol
    * @property {QuoteExtensionHiLo=} hilo
+   * @property {QuoteExtensionCmdtyStatus=} cmdtyStats
    */
 
   /**
@@ -3690,6 +3732,16 @@ module.exports = (() => {
    * @property {Day=} lowDate
    */
 
+  /**
+   * Extended quote information (for cmdtyStats instruments).
+   *
+   * @typedef QuoteExtensionCmdtyStats
+   * @type {Object}
+   * @ignore
+   * @property {Day=} currentDate
+   * @property {Day=} previousDate
+   */
+
 
   return retrieveExtensions;
 })();
@@ -4671,9 +4723,9 @@ module.exports = (() => {
     };
 
     const _processQuoteExtension = (quote, extension) => {
-      if (extension.hilo) {
-        const hilo = extension.hilo;
+      const hilo = extension.hilo;
 
+      if (hilo) {
         if (is.number(hilo.highPrice)) {
           quote.recordHighPrice = Math.max(hilo.highPrice, is.number(quote.highPrice) ? quote.highPrice : Number.MIN_SAFE_INTEGER);
         }
@@ -4682,6 +4734,18 @@ module.exports = (() => {
           quote.recordLowPrice = Math.min(hilo.lowPrice, is.number(quote.lowPrice) ? quote.lowPrice : Number.MAX_SAFE_INTEGER);
         }
       }
+
+      const cmdtyStats = extension.cmdtyStats;
+
+      if (cmdtyStats) {
+        if (cmdtyStats.currentDate) {
+          quote.currentDate = cmdtyStats.currentDate;
+        }
+
+        if (cmdtyStats.previousDate) {
+          quote.previousDate = cmdtyStats.previousDate;
+        }
+      }
     };
 
     const _getOrCreateQuote = symbol => {
@@ -5983,7 +6047,7 @@ module.exports = (() => {
   'use strict';
 
   return {
-    version: '5.23.0'
+    version: '5.24.0'
   };
 })();
 
@@ -7991,7 +8055,7 @@ module.exports = (() => {
       return is.string(symbol) && (types.cmdty.stats.test(symbol) || types.cmdty.internal.test(symbol) || types.cmdty.external.test(symbol));
     }
     /**
-     * Returns true if the symbol represents cmdtyStats symbol.
+     * Returns true if the symbol represents a cmdtyStats instrument.
      *
      * @public
      * @static

lib/meta.js

@@ -2,6 +2,6 @@ module.exports = (() => {
 	'use strict';
 
 	return {
-		version: '5.23.0'
+		version: '5.24.0'
 	};
 })();

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@barchart/marketdata-api-js",
-	"version": "5.23.0",
+	"version": "5.24.0",
 	"description": "SDK for streaming market data from Barchart.com",
 	"author": {
 		"name": "Eero Pikat",

test/dist/barchart-marketdata-api-tests-5.js

@@ -3092,7 +3092,7 @@ module.exports = (() => {
       return is.string(symbol) && (types.cmdty.stats.test(symbol) || types.cmdty.internal.test(symbol) || types.cmdty.external.test(symbol));
     }
     /**
-     * Returns true if the symbol represents cmdtyStats symbol.
+     * Returns true if the symbol represents a cmdtyStats instrument.
      *
      * @public
      * @static