react-toolkits 2.32.8 → 2.32.10

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # react-toolkits
 
+## 2.32.10
+
+### Patch Changes
+
+- 19be7a6: refactor: update mergeHooks function to improve hook execution order
+
+## 2.32.9
+
+### Patch Changes
+
+- 13ae33d: refactor: remove useKy.ts and update imports across components
+
 ## 2.32.8
 
 ### Patch Changes

package/lib/index.d.ts

@@ -1,6 +1,6 @@
 import { ButtonProps, SelectProps, FormInstance, DrawerProps, Button, FormProps, ModalProps } from 'antd';
 import { FC, PropsWithChildren, Key, ReactNode, ReactElement, CSSProperties, Ref, DetailedHTMLProps, ImgHTMLAttributes, ComponentProps } from 'react';
-import { Hooks, Options, KyInstance } from 'ky';
+import { Options, KyInstance, Hooks } from 'ky';
 import { ParagraphProps } from 'antd/es/typography/Paragraph';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { useLocation, PathPattern } from 'react-router';
@@ -12,60 +12,65 @@ import { StateCreator } from 'zustand';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { StateStorage } from 'zustand/middleware';
 
+/** HTTP 响应错误，包含响应和数据 */
+declare class HttpResponseError extends Error {
+    response?: Response;
+    data?: unknown;
+    constructor(message: string, response?: Response, data?: unknown);
+}
 /** 响应类型 */
 type ResponseType = 'json' | 'blob' | 'text' | 'arrayBuffer' | 'formData';
 /** 通用请求选项接口 */
 interface RequestOptions extends Options {
     /** 响应类型 */
     responseType?: ResponseType;
-    /** 是否使用全局模式 */
+    /** 是否使用全局模式，为 true 时 app-id header 设置为 global */
     isGlobalMode?: boolean;
 }
-/** KyClient 构造函数配置 */
-interface KyClientOptions {
-    /** 基础 URL */
-    baseURL?: string;
-    /** 自定义 hooks（拦截器） */
-    hooks?: Partial<Hooks>;
-}
-/** HTTP客户端方法接口 */
+/** HTTP 客户端方法接口 */
 interface KyMethods {
     get: <T = unknown>(url: string, options?: RequestOptions) => Promise<T>;
     post: <T = unknown>(url: string, data?: unknown, options?: RequestOptions) => Promise<T>;
     put: <T = unknown>(url: string, data?: unknown, options?: RequestOptions) => Promise<T>;
     delete: <T = unknown>(url: string, options?: RequestOptions) => Promise<T>;
     patch: <T = unknown>(url: string, data?: unknown, options?: RequestOptions) => Promise<T>;
-    options: <T = unknown>(url: string, options?: RequestOptions) => Promise<T>;
-    head: <T = unknown>(url: string, options?: RequestOptions) => Promise<T>;
+    /** 通用请求方法 */
     request: <T = unknown>(options: RequestOptions & {
         url: string;
+        method?: string;
     }) => Promise<T>;
     instance: KyInstance;
 }
 /** useKy 配置选项 */
 interface UseKyOptions {
-    /** 自定义 hooks（拦截器） */
+    /** 自定义 hooks（拦截器），在默认 hooks 之前执行 */
     hooks?: Partial<Hooks>;
 }
 /**
- * Ky HTTP 客户端类
+ * HTTP 客户端 Hook
+ *
+ * @example
+ * ```tsx
+ * const client = useKy()
+ *
+ * // GET 请求
+ * const data = await client.get<User[]>('/api/users')
+ *
+ * // POST 请求
+ * const result = await client.post<User>('/api/users', { name: 'John' })
+ *
+ * // 全局模式（app-id: global）
+ * const games = await client.get('/api/games', { isGlobalMode: true })
+ *
+ * // 自定义 hooks
+ * const client = useKy({
+ *   hooks: {
+ *     beforeRequest: [(request) => { console.log(request.url) }]
+ *   }
+ * })
+ * ```
  */
-declare class KyClient implements KyMethods {
-    private readonly _instance;
-    constructor(options?: KyClientOptions);
-    get instance(): KyInstance;
-    get: <T = unknown>(url: string, options?: RequestOptions) => Promise<T>;
-    post: <T = unknown>(url: string, data?: unknown, options?: RequestOptions) => Promise<T>;
-    put: <T = unknown>(url: string, data?: unknown, options?: RequestOptions) => Promise<T>;
-    delete: <T = unknown>(url: string, options?: RequestOptions) => Promise<T>;
-    patch: <T = unknown>(url: string, data?: unknown, options?: RequestOptions) => Promise<T>;
-    options: <T = unknown>(url: string, requestOptions?: RequestOptions) => Promise<T>;
-    head: <T = unknown>(url: string, requestOptions?: RequestOptions) => Promise<T>;
-    request: <T = unknown>(requestOptions: RequestOptions & {
-        url: string;
-    }) => Promise<T>;
-    private makeRequest;
-}
+declare function useKy(options?: UseKyOptions): KyMethods;
 
 interface AuthButtonProps extends ButtonProps {
     /** 权限码，支持单个或多个 */
@@ -1492,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, 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 };
+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, HttpResponseError, 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, type KyMethods, 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, useKy, useMenuList, useModal, useModalStore, useQueryListStore, useToolkitsStore };