Enable passing in additionalParameters in iOS

Author: Kadi Kraman

README.md

@@ -54,6 +54,14 @@ const result = await appAuth.authorize(scopes);
 // returns accessToken, accessTokenExpirationDate and refreshToken
 ```
 
+## config
+
+This is your configuration object for the client
+- **issuer**: (`string`) *REQUIRED* the url of the auth server
+- **clientId**: (`string`) *REQUIRED* your client id on the auth server
+- **redirectUrl**: (`string`) *REQUIRED* the url that links back to your app with the auth code
+- **additionalParameters**: (`object` | `null`) additional parameters that will be passed in the authorization request
+
 ### `refresh`
 
 This method will refresh the accessToken using the refreshToken. Some auth providers will also give
@@ -280,7 +288,7 @@ import AppAuth from 'react-native-app-auth';
 // initialise the client with your configuration
 const appAuth = new AppAuth({
   issuer: '<YOUR_ISSUER_URL>',
-  clientId: '<YOUR_CLIENT_ID',
+  clientId: '<YOUR_CLIENT_ID>',
   redirectUrl: '<YOUR_REDIRECT_URL>',
 });
 

index.js

@@ -23,7 +23,8 @@ export default class AppAuth {
       this.config.issuer,
       this.config.redirectUrl,
       this.config.clientId,
-      scopes
+      scopes,
+      this.config.additionalParameters
     );
   }
 
@@ -36,7 +37,8 @@ export default class AppAuth {
       this.config.redirectUrl,
       this.config.clientId,
       refreshToken,
-      scopes
+      scopes,
+      this.config.additionalParameters
     );
   }
 

index.spec.js

@@ -17,6 +17,7 @@ describe('AppAuth', () => {
     issuer: 'test-issuer',
     redirectUrl: 'test-redirectUrl',
     clientId: 'test-clientId',
+    additionalParameters: { hello: 'world' },
   };
 
   beforeAll(() => {
@@ -33,6 +34,11 @@ describe('AppAuth', () => {
       expect(appAuth.getConfig()).toEqual(config);
     });
 
+    it('saves the additionalParameters correctly if they are empty', () => {
+      const appAuth = new AppAuth({ ...config, additionalParameters: undefined });
+      expect(appAuth.getConfig()).toEqual({ ...config, additionalParameters: undefined });
+    });
+
     it('throws an error when issuer is not a string', () => {
       expect(() => {
         new AppAuth({ ...config, issuer: () => ({}) }); // eslint-disable-line no-new
@@ -81,7 +87,8 @@ describe('AppAuth', () => {
         config.issuer,
         config.redirectUrl,
         config.clientId,
-        scopes
+        scopes,
+        config.additionalParameters
       );
     });
   });
@@ -124,7 +131,8 @@ describe('AppAuth', () => {
         config.redirectUrl,
         config.clientId,
         refreshToken,
-        scopes
+        scopes,
+        config.additionalParameters
       );
     });
   });

ios/RNAppAuth.m

@@ -18,6 +18,7 @@ - (dispatch_queue_t)methodQueue
                  redirectUrl: (NSString *) redirectUrl
                  clientId: (NSString *) clientId
                  scopes: (NSArray *) scopes
+                 additionalParameters: (NSDictionary *_Nullable) additionalParameters
                  resolve:(RCTPromiseResolveBlock) resolve
                  reject: (RCTPromiseRejectBlock)  reject)
 {
@@ -35,7 +36,7 @@ - (dispatch_queue_t)methodQueue
                                                                                                         scopes:scopes
                                                                                                    redirectURL:[NSURL URLWithString:redirectUrl]
                                                                                                   responseType:OIDResponseTypeCode
-                                                                                          additionalParameters:nil];
+                                                                                          additionalParameters:additionalParameters];
 
 
                                                         // performs authentication request
@@ -79,6 +80,7 @@ - (dispatch_queue_t)methodQueue
                  clientId: (NSString *) clientId
                  refreshToken: (NSString *) refreshToken
                  scopes: (NSArray *) scopes
+                 additionalParameters: (NSDictionary *_Nullable) additionalParameters
                  resolve:(RCTPromiseResolveBlock) resolve
                  reject: (RCTPromiseRejectBlock)  reject)
 {
@@ -99,7 +101,7 @@ - (dispatch_queue_t)methodQueue
                                                                                                 scopes:scopes
                                                                                           refreshToken:refreshToken
                                                                                           codeVerifier:nil
-                                                                                  additionalParameters:nil];
+                                                                                  additionalParameters:additionalParameters];
 
                                                         [OIDAuthorizationService performTokenRequest:tokenRefreshRequest
                                                                                             callback:^(OIDTokenResponse *_Nullable response,

yarn.lock

@@ -4076,7 +4076,7 @@ preserve@^0.2.0:
   version "0.2.0"
   resolved "https://registry.yarnpkg.com/preserve/-/preserve-0.2.0.tgz#815ed1f6ebc65926f865b310c0713bcb3315ce4b"
 
-prettier@^1.10.2:
+prettier@1.10.2:
   version "1.10.2"
   resolved "https://registry.yarnpkg.com/prettier/-/prettier-1.10.2.tgz#1af8356d1842276a99a5b5529c82dd9e9ad3cc93"