Add support for groupBy argument

Author: antas-marcin

src/graphql/getter.test.ts

@@ -1311,3 +1311,22 @@ warm`,
     expect(mockClient.query).toHaveBeenCalledWith(expectedQuery);
   });
 });
+
+describe('groupBy valid searchers', () => {
+  const mockClient: any = {
+    query: jest.fn(),
+  };
+
+  test('valid groupBy', () => {
+    const groupByQuery = `(groupBy:{path:["property"],groups:2,objectsPerGroup:3})`;
+    const expectedQuery = `{Get{Person` + groupByQuery + `{name}}}`;
+
+    new Getter(mockClient)
+      .withClassName('Person')
+      .withFields('name')
+      .withGroupBy({ path: ['property'], groups: 2, objectsPerGroup: 3 })
+      .do();
+
+    expect(mockClient.query).toHaveBeenCalledWith(expectedQuery);
+  });
+});

src/graphql/getter.ts

@@ -13,6 +13,7 @@ import { CommandBase } from '../validation/commandBase';
 import { WhereFilter } from '../openapi/types';
 import { GenerateArgs, GraphQLGenerate } from './generate';
 import { ConsistencyLevel } from '../data';
+import GroupBy, { GroupByArgs } from './groupBy';
 
 export default class GraphQLGetter extends CommandBase {
   private after?: string;
@@ -33,6 +34,7 @@ export default class GraphQLGetter extends CommandBase {
   private whereString?: string;
   private generateString?: string;
   private consistencyLevel?: ConsistencyLevel;
+  private groupByString?: string;
 
   constructor(client: Connection) {
     super(client);
@@ -183,6 +185,15 @@ export default class GraphQLGetter extends CommandBase {
     return this;
   };
 
+  withGroupBy = (args: GroupByArgs) => {
+    try {
+      this.groupByString = new GroupBy(args).toString();
+    } catch (e: any) {
+      this.addError(e.toString());
+    }
+    return this;
+  };
+
   validateIsSet = (prop: string | undefined | null, name: string, setter: string) => {
     if (prop == undefined || prop == null || prop.length == 0) {
       this.addError(`${name} must be set - set with ${setter}`);
@@ -267,6 +278,10 @@ export default class GraphQLGetter extends CommandBase {
       args = [...args, `consistencyLevel:${this.consistencyLevel}`];
     }
 
+    if (this.groupByString) {
+      args = [...args, `groupBy:${this.groupByString}`];
+    }
+
     if (args.length > 0) {
       params = `(${args.join(',')})`;
     }

src/graphql/groupBy.ts

@@ -0,0 +1,31 @@
+export interface GroupByArgs {
+  path: string[];
+  groups: number;
+  objectsPerGroup: number;
+}
+
+export default class GraphQLGroupBy {
+  private args: GroupByArgs;
+
+  constructor(args: GroupByArgs) {
+    this.args = args;
+  }
+
+  toString() {
+    let parts: string[] = [];
+
+    if (this.args.path) {
+      parts = [...parts, `path:${JSON.stringify(this.args.path)}`];
+    }
+
+    if (this.args.groups) {
+      parts = [...parts, `groups:${this.args.groups}`];
+    }
+
+    if (this.args.objectsPerGroup) {
+      parts = [...parts, `objectsPerGroup:${this.args.objectsPerGroup}`];
+    }
+
+    return `{${parts.join(',')}}`;
+  }
+}