@peng_kai/kit 0.0.14 → 0.0.16

package/request/helpers.ts

@@ -1,32 +1,49 @@
-export { isTimeout,  ApiCode, ApiError }
-
-enum ApiCode {
-  NORMAL = 0, // 正常
-  UNKNOWN = -1, // 未知错误
-  TIMEOUT = -2, // 请求超时
-}
-
-function isTimeout(error: any) {
-  return error?.message?.toLowerCase().includes('timeout')
-}
-
-class ApiError<TResp = any> extends Error {
-  public static is<ErrorResp = any>(error: any): error is ApiError<ErrorResp> {
-    return !!error?.isApiError
-  }
-
-  /**
-   * 将HTTP status和Api code统一到一个code里
-   */
-  public code: number
-  public msg: string
-  public data: TResp
-  public isApiError = true
-
-  public constructor(info: { code: number; msg: string; data: TResp }) {
-    super(info.msg)
-    this.code = info.code
-    this.msg = info.msg
-    this.data = info.data
-  }
-}
+import type { AxiosInstance } from 'axios';
+
+export { isTimeout, getServices, ApiCode, ApiError };
+
+enum ApiCode {
+  NORMAL = 0, // 正常
+  UNKNOWN = -1, // 未知错误
+  TIMEOUT = -2, // 请求超时
+}
+
+function getServices() {
+  const serversModule = getServices.modules;
+  const servers: Record<string, { server: AxiosInstance } | undefined> = {};
+
+  for (const [key, module] of Object.entries(serversModule)) {
+    const name = key.match(/\/([0-9a-zA-Z]+)\.ts$/)?.[1];
+
+    if (name)
+      servers[`${name}.api`] = module as any;
+  }
+
+  return servers;
+}
+getServices.modules = {} as any;
+
+function isTimeout(error: any) {
+  return error?.message?.toLowerCase().includes('timeout');
+}
+
+class ApiError<TResp = any> extends Error {
+  public static is<ErrorResp = any>(error: any): error is ApiError<ErrorResp> {
+    return !!error?.isApiError;
+  }
+
+  /**
+   * 将HTTP status和Api code统一到一个code里
+   */
+  public code: number;
+  public msg: string;
+  public data: TResp;
+  public isApiError = true;
+
+  public constructor(info: { code: number, msg: string, data: TResp }) {
+    super(info.msg);
+    this.code = info.code;
+    this.msg = info.msg;
+    this.data = info.data;
+  }
+}

package/request/index.ts

@@ -1,4 +1,4 @@
 /// <reference path="./type.d.ts" />
 
-export { createRequest } from './request'
-export { ApiCode, ApiError } from './helpers'
+export { createRequest } from './request';
+export { ApiCode, ApiError, getServices } from './helpers';

package/request/interceptors/checkCode.ts

