Add aggregates support to FindOptions

Author: leandrogehlen

src/DataStore.ts

@@ -7,6 +7,13 @@ export type SearchField = string | { [name: string]: SearchFieldType };
 export type FindScope = { [name: string]: (string | number)[] };
 export type FindResult<T> = { data: T[]; totalCount?: number };
 
+export type Aggregate = {
+  type: string;
+  selector: string;
+  field?: string;
+  filters?: any[];
+};
+
 export type MediaParams = Record<string, string | number | Blob> & {
   name: string;
   type: string;
@@ -29,6 +36,7 @@ export interface Group {
 export interface FindOptions {
   filter?: any[];
   scopes?: FindScope;
+  aggregates?: Aggregate[];
   search?: string | number;
   skip?: number;
   limit?: number;

src/transformers/OrionFindTransformer.ts

@@ -121,6 +121,8 @@ export class OrionFindTransformer implements Transformer<FindOptions> {
       only_trashed: onlyTrashed ? onlyTrashed[2] === true : null,
     };
 
+    const filters = this.buildFilter(data.filter);
+
     const sort = data.sort?.map((order: any) => ({
       field: order.selector,
       direction: order.desc ? 'desc' : 'asc',
@@ -131,12 +133,23 @@ export class OrionFindTransformer implements Transformer<FindOptions> {
       parameters: Array.isArray(value) ? value : [value],
     }));
 
-    const filters = this.buildFilter(data.filter);
+    const aggregates = data.aggregates?.map((item) =>
+      omitBy(
+        {
+          type: item.type,
+          relation: item.selector,
+          field: item.field,
+          filters: this.buildFilter(item.filters),
+        },
+        isNil,
+      ),
+    );
 
     const body = {
       sort,
       scopes,
       filters,
+      aggregates,
       search: data.search ? { value: this.formatLike(data.search) } : null,
       [this.paramNames.group]: data.group?.map((group) => group.selector),
     };

tests/transformers/OrionFindTransformer.spec.ts

@@ -36,6 +36,7 @@ describe('Orion - FindTransformer', () => {
       scopes: {
         whereCategory: [1],
       },
+      aggregates: [{ type: 'exists', selector: 'tags' }],
       params: {
         pagination: 0,
       },
@@ -59,6 +60,7 @@ describe('Orion - FindTransformer', () => {
           ],
         },
       ],
+      aggregates: [{ type: 'exists', relation: 'tags' }],
       scopes: [{ name: 'whereCategory', parameters: [1] }],
       search: { value: '%loren%ipsum%dolor%' },
       group: ['city'],