instantsearch.js 4.31.0 → 4.33.1

package/es/types/insights.d.ts

@@ -1,4 +1,6 @@
-export declare type InsightsClientMethod = 'viewedObjectIDs' | 'clickedFilters' | 'clickedObjectIDsAfterSearch' | 'convertedObjectIDsAfterSearch';
+import type { InsightsMethodMap, InsightsClient as _InsightsClient } from 'search-insights';
+export type { Init as InsightsInit, AddAlgoliaAgent as InsightsAddAlgoliaAgent, SetUserToken as InsightsSetUserToken, GetUserToken as InsightsGetUserToken, OnUserTokenChange as InsightsOnUserTokenChange, } from 'search-insights';
+export declare type InsightsClientMethod = keyof InsightsMethodMap;
 export declare type InsightsClientPayload = {
     eventName: string;
     queryID: string;
@@ -6,18 +8,13 @@ export declare type InsightsClientPayload = {
     objectIDs: string[];
     positions?: number[];
 };
-export declare type InsightsSetUserToken = (method: 'setUserToken', userToken: string) => void;
-export declare type InsightsSendEvent = (method: InsightsClientMethod, payload: InsightsClientPayload) => void;
-export declare type InsightsOnUserTokenChange = (method: 'onUserTokenChange', callback?: (userToken: string) => void, options?: {
-    immediate?: boolean;
-}) => void;
-export declare type InsightsGetUserToken = (method: 'getUserToken', options?: any, callback?: (error: any, userToken: string) => void) => void;
-export declare type InsightsInit = (method: 'init', options: {
-    appId: string;
-    apiKey: string;
-}) => void;
-export declare type InsightsAddAlgoliaAgent = (method: 'addAlgoliaAgent', algoliaAgent: string) => void;
-export declare type InsightsClient = InsightsAddAlgoliaAgent & InsightsSendEvent & InsightsOnUserTokenChange & InsightsInit & InsightsSetUserToken & InsightsGetUserToken & {
-    queue?: Array<[string, any]>;
+declare type QueueItemMap = {
+    [MethodName in keyof InsightsMethodMap]: [
+        methodName: MethodName,
+        ...args: InsightsMethodMap[MethodName]
+    ];
+};
+declare type QueueItem = QueueItemMap[keyof QueueItemMap];
+export declare type InsightsClient = _InsightsClient & {
+    queue?: QueueItem[];
 };
-export declare type InsightsClientWrapper = (method: InsightsClientMethod, payload: Partial<InsightsClientPayload>) => void;

package/es/types/widget-factory.d.ts

@@ -1,8 +1,8 @@
-import type { Widget, WidgetDescription } from './widget';
+import type { UnknownWidgetParams, Widget, WidgetDescription } from './widget';
 /**
  * The function that creates a new widget.
  */
-export declare type WidgetFactory<TWidgetDescription extends WidgetDescription, TConnectorParams, TWidgetParams> = (
+export declare type WidgetFactory<TWidgetDescription extends WidgetDescription, TConnectorParams extends UnknownWidgetParams, TWidgetParams extends UnknownWidgetParams> = (
 /**
  * The params of the widget.
  */

package/es/types/widget.d.ts

@@ -36,8 +36,9 @@ export declare type DisposeOptions = {
 };
 export declare type BuiltinTypes = 'ais.analytics' | 'ais.answers' | 'ais.autocomplete' | 'ais.breadcrumb' | 'ais.clearRefinements' | 'ais.configure' | 'ais.configureRelatedItems' | 'ais.currentRefinements' | 'ais.dynamicWidgets' | 'ais.geoSearch' | 'ais.hierarchicalMenu' | 'ais.hits' | 'ais.hitsPerPage' | 'ais.index' | 'ais.infiniteHits' | 'ais.menu' | 'ais.numericMenu' | 'ais.pagination' | 'ais.places' | 'ais.poweredBy' | 'ais.queryRules' | 'ais.range' | 'ais.rangeSlider' | 'ais.rangeInput' | 'ais.ratingMenu' | 'ais.refinementList' | 'ais.searchBox' | 'ais.relevantSort' | 'ais.sortBy' | 'ais.stats' | 'ais.toggleRefinement' | 'ais.voiceSearch';
 export declare type BuiltinWidgetTypes = 'ais.analytics' | 'ais.answers' | 'ais.autocomplete' | 'ais.breadcrumb' | 'ais.clearRefinements' | 'ais.configure' | 'ais.configureRelatedItems' | 'ais.currentRefinements' | 'ais.dynamicWidgets' | 'ais.geoSearch' | 'ais.hierarchicalMenu' | 'ais.hits' | 'ais.hitsPerPage' | 'ais.index' | 'ais.infiniteHits' | 'ais.menu' | 'ais.menuSelect' | 'ais.numericMenu' | 'ais.pagination' | 'ais.places' | 'ais.poweredBy' | 'ais.queryRuleCustomData' | 'ais.queryRuleContext' | 'ais.rangeInput' | 'ais.rangeSlider' | 'ais.ratingMenu' | 'ais.refinementList' | 'ais.searchBox' | 'ais.relevantSort' | 'ais.sortBy' | 'ais.stats' | 'ais.toggleRefinement' | 'ais.voiceSearch';
+export declare type UnknownWidgetParams = NonNullable<object>;
 export declare type WidgetParams = {
-    widgetParams: NonNullable<unknown>;
+    widgetParams?: UnknownWidgetParams;
 };
 export declare type WidgetDescription = {
     $$type: string;
@@ -127,7 +128,6 @@ declare type RequiredRenderStateLifeCycle<TWidgetDescription extends WidgetDescr
 declare type RenderStateLifeCycle<TWidgetDescription extends WidgetDescription & WidgetParams> = TWidgetDescription extends RequiredKeys<WidgetDescription, 'renderState' | 'indexRenderState'> & WidgetParams ? RequiredRenderStateLifeCycle<TWidgetDescription> : Partial<RequiredRenderStateLifeCycle<TWidgetDescription>>;
 export declare type Widget<TWidgetDescription extends WidgetDescription & WidgetParams = {
     $$type: string;
-    widgetParams: unknown;
 }> = Expand<RequiredWidgetLifeCycle<TWidgetDescription> & WidgetType<TWidgetDescription> & UiStateLifeCycle<TWidgetDescription> & RenderStateLifeCycle<TWidgetDescription>>;
 /**
  * Transforms the given items.

package/es/widgets/index/index.js

@@ -541,7 +541,7 @@ var index = function index(widgetParams) {
       localUiState = getLocalWidgetsUiState(localWidgets, {
         searchParameters: this.getHelper().state,
         helper: this.getHelper()
-      });
+      }, localUiState);
     }
   };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.31.0",
+  "version": "4.33.1",
   "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",
@@ -55,12 +55,13 @@
     "@types/google.maps": "^3.45.3",
     "@types/hogan.js": "^3.0.0",
     "@types/qs": "^6.5.3",
-    "algoliasearch-helper": "^3.5.5",
+    "algoliasearch-helper": "^3.6.2",
     "classnames": "^2.2.5",
     "events": "^1.1.0",
     "hogan.js": "^3.0.2",
     "preact": "^10.0.0",
-    "qs": "^6.5.1 < 6.10"
+    "qs": "^6.5.1 < 6.10",
+    "search-insights": "^2.0.5"
   },
   "devDependencies": {
     "@algolia/client-search": "4.10.3",
@@ -137,7 +138,6 @@
     "rollup-plugin-replace": "2.2.0",
     "rollup-plugin-uglify": "6.0.4",
     "scriptjs": "2.5.9",
-    "search-insights": "1.7.2",
     "semver": "6.3.0",
     "shelljs": "0.8.3",
     "shipjs": "0.21.0",
@@ -150,7 +150,7 @@
   "bundlesize": [
     {
       "path": "./dist/instantsearch.production.min.js",
-      "maxSize": "69 kB"
+      "maxSize": "69.25 kB"
     },
     {
       "path": "./dist/instantsearch.development.js",