@@ -1,6 +1,6 @@
-import axios from "axios";
-import type { AxiosInterceptorManager } from "axios";
-import {  ApiCode} from "../helpers";
+import axios from 'axios';
+import type { AxiosInterceptorManager } from 'axios';
+import { ApiCode } from '../helpers';
 
 /**
  * 【响应拦截器】检查 API 的 code 字段
@@ -19,10 +19,10 @@ export function checkCode(): Parameters<AxiosInterceptorManager<any>['use']> {
           resp.config,
           resp.request,
           resp,
-        )
+        );
       }
-    
-      return resp
-    }
-  ]
+
+      return resp;
+    },
+  ];
 }

package/request/interceptors/filterEmptyValue.ts

@@ -1,5 +1,5 @@
-import type { AxiosInterceptorManager } from "axios";
-import pickBy from 'lodash-es/pickBy'
+import type { AxiosInterceptorManager } from 'axios';
+import pickBy from 'lodash-es/pickBy';
 
 /**
  * 【请求拦截器】过滤空值，如：null、undefined、''、NaN
@@ -8,10 +8,10 @@ export function filterEmptyValue(): Parameters<AxiosInterceptorManager<any>['use
   return [
     (req) => {
       req.params = pickBy(req.params, (v) => {
-        return v !== null && v !== undefined && v !== '' && !Number.isNaN(v)
-      })
-    
-      return req
-    }
-  ]
-}
+        return v !== null && v !== undefined && v !== '' && !Number.isNaN(v);
+      });
+
+      return req;
+    },
+  ];
+}

package/request/interceptors/formatPaging.ts

@@ -1,4 +1,4 @@
-import type { AxiosInterceptorManager } from "axios";
+import type { AxiosInterceptorManager } from 'axios';
 
 /**
  * 【响应拦截器】格式化分页数据
@@ -6,21 +6,21 @@ import type { AxiosInterceptorManager } from "axios";
 export function formatPaging(): Parameters<AxiosInterceptorManager<any>['use']> {
   return [
     (resp) => {
-      const result = resp?.data
-    
+      const result = resp?.data;
+
       if (!result)
-        return resp
-    
+        return resp;
+
       if (result.pagination) {
         result.data = {
           list: result.data,
           pagination: result.pagination,
-        }
-    
-        Reflect.deleteProperty(result, 'pagination')
+        };
+
+        Reflect.deleteProperty(result, 'pagination');
       }
-    
-      return resp
-    }
-  ]
+
+      return resp;
+    },
+  ];
 }

package/request/interceptors/index.ts

@@ -1,9 +1,10 @@
-export { popupMessage } from './popupMessage'
-export { returnResultType } from './returnResultType'
-export { unitizeAxiosError } from './unitizeAxiosError'
-export { checkCode } from './checkCode'
-export { formatPaging } from './formatPaging'
-export { filterEmptyValue } from './filterEmptyValue'
+export { popupMessage } from './popupMessage';
+export { returnResultType } from './returnResultType';
+export { unitizeAxiosError } from './unitizeAxiosError';
+export { checkCode } from './checkCode';
+export { formatPaging } from './formatPaging';
+export { filterEmptyValue } from './filterEmptyValue';
+export { toLogin } from './toLogin';
 
 declare module 'axios' {
   interface AxiosRequestConfig {

package/request/interceptors/popupMessage.ts

@@ -1,6 +1,6 @@
-import axios from 'axios'
-import type { AxiosInterceptorManager } from "axios";
-import { isTimeout } from "../helpers";
+import axios from 'axios';
+import type { AxiosInterceptorManager } from 'axios';
+import { isTimeout } from '../helpers';
 
 /**
  * 【响应拦截器】弹出 message 提示
@@ -8,44 +8,44 @@ import { isTimeout } from "../helpers";
  */
 export function popupMessage(popup: (type: 'error' | 'success', message: string) => void): Parameters<AxiosInterceptorManager<any>['use']> {
   return [
-  (resp) => {
-    const successMessageConfig = resp?.config?.successMessage
+    (resp) => {
+      const successMessageConfig = resp?.config?.successMessage;
 
-    if (successMessageConfig === false)
-      return resp
+      if (successMessageConfig === false)
+        return resp;
 
-    let successMsg = successMessageConfig
+      let successMsg = successMessageConfig;
 
-    if (typeof successMessageConfig !== 'string')
-      successMsg = resp?.data?.msg
+      if (typeof successMessageConfig !== 'string')
+        successMsg = resp?.data?.msg;
 
-    popup('success', successMsg)
+      popup('success', successMsg);
 
-    return resp
-  },
-  (error) => {
-    const errorMessageConfig = error?.config?.errorMessage
+      return resp;
+    },
+    (error) => {
+      const errorMessageConfig = error?.config?.errorMessage;
 
-    if (errorMessageConfig === false)
-      throw error
+      if (errorMessageConfig === false)
+        throw error;
 
-    let errorMsg: boolean | string = errorMessageConfig
+      let errorMsg: boolean | string = errorMessageConfig;
 
-    if (axios.isAxiosError(error)) {
+      if (axios.isAxiosError(error)) {
       // 请求超时
-      if (isTimeout(error))
-        errorMsg = 'Request Timeout'
-      else if (typeof errorMessageConfig !== 'string')
-        errorMsg = error.response?.data?.msg || error.message || error.response?.statusText
-    }
-    else if (error instanceof Error && typeof errorMessageConfig !== 'string') {
-      errorMsg = error.message
-    }
-
-    if (typeof errorMsg === 'string')
-      popup('error', errorMsg)
-
-    throw error
-  },
-  ]
-}
+        if (isTimeout(error))
+          errorMsg = 'Request Timeout';
+        else if (typeof errorMessageConfig !== 'string')
+          errorMsg = error.response?.data?.msg || error.message || error.response?.statusText;
+      }
+      else if (error instanceof Error && typeof errorMessageConfig !== 'string') {
+        errorMsg = error.message;
+      }
+
+      if (typeof errorMsg === 'string')
+        popup('error', errorMsg);
+
+      throw error;
+    },
+  ];
+}

