@aws/mynah-ui 4.6.2 → 4.6.3

package/dist/components/card/card.d.ts

@@ -1,3 +1,7 @@
+/*!
+ * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import { DomBuilderObject, ExtendedHTMLElement } from '../../helper/dom';
 import { EngagementType } from '../../static';
 export interface CardProps extends Partial<DomBuilderObject> {

package/dist/components/chat-item/chat-item-tree-file.d.ts

@@ -0,0 +1,17 @@
+import { ExtendedHTMLElement } from '../../helper/dom';
+import { FileNodeAction, TreeNodeDetails } from '../../static';
+import { MynahIcons } from '../icon';
+export interface ChatItemTreeFileProps {
+    tabId: string;
+    messageId: string;
+    filePath: string;
+    fileName: string;
+    icon?: MynahIcons;
+    deleted?: boolean;
+    details?: TreeNodeDetails;
+    actions?: FileNodeAction[];
+}
+export declare class ChatItemTreeFile {
+    render: ExtendedHTMLElement;
+    constructor(props: ChatItemTreeFileProps);
+}

package/dist/components/icon.d.ts

@@ -9,6 +9,7 @@ export declare enum MynahIcons {
     MINUS = "minus",
     SEARCH = "search",
     PLUS = "plus",
+    PAPER_CLIP = "paper-clip",
     LIST_ADD = "list-add",
     TABS = "tabs",
     CHAT = "chat",

package/dist/components/notification.d.ts

@@ -20,6 +20,10 @@ export declare class Notification {
     private readonly props;
     constructor(props: NotificationProps);
     notify(): void;
+    /**
+     * Calculates the top according to the previously shown and still visible notifications
+     * @returns number
+     */
     private readonly getNextCalculatedTop;
     private readonly getChildren;
 }

package/dist/components/overlay.d.ts

@@ -4,18 +4,54 @@
  */
 import { DomBuilderObject, ExtendedHTMLElement } from '../helper/dom';
 export declare const OVERLAY_MARGIN = 8;
+/**
+ * The horizontal creation direction of the overlay
+ */
 export declare enum OverlayHorizontalDirection {
+    /**
+       * starts from the left edge of the reference element and opens to left
+       */
     TO_LEFT = "horizontal-direction-to-left",
+    /**
+       * starts from the right edge of the reference element and opens to left
+       */
     END_TO_LEFT = "horizontal-direction-from-end-to-left",
+    /**
+       * starts from the right edge of the reference element and opens to right
+       */
     TO_RIGHT = "horizontal-direction-to-right",
+    /**
+       * starts from the left edge of the reference element and opens to right
+       */
     START_TO_RIGHT = "horizontal-direction-from-start-to-right",
+    /**
+       * starts and opens at the center of the reference element
+       */
     CENTER = "horizontal-direction-at-center"
 }
