@rqdhw3n/react-auth-flow 1.0.4 → 1.0.6

package/dist/index.d.ts

@@ -1,14 +1,23 @@
 import { Context } from 'react';
 import { default as default_2 } from 'react';
 
+export declare interface AuthActionResponse {
+    success?: boolean;
+    message?: string;
+    user?: AuthUser;
+    [key: string]: unknown;
+}
+
 export declare type AuthClient = ReturnType<typeof createAuthClient>;
 
 export declare interface AuthClientConfig {
     baseURL?: string;
+    baseUrl?: string;
     endpoints?: AuthEndpoints;
     headers?: Record<string, string>;
     credentials?: RequestCredentials;
-    adapter?: RequestAdapter;
+    requestAdapter?: AuthRequestAdapter;
+    adapter?: LegacyRequestAdapter;
 }
 
 /**
@@ -28,12 +37,20 @@ export declare interface AuthContextValue {
     login: (payload: LoginPayload) => Promise<AuthUser>;
     register: (payload: RegisterPayload) => Promise<AuthUser>;
     logout: () => Promise<void>;
-    forgotPassword: (payload: ForgotPasswordPayload) => Promise<void>;
-    resetPassword: (payload: ResetPasswordPayload) => Promise<void>;
-    verifyEmail: (payload: VerifyEmailPayload) => Promise<void>;
-    refreshSession: () => Promise<void>;
-    restoreSession: () => Promise<void>;
+    forgotPassword: (payload: ForgotPasswordPayload) => Promise<AuthActionResponse>;
+    resetPassword: (payload: ResetPasswordPayload) => Promise<AuthActionResponse>;
+    verifyEmail: (payload: VerifyEmailPayload) => Promise<AuthActionResponse>;
+    verifyTwoFactor: (payload: TwoFactorPayload) => Promise<AuthActionResponse>;
+    refreshSession: () => Promise<AuthUser | null>;
+    restoreSession: () => Promise<AuthUser | null>;
+    clearError: () => void;
+    setError: (error?: AuthError | string | null) => void;
     setUser: (user: AuthUser | null) => void;
+    hasRole: (role: string) => boolean;
+    hasAnyRole: (roles: string[]) => boolean;
+    hasPermission: (permission: string) => boolean;
+    hasAnyPermission: (permissions: string[]) => boolean;
+    hasAllPermissions: (permissions: string[]) => boolean;
 }
 
 /**
@@ -48,6 +65,7 @@ export declare interface AuthEndpoints {
     forgotPassword?: string;
     resetPassword?: string;
     verifyEmail?: string;
+    twoFactorVerify?: string;
 }
 
 export declare interface AuthError {
@@ -58,7 +76,7 @@ export declare interface AuthError {
 }
 
 /**
- * Auth Form Class Names - Tailwind-friendly styling
+ * Auth Form Class Names
  */
 export declare interface AuthFormClassNames {
     className?: string;
@@ -73,10 +91,18 @@ export declare interface AuthFormClassNames {
     subtitleClassName?: string;
 }
 
-/**
- * AuthProvider component
- * Provides authentication state and methods to the entire application
- */
+export declare const AuthLayout: default_2.FC<AuthLayoutProps>;
+
+export declare interface AuthLayoutProps {
+    children: React.ReactNode;
+    title?: string;
+    subtitle?: string;
+    className?: string;
+    cardClassName?: string;
+    brand?: React.ReactNode;
+    footer?: React.ReactNode;
+}
+
 export declare const AuthProvider: default_2.FC<AuthProviderProps>;
 
 /**
@@ -85,20 +111,46 @@ export declare const AuthProvider: default_2.FC<AuthProviderProps>;
 export declare interface AuthProviderProps {
     children: React.ReactNode;
     baseURL?: string;
+    baseUrl?: string;
     endpoints?: AuthEndpoints;
+    headers?: Record<string, string>;
+    credentials?: RequestCredentials;
     onAuthError?: (error: AuthError) => void;
     autoRefresh?: boolean;
+    autoRestore?: boolean;
     refreshInterval?: number;
+    requestAdapter?: AuthRequestAdapter;
+    theme?: AuthTheme;
+    mock?: boolean;
+    mockStorageKey?: string;
+    mockUser?: AuthUser;
+}
+
+export declare type AuthRequestAdapter = (params: AuthRequestParams) => Promise<unknown>;
+
+export declare type AuthRequestMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+
+export declare interface AuthRequestParams {
+    endpoint: string;
+    method: AuthRequestMethod;
+    data?: unknown;
+    headers?: Record<string, string>;
 }
 
 /**
  * API Response Format
  */
-export declare interface AuthResponse<T = AuthUser> {
+export declare interface AuthResponse<T extends AuthUser = AuthUser> extends AuthActionResponse {
     user?: T;
     token?: string;
     refreshToken?: string;
-    message?: string;
+}
+
+export declare interface AuthTheme {
+    primaryColor?: string;
+    primaryHoverColor?: string;
+    radius?: string;
+    fontFamily?: string;
 }
 
 /**
@@ -123,60 +175,22 @@ export declare function cn(...classes: Array<string | undefined | false | null>)
  * Creates an authenticated API client
  */
 export declare function createAuthClient(config?: AuthClientConfig): {
-    /**
-     * Login with email and password
-     */
     login(email: string, password: string, rememberMe?: boolean): Promise<AuthResponse<AuthUser>>;
-    /**
-     * Register a new account
-     */
     register(payload: Record<string, unknown>): Promise<AuthResponse<AuthUser>>;
-    /**
-     * Logout the user
-     */
     logout(): Promise<void>;
-    /**
-     * Get current user
-     */
     me(): Promise<AuthResponse<AuthUser>>;
-    /**
-     * Refresh the authentication session
-     */
     refresh(): Promise<AuthResponse<AuthUser>>;
-    /**
-     * Request a password reset
-     */
-    forgotPassword(email: string): Promise<void>;
-    /**
-     * Reset password with token
-     */
-    resetPassword(token: string, password: string, confirmPassword?: string): Promise<void>;
-    /**
-     * Verify email with token
-     */
-    verifyEmail(token: string, email?: string): Promise<void>;
-    /**
-     * Set custom headers for subsequent requests
-     */
+    forgotPassword(email: string): Promise<AuthResponse<AuthUser>>;
+    resetPassword(token: string, password: string, confirmPassword?: string): Promise<AuthResponse<AuthUser>>;
+    verifyEmail(token: string, email?: string): Promise<AuthResponse<AuthUser>>;
+    verifyTwoFactor(code: string): Promise<AuthResponse<AuthUser>>;
     setHeaders(newHeaders: Record<string, string>): void;
-    /**
-     * Get current endpoints configuration
-     */
-    getEndpoints(): {
-        login?: string;
-        register?: string;
-        logout?: string;
-        me?: string;
-        refresh?: string;
-        forgotPassword?: string;
-        resetPassword?: string;
-        verifyEmail?: string;
-    };
+    getEndpoints(): Required<AuthEndpoints>;
 };
 
 /**
  * ForgotPasswordForm Component
- * A ready-to-use forgot password form with customizable Tailwind styling
+ * A ready-to-use forgot password form with packaged default styling
  */
 export declare const ForgotPasswordForm: default_2.FC<ForgotPasswordFormProps>;
 
@@ -206,9 +220,22 @@ export declare interface FormComponentProps extends AuthFormClassNames {
     onError?: (error: AuthError) => void;
 }
 
+export declare const GuestRoute: default_2.FC<GuestRouteProps>;
+
+export declare interface GuestRouteProps {
+    children: React.ReactNode;
+    redirectTo?: string;
+    fallback?: React.ReactNode;
+}
+
+/**
+ * Legacy adapter signature kept for backward compatibility.
+ */
+export declare type LegacyRequestAdapter = (url: string, options: RequestInit) => Promise<Response>;
+
 /**
  * LoginForm Component
- * A ready-to-use login form with customizable Tailwind styling
+ * A ready-to-use login form with packaged default styling
  */
 export declare const LoginForm: default_2.FC<LoginFormProps>;
 
@@ -231,15 +258,22 @@ export declare interface LoginPayload {
  */
 export declare function normalizeError(error: unknown): AuthError;
 
-/**
- * ProtectedRoute Component
- * Protects routes based on authentication status and optional role/permission checks
- * Compatible with React Router v6
- */
+export declare const OtpInput: default_2.FC<OtpInputProps>;
+
+export declare interface OtpInputProps {
+    length?: number;
+    value?: string;
+    onChange?: (value: string) => void;
+    onComplete?: (value: string) => void;
+    disabled?: boolean;
+    className?: string;
+    inputClassName?: string;
+}
+
 export declare const ProtectedRoute: default_2.FC<ProtectedRouteProps>;
 
 /**
- * Protected Route Props
+ * Route Props
  */
 export declare interface ProtectedRouteProps {
     children: React.ReactNode;
@@ -247,11 +281,13 @@ export declare interface ProtectedRouteProps {
     fallback?: React.ReactNode;
     roles?: string[];
     permissions?: string[];
+    unauthorizedTo?: string;
+    requireAllPermissions?: boolean;
 }
 
 /**
  * RegisterForm Component
- * A ready-to-use registration form with customizable Tailwind styling
+ * A ready-to-use registration form with packaged default styling
  */
 export declare const RegisterForm: default_2.FC<RegisterFormProps>;
 
@@ -268,14 +304,11 @@ export declare interface RegisterPayload {
     [key: string]: unknown;
 }
 
-/**
- * Custom Headers and Request Adapter
- */
-export declare type RequestAdapter = (url: string, options: RequestInit) => Promise<Response>;
+export declare type RequestAdapter = LegacyRequestAdapter;
 
 /**
  * ResetPasswordForm Component
- * A ready-to-use password reset form with customizable Tailwind styling
+ * A ready-to-use password reset form with packaged default styling
  */
 export declare const ResetPasswordForm: default_2.FC<ResetPasswordFormProps>;
 
@@ -291,6 +324,34 @@ export declare interface ResetPasswordPayload {
     confirmPassword?: string;
 }
 
+export declare const SocialLoginButton: default_2.FC<SocialLoginButtonProps>;
+
+export declare interface SocialLoginButtonProps {
+    provider: "google" | "github" | "facebook" | "custom";
+    label?: string;
+    icon?: React.ReactNode;
+    onClick?: () => void;
+    className?: string;
+    disabled?: boolean;
+}
+
+export declare const TwoFactorForm: default_2.FC<TwoFactorFormProps>;
+
+export declare interface TwoFactorFormProps {
+    onSuccess?: (response: AuthActionResponse) => void;
+    onError?: (error: AuthError) => void;
+    className?: string;
+    submitButtonText?: string;
+    loadingText?: string;
+    title?: string;
+    subtitle?: string;
+    length?: number;
+}
+
+export declare interface TwoFactorPayload {
+    code: string;
+}
+
 /**
  * Hook to access auth context
  * Must be used within an AuthProvider
@@ -299,7 +360,7 @@ export declare function useAuth(): AuthContextValue;
 
 /**
  * VerifyEmailForm Component
- * A ready-to-use email verification form with customizable Tailwind styling
+ * A ready-to-use email verification form with packaged default styling
  */
 export declare const VerifyEmailForm: default_2.FC<VerifyEmailFormProps>;