fix(types): improve UiState types (#3763)

algolia · May 13, 2019 · e8ea57b · e8ea57b
1 parent 2808b52
commit e8ea57b
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 6 deletions.
diff --git a/src/lib/RoutingManager.ts b/src/lib/RoutingManager.ts
@@ -61,7 +61,7 @@ class RoutingManager implements Widget {
     const widgets = this.instantSearchInstance.widgets;
     const helper = this.instantSearchInstance.helper!;
 
-    return widgets.reduce((state, widget) => {
+    return widgets.reduce<UiState>((state, widget) => {
       if (!widget.getWidgetState) {
         return state;
       }

diff --git a/src/lib/__tests__/RoutingManager-test.js b/src/lib/__tests__/RoutingManager-test.js
@@ -98,7 +98,7 @@ describe('RoutingManager', () => {
       });
 
       const widgetState = {
-        some: 'values',
+        query: 'query',
       };
       const widget = {
         render: () => {},
@@ -107,7 +107,7 @@ describe('RoutingManager', () => {
       search.addWidget(widget);
 
       const actualInitialState = {
-        some: 'values',
+        query: 'query',
       };
 
       search.start();
@@ -149,7 +149,7 @@ describe('RoutingManager', () => {
       search.start();
 
       const actualInitialState = {
-        some: 'values',
+        query: 'query',
       };
 
       const router = new RoutingManager({
@@ -182,7 +182,7 @@ describe('RoutingManager', () => {
       search.addWidget(widget);
 
       const actualInitialState = {
-        some: 'values',
+        query: 'query',
       };
 
       search.start();

diff --git a/src/types/widget.ts b/src/types/widget.ts
@@ -31,7 +31,45 @@ interface DisposeOptions {
 }
 
 export type UiState = {
-  [stateKey: string]: any;
+  query?: string;
+  menu?: {
+    [attribute: string]: string;
+  };
+  /**
+   * The list of hierarchical menus.
+   * Nested levels must contain the record separator.
+   *
+   * @example ['Audio', 'Audio > Headphones']
+   */
+  hierarchicalMenu?: {
+    [attribute: string]: string[];
+  };
+  refinementList?: {
+    [attribute: string]: string[];
+  };
+  numericRefinementList?: {
+    [attribute: string]: number;
+  };
+  numericSelector?: {
+    [attribute: string]: number;
+  };
+  /**
+   * The range as a tuple.
+   *
+   * @example '100:500'
+   */
+  range?: {
+    [attribute: string]: string;
+  };
+  starRating?: {
+    [attribute: string]: number;
+  };
+  toggle?: {
+    [attribute: string]: boolean;
+  };
+  sortBy?: string;
+  page?: number;
+  hitsPerPage?: number;
 };
 
 export interface Widget {