@openfin/workspace 19.3.2 → 19.3.4

package/browser/src/components/ControlBar/LeftControlsContainer/EnterpriseNavigationContainer/AddressBar/AddressBarInput.d.ts

@@ -3,16 +3,16 @@ import { OpenFin } from '@openfin/core';
 import { BrowserSearchMenuKeyboardEvent } from '../../../../../../../common/src/utils/popup-window';
 import { SearchViewExpansionState, SecureIconState } from './AddressBar';
 type AddressBarInputProps = {
-    addressSearchResultsView?: OpenFin.View;
-    addressBarInputRef?: MutableRefObject<HTMLInputElement>;
-    inputContainerRef?: MutableRefObject<HTMLDivElement>;
-    addressBarWidth?: number;
+    addressSearchResultsView: OpenFin.View;
+    addressBarInputRef: MutableRefObject<HTMLInputElement>;
+    inputContainerRef: MutableRefObject<HTMLDivElement>;
+    addressBarWidth: number;
     isSecure: SecureIconState;
-    setShouldExpandMenu?: Dispatch<SetStateAction<SearchViewExpansionState>>;
-    shouldExpandMenu?: SearchViewExpansionState;
+    setShouldExpandMenu: Dispatch<SetStateAction<SearchViewExpansionState>>;
+    shouldExpandMenu: SearchViewExpansionState;
     setSearchText: Dispatch<SetStateAction<string>>;
     searchText: string;
-    setKeyboardEvent: Dispatch<BrowserSearchMenuKeyboardEvent>;
+    sendKeyboardEventToSearchMenuView: (keyboardEvent: BrowserSearchMenuKeyboardEvent) => void;
 };
 export declare const AddressBarInput: React.FC<AddressBarInputProps>;
 export {};

package/browser/src/components/ControlBar/SearchMenu/BookmarkButton.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+type BookmarkIconProps = {
+    inputContainerRef: React.MutableRefObject<HTMLDivElement>;
+    iconGradientClick?: () => void;
+    url?: string;
+    isMenuExpanded?: boolean;
+    disableMonitorBookmarkPanelActions?: boolean;
+};
+export declare const BookmarkButton: ({ inputContainerRef, url, iconGradientClick, isMenuExpanded, disableMonitorBookmarkPanelActions }: BookmarkIconProps) => JSX.Element;
+export {};

package/browser/src/components/ControlBar/SearchMenu/useBookmarkButtonHover.d.ts

@@ -0,0 +1,2 @@
+import { MutableRefObject } from 'react';
+export declare const useBookmarkButtonHover: (inputContainerRef: MutableRefObject<HTMLElement | null>) => boolean;

package/browser/src/components/ControlBar/SearchMenu/useEnterpriseBookmarkDialogWindow.d.ts

@@ -0,0 +1,2 @@
+import OpenFin from '@openfin/core';
+export declare const useEnterpriseBookmarkDialogWindow: () => OpenFin.Window | null;

package/browser/src/components/ControlBar/SearchMenu/useIsBookmarked.d.ts

@@ -0,0 +1 @@
+export declare const useIsBookmarked: (url?: string, ...beacons: (any | undefined)[]) => boolean;

package/browser/src/components/ControlBar/SearchMenu/useIsSelectedViewNavigated.d.ts

@@ -0,0 +1,5 @@
+import OpenFin from '@openfin/core';
+export declare const useIsSelectedViewNavigated: (url: string) => {
+    isViewNavigatedToUrl: boolean;
+    selectedView: OpenFin.View;
+};

package/browser/src/components/ControlBar/SearchMenu/useSelectedAndOpenViewsBroadcastChannel.d.ts

@@ -0,0 +1,8 @@
+import { MutableRefObject } from 'react';
+import type OpenFin from '@openfin/core';
+import { SearchMenuChannelRequest } from '../../../../../common/src/utils/popup-window';
+export declare const useSelectedAndOpenViewsBroadcastChannel: (additionalCallBack?: (ev: MessageEvent<SearchMenuChannelRequest>) => void) => {
+    selectedViews: OpenFin.Identity[];
+    openViews: OpenFin.Identity[];
+    searchMenuChannel: MutableRefObject<BroadcastChannel>;
+};

package/browser/src/components/ControlBar/SearchMenu/utils.d.ts

