@alneas/appkit-react 0.1.0 → 0.3.0

package/dist/tools/components/auth/useAuth.d.cts

@@ -1,45 +1,138 @@
 import { AuthAdapter, User } from './types.cjs';
+/**
+ * Current display authentication state; see useAuth for provider setup.
+ *
+ * @see useAuth for the canonical usage example.
+ */
 export interface AuthState {
+    /**
+     * Current display user or null; optimistic display is not proof of a verified session.
+     */
     user: User | null;
+    /**
+     * True during initial hydration/query loading or tracked login/register/logout/OAuth work.
+     */
     isLoading: boolean;
+    /**
+     * Last tracked action error or session-query error; null when none is present.
+     */
     error: Error | null;
 }
 /**
- * 認証コンテキストの値
+ * Authentication state and adapter-backed actions exposed by AuthProvider.
  *
- * AuthProvider 配下のコンポーネントで useAuth() を通じて取得できます。
- * アダプターが対応していないオプショナルメソッドは undefined になります。
+ * @remarks Optional adapter capabilities are undefined when unsupported.
+ *
+ * @see useAuth for consumption; see AuthAdapter for argument/result contracts.
  */
 export interface AuthContextValue extends AuthState {
-    /** セッションが裏で再検証され、確定した状態か。`optimisticSession` 無効時は常に true */
+    /**
+     * Whether a session query has fetched without placeholder data; false before verification even when optimistic caching is disabled.
+     */
     isSessionVerified?: boolean;
-    /** 再検証によって「未ログイン」が確定しているか。`optimisticSession` 無効時は false */
+    /**
+     * Whether backend verification completed with user null; independent of whether optimistic caching is enabled.
+     */
     isLoggedOutKnown?: boolean;
-    /** 楽観セッションキャッシュを利用中か */
+    /**
+     * Whether the provider enabled optimistic display caching.
+     */
     optimisticSession?: boolean;
-    /** メール/パスワードでログイン */
+    /**
+     * Sign in through the adapter; see AuthAdapter.login.
+     *
+     * @param email - Account email.
+     *
+     * @param password - Account password.
+     *
+     * @returns Signed-in user; adapter failures reject.
+     */
     login: AuthAdapter['login'];
-    /** 新規ユーザー登録 */
+    /**
+     * Register through the adapter; see AuthAdapter.register.
+     *
+     * @param email - New account email.
+     *
+     * @param password - New account password.
+     *
+     * @param data - Optional display name.
+     *
+     * @returns Registered user; adapter failures reject.
+     */
     register: AuthAdapter['register'];
-    /** ログアウト */
+    /**
+     * Sign out through the adapter; see AuthAdapter.logout.
+     *
+     * @returns No value after adapter sign-out; adapter failures reject.
+     */
     logout: AuthAdapter['logout'];
-    /** パスワードリセットメール送信 */
+    /**
+     * Request a reset through the adapter; see AuthAdapter.resetPassword.
+     *
+     * @param email - Account email.
+     *
+     * @returns No value after the adapter accepts the reset request; failures reject.
+     */
     resetPassword: AuthAdapter['resetPassword'];
-    /** メールアドレス変更 */
+    /**
+     * Change email through the adapter; see AuthAdapter.updateEmail.
+     *
+     * @param email - Replacement email.
+     *
+     * @returns No value after adapter completion; failures reject.
+     */
     updateEmail: AuthAdapter['updateEmail'];
-    /** パスワード変更 */
+    /**
+     * Change password through the adapter; see AuthAdapter.updatePassword.
+     *
+     * @param password - Replacement password.
+     *
+     * @returns No value after adapter completion; failures reject.
+     */
     updatePassword: AuthAdapter['updatePassword'];
-    /** 再認証（パスワード/メール変更前に必要、アダプター対応時のみ） */
+    /**
+     * Optional adapter reauthentication capability; see AuthAdapter.reauthenticate.
+     */
     reauthenticate?: AuthAdapter['reauthenticate'];
-    /** メールアドレス確認メール送信（アダプター対応時のみ） */
+    /**
+     * Optional verification-email capability; see AuthAdapter.sendVerificationEmail.
+     */
     sendVerificationEmail?: AuthAdapter['sendVerificationEmail'];
-    /** 認証トークン取得（API 連携用、アダプター対応時のみ） */
+    /**
+     * Optional token capability; see AuthAdapter.getToken.
+     */
     getToken?: AuthAdapter['getToken'];
-    /** OAuth プロバイダーでログイン（アダプター対応時のみ） */
+    /**
+     * Optional OAuth capability; see AuthAdapter.loginWithProvider.
+     */
     loginWithProvider?: AuthAdapter['loginWithProvider'];
 }
+/**
+ * Nullable React authentication context; AuthProvider owns its populated value.
+ *
+ * @see useAuth for supported consumption and missing-provider checks.
+ */
 export declare const AuthContext: import('react').Context<AuthContextValue | null>;
 /**
- * 現在の認証状態およびログイン・ログアウト等の認証操作関数を提供するReactフック。
+ * Reads authentication state and adapter actions from the nearest AuthProvider.
+ *
+ * @returns Current display state and provider actions; optional capabilities can be undefined.
+ *
+ * @throws Error when used outside AuthProvider.
+ *
+ * @remarks Requires AuthProvider inside QueryClientProvider; no CSS is required by the hook.
+ * Actions can reject with adapter errors. Backend authorization remains host-owned.
+ *
+ * @example
+ * ```tsx
+ * import type { ReactNode } from 'react';
+ * import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
+ * import { AuthProvider, useAuth, type AuthAdapter } from '@alneas/appkit-react/tools/auth';
+ *
+ * function Content() { const { user } = useAuth(); return <span>{user?.email ?? 'Signed out'}</span>; }
+ * export function Example({ adapter, queryClient }: { adapter: AuthAdapter; queryClient: QueryClient }) {
+ *   return <QueryClientProvider client={queryClient}><AuthProvider adapter={adapter}><Content /></AuthProvider></QueryClientProvider>;
+ * }
+ * ```
  */
 export declare const useAuth: () => AuthContextValue;

package/dist/tools/components/auth/useAuth.d.ts

