@tsingroc/tsingroc-components 5.0.0-alpha.27 → 5.0.1

package/dist/components/{AutoResizedECharts.d.ts → AutoResizedECharts/index.d.ts}

@@ -1,4 +1,4 @@
-import type { EChartsHOCType } from "./ECharts";
+import type { EChartsHOCType } from "../ECharts";
 /**
  * 为 ECharts 增加自适应容器尺寸的能力。
  *
@@ -15,5 +15,5 @@ export declare const withAutoResize: EChartsHOCType;
  *
  * @see {@linkcode withAutoResize}
  */
-declare const AutoResizedECharts: import("./ECharts").EChartsComponentType<{}>;
+declare const AutoResizedECharts: import("../ECharts").EChartsComponentType<{}>;
 export default AutoResizedECharts;

package/dist/components/{AutoResizedECharts.js → AutoResizedECharts/index.js}

@@ -1,7 +1,7 @@
 import { c as _c } from "react/compiler-runtime";
 import { useEffect, useImperativeHandle, useRef } from "react";
-import { debugAssert } from "../utils/debug";
-import EChartsInstance from "./ECharts";
+import { debugAssert } from "#src/utils/debug";
+import EChartsInstance from "../ECharts";
 
 /**
  * 为 ECharts 增加自适应容器尺寸的能力。

package/dist/components/{Calendar.js → Calendar/index.js}

@@ -79,7 +79,7 @@ function Calendar(props) {
     styles
   } = useStyles();
   const [selected, setSelected] = propsSelected === undefined
-  // eslint-disable-next-line react-hooks/rules-of-hooks
+  // oxlint-disable-next-line rules-of-hooks
   ? useState() : [propsSelected, () => {}];
   const monthStart = month.startOf("month");
   const calendarStart = monthStart.startOf("week");
@@ -105,13 +105,13 @@ function Calendar(props) {
       children: Array.from({
         length: alwaysSixWeeks ? 6 : minWeeks
       }, (_, week) => /*#__PURE__*/_jsx("tr", {
-        children: Array(7).fill(null).map((_, weekday) => {
-          const date = calendarStart.add(week * 7 + weekday, "day");
+        children: Array(7).fill(null).map((__0, weekday_0) => {
+          const date = calendarStart.add(week * 7 + weekday_0, "day");
           const fade = fadeAdjacentDays && date.month() !== monthStart.month();
           const isSelected = Math.floor(selected?.diff(date, "day", true) ?? NaN) === 0;
           const {
-            className,
-            ...props
+            className: className_0,
+            ...props_0
           } = tdProps?.(date, false) ?? {};
           return /*#__PURE__*/_jsx("td", {
             // oxlint-disable-next-line react/no-children-prop
@@ -120,12 +120,12 @@ function Calendar(props) {
               setSelected(date);
               onChange?.(date);
             },
-            ...props,
+            ...props_0,
             className: cx({
               [styles.calendarFade]: fade,
               [styles.calendarSelected]: isSelected
-            }, className)
-          }, weekday);
+            }, className_0)
+          }, weekday_0);
         })
       }, week))
     })]

package/dist/components/{ConnectedECharts.d.ts → ConnectedECharts/index.d.ts}

@@ -1,5 +1,5 @@
 import { type ReactNode } from "react";
-import type { EChartsHOCType } from "./ECharts";
+import type { EChartsHOCType } from "../ECharts";
 /**
  * 为 {@linkcode ConnectedECharts}/{@linkcode withConnector | withConnector(ECharts)}
  * 提供联动上下文，只有同一个上下文内的 ECharts 会联动。
@@ -22,7 +22,7 @@ export declare const withConnector: EChartsHOCType<{
  * @see {@linkcode withConnector}
  * @see {@linkcode withAutoResize}
  */
