Add new filter and aggregation response types (#21)

* Add new filter types

* Add array filter types

* Add date aggregation models

* PR comments

---------

Co-authored-by: Dan Jones <[email protected]>

Author: danmichaeljones

src/query/response/api-response-mapping.ts

@@ -6,6 +6,7 @@ import {
   SearchResult,
   Source,
   Usage,
+  DateFilterValue,
 } from "./response.js";
 
 import {
@@ -16,6 +17,7 @@ import {
   ApiSearchResult,
   ApiSource,
   ApiUsage,
+  ApiDateFilterValue,
 } from "./api-response.js";
 
 export const mapApiResponse = (
@@ -43,14 +45,122 @@ const mapApiSearches = (searches: SearchResult[][]): ApiSearchResult[][] =>
     }))
   );
 
+const mapDateFilterValue = (value: DateFilterValue): ApiDateFilterValue | undefined => {
+  if ("exactTimestamp" in value) {
+    return {
+      exact_timestamp: value.exactTimestamp,
+      operator: value.operator,
+    };
+  } else if (
+    "dateFrom" in value
+    && "dateTo" in value
+    && value.dateFrom != null
+    && value.dateTo != null
+  ) {
+    return {
+      date_from: value.dateFrom,
+      date_to: value.dateTo,
+      inclusive_from: value.inclusiveFrom,
+      inclusive_to: value.inclusiveTo,
+    };
+  } else if ("dateFrom" in value && value.dateFrom != null) {
+    return {
+      date_from: value.dateFrom,
+      inclusive_from: value.inclusiveFrom,
+    };
+  } else if ("dateTo" in value && value.dateTo != null) {
+    return {
+      date_to: value.dateTo,
+      inclusive_to: value.inclusiveTo,
+    };
+  }
+  else {
+    return undefined
+  }
+};
+
 const mapApiPropertyFilters = (
   filters: PropertyFilter[]
 ): ApiPropertyFilter[] =>
