instantsearch.js 4.46.3 → 4.48.0

package/es/connectors/hierarchical-menu/connectHierarchicalMenu.js

@@ -167,7 +167,10 @@ var connectHierarchicalMenu = function connectHierarchicalMenu(renderFn) {
           sendEvent = createSendEventForFacet({
             instantSearchInstance: instantSearchInstance,
             helper: helper,
-            attribute: hierarchicalFacetName,
+            attribute: function attribute(facetValue) {
+              var index = facetValue.split(separator).length - 1;
+              return attributes[index];
+            },
             widgetType: this.$$type
           });
         }

package/es/connectors/search-box/connectSearchBox.d.ts

@@ -34,6 +34,7 @@ export declare type SearchBoxRenderState = {
      * `true` if the search results takes more than a certain time to come back
      * from Algolia servers. This can be configured on the InstantSearch constructor with the attribute
      * `stalledSearchDelay` which is 200ms, by default.
+     * @deprecated use `instantSearchInstance.status` instead
      */
     isSearchStalled: boolean;
 };

package/es/lib/InstantSearch.d.ts

@@ -86,6 +86,7 @@ export declare type InstantSearchOptions<TUiState extends UiState = UiState, TRo
      */
     insightsClient?: AlgoliaInsightsClient;
 };
+export declare type InstantSearchStatus = 'idle' | 'loading' | 'stalled' | 'error';
 /**
  * The actual implementation of the InstantSearch. This is
  * created using the `instantsearch` factory function.
@@ -104,7 +105,6 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     renderState: RenderState;
     _stalledSearchDelay: number;
     _searchStalledTimer: any;
-    _isSearchStalled: boolean;
     _initialUiState: TUiState;
     _initialResults: InitialResults | null;
     _createURL: CreateURL<TUiState>;
@@ -115,6 +115,19 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
         instance: MiddlewareDefinition;
     }>;
     sendEventToInsights: (event: InsightsEvent) => void;
+    /**
+     * The status of the search. Can be "idle", "loading", "stalled", or "error".
+     */
+    status: InstantSearchStatus;
+    /**
+     * The last returned error from the Search API.
+     * The error gets cleared when the next valid search response is rendered.
+     */
+    error: Error | undefined;
+    /**
+     * @deprecated use `status === 'stalled'` instead
+     */
+    get _isSearchStalled(): boolean;
     constructor(options: InstantSearchOptions<TUiState, TRouteState>);
     /**
      * Hooks a middleware into the InstantSearch lifecycle.
@@ -168,11 +181,11 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
      * @return {undefined} This method does not return anything
      */
     dispose(): void;
