@aws/mynah-ui 3.3.0 → 3.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. package/.eslintrc.js +2 -0
  2. package/README.md +3 -1
  3. package/dist/helper/store.d.ts +1 -0
  4. package/dist/main.d.ts +1 -0
  5. package/dist/main.js +1 -1
  6. package/dist/main.js.map +1 -1
  7. package/dist/static.d.ts +1 -2
  8. package/package.json +1 -1
  9. package/docs/CONFIG.md +0 -190
  10. package/docs/DATAMODEL.md +0 -932
  11. package/docs/PROPERTIES.md +0 -615
  12. package/docs/STARTUP.md +0 -50
  13. package/docs/STYLING.md +0 -175
  14. package/docs/USAGE.md +0 -325
  15. package/docs/img/code-attachment.png +0 -0
  16. package/docs/img/data-model/chatItems/answer.png +0 -0
  17. package/docs/img/data-model/chatItems/answerStream.png +0 -0
  18. package/docs/img/data-model/chatItems/body.png +0 -0
  19. package/docs/img/data-model/chatItems/canBeVoted.png +0 -0
  20. package/docs/img/data-model/chatItems/codeReference-1.png +0 -0
  21. package/docs/img/data-model/chatItems/codeReference-2.png +0 -0
  22. package/docs/img/data-model/chatItems/codeResult.png +0 -0
  23. package/docs/img/data-model/chatItems/followUp-1.png +0 -0
  24. package/docs/img/data-model/chatItems/followUp-2.png +0 -0
  25. package/docs/img/data-model/chatItems/notification-1.png +0 -0
  26. package/docs/img/data-model/chatItems/notification-2.png +0 -0
  27. package/docs/img/data-model/chatItems/notification-3.png +0 -0
  28. package/docs/img/data-model/chatItems/notification-4.png +0 -0
  29. package/docs/img/data-model/chatItems/prompt.png +0 -0
  30. package/docs/img/data-model/chatItems/relatedContent-1.png +0 -0
  31. package/docs/img/data-model/chatItems/relatedContent-2.png +0 -0
  32. package/docs/img/data-model/chatItems/relatedContent-3.png +0 -0
  33. package/docs/img/data-model/chatItems/systemPrompt.png +0 -0
  34. package/docs/img/data-model/tabStore/loadingChat-1.png +0 -0
  35. package/docs/img/data-model/tabStore/loadingChat-2.png +0 -0
  36. package/docs/img/data-model/tabStore/promptInputDisabledState.png +0 -0
  37. package/docs/img/data-model/tabStore/promptInputPlaceholder.png +0 -0
  38. package/docs/img/data-model/tabStore/quickActionCommands.png +0 -0
  39. package/docs/img/data-model/tabStore/stopChatResponse.png +0 -0
  40. package/docs/img/data-model/tabStore/tabTitle.png +0 -0
  41. package/docs/img/feedbackOptions.png +0 -0
  42. package/docs/img/maxTabs1.png +0 -0
  43. package/docs/img/noPrompt.png +0 -0
  44. package/docs/img/notification.png +0 -0
  45. package/docs/img/onChatItemEngagement.png +0 -0
  46. package/docs/img/onChatPrompt.png +0 -0
  47. package/docs/img/onCodeInsertToCursorPosition.png +0 -0
  48. package/docs/img/onCopyCodeToClipboard.png +0 -0
  49. package/docs/img/onFollowupClicked.png +0 -0
  50. package/docs/img/onInfoLinkClick.png +0 -0
  51. package/docs/img/onLinkClick.png +0 -0
  52. package/docs/img/onOpenDiff.png +0 -0
  53. package/docs/img/onSendFeedback-1.png +0 -0
  54. package/docs/img/onSendFeedback-2.png +0 -0
  55. package/docs/img/onSendFeedback-3.png +0 -0
  56. package/docs/img/onShowMoreClick.png +0 -0
  57. package/docs/img/onSourceLinkClick.png +0 -0
  58. package/docs/img/onStopChatResponse.png +0 -0
  59. package/docs/img/onTabAdd.png +0 -0
  60. package/docs/img/onTabChange.png +0 -0
  61. package/docs/img/onTabRemove.png +0 -0
  62. package/docs/img/onVote.png +0 -0
  63. package/docs/img/prompt-with-code-attached.png +0 -0
  64. package/docs/img/texts/codeFileSuggestions.png +0 -0
  65. package/docs/img/texts/copyInsertToCursor.png +0 -0
  66. package/docs/img/texts/feedbackForm.png +0 -0
  67. package/docs/img/texts/mainTitle.png +0 -0
  68. package/docs/img/texts/noMoreTabs.png +0 -0
  69. package/docs/img/texts/spinnerText.png +0 -0
  70. package/docs/img/texts/stopGenerating.png +0 -0
  71. package/docs/img/texts/voteAndSourceActions.png +0 -0
  72. package/docs/img/theming-1.png +0 -0
  73. package/docs/img/theming-2.png +0 -0