@@ -1,45 +1,138 @@
 import { AuthAdapter, User } from './types.js';
+/**
+ * Current display authentication state; see useAuth for provider setup.
+ *
+ * @see useAuth for the canonical usage example.
+ */
 export interface AuthState {
+    /**
+     * Current display user or null; optimistic display is not proof of a verified session.
+     */
     user: User | null;
+    /**
+     * True during initial hydration/query loading or tracked login/register/logout/OAuth work.
+     */
     isLoading: boolean;
+    /**
+     * Last tracked action error or session-query error; null when none is present.
+     */
     error: Error | null;
 }
 /**
- * 認証コンテキストの値
+ * Authentication state and adapter-backed actions exposed by AuthProvider.
  *
- * AuthProvider 配下のコンポーネントで useAuth() を通じて取得できます。
- * アダプターが対応していないオプショナルメソッドは undefined になります。
+ * @remarks Optional adapter capabilities are undefined when unsupported.
+ *
+ * @see useAuth for consumption; see AuthAdapter for argument/result contracts.
  */
 export interface AuthContextValue extends AuthState {
-    /** セッションが裏で再検証され、確定した状態か。`optimisticSession` 無効時は常に true */
+    /**
+     * Whether a session query has fetched without placeholder data; false before verification even when optimistic caching is disabled.
+     */
     isSessionVerified?: boolean;
-    /** 再検証によって「未ログイン」が確定しているか。`optimisticSession` 無効時は false */
+    /**
+     * Whether backend verification completed with user null; independent of whether optimistic caching is enabled.
+     */
     isLoggedOutKnown?: boolean;
-    /** 楽観セッションキャッシュを利用中か */
+    /**
+     * Whether the provider enabled optimistic display caching.
+     */
     optimisticSession?: boolean;
-    /** メール/パスワードでログイン */
+    /**
+     * Sign in through the adapter; see AuthAdapter.login.
+     *
+     * @param email - Account email.
+     *
+     * @param password - Account password.
+     *
+     * @returns Signed-in user; adapter failures reject.
+     */
     login: AuthAdapter['login'];
-    /** 新規ユーザー登録 */
+    /**
+     * Register through the adapter; see AuthAdapter.register.
+     *
+     * @param email - New account email.
+     *
+     * @param password - New account password.
+     *
+     * @param data - Optional display name.
+     *
+     * @returns Registered user; adapter failures reject.
+     */
     register: AuthAdapter['register'];
-    /** ログアウト */
+    /**
+     * Sign out through the adapter; see AuthAdapter.logout.
+     *
+     * @returns No value after adapter sign-out; adapter failures reject.
+     */
     logout: AuthAdapter['logout'];
-    /** パスワードリセットメール送信 */
+    /**
+     * Request a reset through the adapter; see AuthAdapter.resetPassword.
+     *
+     * @param email - Account email.
+     *
+     * @returns No value after the adapter accepts the reset request; failures reject.
+     */
     resetPassword: AuthAdapter['resetPassword'];
-    /** メールアドレス変更 */
+    /**
+     * Change email through the adapter; see AuthAdapter.updateEmail.
+     *
+     * @param email - Replacement email.
+     *
+     * @returns No value after adapter completion; failures reject.
+     */
     updateEmail: AuthAdapter['updateEmail'];
-    /** パスワード変更 */
+    /**
+     * Change password through the adapter; see AuthAdapter.updatePassword.
+     *
+     * @param password - Replacement password.
+     *
+     * @returns No value after adapter completion; failures reject.
+     */
     updatePassword: AuthAdapter['updatePassword'];
-    /** 再認証（パスワード/メール変更前に必要、アダプター対応時のみ） */
+    /**
+     * Optional adapter reauthentication capability; see AuthAdapter.reauthenticate.
+     */
     reauthenticate?: AuthAdapter['reauthenticate'];
-    /** メールアドレス確認メール送信（アダプター対応時のみ） */
+    /**
+     * Optional verification-email capability; see AuthAdapter.sendVerificationEmail.
+     */
     sendVerificationEmail?: AuthAdapter['sendVerificationEmail'];
-    /** 認証トークン取得（API 連携用、アダプター対応時のみ） */
+    /**
+     * Optional token capability; see AuthAdapter.getToken.
+     */
     getToken?: AuthAdapter['getToken'];
-    /** OAuth プロバイダーでログイン（アダプター対応時のみ） */
+    /**
+     * Optional OAuth capability; see AuthAdapter.loginWithProvider.
+     */
     loginWithProvider?: AuthAdapter['loginWithProvider'];
 }
+/**
+ * Nullable React authentication context; AuthProvider owns its populated value.
+ *
+ * @see useAuth for supported consumption and missing-provider checks.
+ */
 export declare const AuthContext: import('react').Context<AuthContextValue | null>;
 /**
- * 現在の認証状態およびログイン・ログアウト等の認証操作関数を提供するReactフック。
+ * Reads authentication state and adapter actions from the nearest AuthProvider.
+ *
+ * @returns Current display state and provider actions; optional capabilities can be undefined.
+ *
+ * @throws Error when used outside AuthProvider.
+ *
+ * @remarks Requires AuthProvider inside QueryClientProvider; no CSS is required by the hook.
+ * Actions can reject with adapter errors. Backend authorization remains host-owned.
+ *
+ * @example
+ * ```tsx
+ * import type { ReactNode } from 'react';
+ * import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
+ * import { AuthProvider, useAuth, type AuthAdapter } from '@alneas/appkit-react/tools/auth';
+ *
+ * function Content() { const { user } = useAuth(); return <span>{user?.email ?? 'Signed out'}</span>; }
+ * export function Example({ adapter, queryClient }: { adapter: AuthAdapter; queryClient: QueryClient }) {
+ *   return <QueryClientProvider client={queryClient}><AuthProvider adapter={adapter}><Content /></AuthProvider></QueryClientProvider>;
+ * }
+ * ```
  */
 export declare const useAuth: () => AuthContextValue;

package/dist/tools/components/auth/useAuth.js.map

