[CDX-390]: update VarioationsMap type (#440)

* [CDX-390]: update VarioationsMap type

* [CDX-390]: add discriminated union for VariationValue types

* [CDX-390]: update FilterNode to union type

* Address comment

* Lint

* Update types

* Update types

* Address comments

---------

Co-authored-by: Enes Kutay SEZEN <eneskutaysezen@gmail.com>

Author: niizom

src/types/browse.d.ts

@@ -13,6 +13,7 @@ import {
   ResultSources,
   SortOption,
   VariationsMap,
+  VariationsMapResponse,
 } from '.';
 import EventDispatcher from './event-dispatcher';
 
@@ -136,7 +137,7 @@ export interface BrowseResultData extends Record<string, any> {
   is_slotted: false;
   labels: Record<string, any>;
   variations?: Record<string, any>[];
-  variations_map?: Record<string, any> | Record<string, any>[];
+  variations_map?: VariationsMapResponse;
 }
 
 export interface BrowseRequestType extends Record<string, any> {

src/types/index.d.ts

@@ -12,6 +12,10 @@ export * from './browse';
 export * from './tracker';
 export * from './event-dispatcher';
 
+type RequireAtLeastOne<T, Keys extends keyof T = keyof T> =
+  Pick<T, Exclude<keyof T, Keys>> &
+  { [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>> }[Keys];
+
 export interface NetworkParameters extends Record<string, any> {
   timeout?: number;
 }
@@ -215,6 +219,24 @@ export type FilterExpressionRange = {
 
 export type FilterExpressionRangeValue = ['-inf' | number, 'inf' | number];
 
+export interface VariationsMapSingleFilter {
+  field: string;
+  value: string | number | boolean;
+}
+
+export interface VariationsMapRange {
+  field: string;
+  range: FilterExpressionRangeValue;
+}
+
+export type FilterNode = VariationsMapSingleFilter | VariationsMapRange;
+
+export type FilterBy = RequireAtLeastOne<{
+  and?: Array<FilterNode | FilterBy>;
+  or?: Array<FilterNode | FilterBy>;
+  not?: FilterNode | FilterBy;
+}>;
+
 export interface Item extends Record<string, any> {
   value: string;
   is_slotted: boolean;
@@ -223,6 +245,7 @@ export interface Item extends Record<string, any> {
   data?: ItemData;
   strategy?: { id: string };
   variations?: { data?: ItemData, value: string }[]
+  variations_map?: VariationsMapResponse;
 }
 
 export interface ItemData extends Record<string, any> {
@@ -244,16 +267,32 @@ export interface SearchSuggestion extends Item {
   } & ItemData;
 }
 
+export type VariationsMapResponse = Array<Record<string, unknown>> | Record<string, unknown>;
+
+export type Aggregation = 'first' | 'min' | 'max' | 'all' | 'count' | 'field_count' | 'value_count';
+
+export interface VariationsMapBaseValue {
+  aggregation: Aggregation;
+  field: string;
+}
+
+export interface VariationsMapValueCount extends VariationsMapBaseValue {
+  aggregation: 'value_count';
+  value: boolean | number | string;
+}
+
+export interface VariationsMapStandardValue extends VariationsMapBaseValue {
+  aggregation: Exclude<Aggregation, 'value_count'>;
+}
+
 export interface VariationsMap {
-  group_by: Array<{
+  group_by?: Array<{
     name: string,
     field: string
   }>;
+  filter_by?: FilterBy;
   values: {
-    [key: string]: {
-        aggregation: 'first' | 'min' | 'max' | 'all',
-        field: string
-    },
+    [key: string]: VariationsMapValueCount | VariationsMapStandardValue,
   },
   dtype: 'array' | 'object'
 }

src/types/tests/autocomplete.test-d.ts

@@ -65,6 +65,20 @@ expectAssignable<AutocompleteResponse>({
           field: 'data.VariationId',
         },
       ],
+      filter_by: {
+        and: [
+          { field: 'data.availability', value: 'in stock' },
+          {
+            not: { field: 'data.discontinued', value: true },
+          },
+          {
+            or: [
+              { field: 'data.price', range: [10, 100] },
+              { field: 'data.backorderable', value: 'true' },
+            ],
+          },
+        ],
+      },
       values: {
         availability: {
           aggregation: 'all',

src/types/tests/browse.test-d.ts

@@ -123,6 +123,20 @@ expectAssignable<GetBrowseResultsResponse>({
           field: 'data.VariationId',
         },
       ],
+      filter_by: {
+        and: [
+          { field: 'data.availability', value: 'in stock' },
+          {
+            not: { field: 'data.discontinued', value: true },
+          },
+          {
+            or: [
+              { field: 'data.price', range: [10, 100] },
+              { field: 'data.backorderable', value: 'true' },
+            ],
+          },
+        ],
+      },
       values: {
         availability: {
           aggregation: 'all',

src/types/tests/search.test-d.ts

@@ -132,6 +132,20 @@ expectAssignable<SearchResponse>({
           field: 'data.VariationId',
         },
       ],
+      filter_by: {
+        and: [
+          { field: 'data.availability', value: 'in stock' },
+          {
+            not: { field: 'data.discontinued', value: true },
+          },
+          {
+            or: [
+              { field: 'data.price', range: [10, 100] },
+              { field: 'data.backorderable', value: 'true' },
+            ],
+          },
+        ],
+      },
       values: {
         availability: {
           aggregation: 'all',