@aws/mynah-ui 1.1.12 → 1.2.0

package/README.md

@@ -19,7 +19,7 @@ export const createMynahUI = () => {
         // initial UI state data
         // It doesn't have to be matched with backend data
         // but to update the UI and rerender its desired parts, 
-        // it expects the data in this model.
+        // it expects the data in type of MynahUIDataModel.
         storeData?: MynahUIDataModel;
         
         // All below items trigger when;
@@ -51,6 +51,9 @@ export const createMynahUI = () => {
         // Matching policy is changed (context items)
         onChangeContext?: (changeType: ContextChangeType, queryContext: ContextType) => void;
 
+        // When navigation tab is changed
+        onNavigationTabChange?: (selectedTab: string) => void;
+
         // User engages with a suggestion
         onSuggestionEngagement?: (engagement: SuggestionEngagement) => void;
 
@@ -108,6 +111,18 @@ export const createMynahUI = () => {
         ...,
         onSearch: getSuggestions
     });
+
+    // to update the store fully or partially
+    mynahUI.updateStore(...);
+
+    // set default values for the UI data store fully or partially
+    mynahUI.setStoreDefaults(...);
+
+    // get current search payload
+    mynahUI.getSearchPayload();
+
+    // Show a notification balloon
+    mynahUI.notify(...);
 }
 ```
 

package/dist/components/navigation-tabs.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ExtendedHTMLElement } from '../helper/dom';
+export interface NavivationTabsProps {
+    onChange?: (selectedValue: string) => void;
+}
+export declare class NavivationTabs {
+    render: ExtendedHTMLElement;
+    private readonly props;
+    constructor(props: NavivationTabsProps);
+    private readonly setLoading;
+    private readonly getTabsRender;
+}

package/dist/components/toggle.d.ts

@@ -6,11 +6,13 @@ import { ExtendedHTMLElement } from '../helper/dom';
 export interface ToggleOption {
     label?: ExtendedHTMLElement | string | HTMLElement;
     color?: string;
+    disabled?: boolean;
     value: string;
 }
 export interface ToggleProps {
     options: ToggleOption[];
-    value?: string;
+    type?: 'switch' | 'tabs';
+    value?: string | null;
     name: string;
     disabled?: boolean;
     onChange?: (selectedValue: string) => void;

package/dist/helper/payload-transformer.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { SearchPayload } from '../static';
+export interface PayloadTransformRule {
+    targetRoute: string[];
+    method: 'add' | 'remove' | 'set';
+    value?: any;
+    values?: any[];
+}
+export declare const transformPayloadData: (rules: PayloadTransformRule[], payloadData: SearchPayload) => SearchPayload;
+export declare const validateRulesOnPayloadData: (rules: PayloadTransformRule[], payloadData: SearchPayload) => boolean;

package/dist/helper/store.d.ts

@@ -19,6 +19,10 @@ export declare class MynahUIDataStore {
      * @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;
     /**
      * Subscribe to value changes of a specific item in data store
      * @param storeKey One of the keys in MynahUIDataModel
@@ -48,7 +52,7 @@ export declare class MynahUIDataStore {
      * Updates the store and informs the subscribers.
      * @param data A full or partial set of store data model with values.
      */
-    updateStore: (data: MynahUIDataModel) => void;
+    updateStore: (data: MynahUIDataModel, skipSubscribers?: boolean | undefined) => void;
     /**
      * Clears store data and informs all the subscribers
      */

package/dist/main.d.ts

@@ -5,6 +5,7 @@
 import { SuggestionEngagement, Suggestion, SearchPayload, LiveSearchState, SuggestionEventName, RelevancyVoteType, FeedbackPayload, MynahUIDataModel, ContextChangeType, ContextType, SearchHistoryFilters, NotificationType } from './static';
 import './styles/styles.scss';
 export { AutocompleteItem, SearchPayloadCodeSelection, FeedbackPayload, RelevancyVoteType, LiveSearchState, SearchPayload, Suggestion, ContextType, SearchHistoryItem, EngagementType, SuggestionEngagement, SuggestionEventName, SearchHistoryFilters, MynahUIDataModel, ContextChangeType, ContextSource, ContextTypes, NotificationType, } from './static';
+export { transformPayloadData, validateRulesOnPayloadData, PayloadTransformRule, } from './helper/payload-transformer';
 export interface MynahUIProps {
     rootSelector?: string;
     storeData?: MynahUIDataModel;
@@ -23,12 +24,13 @@ export interface MynahUIProps {
     }) => void;
     onResetStore?: () => void;
     onChangeContext?: (changeType: ContextChangeType, queryContext: ContextType) => void;
+    onNavigationTabChange?: (selectedTab: string) => void;
     onSuggestionEngagement?: (engagement: SuggestionEngagement) => void;
     onSuggestionClipboardInteraction?: (suggestionId: string, type?: string, text?: string) => void;
     onSuggestionInteraction?: (eventName: SuggestionEventName, suggestion: Suggestion, mouseEvent?: MouseEvent) => void;
     onSendFeedback?: (feedbackPayload: FeedbackPayload) => void;
     onRequestHistoryRecords?: (filterPayload: SearchHistoryFilters) => void;
-    onRequestAutocompleteList?: (input: string) => void;
+    onInputQueryChange?: (input: string) => void;
     onChangeLiveSearchState?: (liveSearchState: LiveSearchState) => void;
     onClickAutocompleteItem?: (text: string, currSelected?: number, suggestionCount?: number) => void;
 }
@@ -36,6 +38,7 @@ export declare class MynahUI {
     private readonly props;
     private readonly wrapper;
     private readonly searchCard;
+    private readonly navTabs;
     private readonly mainContainer;
     private readonly config;
     constructor(props: MynahUIProps);
@@ -51,6 +54,10 @@ export declare class MynahUI {
      * @param defaults partial set of MynahUIDataModel for defaults
      */
     setStoreDefaults: (defaults: MynahUIDataModel | null) => void;
+    /**
+     * Returns the current search payload
+     */
+    getSearchPayload: () => SearchPayload;
     /**
      * Simply creates and shows a notification
      * @param props NotificationProps