@chidchanun/bcp 0.2.4 → 0.2.6

package/packages/server/src/auth-guard.ts

@@ -4,6 +4,11 @@ import {
     type AuthSession,
     type AuthUser,
 } from "./auth.js";
+import {
+    hasPermission,
+    type AuthorizationMatch,
+    type PermissionRequirement,
+} from "./authorization.js";
 import {
     redirect,
     type RedirectStatus,
@@ -18,21 +23,29 @@ export interface AuthGuardData<
 
 export interface RequireAuthOptions
 extends AuthOptions {
-    redirectTo?:
-        string |
-        URL |
-        null;
+    redirectTo?: string | URL | null;
+    redirectStatus?: RedirectStatus;
+}
+
+export interface RequireGuestOptions
+extends AuthOptions {
+    redirectTo?: string | URL | null;
     redirectStatus?: RedirectStatus;
 }
 
 export interface RequireRoleOptions
 extends RequireAuthOptions {
     roleField?: string;
-    match?: "any" | "all";
-    forbiddenRedirectTo?:
-        string |
-        URL |
-        null;
+    match?: AuthorizationMatch;
+    forbiddenRedirectTo?: string | URL | null;
+    forbiddenRedirectStatus?: RedirectStatus;
+}
+
+export interface RequirePermissionOptions
+extends RequireAuthOptions {
+    permissionField?: string;
+    match?: AuthorizationMatch;
+    forbiddenRedirectTo?: string | URL | null;
     forbiddenRedirectStatus?: RedirectStatus;
 }
 
@@ -47,16 +60,20 @@ export type AuthGuardResult<
     | AuthGuardData<TUser, TData>
     | Response;
 
+export type GuestGuardResult =
+    | Record<string, never>
+    | Response;
+
 export type AuthGuardFunction<
     TUser extends AuthUser = AuthUser,
     TData extends object = Record<string, never>
 > = () => Promise<
-    AuthGuardResult<
-        TUser,
-        TData
-    >
+    AuthGuardResult<TUser, TData>
 >;
 
+export type GuestGuardFunction =
+    () => Promise<GuestGuardResult>;
+
 export async function requireAuth<
     TUser extends AuthUser = AuthUser,
     TData extends object = Record<string, never>
@@ -69,23 +86,18 @@ export async function requireAuth<
         ...authOptions
     } = options;
     const session =
-        await auth<
-            TUser,
-            TData
-        >(
+        await auth<TUser, TData>(
             authOptions
         );
 
     if (!session) {
         if (
-            redirectTo ===
-            null
+            redirectTo === null
         ) {
             return new Response(
                 "Unauthorized",
                 {
-                    status:
-                        401,
+                    status: 401,
                 }
             );
         }
@@ -97,11 +109,47 @@ export async function requireAuth<
     }
 
     return {
-        auth:
-            session,
+        auth: session,
     };
 }
 
+export async function requireGuest<
+    TUser extends AuthUser = AuthUser,
+    TData extends object = Record<string, never>
+>(
+    options: RequireGuestOptions = {}
+): Promise<GuestGuardResult> {
+    const {
+        redirectTo = "/",
+        redirectStatus = 303,
+        ...authOptions
+    } = options;
+    const session =
+        await auth<TUser, TData>(
+            authOptions
+        );
+
+    if (!session) {
+        return {};
+    }
+
+    if (
+        redirectTo === null
+    ) {
+        return new Response(
+            "Already authenticated",
+            {
+                status: 409,
+            }
+        );
+    }
+
+    return redirect(
+        redirectTo,
+        redirectStatus
+    );
+}
+
 export async function requireRole<
     TUser extends AuthUser = AuthUser,
     TData extends object = Record<string, never>
@@ -121,16 +169,12 @@ export async function requireRole<
         ...authOptions
     } = options;
     const authenticated =
-        await requireAuth<
-            TUser,
-            TData
-        >(
+        await requireAuth<TUser, TData>(
             authOptions
         );
 
     if (
-        authenticated instanceof
-        Response
+        authenticated instanceof Response
     ) {
         return authenticated;
     }
@@ -155,27 +199,59 @@ export async function requireRole<
                     )
             );
 
-    if (!allowed) {
-        if (
-            forbiddenRedirectTo !==
-            null
-        ) {
-            return redirect(
-                forbiddenRedirectTo,
-                forbiddenRedirectStatus
-            );
-        }
+    return finalizeAuthorization(
+        allowed,
+        authenticated,
+        forbiddenRedirectTo,
+        forbiddenRedirectStatus
+    );
+}
 
-        return new Response(
-            "Forbidden",
+export async function requirePermission<
+    TUser extends AuthUser = AuthUser,
+    TData extends object = Record<string, never>
+>(
+    requiredPermission:
+        PermissionRequirement,
+    options:
+        RequirePermissionOptions = {}
+): Promise<AuthGuardResult<TUser, TData>> {
+    const {
+        permissionField =
+            "permissions",
+        match = "any",
+        forbiddenRedirectTo = null,
+        forbiddenRedirectStatus = 303,
+        ...authOptions
+    } = options;
+    const authenticated =
+        await requireAuth<TUser, TData>(
+            authOptions
+        );
+
+    if (
+        authenticated instanceof Response
+    ) {
+        return authenticated;
+    }
+
+    const allowed =
+        hasPermission(
+            authenticated.auth.user,
+            requiredPermission,
             {
-                status:
-                    403,
+                field:
+                    permissionField,
+                match,
             }
         );
-    }
 
-    return authenticated;
+    return finalizeAuthorization(
+        allowed,
+        authenticated,
+        forbiddenRedirectTo,
+        forbiddenRedirectStatus
+    );
 }
 
 export function createAuthGuard<
