@demokit-ai/auth 0.0.1

package/dist/index.d.cts

@@ -0,0 +1,337 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { SupabaseClient } from '@supabase/supabase-js';
+
+/**
+ * Represents an authenticated user
+ */
+interface AuthUser {
+    /**
+     * Unique identifier for the user
+     */
+    id: string;
+    /**
+     * User's email address
+     */
+    email: string | null;
+    /**
+     * User's display name
+     */
+    name?: string | null;
+    /**
+     * URL to user's avatar image
+     */
+    avatarUrl?: string | null;
+    /**
+     * Additional user metadata
+     */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Represents an authenticated session
+ */
+interface AuthSession {
+    /**
+     * Access token for API requests
+     */
+    accessToken: string;
+    /**
+     * Refresh token for obtaining new access tokens
+     */
+    refreshToken?: string;
+    /**
+     * Unix timestamp when the access token expires
+     */
+    expiresAt?: number;
+    /**
+     * The authenticated user
+     */
+    user: AuthUser;
+}
+/**
+ * Supported OAuth providers
+ */
+type OAuthProvider = 'github' | 'google' | 'gitlab';
+/**
+ * Options for email/password sign in
+ */
+interface SignInOptions {
+    email: string;
+    password: string;
+}
+/**
+ * Options for email/password sign up
+ */
+interface SignUpOptions {
+    email: string;
+    password: string;
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Result of an authentication operation
+ */
+interface AuthResult {
+    /**
+     * The authenticated user, if successful
+     */
+    user: AuthUser | null;
+    /**
+     * The session, if successful
+     */
+    session: AuthSession | null;
+    /**
+     * Error details, if the operation failed
+     */
+    error: AuthError | null;
+}
+/**
+ * Authentication error details
+ */
+interface AuthError {
+    /**
+     * Error code for programmatic handling
+     */
+    code: string;
+    /**
+     * Human-readable error message
+     */
+    message: string;
+}
+/**
+ * Events emitted by the auth state change listener
+ */
+type AuthStateChangeEvent = 'SIGNED_IN' | 'SIGNED_OUT' | 'TOKEN_REFRESHED' | 'USER_UPDATED' | 'PASSWORD_RECOVERY' | 'INITIAL_SESSION';
+/**
+ * Callback for auth state changes
+ */
+type AuthStateChangeCallback = (event: AuthStateChangeEvent, session: AuthSession | null) => void;
+/**
+ * Abstract authentication provider interface
+ *
+ * Implement this interface to add support for different auth providers.
+ * The default implementation uses Supabase Auth.
+ */
+interface AuthProvider$1 {
+    /**
+     * Get the current session, if any
+     */
+    getSession(): Promise<AuthSession | null>;
+    /**
+     * Get the current user, if authenticated
+     */
+    getUser(): Promise<AuthUser | null>;
+    /**
+     * Sign in with email and password
+     */
+    signIn(options: SignInOptions): Promise<AuthResult>;
+    /**
+     * Sign up with email and password
+     */
+    signUp(options: SignUpOptions): Promise<AuthResult>;
+    /**
+     * Sign out the current user
+     */
+    signOut(): Promise<void>;
+    /**
+     * Sign in with an OAuth provider
+     * This will redirect to the provider's login page
+     */
+    signInWithOAuth(provider: OAuthProvider, redirectTo?: string): Promise<void>;
+    /**
+     * Send a password reset email
+     */
+    resetPasswordForEmail(email: string, redirectTo?: string): Promise<void>;
+    /**
+     * Update the current user's password
+     */
+    updatePassword(newPassword: string): Promise<void>;
+    /**
+     * Subscribe to auth state changes
+     * @returns Unsubscribe function
+     */
+    onAuthStateChange(callback: AuthStateChangeCallback): () => void;
+}
+
+/**
+ * Context value provided by AuthProvider
+ */
+interface AuthContextValue {
+    /**
+     * The current authenticated user, or null if not authenticated
+     */
+    user: AuthUser | null;
+    /**
+     * The current session, or null if not authenticated
+     */
+    session: AuthSession | null;
+    /**
+     * Whether the auth state is still loading
+     */
+    isLoading: boolean;
+    /**
+     * Whether the user is authenticated
+     */
+    isAuthenticated: boolean;
+    /**
+     * Sign in with email and password
+     */
+    signIn: (email: string, password: string) => Promise<AuthResult>;
+    /**
+     * Sign up with email and password
+     */
+    signUp: (email: string, password: string, metadata?: Record<string, unknown>) => Promise<AuthResult>;
+    /**
+     * Sign out the current user
+     */
+    signOut: () => Promise<void>;
+    /**
+     * Sign in with an OAuth provider
+     */
+    signInWithOAuth: (provider: OAuthProvider, redirectTo?: string) => Promise<void>;
+    /**
+     * Send a password reset email
+     */
+    resetPasswordForEmail: (email: string, redirectTo?: string) => Promise<void>;
+}
+/**
+ * Props for the AuthProvider component
+ */
+interface AuthProviderProps {
+    /**
+     * Child components to render
+     */
+    children: ReactNode;
+    /**
+     * The auth provider implementation to use
+     */
+    provider: AuthProvider$1;
+}
+/**
+ * Provider component that manages authentication state
+ *
+ * @example
+ * import { AuthProvider, createSupabaseAuthProvider } from '@demokit-ai/auth'
+ *
+ * const authProvider = createSupabaseAuthProvider({
+ *   supabaseUrl: process.env.NEXT_PUBLIC_SUPABASE_URL!,
+ *   supabaseAnonKey: process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!,
+ * })
+ *
+ * function App() {
+ *   return (
+ *     <AuthProvider provider={authProvider}>
+ *       <YourApp />
+ *     </AuthProvider>
+ *   )
+ * }
+ */
+declare function AuthProvider({ children, provider }: AuthProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Hook to access authentication state and methods
+ *
+ * @throws Error if used outside of AuthProvider
+ *
+ * @example
+ * function LoginButton() {
+ *   const { user, signIn, signOut, isLoading } = useAuth()
+ *
+ *   if (isLoading) return <Loading />
+ *
+ *   if (user) {
+ *     return <button onClick={signOut}>Sign Out</button>
+ *   }
+ *
+ *   return <button onClick={() => signIn('user@example.com', 'password')}>Sign In</button>
+ * }
+ */
+declare function useAuth(): AuthContextValue;
+/**
+ * Hook to get the current user
+ * Shorthand for useAuth().user
+ */
+declare function useUser(): AuthUser | null;
+/**
+ * Hook to get the current session
+ * Shorthand for useAuth().session
+ */
+declare function useSession(): AuthSession | null;
+/**
+ * Hook to check if user is authenticated
+ * Shorthand for useAuth().isAuthenticated
+ */
+declare function useIsAuthenticated(): boolean;
+
+/**
+ * Configuration for the Supabase auth provider
+ */
+interface SupabaseAuthConfig {
+    /**
+     * Supabase project URL
+     */
+    supabaseUrl: string;
+    /**
+     * Supabase anonymous/public key
+     */
+    supabaseAnonKey: string;
+    /**
+     * Optional: existing Supabase client instance
+     * If provided, supabaseUrl and supabaseAnonKey are ignored
+     */
+    client?: SupabaseClient;
+}
+/**
+ * Create an auth provider using Supabase Auth
+ *
+ * @example
+ * const authProvider = createSupabaseAuthProvider({
+ *   supabaseUrl: process.env.NEXT_PUBLIC_SUPABASE_URL!,
+ *   supabaseAnonKey: process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!,
+ * })
+ *
+ * // Use in AuthProvider
+ * <AuthProvider provider={authProvider}>
+ *   <App />
+ * </AuthProvider>
+ */
+declare function createSupabaseAuthProvider(config: SupabaseAuthConfig): AuthProvider$1;
+
+/**
+ * Configuration for the memory auth provider
+ */
+interface MemoryAuthConfig {
+    /**
+     * Pre-populated users for testing
+     */
+    users?: Map<string, {
+        password: string;
+        user: AuthUser;
+    }>;
+    /**
+     * Initial session (for testing authenticated state)
+     */
+    initialSession?: AuthSession | null;
+    /**
+     * Delay in ms to simulate network latency
+     * @default 0
+     */
+    delay?: number;
+}
+/**
+ * Create an in-memory auth provider for testing
+ *
+ * This provider stores all data in memory and resets on page refresh.
+ * Useful for unit tests and local development without a real auth backend.
+ *
+ * @example
+ * const authProvider = createMemoryAuthProvider({
+ *   users: new Map([
+ *     ['test@example.com', {
+ *       password: 'password123',
+ *       user: { id: '1', email: 'test@example.com', name: 'Test User' }
+ *     }]
+ *   ])
+ * })
+ */
+declare function createMemoryAuthProvider(config?: MemoryAuthConfig): AuthProvider$1;
+
+export { type AuthContextValue, type AuthError, AuthProvider, type AuthProviderProps, type AuthResult, type AuthSession, type AuthStateChangeCallback, type AuthStateChangeEvent, type AuthUser, type AuthProvider$1 as IAuthProvider, type MemoryAuthConfig, type OAuthProvider, type SignInOptions, type SignUpOptions, type SupabaseAuthConfig, createMemoryAuthProvider, createSupabaseAuthProvider, useAuth, useIsAuthenticated, useSession, useUser };

package/dist/index.d.ts

@@ -0,0 +1,337 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { SupabaseClient } from '@supabase/supabase-js';
+
+/**
+ * Represents an authenticated user
+ */
+interface AuthUser {
+    /**
+     * Unique identifier for the user
+     */
+    id: string;
+    /**
+     * User's email address
+     */
+    email: string | null;
+    /**
+     * User's display name
+     */
+    name?: string | null;
+    /**
+     * URL to user's avatar image
+     */
+    avatarUrl?: string | null;
+    /**
+     * Additional user metadata
+     */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Represents an authenticated session
+ */
+interface AuthSession {
+    /**
+     * Access token for API requests
+     */
+    accessToken: string;
+    /**
+     * Refresh token for obtaining new access tokens
+     */
+    refreshToken?: string;
+    /**
+     * Unix timestamp when the access token expires
+     */
+    expiresAt?: number;
+    /**
+     * The authenticated user
+     */
+    user: AuthUser;
+}
+/**
+ * Supported OAuth providers
+ */
+type OAuthProvider = 'github' | 'google' | 'gitlab';
+/**
+ * Options for email/password sign in
+ */
+interface SignInOptions {
+    email: string;
+    password: string;
+}
+/**
+ * Options for email/password sign up
+ */
+interface SignUpOptions {
+    email: string;
+    password: string;
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Result of an authentication operation
+ */
+interface AuthResult {
+    /**
+     * The authenticated user, if successful
+     */
+    user: AuthUser | null;
+    /**
+     * The session, if successful
+     */
+    session: AuthSession | null;
+    /**
+     * Error details, if the operation failed
+     */
+    error: AuthError | null;
+}
+/**
+ * Authentication error details
+ */
+interface AuthError {
+    /**
+     * Error code for programmatic handling
+     */
+    code: string;
+    /**
+     * Human-readable error message
+     */
+    message: string;
+}
+/**
+ * Events emitted by the auth state change listener
+ */
+type AuthStateChangeEvent = 'SIGNED_IN' | 'SIGNED_OUT' | 'TOKEN_REFRESHED' | 'USER_UPDATED' | 'PASSWORD_RECOVERY' | 'INITIAL_SESSION';
+/**
+ * Callback for auth state changes
+ */
+type AuthStateChangeCallback = (event: AuthStateChangeEvent, session: AuthSession | null) => void;
+/**
+ * Abstract authentication provider interface
+ *
+ * Implement this interface to add support for different auth providers.
+ * The default implementation uses Supabase Auth.
+ */
+interface AuthProvider$1 {
+    /**
+     * Get the current session, if any
+     */
+    getSession(): Promise<AuthSession | null>;
+    /**
+     * Get the current user, if authenticated
+     */
+    getUser(): Promise<AuthUser | null>;
+    /**
+     * Sign in with email and password
+     */
+    signIn(options: SignInOptions): Promise<AuthResult>;
+    /**
+     * Sign up with email and password
+     */
+    signUp(options: SignUpOptions): Promise<AuthResult>;
+    /**
+     * Sign out the current user
+     */
+    signOut(): Promise<void>;
+    /**
+     * Sign in with an OAuth provider
+     * This will redirect to the provider's login page
+     */
+    signInWithOAuth(provider: OAuthProvider, redirectTo?: string): Promise<void>;
+    /**
+     * Send a password reset email
+     */
+    resetPasswordForEmail(email: string, redirectTo?: string): Promise<void>;
+    /**
+     * Update the current user's password
+     */
+    updatePassword(newPassword: string): Promise<void>;
+    /**
+     * Subscribe to auth state changes
+     * @returns Unsubscribe function
+     */
+    onAuthStateChange(callback: AuthStateChangeCallback): () => void;
+}
+
+/**
+ * Context value provided by AuthProvider
+ */
+interface AuthContextValue {
+    /**
+     * The current authenticated user, or null if not authenticated
+     */
+    user: AuthUser | null;
+    /**
+     * The current session, or null if not authenticated
+     */
+    session: AuthSession | null;
+    /**
+     * Whether the auth state is still loading
+     */
+    isLoading: boolean;
+    /**
+     * Whether the user is authenticated
+     */
+    isAuthenticated: boolean;
+    /**
+     * Sign in with email and password
+     */
+    signIn: (email: string, password: string) => Promise<AuthResult>;
+    /**
+     * Sign up with email and password
+     */
+    signUp: (email: string, password: string, metadata?: Record<string, unknown>) => Promise<AuthResult>;
+    /**
+     * Sign out the current user
+     */
+    signOut: () => Promise<void>;
+    /**
+     * Sign in with an OAuth provider
+     */
+    signInWithOAuth: (provider: OAuthProvider, redirectTo?: string) => Promise<void>;
+    /**
+     * Send a password reset email
+     */
+    resetPasswordForEmail: (email: string, redirectTo?: string) => Promise<void>;
+}
+/**
+ * Props for the AuthProvider component
+ */
+interface AuthProviderProps {
+    /**
+     * Child components to render
+     */
+    children: ReactNode;
+    /**
+     * The auth provider implementation to use
+     */
+    provider: AuthProvider$1;
+}
+/**
+ * Provider component that manages authentication state
+ *
+ * @example
+ * import { AuthProvider, createSupabaseAuthProvider } from '@demokit-ai/auth'
+ *
+ * const authProvider = createSupabaseAuthProvider({
+ *   supabaseUrl: process.env.NEXT_PUBLIC_SUPABASE_URL!,
+ *   supabaseAnonKey: process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!,
+ * })
+ *
+ * function App() {
+ *   return (
+ *     <AuthProvider provider={authProvider}>
+ *       <YourApp />
+ *     </AuthProvider>
+ *   )
+ * }
+ */
+declare function AuthProvider({ children, provider }: AuthProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Hook to access authentication state and methods
+ *
+ * @throws Error if used outside of AuthProvider
+ *
+ * @example
+ * function LoginButton() {
+ *   const { user, signIn, signOut, isLoading } = useAuth()
+ *
+ *   if (isLoading) return <Loading />
+ *
+ *   if (user) {
+ *     return <button onClick={signOut}>Sign Out</button>
+ *   }
+ *
+ *   return <button onClick={() => signIn('user@example.com', 'password')}>Sign In</button>
+ * }
+ */
+declare function useAuth(): AuthContextValue;
+/**
+ * Hook to get the current user
+ * Shorthand for useAuth().user
+ */
+declare function useUser(): AuthUser | null;
+/**
+ * Hook to get the current session
+ * Shorthand for useAuth().session
+ */
+declare function useSession(): AuthSession | null;
+/**
+ * Hook to check if user is authenticated
+ * Shorthand for useAuth().isAuthenticated
+ */
+declare function useIsAuthenticated(): boolean;
+
+/**
+ * Configuration for the Supabase auth provider
+ */
+interface SupabaseAuthConfig {
+    /**
+     * Supabase project URL
+     */
+    supabaseUrl: string;
+    /**
+     * Supabase anonymous/public key
+     */
+    supabaseAnonKey: string;
+    /**
+     * Optional: existing Supabase client instance
+     * If provided, supabaseUrl and supabaseAnonKey are ignored
+     */
+    client?: SupabaseClient;
+}
+/**
+ * Create an auth provider using Supabase Auth
+ *
+ * @example
+ * const authProvider = createSupabaseAuthProvider({
+ *   supabaseUrl: process.env.NEXT_PUBLIC_SUPABASE_URL!,
+ *   supabaseAnonKey: process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!,
+ * })
+ *
+ * // Use in AuthProvider
+ * <AuthProvider provider={authProvider}>
+ *   <App />
+ * </AuthProvider>
+ */
+declare function createSupabaseAuthProvider(config: SupabaseAuthConfig): AuthProvider$1;
+
+/**
+ * Configuration for the memory auth provider
+ */
+interface MemoryAuthConfig {
+    /**
+     * Pre-populated users for testing
+     */
+    users?: Map<string, {
+        password: string;
+        user: AuthUser;
+    }>;
+    /**
+     * Initial session (for testing authenticated state)
+     */
+    initialSession?: AuthSession | null;
+    /**
+     * Delay in ms to simulate network latency
+     * @default 0
+     */
+    delay?: number;
+}
+/**
+ * Create an in-memory auth provider for testing
+ *
+ * This provider stores all data in memory and resets on page refresh.
+ * Useful for unit tests and local development without a real auth backend.
+ *
+ * @example
+ * const authProvider = createMemoryAuthProvider({
+ *   users: new Map([
+ *     ['test@example.com', {
+ *       password: 'password123',
+ *       user: { id: '1', email: 'test@example.com', name: 'Test User' }
+ *     }]
+ *   ])
+ * })
+ */
+declare function createMemoryAuthProvider(config?: MemoryAuthConfig): AuthProvider$1;
+
+export { type AuthContextValue, type AuthError, AuthProvider, type AuthProviderProps, type AuthResult, type AuthSession, type AuthStateChangeCallback, type AuthStateChangeEvent, type AuthUser, type AuthProvider$1 as IAuthProvider, type MemoryAuthConfig, type OAuthProvider, type SignInOptions, type SignUpOptions, type SupabaseAuthConfig, createMemoryAuthProvider, createSupabaseAuthProvider, useAuth, useIsAuthenticated, useSession, useUser };