@go-mailer/jarvis 3.2.11 → 3.3.0

package/README.md

@@ -224,6 +224,22 @@ Keywords in request queries are used to prepare the following queries. Given the
     ```
     GET https://go-mailer.com?group_by=age
     ```
+7. **boolean**: To return items that match the query for boolean fields, the `bool` keyword is used. pre-pending the minus (-) signto the name of the field would evaluate that field to `false` and vice-versa.
+
+    ```
+    GET https://go-mailer.com?bool=age,-name
+    
+    // evaluates to:
+    { age: true, name: false }
+    ```
+8. **exists**: To return items based on the existence of certain fields, the `exists` keyword is used. Prepend the minus (-) sign to achieve the opposite.
+
+    ```
+    GET https://go-mailer.com?exists=age,-state
+    
+    // evaluates to
+    { age: { $exists: true }, state: { $exists: false } }
+    ```
 
 ### **Special Characters**
 The use of special characters in query values indicate the need to prepare the following queries:

package/lib/query.js

@@ -2,14 +2,29 @@ const buildQuery = (options) => {
   const sort_condition = options.sort_by ? buildSortOrderString(options.sort_by) : ''
   const fields_to_return = options.return_only ? buildReturnFieldsString(options.return_only) : ''
   const count = options.count || false
-  const seek_conditions = options.bool ? { ...buildBooleanQuery(options.bool || '') } : {}
   const group_by = options.group_by || null
+  
+  let seek_conditions = {}
+  if (options.bool){
+    seek_conditions = {
+      ...seek_conditions,
+      ...buildBooleanQuery(options.bool || '')
+    }
+  }
+
+  if (options.exists) {
+    seek_conditions = { 
+      ...seek_conditions,
+      ...buildExistsQuery(options.exists || '')
+    }
+  }
 
   const { skip, limit } = determinePagination(options.page, options.population)
 
   /** Delete sort and return fields */
   delete options.bool
   delete options.count
+  delete options.exists
   delete options.group_by
   delete options.page
   delete options.population
@@ -72,6 +87,23 @@ const buildBooleanQuery = (value) => {
   }, {})
 }
 
+const buildExistsQuery = (value) => {
+  const values = value.split(',')
+  return values.reduce((sac, val) => {
+    let truthiness = true
+    let key = val
+    if (val[0] === '-') {
+      truthiness = false
+      key = val.substr(1)
+    }
+
+    return {
+      ...sac,
+      [key]: { $exists: truthiness }
+    }
+  }, {})
+}
+
 const buildInQuery = (value) => {
   const values = value.split(':')
   return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@go-mailer/jarvis",
-  "version": "3.2.11",
+  "version": "3.3.0",
   "main": "index.js",
   "repository": "git@github.com:go-mailer-ltd/jarvis-node.git",
   "author": "Nathan Oguntuberu <nateoguns.work@gmail.com>",