instantsearch-ui-components 0.16.0 → 0.17.1

package/dist/es/components/autocomplete/createAutocompletePropGetters.js

@@ -1,5 +1,6 @@
 import _typeof from "@babel/runtime/helpers/typeof";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import { find } from "../../lib/index.js";
 export function createAutocompletePropGetters(_ref) {
   var useEffect = _ref.useEffect,
     useId = _ref.useId,
@@ -211,18 +212,23 @@ function buildItems(_ref5) {
     getElementId = _ref5.getElementId;
   var itemsIds = [];
   var items = new Map();
-  for (var i = 0; i < indicesConfig.length; i++) {
+  var _loop = function _loop(i) {
     var _indices$i;
-    var config = indicesConfig[i];
+    var currentIndexConfig = find(indicesConfig, function (config) {
+      return config.indexName === indices[i].indexName;
+    });
     var hits = ((_indices$i = indices[i]) === null || _indices$i === void 0 ? void 0 : _indices$i.hits) || [];
     for (var position = 0; position < hits.length; position++) {
-      var itemId = getElementId('item', config.indexName, position);
+      var itemId = getElementId('item', (currentIndexConfig === null || currentIndexConfig === void 0 ? void 0 : currentIndexConfig.indexName) || indices[i].indexName, position);
       items.set(itemId, {
         item: hits[position],
-        config: config
+        config: currentIndexConfig
       });
       itemsIds.push(itemId);
     }
+  };
+  for (var i = 0; i < indices.length; i++) {
+    _loop(i);
   }
   return {
     items: items,

package/dist/es/components/autocomplete/createAutocompleteStorage.d.ts

@@ -9,8 +9,9 @@ type UseStorageParams<TItem extends Record<string, unknown>> = {
         storageKey?: string;
     };
     query?: string;
+    suggestionsIndexName?: string;
 } & Pick<Parameters<UsePropGetters<TItem>>[0], 'indices' | 'indicesConfig'>;
-export declare function createAutocompleteStorage({ useEffect, useMemo, useState, }: CreateAutocompleteStorageParams): <TItem extends Record<string, unknown>>({ showRecent, query, indices, indicesConfig, }: UseStorageParams<TItem>) => {
+export declare function createAutocompleteStorage({ useEffect, useMemo, useState, }: CreateAutocompleteStorageParams): <TItem extends Record<string, unknown>>({ showRecent, query, indices, indicesConfig, suggestionsIndexName, }: UseStorageParams<TItem>) => {
     storage: {
         onAdd: () => void;
         onRemove: () => void;

package/dist/es/components/autocomplete/createAutocompleteStorage.js

@@ -1,6 +1,10 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _typeof from "@babel/runtime/helpers/typeof";
+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; }
+import { find } from "../../lib/index.js";
 export function createAutocompleteStorage(_ref) {
   var useEffect = _ref.useEffect,
     useMemo = _ref.useMemo,
@@ -9,7 +13,8 @@ export function createAutocompleteStorage(_ref) {
     var showRecent = _ref2.showRecent,
       query = _ref2.query,
       indices = _ref2.indices,
-      indicesConfig = _ref2.indicesConfig;
+      indicesConfig = _ref2.indicesConfig,
+      suggestionsIndexName = _ref2.suggestionsIndexName;
     var storageKey = showRecent && _typeof(showRecent) === 'object' ? showRecent.storageKey : undefined;
     var storage = useMemo(function () {
       return createStorage({
@@ -53,7 +58,15 @@ export function createAutocompleteStorage(_ref) {
         })
       };
     });
-    var indicesForPropGetters = _toConsumableArray(indices);
+    var indicesForPropGetters = _toConsumableArray(indices.map(function (index) {
+      return index.indexName === suggestionsIndexName ? _objectSpread(_objectSpread({}, index), {}, {
+        hits: index.hits.filter(function (hit) {
+          return !find(storageHits, function (storageHit) {
+            return storageHit.query === hit.query;
+          });
+        })
+      }) : index;
+    }));
     var indicesConfigForPropGetters = _toConsumableArray(indicesConfig);
     indicesForPropGetters.unshift({
       indexName: 'recent-searches',

package/dist/es/components/chat/Chat.d.ts

@@ -2,6 +2,7 @@ import type { Renderer, ComponentProps } from '../../types';
 import type { ChatHeaderProps, ChatHeaderOwnProps } from './ChatHeader';
 import type { ChatMessagesProps } from './ChatMessages';
 import type { ChatPromptProps, ChatPromptOwnProps } from './ChatPrompt';
+import type { ChatPromptSuggestionsOwnProps } from './ChatPromptSuggestions';
 import type { ChatToggleButtonOwnProps, ChatToggleButtonProps } from './ChatToggleButton';
 export type ChatClassNames = {
     root?: string | string[];
@@ -11,6 +12,7 @@ export type ChatClassNames = {
     message?: ChatMessagesProps['messageClassNames'];
     prompt?: ChatPromptProps['classNames'];
     toggleButton?: ChatToggleButtonProps['classNames'];
+    suggestions?: ChatPromptSuggestionsOwnProps['classNames'];
 };
 export type ChatProps = Omit<ComponentProps<'div'>, 'onError' | 'title'> & {
     open: boolean;
@@ -19,6 +21,7 @@ export type ChatProps = Omit<ComponentProps<'div'>, 'onError' | 'title'> & {
     toggleButtonProps: ChatToggleButtonProps;
     messagesProps: ChatMessagesProps;
     promptProps: ChatPromptProps;
+    suggestionsProps: ChatPromptSuggestionsOwnProps;
     /**
      * Optional class names for elements
      */
@@ -39,5 +42,9 @@ export type ChatProps = Omit<ComponentProps<'div'>, 'onError' | 'title'> & {
      * Optional toggle button component for the chat
      */
     toggleButtonComponent?: (props: ChatToggleButtonOwnProps) => JSX.Element;
+    /**
+     * Optional suggestions component for the chat
+     */
+    suggestionsComponent?: (props: ChatPromptSuggestionsOwnProps) => JSX.Element;
 };
 export declare function createChatComponent({ createElement, Fragment }: Renderer): (userProps: ChatProps) => JSX.Element;

package/dist/es/components/chat/Chat.js

@@ -1,13 +1,14 @@
 import _extends from "@babel/runtime/helpers/extends";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
-var _excluded = ["open", "maximized", "headerProps", "toggleButtonProps", "messagesProps", "promptProps", "headerComponent", "promptComponent", "toggleButtonComponent", "classNames", "className"];
+var _excluded = ["open", "maximized", "headerProps", "toggleButtonProps", "messagesProps", "suggestionsProps", "promptProps", "headerComponent", "promptComponent", "toggleButtonComponent", "suggestionsComponent", "classNames", "className"];
 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; }
 import { cx } from "../../lib/index.js";
 import { createChatHeaderComponent } from "./ChatHeader.js";
 import { createChatMessagesComponent } from "./ChatMessages.js";
 import { createChatPromptComponent } from "./ChatPrompt.js";
+import { createChatPromptSuggestionsComponent } from "./ChatPromptSuggestions.js";
 import { createChatToggleButtonComponent } from "./ChatToggleButton.js";
 export function createChatComponent(_ref) {
   var createElement = _ref.createElement,
@@ -28,6 +29,10 @@ export function createChatComponent(_ref) {
     createElement: createElement,
     Fragment: Fragment
   });
+  var ChatPromptSuggestions = createChatPromptSuggestionsComponent({
+    createElement: createElement,
+    Fragment: Fragment
+  });
   return function Chat(userProps) {
     var open = userProps.open,
       _userProps$maximized = userProps.maximized,
@@ -35,11 +40,13 @@ export function createChatComponent(_ref) {
       headerProps = userProps.headerProps,
       toggleButtonProps = userProps.toggleButtonProps,
       messagesProps = userProps.messagesProps,
+      suggestionsProps = userProps.suggestionsProps,
       _userProps$promptProp = userProps.promptProps,
       promptProps = _userProps$promptProp === void 0 ? {} : _userProps$promptProp,
       HeaderComponent = userProps.headerComponent,
       PromptComponent = userProps.promptComponent,
       ToggleButtonComponent = userProps.toggleButtonComponent,
+      SuggestionsComponent = userProps.suggestionsComponent,
       _userProps$classNames = userProps.classNames,
       classNames = _userProps$classNames === void 0 ? {} : _userProps$classNames,
       className = userProps.className,
@@ -53,7 +60,10 @@ export function createChatComponent(_ref) {
       maximized: maximized
     })), createElement(ChatMessages, _extends({}, messagesProps, {
       classNames: classNames.messages,
-      messageClassNames: classNames.message
+      messageClassNames: classNames.message,
+      suggestionsElement: createElement(SuggestionsComponent || ChatPromptSuggestions, _objectSpread(_objectSpread({}, suggestionsProps), {}, {
+        classNames: classNames.suggestions
+      }))
     })), createElement(PromptComponent || ChatPrompt, _objectSpread(_objectSpread({}, promptProps), {}, {
       classNames: classNames.prompt
     }))), createElement("div", {

package/dist/es/components/chat/ChatMessage.d.ts

@@ -1,4 +1,4 @@
-import type { ComponentProps, Renderer } from '../../types';
+import type { ComponentProps, Renderer, VNode } from '../../types';
 import type { ChatMessageBase, ClientSideTools } from './types';
 export type ChatMessageSide = 'left' | 'right';
 export type ChatMessageVariant = 'neutral' | 'subtle';
@@ -112,6 +112,10 @@ export type ChatMessageProps = ComponentProps<'article'> & {
      * Array of tools available for the assistant (for tool messages)
      */
     tools: ClientSideTools;
+    /**
+     * Optional suggestions element
+     */
+    suggestionsElement?: VNode;
     /**
      * Optional class names
      */

package/dist/es/components/chat/ChatMessage.js

@@ -1,7 +1,7 @@
 import _extends from "@babel/runtime/helpers/extends";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
-var _excluded = ["classNames", "message", "side", "variant", "actions", "autoHideActions", "leadingComponent", "actionsComponent", "footerComponent", "tools", "indexUiState", "setIndexUiState", "onClose", "translations"];
+var _excluded = ["classNames", "message", "side", "variant", "actions", "autoHideActions", "leadingComponent", "actionsComponent", "footerComponent", "tools", "indexUiState", "setIndexUiState", "onClose", "translations", "suggestionsElement"];
 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; }
 import { compiler } from 'markdown-to-jsx';
@@ -34,6 +34,7 @@ export function createChatMessageComponent(_ref) {
       setIndexUiState = userProps.setIndexUiState,
       onClose = userProps.onClose,
       userTranslations = userProps.translations,
+      suggestionsElement = userProps.suggestionsElement,
       props = _objectWithoutProperties(userProps, _excluded);
     var translations = _objectSpread({
       messageLabel: 'Message',
@@ -105,7 +106,7 @@ export function createChatMessageComponent(_ref) {
       className: cx(cssClasses.content)
     }, createElement("div", {
       className: cx(cssClasses.message)
-    }, message.parts.map(renderMessagePart)), hasActions && createElement("div", {
+    }, message.parts.map(renderMessagePart)), suggestionsElement, hasActions && createElement("div", {
       className: cx(cssClasses.actions),
       "aria-label": translations.actionsLabel
     }, ActionsComponent ? createElement(ActionsComponent, {

package/dist/es/components/chat/ChatMessages.d.ts

@@ -1,5 +1,5 @@
 /** @jsx createElement */
-import type { ComponentProps, MutableRef, Renderer } from '../../types';
+import type { ComponentProps, MutableRef, Renderer, VNode } from '../../types';
 import type { ChatMessageProps, ChatMessageClassNames, ChatMessageTranslations } from './ChatMessage';
 import type { ChatMessageErrorProps } from './ChatMessageError';
 import type { ChatMessageLoaderProps } from './ChatMessageLoader';
@@ -143,5 +143,9 @@ export type ChatMessagesProps<TMessage extends ChatMessageBase = ChatMessageBase
      * Callback to scroll to bottom
      */
     onScrollToBottom?: () => void;
+    /**
+     * Suggestions element to display below a message
+     */
+    suggestionsElement?: VNode;
 };
 export declare function createChatMessagesComponent({ createElement, Fragment, }: Renderer): <TMessage extends ChatMessageBase = ChatMessageBase>(userProps: ChatMessagesProps<TMessage>) => JSX.Element;

package/dist/es/components/chat/ChatMessages.js

@@ -2,7 +2,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 import _extends from "@babel/runtime/helpers/extends";
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
-var _excluded = ["classNames", "messageClassNames", "messageTranslations", "messages", "messageComponent", "loaderComponent", "errorComponent", "actionsComponent", "tools", "indexUiState", "setIndexUiState", "status", "hideScrollToBottom", "onReload", "onClose", "translations", "userMessageProps", "assistantMessageProps", "isClearing", "onClearTransitionEnd", "isScrollAtBottom", "scrollRef", "contentRef", "onScrollToBottom"];
+var _excluded = ["classNames", "messageClassNames", "messageTranslations", "messages", "messageComponent", "loaderComponent", "errorComponent", "actionsComponent", "tools", "indexUiState", "setIndexUiState", "status", "hideScrollToBottom", "onReload", "onClose", "translations", "userMessageProps", "assistantMessageProps", "isClearing", "onClearTransitionEnd", "isScrollAtBottom", "scrollRef", "contentRef", "onScrollToBottom", "suggestionsElement"];
 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; }
 import { cx } from "../../lib/index.js";
@@ -41,7 +41,8 @@ function createDefaultMessageComponent(_ref) {
       actionsComponent = _ref2.actionsComponent,
       classNames = _ref2.classNames,
       messageTranslations = _ref2.messageTranslations,
-      translations = _ref2.translations;
+      translations = _ref2.translations,
+      suggestionsElement = _ref2.suggestionsElement;
     var defaultAssistantActions = [].concat(_toConsumableArray(hasTextContent(message) ? [{
       title: translations.copyToClipboardLabel,
       icon: function icon() {
@@ -75,7 +76,8 @@ function createDefaultMessageComponent(_ref) {
       actionsComponent: actionsComponent,
       "data-role": message.role,
       classNames: classNames,
-      translations: messageTranslations
+      translations: messageTranslations,
+      suggestionsElement: suggestionsElement
     }, messageProps));
   };
 }
@@ -126,6 +128,7 @@ export function createChatMessagesComponent(_ref3) {
       scrollRef = userProps.scrollRef,
       contentRef = userProps.contentRef,
       onScrollToBottom = userProps.onScrollToBottom,
+      suggestionsElement = userProps.suggestionsElement,
       props = _objectWithoutProperties(userProps, _excluded);
     var translations = _objectSpread({
       scrollToBottomLabel: 'Scroll to bottom',
@@ -157,7 +160,7 @@ export function createChatMessagesComponent(_ref3) {
           onClearTransitionEnd === null || onClearTransitionEnd === void 0 ? void 0 : onClearTransitionEnd();
         }
       }
-    }, messages.map(function (message) {
+    }, messages.map(function (message, index) {
       return createElement(DefaultMessage, {
         key: message.id,
         message: message,
@@ -171,7 +174,8 @@ export function createChatMessagesComponent(_ref3) {
         onClose: onClose,
         translations: translations,
         classNames: messageClassNames,
-        messageTranslations: messageTranslations
+        messageTranslations: messageTranslations,
+        suggestionsElement: status === 'ready' && message.role === 'assistant' && index === messages.length - 1 ? suggestionsElement : undefined
       });
     }), status === 'submitted' && createElement(DefaultLoader, {
       translations: {

package/dist/es/components/chat/ChatPromptSuggestions.d.ts

@@ -0,0 +1,14 @@
+import type { Renderer } from '../../types';
+export type ChatPromptSuggestionsClassNames = {
+    root?: string | string[];
+    suggestion?: string | string[];
+};
+export type ChatPromptSuggestionsOwnProps = {
+    suggestions?: string[];
+    onSuggestionClick: (suggestion: string) => void;
+    /**
+     * Optional class names for elements
+     */
+    classNames?: Partial<ChatPromptSuggestionsClassNames>;
+};
+export declare function createChatPromptSuggestionsComponent({ createElement, }: Renderer): (userProps: ChatPromptSuggestionsOwnProps) => JSX.Element | null;

package/dist/es/components/chat/ChatPromptSuggestions.js

@@ -0,0 +1,31 @@
+import { cx } from "../../lib/index.js";
+import { createButtonComponent } from "../Button.js";
+export function createChatPromptSuggestionsComponent(_ref) {
+  var createElement = _ref.createElement;
+  var Button = createButtonComponent({
+    createElement: createElement
+  });
+  return function ChatPromptSuggestions(userProps) {
+    var _userProps$suggestion = userProps.suggestions,
+      suggestions = _userProps$suggestion === void 0 ? [] : _userProps$suggestion,
+      onSuggestionClick = userProps.onSuggestionClick,
+      _userProps$classNames = userProps.classNames,
+      classNames = _userProps$classNames === void 0 ? {} : _userProps$classNames;
+    if (suggestions.length === 0) {
+      return null;
+    }
+    return createElement("div", {
+      className: cx('ais-ChatPromptSuggestions', classNames.root)
+    }, suggestions.map(function (suggestion, index) {
+      return createElement(Button, {
+        key: index,
+        size: "sm",
+        variant: "primary",
+        className: cx('ais-ChatPromptSuggestions-suggestion', classNames.suggestion),
+        onClick: function onClick() {
+          return onSuggestionClick(suggestion);
+        }
+      }, suggestion);
+    }));
+  };
+}