Merge pull request #215 from devforth/enhance-filter-methods

feat: update Filters methods to accept variable arguments for improve…

Author: ivictbor

adminforth/documentation/blog/2025-04-10-how-to-translate-dynamic-strings/index.md

@@ -234,13 +234,13 @@ You can mitigate this by adding couple of lines into edit hook:
        //diff-add
         const oldStrings = await adminforth.resource('translations').list([
        //diff-add
-            Filters.AND([
+            Filters.AND(
        //diff-add
               Filters.EQ('category', 'seo_page_config'),
        //diff-add
               Filters.IN('en_string', Object.keys(updates).map((key: string) => oldRecord[key]))
        //diff-add
-            ])
+            )
        //diff-add
           ]);
        //diff-add

adminforth/documentation/docs/tutorial/03-Customization/03-virtualColumns.md

@@ -99,11 +99,11 @@ hooks: {
         // replace apartment_type filter with complex one
         if (filter.field === 'apartment_type') {
           if (filter.value === 'luxury') {
-            return Filters.OR([Filters.GTE('square_meter', 80), Filters.GTE('price', 100000)]);
+            return Filters.OR(Filters.GTE('square_meter', 80), Filters.GTE('price', 100000));
           }
 
           // filter for "base" apartment as default
-          return Filters.AND([Filters.LT('square_meter', 80), Filters.LT('price', 100000)]);
+          return Filters.AND(Filters.LT('square_meter', 80), Filters.LT('price', 100000));
         }
 
         return filter;

adminforth/documentation/docs/tutorial/03-Customization/11-dataApi.md

@@ -25,7 +25,7 @@ const admin = new AdminForth({
 });
 
 // get the resource object
-await admin.resource('adminuser').get([Filters.EQ('id', '1234')]);
+await admin.resource('adminuser').get(Filters.EQ('id', '1234'));
 ```
 
 Here we will show you how to use the Data API with simple examples.
@@ -37,7 +37,7 @@ Signature:
 
 ```ts
 .get(
-  filters: [],
+  filters: <AdminForthFilterObject>,
 ): Promise<any>
 ```
 
@@ -62,7 +62,8 @@ Get user with name 'John' and role not 'SuperAdmin'
 
 ```ts
 const user = await admin.resource('adminuser').get(
-  [Filters.EQ('name', 'John'), Filters.NEQ('role', 'SuperAdmin')]
+  Filters.EQ('name', 'John'), 
+  Filters.NEQ('role', 'SuperAdmin')
 );
 ```
 
@@ -73,7 +74,7 @@ Signature:
 
 ```ts
 .list(
-  filters: [],
+  filters: <AdminForthFilterObject>,
   limit: number | null
   offset: number | null
   sort: []
@@ -112,13 +113,13 @@ Get all users that have gmail address AND the ones created not in 2024
 
 ```ts
 const users = await admin.resource('adminuser').list(
-  Filters.AND([
+  Filters.AND(
     Filters.LIKE('email', '@gmail.com'),
-    Filters.OR([
+    Filters.OR(
       Filters.LT('createdAt', '2024-01-01T00:00:00.000Z'),
       Filters.GTE('createdAt', '2025-01-01T00:00:00.000Z'),
-    ]),
-  ])
+    ),
+  )
 );
 ```
 
@@ -150,16 +151,16 @@ Signature:
 
 ```ts
 .count(
-  filters: [],
-): Promise<number>
+  filters: <AdminForthFilterObject>,
+): Promise<any>
 ```
 
 Returns number of items in database which match the filters.
 
 Count number of schools with rating above 4:
 
 ```ts
-const schoolsCount = await admin.resource('schools').count([Filters.GT('rating', 4)]);
+const schoolsCount = await admin.resource('schools').count(Filters.GT('rating', 4));
 ```
 
 Create data for daily report with number of users signed up daily for last 7 days:

adminforth/types/Back.ts

@@ -1100,11 +1100,31 @@ export class Filters {
   static LIKE(field: string, value: any): IAdminForthSingleFilter {
     return { field, operator: AdminForthFilterOperators.LIKE, value };
   }
-  static AND(subFilters: Array<IAdminForthSingleFilter | IAdminForthAndOrFilter>): IAdminForthAndOrFilter {
-    return { operator: AdminForthFilterOperators.AND, subFilters };
+  static AND(
+    ...args: (IAdminForthSingleFilter | IAdminForthAndOrFilter | Array<IAdminForthSingleFilter | IAdminForthAndOrFilter>)[]
+  ): IAdminForthAndOrFilter {
+    const subFilters =
+      args.length === 1 && Array.isArray(args[0])
+        ? args[0]
+        : args as Array<IAdminForthSingleFilter | IAdminForthAndOrFilter>;
+  
+    return {
+      operator: AdminForthFilterOperators.AND,
+      subFilters,
+    };
   }
-  static OR(subFilters: Array<IAdminForthSingleFilter | IAdminForthAndOrFilter>): IAdminForthAndOrFilter {
-    return { operator: AdminForthFilterOperators.OR, subFilters };
+  static OR(
+    ...args: (IAdminForthSingleFilter | IAdminForthAndOrFilter | Array<IAdminForthSingleFilter | IAdminForthAndOrFilter>)[]
+  ): IAdminForthAndOrFilter {
+    const subFilters =
+      args.length === 1 && Array.isArray(args[0])
+        ? args[0]
+        : args as Array<IAdminForthSingleFilter | IAdminForthAndOrFilter>;
+  
+    return {
+      operator: AdminForthFilterOperators.OR,
+      subFilters,
+    };
   }
 }