@smartcar/auth 2.8.0 → 2.10.0

package/README.md

@@ -24,7 +24,7 @@ npm install @smartcar/auth
 ### Smartcar CDN
 
 ```html
-<script src="https://javascript-sdk.smartcar.com/2.8.0/sdk.js"></script>
+<script src="https://javascript-sdk.smartcar.com/2.10.0/sdk.js"></script>
 ```
 
 ## SDK reference
@@ -178,4 +178,4 @@ https://application-backend.com/page?error=access_denied&error_description=User+
 [tag-image]: https://img.shields.io/github/tag/smartcar/javascript-sdk.svg
 
 <!-- Please do not modify or remove this, it is used by the build process -->
-[version]: 2.8.0
+[version]: 2.10.0

package/dist/npm/sdk.js

@@ -1,32 +1,69 @@
-var _slicedToArray = function () { function sliceIterator(arr, i) { var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"]) _i["return"](); } finally { if (_d) throw _e; } } return _arr; } return function (arr, i) { if (Array.isArray(arr)) { return arr; } else if (Symbol.iterator in Object(arr)) { return sliceIterator(arr, i); } else { throw new TypeError("Invalid attempt to destructure non-iterable instance"); } }; }();
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
 
-var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
 
-var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; };
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
 
-function _possibleConstructorReturn(self, call) { if (!self) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return call && (typeof call === "object" || typeof call === "function") ? call : self; }
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
 
-function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
+function _wrapNativeSuper(Class) { var _cache = typeof Map === "function" ? new Map() : undefined; _wrapNativeSuper = function _wrapNativeSuper(Class) { if (Class === null || !_isNativeFunction(Class)) return Class; if (typeof Class !== "function") { throw new TypeError("Super expression must either be null or a function"); } if (typeof _cache !== "undefined") { if (_cache.has(Class)) return _cache.get(Class); _cache.set(Class, Wrapper); } function Wrapper() { return _construct(Class, arguments, _getPrototypeOf(this).constructor); } Wrapper.prototype = Object.create(Class.prototype, { constructor: { value: Wrapper, enumerable: false, writable: true, configurable: true } }); return _setPrototypeOf(Wrapper, Class); }; return _wrapNativeSuper(Class); }
 
-function _toConsumableArray(arr) { if (Array.isArray(arr)) { for (var i = 0, arr2 = Array(arr.length); i < arr.length; i++) { arr2[i] = arr[i]; } return arr2; } else { return Array.from(arr); } }
+function _construct(Parent, args, Class) { if (_isNativeReflectConstruct()) { _construct = Reflect.construct.bind(); } else { _construct = function _construct(Parent, args, Class) { var a = [null]; a.push.apply(a, args); var Constructor = Function.bind.apply(Parent, a); var instance = new Constructor(); if (Class) _setPrototypeOf(instance, Class.prototype); return instance; }; } return _construct.apply(null, arguments); }
+
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+
+function _isNativeFunction(fn) { return Function.toString.call(fn).indexOf("[native code]") !== -1; }
+
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
+
+function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e2) { throw _e2; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e3) { didErr = true; err = _e3; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
 
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
-;(function (root, factory) {
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+
+;
+
+(function (root, factory) {
   /* istanbul ignore next */
   if (typeof define === 'function' && define.amd) {
     define([], factory);
-  } else if ((typeof exports === 'undefined' ? 'undefined' : _typeof(exports)) === 'object') {
+  } else if ((typeof exports === "undefined" ? "undefined" : _typeof(exports)) === 'object') {
     module.exports = factory();
   } else {
     root.Smartcar = factory();
   }
 })(this, function () {
   'use strict';
-
   /* eslint-env node */
 
-  var Smartcar = function () {
+  var Smartcar = /*#__PURE__*/function () {
     /**
      * @callback OnComplete
      * @param {?Error} error - something went wrong in Connect; this
@@ -36,6 +73,10 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
      * backend sever for an access token
      * @param {Object} [state] - contains state if it was set on the initial
      * authorization request
+     * @param {String} [virtualKeyUrl] - virtual key URL used by Tesla to register
+     * Smartcar's virtual key on a vehicle. This registration will be required in order to use
+     * any commands on a Tesla vehicle. It is an optional argument as it is only included in
+     * specific cases.
      */
 
     /**
@@ -48,8 +89,11 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
      * application
      * @param {String[]} [options.scope] - requested permission scopes
      * @param {OnComplete} [options.onComplete] - called on completion of Smartcar Connect
-     * @param {Boolean} [options.testMode=false] - launch Smartcar Connect in test mode
-     */
+     * @param {Boolean} [options.testMode=false] - Deprecated, please use `mode` instead.
+     * Launch Smartcar Connect in [test mode](https://smartcar.com/docs/guides/testing/).
+     * @param {String} [options.mode='live'] - Determine what mode Smartcar Connect should be
+     * launched in. Should be one of test, live or simulated.
+    */
     function Smartcar(options) {
       var _this = this;
 
@@ -63,37 +107,50 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
           position = position || 0;
           return this.substr(position, searchString.length) === searchString;
         };
-      }
+      } // ensure options are well formed
+
 
-      // ensure options are well formed
       Smartcar._validateConstructorOptions(options);
 
       this.clientId = options.clientId;
       this.redirectUri = options.redirectUri;
       this.scope = options.scope;
       this.onComplete = options.onComplete;
-      this.mode = options.testMode === true ? 'test' : 'live';
-      this.responseType = 'code';
-      // identifier for matching message event and multiple Smartcar instances
+      this.mode = 'live';
+
+      if (options.hasOwnProperty('testMode')) {
+        // eslint-disable-next-line no-console
+        console.warn('The "testMode" parameter is deprecated, please use the "mode" parameter instead.');
+        this.mode = options.testMode === true ? 'test' : 'live';
+      } else if (options.hasOwnProperty('mode')) {
+        this.mode = options.mode;
+      }
+
+      if (!['test', 'live', 'simulated'].includes(this.mode)) {
+        throw new Error('The "mode" parameter MUST be one of the following: \'test\', \'live\', \'simulated\'');
+      }
+
+      this.responseType = 'code'; // identifier for matching message event and multiple Smartcar instances
       // it is a string composed of a timestamp and a 8-digit random number
-      this.instanceId = new Date().getTime() + String(Math.random()).slice(2, 10);
 
-      // handler
+      this.instanceId = new Date().getTime() + String(Math.random()).slice(2, 10); // handler
+
       this.messageHandler = function (event) {
         // bail if message from unexpected source
         if (!_this.redirectUri.startsWith(event.origin)) {
           return;
         }
 
-        var message = event.data || {};
-        // bail if `message.name` is not `SmartcarAuthMessage`
+        var message = event.data || {}; // bail if `message.name` is not `SmartcarAuthMessage`
         // this prevents attempting to handle messages intended for others
+
         if (message.name !== 'SmartcarAuthMessage') {
           return;
-        }
+        } // bail if `state` is invalid
+
+
+        var stateObject;
 
-        // bail if `state` is invalid
-        var stateObject = void 0;
         try {
           stateObject = JSON.parse(window.atob(message.state));
         } catch (e) {
@@ -102,16 +159,15 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
 
         var _stateObject = stateObject,
             originalState = _stateObject.originalState,
-            instanceId = _stateObject.instanceId;
-        // bail if `instanceId` doesn't match
+            instanceId = _stateObject.instanceId; // bail if `instanceId` doesn't match
 
         if (instanceId !== _this.instanceId) {
           return;
-        }
-
-        // if onComplete not specified do nothing, assume developer is conveying
+        } // if onComplete not specified do nothing, assume developer is conveying
         // completion information from backend server receiving redirect to front
         // end (not using onComplete)
+
+
         if (_this.onComplete) {
           // if auth errored generate appropriate error else null
           var generateError = function generateError(error, description) {
@@ -122,36 +178,37 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
             switch (error) {
               case 'access_denied':
                 return new Smartcar.AccessDenied(description);
+
               case 'invalid_subscription':
                 return new Smartcar.InvalidSubscription(description);
+
               case 'vehicle_incompatible':
-                var params = event.data;
+                var params = event.data; // This field will always exist if vehicleInfo is returned
 
-                // This field will always exist if vehicleInfo is returned
                 if (!params.vin) {
                   return new Smartcar.VehicleIncompatible(description, null);
-                }
+                } // These fields are required when vehicleInfo is returned
+
 
-                // These fields are required when vehicleInfo is returned
                 var vehicleInfo = {
                   vin: params.vin,
                   make: params.make,
                   year: Number(params.year)
-                };
+                }; // This field is optional
 
-                // This field is optional
                 if (params.model) {
                   vehicleInfo.model = params.model;
                 }
 
                 return new Smartcar.VehicleIncompatible(description, vehicleInfo);
+
               default:
-                return new Error('Unexpected error: ' + error + ' - ' + description);
+                return new Error("Unexpected error: ".concat(error, " - ").concat(description));
             }
           };
 
           var err = generateError(message.error, message.errorDescription);
-
+          var virtualKeyUrl = message.virtualKeyUrl;
           /**
            * Call `onComplete` with parameters even if developer is not using
            * a Smartcar-hosted redirect. Regardless of if they are using a
@@ -164,14 +221,14 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
            * parameters they must also handle populating the corresponding query
            * parameters in their redirect uri.
            */
-          _this.onComplete(err, message.code, originalState);
+
+          _this.onComplete(err, message.code, originalState, virtualKeyUrl);
         }
-      };
+      }; // add handler for postMessage event on completion of Smartcar Connect
+
 
-      // add handler for postMessage event on completion of Smartcar Connect
       window.addEventListener('message', this.messageHandler);
     }
-
     /**
      * Validate options passed to Smartcar constructor.
      *
@@ -183,9 +240,8 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
 
 
     _createClass(Smartcar, [{
-      key: 'getAuthUrl',
-
-
+      key: "getAuthUrl",
+      value:
       /**
        * Generates Smartcar OAuth URL.
        *
@@ -223,56 +279,36 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
        * &single_select_vin=5YJSA1E14FF101307
        * &flags=country:DE color:00819D
        */
-      value: function getAuthUrl(options) {
+      function getAuthUrl(options) {
         options = options || {};
-
         var link = '';
         link += 'https://connect.smartcar.com/oauth/authorize';
-        link += '?response_type=' + this.responseType;
-        link += '&client_id=' + this.clientId;
-        link += '&redirect_uri=' + encodeURIComponent(this.redirectUri);
+        link += "?response_type=".concat(this.responseType);
+        link += "&client_id=".concat(this.clientId);
+        link += "&redirect_uri=".concat(encodeURIComponent(this.redirectUri)); // map forcePrompt to approvalPrompt, two options: 'force' and 'auto'
 
-        // map forcePrompt to approvalPrompt, two options: 'force' and 'auto'
         var forcePrompt = options.forcePrompt === true;
-        link += '&approval_prompt=' + (forcePrompt ? 'force' : 'auto');
-
-        // If scope is not specified, Smartcar will default to requesting all scopes
+        link += "&approval_prompt=".concat(forcePrompt ? 'force' : 'auto'); // If scope is not specified, Smartcar will default to requesting all scopes
         // from the user
+
         if (this.scope) {
-          link += '&scope=' + encodeURIComponent(this.scope.join(' '));
+          link += "&scope=".concat(encodeURIComponent(this.scope.join(' ')));
         }
 
-        link += '&mode=' + this.mode;
+        link += "&mode=".concat(this.mode);
 
         if (options.singleSelect !== undefined && options.singleSelect !== null) {
           var singleSelectParamAdded = false;
+
           if (_typeof(options.singleSelect) === 'object') {
             var availableParams = ['vin'];
-            var _iteratorNormalCompletion = true;
-            var _didIteratorError = false;
-            var _iteratorError = undefined;
 
-            try {
-              for (var _iterator = availableParams[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
-                var param = _step.value;
+            for (var _i = 0, _availableParams = availableParams; _i < _availableParams.length; _i++) {
+              var param = _availableParams[_i];
 
-                if (param in options.singleSelect) {
-                  link += '&single_select_' + param + '=' + options.singleSelect[param];
-                  singleSelectParamAdded = true;
-                }
-              }
-            } catch (err) {
-              _didIteratorError = true;
-              _iteratorError = err;
-            } finally {
-              try {
-                if (!_iteratorNormalCompletion && _iterator.return) {
-                  _iterator.return();
-                }
-              } finally {
-                if (_didIteratorError) {
-                  throw _iteratorError;
-                }
+              if (param in options.singleSelect) {
+                link += "&single_select_".concat(param, "=").concat(options.singleSelect[param]);
+                singleSelectParamAdded = true;
               }
             }
 
@@ -282,57 +318,40 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
               link += '&single_select=true';
             }
           } else {
-            link += '&single_select=' + (options.singleSelect === true);
+            link += "&single_select=".concat(options.singleSelect === true);
           }
-        }
+        } // augment state to track the corresponding instance
+
 
-        // augment state to track the corresponding instance
         var state = {
           instanceId: this.instanceId
         };
+
         if (options.state) {
           state.originalState = options.state;
-        }
-        // convert the augmented state to a base64 string
-        link += '&state=' + window.btoa(JSON.stringify(state));
+        } // convert the augmented state to a base64 string
+
+
+        link += "&state=".concat(window.btoa(JSON.stringify(state)));
 
         if (options.vehicleInfo) {
-          var _availableParams = ['make'];
-          var _iteratorNormalCompletion2 = true;
-          var _didIteratorError2 = false;
-          var _iteratorError2 = undefined;
+          var _availableParams2 = ['make'];
 
-          try {
-            for (var _iterator2 = _availableParams[Symbol.iterator](), _step2; !(_iteratorNormalCompletion2 = (_step2 = _iterator2.next()).done); _iteratorNormalCompletion2 = true) {
-              var _param = _step2.value;
+          for (var _i2 = 0, _availableParams3 = _availableParams2; _i2 < _availableParams3.length; _i2++) {
+            var _param = _availableParams3[_i2];
 
-              if (_param in options.vehicleInfo) {
-                link += '&' + _param + '=' + encodeURIComponent(options.vehicleInfo[_param]);
-              }
-            }
-          } catch (err) {
-            _didIteratorError2 = true;
-            _iteratorError2 = err;
-          } finally {
-            try {
-              if (!_iteratorNormalCompletion2 && _iterator2.return) {
-                _iterator2.return();
-              }
-            } finally {
-              if (_didIteratorError2) {
-                throw _iteratorError2;
-              }
+            if (_param in options.vehicleInfo) {
+              link += "&".concat(_param, "=").concat(encodeURIComponent(options.vehicleInfo[_param]));
             }
           }
         }
 
         if (options.flags) {
-          link += '&flags=' + encodeURIComponent(options.flags.join(' '));
+          link += "&flags=".concat(encodeURIComponent(options.flags.join(' ')));
         }
 
         return link;
       }
-
       /**
        * Launches Smartcar Connect in a new window.
        *
@@ -353,26 +372,20 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
        * the vehicle with the specified VIN. See the
        * [API reference](https://smartcar.com/docs/api/#connect-match)
        * for more information.
-       * @param {Object} [options.windowOptions] - the position and dimension settings
-       * of the popup window
-       * @param {String} [options.windowOptions.top] - the top property of
-       * [window features](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#Window_features)
-       * @param {String} [options.windowOptions.left] - the left property of
-       * [window features](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#Window_features)
-       * @param {String} [options.windowOptions.width] - the width property of
-       * [window features](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#Window_features)
-       * @param {String} [options.windowOptions.height] - the height property of
-       * [window features](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#Window_features)
+       * @param {String[]} [options.flags] - An optional space-separated list of feature
+       * flags that your application has early access to.
+       * @param {WindowOptions} [options.windowOptions] - position and size settings for
+       * the popup window
        */
 
     }, {
-      key: 'openDialog',
+      key: "openDialog",
       value: function openDialog(options) {
         var windowOptions = Smartcar._getWindowOptions(options.windowOptions || {});
+
         var href = this.getAuthUrl(options);
         window.open(href, 'Connect your car', windowOptions);
       }
-
       /**
        * Adds an on-click event listener to the element with the provided id.
        *
@@ -397,58 +410,66 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
        * the vehicle with the specified VIN. See the
        * [API reference](https://smartcar.com/docs/api/#connect-match)
        * for more information.
+       * @param {String[]} [options.flags] - An optional space-separated list of feature
+       * flags that your application has early access to.
+       * @param {WindowOptions} [options.windowOptions] - position and size settings for
+       * the popup window
        */
 
     }, {
-      key: 'addClickHandler',
+      key: "addClickHandler",
       value: function addClickHandler(options) {
         var _this2 = this;
 
         var id = options.id,
-            selector = options.selector;
-
-        // check if id or selector option exists
+            selector = options.selector; // check if id or selector option exists
 
         if (!id && !selector) {
           throw new Error('Could not add click handler: id or selector must be provided.');
-        }
+        } // find all the DOM elements that match the id and selector
+
 
-        // find all the DOM elements that match the id and selector
         var elements = [];
+
         if (id) {
           var element = document.getElementById(id);
+
           if (element) {
             elements.push(element);
           }
         }
+
         if (selector) {
           elements.push.apply(elements, _toConsumableArray(document.querySelectorAll(selector)));
         }
-        if (!elements.length) {
-          throw new Error('\n        Could not add click handler: element with \'' + (id || selector) + '\' was not found.\n      ');
-        }
 
-        // _elementToClickHandler stores all the element - clickHandler pairs under the same instance
+        if (!elements.length) {
+          throw new Error("\n        Could not add click handler: element with '".concat(id || selector, "' was not found.\n      "));
+        } // _elementToClickHandler stores all the element - clickHandler pairs under the same instance
         // because it is possible to call addClickHandler multiple times with different options
+
+
         if (!this._elementToClickHandler) {
           this._elementToClickHandler = new Map();
         }
+
         var clickHandler = function clickHandler() {
-          _this2.openDialog(options);
-          // this is equivalent to calling:
+          _this2.openDialog(options); // this is equivalent to calling:
           // event.preventDefault();
           // event.stopPropogation();
+
+
           return false;
         };
 
         elements.forEach(function (element) {
           // register element - clickHandler pair
-          _this2._elementToClickHandler.set(element, clickHandler);
-          // register eventListener
+          _this2._elementToClickHandler.set(element, clickHandler); // register eventListener
+
+
           element.addEventListener('click', clickHandler);
         });
       }
-
       /**
        * Remove Smartcar's event listeners.
        *
@@ -464,43 +485,31 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
        */
 
     }, {
-      key: 'unmount',
+      key: "unmount",
       value: function unmount() {
         window.removeEventListener('message', this.messageHandler);
+
         if (this._elementToClickHandler) {
-          var _iteratorNormalCompletion3 = true;
-          var _didIteratorError3 = false;
-          var _iteratorError3 = undefined;
+          var _iterator = _createForOfIteratorHelper(this._elementToClickHandler.entries()),
+              _step;
 
           try {
-            for (var _iterator3 = this._elementToClickHandler.entries()[Symbol.iterator](), _step3; !(_iteratorNormalCompletion3 = (_step3 = _iterator3.next()).done); _iteratorNormalCompletion3 = true) {
-              var _ref = _step3.value;
-
-              var _ref2 = _slicedToArray(_ref, 2);
-
-              var element = _ref2[0];
-              var clickHandler = _ref2[1];
+            for (_iterator.s(); !(_step = _iterator.n()).done;) {
+              var _step$value = _slicedToArray(_step.value, 2),
+                  element = _step$value[0],
+                  clickHandler = _step$value[1];
 
               element.removeEventListener('click', clickHandler);
             }
           } catch (err) {
-            _didIteratorError3 = true;
-            _iteratorError3 = err;
+            _iterator.e(err);
           } finally {
-            try {
-              if (!_iteratorNormalCompletion3 && _iterator3.return) {
-                _iterator3.return();
-              }
-            } finally {
-              if (_didIteratorError3) {
-                throw _iteratorError3;
-              }
-            }
+            _iterator.f();
           }
         }
       }
     }], [{
-      key: '_validateConstructorOptions',
+      key: "_validateConstructorOptions",
       value: function _validateConstructorOptions(options) {
         if (!options.clientId) {
           throw new TypeError('A client ID option must be provided');
@@ -521,34 +530,37 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
 
           if (usesOldUriScheme) {
             // eslint-disable-next-line no-console
-            console.warn("\nThe Smartcar redirect URI you're using is outdated! To update it, please see:\nhttps://smartcar.com/docs/guides/new-redirect-uri\n");
+            console.warn("\nThe Smartcar redirect URI you're using is outdated! To update it, please see:\nhttps://github.com/smartcar/javascript-sdk#1-register-a-javascript-sdk-redirect-uri\n");
           }
         }
       }
+      /**
+       * Position and size settings for the popup window.
+       *
+       * @see Please reference the {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/open#Window_features|Window.open()#Window Features}
+       * MDN article for more details
+       *
+       * @typedef {Object} WindowOptions
+       * @property {String} [top]
+       * @property {String} [left]
+       * @property {String} [width]
+       * @property {String} [height]
+       */
 
       /**
        * Calculate popup window size and position based on current window settings.
        *
-       * @param {Object} options - the postion and dimention setting of the popup window
-       * @param {String|Number} [options.top] - the top property of
-       * [window features](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#Window_features)
-       * @param {String|Number} [options.left] - the left property of
-       * [window features](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#Window_features)
-       * @param {String|Number} [options.width] - the width property of
-       * [window features](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#Window_features)
-       * the minimum required value is 100.
-       * @param {String|Number} [options.height] - the height property of
-       * [window features](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#Window_features)
-       * the minimum required value is 100.
        * @private
+       * @param {WindowOptions} options
        * @return {String} a string of window settings
        */
 
     }, {
-      key: '_getWindowOptions',
+      key: "_getWindowOptions",
       value: function _getWindowOptions(windowOptions) {
         Object.keys(windowOptions).forEach(function (option) {
           var numValue = parseFloat(windowOptions[option]);
+
           if (isNaN(numValue)) {
             windowOptions[option] = '';
           } else if (numValue < 100 && (option === 'width' || option === 'height')) {
@@ -556,31 +568,26 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
           } else {
             windowOptions[option] = String(numValue);
           }
-        });
-
-        // Sets default popup window size as percentage of screen size
+        }); // Sets default popup window size as percentage of screen size
         // Note that this only applies to desktop browsers
+
         var windowSettings = {
           width: window.screen.width * 0.3,
           height: window.screen.height * 0.75
         };
-
         var widthOffset = (window.outerWidth - windowSettings.width) / 2;
         var heightOffset = (window.outerHeight - windowSettings.height) / 8;
-
         var options = '';
-        options += 'top=' + (windowOptions.top || window.screenY + heightOffset) + ',';
-        options += 'left=' + (windowOptions.left || window.screenX + widthOffset) + ',';
-        options += 'width=' + (windowOptions.width || windowSettings.width) + ',';
-        options += 'height=' + (windowOptions.height || windowSettings.height) + ',';
-
+        options += "top=".concat(windowOptions.top || window.screenY + heightOffset, ",");
+        options += "left=".concat(windowOptions.left || window.screenX + widthOffset, ",");
+        options += "width=".concat(windowOptions.width || windowSettings.width, ",");
+        options += "height=".concat(windowOptions.height || windowSettings.height, ",");
         return options;
       }
     }]);
 
     return Smartcar;
   }();
