react-instantsearch-core 7.38.0 → 7.39.0

package/dist/cjs/version.js

@@ -9,4 +9,4 @@ Object.defineProperty(exports, "default", {
         return _default;
     }
 });
-var _default = '7.38.0';
+var _default = '7.39.0';

package/dist/es/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "7.38.0";
+declare const _default: "7.39.0";
 export default _default;

package/dist/es/version.js

@@ -1,3 +1,3 @@
-var version = '7.38.0';
+var version = '7.39.0';
 
 export { version as default };

package/dist/umd/ReactInstantSearchCore.js

@@ -1,4 +1,4 @@
-/*! React InstantSearch Core 7.38.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! React InstantSearch Core 7.39.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
 (function (global, factory) {
     typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('react')) :
     typeof define === 'function' && define.amd ? define(['exports', 'react'], factory) :
@@ -24,7 +24,7 @@
 
     var React__namespace = /*#__PURE__*/_interopNamespaceDefault(React);
 
-    var version$2 = '7.38.0';
+    var version$2 = '7.39.0';
 
     function _define_property(obj, key, value) {
         if (key in obj) {
@@ -571,10 +571,10 @@
         return objectHasKeys_1;
     }
 
-    var omit;
+    var omit$1;
     var hasRequiredOmit;
     function requireOmit() {
-        if (hasRequiredOmit) return omit;
+        if (hasRequiredOmit) return omit$1;
         hasRequiredOmit = 1;
         // https://github.com/babel/babel/blob/3aaafae053fa75febb3aa45d45b6f00646e30ba4/packages/babel-helpers/src/helpers.js#L604-L620
         function _objectWithoutPropertiesLoose(source, excluded) {
@@ -591,8 +591,8 @@
             }
             return target;
         }
-        omit = _objectWithoutPropertiesLoose;
-        return omit;
+        omit$1 = _objectWithoutPropertiesLoose;
+        return omit$1;
     }
 
     var RecommendParameters_1;
@@ -3919,7 +3919,7 @@
     function requireVersion() {
         if (hasRequiredVersion) return version$1;
         hasRequiredVersion = 1;
-        version$1 = '3.29.1';
+        version$1 = '3.29.2';
         return version$1;
     }
 
@@ -7267,19 +7267,23 @@
         return widget.$$type === 'ais.dynamicWidgets' || widget.$$type === 'ais.feeds';
     }
 
