Merge pull request #336 from bahamoth/main

chore: Support for extended_bounds in Date Histogram Aggregation for elastic-ts
jacobwgillespie · Jan 23, 2024 · ab98383 · ab98383
2 parents 391e099 + e9557e4
commit ab98383
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/src/types/aggregations.ts b/src/types/aggregations.ts
@@ -191,6 +191,10 @@ export interface DateHistogramAggregation {
     fixed_interval?: string
     offset?: string
     min_doc_count?: number
+    extended_bounds?: {
+      min: number | string
+      max: number | string
+    }
     format?: string
     time_zone?: string
     keyed?: boolean

diff --git a/test/aggregations.spec.ts b/test/aggregations.spec.ts
@@ -284,6 +284,44 @@ describe('esBuilder - Aggregations', () => {
     })
   })
 
+  it('date_histogram aggregation with extended_bounds support', () => {
+    const result = esBuilder().aggregation('agg_date_histogram_extended_bounds',
+      'date_histogram', 'extended', { extended_bounds: {min: 0, max: 1} }).build()
+
+    expect(result).toEqual({
+      aggs: {
+        agg_date_histogram_extended_bounds: {
+          date_histogram: {
+            field: 'extended',
+            extended_bounds: {
+              max: 1,
+              min: 0
+            }
+          },
+        },
+      },
+    })
+  })
+
+  it('date_histogram aggregation with extended_bounds support, date string format', () => {
+    const result = esBuilder().aggregation('agg_date_histogram_extended_bounds',
+      'date_histogram', 'extended', { extended_bounds: {min: '2024-01-01', max: '2024-12-31'} }).build()
+
+    expect(result).toEqual({
+      aggs: {
+        agg_date_histogram_extended_bounds: {
+          date_histogram: {
+            field: 'extended',
+            extended_bounds: {
+              max: '2024-12-31',
+              min: '2024-01-01'
+            }
+          },
+        },
+      },
+    })
+  })
+
   it('date_range aggregation', () => {
     const result = esBuilder()
       .aggregation('agg_date_range_date', 'date_range', 'date', {