instantsearch.js 4.86.1 → 4.87.0

package/es/connectors/index.umd.js

@@ -44,4 +44,5 @@ export { default as connectFrequentlyBoughtTogether } from "./frequently-bought-
 export { default as connectLookingSimilar } from "./looking-similar/connectLookingSimilar.js";
 export var connectChat = function connectChat() {
   throw new Error("\"connectChat\" is not available from the UMD build.\n\nPlease use InstantSearch.js with a packaging system:\nhttps://www.algolia.com/doc/guides/building-search-ui/installation/js/#with-a-packaging-system");
-};
+};
+export { default as connectFilterSuggestions } from "./filter-suggestions/connectFilterSuggestions.js";

package/es/lib/chat/chat.d.ts

@@ -3,7 +3,7 @@ import type { UIMessage, ChatState as BaseChatState, ChatStatus, ChatInit } from
 export type { UIMessage };
 export { AbstractChat };
 export { ChatInit };
-export declare const CACHE_KEY = "instantsearch-chat-initial-messages-";
+export declare const CACHE_KEY = "instantsearch-chat-initial-messages";
 export declare class ChatState<TUiMessage extends UIMessage> implements BaseChatState<TUiMessage> {
     _messages: TUiMessage[];
     _status: ChatStatus;

package/es/lib/chat/chat.js

@@ -25,9 +25,9 @@ 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); }
 import { AbstractChat } from 'ai';
 export { AbstractChat };