-
   /**
    * Access denied error returned by Connect.
    *
@@ -588,24 +595,26 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
    */
 
 
-  Smartcar.AccessDenied = function (_Error) {
+  Smartcar.AccessDenied = /*#__PURE__*/function (_Error) {
     _inherits(_class, _Error);
 
+    var _super = _createSuper(_class);
+
     /**
      * @param {String} message - detailed error description
      */
     function _class(message) {
-      _classCallCheck(this, _class);
+      var _this3;
 
-      var _this3 = _possibleConstructorReturn(this, (_class.__proto__ || Object.getPrototypeOf(_class)).call(this, message));
+      _classCallCheck(this, _class);
 
+      _this3 = _super.call(this, message);
       _this3.name = 'AccessDenied';
       return _this3;
     }
 
-    return _class;
-  }(Error);
-
+    return _createClass(_class);
+  }( /*#__PURE__*/_wrapNativeSuper(Error));
   /**
    * Vehicle incompatible error returned by Connect. Will optionally
    * have a vehicleInfo object if the user chooses to give permissions to provide
@@ -614,9 +623,13 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
    *
    * @extends Error
    */
-  Smartcar.VehicleIncompatible = function (_Error2) {
+
+
+  Smartcar.VehicleIncompatible = /*#__PURE__*/function (_Error2) {
     _inherits(_class2, _Error2);
 
+    var _super2 = _createSuper(_class2);
+
     /**
      * @param {String} message - detailed error description
      * @param {?Object} vehicleInfo - If a vehicle is incompatible, the user has
@@ -627,40 +640,45 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
      * @param {String} [vehicleInfo.model] - optionally returned if user gives permission.
      */
     function _class2(message, vehicleInfo) {
-      _classCallCheck(this, _class2);
+      var _this4;
 
-      var _this4 = _possibleConstructorReturn(this, (_class2.__proto__ || Object.getPrototypeOf(_class2)).call(this, message));
+      _classCallCheck(this, _class2);
 
+      _this4 = _super2.call(this, message);
       _this4.name = 'VehicleIncompatible';
       _this4.vehicleInfo = vehicleInfo;
       return _this4;
     }
 
-    return _class2;
-  }(Error);
-
+    return _createClass(_class2);
+  }( /*#__PURE__*/_wrapNativeSuper(Error));
   /**
    * Invalid subscription error returned by Connect.
    *
    * @extends Error
    */