-declare const ConnectedECharts: import("./ECharts").EChartsComponentType<{
+declare const ConnectedECharts: import("../ECharts").EChartsComponentType<{
     group?: string;
 }>;
 export default ConnectedECharts;

package/dist/components/{ConnectedECharts.js → ConnectedECharts/index.js}

@@ -1,7 +1,7 @@
 import { c as _c } from "react/compiler-runtime";
 import * as echarts from "echarts/core";
 import { createContext, use, useId } from "react";
-import AutoResizedECharts from "./AutoResizedECharts"; // eslint-disable-line @typescript-eslint/no-unused-vars
+import AutoResizedECharts from "../AutoResizedECharts"; // oxlint-disable-line no-unused-vars
 import { jsx as _jsx } from "react/jsx-runtime";
 const EChartsConnectorContext = /*#__PURE__*/createContext("default");
 

package/dist/components/ECharts/Wrapper.d.ts

@@ -0,0 +1,5 @@
+import type { EChartsProps } from ".";
+/**
+ * ECharts 的 React 封装，支持 `theme`、`opts` 等初始化参数和 `option` 配置的响应式更新。
+ */
+export declare const EChartsWrapper: (_props: EChartsProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/ECharts/Wrapper.js

@@ -0,0 +1,16 @@
+import { c as _c } from "react/compiler-runtime";
+import { jsx as _jsx } from "react/jsx-runtime";
+/**
+ * ECharts 的 React 封装，支持 `theme`、`opts` 等初始化参数和 `option` 配置的响应式更新。
+ */
+export const EChartsWrapper = _props => {
+  const $ = _c(1);
+  let t0;
+  if ($[0] === Symbol.for("react.memo_cache_sentinel")) {
+    t0 = /*#__PURE__*/_jsx("a", {});
+    $[0] = t0;
+  } else {
+    t0 = $[0];
+  }
+  return t0;
+};

package/dist/components/{ECharts.d.ts → ECharts/index.d.ts}

@@ -9,7 +9,10 @@ export interface EChartsProps<Option extends EChartsCoreOption = EChartsOption>
      * 实例上添加事件监听器或者执行其它的初始化操作，请使用 {@linkcode onInit}。
      */
     ref?: Ref<EChartsRef>;
-    /** 主题。 @default "default" */
+    /**
+     * 主题。
+     * @default "default"
+     */
     theme?: string | Record<string, any> | null;
     /**
      * 初始化实例时的选项。

package/dist/components/{ECharts.js → ECharts/index.js}

@@ -1,10 +1,7 @@
 import { c as _c } from "react/compiler-runtime";
-/* eslint-disable @typescript-eslint/no-empty-object-type */
-/* eslint-disable @typescript-eslint/no-invalid-void-type */
-/* eslint-disable @typescript-eslint/no-explicit-any */
 import * as echarts from "echarts/core";
 import { useEffect, useEffectEvent, useImperativeHandle, useRef } from "react";
-import { debugAssert } from "../utils/debug";
+import { debugAssert } from "#src/utils/debug";
 
 /** 用于 HOC 的返回值。 */
 
@@ -250,6 +247,6 @@ function useForwardEChartsRef(outerRef, innerRef) {
         return innerRef.current.instance;
       }
     };
-    // eslint-disable-next-line react-hooks/exhaustive-deps
+    // oxlint-disable-next-line exhaustive-deps
   }, []);
 }

package/dist/components/{Header.js → Header/index.js}

@@ -1,8 +1,8 @@
 import { c as _c } from "react/compiler-runtime";
 import { Flex, Layout, Menu, theme } from "antd";
-import UserButton from "./UserButton";
-// eslint-disable-line @typescript-eslint/no-unused-vars
-// eslint-disable-line @typescript-eslint/no-unused-vars
+import UserButton from "../UserButton";
+// oxlint-disable-line no-unused-vars
+// oxlint-disable-line no-unused-vars
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 /**
  * 顶栏组件。该组件需要放置在 [Ant Design 的 `Layout` 组件][1]内部才能正常工作。

package/dist/components/{LeftAlignedECharts.d.ts → LeftAlignedECharts/index.d.ts}

@@ -1,5 +1,5 @@
 import { type ReactNode } from "react";
-import type { EChartsHOCType } from "./ECharts";
+import type { EChartsHOCType } from "../ECharts";
 /**
  * 为 {@linkcode LeftAlignedECharts} 和
  * {@linkcode withLeftAlign | withLeftAlign(ECharts)}
@@ -34,7 +34,7 @@ export declare const withLeftAlign: EChartsHOCType;
  * @see {@linkcode withConnector}
  * @see {@linkcode withAutoResize}
  */
