Merge pull request #223 from ghiscoding/feat/test-graphql-query-builder

feat(tests): add GraphqlQueryBuilder unit tests

Author: ghiscoding

src/app/modules/angular-slickgrid/global-grid-options.ts

@@ -106,7 +106,7 @@ export const GlobalGridOptions: GridOption = {
     saveDetailViewOnScroll: false,
 
     // the following 2 property/method should always be override by the user
-    process: () => new Promise((resolve) => resolve('')),
+    process: undefined,
     viewComponent: null
   },
   rowHeight: 35,

src/app/modules/angular-slickgrid/models/backendService.interface.ts

@@ -61,7 +61,8 @@ export interface BackendService {
   // -----------------
 
   /** Execute when any of the filters changed */
-  processOnFilterChanged: (event: Event, args: FilterChangedArgs) => Promise<string>;
+  // @deprecated return output should be string only not Promise
+  processOnFilterChanged: (event: Event, args: FilterChangedArgs) => string | Promise<string>;
 
   /** Execute when the pagination changed */
   processOnPaginationChanged: (event: Event | undefined, args: PaginationChangedArgs) => string;

src/app/modules/angular-slickgrid/models/backendServiceOption.interface.ts

@@ -8,10 +8,10 @@ export interface BackendServiceOption {
   /** What are the pagination options? ex.: (first, last, offset) */
   paginationOptions?: any;
 
-  /** array of Filtering Options, ex.: { field: name, operator: EQ, value: "John" }  */
+  /** array of Filtering Options, ex.: [{ field: 'firstName', operator: 'EQ', value: 'John' }] */
   filteringOptions?: any[];
 
-  /** array of Filtering Options, ex.: { field: name, direction: DESC }  */
+  /** array of Filtering Options, ex.: [{ field: 'firstName', direction: 'DESC' }] */
   sortingOptions?: any[];
 
   /** Execute the process callback command on component init (page load) */

src/app/modules/angular-slickgrid/models/column.interface.ts

@@ -47,7 +47,7 @@ export interface Column {
   /** Default to false, which leads to exclude the column title from the Grid Menu. */
   excludeFromGridMenu?: boolean;
 
-  /** Defaults to false, which leads to exclude the field from the query (mostly a backend service query) */
+  /** Defaults to false, which leads to exclude the field from the query (typically a backend service query) */
   excludeFromQuery?: boolean;
 
   /** Defaults to false, which leads to exclude the column from getting a header menu. For example, the checkbox row selection should not have a header menu. */

src/app/modules/angular-slickgrid/models/columnSort.interface.ts

@@ -1,7 +1,18 @@
 import { Column } from './column.interface';
 
 export interface ColumnSort {
+  /** SlickGrid grid object */
+  grid?: any;
+
+  /** Defaults to false, is it a multi-column sort? */
+  multiColumnSort?: boolean;
+
+  /** Column Id to be sorted */
   columnId?: string | number;
-  sortAsc?: boolean;
-  sortCol?: Column;
+
+  /** Are we sorting Ascending? */
+  sortAsc: boolean;
+
+  /** Column to be sorted */
+  sortCol: Column;
 }

src/app/modules/angular-slickgrid/models/filterChangedArgs.interface.ts

@@ -1,8 +1,15 @@
 import { SearchTerm } from './searchTerm.type';
+import { Column } from './column.interface';
 import { ColumnFilters } from './columnFilters.interface';
+import { OperatorType } from './operatorType.enum';
+import { OperatorString } from 'dist/public_api';
 
 export interface FilterChangedArgs {
+  clearFilterTriggered?: boolean;
+  columnDef: Column;
   columnFilters: ColumnFilters;
   grid: any;
+  operator: OperatorType | OperatorString;
   searchTerms: SearchTerm[];
+  shouldTriggerQuery?: boolean;
 }

src/app/modules/angular-slickgrid/models/graphqlFilteringOption.interface.ts

@@ -1,6 +1,8 @@
 import { OperatorType } from './operatorType.enum';
+import { OperatorString } from './operatorString';
+
 export interface GraphqlFilteringOption {
   field: string;
-  operator: OperatorType;
+  operator: OperatorType | OperatorString;
   value: any | any[];
 }

src/app/modules/angular-slickgrid/models/graphqlServiceOption.interface.ts

@@ -12,9 +12,6 @@ export interface GraphqlServiceOption extends BackendServiceOption {
    */
   addLocaleIntoQuery?: boolean;
 
-  /** Array of column ids that are included in the column definitions */
-  columnIds?: string[];
-
   /** What is the dataset, this is required for the GraphQL query to be built */
   datasetName?: string;
 

src/app/modules/angular-slickgrid/models/index.ts

@@ -79,6 +79,7 @@ export * from './headerMenuOnCommandArgs.interface';
 export * from './headerMenuOnBeforeMenuShowArgs.interface';
 export * from './htmlElementPosition.interface';
 export * from './keyCode.enum';
+export * from './multiColumnSort.interface';
 export * from './multipleSelectOption.interface';
 export * from './odataOption.interface';
 export * from './onEventArgs.interface';

src/app/modules/angular-slickgrid/models/multiColumnSort.interface.ts

@@ -0,0 +1,12 @@
+import { ColumnSort } from './columnSort.interface';
+
+export interface MultiColumnSort {
+  /** SlickGrid grid object */
+  grid?: any;
+
+  /** Defaults to false, is it a multi-column sort? */
+  multiColumnSort?: boolean;
+
+  /** Array of Columns to be sorted */
+  sortCols: ColumnSort[];
+}

src/app/modules/angular-slickgrid/models/operatorString.ts

@@ -1 +1 @@
-export type OperatorString = '' | '<>' | '!=' | '=' | '==' | '>' | '>=' | '<' | '<=' | '*' | 'a*' | '*z' | 'EQ' | 'GE' | 'GT' | 'NE' | 'LE' | 'LT' | 'IN' | 'NIN' | 'NOT_IN' | 'IN_CONTAINS' | 'NIN_CONTAINS' | 'NOT_IN_CONTAINS';
+export type OperatorString = '' | '<>' | '!=' | '=' | '==' | '>' | '>=' | '<' | '<=' | '*' | 'a*' | '*z' | 'EQ' | 'GE' | 'GT' | 'NE' | 'LE' | 'LT' | 'IN' | 'NIN' | 'NOT_IN' | 'IN_CONTAINS' | 'NIN_CONTAINS' | 'NOT_IN_CONTAINS' | 'endsWith' | 'startsWith';

src/app/modules/angular-slickgrid/models/sortChangedArgs.interface.ts

@@ -1,6 +1,7 @@
+/** @deprecated to be replaced in the future by ColumnSort | MultiColumnSort */
 export interface SortChangedArgs {
   multiColumnSort?: boolean;
-  sortAsc: boolean;
+  sortAsc?: boolean;
   sortCol?: any;
   sortCols?: any[];
 }