-  Smartcar.InvalidSubscription = function (_Error3) {
+
+
+  Smartcar.InvalidSubscription = /*#__PURE__*/function (_Error3) {
     _inherits(_class3, _Error3);
 
+    var _super3 = _createSuper(_class3);
+
     /**
      * @param {String} message - detailed error description
      */
     function _class3(message) {
-      _classCallCheck(this, _class3);
+      var _this5;
 
-      var _this5 = _possibleConstructorReturn(this, (_class3.__proto__ || Object.getPrototypeOf(_class3)).call(this, message));
+      _classCallCheck(this, _class3);
 
+      _this5 = _super3.call(this, message);
       _this5.name = 'InvalidSubscription';
       return _this5;
     }
 
-    return _class3;
-  }(Error);
+    return _createClass(_class3);
+  }( /*#__PURE__*/_wrapNativeSuper(Error));
 
   return Smartcar;
 });

package/doc/README.md

@@ -15,6 +15,9 @@ Smartcar JavaScript SDK documentation.
 <dl>
 <dt><a href="#OnComplete">OnComplete</a> : <code>function</code></dt>
 <dd></dd>
+<dt><a href="#WindowOptions">WindowOptions</a> : <code>Object</code></dt>
+<dd><p>Position and size settings for the popup window.</p>
+</dd>
 </dl>
 
 <a name="Smartcar"></a>
