Fix events types

oramasearch · Nov 27, 2024 · 116e3e5 · 116e3e5
1 parent 61f9219
commit 116e3e5
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 10 deletions.
diff --git a/packages/ui-stencil/src/components.d.ts b/packages/ui-stencil/src/components.d.ts
@@ -6,7 +6,7 @@
  */
 import { HTMLStencilElement, JSXBase } from "@stencil/core/internal";
 import { ButtonProps } from "./components/internal/orama-button/orama-button";
-import { ChatMarkdownLinkHref, ChatMarkdownLinkTarget, ChatMarkdownLinkTitle, CloudIndexConfig, ColorScheme, Facet, OnAnswerGeneratedCallbackProps, OnAnswerSourceClickCallbackProps, OnChatMarkdownLinkClickedCallbackProps, OnSearchCompletedCallbackProps, OnSearchResultClickCallbackProps, ResultMap, SearchResult, SearchResultBySection, SourcesMap } from "./types/index";
+import { ChatMarkdownLinkHref, ChatMarkdownLinkTarget, ChatMarkdownLinkTitle, CloudIndexConfig, ColorScheme, Facet, OnAnswerGeneratedCallbackProps, OnAnswerSourceClickCallbackProps, OnChatMarkdownLinkClickedCallbackProps, OnSearchCompletedCallbackProps, OnSearchResultClickCallbackProps, ResultMap, SearchResultBySection, SourcesMap } from "./types/index";
 import { TChatInteraction } from "./context/chatContext";
 import { OramaClient } from "@oramacloud/client";
 import { AnyOrama, Orama, SearchParams } from "@orama/orama";
@@ -18,7 +18,7 @@ import { TThemeOverrides as TThemeOverrides1 } from "./components.d";
 import { SearchResultsProps } from "./components/internal/orama-search-results/orama-search-results";
 import { TextProps } from "./components/internal/orama-text/orama-text";
 export { ButtonProps } from "./components/internal/orama-button/orama-button";
-export { ChatMarkdownLinkHref, ChatMarkdownLinkTarget, ChatMarkdownLinkTitle, CloudIndexConfig, ColorScheme, Facet, OnAnswerGeneratedCallbackProps, OnAnswerSourceClickCallbackProps, OnChatMarkdownLinkClickedCallbackProps, OnSearchCompletedCallbackProps, OnSearchResultClickCallbackProps, ResultMap, SearchResult, SearchResultBySection, SourcesMap } from "./types/index";
+export { ChatMarkdownLinkHref, ChatMarkdownLinkTarget, ChatMarkdownLinkTitle, CloudIndexConfig, ColorScheme, Facet, OnAnswerGeneratedCallbackProps, OnAnswerSourceClickCallbackProps, OnChatMarkdownLinkClickedCallbackProps, OnSearchCompletedCallbackProps, OnSearchResultClickCallbackProps, ResultMap, SearchResultBySection, SourcesMap } from "./types/index";
 export { TChatInteraction } from "./context/chatContext";
 export { OramaClient } from "@oramacloud/client";
 export { AnyOrama, Orama, SearchParams } from "@orama/orama";
@@ -517,7 +517,7 @@ declare global {
         new (): HTMLOramaSlidingPanelElement;
     };
     interface HTMLOramaSourcesElementEventMap {
-        "answerSourceClick": SearchResult;
+        "answerSourceClick": OnAnswerSourceClickCallbackProps;
     }
     interface HTMLOramaSourcesElement extends Components.OramaSources, HTMLStencilElement {
         addEventListener<K extends keyof HTMLOramaSourcesElementEventMap>(type: K, listener: (this: HTMLOramaSourcesElement, ev: OramaSourcesCustomEvent<HTMLOramaSourcesElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -792,7 +792,7 @@ declare namespace LocalJSX {
     interface OramaSources {
         "linksRel"?: string;
         "linksTarget"?: string;
-        "onAnswerSourceClick"?: (event: OramaSourcesCustomEvent<SearchResult>) => void;
+        "onAnswerSourceClick"?: (event: OramaSourcesCustomEvent<OnAnswerSourceClickCallbackProps>) => void;
         "sourceBaseURL"?: string;
         "sources"?: any;
         "sourcesMap"?: SourcesMap;

diff --git a/...rama-chat-messages-container/orama-chat-assistent-message/orama-sources/orama-sources.tsx b/...rama-chat-messages-container/orama-chat-assistent-message/orama-sources/orama-sources.tsx
@@ -1,4 +1,4 @@
-import type { SourcesMap, SearchResult } from '@/types'
+import type { SourcesMap, SearchResult, OnAnswerSourceClickCallbackProps } from '@/types'
 import { Component, Event, Prop, State, h, type EventEmitter } from '@stencil/core'
 import '@phosphor-icons/webcomponents/dist/icons/PhCaretLeft.mjs'
 import '@phosphor-icons/webcomponents/dist/icons/PhCaretRight.mjs'
@@ -27,7 +27,8 @@ export class OramaSources {
   @State() isCarouselScrollAtEnd = false
   @State() isCarouselScrollAtStart = false
 
-  @Event({ bubbles: true, composed: true, cancelable: true }) answerSourceClick: EventEmitter<SearchResult>
+  @Event({ bubbles: true, composed: true, cancelable: true })
+  answerSourceClick: EventEmitter<OnAnswerSourceClickCallbackProps>
 
   // TODO: Move this to utils
   private buildUrl(path: string): string {
@@ -123,7 +124,7 @@ export class OramaSources {
   }
 
   handleItemClick = (originalOnClickEvent: MouseEvent, item: SearchResult) => {
-    const answerSourceClick = this.answerSourceClick.emit(item)
+    const answerSourceClick = this.answerSourceClick.emit({ source: item })
 
     if (answerSourceClick.defaultPrevented) {
       originalOnClickEvent.preventDefault()

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
@@ -18,9 +18,9 @@
 
 ## Events
 
-| Event               | Description | Type                                                                             |
-| ------------------- | ----------- | -------------------------------------------------------------------------------- |
-| `answerSourceClick` |             | `CustomEvent<{ id: string; title: string; description: string; path: string; }>` |
+| Event               | Description | Type                                     |
+| ------------------- | ----------- | ---------------------------------------- |
+| `answerSourceClick` |             | `CustomEvent<{ source: SearchResult; }>` |
 
 
 ## Dependencies