-    function range(param) {
-        var _param_start = param.start, start = _param_start === void 0 ? 0 : _param_start, end = param.end, _param_step = param.step, step = _param_step === void 0 ? 1 : _param_step;
-        // We can't divide by 0 so we re-assign the step to 1 if it happens.
-        var limitStep = step === 0 ? 1 : step;
-        // In some cases the array to create has a decimal length.
-        // We therefore need to round the value.
-        // Example:
-        //   { start: 1, end: 5000, step: 500 }
-        //   => Array length = (5000 - 1) / 500 = 9.998
-        var arrayLength = Math.round((end - start) / limitStep);
-        return _to_consumable_array(Array(arrayLength)).map(function(_, current) {
-            return start + current * limitStep;
-        });
+    /**
+     * Creates a new object with the same keys as the original object, but without the excluded keys.
+     * @param source original object
+     * @param excluded keys to remove from the original object
+     * @returns the new object
+     */ function omit(source, excluded) {
+        if (source === null || source === undefined) {
+            return source;
+        }
+        return Object.keys(source).reduce(function(target, key) {
+            if (excluded.indexOf(key) >= 0) {
+                return target;
+            }
+            var validKey = key;
+            target[validKey] = source[validKey];
+            return target;
+        }, {});
     }
 
     function createInitArgs(instantSearchInstance, parent, uiState) {
@@ -7327,6 +7331,132 @@
         instantSearchInstance.renderState = _object_spread_props(_object_spread({}, instantSearchInstance.renderState), _define_property({}, parentIndexName, _object_spread({}, instantSearchInstance.renderState[parentIndexName], renderState)));
     }
 
+    function serializeParamValue(value) {
+        if (value === undefined || value === null) {
+            return null;
+        }
+        var t = typeof value === "undefined" ? "undefined" : _type_of(value);
+        if (t === 'string' || t === 'number' || t === 'boolean') {
+            return {
+                value: String(value),
+                type: t
+            };
+        }
+        if (Array.isArray(value) || t === 'object') {
+            var type = Array.isArray(value) ? 'array' : 'object';
+            try {
+                return {
+                    value: JSON.stringify(value),
+                    type: type
+                };
+            } catch (unused) {
+                return {
+                    type: type
+                };
+            }
+        }
+        if (t === 'function') {
+            return {
+                value: value.name,
+                type: 'function'
+            };
+        }
+        // symbols, DOM elements: name only
+        return null;
+    }
+    /**
+     * Turns a `widgetParams`-style record into the serialized `WidgetTreeParam[]`
+     * shape used throughout the usage events. Shared between the widget tree and
+     * the root `ais.instantSearch` node so every node reports params identically.
+     */ function serializeWidgetParams(widgetParams) {
+        var params = [];
+        Object.keys(widgetParams).forEach(function(key) {
+            var raw = widgetParams[key];
+            if (raw === undefined) {
+                return;
+            }
+            var serialized = serializeParamValue(raw);
+            if (serialized) {
+                params.push(_object_spread({
+                    name: key
+                }, serialized));
+            } else {
+                params.push({
+                    name: key
+                });
+            }
+        });
+        return params;
+    }
+    function buildWidgetTree(widgets, instantSearchInstance) {
+        var parent = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : instantSearchInstance.mainIndex;
+        var initOptions = createInitArgs(instantSearchInstance, parent, instantSearchInstance._initialUiState);
+        return widgets.map(function(widget) {
+            var widgetParams = {};
+            if (widget.getWidgetRenderState) {
+                var renderState = widget.getWidgetRenderState(initOptions);
+                if (renderState && renderState.widgetParams) {
+                    widgetParams = renderState.widgetParams;
+                }
+            }
+            var params = serializeWidgetParams(widgetParams);
+            var children = isIndexWidget(widget) ? buildWidgetTree(widget.getWidgets(), instantSearchInstance, widget) : [];
+            return {
+                type: widget.$$widgetType || widget.$$type || 'unknown',
+                params: params,
+                children: children
+            };
+        });
+    }
+
+    function extractWidgetPayload(widgets, instantSearchInstance, payload) {
+        var parent = arguments.length > 3 && arguments[3] !== void 0 ? arguments[3] : instantSearchInstance.mainIndex;
+        var initOptions = createInitArgs(instantSearchInstance, parent, instantSearchInstance._initialUiState);
+        widgets.forEach(function(widget) {
+            var widgetParams = {};
+            if (widget.getWidgetRenderState) {
+                var renderState = widget.getWidgetRenderState(initOptions);
+                if (renderState && renderState.widgetParams) {
+                    // casting, as we just earlier checked widgetParams exists, and thus an object
+                    widgetParams = renderState.widgetParams;
+                }
+            }
+            // since we destructure in all widgets, the parameters with defaults are set to "undefined"
+            var params = Object.keys(widgetParams).filter(function(key) {
+                return widgetParams[key] !== undefined;
+            });
+            payload.widgets.push({
+                type: widget.$$type,
+                widgetType: widget.$$widgetType,
+                params: params
+            });
+            if (isIndexWidget(widget)) {
+                extractWidgetPayload(widget.getWidgets(), instantSearchInstance, payload, widget);
+            }
+        });
+    }
+
+    var now = typeof performance !== 'undefined' ? function() {
+        return performance.now();
+    } : function() {
+        return Date.now();
+    };
+
+    function range(param) {
+        var _param_start = param.start, start = _param_start === void 0 ? 0 : _param_start, end = param.end, _param_step = param.step, step = _param_step === void 0 ? 1 : _param_step;
+        // We can't divide by 0 so we re-assign the step to 1 if it happens.
+        var limitStep = step === 0 ? 1 : step;
+        // In some cases the array to create has a decimal length.
+        // We therefore need to round the value.
+        // Example:
+        //   { start: 1, end: 5000, step: 500 }
+        //   => Array length = (5000 - 1) / 500 = 9.998
+        var arrayLength = Math.round((end - start) / limitStep);
+        return _to_consumable_array(Array(arrayLength)).map(function(_, current) {
+            return start + current * limitStep;
+        });
+    }
+
     function resolveSearchParameters(current) {
         var parent = current.getParent();
         var states = [
@@ -9062,6 +9192,8 @@
         });
     }
 
