Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/lib/aggregations/get-date-histogram.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,22 @@ describe('getDateHistogramAggregation', () => {
})
})

it('accepts custom enum that extends same keys', () => {
enum SelectedTimePeriod {
DAY = 'day'
}

const query = getDateHistogramAggregation<HomeDocument>('address', SelectedTimePeriod.DAY)

expect(query).toEqual({
// eslint-disable-next-line camelcase
date_histogram: {
field: 'address',
// eslint-disable-next-line camelcase
calendar_interval: '1d'
}
})
})

test.todo('accepts only schema field with keyword')
})
5 changes: 3 additions & 2 deletions src/lib/aggregations/get-date-histogram.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import { Document, Key } from 'lib/common'
import { ExtractEnumValues } from 'lib/utils'
import { CalendarIntervalName, CalendarIntervalQuantity } from 'lib/enums'

export type DateHistogramAggregationBody<TDocument extends Document> = {
field: Key<TDocument>
calendar_interval: CalendarIntervalName | CalendarIntervalQuantity
calendar_interval: ExtractEnumValues<CalendarIntervalName | CalendarIntervalQuantity>
}

export type DateHistogramAggregation<TDocument extends Document> = {
Expand All @@ -12,7 +13,7 @@ export type DateHistogramAggregation<TDocument extends Document> = {

export const getDateHistogramAggregation = <TDocument extends Document>(
field: Key<TDocument>,
interval: CalendarIntervalName | CalendarIntervalQuantity
interval: ExtractEnumValues<CalendarIntervalName | CalendarIntervalQuantity>
): DateHistogramAggregation<TDocument> => ({
// eslint-disable-next-line camelcase
date_histogram: {
Expand Down
1 change: 1 addition & 0 deletions src/lib/utils/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
export * from './types'
export * from './get-should-not'
export * from './is-total-hits'
1 change: 1 addition & 0 deletions src/lib/utils/types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export type ExtractEnumValues<T> = `${T & string}`