feat(abc:st): add whether to ignore null or undefined value (#1515)

Author: cipchk

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

@@ -138,6 +138,7 @@ class TestComponent {
 |----------|-------------|------|---------|---------------|
 | `[type]` | Pagination type, `page` used `pi`, `ps`; `skip` used `skip`, `limit` | `page,skip` | `page` | ✅ |
 | `[params]` | Request parameters, default to auto append `pi`, `ps` to URL | `any` | - | - |
+| `[ignoreParamNull]` | Whether to ignore `null` or `unfind` values in parameters | `Boolean` |`false` | ✅ |
 | `[method]` | Request method | `'POST','GET','HEAD','PUT','PATCH','DELETE'` | `'GET'` | ✅ |
 | `[body]` | Request body (only method is POST) | `any` | - | - |
 | `[headers]` | Request header | `any` | - | ✅ |

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

@@ -138,6 +138,7 @@ class TestComponent {
 |----|----|----|-----|------|
 | `[type]` | 分页类型，`page` 使用 `pi`，`ps` 组合；`skip` 使用 `skip`，`limit` 组合 | `page,skip` | `page` | ✅ |
 | `[params]` | 额外请求参数，默认自动附加 `pi`、`ps` 至URL | `any` | - | - |
+| `[ignoreParamNull]` | 是否忽略参数中 `null` 或 `undefind` 值 | `Boolean` |`false` | ✅ |
 | `[method]` | 请求方法 | `'POST','GET','HEAD','PUT','PATCH','DELETE'` | `'GET'` | ✅ |
 | `[body]` | 请求体 `body`，当 `method: POST` 时有效 | `any` | - | - |
 | `[headers]` | 请求体 `headers` | `any` | - | ✅ |

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

@@ -273,7 +273,8 @@ export class STDataSource {
   private getByRemote(url: string, options: STDataSourceOptions): Observable<unknown> {
     const { req, page, paginator, pi, ps, singleSort, multiSort, columns } = options;
     const method = (req.method || 'GET').toUpperCase();
-    let params = {};
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    let params: { [param: string]: any } = {};
     const reName = req.reName as STReqReNameType;
     if (paginator) {
       if (req.type === 'page') {
@@ -294,6 +295,11 @@ export class STDataSource {
       ...this.getReqSortMap(singleSort, multiSort, columns),
       ...this.getReqFilterMap(columns)
     };
+    if (options.req.ignoreParamNull == true) {
+      Object.keys(params).forEach(key => {
+        if (params[key] == null) delete params[key];
+      });
+    }
 
     let reqOptions: STRequestOptions = {
       params,

packages/abc/st/st.config.ts

@@ -11,6 +11,7 @@ export const ST_DEFAULT_CONFIG: AlainSTConfig = {
     method: 'GET',
     allInBody: false,
     lazyLoad: false,
+    ignoreParamNull: false,
     reName: { pi: 'pi', ps: 'ps', skip: 'skip', limit: 'limit' }
   },
   res: {

packages/abc/st/st.interfaces.ts

@@ -60,6 +60,12 @@ export interface STReq {
    * - `{ status: 'new' }` => `url?pi=1&ps=10&status=new`
    */
   params?: any;
+  /**
+   * Whether to ignore `null` or `unfind` values in parameters
+   *
+   * 是否忽略参数中 `null` 或 `undefind` 值
+   */
+  ignoreParamNull?: Boolean;
   /** 请求方法，默认：`GET` */
   method?: string;
   /** 请求体 `body` */

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

@@ -367,6 +367,16 @@ describe('abc: table: data-souce', () => {
           });
         });
       });
+      it('should be ignoreParamNull', done => {
+        options.req.ignoreParamNull = true;
+        options.req.params = { a: null, b: 1 };
+        options.req.process = res => {
+          expect(Object.keys(res.params!!)).not.toContain(`a`);
+          expect(Object.keys(res.params!!)).toContain(`b`);
+          return res;
+        };
+        srv.process(options).subscribe(() => done());
+      });
     });
     describe('[response]', () => {
       beforeEach(() => {

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

@@ -40,6 +40,12 @@ export interface AlainSTConfig {
      * - `skip` 使用 `skip`，`limit` 组合
      */
     type?: 'page' | 'skip';
+    /**
+     * Whether to ignore `null` or `unfind` values in parameters
+     *
+     * 是否忽略参数中 `null` 或 `undefind` 值
+     */
+    ignoreParamNull?: Boolean;
     /** 请求方法，默认：`GET` */
     method?: string;
     /** 请求体 `Header` */