Change filter registration API

Author: luca-nardelli

packages/query-typeorm/__tests__/query/where.builder.spec.ts

@@ -14,19 +14,22 @@ describe('WhereBuilder', (): void => {
 
   const customFilterRegistry = new CustomFilterRegistry();
   // Test for (operation) filter registration (this is valid for all fields of all entities)
-  customFilterRegistry.setFilter('isMultipleOf', {
-    apply(field, cmp, val: number, alias): CustomFilterResult {
-      alias = alias ? alias : '';
-      const pname = `param${randomString()}`;
-      return {
-        sql: `("${alias}"."${field}" % :${pname}) == 0`,
-        params: { [pname]: val },
-      };
+  customFilterRegistry.setFilter(
+    { operation: 'isMultipleOf' },
+    {
+      apply(field, cmp, val: number, alias): CustomFilterResult {
+        alias = alias ? alias : '';
+        const pname = `param${randomString()}`;
+        return {
+          sql: `("${alias}"."${field}" % :${pname}) == 0`,
+          params: { [pname]: val },
+        };
+      },
     },
-  });
+  );
   // Test for (class, field, operation) filter overriding the previous operation filter on a specific field
-  customFilterRegistry.setFilter<TestEntity>(
-    'isMultipleOf',
+  customFilterRegistry.setFilter(
+    { operation: 'isMultipleOf', Entity: TestEntity, field: 'dateType' },
     {
       apply(field, cmp, val: number, alias): CustomFilterResult {
         alias = alias ? alias : '';
@@ -37,11 +40,10 @@ describe('WhereBuilder', (): void => {
         };
       },
     },
-    { klass: TestEntity, field: 'dateType' },
   );
   // Test for (class, field, operation) filter on a virtual property 'fakePointType' that does not really exist on the entity
-  customFilterRegistry.setFilter<TestEntity>(
-    'distanceFrom',
+  customFilterRegistry.setFilter(
+    { operation: 'distanceFrom', Entity: TestEntity, field: 'fakePointType' },
     {
       apply(field, cmp, val: { point: { lat: number; lng: number }; radius: number }, alias): CustomFilterResult {
         alias = alias ? alias : '';
@@ -54,7 +56,6 @@ describe('WhereBuilder', (): void => {
         };
       },
     },
-    { klass: TestEntity, field: 'fakePointType' },
   );
 
   const expectSQLSnapshot = (filter: Filter<TestEntity>): void => {

packages/query-typeorm/src/query/custom-filter.registry.ts

@@ -40,23 +40,23 @@ export class CustomFilterRegistry {
   }
 
   // (operation) filter overload
-  setFilter<Entity>(opName: string, filter: CustomFilter, opts?: unknown): void;
-
-  // (class, field, operation) filter overload
+  // setFilter<Entity>(opSpec: { operation: string }, filter: CustomFilter<Entity>): void;
+  // Implementation
   setFilter<Entity>(
-    opName: string,
+    opSpec: { operation: string; Entity?: Class<Entity>; field?: keyof Entity | string },
     filter: CustomFilter<Entity>,
-    opts?: { klass: Class<Entity>; field?: keyof Entity | string },
   ): void {
-    if (opts && opts.klass && opts.field) {
-      const { klass, field } = opts;
-      if (!this.cfoRegistry.has(klass)) {
-        this.cfoRegistry.set(klass, {});
+    if (opSpec.Entity && opSpec.field) {
+      // (entity/class, field, operation) filter
+      const { Entity, field } = opSpec;
+      if (!this.cfoRegistry.has(Entity)) {
+        this.cfoRegistry.set(Entity, {});
       }
-      const klassFilters = this.cfoRegistry.get(klass) as EntityCustomFilters;
-      klassFilters[field] = merge(klassFilters[field], { [opName]: filter });
-    } else {
-      this.oRegistry[opName] = filter;
+      const entityFilters = this.cfoRegistry.get(Entity) as EntityCustomFilters;
+      entityFilters[field] = merge(entityFilters[field], { [opSpec.operation]: filter });
+    } else if (opSpec.operation) {
+      // (operation) filter
+      this.oRegistry[opSpec.operation] = filter;
     }
   }
 }