feat(hooks): useTable supports passing in the default transformer clo…

src/hooks/common/table.ts

@@ -16,12 +16,33 @@ export function useTable<A extends NaiveUI.TableApiFn>(config: NaiveUI.NaiveTabl
 
   const isMobile = computed(() => appStore.isMobile);
 
-  const { apiFn, apiParams, immediate, showTotal } = config;
+  const { apiFn, transformer, apiParams, immediate, showTotal } = config;
 
   const SELECTION_KEY = '__selection__';
 
   const EXPAND_KEY = '__expand__';
 
+  const defaultTransformer = (res: Awaited<ReturnType<A>>) => {
+    const { records = [], current = 1, size = 10, total = 0 } = res.data || {};
+
+    // Ensure that the size is greater than 0, If it is less than 0, it will cause paging calculation errors.
+    const pageSize = size <= 0 ? 10 : size;
+
+    const recordsWithIndex = records.map((item, index) => {
+      return {
+        ...item,
+        index: (current - 1) * pageSize + index + 1
+      };
+    });
+
+    return {
+      data: recordsWithIndex,
+      pageNum: current,
+      pageSize,
+      total
+    };
+  };
+
   const {
     loading,
     empty,
@@ -37,26 +58,7 @@ export function useTable<A extends NaiveUI.TableApiFn>(config: NaiveUI.NaiveTabl
     apiFn,
     apiParams,
     columns: config.columns,
-    transformer: res => {
-      const { records = [], current = 1, size = 10, total = 0 } = res.data || {};
-
-      // Ensure that the size is greater than 0, If it is less than 0, it will cause paging calculation errors.
-      const pageSize = size <= 0 ? 10 : size;
-
-      const recordsWithIndex = records.map((item, index) => {
-        return {
-          ...item,
-          index: (current - 1) * pageSize + index + 1
-        };
-      });
-
-      return {
-        data: recordsWithIndex,
-        pageNum: current,
-        pageSize,
-        total
-      };
-    },
+    transformer: transformer || defaultTransformer,
     getColumnChecks: cols => {
       const checks: NaiveUI.TableColumnCheck[] = [];
 

src/typings/api.d.ts

@@ -15,6 +15,9 @@ declare namespace Api {
       total: number;
     }
 
+    /** common search params of table */
+    type CommonSearchParams = Pick<Common.PaginatingCommonParams, 'current' | 'size'>;
+
     /** common params of paginating query list data */
     interface PaginatingQueryRecord<T = any> extends PaginatingCommonParams {
       records: T[];

src/typings/naive-ui.d.ts

@@ -26,7 +26,7 @@ declare namespace NaiveUI {
 
   type TableColumn<T> = TableColumnWithKey<T> | DataTableSelectionColumn<T> | DataTableExpandColumn<T>;
 
-  type TableApiFn<T = any, R = Api.SystemManage.CommonSearchParams> = (
+  type TableApiFn<T = any, R = Api.Common.CommonSearchParams> = (
     params: R
   ) => Promise<FlatResponseData<Api.Common.PaginatingQueryRecord<T>>>;
 
@@ -50,5 +50,12 @@ declare namespace NaiveUI {
      * @default false
      */
     showTotal?: boolean;
+    /**
+     * the custom transformer function
+     *
+     * @param res the response data
+     * @returns the transformed data
+     */
+    transformer?: (res: Awaited<ReturnType<A>>) => { data: any[]; pageNum: number; pageSize: number; total: number };
   };
 }