Allow <, <=, >=, > filter strings in Knex for date

TRUEPIC · Oct 22, 2020 · 9776f85 · 9776f85
1 parent ec7e850
commit 9776f85
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 20 deletions.
diff --git a/DOCS.md b/DOCS.md
@@ -166,10 +166,10 @@ That said, the default Knex adapter supports the following operators/values:
 - `=`: string, number, or boolean
 - `!=`: string, number, or boolean
 - `<>`: string, number, or boolean
-- `>`: number
-- `>=`: number
-- `<`: number
-- `<=`: number
+- `>`: string or number
+- `>=`: string or number
+- `<`: string or number
+- `<=`: string or number
 - `is`: `null`
 - `is not`: `null`
 - `in`: array of strings and/or numbers

diff --git a/src/adapters/knex.js b/src/adapters/knex.js
@@ -38,10 +38,10 @@ class KnexAdapter extends BaseAdapter {
       'filter:<>': schema
         .alternatives()
         .try(schema.boolean(), schema.number(), schema.string()),
-      'filter:>': schema.number(),
-      'filter:>=': schema.number(),
-      'filter:<': schema.number(),
-      'filter:<=': schema.number(),
+      'filter:>': schema.alternatives().try(schema.number(), schema.string()),
+      'filter:>=': schema.alternatives().try(schema.number(), schema.string()),
+      'filter:<': schema.alternatives().try(schema.number(), schema.string()),
+      'filter:<=': schema.alternatives().try(schema.number(), schema.string()),
       'filter:is': schema.any().valid(null),
       'filter:is not': schema.any().valid(null),
       'filter:in': schema.array().items(schema.number(), schema.string()),

diff --git a/test/src/adapters/knex.js b/test/src/adapters/knex.js
@@ -283,12 +283,18 @@ describe('validation', () => {
       expect(validator.validateValue('filter:>', 'test', 123)).toBe(true)
     })
 
+    test('permits a string value', () => {
+      const validator = new KnexAdapter().validator
+
+      expect(validator.validateValue('filter:>', 'test', 'valid')).toBe(true)
+    })
+
     test('throws for a non-permitted value', () => {
       const validator = new KnexAdapter().validator
 
-      expect(() =>
-        validator.validateValue('filter:>', 'test', 'invalid')
-      ).toThrow(new ValidationError('test must be a number'))
+      expect(() => validator.validateValue('filter:>', 'test', false)).toThrow(
+        new ValidationError('test must be one of [number, string]')
+      )
     })
   })
 
@@ -299,12 +305,18 @@ describe('validation', () => {
       expect(validator.validateValue('filter:>=', 'test', 123)).toBe(true)
     })
 
+    test('permits a string value', () => {
+      const validator = new KnexAdapter().validator
+
+      expect(validator.validateValue('filter:>=', 'test', 'valid')).toBe(true)
+    })
+
     test('throws for a non-permitted value', () => {
       const validator = new KnexAdapter().validator
 
-      expect(() =>
-        validator.validateValue('filter:>=', 'test', 'invalid')
-      ).toThrow(new ValidationError('test must be a number'))
+      expect(() => validator.validateValue('filter:>=', 'test', false)).toThrow(
+        new ValidationError('test must be one of [number, string]')
+      )
     })
   })
 
@@ -315,12 +327,18 @@ describe('validation', () => {
       expect(validator.validateValue('filter:<', 'test', 123)).toBe(true)
     })
 
+    test('permits a string value', () => {
+      const validator = new KnexAdapter().validator
+
+      expect(validator.validateValue('filter:<', 'test', 'valid')).toBe(true)
+    })
+
     test('throws for a non-permitted value', () => {
       const validator = new KnexAdapter().validator
 
-      expect(() =>
-        validator.validateValue('filter:<', 'test', 'invalid')
-      ).toThrow(new ValidationError('test must be a number'))
+      expect(() => validator.validateValue('filter:<', 'test', false)).toThrow(
+        new ValidationError('test must be one of [number, string]')
+      )
     })
   })
 
@@ -331,12 +349,18 @@ describe('validation', () => {
       expect(validator.validateValue('filter:<=', 'test', 123)).toBe(true)
     })
 
+    test('permits a string value', () => {
+      const validator = new KnexAdapter().validator
+
+      expect(validator.validateValue('filter:<=', 'test', 'valid')).toBe(true)
+    })
+
     test('throws for a non-permitted value', () => {
       const validator = new KnexAdapter().validator
 
-      expect(() =>
-        validator.validateValue('filter:<=', 'test', 'invalid')
-      ).toThrow(new ValidationError('test must be a number'))
+      expect(() => validator.validateValue('filter:<=', 'test', false)).toThrow(
+        new ValidationError('test must be one of [number, string]')
+      )
     })
   })