@aws/mynah-ui 4.23.0-beta.2 → 4.23.0-beta.4

package/docs/USAGE.md

@@ -18,6 +18,7 @@ mynahUI.addToUserPrompt(...);
 mynahUI.updateLastChatAnswer(...);
 mynahUI.updateChatAnswerWithMessageId(...);
 mynahUI.endMessageStream(...);
+mynahUI.serializeChat(...);
 mynahUI.updateStore(...);
 mynahUI.selectTab(...);
 mynahUI.removeTab(...);
@@ -390,6 +391,25 @@ Can you end stream for a card you already ended the stream? Basically yes becaus
 
 ---
 
+## Serializing a chat (`serializeChat`)
+
+You can serialize an entire chat from a specific tab using this function. Only the card bodies will be included, meaning that buttons and other interactable components are left out. There are two output options for the serialization:
+- **Markdown:** get all the bodies from chat items in markdown format so that it serves as the contents of a valid `.md` file. Each card body is separated by `\n\n---\n\n`.
+- **HTML:** get a string which serves as the contents of a valid `.html` file. It consists of a centered chat container, containing all the chat item bodies in cards. All the relevant stylesheets from MynahUI are included in the `<style>` section of the string.
+
+The following example shows how serialization could be used to download an export of a tab's chat:
+```typescript
+const serializedChat = mynahUI.serializeChat(tabId, 'markdown')
+const blob = new Blob([serializedChat], { type: 'text/plain' });
+const url = URL.createObjectURL(blob);
+const link = document.createElement('a');
+link.download = 'exported-chat.md';
+link.href = url;
+link.click();
+```
+
+---
+
 ## Adding code attachments to prompt field (`addToUserPrompt`)
 
 You can add code attachments under the prompt field of the desired tab. When user fills the prompt field and sends it, the attached code block will be appended at the end of the prompt text. It accepts max chars set through **[CONFIG](./CONFIG.md#maxUserInput)** however you don't need to worry about it. MynahUI will automatically crop it depending on the available chars left from the prompt field itself by using a `96` chars of threshold. **So beware that for example if you want 4000 chars exact, you need to give 4096 to the config.**

package/package.json

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