feat: field keywords with type infering

Author: przemyslawwalczak

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

@@ -9,11 +9,10 @@ describe('getBoolQuery', () => {
         const id = faker.string.uuid()
         const query = getBoolQuery<HomeDocument>({
             should: [
+                getTermQuery('id.keyword', id),
                 getTermQuery('id', id),
                 getTermsQuery('propertyType', [PropertyType.Apartment]),
-                getBoolQuery<HomeDocument>({
-                //          ^
-                // note: weird bug when Generic Type is not being passed
+                getBoolQuery({
                     must: {
                         term: { address: { value: 'test' } }
                     }
@@ -24,6 +23,7 @@ describe('getBoolQuery', () => {
         expect(query).toEqual({
             bool: {
                 should: [
+                    { term: { 'id.keyword': { value: id } } },
                     { term: { id: { value: id } } },
                     { terms: { propertyType: [PropertyType.Apartment] } },
                     {

src/lib/queries/get-term.ts

@@ -1,16 +1,24 @@
-import { Document, Field, FieldType, Keyword } from 'lib/types'
+import { Document, Keyword, KeywordType } from 'lib/types'
 
-export type TermQueryBody<TDocument extends Document, TField extends Field<TDocument>> = {
-    [Key in keyof TDocument]?: { value: FieldType<TDocument, TField> }
+export type TermQueryBody<
+    TDocument extends Document,
+    TKeyword extends Keyword<TDocument> = Keyword<TDocument>
+> = {
+    [x in TKeyword]?: { value: KeywordType<TDocument, TKeyword> }
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type TermQuery<TDocument extends Document, TField extends Field<TDocument> = keyof TDocument> = {
-    term: TermQueryBody<TDocument, TField>
+export type TermQuery<
+    TDocument extends Document,
+    TKeyword extends Keyword<TDocument> = Keyword<TDocument>
+> = {
+    term: TermQueryBody<TDocument, TKeyword>
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const getTermQuery = <TDocument extends Document, TField extends keyof TDocument = keyof TDocument>
-(field: Keyword<TDocument, TField>, value: FieldType<TDocument, TField>): TermQuery<TDocument, TField> => ({
-    term: { [field]: { value } } as TermQueryBody<TDocument, TField>
+export const getTermQuery = <
+    TDocument extends Document,
+    TKeyword extends Keyword<TDocument> = Keyword<TDocument>
+>(field: TKeyword, value: KeywordType<TDocument, TKeyword>): TermQuery<TDocument, TKeyword> => ({
+    term: { [field]: { value } } as TermQueryBody<TDocument, TKeyword>
 })

src/lib/queries/get-terms.ts

@@ -1,16 +1,24 @@
-import { Document, Field, FieldType, Keyword } from 'lib/types'
+import { Document, Field, FieldType, Keyword, KeywordType } from 'lib/types'
 
-type TermsQueryBody<TDocument extends Document, TField extends Field<TDocument>> = {
-    [Key in keyof TDocument]: Array<FieldType<TDocument, TField>>
+type TermsQueryBody<
+    TDocument extends Document,
+    TKeyword extends Keyword<TDocument> = Keyword<TDocument>
+> = {
+    [x in TKeyword]?: Array<KeywordType<TDocument, TKeyword>>
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type TermsQuery<TDocument extends Document, TField extends Field<TDocument> = keyof TDocument> = {
-    terms: TermsQueryBody<TDocument, TField>
+export type TermsQuery<
+    TDocument extends Document,
+    TKeyword extends Keyword<TDocument> = Keyword<TDocument>
+> = {
+    terms: TermsQueryBody<TDocument, TKeyword>
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const getTermsQuery = <TDocument extends Document, TField extends Field<TDocument> = keyof TDocument>
-(field: Keyword<TDocument, TField>, values: Array<FieldType<TDocument, TField>>): TermsQuery<TDocument, TField> => ({
-    terms: { [field]: values } as TermsQueryBody<TDocument, TField>
+export const getTermsQuery = <
+    TDocument extends Document,
+    TKeyword extends Keyword<TDocument> = Keyword<TDocument>
+>(field: TKeyword, values: Array<KeywordType<TDocument, TKeyword>>): TermsQuery<TDocument, TKeyword> => ({
+    terms: { [field]: values } as TermsQueryBody<TDocument, TKeyword>
 })

src/lib/types/common.ts

@@ -5,5 +5,7 @@ export type ClassConstructor<T> = new (...args: Array<any>) => T
 export type Document = Record<string, any>
 
 export type Field<TDocument extends Document> = keyof TDocument
-export type FieldType<TDocument extends Document, TKey extends Field<TDocument>> = TKey extends Field<TDocument> ? TDocument[TKey] : never
-export type Keyword<TDocument extends Document, TField extends Field<TDocument>> = TField | `${TField & string}.keyword`
+export type FieldType<TDocument extends Document, TField extends Field<TDocument>> = TDocument[TField]
+export type Keyword<TDocument extends Document> = (Field<TDocument> & string) | `${Field<TDocument> & string}.keyword`
+export type KeywordFields<TDocument extends Document> = { [K in keyof TDocument as K | `${K & string}.keyword`]: TDocument[K] }
+export type KeywordType<TDocument extends Document, TKeyword extends Keyword<TDocument>> = KeywordFields<TDocument>[TKeyword]