@@ -0,0 +1,9 @@
+import OpenFin from '@openfin/core';
+import { BookmarkNode } from '../../../../../common/src/api/pages/shapes';
+import { AttachedPage, Site } from '../../../../../client-api-platform/src/index';
+export declare const handleAlreadyOpenPage: (attachedPages: AttachedPage[], site?: Site) => boolean;
+export declare const convertSiteData: (result: any) => Site;
+export declare const getRecentlyVisitedSites: () => Promise<Site[]>;
+export declare const getSiteSubTitle: (site: Site) => string;
+export declare const checkViewUrl: (view: OpenFin.View | null, url: string, setViewNavigatedToUrl: (value: boolean) => void) => Promise<void>;
+export declare const searchBookmark: (url: string, browserIdentity?: OpenFin.Identity) => Promise<BookmarkNode | undefined>;

package/browser/src/components/PanelContainer/BookmarksPanel/BookmarkItem.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="react" />
+import { BookmarkNode } from '../../../../../common/src/api/pages/shapes';
+import { Props as BaseButtonProps } from '../../../../../common/src/components/BaseButton/BaseButton';
+interface BookmarkItemProps {
+    bookmark: BookmarkNode;
+    isRenaming: boolean;
+    handleNavigateToFolder: (folderId: string) => void;
+    setRenamingNode: (id?: string) => void;
+}
+declare const _default: import("react").NamedExoticComponent<BookmarkItemProps>;
+export default _default;
+export declare const BookmarkItemButton: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<BaseButtonProps & import("react").HTMLAttributes<HTMLButtonElement> & import("react").RefAttributes<HTMLButtonElement>>, import("styled-components").DefaultTheme, BaseButtonProps & {
+    isRenaming?: boolean;
+}, never>;
+export declare const BookmarkItemButtonContent: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;
+export declare const BookmarkFolderIcon: React.FC;
+export declare const BookmarkFavoritesIcon: React.FC;

package/browser/src/components/PanelContainer/BookmarksPanel/BookmarksFolderHeader.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { BookmarkNode } from '../../../../../common/src/api/pages/shapes';
+interface BookmarksPanelHeaderProps {
+    folder: BookmarkNode;
+    handleNavigateToFolder: (folderId: string) => void;
+}
+declare const BookmarksFolderHeader: React.FC<BookmarksPanelHeaderProps>;
+export default BookmarksFolderHeader;

package/browser/src/components/PanelContainer/BookmarksPanel/BookmarksPanel.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+declare const BookmarksPanel: () => JSX.Element;
+export default BookmarksPanel;
+export declare const TextHelp: import("styled-components").StyledComponent<"span", import("styled-components").DefaultTheme, import("react").HTMLAttributes<HTMLElement> & {
+    color?: "background6" | "textDefault";
+    children: import("react").ReactNode;
+    size?: "small" | "base" | "large" | "xsmall" | "xlarge" | "xxlarge" | "xxxlarge" | "xxxxlarge";
+    weight?: "normal" | "bold";
+}, never>;

package/browser/src/components/PanelContainer/BookmarksPanel/BookmarksPanelHeader.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+declare const BookmarksPanelHeader: () => JSX.Element;
+export default BookmarksPanelHeader;

package/browser/src/components/PanelContainer/BookmarksPanel/BookmarksResults.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="react" />
+import { BookmarkNode } from '../../../../../common/src/api/pages/shapes';
+import { CategorizedBookmarkSearchResults } from './utils';
+interface BookmarksResultsProps {
+    currentFolder: BookmarkNode;
+    bookmarksList: BookmarkNode[];
+    categorizedSearchResults: CategorizedBookmarkSearchResults;
+    isSearchQueryResults: boolean;
+    renamingNodeId: string | undefined;
+    handleNavigateToFolder: (folderId: string) => void;
+    setRenamingNode: (id?: string) => void;
+}
+declare const BookmarksResults: React.FC<BookmarksResultsProps>;
+export default BookmarksResults;
+export declare const TextHeader: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;

package/browser/src/components/PanelContainer/BookmarksPanel/BookmarksSearchInput.d.ts

@@ -0,0 +1,7 @@
+import { ChangeEvent } from 'react';
+interface BookmarksSearchInputProps {
+    handleSearchInputChange: (event: ChangeEvent<HTMLInputElement>) => void;
+    clearSearchInput: () => void;
+}
+declare const BookmarksSearchInput: React.FC<BookmarksSearchInputProps>;
+export default BookmarksSearchInput;

package/browser/src/components/PanelContainer/BookmarksPanel/useBookmarkNavigation.d.ts

