evolution: add extra param on Request - gid-oss#11

gantispam · Mar 13, 2023 · 7922373 · 7922373
1 parent e8fddfe
commit 7922373
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 4 deletions.
diff --git a/packages/crud-request/src/interfaces/create-query-params.interface.ts b/packages/crud-request/src/interfaces/create-query-params.interface.ts
@@ -1,4 +1,5 @@
 import {
+  QueryExtra,
   QueryFields,
   QueryFilter,
   QueryFilterArr,
@@ -21,4 +22,5 @@ export interface CreateQueryParams {
   page?: number;
   resetCache?: boolean;
   includeDeleted?: number;
+  extra?: QueryExtra;
 }
diff --git a/packages/crud-request/src/interfaces/parsed-request.interface.ts b/packages/crud-request/src/interfaces/parsed-request.interface.ts
@@ -1,7 +1,7 @@
 import { ObjectLiteral } from '@dataui/crud-util';
 import { QueryFields, QueryFilter, QueryJoin, QuerySort, SCondition } from '../types';
 
-export interface ParsedRequestParams {
+export interface ParsedRequestParams<EXTRA = {}> {
   fields: QueryFields;
   paramsFilter: QueryFilter[];
   authPersist: ObjectLiteral;
@@ -15,4 +15,11 @@ export interface ParsedRequestParams {
   page: number;
   cache: number;
   includeDeleted: number;
+  /**
+   * Extra options.
+   *
+   * Custom extra option come from Request and can be used anywhere you want for your business rules.
+   * CrudRequest lib. do not evaluat this attribut.
+   */
+  extra?: EXTRA;
 }
diff --git a/packages/crud-request/src/interfaces/request-query-builder-options.interface.ts b/packages/crud-request/src/interfaces/request-query-builder-options.interface.ts
@@ -13,5 +13,6 @@ export interface RequestQueryBuilderOptions {
     page?: string | string[];
     cache?: string | string[];
     includeDeleted?: string | string[];
+    extra?: string | string[];
   };
 }
diff --git a/packages/crud-request/src/request-query.builder.ts b/packages/crud-request/src/request-query.builder.ts
@@ -52,6 +52,7 @@ export class RequestQueryBuilder {
       page: 'page',
       cache: 'cache',
       includeDeleted: 'include_deleted',
+      extra: 'extra.',
     },
   };
   private paramNames: {

diff --git a/packages/crud-request/src/request-query.parser.ts b/packages/crud-request/src/request-query.parser.ts
@@ -29,7 +29,7 @@ import {
   validateUUID,
 } from './request-query.validator';
 import {
-  ComparisonOperator,
+  ComparisonOperator, QueryExtra,
   QueryFields,
   QueryFilter,
   QueryJoin,
@@ -54,6 +54,7 @@ export class RequestQueryParser implements ParsedRequestParams {
   public page: number;
   public cache: number;
   public includeDeleted: number;
+  public extra?: QueryExtra;
 
   private _params: any;
   private _query: any;
@@ -83,6 +84,7 @@ export class RequestQueryParser implements ParsedRequestParams {
       page: this.page,
       cache: this.cache,
       includeDeleted: this.includeDeleted,
+      extra: this.extra,
     };
   }
 
@@ -129,6 +131,8 @@ export class RequestQueryParser implements ParsedRequestParams {
           'includeDeleted',
           this.numericParser.bind(this, 'includeDeleted'),
         )[0];
+
+        this.extra = this.parseExtraFromQueryParam();
       }
     }
 
@@ -209,6 +213,19 @@ export class RequestQueryParser implements ParsedRequestParams {
     return [];
   }
 
+  private parseExtraFromQueryParam(): QueryExtra {
+    const params = Array.isArray(this._options.paramNamesMap.extra) ? this._options.paramNamesMap.extra : [this._options.paramNamesMap.extra];
+    const extraKeys = Object
+        .keys(this._query || {})
+        .filter(k => params.find(p => k?.startsWith(p)))
+        .reduce((o, k) => {
+          o[k.replace('extra.', '')] = this.parseValues(this._query[k]);
+          return o;
+        }, {});
+
+    return Object.keys(extraKeys).length > 0 ? extraKeys : null;
+  }
+
   private parseValue(val: any) {
     try {
       const parsed = JSON.parse(val);

diff --git a/packages/crud-request/src/types/request-query.types.ts b/packages/crud-request/src/types/request-query.types.ts
@@ -20,6 +20,9 @@ export interface QuerySort {
   order: QuerySortOperator;
 }
 
+/** Extra object or null */
+export type QueryExtra = any | null;
+
 export type QuerySortArr = [string, QuerySortOperator];
 
 export type QuerySortOperator = 'ASC' | 'DESC';

diff --git a/packages/crud/src/interfaces/crud-request.interface.ts b/packages/crud/src/interfaces/crud-request.interface.ts
@@ -2,7 +2,7 @@ import { ParsedRequestParams } from '@dataui/crud-request';
 
 import { CrudRequestOptions } from '../interfaces';
 
-export interface CrudRequest {
-  parsed: ParsedRequestParams;
+export interface CrudRequest<EXTRA = {}> {
+  parsed: ParsedRequestParams<EXTRA>;
   options: CrudRequestOptions;
 }