+    var version = '4.105.0';
+
     var ANONYMOUS_TOKEN_COOKIE_KEY = '_ALGOLIA';
     function getCookie(name) {
         if ((typeof document === "undefined" ? "undefined" : _type_of(document)) !== 'object' || typeof document.cookie !== 'string') {
@@ -9084,8 +9216,61 @@
         return getCookie(ANONYMOUS_TOKEN_COOKIE_KEY);
     }
 
+    var USAGE_SESSION_KEY = 'ais.usage.sessionId';
+    // Cache the id for the lifetime of the runtime so repeated calls don't hit
+    // `sessionStorage` again, and so we always return the same id even when
+    // storage is unavailable (SSR, privacy mode) and we fall back to a fresh UUID.
+    var usageSessionId = null;
+    function getUsageSessionId() {
+        if (usageSessionId) {
+            return usageSessionId;
+        }
+        try {
+            var existing = sessionStorage.getItem(USAGE_SESSION_KEY);
+            if (existing) {
+                usageSessionId = existing;
+                return usageSessionId;
+            }
+            usageSessionId = createUUID();
+            sessionStorage.setItem(USAGE_SESSION_KEY, usageSessionId);
+            return usageSessionId;
+        } catch (unused) {
+            // sessionStorage unavailable (SSR, privacy mode, etc.)
+            usageSessionId = createUUID();
+            return usageSessionId;
+        }
+    }
+    /** @deprecated use bindEvent instead */ function writeDataAttributes(param) {
+        var method = param.method, payload = param.payload;
+        if ((typeof payload === "undefined" ? "undefined" : _type_of(payload)) !== 'object') {
+            throw new Error("The insights helper expects the payload to be an object.");
+        }
+        var serializedPayload;
+        try {
+            serializedPayload = serializePayload(payload);
+        } catch (error) {
+            throw new Error("Could not JSON serialize the payload object.");
+        }
+        return 'data-insights-method="'.concat(method, '" data-insights-payload="').concat(serializedPayload, '"');
+    }
+    /**
+     * @deprecated This function will be still supported in 4.x releases, but not further. It is replaced by the `insights` middleware. For more information, visit https://www.algolia.com/doc/guides/getting-insights-and-analytics/search-analytics/click-through-and-conversions/how-to/send-click-and-conversion-events-with-instantsearch/js/
+     */ function insights(method, payload) {
+        return writeDataAttributes({
+            method: method,
+            payload: payload
+        });
+    }
+
     var ALGOLIA_INSIGHTS_VERSION = '2.17.2';
     var ALGOLIA_INSIGHTS_SRC = "https://cdn.jsdelivr.net/npm/search-insights@".concat(ALGOLIA_INSIGHTS_VERSION, "/dist/search-insights.min.js");
+    // InstantSearch options that must never be sent in usage events because
+    // they carry credentials or end-user data. Everything else is reported as-is.
+    var SENSITIVE_OPTIONS = [
+        'searchClient',
+        'insightsClient',
+        'initialUiState'
+    ];
     function createInsightsMiddleware() {
         var props = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         var _insightsClient = props.insightsClient, insightsInitParams = props.insightsInitParams, onEvent = props.onEvent, _props_$$internal = props.$$internal, $$internal = _props_$$internal === void 0 ? false : _props_$$internal, _props_$$automatic = props.$$automatic, $$automatic = _props_$$automatic === void 0 ? false : _props_$$automatic;
@@ -9175,6 +9360,7 @@
             }
             var initialParameters;
             var helper;
+            var removeStartEventListener = null;
             return {
                 $$type: 'ais.insights',
                 $$internal: $$internal,
@@ -9349,8 +9535,65 @@
                             insightsClientWithLocalCredentials(event.insightsMethod, event.payload);
                         } else ;
                     };