@@ -1 +1 @@
-{"version":3,"file":"useAuth.js","names":["AuthContext","createContext","useAuth","context","useContext"],"sources":["../../../../src/tools/components/auth/useAuth.ts"],"sourcesContent":["import { createContext, useContext } from 'react';\nimport type { AuthAdapter, User } from './types';\n\nexport interface AuthState {\n  user: User | null;\n  isLoading: boolean;\n  error: Error | null;\n}\n\n/**\n * 認証コンテキストの値\n *\n * AuthProvider 配下のコンポーネントで useAuth() を通じて取得できます。\n * アダプターが対応していないオプショナルメソッドは undefined になります。\n */\nexport interface AuthContextValue extends AuthState {\n  /** セッションが裏で再検証され、確定した状態か。`optimisticSession` 無効時は常に true */\n  isSessionVerified?: boolean;\n  /** 再検証によって「未ログイン」が確定しているか。`optimisticSession` 無効時は false */\n  isLoggedOutKnown?: boolean;\n  /** 楽観セッションキャッシュを利用中か */\n  optimisticSession?: boolean;\n  /** メール/パスワードでログイン */\n  login: AuthAdapter['login'];\n  /** 新規ユーザー登録 */\n  register: AuthAdapter['register'];\n  /** ログアウト */\n  logout: AuthAdapter['logout'];\n  /** パスワードリセットメール送信 */\n  resetPassword: AuthAdapter['resetPassword'];\n  /** メールアドレス変更 */\n  updateEmail: AuthAdapter['updateEmail'];\n  /** パスワード変更 */\n  updatePassword: AuthAdapter['updatePassword'];\n  /** 再認証（パスワード/メール変更前に必要、アダプター対応時のみ） */\n  reauthenticate?: AuthAdapter['reauthenticate'];\n  /** メールアドレス確認メール送信（アダプター対応時のみ） */\n  sendVerificationEmail?: AuthAdapter['sendVerificationEmail'];\n  /** 認証トークン取得（API 連携用、アダプター対応時のみ） */\n  getToken?: AuthAdapter['getToken'];\n  /** OAuth プロバイダーでログイン（アダプター対応時のみ） */\n  loginWithProvider?: AuthAdapter['loginWithProvider'];\n}\n\nexport const AuthContext = createContext<AuthContextValue | null>(null);\n\n/**\n * 現在の認証状態およびログイン・ログアウト等の認証操作関数を提供するReactフック。\n */\nexport const useAuth = () => {\n  const context = useContext(AuthContext);\n  if (!context) {\n    throw new Error('useAuth must be used within an AuthProvider');\n  }\n  return context;\n};\n"],"mappings":";;;AA4CA,IAAaA,IAAcC,EAAuC,IAAI,GAKzDC,UAAgB;CAC3B,IAAMC,IAAUC,EAAWJ,CAAW;CACtC,IAAI,CAACG,GACH,MAAU,MAAM,6CAA6C;CAE/D,OAAOA;AACT"}
+{"version":3,"file":"useAuth.js","names":["AuthContext","createContext","useAuth","context","useContext"],"sources":["../../../../src/tools/components/auth/useAuth.ts"],"sourcesContent":["import { createContext, useContext } from 'react';\nimport type { AuthAdapter, User } from './types';\n\n/**\n * Current display authentication state; see useAuth for provider setup.\n *\n * @see useAuth for the canonical usage example.\n */\nexport interface AuthState {\n  /**\n   * Current display user or null; optimistic display is not proof of a verified session.\n   */\n  user: User | null;\n  /**\n   * True during initial hydration/query loading or tracked login/register/logout/OAuth work.\n   */\n  isLoading: boolean;\n  /**\n   * Last tracked action error or session-query error; null when none is present.\n   */\n  error: Error | null;\n}\n\n/**\n * Authentication state and adapter-backed actions exposed by AuthProvider.\n *\n * @remarks Optional adapter capabilities are undefined when unsupported.\n *\n * @see useAuth for consumption; see AuthAdapter for argument/result contracts.\n */\nexport interface AuthContextValue extends AuthState {\n    /**\n     * Whether a session query has fetched without placeholder data; false before verification even when optimistic caching is disabled.\n     */\n  isSessionVerified?: boolean;\n    /**\n     * Whether backend verification completed with user null; independent of whether optimistic caching is enabled.\n     */\n  isLoggedOutKnown?: boolean;\n    /**\n     * Whether the provider enabled optimistic display caching.\n     */\n  optimisticSession?: boolean;\n    /**\n     * Sign in through the adapter; see AuthAdapter.login.\n     *\n     * @param email - Account email.\n     *\n     * @param password - Account password.\n     *\n     * @returns Signed-in user; adapter failures reject.\n     */\n  login: AuthAdapter['login'];\n    /**\n     * Register through the adapter; see AuthAdapter.register.\n     *\n     * @param email - New account email.\n     *\n     * @param password - New account password.\n     *\n     * @param data - Optional display name.\n     *\n     * @returns Registered user; adapter failures reject.\n     */\n  register: AuthAdapter['register'];\n    /**\n     * Sign out through the adapter; see AuthAdapter.logout.\n     *\n     * @returns No value after adapter sign-out; adapter failures reject.\n     */\n  logout: AuthAdapter['logout'];\n    /**\n     * Request a reset through the adapter; see AuthAdapter.resetPassword.\n     *\n     * @param email - Account email.\n     *\n     * @returns No value after the adapter accepts the reset request; failures reject.\n     */\n  resetPassword: AuthAdapter['resetPassword'];\n    /**\n     * Change email through the adapter; see AuthAdapter.updateEmail.\n     *\n     * @param email - Replacement email.\n     *\n     * @returns No value after adapter completion; failures reject.\n     */\n  updateEmail: AuthAdapter['updateEmail'];\n    /**\n     * Change password through the adapter; see AuthAdapter.updatePassword.\n     *\n     * @param password - Replacement password.\n     *\n     * @returns No value after adapter completion; failures reject.\n     */\n  updatePassword: AuthAdapter['updatePassword'];\n    /**\n     * Optional adapter reauthentication capability; see AuthAdapter.reauthenticate.\n     */\n  reauthenticate?: AuthAdapter['reauthenticate'];\n    /**\n     * Optional verification-email capability; see AuthAdapter.sendVerificationEmail.\n     */\n  sendVerificationEmail?: AuthAdapter['sendVerificationEmail'];\n    /**\n     * Optional token capability; see AuthAdapter.getToken.\n     */\n  getToken?: AuthAdapter['getToken'];\n    /**\n     * Optional OAuth capability; see AuthAdapter.loginWithProvider.\n     */\n  loginWithProvider?: AuthAdapter['loginWithProvider'];\n}\n\n/**\n * Nullable React authentication context; AuthProvider owns its populated value.\n *\n * @see useAuth for supported consumption and missing-provider checks.\n */\nexport const AuthContext = createContext<AuthContextValue | null>(null);\n\n/**\n * Reads authentication state and adapter actions from the nearest AuthProvider.\n *\n * @returns Current display state and provider actions; optional capabilities can be undefined.\n *\n * @throws Error when used outside AuthProvider.\n *\n * @remarks Requires AuthProvider inside QueryClientProvider; no CSS is required by the hook.\n * Actions can reject with adapter errors. Backend authorization remains host-owned.\n *\n * @example\n * ```tsx\n * import type { ReactNode } from 'react';\n * import { QueryClient, QueryClientProvider } from '@tanstack/react-query';\n * import { AuthProvider, useAuth, type AuthAdapter } from '@alneas/appkit-react/tools/auth';\n *\n * function Content() { const { user } = useAuth(); return <span>{user?.email ?? 'Signed out'}</span>; }\n * export function Example({ adapter, queryClient }: { adapter: AuthAdapter; queryClient: QueryClient }) {\n *   return <QueryClientProvider client={queryClient}><AuthProvider adapter={adapter}><Content /></AuthProvider></QueryClientProvider>;\n * }\n * ```\n */\nexport const useAuth = () => {\n  const context = useContext(AuthContext);\n  if (!context) {\n    throw new Error('useAuth must be used within an AuthProvider');\n  }\n  return context;\n};\n"],"mappings":";;;AAsHA,IAAaA,IAAcC,EAAuC,IAAI,GAwBzDC,UAAgB;CAC3B,IAAMC,IAAUC,EAAWJ,CAAW;CACtC,IAAI,CAACG,GACH,MAAU,MAAM,6CAA6C;CAE/D,OAAOA;AACT"}