@@ -0,0 +1,8 @@
+import { MouseEvent } from 'react';
+import { BookmarkNode } from '../../../../../common/src/api/pages/shapes';
+/**
+ * Custom hook that returns function to handle navigation for a click on a bookmark item.
+ *
+ * @returns {Function} Function to handle bookmark navigation click.
+ */
+export declare const useBookmarkNavigation: () => (bookmark: BookmarkNode, event: MouseEvent<HTMLButtonElement>) => Promise<void>;

package/browser/src/components/PanelContainer/BookmarksPanel/useBookmarksSearch.d.ts

@@ -0,0 +1,16 @@
+import { BookmarkNode } from '../../../../../common/src/api/pages/shapes';
+import { CategorizedBookmarkSearchResults } from './utils';
+/**
+ * Custom hook that manages and sorts bookmark search results and returns an object of categorized bookmarks
+ * and actions to update the search query.
+ *
+ * @returns {Object} An object containing the following:
+ * - `categorizedSearchResults` : An object containing two arrays, `bookmarksInFolder` and `bookmarksOutsideFolder`.
+ * - `handleSearchInputChange` : A function to update the search query phrase to retrieve new search results.
+ * - `clearSearchInput` : A function to clear the search query and reset the panel to its previous state.
+ */
+export declare const useBookmarksSearch: (currentFolder: BookmarkNode, setSearchQuery: (query: string) => void, updateBookmarksResults: (folderId?: string, navigateToFolder?: boolean) => void) => {
+    categorizedSearchResults: CategorizedBookmarkSearchResults;
+    handleSearchInputChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
+    clearSearchInput: () => void;
+};

package/browser/src/components/PanelContainer/BookmarksPanel/useUpdateBookmarkResultsActions.d.ts

@@ -0,0 +1,15 @@
+import { BookmarkNode } from '../../../../../common/src/api/pages/shapes';
+/**
+ * Custom hook that retrieves the root node corresponding to All Bookmarks on initial render and
+ * provides actions to update bookmark results.
+ *
+ * @returns {Object} An object containing the following:
+ * - `bookmarksList` : `BookmarkNode[]` - A sorted list of the current folder's child bookmarks and folders.
+ * - `currentFolder` : `BookmarkNode` - The currently active folder.
+ * - `deleteBookmark` : A function to update currentFolder and bookmarksList given a specific folderId.
+ */
+export declare const useUpdateBookmarkResultsActions: () => {
+    bookmarksList: BookmarkNode[];
+    currentFolder: BookmarkNode;
+    updateBookmarksResults: (folderId?: string) => Promise<void>;
+};

package/browser/src/components/PanelContainer/BookmarksPanel/utils.d.ts

@@ -0,0 +1,7 @@
+import { BookmarkNode } from '../../../../../common/src/api/pages/shapes';
+export type CategorizedBookmarkSearchResults = {
+    bookmarksInFolder: BookmarkNode[];
+    bookmarksOutsideFolder: BookmarkNode[];
+};
+export declare const renderBookmarkNodeTitle: (title: string) => string;
+export declare const categorizeSearchResults: (bookmarks: BookmarkNode[], folderId: string) => CategorizedBookmarkSearchResults;

package/browser/src/hooks/EnterpriseSearchMenu/usePostMessageToSearchMenuView.d.ts

@@ -11,6 +11,8 @@ import { SearchViewExpansionState } from '../../components/ControlBar/LeftContro
  * @param {AttachedPageInternal} activePage - Object representing the currently active page in the browser window.
  * @param {SearchViewExpansionState} shouldExpandMenu - Object with boolean indicating if the search results view should expand and the method of expansion.
  * @param {string} searchText - String representing the current text in the address input.
- * @param {BrowserSearchMenuKeyboardEvent} keyboardEvent - Object representing keyboard event to send to search results view to shift focus or interact with results.
+ * @returns {{ sendKeyboardEventToSearchMenuView: (keyboardEvent: BrowserSearchMenuKeyboardEvent) => void }} - Object containing a function to send keyboard events to the search menu view.
  */
-export declare const usePostMessageToSearchMenuView: (selectedViews: OpenFin.Identity[], searchMenuChannel: BroadcastChannel, activePage: AttachedPageInternal, shouldExpandMenu: SearchViewExpansionState, searchText: string, keyboardEvent: BrowserSearchMenuKeyboardEvent) => void;
+export declare const usePostMessageToSearchMenuView: (selectedViews: OpenFin.Identity[], searchMenuChannel: BroadcastChannel, activePage: AttachedPageInternal, shouldExpandMenu: SearchViewExpansionState, searchText: string) => {
+    sendKeyboardEventToSearchMenuView: (keyboardEvent: BrowserSearchMenuKeyboardEvent) => Promise<void>;
+};

