instantsearch.js 4.54.1 → 4.55.0

package/es/middlewares/createMetadataMiddleware.js

@@ -1,5 +1,5 @@
 import { createInitArgs, safelyRunOnBrowser } from "../lib/utils/index.js";
-function extractPayload(widgets, instantSearchInstance, payload) {
+function extractWidgetPayload(widgets, instantSearchInstance, payload) {
   var initOptions = createInitArgs(instantSearchInstance, instantSearchInstance.mainIndex, instantSearchInstance._initialUiState);
   widgets.forEach(function (widget) {
     var widgetParams = {};
@@ -21,7 +21,7 @@ function extractPayload(widgets, instantSearchInstance, payload) {
       params: params
     });
     if (widget.$$type === 'ais.index') {
-      extractPayload(widget.getWidgets(), instantSearchInstance, payload);
+      extractWidgetPayload(widget.getWidgets(), instantSearchInstance, payload);
     }
   });
 }
@@ -45,8 +45,11 @@ export function isMetadataEnabled() {
  * - connector name
  */
 export function createMetadataMiddleware() {
-  return function (_ref2) {
-    var instantSearchInstance = _ref2.instantSearchInstance;
+  var _ref2 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+    _ref2$$$internal = _ref2.$$internal,
+    $$internal = _ref2$$$internal === void 0 ? false : _ref2$$$internal;
+  return function (_ref3) {
+    var instantSearchInstance = _ref3.instantSearchInstance;
     var payload = {
       widgets: []
     };
@@ -54,13 +57,22 @@ export function createMetadataMiddleware() {
     var refNode = document.querySelector('head');
     payloadContainer.name = 'instantsearch:widgets';
     return {
+      $$type: 'ais.metadata',
+      $$internal: $$internal,
       onStateChange: function onStateChange() {},
       subscribe: function subscribe() {
         // using setTimeout here to delay extraction until widgets have been added in a tick (e.g. Vue)
         setTimeout(function () {
           var client = instantSearchInstance.client;
           payload.ua = client.transporter && client.transporter.userAgent ? client.transporter.userAgent.value : client._ua;
-          extractPayload(instantSearchInstance.mainIndex.getWidgets(), instantSearchInstance, payload);
+          extractWidgetPayload(instantSearchInstance.mainIndex.getWidgets(), instantSearchInstance, payload);
+          instantSearchInstance.middleware.forEach(function (middleware) {
+            return payload.widgets.push({
+              middleware: true,
+              type: middleware.instance.$$type,
+              internal: middleware.instance.$$internal
+            });
+          });
           payloadContainer.content = JSON.stringify(payload);
           refNode.appendChild(payloadContainer);
         }, 0);

package/es/middlewares/createRouterMiddleware.js

@@ -12,7 +12,9 @@ export var createRouterMiddleware = function createRouterMiddleware() {
   var _props$router = props.router,
     router = _props$router === void 0 ? historyRouter() : _props$router,
     _props$stateMapping = props.stateMapping,
-    stateMapping = _props$stateMapping === void 0 ? simpleStateMapping() : _props$stateMapping;
+    stateMapping = _props$stateMapping === void 0 ? simpleStateMapping() : _props$stateMapping,
+    _props$$$internal = props.$$internal,
+    $$internal = _props$$$internal === void 0 ? false : _props$$$internal;
   return function (_ref) {
     var instantSearchInstance = _ref.instantSearchInstance;
     function topLevelCreateURL(nextState) {
@@ -29,6 +31,8 @@ export var createRouterMiddleware = function createRouterMiddleware() {
     var lastRouteState = undefined;
     var initialUiState = instantSearchInstance._initialUiState;
     return {
+      $$type: "ais.router({router:".concat(router.$$type || '__unknown__', ", stateMapping:").concat(stateMapping.$$type || '__unknown__', "})"),
+      $$internal: $$internal,
       onStateChange: function onStateChange(_ref2) {
         var uiState = _ref2.uiState;
         var routeState = stateMapping.stateToRoute(uiState);

package/es/types/insights.d.ts

@@ -1,6 +1,24 @@
-import type { InsightsMethodMap, InsightsClient as _InsightsClient } from 'search-insights';
+import type { Hit } from './results';
+import type { InsightsMethodMap as _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 type InsightsMethodMap = _InsightsMethodMap;
 export type InsightsClientMethod = keyof InsightsMethodMap;
+/**
+ * Method allowed by the insights middleware.
+ */
+export type InsightsMethod = 'clickedObjectIDsAfterSearch' | 'clickedObjectIDs' | 'clickedFilters' | 'convertedObjectIDsAfterSearch' | 'convertedObjectIDs' | 'convertedFilters' | 'viewedObjectIDs' | 'viewedFilters';
+/**
+ * The event sent to the insights middleware.
+ */
+export type InsightsEvent<TMethod extends InsightsMethod = InsightsMethod> = {
+    insightsMethod?: TMethod;
+    payload: InsightsMethodMap[TMethod][0];
+    widgetType: string;
+    eventType: string;
+    eventModifier?: string;
+    hits?: Hit[];
+    attribute?: string;
+};
 export type InsightsClientPayload = {
     eventName: string;
     queryID: string;

package/es/types/middleware.d.ts

@@ -2,11 +2,27 @@ import type InstantSearch from '../lib/InstantSearch';
 import type { UiState } from './ui-state';
 import type { AtLeastOne } from './utils';
 export type MiddlewareDefinition<TUiState extends UiState = UiState> = {
+    /**
+     * string to identify the middleware
+     */
+    $$type: string;
+    /**
+     * Change handler called on every UiState change
+     */
     onStateChange(options: {
         uiState: TUiState;
     }): void;
+    /**
+     * Called when the middleware is added to InstantSearch
+     */
     subscribe(): void;
+    /**
+     * Called when InstantSearch is started
+     */
     started(): void;
+    /**
+     * Called when the middleware is removed from InstantSearch
+     */
     unsubscribe(): void;
 };
 export type MiddlewareOptions = {

package/es/types/router.d.ts

@@ -34,6 +34,10 @@ export type Router<TRouteState = UiState> = {
      * Called when InstantSearch is started.
      */
     start?: () => void;
+    /**
+     * Identifier for this router. Used to differentiate between routers.
+     */
+    $$type?: string;
 };
 /**
  * The state mapping is a way to customize the structure before sending it to the router.
@@ -55,4 +59,8 @@ export type StateMapping<TUiState = UiState, TRouteState = TUiState> = {
      * The format is the output of `stateToRoute`.
      */
     routeToState(routeState: TRouteState): TUiState;
+    /**
+     * Identifier for this stateMapping. Used to differentiate between stateMappings.
+     */
+    $$type?: string;
 };

package/es/widgets/hits/hits.js

@@ -8,7 +8,7 @@ import { cx } from '@algolia/ui-components-shared';
 import { h, render } from 'preact';
 import Hits from "../../components/Hits/Hits.js";
 import connectHits from "../../connectors/hits/connectHits.js";
-import { withInsights, withInsightsListener } from "../../lib/insights/index.js";
+import { withInsights } from "../../lib/insights/index.js";
 import { component } from "../../lib/suit.js";
 import { prepareTemplateProps } from "../../lib/templating/index.js";
 import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
@@ -17,7 +17,6 @@ var withUsage = createDocumentationMessageGenerator({
   name: 'hits'
 });
 var suit = component('Hits');
-var HitsWithInsightsListener = withInsightsListener(Hits);
 var renderer = function renderer(_ref) {
   var renderState = _ref.renderState,
     cssClasses = _ref.cssClasses,
@@ -38,7 +37,7 @@ var renderer = function renderer(_ref) {
       });
       return;
     }
-    render(h(HitsWithInsightsListener, {
+    render(h(Hits, {
       cssClasses: cssClasses,
       hits: receivedHits,
       results: results,

package/es/widgets/infinite-hits/infinite-hits.js

@@ -8,7 +8,7 @@ import { cx } from '@algolia/ui-components-shared';
 import { h, render } from 'preact';
 import InfiniteHits from "../../components/InfiniteHits/InfiniteHits.js";
 import connectInfiniteHits from "../../connectors/infinite-hits/connectInfiniteHits.js";
-import { withInsights, withInsightsListener } from "../../lib/insights/index.js";
+import { withInsights } from "../../lib/insights/index.js";
 import { component } from "../../lib/suit.js";
 import { prepareTemplateProps } from "../../lib/templating/index.js";
 import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
@@ -17,7 +17,6 @@ var withUsage = createDocumentationMessageGenerator({
   name: 'infinite-hits'
 });
 var suit = component('InfiniteHits');
-var InfiniteHitsWithInsightsListener = withInsightsListener(InfiniteHits);
 var renderer = function renderer(_ref) {
   var containerNode = _ref.containerNode,
     cssClasses = _ref.cssClasses,
@@ -43,7 +42,7 @@ var renderer = function renderer(_ref) {
       });
       return;
     }
-    render(h(InfiniteHitsWithInsightsListener, {
+    render(h(InfiniteHits, {
       cssClasses: cssClasses,
       hits: hits,
       results: results,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.54.1",
+  "version": "4.55.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",
@@ -38,7 +38,7 @@
     "htm": "^3.0.0",
     "preact": "^10.10.0",
     "qs": "^6.5.1 < 6.10",
-    "search-insights": "^2.1.0"
+    "search-insights": "^2.6.0"
   },
   "peerDependencies": {
     "algoliasearch": ">= 3.1 < 6"
@@ -55,9 +55,9 @@
     "version": "./scripts/version/update-version.js"
   },
   "devDependencies": {
-    "@instantsearch/mocks": "1.11.0",
-    "@instantsearch/tests": "1.11.0",
-    "@instantsearch/testutils": "1.0.14",
+    "@instantsearch/mocks": "1.12.0",
+    "@instantsearch/tests": "1.12.0",
+    "@instantsearch/testutils": "1.1.0",
     "@storybook/html": "5.3.9",
     "@types/scriptjs": "0.0.2",
     "algoliasearch": "4.14.3",
@@ -65,5 +65,5 @@
     "scriptjs": "2.5.9",
     "webpack": "4.41.5"
   },
-  "gitHead": "1f81b61cf0e78aeb7022d5e9eca0d49de727dc64"
+  "gitHead": "c483ae31e1e615be61dffb5d0bc04a4927960a67"
 }