feat(abc:st): add function of reName (#1500)

Author: cipchk

packages/abc/st/index.en-US.md

@@ -141,7 +141,7 @@ class TestComponent {
 | `[method]` | Request method | `'POST','GET','HEAD','PUT','PATCH','DELETE'` | `'GET'` | ✅ |
 | `[body]` | Request body (only method is POST) | `any` | - | - |
 | `[headers]` | Request header | `any` | - | ✅ |
-| `[reName]` | Map name `pi`、`ps` | `STReqReNameType` | `{ pi: 'pi', ps: 'ps', skip: 'skip', limit: 'limit' }` | ✅ |
+| `[reName]` | Map name `pi`、`ps` | `STReqReNameType, ((result: any, options: { pi: number; ps: number; total: number }) => { total: number; list: T[] })` | `{ pi: 'pi', ps: 'ps', skip: 'skip', limit: 'limit' }` | ✅ |
 | `[allInBody]` | Whether to request all parameter data into `body` (except `url` itself parameter) | `boolean` | `false` | ✅ |
 | `[lazyLoad]` | Whether to delay loading data in first render `st` component | `boolean` | `false` | ✅ |
 | `[process]` | Pre-request data processing | `(requestOptions: STRequestOptions) => STRequestOptions` | - | ✅ |

packages/abc/st/index.zh-CN.md

@@ -141,7 +141,7 @@ class TestComponent {
 | `[method]` | 请求方法 | `'POST','GET','HEAD','PUT','PATCH','DELETE'` | `'GET'` | ✅ |
 | `[body]` | 请求体 `body`，当 `method: POST` 时有效 | `any` | - | - |
 | `[headers]` | 请求体 `headers` | `any` | - | ✅ |
-| `[reName]` | 重命名请求参数 `pi`、`ps` | `STReqReNameType` | `{ pi: 'pi', ps: 'ps', skip: 'skip', limit: 'limit' }` | ✅ |
+| `[reName]` | 重命名请求参数 `pi`、`ps` | `STReqReNameType, ((result: any, options: { pi: number; ps: number; total: number }) => { total: number; list: T[] })` | `{ pi: 'pi', ps: 'ps', skip: 'skip', limit: 'limit' }` | ✅ |
 | `[allInBody]` | 是否将请求所有参数数据都放入 `body` 当中（`url` 地址本身参数除外），仅当 `method: 'POST'` 时有效 | `boolean` | `false` | ✅ |
 | `[lazyLoad]` | 是否延迟加载数据，即渲染结束后不会主动发起请求 | `boolean` | `false` | ✅ |
 | `[process]` | 请求前数据处理 | `(requestOptions: STRequestOptions) => STRequestOptions` | - | ✅ |

packages/abc/st/st-data-source.ts

@@ -106,14 +106,21 @@ export class STDataSource {
             retPs = retTotal;
             showPage = false;
           } else {
-            // list
-            ret = deepGet(result, res.reName!.list as string[], []);
-            if (ret == null || !Array.isArray(ret)) {
-              ret = [];
+            const reName = res.reName!;
+            if (typeof reName === 'function') {
+              const fnRes = reName(result, { pi, ps, total });
+              ret = fnRes.list;
+              retTotal = fnRes.total;
+            } else {
+              // list
+              ret = deepGet(result, reName.list as string[], []);
+              if (ret == null || !Array.isArray(ret)) {
+                ret = [];
+              }
+              // total
+              const resultTotal = reName.total && deepGet(result, reName.total as string[], null);
+              retTotal = resultTotal == null ? total || 0 : +resultTotal;
             }
-            // total
-            const resultTotal = res.reName!.total && deepGet(result, res.reName!.total as string[], null);
-            retTotal = resultTotal == null ? total || 0 : +resultTotal;
           }
           return deepCopy(ret);
         })

packages/abc/st/st.component.ts

@@ -147,8 +147,10 @@ export class STComponent implements AfterViewInit, OnChanges, OnDestroy {
   set res(value: STRes) {
     const item = (this._res = deepMergeKey({}, true, this.cog.res, value));
     const reName = item.reName!;
-    if (!Array.isArray(reName.list)) reName.list = reName.list!.split('.');
-    if (!Array.isArray(reName.total)) reName.total = reName.total!.split('.');
+    if (typeof reName !== 'function') {
+      if (!Array.isArray(reName.list)) reName.list = reName.list!.split('.');
+      if (!Array.isArray(reName.total)) reName.total = reName.total!.split('.');
+    }
     this._res = item;
   }
   @Input()

packages/abc/st/st.interfaces.ts

@@ -115,7 +115,9 @@ export interface STRes<T extends STData = any> {
    * 重命名返回参数 `total`、`list`
    * - `{ total: 'Total' }` => Total 会被当作 `total`
    */
-  reName?: STResReNameType;
+  reName?:
+    | STResReNameType
+    | ((result: any, options: { pi: number; ps: number; total: number }) => { total: number; list: T[] });
   /**
    * 数据预处理
    */

packages/abc/st/test/st-data-source.spec.ts

@@ -393,6 +393,16 @@ describe('abc: table: data-souce', () => {
           done();
         });
       });
+      it('should be function re-name config', done => {
+        options.res.reName = () => ({ total: 1, list: [{ a: 'L1' }] });
+        spyOn(http, 'request').and.callFake(() => of({ L: genData(DEFAULT.ps), T: DEFAULT.ps }));
+        srv.process(options).subscribe(res => {
+          expect(res.total).toBe(1);
+          expect(res.list.length).toBe(1);
+          expect(res.list[0].a).toBe('L1');
+          done();
+        });
+      });
       it('should be return empty when result is not array', done => {
         options.res.reName = { total: 'T', list: 'L' };
         spyOn(http, 'request').and.callFake(() => of({ L: 1, T: DEFAULT.ps }));

packages/util/config/abc/st.type.ts

@@ -73,10 +73,15 @@ export interface AlainSTConfig {
      * 重命名返回参数 `total`、`list`，默认：`{ list: ['list'], total: ['total'] }`
      * - `{ total: 'Total' }` => Total 会被当作 `total`
      */
-    reName?: {
-      total?: string | string[];
-      list?: string | string[];
-    };
+    reName?:
+      | {
+          total?: string | string[];
+          list?: string | string[];
+        }
+      | ((
+          result: NzSafeAny,
+          options: { pi: number; ps: number; total: number }
+        ) => { total: number; list: NzSafeAny[] });
     /**
      * 数据预处理
      */