added new query operators and possibility to define custom operator functions

Author: noxify

README.md

@@ -28,7 +28,7 @@
     - [Get all incidents - Simple](#get-all-incidents---simple)
     - [Get all incidents - Advanced](#get-all-incidents---advanced)
   - [GraphQL filters](#graphql-filters)
-    - [Example](#example)
+    - [Examples](#examples)
   - [GraphQL Paging & Sorting](#graphql-paging--sorting)
     - [Example - Paging](#example---paging)
     - [Example - Sorting](#example---sorting)
@@ -517,15 +517,23 @@ Currently only the following filter operators are allowed:
 | eq               | =                   |
 | ne               | !=                  |
 | in               | IN                  |
-
-You can easily extend the operators to add operators like `lte`, `lt`, `gt`, `gte`.
-
+| nin              | NOT IN              |
+| lt               | <                   |
+| lte              | <=                  |
+| gt               | >                   |
+| gte              | >=                  |
+| between          | BETWEEN             |
+
+You can easily extend the query operators
 To do this, you have to 
-1. extend the `generateQuery` method
+1. extend the `operators` definition in the `initialize` method
+   - here you can decide between 
+     - the default value transformation (e.g. converting `[A,B]` to `A,B`)
+     - or define your own logic which returns the needed the query part 
 2. create new inputs in the GraphQL schema
 3. update the `IncidentQueryFilter` with the new searchable fields ( like `openedAt` )
 
-### Example
+### Examples
 
 * Use `allIncident` to find all incidents with state `NEW`(=1) and urgency `LOW` (=3):
 
@@ -539,6 +547,17 @@ allIncident(filter:{state:{eq:NEW}, urgency: {eq:LOW}})
 allIncident(filter:{state:{in:[NEW, IN_PROGRESS]}, urgency: {in:[LOW, HIGH]}})
 ```
 
+* Use `allIncident` to find all incidents which have state `NEW` or `IN_PROGRESS` but the urgency is not `LOW` or `HIGH`
+
+```
+allIncident(filter:{state:{in:[NEW, IN_PROGRESS]}, urgency: {nin:[LOW, HIGH]}})
+```
+
+* Use `allIncident` to get all incidents between `INC0010000` and `INC0010010`
+
+```
+allIncident(filter:{number:{between:{from:"INC0010000", to: "INC0010010"}}})
+```
 
 ## GraphQL Paging & Sorting
 

files/GraphQL Schema/Example.schema.gql

@@ -3,14 +3,17 @@ schema {
 }
 
 type Query {
-	allIncident(filter:IncidentQueryFilter, paginate: QueryPaginate, sort: QuerySort): IncidentResultList
-	incident(number: String!): Incident
+  allIncident(
+    filter: IncidentQueryFilter
+    paginate: QueryPaginate
+    sort: QuerySort
+  ): IncidentResultList
+  incident(number: String!): Incident
 }
 
-
 type Incident {
   id: ID!
-	number: String!
+  number: String!
   active: Boolean
   state: IncidentState @source(value: "state.value")
   priority: IncidentPriority @source(value: "priority.value")
@@ -19,16 +22,17 @@ type Incident {
   description: String
   resolvedBy: User @source(value: "resolvedBy.value")
   openedBy: User @source(value: "openedBy.value")
-  openedAt(format:String): String @source(value: "openedAt.value")
-  resolvedAt(format:String): String @source(value: "resolvedAt.value")
-  closedAt(format:String): String @source(value: "closedAt.value")
+  openedAt(format: String): String @source(value: "openedAt.value")
+  resolvedAt(format: String): String @source(value: "resolvedAt.value")
+  closedAt(format: String): String @source(value: "closedAt.value")
   parentIncident: Incident @source(value: "parentIncident.value")
-  childIncidents(filter:IncidentQueryFilter): IncidentResultList @source(value: "childIncidents.value")
+  childIncidents(filter: IncidentQueryFilter): IncidentResultList
+  @source(value: "childIncidents.value")
 }
 
 type User {
-	id: String
-	email: String
+  id: String
+  email: String
 }
 
 type IncidentResultList {
@@ -49,11 +53,11 @@ input QueryPaginate {
 
 input QuerySort {
   by: String!
-  order:SortOrder
+  order: SortOrder
 }
 
 input IncidentQueryFilter {
-  number: StringQueryOperatorInput
+  number: IncidentNumberOperatorInput
   state: IncidentStateOperatorInput
   contactType: IncidentContactTypeOperatorInput
   impact: IncidentImpactOperatorInput
@@ -125,6 +129,26 @@ input StringQueryOperatorInput {
   in: [String]
 }
 
+input StringBetweenQueryFilter {
+  from: String!
+  to: String!
+}
+
+input IncidentNumberOperatorInput {
+  # Filter by property of (strict) equality.
+  eq: String
+  # Filter by property not equal to provided value.
+  ne: String
+  # Filter by property matching any of the provided values.
+  in: [String]
+  nin: [String]
+  lte: String
+  lt: String
+  gt: String
+  gte: String
+  between: StringBetweenQueryFilter
+}
+
 input IncidentStateOperatorInput {
   # Filter by property of (strict) equality.
   eq: IncidentState
@@ -141,6 +165,7 @@ input IncidentContactTypeOperatorInput {
   ne: IncidentContactType
   # Filter by property matching any of the provided values.
   in: [IncidentContactType]
+  nin: [String]
 }
 
 input IncidentUrgencyOperatorInput {
@@ -150,6 +175,7 @@ input IncidentUrgencyOperatorInput {
   ne: IncidentUrgency
   # Filter by property matching any of the provided values.
   in: [IncidentUrgency]
+  nin: [String]
 }
 
 input IncidentImpactOperatorInput {
@@ -159,6 +185,7 @@ input IncidentImpactOperatorInput {
   ne: IncidentImpact
   # Filter by property matching any of the provided values.
   in: [IncidentImpact]
+  nin: [String]
 }
 
 input IncidentPriorityOperatorInput {
@@ -168,4 +195,5 @@ input IncidentPriorityOperatorInput {
   ne: IncidentPriority
   # Filter by property matching any of the provided values.
   in: [IncidentPriority]
-}
+  nin: [String]
+}

files/Script Include/GraphQLExampleUtilities.script.js

@@ -50,8 +50,7 @@ GraphQLExampleUtilities.prototype = {
       }
     };
 
-    //Mapping which will be used as graphl
-    //response
+    //Mapping which will be used as graphl response
     this.mapping = {
       incident: {
         id: { display: false, useQuery: false, field: 'sys_id' },
@@ -76,8 +75,7 @@ GraphQLExampleUtilities.prototype = {
       }
     };
 
-    //Definition for the value replacement
-    //e.g. the GQL enums 
+    //Definition for the value replacement e.g. the GQL enums 
     this.queryBuilder = {
       incident: {
         state: {
@@ -118,7 +116,15 @@ GraphQLExampleUtilities.prototype = {
     this.operators = {
       'eq': '=',
       'ne': '!=',
-      'in': 'IN'
+      'in': 'IN',
+      'nin': 'NOT IN',
+      'lt': '<',
+      'lte': '<=',
+      'gt': '>',
+      'gte': '>=',
+      'between': function (field, value) {
+        return field + 'BETWEEN' + value.from + '@' + value.to;
+      }
     };
   },
 
@@ -143,8 +149,14 @@ GraphQLExampleUtilities.prototype = {
       var targetField = (that.mapping[ module ][ field ]) ? that.mapping[ module ][ field ].field : field;
 
       return _.map(definition, function (value, op) {
-        value = that.convertQueryValue(module, field, value);
-        return targetField + that.operators[ op ] + value;
+        //check if the current operator is a function
+        if (_.isFunction(that.operators[ op ])) {
+          return that.operators[ op ](targetField, value);
+        } else {
+          //if not, run the default behavior
+          value = that.convertQueryValue(module, field, value);
+          return targetField + that.operators[ op ] + value;
+        }
       });
     });