+/**
+ * The vertical creation direction of the overlay
+ */
 export declare enum OverlayVerticalDirection {
+    /**
+       * starts from the bottom edge of the reference element and opens to bottom
+       */
     TO_BOTTOM = "vertical-direction-to-bottom",
+    /**
+       * starts from the top edge of the reference element and opens to bottom
+       */
     START_TO_BOTTOM = "vertical-direction-from-start-to-bottom",
+    /**
+       * starts from the top edge of the reference element and opens to top
+       */
     TO_TOP = "vertical-direction-to-top",
+    /**
+       * starts from the bottom edge of the reference element and opens to top
+       */
     END_TO_TOP = "vertical-direction-from-end-to-top",
+    /**
+       * starts and opens at the center of the reference element
+       */
     CENTER = "vertical-direction-at-center"
 }
 export interface OverlayProps {

package/dist/helper/events.d.ts

@@ -9,7 +9,22 @@ export declare class MynahUIGlobalEvents {
     private readonly listeners;
     private constructor();
     static getInstance: () => MynahUIGlobalEvents;
+    /**
+     * Subscribe to value changes of a specific item in data store
+     * @param eventKey One of the keys in MynahUIDataModel
+     * @param handler function will be called with optional data field
+     * @returns listenerId which will be necessary to removeListener
+     */
     addListener: (eventKey: MynahEventNames, handler: (data?: any) => void) => string;
+    /**
+     * Unsubscribe from changes of a specific item in data store
+     * @param eventKey One of the keys in MynahUIDataModel
+     * @param listenerId listenerId which is returned from addListener function
+     */
     removeListener: (eventKey: MynahEventNames, listenerId: string) => void;
+    /**
+     * Updates the store and informs the subscribers.
+     * @param data A full or partial set of store data model with values.
+     */
     dispatch: (eventKey: MynahEventNames, data?: any) => void;
 }

package/dist/helper/store.d.ts

@@ -13,13 +13,51 @@ export declare class MynahUIDataStore {
     private store;
     private defaults;
     constructor(tabId: string, initialData?: MynahUIDataModel);
+    /**
+     * Sets the defaults to use while clearing the store
+     * @param defaults partial set of MynahUIDataModel for defaults
+     */
     setDefaults: (defaults: MynahUIDataModel | null) => void;
+    /**
+     * Get the defaults to use while generating an empty store data
+     */
     getDefaults: () => MynahUIDataModel | null;
+    /**
+     * Get the current store data
+     */
     getStore: () => MynahUIDataModel | null;
+    /**
+     * Subscribe to value changes of a specific item in data store
+     * @param storeKey One of the keys in MynahUIDataModel
+     * @param handler function will be called when value of the given key is updated in store with new and old values
+     * @returns subscriptionId which needed to unsubscribe
+     */
     subscribe: (storeKey: keyof MynahUIDataModel, handler: (newValue: any, oldValue?: any) => void) => string;
+    /**
+     * Unsubscribe from changes of a specific item in data store
+     * @param storeKey One of the keys in MynahUIDataModel
+     * @param subscriptionId subscriptionId which is returned from subscribe function
+     */
     unsubscribe: (storeKey: keyof MynahUIDataModel, subscriptionId: string) => void;
+    /**
+     * Returns current value of an item in data store
+     * @param storeKey One of the keys in MynahUIDataModel
+     * @returns value of the given key in data store
+     */
     getValue: (storeKey: keyof MynahUIDataModel) => any;
+    /**
+     * Returns current value of an item in data store
+     * @param storeKey One of the keys in MynahUIDataModel
+     * @returns value of the given key in data store
+     */
     getDefaultValue: (storeKey: keyof MynahUIDataModel) => any;
+    /**
+     * Updates the store and informs the subscribers.
+     * @param data A full or partial set of store data model with values.
+     */
     updateStore: (data: MynahUIDataModel, skipSubscribers?: boolean) => void;
+    /**
+     * Clears store data and informs all the subscribers
+     */
     resetStore: () => void;
 }

package/dist/helper/tabs-store.d.ts

@@ -1,7 +1,3 @@
-/*!
- * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
 import { MynahUIDataModel, MynahUITabStoreModel, MynahUITabStoreTab } from '../static';
 import { MynahUIDataStore } from './store';
 interface TabStoreSubscription {
@@ -25,18 +21,68 @@ export declare class MynahUITabsStore {
     readonly addTab: (tabData?: MynahUITabStoreTab) => string | undefined;
     readonly removeTab: (tabId: string) => string;
     readonly selectTab: (tabId: string) => void;
+    /**
+     * Updates the store and informs the subscribers.
+     * @param data A full or partial set of store data model with values.
+     */
     updateTab: (tabId: string, tabData?: Partial<MynahUITabStoreTab>, skipSubscribers?: boolean) => void;
     static getInstance: (initialData?: MynahUITabStoreModel, defaults?: MynahUITabStoreTab) => MynahUITabsStore;
+    /**
+     * Subscribe to changes of the tabsStore
+     * @param handler function will be called when tabs changed
+     * @returns subscriptionId which needed to unsubscribe
+     */
     addListener: (eventName: keyof TabStoreSubscription, handler: (tabId: string, tabData?: MynahUITabStoreTab) => void) => string;
+    /**
+     * Subscribe to changes of the tabs' data store
+     * @param handler function will be called when tabs changed
+     * @returns subscriptionId which needed to unsubscribe
+     */
     addListenerToDataStore: (tabId: string, storeKey: keyof MynahUIDataModel, handler: (newValue: any, oldValue?: any) => void) => string | null;
+    /**
+     * Unsubscribe from changes of the tabs' data store
+     * @param handler function will be called when tabs changed
+     * @returns subscriptionId which needed to unsubscribe
+     */
     removeListenerFromDataStore: (tabId: string, subscriptionId: string, storeKey: keyof MynahUIDataModel) => void;
+    /**
+     * Unsubscribe from changes of the tabs store
+     * @param subscriptionId subscriptionId which is returned from subscribe function
+     */
     removeListener: (eventName: keyof TabStoreSubscription, subscriptionId: string) => void;
     private readonly informSubscribers;
+    /**
+     * Returns the tab
+     * @param tabId Tab Id
+     * @returns info of the tab
+     */
     getTab: (tabId: string) => MynahUITabStoreTab | null;
+    /**
+     * Returns the tab
+     * @param tabId Tab Id
+     * @returns info of the tab
+     */
     getAllTabs: () => MynahUITabStoreModel;
+    /**
+     * Returns the data store of the tab
+     * @param tabId Tab Id
+     * @returns data of the tab
+     */
     getTabDataStore: (tabId: string) => MynahUIDataStore;
+    /**
+     * Returns the data of the tab
+     * @param tabId Tab Id
+     * @returns data of the tab
+     */
     getSelectedTabId: () => string;
+    /**
+     * Clears store data and informs all the subscribers
+     */
     removeAllTabs: () => void;
+    /**
+     * Get all tabs length
+     * @returns tabs length
+     */
     tabsLength: () => number;
 }
 export {};

package/dist/main.d.ts