-export var CACHE_KEY = 'instantsearch-chat-initial-messages-';
+export var CACHE_KEY = 'instantsearch-chat-initial-messages';
 function getDefaultInitialMessages(id) {
-  var initialMessages = sessionStorage.getItem(CACHE_KEY + id);
+  var initialMessages = sessionStorage.getItem(CACHE_KEY + (id ? "-".concat(id) : ''));
   return initialMessages ? JSON.parse(initialMessages) : [];
 }
 export var ChatState = /*#__PURE__*/function () {
@@ -97,7 +97,7 @@ export var ChatState = /*#__PURE__*/function () {
     var saveMessagesInLocalStorage = function saveMessagesInLocalStorage() {
       if (_this.status === 'ready') {
         try {
-          sessionStorage.setItem(CACHE_KEY + id, JSON.stringify(_this.messages));
+          sessionStorage.setItem(CACHE_KEY + (id ? "-".concat(id) : ''), JSON.stringify(_this.messages));
         } catch (e) {
           // Do nothing if sessionStorage is not available or full
         }

package/es/lib/chat/index.d.ts

@@ -5,3 +5,6 @@ export { ChatState } from './chat';
 export { Chat } from './chat';
 export declare const SearchIndexToolType = "algolia_search_index";
 export declare const RecommendToolType = "algolia_recommend";
+export declare const MemorizeToolType = "algolia_memorize";
+export declare const MemorySearchToolType = "algolia_memory_search";
+export declare const PonderToolType = "algolia_ponder";

package/es/lib/chat/index.js

@@ -2,4 +2,7 @@ export { AbstractChat } from "./chat.js";
 export { ChatState } from "./chat.js";
 export { Chat } from "./chat.js";
 export var SearchIndexToolType = 'algolia_search_index';
-export var RecommendToolType = 'algolia_recommend';
+export var RecommendToolType = 'algolia_recommend';
+export var MemorizeToolType = 'algolia_memorize';
+export var MemorySearchToolType = 'algolia_memory_search';
+export var PonderToolType = 'algolia_ponder';

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.86.1";
+declare const _default: "4.87.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.86.1';
+export default '4.87.0';

package/es/widgets/autocomplete/autocomplete.d.ts

@@ -1,5 +1,5 @@
 
-import type { AutocompleteConnectorParams, AutocompleteRenderState, AutocompleteWidgetDescription } from '../../connectors/autocomplete/connectAutocomplete';
+import type { AutocompleteConnectorParams, AutocompleteRenderState, AutocompleteWidgetDescription, TransformItemsIndicesConfig } from '../../connectors/autocomplete/connectAutocomplete';
 import type { BaseHit, IndexUiState, IndexWidget, Template, WidgetFactory } from '../../types';
 import type { PlainSearchParameters } from 'algoliasearch-helper';
 import type { AutocompleteClassNames, AutocompleteIndexClassNames, AutocompleteIndexConfig } from 'instantsearch-ui-components';
@@ -79,6 +79,7 @@ type AutocompleteWidgetParams<TItem extends BaseHit> = {
         }>;
         cssClasses?: Partial<AutocompleteIndexClassNames>;
     };
+    transformItems?: (indices: TransformItemsIndicesConfig[]) => TransformItemsIndicesConfig[];
     /**
      * Search parameters to apply to the autocomplete indices.
      */

package/es/widgets/autocomplete/autocomplete.js

@@ -171,7 +171,8 @@ function AutocompleteWrapper(_ref4) {
       query: searchboxQuery,
       showRecent: showRecent,
       indices: indices,
-      indicesConfig: indicesConfig
+      indicesConfig: indicesConfig,
+      suggestionsIndexName: showSuggestions === null || showSuggestions === void 0 ? void 0 : showSuggestions.indexName
     }),
     storage = _useStorage.storage,
     storageHits = _useStorage.storageHits,
@@ -255,18 +256,24 @@ function AutocompleteWrapper(_ref4) {
     });
   }
   indices.forEach(function (_ref8, i) {
-    var _indicesConfig$i$temp;
+    var _currentIndexConfig$t;
     var indexId = _ref8.indexId,
       indexName = _ref8.indexName,
       hits = _ref8.hits;
+    var currentIndexConfig = find(indicesConfig, function (config) {
+      return config.indexName === indexName;
+    });
+    if (!currentIndexConfig) {
+      return;
+    }
     if (!renderState.indexTemplateProps[i]) {
       renderState.indexTemplateProps[i] = prepareTemplateProps({
         defaultTemplates: {},
         templatesConfig: instantSearchInstance.templatesConfig,
-        templates: indicesConfig[i].templates
+        templates: currentIndexConfig.templates
       });
     }
-    var headerComponent = (_indicesConfig$i$temp = indicesConfig[i].templates) !== null && _indicesConfig$i$temp !== void 0 && _indicesConfig$i$temp.header ? function (_ref9) {
+    var headerComponent = (_currentIndexConfig$t = currentIndexConfig.templates) !== null && _currentIndexConfig$t !== void 0 && _currentIndexConfig$t.header ? function (_ref9) {
       var items = _ref9.items;
       return h(TemplateComponent, _extends({}, renderState.indexTemplateProps[i], {
         templateKey: "header",
@@ -306,7 +313,7 @@ function AutocompleteWrapper(_ref4) {
         });
       }),
       getItemProps: getItemProps,
-      classNames: indicesConfig[i].cssClasses
+      classNames: currentIndexConfig.cssClasses
     });
   });
   return h(Autocomplete, _extends({}, getRootProps(), {
@@ -346,6 +353,7 @@ export function EXPERIMENTAL_autocomplete(widgetParams) {
     onSelect = _ref1.onSelect,
     _ref1$templates = _ref1.templates,
     templates = _ref1$templates === void 0 ? {} : _ref1$templates,
+    transformItems = _ref1.transformItems,
     _ref1$cssClasses = _ref1.cssClasses,
     userCssClasses = _ref1$cssClasses === void 0 ? {} : _ref1$cssClasses,
     placeholder = _ref1.placeholder;
@@ -430,7 +438,8 @@ export function EXPERIMENTAL_autocomplete(widgetParams) {
       indexId: indexName
     }).addWidgets([configure(indexSearchParameters || {})]);
   })), [_objectSpread(_objectSpread({}, makeWidget({
-    escapeHTML: escapeHTML
+    escapeHTML: escapeHTML,
+    transformItems: transformItems
   })), {}, {
     $$widgetType: 'ais.autocomplete'
   })]))];

package/es/widgets/chat/chat.d.ts

@@ -197,6 +197,13 @@ export type ChatTemplates<THit extends NonNullable<object> = BaseHit> = Partial<
         actions: ChatMessageActionProps[];
         message: ChatMessageBase;
     }>;