-declare const LeftAlignedECharts: import("./ECharts").EChartsComponentType<{
+declare const LeftAlignedECharts: import("../ECharts").EChartsComponentType<{
     group?: string;
 }>;
 export default LeftAlignedECharts;

package/dist/components/{LeftAlignedECharts.js → LeftAlignedECharts/index.js}

@@ -1,8 +1,8 @@
 import { c as _c } from "react/compiler-runtime";
 import { createContext, use, useEffect, useEffectEvent, useId, useImperativeHandle, useRef, useState } from "react";
-import { debugAssert } from "../utils/debug";
-// eslint-disable-line @typescript-eslint/no-unused-vars
-import ConnectedECharts from "./ConnectedECharts"; // eslint-disable-line @typescript-eslint/no-unused-vars
+import { debugAssert } from "#src/utils/debug";
+// oxlint-disable-line no-unused-vars
+import ConnectedECharts from "../ConnectedECharts"; // oxlint-disable-line no-unused-vars
 import { jsx as _jsx } from "react/jsx-runtime";
 const LeftAlignContext = /*#__PURE__*/createContext(null);
 

package/dist/components/{LineChartEditor.js → LineChartEditor/index.js}

@@ -1,8 +1,8 @@
 import { Button, ConfigProvider, Flex, Input, Modal, Table, message, theme } from "antd";
 import { createStyles } from "antd-style";
 import { use, useCallback, useEffect, useMemo, useRef, useState } from "react";
-import * as echarts from "../echarts";
-import ECharts from "./ECharts";
+import * as echarts from "#src/echarts";
+import ECharts from "../ECharts";
 import { jsxs as _jsxs, jsx as _jsx, Fragment as _Fragment } from "react/jsx-runtime";
 /**
  * 一个折线图编辑器，由折线图、数据表格和确认/撤销按钮三部分组成。
@@ -31,7 +31,6 @@ function LineChartEditor(props) {
     adjustStep: defaultAdjustStep = 0.1,
     ...rest
   } = props;
-  // TODO i18n
   const unitString = yUnit !== undefined ? `（${yUnit}）` : "";
   const {
     cx,
@@ -111,7 +110,6 @@ function LineChartEditor(props) {
       left: "center",
       top: 0,
       style: {
-        // TODO i18n
         text: !chartFocused ? "" : selectedIndex !== undefined ? "可使用键盘 ↑/↓/W/S 键调节选中数据，使用 +/- 键修改调节步长" : hoverIndex !== undefined ? "点击可选中当前数据点" : "",
         fill: token.colorTextLabel
       }
@@ -271,7 +269,6 @@ function LineChartEditor(props) {
     }
     let confirmed = true;
     if (confirmPopup) {
-      // TODO i18n
       confirmed = await modal.confirm({
         title: "确定要保存修改吗？",
         width: "fit-content",
@@ -392,7 +389,7 @@ function EditorCell({
       ...props
     });
   }
-  /* eslint-disable react-hooks/rules-of-hooks */
+  /* oxlint-disable rules-of-hooks */
   const {
     styles
   } = useStyles();

package/dist/components/{LineChartTable.js → LineChartTable/index.js}

@@ -2,8 +2,8 @@ import { c as _c } from "react/compiler-runtime";
 import { ConfigProvider, Flex, Table, theme } from "antd";
 import { createStyles } from "antd-style";
 import { use, useEffect, useMemo, useRef, useState } from "react";
-import * as echarts from "../echarts";
-import ECharts from "./ECharts";
+import * as echarts from "#src/echarts";
+import ECharts from "../ECharts";
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 const EMPTY = [];
 

package/dist/components/{LinkedLineChart.d.ts → LinkedLineChart/index.d.ts}

@@ -1,6 +1,6 @@
 import type { LineSeriesOption } from "echarts";
 import { type ReactNode } from "react";
-import type { EChartsProps } from "./ECharts";
+import type { EChartsProps } from "../ECharts";
 export interface LineChartLinkProviderProps {
     /** X 轴的数据。*/
     xData: (string | number)[];

package/dist/components/{LinkedLineChart.js → LinkedLineChart/index.js}

@@ -1,8 +1,10 @@
 import { c as _c } from "react/compiler-runtime";
 import { ConfigProvider, theme } from "antd";
+import { DataZoomComponent } from "echarts/components";
+import * as echartsCore from "echarts/core";
 import { createContext, use } from "react";
-import * as echarts from "../echarts";
-import ConnectedECharts, { EChartsConnector } from "./ConnectedECharts";
+import * as echarts from "#src/echarts";
+import ConnectedECharts, { EChartsConnector } from "../ConnectedECharts";
 import { jsx as _jsx } from "react/jsx-runtime";
 const LineChartLinkContext = /*#__PURE__*/createContext({
   xData: [],
@@ -49,6 +51,7 @@ export function LineChartLinkProvider(props) {
  */
 function LinkedLineChart(props) {
   const $ = _c(10);
+  echartsCore.use(DataZoomComponent);
   let rest;
   let t0;
   let t1;

package/dist/components/{QuickDateRangePicker.js → QuickDateRangePicker/index.js}

@@ -28,11 +28,11 @@ function QuickDateRangePicker(props) {
     ...rest
   } = props;
   const [range, setRange] = value === undefined
-  // eslint-disable-next-line react-hooks/rules-of-hooks
+  // oxlint-disable-next-line rules-of-hooks
   ? useState(undefined) : [value, () => {}];
-  function quickPick(value) {
+  function quickPick(value_0) {
     const end = dayjs();
-    const start = end.subtract(value - 1, "day");
+    const start = end.subtract(value_0 - 1, "day");
     const newRange = [start, end];
     setRange(newRange);
     onChange?.(newRange);
@@ -46,9 +46,9 @@ function QuickDateRangePicker(props) {
     }, index)), /*#__PURE__*/_jsx(DatePicker.RangePicker, {
       value: range,
       allowClear: false,
-      onChange: range => {
-        setRange(range);
-        onChange?.(range); // 由于 allowClear=false，这里 range 不可能为 null
+      onChange: range_0 => {
+        setRange(range_0);
+        onChange?.(range_0); // 由于 allowClear=false，这里 range 不可能为 null
       },
       ...pickerProps
     })]

package/dist/components/{SegmentedButtons.js → SegmentedButtons/index.js}

@@ -24,8 +24,6 @@ function SegmentedButtons(props) {
   }
   return t0;
 }
-
-// TODO i18n
 const TIME_UNIT_OPTIONS = [{
   label: "日",
   value: "day"

package/dist/components/{SelectableECharts.d.ts → SelectableECharts/index.d.ts}

@@ -1,12 +1,18 @@
 import type { MarkAreaComponentOption } from "echarts";
 import type { ZRStyleProps } from "echarts/types/src/util/types.js";
-import { type EChartsHOCType } from "./ECharts";
+import { type EChartsHOCType } from "../ECharts";
 export interface SelectableEChartsProps {
-    /** 编辑器的选中方式。 @default "add" */
+    /**
+     * 编辑器的选中方式。
+     * @default "add"
+     */
     mode?: "add" | "subtract";
     /** 可选中的系列名，若为 `undefined` 则均不可选中。（如果需要选中多个系列，可以嵌套多层 `withSelectable`） */
     seriesName?: string;
-    /** 选中的数据点下标集合。 @default new Set() */
+    /**
+     * 选中的数据点下标集合。
+     * @default new Set()
+     */
     selectedIndices?: Set<number>;
     /** 选中区域变化时的回调。 */
     onSelectedIndicesChange?: (selectedIndices: Set<number>) => void;
@@ -20,3 +26,5 @@ export interface SelectableEChartsProps {
     markAreaStyle?: MarkAreaComponentOption["itemStyle"];
 }
 export declare const withSelectable: EChartsHOCType<SelectableEChartsProps>;
+declare const SelectableECharts: import("../ECharts").EChartsComponentType<SelectableEChartsProps>;
+export default SelectableECharts;

package/dist/components/{SelectableECharts.js → SelectableECharts/index.js}

@@ -2,10 +2,11 @@ import { c as _c } from "react/compiler-runtime";
 import { GraphicComponent, MarkAreaComponent } from "echarts/components";
 import * as echarts from "echarts/core";
 import { useEffectEvent, useState } from "react";
-import { debugAssert } from "../utils";
-import { destructureLineDataItem } from "../utils/destructureLineDataItem";
-import { normalizeIntoArray } from "../utils/normalizeIntoArray";
-import "./ECharts";
+import { debugAssert } from "#src/utils";
+import { destructureLineDataItem } from "#src/utils/destructureLineDataItem";
+import { normalizeIntoArray } from "#src/utils/normalizeIntoArray";
+import AutoResizedECharts from "../AutoResizedECharts";
+import "../ECharts";
 import { jsx as _jsx } from "react/jsx-runtime";
 const DEFAULT_SELECTED_INDICES = new Set();
 const DEFAULT_SELECTION_BOX_STYLE = {
@@ -385,6 +386,8 @@ export const withSelectable = ECharts => function SelectableECharts(props) {
     ...rest
   });
 };
+const SelectableECharts = withSelectable(AutoResizedECharts);
+export default SelectableECharts;
 function _temp(item, idx) {
   return destructureLineDataItem(item, idx)?.[0][0];
 }

package/dist/components/{Sidebar.js → Sidebar/index.js}

@@ -2,9 +2,9 @@ import { BarChartOutlined, LeftOutlined, RightOutlined, SwapOutlined, TeamOutlin
 import { Button, Flex, Layout, Menu } from "antd";
 import { createStyles } from "antd-style";
 import { useState } from "react";
-import UserButton from "./UserButton";
-// eslint-disable-line @typescript-eslint/no-unused-vars
-// eslint-disable-line @typescript-eslint/no-unused-vars
+import UserButton from "../UserButton";
+// oxlint-disable-line no-unused-vars
+// oxlint-disable-line no-unused-vars
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 const menuItem = (label, key, icon, children) => ({
   key,

package/dist/components/{TsingrocDatePicker.js → TsingrocDatePicker/index.js}

@@ -20,7 +20,7 @@ function TsingrocDatePicker(props) {
     ...rest
   } = props;
   const [dateValue, setDateValue] = value === undefined
-  // eslint-disable-next-line react-hooks/rules-of-hooks
+  // oxlint-disable-next-line rules-of-hooks
   ? useState(undefined) : [value, () => {}];
   /**
    * 快速增减一定时间，如果当前未选择日期则无效。
@@ -32,10 +32,10 @@ function TsingrocDatePicker(props) {
     setDateValue(temp);
     propsOnChange?.(temp);
   };
-  const onChange = value => {
-    if (!value) return;
-    setDateValue(value);
-    propsOnChange?.(value);
+  const onChange = value_0 => {
+    if (!value_0) return;
+    setDateValue(value_0);
+    propsOnChange?.(value_0);
   };
   return /*#__PURE__*/_jsxs(Space.Compact, {
     ...rest,

package/dist/components/{UserButton.js → UserButton/index.js}

@@ -1,9 +1,9 @@
 import { DownOutlined, LogoutOutlined, UpOutlined, UserOutlined } from "@ant-design/icons";
 import { Avatar, Button, Dropdown, theme } from "antd";
 import { useSyncExternalStore } from "react";
-// eslint-disable-line @typescript-eslint/no-unused-vars
-import { useSessionStoreInternal } from "./auth/AuthProvider";
-// eslint-disable-line @typescript-eslint/no-unused-vars
+// oxlint-disable-line no-unused-vars
+import { useSessionStoreInternal } from "../auth/AuthProvider";
+// oxlint-disable-line no-unused-vars
 import { Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 /**
  * 显示用户信息的按钮，点击弹出登出或跳转到账户页的菜单。

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

@@ -2,20 +2,48 @@ import { type ReactNode } from "react";
 import type { AuthService } from "./AuthService";
 import { SessionStore, type Session, type SessionStoreOptions } from "./SessionStore";
 export type AuthProviderProps = TokenBasedAuthProviderProps | GenericAuthProviderProps;
-export interface TokenBasedAuthProviderProps extends SessionStoreOptions {
-    service: AuthService<string, unknown>;
+export interface CommonAuthProviderProps extends SessionStoreOptions {
+    /** 要使用的 `AuthService` 实现。 */
+    service: AuthService<unknown, unknown>;
+    /**
+     * 是否添加 fetcher 中间件。
+     * @default true
+     */
     fetcherMiddleware?: boolean;
     children: ReactNode;
 }
-export interface GenericAuthProviderProps extends SessionStoreOptions {
-    service: AuthService<unknown, unknown>;
-    fetcherMiddleware?: boolean;
+export interface TokenBasedAuthProviderProps extends CommonAuthProviderProps {
+    service: AuthService<string, unknown>;
+}
+export interface GenericAuthProviderProps extends CommonAuthProviderProps {
     persistent: false;
-    children: ReactNode;
 }
 /**
  * 为内部的组件提供鉴权服务。{@linkcode useSessionStore} 和 {@linkcode useSession}，
- * 还有很多其它 hooks 和组件都只能在这个组件的内部使用。
+ * 还有很多其它 hooks 和组件都只能在这个组件的内部使用。你应该把这个组件包裹在项目的整个 React 组件树的顶层。
+ *
+ * 如果项目用到了多个鉴权机制，那么应该为不同的路由创建不同的 AuthProvider，并使用不同的 key 来强制 React 重新创建组件的实例。下面以 `@nanostores/router` 为例：
+ *
+ * ```tsx
+ * const router = useStore($router);
+ *
+ * // 在 AuthProvider 内部，页面的 UI 实现完全不需要改变即可自动兼容两种鉴权机制
+ * const inner = <LoginCheck><XxxPage /></LoginCheck>;
+ *
+ * if (router.route === "embedded") {
+ *   return (
+ *     <AuthProvider key="embedded" service={embeddedAuthService}>
+ *       {inner}
+ *     </AuthProvider>
+ *   );
+ * } else {
+ *   return (
+ *     <AuthProvider key="casdoor" service={casdoorAuthService}>
+ *       {inner}
+ *     </AuthProvider>
+ *   );
+ * }
+ * ```
  */
 export declare function AuthProvider(props: AuthProviderProps): ReactNode;
 export declare function useSessionStoreInternal(user: string): SessionStore;
@@ -24,7 +52,10 @@ export declare const useSessionStore: () => SessionStore;
 export declare function useSessionInternal(user: string, allowNull?: false): Session;
 export declare function useSessionInternal(user: string, allowNull: true): Session | null;
 export interface UseSessionOptions {
-    /** 当未登录或已登出时是否抛出异常。 @default true */
+    /**
+     * 当未登录或已登出时是否抛出异常。
+     * @default true
+     */
     allowNull?: boolean;
 }
 export interface UseSessionNonNullableOptions extends UseSessionOptions {

package/dist/components/auth/AuthProvider.js

@@ -6,7 +6,30 @@ import { jsx as _jsx } from "react/jsx-runtime";
 const AuthContext = /*#__PURE__*/createContext(null);
 /**
  * 为内部的组件提供鉴权服务。{@linkcode useSessionStore} 和 {@linkcode useSession}，
- * 还有很多其它 hooks 和组件都只能在这个组件的内部使用。
+ * 还有很多其它 hooks 和组件都只能在这个组件的内部使用。你应该把这个组件包裹在项目的整个 React 组件树的顶层。
+ *
+ * 如果项目用到了多个鉴权机制，那么应该为不同的路由创建不同的 AuthProvider，并使用不同的 key 来强制 React 重新创建组件的实例。下面以 `@nanostores/router` 为例：
+ *
+ * ```tsx
+ * const router = useStore($router);
+ *
+ * // 在 AuthProvider 内部，页面的 UI 实现完全不需要改变即可自动兼容两种鉴权机制
+ * const inner = <LoginCheck><XxxPage /></LoginCheck>;
+ *
+ * if (router.route === "embedded") {
+ *   return (
+ *     <AuthProvider key="embedded" service={embeddedAuthService}>
+ *       {inner}
+ *     </AuthProvider>
+ *   );
+ * } else {
+ *   return (
+ *     <AuthProvider key="casdoor" service={casdoorAuthService}>
+ *       {inner}
+ *     </AuthProvider>
+ *   );
+ * }
+ * ```
  */
 export function AuthProvider(props) {
   const $ = _c(14);

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

@@ -3,6 +3,9 @@ import type { Fetcher } from "./Fetcher";
  * 鉴权操作的抽象接口。
  *
  * 对于实现者来说，需要注意实现该接口的类自身不应该保存会话状态。
+ *
+ * @template State 会话状态的类型。只有 State 为 string 的实现才能被 SessionStore 自动持久化。
+ * @template RawUserInfo 用户信息的类型。
  */
 export interface AuthService<State = unknown, RawUserInfo = unknown> {
     /**

package/dist/components/auth/{CasdoorAuth.d.ts → CasdoorAuth/index.d.ts}

@@ -1,12 +1,21 @@
 import type { SdkConfig } from "casdoor-js-sdk/lib/esm/sdk";
 import { type JwtPayload } from "jwt-decode";
 import { type ReactNode } from "react";
-import type { AuthService, UserInfo } from "./AuthService";
-import { fetcherWithBearerToken } from "./Fetcher";
+import type { AuthService, UserInfo } from "../AuthService";
+import { fetcherWithBearerToken } from "../Fetcher";
 export interface CasdoorAuthServiceOptions {
+    /** 传递给 `casdoor-js-sdk` 的配置。 */
     config: SdkConfig;
+    /**
+     * 登录接口的 origin。
+     * @default location.origin
+     */
     signinOrigin?: string;
-    signinPath?: string | undefined;
+    /**
+     * 登录接口的路径。
+     * @default "/api/signin"
+     */
+    signinPath?: string;
 }
 /**
  * 基于 Casdoor 的鉴权服务。该鉴权服务的登录流程如下：
@@ -130,9 +139,13 @@ export interface CasdoorUserInfo {
     roles: string[];
 }
 export interface CasdoorCallbackProps {
+    /** 登录成功时的回调。 */
     onSuccess?: () => void;
+    /** 登录失败时的回调。 */
     onError?: (err: unknown) => void;
+    /** 成功时显示的内容。 */
     success?: ReactNode;
+    /** 失败时显示的内容。 */
     error?: ReactNode;
     /**
      * 跳转前显示的内容。
@@ -143,9 +156,13 @@ export interface CasdoorCallbackProps {
 /** Casdoor 回调组件。请将该组件放置在 {@linkcode CasdoorAuthService} 中设定的回调路径上。 */
 export declare function CasdoorCallback(props: CasdoorCallbackProps): ReactNode;
 export interface CasdoorRoleCheckProps {
+    /** 限制只有特定角色的用户才能访问内部的组件。 */
     required: string[];
+    /** 限制特定角色的用户禁止访问内部的组件。 */
     forbidden?: string[];
+    /** 当用户被禁止访问时显示的内容。 */
     error?: ReactNode;
+    /** 用户被允许访问时正常显示的内容。 */
     children: ReactNode;
 }
 /** 检查 Casdoor 用户的角色（role），限制只有特定角色的用户才能访问内部的组件。 */

package/dist/components/auth/{CasdoorAuth.js → CasdoorAuth/index.js}

@@ -2,10 +2,10 @@ 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"; // oxlint-disable-line no-unused-vars
+import { useSessionStoreInternal } from "../AuthProvider"; // oxlint-disable-line no-unused-vars
 
-import { EmbeddedAuthService } from "./EmbeddedAuth";
-import { fetcherWithBearerToken } from "./Fetcher";
+import { EmbeddedAuthService } from "../EmbeddedAuth";
+import { fetcherWithBearerToken } from "../Fetcher";
 // oxlint-disable-line no-unused-vars
 
 /**

package/dist/components/auth/{EmbeddedAuth.d.ts → EmbeddedAuth/index.d.ts}

@@ -1,10 +1,15 @@
 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 CasdoorTokenPayload, type CasdoorUserInfo } from "./CasdoorAuth";
-import { fetcherWithBearerToken } from "./Fetcher";
+import type { AuthService, UserInfo } from "../AuthService";
+import { type CasdoorTokenPayload, type CasdoorUserInfo } from "../CasdoorAuth";
+import { fetcherWithBearerToken } from "../Fetcher";
 export interface EmbeddedAuthServiceOptions {
+    /** 传递给 `casdoor-js-sdk` 的配置，必须与父页面的配置相同。 */
     config: SdkConfig;
+    /**
+     * 等待父页面提供 token 的超时时间。
+     * @default 5000
+     */
     timeout?: number;
 }
 /**

package/dist/components/auth/{EmbeddedAuth.js → EmbeddedAuth/index.js}

@@ -2,10 +2,10 @@ 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 { useSessionStoreInternal } from "../AuthProvider"; // oxlint-disable-line no-unused-vars
 
-import { CasdoorAuthService } from "./CasdoorAuth";
-import { fetcherWithBearerToken } from "./Fetcher";
+import { CasdoorAuthService } from "../CasdoorAuth";
+import { fetcherWithBearerToken } from "../Fetcher";
 // oxlint-disable-line no-unused-vars
 import { jsx as _jsx } from "react/jsx-runtime";
 /**