package/dist/tools/components/auth/useAuthGuard.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"useAuthGuard.cjs","names":["useAuth","useRef","useState","useCallback","require_tools_components_auth_useAuth","react","useAuthGuard","options","lastCheckRef","pendingRedirect","setPendingRedirect","handleAuthExpired","onAuthExpired","loginPath","logoutAndRedirect","logout","checkAuth","user","isLoading","checkOnVisibility","handleVisibilityChange","handleFocus","enablePeriodicCheck","interval","checkInterval"],"sources":["../../../../src/tools/components/auth/useAuthGuard.tsx"],"sourcesContent":["import { useEffect, useCallback, useRef, useState } from 'react';\nimport { useAuth } from './useAuth';\n\nexport interface AuthGuardOptions {\n  /**\n   * 認証切れ時のコールバック\n   * @default undefined\n   */\n  onAuthExpired?: () => void;\n  /**\n   * ログインページへのリダイレクトパス\n   * @default '/login'\n   */\n  loginPath?: string;\n  /**\n   * タブフォーカス時に認証状態をチェック\n   * @default true\n   */\n  checkOnVisibility?: boolean;\n  /**\n   * 定期チェックの間隔 (ms)\n   * @default 60000 (1分)\n   */\n  checkInterval?: number;\n  /**\n   * 定期チェックを有効にする\n   * @default false\n   */\n  enablePeriodicCheck?: boolean;\n}\n\nexport interface AuthGuardResult {\n  /** 認証済みかどうか */\n  isAuthenticated: boolean;\n  /** 認証をチェック中かどうか */\n  isLoading: boolean;\n  /** 手動で認証状態をチェック */\n  checkAuth: () => Promise<void>;\n  /** ログアウトして指定パスへリダイレクト */\n  logoutAndRedirect: () => Promise<void>;\n}\n\n/**\n * 認証ガードフック\n *\n * Firebase と Supabase の両方で動作し、以下の機能を提供:\n * - onAuthStateChanged によるリアルタイム監視\n * - タブフォーカス時の認証チェック\n * - オプションの定期チェック\n * - 認証切れ時の自動リダイレクト\n *\n * @example\n * ```tsx\n * function App() {\n *   useAuthGuard({\n *     onAuthExpired: () => navigate('/login'),\n *     checkOnVisibility: true,\n *   });\n *\n *   return <MainContent />;\n * }\n * ```\n *\n * @example\n * ```tsx\n * // ルートコンポーネントで使用\n * function ProtectedRoute({ children }) {\n *   const { isAuthenticated, isLoading } = useAuthGuard({\n *     loginPath: '/login',\n *   });\n *\n *   if (isLoading) return <LoadingSpinner />;\n *   if (!isAuthenticated) return null; // リダイレクト処理中\n *   return children;\n * }\n * ```\n */\nexport function useAuthGuard(options: AuthGuardOptions = {}): AuthGuardResult {\n  const {\n    onAuthExpired,\n    loginPath = '/login',\n    checkOnVisibility = true,\n    checkInterval = 60000,\n    enablePeriodicCheck = false,\n  } = options;\n\n  const { user, isLoading, logout } = useAuth();\n  const lastCheckRef = useRef<number>(0);\n  // SSR-safe: Track pending redirect in state, perform in useEffect\n  const [pendingRedirect, setPendingRedirect] = useState<string | null>(null);\n\n  // Perform actual redirect in useEffect (client-only)\n  useEffect(() => {\n    lastCheckRef.current = Date.now();\n    if (pendingRedirect) {\n      window.location.href = pendingRedirect;\n    }\n  }, [pendingRedirect]);\n\n  const handleAuthExpired = useCallback(() => {\n    if (onAuthExpired) {\n      onAuthExpired();\n    } else {\n      // Set state instead of directly accessing window\n      setPendingRedirect(loginPath);\n    }\n  }, [onAuthExpired, loginPath]);\n\n  const logoutAndRedirect = useCallback(async () => {\n    try {\n      await logout();\n    } catch {\n      // Ignore logout errors\n    }\n    handleAuthExpired();\n  }, [logout, handleAuthExpired]);\n\n  const checkAuth = useCallback(async () => {\n    lastCheckRef.current = Date.now();\n    // 認証状態は onAuthStateChanged で自動更新されるため、\n    // ここでは現在のユーザー状態をチェック\n    if (!user && !isLoading) {\n      handleAuthExpired();\n    }\n  }, [user, isLoading, handleAuthExpired]);\n\n  // タブがフォーカスされた時のチェック\n  useEffect(() => {\n    if (!checkOnVisibility) return;\n\n    const handleVisibilityChange = () => {\n      if (document.visibilityState === 'visible') {\n        // タブがアクティブになった時、認証状態をチェック\n        checkAuth();\n      }\n    };\n\n    const handleFocus = () => {\n      // window.focus イベントでもチェック\n      checkAuth();\n    };\n\n    document.addEventListener('visibilitychange', handleVisibilityChange);\n    window.addEventListener('focus', handleFocus);\n\n    return () => {\n      document.removeEventListener('visibilitychange', handleVisibilityChange);\n      window.removeEventListener('focus', handleFocus);\n    };\n  }, [checkOnVisibility, checkAuth]);\n\n  // 定期チェック\n  useEffect(() => {\n    if (!enablePeriodicCheck) return;\n\n    const interval = setInterval(() => {\n      checkAuth();\n    }, checkInterval);\n\n    return () => clearInterval(interval);\n  }, [enablePeriodicCheck, checkInterval, checkAuth]);\n\n  // ユーザーが null になった時の処理 (セッション切れ)\n  useEffect(() => {\n    if (!isLoading && !user) {\n      // 初回ロード後にユーザーがいない場合\n      // onAuthExpired は呼ばず、コンポーネント側で判断させる\n    }\n  }, [user, isLoading]);\n\n  return {\n    isAuthenticated: !!user,\n    isLoading,\n    checkAuth,\n    logoutAndRedirect,\n  };\n}\n"],"mappings":"A,wIA6EA,SAAgBM,EAAa,EAA4B,CAAC,EAAoB,CAC5E,GAAM,CACJ,gBACA,YAAY,SACZ,oBAAoB,GACpB,gBAAgB,IAChB,sBAAsB,IACpBC,EAEE,CAAE,OAAM,YAAW,UAAWP,EAAAA,QAAQ,EACtCQ,GAAA,EAAeP,EAAAA,OAAAA,CAAe,CAAC,EAE/B,CAACQ,EAAiBC,IAAA,EAAsBR,EAAAA,SAAAA,CAAwB,IAAI,GAG1E,EAAAG,EAAA,UAAA,KAAgB,CACd,EAAa,QAAU,KAAK,IAAI,EAC5BI,IACF,OAAO,SAAS,KAAOA,EAE3B,EAAG,CAACA,CAAe,CAAC,EAEpB,IAAME,GAAA,EAAoBR,EAAAA,YAAAA,KAAkB,CACtCS,EACFA,EAAc,EAGdF,EAAmBG,CAAS,CAEhC,EAAG,CAACD,EAAeC,CAAS,CAAC,EAEvBC,GAAA,EAAoBX,EAAAA,YAAAA,CAAY,SAAY,CAChD,GAAI,CACF,MAAMY,EAAO,CACf,MAAQ,CAER,CACAJ,EAAkB,CACpB,EAAG,CAACI,EAAQJ,CAAiB,CAAC,EAExBK,GAAA,EAAYb,EAAAA,YAAAA,CAAY,SAAY,CACxC,EAAa,QAAU,KAAK,IAAI,EAG5B,CAACc,GAAQ,CAACC,GACZP,EAAkB,CAEtB,EAAG,CAACM,EAAMC,EAAWP,CAAiB,CAAC,EA8CvC,OA3CA,EAAAN,EAAA,UAAA,KAAgB,CACd,GAAI,CAACc,EAAmB,OAExB,IAAMC,MAA+B,CAC/B,SAAS,kBAAoB,WAE/BJ,EAAU,CAEd,EAEMK,MAAoB,CAExBL,EAAU,CACZ,EAKA,OAHA,SAAS,iBAAiB,mBAAoBI,CAAsB,EACpE,OAAO,iBAAiB,QAASC,CAAW,MAE/B,CACX,SAAS,oBAAoB,mBAAoBD,CAAsB,EACvE,OAAO,oBAAoB,QAASC,CAAW,CACjD,CACF,EAAG,CAACF,EAAmBH,CAAS,CAAC,GAGjC,EAAAX,EAAA,UAAA,KAAgB,CACd,GAAI,CAACiB,EAAqB,OAE1B,IAAMC,EAAW,gBAAkB,CACjCP,EAAU,CACZ,EAAGQ,CAAa,EAEhB,UAAa,cAAcD,CAAQ,CACrC,EAAG,CAACD,EAAqBE,EAAeR,CAAS,CAAC,GAGlD,EAAAX,EAAA,UAAA,KAAgB,CAKhB,EAAG,CAACY,EAAMC,CAAS,CAAC,EAEb,CACL,gBAAiB,CAAC,CAACD,EACnB,YACA,YACA,mBACF,CACF,C"}
+{"version":3,"file":"useAuthGuard.cjs","names":["useAuth","useRef","useState","useCallback","require_tools_components_auth_useAuth","react","useAuthGuard","options","lastCheckRef","pendingRedirect","setPendingRedirect","handleAuthExpired","onAuthExpired","loginPath","logoutAndRedirect","logout","checkAuth","user","isLoading","checkOnVisibility","handleVisibilityChange","handleFocus","enablePeriodicCheck","interval","checkInterval"],"sources":["../../../../src/tools/components/auth/useAuthGuard.tsx"],"sourcesContent":["import { useEffect, useCallback, useRef, useState } from 'react';\nimport { useAuth } from './useAuth';\n\n/**\n * Display-session checks and client navigation settings for useAuthGuard.\n *\n * @see useAuthGuard for behavior and setup.\n */\nexport interface AuthGuardOptions {\n    /**\n     * Callback used instead of navigation when a check finds no user; omitted by default. Callback errors propagate.\n     */\n  onAuthExpired?: () => void;\n    /**\n     * Destination assigned to window.location.href when no callback is supplied; defaults to /login.\n     */\n  loginPath?: string;\n    /**\n     * Check the current context on visible/focus events; defaults to true.\n     */\n  checkOnVisibility?: boolean;\n    /**\n     * Periodic timer interval in milliseconds; defaults to 60000 and is used only when periodic checks are enabled.\n     */\n  checkInterval?: number;\n    /**\n     * Start a repeating current-context check; defaults to false.\n     */\n  enablePeriodicCheck?: boolean;\n}\n\n/**\n * Display-session state and explicit check/navigation actions; see useAuthGuard.\n *\n * @see useAuthGuard for the canonical usage example.\n */\nexport interface AuthGuardResult {\n    /**\n     * Whether the context currently has a user; does not require isSessionVerified.\n     */\n  isAuthenticated: boolean;\n    /**\n     * Current AuthProvider loading flag.\n     */\n  isLoading: boolean;\n    /**\n     * Inspect current context, without a backend request.\n     *\n     * @returns No value; invokes expiry handling only when no user and not loading.\n     */\n  checkAuth: () => Promise<void>;\n    /**\n     * Attempt logout, swallow logout failure, then handle expiry.\n     *\n     * @returns No value after logout attempt and expiry callback or navigation scheduling.\n     *\n     * @throws Rejects if the supplied expiry callback throws.\n     */\n  logoutAndRedirect: () => Promise<void>;\n}\n\n/**\n * Checks current authentication context on explicit calls, focus or optional timers.\n *\n * @param options - Expiry callback/navigation and check scheduling; defaults to focus checks only.\n *\n * @returns Current display authentication/loading flags and explicit check/logout actions.\n *\n * @throws Error when no AuthProvider exists.\n *\n * @remarks Requires AuthProvider within QueryClientProvider. Checks do not call a backend\n * or refetch a session; they inspect useAuth state. Mounting alone does not redirect:\n * checkAuth must run via an event, timer or caller. onAuthExpired overrides navigation;\n * otherwise navigation is performed by an effect. Cleanup removes listeners/timers.\n * No CSS is required. Optimistic display state can report authenticated before verification.\n *\n * @example\n * ```tsx\n * import type { ReactNode } from 'react';\n * import { QueryClient, QueryClientProvider } from '@tanstack/react-query';\n * import { AuthProvider, useAuthGuard, type AuthAdapter } from '@alneas/appkit-react/tools/auth';\n *\n * function Content() { const { isAuthenticated } = useAuthGuard(); return <span>{isAuthenticated ? 'Signed in' : 'Signed out'}</span>; }\n * export function Example({ adapter, queryClient }: { adapter: AuthAdapter; queryClient: QueryClient }) {\n *   return <QueryClientProvider client={queryClient}><AuthProvider adapter={adapter}><Content /></AuthProvider></QueryClientProvider>;\n * }\n * ```\n */\nexport function useAuthGuard(options: AuthGuardOptions = {}): AuthGuardResult {\n  const {\n    onAuthExpired,\n    loginPath = '/login',\n    checkOnVisibility = true,\n    checkInterval = 60000,\n    enablePeriodicCheck = false,\n  } = options;\n\n  const { user, isLoading, logout } = useAuth();\n  const lastCheckRef = useRef<number>(0);\n  // SSR-safe: Track pending redirect in state, perform in useEffect\n  const [pendingRedirect, setPendingRedirect] = useState<string | null>(null);\n\n  // Perform actual redirect in useEffect (client-only)\n  useEffect(() => {\n    lastCheckRef.current = Date.now();\n    if (pendingRedirect) {\n      window.location.href = pendingRedirect;\n    }\n  }, [pendingRedirect]);\n\n  const handleAuthExpired = useCallback(() => {\n    if (onAuthExpired) {\n      onAuthExpired();\n    } else {\n      // Set state instead of directly accessing window\n      setPendingRedirect(loginPath);\n    }\n  }, [onAuthExpired, loginPath]);\n\n  const logoutAndRedirect = useCallback(async () => {\n    try {\n      await logout();\n    } catch {\n      // Ignore logout errors\n    }\n    handleAuthExpired();\n  }, [logout, handleAuthExpired]);\n\n  const checkAuth = useCallback(async () => {\n    lastCheckRef.current = Date.now();\n    // 認証状態は onAuthStateChanged で自動更新されるため、\n    // ここでは現在のユーザー状態をチェック\n    if (!user && !isLoading) {\n      handleAuthExpired();\n    }\n  }, [user, isLoading, handleAuthExpired]);\n\n  // タブがフォーカスされた時のチェック\n  useEffect(() => {\n    if (!checkOnVisibility) return;\n\n    const handleVisibilityChange = () => {\n      if (document.visibilityState === 'visible') {\n        // タブがアクティブになった時、認証状態をチェック\n        checkAuth();\n      }\n    };\n\n    const handleFocus = () => {\n      // window.focus イベントでもチェック\n      checkAuth();\n    };\n\n    document.addEventListener('visibilitychange', handleVisibilityChange);\n    window.addEventListener('focus', handleFocus);\n\n    return () => {\n      document.removeEventListener('visibilitychange', handleVisibilityChange);\n      window.removeEventListener('focus', handleFocus);\n    };\n  }, [checkOnVisibility, checkAuth]);\n\n  // 定期チェック\n  useEffect(() => {\n    if (!enablePeriodicCheck) return;\n\n    const interval = setInterval(() => {\n      checkAuth();\n    }, checkInterval);\n\n    return () => clearInterval(interval);\n  }, [enablePeriodicCheck, checkInterval, checkAuth]);\n\n  // ユーザーが null になった時の処理 (セッション切れ)\n  useEffect(() => {\n    if (!isLoading && !user) {\n      // 初回ロード後にユーザーがいない場合\n      // onAuthExpired は呼ばず、コンポーネント側で判断させる\n    }\n  }, [user, isLoading]);\n\n  return {\n    isAuthenticated: !!user,\n    isLoading,\n    checkAuth,\n    logoutAndRedirect,\n  };\n}\n"],"mappings":"A,wIAwFA,SAAgBM,EAAa,EAA4B,CAAC,EAAoB,CAC5E,GAAM,CACJ,gBACA,YAAY,SACZ,oBAAoB,GACpB,gBAAgB,IAChB,sBAAsB,IACpBC,EAEE,CAAE,OAAM,YAAW,UAAWP,EAAAA,QAAQ,EACtCQ,GAAA,EAAeP,EAAAA,OAAAA,CAAe,CAAC,EAE/B,CAACQ,EAAiBC,IAAA,EAAsBR,EAAAA,SAAAA,CAAwB,IAAI,GAG1E,EAAAG,EAAA,UAAA,KAAgB,CACd,EAAa,QAAU,KAAK,IAAI,EAC5BI,IACF,OAAO,SAAS,KAAOA,EAE3B,EAAG,CAACA,CAAe,CAAC,EAEpB,IAAME,GAAA,EAAoBR,EAAAA,YAAAA,KAAkB,CACtCS,EACFA,EAAc,EAGdF,EAAmBG,CAAS,CAEhC,EAAG,CAACD,EAAeC,CAAS,CAAC,EAEvBC,GAAA,EAAoBX,EAAAA,YAAAA,CAAY,SAAY,CAChD,GAAI,CACF,MAAMY,EAAO,CACf,MAAQ,CAER,CACAJ,EAAkB,CACpB,EAAG,CAACI,EAAQJ,CAAiB,CAAC,EAExBK,GAAA,EAAYb,EAAAA,YAAAA,CAAY,SAAY,CACxC,EAAa,QAAU,KAAK,IAAI,EAG5B,CAACc,GAAQ,CAACC,GACZP,EAAkB,CAEtB,EAAG,CAACM,EAAMC,EAAWP,CAAiB,CAAC,EA8CvC,OA3CA,EAAAN,EAAA,UAAA,KAAgB,CACd,GAAI,CAACc,EAAmB,OAExB,IAAMC,MAA+B,CAC/B,SAAS,kBAAoB,WAE/BJ,EAAU,CAEd,EAEMK,MAAoB,CAExBL,EAAU,CACZ,EAKA,OAHA,SAAS,iBAAiB,mBAAoBI,CAAsB,EACpE,OAAO,iBAAiB,QAASC,CAAW,MAE/B,CACX,SAAS,oBAAoB,mBAAoBD,CAAsB,EACvE,OAAO,oBAAoB,QAASC,CAAW,CACjD,CACF,EAAG,CAACF,EAAmBH,CAAS,CAAC,GAGjC,EAAAX,EAAA,UAAA,KAAgB,CACd,GAAI,CAACiB,EAAqB,OAE1B,IAAMC,EAAW,gBAAkB,CACjCP,EAAU,CACZ,EAAGQ,CAAa,EAEhB,UAAa,cAAcD,CAAQ,CACrC,EAAG,CAACD,EAAqBE,EAAeR,CAAS,CAAC,GAGlD,EAAAX,EAAA,UAAA,KAAgB,CAKhB,EAAG,CAACY,EAAMC,CAAS,CAAC,EAEb,CACL,gBAAiB,CAAC,CAACD,EACnB,YACA,YACA,mBACF,CACF,C"}