package/browser/src/hooks/usePanelBounds.d.ts

@@ -1,3 +1,4 @@
-import { PanelPosition } from '../../../common/src/api/pages/shapes';
+import { PanelConfigVertical, PanelPosition } from '../../../common/src/api/pages/shapes';
 export type CSSBounds = Partial<Record<'top' | 'right' | 'bottom' | 'left' | 'height' | 'width', string>>;
+export declare const BookmarksPanelConfig: PanelConfigVertical;
 export declare const usePanelBounds: (panelPosition: PanelPosition | 'Center') => Partial<Record<"top" | "left" | "height" | "width" | "bottom" | "right", string>>;

package/browser/src/hooks/useSingleViewPage.d.ts

@@ -0,0 +1,2 @@
+export declare const useIsPageSingleView: (pageId: string) => boolean;
+export declare const useIsActivePageSingleView: () => boolean;

package/browser/src/hooks/useWindowFocusState.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="react" />
+type WindowState = 'focused' | 'view-focused' | 'blurred';
+/**
+ * Creates a context which exposes information about the specified window's state
+ */
+export declare const WindowStateProvider: (props: {
+    children: React.ReactNode;
+}) => JSX.Element;
+/**
+ * Tracks the window's current state.
+ */
+export declare const useWindowState: () => WindowState;
+/**
+ * Tracks whether the window or any view within it is focused.
+ */
+declare const useWindowFocusState: () => boolean;
+export default useWindowFocusState;

package/client-api-platform/src/api/browser/bookmarks.d.ts

@@ -0,0 +1,6 @@
+import { BookmarkNode, CreateBookmarkNodeRequest, UpdateBookmarkNodeRequest } from '../../../../common/src/api/pages/shapes';
+export declare const createBookmarkNodeInternal: (req: CreateBookmarkNodeRequest) => Promise<BookmarkNode>;
+export declare const getBookmarkNodeInternal: (id?: string) => Promise<BookmarkNode | undefined>;
+export declare const searchBookmarkNodesInternal: (query: string) => Promise<BookmarkNode[]>;
+export declare const updateBookmarkNodeInternal: (req: UpdateBookmarkNodeRequest) => Promise<BookmarkNode | undefined>;
+export declare const deleteBookmarkNodeInternal: (id: string) => Promise<void>;

package/client-api-platform/src/api/context-menu/index.d.ts

@@ -6,7 +6,8 @@ export declare enum AnchorBehavior {
     BottomRight = 1,
     Center = 2
 }
-export declare const openCommonContextMenu: (payload: OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload, _callerIdentity: OpenFin.Identity, type?: ContextMenuType, anchorBehavior?: AnchorBehavior) => Promise<void>;
+type ContextMenuPayload = OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload;
+export declare const openCommonContextMenu: (payload: ContextMenuPayload, _callerIdentity: OpenFin.Identity, type?: ContextMenuType, anchorBehavior?: AnchorBehavior) => Promise<void>;
 export declare function openGlobalContextMenuInternal(this: WorkspacePlatformProvider, payload: InternalOpenGlobalContextMenuRequest & {
     identity: OpenFin.Identity;
 }, callerIdentity: OpenFin.Identity): Promise<void>;
