react-instantsearch 7.49.1 → 7.50.0

package/dist/cjs/widgets/Chat.js

@@ -13,7 +13,11 @@ _export(exports, {
     get Chat () {
         return Chat;
     },
-    get DisplayResultsToolType () {
+    get CompareProductsToolType () {
+        return _chat.CompareProductsToolType;
+    },
+    get // eslint-disable-next-line typescript/no-deprecated
+    DisplayResultsToolType () {
         return _chat.DisplayResultsToolType;
     },
     get GroupedResultsToolType () {
@@ -56,7 +60,8 @@ var _focusAfterReveal = require("instantsearch.js/cjs/lib/chat/focusAfterReveal"
 var _react = /*#__PURE__*/ _interop_require_wildcard._(require("react"));
 var _reactinstantsearchcore = require("react-instantsearch-core");
 var _useStickToBottom = require("../lib/useStickToBottom");
-var _DisplayResultsTool = require("./chat/tools/DisplayResultsTool");
+var _CompareProductsTool = require("./chat/tools/CompareProductsTool");
+var _GroupedResultsTool = require("./chat/tools/GroupedResultsTool");
 var _SearchIndexTool = require("./chat/tools/SearchIndexTool");
 var ChatUiComponent = (0, _instantsearchuicomponents.createChatComponent)({
     createElement: _react.createElement,
@@ -66,20 +71,15 @@ var ChatUiComponent = (0, _instantsearchuicomponents.createChatComponent)({
     useEffect: _react.useEffect
 });
 function createDefaultTools(itemComponent, getSearchPageURL) {
+    var groupedResultsTool = (0, _GroupedResultsTool.createGroupedResultsTool)(itemComponent);
     var _obj;
     return _obj = {}, _define_property._(_obj, _chat.SearchIndexToolType, _object_spread_props._(_object_spread._({}, (0, _SearchIndexTool.createCarouselTool)(true, itemComponent, getSearchPageURL)), {
         // The agent decides per turn whether the richer Grouped Results tool
         // takes over the rendering of the search results.
-        shouldRender: isDisplayResultsDisabled
-    })), _define_property._(_obj, _chat.RecommendToolType, (0, _SearchIndexTool.createCarouselTool)(false, itemComponent, getSearchPageURL)), _define_property._(_obj, _chat.DisplayResultsToolType, (0, _DisplayResultsTool.createGroupedResultsTool)(itemComponent)), _define_property._(_obj, _chat.GroupedResultsToolType, (0, _DisplayResultsTool.createGroupedResultsTool)(itemComponent)), _define_property._(_obj, _chat.MemorizeToolType, {}), _define_property._(_obj, _chat.MemorySearchToolType, {}), _define_property._(_obj, _chat.PonderToolType, {}), _obj;
-}
-/**
- * Whether the search tool renders its own results, i.e. the agent did not hand
- * the turn to the Grouped Results tool. Set on the message by the backend.
- */ function isDisplayResultsDisabled(param) {
-    var parentMessage = param.parentMessage;
-    var _parentMessage_metadata;
-    return ((_parentMessage_metadata = parentMessage.metadata) === null || _parentMessage_metadata === void 0 ? void 0 : _parentMessage_metadata.displayResultsEnabled) !== true;
+        shouldRender: _instantsearchuicomponents.shouldSearchToolRenderResults
+    })), _define_property._(_obj, _chat.RecommendToolType, (0, _SearchIndexTool.createCarouselTool)(false, itemComponent, getSearchPageURL)), _define_property._(_obj, _chat.GroupedResultsToolType, groupedResultsTool), // Agents configured before the rename still emit the legacy tool name.
+    // eslint-disable-next-line typescript/no-deprecated
+    _define_property._(_obj, _chat.DisplayResultsToolType, groupedResultsTool), _define_property._(_obj, _chat.CompareProductsToolType, (0, _CompareProductsTool.createCompareProductsTool)()), _define_property._(_obj, _chat.MemorizeToolType, {}), _define_property._(_obj, _chat.MemorySearchToolType, {}), _define_property._(_obj, _chat.PonderToolType, {}), _obj;
 }
 function mergeToolOptions(defaultTools, userTools) {
     if (!userTools) {

package/dist/cjs/widgets/CompareBar.js

@@ -0,0 +1,46 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "CompareBar", {
+    enumerable: true,
+    get: function() {
+        return CompareBar;
+    }
+});
+var _interop_require_wildcard = require("@swc/helpers/_/_interop_require_wildcard");
+var _object_without_properties = require("@swc/helpers/_/_object_without_properties");
+var _instantsearchuicomponents = require("instantsearch-ui-components");
+var _react = /*#__PURE__*/ _interop_require_wildcard._(require("react"));
+var _reactinstantsearchcore = require("react-instantsearch-core");
+var CompareBarUiComponent = (0, _instantsearchuicomponents.createCompareBarComponent)({
+    createElement: _react.createElement,
+    Fragment: _react.Fragment
+});
+function CompareBar(_0) {
+    var classNames = _0.classNames, translations = _0.translations, itemComponent = _0.itemComponent, props = _object_without_properties._(_0, [
+        "classNames",
+        "translations",
+        "itemComponent"
+    ]);
+    var _useCompare = (0, _reactinstantsearchcore.useCompare)(props, {
+        $$widgetType: 'ais.compareBar'
+    }), items = _useCompare.items, minItems = _useCompare.minItems, maxItems = _useCompare.maxItems, canCompare = _useCompare.canCompare, removeItem = _useCompare.removeItem, clearItems = _useCompare.clearItems, compare = _useCompare.compare;
+    return /*#__PURE__*/ _react.default.createElement(CompareBarUiComponent, {
+        items: items,
+        minItems: minItems,
+        maxItems: maxItems,
+        canCompare: canCompare,
+        onCompare: function onCompare() {
+            return compare();
+        },
+        onRemove: function onRemove(item) {
+            return removeItem(item.objectID);
+        },
+        onClear: clearItems,
+        itemComponent: itemComponent,
+        classNames: classNames,
+        translations: translations
+    });
+}

package/dist/cjs/widgets/chat/tools/CompareProductsTool.js

@@ -0,0 +1,50 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "createCompareProductsTool", {
+    enumerable: true,
+    get: function() {
+        return createCompareProductsTool;
+    }
+});
+var _interop_require_wildcard = require("@swc/helpers/_/_interop_require_wildcard");
+var _instantsearchuicomponents = require("instantsearch-ui-components");
+var _react = /*#__PURE__*/ _interop_require_wildcard._(require("react"));
+/**
+ * Builtin comparison tool (`algolia_compare_products`).
+ *
+ * Registered by default in the chat widget so the agent can trigger a grounded
+ * side-by-side comparison: its tool call names only the product objectIDs and
+ * the attribute keys, and every cell is hydrated client-side from the real
+ * `algolia_search_index` hits. The model never types a value, so it cannot
+ * hallucinate one. See `instantsearch-ui-components` `CompareProductsTool` for
+ * the contract, and `comparison-eval/README.md` for the study behind it.
+ */ function createCompareProductsTool(translations) {
+    var CompareProductsUIComponent = (0, _instantsearchuicomponents.createCompareProductsToolComponent)({
+        createElement: _react.createElement,
+        Fragment: _react.Fragment
+    });
+    var CompareProductsLayoutComponent = function CompareProductsLayoutComponent(toolProps) {
+        return /*#__PURE__*/ _react.default.createElement(CompareProductsUIComponent, {
+            toolProps: toolProps,
+            translations: translations
+        });
+    };
+    return {
+        layoutComponent: CompareProductsLayoutComponent,
+        // Client-side tool: acknowledge the call so the agent's turn can complete.
+        // The table itself is rendered from the call's input + real search hits.
+        onToolCall: function onToolCall(param) {
+            var input = param.input, addToolResult = param.addToolResult;
+            var objectIDs = input === null || input === void 0 ? void 0 : input.objectIDs;
+            addToolResult({
+                output: {
+                    status: 'displayed',
+                    objectIDs: Array.isArray(objectIDs) ? objectIDs : []
+                }
+            });
+        }
+    };
+}

package/dist/cjs/widgets/chat/tools/ComparisonTableTool.js

@@ -0,0 +1,40 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "createComparisonTableTool", {
+    enumerable: true,
+    get: function() {
+        return createComparisonTableTool;
+    }
+});
+var _interop_require_wildcard = require("@swc/helpers/_/_interop_require_wildcard");
+var _instantsearchuicomponents = require("instantsearch-ui-components");
+var _react = /*#__PURE__*/ _interop_require_wildcard._(require("react"));
+/**
+ * Grounded comparison-table tool (prototype).
+ *
+ * Renders a v2 `markdownTable` display block whose every cell is hydrated from
+ * the real `algolia_search_index` hits by objectID — the agent supplies only the
+ * objectIDs and the attribute keys, never the values. See
+ * `instantsearch-ui-components` `ComparisonTableTool` for the contract.
+ *
+ * Register under the display-results tool key (or a dedicated key) in
+ * `createDefaultTools` to have comparison answers rendered as a grounded table
+ * instead of the model-authored markdown table.
+ */ function createComparisonTableTool(translations) {
+    var ComparisonTableUIComponent = (0, _instantsearchuicomponents.createComparisonTableToolComponent)({
+        createElement: _react.createElement,
+        Fragment: _react.Fragment
+    });
+    var ComparisonTableLayoutComponent = function ComparisonTableLayoutComponent(toolProps) {
+        return /*#__PURE__*/ _react.default.createElement(ComparisonTableUIComponent, {
+            toolProps: toolProps,
+            translations: translations
+        });
+    };
+    return {
+        layoutComponent: ComparisonTableLayoutComponent
+    };
+}

package/dist/cjs/widgets/chat/tools/{DisplayResultsTool.js → GroupedResultsTool.js}

@@ -14,7 +14,7 @@ var _instantsearchuicomponents = require("instantsearch-ui-components");
 var _react = /*#__PURE__*/ _interop_require_wildcard._(require("react"));
 var _components = require("../../../components");
 function createGroupedResultsTool(itemComponent) {
-    var DisplayResultsUIComponent = (0, _instantsearchuicomponents.createDisplayResultsToolComponent)({
+    var GroupedResultsUIComponent = (0, _instantsearchuicomponents.createGroupedResultsToolComponent)({
         createElement: _react.createElement,
         Fragment: _react.Fragment,
         useEffect: _react.useEffect,
@@ -23,14 +23,14 @@ function createGroupedResultsTool(itemComponent) {
     var Button = (0, _instantsearchuicomponents.createButtonComponent)({
         createElement: _react.createElement
     });
-    var DisplayResultsCarouselHeader = function DisplayResultsCarouselHeader(param) {
+    var GroupedResultsCarouselHeader = function GroupedResultsCarouselHeader(param) {
         var nbItems = param.nbItems, canScrollLeft = param.canScrollLeft, canScrollRight = param.canScrollRight, scrollLeft = param.scrollLeft, scrollRight = param.scrollRight;
         return /*#__PURE__*/ _react.default.createElement("div", {
-            className: "ais-ChatToolDisplayResultsCarouselHeader"
+            className: "ais-ChatToolGroupedResultsCarouselHeader"
         }, /*#__PURE__*/ _react.default.createElement("div", {
-            className: "ais-ChatToolDisplayResultsCarouselHeaderCount"
+            className: "ais-ChatToolGroupedResultsCarouselHeaderCount"
         }, nbItems, " result", nbItems > 1 ? 's' : ''), /*#__PURE__*/ _react.default.createElement("div", {
-            className: "ais-ChatToolDisplayResultsCarouselHeaderScrollButtons"
+            className: "ais-ChatToolGroupedResultsCarouselHeaderScrollButtons"
         }, /*#__PURE__*/ _react.default.createElement(Button, {
             variant: "outline",
             size: "sm",
@@ -38,7 +38,7 @@ function createGroupedResultsTool(itemComponent) {
             "aria-label": "Previous",
             onClick: scrollLeft,
             disabled: !canScrollLeft,
-            className: "ais-ChatToolDisplayResultsCarouselHeaderScrollButton"
+            className: "ais-ChatToolGroupedResultsCarouselHeaderScrollButton"
         }, /*#__PURE__*/ _react.default.createElement(_instantsearchuicomponents.ChevronLeftIcon, {
             createElement: _react.createElement
         })), /*#__PURE__*/ _react.default.createElement(Button, {
@@ -48,13 +48,13 @@ function createGroupedResultsTool(itemComponent) {
             "aria-label": "Next",
             onClick: scrollRight,
             disabled: !canScrollRight,
-            className: "ais-ChatToolDisplayResultsCarouselHeaderScrollButton"
+            className: "ais-ChatToolGroupedResultsCarouselHeaderScrollButton"
         }, /*#__PURE__*/ _react.default.createElement(_instantsearchuicomponents.ChevronRightIcon, {
             createElement: _react.createElement
         }))));
     };
-    var DisplayResultsLayoutComponent = function DisplayResultsLayoutComponent(toolProps) {
-        return /*#__PURE__*/ _react.default.createElement(DisplayResultsUIComponent, {
+    var GroupedResultsLayoutComponent = function GroupedResultsLayoutComponent(toolProps) {
+        return /*#__PURE__*/ _react.default.createElement(GroupedResultsUIComponent, {
             toolProps: toolProps,
             groupCarouselComponent: function groupCarouselComponent(param) {
                 var items = param.items, sendEvent = param.sendEvent;
@@ -63,13 +63,13 @@ function createGroupedResultsTool(itemComponent) {
                     itemComponent: itemComponent,
                     sendEvent: sendEvent,
                     showNavigation: false,
-                    headerComponent: DisplayResultsCarouselHeader
+                    headerComponent: GroupedResultsCarouselHeader
                 });
             }
         });
     };
     return {
-        layoutComponent: DisplayResultsLayoutComponent,
+        layoutComponent: GroupedResultsLayoutComponent,
         streamInput: true
     };
 }

package/dist/cjs/widgets/index.js

@@ -9,6 +9,7 @@ _export_star._(require("./Breadcrumb"), exports);
 _export_star._(require("./Chat"), exports);
 _export_star._(require("./PromptSuggestions"), exports);
 _export_star._(require("./ChatTrigger"), exports);
+_export_star._(require("./CompareBar"), exports);
 _export_star._(require("./ClearRefinements"), exports);
 _export_star._(require("./CurrentRefinements"), exports);
 _export_star._(require("./FrequentlyBoughtTogether"), exports);

package/dist/es/index.js

@@ -2,10 +2,11 @@ export * from 'react-instantsearch-core';
 export { useStickToBottom } from './lib/useStickToBottom.js';
 export { Autocomplete, EXPERIMENTAL_Autocomplete } from './widgets/Autocomplete.js';
 export { Breadcrumb } from './widgets/Breadcrumb.js';
-export { DisplayResultsToolType, GroupedResultsToolType, MemorizeToolType, MemorySearchToolType, PonderToolType, RecommendToolType, SearchIndexToolType } from 'instantsearch.js/es/lib/chat/index.js';
+export { CompareProductsToolType, DisplayResultsToolType, GroupedResultsToolType, MemorizeToolType, MemorySearchToolType, PonderToolType, RecommendToolType, SearchIndexToolType } from 'instantsearch.js/es/lib/chat/index.js';
 export { Chat, createDefaultTools } from './widgets/Chat.js';
 export { PromptSuggestions } from './widgets/PromptSuggestions.js';
 export { ChatTrigger } from './widgets/ChatTrigger.js';
+export { CompareBar } from './widgets/CompareBar.js';
 export { ClearRefinements } from './widgets/ClearRefinements.js';
 export { CurrentRefinements } from './widgets/CurrentRefinements.js';
 export { FrequentlyBoughtTogether } from './widgets/FrequentlyBoughtTogether.js';

package/dist/es/widgets/Chat.d.ts

@@ -1,6 +1,6 @@
-import { SearchIndexToolType, RecommendToolType, MemorizeToolType, MemorySearchToolType, PonderToolType, DisplayResultsToolType, GroupedResultsToolType } from 'instantsearch.js/es/lib/chat';
+import { SearchIndexToolType, RecommendToolType, MemorizeToolType, MemorySearchToolType, PonderToolType, DisplayResultsToolType, CompareProductsToolType, GroupedResultsToolType } from 'instantsearch.js/es/lib/chat';
 import React from 'react';
-export { SearchIndexToolType, RecommendToolType, MemorizeToolType, MemorySearchToolType, PonderToolType, DisplayResultsToolType, GroupedResultsToolType, };
+export { SearchIndexToolType, RecommendToolType, MemorizeToolType, MemorySearchToolType, PonderToolType, DisplayResultsToolType, CompareProductsToolType, GroupedResultsToolType, };
 import type { ChatProps as ChatUiProps, ChatLayoutOwnProps, RecommendComponentProps, RecordWithObjectID, UserClientSideTool, UserClientSideTools, ChatMessageProps } from 'instantsearch-ui-components';
 import type { IndexUiState } from 'instantsearch.js';
 import type { UIMessage } from 'instantsearch.js/es/lib/chat';

package/dist/es/widgets/Chat.js

@@ -9,14 +9,15 @@ import { _ as _$8 } from '@swc/helpers/esm/_object_without_properties.js';
 import { _ as _$9 } from '@swc/helpers/esm/_sliced_to_array.js';
 import { _ as _$7 } from '@swc/helpers/esm/_to_array.js';
 import { _ as _$a } from '@swc/helpers/esm/_to_consumable_array.js';
-import { createChatComponent } from 'instantsearch-ui-components';
-import { SearchIndexToolType, RecommendToolType, DisplayResultsToolType, GroupedResultsToolType, MemorizeToolType, MemorySearchToolType, PonderToolType } from 'instantsearch.js/es/lib/chat/index.js';
-export { DisplayResultsToolType, GroupedResultsToolType, MemorizeToolType, MemorySearchToolType, PonderToolType, RecommendToolType, SearchIndexToolType } from 'instantsearch.js/es/lib/chat/index.js';
+import { createChatComponent, shouldSearchToolRenderResults } from 'instantsearch-ui-components';
+import { SearchIndexToolType, RecommendToolType, GroupedResultsToolType, DisplayResultsToolType, CompareProductsToolType, MemorizeToolType, MemorySearchToolType, PonderToolType } from 'instantsearch.js/es/lib/chat/index.js';
+export { CompareProductsToolType, DisplayResultsToolType, GroupedResultsToolType, MemorizeToolType, MemorySearchToolType, PonderToolType, RecommendToolType, SearchIndexToolType } from 'instantsearch.js/es/lib/chat/index.js';
 import { getActiveContainerAnimations, holdContainerInertUntilReveal, restoreContainerInertUntilReveal, focusAfterReveal } from 'instantsearch.js/es/lib/chat/focusAfterReveal.js';
 import React, { createElement, Fragment, useMemo, useState, useEffect, useRef, useCallback, useImperativeHandle } from 'react';
 import { useInstantSearch, useChat } from 'react-instantsearch-core';
 import { useStickToBottom } from '../lib/useStickToBottom.js';
-import { createGroupedResultsTool } from './chat/tools/DisplayResultsTool.js';
+import { createCompareProductsTool } from './chat/tools/CompareProductsTool.js';
+import { createGroupedResultsTool } from './chat/tools/GroupedResultsTool.js';
 import { createCarouselTool } from './chat/tools/SearchIndexTool.js';
 
 var ChatUiComponent = createChatComponent({
@@ -27,20 +28,15 @@ var ChatUiComponent = createChatComponent({
     useEffect: useEffect
 });
 function createDefaultTools(itemComponent, getSearchPageURL) {
+    var groupedResultsTool = createGroupedResultsTool(itemComponent);
     var _obj;
     return _obj = {}, _$4(_obj, SearchIndexToolType, _$5(_$6({}, createCarouselTool(true, itemComponent, getSearchPageURL)), {
         // The agent decides per turn whether the richer Grouped Results tool
         // takes over the rendering of the search results.
-        shouldRender: isDisplayResultsDisabled
-    })), _$4(_obj, RecommendToolType, createCarouselTool(false, itemComponent, getSearchPageURL)), _$4(_obj, DisplayResultsToolType, createGroupedResultsTool(itemComponent)), _$4(_obj, GroupedResultsToolType, createGroupedResultsTool(itemComponent)), _$4(_obj, MemorizeToolType, {}), _$4(_obj, MemorySearchToolType, {}), _$4(_obj, PonderToolType, {}), _obj;
-}
-/**
- * Whether the search tool renders its own results, i.e. the agent did not hand
- * the turn to the Grouped Results tool. Set on the message by the backend.
- */ function isDisplayResultsDisabled(param) {
-    var parentMessage = param.parentMessage;
-    var _parentMessage_metadata;
-    return ((_parentMessage_metadata = parentMessage.metadata) === null || _parentMessage_metadata === void 0 ? void 0 : _parentMessage_metadata.displayResultsEnabled) !== true;
+        shouldRender: shouldSearchToolRenderResults
+    })), _$4(_obj, RecommendToolType, createCarouselTool(false, itemComponent, getSearchPageURL)), _$4(_obj, GroupedResultsToolType, groupedResultsTool), // Agents configured before the rename still emit the legacy tool name.
+    // eslint-disable-next-line typescript/no-deprecated
+    _$4(_obj, DisplayResultsToolType, groupedResultsTool), _$4(_obj, CompareProductsToolType, createCompareProductsTool()), _$4(_obj, MemorizeToolType, {}), _$4(_obj, MemorySearchToolType, {}), _$4(_obj, PonderToolType, {}), _obj;
 }
 function mergeToolOptions(defaultTools, userTools) {
     if (!userTools) {

package/dist/es/widgets/CompareBar.d.ts

@@ -0,0 +1,27 @@
+import React from 'react';
+import type { CompareBarClassNames, CompareBarItemComponentProps, CompareBarTranslations } from 'instantsearch-ui-components';
+import type { UseCompareProps } from 'react-instantsearch-core';
+export type CompareBarProps = UseCompareProps & {
+    /**
+     * CSS classes to add to the widget elements.
+     */
+    classNames?: Partial<CompareBarClassNames>;
+    /**
+     * Translations for the widget's texts.
+     */
+    translations?: Partial<CompareBarTranslations>;
+    /**
+     * Custom renderer for a selected item's label.
+     */
+    itemComponent?: (props: CompareBarItemComponentProps) => JSX.Element;
+};
+/**
+ * Renders the comparison selection bar: the records picked for comparison,
+ * a clear-selection action, and the "Compare" call-to-action that opens the
+ * `<Chat>` widget with the comparison message.
+ *
+ * Select records from your own UI (e.g. a "Compare" button in your hit
+ * component) with `useCompare().toggleItem(hit)` — the selection is shared
+ * with this widget.
+ */
+export declare function CompareBar({ classNames, translations, itemComponent, ...props }: CompareBarProps): React.JSX.Element;

package/dist/es/widgets/CompareBar.js

@@ -0,0 +1,45 @@
+import { _ } from '@swc/helpers/esm/_object_without_properties.js';
+import { createCompareBarComponent } from 'instantsearch-ui-components';
+import React, { createElement, Fragment } from 'react';
+import { useCompare } from 'react-instantsearch-core';
+
+var CompareBarUiComponent = createCompareBarComponent({
+    createElement: createElement,
+    Fragment: Fragment
+});
+/**
+ * Renders the comparison selection bar: the records picked for comparison,
+ * a clear-selection action, and the "Compare" call-to-action that opens the
+ * `<Chat>` widget with the comparison message.
+ *
+ * Select records from your own UI (e.g. a "Compare" button in your hit
+ * component) with `useCompare().toggleItem(hit)` — the selection is shared
+ * with this widget.
+ */ function CompareBar(_0) {
+    var classNames = _0.classNames, translations = _0.translations, itemComponent = _0.itemComponent, props = _(_0, [
+        "classNames",
+        "translations",
+        "itemComponent"
+    ]);
+    var _useCompare = useCompare(props, {
+        $$widgetType: 'ais.compareBar'
+    }), items = _useCompare.items, minItems = _useCompare.minItems, maxItems = _useCompare.maxItems, canCompare = _useCompare.canCompare, removeItem = _useCompare.removeItem, clearItems = _useCompare.clearItems, compare = _useCompare.compare;
+    return /*#__PURE__*/ React.createElement(CompareBarUiComponent, {
+        items: items,
+        minItems: minItems,
+        maxItems: maxItems,
+        canCompare: canCompare,
+        onCompare: function onCompare() {
+            return compare();
+        },
+        onRemove: function onRemove(item) {
+            return removeItem(item.objectID);
+        },
+        onClear: clearItems,
+        itemComponent: itemComponent,
+        classNames: classNames,
+        translations: translations
+    });
+}
+
+export { CompareBar };

package/dist/es/widgets/chat/tools/CompareProductsTool.d.ts

@@ -0,0 +1,13 @@
+import type { ComparisonTableTranslations, UserClientSideTool } from 'instantsearch-ui-components';
+/**
+ * Builtin comparison tool (`algolia_compare_products`).
+ *
+ * Registered by default in the chat widget so the agent can trigger a grounded
+ * side-by-side comparison: its tool call names only the product objectIDs and
+ * the attribute keys, and every cell is hydrated client-side from the real
+ * `algolia_search_index` hits. The model never types a value, so it cannot
+ * hallucinate one. See `instantsearch-ui-components` `CompareProductsTool` for
+ * the contract, and `comparison-eval/README.md` for the study behind it.
+ */
+declare function createCompareProductsTool(translations?: Partial<ComparisonTableTranslations>): UserClientSideTool;
+export { createCompareProductsTool };

package/dist/es/widgets/chat/tools/CompareProductsTool.js

@@ -0,0 +1,41 @@
+import { createCompareProductsToolComponent } from 'instantsearch-ui-components';
+import React, { createElement, Fragment } from 'react';
+
+/**
+ * Builtin comparison tool (`algolia_compare_products`).
+ *
+ * Registered by default in the chat widget so the agent can trigger a grounded
+ * side-by-side comparison: its tool call names only the product objectIDs and
+ * the attribute keys, and every cell is hydrated client-side from the real
+ * `algolia_search_index` hits. The model never types a value, so it cannot
+ * hallucinate one. See `instantsearch-ui-components` `CompareProductsTool` for
+ * the contract, and `comparison-eval/README.md` for the study behind it.
+ */ function createCompareProductsTool(translations) {
+    var CompareProductsUIComponent = createCompareProductsToolComponent({
+        createElement: createElement,
+        Fragment: Fragment
+    });
+    var CompareProductsLayoutComponent = function CompareProductsLayoutComponent(toolProps) {
+        return /*#__PURE__*/ React.createElement(CompareProductsUIComponent, {
+            toolProps: toolProps,
+            translations: translations
+        });
+    };
+    return {
+        layoutComponent: CompareProductsLayoutComponent,
+        // Client-side tool: acknowledge the call so the agent's turn can complete.
+        // The table itself is rendered from the call's input + real search hits.
+        onToolCall: function onToolCall(param) {
+            var input = param.input, addToolResult = param.addToolResult;
+            var objectIDs = input === null || input === void 0 ? void 0 : input.objectIDs;
+            addToolResult({
+                output: {
+                    status: 'displayed',
+                    objectIDs: Array.isArray(objectIDs) ? objectIDs : []
+                }
+            });
+        }
+    };
+}
+
+export { createCompareProductsTool };

package/dist/es/widgets/chat/tools/ComparisonTableTool.d.ts

@@ -0,0 +1,15 @@
+import type { ComparisonTableTranslations, UserClientSideTool } from 'instantsearch-ui-components';
+/**
+ * Grounded comparison-table tool (prototype).
+ *
+ * Renders a v2 `markdownTable` display block whose every cell is hydrated from
+ * the real `algolia_search_index` hits by objectID — the agent supplies only the
+ * objectIDs and the attribute keys, never the values. See
+ * `instantsearch-ui-components` `ComparisonTableTool` for the contract.
+ *
+ * Register under the display-results tool key (or a dedicated key) in
+ * `createDefaultTools` to have comparison answers rendered as a grounded table
+ * instead of the model-authored markdown table.
+ */
+declare function createComparisonTableTool(translations?: Partial<ComparisonTableTranslations>): UserClientSideTool;
+export { createComparisonTableTool };

package/dist/es/widgets/chat/tools/ComparisonTableTool.js

@@ -0,0 +1,31 @@
+import { createComparisonTableToolComponent } from 'instantsearch-ui-components';
+import React, { createElement, Fragment } from 'react';
+
+/**
+ * Grounded comparison-table tool (prototype).
+ *
+ * Renders a v2 `markdownTable` display block whose every cell is hydrated from
+ * the real `algolia_search_index` hits by objectID — the agent supplies only the
+ * objectIDs and the attribute keys, never the values. See
+ * `instantsearch-ui-components` `ComparisonTableTool` for the contract.
+ *
+ * Register under the display-results tool key (or a dedicated key) in
+ * `createDefaultTools` to have comparison answers rendered as a grounded table
+ * instead of the model-authored markdown table.
+ */ function createComparisonTableTool(translations) {
+    var ComparisonTableUIComponent = createComparisonTableToolComponent({
+        createElement: createElement,
+        Fragment: Fragment
+    });
+    var ComparisonTableLayoutComponent = function ComparisonTableLayoutComponent(toolProps) {
+        return /*#__PURE__*/ React.createElement(ComparisonTableUIComponent, {
+            toolProps: toolProps,
+            translations: translations
+        });
+    };
+    return {
+        layoutComponent: ComparisonTableLayoutComponent
+    };
+}
+
+export { createComparisonTableTool };

package/dist/es/widgets/chat/tools/{DisplayResultsTool.js → GroupedResultsTool.js}

@@ -1,9 +1,9 @@
-import { createDisplayResultsToolComponent, createButtonComponent, ChevronLeftIcon, ChevronRightIcon } from 'instantsearch-ui-components';
+import { createGroupedResultsToolComponent, createButtonComponent, ChevronLeftIcon, ChevronRightIcon } from 'instantsearch-ui-components';
 import React, { createElement, Fragment, useEffect, useRef } from 'react';
 import { Carousel } from '../../../components/Carousel.js';
 
 function createGroupedResultsTool(itemComponent) {
-    var DisplayResultsUIComponent = createDisplayResultsToolComponent({
+    var GroupedResultsUIComponent = createGroupedResultsToolComponent({
         createElement: createElement,
         Fragment: Fragment,
         useEffect: useEffect,
@@ -12,14 +12,14 @@ function createGroupedResultsTool(itemComponent) {
     var Button = createButtonComponent({
         createElement: createElement
     });
-    var DisplayResultsCarouselHeader = function DisplayResultsCarouselHeader(param) {
+    var GroupedResultsCarouselHeader = function GroupedResultsCarouselHeader(param) {
         var nbItems = param.nbItems, canScrollLeft = param.canScrollLeft, canScrollRight = param.canScrollRight, scrollLeft = param.scrollLeft, scrollRight = param.scrollRight;
         return /*#__PURE__*/ React.createElement("div", {
-            className: "ais-ChatToolDisplayResultsCarouselHeader"
+            className: "ais-ChatToolGroupedResultsCarouselHeader"
         }, /*#__PURE__*/ React.createElement("div", {
-            className: "ais-ChatToolDisplayResultsCarouselHeaderCount"
+            className: "ais-ChatToolGroupedResultsCarouselHeaderCount"
         }, nbItems, " result", nbItems > 1 ? 's' : ''), /*#__PURE__*/ React.createElement("div", {
-            className: "ais-ChatToolDisplayResultsCarouselHeaderScrollButtons"
+            className: "ais-ChatToolGroupedResultsCarouselHeaderScrollButtons"
         }, /*#__PURE__*/ React.createElement(Button, {
             variant: "outline",
             size: "sm",
@@ -27,7 +27,7 @@ function createGroupedResultsTool(itemComponent) {
             "aria-label": "Previous",
             onClick: scrollLeft,
             disabled: !canScrollLeft,
-            className: "ais-ChatToolDisplayResultsCarouselHeaderScrollButton"
+            className: "ais-ChatToolGroupedResultsCarouselHeaderScrollButton"
         }, /*#__PURE__*/ React.createElement(ChevronLeftIcon, {
             createElement: createElement
         })), /*#__PURE__*/ React.createElement(Button, {
@@ -37,13 +37,13 @@ function createGroupedResultsTool(itemComponent) {
             "aria-label": "Next",
             onClick: scrollRight,
             disabled: !canScrollRight,
-            className: "ais-ChatToolDisplayResultsCarouselHeaderScrollButton"
+            className: "ais-ChatToolGroupedResultsCarouselHeaderScrollButton"
         }, /*#__PURE__*/ React.createElement(ChevronRightIcon, {
             createElement: createElement
         }))));
     };
-    var DisplayResultsLayoutComponent = function DisplayResultsLayoutComponent(toolProps) {
-        return /*#__PURE__*/ React.createElement(DisplayResultsUIComponent, {
+    var GroupedResultsLayoutComponent = function GroupedResultsLayoutComponent(toolProps) {
+        return /*#__PURE__*/ React.createElement(GroupedResultsUIComponent, {
             toolProps: toolProps,
             groupCarouselComponent: function groupCarouselComponent(param) {
                 var items = param.items, sendEvent = param.sendEvent;
@@ -52,13 +52,13 @@ function createGroupedResultsTool(itemComponent) {
                     itemComponent: itemComponent,
                     sendEvent: sendEvent,
                     showNavigation: false,
-                    headerComponent: DisplayResultsCarouselHeader
+                    headerComponent: GroupedResultsCarouselHeader
                 });
             }
         });
     };
     return {
-        layoutComponent: DisplayResultsLayoutComponent,
+        layoutComponent: GroupedResultsLayoutComponent,
         streamInput: true
     };
 }

package/dist/es/widgets/index.d.ts

@@ -3,6 +3,7 @@ export * from './Breadcrumb';
 export * from './Chat';
 export * from './PromptSuggestions';
 export * from './ChatTrigger';
+export * from './CompareBar';
 export * from './ClearRefinements';
 export * from './CurrentRefinements';
 export * from './FrequentlyBoughtTogether';

package/dist/es/widgets/index.js

@@ -3,6 +3,7 @@ export { Breadcrumb } from './Breadcrumb.js';
 export { Chat, createDefaultTools } from './Chat.js';
 export { PromptSuggestions } from './PromptSuggestions.js';
 export { ChatTrigger } from './ChatTrigger.js';
+export { CompareBar } from './CompareBar.js';
 export { ClearRefinements } from './ClearRefinements.js';
 export { CurrentRefinements } from './CurrentRefinements.js';
 export { FrequentlyBoughtTogether } from './FrequentlyBoughtTogether.js';
@@ -27,4 +28,4 @@ export { ToggleRefinement } from './ToggleRefinement.js';
 export { TrendingItems } from './TrendingItems.js';
 export { TrendingFacets } from './TrendingFacets.js';
 export { FilterSuggestions } from './FilterSuggestions.js';
-export { DisplayResultsToolType, GroupedResultsToolType, MemorizeToolType, MemorySearchToolType, PonderToolType, RecommendToolType, SearchIndexToolType } from 'instantsearch.js/es/lib/chat/index.js';
+export { CompareProductsToolType, DisplayResultsToolType, GroupedResultsToolType, MemorizeToolType, MemorySearchToolType, PonderToolType, RecommendToolType, SearchIndexToolType } from 'instantsearch.js/es/lib/chat/index.js';