Release. Bump version number

Author: bryaningl3

docs/_coverpage.md

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

example/browser/example.js

@@ -1985,7 +1985,7 @@ module.exports = (() => {
         return;
       }
 
-      retrieveProfileExtensions(array.difference(symbols, __completedProfileExtensions), __loginInfo.username, __loginInfo.password).then(extensions => {
+      retrieveProfileExtensions(array.difference(symbols, __completedProfileExtensions)).then(extensions => {
         if (__connectionState !== state.authenticated) {
           return;
         }
@@ -3282,14 +3282,14 @@ module.exports = (() => {
    * @returns {Promise<ProfileExtension[]>}
    */
 
-  function retrieveExtensions(symbols, username, password) {
+  function retrieveExtensions(symbols) {
     return Promise.resolve().then(() => {
       if (logger === null) {
         logger = LoggerFactory.getLogger('@barchart/marketdata-api-js');
       }
 
       assert.argumentIsArray(symbols, 'symbols', String);
-      return Promise.all([retrieveExtensionsForC3(symbols.filter(SymbolParser.getIsC3)), retrieveExtensionsForCmdtyStats(symbols.filter(SymbolParser.getIsCmdtyStats)), retrieveExtensionsForFutures(symbols.filter(SymbolParser.getIsFuture)), retrieveExtensionsForFuturesOptions(symbols.filter(SymbolParser.getIsFutureOption))]).then(results => {
+      return Promise.all([retrieveExtensionsForC3(symbols.filter(SymbolParser.getIsC3)), retrieveExtensionsForCmdtyStats(symbols.filter(SymbolParser.getIsCmdtyStats)), retrieveExtensionsForFutures(symbols.filter(SymbolParser.getIsFuture)), retrieveExtensionsForFuturesOptions(symbols.filter(SymbolParser.getIsFutureOption)), retrieveExtensionsForGrainBids(symbols.filter(SymbolParser.getIsGrainBid))]).then(results => {
         return array.flatten(results);
       });
     });
@@ -3510,6 +3510,34 @@ module.exports = (() => {
     });
   }
 
+  function retrieveExtensionsForGrainBids(symbols) {
+    return Promise.resolve().then(() => {
+      if (symbols.length === 0) {
+        return Promise.resolve([]);
+      }
+
+      const options = {
+        url: `https://instrument-extensions.aws.barchart.com/v1/grains/meta?&symbols=${encodeURIComponent(symbols.join())}`,
+        method: 'GET'
+      };
+      return Promise.resolve(axios(options)).then(response => {
+        if (response.status !== 200) {
+          return [];
+        }
+
+        const results = (response.data || []).filter(result => {
+          return result.meta !== null;
+        });
+        return results.map(result => {
+          const extension = {};
+          extension.symbol = result.symbol;
+          extension.grainBid = result.meta;
+          return extension;
+        });
+      });
+    });
+  }
+
   const regex = {};
   regex.dates = {};
   regex.dates.expire = /^([0-9]{4}-[0-9]{2}-[0-9]{2})T/;
@@ -3541,9 +3569,10 @@ module.exports = (() => {
    * @ignore
    * @property {String} symbol
    * @property {String=} expiration
-   * @property {String=} firstNotice
    * @property {Object=} c3
    * @property {Object=} cmdtyStats
+   * @property {String=} firstNotice
+   * @property {Object=} grainBid
    * @property {Object=} option
    */
 
@@ -4809,6 +4838,10 @@ module.exports = (() => {
         profile.cmdtyStats = extension.cmdtyStats;
       }
 
+      if (extension.grainBid) {
+        profile.grainBid = extension.grainBid;
+      }
+
       if (extension.option) {
         profile.option = extension.option;
       }
@@ -6109,7 +6142,7 @@ module.exports = (() => {
   'use strict';
 
   return {
-    version: '5.26.0'
+    version: '5.27.0'
   };
 })();
 
@@ -8091,7 +8124,7 @@ module.exports = (() => {
       return is.string(symbol) && types.indicies.external.test(symbol);
     }
     /**
-     * Returns true if the symbol represents an Barchart sector (i.e. a type
+     * Returns true if the symbol represents a Barchart sector (i.e. a type
      * of index calculated by Barchart).
      *
      * @public
@@ -8244,6 +8277,19 @@ module.exports = (() => {
     static getIsPit(symbol, name) {
       return is.string(symbol) && is.string(name) && predicates.pit.test(name);
     }
+    /**
+     * Returns true if the symbol represents a grain bid instrument.
+     *
+     * @public
+     * @static
+     * @param {String} symbol
+     * @returns {Boolean}
+     */
+
+
+    static getIsGrainBid(symbol) {
+      return is.string(symbol) && types.bids.test(symbol);
+    }
     /**
      * Returns a simple instrument definition containing information which
      * can be inferred from the symbol. A null value is returned if nothing
@@ -8412,6 +8458,7 @@ module.exports = (() => {
   predicates.percent = /(\.RT)$/;
   predicates.pit = /\(P(it)?\)/;
   const types = {};
+  types.bids = /^([A-Z]{2})([B|P])([A-Z\d]{3,4})-(\d+)-(\d+)(\.CM)$/i;
   types.c3 = {};
   types.c3.alias = /^(C3:)(.*)$/i;
   types.c3.concrete = /(\.C3)$/i;

lib/meta.js

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

package.json

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

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

@@ -3066,7 +3066,7 @@ module.exports = (() => {
       return is.string(symbol) && types.indicies.external.test(symbol);
     }
     /**
-     * Returns true if the symbol represents an Barchart sector (i.e. a type
+     * Returns true if the symbol represents a Barchart sector (i.e. a type
      * of index calculated by Barchart).
      *
      * @public
@@ -3219,6 +3219,19 @@ module.exports = (() => {
     static getIsPit(symbol, name) {
       return is.string(symbol) && is.string(name) && predicates.pit.test(name);
     }
+    /**
+     * Returns true if the symbol represents a grain bid instrument.
+     *
+     * @public
+     * @static
+     * @param {String} symbol
+     * @returns {Boolean}
+     */
+
+
+    static getIsGrainBid(symbol) {
+      return is.string(symbol) && types.bids.test(symbol);
+    }
     /**
      * Returns a simple instrument definition containing information which
      * can be inferred from the symbol. A null value is returned if nothing
@@ -3387,6 +3400,7 @@ module.exports = (() => {
   predicates.percent = /(\.RT)$/;
   predicates.pit = /\(P(it)?\)/;
   const types = {};
+  types.bids = /^([A-Z]{2})([B|P])([A-Z\d]{3,4})-(\d+)-(\d+)(\.CM)$/i;
   types.c3 = {};
   types.c3.alias = /^(C3:)(.*)$/i;
   types.c3.concrete = /(\.C3)$/i;
@@ -21936,6 +21950,14 @@ describe('When checking to see if a symbol is a BATS listing', () => {
     expect(SymbolParser.getIsBats('IBM.BZ')).toEqual(true);
   });
 });
+describe('When checking to see if a symbol is a grain bids instrument', () => {
+  it('the symbol "IBM" should return false', () => {
+    expect(SymbolParser.getIsGrainBid('IBM')).toEqual(false);
+  });
+  it('the symbol "ZCPN22-4574-5387.CM" should return true', () => {
+    expect(SymbolParser.getIsGrainBid('ZCPN22-4574-5387.CM')).toEqual(true);
+  });
+});
 describe('When checking to see if a symbol is pit-traded', () => {
   it('the symbol "IBM" (with the name "International Business Machines") should return false', () => {
     expect(SymbolParser.getIsPit('IBM', 'International Business Machines')).toEqual(false);