instantsearch.js 4.54.0 → 4.55.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. package/cjs/components/Hits/Hits.js +16 -7
  2. package/cjs/components/InfiniteHits/InfiniteHits.js +13 -2
  3. package/cjs/components/Pagination/Pagination.js +35 -17
  4. package/cjs/components/Template/Template.js +6 -3
  5. package/cjs/connectors/autocomplete/connectAutocomplete.js +1 -1
  6. package/cjs/connectors/geo-search/connectGeoSearch.js +1 -1
  7. package/cjs/connectors/hierarchical-menu/connectHierarchicalMenu.js +1 -1
  8. package/cjs/connectors/hits/connectHits.js +1 -1
  9. package/cjs/connectors/infinite-hits/connectInfiniteHits.js +39 -31
  10. package/cjs/connectors/menu/connectMenu.js +1 -1
  11. package/cjs/connectors/numeric-menu/connectNumericMenu.js +1 -1
  12. package/cjs/connectors/rating-menu/connectRatingMenu.js +7 -3
  13. package/cjs/connectors/refinement-list/connectRefinementList.js +1 -1
  14. package/cjs/connectors/toggle-refinement/connectToggleRefinement.js +14 -4
  15. package/cjs/helpers/highlight.js +5 -0
  16. package/cjs/helpers/insights.js +3 -4
  17. package/cjs/helpers/reverseHighlight.js +5 -0
  18. package/cjs/helpers/reverseSnippet.js +5 -0
  19. package/cjs/helpers/snippet.js +5 -0
  20. package/cjs/lib/InstantSearch.js +18 -2
  21. package/cjs/lib/insights/listener.js +43 -36
  22. package/cjs/lib/routers/history.js +1 -0
  23. package/cjs/lib/server.js +60 -0
  24. package/cjs/lib/stateMappings/simple.js +1 -0
  25. package/cjs/lib/stateMappings/singleIndex.js +1 -0
  26. package/cjs/lib/utils/createSendEventForFacet.js +12 -2
  27. package/cjs/lib/utils/createSendEventForHits.js +34 -11
  28. package/cjs/lib/utils/index.js +11 -0
  29. package/cjs/lib/utils/walkIndex.js +18 -0
  30. package/cjs/lib/version.js +1 -1
  31. package/cjs/middlewares/createInsightsMiddleware.js +135 -33
  32. package/cjs/middlewares/createMetadataMiddleware.js +17 -5
  33. package/cjs/middlewares/createRouterMiddleware.js +5 -1
  34. package/cjs/widgets/hits/hits.js +1 -2
  35. package/cjs/widgets/infinite-hits/infinite-hits.js +1 -2
  36. package/cjs/widgets/pagination/pagination.js +51 -39
  37. package/cjs/widgets/panel/panel.js +0 -2
  38. package/dist/instantsearch.development.d.ts +94 -12
  39. package/dist/instantsearch.development.js +543 -312
  40. package/dist/instantsearch.development.js.map +1 -1
  41. package/dist/instantsearch.production.d.ts +94 -12
  42. package/dist/instantsearch.production.min.d.ts +94 -12
  43. package/dist/instantsearch.production.min.js +2 -2
  44. package/dist/instantsearch.production.min.js.map +1 -1
  45. package/es/components/Hits/Hits.d.ts +5 -5
  46. package/es/components/Hits/Hits.js +15 -5
  47. package/es/components/InfiniteHits/InfiniteHits.d.ts +3 -2
  48. package/es/components/InfiniteHits/InfiniteHits.js +13 -2
  49. package/es/components/Pagination/Pagination.js +34 -17
  50. package/es/components/Panel/Panel.d.ts +1 -1
  51. package/es/components/Template/Template.js +6 -3
  52. package/es/connectors/autocomplete/connectAutocomplete.js +1 -1
  53. package/es/connectors/geo-search/connectGeoSearch.js +1 -1
  54. package/es/connectors/hierarchical-menu/connectHierarchicalMenu.js +1 -1
  55. package/es/connectors/hits/connectHits.js +1 -1
  56. package/es/connectors/infinite-hits/connectInfiniteHits.js +39 -31
  57. package/es/connectors/menu/connectMenu.js +1 -1
  58. package/es/connectors/numeric-menu/connectNumericMenu.js +1 -1
  59. package/es/connectors/rating-menu/connectRatingMenu.js +7 -3
  60. package/es/connectors/refinement-list/connectRefinementList.js +1 -1
  61. package/es/connectors/toggle-refinement/connectToggleRefinement.js +13 -3
  62. package/es/helpers/highlight.d.ts +3 -0
  63. package/es/helpers/highlight.js +5 -0
  64. package/es/helpers/insights.d.ts +2 -1
  65. package/es/helpers/insights.js +3 -3
  66. package/es/helpers/reverseHighlight.d.ts +3 -0
  67. package/es/helpers/reverseHighlight.js +5 -0
  68. package/es/helpers/reverseSnippet.d.ts +3 -0
  69. package/es/helpers/reverseSnippet.js +5 -0
  70. package/es/helpers/snippet.d.ts +3 -0
  71. package/es/helpers/snippet.js +5 -0
  72. package/es/lib/InstantSearch.d.ts +11 -1
  73. package/es/lib/InstantSearch.js +18 -2
  74. package/es/lib/insights/listener.d.ts +10 -6
  75. package/es/lib/insights/listener.js +42 -36
  76. package/es/lib/routers/history.d.ts +1 -0
  77. package/es/lib/routers/history.js +1 -0
  78. package/es/lib/server.d.ts +10 -0
  79. package/es/lib/server.js +53 -0
  80. package/es/lib/stateMappings/simple.js +1 -0
  81. package/es/lib/stateMappings/singleIndex.js +1 -0
  82. package/es/lib/utils/createSendEventForFacet.js +12 -2
  83. package/es/lib/utils/createSendEventForHits.d.ts +8 -0
  84. package/es/lib/utils/createSendEventForHits.js +33 -11
  85. package/es/lib/utils/index.d.ts +1 -0
  86. package/es/lib/utils/index.js +1 -0
  87. package/es/lib/utils/walkIndex.d.ts +5 -0
  88. package/es/lib/utils/walkIndex.js +12 -0
  89. package/es/lib/version.d.ts +1 -1
  90. package/es/lib/version.js +1 -1
  91. package/es/middlewares/createInsightsMiddleware.d.ts +12 -12
  92. package/es/middlewares/createInsightsMiddleware.js +136 -34
  93. package/es/middlewares/createMetadataMiddleware.d.ts +3 -1
  94. package/es/middlewares/createMetadataMiddleware.js +17 -5
  95. package/es/middlewares/createRouterMiddleware.js +5 -1
  96. package/es/types/insights.d.ts +19 -1
  97. package/es/types/middleware.d.ts +16 -0
  98. package/es/types/router.d.ts +8 -0
  99. package/es/widgets/hits/hits.js +2 -3
  100. package/es/widgets/infinite-hits/infinite-hits.js +2 -3
  101. package/es/widgets/pagination/pagination.d.ts +12 -5
  102. package/es/widgets/pagination/pagination.js +51 -39
  103. package/es/widgets/panel/panel.js +0 -2
  104. package/package.json +6 -6
