fix: pass response to onSignoutCallback

docs/react-oidc-context.api.md

@@ -14,6 +14,7 @@ import type { SigninResourceOwnerCredentialsArgs } from 'oidc-client-ts';
 import type { SigninSilentArgs } from 'oidc-client-ts';
 import type { SignoutPopupArgs } from 'oidc-client-ts';
 import type { SignoutRedirectArgs } from 'oidc-client-ts';
+import type { SignoutResponse } from 'oidc-client-ts';
 import type { SignoutSilentArgs } from 'oidc-client-ts';
 import { User } from 'oidc-client-ts';
 import { UserManager } from 'oidc-client-ts';
@@ -76,7 +77,7 @@ export interface AuthProviderPropsBase extends UserManagerSettings {
     matchSignoutCallback?: (args: UserManagerSettings) => boolean;
     onRemoveUser?: () => Promise<void> | void;
     onSigninCallback?: (user: User | void) => Promise<void> | void;
-    onSignoutCallback?: () => Promise<void> | void;
+    onSignoutCallback?: (resp: SignoutResponse | void) => Promise<void> | void;
     // @deprecated (undocumented)
     onSignoutPopup?: () => Promise<void> | void;
     // @deprecated (undocumented)

package.json

@@ -40,7 +40,7 @@
     "prepare": "husky install"
   },
   "peerDependencies": {
-    "oidc-client-ts": "^2.2.1",
+    "oidc-client-ts": "^2.4.1",
     "react": ">=16.8.0"
   },
   "devDependencies": {

src/AuthProvider.tsx

@@ -5,6 +5,7 @@ import type {
     SignoutPopupArgs,
     SignoutSilentArgs,
     ProcessResourceOwnerPasswordCredentialsArgs,
+    SignoutResponse,
 } from "oidc-client-ts";
 
 import { AuthContext } from "./AuthContext";
@@ -74,13 +75,13 @@ export interface AuthProviderPropsBase extends UserManagerSettings {
      * When using this, specifying `matchSignoutCallback` is required.
      *
      * ```jsx
-     * const onSignoutCallback = (): void => {
+     * const onSignoutCallback = (resp: SignoutResponse | void): void => {
      *     // go to home after logout
      *     window.location.pathname = ""
      * }
      * ```
      */
-    onSignoutCallback?: () => Promise<void> | void;
+    onSignoutCallback?: (resp: SignoutResponse | void) => Promise<void> | void;
 
     /**
      * On remove user hook. Can be a async function.
@@ -256,8 +257,8 @@ export const AuthProvider = (props: AuthProviderProps): JSX.Element => {
             // sign-out
             try {
                 if (matchSignoutCallback && matchSignoutCallback(userManager.settings)) {
-                    await userManager.signoutCallback();
-                    onSignoutCallback && (await onSignoutCallback());
+                    const resp = await userManager.signoutCallback();
+                    onSignoutCallback && await onSignoutCallback(resp);
                 }
             } catch (error) {
                 dispatch({ type: "ERROR", error: signoutError(error) });