@@ -19,3 +20,4 @@ export declare function openPageTabContextMenuInternal(this: WorkspacePlatformPr
 export declare function openSaveButtonContextMenuInternal(this: WorkspacePlatformProvider, payload: OpenSaveButtonContextMenuRequest & {
     identity: OpenFin.Identity;
 }, callerIdentity: OpenFin.Identity): Promise<void>;
+export {};

package/client-api-platform/src/shapes.d.ts

@@ -4,7 +4,7 @@ import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/ut
 import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 import { Resource } from '../../common/src/api/i18next';
 import { TrackedSite } from '../../common/src/api/pages/idb';
-import type { AddDefaultPagePayload, AttachedPage, CopyPagePayload, HandlePagesAndWindowClosePayload, HandlePagesAndWindowCloseResult, HandleSaveModalOnPageClosePayload, Page, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult, ShouldPageClosePayload, ShouldPageCloseResult, ViewsPreventingUnloadPayload } from '../../common/src/api/pages/shapes';
+import { AddDefaultPagePayload, AttachedPage, BookmarkNode, CopyPagePayload, CreateBookmarkNodeRequest, HandlePagesAndWindowClosePayload, HandlePagesAndWindowCloseResult, HandleSaveModalOnPageClosePayload, Page, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult, ShouldPageClosePayload, ShouldPageCloseResult, UpdateBookmarkNodeRequest, ViewsPreventingUnloadPayload } from '../../common/src/api/pages/shapes';
 import { SetActivePageForWindowPayload } from '../../common/src/api/pages/shapes';
 import { NotificationsCustomManifestOptions } from '../../common/src/api/shapes/notifications';
 import type { CustomThemes } from '../../common/src/api/theming';
@@ -170,6 +170,12 @@ export declare enum EnterpriseMainContextMenuOptionType {
     Print = "Print",
     Pin = "Pin"
 }
+/** @internal */
+export declare enum BookmarkItemContextMenuOptionType {
+    EditName = "Edit Name",
+    Move = "Move",
+    Delete = "Delete"
+}
 /**Shape of the data property of a global context menu template item */
 export interface GlobalContextMenuItemData extends ContextMenuItemData {
     type: GlobalContextMenuOptionType;
@@ -189,6 +195,13 @@ export interface AppearanceContextMenuItemData extends GlobalContextMenuItemData
 export type GlobalContextMenuItemTemplate = OpenFin.MenuItemTemplate<GlobalContextMenuItemData>;
 /** @internal */
 export type EnterpriseMainContextMenuItemTemplate = OpenFin.MenuItemTemplate<EnterpriseMainContextMenuItemData>;
+/** @internal */
+export interface BookmarkItemContextMenuItemData extends ContextMenuItemData {
+    type: BookmarkItemContextMenuOptionType;
+    parentId?: string;
+}
+/** @internal */
+export type BookmarkItemContextMenuItemTemplate = OpenFin.MenuItemTemplate<BookmarkItemContextMenuItemData>;
 /**Shape of the data property of a page tab context menu template item */
 export interface PageTabContextMenuItemData extends ContextMenuItemData {
     type: PageTabContextMenuOptionType;
@@ -1084,6 +1097,39 @@ export interface BrowserWindowModule {
     _getCuratedContent(req?: any): Promise<Site[]>;
     /** @internal */
     _handleRequestNavigation(args: NavigationRequest): Promise<void>;
+    _bookmarks: BrowserBookmarks;
+}
+export interface BrowserBookmarks {
+    /**
+     * Implementation for creating a new bookmark node.
+     * @param req The request object specifying the attributes of the new node.
+     * @internal
+     */
+    _createBookmarkNode(req: CreateBookmarkNodeRequest): Promise<BookmarkNode>;
+    /**
+     * Implementation for getting a bookmark node.
+     * @param string The unique id of the node. Returns root node when left undefined.
+     * @internal
+     */
+    _getBookmarkNode(id?: string): Promise<BookmarkNode | undefined>;
+    /**
+     * Implementation for searching for a bookmark node.
+     * @param query The string used to filter bookmark nodes by title or, in the case of bookmarks, URL, as well.
+     * @internal
+     */
+    _searchBookmarkNodes(query: string): Promise<BookmarkNode[]>;
+    /**
+     * Implementation for updating a bookmark node.
+     * @param req The request object with the updated attributes of the targeted node.
+     * @internal
+     */
+    _updateBookmarkNode(req: UpdateBookmarkNodeRequest): Promise<BookmarkNode | undefined>;
+    /**
+     * Implementation for deleting a bookmark node.
+     * @param id The unique id of the node.
+     * @internal
+     */
+    _deleteBookmarkNode(id: string): Promise<void>;
 }
 /**
  * @internal
@@ -1736,6 +1782,12 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      * Implementation for getting the notifications workspace platform configuration.
      */
     getNotificationsConfig(): Promise<NotificationsCustomManifestOptions | undefined>;
+    _raiseAnalytics(events: AnalyticsEventInternal[]): Promise<void>;
+    /**
+     * Triggers all browser windows to refresh bookmarks data
+     * @internal
+     */
+    _refreshBookmarksInternal(): Promise<void>;
     /**
      * The browser window factory for the Workspace Platform.
      */
@@ -1748,7 +1800,6 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      * Theme API for the Workspace Platform.
      */
     Theme: ThemeApi;
-    _raiseAnalytics(events: AnalyticsEventInternal[]): Promise<void>;
 }
 export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
     /**
@@ -1988,6 +2039,8 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
     }): Promise<SearchSitesResponse>;
     /** @internal */
     handleRequestNavigationInternal(req: NavigationRequest): Promise<void>;
+    /** @internal */
+    refreshBookmarksInternal(): Promise<void>;
 }
 /**
  * The origins from which a custom action can be invoked

package/common/src/api/pages/shapes.d.ts

@@ -256,4 +256,95 @@ export type AddPagePayload = {
     /** Index at which the page should be added */
     insertionIndex?: number;
 };
