feat: configure redirect if unauthenticated

manchenkoff · Jun 26, 2024 · 9574818 · 9574818
1 parent 782af6a
commit 9574818
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 12 deletions.
diff --git a/src/config.ts b/src/config.ts
@@ -4,6 +4,7 @@ export const defaultModuleOptions: Partial<SanctumModuleOptions> = {
     mode: 'cookie',
     userStateKey: 'sanctum.user.identity',
     redirectIfAuthenticated: false,
+    redirectIfUnauthenticated: false,
     endpoints: {
         csrf: '/sanctum/csrf-cookie',
         login: '/login',

diff --git a/src/runtime/httpFactory.ts b/src/runtime/httpFactory.ts
@@ -1,5 +1,5 @@
 import type { $Fetch, FetchOptions, FetchContext } from 'ofetch';
-import { useNuxtApp } from '#app';
+import { navigateTo, useNuxtApp } from '#app';
 import { useSanctumUser } from './composables/useSanctumUser';
 import { useSanctumConfig } from './composables/useSanctumConfig';
 import { type ConsolaInstance } from 'consola';
@@ -84,7 +84,7 @@ export function createHttpClient(logger: ConsolaInstance): $Fetch {
             }
         },
 
-        async onResponseError({ request, response }): Promise<void> {
+        async onResponseError({ response }): Promise<void> {
             if (response.status === 419) {
                 logger.warn(
                     'CSRF token mismatch, check your API configuration'
@@ -93,15 +93,24 @@ export function createHttpClient(logger: ConsolaInstance): $Fetch {
                 return;
             }
 
-            if (
-                response.status === 401 &&
-                request.toString().endsWith(options.endpoints.user) &&
-                user.value !== null
-            ) {
-                logger.warn(
-                    'User session is not set in API or expired, resetting identity'
-                );
-                user.value = null;
+            if (response.status === 401) {
+                if (user.value !== null) {
+                    logger.warn(
+                        'User session is not set in API or expired, resetting identity'
+                    );
+
+                    user.value = null;
+                }
+
+                if (
+                    import.meta.client &&
+                    options.redirectIfUnauthenticated &&
+                    options.redirect.onAuthOnly
+                ) {
+                    await nuxtApp.runWithContext(() =>
+                        navigateTo(options.redirect.onAuthOnly as string)
+                    );
+                }
             }
         },
     };

diff --git a/src/runtime/types/options.ts b/src/runtime/types/options.ts
@@ -124,10 +124,15 @@ export interface SanctumModuleOptions {
      */
     userStateKey: string;
     /**
-     * Determine to redirect when user is authenticated.
+     * Determine whether to redirect when the user is authenticated when on login attempt.
      * @default false
      */
     redirectIfAuthenticated: boolean;
+    /**
+     * Determine whether to redirect when the user got unauthenticated on any API request.
+     * @default false
+     */
+    redirectIfUnauthenticated: boolean;
     /**
      * Laravel Sanctum endpoints to be used by the client.
      */