-    scheduleSearch: ((...args: any[]) => void) & {
+    scheduleSearch: (() => void) & {
         wait(): Promise<void>;
         cancel(): void;
     };
-    scheduleRender: ((...args: any[]) => void) & {
+    scheduleRender: ((shouldResetStatus?: boolean) => void) & {
         wait(): Promise<void>;
         cancel(): void;
     };
@@ -184,7 +197,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
      */
     setUiState(uiState: TUiState | ((previousUiState: TUiState) => TUiState), callOnStateChange?: boolean): void;
     getUiState(): TUiState;
-    onInternalStateChange: ((...args: any[]) => void) & {
+    onInternalStateChange: (() => void) & {
         wait(): Promise<void>;
         cancel(): void;
     };

package/es/lib/InstantSearch.js

@@ -86,8 +86,6 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
 
     _defineProperty(_assertThisInitialized(_this), "_searchStalledTimer", void 0);
 
-    _defineProperty(_assertThisInitialized(_this), "_isSearchStalled", void 0);
-
     _defineProperty(_assertThisInitialized(_this), "_initialUiState", void 0);
 
     _defineProperty(_assertThisInitialized(_this), "_initialResults", void 0);
@@ -102,6 +100,10 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
 
     _defineProperty(_assertThisInitialized(_this), "sendEventToInsights", void 0);
 
+    _defineProperty(_assertThisInitialized(_this), "status", 'idle');
+
+    _defineProperty(_assertThisInitialized(_this), "error", undefined);
+
     _defineProperty(_assertThisInitialized(_this), "scheduleSearch", defer(function () {
       if (_this.started) {
         _this.mainHelper.search();
@@ -109,10 +111,16 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
     }));
 
     _defineProperty(_assertThisInitialized(_this), "scheduleRender", defer(function () {
+      var shouldResetStatus = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+
       if (!_this.mainHelper.hasPendingRequests()) {
         clearTimeout(_this._searchStalledTimer);
         _this._searchStalledTimer = null;
-        _this._isSearchStalled = false;
+
+        if (shouldResetStatus) {
+          _this.status = 'idle';
+          _this.error = undefined;
+        }
       }
 
       _this.mainIndex.render({
@@ -193,7 +201,6 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
     };
     _this._stalledSearchDelay = stalledSearchDelay;
     _this._searchStalledTimer = null;
-    _this._isSearchStalled = false;
     _this._createURL = defaultCreateURL;
     _this._initialUiState = initialUiState;
     _this._initialResults = null;
@@ -222,6 +229,25 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
 
 
   _createClass(InstantSearch, [{
+    key: "_isSearchStalled",
+    get:
+    /**
+     * The status of the search. Can be "idle", "loading", "stalled", or "error".
+     */
+
+    /**
+     * The last returned error from the Search API.
+     * The error gets cleared when the next valid search response is rendered.
+     */
+
+    /**
+     * @deprecated use `status === 'stalled'` instead
+     */
+    function get() {
+      process.env.NODE_ENV === 'development' ? warning(false, "`InstantSearch._isSearchStalled` is deprecated and will be removed in InstantSearch.js 5.0.\n\nUse `InstantSearch.status === \"stalled\"` instead.") : void 0;
+      return this.status === 'stalled';
+    }
+  }, {
     key: "use",
     value: function use() {
       var _this2 = this;
@@ -383,10 +409,18 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       var mainHelper = this.mainHelper || algoliasearchHelper(this.client, this.indexName);
 
       mainHelper.search = function () {
-        // This solution allows us to keep the exact same API for the users but
+        _this3.status = 'loading'; // @MAJOR: use scheduleRender here
+        // For now, widgets don't expect to be rendered at the start of `loading`,
+        // so it would be a breaking change to add an extra render. We don't have
+        // these guarantees about the render event, thus emitting it once more
+        // isn't a breaking change.
+
+        _this3.emit('render'); // This solution allows us to keep the exact same API for the users but
         // under the hood, we have a different implementation. It should be
         // completely transparent for the rest of the codebase. Only this module
         // is impacted.
+
+
         return mainHelper.searchOnlyWithDerivedHelpers();
       };
 
@@ -443,6 +477,11 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
 
 
         error.error = error;
+        _this3.error = error;
+        _this3.status = 'error';
+
+        _this3.scheduleRender(false); // This needs to execute last because it throws the error.
+
 
         _this3.emit('error', error);
       });
@@ -531,7 +570,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
 
       if (!this._searchStalledTimer) {
         this._searchStalledTimer = setTimeout(function () {
-          _this4._isSearchStalled = true;
+          _this4.status = 'stalled';
 
           _this4.scheduleRender();
         }, this._stalledSearchDelay);

package/es/lib/utils/createSendEventForFacet.d.ts

@@ -3,10 +3,11 @@ import type { InstantSearch } from '../../types';
 declare type BuiltInSendEventForFacet = (eventType: string, facetValue: string, eventName?: string) => void;
 declare type CustomSendEventForFacet = (customPayload: any) => void;
 export declare type SendEventForFacet = BuiltInSendEventForFacet & CustomSendEventForFacet;
-export declare function createSendEventForFacet({ instantSearchInstance, helper, attribute, widgetType, }: {
+declare type CreateSendEventForFacetOptions = {
     instantSearchInstance: InstantSearch;
     helper: AlgoliaSearchHelper;
-    attribute: string;
+    attribute: string | ((facetValue: string) => string);
     widgetType: string;
-}): SendEventForFacet;
+};
+export declare function createSendEventForFacet({ instantSearchInstance, helper, attribute: attr, widgetType, }: CreateSendEventForFacetOptions): SendEventForFacet;
 export {};

package/es/lib/utils/createSendEventForFacet.js

@@ -4,7 +4,7 @@ import { isFacetRefined } from "./isFacetRefined.js";
 export function createSendEventForFacet(_ref) {
   var instantSearchInstance = _ref.instantSearchInstance,
       helper = _ref.helper,
-      attribute = _ref.attribute,
+      attr = _ref.attribute,
       widgetType = _ref.widgetType;
 
   var sendEventForFacet = function sendEventForFacet() {
@@ -16,6 +16,7 @@ export function createSendEventForFacet(_ref) {
         facetValue = args[1],
         _args$ = args[2],
         eventName = _args$ === void 0 ? 'Filter Applied' : _args$;
+    var attribute = typeof attr === 'string' ? attr : attr(facetValue);
 
     if (args.length === 1 && _typeof(args[0]) === 'object') {
       instantSearchInstance.sendEventToInsights(args[0]);

package/es/lib/utils/createSendEventForHits.js

@@ -140,7 +140,7 @@ export function createSendEventForHits(_ref2) {
       index: index,
       methodName: 'sendEvent',
       args: args,
-      isSearchStalled: instantSearchInstance._isSearchStalled
+      isSearchStalled: instantSearchInstance.status === 'stalled'
     });
     payloads.forEach(function (payload) {
       return instantSearchInstance.sendEventToInsights(payload);

package/es/lib/utils/defer.d.ts

@@ -1,7 +1,7 @@
 declare type Callback = (...args: any[]) => void;
-declare type Defer = Callback & {
+declare type Defer = {
     wait(): Promise<void>;
     cancel(): void;
 };
-export declare function defer(callback: Callback): Defer;
+export declare function defer<TCallback extends Callback>(callback: TCallback): TCallback & Defer;
 export {};

package/es/lib/utils/index.d.ts

@@ -38,6 +38,7 @@ export * from './logger';
 export * from './mergeSearchParameters';
 export * from './noop';
 export * from './range';
+export * from './render-args';
 export * from './resolveSearchParameters';
 export * from './reverseHighlightedParts';
 export * from './safelyRunOnBrowser';

package/es/lib/utils/index.js

@@ -38,6 +38,7 @@ export * from "./logger.js";
 export * from "./mergeSearchParameters.js";
 export * from "./noop.js";
 export * from "./range.js";
+export * from "./render-args.js";
 export * from "./resolveSearchParameters.js";
 export * from "./reverseHighlightedParts.js";
 export * from "./safelyRunOnBrowser.js";

package/es/lib/utils/render-args.d.ts

@@ -0,0 +1,34 @@
+import type { InstantSearch, UiState } from '../../types';
+import type { IndexWidget } from '../../widgets/index/index';
+export declare function createInitArgs(instantSearchInstance: InstantSearch, parent: IndexWidget, uiState: UiState): {
+    uiState: UiState;
+    helper: import("algoliasearch-helper").AlgoliaSearchHelper;
+    parent: IndexWidget;
+    instantSearchInstance: InstantSearch<UiState, UiState>;
+    state: import("algoliasearch-helper").SearchParameters;
+    renderState: import("../../types").RenderState;
+    templatesConfig: Record<string, unknown>;
+    createURL: (state: import("algoliasearch-helper").SearchParameters) => string;
+    scopedResults: never[];
+    searchMetadata: {
+        isSearchStalled: boolean;
+    };
+    status: import("../InstantSearch").InstantSearchStatus;
+    error: Error | undefined;
+};
+export declare function createRenderArgs(instantSearchInstance: InstantSearch, parent: IndexWidget): {
+    helper: import("algoliasearch-helper").AlgoliaSearchHelper;
+    parent: IndexWidget;
+    instantSearchInstance: InstantSearch<UiState, UiState>;
+    results: import("algoliasearch-helper").SearchResults<any>;
+    scopedResults: import("../../types").ScopedResult[];
+    state: import("algoliasearch-helper").SearchParameters;
+    renderState: import("../../types").RenderState;
+    templatesConfig: Record<string, unknown>;
+    createURL: (state: import("algoliasearch-helper").SearchParameters) => string;
+    searchMetadata: {
+        isSearchStalled: boolean;
+    };
+    status: import("../InstantSearch").InstantSearchStatus;
+    error: Error | undefined;
+};

package/es/lib/utils/render-args.js

@@ -0,0 +1,38 @@
+export function createInitArgs(instantSearchInstance, parent, uiState) {
+  var helper = parent.getHelper();
+  return {
+    uiState: uiState,
+    helper: helper,
+    parent: parent,
+    instantSearchInstance: instantSearchInstance,
+    state: helper.state,
+    renderState: instantSearchInstance.renderState,
+    templatesConfig: instantSearchInstance.templatesConfig,
+    createURL: parent.createURL,
+    scopedResults: [],
+    searchMetadata: {
+      isSearchStalled: instantSearchInstance.status === 'stalled'
+    },
+    status: instantSearchInstance.status,
+    error: instantSearchInstance.error
+  };
+}
+export function createRenderArgs(instantSearchInstance, parent) {
+  var results = parent.getResults();
+  return {
+    helper: parent.getHelper(),
+    parent: parent,
+    instantSearchInstance: instantSearchInstance,
+    results: results,
+    scopedResults: parent.getScopedResults(),
+    state: results._state,
+    renderState: instantSearchInstance.renderState,
+    templatesConfig: instantSearchInstance.templatesConfig,
+    createURL: parent.createURL,
+    searchMetadata: {
+      isSearchStalled: instantSearchInstance.status === 'stalled'
+    },
+    status: instantSearchInstance.status,
+    error: instantSearchInstance.error
+  };
+}

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.46.3";
+declare const _default: "4.48.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.46.3';
+export default '4.48.0';

package/es/middlewares/createInsightsMiddleware.d.ts

@@ -7,15 +7,15 @@ export declare type InsightsEvent = {
     hits?: Hit[];
     attribute?: string;
 };
-export declare type InsightsProps = {
-    insightsClient: null | InsightsClient;
+export declare type InsightsProps<TInsightsClient extends null | InsightsClient = InsightsClient | null> = {
+    insightsClient: TInsightsClient;
     insightsInitParams?: {
         userHasOptedOut?: boolean;
         useCookie?: boolean;
         cookieDuration?: number;
         region?: 'de' | 'us';
     };
-    onEvent?: (event: InsightsEvent, insightsClient: null | InsightsClient) => void;
+    onEvent?: (event: InsightsEvent, insightsClient: TInsightsClient) => void;
 };
-export declare type CreateInsightsMiddleware = (props: InsightsProps) => InternalMiddleware;
-export declare const createInsightsMiddleware: CreateInsightsMiddleware;
+export declare type CreateInsightsMiddleware = typeof createInsightsMiddleware;
+export declare function createInsightsMiddleware<TInsightsClient extends null | InsightsClient>(props: InsightsProps<TInsightsClient>): InternalMiddleware;

package/es/middlewares/createInsightsMiddleware.js

@@ -18,7 +18,7 @@ function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 
 import { getInsightsAnonymousUserTokenInternal } from "../helpers/index.js";
 import { warning, noop, getAppIdAndApiKey, find } from "../lib/utils/index.js";
-export var createInsightsMiddleware = function createInsightsMiddleware(props) {
+export function createInsightsMiddleware(props) {
   var _ref = props || {},
       _insightsClient = _ref.insightsClient,
       insightsInitParams = _ref.insightsInitParams,
@@ -157,4 +157,4 @@ export var createInsightsMiddleware = function createInsightsMiddleware(props) {
       }
     };
   };
-};
+}

package/es/middlewares/createMetadataMiddleware.js

@@ -1,21 +1,7 @@
-import { safelyRunOnBrowser } from "../lib/utils/index.js";
+import { createInitArgs, safelyRunOnBrowser } from "../lib/utils/index.js";
 
 function extractPayload(widgets, instantSearchInstance, payload) {
-  var parent = instantSearchInstance.mainIndex;
-  var initOptions = {
-    instantSearchInstance: instantSearchInstance,
-    parent: parent,
-    scopedResults: [],
-    state: parent.getHelper().state,
-    helper: parent.getHelper(),
-    createURL: parent.createURL,
-    uiState: instantSearchInstance._initialUiState,
-    renderState: instantSearchInstance.renderState,
-    templatesConfig: instantSearchInstance.templatesConfig,
-    searchMetadata: {
-      isSearchStalled: instantSearchInstance._isSearchStalled
-    }
-  };
+  var initOptions = createInitArgs(instantSearchInstance, instantSearchInstance.mainIndex, instantSearchInstance._initialUiState);
   widgets.forEach(function (widget) {
     var widgetParams = {};
 

package/es/types/widget.d.ts

@@ -17,9 +17,13 @@ declare type SharedRenderOptions = {
     state: SearchParameters;
     renderState: IndexRenderState;
     helper: Helper;
+    /** @deprecated use `status` instead */
     searchMetadata: {
+        /** @deprecated use `status === "stalled"` instead */
         isSearchStalled: boolean;
     };
+    status: InstantSearch['status'];
+    error: InstantSearch['error'];
     createURL(state: SearchParameters): string;
 };
 export declare type InitOptions = SharedRenderOptions & {

package/es/widgets/hierarchical-menu/defaultTemplates.js

@@ -6,9 +6,10 @@ var defaultTemplates = {
     var url = _ref.url,
         label = _ref.label,
         count = _ref.count,
-        cssClasses = _ref.cssClasses;
+        cssClasses = _ref.cssClasses,
+        isRefined = _ref.isRefined;
     return h("a", {
-      className: cx(cssClasses.link),
+      className: cx([cx(cssClasses.link), cx(isRefined ? cssClasses.selectedItemLink : undefined)]),
       href: url
     }, h("span", {
       className: cx(cssClasses.label)

package/es/widgets/hierarchical-menu/hierarchical-menu.d.ts

@@ -53,6 +53,10 @@ export declare type HierarchicalMenuCSSClasses = Partial<{
      * CSS class to add to each link (when using the default template).
      */
     link: string | string[];
+    /**
+     * CSS class to add to the link of each selected item element (when using the default template).
+     */
+    selectedItemLink: string | string[];
     /**
      * CSS class to add to each label (when using the default template).
      */

package/es/widgets/hierarchical-menu/hierarchical-menu.js

@@ -156,6 +156,10 @@ var hierarchicalMenu = function hierarchicalMenu(widgetParams) {
     link: cx(suit({
       descendantName: 'link'
     }), userCssClasses.link),
+    selectedItemLink: cx(suit({
+      descendantName: 'link',
+      modifierName: 'selected'
+    }), userCssClasses.selectedItemLink),
     label: cx(suit({
       descendantName: 'label'
     }), userCssClasses.label),

package/es/widgets/index/index.d.ts

@@ -36,7 +36,7 @@ export declare type IndexWidget = Omit<Widget<IndexWidgetDescription & {
      * @deprecated
      */
     getWidgetState(uiState: UiState): UiState;
-    getWidgetUiState<TUiState = UiState>(uiState: TUiState): TUiState;
+    getWidgetUiState<TUiState extends UiState = UiState>(uiState: TUiState): TUiState;
     getWidgetSearchParameters(searchParameters: SearchParameters, searchParametersOptions: {
         uiState: IndexUiState;
     }): SearchParameters;

package/es/widgets/index/index.js

@@ -21,7 +21,7 @@ function _objectWithoutProperties(source, excluded) { if (source == null) return
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
 
 import algoliasearchHelper from 'algoliasearch-helper';
-import { checkIndexUiState, createDocumentationMessageGenerator, resolveSearchParameters, mergeSearchParameters, warning, isIndexWidget } from "../../lib/utils/index.js";
+import { checkIndexUiState, createDocumentationMessageGenerator, resolveSearchParameters, mergeSearchParameters, warning, isIndexWidget, createInitArgs, createRenderArgs } from "../../lib/utils/index.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'index-widget'
 });
@@ -184,20 +184,7 @@ var index = function index(widgetParams) {
 
         widgets.forEach(function (widget) {
           if (widget.getRenderState) {
-            var renderState = widget.getRenderState(localInstantSearchInstance.renderState[_this.getIndexId()] || {}, {
-              uiState: localInstantSearchInstance._initialUiState,
-              helper: _this.getHelper(),
-              parent: _this,
-              instantSearchInstance: localInstantSearchInstance,
-              state: helper.state,
-              renderState: localInstantSearchInstance.renderState,
-              templatesConfig: localInstantSearchInstance.templatesConfig,
-              createURL: _this.createURL,
-              scopedResults: [],
-              searchMetadata: {
-                isSearchStalled: localInstantSearchInstance._isSearchStalled
-              }
-            });
+            var renderState = widget.getRenderState(localInstantSearchInstance.renderState[_this.getIndexId()] || {}, createInitArgs(localInstantSearchInstance, _this, localInstantSearchInstance._initialUiState));
             storeRenderState({
               renderState: renderState,
               instantSearchInstance: localInstantSearchInstance,
@@ -207,20 +194,7 @@ var index = function index(widgetParams) {
         });
         widgets.forEach(function (widget) {
           if (widget.init) {
-            widget.init({
-              helper: helper,
-              parent: _this,
-              uiState: localInstantSearchInstance._initialUiState,
-              instantSearchInstance: localInstantSearchInstance,
-              state: helper.state,
-              renderState: localInstantSearchInstance.renderState,
-              templatesConfig: localInstantSearchInstance.templatesConfig,
-              createURL: _this.createURL,
-              scopedResults: [],
-              searchMetadata: {
-                isSearchStalled: localInstantSearchInstance._isSearchStalled
-              }
-            });
+            widget.init(createInitArgs(localInstantSearchInstance, _this, localInstantSearchInstance._initialUiState));
           }
         });
         localInstantSearchInstance.scheduleSearch();
@@ -386,20 +360,7 @@ var index = function index(widgetParams) {
 
       localWidgets.forEach(function (widget) {
         if (widget.getRenderState) {
-          var renderState = widget.getRenderState(instantSearchInstance.renderState[_this3.getIndexId()] || {}, {
-            uiState: uiState,
-            helper: helper,
-            parent: _this3,
-            instantSearchInstance: instantSearchInstance,
-            state: helper.state,
-            renderState: instantSearchInstance.renderState,
-            templatesConfig: instantSearchInstance.templatesConfig,
-            createURL: _this3.createURL,
-            scopedResults: [],
-            searchMetadata: {
-              isSearchStalled: instantSearchInstance._isSearchStalled
-            }
-          });
+          var renderState = widget.getRenderState(instantSearchInstance.renderState[_this3.getIndexId()] || {}, createInitArgs(instantSearchInstance, _this3, uiState));
           storeRenderState({
             renderState: renderState,
             instantSearchInstance: instantSearchInstance,
@@ -413,20 +374,7 @@ var index = function index(widgetParams) {
         !widget.getWidgetState || Boolean(widget.getWidgetUiState), 'The `getWidgetState` method is renamed `getWidgetUiState` and will no longer exist under that name in InstantSearch.js 5.x. Please use `getWidgetUiState` instead.') : void 0;
 
         if (widget.init) {
-          widget.init({
-            uiState: uiState,
-            helper: helper,
-            parent: _this3,
-            instantSearchInstance: instantSearchInstance,
-            state: helper.state,
-            renderState: instantSearchInstance.renderState,
-            templatesConfig: instantSearchInstance.templatesConfig,
-            createURL: _this3.createURL,
-            scopedResults: [],
-            searchMetadata: {
-              isSearchStalled: instantSearchInstance._isSearchStalled
-            }
-          });
+          widget.init(createInitArgs(instantSearchInstance, _this3, uiState));
         }
       }); // Subscribe to the Helper state changes for the `uiState` once widgets
       // are initialized. Until the first render, state changes are part of the
@@ -467,20 +415,7 @@ var index = function index(widgetParams) {
 
       localWidgets.forEach(function (widget) {
         if (widget.getRenderState) {
-          var renderState = widget.getRenderState(instantSearchInstance.renderState[_this4.getIndexId()] || {}, {
-            helper: _this4.getHelper(),
-            parent: _this4,
-            instantSearchInstance: instantSearchInstance,
-            results: _this4.getResults(),
-            scopedResults: _this4.getScopedResults(),
-            state: _this4.getResults()._state,
-            renderState: instantSearchInstance.renderState,
-            templatesConfig: instantSearchInstance.templatesConfig,
-            createURL: _this4.createURL,
-            searchMetadata: {
-              isSearchStalled: instantSearchInstance._isSearchStalled
-            }
-          });
+          var renderState = widget.getRenderState(instantSearchInstance.renderState[_this4.getIndexId()] || {}, createRenderArgs(instantSearchInstance, _this4));
           storeRenderState({
             renderState: renderState,
             instantSearchInstance: instantSearchInstance,
@@ -496,20 +431,7 @@ var index = function index(widgetParams) {
         // be delayed. The render is triggered for the complete tree but some parts do
         // not have results yet.
         if (widget.render) {
-          widget.render({
-            helper: helper,
-            parent: _this4,
-            instantSearchInstance: instantSearchInstance,
-            results: _this4.getResults(),
-            scopedResults: _this4.getScopedResults(),
-            state: _this4.getResults()._state,
-            renderState: instantSearchInstance.renderState,
-            templatesConfig: instantSearchInstance.templatesConfig,
-            createURL: _this4.createURL,
-            searchMetadata: {
-              isSearchStalled: instantSearchInstance._isSearchStalled
-            }
-          });
+          widget.render(createRenderArgs(instantSearchInstance, _this4));
         }
       });
     },
@@ -541,7 +463,7 @@ var index = function index(widgetParams) {
     getWidgetUiState: function getWidgetUiState(uiState) {
       return localWidgets.filter(isIndexWidget).reduce(function (previousUiState, innerIndex) {
         return innerIndex.getWidgetUiState(previousUiState);
-      }, _objectSpread(_objectSpread({}, uiState), {}, _defineProperty({}, this.getIndexId(), localUiState)));
+      }, _objectSpread(_objectSpread({}, uiState), {}, _defineProperty({}, indexId, _objectSpread(_objectSpread({}, uiState[indexId]), localUiState))));
     },
     getWidgetState: function getWidgetState(uiState) {
       process.env.NODE_ENV === 'development' ? warning(false, 'The `getWidgetState` method is renamed `getWidgetUiState` and will no longer exist under that name in InstantSearch.js 5.x. Please use `getWidgetUiState` instead.') : void 0;