@peng_kai/kit 0.1.10 → 0.1.12

package/antd/hooks/useAntdTable.ts

@@ -1,82 +1,115 @@
-import { computed, reactive } from 'vue';
-import type { UseQueryReturnType } from '@tanstack/vue-query';
-import type { Table, TableProps } from 'ant-design-vue';
-import type { ColumnType } from 'ant-design-vue/es/table/interface';
-import type { ComponentProps } from 'vue-component-type-helpers';
-
-export function useAntdTable<
-  UQRR extends UseQueryReturnType<any, any>,
-  QP extends Partial<{ page?: string | number, page_size?: string | number }>,
->(uqrt: UQRR, queryParams: QP = ({} as any)) {
-  type RecordType = GetRecordType<UQRR>;
-  type LocalTableProps = TableProps<RecordType>;
-  type LocalColumnsType = NonNullable<LocalTableProps['columns']>;
-  type LocalTableRowSelection = NonNullable<LocalTableProps['rowSelection']>;
-
-  const { data, isFetching, isLoading } = uqrt;
-
-  const onPaginationChange: ComponentProps<typeof Table>['onChange'] = (pagination) => {
-    const page = queryParams.page_size !== pagination.pageSize ? 1 : pagination.current;
-    Object.assign(queryParams, { page, page_size: pagination.pageSize ?? 10 });
-  };
-  const defineColumns = (columnsGetter: () => LocalColumnsType) => computed(columnsGetter);
-  const defineRowSelection = (rowSelectionGetter: () => LocalTableRowSelection) => {
-    const rowSelection = reactive(rowSelectionGetter());
-
-    rowSelection.selectedRowKeys ??= [];
-    rowSelection.onChange ??= keys => rowSelection.selectedRowKeys = keys;
-
-    return rowSelection;
-  };
-
-  const tableProps = computed<LocalTableProps>(() => {
-    const { list, pagination } = data.value ?? {};
-
-    return {
-      dataSource: list,
-      pagination: {
-        disabled: isFetching.value,
-        current: Number(queryParams.page ?? 1),
-        pageSize: Number(queryParams.page_size ?? 10),
-        total: pagination?.total ?? 0,
-        showTotal: total => `共 ${total} 条`,
-      },
-      loading: isLoading.value,
-      scroll: { x: 'max-content' },
-      sticky: true,
-      onChange: onPaginationChange as any,
-    };
-  });
-  const dataIndexs = new Proxy({} as Record<keyof RecordType, string>, {
-    get(_, p) {
-      return p;
-    },
-  });
-  const bodyCellType = {} as {
-    index: number
-    text: any
-    value: any
-    record: RecordType
-    column: ColumnType<RecordType>
-  };
-
-  return {
-    /** ATable 的预设 Props */
-    tableProps,
-    /** 【类型辅助】基于接口数据类型推导出的 dataIndex，供 columns 的 dataIndex 使用 */
-    dataIndexs,
-    /** 【类型辅助】bodyCell 插槽数据的精确类型描述 */
-    bodyCellType,
-    /** 【类型辅助】用于定义出类型精确的 columns  */
-    defineColumns,
-    /** 【类型辅助】用于定义出类型精确的 rowSelection  */
-    defineRowSelection,
-    onPaginationChange,
-  };
-}
-
-type GetRecordType<T> = T extends UseQueryReturnType<infer D, any>
-  ? D extends Api.PageData
-    ? NonNullable<D['list']>[0]
-    : never
-  : never;
+import { computed, reactive, ref } from 'vue';
+import { pick } from 'lodash-es';
+import type { UseQueryReturnType } from '@tanstack/vue-query';
+import type { Table, TableProps } from 'ant-design-vue';
+import type { ColumnType, FilterValue } from 'ant-design-vue/es/table/interface';
+import type { ComponentProps } from 'vue-component-type-helpers';
+
+interface ISorter {
+  field?: string
+  order?: string
+}
+
+export function useAntdTable<
+  UQRR extends UseQueryReturnType<any, any>,
+  QP extends Partial<{ page?: string | number, page_size?: string | number }>,
+>(uqrt: UQRR, queryParams: QP = ({} as any)) {
+  type RecordType = GetRecordType<UQRR>;
+  type LocalTableProps = TableProps<RecordType>;
+  type LocalColumnsType = NonNullable<LocalTableProps['columns']>;
+  type LocalTableRowSelection = NonNullable<LocalTableProps['rowSelection']>;
+
+  const { data, isFetching, isLoading } = uqrt;
+  const filters = ref<Record<string, FilterValue>>();
+  const sorter = ref<ISorter>();
+  const sorters = ref<ISorter[]>();
+
+  const onChange: ComponentProps<typeof Table>['onChange'] = (_pagination, _filters, _sorter, extra) => {
+    if (extra.action === 'paginate') {
+      const page = queryParams.page_size !== _pagination.pageSize ? 1 : _pagination.current;
+      Object.assign(queryParams, { page, page_size: _pagination.pageSize ?? 10 });
+    }
+    else if (extra.action === 'filter') {
+      filters.value = _filters;
+    }
+    else if (extra.action === 'sort') {
+      if (Array.isArray(_sorter)) {
+        sorter.value = pick(_sorter[0], ['field', 'order']) as any;
+        sorters.value = _sorter.map(item => pick(item, ['field', 'order'])) as any;
+      }
+      else {
+        sorter.value = pick(_sorter, ['field', 'order']) as any;
+        sorters.value = [{ ...sorter.value }];
+      }
+    }
+  };
+  const defineColumns = (columnsGetter: () => LocalColumnsType) => computed(columnsGetter);
+  const defineRowSelection = (rowSelectionGetter: () => LocalTableRowSelection) => {
+    const rowSelection = reactive(rowSelectionGetter());
+
+    rowSelection.selectedRowKeys ??= [];
+    rowSelection.onChange ??= keys => rowSelection.selectedRowKeys = keys;
+
+    return rowSelection;
+  };
+
+  const tableProps = computed<LocalTableProps>(() => {
+    const { list, pagination } = data.value ?? {};
+
+    return {
+      dataSource: list,
+      pagination: {
+        disabled: isFetching.value,
+        current: Number(queryParams.page ?? 1),
+        pageSize: Number(queryParams.page_size ?? 10),
+        total: pagination?.total ?? 0,
+        showSizeChanger: true,
+        showQuickJumper: true,
+        showTotal: total => `共 ${total} 条`,
+      },
+      loading: isLoading.value,
+      scroll: { x: 'max-content' },
+      sticky: true,
+      onChange: onChange as any,
+    };
+  });
+  const dataIndexs = new Proxy({} as Record<keyof RecordType, string>, {
+    get(_, p) {
+      return p;
+    },
+  });
+  const bodyCellType = {} as {
+    index: number
+    text: any
+    value: any
+    record: RecordType
+    column: ColumnType<RecordType>
+  };
+
+  return {
+    /** ATable 的预设 Props */
+    tableProps,
+    /* 过滤的字段 */
+    filters,
+    /* 排序的字段 */
+    sorter,
+    /* 多维排序的字段 */
+    sorters,
+    /** 【类型辅助】基于接口数据类型推导出的 dataIndex，供 columns 的 dataIndex 使用 */
+    dataIndexs,
+    /** 【类型辅助】bodyCell 插槽数据的精确类型描述 */
+    bodyCellType,
+    /** 【类型辅助】用于定义出类型精确的 columns  */
+    defineColumns,
+    /** 【类型辅助】用于定义出类型精确的 rowSelection  */
+    defineRowSelection,
+    /** 内置的 ATable onChange 事件，默认在 `tableProps` 中 */
+    onChange,
+  };
+}
+
+type GetRecordType<T> = T extends UseQueryReturnType<infer D, any>
+  ? D extends Api.PageData
+    ? NonNullable<D['list']>[0]
+    : never
+  : never;

