Merge pull request #257 from smartprocure/GS-8094/consistent-api

[GS-8094] feat: `step` type contract updated to use `min` and `max` instead of …

.changeset/seven-sheep-complain.md

@@ -0,0 +1,6 @@
+---
+'contexture-elasticsearch': major
+'contexture-client': major
+---
+
+`step` type contract updated to use `min` and `max` instead of `range` so it can be consistent with `number` type

packages/client/src/exampleTypes.js

@@ -190,12 +190,13 @@ export default F.stampKey('type', {
   step: {
     label: 'Number Slider',
     reactors: {
-      range: 'all',
+      min: 'all',
+      max: 'all',
     },
     defaults: {
       field: null,
-      range: [0, 1000],
-      steps: [0, 1000, 5000, 10000, 25000, 50000, 1000000],
+      min: 0,
+      max: null,
       context: {
         recordsCount: 0,
       },

packages/provider-elasticsearch/src/example-types/filters/step.js

@@ -1,40 +1,31 @@
 import _ from 'lodash/fp.js'
 import { pickSafeNumbers } from '../../utils/futil.js'
 
-const getMinAndMax = (range) => {
-  const min = range[0]
-  const max = range[range.length - 1]
-  return { min, max }
-}
-
-let filter = ({ field, range }) => {
-  const { min, max } = getMinAndMax(range)
-  return {
-    range: { [field]: pickSafeNumbers({ gte: min, lte: max }) },
-  }
-}
+let filter = ({ field, min, max }) => ({
+  range: { [field]: pickSafeNumbers({ gte: min, lte: max }) },
+})
 
-let buildQuery = (field, range) => {
+let buildQuery = (field, min, max) => {
   return {
     aggs: {
       rangeFilter: {
-        filter: filter({ field, range }),
+        filter: filter({ field, min, max }),
       },
     },
   }
 }
 
 let result = async (node, search) => {
-  let { field, range } = node
-  const result = await search(buildQuery(field, range))
+  let { field, min, max } = node
+  const result = await search(buildQuery(field, min, max))
   const recordsCount = result.aggregations.rangeFilter.doc_count
   return { recordsCount }
 }
 
 export default {
-  hasValue: ({ range }) => !_.isEmpty(range),
+  hasValue: ({ min }) => !_.isNil(min),
   filter,
-  validContext: ({ range }) => !_.isEmpty(range),
+  validContext: ({ min }) => !_.isNil(min),
   result,
   buildQuery,
 }

packages/provider-elasticsearch/src/example-types/filters/step.test.js

@@ -7,7 +7,8 @@ describe('step', () => {
   const input = {
     type: 'step',
     field: 'test',
-    range: [0, 500],
+    min: 0,
+    max: 500,
     steps: [0, 500, 1000],
   }
 
@@ -25,7 +26,8 @@ describe('step', () => {
   it('removes upper bound when upper bound is null', () => {
     const inputWithNewRange = {
       ...input,
-      range: [0, null],
+      min: 0,
+      max: null,
     }
     let expectedValue = { range: { test: { gte: 0 } } }
     expect(filter(inputWithNewRange)).toEqual(expectedValue)
@@ -39,7 +41,7 @@ describe('step', () => {
         },
       },
     }
-    let output = buildQuery(input.field, input.range)
+    let output = buildQuery(input.field, input.min, input.max)
     expect(output).toEqual(expectedDSL)
   })
 })