@authsome/ui-core 0.1.8 → 1.0.0

package/dist/provider-S9ZY5hsp.d.ts

@@ -1,787 +0,0 @@
-/**
- * Core authentication types and interfaces
- */
-/**
- * Authentication state enum
- */
-declare enum AuthState {
-    AUTHENTICATED = "authenticated",
-    UNAUTHENTICATED = "unauthenticated",
-    LOADING = "loading",
-    ERROR = "error"
-}
-/**
- * User profile interface
- */
-interface User {
-    id: string;
-    email?: string;
-    username?: string;
-    phone?: string;
-    emailVerified?: boolean;
-    phoneVerified?: boolean;
-    name?: string;
-    firstName?: string;
-    lastName?: string;
-    avatar?: string;
-    metadata?: Record<string, unknown>;
-    createdAt?: Date;
-    updatedAt?: Date;
-    organizationId?: string;
-    organizationRole?: string;
-    organizationMemberships?: OrganizationMembership[];
-}
-/**
- * Session interface
- */
-interface Session {
-    id: string;
-    userId: string;
-    token: string;
-    expiresAt?: Date;
-    createdAt?: Date;
-    metadata?: Record<string, unknown>;
-}
-/**
- * Session data with user and session combined
- * Used for efficient retrieval of both user and session in one call
- */
-interface SessionData {
-    user: User;
-    session: Session;
-    expiresAt: number;
-}
-/**
- * Auth error types
- */
-declare enum AuthErrorType {
-    INVALID_CREDENTIALS = "invalid_credentials",
-    USER_NOT_FOUND = "user_not_found",
-    USER_ALREADY_EXISTS = "user_already_exists",
-    INVALID_TOKEN = "invalid_token",
-    TOKEN_EXPIRED = "token_expired",
-    NETWORK_ERROR = "network_error",
-    VALIDATION_ERROR = "validation_error",
-    MFA_REQUIRED = "mfa_required",
-    EMAIL_NOT_VERIFIED = "email_not_verified",
-    PHONE_NOT_VERIFIED = "phone_not_verified",
-    RATE_LIMIT_EXCEEDED = "rate_limit_exceeded",
-    UNKNOWN_ERROR = "unknown_error"
-}
-/**
- * Auth error class
- *
- * Extends Error to provide proper error handling with auth-specific context
- */
-declare class AuthError extends Error {
-    readonly type: AuthErrorType;
-    readonly details?: Record<string, unknown>;
-    readonly code?: string | number;
-    readonly originalError?: unknown;
-    constructor(message: string, type?: AuthErrorType, options?: {
-        details?: Record<string, unknown>;
-        code?: string | number;
-        originalError?: unknown;
-    });
-}
-/**
- * Auth context state
- */
-interface AuthContext {
-    state: AuthState;
-    user: User | null;
-    session: Session | null;
-    error: AuthError | null;
-    isAuthenticated: boolean;
-    isLoading: boolean;
-}
-/**
- * OAuth provider types
- */
-declare enum OAuthProvider {
-    GOOGLE = "google",
-    GITHUB = "github",
-    FACEBOOK = "facebook",
-    TWITTER = "twitter",
-    MICROSOFT = "microsoft",
-    APPLE = "apple",
-    LINKEDIN = "linkedin",
-    DISCORD = "discord"
-}
-/**
- * OAuth configuration
- */
-interface OAuthConfig {
-    provider: OAuthProvider;
-    clientId: string;
-    redirectUri: string;
-    scope?: string[];
-    state?: string;
-}
-/**
- * 2FA method types
- */
-declare enum TwoFactorMethod {
-    TOTP = "totp",
-    SMS = "sms",
-    EMAIL = "email",
-    BACKUP_CODE = "backup_code"
-}
-/**
- * 2FA configuration
- */
-interface TwoFactorConfig {
-    method: TwoFactorMethod;
-    enabled: boolean;
-    verified?: boolean;
-}
-/**
- * Passkey/WebAuthn types
- */
-interface PasskeyCredential {
-    id: string;
-    name?: string;
-    createdAt?: Date;
-    lastUsedAt?: Date;
-}
-/**
- * Validation error
- */
-interface ValidationError {
-    field: string;
-    message: string;
-    code?: string;
-}
-/**
- * Organization interface
- */
-interface Organization {
-    id: string;
-    name: string;
-    slug: string;
-    logoUrl?: string;
-    createdAt?: Date;
-    metadata?: Record<string, unknown>;
-}
-/**
- * Organization membership interface
- */
-interface OrganizationMembership {
-    organization: Organization;
-    role: 'owner' | 'admin' | 'member';
-    permissions?: string[];
-}
-
-/**
- * Sign in request
- */
-interface SignInRequest {
-    email?: string;
-    username?: string;
-    phone?: string;
-    password?: string;
-    remember?: boolean;
-}
-/**
- * Sign up request
- */
-interface SignUpRequest {
-    email?: string;
-    username?: string;
-    phone?: string;
-    password: string;
-    name?: string;
-    firstName?: string;
-    lastName?: string;
-    metadata?: Record<string, unknown>;
-    [key: string]: unknown;
-}
-/**
- * OAuth sign in request
- */
-interface OAuthSignInRequest {
-    provider: OAuthProvider;
-    redirectUri?: string;
-    state?: string;
-    scope?: string[];
-}
-/**
- * OAuth callback request
- */
-interface OAuthCallbackRequest {
-    provider: OAuthProvider;
-    code: string;
-    state?: string;
-}
-/**
- * Magic link request
- */
-interface MagicLinkRequest {
-    email: string;
-    redirectUri?: string;
-}
-/**
- * Magic link verify request
- */
-interface MagicLinkVerifyRequest {
-    token: string;
-}
-/**
- * Phone auth request
- */
-interface PhoneAuthRequest {
-    phone: string;
-}
-/**
- * Phone verify request
- */
-interface PhoneVerifyRequest {
-    phone: string;
-    code: string;
-}
-/**
- * 2FA setup request
- */
-interface TwoFactorSetupRequest {
-    method: TwoFactorMethod;
-    phone?: string;
-    email?: string;
-}
-/**
- * 2FA setup response
- */
-interface TwoFactorSetupResponse {
-    method: TwoFactorMethod;
-    secret?: string;
-    qrCode?: string;
-    backupCodes?: string[];
-}
-/**
- * 2FA verify request
- */
-interface TwoFactorVerifyRequest {
-    code: string;
-    method?: TwoFactorMethod;
-    remember?: boolean;
-}
-/**
- * Passkey registration request
- */
-interface PasskeyRegisterRequest {
-    name?: string;
-}
-/**
- * Passkey authentication request
- */
-interface PasskeyAuthRequest {
-    credentialId?: string;
-}
-/**
- * Password reset request
- */
-interface PasswordResetRequest {
-    email: string;
-}
-/**
- * Password reset confirm request
- */
-interface PasswordResetConfirmRequest {
-    token: string;
-    password: string;
-}
-/**
- * Password change request
- */
-interface PasswordChangeRequest {
-    currentPassword: string;
-    newPassword: string;
-}
-/**
- * Update user request
- */
-interface UpdateUserRequest {
-    name?: string;
-    firstName?: string;
-    lastName?: string;
-    avatar?: string;
-    metadata?: Record<string, unknown>;
-}
-/**
- * Field validation rules for dynamic signup fields
- */
-interface FieldValidation {
-    required?: boolean;
-    minLength?: number;
-    maxLength?: number;
-    min?: number;
-    max?: number;
-    pattern?: string;
-    errorMessage?: string;
-}
-/**
- * Field type for dynamic signup forms
- */
-type FieldType = 'text' | 'email' | 'tel' | 'number' | 'select' | 'checkbox' | 'textarea' | 'date' | 'url' | 'password' | 'group';
-/**
- * Dynamic field definition for signup forms
- */
-interface FieldDefinition {
-    name: string;
-    label: string;
-    type: FieldType;
-    placeholder?: string;
-    helperText?: string;
-    defaultValue?: string | number | boolean;
-    options?: Array<{
-        value: string;
-        label: string;
-    }>;
-    validation?: FieldValidation;
-    /**
-     * Nested fields for 'group' type
-     * Groups render multiple fields in a horizontal row with a gap
-     */
-    fields?: FieldDefinition[];
-    /**
-     * Gap between fields in a group (CSS gap value)
-     * @default '1rem'
-     */
-    gap?: string;
-    /**
-     * Order priority for field positioning
-     * Lower numbers appear first. Fields without order are sorted after ordered fields.
-     * @default undefined
-     */
-    order?: number;
-}
-/**
- * Response containing dynamic signup fields
- */
-interface SignupFieldsResponse {
-    fields: FieldDefinition[];
-}
-/**
- * Auth response
- */
-interface AuthResponse {
-    user: User;
-    session: Session;
-    requiresTwoFactor?: boolean;
-    twoFactorMethods?: TwoFactorMethod[];
-}
-/**
- * Provider configuration
- */
-interface ProviderConfig {
-    apiUrl?: string;
-    apiKey?: string;
-    [key: string]: unknown;
-}
-/**
- * Generic request context (framework-agnostic)
- * Used to pass request information to adapters in edge runtime environments
- */
-interface RequestContext {
-    headers?: Record<string, string>;
-    cookies?: Record<string, string>;
-    url?: string;
-    method?: string;
-    [key: string]: unknown;
-}
-/**
- * Cookie data to be set by the framework
- * Adapters return this data; the framework is responsible for setting cookies
- */
-interface CookieData {
-    name: string;
-    value: string;
-    options?: {
-        path?: string;
-        domain?: string;
-        secure?: boolean;
-        httpOnly?: boolean;
-        sameSite?: 'strict' | 'lax' | 'none';
-        maxAge?: number;
-        expires?: Date;
-    };
-}
-/**
- * Email verification request
- */
-interface SendVerificationEmailRequest {
-    email: string;
-}
-/**
- * Verify email request
- */
-interface VerifyEmailRequest {
-    token: string;
-    code?: string;
-}
-/**
- * Resend verification email request
- */
-interface ResendVerificationRequest {
-    email: string;
-}
-/**
- * MFA Factor representation
- */
-interface MFAFactor {
-    id: string;
-    type: string;
-    name: string;
-    status: string;
-    createdAt: Date;
-    metadata?: Record<string, unknown>;
-}
-/**
- * Enroll MFA factor request
- */
-interface EnrollMFAFactorRequest {
-    type: string;
-    name: string;
-    metadata?: Record<string, unknown>;
-}
-/**
- * Verify MFA factor request
- */
-interface VerifyMFAFactorRequest {
-    factorId: string;
-    code: string;
-}
-/**
- * MFA challenge request
- */
-interface MFAChallengeRequest {
-    userId?: string;
-    factorTypes?: string[];
-}
-/**
- * MFA challenge response
- */
-interface MFAChallengeResponse {
-    challengeId: string;
-    availableFactors: MFAFactor[];
-    expiresAt: Date;
-}
-/**
- * Device information
- */
-interface Device {
-    id: string;
-    userId: string;
-    name?: string;
-    type?: string;
-    lastUsedAt: Date;
-    ipAddress?: string;
-    userAgent?: string;
-}
-/**
- * Extended session information with device and location
- */
-interface SessionInfo extends Session {
-    device?: Device;
-    location?: string;
-}
-/**
- * Options for listing sessions with filtering and pagination
- */
-interface ListSessionsOptions {
-    /** Filter by active sessions only */
-    active?: boolean;
-    /** Filter by IP address */
-    ipAddress?: string;
-    /** Filter by user agent */
-    userAgent?: string;
-    /** Filter sessions created after this date (ISO string or Date) */
-    createdFrom?: string | Date;
-    /** Filter sessions created before this date (ISO string or Date) */
-    createdTo?: string | Date;
-    /** Field to sort by (e.g., 'createdAt', 'lastUsedAt') */
-    sortBy?: string;
-    /** Sort order */
-    sortOrder?: 'asc' | 'desc';
-    /** Maximum number of sessions to return (default: 50) */
-    limit?: number;
-    /** Number of sessions to skip for pagination (default: 0) */
-    offset?: number;
-}
-/**
- * Paginated response for session listing
- */
-interface ListSessionsResponse {
-    /** Array of session information */
-    sessions: SessionInfo[];
-    /** Total number of sessions matching the filter */
-    total: number;
-    /** Current page number */
-    page: number;
-    /** Total number of pages */
-    totalPages: number;
-    /** Number of sessions per page */
-    limit: number;
-}
-/**
- * Auth provider interface
- *
- * This interface defines the contract that all auth providers must implement.
- * Providers can be for different backends like AuthSome, Clerk, Supabase, etc.
- */
-interface AuthProvider {
-    /**
-     * Provider name/identifier
-     */
-    readonly name: string;
-    /**
-     * Initialize the provider
-     */
-    initialize(config: ProviderConfig): Promise<void>;
-    /**
-     * Sign in with email/username/phone and password
-     */
-    signIn(request: SignInRequest): Promise<AuthResponse>;
-    /**
-     * Sign up with email/username/phone and password
-     */
-    signUp(request: SignUpRequest): Promise<AuthResponse>;
-    /**
-     * Sign out
-     */
-    signOut(): Promise<void>;
-    /**
-     * Get current user
-     */
-    getCurrentUser(): Promise<User | null>;
-    /**
-     * Get current session
-     */
-    getCurrentSession(): Promise<Session | null>;
-    /**
-     * Get current session data (user + session combined)
-     * More efficient than calling getCurrentUser() and getCurrentSession() separately
-     */
-    getCurrentSessionData(): Promise<SessionData | null>;
-    /**
-     * Refresh session
-     */
-    refreshSession(): Promise<Session>;
-    /**
-     * Update user profile
-     */
-    updateUser(request: UpdateUserRequest): Promise<User>;
-    /**
-     * Change password
-     */
-    changePassword(request: PasswordChangeRequest): Promise<void>;
-    /**
-     * Request password reset
-     */
-    requestPasswordReset(request: PasswordResetRequest): Promise<void>;
-    /**
-     * Confirm password reset
-     */
-    confirmPasswordReset(request: PasswordResetConfirmRequest): Promise<void>;
-    /**
-     * Initiate OAuth sign in
-     */
-    oauthSignIn(request: OAuthSignInRequest): Promise<string>;
-    /**
-     * Handle OAuth callback
-     */
-    oauthCallback(request: OAuthCallbackRequest): Promise<AuthResponse>;
-    /**
-     * Get available OAuth providers
-     */
-    getOAuthProviders(): Promise<OAuthProvider[]>;
-    /**
-     * Send magic link
-     */
-    sendMagicLink(request: MagicLinkRequest): Promise<void>;
-    /**
-     * Verify magic link
-     */
-    verifyMagicLink(request: MagicLinkVerifyRequest): Promise<AuthResponse>;
-    /**
-     * Send phone verification code
-     */
-    sendPhoneCode(request: PhoneAuthRequest): Promise<void>;
-    /**
-     * Verify phone code
-     */
-    verifyPhoneCode(request: PhoneVerifyRequest): Promise<AuthResponse>;
-    /**
-     * Setup 2FA
-     */
-    setupTwoFactor(request: TwoFactorSetupRequest): Promise<TwoFactorSetupResponse>;
-    /**
-     * Verify 2FA
-     */
-    verifyTwoFactor(request: TwoFactorVerifyRequest): Promise<AuthResponse>;
-    /**
-     * Disable 2FA
-     */
-    disableTwoFactor(): Promise<void>;
-    /**
-     * Get 2FA status
-     */
-    getTwoFactorStatus(): Promise<TwoFactorMethod[]>;
-    /**
-     * Register passkey
-     */
-    registerPasskey(request: PasskeyRegisterRequest): Promise<PasskeyCredential>;
-    /**
-     * Authenticate with passkey
-     */
-    authenticatePasskey(request: PasskeyAuthRequest): Promise<AuthResponse>;
-    /**
-     * List passkeys
-     */
-    listPasskeys(): Promise<PasskeyCredential[]>;
-    /**
-     * Delete passkey
-     */
-    deletePasskey(credentialId: string): Promise<void>;
-    /**
-     * Normalize provider-specific errors to AuthError
-     */
-    normalizeError(error: unknown): AuthError;
-    /**
-     * Get all organizations the user belongs to
-     * Optional - only available if adapter supports organizations
-     */
-    getOrganizations?(): Promise<Organization[]>;
-    /**
-     * Get the currently active organization
-     * Optional - only available if adapter supports organizations
-     */
-    getActiveOrganization?(): Promise<Organization | null>;
-    /**
-     * Set the active organization
-     * Optional - only available if adapter supports organizations
-     */
-    setActiveOrganization?(organizationId: string): Promise<void>;
-    /**
-     * Get organization memberships with roles and permissions
-     * Optional - only available if adapter supports organizations
-     */
-    getOrganizationMemberships?(): Promise<OrganizationMembership[]>;
-    /**
-     * Get dynamic signup fields from the backend
-     * Optional - only available if adapter supports dynamic signup fields
-     */
-    getSignupFields?(): Promise<FieldDefinition[]>;
-    /**
-     * Set request context for subsequent adapter calls
-     * Optional - only needed for edge runtime environments
-     */
-    setContext?(context: RequestContext): void;
-    /**
-     * Get cookies that should be set by the framework
-     * Optional - only needed for edge runtime environments
-     */
-    getCookies?(): CookieData[];
-    /**
-     * Clear request context
-     * Optional - only needed for edge runtime environments
-     */
-    clearContext?(): void;
-    /**
-     * Send verification email to user
-     * Optional - only available if adapter supports email verification
-     */
-    sendVerificationEmail?(request: SendVerificationEmailRequest): Promise<void>;
-    /**
-     * Verify email with token/code
-     * Optional - only available if adapter supports email verification
-     */
-    verifyEmail?(request: VerifyEmailRequest): Promise<void>;
-    /**
-     * Resend verification email
-     * Optional - only available if adapter supports email verification
-     */
-    resendVerificationEmail?(request: ResendVerificationRequest): Promise<void>;
-    /**
-     * Enroll a new MFA factor
-     * Optional - only available if adapter supports advanced MFA
-     */
-    enrollMFAFactor?(request: EnrollMFAFactorRequest): Promise<MFAFactor>;
-    /**
-     * List all enrolled MFA factors
-     * Optional - only available if adapter supports advanced MFA
-     */
-    listMFAFactors?(): Promise<MFAFactor[]>;
-    /**
-     * Get specific MFA factor details
-     * Optional - only available if adapter supports advanced MFA
-     */
-    getMFAFactor?(factorId: string): Promise<MFAFactor>;
-    /**
-     * Delete an MFA factor
-     * Optional - only available if adapter supports advanced MFA
-     */
-    deleteMFAFactor?(factorId: string): Promise<void>;
-    /**
-     * Verify an MFA factor
-     * Optional - only available if adapter supports advanced MFA
-     */
-    verifyMFAFactor?(request: VerifyMFAFactorRequest): Promise<void>;
-    /**
-     * Initiate MFA challenge
-     * Optional - only available if adapter supports advanced MFA
-     */
-    initiateMFAChallenge?(request: MFAChallengeRequest): Promise<MFAChallengeResponse>;
-    /**
-     * Get MFA status for current user
-     * Optional - only available if adapter supports advanced MFA
-     */
-    getMFAStatus?(): Promise<{
-        enabled: boolean;
-        factors: MFAFactor[];
-    }>;
-    /**
-     * List all devices for current user
-     * Optional - only available if adapter supports device management
-     */
-    listDevices?(): Promise<Device[]>;
-    /**
-     * Revoke a specific device
-     * Optional - only available if adapter supports device management
-     */
-    revokeDevice?(deviceId: string): Promise<void>;
-    /**
-     * Trust a device for MFA
-     * Optional - only available if adapter supports device management
-     */
-    trustDevice?(deviceId: string, name?: string): Promise<void>;
-    /**
-     * List all trusted devices
-     * Optional - only available if adapter supports device management
-     */
-    listTrustedDevices?(): Promise<Device[]>;
-    /**
-     * Revoke trust from a device
-     * Optional - only available if adapter supports device management
-     */
-    revokeTrustedDevice?(deviceId: string): Promise<void>;
-    /**
-     * List sessions with optional filtering and pagination
-     * Optional - only available if adapter supports session management
-     *
-     * @param options - Optional filter and pagination parameters
-     * @returns Paginated session list with metadata
-     */
-    listSessions?(options?: ListSessionsOptions): Promise<ListSessionsResponse>;
-    /**
-     * Revoke a specific session
-     * Optional - only available if adapter supports session management
-     */
-    revokeSession?(sessionId: string): Promise<void>;
-    /**
-     * Revoke all sessions except current
-     * Optional - only available if adapter supports session management
-     */
-    revokeAllSessions?(): Promise<void>;
-}
-
-export { AuthErrorType as A, type FieldDefinition as B, type CookieData as C, type SignupFieldsResponse as D, type AuthResponse as E, type FieldValidation as F, type ProviderConfig as G, type SendVerificationEmailRequest as H, type VerifyEmailRequest as I, type ResendVerificationRequest as J, type MFAFactor as K, type EnrollMFAFactorRequest as L, type MagicLinkRequest as M, type VerifyMFAFactorRequest as N, type OAuthSignInRequest as O, type PasswordChangeRequest as P, type MFAChallengeRequest as Q, type RequestContext as R, type SignInRequest as S, type TwoFactorSetupRequest as T, type UpdateUserRequest as U, type ValidationError as V, type MFAChallengeResponse as W, type Device as X, type SessionInfo as Y, type ListSessionsOptions as Z, type ListSessionsResponse as _, AuthError as a, type AuthContext as b, type AuthProvider as c, type SignUpRequest as d, type PasswordResetRequest as e, type PasswordResetConfirmRequest as f, type OAuthCallbackRequest as g, OAuthProvider as h, type MagicLinkVerifyRequest as i, type PhoneAuthRequest as j, type PhoneVerifyRequest as k, type TwoFactorSetupResponse as l, type TwoFactorVerifyRequest as m, TwoFactorMethod as n, type PasskeyRegisterRequest as o, type PasskeyCredential as p, type PasskeyAuthRequest as q, type Organization as r, type OrganizationMembership as s, type User as t, type Session as u, AuthState as v, type SessionData as w, type OAuthConfig as x, type TwoFactorConfig as y, type FieldType as z };