package/package.json

@@ -1,55 +1,55 @@
-{
-  "name": "@peng_kai/kit",
-  "type": "module",
-  "version": "0.1.10",
-  "description": "",
-  "author": "",
-  "license": "ISC",
-  "keywords": [],
-  "main": "index.js",
-  "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
-  },
-  "peerDependencies": {
-    "@tanstack/vue-query": "4.37.1",
-    "@vueuse/core": "10.6.1",
-    "ant-design-vue": "4.0.7",
-    "axios": "1.6.2",
-    "bignumber.js": "9.1.2",
-    "dayjs": "1.11.10",
-    "lodash-es": "4.17.21",
-    "vue": "3.3.8",
-    "vue-router": "4.2.5"
-  },
-  "dependencies": {
-    "@babel/generator": "^7.23.5",
-    "@babel/parser": "^7.23.5",
-    "@babel/traverse": "^7.23.5",
-    "@babel/types": "^7.23.5",
-    "@tanstack/vue-query": "^4.37.1",
-    "@vueuse/core": "^10.6.1",
-    "a-calc": "^1.3.8",
-    "ant-design-vue": "^4.0.7",
-    "axios": "^1.6.2",
-    "bignumber.js": "^9.1.2",
-    "chokidar": "^3.5.3",
-    "dayjs": "^1.11.10",
-    "fast-glob": "^3.3.2",
-    "lodash-es": "^4.17.21",
-    "nprogress": "^0.2.0",
-    "vue": "^3.3.8",
-    "vue-router": "^4.2.5"
-  },
-  "devDependencies": {
-    "@antfu/eslint-config": "^1.2.1",
-    "@peng_kai/lint": "^0.1.0",
-    "@types/lodash-es": "^4.17.11",
-    "@types/node": "18",
-    "@types/nprogress": "^0.2.3",
-    "@unocss/eslint-plugin": "^0.57.7",
-    "type-fest": "^4.8.1",
-    "typescript": "^5.2.2",
-    "vue-component-type-helpers": "^1.8.22"
-  }
-}
+{
+  "name": "@peng_kai/kit",
+  "type": "module",
+  "version": "0.1.12",
+  "description": "",
+  "author": "",
+  "license": "ISC",
+  "keywords": [],
+  "main": "index.js",
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  },
+  "peerDependencies": {
+    "@tanstack/vue-query": "4.37.1",
+    "@vueuse/core": "10.6.1",
+    "ant-design-vue": "4.0.8",
+    "axios": "1.6.2",
+    "bignumber.js": "9.1.2",
+    "dayjs": "1.11.10",
+    "lodash-es": "4.17.21",
+    "vue": "3.3.8",
+    "vue-router": "4.2.5"
+  },
+  "dependencies": {
+    "@babel/generator": "^7.23.5",
+    "@babel/parser": "^7.23.5",
+    "@babel/traverse": "^7.23.5",
+    "@babel/types": "^7.23.5",
+    "@tanstack/vue-query": "^4.37.1",
+    "@vueuse/core": "^10.6.1",
+    "a-calc": "^1.3.8",
+    "ant-design-vue": "^4.0.8",
+    "axios": "^1.6.2",
+    "bignumber.js": "^9.1.2",
+    "chokidar": "^3.5.3",
+    "dayjs": "^1.11.10",
+    "fast-glob": "^3.3.2",
+    "lodash-es": "^4.17.21",
+    "nprogress": "^0.2.0",
+    "vue": "^3.3.8",
+    "vue-router": "^4.2.5"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^1.2.1",
+    "@peng_kai/lint": "^0.1.0",
+    "@types/lodash-es": "^4.17.11",
+    "@types/node": "18",
+    "@types/nprogress": "^0.2.3",
+    "@unocss/eslint-plugin": "^0.57.7",
+    "type-fest": "^4.8.1",
+    "typescript": "^5.2.2",
+    "vue-component-type-helpers": "^1.8.22"
+  }
+}

