Authrix Authentication SDK

Authentication SDK with React hooks, automatic token refresh, and comprehensive error handling.

Features

• 🔐 Complete authentication flow (login, register, logout, password reset)
• 🔄 Automatic token refresh with retry logic
• 🛡️ Built-in rate limiting and request retry
• ⚛️ React hooks for seamless integration
• 🍪 Secure cookie-based token storage
• 📝 Comprehensive TypeScript support
• 🔍 Configurable logging system

Installation

npm install authrix-sdk
# or
yarn add authrix-sdk
# or
bun install authrix-sdk

Quick Start

1. Initialize the Client

import { AuthClient, AuthProvider } from 'authrix-sdk';

const authClient = new AuthClient({
  apiKey: 'your-api-key',
  baseUrl: 'https://your-api-url.com'
});

// Wrap your app with AuthProvider
function App() {
  return (
    <AuthProvider client={authClient}>
      <YourApp />
    </AuthProvider>
  );
}

2. Use Authentication Hooks

import { useAuth } from 'authrix-sdk';

function LoginComponent() {
  const { login, register, user, loading, logout } = useAuth();
  
  const handleLogin = async () => {
    try {
      await login({ 
        email: '[email protected]', 
        password: 'password' 
      });
    } catch (error) {
      console.error('Login failed:', error);
    }
  };
  
  const handleRegister = async () => {
    try {
      await register({
        email: '[email protected]',
        password: 'password',
        username: 'username'
      });
    } catch (error) {
      console.error('Registration failed:', error);
    }
  };
  
  if (loading) return <div>Loading...</div>;
  
  return (
    <div>
      {user ? (
        <div>
          <p>Welcome, {user.username || user.email}!</p>
          <button onClick={logout}>Logout</button>
        </div>
      ) : (
        <div>
          <button onClick={handleLogin}>Login</button>
          <button onClick={handleRegister}>Register</button>
        </div>
      )}
    </div>
  );
}

API Reference

AuthClient

const client = new AuthClient({
  apiKey: 'your-api-key',
  baseUrl: 'https://your-api-url.com', // optional, defaults to localhost:3000
  timeout: 10000, // optional, request timeout in ms
  retries: 3 // optional, number of retries for failed requests
});

useAuth Hook

const {
  user,           // Current user object or null
  loading,        // Loading state
  login,          // Login function
  register,       // Register function  
  logout,         // Logout function
  logoutAll,      // Logout from all devices
  isAuthenticated // Boolean authentication status
} = useAuth();

Methods

login(credentials)

await login({
  email: '[email protected]',
  password: 'password'
});

register(userData)

await register({
  email: '[email protected]',
  password: 'password',
  username: 'username'
});

logout()

await logout(); // Logout from current device

logoutAll()

await logoutAll(); // Logout from all devices

Password Reset

// Request password reset (server will send email with code)
await client.requestPasswordReset('[email protected]');

// Reset password with code from email
await client.resetPassword('123456', 'newPassword');

Configuration

interface AuthConfig {
  apiKey: string;        // Your application API key
  baseUrl?: string;      // API base URL (optional)
  timeout?: number;      // Request timeout in milliseconds (optional)
  retries?: number;      // Number of retries for failed requests (optional)
}

Error Handling

The SDK throws descriptive errors that you can catch and handle:

try {
  await login({ email: '[email protected]', password: 'wrong' });
} catch (error) {
  if (error.message.includes('Invalid credentials')) {
    // Handle invalid login
  } else if (error.message.includes('verify')) {
    // Handle email verification required
  }
}

TypeScript Support

The SDK is written in TypeScript and includes full type definitions:

import type { User, AuthResponse, LoginData, RegisterData } from 'authrix-sdk';

License

MIT