@yiminlab/authkit 0.1.0

package/dist/index-jde0aIND.d.mts

@@ -0,0 +1,349 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+/**
+ * 认证相关类型定义
+ */
+/**
+ * 用户信息（来自 /api/auth/me）
+ */
+interface User {
+    id: string;
+    email?: string;
+    username?: string;
+    display_name?: string;
+    avatar_url?: string;
+    is_active: boolean;
+    email_verified: boolean;
+    sync_enabled: boolean;
+}
+/**
+ * Token 响应
+ */
+interface TokenResponse {
+    access_token: string;
+    refresh_token: string;
+    expires_in: number;
+    token_type: string;
+}
+/**
+ * 认证响应（登录/注册）
+ */
+interface AuthResponse extends TokenResponse {
+    user: User;
+}
+/**
+ * Token 存储数据
+ */
+interface StoredTokens {
+    accessToken: string;
+    refreshToken: string;
+    expiresAt: number;
+}
+/**
+ * 认证状态
+ */
+interface AuthState {
+    isAuthenticated: boolean;
+    isLoading: boolean;
+    user: User | null;
+    error: string | null;
+}
+/**
+ * Token 管理器接口（依赖注入）
+ */
+interface ITokenManager {
+    setTokens(accessToken: string, refreshToken: string, expiresIn: number): void;
+    getAccessToken(): string | null;
+    getRefreshToken(): string | null;
+    isAccessTokenExpired(): boolean;
+    clearTokens(): void;
+    hasValidAuth(): boolean;
+}
+/**
+ * 认证配置
+ */
+interface AuthConfig {
+    portalUrl: string;
+    apiBaseUrl: string;
+    callbackPath: string;
+    tokenKeys: {
+        accessToken: string;
+        refreshToken: string;
+        tokenExpiry: string;
+    };
+}
+/**
+ * 默认认证配置
+ */
+declare const DEFAULT_AUTH_CONFIG: AuthConfig;
+
+/**
+ * Token 管理器
+ * 提供 token 的存储、获取、验证和清除功能
+ *
+ * 设计原则：
+ * - 依赖注入：支持自定义 storage 和配置
+ * - 与 Portal 共享相同的 localStorage key
+ * - 支持 SSR（检查 window 对象）
+ */
+
+/**
+ * Storage 接口（依赖注入）
+ */
+interface IStorage {
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+}
+/**
+ * 浏览器 localStorage 适配器
+ */
+declare class LocalStorageAdapter implements IStorage {
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+}
+/**
+ * Token 管理器实现
+ */
+declare class TokenManager implements ITokenManager {
+    private storage;
+    private config;
+    constructor(storage?: IStorage, config?: Partial<AuthConfig>);
+    /**
+     * 保存 tokens
+     */
+    setTokens(accessToken: string, refreshToken: string, expiresIn: number): void;
+    /**
+     * 获取 Access Token
+     */
+    getAccessToken(): string | null;
+    /**
+     * 获取 Refresh Token
+     */
+    getRefreshToken(): string | null;
+    /**
+     * 获取 Token 过期时间
+     */
+    getTokenExpiry(): number | null;
+    /**
+     * 检查 Access Token 是否过期
+     * 提前 60 秒认为过期，留出刷新时间
+     */
+    isAccessTokenExpired(): boolean;
+    /**
+     * 清除所有 tokens
+     */
+    clearTokens(): void;
+    /**
+     * 检查是否有有效的认证信息
+     */
+    hasValidAuth(): boolean;
+    /**
+     * 获取配置
+     */
+    getConfig(): AuthConfig;
+}
+/**
+ * 获取 TokenManager 单例
+ */
+declare function getTokenManager(config?: Partial<AuthConfig>): TokenManager;
+/**
+ * 重置单例（用于测试）
+ */
+declare function resetTokenManager(): void;
+
+/**
+ * 认证跳转工具
+ * 处理跳转到 Portal 登录和回调处理
+ */
+/**
+ * 认证跳转配置
+ */
+interface AuthRedirectConfig {
+    portalUrl: string;
+    callbackPath: string;
+}
+/**
+ * 认证跳转工具类
+ */
+declare class AuthRedirect {
+    private config;
+    constructor(config?: Partial<AuthRedirectConfig>);
+    /**
+     * 获取当前页面的完整 URL
+     */
+    private getCurrentUrl;
+    /**
+     * 获取当前页面的 origin
+     */
+    private getCurrentOrigin;
+    /**
+     * 构建回调 URL
+     */
+    private buildCallbackUrl;
+    /**
+     * 构建登录跳转 URL
+     * @param returnPath 登录成功后返回的路径（默认当前页面）
+     */
+    buildLoginUrl(returnPath?: string): string;
+    /**
+     * 跳转到 Portal 登录页
+     * @param returnPath 登录成功后返回的路径
+     */
+    redirectToLogin(returnPath?: string): void;
+    /**
+     * 从 URL 参数中解析 Token
+     */
+    parseTokensFromUrl(): {
+        accessToken: string | null;
+        refreshToken: string | null;
+        expiresIn: number | null;
+        returnPath: string | null;
+    } | null;
+    /**
+     * 清除 URL 中的 Token 参数
+     */
+    clearTokensFromUrl(): void;
+    /**
+     * 验证跳转 URL 是否在白名单中
+     */
+    isAllowedRedirectUrl(url: string): boolean;
+}
+/**
+ * 获取 AuthRedirect 单例
+ */
+declare function getAuthRedirect(config?: Partial<AuthRedirectConfig>): AuthRedirect;
+/**
+ * 重置单例（用于测试）
+ */
+declare function resetAuthRedirect(): void;
+
+/**
+ * Hook 配置
+ */
+interface UseAuthOptions {
+    tokenManager?: TokenManager;
+    authRedirect?: AuthRedirect;
+    config?: Partial<AuthConfig>;
+    /**
+     * 是否自动获取用户信息
+     * @default true
+     */
+    fetchUser?: boolean;
+}
+/**
+ * Hook 返回值
+ */
+interface UseAuthReturn extends AuthState {
+    /**
+     * 登录（跳转到 Portal）
+     */
+    login: (returnPath?: string) => void;
+    /**
+     * 登出
+     */
+    logout: () => void;
+    /**
+     * 获取 access token
+     */
+    getAccessToken: () => string | null;
+    /**
+     * 刷新认证状态
+     */
+    refresh: () => void;
+    /**
+     * 刷新用户信息
+     */
+    refreshUser: () => Promise<void>;
+}
+/**
+ * 认证状态 Hook
+ */
+declare function useAuth(options?: UseAuthOptions): UseAuthReturn;
+/**
+ * 简化版 Hook：只获取 token
+ */
+declare function useAccessToken(): string | null;
+
+interface AuthGuardProps {
+    children: ReactNode;
+    /**
+     * 未登录时的行为
+     * - 'redirect': 自动跳转到登录页
+     * - 'prompt': 显示登录提示
+     * @default 'prompt'
+     */
+    fallback?: 'redirect' | 'prompt';
+    /**
+     * 登录后返回的路径
+     */
+    returnPath?: string;
+    /**
+     * 加载中显示的内容
+     */
+    loadingContent?: ReactNode;
+    /**
+     * 未登录提示内容
+     */
+    promptContent?: ReactNode;
+    /**
+     * 提示标题
+     */
+    promptTitle?: string;
+    /**
+     * 提示描述
+     */
+    promptDescription?: string;
+    /**
+     * 登录按钮文字
+     */
+    loginButtonText?: string;
+    /**
+     * useAuth 配置
+     */
+    authOptions?: UseAuthOptions;
+}
+/**
+ * 认证守卫组件
+ */
+declare function AuthGuard({ children, fallback, returnPath, loadingContent, promptContent, promptTitle, promptDescription, loginButtonText, authOptions, }: AuthGuardProps): react_jsx_runtime.JSX.Element;
+/**
+ * HOC 版本：withAuthGuard
+ */
+declare function withAuthGuard<P extends object>(Component: React.ComponentType<P>, guardProps?: Omit<AuthGuardProps, 'children'>): (props: P) => react_jsx_runtime.JSX.Element;
+
+interface CallbackHandlerProps {
+    /**
+     * 默认跳转路径（如果 URL 中没有 return 参数）
+     * @default '/'
+     */
+    defaultRedirectPath?: string;
+    /**
+     * 处理中显示的内容
+     */
+    loadingContent?: ReactNode;
+    /**
+     * 错误时显示的内容
+     */
+    errorContent?: ReactNode | ((error: string) => ReactNode);
+    /**
+     * 认证配置
+     */
+    config?: Partial<AuthConfig>;
+    /**
+     * 成功后的回调
+     */
+    onSuccess?: () => void;
+    /**
+     * 失败后的回调
+     */
+    onError?: (error: string) => void;
+}
+/**
+ * 认证回调处理组件
+ */
+declare function CallbackHandler({ defaultRedirectPath, loadingContent, errorContent, config, onSuccess, onError, }: CallbackHandlerProps): react_jsx_runtime.JSX.Element;
+
+export { type AuthResponse as A, CallbackHandler as C, DEFAULT_AUTH_CONFIG as D, type ITokenManager as I, LocalStorageAdapter as L, type StoredTokens as S, type TokenResponse as T, type User as U, type AuthState as a, type AuthConfig as b, TokenManager as c, type IStorage as d, AuthRedirect as e, getAuthRedirect as f, getTokenManager as g, resetAuthRedirect as h, type AuthRedirectConfig as i, useAccessToken as j, type UseAuthOptions as k, type UseAuthReturn as l, AuthGuard as m, type AuthGuardProps as n, type CallbackHandlerProps as o, resetTokenManager as r, useAuth as u, withAuthGuard as w };

