algolia-experiences 1.8.16 → 1.8.18

package/README.md

@@ -1,6 +1,6 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
 - [`algolia-experiences`](#algolia-experiences)
   - [Usage](#usage)
 

package/dist/algolia-experiences.development.js

@@ -1,4 +1,4 @@
-/*! algolia-experiences 1.8.16 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! algolia-experiences 1.8.18 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
 (function (factory) {
     typeof define === 'function' && define.amd ? define(factory) :
     factory();
@@ -4987,7 +4987,7 @@
     function requireVersion() {
         if (hasRequiredVersion) return version$1;
         hasRequiredVersion = 1;
-        version$1 = '3.29.2';
+        version$1 = '3.29.3';
         return version$1;
     }
 
@@ -6886,7 +6886,7 @@
         });
     }
 
-    var version = '4.107.0';
+    var version = '4.109.0';
 
     var ANONYMOUS_TOKEN_COOKIE_KEY = '_ALGOLIA';
     function getCookie(name) {
@@ -7374,7 +7374,8 @@
                             helper.overrideStateWithoutTriggeringChangeEvent(_object_spread_props(_object_spread({}, helper.state), {
                                 userToken: normalizedUserToken
                             }));
-                            if (existingToken && existingToken !== userToken) {
+                            if (existingToken && existingToken !== normalizedUserToken) {
+                                helper._recommendCache = {};
                                 instantSearchInstance.scheduleSearch();
                             }
                         }
@@ -7463,14 +7464,17 @@
                         } else if (event.insightsMethod) {
                             if (event.insightsMethod === 'viewedObjectIDs') {
                                 var payload = event.payload;
+                                var getViewEventKey = function getViewEventKey(objectID) {
+                                    return payload.queryID ? "".concat(payload.queryID, ":").concat(objectID) : objectID;
+                                };
                                 var difference = payload.objectIDs.filter(function(objectID) {
-                                    return !viewedObjectIDs.has(objectID);
+                                    return !viewedObjectIDs.has(getViewEventKey(objectID));
                                 });
                                 if (difference.length === 0) {
                                     return;
                                 }
                                 difference.forEach(function(objectID) {
-                                    return viewedObjectIDs.add(objectID);
+                                    return viewedObjectIDs.add(getViewEventKey(objectID));
                                 });
                                 payload.objectIDs = difference;
                             }
@@ -7578,10 +7582,10 @@
      * and the ability to set credentials via extra parameters when sending events.
      */ function isModernInsightsClient(client) {
         var _split_map = _sliced_to_array((client.version || '').split('.').map(Number), 2), major = _split_map[0], minor = _split_map[1];
-        /* eslint-disable instantsearch/naming-convention */ var v3 = major >= 3;
+        /* oxlint-disable instantsearch/naming-convention */ var v3 = major >= 3;
         var v2_6 = major === 2 && minor >= 6;
         var v1_10 = major === 1 && minor >= 10;
-        /* eslint-enable instantsearch/naming-convention */ return v3 || v2_6 || v1_10;
+        /* oxlint-enable instantsearch/naming-convention */ return v3 || v2_6 || v1_10;
     }
     /**
      * While `search-insights` supports both string and number user tokens,
@@ -9040,6 +9044,38 @@
         return states;
     }
 
+    /**
+     * Forwards the insights-related search parameters to every Recommend query.
+     *
+     * The insights middleware writes `userToken` and `clickAnalytics` on the main
+     * helper's search state, which only feeds search queries: Recommend queries are
+     * built from their own parameters and never read the search state. Without this,
+     * recommendations can't be personalized, and their responses carry no `queryID`
+     * for the connectors to attribute click and conversion events with.
+     *
+     * Parameters set on a widget win, so an explicit `queryParameters.userToken`
+     * keeps overriding the middleware.
+     */ function addInsightsToRecommendParameters(recommendParameters, param) {
+        var userToken = param.userToken, clickAnalytics = param.clickAnalytics;
+        if (userToken === undefined && clickAnalytics === undefined) {
+            return recommendParameters;
+        }
+        return new algoliasearchHelper.RecommendParameters({
+            params: recommendParameters.params.map(function(params) {
+                // v4 `TrendingFacetsQuery` doesn't include `queryParameters`, but the v5
+                // API and the helper support them, like `connectTrendingFacets` does.
+                var queryParameters = params.queryParameters;
+                return _object_spread_props(_object_spread({}, params), {
+                    queryParameters: _object_spread({}, clickAnalytics === undefined ? {} : {
+                        clickAnalytics: clickAnalytics
+                    }, userToken === undefined ? {} : {
+                        userToken: userToken
+                    }, queryParameters)
+                });
+            })
+        });
+    }
+
     function createDocumentationLink(param) {
         var name = param.name, _param_connector = param.connector, connector = _param_connector === void 0 ? false : _param_connector;
         return [
@@ -9324,12 +9360,13 @@
         instantSearchInstance._hasRecommendWidget = hasRecommendWidget;
     }
     var index = function index(widgetParams) {
-        if (widgetParams === undefined || widgetParams.indexName === undefined && !widgetParams.EXPERIMENTAL_isolated) {
+        var _widgetParams_EXPERIMENTAL_isolated;
+        if (widgetParams === undefined || widgetParams.indexName === undefined && !widgetParams.isolated && !widgetParams.EXPERIMENTAL_isolated) {
             throw new Error(withUsage$K('The `indexName` option is required.'));
         }
         // When isolated=true, we use an empty string as the default indexName.
         // This is intentional: isolated indices do not require a real index name.
-        var _widgetParams_indexName = widgetParams.indexName, indexName = _widgetParams_indexName === void 0 ? '' : _widgetParams_indexName, _widgetParams_indexId = widgetParams.indexId, indexId = _widgetParams_indexId === void 0 ? indexName : _widgetParams_indexId, tmp = widgetParams.EXPERIMENTAL_isolated, isolated = tmp === void 0 ? false : tmp;
+        var _widgetParams_indexName = widgetParams.indexName, indexName = _widgetParams_indexName === void 0 ? '' : _widgetParams_indexName, _widgetParams_indexId = widgetParams.indexId, indexId = _widgetParams_indexId === void 0 ? indexName : _widgetParams_indexId, _widgetParams_isolated = widgetParams.isolated, isolated = _widgetParams_isolated === void 0 ? (_widgetParams_EXPERIMENTAL_isolated = widgetParams.EXPERIMENTAL_isolated) !== null && _widgetParams_EXPERIMENTAL_isolated !== void 0 ? _widgetParams_EXPERIMENTAL_isolated : false : _widgetParams_isolated;
         var localWidgets = [];
         var localUiState = {};
         var localInstantSearchInstance = null;
@@ -9617,7 +9654,7 @@
                         mainHelper.state
                     ].concat(_to_consumable_array(resolveSearchParameters(_this))));
                 }, function() {
-                    return _this.getHelper().recommendState;
+                    return addInsightsToRecommendParameters(_this.getHelper().recommendState, mainHelper.state);
                 });
                 var indexInitialResults = (_instantSearchInstance__initialResults = instantSearchInstance._initialResults) === null || _instantSearchInstance__initialResults === void 0 ? void 0 : _instantSearchInstance__initialResults[this.getIndexId()];
                 if (indexInitialResults === null || indexInitialResults === void 0 ? void 0 : indexInitialResults.results) {
@@ -11410,6 +11447,22 @@
         };
     }
 