package/dist/tools/components/auth/useAuthGuard.d.cts

@@ -1,72 +1,83 @@
+/**
+ * Display-session checks and client navigation settings for useAuthGuard.
+ *
+ * @see useAuthGuard for behavior and setup.
+ */
 export interface AuthGuardOptions {
     /**
-     * 認証切れ時のコールバック
-     * @default undefined
+     * Callback used instead of navigation when a check finds no user; omitted by default. Callback errors propagate.
      */
     onAuthExpired?: () => void;
     /**
-     * ログインページへのリダイレクトパス
-     * @default '/login'
+     * Destination assigned to window.location.href when no callback is supplied; defaults to /login.
      */
     loginPath?: string;
     /**
-     * タブフォーカス時に認証状態をチェック
-     * @default true
+     * Check the current context on visible/focus events; defaults to true.
      */
     checkOnVisibility?: boolean;
     /**
-     * 定期チェックの間隔 (ms)
-     * @default 60000 (1分)
+     * Periodic timer interval in milliseconds; defaults to 60000 and is used only when periodic checks are enabled.
      */
     checkInterval?: number;
     /**
-     * 定期チェックを有効にする
-     * @default false
+     * Start a repeating current-context check; defaults to false.
      */
     enablePeriodicCheck?: boolean;
 }
