instantsearch.js 4.86.1 → 4.87.1

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> = {
     /**
@@ -237,7 +244,7 @@ declare const _default: <THit extends RecordWithObjectID = RecordWithObjectID>(w
         breadcrumb?: {
             [rootAttribute: string]: import("../../types").WidgetRenderState<import("../../connectors/breadcrumb/connectBreadcrumb").BreadcrumbRenderState, import("../../connectors/breadcrumb/connectBreadcrumb").BreadcrumbConnectorParams>;
         } | undefined;
-        chat?: import("../../types").WidgetRenderState<ChatRenderState<import("ai").UIMessage<unknown, import("ai").UIDataTypes, import("ai").UITools>>, ChatConnectorParams<import("ai").UIMessage<unknown, import("ai").UIDataTypes, import("ai").UITools>>> | undefined;
+        chat?: import("../../types").WidgetRenderState<ChatRenderState<import("../../lib/chat").UIMessage<unknown, import("../../lib/ai-lite").UIDataTypes, import("../../lib/ai-lite").UITools>>, ChatConnectorParams<import("../../lib/chat").UIMessage<unknown, import("../../lib/ai-lite").UIDataTypes, import("../../lib/ai-lite").UITools>>> | undefined;
         clearRefinements?: import("../../types").WidgetRenderState<import("../../connectors/clear-refinements/connectClearRefinements").ClearRefinementsRenderState, import("../../connectors/clear-refinements/connectClearRefinements").ClearRefinementsConnectorParams> | undefined;
         configure?: import("../../types").WidgetRenderState<import("../../connectors/configure/connectConfigure").ConfigureRenderState, import("../../connectors/configure/connectConfigure").ConfigureConnectorParams> | undefined;
         currentRefinements?: import("../../types").WidgetRenderState<import("../../connectors/current-refinements/connectCurrentRefinements").CurrentRefinementsRenderState, import("../../connectors/current-refinements/connectCurrentRefinements").CurrentRefinementsConnectorParams> | undefined;
@@ -505,26 +512,27 @@ declare const _default: <THit extends RecordWithObjectID = RecordWithObjectID>(w
         }>)) => void;
         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;
+        setMessages: (messagesParam: import("../../lib/chat").UIMessage<unknown, import("../../lib/ai-lite").UIDataTypes, import("../../lib/ai-lite").UITools>[] | ((m: import("../../lib/chat").UIMessage<unknown, import("../../lib/ai-lite").UIDataTypes, import("../../lib/ai-lite").UITools>[]) => import("../../lib/chat").UIMessage<unknown, import("../../lib/ai-lite").UIDataTypes, import("../../lib/ai-lite").UITools>[])) => void;
+        suggestions: string[] | undefined;
         isClearing: boolean;
         clearMessages: () => void;
         onClearTransitionEnd: () => void;
         tools: ClientSideTools;
-        widgetParams: Partial<ChatWidgetParams<RecordWithObjectID>> & ChatConnectorParams<import("ai").UIMessage<unknown, import("ai").UIDataTypes, import("ai").UITools>>;
-        addToolResult: <TOOL extends string>({ tool, toolCallId, output, }: {
-            tool: TOOL;
+        widgetParams: Partial<ChatWidgetParams<RecordWithObjectID>> & ChatConnectorParams<import("../../lib/chat").UIMessage<unknown, import("../../lib/ai-lite").UIDataTypes, import("../../lib/ai-lite").UITools>>;
+        addToolResult: <TTool extends string>({ tool, toolCallId, output, }: {
+            tool: TTool;
             toolCallId: string;
             output: unknown;
         }) => Promise<void>;
         clearError: () => void;
         error: Error | undefined;
         id: string;
-        messages: import("ai").UIMessage<unknown, import("ai").UIDataTypes, import("ai").UITools>[];
+        messages: import("../../lib/chat").UIMessage<unknown, import("../../lib/ai-lite").UIDataTypes, import("../../lib/ai-lite").UITools>[];
         regenerate: ({ messageId, ...options }?: {
             messageId?: string;
-        } & import("ai").ChatRequestOptions) => Promise<void>;
-        resumeStream: (options?: import("ai").ChatRequestOptions) => Promise<void>;
-        sendMessage: (message?: (Omit<import("ai").UIMessage<unknown, import("ai").UIDataTypes, import("ai").UITools>, "id" | "role"> & {
+        } & import("../../lib/ai-lite").ChatRequestOptions) => Promise<void>;
+        resumeStream: (options?: import("../../lib/ai-lite").ChatRequestOptions) => Promise<void>;
+        sendMessage: (message?: (Omit<import("../../lib/chat").UIMessage<unknown, import("../../lib/ai-lite").UIDataTypes, import("../../lib/ai-lite").UITools>, "id" | "role"> & {
             id?: string | undefined;
             role?: "system" | "user" | "assistant" | undefined;
         } & {
@@ -533,21 +541,21 @@ declare const _default: <THit extends RecordWithObjectID = RecordWithObjectID>(w
             messageId?: string;
         }) | {
             text: string;
-            files?: FileList | import("ai").FileUIPart[];
+            files?: FileList | import("../../lib/ai-lite").FileUIPart[];
             metadata?: unknown;
             parts?: never;
             messageId?: string;
         } | {
-            files: FileList | import("ai").FileUIPart[];
+            files: FileList | import("../../lib/ai-lite").FileUIPart[];
             metadata?: unknown;
             parts?: never;
             messageId?: string;
-        } | undefined, options?: import("ai").ChatRequestOptions) => Promise<void>;
-        status: import("ai").ChatStatus;
+        } | undefined, options?: import("../../lib/ai-lite").ChatRequestOptions) => Promise<void>;
+        status: import("../../lib/ai-lite").ChatStatus;
         stop: () => Promise<void>;
     };
     dispose(): void;
     shouldRender(): true;
-    chatInstance: import("../../lib/chat").Chat<import("ai").UIMessage<unknown, import("ai").UIDataTypes, import("ai").UITools>>;
+    chatInstance: import("../../lib/chat").Chat<import("../../lib/chat").UIMessage<unknown, import("../../lib/ai-lite").UIDataTypes, import("../../lib/ai-lite").UITools>>;
 };
 export default _default;

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();