instantsearch.js 4.40.5 → 4.41.1

package/CHANGELOG.md

@@ -1,3 +1,32 @@
+## [4.41.1](https://github.com/algolia/instantsearch.js/compare/v4.41.0...v4.41.1) (2022-06-14)
+
+
+### Bug Fixes
+
+* **insights:** don't send view event if search is stalled ([#5058](https://github.com/algolia/instantsearch.js/issues/5058)) ([1686dfb](https://github.com/algolia/instantsearch.js/commit/1686dfb096cfce062e268feda7956e3b160bf2da)), closes [/github.com/algolia/instantsearch.js/blob/99f6fe1dc51e4815e5b9efcfb30e3e2f3127e763/src/lib/utils/createSendEventForHits.ts#L168](https://github.com//github.com/algolia/instantsearch.js/blob/99f6fe1dc51e4815e5b9efcfb30e3e2f3127e763/src/lib/utils/createSendEventForHits.ts/issues/L168) [/github.com/algolia/instantsearch.js/blob/55313e4ea4105b777f3f102e9f48a7e440496d25/src/middlewares/createInsightsMiddleware.ts#L144](https://github.com//github.com/algolia/instantsearch.js/blob/55313e4ea4105b777f3f102e9f48a7e440496d25/src/middlewares/createInsightsMiddleware.ts/issues/L144)
+* **types:** avoid inferring UiState type from initialUiState ([#5061](https://github.com/algolia/instantsearch.js/issues/5061)) ([80ca07e](https://github.com/algolia/instantsearch.js/commit/80ca07e29064357343ee997be94ef10beadba637)), closes [/github.com/Microsoft/TypeScript/issues/14829#issuecomment-504042546](https://github.com//github.com/Microsoft/TypeScript/issues/14829/issues/issuecomment-504042546) [#5060](https://github.com/algolia/instantsearch.js/issues/5060)
+* **types:** make all usages of UiState in InstantSearch generic ([#5060](https://github.com/algolia/instantsearch.js/issues/5060)) ([2b9e76b](https://github.com/algolia/instantsearch.js/commit/2b9e76b568fb4d4cc5bd49c384ee583d84d6f39a))
+
+
+
+# [4.41.0](https://github.com/algolia/instantsearch.js/compare/v4.40.6...v4.41.0) (2022-06-01)
+
+
+### Features
+
+* **core:** don't schedule search without widgets ([#5056](https://github.com/algolia/instantsearch.js/issues/5056)) ([ea3d6d9](https://github.com/algolia/instantsearch.js/commit/ea3d6d9c6ae1fe2f90bf5643d4bdcbb89507e9bc))
+
+
+
+## [4.40.6](https://github.com/algolia/instantsearch.js/compare/v4.40.5...v4.40.6) (2022-05-24)
+
+
+### Bug Fixes
+
+* **types:** only allow `null` for parent in `getWidgetRenderState` if widget is an index ([#5052](https://github.com/algolia/instantsearch.js/issues/5052)) ([fe0fce0](https://github.com/algolia/instantsearch.js/commit/fe0fce0641ffff9af1d1303b7ee71d77ba08f8bd))
+
+
+
 ## [4.40.5](https://github.com/algolia/instantsearch.js/compare/v4.40.4...v4.40.5) (2022-04-26)
 
 

package/cjs/lib/InstantSearch.js

@@ -61,10 +61,9 @@ var withUsage = (0, _index2.createDocumentationMessageGenerator)({
 
 function defaultCreateURL() {
   return '#';
-}
-/**
- * Global options for an InstantSearch instance.
- */
+} // this purposely breaks typescript's type inference to ensure it's not used
+// as it's used for a default parameter for example
+// source: https://github.com/Microsoft/TypeScript/issues/14829#issuecomment-504042546
 
 
 /**
@@ -481,9 +480,17 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
         (0, _index2.defer)(function () {
           _this3.scheduleSearch = originalScheduleSearch;
         })();
-      } else {
-        this.scheduleSearch();
-      } // Keep the previous reference for legacy purpose, some pattern use
+      } // We only schedule a search when widgets have been added before `start()`
+      // because there are listeners that can use these results.
+      // This is especially useful in framework-based flavors that wait for
+      // dynamically-added widgets to trigger a network request. It avoids
+      // having to batch this initial network request with the one coming from
+      // `addWidgets()`.
+      // Later, we could also skip `index()` widgets and widgets that don't read
+      // the results, but this is an optimization that has a very low impact for now.
+      else if (this.mainIndex.getWidgets().length > 0) {
+          this.scheduleSearch();
+        } // Keep the previous reference for legacy purpose, some pattern use
       // the direct Helper access `search.helper` (e.g multi-index).
 
 

package/cjs/lib/utils/createSendEventForHits.js

@@ -25,7 +25,8 @@ var buildPayloads = function buildPayloads(_ref) {
   var index = _ref.index,
       widgetType = _ref.widgetType,
       methodName = _ref.methodName,
-      args = _ref.args;
+      args = _ref.args,
+      isSearchStalled = _ref.isSearchStalled;
 
   // when there's only one argument, that means it's custom
   if (args.length === 1 && _typeof(args[0]) === 'object') {
@@ -72,6 +73,10 @@ var buildPayloads = function buildPayloads(_ref) {
   });
 
   if (eventType === 'view') {
+    if (isSearchStalled) {
+      return [];
+    }
+
     return hitsChunks.map(function (batch, i) {
       return {
         insightsMethod: 'viewedObjectIDs',
@@ -142,7 +147,8 @@ function createSendEventForHits(_ref2) {
       widgetType: widgetType,
       index: index,
       methodName: 'sendEvent',
-      args: args
+      args: args,
+      isSearchStalled: instantSearchInstance._isSearchStalled
     });
     payloads.forEach(function (payload) {
       return instantSearchInstance.sendEventToInsights(payload);
@@ -165,7 +171,8 @@ function createBindEventForHits(_ref3) {
       widgetType: widgetType,
       index: index,
       methodName: 'bindEvent',
-      args: args
+      args: args,
+      isSearchStalled: false
     });
     return payloads.length ? "data-insights-event=".concat((0, _serializer.serializePayload)(payloads)) : '';
   };

package/cjs/lib/utils/safelyRunOnBrowser.js

@@ -8,7 +8,7 @@ exports.safelyRunOnBrowser = safelyRunOnBrowser;
 // eslint-disable-next-line no-restricted-globals
 
 /**
- * Runs code on browser enviromnents safely.
+ * Runs code on browser environments safely.
  */
 function safelyRunOnBrowser(callback) {
   var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {

package/cjs/lib/version.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _default = '4.40.5';
+var _default = '4.41.1';
 exports.default = _default;

package/dist/instantsearch.development.d.ts

@@ -2003,9 +2003,15 @@ declare type HTMLMarkerArguments = {
 
 declare const index: (widgetParams: IndexWidgetParams) => IndexWidget;
 
-declare type IndexInitOptions = Pick<InitOptions, 'instantSearchInstance' | 'parent' | 'uiState'>;
+declare type IndexInitOptions = {
+    instantSearchInstance: InstantSearch;
+    parent: IndexWidget | null;
+    uiState: UiState;
+};
 
-declare type IndexRenderOptions = Pick<RenderOptions, 'instantSearchInstance'>;
+declare type IndexRenderOptions = {
+    instantSearchInstance: InstantSearch;
+};
 
 declare type IndexRenderState = Partial<ConnectorRenderStates & WidgetRenderStates>;
 
@@ -2280,7 +2286,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     client: InstantSearchOptions['searchClient'];
     indexName: string;
     insightsClient: InsightsClient | null;
-    onStateChange: InstantSearchOptions['onStateChange'] | null;
+    onStateChange: InstantSearchOptions<TUiState>['onStateChange'] | null;
     helper: AlgoliaSearchHelper | null;
     mainHelper: AlgoliaSearchHelper | null;
     mainIndex: IndexWidget;
@@ -2290,9 +2296,9 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     _stalledSearchDelay: number;
     _searchStalledTimer: any;
     _isSearchStalled: boolean;
-    _initialUiState: UiState;
+    _initialUiState: TUiState;
     _initialResults: InitialResults | null;
-    _createURL: CreateURL<UiState>;
+    _createURL: CreateURL<TUiState>;
     _searchFunction?: InstantSearchOptions['searchFunction'];
     _mainHelperSearch?: AlgoliaSearchHelper['search'];
     middleware: Array<{
@@ -2362,13 +2368,13 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
         cancel(): void;
     };
     scheduleStalledRender(): void;
-    setUiState(uiState: UiState | ((previousUiState: UiState) => UiState)): void;
-    getUiState(): UiState;
+    setUiState(uiState: TUiState | ((previousUiState: TUiState) => TUiState)): void;
+    getUiState(): TUiState;
     onInternalStateChange: ((...args: any[]) => void) & {
         wait(): Promise<void>;
         cancel(): void;
     };
-    createURL(nextState?: UiState): string;
+    createURL(nextState?: TUiState): string;
     refresh(): void;
 }
 
@@ -2460,8 +2466,8 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * become in charge of updating the UI state with the `setUiState` function.
      */
     onStateChange?: (params: {
-        uiState: UiState;
-        setUiState(uiState: UiState | ((previousUiState: UiState) => UiState)): void;
+        uiState: TUiState;
+        setUiState(uiState: TUiState | ((previousUiState: TUiState) => TUiState)): void;
     }) => void;
     /**
      * Injects a `uiState` to the `instantsearch` instance. You can use this option
@@ -2469,7 +2475,7 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * for the first search. To unconditionally pass additional parameters to the
      * Algolia API, take a look at the `configure` widget.
      */
-    initialUiState?: TUiState;
+    initialUiState?: NoInfer<TUiState>;
     /**
      * Time before a search is considered stalled. The default is 200ms
      */
@@ -2773,6 +2779,8 @@ declare namespace middlewares {
     }
 }
 
+declare type NoInfer<T> = [T][T extends any ? 0 : never];
+
 declare const numericMenu: NumericMenuWidget;
 
 declare type NumericMenuComponentCSSClasses = ComponentCSSClasses<NumericMenuCSSClasses>;
@@ -4595,7 +4603,7 @@ declare type SendEventForToggle = BuiltInSendEventForToggle & CustomSendEventFor
 
 declare type SharedRenderOptions = {
     instantSearchInstance: InstantSearch;
-    parent: IndexWidget | null;
+    parent: IndexWidget;
     templatesConfig: Record<string, unknown>;
     scopedResults: ScopedResult[];
     state: SearchParameters;

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.40.5 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.41.1 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -7692,7 +7692,8 @@
     var index = _ref.index,
         widgetType = _ref.widgetType,
         methodName = _ref.methodName,
-        args = _ref.args;
+        args = _ref.args,
+        isSearchStalled = _ref.isSearchStalled;
 
     // when there's only one argument, that means it's custom
     if (args.length === 1 && _typeof(args[0]) === 'object') {
@@ -7735,6 +7736,10 @@
     });
 
     if (eventType === 'view') {
+      if (isSearchStalled) {
+        return [];
+      }
+
       return hitsChunks.map(function (batch, i) {
         return {
           insightsMethod: 'viewedObjectIDs',
@@ -7803,7 +7808,8 @@
         widgetType: widgetType,
         index: index,
         methodName: 'sendEvent',
-        args: args
+        args: args,
+        isSearchStalled: instantSearchInstance._isSearchStalled
       });
       payloads.forEach(function (payload) {
         return instantSearchInstance.sendEventToInsights(payload);
@@ -7825,7 +7831,8 @@
         widgetType: widgetType,
         index: index,
         methodName: 'bindEvent',
-        args: args
+        args: args,
+        isSearchStalled: false
       });
       return payloads.length ? "data-insights-event=".concat(serializePayload(payloads)) : '';
     };
@@ -7965,7 +7972,7 @@
   // eslint-disable-next-line no-restricted-globals
 
   /**
-   * Runs code on browser enviromnents safely.
+   * Runs code on browser environments safely.
    */
   function safelyRunOnBrowser(callback) {
     var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {
@@ -8536,7 +8543,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.40.5';
+  var version$1 = '4.41.1';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -10026,10 +10033,9 @@
 
   function defaultCreateURL() {
     return '#';
-  }
-  /**
-   * Global options for an InstantSearch instance.
-   */
+  } // this purposely breaks typescript's type inference to ensure it's not used
+  // as it's used for a default parameter for example
+  // source: https://github.com/Microsoft/TypeScript/issues/14829#issuecomment-504042546
 
 
   /**
@@ -10446,9 +10452,17 @@
           defer(function () {
             _this3.scheduleSearch = originalScheduleSearch;
           })();
-        } else {
-          this.scheduleSearch();
-        } // Keep the previous reference for legacy purpose, some pattern use
+        } // We only schedule a search when widgets have been added before `start()`
+        // because there are listeners that can use these results.
+        // This is especially useful in framework-based flavors that wait for
+        // dynamically-added widgets to trigger a network request. It avoids
+        // having to batch this initial network request with the one coming from
+        // `addWidgets()`.
+        // Later, we could also skip `index()` widgets and widgets that don't read
+        // the results, but this is an optimization that has a very low impact for now.
+        else if (this.mainIndex.getWidgets().length > 0) {
+            this.scheduleSearch();
+          } // Keep the previous reference for legacy purpose, some pattern use
         // the direct Helper access `search.helper` (e.g multi-index).