@@ -30,6 +30,10 @@ export interface MynahUIProps {
     onTabChange?: (tabId: string, eventId?: string) => void;
     onTabAdd?: (tabId: string, eventId?: string) => void;
     onTabRemove?: (tabId: string, eventId?: string) => void;
+    /**
+     * @param tabId tabId which the close button triggered
+     * @returns boolean -> If you want to close the tab immediately send true
+     */
     onBeforeTabRemove?: (tabId: string, eventId?: string) => boolean;
     onChatItemEngagement?: (tabId: string, messageId: string, engagement: Engagement) => void;
     onCopyCodeToClipboard?: (tabId: string, messageId: string, code?: string, type?: CodeSelectionType, referenceTrackerInformation?: ReferenceTrackerInformation[], eventId?: string, codeBlockIndex?: number, totalCodeBlocks?: number) => void;
@@ -43,7 +47,11 @@ export interface MynahUIProps {
         text?: string;
         formItemValues?: Record<string, string>;
     }, eventId?: string) => void;
+    /**
+     * @deprecated since version 4.6.3. Will be dropped after version 5.x.x. Use {@link onFileClick} instead
+     */
     onOpenDiff?: (tabId: string, filePath: string, deleted: boolean, messageId?: string, eventId?: string) => void;
+    onFileClick?: (tabId: string, filePath: string, deleted: boolean, messageId?: string, eventId?: string) => void;
     onFileActionClick?: (tabId: string, messageId: string, filePath: string, actionName: string, eventId?: string) => void;
     onTabBarButtonClick?: (tabId: string, buttonId: string, eventId?: string) => void;
 }
@@ -59,16 +67,72 @@ export declare class MynahUI {
     private readonly getUserEventId;
     private readonly addGlobalListeners;
     addToUserPrompt: (tabId: string, codeStringToAdd: string) => void;
+    /**
+     * Adds a new item to the chat window
+     * @param tabId Corresponding tab ID.
+     * @param answer An ChatItem object.
+     */
     addChatItem: (tabId: string, chatItem: ChatItem) => void;
+    /**
+     * Updates the last ChatItemType.ANSWER_STREAM chat item
+     * @param tabId Corresponding tab ID.
+     * @param updateWith ChatItem object to update with.
+     */
     updateLastChatAnswer: (tabId: string, updateWith: Partial<ChatItem>) => void;
+    /**
+     * Updates the chat item with the given messageId
+     * @param tabId Corresponding tab ID.
+     * @param messageId Corresponding tab ID.
+     * @param updateWith ChatItem object to update with.
+     */
     updateChatAnswerWithMessageId: (tabId: string, messageId: string, updateWith: Partial<ChatItem>) => void;
+    /**
+     * Converts a card to an ANSWER if it is an ANSWER_STREAM
+     * @param tabId Corresponding tab ID.
+     * @param messageId Corresponding tab ID.
+     * @param updateWith Optional, if you like update the card while converting it to
+     * a normal ANSWER instead of a stream one, you can send a ChatItem object to update with.
+     */
     endMessageStream: (tabId: string, messageId: string, updateWith?: Partial<ChatItem>) => CardRenderDetails;
+    /**
+     * If exists, switch to a different tab
+     * @param tabId Tab ID to switch to
+     * @param eventId last action's user event ID passed from an event binded to mynahUI.
+     * Without user intent you cannot switch to a different tab
+     */
     selectTab: (tabId: string, eventId: string) => void;
+    /**
+     * If exists, close the given tab
+     * @param tabId Tab ID to switch to
+     * @param eventId last action's user event ID passed from an event binded to mynahUI.
+     * Without user intent you cannot switch to a different tab
+     */
     removeTab: (tabId: string, eventId: string) => void;
+    /**
+     * Updates only the UI with the given data for the given tab
+     * Send tab id as an empty string to open a new tab!
+     * If max tabs reached, will not return tabId
+     * @param data A full or partial set of data with values.
+     */
     updateStore: (tabId: string | '', data: MynahUIDataModel) => string | undefined;
+    /**
+     * This function returns the selected tab id if there is any, otherwise returns undefined
+     * @returns string selectedTabId or undefined
+     */
     getSelectedTabId: () => string | undefined;
+    /**
+     * Returns all tabs with their store information
+     * @returns string selectedTabId or undefined
+     */
     getAllTabs: () => MynahUITabStoreModel;
+    /**
+     * Simply creates and shows a notification
+     * @param props NotificationProps
+     */
     notify: (props: {
+        /**
+         * -1 for infinite
+         */
         duration?: number | undefined;
         type?: NotificationType | undefined;
         title?: string | undefined;
@@ -76,5 +140,9 @@ export declare class MynahUI {
         onNotificationClick?: ((eventId: string) => void) | undefined;
         onNotificationHide?: ((eventId: string) => void) | undefined;
     }) => void;
+    /**
+     * Simply creates and shows a notification
+     * @param props NotificationProps
+     */
     showCustomForm: (tabId: string, formItems?: ChatItemFormItem[], buttons?: ChatItemButton[], title?: string, description?: string) => void;
 }