@smartcar/auth 2.9.0 → 2.11.0

package/README.md

@@ -24,7 +24,7 @@ npm install @smartcar/auth
 ### Smartcar CDN
 
 ```html
-<script src="https://javascript-sdk.smartcar.com/2.9.0/sdk.js"></script>
+<script src="https://javascript-sdk.smartcar.com/2.11.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.9.0
+[version]: 2.11.0

package/dist/npm/sdk.js

@@ -73,6 +73,10 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
      * 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.
      */
 
     /**
@@ -204,6 +208,7 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
           };
 
           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
@@ -217,7 +222,7 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
            * 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
 
@@ -259,6 +264,8 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
        * for more information.
        * @param {String[]} [options.flags] - An optional space-separated list of feature
        * flags that your application has early access to.
+       * @param {String} [options.user] - An optional unique identifier for a vehicle owner.
+       * This identifier is used to aggregate analytics across Connect sessions for each vehicle owner.
        *
        * @return {String} Connect URL to redirect user to.
        *
@@ -273,6 +280,7 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
        * &single_select=true
        * &single_select_vin=5YJSA1E14FF101307
        * &flags=country:DE color:00819D
+       * &user=2dad4eaf-9094-4bff-bb0f-ffbbdde8b562
        */
       function getAuthUrl(options) {
         options = options || {};
@@ -345,6 +353,10 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
           link += "&flags=".concat(encodeURIComponent(options.flags.join(' ')));
         }
 
+        if (options.user) {
+          link += "&user=".concat(encodeURIComponent(options.user));
+        }
+
         return link;
       }
       /**
@@ -525,7 +537,7 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
 
           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");
           }
         }
       }

package/doc/README.md

@@ -72,6 +72,7 @@ Generates Smartcar OAuth URL.
 | [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 brands, 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.user] | <code>String</code> |  | An optional unique identifier for a vehicle owner. This identifier is used to aggregate analytics across Connect sessions for each vehicle owner. |
 
 **Example**
 ```js
@@ -85,6 +86,7 @@ response_type=code
 &single_select=true
 &single_select_vin=5YJSA1E14FF101307
 &flags=country:DE color:00819D
+&user=2dad4eaf-9094-4bff-bb0f-ffbbdde8b562
 ```
 <a name="Smartcar+openDialog"></a>
 
@@ -203,6 +205,7 @@ 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>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartcar/auth",
-  "version": "2.9.0",
+  "version": "2.11.0",
   "description": "javascript auth sdk for the smartcar",
   "main": "dist/npm/sdk.js",
   "license": "MIT",