@@ -14,35 +14,69 @@ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _ty
14
14
  function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
15
15
  function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
16
16
  function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
17
- function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
18
- function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
19
17
  function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
20
18
  function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
21
- function createInsightsMiddleware(props) {
22
- var _ref = props || {},
23
- _insightsClient = _ref.insightsClient,
24
- insightsInitParams = _ref.insightsInitParams,
25
- onEvent = _ref.onEvent;
26
- if (_insightsClient !== null && !_insightsClient) {
27
- if (process.env.NODE_ENV === 'development') {
28
- throw new Error("The `insightsClient` option is required if you want userToken to be automatically set in search calls. If you don't want this behaviour, set it to `null`.");
29
- } else {
30
- throw new Error('The `insightsClient` option is required. To disable, set it to `null`.');
31
- }
19
+ function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
20
+ function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
21
+ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
22
+ function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
23
+ function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
24
+ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
25
+ var ALGOLIA_INSIGHTS_VERSION = '2.6.0';
26
+ var ALGOLIA_INSIGHTS_SRC = "https://cdn.jsdelivr.net/npm/search-insights@".concat(ALGOLIA_INSIGHTS_VERSION, "/dist/search-insights.min.js");
27
+ function createInsightsMiddleware() {
28
+ var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
29
+ var _insightsClient = props.insightsClient,
30
+ insightsInitParams = props.insightsInitParams,
31
+ onEvent = props.onEvent,
32
+ _props$$$internal = props.$$internal,
33
+ $$internal = _props$$$internal === void 0 ? false : _props$$$internal;
34
+ var potentialInsightsClient = _insightsClient;
35
+ if (!_insightsClient && _insightsClient !== null) {
36
+ (0, _utils.safelyRunOnBrowser)(function (_ref) {
37
+ var window = _ref.window;
38
+ var pointer = window.AlgoliaAnalyticsObject || 'aa';
39
+ if (typeof pointer === 'string') {
40
+ potentialInsightsClient = window[pointer];
41
+ }
42
+ if (!potentialInsightsClient) {
43
+ window.AlgoliaAnalyticsObject = pointer;
44
+ if (!window[pointer]) {
45
+ window[pointer] = function () {
46
+ if (!window[pointer].queue) {
47
+ window[pointer].queue = [];
48
+ }
49
+ for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
50
+ args[_key] = arguments[_key];
51
+ }
52
+ window[pointer].queue.push(args);
53
+ };
54
+ window[pointer].version = ALGOLIA_INSIGHTS_VERSION;
55
+ window[pointer].shouldAddScript = true;
56
+ }
57
+ potentialInsightsClient = window[pointer];
58
+ }
59
+ });
32
60
  }
33
- var hasInsightsClient = Boolean(_insightsClient);
34
- var insightsClient = _insightsClient === null ? _utils.noop : _insightsClient;
61
+ // if still no insightsClient was found, we use a noop
62
+ var insightsClient = potentialInsightsClient || _utils.noop;
35
63
  return function (_ref2) {
36
64
  var instantSearchInstance = _ref2.instantSearchInstance;
65
+ // remove existing default insights middleware
66
+ // user-provided insights middleware takes precedence
67
+ var existingInsightsMiddlewares = instantSearchInstance.middleware.filter(function (m) {
68
+ return m.instance.$$type === 'ais.insights' && m.instance.$$internal;
69
+ }).map(function (m) {
70
+ return m.creator;
71
+ });
72
+ instantSearchInstance.unuse.apply(instantSearchInstance, _toConsumableArray(existingInsightsMiddlewares));
37
73
  var _getAppIdAndApiKey = (0, _utils.getAppIdAndApiKey)(instantSearchInstance.client),
38
74
  _getAppIdAndApiKey2 = _slicedToArray(_getAppIdAndApiKey, 2),
39
75
  appId = _getAppIdAndApiKey2[0],
40
76
  apiKey = _getAppIdAndApiKey2[1];
41
77
 
42
78
  // search-insights.js also throws an error so dev-only clarification is sufficient
43
- if (process.env.NODE_ENV === 'development' && !(appId && apiKey)) {
44
- throw new Error('[insights middleware]: could not extract Algolia credentials from searchClient');
45
- }
79
+ process.env.NODE_ENV === 'development' ? (0, _utils.warning)(Boolean(appId && apiKey), 'could not extract Algolia credentials from searchClient in insights middleware.') : void 0;
46
80
  var queuedUserToken = undefined;
47
81
  var userTokenBeforeInit = undefined;
48
82
  if (Array.isArray(insightsClient.queue)) {
@@ -72,15 +106,39 @@ function createInsightsMiddleware(props) {
72
106
  // Otherwise, the `init` call might override it with anonymous user token.
73
107
  userTokenBeforeInit = userToken;
74
108
  });
75
- insightsClient('init', _objectSpread({
76
- appId: appId,
77
- apiKey: apiKey
78
- }, insightsInitParams));
109
+
110
+ // Only `init` if the `insightsInitParams` option is passed or
111
+ // if the `insightsClient` version doesn't supports optional `init` calling.
112
+ if (insightsInitParams || !isModernInsightsClient(insightsClient)) {
113
+ insightsClient('init', _objectSpread({
114
+ appId: appId,
115
+ apiKey: apiKey,
116
+ partial: true
117
+ }, insightsInitParams));
118
+ }
79
119
  var initialParameters;
80
120
  var helper;
81
121
  return {
122
+ $$type: 'ais.insights',
123
+ $$internal: $$internal,
82
124
  onStateChange: function onStateChange() {},
83
- subscribe: function subscribe() {},
125
+ subscribe: function subscribe() {
126
+ if (!insightsClient.shouldAddScript) return;
127
+ var errorMessage = '[insights middleware]: could not load search-insights.js. Please load it manually following https://alg.li/insights-init';
128
+ try {
129
+ var script = document.createElement('script');
130
+ script.async = true;
131
+ script.src = ALGOLIA_INSIGHTS_SRC;
132
+ script.onerror = function () {
133
+ instantSearchInstance.emit('error', new Error(errorMessage));
134
+ };
135
+ document.body.appendChild(script);
136
+ insightsClient.shouldAddScript = false;
137
+ } catch (cause) {
138
+ insightsClient.shouldAddScript = false;
139
+ instantSearchInstance.emit('error', new Error(errorMessage));
140
+ }
141
+ },
84
142
  started: function started() {
85
143
  insightsClient('addAlgoliaAgent', 'insights-middleware');
86
144
  helper = instantSearchInstance.helper;
@@ -91,15 +149,23 @@ function createInsightsMiddleware(props) {
91
149
  helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread(_objectSpread({}, helper.state), {}, {
92
150
  clickAnalytics: true
93
151
  }));
94
- instantSearchInstance.scheduleSearch();
152
+ if (!$$internal) {
153
+ instantSearchInstance.scheduleSearch();
154
+ }
95
155
  var setUserTokenToSearch = function setUserTokenToSearch(userToken) {
156
+ if (!userToken) {
157
+ return;
158
+ }
159
+ var existingToken = helper.state.userToken;
96
160
  helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread(_objectSpread({}, helper.state), {}, {
97
161
  userToken: userToken
98
162
  }));
99
- instantSearchInstance.scheduleSearch();
163
+ if (existingToken && existingToken !== userToken) {
164
+ instantSearchInstance.scheduleSearch();
165
+ }
100
166
  };
101
167
  var anonymousUserToken = (0, _helpers.getInsightsAnonymousUserTokenInternal)();
102
- if (hasInsightsClient && anonymousUserToken) {
168
+ if (anonymousUserToken) {
103
169
  // When `aa('init', { ... })` is called, it creates an anonymous user token in cookie.
104
170
  // We can set it as userToken.
105
171
  setUserTokenToSearch(anonymousUserToken);
@@ -108,8 +174,10 @@ function createInsightsMiddleware(props) {
108
174
  // We consider the `userToken` coming from a `init` call to have a higher
109
175
  // importance than the one coming from the queue.
110
176
  if (userTokenBeforeInit) {
177
+ setUserTokenToSearch(userTokenBeforeInit);
111
178
  insightsClient('setUserToken', userTokenBeforeInit);
112
179
  } else if (queuedUserToken) {
180
+ setUserTokenToSearch(queuedUserToken);
113
181
  insightsClient('setUserToken', queuedUserToken);
114
182
  }
115
183
 
@@ -117,16 +185,31 @@ function createInsightsMiddleware(props) {
117
185
  insightsClient('onUserTokenChange', setUserTokenToSearch, {
118
186
  immediate: true
119
187
  });
188
+ var insightsClientWithLocalCredentials = insightsClient;
189
+ if (isModernInsightsClient(insightsClient)) {
190
+ insightsClientWithLocalCredentials = function insightsClientWithLocalCredentials(method, payload) {
191
+ var extraParams = {
192
+ headers: {
193
+ 'X-Algolia-Application-Id': appId,
194
+ 'X-Algolia-API-Key': apiKey
195
+ }
196
+ };
197
+
198
+ // @ts-ignore we are calling this only when we know that the client actually is correct
199
+ return insightsClient(method, payload, extraParams);
200
+ };
201
+ }
120
202
  instantSearchInstance.sendEventToInsights = function (event) {
121
203
  if (onEvent) {
122
- onEvent(event, _insightsClient);
204
+ onEvent(event, insightsClientWithLocalCredentials);
123
205
  } else if (event.insightsMethod) {
124
- var hasUserToken = Boolean(helper.state.userToken);
125
- if (hasUserToken) {
126
- insightsClient(event.insightsMethod, event.payload);
127
- } else {
128
- process.env.NODE_ENV === 'development' ? (0, _utils.warning)(false, "\nCannot send event to Algolia Insights because `userToken` is not set.\n\nSee documentation: https://www.algolia.com/doc/guides/building-search-ui/going-further/send-insights-events/js/#setting-the-usertoken\n") : void 0;
206
+ // Source is used to differentiate events sent by instantsearch from those sent manually.
207
+ event.payload.algoliaSource = ['instantsearch'];
208
+ if (event.eventModifier === 'internal') {
209
+ event.payload.algoliaSource.push('instantsearch-internal');
129
210
  }
211
+ insightsClientWithLocalCredentials(event.insightsMethod, event.payload);
212
+ process.env.NODE_ENV === 'development' ? (0, _utils.warning)(Boolean(helper.state.userToken), "\nCannot send event to Algolia Insights because `userToken` is not set.\n\nSee documentation: https://www.algolia.com/doc/guides/building-search-ui/going-further/send-insights-events/js/#setting-the-usertoken\n") : void 0;
130
213
  } else {
131
214
  process.env.NODE_ENV === 'development' ? (0, _utils.warning)(false, 'Cannot send event to Algolia Insights because `insightsMethod` option is missing.') : void 0;
132
215
  }
@@ -136,10 +219,29 @@ function createInsightsMiddleware(props) {
136
219
  insightsClient('onUserTokenChange', undefined);
137
220
  instantSearchInstance.sendEventToInsights = _utils.noop;
138
221
  if (helper && initialParameters) {
139
- helper.setState(_objectSpread(_objectSpread({}, helper.state), initialParameters));
222
+ helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread(_objectSpread({}, helper.state), initialParameters));
140
223
  instantSearchInstance.scheduleSearch();
141
224
  }
142
225
  }
143
226
  };
144
227
  };
228
+ }
229
+
230
+ /**
231
+ * Determines if a given insights `client` supports the optional call to `init`
232
+ * and the ability to set credentials via extra parameters when sending events.
233
+ */
234
+ function isModernInsightsClient(client) {
235
+ var _split$map = (client.version || '').split('.').map(Number),
236
+ _split$map2 = _slicedToArray(_split$map, 2),
237
+ major = _split$map2[0],
238
+ minor = _split$map2[1];
239
+
240
+ /* eslint-disable @typescript-eslint/naming-convention */
241
+ var v3 = major >= 3;
242
+ var v2_6 = major === 2 && minor >= 6;
243
+ var v1_10 = major === 1 && minor >= 10;
244
+ /* eslint-enable @typescript-eslint/naming-convention */
245
+
246
+ return v3 || v2_6 || v1_10;
145
247
  }
@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports.createMetadataMiddleware = createMetadataMiddleware;
7
7
  exports.isMetadataEnabled = isMetadataEnabled;
8
8
  var _utils = require("../lib/utils");
9
- function extractPayload(widgets, instantSearchInstance, payload) {
9
+ function extractWidgetPayload(widgets, instantSearchInstance, payload) {
10
10
  var initOptions = (0, _utils.createInitArgs)(instantSearchInstance, instantSearchInstance.mainIndex, instantSearchInstance._initialUiState);
11
11
  widgets.forEach(function (widget) {
12
12
  var widgetParams = {};
@@ -28,7 +28,7 @@ function extractPayload(widgets, instantSearchInstance, payload) {
28
28
  params: params
29
29
  });
30
30
  if (widget.$$type === 'ais.index') {
31
- extractPayload(widget.getWidgets(), instantSearchInstance, payload);
31
+ extractWidgetPayload(widget.getWidgets(), instantSearchInstance, payload);
32
32
  }
33
33
  });
34
34
  }
@@ -52,8 +52,11 @@ function isMetadataEnabled() {
52
52
  * - connector name
53
53
  */
54
54
  function createMetadataMiddleware() {
55
- return function (_ref2) {
56
- var instantSearchInstance = _ref2.instantSearchInstance;
55
+ var _ref2 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
56
+ _ref2$$$internal = _ref2.$$internal,
57
+ $$internal = _ref2$$$internal === void 0 ? false : _ref2$$$internal;
58
+ return function (_ref3) {
59
+ var instantSearchInstance = _ref3.instantSearchInstance;
57
60
  var payload = {
58
61
  widgets: []
59
62
  };
@@ -61,13 +64,22 @@ function createMetadataMiddleware() {
61
64
  var refNode = document.querySelector('head');
62
65
  payloadContainer.name = 'instantsearch:widgets';
63
66
  return {
67
+ $$type: 'ais.metadata',
68
+ $$internal: $$internal,
64
69
  onStateChange: function onStateChange() {},
65
70
  subscribe: function subscribe() {
66
71
  // using setTimeout here to delay extraction until widgets have been added in a tick (e.g. Vue)
67
72
  setTimeout(function () {
68
73
  var client = instantSearchInstance.client;
69
74
  payload.ua = client.transporter && client.transporter.userAgent ? client.transporter.userAgent.value : client._ua;
70
- extractPayload(instantSearchInstance.mainIndex.getWidgets(), instantSearchInstance, payload);
75
+ extractWidgetPayload(instantSearchInstance.mainIndex.getWidgets(), instantSearchInstance, payload);
76
+ instantSearchInstance.middleware.forEach(function (middleware) {
77
+ return payload.widgets.push({
78
+ middleware: true,
79
+ type: middleware.instance.$$type,
80
+ internal: middleware.instance.$$internal
81
+ });
82
+ });
71
83
  payloadContainer.content = JSON.stringify(payload);
72
84
  refNode.appendChild(payloadContainer);
73
85
  }, 0);
@@ -19,7 +19,9 @@ var createRouterMiddleware = function createRouterMiddleware() {
19
19
  var _props$router = props.router,
20
20
  router = _props$router === void 0 ? (0, _history.default)() : _props$router,
21
21
  _props$stateMapping = props.stateMapping,
22
- stateMapping = _props$stateMapping === void 0 ? (0, _simple.default)() : _props$stateMapping;
22
+ stateMapping = _props$stateMapping === void 0 ? (0, _simple.default)() : _props$stateMapping,
23
+ _props$$$internal = props.$$internal,
24
+ $$internal = _props$$$internal === void 0 ? false : _props$$$internal;
23
25
  return function (_ref) {
24
26
  var instantSearchInstance = _ref.instantSearchInstance;
25
27
  function topLevelCreateURL(nextState) {
@@ -36,6 +38,8 @@ var createRouterMiddleware = function createRouterMiddleware() {
36
38
  var lastRouteState = undefined;
37
39
  var initialUiState = instantSearchInstance._initialUiState;
38
40
  return {
41
+ $$type: "ais.router({router:".concat(router.$$type || '__unknown__', ", stateMapping:").concat(stateMapping.$$type || '__unknown__', "})"),
42
+ $$internal: $$internal,
39
43
  onStateChange: function onStateChange(_ref2) {
40
44
  var uiState = _ref2.uiState;
41
45
  var routeState = stateMapping.stateToRoute(uiState);
@@ -24,7 +24,6 @@ var withUsage = (0, _utils.createDocumentationMessageGenerator)({
24
24
  name: 'hits'
25
25
  });
26
26
  var suit = (0, _suit.component)('Hits');
27
- var HitsWithInsightsListener = (0, _insights.withInsightsListener)(_Hits.default);
28
27
  var renderer = function renderer(_ref) {
29
28
  var renderState = _ref.renderState,
30
29
  cssClasses = _ref.cssClasses,
@@ -45,7 +44,7 @@ var renderer = function renderer(_ref) {
45
44
  });
46
45
  return;
47
46
  }
48
- (0, _preact.render)((0, _preact.h)(HitsWithInsightsListener, {
47
+ (0, _preact.render)((0, _preact.h)(_Hits.default, {
49
48
  cssClasses: cssClasses,
50
49
  hits: receivedHits,
51
50
  results: results,
@@ -24,7 +24,6 @@ var withUsage = (0, _utils.createDocumentationMessageGenerator)({
24
24
  name: 'infinite-hits'
25
25
  });
26
26
  var suit = (0, _suit.component)('InfiniteHits');
27
- var InfiniteHitsWithInsightsListener = (0, _insights.withInsightsListener)(_InfiniteHits.default);
28
27
  var renderer = function renderer(_ref) {
29
28
  var containerNode = _ref.containerNode,
30
29
  cssClasses = _ref.cssClasses,
@@ -50,7 +49,7 @@ var renderer = function renderer(_ref) {
50
49
  });
51
50
  return;
52
51
  }
53
- (0, _preact.render)((0, _preact.h)(InfiniteHitsWithInsightsListener, {
52
+ (0, _preact.render)((0, _preact.h)(_InfiniteHits.default, {
54
53
  cssClasses: cssClasses,
55
54
  hits: hits,
56
55
  results: results,
@@ -22,28 +22,40 @@ var withUsage = (0, _utils.createDocumentationMessageGenerator)({
22
22
  name: 'pagination'
23
23
  });
24
24
  var defaultTemplates = {
25
- previous: '‹',
26
- next: '',
27
- first: '«',
28
- last: '»'
25
+ previous: function previous() {
26
+ return '';
27
+ },
28
+ next: function next() {
29
+ return '›';
30
+ },
31
+ page: function page(_ref) {
32
+ var _page = _ref.page;
33
+ return "".concat(_page);
34
+ },
35
+ first: function first() {
36
+ return '«';
37
+ },
38
+ last: function last() {
39
+ return '»';
40
+ }
29
41
  };
30
- var renderer = function renderer(_ref) {
31
- var containerNode = _ref.containerNode,
32
- cssClasses = _ref.cssClasses,
33
- templates = _ref.templates,
34
- showFirst = _ref.showFirst,
35
- showLast = _ref.showLast,
36
- showPrevious = _ref.showPrevious,
37
- showNext = _ref.showNext,
38
- scrollToNode = _ref.scrollToNode;
39
- return function (_ref2, isFirstRendering) {
40
- var createURL = _ref2.createURL,
41
- currentRefinement = _ref2.currentRefinement,
42
- nbPages = _ref2.nbPages,
43
- pages = _ref2.pages,
44
- isFirstPage = _ref2.isFirstPage,
45
- isLastPage = _ref2.isLastPage,
46
- refine = _ref2.refine;
42
+ var renderer = function renderer(_ref2) {
43
+ var containerNode = _ref2.containerNode,
44
+ cssClasses = _ref2.cssClasses,
45
+ templates = _ref2.templates,
46
+ showFirst = _ref2.showFirst,
47
+ showLast = _ref2.showLast,
48
+ showPrevious = _ref2.showPrevious,
49
+ showNext = _ref2.showNext,
50
+ scrollToNode = _ref2.scrollToNode;
51
+ return function (_ref3, isFirstRendering) {
52
+ var createURL = _ref3.createURL,
53
+ currentRefinement = _ref3.currentRefinement,
54
+ nbPages = _ref3.nbPages,
55
+ pages = _ref3.pages,
56
+ isFirstPage = _ref3.isFirstPage,
57
+ isLastPage = _ref3.isLastPage,
58
+ refine = _ref3.refine;
47
59
  if (isFirstRendering) return;
48
60
  var setCurrentPage = function setCurrentPage(pageNumber) {
49
61
  refine(pageNumber);
@@ -69,24 +81,24 @@ var renderer = function renderer(_ref) {
69
81
  };
70
82
  };
71
83
  var pagination = function pagination(widgetParams) {
72
- var _ref3 = widgetParams || {},
73
- container = _ref3.container,
74
- _ref3$templates = _ref3.templates,
75
- userTemplates = _ref3$templates === void 0 ? {} : _ref3$templates,
76
- _ref3$cssClasses = _ref3.cssClasses,
77
- userCssClasses = _ref3$cssClasses === void 0 ? {} : _ref3$cssClasses,
78
- totalPages = _ref3.totalPages,
79
- padding = _ref3.padding,
80
- _ref3$showFirst = _ref3.showFirst,
81
- showFirst = _ref3$showFirst === void 0 ? true : _ref3$showFirst,
82
- _ref3$showLast = _ref3.showLast,
83
- showLast = _ref3$showLast === void 0 ? true : _ref3$showLast,
84
- _ref3$showPrevious = _ref3.showPrevious,
85
- showPrevious = _ref3$showPrevious === void 0 ? true : _ref3$showPrevious,
86
- _ref3$showNext = _ref3.showNext,
87
- showNext = _ref3$showNext === void 0 ? true : _ref3$showNext,
88
- _ref3$scrollTo = _ref3.scrollTo,
89
- userScrollTo = _ref3$scrollTo === void 0 ? 'body' : _ref3$scrollTo;
84
+ var _ref4 = widgetParams || {},
85
+ container = _ref4.container,
86
+ _ref4$templates = _ref4.templates,
87
+ userTemplates = _ref4$templates === void 0 ? {} : _ref4$templates,
88
+ _ref4$cssClasses = _ref4.cssClasses,
89
+ userCssClasses = _ref4$cssClasses === void 0 ? {} : _ref4$cssClasses,
90
+ totalPages = _ref4.totalPages,
91
+ padding = _ref4.padding,
92
+ _ref4$showFirst = _ref4.showFirst,
93
+ showFirst = _ref4$showFirst === void 0 ? true : _ref4$showFirst,
94
+ _ref4$showLast = _ref4.showLast,
95
+ showLast = _ref4$showLast === void 0 ? true : _ref4$showLast,
96
+ _ref4$showPrevious = _ref4.showPrevious,
97
+ showPrevious = _ref4$showPrevious === void 0 ? true : _ref4$showPrevious,
98
+ _ref4$showNext = _ref4.showNext,
99
+ showNext = _ref4$showNext === void 0 ? true : _ref4$showNext,
100
+ _ref4$scrollTo = _ref4.scrollTo,
101
+ userScrollTo = _ref4$scrollTo === void 0 ? 'body' : _ref4$scrollTo;
90
102
  if (!container) {
91
103
  throw new Error(withUsage('The `container` option is required.'));
92
104
  }
@@ -97,8 +97,6 @@ var panel = function panel(panelWidgetParams) {
97
97
  }
98
98
  var containerNode = (0, _utils.getContainerNode)(widgetParams.container);
99
99
  var defaultTemplates = {
100
- header: '',
101
- footer: '',
102
100
  collapseButtonText: function collapseButtonText(_ref4) {
103
101
  var isCollapsed = _ref4.collapsed;
104
102
  return "<svg\n class=\"".concat(cssClasses.collapseIcon, "\"\n style=\"width: 1em; height: 1em;\"\n viewBox=\"0 0 500 500\"\n >\n <path d=\"").concat(isCollapsed ? 'M100 250l300-150v300z' : 'M250 400l150-300H100z', "\" fill=\"currentColor\" />\n </svg>");