feat: drop support of searchParameters for initialUiState (#4081)

This PR drops the support of `searchParameters` for `initialUiState`. Here is the changes:

- `InstantSearch`: remove the support of the option
- `index`: remove the logic for the option
- `stories`: replace the usage of `searchParamters` by `initialUiState` when applicable
- `stories`: replace the usage of `searchParamters` by `configure` when applicable

Author: samouss

.eslintrc.js

@@ -10,6 +10,10 @@ module.exports = {
       'error',
       { argsIgnorePattern: '^_', ignoreRestSiblings: true },
     ],
+    '@typescript-eslint/camelcase': [
+      'error',
+      { allow: ['instant_search', 'instant_search_movies'] },
+    ],
   },
   overrides: [
     {

.storybook/decorators/withHits.ts

@@ -19,7 +19,6 @@ export const withHits = (
     appId = 'latency',
     apiKey = '6be0576ff61c053d5f9a3225e2a90f76',
     indexName = 'instant_search',
-    searchParameters = {},
     playground = defaultPlayground,
     ...instantsearchOptions
   } = searchOptions || {};
@@ -70,6 +69,14 @@ export const withHits = (
   rightPanelPlaygroundElement.classList.add('panel-right');
   playgroundElement.appendChild(rightPanelPlaygroundElement);
 
+  search.addWidget(
+    instantsearch.widgets.configure({
+      hitsPerPage: 4,
+      attributesToSnippet: ['description:15'],
+      snippetEllipsisText: '[…]',
+    })
+  );
+
   playground({
     search,
     leftPanel: leftPanelPlaygroundElement,

src/lib/InstantSearch.ts

@@ -97,12 +97,6 @@ export type InstantSearchOptions<TRouteState = UiState> = {
    */
   searchFunction?: (helper: AlgoliaSearchHelper) => void;
 
-  /**
-   * Additional parameters to unconditionally pass to the Algolia API. See also
-   * the `configure` widget for dynamically passing search parameters.
-   */
-  searchParameters?: PlainSearchParameters;
-
   /**
    * Injects a `uiState` to the `instantsearch` instance. You can use this option
    * to provide an initial state to a widget. Note that the state is only used
@@ -146,7 +140,6 @@ class InstantSearch extends EventEmitter {
   public _stalledSearchDelay: number;
   public _searchStalledTimer: any;
   public _isSearchStalled: boolean;
-  public _searchParameters: PlainSearchParameters;
   public _initialUiState: UiState;
   public _searchFunction?: InstantSearchOptions['searchFunction'];
   public _createURL?: (params: SearchParameters) => string;
@@ -160,7 +153,6 @@ class InstantSearch extends EventEmitter {
     const {
       indexName = null,
       numberLocale,
-      searchParameters = {},
       initialUiState = {},
       routing = null,
       searchFunction,
@@ -245,10 +237,6 @@ See ${createDocumentationLink({
     this._searchStalledTimer = null;
     this._isSearchStalled = false;
     this._initialUiState = initialUiState;
-    this._searchParameters = {
-      ...searchParameters,
-      index: indexName,
-    };
 
     if (searchFunction) {
       this._searchFunction = searchFunction;

src/lib/__tests__/InstantSearch-test.js

@@ -400,12 +400,11 @@ describe('start', () => {
       indexName: 'indexName',
       searchClient,
       searchFunction(helper) {
-        helper.addDisjunctiveFacetRefinement('brand', 'Apple');
-        helper.search();
-      },
-      searchParameters: {
-        disjunctiveFacetsRefinements: { brand: ['Apple'] },
-        disjunctiveFacets: ['brand'],
+        const nextState = helper.state
+          .addDisjunctiveFacet('brand')
+          .addDisjunctiveFacetRefinement('brand', 'Apple');
+
+        helper.setState(nextState).search();
       },
     });
 
@@ -414,29 +413,6 @@ describe('start', () => {
     }).not.toThrow();
   });
 
-  it('forwards the `searchParameters` to the main index', () => {
-    const search = new InstantSearch({
-      indexName: 'indexName',
-      searchClient: createSearchClient(),
-      searchParameters: {
-        hitsPerPage: 5,
-        disjunctiveFacetsRefinements: { brand: ['Apple'] },
-        disjunctiveFacets: ['brand'],
-      },
-    });
-
-    search.start();
-
-    expect(search.mainIndex.getHelper().state).toEqual(
-      algoliasearchHelper.SearchParameters.make({
-        index: 'indexName',
-        hitsPerPage: 5,
-        disjunctiveFacetsRefinements: { brand: ['Apple'] },
-        disjunctiveFacets: ['brand'],
-      })
-    );
-  });
-
   it('forwards the `initialUiState` to the main index', () => {
     const search = new InstantSearch({
       indexName: 'indexName',

src/widgets/index/__tests__/index-test.ts

@@ -595,57 +595,6 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/index/js/"
       );
     });
 
-    it('uses `searchParameters` for the top level index', () => {
-      const instance = index({ indexName: 'indexName' });
-      const instantSearchInstance = createInstantSearch({
-        _searchParameters: {
-          hitsPerPage: 5,
-          disjunctiveFacetsRefinements: { brand: ['Apple'] },
-          disjunctiveFacets: ['brand'],
-        },
-      });
-
-      instance.init(
-        createInitOptions({
-          instantSearchInstance,
-        })
-      );
-
-      expect(instance.getHelper()!.state).toEqual(
-        new SearchParameters({
-          index: 'indexName',
-          hitsPerPage: 5,
-          disjunctiveFacetsRefinements: { brand: ['Apple'] },
-          disjunctiveFacets: ['brand'],
-        })
-      );
-    });
-
-    it('does not use `searchParameters` for sub level indices ', () => {
-      const topLevelInstance = index({ indexName: 'topLevelIndexName' });
-      const subLevelInstance = index({ indexName: 'subLevelIndexName' });
-      const instantSearchInstance = createInstantSearch({
-        _searchParameters: {
-          hitsPerPage: 5,
-          disjunctiveFacetsRefinements: { brand: ['Apple'] },
-          disjunctiveFacets: ['brand'],
-        },
-      });
-
-      subLevelInstance.init(
-        createInitOptions({
-          instantSearchInstance,
-          parent: topLevelInstance,
-        })
-      );
-
-      expect(subLevelInstance.getHelper()!.state).toEqual(
-        new SearchParameters({
-          index: 'subLevelIndexName',
-        })
-      );
-    });
-
     it('uses the internal state for the queries', () => {
       const instance = index({ indexName: 'indexName' });
       const searchClient = createSearchClient();

src/widgets/index/index.ts

@@ -287,12 +287,6 @@ const index = (props: IndexProps): Index => {
       // step.
       const mainHelper = instantSearchInstance.mainHelper!;
 
-      const initialSearchParameters = new algoliasearchHelper.SearchParameters(
-        // Uses the `searchParameters` for the top level index only, it allows
-        // us to have the exact same behaviour than before for the mono-index.
-        parent === null ? instantSearchInstance._searchParameters : {}
-      );
-
       // This Helper is only used for state management we do not care about the
       // `searchClient`. Only the "main" Helper created at the `InstantSearch`
       // level is aware of the client.
@@ -301,7 +295,7 @@ const index = (props: IndexProps): Index => {
         indexName,
         getLocalWidgetsSearchParameters(localWidgets, {
           uiState: localUiState,
-          initialSearchParameters,
+          initialSearchParameters: new algoliasearchHelper.SearchParameters(),
         })
       );