@aws/mynah-ui 1.0.0 → 1.1.0

package/dist/components/feedback-form/feedback-form.d.ts

@@ -5,7 +5,6 @@
 import { FeedbackPayload } from '../../static';
 import { ExtendedHTMLElement } from '../../helper/dom';
 export interface FeedbackFormProps {
-    onFeedbackSet: (feedbackPayload: FeedbackPayload) => void;
     initPayload?: FeedbackPayload;
 }
 export declare class FeedbackForm {
@@ -17,6 +16,6 @@ export declare class FeedbackForm {
     private readonly feedbackSubmitButton;
     readonly feedbackFormContainer: ExtendedHTMLElement;
     readonly feedbackContainer: ExtendedHTMLElement;
+    constructor(props?: FeedbackFormProps);
     private readonly onFeedbackSet;
-    constructor(props: FeedbackFormProps);
 }

package/dist/components/main-container.d.ts

@@ -3,23 +3,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { ExtendedHTMLElement } from '../helper/dom';
-import { OnCopiedToClipboardFunctionWithSuggestionId, RelevancyVoteType, Suggestion, SuggestionEngagement } from '../static';
+import { Suggestion } from '../static';
 export interface MainContainerProps {
-    onSuggestionOpen?: (suggestion: Suggestion) => void;
-    onSuggestionLinkClick?: (suggestion: Suggestion) => void;
-    onSuggestionLinkCopy?: (suggestion: Suggestion) => void;
-    onSuggestionEngaged?: (engagementInfo: SuggestionEngagement) => void;
-    onCopiedToClipboard?: OnCopiedToClipboardFunctionWithSuggestionId;
-    onVoteChange: (suggestion: Suggestion, vote: RelevancyVoteType) => void;
     onScroll?: (e: Event) => void;
 }
 export declare class MainContainer {
-    private readonly onSuggestionOpen;
-    private readonly onSuggestionLinkClick;
-    private readonly onSuggestionLinkCopy;
-    private readonly onSuggestionEngaged;
-    private readonly onCopiedToClipboard;
-    private readonly onVoteChange;
     private readonly cardsWrapper;
     private readonly skeletonWrapper;
     render: ExtendedHTMLElement;

package/dist/components/notification/notification.d.ts

@@ -3,26 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { DomBuilderObject, ExtendedHTMLElement } from '../../helper/dom';
+import { NotificationType } from '../../static';
 declare type NotificationContentType = string | ExtendedHTMLElement | HTMLElement | DomBuilderObject;
-/**
- * Options for where to show the notification
- */
-export declare enum NotificationTarget {
-    /**
-       * Shows an IDE level notification
-       */
-    IDE = "ide",
-    /**
-       * Shows a notification inside the extension UI
-       */
-    UI = "ui"
-}
-export declare enum NotificationType {
-    INFO = "info",
-    SUCCESS = "ok-circled",
-    WARNING = "warning",
-    ERROR = "error"
-}
 export interface NotificationProps {
     duration?: number;
     type?: NotificationType;

package/dist/components/search-block/autocomplete-content.d.ts

@@ -8,7 +8,6 @@ export interface AutocompleteContentProps {
     searchQuery: string;
     referenceElement: Element | ExtendedHTMLElement;
     autocompleteSuggestions: AutocompleteItem[];
-    onAutocompleteClick: (autocompleteQuery: AutocompleteItem, index: number, count: number) => void;
     onClose?: () => void;
 }
 export declare class AutocompleteContent {

package/dist/components/search-block/search-api-help.d.ts

@@ -3,36 +3,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { ExtendedHTMLElement } from '../../helper/dom';
-export interface SearchApiHelpProps {
-    code: string;
-    fileName?: string;
-    range?: {
-        start: {
-            row: string;
-            column?: string;
-        };
-        end?: {
-            row: string;
-            column?: string;
-        };
-    };
-}
 export declare class SearchApiHelp {
-    props: SearchApiHelpProps;
     render: ExtendedHTMLElement;
     private isCollapsed;
-    private readonly onCodeDetailsClicked?;
-    constructor(onCodeDetailsClicked?: (code: string, fileName?: string, range?: {
-        start: {
-            row: string;
-            column?: string;
-        };
-        end?: {
-            row: string;
-            column?: string;
-        };
-    }) => void);
-    hide: () => void;
-    show: () => void;
-    updateContent: (props: SearchApiHelpProps) => void;
+    constructor();
+    private readonly hide;
+    private readonly show;
+    private readonly updateContent;
+    private readonly onCodeDetailsClicked;
 }

package/dist/components/search-block/search-card-header.d.ts

@@ -2,13 +2,11 @@
  * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
-import { FeedbackPayload } from '../../static';
 import { ExtendedHTMLElement } from '../../helper/dom';
-export interface SearchCardHeaderProps {
-    onFeedbackSet: (feedbackPayload: FeedbackPayload) => void;
-}
 export declare class SearchCardHeader {
     private readonly feedbackForm;
+    private readonly infoBar;
     render: ExtendedHTMLElement;
-    constructor(props: SearchCardHeaderProps);
+    constructor();
+    private readonly getHeaderInfoContent;
 }

package/dist/components/search-block/search-card.d.ts

@@ -3,72 +3,17 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { ExtendedHTMLElement } from '../../helper/dom';
-import { LiveSearchState, SearchPayload, SearchPayloadMatchPolicy, Suggestion, SearchHistoryItem, FeedbackPayload, AutocompleteItem, SearchHistoryFilters } from '../../static';
-export interface SearchCardProps {
-    onSearch: (searchPayload: SearchPayload, isFromAutocomplete: boolean, currAutocompleteSuggestionSelected?: number, autocompleteSuggestionsCount?: number) => void;
-    onHistoryChange?: (historySuggestions: Suggestion[], searchPayload: SearchPayload) => void;
-    onLiveSearchToggle?: (value: LiveSearchState) => void;
-    onFeedbackSet: (feedbackPayload: FeedbackPayload) => void;
-    onHistoryOpen: (filterPayload: SearchHistoryFilters) => Promise<SearchHistoryItem[]>;
-    onAutocompleteRequest: (input: string) => Promise<AutocompleteItem[]>;
-    onCodeDetailsClicked?: (code: string, fileName?: string, range?: {
-        start: {
-            row: string;
-            column?: string;
-        };
-        end?: {
-            row: string;
-            column?: string;
-        };
-    }) => void;
-    initContextList?: SearchPayloadMatchPolicy;
-    initText?: string;
-    liveSearch?: boolean;
-    codeSelection?: {
-        selectedCode: string;
-        file?: {
-            range: {
-                start: {
-                    row: string;
-                    column: string;
-                };
-                end: {
-                    row: string;
-                    column: string;
-                };
-            };
-            name: string;
-        };
-    };
-    codeQuery?: {
-        simpleNames: string[];
-        usedFullyQualifiedNames: string[];
-    };
-}
 export declare class SearchCard {
-    props: SearchCardProps;
-    private historyProcess;
+    private unfoldedByContextInsertion;
+    private unfoldedByButton;
     private readonly searchInput;
     private readonly searchAPIHelp;
-    private liveSearchToggle;
-    private searchPayload;
+    private readonly liveSearchToggle;
     private readonly foldUnfoldButton;
     private readonly contextManagement;
     private readonly searchCardHeader;
-    private unfoldedByContextInsertion;
-    private unfoldedByButton;
     render: ExtendedHTMLElement;
-    constructor(props: SearchCardProps);
+    constructor();
     addFocusOnInput: () => void;
-    private readonly performSearch;
-    private readonly handleSearchQueryChange;
-    private readonly handleContextChange;
-    private readonly handleHistoryChange;
-    setSearchQuery: (value: string) => void;
-    setContextItems: (contextItems: SearchPayloadMatchPolicy) => void;
-    setWaitState: (waitState: boolean) => void;
     setFolded: (folded: boolean) => void;
-    removeLiveSearchToggle: () => void;
-    onLiveSearchDataReceived: () => void;
-    changeLiveSearchState: (state: LiveSearchState) => void;
 }

package/dist/components/search-block/search-context.d.ts

@@ -18,10 +18,9 @@ export declare class SearchContext {
     private readonly onContextInsertionEnabled;
     private readonly onContextInsertionDisabled;
     constructor(props?: SearchContextProps);
-    updateLocalContext: (contextItems: SearchPayloadMatchPolicy) => void;
-    private readonly updateContextItems;
     private readonly enableContextInsertion;
     private readonly disableContextInsertion;
+    private readonly createContextItemElements;
     private readonly contextInsertionKeydownHandler;
     private readonly inputAutoWidth;
     private contextInsertionInput;

package/dist/components/search-block/search-history-content.d.ts

@@ -7,7 +7,6 @@ import { SearchHistoryItem } from '../../static';
 export interface HistoryContentProps {
     referenceElement: Element | ExtendedHTMLElement;
     searchHistory: SearchHistoryItem[];
-    onHistoryChange: (historyItem: SearchHistoryItem) => void;
 }
 export declare class HistoryContent {
     private historyItemsOverlay;

package/dist/components/search-block/search-input.d.ts

@@ -3,18 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { ExtendedHTMLElement } from '../../helper/dom';
-import { AutocompleteItem, SearchHistoryFilters, SearchHistoryItem } from '../../static';
-export interface SearchInputProps {
-    onSearch: (queryText: string, isFromAutocomplete: boolean, currAutocompleteSuggestionSelected?: number, autocompleteSuggestionsCount?: number) => void;
-    onHistoryOpen: (filterPayload: SearchHistoryFilters) => Promise<SearchHistoryItem[]>;
-    onAutocompleteRequest: (input: string) => Promise<AutocompleteItem[]>;
-    onHistoryChange: (historyItem: SearchHistoryItem) => void;
-    initText?: string;
-    searchAlwaysActive?: boolean;
-    hideHistoryButton?: boolean;
-}
 export declare class SearchInput {
-    props: SearchInputProps;
     render: ExtendedHTMLElement;
     private searchTextInput;
     private readonly searchButton;
@@ -22,15 +11,12 @@ export declare class SearchInput {
     private readonly remainingIndicator;
     private autocompleteContent;
     private readonly allowedCharCount;
-    constructor(props: SearchInputProps);
+    private codeSelectionAvailable;
+    constructor();
     addFocusOnInput: () => void;
     private readonly handleInputKeydown;
-    triggerSearch: () => void;
-    triggerSearchHistory: () => void;
-    getAutocompleteSuggestions: (input: string) => void;
-    private readonly handleHistoryChange;
-    private readonly handleAutocompleteClick;
-    getSearchText: () => string;
-    setSearchText: (value: string) => void;
-    setWaitState: (waitState?: boolean | undefined) => void;
+    private readonly triggerSearch;
+    private readonly triggerSearchHistory;
+    private readonly handleAutocompleteSuggestions;
+    private readonly setWaitState;
 }

package/dist/components/search-block/search-live-toggle.d.ts

@@ -3,16 +3,13 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { ExtendedHTMLElement } from '../../helper/dom';
-import { LiveSearchState } from '../../static';
 export interface SearchLiveToggleProps {
     label: string;
-    value: LiveSearchState.RESUME | LiveSearchState.PAUSE;
-    onChange?: (value: LiveSearchState.RESUME | LiveSearchState.PAUSE) => void;
 }
 export declare class SearchLiveToggle {
     render: ExtendedHTMLElement;
     private readonly toggle;
+    private queryChangeSubscriptionId;
     constructor(props: SearchLiveToggleProps);
-    setToggleState: (state: LiveSearchState) => void;
     flashToggle: () => void;
 }

package/dist/components/suggestion-card/suggestion-card-body.d.ts

@@ -3,11 +3,9 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { ExtendedHTMLElement } from '../../helper/dom';
-import { OnCopiedToClipboardFunction, RelevancyVoteType, Suggestion } from '../../static';
+import { Suggestion } from '../../static';
 export interface SuggestionCardBodyProps {
     suggestion: Suggestion;
-    onVoteChange: (suggestion: Suggestion, vote: RelevancyVoteType) => void;
-    onCopiedToClipboard?: OnCopiedToClipboardFunction;
 }
 export declare class SuggestionCardBody {
     render: ExtendedHTMLElement;

package/dist/components/suggestion-card/suggestion-card-relevance-vote.d.ts

@@ -2,15 +2,13 @@
  * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
-import { RelevancyVoteType, Suggestion } from '../../static';
+import { Suggestion } from '../../static';
 import { ExtendedHTMLElement } from '../../helper/dom';
 export interface SuggestionCardRelevanceVoteProps {
     suggestion: Suggestion;
-    onVoteChange: (suggestion: Suggestion, vote: RelevancyVoteType) => void;
 }
 export declare class SuggestionCardRelevanceVote {
     render: ExtendedHTMLElement;
-    private readonly onVoteChange;
     constructor(props: SuggestionCardRelevanceVoteProps);
     private readonly handleVoteChange;
 }

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

@@ -3,22 +3,15 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { ExtendedHTMLElement } from '../../helper/dom';
-import { OnCopiedToClipboardFunctionWithSuggestionId, RelevancyVoteType, Suggestion, SuggestionEngagement } from '../../static';
+import { Suggestion } from '../../static';
 export interface SuggestionCardProps {
     suggestion: Suggestion;
-    onSuggestionOpen?: (suggestion: Suggestion) => void;
-    onSuggestionLinkClick?: (suggestion: Suggestion) => void;
-    onSuggestionLinkCopy?: (suggestion: Suggestion) => void;
-    onSuggestionEngaged?: (engagementInfo: SuggestionEngagement) => void;
-    onCopiedToClipboard?: OnCopiedToClipboardFunctionWithSuggestionId;
-    onVoteChange: (suggestion: Suggestion, vote: RelevancyVoteType) => void;
 }
 export declare class SuggestionCard {
     private engagementStartTime;
     private totalMouseDistanceTraveled;
     private previousMousePosition;
     private mouseDownInfo;
-    private readonly onSuggestionEngaged;
     private readonly suggestion;
     render: ExtendedHTMLElement;
     constructor(props: SuggestionCardProps);

package/dist/components/toggle.d.ts

@@ -18,10 +18,12 @@ export interface ToggleProps {
 export declare class Toggle {
     render: ExtendedHTMLElement;
     private readonly props;
+    private currentValue?;
     private readonly relocateTransitioner;
     constructor(props: ToggleProps);
     private readonly getChildren;
     private readonly setRelocatePosition;
     private readonly updateSelectionRender;
     setValue: (value: string) => void;
+    getValue: () => string | undefined;
 }

package/dist/helper/config.d.ts

@@ -2,14 +2,9 @@
  * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
-import { StateManager } from '../static';
-export interface MynahConfigProps {
-    stateManager: StateManager;
-}
 export declare class MynahConfig {
     private config;
-    private readonly stateManager;
-    constructor(props: MynahConfigProps);
+    constructor();
     getConfig: (configName: string) => any;
     setConfig: (configName: string, configValue: string) => void;
 }

package/dist/helper/date-time.d.ts

@@ -2,11 +2,11 @@
  * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
-export declare const getTimeDiff: (differenceInMs: number, show?: 1 | 2 | 3 | 4 | 5 | 6 | {
+export declare const getTimeDiff: (differenceInMs: number, show?: {
     years?: boolean | undefined;
     months?: boolean | undefined;
     weeks?: boolean | undefined;
     days?: boolean | undefined;
     hours?: boolean | undefined;
     minutes?: boolean | undefined;
-} | undefined, separator?: string | undefined) => string;
+} | 1 | 2 | 3 | 4 | 5 | 6 | undefined, separator?: string | undefined) => string;

package/dist/helper/dom.d.ts

@@ -49,4 +49,3 @@ export declare class DomBuilder {
     getPortal: (portalName: string) => ExtendedHTMLElement;
     removePortal: (portalName: string) => void;
 }
-export declare const cancelEvent: (event: Event) => boolean;

package/dist/helper/events.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { MynahEventNames } from '../static';
+export declare const cancelEvent: (event: Event) => boolean;
+export declare class MynahUIGlobalEvents {
+    private static instance;
+    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

@@ -0,0 +1,44 @@
+/*!
+ * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { MynahUIDataModel } from '../static';
+export declare class EmptyMynahUIDataModel {
+    data: Required<MynahUIDataModel>;
+    constructor();
+}
+export declare class MynahUIDataStore {
+    private static instance;
+    private readonly subsciptions;
+    private store;
+    private constructor();
+    static getInstance: (initialData?: MynahUIDataModel | undefined) => MynahUIDataStore;
+    /**
+     * 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 subsciptionId 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;
+    /**
+     * Updates the store and informs the subscribers.
+     * @param data A full or partial set of store data model with values.
+     */
+    updateStore: (data: MynahUIDataModel) => void;
+    /**
+     * Clears store data and informs all the subscribers
+     */
+    resetStore: () => void;
+}

package/dist/main.d.ts

@@ -2,25 +2,57 @@
  * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
-import { SearchPayload, ServiceConnector, StateManager } from './static';
+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, } from './static';
+export { AutocompleteItem, SearchPayloadCodeSelection, FeedbackPayload, RelevancyVoteType, LiveSearchState, SearchPayload, Suggestion, ContextType, SearchHistoryItem, EngagementType, SuggestionEngagement, SuggestionEventName, SearchHistoryFilters, MynahUIDataModel, ContextChangeType, ContextSource, ContextTypes, NotificationType, } from './static';
 export interface MynahUIProps {
-    serviceConnector: ServiceConnector;
-    stateManager: StateManager;
+    storeData?: MynahUIDataModel;
+    onSearch?: (searchPayload: SearchPayload, isFromHistory?: boolean, isFromAutocomplete?: boolean) => void;
+    onReady?: () => void;
+    onClickSuggestionVote?: (suggestion: Suggestion, vote: RelevancyVoteType) => void;
+    onClickCodeDetails?: (code: string, fileName?: string, range?: {
+        start: {
+            row: string;
+            column?: string;
+        };
+        end?: {
+            row: string;
+            column?: string;
+        };
+    }) => void;
+    onChangeContext?: (changeType: ContextChangeType, queryContext: ContextType) => void;
+    onSuggestionEngagement?: (engagement: SuggestionEngagement) => void;
+    onSuggestionClipboardInteraction?: (suggestionId: string, type?: string, text?: string) => void;
+    onSuggestionInteraction?: (eventName: SuggestionEventName, suggestion: Suggestion) => void;
+    onSendFeedback?: (feedbackPayload: FeedbackPayload) => void;
+    onRequestHistoryRecords?: (filterPayload: SearchHistoryFilters) => void;
+    onRequestAutocompleteList?: (input: string) => void;
+    onChangeLiveSearchState?: (liveSearchState: LiveSearchState) => void;
+    onClickAutocompleteItem?: (text: string, currSelected?: number, suggestionCount?: number) => void;
 }
 export declare class MynahUI {
+    private readonly props;
     private readonly wrapper;
     private readonly searchCard;
     private readonly mainContainer;
     private readonly config;
-    private readonly connector;
     constructor(props: MynahUIProps);
-    updateSearchPayload: (searchPayload: SearchPayload) => void;
-    private readonly handleLiveSearchExternalCommand;
-    private readonly handlePayloadChange;
-    private readonly handleLiveSearch;
-    private readonly handleContentUpdate;
-    handleSearch: (payload: SearchPayload, isFromAutocomplete: boolean, currAutocompleteSuggestionSelected?: number | undefined, autocompleteSuggestionsCount?: number | undefined) => void;
-    private readonly recordContextChange;
+    private readonly addGlobalListeners;
+    /**
+     * Updates only the UI with the given data.
+     * @param data A full or partial set of data with values.
+     */
+    updateStore: (data: MynahUIDataModel) => void;
+    /**
+     * Simply creates and shows a notification
+     * @param props NotificationProps
+     */
+    notify: (props: {
+        duration?: number;
+        type?: NotificationType;
+        title?: string;
+        content: string;
+        onNotificationClick?: () => void;
+        onNotificationHide?: () => void;
+    }) => void;
 }