+/**
+ * Display-session state and explicit check/navigation actions; see useAuthGuard.
+ *
+ * @see useAuthGuard for the canonical usage example.
+ */
 export interface AuthGuardResult {
-    /** 認証済みかどうか */
+    /**
+     * Whether the context currently has a user; does not require isSessionVerified.
+     */
     isAuthenticated: boolean;
-    /** 認証をチェック中かどうか */
+    /**
+     * Current AuthProvider loading flag.
+     */
     isLoading: boolean;
-    /** 手動で認証状態をチェック */
+    /**
+     * Inspect current context, without a backend request.
+     *
+     * @returns No value; invokes expiry handling only when no user and not loading.
+     */
     checkAuth: () => Promise<void>;
-    /** ログアウトして指定パスへリダイレクト */
+    /**
+     * Attempt logout, swallow logout failure, then handle expiry.
+     *
+     * @returns No value after logout attempt and expiry callback or navigation scheduling.
+     *
+     * @throws Rejects if the supplied expiry callback throws.
+     */
     logoutAndRedirect: () => Promise<void>;
 }
 /**
- * 認証ガードフック
+ * Checks current authentication context on explicit calls, focus or optional timers.
  *
- * Firebase と Supabase の両方で動作し、以下の機能を提供:
- * - onAuthStateChanged によるリアルタイム監視
- * - タブフォーカス時の認証チェック
- * - オプションの定期チェック
- * - 認証切れ時の自動リダイレクト
+ * @param options - Expiry callback/navigation and check scheduling; defaults to focus checks only.
  *
- * @example
- * ```tsx
- * function App() {
- *   useAuthGuard({
- *     onAuthExpired: () => navigate('/login'),
- *     checkOnVisibility: true,
- *   });
+ * @returns Current display authentication/loading flags and explicit check/logout actions.
  *
- *   return <MainContent />;
- * }
- * ```
+ * @throws Error when no AuthProvider exists.
+ *
+ * @remarks Requires AuthProvider within QueryClientProvider. Checks do not call a backend
+ * or refetch a session; they inspect useAuth state. Mounting alone does not redirect:
+ * checkAuth must run via an event, timer or caller. onAuthExpired overrides navigation;
+ * otherwise navigation is performed by an effect. Cleanup removes listeners/timers.
+ * No CSS is required. Optimistic display state can report authenticated before verification.
  *
  * @example
  * ```tsx
- * // ルートコンポーネントで使用
- * function ProtectedRoute({ children }) {
- *   const { isAuthenticated, isLoading } = useAuthGuard({
- *     loginPath: '/login',
- *   });
+ * import type { ReactNode } from 'react';
+ * import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
+ * import { AuthProvider, useAuthGuard, type AuthAdapter } from '@alneas/appkit-react/tools/auth';
  *
- *   if (isLoading) return <LoadingSpinner />;
- *   if (!isAuthenticated) return null; // リダイレクト処理中
- *   return children;
+ * function Content() { const { isAuthenticated } = useAuthGuard(); return <span>{isAuthenticated ? 'Signed in' : 'Signed out'}</span>; }
+ * export function Example({ adapter, queryClient }: { adapter: AuthAdapter; queryClient: QueryClient }) {
+ *   return <QueryClientProvider client={queryClient}><AuthProvider adapter={adapter}><Content /></AuthProvider></QueryClientProvider>;
  * }
  * ```
  */