+    /**
+     * Template to use for prompt suggestions.
+     */
+    suggestions: Template<{
+        suggestions: string[];
+        onSuggestionClick: (suggestion: string) => void;
+    }>;
 }>;
 type ChatWidgetParams<THit extends RecordWithObjectID = RecordWithObjectID> = {
     /**
@@ -506,6 +513,7 @@ declare const _default: <THit extends RecordWithObjectID = RecordWithObjectID>(w
         setInput: (input: string) => void;
         setOpen: (open: boolean) => void;
         setMessages: (messagesParam: import("ai").UIMessage<unknown, import("ai").UIDataTypes, import("ai").UITools>[] | ((m: import("ai").UIMessage<unknown, import("ai").UIDataTypes, import("ai").UITools>[]) => import("ai").UIMessage<unknown, import("ai").UIDataTypes, import("ai").UITools>[])) => void;
+        suggestions: string[] | undefined;
         isClearing: boolean;
         clearMessages: () => void;
         onClearTransitionEnd: () => void;

package/es/widgets/chat/chat.js

@@ -19,7 +19,7 @@ import { Fragment, h, render } from 'preact';
 import { useMemo } from 'preact/hooks';
 import TemplateComponent from "../../components/Template/Template.js";
 import connectChat from "../../connectors/chat/connectChat.js";
-import { SearchIndexToolType, RecommendToolType } from "../../lib/chat/index.js";
+import { SearchIndexToolType, RecommendToolType, MemorizeToolType, MemorySearchToolType, PonderToolType } from "../../lib/chat/index.js";
 import { prepareTemplateProps } from "../../lib/templating/index.js";
 import { useStickToBottom } from "../../lib/useStickToBottom.js";
 import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
@@ -161,7 +161,13 @@ function createCarouselTool(showViewAll, templates, getSearchPageURL) {
 }
 function createDefaultTools(templates, getSearchPageURL) {
   var _ref9;
-  return _ref9 = {}, _defineProperty(_ref9, SearchIndexToolType, createCarouselTool(true, templates, getSearchPageURL)), _defineProperty(_ref9, RecommendToolType, createCarouselTool(false, templates, getSearchPageURL)), _ref9;
+  return _ref9 = {}, _defineProperty(_ref9, SearchIndexToolType, createCarouselTool(true, templates, getSearchPageURL)), _defineProperty(_ref9, RecommendToolType, createCarouselTool(false, templates, getSearchPageURL)), _defineProperty(_ref9, MemorizeToolType, {
+    templates: {}
+  }), _defineProperty(_ref9, MemorySearchToolType, {
+    templates: {}
+  }), _defineProperty(_ref9, PonderToolType, {
+    templates: {}
+  }), _ref9;
 }
 function ChatWrapper(_ref0) {
   var cssClasses = _ref0.cssClasses,
@@ -184,6 +190,7 @@ function ChatWrapper(_ref0) {
     headerProps = _ref0.headerProps,
     messagesProps = _ref0.messagesProps,
     promptProps = _ref0.promptProps,
+    suggestionsProps = _ref0.suggestionsProps,
     state = _ref0.state;
   var _useStickToBottom = useStickToBottom({
       initial: 'smooth',
@@ -212,6 +219,7 @@ function ChatWrapper(_ref0) {
     },
     headerComponent: headerProps.layoutComponent,
     promptComponent: promptProps.layoutComponent,
+    suggestionsComponent: suggestionsProps.suggestionsComponent,
     headerProps: {
       onClose: function onClose() {
         return setChatOpen(false);
@@ -275,6 +283,10 @@ function ChatWrapper(_ref0) {
       headerComponent: promptProps.headerComponent,
       footerComponent: promptProps.footerComponent,
       translations: promptProps.translations
+    },
+    suggestionsProps: {
+      onSuggestionClick: suggestionsProps.onSuggestionClick,
+      suggestions: suggestionsProps.suggestions
     }
   });
 }
@@ -308,7 +320,8 @@ var createRenderer = function createRenderer(_ref1) {
       isClearing = props.isClearing,
       clearMessages = props.clearMessages,
       onClearTransitionEnd = props.onClearTransitionEnd,
-      toolsFromConnector = props.tools;
+      toolsFromConnector = props.tools,
+      suggestions = props.suggestions;
     if (process.env.NODE_ENV === 'development' && error) {
       throw error;
     }
@@ -509,6 +522,13 @@ var createRenderer = function createRenderer(_ref1) {
         }
       }));
     } : undefined;
+    var suggestionsComponent = templates.suggestions ? function (suggestionsProps) {
+      return h(TemplateComponent, _extends({}, renderState.templateProps, {
+        templateKey: "suggestions",
+        rootTagName: "fragment",
+        data: suggestionsProps
+      }));
+    } : undefined;
     state.subscribe(rerender);
     function rerender() {
       render(h(ChatWrapper, {
@@ -562,7 +582,16 @@ var createRenderer = function createRenderer(_ref1) {
           translations: promptTranslations,
           promptRef: promptRef
         },
-        state: state
+        state: state,
+        suggestionsProps: {
+          suggestions: suggestions,
+          onSuggestionClick: function onSuggestionClick(message) {
+            sendMessage({
+              text: message
+            });
+          },
+          suggestionsComponent: suggestionsComponent
+        }
       }), containerNode);
     }
     rerender();