+/**
+ * A node that represents either a bookmark or folder in the bookmark tree.
+ */
+export interface BookmarkNode {
+    /**
+     * The unique id of the node.
+     */
+    id: string;
+    /**
+     * The title of the bookmark or folder.
+     */
+    title: string;
+    /**
+     * The unique URL associated with a bookmark. Is undefined for folders.
+     */
+    url?: string;
+    /**
+     * When this bookmark or folder was created, in milliseconds since the epoch.
+     */
+    dateCreated: number;
+    /**
+     * The favicon to display next to titles for bookmarks. When no icon or a
+     * broken icon is provided, the default globe icon will be used instead. Is
+     * undefined for folders.
+     */
+    favIcon?: string;
+    /**
+     * The id of the parent folder that contains a bookmark. Is undefined for the
+     * root node.
+     */
+    parentId?: string;
+    /**
+     * The children of this node. Can only contain bookmarks. Is undefined for
+     * bookmarks.
+     */
+    children?: BookmarkNode[];
+}
+/**
+ * Request object to create a new bookmark node.
+ */
+export interface CreateBookmarkNodeRequest {
+    /**
+     * The title of the bookmark or folder.
+     */
+    title: string;
+    /**
+     * The unique URL associated with the bookmark. Omit for folders.
+     */
+    url?: string;
+    /**
+     * The favicon to display next to titles for bookmarks. When no icon or a
+     * broken icon is provided, the default globe icon will be used instead. Omit
+     * for folders.
+     */
+    favIcon?: string;
+    /**
+     * The id of the parent folder for this bookmark. Omit for bookmarks under
+     * "All Bookmarks" and folders.
+     */
+    parentId?: string;
+}
+export type UpdatedBookmarkNodeAttrs = {
+    /**
+     * The new title to apply to the bookmark/folder.
+     */
+    title?: string;
+    /**
+     * The id of the parent folder to move this bookmark to. Leave undefined to
+     * move bookmark under "All Bookmarks". Omit for folders.
+     */
+    parentId?: string;
+    /**
+     * The favicon to display next to titles for bookmarks. When no icon or a
+     * broken icon is provided, the default globe icon will be used instead. Omit
+     * for folders.
+     */
+    favIcon?: string;
+};
+/**
+ * Request object to update a bookmark node.
+ */
+export interface UpdateBookmarkNodeRequest {
+    /**
+     * The unique id of the bookmark.
+     */
+    id: string;
+    /**
+     * The object describing which attributes of the bookmark to update.
+     */
+    changes: UpdatedBookmarkNodeAttrs;
+}
 export {};

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/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/hooks/context.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="react" />
+import { Dispatch, SetStateAction } from 'react';
 import { ProviderInfoInternal, ProviderType } from '../../../common/src/api/provider';
 export type ProviderContext<T extends ProviderType = any> = {
     /**
@@ -48,3 +48,11 @@ export declare const BrowserLayoutDragContext: import("react").Context<{
 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/useAddEditBookmarkDialog.d.ts

@@ -0,0 +1,7 @@
+import { MutableRefObject } from 'react';
+import OpenFin from '@openfin/core';
+export declare const useAddEditBookmarkDialog: (bookmarkIconRef: MutableRefObject<HTMLElement | null>, selectedView?: OpenFin.View) => {
+    showDialog: () => Promise<void>;
+    isDialogShown: boolean;
+    isBookmarkUpdatedOrCreated: boolean;
+};

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

@@ -0,0 +1,13 @@
+import type OpenFin from '@openfin/core';
+interface PreloadedWindowOptions {
+    windowName: string;
+    route: string;
+    width?: number;
+    height?: number;
+    windowType?: string;
+    shouldPreload: boolean;
+}
+export default function usePreloadedWindow({ windowName, route, width, height, windowType, shouldPreload }: PreloadedWindowOptions & {
+    shouldPreload?: boolean;
+}): OpenFin.Window;
+export {};

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[];