@@ -50,7 +53,8 @@ Initializes Smartcar class.
 | options.redirectUri | <code>String</code> |  | the registered redirect uri of the application |
 | [options.scope] | <code>Array.&lt;String&gt;</code> |  | requested permission scopes |
 | [options.onComplete] | [<code>OnComplete</code>](#OnComplete) |  | called on completion of Smartcar Connect |
-| [options.testMode] | <code>Boolean</code> | <code>false</code> | launch Smartcar Connect in test mode |
+| [options.testMode] | <code>Boolean</code> | <code>false</code> | Deprecated, please use `mode` instead. Launch Smartcar Connect in [test mode](https://smartcar.com/docs/guides/testing/). |
+| [options.mode] | <code>String</code> | <code>&#x27;live&#x27;</code> | Determine what mode Smartcar Connect should be launched in. Should be one of test, live or simulated. |
 
 <a name="Smartcar+getAuthUrl"></a>
 
@@ -96,11 +100,8 @@ Launches Smartcar Connect in a new window.
 | [options.forcePrompt] | <code>Boolean</code> | <code>false</code> | force permission approval screen to show on every authentication, even if the user has previously consented to the exact scope of permission |
 | [options.vehicleInfo.make] | <code>String</code> |  | `vehicleInfo` is an object with an optional property `make`, which allows users to bypass the car brand selection screen. For a complete list of supported makes, please see our [API Reference](https://smartcar.com/docs/api#authorization) documentation. |
 | [options.singleSelect] | <code>Boolean</code> \| <code>Object</code> |  | An optional value that sets the behavior of the grant dialog displayed to the user. If set to `true`, `single_select` limits the user to selecting only one vehicle. If `single_select` is passed in as an object with the property `vin`, Smartcar will only authorize the vehicle with the specified VIN. See the [API reference](https://smartcar.com/docs/api/#connect-match) for more information. |
-| [options.windowOptions] | <code>Object</code> |  | the position and dimension settings of the popup window |
-| [options.windowOptions.top] | <code>String</code> |  | the top property of [window features](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#Window_features) |
-| [options.windowOptions.left] | <code>String</code> |  | the left property of [window features](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#Window_features) |
-| [options.windowOptions.width] | <code>String</code> |  | the width property of [window features](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#Window_features) |
-| [options.windowOptions.height] | <code>String</code> |  | the height property of [window features](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#Window_features) |
+| [options.flags] | <code>Array.&lt;String&gt;</code> |  | An optional space-separated list of feature flags that your application has early access to. |
+| [options.windowOptions] | [<code>WindowOptions</code>](#WindowOptions) |  | position and size settings for the popup window |
 
 <a name="Smartcar+addClickHandler"></a>
 
@@ -120,6 +121,8 @@ On-click event calls openDialog when the specified element is clicked.
 | [options.forcePrompt] | <code>Boolean</code> | <code>false</code> | force permission approval screen to show on every authentication, even if the user has previously consented to the exact scope of permission |
 | [options.vehicleInfo.make] | <code>String</code> |  | `vehicleInfo` is an object with an optional property `make`, which allows users to bypass the car brand selection screen. For a complete list of supported makes, please see our [API Reference](https://smartcar.com/docs/api#authorization) documentation. |
 | [options.singleSelect] | <code>Boolean</code> \| <code>Object</code> |  | An optional value that sets the behavior of the grant dialog displayed to the user. If set to `true`, `single_select` limits the user to selecting only one vehicle. If `single_select` is passed in as an object with the property `vin`, Smartcar will only authorize the vehicle with the specified VIN. See the [API reference](https://smartcar.com/docs/api/#connect-match) for more information. |
+| [options.flags] | <code>Array.&lt;String&gt;</code> |  | An optional space-separated list of feature flags that your application has early access to. |
+| [options.windowOptions] | [<code>WindowOptions</code>](#WindowOptions) |  | position and size settings for the popup window |
 
 <a name="Smartcar+unmount"></a>
 
@@ -200,4 +203,22 @@ Invalid subscription error returned by Connect.
 | error | <code>Error</code> | something went wrong in Connect; this normally indicates that the user denied access to your application or does not have a connected vehicle |
 | code | <code>String</code> | the authorization code to be exchanged from a backend sever for an access token |
 | [state] | <code>Object</code> | contains state if it was set on the initial authorization request |
+| [virtualKeyUrl] | <code>String</code> | virtual key URL used by Tesla to register Smartcar's virtual key on a vehicle. This registration will be required in order to use any commands on a Tesla vehicle. It is an optional argument as it is only included in specific cases. |
+
+<a name="WindowOptions"></a>
+
+## WindowOptions : <code>Object</code>
+Position and size settings for the popup window.
+
+**Kind**: global typedef
+**See**: Please reference the [Window.open()#Window Features](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#Window_features)
+MDN article for more details
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| [top] | <code>String</code> |
+| [left] | <code>String</code> |
+| [width] | <code>String</code> |
+| [height] | <code>String</code> |
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartcar/auth",
-  "version": "2.8.0",
+  "version": "2.10.0",
   "description": "javascript auth sdk for the smartcar",
   "main": "dist/npm/sdk.js",
   "license": "MIT",
@@ -15,48 +15,42 @@
   "homepage": "https://github.com/smartcar/javascript-sdk#readme",
   "files": [
     "dist/npm/**",
-    "doc/**",
-    "postinstall.js"
+    "doc/**"
   ],
   "scripts": {
     "pretest": "gulp build",
-    "postinstall": "node postinstall",
     "test": "jest",
     "posttest": "npm run lint -s",
     "lint": "eslint . --cache",
     "cover": "npm test -- --coverage",
     "readme": "gulp template:readme",
     "jsdoc": "jsdoc2md --example-lang js --template doc/.template.hbs --files src/sdk.js | sed 's/[ \t]*$//' > doc/README.md",
-    "prepare-release": "semantic-release --branch \"$(git rev-parse --abbrev-ref HEAD)\" --extends ./build/sr-configs/local.js"
+    "prepare-release": "semantic-release --branches \"$(git rev-parse --abbrev-ref HEAD)\" --extends ./build/sr-configs/local.js"
   },
   "devDependencies": {
-    "@semantic-release/exec": "^3.1.3",
-    "babel-core": "^6.26.3",
-    "babel-preset-env": "^1.7.0",
-    "convict": "^4.3.1",
-    "eslint": "^5.8.0",
-    "eslint-config-smartcar": "^2.0.0",
-    "express": "^4.16.3",
-    "gulp": "^3.8.5",
-    "gulp-awspublish": "^3.0.1",
-    "gulp-babel": "^7.0.1",
-    "gulp-rename": "^1.2.2",
+    "@babel/core": "^7.18.2",
+    "@babel/preset-env": "^7.18.2",
+    "@semantic-release/exec": "^6.0.3",
+    "eslint": "^8.16.0",
+    "eslint-config-smartcar": "^3.0.0",
+    "express": "^4.18.1",
+    "geckodriver": "^3.0.1",
+    "gulp": "^4.0.2",
+    "gulp-awspublish": "^6.0.2",
+    "gulp-babel": "^8.0.0",
+    "gulp-rename": "^2.0.0",
     "gulp-template": "^5.0.0",
     "gulp-uglify": "^3.0.0",
     "gulp-umd": "^2.0.0",
-    "jest": "^23.6.0",
-    "jest-environment-jsdom": "^23.3.0",
-    "jest-environment-jsdom-global": "^1.1.0",
-    "jsdoc-to-markdown": "^4.0.1",
-    "nightwatch": "^0.9.21",
-    "semantic-release": "^15.9.17"
+    "is-ci": "^3.0.1",
+    "jest": "^28.1.0",
+    "jest-environment-jsdom": "^28.1.0",
+    "jest-environment-jsdom-global": "^3.1.2",
+    "jsdoc-to-markdown": "^7.1.1",
+    "selenium-webdriver": "^4.0.0-alpha.7",
+    "semantic-release": "^19.0.2"
   },
   "publishConfig": {
     "access": "public"
-  },
-  "dependencies": {
-    "chalk": "^2.4.2",
-    "request": "^2.88.0",
-    "semver": "^6.1.1"
   }
 }

package/postinstall.js

@@ -1,29 +0,0 @@
-/* eslint-env node */
-/* eslint-disable no-console */
-'use strict';
-
-const chalk = require('chalk');
-const request = require('request');
-const semver = require('semver');
-
-const {version} = require('./package');
-
-const primaryColor = (text) => chalk.yellow(text);
-const highlight = (text) => chalk.cyan.bold(text);
-
-request.get('https://registry.npmjs.org/@smartcar/auth', function(err, res, body) {
-  if (err) {
-    return;
-  }
-
-  body = JSON.parse(body);
-
-  const {latest} = body['dist-tags'];
-
-  if (semver.gt(latest, version)) {
-    console.warn(
-      primaryColor('\nYour Smartcar JavaScript SDK is outdated! Please update by running:\n'),
-      highlight('> npm i @smartcar/auth@latest\n'),
-    );
-  }
-});