+                    // usage tracking (browser-only)
+                    safelyRunOnBrowser(function() {
+                        var usageSessionId = getUsageSessionId();
+                        function sendUsageEvent(event) {
+                            var _helper_state;
+                            var userToken = (_helper_state = helper.state) === null || _helper_state === void 0 ? void 0 : _helper_state.userToken;
+                            insightsClientWithLocalCredentials('sendEvents', [
+                                _object_spread({
+                                    eventType: 'instantsearch',
+                                    timestamp: Date.now(),
+                                    sessionID: usageSessionId,
+                                    userToken: userToken ? String(userToken) : undefined
+                                }, event)
+                            ]);
+                        }
+                        // Send the start event on the first `render`, by which point every
+                        // flavor has registered its widgets. `bootstrapMs` then measures the
+                        // time between the constructor running and that point, so for flavors
+                        // that register widgets right at start (e.g. React) it captures the
+                        // cost of adding them.
+                        var sendStartEvent = function sendStartEvent() {
+                            try {
+                                var bootstrapMs = Math.round(now() - instantSearchInstance._createdAt);
+                                sendUsageEvent({
+                                    eventName: '__start__',
+                                    algoliaAgent: getAlgoliaAgent(instantSearchInstance.client),
+                                    version: version,
+                                    applicationId: appId,
+                                    performance: {
+                                        bootstrapMs: bootstrapMs
+                                    },
+                                    widgets: [
+                                        {
+                                            type: 'ais.instantSearch',
+                                            // The options the instance was created with, serialized the
+                                            // same way every widget's params are. Derived dynamically from
+                                            // `_initialOptions` so new options are reported automatically,
+                                            // minus the keys that carry credentials or user data. Functions
+                                            // (`onStateChange`, `searchFunction`) report their `fn.name`
+                                            // when present, tagged `type: 'function'`.
+                                            params: instantSearchInstance._initialOptions ? serializeWidgetParams(omit(instantSearchInstance._initialOptions, _to_consumable_array(SENSITIVE_OPTIONS))) : [],
+                                            children: buildWidgetTree(instantSearchInstance.mainIndex.getWidgets(), instantSearchInstance)
+                                        }
+                                    ]
+                                });
+                            } catch (unused) {
+                            // usage tracking must never crash the host app
+                            }
+                        };
+                        instantSearchInstance.once('render', sendStartEvent);
+                        removeStartEventListener = function removeStartEventListener() {
+                            return instantSearchInstance.removeListener('render', sendStartEvent);
+                        };
+                    });
                 },
                 unsubscribe: function unsubscribe() {
+                    if (removeStartEventListener) {
+                        removeStartEventListener();
+                    }
                     insightsClient('onUserTokenChange', undefined);
                     instantSearchInstance.sendEventToInsights = noop;
                     if (helper && initialParameters) {
@@ -9398,31 +9641,6 @@
         return typeof userToken === 'number' ? userToken.toString() : userToken;
     }
 
-    function extractWidgetPayload(widgets, instantSearchInstance, payload) {
-        var initOptions = createInitArgs(instantSearchInstance, instantSearchInstance.mainIndex, instantSearchInstance._initialUiState);
-        widgets.forEach(function(widget) {
-            var widgetParams = {};
-            if (widget.getWidgetRenderState) {
-                var renderState = widget.getWidgetRenderState(initOptions);
-                if (renderState && renderState.widgetParams) {
-                    // casting, as we just earlier checked widgetParams exists, and thus an object
-                    widgetParams = renderState.widgetParams;
-                }
-            }
-            // since we destructure in all widgets, the parameters with defaults are set to "undefined"
-            var params = Object.keys(widgetParams).filter(function(key) {
-                return widgetParams[key] !== undefined;
-            });
-            payload.widgets.push({
-                type: widget.$$type,
-                widgetType: widget.$$widgetType,
-                params: params
-            });
-            if (isIndexWidget(widget)) {
-                extractWidgetPayload(widget.getWidgets(), instantSearchInstance, payload);
-            }
-        });
-    }
     function isMetadataEnabled() {
         return safelyRunOnBrowser(function(param) {
             var window = param.window;
@@ -10771,28 +10989,6 @@
         return reverseHighlightedValue.replace(new RegExp(TAG_REPLACEMENT.highlightPreTag, 'g'), "<".concat(highlightedTagName, ' class="').concat(className, '">')).replace(new RegExp(TAG_REPLACEMENT.highlightPostTag, 'g'), "</".concat(highlightedTagName, ">"));
     }
 
-    /** @deprecated use bindEvent instead */ function writeDataAttributes(param) {
-        var method = param.method, payload = param.payload;
-        if ((typeof payload === "undefined" ? "undefined" : _type_of(payload)) !== 'object') {
-            throw new Error("The insights helper expects the payload to be an object.");
-        }
-        var serializedPayload;
-        try {
-            serializedPayload = serializePayload(payload);
-        } catch (error) {
-            throw new Error("Could not JSON serialize the payload object.");
-        }
-        return 'data-insights-method="'.concat(method, '" data-insights-payload="').concat(serializedPayload, '"');
-    }
-    /**
-     * @deprecated This function will be still supported in 4.x releases, but not further. It is replaced by the `insights` middleware. For more information, visit https://www.algolia.com/doc/guides/getting-insights-and-analytics/search-analytics/click-through-and-conversions/how-to/send-click-and-conversion-events-with-instantsearch/js/
-     */ function insights(method, payload) {
-        return writeDataAttributes({
-            method: method,
-            payload: payload
-        });
-    }
-
     function hoganHelpers(param) {
         var numberLocale = param.numberLocale;
         return {
@@ -10854,8 +11050,6 @@
         };
     }
 
-    var version = '4.104.0';
-
     var withUsage$r = createDocumentationMessageGenerator({
         name: 'instantsearch'
     });
@@ -10875,7 +11069,14 @@
         function InstantSearch(options) {
             _class_call_check(this, InstantSearch);
             var _this;
-            _this = _call_super(this, InstantSearch), _define_property(_this, "client", void 0), _define_property(_this, "indexName", void 0), _define_property(_this, "compositionID", void 0), _define_property(_this, "insightsClient", void 0), _define_property(_this, "onStateChange", null), _define_property(_this, "future", void 0), _define_property(_this, "helper", void 0), _define_property(_this, "mainHelper", void 0), _define_property(_this, "mainIndex", void 0), _define_property(_this, "started", void 0), _define_property(_this, "templatesConfig", void 0), _define_property(_this, "renderState", {}), _define_property(_this, "_stalledSearchDelay", void 0), _define_property(_this, "_searchStalledTimer", void 0), _define_property(_this, "_initialUiState", void 0), _define_property(_this, "_initialResults", void 0), _define_property(_this, "_manuallyResetScheduleSearch", false), _define_property(_this, "_resetScheduleSearch", void 0), _define_property(_this, "_createURL", void 0), _define_property(_this, "_searchFunction", void 0), _define_property(_this, "_mainHelperSearch", void 0), _define_property(_this, "_hasSearchWidget", false), _define_property(_this, "_hasRecommendWidget", false), _define_property(_this, "_insights", void 0), _define_property(_this, "middleware", []), _define_property(_this, "sendEventToInsights", void 0), /**
+            _this = _call_super(this, InstantSearch), _define_property(_this, "client", void 0), _define_property(_this, "indexName", void 0), _define_property(_this, "compositionID", void 0), _define_property(_this, "insightsClient", void 0), _define_property(_this, "onStateChange", null), _define_property(_this, "future", void 0), _define_property(_this, "helper", void 0), _define_property(_this, "mainHelper", void 0), _define_property(_this, "mainIndex", void 0), _define_property(_this, "started", void 0), _define_property(_this, "templatesConfig", void 0), _define_property(_this, "renderState", {}), _define_property(_this, "_stalledSearchDelay", void 0), _define_property(_this, "_searchStalledTimer", void 0), _define_property(_this, "_initialUiState", void 0), _define_property(_this, "_initialResults", void 0), _define_property(_this, "_manuallyResetScheduleSearch", false), _define_property(_this, "_resetScheduleSearch", void 0), _define_property(_this, "_createURL", void 0), _define_property(_this, "_searchFunction", void 0), _define_property(_this, "_mainHelperSearch", void 0), _define_property(_this, "_hasSearchWidget", false), _define_property(_this, "_hasRecommendWidget", false), _define_property(_this, "_insights", void 0), /**
+       * The options the instance was created with, kept verbatim so consumers
+       * (e.g. usage events) can introspect the configuration without the class
+       * having to enumerate every option by hand. Typed without the class generics
+       * on purpose: referencing `TUiState`/`TRouteState` here (they sit in
+       * contravariant positions inside `InstantSearchOptions`) would break the
+       * assignability of `InstantSearch<SpecificUiState>` to `InstantSearch`.
+       */ _define_property(_this, "_initialOptions", void 0), _define_property(_this, "middleware", []), _define_property(_this, "sendEventToInsights", void 0), _define_property(_this, "_createdAt", now()), /**
        * The status of the search. Can be "idle", "loading", "stalled", or "error".
        */ _define_property(_this, "status", 'idle'), /**
        * The last returned error from the Search API.
@@ -10923,6 +11124,7 @@
             if (insightsClient && typeof insightsClient !== 'function') {
                 throw new Error(withUsage$r('The `insightsClient` option should be a function.'));
             }
+            _this._initialOptions = options;
             _this.client = searchClient;
             _this.future = future;
             _this.insightsClient = insightsClient;
@@ -11295,6 +11497,9 @@
                         var instance = param.instance;
                         instance.unsubscribe();
                     });
+                    // Cleared after unsubscribe so in-flight readers (e.g. the insights
+                    // start-event listener) have detached before the reference goes away.
+                    this._initialOptions = null;
                 }
             },
             {