package/dist/index-jde0aIND.d.ts

@@ -0,0 +1,349 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+/**
+ * 认证相关类型定义
+ */
+/**
+ * 用户信息（来自 /api/auth/me）
+ */
+interface User {
+    id: string;
+    email?: string;
+    username?: string;
+    display_name?: string;
+    avatar_url?: string;
+    is_active: boolean;
+    email_verified: boolean;
+    sync_enabled: boolean;
+}
+/**
+ * Token 响应
+ */
+interface TokenResponse {
+    access_token: string;
+    refresh_token: string;
+    expires_in: number;
+    token_type: string;
+}
+/**
+ * 认证响应（登录/注册）
+ */
+interface AuthResponse extends TokenResponse {
+    user: User;
+}
+/**
+ * Token 存储数据
+ */
+interface StoredTokens {
+    accessToken: string;
+    refreshToken: string;
+    expiresAt: number;
+}
+/**
+ * 认证状态
+ */
+interface AuthState {
+    isAuthenticated: boolean;
+    isLoading: boolean;
+    user: User | null;
+    error: string | null;
+}
+/**
+ * Token 管理器接口（依赖注入）
+ */
+interface ITokenManager {
+    setTokens(accessToken: string, refreshToken: string, expiresIn: number): void;
+    getAccessToken(): string | null;
+    getRefreshToken(): string | null;
+    isAccessTokenExpired(): boolean;
+    clearTokens(): void;
+    hasValidAuth(): boolean;
+}
+/**
+ * 认证配置
+ */
+interface AuthConfig {
+    portalUrl: string;
+    apiBaseUrl: string;
+    callbackPath: string;
+    tokenKeys: {
+        accessToken: string;
+        refreshToken: string;
+        tokenExpiry: string;
+    };
+}
+/**
+ * 默认认证配置
+ */
+declare const DEFAULT_AUTH_CONFIG: AuthConfig;
+
+/**
+ * Token 管理器
+ * 提供 token 的存储、获取、验证和清除功能
+ *
+ * 设计原则：
+ * - 依赖注入：支持自定义 storage 和配置
+ * - 与 Portal 共享相同的 localStorage key
+ * - 支持 SSR（检查 window 对象）
+ */
+
+/**
+ * Storage 接口（依赖注入）
+ */
+interface IStorage {
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+}
+/**
+ * 浏览器 localStorage 适配器
+ */
+declare class LocalStorageAdapter implements IStorage {
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+}
+/**
+ * Token 管理器实现
+ */
+declare class TokenManager implements ITokenManager {
+    private storage;
+    private config;
+    constructor(storage?: IStorage, config?: Partial<AuthConfig>);
+    /**
+     * 保存 tokens
+     */
+    setTokens(accessToken: string, refreshToken: string, expiresIn: number): void;
+    /**
+     * 获取 Access Token
+     */
+    getAccessToken(): string | null;
+    /**
+     * 获取 Refresh Token
+     */
+    getRefreshToken(): string | null;
+    /**
+     * 获取 Token 过期时间
+     */
+    getTokenExpiry(): number | null;
+    /**
+     * 检查 Access Token 是否过期
+     * 提前 60 秒认为过期，留出刷新时间
+     */
+    isAccessTokenExpired(): boolean;
+    /**
+     * 清除所有 tokens
+     */
+    clearTokens(): void;
+    /**
+     * 检查是否有有效的认证信息
+     */
+    hasValidAuth(): boolean;
+    /**
+     * 获取配置
+     */
+    getConfig(): AuthConfig;
+}
+/**
+ * 获取 TokenManager 单例
+ */
+declare function getTokenManager(config?: Partial<AuthConfig>): TokenManager;
+/**
+ * 重置单例（用于测试）
+ */
+declare function resetTokenManager(): void;
+
+/**
+ * 认证跳转工具
+ * 处理跳转到 Portal 登录和回调处理
+ */
+/**
+ * 认证跳转配置
+ */
+interface AuthRedirectConfig {
+    portalUrl: string;
+    callbackPath: string;
+}
+/**
+ * 认证跳转工具类
+ */
+declare class AuthRedirect {
+    private config;
+    constructor(config?: Partial<AuthRedirectConfig>);
+    /**
+     * 获取当前页面的完整 URL
+     */
+    private getCurrentUrl;
+    /**
+     * 获取当前页面的 origin
+     */
+    private getCurrentOrigin;
+    /**
+     * 构建回调 URL
+     */
+    private buildCallbackUrl;
+    /**
+     * 构建登录跳转 URL
+     * @param returnPath 登录成功后返回的路径（默认当前页面）
+     */
+    buildLoginUrl(returnPath?: string): string;
+    /**
+     * 跳转到 Portal 登录页
+     * @param returnPath 登录成功后返回的路径
+     */
+    redirectToLogin(returnPath?: string): void;
+    /**
+     * 从 URL 参数中解析 Token
+     */
+    parseTokensFromUrl(): {
+        accessToken: string | null;
+        refreshToken: string | null;
+        expiresIn: number | null;
+        returnPath: string | null;
+    } | null;
+    /**
+     * 清除 URL 中的 Token 参数
+     */
+    clearTokensFromUrl(): void;
+    /**
+     * 验证跳转 URL 是否在白名单中
+     */
+    isAllowedRedirectUrl(url: string): boolean;
+}
+/**
+ * 获取 AuthRedirect 单例
+ */
+declare function getAuthRedirect(config?: Partial<AuthRedirectConfig>): AuthRedirect;
+/**
+ * 重置单例（用于测试）
+ */
+declare function resetAuthRedirect(): void;
+
+/**
+ * Hook 配置
+ */
+interface UseAuthOptions {
+    tokenManager?: TokenManager;
+    authRedirect?: AuthRedirect;
+    config?: Partial<AuthConfig>;
+    /**
+     * 是否自动获取用户信息
+     * @default true
+     */
+    fetchUser?: boolean;
+}
+/**
+ * Hook 返回值
+ */
+interface UseAuthReturn extends AuthState {
+    /**
+     * 登录（跳转到 Portal）
+     */
+    login: (returnPath?: string) => void;
+    /**
+     * 登出
+     */
+    logout: () => void;
+    /**
+     * 获取 access token
+     */
+    getAccessToken: () => string | null;
+    /**
+     * 刷新认证状态
+     */
+    refresh: () => void;
+    /**
+     * 刷新用户信息
+     */
+    refreshUser: () => Promise<void>;
+}
+/**
+ * 认证状态 Hook
+ */
+declare function useAuth(options?: UseAuthOptions): UseAuthReturn;
+/**
+ * 简化版 Hook：只获取 token
+ */
+declare function useAccessToken(): string | null;
+
+interface AuthGuardProps {
+    children: ReactNode;
+    /**
+     * 未登录时的行为
+     * - 'redirect': 自动跳转到登录页
+     * - 'prompt': 显示登录提示
+     * @default 'prompt'
+     */
+    fallback?: 'redirect' | 'prompt';
+    /**
+     * 登录后返回的路径
+     */
+    returnPath?: string;
+    /**
+     * 加载中显示的内容
+     */
+    loadingContent?: ReactNode;
+    /**
+     * 未登录提示内容
+     */
+    promptContent?: ReactNode;
+    /**
+     * 提示标题
+     */
+    promptTitle?: string;
+    /**
+     * 提示描述
+     */
+    promptDescription?: string;
+    /**
+     * 登录按钮文字
+     */
+    loginButtonText?: string;
+    /**
+     * useAuth 配置
+     */
+    authOptions?: UseAuthOptions;
+}
+/**
+ * 认证守卫组件
+ */
+declare function AuthGuard({ children, fallback, returnPath, loadingContent, promptContent, promptTitle, promptDescription, loginButtonText, authOptions, }: AuthGuardProps): react_jsx_runtime.JSX.Element;
+/**
+ * HOC 版本：withAuthGuard
+ */
+declare function withAuthGuard<P extends object>(Component: React.ComponentType<P>, guardProps?: Omit<AuthGuardProps, 'children'>): (props: P) => react_jsx_runtime.JSX.Element;
+
+interface CallbackHandlerProps {
+    /**
+     * 默认跳转路径（如果 URL 中没有 return 参数）
+     * @default '/'
+     */
+    defaultRedirectPath?: string;
+    /**
+     * 处理中显示的内容
+     */
+    loadingContent?: ReactNode;
+    /**
+     * 错误时显示的内容
+     */
+    errorContent?: ReactNode | ((error: string) => ReactNode);
+    /**
+     * 认证配置
+     */
+    config?: Partial<AuthConfig>;
+    /**
+     * 成功后的回调
+     */
+    onSuccess?: () => void;
+    /**
+     * 失败后的回调
+     */
+    onError?: (error: string) => void;
+}
+/**
+ * 认证回调处理组件
+ */
+declare function CallbackHandler({ defaultRedirectPath, loadingContent, errorContent, config, onSuccess, onError, }: CallbackHandlerProps): react_jsx_runtime.JSX.Element;
+
+export { type AuthResponse as A, CallbackHandler as C, DEFAULT_AUTH_CONFIG as D, type ITokenManager as I, LocalStorageAdapter as L, type StoredTokens as S, type TokenResponse as T, type User as U, type AuthState as a, type AuthConfig as b, TokenManager as c, type IStorage as d, AuthRedirect as e, getAuthRedirect as f, getTokenManager as g, resetAuthRedirect as h, type AuthRedirectConfig as i, useAccessToken as j, type UseAuthOptions as k, type UseAuthReturn as l, AuthGuard as m, type AuthGuardProps as n, type CallbackHandlerProps as o, resetTokenManager as r, useAuth as u, withAuthGuard as w };