instantsearch.js 4.86.1 → 4.87.0

package/es/connectors/autocomplete/connectAutocomplete.d.ts

@@ -1,6 +1,12 @@
 import type { SendEventForHits } from '../../lib/utils';
 import type { Hit, Connector, WidgetRenderState } from '../../types';
 import type { SearchResults } from 'algoliasearch-helper';
+export type TransformItemsIndicesConfig = {
+    indexName: string;
+    indexId: string;
+    hits: Hit[];
+    results: SearchResults;
+};
 export type AutocompleteConnectorParams = {
     /**
      * Escapes HTML entities from hits string values.
@@ -8,6 +14,10 @@ export type AutocompleteConnectorParams = {
      * @default `true`
      */
     escapeHTML?: boolean;
+    /**
+     * Transforms the items of all indices.
+     */
+    transformItems?: (indices: TransformItemsIndicesConfig[]) => TransformItemsIndicesConfig[];
 };
 export type AutocompleteRenderState = {
     /**

package/es/connectors/autocomplete/connectAutocomplete.js

@@ -15,7 +15,11 @@ var connectAutocomplete = function connectAutocomplete(renderFn) {
   return function (widgetParams) {
     var _ref = widgetParams || {},
       _ref$escapeHTML = _ref.escapeHTML,
-      escapeHTML = _ref$escapeHTML === void 0 ? true : _ref$escapeHTML;
+      escapeHTML = _ref$escapeHTML === void 0 ? true : _ref$escapeHTML,
+      _ref$transformItems = _ref.transformItems,
+      transformItems = _ref$transformItems === void 0 ? function (indices) {
+        return indices;
+      } : _ref$transformItems;
     process.env.NODE_ENV === 'development' ? warning(!widgetParams.indices, "\nThe option `indices` has been removed from the Autocomplete connector.\n\nThe indices to target are now inferred from the widgets tree.\n".concat(Array.isArray(widgetParams.indices) ? "\nAn alternative would be:\n\nconst autocomplete = connectAutocomplete(renderer);\n\nsearch.addWidgets([\n  ".concat(widgetParams.indices.map(function (_ref2) {
       var value = _ref2.value;
       return "index({ indexName: '".concat(value, "' }),");
@@ -57,6 +61,7 @@ var connectAutocomplete = function connectAutocomplete(renderFn) {
             helper.setQuery(query).search();
           };
         }
+        var sendEventMap = {};
         var indices = scopedResults.map(function (scopedResult) {
           var _scopedResult$results, _scopedResult$results2;
           // We need to escape the hits because highlighting
@@ -64,7 +69,7 @@ var connectAutocomplete = function connectAutocomplete(renderFn) {
           if (scopedResult.results) {
             scopedResult.results.hits = escapeHTML ? escapeHits(scopedResult.results.hits) : scopedResult.results.hits;
           }
-          var sendEvent = createSendEventForHits({
+          sendEventMap[scopedResult.indexId] = createSendEventForHits({
             instantSearchInstance: instantSearchInstance,
             helper: scopedResult.helper,
             widgetType: _this.$$type
@@ -73,13 +78,16 @@ var connectAutocomplete = function connectAutocomplete(renderFn) {
             indexId: scopedResult.indexId,
             indexName: ((_scopedResult$results = scopedResult.results) === null || _scopedResult$results === void 0 ? void 0 : _scopedResult$results.index) || '',
             hits: ((_scopedResult$results2 = scopedResult.results) === null || _scopedResult$results2 === void 0 ? void 0 : _scopedResult$results2.hits) || [],
-            results: scopedResult.results || {},
-            sendEvent: sendEvent
+            results: scopedResult.results || {}
           };
         });
         return {
           currentRefinement: state.query || '',
-          indices: indices,
+          indices: transformItems(indices).map(function (transformedIndex) {
+            return _objectSpread(_objectSpread({}, transformedIndex), {}, {
+              sendEvent: sendEventMap[transformedIndex.indexId]
+            });
+          }),
           refine: connectorState.refine,
           widgetParams: widgetParams
         };

package/es/connectors/chat/connectChat.d.ts

@@ -37,6 +37,10 @@ export type ChatRenderState<TUiMessage extends UIMessage = UIMessage> = {
      * Tools configuration with addToolResult bound, ready to be used by the UI.
      */
     tools: ClientSideTools;
+    /**
+     * Suggestions received from the AI model.
+     */
+    suggestions?: string[];
 } & Pick<AbstractChat<TUiMessage>, 'addToolResult' | 'clearError' | 'error' | 'id' | 'messages' | 'regenerate' | 'resumeStream' | 'sendMessage' | 'status' | 'stop'>;
 export type ChatInitWithoutTransport<TUiMessage extends UIMessage> = Omit<ChatInitAi<TUiMessage>, 'transport'>;
 export type ChatTransport = {
@@ -55,6 +59,11 @@ export type ChatConnectorParams<TUiMessage extends UIMessage = UIMessage> = ({
      * Configuration for client-side tools.
      */
     tools?: Record<string, Omit<UserClientSideTool, 'layoutComponent'>>;
+    /**
+     * Identifier of this type of chat widget. This is used for the key in renderState.
+     * @default 'chat'
+     */
+    type?: string;
 };
 export type ChatWidgetDescription<TUiMessage extends UIMessage = UIMessage> = {
     $$type: 'ais.chat';
@@ -343,6 +352,7 @@ declare const _default: <TWidgetParams extends UnknownWidgetParams>(renderFn: Re
         setInput: (input: string) => void;
         setOpen: (open: boolean) => void;
         setMessages: (messagesParam: TUiMessage[] | ((m: TUiMessage[]) => TUiMessage[])) => void;
+        suggestions: string[] | undefined;
         isClearing: boolean;
         clearMessages: () => void;
         onClearTransitionEnd: () => void;

package/es/connectors/chat/connectChat.js

@@ -1,5 +1,6 @@
 function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
-var _excluded = ["resume", "tools"];
+var _excluded = ["resume", "tools", "type"],
+  _excluded2 = ["messages", "trigger"];
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
@@ -7,10 +8,14 @@ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol"
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
 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."); }
-function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
-function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
 function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t.return && (u = t.return(), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
 function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+function _toConsumableArray(r) { return _arrayWithoutHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableSpread(); }
+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."); }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _iterableToArray(r) { if ("undefined" != typeof Symbol && null != r[Symbol.iterator] || null != r["@@iterator"]) return Array.from(r); }
+function _arrayWithoutHoles(r) { if (Array.isArray(r)) return _arrayLikeToArray(r); }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
 function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
 function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
 import { DefaultChatTransport, lastAssistantMessageIsCompleteWithToolCalls } from 'ai';
@@ -30,6 +35,8 @@ export default (function connectChat(renderFn) {
       resume = _ref$resume === void 0 ? false : _ref$resume,
       _ref$tools = _ref.tools,
       tools = _ref$tools === void 0 ? {} : _ref$tools,
+      _ref$type = _ref.type,
+      type = _ref$type === void 0 ? 'chat' : _ref$type,
       options = _objectWithoutProperties(_ref, _excluded);
     var _chatInstance;
     var input = '';
@@ -39,6 +46,25 @@ export default (function connectChat(renderFn) {
     var setInput;
     var setOpen;
     var setIsClearing;
+    var agentId = 'agentId' in options ? options.agentId : undefined;
+
+    // Extract suggestions from the last assistant message's data-suggestions part
+    var getSuggestionsFromMessages = function getSuggestionsFromMessages(messages) {
+      // Find the last assistant message (iterate from end)
+      var lastAssistantMessage = _toConsumableArray(messages).reverse().find(function (message) {
+        return message.role === 'assistant' && message.parts;
+      });
+      if (!(lastAssistantMessage !== null && lastAssistantMessage !== void 0 && lastAssistantMessage.parts)) {
+        return undefined;
+      }
+
+      // Find the data-suggestions part
+      var suggestionsPart = lastAssistantMessage.parts.find(function (part) {
+        var _data;
+        return 'type' in part && part.type === 'data-suggestions' && 'data' in part && Array.isArray((_data = part.data) === null || _data === void 0 ? void 0 : _data.suggestions);
+      });
+      return suggestionsPart === null || suggestionsPart === void 0 ? void 0 : suggestionsPart.data.suggestions;
+    };
     var setMessages = function setMessages(messagesParam) {
       if (typeof messagesParam === 'function') {
         messagesParam = messagesParam(_chatInstance.messages);
@@ -62,20 +88,67 @@ export default (function connectChat(renderFn) {
         _getAppIdAndApiKey2 = _slicedToArray(_getAppIdAndApiKey, 2),
         appId = _getAppIdAndApiKey2[0],
         apiKey = _getAppIdAndApiKey2[1];
+
+      // Filter out custom data parts (like data-suggestions) that the backend doesn't accept
+      var filterDataParts = function filterDataParts(messages) {
+        return messages.map(function (message) {
+          var _message$parts;
+          return _objectSpread(_objectSpread({}, message), {}, {
+            parts: (_message$parts = message.parts) === null || _message$parts === void 0 ? void 0 : _message$parts.filter(function (part) {
+              return !('type' in part && part.type.startsWith('data-'));
+            })
+          });
+        });
+      };
       if ('transport' in options && options.transport) {
-        transport = new DefaultChatTransport(options.transport);
+        var originalPrepare = options.transport.prepareSendMessagesRequest;
+        transport = new DefaultChatTransport(_objectSpread(_objectSpread({}, options.transport), {}, {
+          prepareSendMessagesRequest: function prepareSendMessagesRequest(params) {
+            // Call the original prepareSendMessagesRequest if it exists,
+            // otherwise construct the default body
+            var preparedOrPromise = originalPrepare ? originalPrepare(params) : {
+              body: _objectSpread({}, params)
+            };
+            // Then filter out data-* parts
+            var applyFilter = function applyFilter(prepared) {
+              return _objectSpread(_objectSpread({}, prepared), {}, {
+                body: _objectSpread(_objectSpread({}, prepared.body), {}, {
+                  messages: filterDataParts(prepared.body.messages)
+                })
+              });
+            };
+
+            // Handle both sync and async cases
+            if (preparedOrPromise && 'then' in preparedOrPromise) {
+              return preparedOrPromise.then(applyFilter);
+            }
+            return applyFilter(preparedOrPromise);
+          }
+        }));
       }
       if ('agentId' in options && options.agentId) {
-        var agentId = options.agentId;
         if (!appId || !apiKey) {
           throw new Error(withUsage('Could not extract Algolia credentials from the search client.'));
         }
+        var baseApi = "https://".concat(appId, ".algolia.net/agent-studio/1/agents/").concat(agentId, "/completions?compatibilityMode=ai-sdk-5");
         transport = new DefaultChatTransport({
-          api: "https://".concat(appId, ".algolia.net/agent-studio/1/agents/").concat(agentId, "/completions?compatibilityMode=ai-sdk-5"),
+          api: baseApi,
           headers: {
             'x-algolia-application-id': appId,
             'x-algolia-api-Key': apiKey,
             'x-algolia-agent': getAlgoliaAgent(instantSearchInstance.client)
+          },
+          prepareSendMessagesRequest: function prepareSendMessagesRequest(_ref2) {
+            var messages = _ref2.messages,
+              trigger = _ref2.trigger,
+              rest = _objectWithoutProperties(_ref2, _excluded2);
+            return {
+              // Bypass cache when regenerating to ensure fresh responses
+              api: trigger === 'regenerate-message' ? "".concat(baseApi, "&cache=false") : baseApi,
+              body: _objectSpread(_objectSpread({}, rest), {}, {
+                messages: filterDataParts(messages)
+              })
+            };
           }
         });
       }
@@ -88,8 +161,8 @@ export default (function connectChat(renderFn) {
       return new Chat(_objectSpread(_objectSpread({}, options), {}, {
         transport: transport,
         sendAutomaticallyWhen: lastAssistantMessageIsCompleteWithToolCalls,
-        onToolCall: function onToolCall(_ref2) {
-          var toolCall = _ref2.toolCall;
+        onToolCall: function onToolCall(_ref3) {
+          var toolCall = _ref3.toolCall;
           var tool = tools[toolCall.toolName];
           if (!tool) {
             if (process.env.NODE_ENV === 'development') {
@@ -102,8 +175,8 @@ export default (function connectChat(renderFn) {
             });
           }
           if (tool.onToolCall) {
-            var addToolResult = function addToolResult(_ref3) {
-              var output = _ref3.output;
+            var addToolResult = function addToolResult(_ref4) {
+              var output = _ref4.output;
               return _chatInstance.addToolResult({
                 output: output,
                 tool: toolCall.toolName,
@@ -159,9 +232,7 @@ export default (function connectChat(renderFn) {
       getRenderState: function getRenderState(renderState, renderOptions
       // Type is explicitly redefined, to avoid having the TWidgetParams type in the definition
       ) {
-        return _objectSpread(_objectSpread({}, renderState), {}, {
-          chat: this.getWidgetRenderState(renderOptions)
-        });
+        return _objectSpread(_objectSpread({}, renderState), {}, _defineProperty({}, type, this.getWidgetRenderState(renderOptions)));
       },
       getWidgetRenderState: function getWidgetRenderState(renderOptions) {
         var instantSearchInstance = renderOptions.instantSearchInstance,
@@ -180,10 +251,10 @@ export default (function connectChat(renderFn) {
           });
         }
         var toolsWithAddToolResult = {};
-        Object.entries(tools).forEach(function (_ref4) {
-          var _ref5 = _slicedToArray(_ref4, 2),
-            key = _ref5[0],
-            tool = _ref5[1];
+        Object.entries(tools).forEach(function (_ref5) {
+          var _ref6 = _slicedToArray(_ref5, 2),
+            key = _ref6[0],
+            tool = _ref6[1];
           var toolWithAddToolResult = _objectSpread(_objectSpread({}, tool), {}, {
             addToolResult: _chatInstance.addToolResult
           });
@@ -198,6 +269,7 @@ export default (function connectChat(renderFn) {
           setInput: setInput,
           setOpen: setOpen,
           setMessages: setMessages,
+          suggestions: getSuggestionsFromMessages(_chatInstance.messages),
           isClearing: isClearing,
           clearMessages: clearMessages,
           onClearTransitionEnd: onClearTransitionEnd,

package/es/connectors/filter-suggestions/connectFilterSuggestions.d.ts

@@ -0,0 +1,95 @@
+import type { Connector, TransformItems, WidgetRenderState } from '../../types';
+export type Suggestion = {
+    /**
+     * The facet attribute name.
+     */
+    attribute: string;
+    /**
+     * The facet value to filter by.
+     */
+    value: string;
+    /**
+     * Human-readable display label.
+     */
+    label: string;
+    /**
+     * Number of records matching this filter.
+     */
+    count: number;
+};
+export type FilterSuggestionsTransport = {
+    /**
+     * The custom API endpoint URL.
+     */
+    api: string;
+    /**
+     * Custom headers to send with the request.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Function to prepare the request body before sending.
+     * Receives the default body and returns the modified request options.
+     */
+    prepareSendMessagesRequest?: (body: Record<string, unknown>) => {
+        body: Record<string, unknown>;
+    };
+};
+export type FilterSuggestionsRenderState = {
+    /**
+     * The list of suggested filters.
+     */
+    suggestions: Suggestion[];
+    /**
+     * Whether suggestions are currently being fetched.
+     */
+    isLoading: boolean;
+    /**
+     * Applies a filter for the given attribute and value.
+     */
+    refine: (attribute: string, value: string) => void;
+};
+export type FilterSuggestionsConnectorParams = {
+    /**
+     * The ID of the agent configured in the Algolia dashboard.
+     * Required unless a custom `transport` is provided.
+     */
+    agentId?: string;
+    /**
+     * Limit to specific facet attributes.
+     */
+    attributes?: string[];
+    /**
+     * Maximum number of suggestions to return.
+     * @default 3
+     */
+    maxSuggestions?: number;
+    /**
+     * Debounce delay in milliseconds before fetching suggestions.
+     * @default 300
+     */
+    debounceMs?: number;
+    /**
+     * Number of hits to send for context.
+     * @default 5
+     */
+    hitsToSample?: number;
+    /**
+     * Function to transform the items passed to the templates.
+     */
+    transformItems?: TransformItems<Suggestion>;
+    /**
+     * Custom transport configuration for the API requests.
+     * When provided, allows using a custom endpoint, headers, and request body.
+     */
+    transport?: FilterSuggestionsTransport;
+};
+export type FilterSuggestionsWidgetDescription = {
+    $$type: 'ais.filterSuggestions';
+    renderState: FilterSuggestionsRenderState;
+    indexRenderState: {
+        filterSuggestions: WidgetRenderState<FilterSuggestionsRenderState, FilterSuggestionsConnectorParams>;
+    };
+};
+export type FilterSuggestionsConnector = Connector<FilterSuggestionsWidgetDescription, FilterSuggestionsConnectorParams>;
+declare const connectFilterSuggestions: FilterSuggestionsConnector;
+export default connectFilterSuggestions;

package/es/connectors/filter-suggestions/connectFilterSuggestions.js

@@ -0,0 +1,249 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
+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."); }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t.return && (u = t.return(), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+import { checkRendering, createDocumentationMessageGenerator, getAlgoliaAgent, getAppIdAndApiKey, getRefinements, noop } from "../../lib/utils/index.js";
+var withUsage = createDocumentationMessageGenerator({
+  name: 'filter-suggestions',
+  connector: true
+});
+var connectFilterSuggestions = function connectFilterSuggestions(renderFn) {
+  var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
+  checkRendering(renderFn, withUsage());
+  return function (widgetParams) {
+    var agentId = widgetParams.agentId,
+      attributes = widgetParams.attributes,
+      _widgetParams$maxSugg = widgetParams.maxSuggestions,
+      maxSuggestions = _widgetParams$maxSugg === void 0 ? 3 : _widgetParams$maxSugg,
+      _widgetParams$debounc = widgetParams.debounceMs,
+      debounceMs = _widgetParams$debounc === void 0 ? 300 : _widgetParams$debounc,
+      _widgetParams$hitsToS = widgetParams.hitsToSample,
+      hitsToSample = _widgetParams$hitsToS === void 0 ? 5 : _widgetParams$hitsToS,
+      _widgetParams$transfo = widgetParams.transformItems,
+      transformItems = _widgetParams$transfo === void 0 ? function (items) {
+        return items;
+      } : _widgetParams$transfo,
+      transport = widgetParams.transport;
+    if (!agentId && !transport) {
+      throw new Error(withUsage('The `agentId` option is required unless a custom `transport` is provided.'));
+    }
+    var endpoint;
+    var headers;
+    var suggestions = [];
+    var isLoading = false;
+    var debounceTimer;
+    var lastStateSignature = null; // null means never fetched
+    var refine;
+    var searchHelper = null;
+    var latestRenderOptions = null;
+
+    // Create a signature of the current search state (query + refinements)
+    var getStateSignature = function getStateSignature(results) {
+      var query = results.query || '';
+      var refinements = searchHelper ? JSON.stringify(searchHelper.state.facetsRefinements) + JSON.stringify(searchHelper.state.disjunctiveFacetsRefinements) + JSON.stringify(searchHelper.state.hierarchicalFacetsRefinements) : '';
+      return "".concat(query, "|").concat(refinements);
+    };
+    var _getWidgetRenderState = function getWidgetRenderState(renderOptions) {
+      var results = 'results' in renderOptions ? renderOptions.results : undefined;
+      var transformedSuggestions = transformItems(suggestions, {
+        results: results
+      });
+      return {
+        suggestions: transformedSuggestions,
+        isLoading: isLoading,
+        refine: refine,
+        widgetParams: widgetParams
+      };
+    };
+
+    // Minimum duration to show skeleton to avoid flash when results are cached
+    var MIN_SKELETON_DURATION_MS = 300;
+    var fetchSuggestions = function fetchSuggestions(results, renderOptions) {
+      var _results$hits, _rawResults$;
+      if (!(results !== null && results !== void 0 && (_results$hits = results.hits) !== null && _results$hits !== void 0 && _results$hits.length)) {
+        suggestions = [];
+        isLoading = false;
+        renderFn(_objectSpread(_objectSpread({}, _getWidgetRenderState(renderOptions)), {}, {
+          instantSearchInstance: renderOptions.instantSearchInstance
+        }), false);
+        return;
+      }
+      var loadingStartTime = Date.now();
+      isLoading = true;
+      renderFn(_objectSpread(_objectSpread({}, _getWidgetRenderState(renderOptions)), {}, {
+        instantSearchInstance: renderOptions.instantSearchInstance
+      }), false);
+
+      // Get facets from raw results (results.facets is processed differently)
+      var rawResults = results._rawResults;
+      var rawFacets = (rawResults === null || rawResults === void 0 ? void 0 : (_rawResults$ = rawResults[0]) === null || _rawResults$ === void 0 ? void 0 : _rawResults$.facets) || {};
+      var facetsToSend = attributes ? Object.fromEntries(Object.entries(rawFacets).filter(function (_ref) {
+        var _ref2 = _slicedToArray(_ref, 1),
+          key = _ref2[0];
+        return attributes.includes(key);
+      })) : rawFacets;
+
+      // Collect current refinements to exclude from suggestions
+      var currentRefinements = searchHelper ? getRefinements(results, searchHelper.state).map(function (refinement) {
+        return {
+          attribute: refinement.attribute,
+          value: refinement.name
+        };
+      }) : [];
+      var messageText = JSON.stringify({
+        query: results.query,
+        facets: facetsToSend,
+        hitsSample: results.hits.slice(0, hitsToSample),
+        currentRefinements: currentRefinements,
+        maxSuggestions: maxSuggestions
+      });
+      var payload = {
+        messages: [{
+          id: "sr-".concat(Date.now()),
+          createdAt: new Date().toISOString(),
+          role: 'user',
+          parts: [{
+            type: 'text',
+            text: messageText
+          }]
+        }]
+      };
+
+      // Apply custom body transformation if provided
+      var finalPayload = transport !== null && transport !== void 0 && transport.prepareSendMessagesRequest ? transport.prepareSendMessagesRequest(payload).body : payload;
+      fetch(endpoint, {
+        method: 'POST',
+        headers: _objectSpread(_objectSpread({}, headers), {}, {
+          'Content-Type': 'application/json'
+        }),
+        body: JSON.stringify(finalPayload)
+      }).then(function (response) {
+        if (!response.ok) {
+          throw new Error("HTTP error ".concat(response.status));
+        }
+        return response.json();
+      }).then(function (data) {
+        var parsedSuggestions = JSON.parse(data.parts[1].text);
+        var validSuggestions = (Array.isArray(parsedSuggestions) ? parsedSuggestions : []).filter(function (suggestion) {
+          if (!(suggestion !== null && suggestion !== void 0 && suggestion.attribute) || !(suggestion !== null && suggestion !== void 0 && suggestion.value) || !(suggestion !== null && suggestion !== void 0 && suggestion.label)) {
+            return false;
+          }
+          // If attributes filter is specified, only allow suggestions for those attributes
+          if (attributes && !attributes.includes(suggestion.attribute)) {
+            return false;
+          }
+          return true;
+        }).slice(0, maxSuggestions);
+        suggestions = validSuggestions;
+      }).catch(function () {
+        suggestions = [];
+      }).finally(function () {
+        var elapsed = Date.now() - loadingStartTime;
+        var remainingDelay = Math.max(0, MIN_SKELETON_DURATION_MS - elapsed);
+        var finishLoading = function finishLoading() {
+          isLoading = false;
+          renderFn(_objectSpread(_objectSpread({}, _getWidgetRenderState(renderOptions)), {}, {
+            instantSearchInstance: renderOptions.instantSearchInstance
+          }), false);
+        };
+        if (remainingDelay > 0) {
+          setTimeout(finishLoading, remainingDelay);
+        } else {
+          finishLoading();
+        }
+      });
+    };
+    return {
+      $$type: 'ais.filterSuggestions',
+      init: function init(initOptions) {
+        var instantSearchInstance = initOptions.instantSearchInstance,
+          helper = initOptions.helper;
+        searchHelper = helper;
+        if (transport) {
+          // Use custom transport configuration
+          endpoint = transport.api;
+          headers = transport.headers || {};
+        } else {
+          // Use default Algolia agent endpoint
+          var _getAppIdAndApiKey = getAppIdAndApiKey(instantSearchInstance.client),
+            _getAppIdAndApiKey2 = _slicedToArray(_getAppIdAndApiKey, 2),
+            appId = _getAppIdAndApiKey2[0],
+            apiKey = _getAppIdAndApiKey2[1];
+          if (!appId || !apiKey) {
+            throw new Error(withUsage('Could not extract Algolia credentials from the search client.'));
+          }
+          endpoint = "https://".concat(appId, ".algolia.net/agent-studio/1/agents/").concat(agentId, "/completions?compatibilityMode=ai-sdk-5&stream=false");
+          headers = {
+            'x-algolia-application-id': appId,
+            'x-algolia-api-key': apiKey,
+            'x-algolia-agent': getAlgoliaAgent(instantSearchInstance.client)
+          };
+        }
+        refine = function refine(attribute, value) {
+          var _helper$state$hierarc;
+          // Check if the attribute belongs to a hierarchical facet
+          // by finding a hierarchical facet that includes this attribute
+          var attr = ((_helper$state$hierarc = helper.state.hierarchicalFacets.find(function (facet) {
+            return facet.attributes.includes(attribute);
+          })) === null || _helper$state$hierarc === void 0 ? void 0 : _helper$state$hierarc.name) || attribute;
+          helper.toggleFacetRefinement(attr, value);
+          helper.search();
+        };
+        renderFn(_objectSpread(_objectSpread({}, _getWidgetRenderState(initOptions)), {}, {
+          instantSearchInstance: instantSearchInstance
+        }), true);
+      },
+      render: function render(renderOptions) {
+        var results = renderOptions.results,
+          instantSearchInstance = renderOptions.instantSearchInstance;
+
+        // Always store the latest render options
+        latestRenderOptions = renderOptions;
+        if (!results) {
+          renderFn(_objectSpread(_objectSpread({}, _getWidgetRenderState(renderOptions)), {}, {
+            instantSearchInstance: instantSearchInstance
+          }), false);
+          return;
+        }
+
+        // Debounce: only fetch if search state changed (query or refinements) and after delay
+        var stateSignature = getStateSignature(results);
+        if (stateSignature !== lastStateSignature) {
+          lastStateSignature = stateSignature;
+          clearTimeout(debounceTimer);
+          debounceTimer = setTimeout(function () {
+            var _latestRenderOptions;
+            // Use the latest render options when the timeout fires
+            if ((_latestRenderOptions = latestRenderOptions) !== null && _latestRenderOptions !== void 0 && _latestRenderOptions.results) {
+              fetchSuggestions(latestRenderOptions.results, latestRenderOptions);
+            }
+          }, debounceMs);
+        }
+        renderFn(_objectSpread(_objectSpread({}, _getWidgetRenderState(renderOptions)), {}, {
+          instantSearchInstance: instantSearchInstance
+        }), false);
+      },
+      dispose: function dispose() {
+        clearTimeout(debounceTimer);
+        unmountFn();
+      },
+      getRenderState: function getRenderState(renderState, renderOptions) {
+        return _objectSpread(_objectSpread({}, renderState), {}, {
+          filterSuggestions: this.getWidgetRenderState(renderOptions)
+        });
+      },
+      getWidgetRenderState: function getWidgetRenderState(renderOptions) {
+        return _getWidgetRenderState(renderOptions);
+      }
+    };
+  };
+};
+export default connectFilterSuggestions;

package/es/connectors/index.d.ts

@@ -37,3 +37,4 @@ export { default as connectRelevantSort } from './relevant-sort/connectRelevantS
 export { default as connectFrequentlyBoughtTogether } from './frequently-bought-together/connectFrequentlyBoughtTogether';
 export { default as connectLookingSimilar } from './looking-similar/connectLookingSimilar';
 export { default as connectChat } from './chat/connectChat';
+export { default as connectFilterSuggestions } from './filter-suggestions/connectFilterSuggestions';

package/es/connectors/index.js

@@ -42,4 +42,5 @@ export { default as connectVoiceSearch } from "./voice-search/connectVoiceSearch
 export { default as connectRelevantSort } from "./relevant-sort/connectRelevantSort.js";
 export { default as connectFrequentlyBoughtTogether } from "./frequently-bought-together/connectFrequentlyBoughtTogether.js";
 export { default as connectLookingSimilar } from "./looking-similar/connectLookingSimilar.js";
-export { default as connectChat } from "./chat/connectChat.js";
+export { default as connectChat } from "./chat/connectChat.js";
+export { default as connectFilterSuggestions } from "./filter-suggestions/connectFilterSuggestions.js";

package/es/connectors/index.umd.d.ts

@@ -37,3 +37,4 @@ export { default as connectRelevantSort } from './relevant-sort/connectRelevantS
 export { default as connectFrequentlyBoughtTogether } from './frequently-bought-together/connectFrequentlyBoughtTogether';
 export { default as connectLookingSimilar } from './looking-similar/connectLookingSimilar';
 export declare const connectChat: () => never;
+export { default as connectFilterSuggestions } from './filter-suggestions/connectFilterSuggestions';