feat: add option to use signoutRedirect

bjerkio · May 15, 2020 · d2c4278 · d2c4278
1 parent ada396a
commit d2c4278
Show file tree

Hide file tree

Showing 5 changed files with 71 additions and 6 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -8,6 +8,7 @@
 
 * [AuthContextProps](interfaces/authcontextprops.md)
 * [AuthProviderProps](interfaces/authproviderprops.md)
+* [AuthProviderSignOutProps](interfaces/authprovidersignoutprops.md)
 * [Location](interfaces/location.md)
 
 ### Variables

diff --git a/docs/interfaces/authcontextprops.md b/docs/interfaces/authcontextprops.md
@@ -32,7 +32,13 @@ ___
 
 #### Type declaration:
 
-▸ (): *void*
+▸ (`options?`: [AuthProviderSignOutProps](authprovidersignoutprops.md)): *void*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`options?` | [AuthProviderSignOutProps](authprovidersignoutprops.md) |
 
 ___
 

diff --git a/docs/interfaces/authprovidersignoutprops.md b/docs/interfaces/authprovidersignoutprops.md
@@ -0,0 +1,33 @@
+[oidc-react](../README.md) › [AuthProviderSignOutProps](authprovidersignoutprops.md)
+
+# Interface: AuthProviderSignOutProps
+
+## Hierarchy
+
+* **AuthProviderSignOutProps**
+
+## Index
+
+### Properties
+
+* [signoutRedirect](authprovidersignoutprops.md#optional-signoutredirect)
+
+## Properties
+
+### `Optional` signoutRedirect
+
+• **signoutRedirect**? : *boolean | unknown*
+
+Trigger a redirect of the current window to the end session endpoint
+
+You can also provide an object. This object will be sent with the
+function.
+
+**`example`** 
+```javascript
+const config = {
+ signOutRedirect: {
+   state: 'abrakadabra',
+ },
+};
+```
diff --git a/src/AuthContext.tsx b/src/AuthContext.tsx
@@ -6,6 +6,25 @@ export interface Location {
   hash: string;
 }
 
+export interface AuthProviderSignOutProps {
+  /**
+   * Trigger a redirect of the current window to the end session endpoint
+   * 
+   * You can also provide an object. This object will be sent with the
+   * function.
+   * 
+   * @example
+   * ```javascript
+   * const config = {
+   *  signOutRedirect: {
+   *    state: 'abrakadabra',
+   *  },
+   * };
+   * ```
+   */
+  signoutRedirect?: boolean | unknown;
+}
+
 export interface AuthProviderProps {
   /**
    * See [UserManager](https://github.com/IdentityModel/oidc-client-js/wiki#usermanager) for more details.
@@ -56,12 +75,12 @@ export interface AuthProviderProps {
   /**
    * On sign out hook. Can be a async function.
    */
-  onSignOut?: () => Promise<void> | void;
+  onSignOut?: (options?: AuthProviderSignOutProps) => Promise<void> | void;
 }
 
 export interface AuthContextProps {
   signIn: () => void;
-  signOut: (providerLogout?: boolean) => void;
+  signOut: (options?: AuthProviderSignOutProps) => void;
   /**
    * See [User](https://github.com/IdentityModel/oidc-client-js/wiki#user) for more details.
    */
@@ -148,8 +167,12 @@ export const AuthProvider: FC<AuthProviderProps> = (props) => {
 
   const context: AuthContextProps = {
     signIn,
-    signOut: async (providerLogout?: boolean) => {
-      providerLogout ? await userManager!.signoutRedirect() : await userManager!.removeUser();
+    signOut: async (options) => {
+      if (options && options?.signoutRedirect) {
+        await userManager!.signoutRedirect()
+      } else {
+        await userManager!.removeUser();
+      }
       setUserData(null);
       onSignOut && onSignOut();
     },

diff --git a/src/__tests__/AuthContext.test.tsx b/src/__tests__/AuthContext.test.tsx
@@ -149,7 +149,9 @@ describe('AuthContext', () => {
       >
         <AuthContext.Consumer>
           {(value) => {
-            value.signOut(true);
+            value.signOut({
+              signoutRedirect: true
+            });
             return <p>Bjerk</p>;
           }}
         </AuthContext.Consumer>