@peng_kai/kit 0.1.5 → 0.1.7

package/antd/hooks/useAntdTable.ts

@@ -1,82 +1,82 @@
-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 } 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;

package/package.json

@@ -1,55 +1,55 @@
-{
-  "name": "@peng_kai/kit",
-  "type": "module",
-  "version": "0.1.5",
-  "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.7",
+  "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"
+  }
+}

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/toLogin.ts

@@ -1,15 +1,15 @@
-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';
+
+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();
+    },
+  ];
+}

package/request/type.d.ts

@@ -1,92 +1,92 @@
-declare namespace Api {
-  type Request = ((reqData: any, options?: Options) => Promise<any>) & {
-    id: string
-    setDefaultConfig: (config: Partial<import('axios').AxiosRequestConfig>) => Request
-  };
-  // type RequestPagination = (reqData: Partial<PageParam>, options?: Options) => Promise<PaginationData<any>>;
-  interface PageParam {
-    page: number
-    page_size: number
-  }
-  interface PageInfo {
-    has_more: boolean
-    page: number
-    page_size: number
-    total: number
-  }
-  interface PageData<T = any> {
-    list: T[] | null
-    pagination: PaginationInfo
-    [k in string]: any
-  }
-  interface Result<T = any | PageData<any>> {
-    code: number
-    msg: string
-    data: T
-  }
-  type GetParam<A extends Request> = A extends (reqData: infer R) => any ? R : any;
-  type GetData<A extends Request> = ReturnType<A> extends Promise<infer D> ? D : any;
-  type GetDataItem<A extends Request> = NonNullable<GetData<A>> extends { list: infer L }
-    ? NonNullable<L> extends Array<infer I>
-      ? I
-      : any
-    : any;
-  type GetDataField<R> = R extends { data: infer D } ? (D extends { list: any, pagination: any } ? D : D) : any;
-
-  /**
-   * 将api返回的分页数据转换成前端使用的分页数据格式，将分页数据格式统一
-   *
-   * ```
-   * {
-   *   code: number,
-   *   msg: string,
-   *   data: {
-   *     list: [],
-   *     pagination: {},
-   *     ...
-   *   }
-   * }
-   * ```
-   */
-  type TransformPageResult<R> = R extends { pagination: infer P, data: infer D }
-    ? D extends Record<string, any>
-      ? D extends { list: any }
-      ? {
-          [Rk in Exclude<keyof R, 'data' | 'pagination'>]: R[Rk];
-        } & {
-          data: D & { pagination: P }
-        }
-        : {
-          [Rk in Exclude<keyof R, 'data' | 'pagination'>]: R[Rk];
-        } & {
-          data: {
-            list: D
-            pagination: P
-          }
-        }
-      : R
-    : R;
-}
-
-// 测试用例 ----------------------------
-// type DDD1 = Api.TransformPageResult<{
-//   code: number
-//   msg: string
-//   data: {
-//     name: string
-//   }[]
-//   pagination: {
-//     page: number
-//   }
-// }>
-// type DDD2 = Api.TransformPageResult<{
-//   code: number
-//   msg: string
-//   data: {
-//     list: { name: string }[]
-//     total: {}
-//   }
-//   pagination: {
-//     page: number
-//   }
-// }>
+declare namespace Api {
+  type Request = ((reqData: any, options?: Options) => Promise<any>) & {
+    id: string
+    setDefaultConfig: (config: Partial<import('axios').AxiosRequestConfig>) => Request
+  };
+  // type RequestPagination = (reqData: Partial<PageParam>, options?: Options) => Promise<PaginationData<any>>;
+  interface PageParam {
+    page: number
+    page_size: number
+  }
+  interface PageInfo {
+    has_more: boolean
+    page: number
+    page_size: number
+    total: number
+  }
+  interface PageData<T = any> {
+    list: T[] | null
+    pagination: PaginationInfo
+    [k in string]: any
+  }
+  interface Result<T = any | PageData<any>> {
+    code: number
+    msg: string
+    data: T
+  }
+  type GetParam<A extends Request> = A extends (reqData: infer R) => any ? R : any;
+  type GetData<A extends Request> = ReturnType<A> extends Promise<infer D> ? D : any;
+  type GetDataItem<A extends Request> = NonNullable<GetData<A>> extends { list: infer L }
+    ? NonNullable<L> extends Array<infer I>
+      ? I
+      : any
+    : any;
+  type GetDataField<R> = R extends { data: infer D } ? (D extends { list: any, pagination: any } ? D : D) : any;
+
+  /**
+   * 将api返回的分页数据转换成前端使用的分页数据格式，将分页数据格式统一
+   *
+   * ```
+   * {
+   *   code: number,
+   *   msg: string,
+   *   data: {
+   *     list: [],
+   *     pagination: {},
+   *     ...
+   *   }
+   * }
+   * ```
+   */
+  type TransformPageResult<R> = R extends { pagination: infer P, data: infer D }
+    ? D extends Record<string, any>
+      ? D extends { list: any }
+      ? {
+          [Rk in Exclude<keyof R, 'data' | 'pagination'>]: R[Rk];
+        } & {
+          data: D & { pagination: P }
+        }
+        : {
+          [Rk in Exclude<keyof R, 'data' | 'pagination'>]: R[Rk];
+        } & {
+          data: {
+            list: D
+            pagination: P
+          }
+        }
+      : R
+    : R;
+}
+
+// 测试用例 ----------------------------
+// type DDD1 = Api.TransformPageResult<{
+//   code: number
+//   msg: string
+//   data: {
+//     name: string
+//   }[]
+//   pagination: {
+//     page: number
+//   }
+// }>
+// type DDD2 = Api.TransformPageResult<{
+//   code: number
+//   msg: string
+//   data: {
+//     list: { name: string }[]
+//     total: {}
+//   }
+//   pagination: {
+//     page: number
+//   }
+// }>

package/stylelint.config.cjs

@@ -1,7 +1,7 @@
-module.exports = {
-  // root: true,
-  extends: ['@peng_kai/lint/vue/stylelint_v2'],
-  rules: {
-    'custom-property-pattern': '(antd-([a-z][a-zA-Z0-9]+)*)|(([a-z][a-z0-9]*)(-[a-z0-9]+)*)',
-  },
-};
+module.exports = {
+  // root: true,
+  extends: ['@peng_kai/lint/vue/stylelint_v2'],
+  rules: {
+    'custom-property-pattern': '(antd-([a-z][a-zA-Z0-9]+)*)|(([a-z][a-z0-9]*)(-[a-z0-9]+)*)',
+  },
+};