+    function updateNavigationButtonsProps(param) {
+        var listRef = param.listRef, nextButtonRef = param.nextButtonRef, previousButtonRef = param.previousButtonRef, setCanScrollLeft = param.setCanScrollLeft, setCanScrollRight = param.setCanScrollRight;
+        if (!listRef.current) {
+            return;
+        }
+        var isLeftHidden = listRef.current.scrollLeft <= 0;
+        var isRightHidden = listRef.current.scrollLeft + listRef.current.clientWidth >= listRef.current.scrollWidth;
+        setCanScrollLeft(!isLeftHidden);
+        setCanScrollRight(!isRightHidden);
+        if (previousButtonRef.current) {
+            previousButtonRef.current.hidden = isLeftHidden;
+        }
+        if (nextButtonRef.current) {
+            nextButtonRef.current.hidden = isRightHidden;
+        }
+    }
     var lastCarouselId = 0;
     function generateCarouselId() {
         return "ais-Carousel-".concat(lastCarouselId++);
@@ -11443,7 +11496,7 @@
         }));
     }
     function createCarouselComponent(param) {
-        var createElement = param.createElement, Fragment = param.Fragment;
+        var createElement = param.createElement, Fragment = param.Fragment, useEffect = param.useEffect, useRef = param.useRef;
         return function Carousel(userProps) {
             var listRef = userProps.listRef, nextButtonRef = userProps.nextButtonRef, previousButtonRef = userProps.previousButtonRef, carouselIdRef = userProps.carouselIdRef, canScrollLeft = userProps.canScrollLeft, canScrollRight = userProps.canScrollRight, setCanScrollLeft = userProps.setCanScrollLeft, setCanScrollRight = userProps.setCanScrollRight, _userProps_classNames = userProps.classNames, classNames = _userProps_classNames === void 0 ? {} : _userProps_classNames, tmp = userProps.itemComponent, ItemComponent = tmp === void 0 ? createDefaultItemComponent({
                 createElement: createElement,
@@ -11474,6 +11527,7 @@
                 previousButtonLabel: 'Previous',
                 previousButtonTitle: 'Previous'
             }, userTranslations);
+            var previousItemsLengthRef = useRef(items.length);
             var cssClasses = {
                 root: cx('ais-Carousel', classNames.root),
                 list: cx('ais-Carousel-list', classNames.list),
@@ -11492,27 +11546,33 @@
                     listRef.current.scrollLeft += listRef.current.offsetWidth * 0.75;
                 }
             }
-            function updateNavigationButtonsProps() {
-                if (!listRef.current) {
-                    return;
-                }
-                var isLeftHidden = listRef.current.scrollLeft <= 0;
-                var isRightHidden = listRef.current.scrollLeft + listRef.current.clientWidth >= listRef.current.scrollWidth;
-                setCanScrollLeft(!isLeftHidden);
-                setCanScrollRight(!isRightHidden);
-                if (previousButtonRef.current) {
-                    previousButtonRef.current.hidden = isLeftHidden;
-                }
-                if (nextButtonRef.current) {
-                    nextButtonRef.current.hidden = isRightHidden;
+            useEffect(function() {
+                if (previousItemsLengthRef.current !== items.length) {
+                    updateNavigationButtonsProps({
+                        listRef: listRef,
+                        nextButtonRef: nextButtonRef,
+                        previousButtonRef: previousButtonRef,
+                        setCanScrollLeft: setCanScrollLeft,
+                        setCanScrollRight: setCanScrollRight
+                    });
+                    previousItemsLengthRef.current = items.length;
                 }
-            }
+            }, [
+                items.length,
+                listRef,
+                nextButtonRef,
+                previousButtonRef,
+                setCanScrollLeft,
+                setCanScrollRight
+            ]);
             if (items.length === 0) {
                 return null;
             }
+            var itemOccurrences = new Map();
             return /*#__PURE__*/ createElement("div", _object_spread_props(_object_spread({}, props), {
                 className: cx(cssClasses.root)
             }), HeaderComponent && /*#__PURE__*/ createElement(HeaderComponent, {
+                nbItems: items.length,
                 canScrollLeft: canScrollLeft,
                 canScrollRight: canScrollRight,
                 scrollLeft: scrollLeft,
@@ -11538,7 +11598,15 @@
                 "aria-roledescription": "carousel",
                 "aria-label": translations.listLabel,
                 "aria-live": "polite",
-                onScroll: updateNavigationButtonsProps,
+                onScroll: function onScroll() {
+                    return updateNavigationButtonsProps({
+                        listRef: listRef,
+                        nextButtonRef: nextButtonRef,
+                        previousButtonRef: previousButtonRef,
+                        setCanScrollLeft: setCanScrollLeft,
+                        setCanScrollRight: setCanScrollRight
+                    });
+                },
                 onKeyDown: function onKeyDown(event) {
                     if (event.key === 'ArrowLeft') {
                         event.preventDefault();
@@ -11549,8 +11617,14 @@
                     }
                 }
             }, items.map(function(item, index) {
+                var _itemOccurrences_get;
+                var occurrence = (_itemOccurrences_get = itemOccurrences.get(item.objectID)) !== null && _itemOccurrences_get !== void 0 ? _itemOccurrences_get : 0;
+                itemOccurrences.set(item.objectID, occurrence + 1);
                 return /*#__PURE__*/ createElement("li", {
-                    key: item.objectID,
+                    key: JSON.stringify([
+                        item.objectID,
+                        occurrence
+                    ]),
                     className: cx(cssClasses.item),
                     "aria-roledescription": "slide",
                     "aria-label": "".concat(index + 1, " of ").concat(items.length),
@@ -11978,7 +12052,9 @@
 
     var Carousel = createCarouselComponent({
         createElement: h$1,
-        Fragment: p$1
+        Fragment: p$1,
+        useEffect: s,
+        useRef: A
     });
     function CarouselWithRefs(props) {
         var _useState = _sliced_to_array(y(false), 2), canScrollLeft = _useState[0], setCanScrollLeft = _useState[1];
@@ -11997,28 +12073,31 @@
     }
     function carousel() {
         var _ref = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {}, cssClasses = _ref.cssClasses, _ref_templates = _ref.templates, templates = _ref_templates === void 0 ? {} : _ref_templates, _ref_showNavigation = _ref.showNavigation, showNavigation = _ref_showNavigation === void 0 ? true : _ref_showNavigation;
+        var previous = templates.previous, next = templates.next, header = templates.header;
+        var HeaderComponent = header ? function(props) {
+            return header(_object_spread({
+                html: m$1
+            }, props));
+        } : undefined;
+        var PreviousIconComponent = previous ? function() {
+            return previous({
+                html: m$1
+            });
+        } : undefined;
+        var NextIconComponent = next ? function() {
+            return next({
+                html: m$1
+            });
+        } : undefined;
         return function CarouselTemplate(param) {
             var items = param.items, widgetTemplates = param.templates, tmp = param.cssClasses, widgetCssClasses = tmp === void 0 ? {} : tmp, _param_sendEvent = param.sendEvent, sendEvent = _param_sendEvent === void 0 ? function() {} : _param_sendEvent;
-            var previous = templates.previous, next = templates.next, header = templates.header;
             return /*#__PURE__*/ h$1(CarouselWithRefs, {
                 items: items,
                 sendEvent: sendEvent,
                 itemComponent: widgetTemplates.item,
-                headerComponent: header ? function(props) {
-                    return header(_object_spread({
-                        html: m$1
-                    }, props));
-                } : undefined,
-                previousIconComponent: previous ? function() {
-                    return previous({
-                        html: m$1
-                    });
-                } : undefined,
-                nextIconComponent: next ? function() {
-                    return next({
-                        html: m$1
-                    });
-                } : undefined,
+                headerComponent: HeaderComponent,
+                previousIconComponent: PreviousIconComponent,
+                nextIconComponent: NextIconComponent,
                 classNames: _object_spread({}, cssClasses, {
                     list: cx(cssClasses === null || cssClasses === void 0 ? void 0 : cssClasses.list, widgetCssClasses === null || widgetCssClasses === void 0 ? void 0 : widgetCssClasses.list),
                     item: cx(cssClasses === null || cssClasses === void 0 ? void 0 : cssClasses.item, widgetCssClasses === null || widgetCssClasses === void 0 ? void 0 : widgetCssClasses.item)
@@ -13280,7 +13359,7 @@
     // it is non-empty and the chat is not already processing a message.
     // Returns true when a message was submitted, so callers can clear their input.
     function openChat(chatRenderState) {
-        var _ref = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {}, message = _ref.message, referer = _ref.referer;
+        var _ref = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {}, message = _ref.message, referer = _ref.referer, turnContext = _ref.turnContext;
         var _ref1;
         var _chatRenderState_setOpen;
         if (!chatRenderState) {
@@ -13296,9 +13375,13 @@
         if (isChatBusy(chatRenderState) || !chatRenderState.sendMessage) {
             return false;
         }
-        chatRenderState.sendMessage({
+        chatRenderState.sendMessage(_object_spread({
             text: trimmed
-        }, referer ? {
+        }, turnContext ? {
+            metadata: {
+                turnContext: turnContext
+            }
+        } : {}), referer ? {
             headers: {
                 'x-algolia-referer': referer
             }