@tsingroc/tsingroc-components 5.0.0-alpha.22 → 5.0.0-alpha.23

package/dist/components/auth/AuthProvider.d.ts

@@ -13,8 +13,13 @@ export interface GenericAuthProviderProps extends SessionStoreOptions {
     persistent: false;
     children: ReactNode;
 }
-export declare function AuthProvider(props: AuthProviderProps): import("react/jsx-runtime").JSX.Element;
+/**
+ * 为内部的组件提供鉴权服务。{@linkcode useSessionStore} 和 {@linkcode useSession}，
+ * 还有很多其它 hooks 和组件都只能在这个组件的内部使用。
+ */
+export declare function AuthProvider(props: AuthProviderProps): ReactNode;
 export declare function useSessionStoreInternal(user: string): SessionStore;
+/** 获取当前上下文的 {@linkcode SessionStore}。 */
 export declare const useSessionStore: () => SessionStore;
 export declare function useSessionInternal(user: string, allowNull?: false): Session;
 export declare function useSessionInternal(user: string, allowNull: true): Session | null;
@@ -25,5 +30,6 @@ export interface UseSessionOptions {
 export interface UseSessionNonNullableOptions extends UseSessionOptions {
     allowNull?: false;
 }
+/** 获取当前上下文的登录会话。 */
 export declare function useSession(options?: UseSessionNonNullableOptions): Session;
 export declare function useSession(options?: UseSessionOptions): Session | null;

package/dist/components/auth/AuthProvider.js

@@ -4,6 +4,10 @@ import { FetcherWithAuth } from "./Fetcher";
 import { SessionStore } from "./SessionStore";
 import { jsx as _jsx } from "react/jsx-runtime";
 const AuthContext = /*#__PURE__*/createContext(null);
+/**
+ * 为内部的组件提供鉴权服务。{@linkcode useSessionStore} 和 {@linkcode useSession}，
+ * 还有很多其它 hooks 和组件都只能在这个组件的内部使用。
+ */
 export function AuthProvider(props) {
   const $ = _c(14);
   let children;
@@ -71,6 +75,8 @@ export function useSessionStoreInternal(user) {
   }
   return sessionStore;
 }
+
+/** 获取当前上下文的 {@linkcode SessionStore}。 */
 export const useSessionStore =
 //
 useSessionStoreInternal.bind(undefined, "useSessionStore");
@@ -103,6 +109,9 @@ export function useSessionInternal(user, t0) {
   }
   return session;
 }
