@openfin/workspace-platform 20.1.0 → 20.1.2

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

@@ -4,7 +4,6 @@ type BookmarkIconProps = {
     iconGradientClick?: () => void;
     url?: string;
     isMenuExpanded?: boolean;
-    disableMonitorBookmarkPanelActions?: boolean;
 };
-export declare const BookmarkButton: ({ inputContainerRef, url, iconGradientClick, isMenuExpanded, disableMonitorBookmarkPanelActions }: BookmarkIconProps) => JSX.Element;
+export declare const BookmarkButton: ({ inputContainerRef, url, iconGradientClick, isMenuExpanded }: BookmarkIconProps) => JSX.Element;
 export {};

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

@@ -4,6 +4,8 @@ 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 formatRecentUrl: (url: string) => string;
+export declare const getSiteSubTitle: (site: Site, urlFormatter: (value: string) => string) => string;
+export declare const trimWithEllipsis: (str: string, characters: number) => 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

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { BookmarkNode } from '../../../../../common/src/api/pages/shapes';
-import { Props as BaseButtonProps } from '../../../../../common/src/components/BaseButton/BaseButton';
+import { BaseButtonProps } from '../../../../../common/src/components/BaseButton/BaseButton';
 interface BookmarkItemProps {
     bookmark: BookmarkNode;
     isRenaming: boolean;
@@ -9,7 +9,7 @@ interface BookmarkItemProps {
 }
 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 & {
+export declare const BookmarkItemButton: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<BaseButtonProps & 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>;

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

@@ -5,5 +5,5 @@ export declare const TextHelp: import("styled-components").StyledComponent<"span
     color?: "background6" | "textDefault";
     children: import("react").ReactNode;
     size?: "small" | "base" | "large" | "xsmall" | "xlarge" | "xxlarge" | "xxxlarge" | "xxxxlarge";
-    weight?: "normal" | "bold";
+    weight?: "bold" | "normal";
 }, never>;

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

@@ -1,6 +1,6 @@
 /// <reference types="react" />
+import { CategorizedBookmarkSearchResults } from '../../../../../common/src/utils/bookmarks';
 import { BookmarkNode } from '../../../../../common/src/api/pages/shapes';
-import { CategorizedBookmarkSearchResults } from './utils';
 interface BookmarksResultsProps {
     currentFolder: BookmarkNode;
     bookmarksList: BookmarkNode[];

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

@@ -1,5 +1,5 @@
+import { CategorizedBookmarkSearchResults } from '../../../../../common/src/utils/bookmarks';
 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.

package/client-api-platform/src/api/app-directory.d.ts

@@ -6,7 +6,7 @@ import type { LaunchAppRequest, SearchSitesRequest, SearchSitesResponse, Site }
  * @param app the app directory entry.
  * @param opts launch options.
  */
-export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Application | OpenFin.Identity | OpenFin.View | OpenFin.Platform>;
+export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Application | OpenFin.Identity | OpenFin.Platform | OpenFin.View>;
 export declare const enterpriseAppDirectoryChannelClient: () => Promise<OpenFin.ChannelClient>;
 export declare function getResults(payload: {
     req: SearchSitesRequest;

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

@@ -0,0 +1,2 @@
+import { LaunchBookmarkPayload } from '../../../client-api-platform/src/shapes';
+export declare const launchBookmark: (payload: LaunchBookmarkPayload) => Promise<void>;

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

@@ -0,0 +1 @@
+import '@common/test/fin-mocks';

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

@@ -0,0 +1,13 @@
+import { ContentMenuEntry } from '@openfin/ui-library';
+import type { DockEntry, WorkspacePanelButton } from '../../../client-api-platform/src/shapes';
+export declare const DockCompanionUpdatesPrefix = "dock-companion-updates";
+export declare const updateDockFavoriteEntries: (favorites: DockEntry[]) => Promise<void>;
+export declare const updateContentMenu: (contentMenu: ContentMenuEntry[]) => Promise<void>;
+export declare const navigateContentMenu: (id: string) => Promise<void>;
+export declare const launchDockEntry: (entry: DockEntry) => Promise<void>;
+export declare const setDockFavoritesOrder: (favorites: DockEntry[]) => Promise<void>;
+export declare const setDockWorkspaceButtonsOrder: (favorites: WorkspacePanelButton[]) => Promise<void>;
+export declare const getDockWorkspacesContextMenu: () => Promise<import("@client/index").BaseCustomDropdownItem[]>;
+export declare const handleDockWorkspacesMenuResponse: (payload: any) => Promise<void>;
+export declare const removeFavoriteEntry: (entry: DockEntry) => Promise<void>;
+export declare const addFavoriteEntry: (entry: DockEntry) => Promise<void>;

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

@@ -1,3 +1,3 @@
 export * from './shapes';
-export { init } from './init';
+export { init, initDockCompanion } from './init';
 export { getCurrentSync, wrapSync } from './api';

package/client-api-platform/src/init/index.d.ts

@@ -1,4 +1,6 @@
-import type { WorkspacePlatformInitConfig } from '../shapes';
+import OpenFin from '@openfin/core';
+import { CompanionDockConfig, WorkspacePlatformInitConfig } from '../shapes';
+export declare function initDockCompanion(config: CompanionDockConfig, platform: OpenFin.Platform): Promise<void>;
 /**
  * Initilaize a Workspace Platform.
  *
@@ -34,4 +36,4 @@ import type { WorkspacePlatformInitConfig } from '../shapes';
  * ```
  * @param options options for configuring the platform.
  */
-export declare const init: ({ theme, customActions, language, ...rest }: WorkspacePlatformInitConfig) => Promise<void>;
+export declare const init: ({ theme, customActions, language, ...rest }: WorkspacePlatformInitConfig) => Promise<OpenFin.Platform>;

package/client-api-platform/src/init/override-callback/browser-defaults.d.ts

@@ -2,7 +2,7 @@ import type OpenFin from '@openfin/core';
 import { WindowName } from '../../../../common/src/utils/window';
 import type { PreloadedThemeData } from '../../../../common/src/api/theming';
 import { BrowserInitConfig } from '../../../../client-api-platform/src/shapes';
-export declare const DEFAULT_BROWSER_URL: string;
+export declare const defaultBrowserUrl: () => Promise<string>;
 export declare const ENTERPRISE_LANDING_PAGE_URL: string;
 export declare const searchMenuIdentityBase: {
     uuid: string;

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

@@ -1,12 +1,12 @@
 import type OpenFin from '@openfin/core';
 import { IconProps, Languages } from '@openfin/ui-library';
 import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/utils/usage-register';
-import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
-import { AddDefaultPagePayload, AttachedPage, CopyPagePayload, HandlePagesAndWindowClosePayload, HandlePagesAndWindowCloseResult, HandleSaveModalOnPageClosePayload, Page, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult, ShouldPageClosePayload, ShouldPageCloseResult, ViewsPreventingUnloadPayload } from '../../common/src/api/pages/shapes';
+import { BaseCustomDropdownItem, CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
+import { AddDefaultPagePayload, AttachedPage, BookmarkNode, CopyPagePayload, HandlePagesAndWindowClosePayload, HandlePagesAndWindowCloseResult, HandleSaveModalOnPageClosePayload, Page, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult, ShouldPageClosePayload, ShouldPageCloseResult, 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';
-import type { App, DockProviderConfigWithIdentity, StoreButtonConfig } from '../../client-api/src/shapes';
+import { App, DockProviderConfigWithIdentity, StoreButtonConfig, WorkspaceButton } from '../../client-api/src/shapes';
 import type { WorkflowIntegration } from '../../client-api/src/shapes/integrations';
 export { AppManifestType } from '../../client-api/src/shapes';
 export type { App, AppIntent, Image } from '../../client-api/src/shapes';
@@ -959,6 +959,14 @@ export interface BrowserWindowModule {
      * @property {string} [value] - The value associated with the 'custom' type.
      */
     updateBrowserWindowTitle(title: WindowTitle): Promise<void>;
+    /**
+     * Internal implementation to retrieve selected view ids from available layouts in a browser window instances
+     */
+    _getLayoutsWithSelectedViews(): Promise<Array<{
+        layoutContainerKey: string;
+        isActive: boolean;
+        selectedViews: OpenFin.Identity[];
+    }>>;
     _bookmarks: BrowserBookmarks;
 }
 export interface BrowserBookmarks {
@@ -1523,6 +1531,44 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      */
     getNotificationsConfig(): Promise<NotificationsCustomManifestOptions | undefined>;
     _raiseAnalytics(events: AnalyticsEventInternal[]): Promise<void>;
+    /**
+     * Launches a bookmark in the browser window.
+     * @param payload
+     */
+    _launchBookmarkInternal: (payload: LaunchBookmarkPayload) => Promise<void>;
+    /**
+     * Updates companion dock favorites list.
+     * @param favorites
+     */
+    _updateDockFavoritesInternal: (favorites: DockEntry[]) => Promise<void>;
+    /**
+     * Updates companion dock content menu.
+     * @param contentMenu
+     */
+    _updateContentMenuInternal: (contentMenu: ContentMenuEntry[]) => Promise<void>;
+    /**
+     * Launches companion dock content menu item.
+     * @param id
+     */
+    _launchDockEntryInternal: (entry: DockEntry) => Promise<void>;
+    _setDockFavoritesInternal: (favorites: DockEntry[]) => Promise<void>;
+    _setDockWorkspaceButtonsOrderInternal: (favorites: WorkspacePanelButton[]) => Promise<void>;
+    _removeDockFavoriteInternal: (entry: DockEntry) => Promise<void>;
+    _addDockFavoriteInternal: (entry: DockEntry) => Promise<void>;
+    /**
+     * Navigates companion dock content menu to a specified folder.
+     * @param id
+     */
+    _navigateContentMenuInternal(id: string): Promise<void>;
+    /**
+     * Retrieves companion dock workspaces dropdown context menu.
+     */
+    _openDockWorkspacesContextMenuInternal(): Promise<BaseCustomDropdownItem[]>;
+    /**
+     * Handles companion dock workspaces dropdown context menu response.
+     * @param payload
+     */
+    _handleDockWorkspacesMenuResponseInternal(payload: any): Promise<void>;
     /**
      * The browser window factory for the Workspace Platform.
      */
@@ -1853,6 +1899,29 @@ export interface AnalyticsConfig {
 }
 export { SUPPORTED_LANGUAGES } from '@openfin/ui-library';
 export type Locale = Languages;
+/**
+ * Configures the workspace to self-host using an asar bundle at the
+ * specified path.
+ *
+ * @remarks Intended as a development tool - in production,
+ * use {@link WorkspaceAsarAssetConfig}.
+ */
+export type WorkspaceAsarPathConfig = {
+    /**
+     * Path of the asar bundle with which to self-host.
+     */
+    path: string;
+};
+/**
+ * Configures the workspace to self-host using the specified asar bundle
+ * app asset.
+ */
+export type WorkspaceAsarAssetConfig = {
+    /**
+     * App asset alias of the asar bundle with which to self-host.
+     */
+    alias: string;
+};
 /**
  * Configuration for initializing a Workspace platform.
  */
@@ -1978,6 +2047,10 @@ export interface WorkspacePlatformInitConfig {
      * Leave undefined to use OpenFin hosted Notification Center.
      */
     notifications?: NotificationsCustomManifestOptions;
+    /**
+     * Configuration for self-hosting of workspace assets.
+     */
+    workspaceAsar?: WorkspaceAsarAssetConfig | WorkspaceAsarPathConfig;
 }
 /**
  * Extend or replace default functionality in order to customize behavior of a Workspace Platform Provider.
@@ -2114,6 +2187,7 @@ export type WorkspacePlatformOverrideCallback = OpenFin.OverrideCallback<Workspa
  * @deprecated
  */
 export type BrowserOverrideCallback = WorkspacePlatformOverrideCallback;
+export type WorkspacePanelButton = Exclude<WorkspaceButton, 'store'> | 'contentMenu';
 /**
  * Configuration for initializing a Browser.
  */
@@ -2188,3 +2262,11 @@ export type TaskbarIcon = {
     dark: string;
     light: string;
 };
+/**
+ * Launch bookmark request payload
+ */
+export interface LaunchBookmarkPayload {
+    bookmark: BookmarkNode;
+    sourceIdentity: OpenFin.Identity;
+    sourceEvent: Pick<MouseEvent, 'ctrlKey' | 'metaKey' | 'shiftKey'>;
+}

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

@@ -5,8 +5,6 @@ interface HotkeyOverrides {
     toggleHomeVisibility: string;
 }
 export interface Overrides {
-    disableBrowserNewPageButton: boolean;
-    enableWorkspaceDock: boolean;
     hotkeys: HotkeyOverrides;
     style: StyleOverrides;
     browserWindowTitle: string;

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

@@ -34,7 +34,8 @@ declare enum GeneralBrowserChannelActions {
     SetSelectedScheme = "set-selected-scheme",
     ShowBrowserIndicator = "show-browser-indicator",
     SetSelectedLanguage = "set-selected-language",
-    RefreshBookmarksInternal = "refresh-bookmarks"
+    RefreshBookmarksInternal = "refresh-bookmarks",
+    GetLayoutsWithSelectedViewsInternal = "get-layouts-with-selected-views"
 }
 /**
  * All of the remote procedures that can be called in the
@@ -53,7 +54,15 @@ export declare enum PageChannelAction {
     IsDetachingPages = "is-detaching-pages",
     IsActivePageChanging = "is-active-page-changing"
 }
+export declare enum CompanionDockChannelAction {
+    UpdateFavoriteEntries = "update-favorite-entries",
+    UpdateContentMenu = "update-content-menu",
+    NavigateContentMenu = "navigate-content-menu"
+}
 export declare const BrowserChannelAction: {
+    UpdateFavoriteEntries: CompanionDockChannelAction.UpdateFavoriteEntries;
+    UpdateContentMenu: CompanionDockChannelAction.UpdateContentMenu;
+    NavigateContentMenu: CompanionDockChannelAction.NavigateContentMenu;
     GetPages: PageChannelAction.GetPages;
     GetActivePageForWindow: PageChannelAction.GetActivePageForWindow;
     AttachPagesToWindow: PageChannelAction.AttachPagesToWindow;
@@ -76,6 +85,7 @@ export declare const BrowserChannelAction: {
     ShowBrowserIndicator: GeneralBrowserChannelActions.ShowBrowserIndicator;
     SetSelectedLanguage: GeneralBrowserChannelActions.SetSelectedLanguage;
     RefreshBookmarksInternal: GeneralBrowserChannelActions.RefreshBookmarksInternal;
+    GetLayoutsWithSelectedViewsInternal: GeneralBrowserChannelActions.GetLayoutsWithSelectedViewsInternal;
 };
 export type BrowserChannelAction = typeof BrowserChannelAction;
 export {};

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

@@ -73,7 +73,18 @@ export declare enum WorkspacePlatformChannelAction {
     GetCuratedContentInternal = "getCuratedContentInternal",
     HandleRequestNavigationInternal = "handleRequestNavigationInternal",
     RefreshBookmarksInternal = "refreshBookmarksInternal",
-    GetNotificationsConfig = "getNotificationsConfig"
+    LaunchBookmarkInternal = "launchBookmarkInternal",
+    GetNotificationsConfig = "getNotificationsConfig",
+    UpdateDockFavoritesInternal = "updateDockFavoritesInternal",
+    UpdateContentMenuInternal = "updateContentMenuInternal",
+    LaunchDockEntryInternal = "launchDockEntryInternal",
+    SetDockFavoritesOrderInternal = "setDockFavoritesOrderInternal",
+    NavigateContentMenuInternal = "navigateContentMenuInternal",
+    SetDockWorkspaceButtonsOrderInternal = "setDockWorkspaceButtonsOrderInternal",
+    GetDockWorkspacesContextMenuInternal = "getDockWorkspacesContextMenuInternal",
+    HandleDockWorkspacesMenuResponseInternal = "handleDockWorkspacesMenuResponseInternal",
+    RemoveDockFavoriteInternal = "removeDockFavoriteInternal",
+    AddDockFavoriteInternal = "addDockFavoriteInternal"
 }
 export type PlatFormSupportedFeatures = boolean | {
     isWorkspacePlatform: boolean;

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

@@ -1,6 +1,7 @@
 import type { DefaultTheme } from 'styled-components';
 import type OpenFin from '@openfin/core';
 import { ColorSchemeType, ThemeSet } from '@openfin/ui-library';
+import { Palette } from '@openfin/ui-library';
 import { ColorSchemeOptionType } from '../../../client-api-platform/src/shapes';
 export type WorkspaceComponentSetSelectedSchemePayload = {
     newScheme: ColorSchemeOptionType;
@@ -39,7 +40,7 @@ export interface BaseThemeOptions {
     label: string;
     logoUrl?: string;
 }
-export interface CustomThemeOptions extends BaseThemeOptions {
+export type CustomThemeOptions = BaseThemeOptions & {
     palette: CustomPaletteSet;
     /**
      * NOTE: Only used in Notifications
@@ -65,8 +66,8 @@ export interface CustomThemeOptions extends BaseThemeOptions {
      * ```
      */
     notificationIndicatorColors?: Record<string, NotificationIndicatorColorsSet>;
-}
-export interface CustomThemeOptionsWithScheme extends BaseThemeOptions {
+};
+export type CustomThemeOptionsWithScheme = BaseThemeOptions & {
     /**
      * The default color scheme for this theme.
      *
@@ -119,7 +120,7 @@ export interface CustomThemeOptionsWithScheme extends BaseThemeOptions {
      * ```
      */
     notificationIndicatorColors?: NotificationIndicatorColorsWithScheme;
-}
+};
 export type CustomThemes = (CustomThemeOptions | CustomThemeOptionsWithScheme)[];
 export interface PreloadedThemeData {
     themes: CustomThemes;
@@ -247,3 +248,4 @@ export declare const computeThemes: (customThemes: CustomThemes, storedScheme?:
 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'>>;
+export declare const getComputedBackgroundColor: (paletteKey: keyof typeof Palette, defaultColor?: string) => Promise<string>;

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

@@ -45,5 +45,5 @@ type EventTypeTypes = {
      */
     '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 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, addListenerWithUUID: (uuid: string) => <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/brand/default-brand.d.ts

@@ -0,0 +1,8 @@
+export declare const defaultBrandIcons: {
+    light: {
+        symbol: string;
+    };
+    dark: {
+        symbol: string;
+    };
+};

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

@@ -1,6 +1,6 @@
 import React from 'react';
 import { SizeType } from '@openfin/ui-library';
-export interface Props {
+export interface BaseButtonProps extends React.HTMLAttributes<HTMLButtonElement> {
     /**
      * Icon to be shown for the control.
      *
@@ -26,8 +26,6 @@ export interface Props {
     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 */
@@ -51,5 +49,5 @@ export interface Props {
  *
  * 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>>;
+declare const BaseButton: React.ForwardRefExoticComponent<BaseButtonProps & React.RefAttributes<HTMLButtonElement>>;
 export default BaseButton;

package/common/src/components/CloseButton/CloseButtonLarge.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { BaseButtonProps } from '../BaseButton/BaseButton';
+declare const CloseButtonLarge: (props: Omit<BaseButtonProps, 'children'>) => JSX.Element;
+export default CloseButtonLarge;

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

@@ -1,5 +1,5 @@
 /// <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, {
+export declare const StyledIcon: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("@openfin/ui-library").IconProps & import("react").RefAttributes<HTMLDivElement>>, import("styled-components").DefaultTheme, {
     disabled?: boolean;
     isEnterprise?: boolean;
     windowFocused?: boolean;

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

@@ -1,3 +1,8 @@
 import { OpenFin } from '@openfin/core';
 import { BookmarkItemContextMenuItemTemplate } from '../../../client-api-platform/src/shapes';
+import { BookmarkFolder } from './bookmarks';
+export declare const getSortedBookmarkFoldersContextMenuOptions: (bookmarkFolders: BookmarkFolder[], checkedNodeId: string, separators?: {
+    afterAllBookmarks?: boolean;
+    afterFavorites?: boolean;
+}) => BookmarkItemContextMenuItemTemplate[];
 export declare const getBookmarkItemContextMenuTemplate: (callerIdentity: OpenFin.Identity, bookmarkId: string) => Promise<BookmarkItemContextMenuItemTemplate[]>;

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

@@ -5,8 +5,12 @@ export type BookmarkFolder = {
     id: string;
     title: string;
 };
+export type CategorizedBookmarkSearchResults = {
+    bookmarksInFolder: BookmarkNode[];
+    bookmarksOutsideFolder: BookmarkNode[];
+};
+export declare const getBookmarkNodeTitle: (title: string) => string;
+export declare const categorizeSearchResults: (bookmarks: BookmarkNode[], folderId: string) => CategorizedBookmarkSearchResults;
 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 collectFolders: (nodes: BookmarkNode[]) => BookmarkFolder[];
 export declare const getBookmarkFoldersList: (rootNode: BookmarkNode) => BookmarkFolder[];

package/common/src/utils/browser-base-url.d.ts

@@ -1,6 +1,7 @@
+export declare function setLocalBrowserUrl(url: string): void;
 /**
  * Get the browser base url override if it exists
  *
  * @returns The browser base url override if it exists, otherwise null
  */
-export declare function getBrowserBaseUrl(): Promise<string | null>;
+export declare function getBrowserBaseUrl(): Promise<string>;

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

@@ -0,0 +1,3 @@
+export declare const DOCK_COMPANION_HEIGHT = 40;
+export declare const DOCK_COMPANION_WIDTH = 728;
+export declare const DOCK_COMPANION_TOP = 150;

package/common/src/utils/menu-window-provider.d.ts

@@ -18,6 +18,7 @@ export interface ModalResponseEvent {
 export declare const menuEvents: {
     emit: <EventKey extends keyof MenuEventTypes>(event: EventKey, ...payload: MenuEventTypes[EventKey]) => Promise<void>;
     addListener: <EventKey_1 extends keyof MenuEventTypes>(event: EventKey_1, listener: (...payload: MenuEventTypes[EventKey_1]) => void) => void;
+    addListenerWithUUID: (uuid: string) => <EventKey_1 extends keyof MenuEventTypes>(event: EventKey_1, listener: (...payload: MenuEventTypes[EventKey_1]) => void) => void;
     removeListener: <EventKey_2 extends keyof MenuEventTypes>(event: EventKey_2, listener: (...payload: MenuEventTypes[EventKey_2]) => void) => void;
     once: <EventKey_3 extends keyof MenuEventTypes>(event: EventKey_3, listener: (...payload: MenuEventTypes[EventKey_3]) => void) => void;
 };

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

@@ -1,5 +1,12 @@
 import type OpenFin from '@openfin/core';
 import { ResponseModalConfig } from './menu-config';
+import { Point } from './window';
+/**
+ *
+ * @param parentWindowIdentity parent window for the modal
+ * @returns a point (top/left) that represents the center of the monitor the parent window is on
+ */
+export declare const getCenterOfParentWindowMonitor: (parentWindowIdentity?: OpenFin.Identity) => Promise<Point>;
 /**
  * returns the correct bounds for the response modal to be displayed at
  * this will return the correct bounds regardless of whether the window is maximized

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

@@ -1,5 +1,4 @@
 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';
@@ -53,16 +52,14 @@ export type BookmarkButtonPayload = {
 export type ContextMenuChannelMessageData = {
     parentIdentity: OpenFin.Identity;
     responseIdentity: OpenFin.Identity;
-    anchorBehavior: AnchorBehavior;
     type: ContextMenuType;
     x: number;
     y: number;
-    payload: OpenFin.ShowPopupMenuOptions | {
+    anchorBehavior?: AnchorBehavior;
+    payload: (OpenFin.ShowPopupMenuOptions | {
         pageId: string;
-    } | BookmarkButtonPayload | {
-        dropdownOptions: Array<BookmarkFolder>;
-        width: number;
-        selected: BookmarkFolder;
+    } | BookmarkButtonPayload) & {
+        width?: number;
     };
 };
 export type SearchMenuChannelResponse = {

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

@@ -25,7 +25,8 @@ export declare enum PageRoute {
     EnterpriseBrowser = "/browser/enterprise/",
     EnterpriseContextMenu = "/browser/enterprise/context-menu/",
     EnterpriseBookmarkDialog = "/browser/enterprise/bookmark-dialog/",
-    DropdownMenu = "/browser/enterprise/dropdown-menu/"
+    DropdownMenu = "/browser/enterprise/dropdown-menu/",
+    EnterpriseDock = "/browser/enterprise/dock/"
 }
 export declare const Assets: {
     readonly IconOpenFinLogo: "/icons/openfinlogo.svg";

package/common/src/utils/shared-emitter.d.ts

@@ -6,6 +6,11 @@ export default function makeSharedEmitter<EventMap extends {
 }>(id: string): {
     emit: <EventKey extends keyof EventMap>(event: EventKey, ...payload: EventMap[EventKey]) => Promise<void>;
     addListener: <EventKey_1 extends keyof EventMap>(event: EventKey_1, listener: (...payload: EventMap[EventKey_1]) => void) => void;
+    /**
+     * Creates a listener for a particular UUID instead of ApplicationUUID.Workspace.
+     * @param uuid The UUID of the application to subscribe to.
+     */
+    addListenerWithUUID: (uuid: string) => <EventKey_1 extends keyof EventMap>(event: EventKey_1, listener: (...payload: EventMap[EventKey_1]) => void) => void;
     removeListener: <EventKey_2 extends keyof EventMap>(event: EventKey_2, listener: (...payload: EventMap[EventKey_2]) => void) => void;
     once: <EventKey_3 extends keyof EventMap>(event: EventKey_3, listener: (...payload: EventMap[EventKey_3]) => void) => void;
 };

package/common/src/utils/usage-register.d.ts

@@ -9,6 +9,7 @@ export interface RegisterUsageStatus {
 export declare enum ComponentName {
     Browser = "Browser",
     Dock = "Dock",
+    EnterpriseDock = "EnterpriseDock",
     Home = "Home",
     Notification = "Notification",
     Storefront = "Storefront",

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

@@ -13,7 +13,8 @@ export declare enum WindowName {
     EnterpriseContextMenu = "openfin-enterprise-context-menu",
     BrowserAddressSearchPrefix = "openfin-browser-menu-address-search-",
     EnterpriseBookmarkDialogWindow = "openfin-enterprise-bookmark-dialog",
-    DropdownMenu = "openfin-enterprise-dropdown-menu"
+    DropdownMenu = "openfin-enterprise-dropdown-menu",
+    DockCompanion = "openfin-dock-companion"
 }
 export interface WindowIdentity {
     uuid: ApplicationUUID | string;