feat: range queries

Author: przemyslawwalczak

src/lib/queries/get-bool.spec.ts

@@ -1,6 +1,7 @@
 import { faker } from '@faker-js/faker'
 import { HomeDocument, PropertyType } from 'test/module'
 import { getBoolQuery } from './get-bool'
+import { getRangeQuery } from './get-range'
 import { getTermQuery } from './get-term'
 import { getTermsQuery } from './get-terms'
 
@@ -16,6 +17,10 @@ describe('getBoolQuery', () => {
                     must: {
                         term: { address: { value: 'test' } }
                     }
+                }),
+                getRangeQuery('propertyAreaSquared', {
+                    gte: 500,
+                    lte: 1000
                 })
             ]
         })
@@ -30,6 +35,11 @@ describe('getBoolQuery', () => {
                         bool: {
                             must: { term: { address: { value: 'test' } } }
                         }
+                    },
+                    {
+                        range: {
+                            propertyAreaSquared: { gte: 500, lte: 1000 }
+                        }
                     }
                 ]
             }

src/lib/queries/get-must.ts

@@ -2,8 +2,9 @@ import { Document } from 'lib/types'
 import { TermQuery } from './get-term'
 import { TermsQuery } from './get-terms'
 import { BoolQuery } from './get-bool'
+import { RangeQuery } from './get-range'
 
-export type MustQueryBody<TDocument extends Document> = TermQuery<TDocument> | TermsQuery<TDocument> | BoolQuery<TDocument>
+export type MustQueryBody<TDocument extends Document> = BoolQuery<TDocument> | TermQuery<TDocument> | TermsQuery<TDocument> | RangeQuery<TDocument>
 
 export type MustQuery<TDocument extends Document> = {
     must?: MustQueryBody<TDocument> | Array<MustQueryBody<TDocument>>

src/lib/queries/get-range.spec.ts

@@ -0,0 +1,16 @@
+import { getRangeQuery } from './get-range'
+
+describe('getRangeQuery', () => {
+    it('accepts optional term queries', () => {
+        const query = getRangeQuery('propertyAreaSquared', {
+            gte: 150,
+            lte: 250
+        })
+
+        expect(query).toEqual({
+            range: {
+                propertyAreaSquared: { gte: 150, lte: 250 }
+            }
+        })
+    })
+})

src/lib/queries/get-range.ts

@@ -0,0 +1,34 @@
+import { Document, Keyword, KeywordType } from 'lib/types'
+
+export type RangeQueryOptions<
+    TDocument extends Document,
+    TKeyword extends Keyword<TDocument> = Keyword<TDocument>
+> = {
+    gt?: KeywordType<TDocument, TKeyword>
+    gte?: KeywordType<TDocument, TKeyword>
+    lt?: KeywordType<TDocument, TKeyword>
+    lte?: KeywordType<TDocument, TKeyword>
+}
+
+export type RangeQueryBody<
+    TDocument extends Document,
+    TKeyword extends Keyword<TDocument> = Keyword<TDocument>
+> = {
+    [x in TKeyword]?: RangeQueryOptions<TDocument, TKeyword>
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type RangeQuery<
+    TDocument extends Document,
+    TKeyword extends Keyword<TDocument> = Keyword<TDocument>
+> = {
+    range: RangeQueryBody<TDocument, TKeyword>
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const getRangeQuery = <
+    TDocument extends Document,
+    TKeyword extends Keyword<TDocument> = Keyword<TDocument>
+>(field: TKeyword, options: RangeQueryOptions<TDocument, TKeyword>): RangeQuery<TDocument, TKeyword> => ({
+    range: { [field]: options } as RangeQueryBody<TDocument, TKeyword>
+})

src/lib/queries/get-should.ts

@@ -2,8 +2,9 @@ import { Document } from 'lib/types'
 import { TermQuery } from './get-term'
 import { TermsQuery } from './get-terms'
 import { BoolQuery } from './get-bool'
+import { RangeQuery } from './get-range'
 
-export type ShouldQueryBody<TDocument extends Document> = TermQuery<TDocument> | TermsQuery<TDocument> | BoolQuery<TDocument>
+export type ShouldQueryBody<TDocument extends Document> = BoolQuery<TDocument> | TermQuery<TDocument> | TermsQuery<TDocument> | RangeQuery<TDocument>
 
 export type ShouldQuery<TDocument extends Document> = {
     should?: ShouldQueryBody<TDocument> | Array<ShouldQueryBody<TDocument>>

src/lib/queries/get-term.spec.ts

@@ -1,9 +1,8 @@
-import { HomeDocument } from 'test/module'
 import { getTermQuery } from './get-term'
 
 describe('getTermQuery', () => {
     it('accepts only schema fields', () => {
-        const query = getTermQuery<HomeDocument>('address', 'test')
+        const query = getTermQuery('address', 'test')
 
         expect(query).toEqual({
             term: {

src/lib/queries/get-terms.spec.ts

@@ -1,9 +1,8 @@
-import { HomeDocument } from 'test/module'
 import { getTermsQuery } from './get-terms'
 
 describe('getTermsQuery', () => {
     it('accepts only schema fields', () => {
-        const query = getTermsQuery<HomeDocument>('address', ['one', 'two', 'three'])
+        const query = getTermsQuery('address', ['one', 'two', 'three'])
 
         expect(query).toEqual({
             terms: {