package/dist/tools/components/auth/useAuthGuard.d.ts

@@ -1,72 +1,83 @@
+/**
+ * Display-session checks and client navigation settings for useAuthGuard.
+ *
+ * @see useAuthGuard for behavior and setup.
+ */
 export interface AuthGuardOptions {
     /**
-     * 認証切れ時のコールバック
-     * @default undefined
+     * Callback used instead of navigation when a check finds no user; omitted by default. Callback errors propagate.
      */
     onAuthExpired?: () => void;
     /**
-     * ログインページへのリダイレクトパス
-     * @default '/login'
+     * Destination assigned to window.location.href when no callback is supplied; defaults to /login.
      */
     loginPath?: string;
     /**
-     * タブフォーカス時に認証状態をチェック
-     * @default true
+     * Check the current context on visible/focus events; defaults to true.
      */
     checkOnVisibility?: boolean;
     /**
-     * 定期チェックの間隔 (ms)
-     * @default 60000 (1分)
+     * Periodic timer interval in milliseconds; defaults to 60000 and is used only when periodic checks are enabled.
      */
     checkInterval?: number;
     /**
-     * 定期チェックを有効にする
-     * @default false
+     * Start a repeating current-context check; defaults to false.
      */
     enablePeriodicCheck?: boolean;
 }
