react-toolkits 2.31.10 → 2.32.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # react-toolkits
 
+## 2.32.0
+
+### Minor Changes
+
+- 752e915: refactor: replace PermissionMode with AuthMode across the toolkit
+
 ## 2.31.10
 
 ### Patch Changes

package/README.md

@@ -38,7 +38,7 @@ import 'react-toolkits/style.css'
 import { createRoot } from 'react-dom/client'
 import { RouterProvider } from 'react-router'
 import { ToolkitsProvider } from 'react-toolkits/components'
-import { PermissionMode } from 'react-toolkits/constants'
+import { AuthMode } from 'react-toolkits/constants'
 
 import router from './router'
 
@@ -61,13 +61,7 @@ const root = createRoot(document.getElementById('root') as HTMLElement)
 
 root.render(
   <QueryClientProvider client={queryClient}>
-    <ToolkitsProvider
-      collapsible
-      gameApiV2
-      permissionMode={PermissionMode.GROUP_BASED}
-      loginPath="/sign_in"
-      mainPagePath="/"
-    >
+    <ToolkitsProvider collapsible gameApiV2 auth={{ mode: AuthMode.GROUP_BASED }} loginPath="/sign_in" mainPagePath="/">
       <RouterProvider router={router} />
     </ToolkitsProvider>
   </QueryClientProvider>,
@@ -80,7 +74,7 @@ root.render(
 
 - **loginPath**: 登录页路径（未鉴权时会跳转）
 - **mainPagePath**: 登录后主页路径（鉴权通过时进入）
-- **permissionMode**: 权限版本，建议使用 `PermissionMode.GROUP_BASED`
+- **auth.mode**: 认证模式，建议使用 `AuthMode.GROUP_BASED`
 - **collapsible**: 侧边栏是否可折叠
 - **gameApiV2**: 是否启用游戏相关 V2 接口适配（如不涉及可忽略）
 - 其余高级配置见类型定义 `react-toolkits/components` 内导出的 Provider Props
@@ -91,7 +85,7 @@ root.render(
 - `react-toolkits/hooks`：表单弹层 Hooks（如 `useFormDrawer`、`useFormModal`）
 - `react-toolkits/pages`：内置页面与路由片段（如 `permissionRoutes`、`menuRoutes`、`SignIn`）
 - `react-toolkits/services`：请求相关 Hooks（如 `useAuth`、`useMenuList`、`useGames`）
-- `react-toolkits/constants`：常量与枚举（如 `APP_ID_HEADER`、`PermissionMode`）
+- `react-toolkits/constants`：常量与枚举（如 `APP_ID_HEADER`、`AuthMode`）
 - `react-toolkits/types`：公共类型
 - `react-toolkits/utils`：工具函数
 - `react-toolkits/locale` 与 `react-toolkits/locale/*`：国际化资源与工具
@@ -346,7 +340,7 @@ import { useAuth } from 'react-toolkits/services'
 
 ### 权限版本兼容
 
-- 历史上存在不同权限数据结构，`PermissionMode` 用于适配后端变体
+- 历史上存在不同权限数据结构，`AuthMode` 用于适配后端变体
 - 新项目建议使用 `V3`；旧项目如为 `V2`，只需在 `ToolkitsProvider` 中切换版本
 
 ## 常见问题（FAQ）

package/lib/index.d.ts

@@ -244,14 +244,30 @@ declare function useKeepAlive(): {
 };
 type UseKeepAliveReturn = ReturnType<typeof useKeepAlive>;
 
+type Primitive = string | number | boolean | bigint | symbol | undefined | null;
+
+type Builtin = Primitive | Function | Date | Error | RegExp;
+
 type Prettify<Type> = Type extends Function ? Type : Extract<{
     [Key in keyof Type]: Type[Key];
 }, Type>;
 
 type Merge<Object1, Object2> = Prettify<Omit<Object1, keyof Object2> & Object2>;
 
+type IsAny<Type> = 0 extends 1 & Type ? true : false;
+
+type IsUnknown<Type> = IsAny<Type> extends true ? false : unknown extends Type ? true : false;
+
 type MarkRequired<Type, Keys extends keyof Type> = Type extends Type ? Prettify<Type & Required<Omit<Type, Exclude<keyof Type, Keys>>>> : never;
 
+type IsTuple<Type> = Type extends readonly any[] ? (any[] extends Type ? never : Type) : never;
+
+type DeepPartial<Type> = Type extends Exclude<Builtin, Error> ? Type : Type extends Map<infer Keys, infer Values> ? Map<DeepPartial<Keys>, DeepPartial<Values>> : Type extends ReadonlyMap<infer Keys, infer Values> ? ReadonlyMap<DeepPartial<Keys>, DeepPartial<Values>> : Type extends WeakMap<infer Keys, infer Values> ? WeakMap<DeepPartial<Keys>, DeepPartial<Values>> : Type extends Set<infer Values> ? Set<DeepPartial<Values>> : Type extends ReadonlySet<infer Values> ? ReadonlySet<DeepPartial<Values>> : Type extends WeakSet<infer Values> ? WeakSet<DeepPartial<Values>> : Type extends ReadonlyArray<infer Values> ? Type extends IsTuple<Type> ? {
+    [Key in keyof Type]?: DeepPartial<Type[Key]>;
+} : Type extends Array<Values> ? Array<DeepPartial<Values> | undefined> : ReadonlyArray<DeepPartial<Values> | undefined> : Type extends Promise<infer Value> ? Promise<DeepPartial<Value>> : Type extends {} ? {
+    [Key in keyof Type]?: DeepPartial<Type[Key]>;
+} : IsUnknown<Type> extends true ? unknown : Partial<Type>;
+
 interface Game {
     game_id: string | number;
     [key: string]: any;
@@ -820,12 +836,12 @@ 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 PermissionMode {
+declare enum AuthMode {
     /** 游戏范围权限：角色权限包含游戏范围信息 */
     GAME_SCOPED = "game_scoped",
     /** 基于项目组的权限：权限依赖项目组，需要先选择项目组才能选择游戏 */
@@ -927,16 +943,26 @@ type Locale = {
 };
 
 interface ContextSlice {
-    locale: Locale;
-    permissionMode: PermissionMode;
+    /** 是否使用游戏 API V2 版本 */
     useGameApiV2: boolean;
-    loginPath: string;
+    /** 为 true 时，APP-ID header 始终使用 'global'，否则为当前游戏 id */
     isGlobalMode: boolean;
-    gameScoped?: boolean;
+    /** 接口基础路径 */
+    apiBaseUrl?: string;
+    /** 登录页路径 */
+    loginPath: string;
+    /** 首页地址 */
+    homePath: string;
+    /** 侧边栏宽度 */
     sidebarWidth?: number;
+    /** 侧边栏是否可折叠 */
     sidebarCollapsible?: boolean;
-    homePath: string;
-    apiBaseUrl?: string;
+    /** 数据是否按游戏划分范围，默认为 false */
+    gameScoped?: boolean;
+    /** 本地化语言包 */
+    locale: Locale;
+    /** 认证模式 */
+    authMode: AuthMode;
 }
 
 interface GameSlice {
@@ -989,7 +1015,20 @@ type ToolkitsState = {
 
 declare function useToolkitsStore(): ToolkitsState;
 declare function useToolkitsStore<T>(selector: (state: ToolkitsState) => T): T;
-type ToolkitsProviderProps = PropsWithChildren<Partial<ContextSlice>>;
+type ToolkitsProviderProps = PropsWithChildren<DeepPartial<ContextSlice>>;
+/**
+ * ToolkitsProvider 组件
+ *
+ * 支持嵌套使用，子 Provider 会从最近的父 Provider 继承 context 配置。
+ * 子 Provider 的 props 会覆盖父 Provider 的对应配置。
+ *
+ * 当父级 context 或当前 props 发生变化时，会重新创建 store 以确保配置同步。
+ *
+ * @example
+ * 外层 Provider 和内层 Provider 嵌套使用示例：
+ * - 外层：loginPath="/login" apiBaseUrl="https://api.example.com"
+ * - 内层：apiBaseUrl="https://api-v2.example.com" (会覆盖外层的 apiBaseUrl)
+ */
 declare const ToolkitsProvider: FC<ToolkitsProviderProps>;
 
 declare const UserDropdown: FC;
@@ -1450,4 +1489,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, 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, KyClient, type KyClientOptions, Layout, type LayoutProps, Logo, type LogoProps, type MenuListItem, type NavItem, type NavMenuItemGroupType, type NavMenuItemType, type NavSubMenuType, type NavigationConfig, NotFound, OperationLogList, type PageParam, type Permission, PermissionMode, QueryList, QueryListAction, type QueryListPayload, type QueryListProps, type QueryListRef, type RecursivePartial, type RequestOptions, RequireAuth, type RequireAuthProps, RequireGame, type ResponseType, type RouteMatchRule, SSO_URL, SelectAll, type SelectAllProps, type ShowFormOptions$1 as ShowFormDrawerOptions, type ShowFormOptions as ShowFormModalOptions, SignIn, ToolkitsProvider, type ToolkitsProviderProps, type UseDrawerOperation, type UseDrawerProps, type UseFormDrawerProps, type UseFormDrawerReturn, type UseFormModalProps, type UseFormModalReturn, type UseKeepAliveReturn, type UseKyOptions, type UseModalOperation, type UseModalProps, UserDropdown, type VisibilityState, WILDCARD, createVisibilityStoreConfig, generateId, _default$1 as menuRoutes, mixedStorage, _default as permissionRoutes, useAuth, useDrawer, useDrawerStore, useFormDrawer, useFormModal, useGames, useInfiniteListStore, useKeepAlive, useKeepAliveContext, useMenuList, useModal, useModalStore, useQueryListStore, useToolkitsStore };
+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, KyClient, type KyClientOptions, 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, type RequestOptions, RequireAuth, type RequireAuthProps, RequireGame, type ResponseType, type RouteMatchRule, SSO_URL, SelectAll, type SelectAllProps, type ShowFormOptions$1 as ShowFormDrawerOptions, type ShowFormOptions as ShowFormModalOptions, SignIn, ToolkitsProvider, type ToolkitsProviderProps, type UseDrawerOperation, type UseDrawerProps, type UseFormDrawerProps, type UseFormDrawerReturn, type UseFormModalProps, type UseFormModalReturn, type UseKeepAliveReturn, type UseKyOptions, type UseModalOperation, type UseModalProps, UserDropdown, type VisibilityState, WILDCARD, createVisibilityStoreConfig, generateId, _default$1 as menuRoutes, mixedStorage, _default as permissionRoutes, useAuth, useDrawer, useDrawerStore, useFormDrawer, useFormModal, useGames, useInfiniteListStore, useKeepAlive, useKeepAliveContext, useMenuList, useModal, useModalStore, useQueryListStore, useToolkitsStore };