package/dist/static.d.ts CHANGED
@@ -105,7 +105,6 @@ export interface ChatPrompt {
105
105
  prompt?: string;
106
106
  escapedPrompt?: string;
107
107
  command?: string;
108
- attachment?: SourceLink;
109
108
  }
110
109
  export interface ChatItemFollowUp extends ChatPrompt {
111
110
  type?: string;
@@ -141,7 +140,7 @@ export interface ReferenceTrackerInformation {
141
140
  licenseName?: string;
142
141
  repository?: string;
143
142
  url?: string;
144
- recommendationContentSpan: {
143
+ recommendationContentSpan?: {
145
144
  start: number;
146
145
  end: number;
147
146
  };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws/mynah-ui",
3
3
  "displayName": "AWS Mynah UI",
4
- "version": "3.3.0",
4
+ "version": "3.3.2",
5
5
  "description": "AWS Toolkit VSCode and Intellij IDE Extension Mynah UI",
6
6
  "publisher": "Amazon Web Services",
7
7
  "license": "Apache License 2.0",
package/docs/CONFIG.md DELETED
@@ -1,190 +0,0 @@
1
- # MynahUI Config
2
-
3
- You can set the config from the constructor parameters while creating a new instance of `mynah-ui`.
4
-
5
- _**Note:** You cannot set it on runtime. It is getting used just once during the initialization._
6
-
7
- ```typescript
8
- ...
9
- interface ConfigModel {
10
- // Do not forget that you have to provide all of them
11
- // Config doesn't allow partial set of texts
12
- texts: {
13
- mainTitle: string;
14
- feedbackFormTitle: string;
15
- feedbackFormOptionsLabel: string;
16
- feedbackFormCommentLabel: string;
17
- feedbackThanks: string;
18
- feedbackReportButtonLabel: string;
19
- codeSuggestions: string;
20
- clickFileToViewDiff: string;
21
- files: string;
22
- insertAtCursorLabel: string;
23
- copy: string;
24
- showMore: string;
25
- save: string; // not used or deprecated
26
- cancel: string;
27
- submit: string;
28
- stopGenerating: string;
29
- copyToClipboard: string; // not used or deprecated
30
- noMoreTabsTooltip: string;
31
- codeSuggestionWithReferenceTitle: string;
32
- spinnerText: string;
33
- };
34
- // Options to show up on the overlay feedback form
35
- // after user clicks to downvote on a chat item
36
- // and clicks 'Report' again
37
- feedbackOptions: Array<{
38
- label: string;
39
- value: string;
40
- }>;
41
- maxTabs: number; // set 1 to hide tabs panel
42
- showPromptField: boolean; // shows prompt field (default: true)
43
- }
44
- ...
45
- ```
46
- ---
47
-
48
- <p><br/></p>
49
-
50
- # `texts`
51
- All static texts will be shown on UI.
52
- Please take a look at each image to identify which text blongs to which item on UI.
53
-
54
- ## mainTitle
55
- Default tab title text if it is not set through store data for that tab.
56
-
57
- <p align="center">
58
- <img src="./img/texts/mainTitle.png" alt="mainTitle" style="max-width:500px; width:100%;border: 1px solid #e0e0e0;">
59
- </p>
60
-
61
- ---
62
-
63
- ## feedbackFormTitle, feedbackFormOptionsLabel, feedbackFormCommentLabel, submit, cancel
64
- <p align="center">
65
- <img src="./img/texts/feedbackForm.png" alt="feedbackForm" style="max-width:500px; width:100%;border: 1px solid #e0e0e0;">
66
- </p>
67
-
68
- ---
69
-
70
- ## feedbackThanks, feedbackReportButtonLabel, showMore
71
- <p align="center">
72
- <img src="./img/texts/voteAndSourceActions.png" alt="voteAndSourceActions" style="max-width:500px; width:100%;border: 1px solid #e0e0e0;">
73
- </p>
74
-
75
- ---
76
-
77
- ## stopGenerating
78
- <p align="center">
79
- <img src="./img/texts/stopGenerating.png" alt="stopGenerating" style="max-width:500px; width:100%;border: 1px solid #e0e0e0;">
80
- </p>
81
-
82
- ---
83
-
84
- ## insertAtCursorLabel, copy
85
- <p align="center">
86
- <img src="./img/texts/copyInsertToCursor.png" alt="copyInsertToCursor" style="border-radius: 10px; max-width:500px; width:100%;border: 1px solid #e0e0e0;">
87
- </p>
88
-
89
- ---
90
-
91
- ## codeSuggestions, clickFileToViewDiff, files, codeSuggestionWithReferenceTitle
92
- <p align="center">
93
- <img src="./img/texts/codeFileSuggestions.png" alt="codeFileSuggestions" style="max-width:500px; width:100%;border: 1px solid #e0e0e0;">
94
- </p>
95
-
96
- ---
97
-
98
- ## spinnerText
99
- <p align="center">
100
- <img src="./img/texts/spinnerText.png" alt="spinnerText" style="max-width:500px; width:100%;border: 1px solid #e0e0e0;">
101
- </p>
102
-
103
- ---
104
-
105
- ## noMoreTabsTooltip
106
- <p align="center">
107
- <img src="./img/texts/noMoreTabs.png" alt="noMoreTabsTooltip" style="max-width:500px; width:100%;border: 1px solid #e0e0e0;">
108
- </p>
109
-
110
- ---
111
-
112
- <p><br/></p>
113
-
114
- # `feedbackOptions`
115
-
116
- Feedback type options to be shown on feedback form.
117
- defaults:
118
- ```typescript
119
- ...
120
- feedbackOptions: [
121
- {
122
- value: 'inaccurate-response',
123
- label: 'Inaccurate response',
124
- },
125
- {
126
- value: 'harmful-content',
127
- label: 'Harmful content'
128
- },
129
- {
130
- value: 'overlap',
131
- label: 'Overlaps with existing content'
132
- },
133
- {
134
- value: 'incorrect-syntax',
135
- label: 'Incorrect syntax'
136
- },
137
- {
138
- value: 'buggy-code',
139
- label: 'Buggy code'
140
- },
141
- {
142
- value: 'low-quality',
143
- label: 'Low quality'
144
- },
145
- {
146
- value: 'other',
147
- label: 'Other'
148
- }
149
- ],
150
- ...
151
- ```
152
-
153
- <p align="center">
154
- <img src="./img/feedbackOptions.png" alt="feedbackOptions" style="max-width:500px; width:100%;border: 1px solid #e0e0e0;">
155
- </p>
156
-
157
- ---
158
-
159
- <p><br/></p>
160
-
161
- # `maxTabs`
162
- Maximum number of tabs user/system can open in a single instance of `mynah-ui`.
163
-
164
- default: `1000`
165
-
166
- An important note here is that if you provide **`1`** to maxTabs, it will not show the tab bar at all. However you still need to add a tab then initially to show a content.
167
-
168
- And finally, if you try to add tabs more than given `maxTabs` amount while initializing the MynahUI with [Constructor Properties](./PROPERTIES.md), it will only generate the tabs till it reaches the `maxTabs` limit.
169
-
170
- _Assume that you've provided `1` for `maxTabs`._
171
-
172
-
173
- <p align="center">
174
- <img src="./img/maxTabs1.png" alt="maxTabs1" style="max-width:500px; width:100%;border: 1px solid #e0e0e0;">
175
- </p>
176
-
177
- ---
178
-
179
- <p><br/></p>
180
-
181
- # `showPromptField`
182
- Show or hide the prompt input field completely. You may want to hide the prompt field by setting `showPromptField` to `false` to make the chat work one way only. Just to provide answers or information.
183
-
184
- default: `true`
185
-
186
- _If you set `showPromptField` to `false`_
187
-
188
- <p align="center">
189
- <img src="./img/noPrompt.png" alt="noPrompt" style="max-width:500px; width:100%;border: 1px solid #e0e0e0;">
190
- </p>