+/**
+ * Display-session state and explicit check/navigation actions; see useAuthGuard.
+ *
+ * @see useAuthGuard for the canonical usage example.
+ */
 export interface AuthGuardResult {
-    /** 認証済みかどうか */
+    /**
+     * Whether the context currently has a user; does not require isSessionVerified.
+     */
     isAuthenticated: boolean;
-    /** 認証をチェック中かどうか */
+    /**
+     * Current AuthProvider loading flag.
+     */
     isLoading: boolean;
-    /** 手動で認証状態をチェック */
+    /**
+     * Inspect current context, without a backend request.
+     *
+     * @returns No value; invokes expiry handling only when no user and not loading.
+     */
     checkAuth: () => Promise<void>;
-    /** ログアウトして指定パスへリダイレクト */
+    /**
+     * Attempt logout, swallow logout failure, then handle expiry.
+     *
+     * @returns No value after logout attempt and expiry callback or navigation scheduling.
+     *
+     * @throws Rejects if the supplied expiry callback throws.
+     */
     logoutAndRedirect: () => Promise<void>;
 }
 /**
- * 認証ガードフック
+ * Checks current authentication context on explicit calls, focus or optional timers.
  *
- * Firebase と Supabase の両方で動作し、以下の機能を提供:
- * - onAuthStateChanged によるリアルタイム監視
- * - タブフォーカス時の認証チェック
- * - オプションの定期チェック
- * - 認証切れ時の自動リダイレクト
+ * @param options - Expiry callback/navigation and check scheduling; defaults to focus checks only.
  *
- * @example
- * ```tsx
- * function App() {
- *   useAuthGuard({
- *     onAuthExpired: () => navigate('/login'),
- *     checkOnVisibility: true,
- *   });
+ * @returns Current display authentication/loading flags and explicit check/logout actions.
  *
- *   return <MainContent />;
- * }
- * ```
+ * @throws Error when no AuthProvider exists.
+ *
+ * @remarks Requires AuthProvider within QueryClientProvider. Checks do not call a backend
+ * or refetch a session; they inspect useAuth state. Mounting alone does not redirect:
+ * checkAuth must run via an event, timer or caller. onAuthExpired overrides navigation;
+ * otherwise navigation is performed by an effect. Cleanup removes listeners/timers.
+ * No CSS is required. Optimistic display state can report authenticated before verification.
  *
  * @example
  * ```tsx
- * // ルートコンポーネントで使用
- * function ProtectedRoute({ children }) {
- *   const { isAuthenticated, isLoading } = useAuthGuard({
- *     loginPath: '/login',
- *   });
+ * import type { ReactNode } from 'react';
+ * import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
+ * import { AuthProvider, useAuthGuard, type AuthAdapter } from '@alneas/appkit-react/tools/auth';
  *
- *   if (isLoading) return <LoadingSpinner />;
- *   if (!isAuthenticated) return null; // リダイレクト処理中
- *   return children;
+ * function Content() { const { isAuthenticated } = useAuthGuard(); return <span>{isAuthenticated ? 'Signed in' : 'Signed out'}</span>; }
+ * export function Example({ adapter, queryClient }: { adapter: AuthAdapter; queryClient: QueryClient }) {
+ *   return <QueryClientProvider client={queryClient}><AuthProvider adapter={adapter}><Content /></AuthProvider></QueryClientProvider>;
  * }
  * ```
  */