feat: extend tabdata interface to include support for welcome screen (#411)

* feat: extend tabdata interface to include support for welcome screen

* feat: include tabHeaderDetails in the tab interface

* chore: removed old tabData title and grouped PromptInput data

* feat: added id to chatActions

* feat: adding welcome counter update message in the ui contract

* feat: adding title to tabdata

Author: anasstahr

chat-client-ui-types/src/uiContracts.ts

@@ -24,6 +24,7 @@ export const AUTH_FOLLOW_UP_CLICKED = 'authFollowUpClicked'
 export const GENERIC_COMMAND = 'genericCommand'
 export const CHAT_OPTIONS = 'chatOptions'
 export const DISCLAIMER_ACKNOWLEDGED = 'disclaimerAcknowledged'
+export const WELCOME_COUNTER_UPDATE_MESSAGE = 'welcomeCounterUpdateMessage'
 
 export type UiMessageCommand =
     | typeof SEND_TO_PROMPT
@@ -34,6 +35,7 @@ export type UiMessageCommand =
     | typeof CHAT_OPTIONS
     | typeof COPY_TO_CLIPBOARD
     | typeof DISCLAIMER_ACKNOWLEDGED
+    | typeof WELCOME_COUNTER_UPDATE_MESSAGE
 
 export interface UiMessage {
     command: UiMessageCommand

types/chat.ts

@@ -30,6 +30,8 @@ export interface ChatItemAction {
     disabled?: boolean
     description?: string
     type?: string
+    status?: string
+    id?: string
 }
 
 export interface SourceLink {
@@ -102,6 +104,8 @@ export interface FileList {
 export interface ChatMessage {
     type?: 'answer' | 'prompt' | 'system-prompt' // will default to 'answer'
     body?: string
+    buttons: ChatItemAction[]
+    icon?: IconType
     messageId?: string
     canBeVoted?: boolean // requires messageId to be filled to show vote thumbs
     relatedContent?: {
@@ -158,10 +162,24 @@ export interface QuickActions {
 }
 
 export interface TabData {
-    placeholderText?: string
+    title?: string
+    tabHeader?: TabHeader
+    promptInput?: PromptInput
+    compactMode?: boolean
     messages: ChatMessage[]
 }
 
+export interface TabHeader {
+    icon?: IconType
+    title?: string
+    description?: string
+}
+
+export interface PromptInput {
+    placeholderText?: string
+    label?: string
+}
+
 /**
  * Registration options regarding chat data
  * Currently contains the available quick actions provided by a server