@aws/mynah-ui 4.14.0 → 4.15.0

package/dist/static.d.ts

@@ -103,6 +103,7 @@ export interface MynahUITabStoreModel {
 export declare enum MynahEventNames {
     RESET_STORE = "resetStore",
     FEEDBACK_SET = "feedbackSet",
+    ROOT_FOCUS = "rootFocusStateChange",
     CARD_VOTE = "cardVote",
     SOURCE_LINK_CLICK = "sourceLinkClick",
     INFO_LINK_CLICK = "infoLinkClick",
@@ -219,7 +220,7 @@ export interface ChatItemAction extends ChatPrompt {
     pillText: string;
     disabled?: boolean;
     description?: string;
-    status?: 'info' | 'success' | 'warning' | 'error';
+    status?: 'primary' | 'info' | 'success' | 'warning' | 'error';
     icon?: MynahIcons;
 }
 export interface ChatItemButton {
@@ -229,7 +230,7 @@ export interface ChatItemButton {
     id: string;
     disabled?: boolean;
     description?: string;
-    status?: 'info' | 'success' | 'warning' | 'error';
+    status?: 'primary' | 'info' | 'success' | 'warning' | 'error';
     icon?: MynahIcons;
 }
 export interface TabBarAction {

package/docs/DATAMODEL.md

@@ -269,7 +269,7 @@ const mynahUI = new MynahUI({
 mynahUI.updateStore('tab-1', {
     contextCommands: [
       {
-        groupName: 'Metion code',
+        groupName: 'Mention code',
         commands:[
           {
             command: '@ws',
@@ -2134,7 +2134,7 @@ mynahUI.notify({
 ---
 
 ## ChatPrompt
-This is the object model which will be send along with the `onChatPrompt` event.
+This is the object model which will be sent along with the `onChatPrompt` event.
 
 ```typescript
 export interface ChatPrompt {

package/docs/PROPERTIES.md

@@ -11,6 +11,7 @@ export interface MynahUIProps {
     messageId: string,
     eventId?: string) => void;
   onReady?: () => void;
+  onFocusStateChanged?: (focusState: boolean) => void;
   onVote?: (
     tabId: string,
     messageId: string,
@@ -58,6 +59,17 @@ export interface MynahUIProps {
     tabId: string,
     messageId: string,
     engagement: Engagement) => void;
+  onCodeBlockActionClicked?: (
+    tabId: string,
+    messageId: string,
+    actionId: string,
+    data?: string,
+    code?: string,
+    type?: CodeSelectionType,
+    referenceTrackerInformation?: ReferenceTrackerInformation[],
+    eventId?: string,
+    codeBlockIndex?: number,
+    totalCodeBlocks?: number,) => void;
   onCopyCodeToClipboard?: (
     tabId: string,
     messageId: string,
@@ -66,7 +78,8 @@ export interface MynahUIProps {
     referenceTrackerInformation?: ReferenceTrackerInformation[],
     eventId?: string,
     codeBlockIndex?: number,
-    totalCodeBlocks?: number) => void;
+    totalCodeBlocks?: number,
+    data?: string,) => void;
   onCodeInsertToCursorPosition?: (
     tabId: string,
     messageId: string,
@@ -75,7 +88,8 @@ export interface MynahUIProps {
     referenceTrackerInformation?: ReferenceTrackerInformation[],
     eventId?: string,
     codeBlockIndex?: number,
-    totalCodeBlocks?: number) => void;
+    totalCodeBlocks?: number,
+    data?: string,) => void;
   onSourceLinkClick?: (
     tabId: string,
     messageId: string,
@@ -286,6 +300,20 @@ onReady: () => {
 
 ---
 
+### `onFocusStateChanged`
+
+This event will be fired whenever user targets to MynahUI or wents away.
+
+```typescript
+...
+onFocusStateChanged: (focusState: boolean) => {
+      console.log(`MynahUI is ${focusState ? 'focused' : 'not focused'}.`);
+    };
+...
+```
+
+---
+
 ### `onVote`
 
 This event will be fired when end user clicks one of the thumbs up or down buttons to vote the answer. It will pass the arguments `tabId`, `messageId` and the `vote`.
@@ -554,6 +582,45 @@ onChatItemEngagement?: (
 ```
 ---
 
+### `onCodeBlockActionClicked`
+
+This event will be fired when user clicks one of the buttons from custom added `codeBlockActions` button on the footer of a code block. It will pass `tabId`, `actionId`, `data`, `messageId`, `code` for the copied code to theclipboard as a text, `type` for the type of the code copied (block or selection) and the `referenceTrackerInformation` if the copied code block contains some code reference as the arguments. Finally after the `eventId` attribute, you can get the index of the code block inside that message with `codeBlockIndex` together with total number of code blocks again inside that message with `totalCodeBlocks`.
+
+**Note:** even though the `referenceTrackerInformation` comes to the message with `codeReference` attribute with the index position depending on the whole content of the body of the message, the return of it as an attribute from this event gives the indexes according to position inside that code block.
+
+_Please refer to the [data model](./DATAMODEL.md#codeblockactions) to learn more about the `codeBlockActions`._
+_Please refer to the [data model](./DATAMODEL.md#codereference) to learn more about the `ReferenceTrackerInformation` object type._
+
+
+<p align="center">
+  <img src="./img/data-model/chatItems/codeBlockActions.png" alt="onCodeBlockActionClicked" style="max-width:500px; width:100%;border: 1px solid #e0e0e0;">
+</p>
+
+```typescript
+...
+onCodeBlockActionClicked: (
+  tabId, 
+  messageId, 
+  actionId, 
+  data, 
+  code, 
+  type, 
+  referenceTrackerInformation, 
+  eventId, 
+  codeBlockIndex, 
+  totalCodeBlocks) => {
+    Log(`Code action <b>${actionId}</b> clicked on tab <b>${tabId}</b> inside message <b>${messageId}</b><br/>
+      type: <b>${type ?? 'unknown'}</b><br/>
+      data: <b>${JSON.stringify(data ?? {})}</b><br/>
+      code: <b>${escapeHTML(code ?? '')}</b><br/>
+      referenceTracker: <b>${referenceTrackerInformation?.map(rt => rt.information).join('<br/>') ?? ''}</b><br/>
+      codeBlockIndex: <b>${(codeBlockIndex ?? 0) + 1}</b> of ${totalCodeBlocks}
+    `);
+},
+...
+```
+---
+
 ### `onCopyCodeToClipboard`
 
 This event will be fired when user clicks the copy button on the footer of a code block or selects some text inside a code block and triggers keyboard shortcuts for copying. It will pass `tabId`, `messageId`, `code` for the copied code to theclipboard as a text, `type` for the type of the code copied (block or selection) and the `referenceTrackerInformation` if the copied code block contains some code reference as the arguments. Finally after the `eventId` attribute, you can get the index of the code block inside that message with `codeBlockIndex` together with total number of code blocks again inside that message with `totalCodeBlocks`.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws/mynah-ui",
   "displayName": "AWS Mynah UI",
-  "version": "4.14.0",
+  "version": "4.15.0",
   "description": "AWS Toolkit VSCode and Intellij IDE Extension Mynah UI",
   "publisher": "Amazon Web Services",
   "license": "Apache License 2.0",