chore: added support of a keyword for terms

Author: przemyslawwalczak

package.json

@@ -7,13 +7,12 @@
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "scripts": {
-        "tsc": "node node_modules/typescript/bin/tsc",
-        "test": "jest --config=./jest.config.json",
+        "test": "jest --config=./jest.config.json --pathPattern=src/*",
         "build:package": "yarn tsc --declaration --project tsconfig.build.json",
         "build:replace-tspaths": "yarn tscpaths -p tsconfig.build.json -s ./src -o ./dist",
         "build": "rimraf dist && yarn build:package && yarn build:replace-tspaths",
         "generate:random-data": "yarn ts-node ./src/test/scripts/generate-random-data.ts",
-        "es:seed": "yarn ts-node ./src/test/scripts/es-seed.ts"
+        "es:seed": "yarn ts-node --project tsconfig.json ./src/test/scripts/es-seed.ts"
     },
     "keywords": [
         "nestjs",
@@ -30,6 +29,9 @@
     },
     "devDependencies": {
         "@faker-js/faker": "^8.1.0",
+        "@nestjs/core": "10.2.7",
+        "@nestjs/platform-express": "10.2.7",
+        "@nestjs/testing": "10.2.7",
         "@propertyguru/eslint-config-propertyguru": "1.9.0",
         "@types/jest": "29.5.5",
         "@types/node": "20.8.0",
@@ -54,8 +56,11 @@
         "jest": "29.7.0",
         "prettier": "3.0.3",
         "rimraf": "5.0.1",
+        "rxjs": "7.8.1",
+        "supertest": "6.3.3",
         "ts-jest": "29.1.1",
         "ts-node": "10.9.1",
+        "tsconfig-paths": "4.2.0",
         "tscpaths": "0.0.9",
         "typescript": "5.2.2"
     }

src/lib/elasticsearch/request.ts

@@ -6,7 +6,8 @@ export type SearchOptions<TDocument extends Document> = {
     body?: SearchRequestBody<TDocument>
 }
 
-export type SearchRequest = {
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export type SearchRequest<TDocument extends Document> = {
     index: string
 }
 
@@ -16,7 +17,7 @@ export type SearchRequestBody<TDocument extends Document> = {
     aggregations?: Record<string, any>
 }
 
-export const getSearchRequest = <TDocument extends Document>(index: string, options: SearchOptions<TDocument>): SearchRequest & SearchOptions<TDocument> => ({
+export const getSearchRequest = <TDocument extends Document>(index: string, options: SearchOptions<TDocument>): SearchRequest<TDocument> & SearchOptions<TDocument> => ({
     index,
     ...options
 })

src/lib/elasticsearch/response.ts

@@ -1,7 +1,17 @@
+import { ApiResponse } from '@elastic/elasticsearch'
+import { HitsMetadata } from '@elastic/elasticsearch/api/types'
 import { Document } from 'lib/types'
 import { SearchRequest } from './request'
 
-export const getSearchResponse = <TDocument extends Document>(request: SearchRequest<TDocument>) => () => ({
-    records: [],
-    aggregations: []
-})
+export type ElasticsearchResult<TDocument extends Document> = {
+    hits: HitsMetadata<TDocument>
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    aggregations?: Record<string, any>
+}
+
+export const getSearchResponse = <TDocument extends Document>(request: SearchRequest<TDocument>) => ({ body }: ApiResponse<ElasticsearchResult<TDocument>>) => ({
+    documents: body.hits.hits.map(({ _source: document }) => document),
+    aggregations: body.aggregations,
+    request,
+    body
+})

src/lib/queries/get-term.ts

@@ -1,4 +1,4 @@
-import { Document, Field, FieldType } from 'lib/types'
+import { Document, Field, FieldType, Keyword } from 'lib/types'
 
 export type TermQueryBody<TDocument extends Document, TField extends Field<TDocument>> = {
     [Key in keyof TDocument]?: { value: FieldType<TDocument, TField> }
@@ -10,7 +10,7 @@ export type TermQuery<TDocument extends Document, TField extends Field<TDocument
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const getTermQuery = <TDocument extends Document, TField extends Field<TDocument> = keyof TDocument>
-(field: TField, value: FieldType<TDocument, TField>): TermQuery<TDocument, TField> => ({
+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>
 })

src/lib/queries/get-terms.ts

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

src/lib/queries/index.ts

@@ -1,4 +1,3 @@
-export * from './types'
 export * from './get-term'
 export * from './get-terms'
 export * from './get-must'

src/lib/types/common.ts

@@ -6,3 +6,4 @@ 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`

src/nestjs/elasticsearch.service.ts

@@ -1,7 +1,7 @@
 import { Injectable } from '@nestjs/common'
 import { ElasticsearchService as ElasticsearchBaseService } from '@nestjs/elasticsearch'
 import { ClassConstructor, Document } from 'lib/types'
-import { SearchOptions, getSearchRequest, getSearchResponse } from 'lib/elasticsearch'
+import { ElasticsearchResult, SearchOptions, getSearchRequest, getSearchResponse } from 'lib/elasticsearch'
 import { Catalog } from './injectables'
 import { ELASTICSEARCH_CATALOG_NAME } from 'lib/constants'
 
@@ -32,8 +32,8 @@ export class ElasticsearchService {
 
         const request = getSearchRequest<TDocument>(index, options)
 
-        return this.elasticsearchBaseService.search(request)
-            .then(getSearchResponse(request))
+        return this.elasticsearchBaseService.search<ElasticsearchResult<TDocument>>(request)
+            .then(getSearchResponse<TDocument>(request))
             .catch(error => {
                 console.error(error)
 

src/test/features/making-a-search.spec.ts

@@ -0,0 +1,37 @@
+import { setupNestApplication } from 'test/toolkit'
+import { ElasticsearchModule } from 'nestjs/elasticsearch.module'
+import { ElasticsearchService } from 'nestjs/elasticsearch.service'
+import { HomeDocument, PropertyType } from 'test/module'
+import { getBoolQuery, getTermQuery } from 'lib/queries'
+
+describe('Making a search', () => {
+    const { app } = setupNestApplication({
+        imports: [
+            ElasticsearchModule.register({
+                node: 'http://localhost:9200'
+            })
+        ]
+    })
+
+    it('has service available', () => {
+        const service = app.get(ElasticsearchService)
+
+        expect(service).toBeDefined()
+    })
+
+    it('makes a test search query', async () => {
+        const service = app.get(ElasticsearchService)
+        const result = await service.search(HomeDocument, {
+            size: 10,
+            body: {
+                query: getBoolQuery({
+                    must: [
+                        getTermQuery('propertyType.keyword', PropertyType.Flat)
+                    ]
+                })
+            }
+        })
+
+        console.log(result.documents)
+    })
+})

src/test/module/homes.catalog.ts

@@ -23,7 +23,8 @@ export class HomeDocument {
     readonly hasProperty: boolean
 
     @IsEnum(PropertyType)
-    readonly propertyType: PropertyType
+    @IsOptional()
+    readonly propertyType?: PropertyType
 
     @IsNumber()
     @IsOptional()
@@ -35,5 +36,5 @@ export class HomeDocument {
 
     @IsString()
     @IsOptional()
-    readonly propertyAreaSquaredAsString?: number
+    readonly propertyAreaSquaredAsString?: string
 }