Merge pull request #123 from kinde-oss/feat/logout-options

Author: DanielRivers

src/components/LogoutLink.tsx

@@ -6,8 +6,11 @@ export function LogoutLink({ children, ...props }: LogoutLinkProps) {
   const auth = useKindeAuth();
 
   const logout = useCallback(async () => {
-    auth.logout(props.redirectUrl || window.location.origin);
-  }, [auth, props.redirectUrl]);
+    auth.logout({
+      redirectUrl: props.redirectUrl || window.location.origin,
+      allSessions: props.allSessions,
+    });
+  }, [auth, props.redirectUrl, props.allSessions]);
 
   return (
     <button

src/state/KindeContext.ts

@@ -1,6 +1,6 @@
 import { createContext } from "react";
 import { initialState } from "./initialState";
-import { State } from "./types";
+import { LogoutOptions, State } from "./types";
 import type {
   getClaim,
   getClaims,
@@ -22,7 +22,7 @@ export interface KindeContextProps extends State {
   register: (
     options?: LoginMethodParams & { state?: Record<string, string> },
   ) => Promise<void>;
-  logout: (redirectUri?: string) => Promise<void>;
+  logout: (options?: string | LogoutOptions) => Promise<void>;
   getClaims: typeof getClaims;
   getIdToken: () => Promise<string | undefined>;
   getToken: () => Promise<string | undefined>;

src/state/KindeProvider.tsx

@@ -37,7 +37,7 @@ import React, {
 import { KindeContext, KindeContextProps } from "./KindeContext";
 import { getRedirectUrl } from "../utils/getRedirectUrl";
 import packageJson from "../../package.json";
-import { ErrorProps } from "./types";
+import { ErrorProps, LogoutOptions } from "./types";
 import { RefreshTokenResult } from "@kinde/js-utils/dist/utils/token/refreshToken";
 // TODO: need to look for old token store and convert.
 storageSettings.keyPrefix = "";
@@ -243,15 +243,27 @@ export const KindeProvider = ({
     [redirectUri],
   );
 
-  const logout = useCallback(async (redirectUrl?: string) => {
+  const logout = useCallback(async (options?: string | LogoutOptions) => {
     try {
       const domain = (await storeState.memoryStorage.getSessionItem(
         storeState.LocalKeys.domain,
       )) as string;
 
       const params = new URLSearchParams();
-      if (redirectUrl) {
-        params.append("redirect", redirectUrl);
+
+      if (options) {
+        if (options && typeof options === "string") {
+          params.append("redirect", options);
+        } else if (typeof options === "object") {
+          if (options.redirectUrl || logoutUri) {
+            params.append("redirect", options.redirectUrl || logoutUri || "");
+          }
+          if (options.allSessions) {
+            params.append("all_sessions", String(options.allSessions));
+          }
+        }
+      } else {
+        params.append("redirect", logoutUri || "");
       }
 
       setState((val) => {

src/state/types.ts

@@ -23,9 +23,15 @@ export interface LogoutLinkProps
   extends React.ButtonHTMLAttributes<HTMLButtonElement> {
   children: React.ReactNode;
   redirectUrl?: string;
+  allSessions?: boolean;
 }
 
 export type ErrorProps = {
   error: string;
   errorDescription: string;
 };
+
+export type LogoutOptions = {
+  allSessions?: boolean;
+  redirectUrl?: string;
+};