@kevisual/query 0.0.9-alpha.2 → 0.0.10

package/dist/query-browser.d.ts

@@ -50,6 +50,11 @@ declare class QueryWs {
     getOpen(): boolean;
 }
 
+/**
+ * 请求前处理函数
+ * @param opts 请求配置
+ * @returns 请求配置
+ */
 type Fn = (opts: {
     url?: string;
     headers?: Record<string, string>;
@@ -74,10 +79,21 @@ type Result<S = any> = {
     data?: S;
     message?: string;
     success: boolean;
+    /**
+     * 是否不返回 message
+     */
+    noMsg?: boolean;
+    /**
+     * 显示错误, 当 handle的信息被处理的时候，如果不是success，同时自己设置了noMsg，那么就不显示错误信息了，因为被处理。
+     *
+     * 日常: fetch().then(res=>if(res.sucess){message.error('error')})的时候，比如401被处理过了，就不再提示401错误了。
+     *
+     */
+    showError: (fn?: () => void) => void;
 };
 type DataOpts = Partial<QueryOpts$1> & {
     beforeRequest?: Fn;
-    afterResponse?: (result: Result) => Promise<any>;
+    afterResponse?: <S, U = S>(result: Result<S>) => Promise<U>;
 };
 /**
  * const query = new Query();
@@ -88,7 +104,7 @@ type DataOpts = Partial<QueryOpts$1> & {
  *
  * U是参数 V是返回值
  */
-declare class Query<U = any, V = any> {
+declare class Query {
     adapter: typeof adapter;
     url: string;
     beforeRequest?: Fn;
@@ -96,9 +112,33 @@ declare class Query<U = any, V = any> {
     headers?: Record<string, string>;
     timeout?: number;
     constructor(opts?: QueryOpts$1);
-    get<T = any, S = any>(params: Record<string, any> & Data & U & T, options?: DataOpts): Promise<Result<V & S>>;
-    post<T = any, S = any>(body: Record<string, any> & Data & T, options?: DataOpts): Promise<Result<S>>;
+    /**
+     * 发送 get 请求，转到 post 请求
+     *  T是请求类型自定义
+     *  S是返回类型自定义
+     * @param params 请求参数
+     * @param options 请求配置
+     * @returns 请求结果
+     */
+    get<R = any, P = any>(params: Data & P, options?: DataOpts): Promise<Result<R>>;
+    /**
+     * 发送 post 请求
+     *  T是请求类型自定义
+     *  S是返回类型自定义
+     * @param body 请求体
+     * @param options 请求配置
+     * @returns 请求结果
+     */
+    post<R = any, P = any>(body: Data & P, options?: DataOpts): Promise<Result<R>>;
+    /**
+     * 请求前处理，设置请求前处理函数
+     * @param fn 处理函数
+     */
     before(fn: Fn): void;
+    /**
+     * 请求后处理，设置请求后处理函数
+     * @param fn 处理函数
+     */
     after(fn: (result: Result) => Promise<any>): void;
 }
 
@@ -111,7 +151,7 @@ type QueryOpts = {
 /**
  * 前端调用后端QueryRouter
  */
-declare class QueryClient<U = any, V = any> extends Query<U, V> {
+declare class QueryClient extends Query {
     tokenName: string;
     storage: Storage;
     token: string;
@@ -127,4 +167,5 @@ declare class QueryClient<U = any, V = any> extends Query<U, V> {
     removeToken(): void;
 }
 
-export { Query, QueryClient, type QueryOpts, QueryWs, type QueryWsOpts, adapter };
+export { Query, QueryClient, QueryWs, adapter };
+export type { QueryOpts, QueryWsOpts };

package/dist/query-browser.js

@@ -245,9 +245,25 @@ class Query {
         };
         this.timeout = opts?.timeout || 60000 * 3; // 默认超时时间为 60s * 3
     }
+    /**
+     * 发送 get 请求，转到 post 请求
+     *  T是请求类型自定义
+     *  S是返回类型自定义
+     * @param params 请求参数
+     * @param options 请求配置
+     * @returns 请求结果
+     */
     async get(params, options) {
         return this.post(params, options);
     }
+    /**
+     * 发送 post 请求
+     *  T是请求类型自定义
+     *  S是返回类型自定义
+     * @param body 请求体
+     * @param options 请求配置
+     * @returns 请求结果
+     */
     async post(body, options) {
         const url = options?.url || this.url;
         const headers = { ...this.headers, ...options?.headers };
@@ -267,11 +283,12 @@ class Query {
             }
         }
         catch (e) {
-            console.error(e);
+            console.error('request beforeFn error', e, req);
             return {
                 code: 500,
                 success: false,
                 message: 'api request beforeFn error',
+                showError: () => { },
             };
         }
         return adapter(req).then(async (res) => {
@@ -280,21 +297,39 @@ class Query {
                 if (afterResponse) {
                     return await afterResponse(res);
                 }
+                /**
+                 * 显示错误
+                 * @param fn 错误处理函数
+                 */
+                res.showError = (fn) => {
+                    if (!res.success && !res.noResult) {
+                        fn?.();
+                    }
+                };
                 return res;
             }
             catch (e) {
-                console.error(e);
+                console.error('request error', e, req);
                 return {
                     code: 500,
                     success: false,
                     message: 'api request afterFn error',
+                    showError: () => { },
                 };
             }
         });
     }
+    /**
+     * 请求前处理，设置请求前处理函数
+     * @param fn 处理函数
+     */
     before(fn) {
         this.beforeRequest = fn;
     }
+    /**
+     * 请求后处理，设置请求后处理函数
+     * @param fn 处理函数
+     */
     after(fn) {
         this.afterResponse = fn;
     }

package/dist/query-ws.d.ts

@@ -45,4 +45,5 @@ declare class QueryWs {
     getOpen(): boolean;
 }
 
-export { type QuerySelectState, QueryWs, type QueryWsOpts, type QueryWsStoreListener, type WsOnMessage, type WsSend };
+export { QueryWs };
+export type { QuerySelectState, QueryWsOpts, QueryWsStoreListener, WsOnMessage, WsSend };

package/dist/query.d.ts

@@ -12,6 +12,11 @@ type AdapterOpts = {
  */
 declare const adapter: (opts: AdapterOpts, overloadOpts?: RequestInit) => Promise<any>;
 
+/**
+ * 请求前处理函数
+ * @param opts 请求配置
+ * @returns 请求配置
+ */
 type Fn = (opts: {
     url?: string;
     headers?: Record<string, string>;
@@ -36,10 +41,21 @@ type Result<S = any> = {
     data?: S;
     message?: string;
     success: boolean;
+    /**
+     * 是否不返回 message
+     */
+    noMsg?: boolean;
+    /**
+     * 显示错误, 当 handle的信息被处理的时候，如果不是success，同时自己设置了noMsg，那么就不显示错误信息了，因为被处理。
+     *
+     * 日常: fetch().then(res=>if(res.sucess){message.error('error')})的时候，比如401被处理过了，就不再提示401错误了。
+     *
+     */
+    showError: (fn?: () => void) => void;
 };
 type DataOpts = Partial<QueryOpts> & {
     beforeRequest?: Fn;
-    afterResponse?: (result: Result) => Promise<any>;
+    afterResponse?: <S, U = S>(result: Result<S>) => Promise<U>;
 };
 /**
  * const query = new Query();
@@ -50,7 +66,7 @@ type DataOpts = Partial<QueryOpts> & {
  *
  * U是参数 V是返回值
  */
-declare class Query<U = any, V = any> {
+declare class Query {
     adapter: typeof adapter;
     url: string;
     beforeRequest?: Fn;
@@ -58,10 +74,35 @@ declare class Query<U = any, V = any> {
     headers?: Record<string, string>;
     timeout?: number;
     constructor(opts?: QueryOpts);
-    get<T = any, S = any>(params: Record<string, any> & Data & U & T, options?: DataOpts): Promise<Result<V & S>>;
-    post<T = any, S = any>(body: Record<string, any> & Data & T, options?: DataOpts): Promise<Result<S>>;
+    /**
+     * 发送 get 请求，转到 post 请求
+     *  T是请求类型自定义
+     *  S是返回类型自定义
+     * @param params 请求参数
+     * @param options 请求配置
+     * @returns 请求结果
+     */
+    get<R = any, P = any>(params: Data & P, options?: DataOpts): Promise<Result<R>>;
+    /**
+     * 发送 post 请求
+     *  T是请求类型自定义
+     *  S是返回类型自定义
+     * @param body 请求体
+     * @param options 请求配置
+     * @returns 请求结果
+     */
+    post<R = any, P = any>(body: Data & P, options?: DataOpts): Promise<Result<R>>;
+    /**
+     * 请求前处理，设置请求前处理函数
+     * @param fn 处理函数
+     */
     before(fn: Fn): void;
+    /**
+     * 请求后处理，设置请求后处理函数
+     * @param fn 处理函数
+     */
     after(fn: (result: Result) => Promise<any>): void;
 }
 
-export { Query, type QueryOpts, adapter };
+export { Query, adapter };
+export type { QueryOpts };

package/dist/query.js

@@ -70,9 +70,25 @@ class Query {
         };
         this.timeout = opts?.timeout || 60000 * 3; // 默认超时时间为 60s * 3
     }
+    /**
+     * 发送 get 请求，转到 post 请求
+     *  T是请求类型自定义
+     *  S是返回类型自定义
+     * @param params 请求参数
+     * @param options 请求配置
+     * @returns 请求结果
+     */
     async get(params, options) {
         return this.post(params, options);
     }
+    /**
+     * 发送 post 请求
+     *  T是请求类型自定义
+     *  S是返回类型自定义
+     * @param body 请求体
+     * @param options 请求配置
+     * @returns 请求结果
+     */
     async post(body, options) {
         const url = options?.url || this.url;
         const headers = { ...this.headers, ...options?.headers };
@@ -92,11 +108,12 @@ class Query {
             }
         }
         catch (e) {
-            console.error(e);
+            console.error('request beforeFn error', e, req);
             return {
                 code: 500,
                 success: false,
                 message: 'api request beforeFn error',
+                showError: () => { },
             };
         }
         return adapter(req).then(async (res) => {
@@ -105,21 +122,39 @@ class Query {
                 if (afterResponse) {
                     return await afterResponse(res);
                 }
+                /**
+                 * 显示错误
+                 * @param fn 错误处理函数
+                 */
+                res.showError = (fn) => {
+                    if (!res.success && !res.noResult) {
+                        fn?.();
+                    }
+                };
                 return res;
             }
             catch (e) {
-                console.error(e);
+                console.error('request error', e, req);
                 return {
                     code: 500,
                     success: false,
                     message: 'api request afterFn error',
+                    showError: () => { },
                 };
             }
         });
     }
+    /**
+     * 请求前处理，设置请求前处理函数
+     * @param fn 处理函数
+     */
     before(fn) {
         this.beforeRequest = fn;
     }
+    /**
+     * 请求后处理，设置请求后处理函数
+     * @param fn 处理函数
+     */
     after(fn) {
         this.afterResponse = fn;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kevisual/query",
-  "version": "0.0.9-alpha.2",
+  "version": "0.0.10",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,10 +22,10 @@
   "license": "ISC",
   "description": "",
   "devDependencies": {
-    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@rollup/plugin-node-resolve": "^16.0.1",
     "@rollup/plugin-typescript": "^12.1.2",
-    "rollup": "^4.34.9",
-    "rollup-plugin-dts": "^6.1.1",
+    "rollup": "^4.36.0",
+    "rollup-plugin-dts": "^6.2.0",
     "ts-node": "^10.9.2",
     "tslib": "^2.8.1",
     "typescript": "^5.8.2",
@@ -58,6 +58,6 @@
     }
   },
   "dependencies": {
-    "openai": "^4.86.1"
+    "openai": "^4.88.0"
   }
 }