instantsearch.js 4.41.0 → 4.42.0

package/es/index.d.ts

@@ -6,7 +6,7 @@ import { createInfiniteHitsSessionStorageCache } from './lib/infiniteHitsCache';
 declare type InstantSearchModule = {
     <TUiState = Record<string, unknown>, TRouteState = TUiState>(options: InstantSearchOptions<Expand<UiState & TUiState>, TRouteState>): InstantSearch<Expand<UiState & TUiState>, TRouteState>;
     version: string;
-    /** @deprecated import { createInfiniteHitsSessionStorageCache } from 'instantsearch.js/es/helpers' */
+    /** @deprecated import { createInfiniteHitsSessionStorageCache } from 'instantsearch.js/es/lib/infiniteHitsCache' */
     createInfiniteHitsSessionStorageCache: typeof createInfiniteHitsSessionStorageCache;
     /** @deprecated import { highlight } from 'instantsearch.js/es/helpers' */
     highlight: typeof highlight;

package/es/index.js

@@ -24,7 +24,7 @@ var instantsearch = function instantsearch(options) {
 };
 
 instantsearch.version = version;
-instantsearch.createInfiniteHitsSessionStorageCache = deprecate(createInfiniteHitsSessionStorageCache, "import { createInfiniteHitsSessionStorageCache } from 'instantsearch.js/es/helpers'");
+instantsearch.createInfiniteHitsSessionStorageCache = deprecate(createInfiniteHitsSessionStorageCache, "import { createInfiniteHitsSessionStorageCache } from 'instantsearch.js/es/lib/infiniteHitsCache'");
 instantsearch.highlight = deprecate(highlight, "import { highlight } from 'instantsearch.js/es/helpers'");
 instantsearch.reverseHighlight = deprecate(reverseHighlight, "import { reverseHighlight } from 'instantsearch.js/es/helpers'");
 instantsearch.snippet = deprecate(snippet, "import { snippet } from 'instantsearch.js/es/helpers'");

package/es/lib/InstantSearch.d.ts

@@ -4,6 +4,7 @@ import type { IndexWidget } from '../widgets/index/index';
 import type { InsightsClient as AlgoliaInsightsClient, SearchClient, Widget, UiState, CreateURL, Middleware, MiddlewareDefinition, RenderState, InitialResults } from '../types';
 import type { RouterProps } from '../middlewares/createRouterMiddleware';
 import type { InsightsEvent } from '../middlewares/createInsightsMiddleware';
+declare type NoInfer<T> = [T][T extends any ? 0 : never];
 /**
  * Global options for an InstantSearch instance.
  */
@@ -58,8 +59,8 @@ export declare type InstantSearchOptions<TUiState extends UiState = UiState, TRo
      * 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
@@ -67,7 +68,7 @@ export declare type InstantSearchOptions<TUiState extends UiState = UiState, TRo
      * 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
      */
@@ -94,7 +95,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     client: InstantSearchOptions['searchClient'];
     indexName: string;
     insightsClient: AlgoliaInsightsClient | null;
-    onStateChange: InstantSearchOptions['onStateChange'] | null;
+    onStateChange: InstantSearchOptions<TUiState>['onStateChange'] | null;
     helper: AlgoliaSearchHelper | null;
     mainHelper: AlgoliaSearchHelper | null;
     mainIndex: IndexWidget;
@@ -104,9 +105,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<{
@@ -176,13 +177,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;
 }
 export default InstantSearch;

package/es/lib/InstantSearch.js

@@ -40,10 +40,9 @@ var withUsage = 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
 
 
 /**

package/es/lib/utils/createSendEventForHits.js

@@ -20,7 +20,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') {
@@ -67,6 +68,10 @@ var buildPayloads = function buildPayloads(_ref) {
   });
 
   if (eventType === 'view') {
+    if (isSearchStalled) {
+      return [];
+    }
+
     return hitsChunks.map(function (batch, i) {
       return {
         insightsMethod: 'viewedObjectIDs',
@@ -137,7 +142,8 @@ export function createSendEventForHits(_ref2) {
       widgetType: widgetType,
       index: index,
       methodName: 'sendEvent',
-      args: args
+      args: args,
+      isSearchStalled: instantSearchInstance._isSearchStalled
     });
     payloads.forEach(function (payload) {
       return instantSearchInstance.sendEventToInsights(payload);
@@ -159,7 +165,8 @@ export function createBindEventForHits(_ref3) {
       widgetType: widgetType,
       index: index,
       methodName: 'bindEvent',
-      args: args
+      args: args,
+      isSearchStalled: false
     });
     return payloads.length ? "data-insights-event=".concat(serializePayload(payloads)) : '';
   };

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.41.0";
+declare const _default: "4.42.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.41.0';
+export default '4.42.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.41.0",
+  "version": "4.42.0",
   "description": "InstantSearch.js is a JavaScript library for building performant and instant search experiences with Algolia.",
   "homepage": "https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/",
   "types": "es/index.d.ts",
@@ -53,12 +53,12 @@
     "scripts/transforms"
   ],
   "dependencies": {
+    "@algolia/events": "^4.0.1",
     "@types/google.maps": "^3.45.3",
     "@types/hogan.js": "^3.0.0",
     "@types/qs": "^6.5.3",
-    "algoliasearch-helper": "^3.8.2",
+    "algoliasearch-helper": "^3.9.0",
     "classnames": "^2.2.5",
-    "@algolia/events": "^4.0.1",
     "hogan.js": "^3.0.2",
     "preact": "^10.6.0",
     "qs": "^6.5.1 < 6.10",