-  filters.map((filter) => ({
-    property_name: filter.propertyName,
-    operator: filter.operator,
-    value: filter.value,
-  }));
+  filters.map((filter) => {
+    switch (filter.filterType) {
+      case "integer":
+        return {
+          filter_type: "integer",
+          property_name: filter.propertyName,
+          operator: filter.operator,
+          value: filter.value,
+        };
+      case "integerArray":
+        return {
+          filter_type: "integer_array",
+          property_name: filter.propertyName,
+          operator: filter.operator,
+          value: filter.value,
+        };
+      case "text":
+        return {
+          filter_type: "text",
+          property_name: filter.propertyName,
+          operator: filter.operator,
+          value: filter.value,
+        };
+      case "textArray":
+        return {
+          filter_type: "text_array",
+          property_name: filter.propertyName,
+          operator: filter.operator,
+          value: filter.value,
+        };
+      case "boolean":
+        return {
+          filter_type: "boolean",
+          property_name: filter.propertyName,
+          operator: filter.operator,
+          value: filter.value,
+        };
+      case "booleanArray":
+        return {
+          filter_type: "boolean_array",
+          property_name: filter.propertyName,
+          operator: filter.operator,
+          value: filter.value,
+        };
+      case "dateRange":
+        const value = mapDateFilterValue(filter.value);
+        if (!value) {
+          return undefined;
+        }
+        return {
+          filter_type: "date_range",
+          property_name: filter.propertyName,
+          value,
+        };
+      case "dateArray":
+        return {
+          filter_type: "date_array",
+          property_name: filter.propertyName,
+          operator: filter.operator,
+          value: filter.value,
+        };
+      case "geo":
+        return {
+          filter_type: "geo",
+          property_name: filter.propertyName,
+          latitude: filter.latitude,
+          longitude: filter.longitude,
+          max_distance_meters: filter.maxDistanceMeters,
+        };
+      case "isNull":
+        return {
+          filter_type: "is_null",
+          property_name: filter.propertyName,
+          is_null: filter.isNull,
+        };
+      default:
+        return undefined
+    }
+  }).filter((filter): filter is ApiPropertyFilter => filter !== undefined);
 
 const mapApiAggregations = (
   aggregations: AggregationResult[][]

src/query/response/api-response.ts

@@ -2,6 +2,7 @@ import {
   NumericMetrics,
   TextMetrics,
   BooleanMetrics,
+  DateMetrics,
   ComparisonOperator,
 } from "./response.js";
 
@@ -27,26 +28,109 @@ export type ApiSearchResult = {
 
 export type ApiPropertyFilter =
   | ApiIntegerPropertyFilter
+  | ApiIntegerArrayPropertyFilter
   | ApiTextPropertyFilter
-  | ApiBooleanPropertyFilter;
+  | ApiTextArrayPropertyFilter
+  | ApiBooleanPropertyFilter
+  | ApiBooleanArrayPropertyFilter
+  | ApiDatePropertyFilter
+  | ApiDateArrayPropertyFilter
+  | ApiGeoPropertyFilter
+  | ApiIsNullPropertyFilter;
 
 type ApiPropertyFilterBase = {
+  filter_type: string;
   property_name: string;
-  operator: ComparisonOperator;
 };
 
 export type ApiIntegerPropertyFilter = ApiPropertyFilterBase & {
+  filter_type: "integer";
+  operator: ComparisonOperator;
   value: number;
 };
 
+export type ApiIntegerArrayPropertyFilter = ApiPropertyFilterBase & {
+  filter_type: "integer_array";
+  operator: ComparisonOperator;
+  value: number[];
+};
+
 export type ApiTextPropertyFilter = ApiPropertyFilterBase & {
+  filter_type: "text";
+  operator: ComparisonOperator;
   value: string;
 };
 
+export type ApiTextArrayPropertyFilter = ApiPropertyFilterBase & {
+  filter_type: "text_array";
+  operator: ComparisonOperator;
+  value: string[];
+};
+
 export type ApiBooleanPropertyFilter = ApiPropertyFilterBase & {
+  filter_type: "boolean";
+  operator: ComparisonOperator;
   value: boolean;
 };
 
+export type ApiBooleanArrayPropertyFilter = ApiPropertyFilterBase & {
+  filter_type: "boolean_array";
+  operator: ComparisonOperator;
+  value: boolean[];
+};
+
+export type ApiDateExact = {
+  exact_timestamp: string;
+  operator: ComparisonOperator;
+};
+
+export type ApiDateRangeFrom = {
+  date_from: string;
+  inclusive_from: boolean;
+};
+
+export type ApiDateRangeTo = {
+  date_to: string;
+  inclusive_to: boolean;  
+};
+
+export type ApiDateRangeBetween = {
+  date_from: string;
+  date_to: string;
+  inclusive_from: boolean;
+  inclusive_to: boolean;
+};
+
+export type ApiDateFilterValue =
+  ApiDateExact
+  | ApiDateRangeFrom
+  | ApiDateRangeTo
+  | ApiDateRangeBetween;
+
+export type ApiDatePropertyFilter = ApiPropertyFilterBase & {
+  filter_type: "date_range";
+  value: ApiDateFilterValue;
+};
+
+export type ApiDateArrayPropertyFilter = ApiPropertyFilterBase & {
+  filter_type: "date_array";
+  operator: ComparisonOperator;
+  value: string[];
+};
+
+export type ApiGeoPropertyFilter = ApiPropertyFilterBase & {
+  filter_type: "geo";
+  latitude: number;
+  longitude: number;
+  max_distance_meters: number;
+};
+
+export type ApiIsNullPropertyFilter = ApiPropertyFilterBase & {
+  filter_type: "is_null";
+  is_null: boolean;
+};
+
+
 export type ApiAggregationResult = {
   collection: string;
   search_query?: string;
@@ -58,7 +142,8 @@ export type ApiAggregationResult = {
 export type ApiPropertyAggregation =
   | ApiIntegerPropertyAggregation
   | ApiTextPropertyAggregation
-  | ApiBooleanPropertyAggregation;
+  | ApiBooleanPropertyAggregation
+  | ApiDatePropertyAggregation;
 
 type ApiPropertyAggregationBase = {
   property_name: string;
@@ -77,6 +162,10 @@ export type ApiBooleanPropertyAggregation = ApiPropertyAggregationBase & {
   metrics: BooleanMetrics;
 };
 
+export type ApiDatePropertyAggregation = ApiPropertyAggregationBase & {
+  metrics: DateMetrics;
+};
+
 export type ApiUsage = {
   requests: number;
   request_tokens?: number;