hofix: fix wrong event props

oramasearch · Nov 25, 2024 · a97014e · a97014e
1 parent 97bdf32
commit a97014e
Show file tree

Hide file tree

Showing 12 changed files with 25 additions and 27 deletions.
diff --git a/apps/demo-react/src/App.tsx b/apps/demo-react/src/App.tsx
@@ -23,8 +23,8 @@ function App() {
             <div className="component-row">
               <OramaChatBox
                 index={{
-                  api_key: 'yl2JSnjLNBV6FVfUWEyadpjFr6KzPiDR',
-                  endpoint: 'https://cloud.orama.run/v1/indexes/recipes-m7w9mm',
+                  api_key: 'qopIuAERiWP2EZOpDjvczjws7WV40yrj',
+                  endpoint: 'https://cloud.orama.run/v1/indexes/nodejs-org-dev-hhqrzv',
                 }}
                 style={{ height: '600px' }}
                 onAnswerSourceClick={(e: Event) => console.log(e)}

diff --git a/packages/ui-stencil/src/components.d.ts b/packages/ui-stencil/src/components.d.ts
@@ -339,7 +339,7 @@ declare global {
         new (): HTMLOramaChatButtonElement;
     };
     interface HTMLOramaChatMessagesContainerElementEventMap {
-        "answerGenerated": OnSearchCompletedCallbackProps;
+        "answerGenerated": OnAnswerGeneratedCallbackProps;
     }
     interface HTMLOramaChatMessagesContainerElement extends Components.OramaChatMessagesContainer, HTMLStencilElement {
         addEventListener<K extends keyof HTMLOramaChatMessagesContainerElementEventMap>(type: K, listener: (this: HTMLOramaChatMessagesContainerElement, ev: OramaChatMessagesContainerCustomEvent<HTMLOramaChatMessagesContainerElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -450,7 +450,7 @@ declare global {
     };
     interface HTMLOramaSearchElementEventMap {
         "searchCompleted": OnSearchCompletedCallbackProps;
-        "answerGenerated": OnSearchCompletedCallbackProps;
+        "answerGenerated": OnAnswerGeneratedCallbackProps;
     }
     interface HTMLOramaSearchElement extends Components.OramaSearch, HTMLStencilElement {
         addEventListener<K extends keyof HTMLOramaSearchElementEventMap>(type: K, listener: (this: HTMLOramaSearchElement, ev: OramaSearchCustomEvent<HTMLOramaSearchElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -656,7 +656,7 @@ declare namespace LocalJSX {
         "chatMarkdownLinkTarget"?: ChatMarkdownLinkTarget;
         "chatMarkdownLinkTitle"?: ChatMarkdownLinkTitle;
         "interactions"?: TChatInteraction[];
-        "onAnswerGenerated"?: (event: OramaChatMessagesContainerCustomEvent<OnSearchCompletedCallbackProps>) => void;
+        "onAnswerGenerated"?: (event: OramaChatMessagesContainerCustomEvent<OnAnswerGeneratedCallbackProps>) => void;
     }
     interface OramaChatUserMessage {
         "interaction"?: TChatInteraction;
@@ -714,7 +714,7 @@ declare namespace LocalJSX {
         "highlightTitle"?: HighlightOptions | false;
         "linksRel"?: string;
         "linksTarget"?: string;
-        "onAnswerGenerated"?: (event: OramaSearchCustomEvent<OnSearchCompletedCallbackProps>) => void;
+        "onAnswerGenerated"?: (event: OramaSearchCustomEvent<OnAnswerGeneratedCallbackProps>) => void;
         "onSearchCompleted"?: (event: OramaSearchCustomEvent<OnSearchCompletedCallbackProps>) => void;
         "placeholder"?: string;
         "sourceBaseUrl"?: string;

diff --git a/...ma-chat-messages-container/orama-chat-assistent-message/orama-sources/readme.md b/...ma-chat-messages-container/orama-chat-assistent-message/orama-sources/readme.md
@@ -13,7 +13,7 @@
 | `linksTarget`   | `links-target`      |             | `string`                                                   | `'_blank'`                                                                    |
 | `sourceBaseURL` | `source-base-u-r-l` |             | `string`                                                   | `''`                                                                          |
 | `sources`       | `sources`           |             | `any`                                                      | `undefined`                                                                   |
-| `sourcesMap`    | --                  |             | `{ title?: string; path?: string; description?: string; }` | `{     title: 'title',     description: 'description',     path: 'path',   }` |
+| `sourcesMap`    | --                  |             | `{ title?: string; description?: string; path?: string; }` | `{     title: 'title',     description: 'description',     path: 'path',   }` |
 
 
 ## Events

diff --git a/...l/src/components/internal/orama-chat-messages-container/orama-chat-messages-container.tsx b/...l/src/components/internal/orama-chat-messages-container/orama-chat-messages-container.tsx
@@ -4,6 +4,7 @@ import type {
   ChatMarkdownLinkHref,
   ChatMarkdownLinkTarget,
   ChatMarkdownLinkTitle,
+  OnAnswerGeneratedCallbackProps,
   OnSearchCompletedCallbackProps,
 } from '@/types'
 
@@ -18,7 +19,7 @@ export class OramaChatMessagesContainer {
   @Prop() chatMarkdownLinkHref?: ChatMarkdownLinkHref
   @Prop() chatMarkdownLinkTarget?: ChatMarkdownLinkTarget
 
-  @Event({ bubbles: true, composed: true }) answerGenerated: EventEmitter<OnSearchCompletedCallbackProps>
+  @Event({ bubbles: true, composed: true }) answerGenerated: EventEmitter<OnAnswerGeneratedCallbackProps>
 
   @Element() el: HTMLElement
 
@@ -27,9 +28,8 @@ export class OramaChatMessagesContainer {
   // TODO: I'm not sure about having this here as we're breaking our rule of maintain service access only to the very top level component
   onSuggestionClick = (suggestion: string) => {
     chatContext.chatService?.sendQuestion(suggestion, undefined, {
-      onAnswerGeneratedCallback(onAnswerGeneratedCallbackProps) {
-        this.answerGenerated.emit(onAnswerGeneratedCallbackProps)
-      },
+      onAnswerGeneratedCallback: (onAnswerGeneratedCallbackProps) =>
+        this.answerGenerated.emit(onAnswerGeneratedCallbackProps),
     })
   }
 

diff --git a/...ages/ui-stencil/src/components/internal/orama-chat-messages-container/readme.md b/...ages/ui-stencil/src/components/internal/orama-chat-messages-container/readme.md
@@ -17,9 +17,9 @@
 
 ## Events
 
-| Event             | Description | Type                                                                                                                                             |
-| ----------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `answerGenerated` |             | `CustomEvent<{ clientSearchParams: ClientSearchParams; result: { results: SearchResultBySection[]; resultsCount: number; facets: Facet[]; }; }>` |
+| Event             | Description | Type                                                                                                                                 |
+| ----------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------ |
+| `answerGenerated` |             | `CustomEvent<{ askParams: AskParams; query: string; sources: Results<unknown>; answer: string; segment: string; trigger: string; }>` |
 
 
 ## Dependencies

diff --git a/packages/ui-stencil/src/components/internal/orama-chat/readme.md b/packages/ui-stencil/src/components/internal/orama-chat/readme.md
@@ -19,7 +19,7 @@
 | `placeholder`            | `placeholder`     |             | `string`                                                      | `'Ask me anything'` |
 | `showClearChat`          | `show-clear-chat` |             | `boolean`                                                     | `true`              |
 | `sourceBaseUrl`          | `source-base-url` |             | `string`                                                      | `''`                |
-| `sourcesMap`             | --                |             | `{ title?: string; path?: string; description?: string; }`    | `undefined`         |
+| `sourcesMap`             | --                |             | `{ title?: string; description?: string; path?: string; }`    | `undefined`         |
 | `suggestions`            | --                |             | `string[]`                                                    | `undefined`         |
 | `systemPrompts`          | --                |             | `string[]`                                                    | `undefined`         |