@smartcar/auth 2.11.0 → 2.13.0

package/README.md

@@ -9,7 +9,7 @@ The [Smartcar API](https://smartcar.com/docs) lets you read vehicle data
 
 To make requests to a vehicle from a web application, the end user must connect their vehicle using [Smartcar Connect](https://smartcar.com/docs/api#smartcar-connect). The Smartcar JavaScript SDK provides an easy way to launch and handle Connect to retrieve the resulting `code`.
 
-Before integrating with the JavaScript SDK, you'll need to register an application in the [Smartcar dashboard](https://dashboard.smartcar.com). Once you have registered an application, you will have a Client ID and Client Secret, which will allow you to authorize users.
+Before integrating with the JavaScript SDK, you'll need to register an application in the [Smartcar dashboard](https://dashboard.smartcar.com). Once you have registered an application, you will have an Application ID, which will allow you to launch Connect and authorize users.
 
 ## Installation
 
@@ -24,7 +24,7 @@ npm install @smartcar/auth
 ### Smartcar CDN
 
 ```html
-<script src="https://javascript-sdk.smartcar.com/2.11.0/sdk.js"></script>
+<script src="https://javascript-sdk.smartcar.com/2.13.0/sdk.js"></script>
 ```
 
 ## SDK reference
@@ -81,7 +81,7 @@ Once you have constructed your redirect URI, make sure to register it on the [Sm
 
 ```javascript
 const smartcar = new Smartcar({
-  clientId: '<your-client-id>',
+  applicationId: '<your-application-id>',
   redirectUri: '<your-redirect-uri>',
   scope: ['read_vehicle_info', 'read_odometer'],
   onComplete: function(err, code) {
@@ -94,6 +94,8 @@ const smartcar = new Smartcar({
 });
 ```
 
+`applicationId` is the preferred option name. For backward compatibility, `clientId` is also supported. You must provide one of `applicationId` or `clientId`.
+
 **Reference:** [`new Smartcar(options)`](doc#new_Smartcar_new)
 
 > NOTE: See the full set of available scopes for each endpoint in the [Smartcar API reference](https://smartcar.com/docs/api#permissions).
@@ -140,7 +142,7 @@ To use the JavaScript SDK for this flow, do the following:
 
 ```javascript
 const smartcar = new Smartcar({
-  clientId: '<your-client-id>',
+  applicationId: '<your-application-id>',
   redirectUri: '<your-backend-redirect-uri>',
   scope: ['read_vehicle_info', 'read_odometer'],
   onComplete: function() {},
@@ -178,4 +180,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.11.0
+[version]: 2.13.0

package/README.mdt

@@ -9,7 +9,7 @@ The [Smartcar API](https://smartcar.com/docs) lets you read vehicle data
 
 To make requests to a vehicle from a web application, the end user must connect their vehicle using [Smartcar Connect](https://smartcar.com/docs/api#smartcar-connect). The Smartcar JavaScript SDK provides an easy way to launch and handle Connect to retrieve the resulting `code`.
 
-Before integrating with the JavaScript SDK, you'll need to register an application in the [Smartcar dashboard](https://dashboard.smartcar.com). Once you have registered an application, you will have a Client ID and Client Secret, which will allow you to authorize users.
+Before integrating with the JavaScript SDK, you'll need to register an application in the [Smartcar dashboard](https://dashboard.smartcar.com). Once you have registered an application, you will have an Application ID, which will allow you to launch Connect and authorize users.
 
 ## Installation
 
@@ -81,7 +81,7 @@ Once you have constructed your redirect URI, make sure to register it on the [Sm
 
 ```javascript
 const smartcar = new Smartcar({
-  clientId: '<your-client-id>',
+  applicationId: '<your-application-id>',
   redirectUri: '<your-redirect-uri>',
   scope: ['read_vehicle_info', 'read_odometer'],
   onComplete: function(err, code) {
@@ -94,6 +94,8 @@ const smartcar = new Smartcar({
 });
 ```
 
+`applicationId` is the preferred option name. For backward compatibility, `clientId` is also supported. You must provide one of `applicationId` or `clientId`.
+
 **Reference:** [`new Smartcar(options)`](doc#new_Smartcar_new)
 
 > NOTE: See the full set of available scopes for each endpoint in the [Smartcar API reference](https://smartcar.com/docs/api#permissions).
@@ -140,7 +142,7 @@ To use the JavaScript SDK for this flow, do the following:
 
 ```javascript
 const smartcar = new Smartcar({
-  clientId: '<your-client-id>',
+  applicationId: '<your-application-id>',
   redirectUri: '<your-backend-redirect-uri>',
   scope: ['read_vehicle_info', 'read_odometer'],
   onComplete: function() {},

package/dist/npm/sdk.js

@@ -63,6 +63,8 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
   'use strict';
   /* eslint-env node */
 
+  var hasWarnedClientIdDeprecation = false;
+
   var Smartcar = /*#__PURE__*/function () {
     /**
      * @callback OnComplete
@@ -77,6 +79,7 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
      * 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.
+     * @param {String} userId - A unique identifier for the vehicle owner that granted access.
      */
 
     /**
@@ -84,7 +87,8 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
      *
      * @constructor
      * @param {Object} options - the SDK configuration object
-     * @param {String} options.clientId - the application's client id
+      * @param {String} options.applicationId - the application's id
+      * @param {String} [options.clientId] - Deprecated alias for applicationId
      * @param {String} options.redirectUri - the registered redirect uri of the
      * application
      * @param {String[]} [options.scope] - requested permission scopes
@@ -112,7 +116,15 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
 
       Smartcar._validateConstructorOptions(options);
 
-      this.clientId = options.clientId;
+      if (!options.applicationId && options.clientId && !hasWarnedClientIdDeprecation) {
+        // eslint-disable-next-line no-console
+        console.warn('The "clientId" parameter is deprecated, please use the "applicationId" parameter instead.');
+        hasWarnedClientIdDeprecation = true;
+      }
+
+      var applicationId = options.applicationId || options.clientId;
+      this.applicationId = applicationId;
+      this.clientId = applicationId;
       this.redirectUri = options.redirectUri;
       this.scope = options.scope;
       this.onComplete = options.onComplete;
@@ -137,7 +149,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;
         }
 
@@ -209,6 +221,7 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
 
           var err = generateError(message.error, message.errorDescription);
           var virtualKeyUrl = message.virtualKeyUrl;
+          var userId = message.userId;
           /**
            * Call `onComplete` with parameters even if developer is not using
            * a Smartcar-hosted redirect. Regardless of if they are using a
@@ -222,7 +235,7 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
            * parameters in their redirect uri.
            */
 
-          _this.onComplete(err, message.code, originalState, virtualKeyUrl);
+          _this.onComplete(err, message.code, originalState, virtualKeyUrl, userId);
         }
       }; // add handler for postMessage event on completion of Smartcar Connect
 
@@ -272,7 +285,7 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
        * @example
        * https://connect.smartcar.com/oauth/authorize?
        * response_type=code
-       * &client_id=8229df9f-91a0-4ff0-a1ae-a1f38ee24d07
+       * &application_id=8229df9f-91a0-4ff0-a1ae-a1f38ee24d07
        * &scope=read_odometer read_vehicle_info
        * &redirect_uri=https://example.com/home
        * &state=0facda3319
@@ -287,12 +300,16 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
         var link = '';
         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'
+        link += "&application_id=".concat(this.applicationId);
+
+        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(' ')));
@@ -518,26 +535,24 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
     }], [{
       key: "_validateConstructorOptions",
       value: function _validateConstructorOptions(options) {
-        if (!options.clientId) {
-          throw new TypeError('A client ID option must be provided');
+        if (!options.applicationId && !options.clientId) {
+          throw new TypeError('An applicationId 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

@@ -49,7 +49,8 @@ Initializes Smartcar class.
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | options | <code>Object</code> |  | the SDK configuration object |
-| options.clientId | <code>String</code> |  | the application's client id |
+| options.applicationId | <code>String</code> |  | the application's id |
+| [options.clientId] | <code>String</code> |  | Deprecated alias for applicationId |
 | 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 |
@@ -78,7 +79,7 @@ Generates Smartcar OAuth URL.
 ```js
 https://connect.smartcar.com/oauth/authorize?
 response_type=code
-&client_id=8229df9f-91a0-4ff0-a1ae-a1f38ee24d07
+&application_id=8229df9f-91a0-4ff0-a1ae-a1f38ee24d07
 &scope=read_odometer read_vehicle_info
 &redirect_uri=https://example.com/home
 &state=0facda3319
@@ -206,6 +207,7 @@ Invalid subscription error returned by Connect.
 | 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. |
+| userId | <code>String</code> | A unique identifier for the vehicle owner that granted access. |
 
 <a name="WindowOptions"></a>
 

package/package.json

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