package/request/helpers.ts

@@ -1,49 +1,49 @@
-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;
-  }
-}
+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/interceptors/formatPaging.ts

@@ -12,10 +12,9 @@ export function formatPaging(): Parameters<AxiosInterceptorManager<any>['use']>
         return resp;
 
       if (result.pagination) {
-        result.data = {
-          list: result.data,
-          pagination: result.pagination,
-        };
+        const originData = result.data;
+        result.data = originData.list ? { ...originData } : { list: originData };
+        result.data.pagination = result.pagination;
 
         Reflect.deleteProperty(result, 'pagination');
       }

package/request/interceptors/popupMessage.ts

@@ -19,7 +19,8 @@ export function popupMessage(popup: (type: 'error' | 'success', message: string)
       if (typeof successMessageConfig !== 'string')
         successMsg = resp?.data?.msg;
 
-      popup('success', successMsg);
+      if (typeof successMsg === 'string' && successMsg !== '')
+        popup('success', successMsg);
 
       return resp;
     },
@@ -32,7 +33,7 @@ export function popupMessage(popup: (type: 'error' | 'success', message: string)
       let errorMsg: boolean | string = errorMessageConfig;
 
       if (axios.isAxiosError(error)) {
-      // 请求超时
+        // 请求超时
         if (isTimeout(error))
           errorMsg = 'Request Timeout';
         else if (typeof errorMessageConfig !== 'string')
@@ -42,10 +43,10 @@ export function popupMessage(popup: (type: 'error' | 'success', message: string)
         errorMsg = error.message;
       }
 
-      if (typeof errorMsg === 'string')
+      if (typeof errorMsg === 'string' && errorMsg !== '')
         popup('error', errorMsg);
 
       throw error;
     },
   ];