@@ -185,10 +261,19 @@ export function createAuthGuard<
     options: RequireAuthOptions = {}
 ): AuthGuardFunction<TUser, TData> {
     return () =>
-        requireAuth<
-            TUser,
-            TData
-        >(
+        requireAuth<TUser, TData>(
+            options
+        );
+}
+
+export function createGuestGuard<
+    TUser extends AuthUser = AuthUser,
+    TData extends object = Record<string, never>
+>(
+    options: RequireGuestOptions = {}
+): GuestGuardFunction {
+    return () =>
+        requireGuest<TUser, TData>(
             options
         );
 }
@@ -201,31 +286,42 @@ export function createRoleGuard<
     options: RequireRoleOptions = {}
 ): AuthGuardFunction<TUser, TData> {
     return () =>
-        requireRole<
-            TUser,
-            TData
-        >(
+        requireRole<TUser, TData>(
             requiredRole,
             options
         );
 }
 
+export function createPermissionGuard<
+    TUser extends AuthUser = AuthUser,
+    TData extends object = Record<string, never>
+>(
+    requiredPermission:
+        PermissionRequirement,
+    options:
+        RequirePermissionOptions = {}
+): AuthGuardFunction<TUser, TData> {
+    return () =>
+        requirePermission<TUser, TData>(
+            requiredPermission,
+            options
+        );
+}
+
 export function getGuardAuth<
     TUser extends AuthUser = AuthUser,
     TData extends object = Record<string, never>
 >(
-    guardData:
-        Readonly<{
-            auth?: unknown;
-        }>
+    guardData: Readonly<{
+        auth?: unknown;
+    }>
 ): AuthSession<TUser, TData> | null {
     const value =
         guardData.auth;
 
     if (
         !value ||
-        typeof value !==
-            "object" ||
+        typeof value !== "object" ||
         Array.isArray(
             value
         )
@@ -235,24 +331,17 @@ export function getGuardAuth<
 
     const session =
         value as Partial<
-            AuthSession<
-                TUser,
-                TData
-            >
+            AuthSession<TUser, TData>
         >;
 
     if (
-        typeof session.sid !==
-            "string" ||
-        session.sid.trim().length ===
-            0 ||
-        typeof session.iat !==
-            "number" ||
+        typeof session.sid !== "string" ||
+        session.sid.trim().length === 0 ||
+        typeof session.iat !== "number" ||
         !Number.isFinite(
             session.iat
         ) ||
-        typeof session.exp !==
-            "number" ||
+        typeof session.exp !== "number" ||
         !Number.isFinite(
             session.exp
         ) ||
@@ -264,18 +353,47 @@ export function getGuardAuth<
     }
 
     return value as
-        AuthSession<
-            TUser,
-            TData
-        >;
+        AuthSession<TUser, TData>;
+}
+
+function finalizeAuthorization<
+    TUser extends AuthUser,
+    TData extends object
+>(
+    allowed: boolean,
+    authenticated:
+        AuthGuardData<TUser, TData>,
+    forbiddenRedirectTo:
+        string | URL | null,
+    forbiddenRedirectStatus:
+        RedirectStatus
+): Promise<AuthGuardResult<TUser, TData>> | AuthGuardData<TUser, TData> | Response {
+    if (allowed) {
+        return authenticated;
+    }
+
+    if (
+        forbiddenRedirectTo !== null
+    ) {
+        return redirect(
+            forbiddenRedirectTo,
+            forbiddenRedirectStatus
+        );
+    }
+
+    return new Response(
+        "Forbidden",
+        {
+            status: 403,
+        }
+    );
 }
 
 function normalizeRequiredRoles(
     value: RequiredRole
 ): string[] {
     const roles =
-        typeof value ===
-            "string"
+        typeof value === "string"
             ? [
                 value,
             ]
@@ -289,12 +407,10 @@ function normalizeRequiredRoles(
         );
 
     if (
-        normalized.length ===
-            0 ||
+        normalized.length === 0 ||
         normalized.some(
             (role) =>
-                role.length ===
-                0
+                role.length === 0
         )
     ) {
         throw new TypeError(
@@ -324,14 +440,12 @@ function readAssignedRoles(
 
     const value =
         (
-            user as
-            unknown as
+            user as unknown as
             Record<string, unknown>
         )[field];
 
     if (
-        typeof value ===
-        "string"
+        typeof value === "string"
     ) {
         const role =
             value.trim();
@@ -353,8 +467,7 @@ function readAssignedRoles(
                 (
                     role
                 ): role is string =>
-                    typeof role ===
-                    "string"
+                    typeof role === "string"
             )
             .map(
                 (role) =>
@@ -373,8 +486,7 @@ function isGuardAuthUser(
 ): value is AuthUser {
     if (
         !value ||
-        typeof value !==
-            "object" ||
+        typeof value !== "object" ||
         Array.isArray(
             value
         )
@@ -389,13 +501,10 @@ function isGuardAuthUser(
         ).id;
 
     return (
-        typeof id ===
-            "string" &&
-        id.trim().length >
-            0
+        typeof id === "string" &&
+        id.trim().length > 0
     ) || (
-        typeof id ===
-            "number" &&
+        typeof id === "number" &&
         Number.isFinite(
             id
         )