feat: add array operators

More info here: nestjsx#754
afilp · Oct 31, 2023 · 528162e · 528162e
1 parent 1f5899f
commit 528162e
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 31 deletions.
diff --git a/packages/crud-request/src/request-query.parser.ts b/packages/crud-request/src/request-query.parser.ts
@@ -325,6 +325,8 @@ export class RequestQueryParser implements ParsedRequestParams {
       '$between',
       '$inL',
       '$notinL',
+      '$contArr',
+      '$intersectsArr',
     ].concat(Object.keys(customOperators).filter((op) => customOperators[op].isArray));
     const isEmptyValue = ['isnull', 'notnull', '$isnull', '$notnull'];
     const param = data.split(this._options.delim);

diff --git a/packages/crud-request/src/request-query.validator.ts b/packages/crud-request/src/request-query.validator.ts
@@ -36,6 +36,8 @@ export const deprecatedComparisonOperatorsList = [
   'isnull',
   'notnull',
   'between',
+  'contArr',
+  'intersectsArr',
 ];
 export const comparisonOperatorsList = [
   ...deprecatedComparisonOperatorsList,

diff --git a/packages/crud-request/src/types/request-query.types.ts b/packages/crud-request/src/types/request-query.types.ts
@@ -42,7 +42,9 @@ type DeprecatedCondOperator =
   | 'notin'
   | 'isnull'
   | 'notnull'
-  | 'between';
+  | 'between'
+  | 'contArr'
+  | 'intersectsArr';
 
 export enum CondOperator {
   EQUALS = '$eq',
@@ -68,39 +70,45 @@ export enum CondOperator {
   EXCLUDES_LOW = '$exclL',
   IN_LOW = '$inL',
   NOT_IN_LOW = '$notinL',
+  CONTAINS_ARRAY = '$contArr',
+  INTERSECTS_ARRAY = '$intersectsArr',
 }
 
 export type ComparisonOperator = DeprecatedCondOperator | keyof SFieldOperator | string;
 
 // new search
 export type SPrimitivesVal = string | number | boolean;
 
-export type SFiledValues = SPrimitivesVal | SPrimitivesVal[];
+export type SFieldValues = SPrimitivesVal | Array<SPrimitivesVal>;
+// DEPRECATED: remove before next major release (or other breaking change)
+export type SFiledValues = SFieldValues;
 
 export interface SFieldOperator {
-  $eq?: SFiledValues;
-  $ne?: SFiledValues;
-  $gt?: SFiledValues;
-  $lt?: SFiledValues;
-  $gte?: SFiledValues;
-  $lte?: SFiledValues;
-  $starts?: SFiledValues;
-  $ends?: SFiledValues;
-  $cont?: SFiledValues;
-  $excl?: SFiledValues;
-  $in?: SFiledValues;
-  $notin?: SFiledValues;
-  $between?: SFiledValues;
-  $isnull?: SFiledValues;
-  $notnull?: SFiledValues;
-  $eqL?: SFiledValues;
-  $neL?: SFiledValues;
-  $startsL?: SFiledValues;
-  $endsL?: SFiledValues;
-  $contL?: SFiledValues;
-  $exclL?: SFiledValues;
-  $inL?: SFiledValues;
-  $notinL?: SFiledValues;
+  $eq?: SFieldValues;
+  $ne?: SFieldValues;
+  $gt?: SFieldValues;
+  $lt?: SFieldValues;
+  $gte?: SFieldValues;
+  $lte?: SFieldValues;
+  $starts?: SFieldValues;
+  $ends?: SFieldValues;
+  $cont?: SFieldValues;
+  $excl?: SFieldValues;
+  $in?: SFieldValues;
+  $notin?: SFieldValues;
+  $between?: SFieldValues;
+  $isnull?: SFieldValues;
+  $notnull?: SFieldValues;
+  $eqL?: SFieldValues;
+  $neL?: SFieldValues;
+  $startsL?: SFieldValues;
+  $endsL?: SFieldValues;
+  $contL?: SFieldValues;
+  $exclL?: SFieldValues;
+  $inL?: SFieldValues;
+  $notinL?: SFieldValues;
+  $contArr?: Array<SPrimitivesVal>;
+  $intersectsArr?: Array<SPrimitivesVal>;
   $or?: SFieldOperator;
   $and?: never;
   $not?: never;
@@ -109,7 +117,7 @@ export interface SFieldOperator {
 export type SField =
   | SPrimitivesVal
   | SFieldOperator
-  | { [$custom: string]: SFiledValues };
+  | { [$custom: string]: SFieldValues };
 
 export interface SFields {
   [key: string]: SField | Array<SFields | SConditionAND | SConditionNOT> | undefined;

diff --git a/packages/crud-typeorm/src/typeorm-crud.service.ts b/packages/crud-typeorm/src/typeorm-crud.service.ts
@@ -1064,7 +1064,8 @@ export class TypeOrmCrudService<T> extends CrudService<T, DeepPartial<T>> {
     const likeOperator =
       this.dbName === 'postgres' ? 'ILIKE' : /* istanbul ignore next */ 'LIKE';
     let str: string;
-    let params: ObjectLiteral;
+    // NOTE: may be overridden by specific operators
+    let params: ObjectLiteral = { [param]: cond.value };
 
     if (cond.operator[0] !== '$') {
       cond.operator = ('$' + cond.operator) as ComparisonOperator;
@@ -1183,6 +1184,16 @@ export class TypeOrmCrudService<T> extends CrudService<T, DeepPartial<T>> {
         str = `LOWER(${field}) NOT IN (:...${param})`;
         break;
 
+      case '$contArr':
+        this.checkFilterIsArray(cond);
+        str = `${field} @> ARRAY[:...${param}]`;
+        break;
+
+      case '$intersectsArr':
+        this.checkFilterIsArray(cond);
+        str = `${field} && ARRAY[:...${param}]`;
+        break;
+
       /* istanbul ignore next */
       default:
         const customOperator = customOperators[cond.operator];
@@ -1203,10 +1214,6 @@ export class TypeOrmCrudService<T> extends CrudService<T, DeepPartial<T>> {
         break;
     }
 
-    if (typeof params === 'undefined') {
-      params = { [param]: cond.value };
-    }
-
     return { str, params };
   }