-}
+}

package/request/interceptors/toLogin.ts

@@ -1,15 +1,26 @@
-import type { AxiosInterceptorManager } from 'axios';
-
-export function toLogin(authPath = `${window.location.origin}/auth/login`, code = 15001): Parameters<AxiosInterceptorManager<any>['use']> {
-  return [
-    undefined,
-    (err) => {
-      if (err.code !== code)
-        throw err;
-
-      const url = new URL(authPath);
-      url.searchParams.set('redirect', window.location.href);
-      window.location.href = url.toString();
-    },
-  ];
-}
+import type { AxiosInterceptorManager } from 'axios';
+
+const REDIRECT_KEY = 'redirect';
+
+export function toLogin(authPath = `${window.location.origin}/auth/login`, code = 15001): Parameters<AxiosInterceptorManager<any>['use']> {
+  return [
+    undefined,
+    (err) => {
+      if (err.code !== code)
+        throw err;
+
+      const currentURL = new URL(window.location.href);
+      const targetURL = new URL(authPath);
+
+      if (currentURL.searchParams.has(REDIRECT_KEY))
+        targetURL.searchParams.set(REDIRECT_KEY, currentURL.searchParams.get(REDIRECT_KEY)!);
+      else
+        targetURL.searchParams.set(REDIRECT_KEY, window.location.href);
+
+      if (currentURL.toString() === targetURL.toString())
+        return;
+
+      window.location.href = targetURL.toString();
+    },
+  ];
+}

package/request/queryClient.ts

@@ -1,24 +1,48 @@
-import type { QueryClientConfig } from '@tanstack/vue-query';
+import type { QueryClientConfig, QueryObserverOptions } from '@tanstack/vue-query';
+import { ApiCode } from './helpers';
 
 /** 不需要重试的 api code */
 export const ignoreRetryCodes = [
+  ApiCode.UNKNOWN,
   11000, // 操作失败
   11001, // 操作过于频繁
   11002, // 权限不足
   11003, // 缺少必要参数
   15001, // 未登录
+  15003, // 用户不存在
+  /^3{2}$/, // HTTP status 3xx
+  /^4{2}$/, // HTTP status 4xx
+  /^5{2}$/, // HTTP status 5xx
 ];
 
+/**
+ * 构建用于查询的重试函数。
+ * @param ignoreList 一个数组，包含要在重试期间忽略的错误代码的数字、字符串或正则表达式。
+ * @param additionPresetIgnore 一个布尔值，指示是否包括额外的预设忽略代码。默认为 true。
+ * @returns 根据失败计数和错误代码确定是否重试的重试函数。
+ */
+export function buildRetryFn(ignoreList: Array<number | string | RegExp>, additionPresetIgnore = true): NonNullable<QueryObserverOptions['retry']> {
+  const _ignoreList = [...ignoreList, ...(additionPresetIgnore ? ignoreRetryCodes : [])];
+  return (failureCount, error: any) => {
+    if (error?.code === undefined)
+      return false;
+
+    const ignored = _ignoreList.some((code) => {
+      if (code instanceof RegExp)
+        return code.test(String(error?.code));
+
+      return code === error?.code;
+    });
+
+    return ignored ? false : failureCount < 2;
+  };
+}
+
 export const presetOptions: QueryClientConfig = {
   defaultOptions: {
     queries: {
       refetchOnWindowFocus: false,
-      retry(failureCount, error: any) {
-        if (ignoreRetryCodes.includes(error?.code))
-          return false;
-
-        return failureCount < 3;
-      },
+      retry: buildRetryFn(ignoreRetryCodes),
       getNextPageParam: (lastPage: any) => {
         const { pagination } = lastPage ?? {};
 
@@ -39,4 +63,4 @@ export const presetOptions: QueryClientConfig = {
       },
     },
   },
-};
+};

package/request/request.ts

@@ -1,5 +1,4 @@
 import type { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
-import { isSSR } from '../utils';
 
 export { createRequest };