package/request/interceptors/returnResultType.ts

@@ -1,5 +1,5 @@
-import type { AxiosInterceptorManager } from "axios";
-import { ApiCode, isTimeout, ApiError } from "../helpers";
+import type { AxiosInterceptorManager } from 'axios';
+import { ApiCode, ApiError, isTimeout } from '../helpers';
 
 /**
  * 【响应拦截器】返回请求结果
@@ -7,27 +7,27 @@ import { ApiCode, isTimeout, ApiError } from "../helpers";
 export function returnResultType(): Parameters<AxiosInterceptorManager<any>['use']> {
   return [
     (resp) => {
-      const { resultType } = resp.config
-  
+      const { resultType } = resp.config;
+
       if (resultType === 'api')
-        return resp.data
-  
+        return resp.data;
+
       else if (resultType === 'axios')
-        return resp
-  
-      return resp.data?.data
+        return resp;
+
+      return resp.data?.data;
     },
     (error) => {
-      let code = error?.response?.data?.code || error?.response?.status || ApiCode.UNKNOWN
-      let msg = error?.response?.data?.msg || error?.message || error?.response?.statusText || 'Unknown Error'
-      const data = error?.response?.data?.data || null
-  
+      let code = error?.response?.data?.code || error?.response?.status || ApiCode.UNKNOWN;
+      let msg = error?.response?.data?.msg || error?.message || error?.response?.statusText || 'Unknown Error';
+      const data = error?.response?.data?.data || null;
+
       if (isTimeout(error)) {
-        code = ApiCode.TIMEOUT
-        msg = 'Request Timeout'
+        code = ApiCode.TIMEOUT;
+        msg = 'Request Timeout';
       }
-  
-      throw new ApiError({ code, msg, data })
+
+      throw new ApiError({ code, msg, data });
     },
-  ]
-}
+  ];
+}

package/request/interceptors/toLogin.ts

@@ -0,0 +1,13 @@
+import type { AxiosInterceptorManager } from 'axios';
+
+export function toLogin(path = '/auth/login', code = 15001): Parameters<AxiosInterceptorManager<any>['use']> {
+  return [
+    undefined,
+    (err) => {
+      if (err.code === code)
+        window.location.href = path;
+
+      throw err;
+    },
+  ];
+}

package/request/interceptors/unitizeAxiosError.ts

@@ -1,5 +1,5 @@
-import axios from "axios";
-import type { AxiosInterceptorManager } from "axios";
+import axios from 'axios';
+import type { AxiosInterceptorManager } from 'axios';
 
 /**
  * 【响应拦截器】统一处理 AxiosError
@@ -9,15 +9,15 @@ export function unitizeAxiosError(): Parameters<AxiosInterceptorManager<any>['us
     resp => resp,
     (error) => {
       if (axios.isAxiosError(error))
-        throw error
+        throw error;
 
       if (error instanceof Error)
-        throw new axios.AxiosError(`${error.message}[AppError01]`)
+        throw new axios.AxiosError(`${error.message}[AppError01]`);
 
       if (typeof error === 'object')
-        throw new axios.AxiosError(`${JSON.stringify(error)}[AppError02]`)
+        throw new axios.AxiosError(`${JSON.stringify(error)}[AppError02]`);
 
-      throw new axios.AxiosError(`${String(error)}[AppError03]`)
+      throw new axios.AxiosError(`${String(error)}[AppError03]`);
     },
-  ]
+  ];
 }

package/request/queryClient.ts

@@ -0,0 +1,42 @@
+import type { QueryClientConfig } from '@tanstack/vue-query';
+
+/** 不需要重试的 api code */
+export const ignoreRetryCodes = [
+  11000, // 操作失败
+  11001, // 操作过于频繁
+  11002, // 权限不足
+  11003, // 缺少必要参数
+  15001, // 未登录
+];
+
+export const presetOptions: QueryClientConfig = {
+  defaultOptions: {
+    queries: {
+      refetchOnWindowFocus: false,
+      retry(failureCount, error: any) {
+        if (ignoreRetryCodes.includes(error?.code))
+          return false;
+
+        return failureCount < 3;
+      },
+      getNextPageParam: (lastPage: any) => {
+        const { pagination } = lastPage ?? {};
+
+        if (pagination?.has_more) {
+          return {
+            page: (pagination.page ?? 0) + 1,
+            page_size: pagination?.page_size ?? 10,
+          };
+        }
+      },
+      getPreviousPageParam: (lastPage: any) => {
+        const { pagination } = lastPage ?? {};
+
+        return {
+          page: (pagination.page ?? 1) - 1,
+          page_size: pagination?.page_size ?? 10,
+        };
+      },
+    },
+  },
+};

