@smartcar/auth 2.10.0 → 2.12.0

package/README.md

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

package/dist/npm/sdk.js

@@ -137,7 +137,7 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
 
       this.messageHandler = function (event) {
         // bail if message from unexpected source
-        if (!_this.redirectUri.startsWith(event.origin)) {
+        if (_this.redirectUri && !_this.redirectUri.startsWith(event.origin)) {
           return;
         }
 
@@ -264,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.
        *
@@ -278,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 || {};
@@ -285,11 +288,15 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
         link += 'https://connect.smartcar.com/oauth/authorize';
         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'
+
+        if (this.redirectUri) {
+          link += "&redirect_uri=".concat(encodeURIComponent(this.redirectUri));
+        } // map forcePrompt to approvalPrompt, two options: 'force' and 'auto'
+
 
         var forcePrompt = options.forcePrompt === true;
-        link += "&approval_prompt=".concat(forcePrompt ? 'force' : 'auto'); // If scope is not specified, Smartcar will default to requesting all scopes
-        // from the user
+        link += "&approval_prompt=".concat(forcePrompt ? 'force' : 'auto'); // If scope is not specified, Smartcar will default to requesting the application's vehicle
+        // access configuration if available or the default set of permissions
 
         if (this.scope) {
           link += "&scope=".concat(encodeURIComponent(this.scope.join(' ')));
@@ -350,6 +357,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;
       }
       /**
@@ -515,22 +526,20 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
           throw new TypeError('A client ID option must be provided');
         }
 
-        if (!options.redirectUri) {
-          throw new TypeError('A redirect URI option must be provided');
-        }
-
-        if (options.redirectUri.startsWith('https://javascript-sdk.smartcar.com')) {
-          // require onComplete method with at least two parameters (error & code)
-          // when hosting on Smartcar CDN
-          if (!options.onComplete || options.onComplete.length < 2) {
-            throw new Error("When using Smartcar's CDN redirect an onComplete function with at" + ' least 2 parameters (error & code) is required to handle' + ' completion of Connect');
-          }
+        if (options.redirectUri) {
+          if (options.redirectUri.startsWith('https://javascript-sdk.smartcar.com')) {
+            // require onComplete method with at least two parameters (error & code)
+            // when hosting on Smartcar CDN
+            if (!options.onComplete || options.onComplete.length < 2) {
+              throw new Error("When using Smartcar's CDN redirect an onComplete function with at" + ' least 2 parameters (error & code) is required to handle' + ' completion of Connect');
+            }
 
-          var usesOldUriScheme = /redirect-[0-9]+\.[0-9]+\.[0-9]+\?/.test(options.redirectUri);
+            var usesOldUriScheme = /redirect-[0-9]+\.[0-9]+\.[0-9]+\?/.test(options.redirectUri);
 
-          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://github.com/smartcar/javascript-sdk#1-register-a-javascript-sdk-redirect-uri\n");
+            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://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>
 

package/package.json

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