+
+/** 获取当前上下文的登录会话。 */
+
 export function useSession(t0) {
   const $ = _c(4);
   const options = t0 === undefined ? {} : t0;

package/dist/components/auth/CasdoorAuth.d.ts

@@ -1,5 +1,5 @@
 import type { SdkConfig } from "casdoor-js-sdk/lib/esm/sdk";
-import type { JwtPayload } from "jwt-decode";
+import { type JwtPayload } from "jwt-decode";
 import { type ReactNode } from "react";
 import type { AuthService, UserInfo } from "./AuthService";
 import { fetcherWithBearerToken } from "./Fetcher";
@@ -8,6 +8,16 @@ export interface CasdoorAuthServiceOptions {
     signinOrigin?: string;
     signinPath?: string | undefined;
 }
+/**
+ * 基于 Casdoor 的鉴权服务。该鉴权服务的登录流程如下：
+ *
+ * 1. 调用 {@linkcode CasdoorAuthService.getSession | getSession()} 跳转到 SSO 登录页面。
+ * 2. 用户在登录页面完成登录，跳转到回调页面。
+ * 3. 回调页面调用 {@linkcode CasdoorAuthService.callback | callback()} 获取 token。
+ *
+ * 当使用 {@linkcode AuthProvider} 时，第 1 步由 {@linkcode LoginCheck} 完成，
+ * 第 3 步由 {@linkcode CasdoorCallback} 完成。
+ */
 export declare class CasdoorAuthService implements AuthService<string, CasdoorUserInfo> {
     #private;
     constructor(options: CasdoorAuthServiceOptions);
@@ -20,8 +30,13 @@ export declare class CasdoorAuthService implements AuthService<string, CasdoorUs
      * 若用户不经过登录流程进入回调页面，或者后端发生错误，则会抛出异常。
      */
     callback(): Promise<string>;
-    fetcherMiddleware: typeof fetcherWithBearerToken;
+    readonly fetcherMiddleware: typeof fetcherWithBearerToken;
     parseUserInfo(info: CasdoorUserInfo): UserInfo;
+    /**
+     * 解析 token 中的内容。
+     * Token 可以通过 `useSession().state` 获取。
+     */
+    decodeToken(token: string): CasdoorTokenPayload;
 }
 export interface CasdoorTokenPayload extends JwtPayload {
     /**
@@ -125,11 +140,13 @@ export interface CasdoorCallbackProps {
      */
     children?: ReactNode;
 }
-export declare function CasdoorCallback(props: CasdoorCallbackProps): string | number | bigint | boolean | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<ReactNode> | Promise<string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null;
+/** Casdoor 回调组件。请将该组件放置在 {@linkcode CasdoorAuthService} 中设定的回调路径上。 */
+export declare function CasdoorCallback(props: CasdoorCallbackProps): ReactNode;
 export interface CasdoorRoleCheckProps {
     required: string[];
     forbidden?: string[];
     error?: ReactNode;
     children: ReactNode;
 }
+/** 检查 Casdoor 用户的角色（role），限制只有特定角色的用户才能访问内部的组件。 */
 export declare function CasdoorRoleCheck(props: CasdoorRoleCheckProps): ReactNode;

package/dist/components/auth/CasdoorAuth.js

@@ -1,9 +1,23 @@
 import { c as _c } from "react/compiler-runtime";
 import Sdk from "casdoor-js-sdk";
+import { jwtDecode } from "jwt-decode";
 import { useEffect, useEffectEvent, useRef, useState, useSyncExternalStore } from "react";
-import { useSessionStoreInternal } from "./AuthProvider";
+import { useSessionStoreInternal } from "./AuthProvider"; // oxlint-disable-line no-unused-vars
+
 import { EmbeddedAuthService } from "./EmbeddedAuth";
 import { fetcherWithBearerToken } from "./Fetcher";
+// oxlint-disable-line no-unused-vars
+
+/**
+ * 基于 Casdoor 的鉴权服务。该鉴权服务的登录流程如下：
+ *
+ * 1. 调用 {@linkcode CasdoorAuthService.getSession | getSession()} 跳转到 SSO 登录页面。
+ * 2. 用户在登录页面完成登录，跳转到回调页面。
+ * 3. 回调页面调用 {@linkcode CasdoorAuthService.callback | callback()} 获取 token。
+ *
+ * 当使用 {@linkcode AuthProvider} 时，第 1 步由 {@linkcode LoginCheck} 完成，
+ * 第 3 步由 {@linkcode CasdoorCallback} 完成。
+ */
 export class CasdoorAuthService {
   #sdk;
   #signinOrigin;
@@ -45,7 +59,16 @@ export class CasdoorAuthService {
   parseUserInfo(info) {
     return info;
   }
+
+  /**
+   * 解析 token 中的内容。
+   * Token 可以通过 `useSession().state` 获取。
+   */
+  decodeToken(token) {
+    return jwtDecode(token);
+  }
 }
+/** Casdoor 回调组件。请将该组件放置在 {@linkcode CasdoorAuthService} 中设定的回调路径上。 */
 export function CasdoorCallback(props) {
   const $ = _c(8);
   const {
@@ -110,6 +133,7 @@ export function CasdoorCallback(props) {
   useEffect(t4, t5);
   return status === "loading" ? children : status === "error" ? error : success;
 }
+/** 检查 Casdoor 用户的角色（role），限制只有特定角色的用户才能访问内部的组件。 */
 export function CasdoorRoleCheck(props) {
   const $ = _c(4);
   const {

package/dist/components/auth/EmbeddedAuth.d.ts

@@ -1,16 +1,38 @@
 import type { SdkConfig } from "casdoor-js-sdk/lib/esm/sdk";
+import { type IframeHTMLAttributes, type ReactNode, type RefAttributes } from "react";
 import type { AuthService, UserInfo } from "./AuthService";
-import type { CasdoorUserInfo } from "./CasdoorAuth";
+import { type CasdoorTokenPayload, type CasdoorUserInfo } from "./CasdoorAuth";
 import { fetcherWithBearerToken } from "./Fetcher";
 export interface EmbeddedAuthServiceOptions {
     config: SdkConfig;
     timeout?: number;
 }
+/**
+ * 嵌入式鉴权服务，只能在 iframe 内使用。该鉴权服务的登录流程如下：
+ *
+ * 1. 调用 {@linkcode EmbeddedAuthService.getSession | getSession()} 向父页面获取 token。
+ * 2. 父页面响应请求，提供 token。
+ * 3. {@linkcode EmbeddedAuthService.getSession | getSession()} 返回 token。
+ *
+ * 当使用 {@linkcode AuthProvider} 时，第 1、3 步由 {@linkcode LoginCheck} 完成，
+ * 第 2 步由父页面中的 {@linkcode Embed} 完成。
+ */
 export declare class EmbeddedAuthService implements AuthService<string, CasdoorUserInfo> {
     #private;
     constructor(options: EmbeddedAuthServiceOptions);
     getSession(): Promise<string>;
     validate(token: string): Promise<CasdoorUserInfo>;
-    fetcherMiddleware: typeof fetcherWithBearerToken;
+    readonly fetcherMiddleware: typeof fetcherWithBearerToken;
     parseUserInfo(info: CasdoorUserInfo): UserInfo;
+    /**
+     * 解析 token 中的内容。
+     * Token 可以通过 `useSession().state` 获取。
+     */
+    decodeToken(token: string): CasdoorTokenPayload;
 }
+/**
+ * 嵌入一个使用了 {@linkcode EmbeddedAuthService} 的页面。
+ * 该组件必须搭配 {@linkcode CasdoorAuthService} 或 {@linkcode EmbeddedAuthService}，并且在 {@linkcode LoginCheck} 内部使用。
+ * 该组件只负责向子页面提供 token，其它方面的用法和 `<iframe>` 完全相同。
+ */
+export declare function Embed(props: IframeHTMLAttributes<HTMLIFrameElement> & RefAttributes<HTMLIFrameElement>): ReactNode;

package/dist/components/auth/EmbeddedAuth.js

@@ -1,5 +1,23 @@
+import { c as _c } from "react/compiler-runtime";
 import Sdk from "casdoor-js-sdk";
+import { jwtDecode } from "jwt-decode";
+import { useEffectEvent, useSyncExternalStore } from "react";
+import { useSessionStoreInternal } from "./AuthProvider"; // oxlint-disable-line no-unused-vars
+
+import { CasdoorAuthService } from "./CasdoorAuth";
 import { fetcherWithBearerToken } from "./Fetcher";
+// oxlint-disable-line no-unused-vars
+import { jsx as _jsx } from "react/jsx-runtime";
+/**
+ * 嵌入式鉴权服务，只能在 iframe 内使用。该鉴权服务的登录流程如下：
+ *
+ * 1. 调用 {@linkcode EmbeddedAuthService.getSession | getSession()} 向父页面获取 token。
+ * 2. 父页面响应请求，提供 token。
+ * 3. {@linkcode EmbeddedAuthService.getSession | getSession()} 返回 token。
+ *
+ * 当使用 {@linkcode AuthProvider} 时，第 1、3 步由 {@linkcode LoginCheck} 完成，
+ * 第 2 步由父页面中的 {@linkcode Embed} 完成。
+ */
 export class EmbeddedAuthService {
   #sdk;
   #timeout;
@@ -50,4 +68,138 @@ export class EmbeddedAuthService {
   parseUserInfo(info) {
     return info;
   }
+
+  /**
+   * 解析 token 中的内容。
+   * Token 可以通过 `useSession().state` 获取。
+   */
+  decodeToken(token) {
+    return jwtDecode(token);
+  }
+}
+
+/**
+ * 嵌入一个使用了 {@linkcode EmbeddedAuthService} 的页面。
+ * 该组件必须搭配 {@linkcode CasdoorAuthService} 或 {@linkcode EmbeddedAuthService}，并且在 {@linkcode LoginCheck} 内部使用。
+ * 该组件只负责向子页面提供 token，其它方面的用法和 `<iframe>` 完全相同。
+ */
+export function Embed(props) {
+  const $ = _c(16);
+  const sessionStore = useSessionStoreInternal("useSession");
+  if (!(sessionStore.service instanceof CasdoorAuthService || sessionStore.service instanceof EmbeddedAuthService)) {
+    throw new Error("CasdoorRoleCheck \u5FC5\u987B\u642D\u914D CasdoorAuthService \u6216 EmbeddedAuthService \u4F7F\u7528\uFF01");
+  }
+  let t0;
+  if ($[0] !== sessionStore) {
+    t0 = onChange => {
+      sessionStore.addEventListener(onChange);
+      return () => sessionStore.addEventListener(onChange);
+    };
+    $[0] = sessionStore;
+    $[1] = t0;
+  } else {
+    t0 = $[1];
+  }
+  let t1;
+  if ($[2] !== sessionStore.session) {
+    t1 = () => sessionStore.session;
+    $[2] = sessionStore.session;
+    $[3] = t1;
+  } else {
+    t1 = $[3];
+  }
+  const session = useSyncExternalStore(t0, t1);
+  if (!session) {
+    throw new Error("\u5F53\u524D\u7528\u6237\u672A\u767B\u5F55\uFF0C\u65E0\u6CD5\u83B7\u53D6\u4F1A\u8BDD\u3002\u8BF7\u786E\u4FDD\u53EA\u5728 LoginCheck \u5185\u90E8\u4F7F\u7528 Embed\u3002");
+  }
+  const {
+    state: token
+  } = session;
+  let t2;
+  if ($[4] !== props.src || $[5] !== token) {
+    t2 = (event, elem) => {
+      if (!props.src) {
+        return;
+      }
+      if (event.source !== elem.contentWindow) {
+        return;
+      }
+      const data = event.data;
+      if (typeof data !== "object" || !data || !("type" in data) || typeof data.type !== "string") {
+        return;
+      }
+      if (data.type === "REQUEST_TOKEN") {
+        elem.contentWindow?.postMessage({
+          type: "TOKEN_RESPONSE",
+          token
+        }, new URL(props.src).origin);
+      }
+    };
+    $[4] = props.src;
+    $[5] = token;
+    $[6] = t2;
+  } else {
+    t2 = $[6];
+  }
+  const onMessage = useEffectEvent(t2);
+  let ref;
+  let rest;
+  if ($[7] !== props) {
+    ({
+      ref,
+      ...rest
+    } = props);
+    $[7] = props;
+    $[8] = ref;
+    $[9] = rest;
+  } else {
+    ref = $[8];
+    rest = $[9];
+  }
+  let t3;
+  if ($[10] !== onMessage || $[11] !== ref) {
+    t3 = elem_0 => {
+      if (!elem_0) {
+        return;
+      }
+      const listener = event_0 => onMessage(event_0, elem_0);
+      window.addEventListener("message", listener);
+      let cleanup = undefined;
+      if (typeof ref === "function") {
+        const cleanupOrUndefined = ref(elem_0);
+        if (typeof cleanupOrUndefined === "function") {
+          cleanup = cleanupOrUndefined;
+        } else {
+          cleanup = () => ref(null);
+        }
+      } else {
+        if (ref) {
+          ref.current = elem_0;
+          cleanup = () => ref.current = null;
+        }
+      }
+      return () => {
+        cleanup?.();
+        window.removeEventListener("message", listener);
+      };
+    };
+    $[10] = onMessage;
+    $[11] = ref;
+    $[12] = t3;
+  } else {
+    t3 = $[12];
+  }
+  let t4;
+  if ($[13] !== rest || $[14] !== t3) {
+    t4 = /*#__PURE__*/_jsx("iframe", {
+      ref: t3,
+      ...rest
+    });
+    $[13] = rest;
+    $[14] = t3;
+    $[15] = t4;
+  } else {
+    t4 = $[15];
+  }
+  return t4;
 }

package/dist/components/auth/Fetcher.d.ts

@@ -16,15 +16,23 @@ export type Fetcher = (resource: RequestInfo | URL, options?: RequestInit & Fetc
 export interface FetcherExtraOptions {
     loginOn401?: boolean;
 }
+/** 在请求中添加 Authorization 头的 fetcher 中间件。 */
 export declare function fetcherWithBearerToken(token: string): (fetcher: Fetcher) => Fetcher;
+/** 在请求返回 401 错误时自动尝试登录的 fetcher 中间件。 */
 export declare function fetcherWithLoginOn401(sessionStore: SessionStore): (fetcher: Fetcher) => Fetcher;
+/** 获取当前上下文的 fetcher。 */
 export declare function useFetcher(): Fetcher;
 export interface FetcherMiddlewareProps {
     middleware: (fetcher: Fetcher) => Fetcher;
     children: ReactNode;
 }
-export declare function FetcherMiddleware(props: FetcherMiddlewareProps): import("react/jsx-runtime").JSX.Element;
+/** 为内部的组件添加额外的 fetcher 中间件，例如在发生错误时弹出警告。 */
+export declare function FetcherMiddleware(props: FetcherMiddlewareProps): ReactNode;
 export interface FetcherWithAuthProps {
     children: ReactNode;
 }
-export declare function FetcherWithAuth(props: FetcherWithAuthProps): import("react/jsx-runtime").JSX.Element;
+/**
+ * 为内部的组件的 fetcher 添加 Authorization 头。
+ * 默认设置下，{@linkcode AuthProvider} 已经提供了这个中间件，不需要另外添加。
+ */
+export declare function FetcherWithAuth(props: FetcherWithAuthProps): ReactNode;

package/dist/components/auth/Fetcher.js

@@ -1,6 +1,6 @@
 import { c as _c } from "react/compiler-runtime";
 import { createContext, use, useSyncExternalStore } from "react";
-import { useSessionStoreInternal } from "./AuthProvider";
+import { useSessionStoreInternal } from "./AuthProvider"; // oxlint-disable-line no-unused-vars
 
 /** 一个与 {@linkcode fetch} 兼容的 fetcher 函数 */
 
@@ -16,6 +16,7 @@ import { useSessionStoreInternal } from "./AuthProvider";
  * ```
  */
 import { jsx as _jsx } from "react/jsx-runtime";
+/** 在请求中添加 Authorization 头的 fetcher 中间件。 */
 export function fetcherWithBearerToken(token) {
   return fetcher => async (resource, options) => {
     const headers = new Headers(options?.headers);
@@ -29,6 +30,8 @@ export function fetcherWithBearerToken(token) {
     return resp;
   };
 }
+
+/** 在请求返回 401 错误时自动尝试登录的 fetcher 中间件。 */
 export function fetcherWithLoginOn401(sessionStore) {
   return fetcher => async (resource, options) => {
     const loggedIn = !!sessionStore.session;
@@ -42,9 +45,12 @@ export function fetcherWithLoginOn401(sessionStore) {
   };
 }
 const FetcherContext = /*#__PURE__*/createContext(fetch);
+
+/** 获取当前上下文的 fetcher。 */
 export function useFetcher() {
   return use(FetcherContext);
 }
+/** 为内部的组件添加额外的 fetcher 中间件，例如在发生错误时弹出警告。 */
 export function FetcherMiddleware(props) {
   const $ = _c(6);
   const {
@@ -75,6 +81,10 @@ export function FetcherMiddleware(props) {
   }
   return t1;
 }
+/**
+ * 为内部的组件的 fetcher 添加 Authorization 头。
+ * 默认设置下，{@linkcode AuthProvider} 已经提供了这个中间件，不需要另外添加。
+ */
 export function FetcherWithAuth(props) {
   const $ = _c(12);
   const {

package/dist/components/auth/LocalAuth.d.ts

@@ -1,4 +1,4 @@
-import type { JwtPayload } from "jwt-decode";
+import { type JwtPayload } from "jwt-decode";
 import type { AuthService, UserInfo } from "./AuthService";
 import { fetcherWithBearerToken } from "./Fetcher";
 export interface LocalAuthServiceOptions {
@@ -6,6 +6,17 @@ export interface LocalAuthServiceOptions {
     signinOrigin?: string;
     signinPath?: string;
 }
+/**
+ * 用于内网使用的鉴权服务，目前只有风功率预测系统在使用这个鉴权服务。该鉴权服务的登录流程如下：
+ *
+ * 1. 调用 {@linkcode LocalAuthService.getSession | getSession()} 跳转到登录页面。
+ *    这个操作的具体实现由初始化时的设置项 {@linkcode LocalAuthServiceOptions.openLoginPage | openLoginPage} 提供。
+ *    用户需要自行实现跳转操作，可以直接修改 {@linkcode window.location}，也可以使用 router 提供的导航功能。
+ * 2. 用户在登录页面输入账号密码，调用 {@linkcode LocalAuthService.login | login()} 得到 token。
+ *
+ * 当使用 {@linkcode AuthProvider} 时，第 1 步会由 {@linkcode LoginCheck} 自动调用，
+ * 第 2 步可以通过 {@linkcode useLocalLogin} 获取到登录函数。
+ */
 export declare class LocalAuthService implements AuthService<string, LocalUserInfo> {
     #private;
     constructor(options: LocalAuthServiceOptions);
@@ -18,8 +29,13 @@ export declare class LocalAuthService implements AuthService<string, LocalUserIn
      * 若账号密码错误，或者后端发生错误，则会抛出异常。
      */
     login(username: string, password: string): Promise<string>;
-    fetcherMiddleware: typeof fetcherWithBearerToken;
+    readonly fetcherMiddleware: typeof fetcherWithBearerToken;
     parseUserInfo(info: LocalUserInfo): UserInfo;
+    /**
+     * 解析 token 中的内容。
+     * Token 可以通过 `useSession().state` 获取。
+     */
+    decodeToken(token: string): LocalTokenPayload;
 }
 export interface LocalTokenPayload extends JwtPayload {
     /** Token 的过期时间（Unix 时间戳）。*/
@@ -67,4 +83,8 @@ export interface LocalUserInfo {
     /** 更新时间。*/
     updatedAt: string;
 }
+/**
+ * 获取 {@linkcode LocalAuthService} 的登录函数。
+ * 返回的函数只负责使用账号密码登录并将得到的 token 存入 session store，用户需要自行实现登录完成后的跳转。
+ */
 export declare function useLocalLogin(): (username: string, password: string) => Promise<import("./SessionStore").Session>;

package/dist/components/auth/LocalAuth.js

@@ -1,6 +1,21 @@
 import { c as _c } from "react/compiler-runtime";
-import { useSessionStoreInternal } from "./AuthProvider";
+import { jwtDecode } from "jwt-decode";
+import { useSessionStoreInternal } from "./AuthProvider"; // oxlint-disable-line no-unused-vars
+
 import { fetcherWithBearerToken } from "./Fetcher";
+// oxlint-disable-line no-unused-vars
+
+/**
+ * 用于内网使用的鉴权服务，目前只有风功率预测系统在使用这个鉴权服务。该鉴权服务的登录流程如下：
+ *
+ * 1. 调用 {@linkcode LocalAuthService.getSession | getSession()} 跳转到登录页面。
+ *    这个操作的具体实现由初始化时的设置项 {@linkcode LocalAuthServiceOptions.openLoginPage | openLoginPage} 提供。
+ *    用户需要自行实现跳转操作，可以直接修改 {@linkcode window.location}，也可以使用 router 提供的导航功能。
+ * 2. 用户在登录页面输入账号密码，调用 {@linkcode LocalAuthService.login | login()} 得到 token。
+ *
+ * 当使用 {@linkcode AuthProvider} 时，第 1 步会由 {@linkcode LoginCheck} 自动调用，
+ * 第 2 步可以通过 {@linkcode useLocalLogin} 获取到登录函数。
+ */
 export class LocalAuthService {
   #openLoginPage;
   #signinOrigin;
@@ -63,7 +78,19 @@ export class LocalAuthService {
       name: info.displayName ?? info.username ?? "未命名用户"
     };
   }
+
+  /**
+   * 解析 token 中的内容。
+   * Token 可以通过 `useSession().state` 获取。
+   */
+  decodeToken(token) {
+    return jwtDecode(token);
+  }
 }
+/**
+ * 获取 {@linkcode LocalAuthService} 的登录函数。
+ * 返回的函数只负责使用账号密码登录并将得到的 token 存入 session store，用户需要自行实现登录完成后的跳转。
+ */
 export function useLocalLogin() {
   const $ = _c(3);
   const sessionStore = useSessionStoreInternal("useLocalLogin");

package/dist/components/auth/LoginCheck.d.ts

@@ -10,4 +10,8 @@ export interface LoginCheckProps {
     failed?: ReactNode;
     children: ReactNode;
 }
+/**
+ * 限制只有已登录用户才能访问内部的组件。
+ * 未登录用户在该组件渲染时会自动尝试登录，登录方式由当前上下文使用的鉴权服务实现决定。
+ */
 export declare function LoginCheck(props: LoginCheckProps): ReactNode;

package/dist/components/auth/LoginCheck.js

@@ -1,5 +1,9 @@
 import { useEffect, useEffectEvent, useState, useSyncExternalStore } from "react";
 import { useSessionStoreInternal } from "./AuthProvider";
+/**
+ * 限制只有已登录用户才能访问内部的组件。
+ * 未登录用户在该组件渲染时会自动尝试登录，登录方式由当前上下文使用的鉴权服务实现决定。
+ */
 export function LoginCheck(props) {
   const {
     onValidated,

package/dist/components/auth/SessionStore.d.ts

@@ -15,6 +15,7 @@ export interface SessionStoreOptions {
     /** 是否在网络连接恢复时立即检查登录状态是否有效。 @default false */
     revalidateOnReconnect?: boolean;
 }
+/** 负责储存登录会话状态，并提供会话状态持久化、自动检查会话有效性等功能。 */
 export declare class SessionStore {
     #private;
     get service(): AuthService<unknown, unknown>;

package/dist/components/auth/SessionStore.js

@@ -1,3 +1,4 @@
+/** 负责储存登录会话状态，并提供会话状态持久化、自动检查会话有效性等功能。 */
 export class SessionStore {
   #service;
   #persistent;

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export { AuthProvider, useSessionStore, useSession, type AuthProviderProps, type TokenBasedAuthProviderProps, type GenericAuthProviderProps, type UseSessionOptions, type UseSessionNonNullableOptions, } from "./components/auth/AuthProvider";
 export type { AuthService, UserInfo } from "./components/auth/AuthService";
 export { CasdoorAuthService, CasdoorCallback, CasdoorRoleCheck, type CasdoorAuthServiceOptions, type CasdoorTokenPayload, type CasdoorUserInfo, type CasdoorCallbackProps, type CasdoorRoleCheckProps, } from "./components/auth/CasdoorAuth";
-export { EmbeddedAuthService, type EmbeddedAuthServiceOptions, } from "./components/auth/EmbeddedAuth";
+export { EmbeddedAuthService, Embed, type EmbeddedAuthServiceOptions, } from "./components/auth/EmbeddedAuth";
 export { fetcherWithBearerToken, fetcherWithLoginOn401, useFetcher, FetcherMiddleware, FetcherWithAuth, type Fetcher, type FetcherExtraOptions, type FetcherMiddlewareProps, type FetcherWithAuthProps, } from "./components/auth/Fetcher";
 export { LocalAuthService, useLocalLogin, type LocalAuthServiceOptions, type LocalTokenPayload, type LocalUserInfo, } from "./components/auth/LocalAuth";
 export { LoginCheck, type LoginCheckProps } from "./components/auth/LoginCheck";

package/dist/index.js

@@ -1,6 +1,6 @@
 export { AuthProvider, useSessionStore, useSession } from "./components/auth/AuthProvider";
 export { CasdoorAuthService, CasdoorCallback, CasdoorRoleCheck } from "./components/auth/CasdoorAuth";
-export { EmbeddedAuthService } from "./components/auth/EmbeddedAuth";
+export { EmbeddedAuthService, Embed } from "./components/auth/EmbeddedAuth";
 export { fetcherWithBearerToken, fetcherWithLoginOn401, useFetcher, FetcherMiddleware, FetcherWithAuth } from "./components/auth/Fetcher";
 export { LocalAuthService, useLocalLogin } from "./components/auth/LocalAuth";
 export { LoginCheck } from "./components/auth/LoginCheck";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsingroc/tsingroc-components",
-  "version": "5.0.0-alpha.22",
+  "version": "5.0.0-alpha.23",
   "author": "",
   "license": "ISC",
   "description": "",