@flow97/react-toolkit 0.0.4 → 0.0.6

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # react-toolkits
 
+## 0.0.6
+
+### Patch Changes
+
+- 5fc6012: refactor: integrate AuthConfig for improved authentication handling
+
+## 0.0.5
+
+### Patch Changes
+
+- 48a1c84: refactor: update KeepAlive components to improve caching behavior and context handling
+
 ## 0.0.4
 
 ### Patch Changes

package/lib/index.d.ts

@@ -87,6 +87,11 @@ interface KeepAliveProps {
  * 使用 React 19 Activity API 实现组件状态缓存，避免路由切换时重新挂载
  * 支持路由级别的自动缓存：如果不提供 cacheKey，会自动使用当前路由路径作为缓存 key
  *
+ * **重要说明：**
+ * - React Activity 会保留组件的状态（state），组件不会被卸载和重新挂载
+ * - 但是当 Activity 从 hidden 切换到 visible 时，会重新执行副作用（useEffect）
+ * - 这意味着组件的状态会保留，但 useEffect 会重新运行，需要根据业务需求处理副作用
+ *
  * @example
  * ```tsx
  * // 手动指定缓存 key
@@ -125,8 +130,6 @@ interface KeepAliveCacheItem {
     element: ReactNode;
     /** 是否激活 */
     active: boolean;
-    /** 缓存时间戳 */
-    timestamp: number;
 }
 /**
  * KeepAlive 上下文类型
@@ -172,12 +175,15 @@ declare function useKeepAliveContext(): KeepAliveContextType;
  * useKeepAlive Hook
  * 用于控制 KeepAlive 缓存
  *
+ * 如果 KeepAliveProvider 不存在，返回 no-op 实现，不会报错
+ * 这样可以在未启用 KeepAlive 的项目中正常使用
+ *
  * @example
  * ```tsx
  * const { clearCache, removeCache, getCacheKeys } = useKeepAlive()
  *
  * const handleClearAll = () => {
- *   clearCache() // 清除所有缓存
+ *   clearCache() // 清除所有缓存（如果 KeepAliveProvider 不存在，则无操作）
  * }
  *
  * const handleClearSpecific = () => {
@@ -186,6 +192,17 @@ declare function useKeepAliveContext(): KeepAliveContextType;
  * ```
  */
 declare function useKeepAlive(): {
+    cache: any;
+    removeCache: () => void;
+    clearCache: () => void;
+    clearCacheByPath: () => void;
+    clearCurrentCache: () => void;
+    getCacheKeys: () => never[];
+    getAllCache: () => never[];
+    getCache: () => undefined;
+    activateCache: () => void;
+    deactivateCache: () => void;
+} | {
     cache: Map<string, KeepAliveCacheItem>;
     removeCache: (key: string) => void;
     clearCache: () => void;
@@ -794,18 +811,24 @@ declare const SSO_URL = "https://idaas.ifunplus.cn/enduser/api/application/plugi
 declare const APP_ID_HEADER = "App-ID";
 declare const FRONTEND_ROUTE_PREFIX = "/console/";
 /**
- * 认证系统模式枚举
- * - GAME_SCOPED: 游戏范围权限（角色权限包含游戏信息）
- * - GROUP_BASED: 基于项目组的权限（需要先选择项目组才能选择游戏）
- * - DIRECT_GAME: 直接游戏权限（不需要项目组，直接选择游戏）
+ * 认证模式枚举：合并了用户配置和角色配置的所有有效组合
  */
 declare enum AuthMode {
-    /** 游戏范围权限：角色权限包含游戏范围信息 */
+    /** 直接角色模式（不带游戏）：直接将角色分配给用户，角色权限不包含游戏信息 */
+    DIRECT_ROLE = "direct_role",
+    /** 直接角色模式（带游戏）：直接将角色分配给用户，角色权限包含游戏信息 */
+    DIRECT_ROLE_WITH_GAME = "direct_role_with_game",
+    /** 游戏范围模式：按游戏分配角色，角色权限不包含游戏信息 */
     GAME_SCOPED = "game_scoped",
-    /** 基于项目组的权限：权限依赖项目组，需要先选择项目组才能选择游戏 */
-    GROUP_BASED = "group_based",
-    /** 直接游戏权限：权限直接选择游戏，不需要项目组作为中间层 */
-    DIRECT_GAME = "direct_game"
+    /** 项目组模式：按项目组-游戏-角色分配，角色权限不包含游戏信息 */
+    GROUP_BASED = "group_based"
+}
+/**
+ * 认证配置：直接使用 AuthMode
+ */
+interface AuthConfig {
+    /** 认证模式 */
+    mode: AuthMode;
 }
 declare const WILDCARD = "*";
 
@@ -900,16 +923,6 @@ type Locale = {
     };
 };
 
-/**
- * JWT Token 解密后的用户信息
- */
-interface UserInfo {
-    authorityId: string;
-    exp: number;
-}
-/**
- * Context 配置接口
- */
 interface ContextSlice {
     /** 是否使用游戏 API V2 版本 */
     useGameApiV2: boolean;
@@ -927,9 +940,18 @@ interface ContextSlice {
     gameScoped?: boolean;
     /** 本地化语言包 */
     locale: Locale;
-    /** 认证模式 */
-    authMode: AuthMode;
+    /** 认证配置 */
+    authConfig: AuthConfig;
 }
+
+/**
+ * JWT Token 解密后的用户信息
+ */
+interface UserInfo {
+    authorityId: string;
+    exp: number;
+}
+
 /**
  * Token 状态接口
  */
@@ -1210,6 +1232,31 @@ declare function useFormModal<Values extends AnyObject = AnyObject, ExtraValues
  */
 declare function useModalStore(): VisibilityState;
 
+/**
+ * 获取当前有效的认证配置
+ */
+declare function useAuthConfig(): AuthConfig;
+/**
+ * 获取当前认证模式
+ */
+declare function useAuthMode(): AuthMode;
+/**
+ * 判断是否为直接角色模式
+ */
+declare function useIsDirectRole(): boolean;
+/**
+ * 判断是否为游戏范围模式
+ */
+declare function useIsGameScoped(): boolean;
+/**
+ * 判断是否为项目组模式
+ */
+declare function useIsGroupBased(): boolean;
+/**
+ * 判断角色是否包含游戏信息
+ */
+declare function useIsRoleWithGame(): boolean;
+
 interface NotFoundProps {
     redirectUrl?: string;
 }
@@ -1450,4 +1497,4 @@ declare function useAuth(code?: string | string[], config?: RequestOptions): {
 declare function useMenuList(): _tanstack_react_query.UseQueryResult<MenuListItem[], Error>;
 declare const useGames: () => _tanstack_react_query.UseQueryResult<Game[], Error>;
 
-export { APP_ID_HEADER, AuthButton, type AuthButtonProps, AuthMode, DynamicTags, type DynamicTagsProps, ExpandableParagraph, type ExpandableParagraphProps, FRONTEND_ROUTE_PREFIX, FilterFormWrapper, type FilterFormWrapperProps, type Game, type GameSelectConfig, type GameSelectProps, type HeaderExtra, type HeaderExtraConfig, Highlight, type HighlightProps, InfiniteList, type InfiniteListDataAdapter, type InfiniteListPayload, type InfiniteListProps, type InfiniteListRef, type InfiniteListRequestConfig, type InfiniteListRequestConfigType, type JsonResponse, KeepAlive, type KeepAliveCacheItem, KeepAliveOutlet, type KeepAliveOutletProps, type KeepAliveProps, KeepAliveProvider, type KeepAliveProviderProps, Layout, type LayoutProps, Logo, type LogoProps, type MenuListItem, type NavItem, type NavMenuItemGroupType, type NavMenuItemType, type NavSubMenuType, type NavigationConfig, NotFound, OperationLogList, type PageParam, type Permission, QueryList, QueryListAction, type QueryListPayload, type QueryListProps, type QueryListRef, type RecursivePartial, RequireAuth, type RequireAuthProps, RequireGame, type RouteMatchRule, SSO_URL, SelectAll, type SelectAllProps, type ShowFormOptions$1 as ShowFormDrawerOptions, type ShowFormOptions as ShowFormModalOptions, SignIn, ToolkitProvider, type ToolkitProviderProps, type UseDrawerOperation, type UseDrawerProps, type UseFormDrawerProps, type UseFormDrawerReturn, type UseFormModalProps, type UseFormModalReturn, type UseKeepAliveReturn, type UseModalOperation, type UseModalProps, UserDropdown, type VisibilityState, WILDCARD, createVisibilityStoreConfig, generateId, _default$1 as menuRoutes, mixedStorage, _default as permissionRoutes, toolkitStore, useAuth, useDrawer, useDrawerStore, useFormDrawer, useFormModal, useGames, useInfiniteListStore, useKeepAlive, useKeepAliveContext, useMenuList, useModal, useModalStore, useQueryListStore, useToolkitStore };
+export { APP_ID_HEADER, AuthButton, type AuthButtonProps, type AuthConfig, AuthMode, DynamicTags, type DynamicTagsProps, ExpandableParagraph, type ExpandableParagraphProps, FRONTEND_ROUTE_PREFIX, FilterFormWrapper, type FilterFormWrapperProps, type Game, type GameSelectConfig, type GameSelectProps, type HeaderExtra, type HeaderExtraConfig, Highlight, type HighlightProps, InfiniteList, type InfiniteListDataAdapter, type InfiniteListPayload, type InfiniteListProps, type InfiniteListRef, type InfiniteListRequestConfig, type InfiniteListRequestConfigType, type JsonResponse, KeepAlive, type KeepAliveCacheItem, KeepAliveOutlet, type KeepAliveOutletProps, type KeepAliveProps, KeepAliveProvider, type KeepAliveProviderProps, Layout, type LayoutProps, Logo, type LogoProps, type MenuListItem, type NavItem, type NavMenuItemGroupType, type NavMenuItemType, type NavSubMenuType, type NavigationConfig, NotFound, OperationLogList, type PageParam, type Permission, QueryList, QueryListAction, type QueryListPayload, type QueryListProps, type QueryListRef, type RecursivePartial, RequireAuth, type RequireAuthProps, RequireGame, type RouteMatchRule, SSO_URL, SelectAll, type SelectAllProps, type ShowFormOptions$1 as ShowFormDrawerOptions, type ShowFormOptions as ShowFormModalOptions, SignIn, ToolkitProvider, type ToolkitProviderProps, type UseDrawerOperation, type UseDrawerProps, type UseFormDrawerProps, type UseFormDrawerReturn, type UseFormModalProps, type UseFormModalReturn, type UseKeepAliveReturn, type UseModalOperation, type UseModalProps, UserDropdown, type VisibilityState, WILDCARD, createVisibilityStoreConfig, generateId, _default$1 as menuRoutes, mixedStorage, _default as permissionRoutes, toolkitStore, useAuth, useAuthConfig, useAuthMode, useDrawer, useDrawerStore, useFormDrawer, useFormModal, useGames, useInfiniteListStore, useIsDirectRole, useIsGameScoped, useIsGroupBased, useIsRoleWithGame, useKeepAlive, useKeepAliveContext, useMenuList, useModal, useModalStore, useQueryListStore, useToolkitStore };