@riligar/auth-react 1.0.4

package/README.md

@@ -0,0 +1,125 @@
+# Auth React
+
+Auth SDK for React with JWT and JWKS.
+
+## Installation
+
+```bash
+bun add @riligar/auth-react
+```
+
+## Basic Usage
+
+```jsx
+import { AuthProvider, useAuth, useSignIn, ProtectedRoute } from '@riligar/auth-react';
+
+// 1. Wrap your app with AuthProvider
+function App() {
+  return (
+    <AuthProvider>
+      <Routes>
+        <Route path="/login" element={<Login />} />
+        <Route element={<ProtectedRoute />}>
+          <Route path="/" element={<Home />} />
+        </Route>
+      </Routes>
+    </AuthProvider>
+  );
+}
+
+// 2. Use hooks in your components
+function Login() {
+  const signIn = useSignIn();
+  
+  async function handleSubmit(e) {
+    e.preventDefault();
+    const { email, password } = Object.fromEntries(new FormData(e.target));
+    try {
+      await signIn(email, password);
+    } catch (err) {
+      alert(err.message);
+    }
+  }
+
+  return (
+    <form onSubmit={handleSubmit}>
+      <input name="email" type="email" placeholder="Email" required />
+      <input name="password" type="password" placeholder="Password" required />
+      <button>Sign In</button>
+    </form>
+  );
+}
+
+function Home() {
+  const { user, isAuthenticated } = useAuth();
+  
+  if (!isAuthenticated) return <p>Not authenticated</p>;
+  
+  return <h1>Hello, {user?.email}!</h1>;
+}
+```
+
+## Features
+
+- ✅ **JWT Tokens** - Secure token-based authentication
+- ✅ **JWKS** - Signature verification with `/.well-known/jwks.json`
+- ✅ **Auto refresh** - Tokens renewed automatically
+- ✅ **Social login** - OAuth provider support
+- ✅ **Cross-tab sync** - Synchronized state across tabs
+- ✅ **Route protection** - Protected routes automatically
+- ✅ **SSR friendly** - Server-side rendering compatible
+- ✅ **LocalStorage** - Token persistence in browser
+
+## API
+
+### Hooks
+
+```jsx
+const { user, loading, error, isAuthenticated } = useAuth();
+const signIn = useSignIn();
+const signUp = useSignUp();
+const signOut = useSignOut();
+const checkToken = useCheckToken();
+```
+
+### Utility functions
+
+```jsx
+import { 
+  isAuthenticated, 
+  getCurrentUser, 
+  refreshToken,
+  socialRedirect 
+} from '@riligar/auth-react';
+
+// Check if authenticated
+if (isAuthenticated()) {
+  console.log('User logged in');
+}
+
+// Get current user data
+const user = getCurrentUser();
+
+// Manually refresh token
+await refreshToken();
+
+// Redirect to social login
+socialRedirect('google', '/dashboard');
+```
+
+## Backend Configuration
+
+The SDK expects your backend to expose:
+
+- `/.well-known/jwks.json` - Public keys for JWT verification
+- `/auth/sign-in` - Login (returns `{ token, user }`)
+- `/auth/sign-up` - Registration (returns `{ token, user }`)
+- `/auth/sign-out` - Logout
+- `/auth/refresh` - Token renewal
+- `/auth/sign-in/:provider` - Social login
+
+## Build
+
+```bash
+bun run build
+```