package/request/request.ts

@@ -1,50 +1,50 @@
-import type { AxiosRequestConfig, AxiosResponse, AxiosInstance } from 'axios'
+import type { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 
-export { createRequest }
+export { createRequest };
 
 function createRequest<Req, OResp, Resp = Api.TransformPageResult<OResp>>(
   // function createRequest<Req, OResp, Resp = OResp>(
   id: string,
   paramBuilder: (params: any) => any,
 ) {
-  type ReqConfig = Partial<AxiosRequestConfig>
-  let defaultConfig: ReqConfig | null = null
+  type ReqConfig = Partial<AxiosRequestConfig>;
+  let defaultConfig: ReqConfig | null = null;
 
   // 返回 Axios 的 Response
-  async function request<Rt extends 'axios'>(reqData: Req, options: ReqConfig & { resultType: Rt }): Promise<AxiosResponse<Resp>>
+  async function request<Rt extends 'axios'>(reqData: Req, options: ReqConfig & { resultType: Rt }): Promise<AxiosResponse<Resp>>;
   // 返回 API 数据
-  async function request<Rt extends 'api'>(reqData: Req, options: ReqConfig & { resultType: Rt }): Promise<Resp>
+  async function request<Rt extends 'api'>(reqData: Req, options: ReqConfig & { resultType: Rt }): Promise<Resp>;
   // 返回 API 数据中的 data 字段值，默认
-  async function request(reqData: Req, config?: ReqConfig): Promise<Api.GetDataField<Resp>>
+  async function request(reqData: Req, config?: ReqConfig): Promise<Api.GetDataField<Resp>>;
   async function request(reqData: Req, config?: ReqConfig): Promise<any> {
-    const params = paramBuilder(reqData)
-    const serviceName = params.headers?.['Service-Name'] ?? ''
-    const service = createRequest.services[serviceName]?.server
+    const params = paramBuilder(reqData);
+    const serviceName = params.headers?.['Service-Name'] ?? '';
+    const service = createRequest.services[serviceName]?.server;
 
     if (service)
-      Reflect.deleteProperty(params.headers, 'Service-Name')
+      Reflect.deleteProperty(params.headers, 'Service-Name');
     else
-      throw new Error(`${serviceName} 接口服务不存在`)
+      throw new Error(`${serviceName} 接口服务不存在`);
 
     const res = await service.request({
       apiName: `${serviceName}/${id}`,
       ...params,
       ...Object.assign({}, defaultConfig, config),
-    })
+    });
 
-    return res as Api.GetDataField<Resp>
+    return res as Api.GetDataField<Resp>;
   }
 
-  request.id = id
+  request.id = id;
   request.setDefaultConfig = (config: ReqConfig) => {
-    defaultConfig = config
-    return request
-  }
+    defaultConfig = config;
+    return request;
+  };
 
-  return request
+  return request;
 }
 
 // 服务
 createRequest.services = {} as Record<string, {
-  server: AxiosInstance;
-} | undefined>
+  server: AxiosInstance
+} | undefined>;