@aws/mynah-ui 4.6.2 → 4.6.3

package/dist/static.d.ts

@@ -14,27 +14,84 @@ export interface QuickActionCommandGroup {
     groupName?: string;
     commands: QuickActionCommand[];
 }
+/**
+ * data store model to update the mynah ui partially or fully
+ */
 export interface MynahUIDataModel {
+    /**
+     * Tab title
+     * */
     tabTitle?: string;
+    /**
+     * If tab is running an action (loadingChat = true) this markdown will be shown before close in a popup
+     */
     tabCloseConfirmationMessage?: string | null;
+    /**
+     * Keep tab open button text
+     */
     tabCloseConfirmationKeepButton?: string | null;
+    /**
+     * Close tab button text
+     */
     tabCloseConfirmationCloseButton?: string | null;
+    /**
+     * Chat screen loading animation state (mainly use during the stream or getting the initial answer)
+     */
     loadingChat?: boolean;
+    /**
+     * Show chat avatars or not
+     * */
     showChatAvatars?: boolean;
+    /**
+     * Show cancel button while loading the chat
+     * */
     cancelButtonWhenLoading?: boolean;
+    /**
+    * Quick Action commands to show when user hits / to the input initially
+    */
     quickActionCommands?: QuickActionCommandGroup[];
+    /**
+    * Placeholder to be shown on prompt input
+    */
     promptInputPlaceholder?: string;
+    /**
+    * Info block to be shown under prompt input
+    */
     promptInputInfo?: string;
+    /**
+    * A sticky chat item card on top of the prompt input
+    */
     promptInputStickyCard?: Partial<ChatItem> | null;
+    /**
+    * Prompt input field disabled state, set to tru to disable it
+    */
     promptInputDisabledState?: boolean;
+    /**
+    * List of chat item objects to be shown on the web suggestions search screen
+    */
     chatItems?: ChatItem[];
+    /**
+     * Attached code under the prompt input field
+     */
     selectedCodeSnippet?: string;
+    /**
+     * Tab bar buttons next to the tab items
+     */
     tabBarButtons?: TabBarMainAction[];
 }
 export interface MynahUITabStoreTab {
+    /**
+     * Is tab selected
+     */
     isSelected?: boolean;
+    /**
+    * Tab items data store
+    */
     store?: MynahUIDataModel;
 }
+/**
+ * tabs store model to update the tabs partially or fully
+ */
 export interface MynahUITabStoreModel {
     [tabId: string]: MynahUITabStoreTab;
 }
@@ -54,7 +111,7 @@ export declare enum MynahEventNames {
     BODY_ACTION_CLICKED = "bodyActionClicked",
     SHOW_MORE_WEB_RESULTS_CLICK = "showMoreWebResultsClick",
     SHOW_FEEDBACK_FORM = "showFeedbackForm",
-    OPEN_DIFF = "openDiff",
+    FILE_CLICK = "fileClick",
     FILE_ACTION_CLICK = "fileActionClick",
     CUSTOM_FORM_ACTION_CLICK = "customFormActionClick",
     ADD_CODE_SNIPPET = "addCodeSnippet",
@@ -221,17 +278,38 @@ export declare enum RelevancyVoteType {
     UP = "upvote",
     DOWN = "downvote"
 }
+/**
+ * 'interaction' will be set if there was a potential text selection or a click input was triggered by the user.
+ *  If this is a selection selectionDistanceTraveled object will also be filled
+ * 'timespend' will be set basically if there is no interaction except mouse movements in a time spent longer than the ENGAGEMENT_DURATION_LIMIT
+ *  Don't forget that in 'timespend' case, user should leave the suggestion card at some point to count it as an interaction.
+ *  (They need to go back to the code or move to another card instead)
+ */
 export declare enum EngagementType {
     INTERACTION = "interaction",
     TIME = "timespend"
 }
 export interface Engagement {
+    /**
+       * Engagement type
+       */
     engagementType: EngagementType;
+    /**
+       * Total duration in ms till the engagement triggered.
+       */
     engagementDurationTillTrigger: number;
+    /**
+       * Total mouse movement in x and y directions till the engagement triggered.
+       * To avoid confusion: this is not the distance between start and end points, this is the total traveled distance.
+       */
     totalMouseDistanceTraveled: {
         x: number;
         y: number;
     };
+    /**
+       * If the engagementType is "interaction" and this object has a value, you can assume it as a text selection.
+       * If the engagementType is "interaction" but this object is not defined, you can assume it as a click
+       */
     selectionDistanceTraveled?: {
         x: number;
         y: number;

package/package.json

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