Fix: Browse and Search types (#410)

* Fix browse types based on empirical testing

* Fix search types based on empirical testing

* Fix types in browse and search tests

* Fix typo

---------

Co-authored-by: Aleksei Pavlov <pavlov.aleksey.m@gmail.com>
Co-authored-by: Enes Kutay SEZEN <eneskutaysezen@gmail.com>

Author: 3 people

src/types/browse.d.ts

@@ -1,4 +1,5 @@
 import {
+  BrowseFacet,
   Collection,
   ConstructorClientOptions,
   Facet,
@@ -31,7 +32,7 @@ export interface IBrowseParameters {
   hiddenFacets?: string[];
   variationsMap?: VariationsMap;
   qsParam?: Record<string, any>;
-  filterMatchTypes?: Record<string, 'all'| 'any' | 'none'>
+  filterMatchTypes?: Record<string, 'all' | 'any' | 'none'>;
 }
 
 declare class Browse {
@@ -77,40 +78,52 @@ declare class Browse {
 /** *********
  * Browse results returned from server
  ********** */
-export interface BrowseResponse<ResponseType> extends Record<string, any> {
-  request?: Partial<BrowseRequestType>;
-  response?: Partial<ResponseType>;
-  result_id?: string;
+export interface BrowseResponse<ResponseType, OmittedRequestFields extends keyof BrowseRequestType>
+  extends Record<string, any> {
+
+  request: Omit<BrowseRequestType, OmittedRequestFields>;
+  response: ResponseType;
+  result_id: string;
   ad_based?: boolean;
 }
 
 export type GetBrowseResultsResponse =
-  BrowseResponse<GetBrowseResultsResponseData>;
+  BrowseResponse<GetBrowseResultsResponseData, 'facet_name'>;
 export type GetBrowseResultsForItemIdsResponse =
-  BrowseResponse<GetBrowseResultsResponseData>;
+  BrowseResponse<GetBrowseResultsResponseData, 'facet_name'>;
 export type GetBrowseGroupsResponse = BrowseResponse<
   Pick<
     GetBrowseResultsResponseData,
     'result_sources' | 'groups' | 'refined_content'
-  >
+  >,
+  'browse_filter_name' | 'browse_filter_value' | 'searchandized_items' | 'facet_name'
 >;
 export type GetBrowseFacetsResponse = BrowseResponse<
-  Pick<GetBrowseResultsResponseData, 'facets' | 'total_num_results'>
+  GetBrowseFacetsResultsResponseData,
+  'browse_filter_name' | 'browse_filter_value' | 'searchandized_items' | 'facet_name'
 >;
 export type GetBrowseFacetOptionsResponse = BrowseResponse<
-  Pick<GetBrowseResultsResponseData, 'facets'>
+  Pick<GetBrowseResultsResponseData, 'facets' | 'total_num_results'>,
+  'browse_filter_name' | 'browse_filter_value' | 'searchandized_items'
 >;
 
 export interface GetBrowseResultsResponseData extends Record<string, any> {
-  result_sources: Partial<ResultSources>;
-  facets: Partial<Facet>[];
-  groups: Partial<Group>[];
-  results: Partial<BrowseResultData>[];
-  sort_options: Partial<SortOption>[];
+  result_sources: ResultSources;
+  facets: Facet[];
+  groups: Group[];
+  results: BrowseResultData[];
+  sort_options: SortOption[];
   refined_content: Record<string, any>[];
   total_num_results: number;
-  features: Partial<Feature>[];
-  collection: Partial<Collection>;
+  features: Feature[];
+  collection?: Partial<Collection>;
+  related_searches?: Record<string, any>[];
+  related_browse_pages?: Record<string, any>[];
+}
+
+export interface GetBrowseFacetsResultsResponseData extends Record<string, any> {
+  facets: BrowseFacet[];
+  total_num_results: number;
 }
 
 export interface BrowseResultData extends Record<string, any> {
@@ -122,23 +135,24 @@ export interface BrowseResultData extends Record<string, any> {
   value: string;
   is_slotted: false;
   labels: Record<string, any>;
-  variations: Record<string, any>[];
-  variations_map: Record<string, any> | Record<string, any>[];
+  variations?: Record<string, any>[];
+  variations_map?: Record<string, any> | Record<string, any>[];
 }
 
 export interface BrowseRequestType extends Record<string, any> {
   browse_filter_name: string;
   browse_filter_value: string;
-  filter_match_types: Record<string, any>;
-  filters: Record<string, any>;
-  fmt_options: Record<string, any>;
+  filter_match_types?: Record<string, any>;
+  filters?: Record<string, any>;
+  fmt_options: FmtOptions;
+  facet_name: string;
   num_results_per_page: number;
   page: number;
   section: string;
   sort_by: string;
   sort_order: string;
   term: string;
-  query: string;
+  query?: string;
   features: Partial<RequestFeature>;
   feature_variants: Partial<RequestFeatureVariant>;
   searchandized_items: Record<string, any>;

src/types/index.d.ts

@@ -97,6 +97,7 @@ export interface SortOption extends Record<string, any> {
   display_name: string;
   sort_order: string;
   status: string;
+  hidden: boolean;
 }
 
 export interface Feature extends Record<string, any> {
@@ -110,44 +111,59 @@ export interface Feature extends Record<string, any> {
   } | null;
 }
 
-export type Facet = RangeFacet | OptionFacet;
+export type Facet = RangeFacet | OptionFacet | HierarchicalOptionFacet;
+
+export type BrowseFacet = Pick<Facet, keyof BaseFacet | 'type'>;
 
 export interface BaseFacet extends Record<string, any> {
   data: Record<string, any>;
-  status: Record<string, any>;
   display_name: string;
   name: string;
   hidden: boolean;
 }
 
 export interface RangeFacet extends BaseFacet, Record<string, any> {
-  max: number;
-  min: number;
+  status?: { min: RangeMin, max: RangeMax };
+  max: RangeMax;
+  min: RangeMin;
   type: 'range';
 }
 
 export interface OptionFacet extends BaseFacet, Record<string, any> {
   options: FacetOption[];
-  type: 'multiple' | 'single' | 'hierarchical';
+  type: 'multiple' | 'single';
+}
+
+export interface HierarchicalOptionFacet extends BaseFacet, Record<string, any> {
+  options: HierarchicalFacetOption[];
+  type: 'hierarchical';
 }
 
 export interface FacetOption extends Record<string, any> {
   count: number;
   display_name: string;
   value: string;
-  options?: FacetOption[];
-  range?: ['-inf' | number, 'inf' | number];
+  range?: [RangeMin, RangeMax];
   status: string;
+  data: Record<string, any>;
 }
 
+export interface HierarchicalFacetOption extends FacetOption {
+  options?: HierarchicalFacetOption[];
+}
+
+export type RangeMin = '-inf' | number;
+export type RangeMax = '+inf' | 'inf' | number
+
 export interface Group extends BaseGroup, Record<string, any> {
-  count?: number;
+  count: number;
   data?: Record<string, any>;
-  parents?: BaseGroup[];
-  children?: Group[];
+  parents: BaseGroup[];
+  children: Group[];
 }
 
 export interface Collection extends Record<string, any> {
+  // documentation says this field is called `id`
   collection_id: string;
   display_name: string;
   data: Record<string, any>;

src/types/search.d.ts

@@ -1,4 +1,5 @@
 import {
+  BrowseResultData,
   ConstructorClientOptions,
   Facet,
   Feature,
@@ -56,27 +57,29 @@ declare class Search {
  * search results returned from server
  ********** */
 export interface SearchResponse {
-  request: Partial<SearchRequestType>;
-  response: Partial<SearchResponseType | Redirect>;
+  request: SearchRequestType;
+  response: SearchResponseType | Redirect;
   result_id: string;
 }
 
 export interface SearchResponseType extends Record<string, any> {
-  result_sources: Partial<ResultSources>;
-  facets: Partial<Facet>[];
-  groups: Partial<Group>[];
-  results: Partial<Result>[];
-  sort_options: Partial<SortOption>[];
+  result_sources: ResultSources;
+  facets: Facet[];
+  groups: Group[];
+  results: Result[];
+  sort_options: SortOption[];
   refined_content: Record<string, any>[];
   total_num_results: number;
-  features: Partial<Feature>[];
+  features: Feature[];
+  related_searches?: Record<string, any>[];
+  related_browse_pages?: Record<string, any>[];
 }
 
 export interface SearchRequestType extends Record<string, any> {
   page: number;
   num_results_per_page: number;
   section: string;
-  blacklist_rules: boolean;
+  blacklist_rules?: boolean;
   term: string;
   fmt_options: FmtOptions;
   sort_by: string;
@@ -89,18 +92,7 @@ export interface SearchRequestType extends Record<string, any> {
   pre_filter_expression?: FilterExpression;
 }
 
-export interface Result extends Record<string, any> {
-  matched_terms: string[];
-  data: {
-    id: string;
-    [key: string]: any;
-  };
-  value: string;
-  is_slotted: false;
-  labels: Record<string, any>;
-  variations: Record<string, any>[];
-  variations_map: Record<string, any> | Record<string, any>[];
-}
+export type Result = BrowseResultData;
 
 export interface Redirect extends Record<string, any> {
   redirect: {

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

@@ -29,6 +29,7 @@ expectAssignable<GetBrowseResultsResponse>({
         data: {},
       },
     ],
+    groups: [],
     results: [
       {
         matched_terms: [],
@@ -62,6 +63,7 @@ expectAssignable<GetBrowseResultsResponse>({
         display_name: 'A - Z',
         sort_order: 'descending',
         status: '',
+        hidden: false,
       },
     ],
     refined_content: [],