@openfin/workspace 20.0.2 → 20.0.4

package/common/src/api/protocol/browser.d.ts

@@ -32,7 +32,8 @@ declare enum GeneralBrowserChannelActions {
     DuplicatePage = "duplicate-page",
     SetSelectedScheme = "set-selected-scheme",
     ShowBrowserIndicator = "show-browser-indicator",
-    SetSelectedLanguage = "set-selected-language"
+    SetSelectedLanguage = "set-selected-language",
+    RefreshBookmarksInternal = "refresh-bookmarks"
 }
 /**
  * All of the remote procedures that can be called in the
@@ -59,6 +60,16 @@ export declare enum EnterpriseAppDirectoryChannelAction {
     GetCuratedContent = "get-curated-content",
     GetRecentlyVisited = "get-recently-visited"
 }
+/**
+ * @internal
+ */
+export declare enum EnterpriseBookmarkChannelAction {
+    CreateBookmarkNode = "create-bookmark-node",
+    GetBookmarkNode = "get-bookmark-node",
+    SearchBookmarkNodes = "search-bookmark-nodes",
+    UpdateBookmarkNode = "update-bookmark-node",
+    DeleteBookmarkNode = "delete-bookmark-node"
+}
 export declare const BrowserChannelAction: {
     GetPages: PageChannelAction.GetPages;
     GetActivePageForWindow: PageChannelAction.GetActivePageForWindow;
@@ -81,6 +92,7 @@ export declare const BrowserChannelAction: {
     SetSelectedScheme: GeneralBrowserChannelActions.SetSelectedScheme;
     ShowBrowserIndicator: GeneralBrowserChannelActions.ShowBrowserIndicator;
     SetSelectedLanguage: GeneralBrowserChannelActions.SetSelectedLanguage;
+    RefreshBookmarksInternal: GeneralBrowserChannelActions.RefreshBookmarksInternal;
 };
 export type BrowserChannelAction = typeof BrowserChannelAction;
 export {};

package/common/src/api/protocol/workspace-platform.d.ts

@@ -72,6 +72,7 @@ export declare enum WorkspacePlatformChannelAction {
     SearchSitesInternal = "searchSitesInternal",
     GetCuratedContentInternal = "getCuratedContentInternal",
     HandleRequestNavigationInternal = "handleRequestNavigationInternal",
+    RefreshBookmarksInternal = "refreshBookmarksInternal",
     GetNotificationsConfig = "getNotificationsConfig"
 }
 export type PlatFormSupportedFeatures = boolean | {

package/common/src/api/theming.d.ts

@@ -1,6 +1,6 @@
 import type { DefaultTheme } from 'styled-components';
 import type OpenFin from '@openfin/core';
-import { ThemeSet } from '@openfin/ui-library';
+import { ColorSchemeType, ThemeSet } from '@openfin/ui-library';
 import { ColorSchemeOptionType } from '../../../client-api-platform/src/shapes';
 export type WorkspaceComponentSetSelectedSchemePayload = {
     newScheme: ColorSchemeOptionType;
@@ -246,3 +246,4 @@ export declare const OpenFinDarkTheme: {
 export declare const computeThemes: (customThemes: CustomThemes, storedScheme?: ColorSchemeOptionType) => ComputedThemes;
 export declare const getComputedPlatformTheme: (platformIdentity: OpenFin.Identity) => Promise<ComputedTheme>;
 export declare const setSelectedScheme: (ctx: ColorSchemeOptionType) => Promise<void>;
+export declare const getComputedScheme: (identity?: OpenFin.Identity) => Promise<Exclude<ColorSchemeType, 'system'>>;

package/common/src/api/workspace-events.d.ts

@@ -0,0 +1,49 @@
+import { NavigatePayload } from '../../../common/src/utils/navigate';
+import { ProviderConnectionPayload, ProviderDisconnectionPayload, ProviderUpdatePayload } from './provider';
+/**
+ * All Workspace related events that can be emitted or listened to
+ * by the Workspace Provider or any of the workspace components
+ */
+type EventTypeTypes = {
+    /**
+     * Emitted when a search is invoked.
+     */
+    'search-invoked': [string];
+    /**
+     * Emitted when a new provider is connected.
+     *
+     * For example, when a Dock Provider is successfully registered by the platform provider
+     */
+    'provider-connected': [ProviderConnectionPayload];
+    /**
+     * Emitted when a provider is disconnected.
+     *
+     * For example, when a Dock Provider is deregistered by the platform provider
+     */
+    'provider-disconnected': [ProviderDisconnectionPayload];
+    /**
+     * Emitted when a provider is updated.
+     *
+     * For example, when a Dock Provider is updated by the platform provider
+     */
+    'provider-updated': [ProviderUpdatePayload];
+    /**
+     * Emmitted when notifications is created or destroyed.
+     */
+    'update-notification-running-status': [];
+    /**
+     * Emitted when the list of search providers has been updated.
+     */
+    'search-provider-list-updated': [];
+    /**
+     * Emmitted when a component is created or destroyed.
+     */
+    'component-lifecycle-update': [];
+    /**
+     * Emitted when component should be navigated to.
+     * Contains the target provider ID and the component name.
+     */
+    'component-navigation': [NavigatePayload];
+};
+export declare const addListener: <EventKey extends keyof EventTypeTypes>(event: EventKey, listener: (...payload: EventTypeTypes[EventKey]) => void) => void, removeListener: <EventKey extends keyof EventTypeTypes>(event: EventKey, listener: (...payload: EventTypeTypes[EventKey]) => void) => void, emit: <EventKey extends keyof EventTypeTypes>(event: EventKey, ...payload: EventTypeTypes[EventKey]) => Promise<void>;
+export {};

package/common/src/components/BaseButton/BaseButton.d.ts

@@ -0,0 +1,55 @@
+import React from 'react';
+import { SizeType } from '@openfin/ui-library';
+export interface Props {
+    /**
+     * Icon to be shown for the control.
+     *
+     * Accepts base64, url, or variables in CSS format.
+     */
+    icon?: string;
+    /**
+     * Title to be applied as a `title` attribute on the button.
+     */
+    title?: string;
+    /**
+     * whether the button title property should be in title case
+     * @default true
+     */
+    withTitleCase?: boolean;
+    /**
+     * Additional CSS classes to be applied to the button.
+     *
+     * This can be useful when a unique style needs to be applied, for example, in a close button.
+     */
+    className?: string;
+    /** When the button is disabled, it cannot be clicked and mouseover does not have an effect */
+    disabled?: boolean;
+    /** Button selected state. Can be used to implement sticky buttons. */
+    selected?: boolean;
+    /** Use wide button */
+    wide?: boolean;
+    /** Disable hover/active background-color change */
+    hoverless?: boolean;
+    /** If not set, svgs in the button will be forced to 13px */
+    customContentSize?: boolean;
+    /** Border radius of the button. If not set defaults to 0px */
+    borderRadius?: SizeType;
+    /**
+     * The `onClick` handler for when the button is closed.
+     *
+     * It is up to the implementor to properly handle the event as they see fit.
+     */
+    onClick?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
+    children: React.ReactNode | React.ReactNode[];
+    width?: number;
+    height?: number;
+    isEnterprise?: boolean;
+}
+/**
+ * Provides a basic browser title bar navigation button look and feel.
+ * Ensure the title is printed in “Title Case”.
+ *
+ * Note: This relies on global CSS and is written to run within the context of the Browser window which contains these globals.
+ */
+declare const BaseButton: React.ForwardRefExoticComponent<Props & React.HTMLAttributes<HTMLButtonElement> & React.RefAttributes<HTMLButtonElement>>;
+export default BaseButton;

package/common/src/components/Icon/CustomIcon.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import { IconSizeType } from '@openfin/ui-library';
+/**
+ * Simple and reusable icon component. The required prop is an iconURL.
+ */
+interface CustomIconProps {
+    iconURL?: string;
+    testId?: string;
+    size?: IconSizeType;
+    description?: string;
+    backgroundColor?: string;
+    applyThemeColor?: boolean;
+}
+export declare const CustomIcon: React.FC<CustomIconProps>;
+export {};

package/common/src/hooks/context.d.ts

@@ -0,0 +1,58 @@
+import { Dispatch, SetStateAction } from 'react';
+import { ProviderInfoInternal, ProviderType } from '../../../common/src/api/provider';
+export type ProviderContext<T extends ProviderType = any> = {
+    /**
+     * The currently active provider.
+     */
+    activeProvider: ProviderInfoInternal<T> | undefined;
+    /**
+     * Sets the active provider.
+     * @param provider The provider to set as active.
+     */
+    setActiveProvider: (provider: ProviderInfoInternal<T>) => void;
+    /**
+     * All providers currently available.
+     */
+    providers: ProviderInfoInternal<T>[];
+    /**
+     * Updates a provider.
+     * Dispatches a channel action back to the Workspace Provider.
+     *
+     * @param updatedProvider The updated provider.
+     * @returns A promise that resolves when the provider has been updated.
+     */
+    updateProvider: (updatedProvider: ProviderInfoInternal<T>) => Promise<void>;
+};
+/**
+ * A hook that returns data related to the active provider, and all providers
+ *
+ * A generic **must** be provided to specify the type of provider to return
+ *
+ * @example
+ * ```ts
+ * const { activeProvider, setActiveProvider, providers } = usePlatformProviders<'dock'>();
+ * ```
+ */
+export declare const usePlatformProviders: <T extends ProviderType = never>() => T extends never ? never : ProviderContext<T>;
+export declare const ProviderContext: <T extends ProviderType>({ children, providerType }: {
+    children?: React.ReactNode;
+    providerType: T;
+}) => JSX.Element;
+export declare const BrowserTypeContext: import("react").Context<{
+    isEnterprise?: boolean | null;
+}>;
+export declare const BrowserLayoutDragContext: import("react").Context<{
+    isAcceptingLayoutDrag: boolean;
+    setIsAcceptingLayoutDrag: (value: boolean) => void;
+}>;
+export declare const BrowserContext: ({ children }: {
+    children?: React.ReactNode;
+}) => JSX.Element;
+export declare const BookmarksContext: import("react").Context<{
+    mostRecentlyUpdated: number;
+    isBookmarksPanelOpen: boolean;
+    setIsBookmarksPanelOpen: Dispatch<SetStateAction<boolean>>;
+}>;
+export declare const BookmarksContextProvider: ({ children }: {
+    children?: React.ReactNode;
+}) => JSX.Element;

package/common/src/hooks/usePlatformTheme.d.ts

@@ -0,0 +1,6 @@
+import type OpenFin from '@openfin/core';
+/**
+ * Set the current theme based on the platform identity provided.
+ * @param identity the platform identity.
+ */
+export declare const usePlatformTheme: (identity?: OpenFin.Identity) => void;

package/common/src/hooks/useSystemSchemeCheck.d.ts

@@ -0,0 +1,13 @@
+import { ColorSchemeType } from '@openfin/ui-library';
+/**
+ * Custom hook that checks the system color scheme and provides information about the current scheme.
+ *
+ * @returns An object containing the current color scheme, system color scheme, and a boolean indicating if the scheme is dark.
+ */
+interface SystemSchemeCheck {
+    currentScheme: Omit<ColorSchemeType, 'system'>;
+    systemScheme: Omit<ColorSchemeType, 'system'>;
+    isSchemeDark: boolean;
+}
+declare function useSystemSchemeCheck(): SystemSchemeCheck;
+export default useSystemSchemeCheck;

package/common/src/slices/environment.d.ts

@@ -0,0 +1,22 @@
+export interface EnvironmentRootState {
+    environment: {
+        isWindows: boolean;
+    };
+}
+export declare const getEnvironment: import("@reduxjs/toolkit").AsyncThunk<boolean, void, {}>;
+export declare const environmentSlice: import("@reduxjs/toolkit").Slice<{
+    isWindows: boolean;
+}, {
+    setEnvironment: (state: import("immer/dist/internal").WritableDraft<{
+        isWindows: boolean;
+    }>, action: {
+        payload: any;
+        type: string;
+    }) => void;
+}, "environment">;
+export declare const setEnvironment: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, string>;
+export declare const selectIsWindows: (state: EnvironmentRootState) => boolean;
+declare const _default: import("redux").Reducer<{
+    isWindows: boolean;
+}>;
+export default _default;

package/common/src/slices/target-theming.d.ts

@@ -0,0 +1,56 @@
+import { ColorSchemeOptionType } from '../../../client-api-platform/src/shapes';
+import type { ComputedTheme } from '../api/theming';
+export interface TargetThemingRootState {
+    targetTheming: {
+        isFetchingTheme: boolean;
+        currentTheme: ComputedTheme | undefined;
+        hasTriedFetch: boolean;
+        currentScheme: ColorSchemeOptionType | undefined;
+    };
+}
+export declare const targetThemingSlice: import("@reduxjs/toolkit").Slice<{
+    isFetchingTheme: boolean;
+    currentTheme: ComputedTheme | undefined;
+    hasTriedFetch: boolean;
+    currentScheme: ColorSchemeOptionType | undefined;
+}, {
+    setTheme: (state: import("immer/dist/internal").WritableDraft<{
+        isFetchingTheme: boolean;
+        currentTheme: ComputedTheme | undefined;
+        hasTriedFetch: boolean;
+        currentScheme: ColorSchemeOptionType | undefined;
+    }>, action: {
+        payload: any;
+        type: string;
+    }) => void;
+    setIsFetchingTheme: (state: import("immer/dist/internal").WritableDraft<{
+        isFetchingTheme: boolean;
+        currentTheme: ComputedTheme | undefined;
+        hasTriedFetch: boolean;
+        currentScheme: ColorSchemeOptionType | undefined;
+    }>, action: {
+        payload: any;
+        type: string;
+    }) => void;
+    setCurrentScheme: (state: import("immer/dist/internal").WritableDraft<{
+        isFetchingTheme: boolean;
+        currentTheme: ComputedTheme | undefined;
+        hasTriedFetch: boolean;
+        currentScheme: ColorSchemeOptionType | undefined;
+    }>, action: {
+        payload: any;
+        type: string;
+    }) => void;
+}, "targetTheming">;
+export declare const setTheme: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, string>, setIsFetchingTheme: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, string>, setCurrentScheme: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, string>;
+export declare const selectTargetTheming: (state: TargetThemingRootState) => ComputedTheme;
+export declare const selectCurrentScheme: (state: TargetThemingRootState) => ColorSchemeOptionType;
+export declare const selectHasTriedFetch: (state: TargetThemingRootState) => boolean;
+export declare const selectIsFetchingTheme: (state: TargetThemingRootState) => boolean;
+declare const _default: import("redux").Reducer<{
+    isFetchingTheme: boolean;
+    currentTheme: ComputedTheme;
+    hasTriedFetch: boolean;
+    currentScheme: ColorSchemeOptionType;
+}>;
+export default _default;

package/common/src/styles/svg-icons.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+export declare const StyledIcon: import("styled-components").StyledComponent<({ tabIndex, icon, children, size, containerSize, "data-testid": dataTestId, ...props }: import("@openfin/ui-library").IconProps) => JSX.Element, import("styled-components").DefaultTheme, {
+    disabled?: boolean;
+    isEnterprise?: boolean;
+    windowFocused?: boolean;
+}, never>;
+export declare const ThemedSVG: import("styled-components").StyledComponent<"svg", import("styled-components").DefaultTheme, {}, never>;

package/common/src/utils/a11y/index.d.ts

@@ -0,0 +1,3 @@
+export type HTMLElementWithAria = HTMLElement & {
+    ariaLabel: string | null;
+};

package/common/src/utils/bookmark-item-context-menu.d.ts

@@ -0,0 +1,3 @@
+import { OpenFin } from '@openfin/core';
+import { BookmarkItemContextMenuItemTemplate } from '../../../client-api-platform/src/shapes';
+export declare const getBookmarkItemContextMenuTemplate: (callerIdentity: OpenFin.Identity, bookmarkId: string) => Promise<BookmarkItemContextMenuItemTemplate[]>;

package/common/src/utils/bookmarks.d.ts

@@ -0,0 +1,12 @@
+import { BookmarkNode } from '../../../common/src/api/pages/shapes';
+export declare const ALL_BOOKMARKS_FOLDER_TITLE = "_ALL_BOOKMARKS_";
+export declare const FAVORITES_FOLDER_TITLE = "_FAVORITES_";
+export type BookmarkFolder = {
+    id: string;
+    title: string;
+};
+export declare const sortBookmarks: (a: BookmarkNode, b: BookmarkNode) => number;
+export declare const collectFolders: (nodes: Array<BookmarkNode>) => Array<BookmarkFolder>;
+export declare const collectFoldersExcludingBuiltin: (nodes: Array<BookmarkNode>) => Array<BookmarkFolder>;
+export declare const prioritizeFolders: (folders: Array<BookmarkFolder>) => Array<BookmarkFolder>;
+export declare const getBookmarkFoldersList: (rootNode: BookmarkNode) => BookmarkFolder[];

package/common/src/utils/custom-logo.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Custom React hook to check the accessibility of a custom logo image.
+ * This hook initiates an image load and returns a boolean value indicating
+ * whether the image is accessible or not.
+ *
+ * @param customLogoUrl The URL of the custom logo to check. If undefined, the hook immediately returns false.
+ * @returns A state value that is true if the custom logo is accessible and has loaded successfully, and false otherwise.
+ * @example
+ * ```jsx
+ * function Component() {
+ *   const logoAccessible = useCustomLogoAccessible('http://example.com/logo.png');
+ *   return logoAccessible ? <img src='http://example.com/logo.png' /> : <DefaultLogo />;
+ * }
+ * ```
+ */
+export declare const useCustomLogoAccessible: (customLogoUrl: string | undefined) => boolean;

package/common/src/utils/enterprise-channels.d.ts

@@ -0,0 +1,13 @@
+import OpenFin from '@openfin/core';
+export declare const getContextMenuChannelName: () => string;
+export declare const getBookmarkContextMenuChannelName: () => string;
+export declare const getBookmarkPanelActionsMonitorChannelName: () => string;
+export declare const getDropdownMenuChannelName: () => string;
+export declare const createDropdownMenuChannel: () => Promise<OpenFin.ChannelProvider>;
+export declare const connectDropdownMenuChannel: () => Promise<OpenFin.ChannelClient>;
+export declare const createBookmarkDialogChannel: () => Promise<OpenFin.ChannelProvider>;
+export declare const connectToBookmarkDialogChannel: () => Promise<OpenFin.ChannelClient>;
+export declare const createBookmarkPanelActionsMonitorChannel: () => Promise<OpenFin.ChannelProvider>;
+export declare const connectToBookmarkPanelActionsMonitor: () => Promise<OpenFin.ChannelClient>;
+export declare const createContextMenuChannel: () => Promise<OpenFin.ChannelProvider>;
+export declare const connectToContextMenuChannel: () => Promise<OpenFin.ChannelClient>;

package/common/src/utils/enterpriseBrowser.d.ts

@@ -6,3 +6,4 @@ export declare function formatUrl(url: string): string;
 export declare const getIsEnterpriseBrowser: (id?: OpenFin.Identity) => Promise<boolean>;
 export declare const getMenuWindowWidth: () => Promise<number>;
 export declare const isLandingPage: (url: string) => boolean;
+export declare const isLandingPageOrEmpty: (url: string) => boolean;

package/common/src/utils/interop.d.ts

@@ -0,0 +1,30 @@
+import type OpenFin from '@openfin/core';
+export declare enum InteropEventType {
+    JoinedContextGroup = "joined-context-group",
+    RemovedFromContextGroup = "removed-from-context-group"
+}
+type InteropEventPayload<E extends InteropEventType> = {
+    [InteropEventType.JoinedContextGroup]: {
+        viewIdentity: OpenFin.Identity;
+        contextGroupId: string;
+    };
+    [InteropEventType.RemovedFromContextGroup]: {
+        viewIdentity: OpenFin.Identity;
+    };
+}[E];
+export type InteropListener<EventType extends InteropEventType> = (payload: InteropEventPayload<EventType>) => void;
+/**
+ * Returns contextGroup data.
+ * @returns Promise<ContextGroup[]>
+ */
+export declare function getContextGroups(): Promise<OpenFin.ContextGroupInfo[]>;
+export declare const joinContextGroup: (viewIdentity: OpenFin.Identity, contextGroupId: string) => Promise<void>;
+export declare const removeFromGroup: (viewIdentity: OpenFin.Identity) => Promise<void>;
+export declare function getViewContextGroupId(viewIdentity: OpenFin.Identity): Promise<string | null | undefined>;
+/**
+ * Listen for interop events.
+ * @param event the interop event to listen for.
+ * @param listener the function to call when the event occurs.
+ */
+export declare const addInteropListener: <Event_1 extends InteropEventType>(event: Event_1, listener: InteropListener<Event_1>) => Promise<void>;
+export {};

package/common/src/utils/layout.d.ts

@@ -65,6 +65,12 @@ export declare const cloneViewComponentWithoutName: (componentState: any) => any
  * @returns A copy of the layout with names removed
  */
 export declare const cloneLayoutAndRemoveNames: (layout: PageLayout) => any;
+/**
+ * Deep clones a layout and removes generated view names.
+ * @param layout The Layout to be cloned
+ * @returns A copy of the layout with generated names removed
+ */
+export declare const cloneLayoutAndRemoveGeneratedNames: (layout: PageLayout) => any;
 export declare const mapContentComponentState: (content: OpenFin.LayoutContent) => OpenFin.LayoutComponent['componentState'][];
 export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<any>;
 export declare const layoutNameInitializedMap: Map<string, boolean>;

package/common/src/utils/menu-config.d.ts

@@ -37,4 +37,5 @@ export type ButtonConfig = {
     label: string;
     type: 'primary' | 'secondary';
     id: string;
+    variant?: 'critical' | 'outline';
 };

package/common/src/utils/modal-bounds.d.ts

@@ -10,12 +10,4 @@ import { ResponseModalConfig } from './menu-config';
  * @returns the bounds for where the modal is to be displayed
  */
 export declare const getResponseModalBounds: (modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean) => Promise<OpenFin.Bounds>;
-/**
- * calculates the percenage of the window that is present within the monitor (float in range 0-1)
- *
- * @param bounds the bounds of the window
- * @param monitor the monitor to check against
- */
-export declare function getPercentageOfBoundsInMonitor(bounds: OpenFin.Bounds, monitor: OpenFin.MonitorDetails): number;
-export declare function getMonitorWindowMaximizedOn(parentWindowBounds: OpenFin.WindowBounds): Promise<OpenFin.MonitorDetails>;
 export declare function getResponseModalBoundsAndCenterParentIfModalOffScreen(modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean): Promise<OpenFin.Bounds>;

package/common/src/utils/navigate.d.ts

@@ -0,0 +1,8 @@
+import type OpenFin from '@openfin/core';
+import { ComponentName } from '../../../common/src/utils/usage-register';
+export interface NavigatePayload {
+    componentName: ComponentName;
+    platformIdentity: OpenFin.Identity;
+    providerId?: string;
+}
+export declare const navigateTo: (componentName: ComponentName, platformIdentity: OpenFin.Identity, providerId?: string) => Promise<void>;

package/common/src/utils/popup-window.d.ts

@@ -1,7 +1,9 @@
 import type OpenFin from '@openfin/core';
+import { BookmarkFolder } from '../../../common/src/utils/bookmarks';
 import { UserMenuParams } from '../../../common/src/utils/menu';
 import { OptionalExceptFor } from '../../../common/src/utils/types';
 import { AnchorBehavior } from '../../../client-api-platform/src/api/context-menu';
+import { SearchViewExpansionState } from '../../../browser/src/components/ControlBar/LeftControlsContainer/EnterpriseNavigationContainer/AddressBar/AddressBar';
 import { Site, SiteAction } from '../../../client-api-platform/src/shapes';
 export declare enum SaveMenuType {
     Save = "Save",
@@ -14,9 +16,6 @@ export declare enum SaveMenuType {
  */
 export declare const getSaveContextMenuTemplate: (saveMenuType?: SaveMenuType) => OpenFin.MenuItemTemplate[];
 export declare function showModalWin<T extends keyof UserMenuParams>(params: UserMenuParams[T], windowOpts: OptionalExceptFor<OpenFin.WindowOptions, 'x' | 'y' | 'defaultWidth' | 'url' | 'name'>): Promise<OpenFin.Window>;
-export type SearchMenuChannelFocusView = {
-    type: 'focus-search-menu';
-};
 export type SearchMenuChannelViewResized = {
     type: 'view-resized';
     height: number;
@@ -26,22 +25,44 @@ export type SearchMenuChannelUpdateState = {
     selectedViews: OpenFin.Identity[];
     openViews: OpenFin.Identity[];
     windowId: OpenFin.Identity;
+    searchText?: string;
+    keyboardEvent?: BrowserSearchMenuKeyboardEvent;
+    shouldExpandMenu?: SearchViewExpansionState;
     type: 'update-search-menu-state';
 };
-export type SearchMenuChannelRequest = SearchMenuChannelFocusView | SearchMenuChannelViewResized | SearchMenuChannelUpdateState;
+export type BrowserSearchMenuKeyboardEvent = {
+    type: string;
+    options: {
+        key: string;
+        metaKey?: boolean;
+        ctrlKey?: boolean;
+        altKey?: boolean;
+    };
+};
+export type SearchMenuChannelRequest = SearchMenuChannelViewResized | SearchMenuChannelUpdateState;
 export declare enum ContextMenuType {
     GlobalMenu = "global-menu",
     ContextMenu = "context-menu",
-    RenameSupertab = "rename-supertab"
+    RenameSupertab = "rename-supertab",
+    AddEditBookmark = "add-edit-bookmark",
+    DropdownMenu = "dropdown-menu"
 }
+export type BookmarkButtonPayload = {
+    selectedViewIdentity?: OpenFin.Identity;
+};
 export type ContextMenuChannelMessageData = {
     parentIdentity: OpenFin.Identity;
+    responseIdentity: OpenFin.Identity;
     anchorBehavior: AnchorBehavior;
     type: ContextMenuType;
     x: number;
     y: number;
     payload: OpenFin.ShowPopupMenuOptions | {
         pageId: string;
+    } | BookmarkButtonPayload | {
+        dropdownOptions: Array<BookmarkFolder>;
+        width: number;
+        selected: BookmarkFolder;
     };
 };
 export type SearchMenuChannelResponse = {
@@ -51,14 +72,14 @@ export type SearchMenuChannelResponse = {
     selectedView: OpenFin.Identity;
     inputUpdate?: string;
     trigger?: SiteAction;
-} | {
-    type: 'update-input';
-    inputText: string;
-    isSecure: boolean;
-    landingPage: boolean;
+    handled?: boolean;
 } | {
     type: 'resize-view';
+    isExpanded: boolean;
     height: number;
     width: number;
+} | {
+    type: 'keyboard-event';
+    keyboardEvent: BrowserSearchMenuKeyboardEvent;
 };
 export declare function showPopupWin<T extends keyof UserMenuParams>(parentWindow: OpenFin.Window, params: UserMenuParams[T], windowOpts: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;

package/common/src/utils/route.d.ts

@@ -15,7 +15,7 @@ export declare enum PageRoute {
     BrowserPopupMenuLayouts = "/browser/popup-menu/layouts/layouts/",
     BrowserPopupMenuColorLinking = "/browser/popup-menu/color-linking/color-linking/",
     BrowserIndicator = "/browser/indicator/",
-    BrowserPopupMenuAddressSearchView = "/browser/popup-menu/address-search-view/",
+    BrowserPopupMenuAddressSearchResultsView = "/browser/popup-menu/address-search-results-view/",
     ResponseModal = "/browser/popup-menu/response-modal/",
     CloseConfirmationModal = "/browser/popup-menu/close-confirmation-modal/",
     Docs = "/provider/docs/",
@@ -23,7 +23,9 @@ export declare enum PageRoute {
     DeprecatedAlert = "/provider/deprecated-alert/",
     Analytics = "/provider/analytics/",
     EnterpriseBrowser = "/browser/enterprise/",
-    EnterpriseContextMenu = "/browser/enterprise/context-menu/"
+    EnterpriseContextMenu = "/browser/enterprise/context-menu/",
+    EnterpriseBookmarkDialog = "/browser/enterprise/bookmark-dialog/",
+    DropdownMenu = "/browser/enterprise/dropdown-menu/"
 }
 export declare const Assets: {
     readonly IconOpenFinLogo: "/icons/openfinlogo.svg";