@openfin/workspace 21.0.2 → 21.0.4

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

@@ -120,6 +120,12 @@ export type DockButton = {
      * Optional button identifier, if not provided will be automatically generated by the provider
      */
     id?: string;
+    /**
+     * Specifies button context menu, if present and has one of the options enabled, the button will have a context menu on right click.
+     */
+    contextMenu?: {
+        removeOption?: boolean;
+    };
 } & (DockButtonConfig | DockDropdownConfig);
 /**
  * The names of the buttons for the workspace components on the Dock.

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

@@ -1,13 +1,15 @@
 import { ContentMenuEntry } from '@openfin/ui-library';
-import type { DockEntry, WorkspacePanelButton } from '../../../client-api-platform/src/shapes';
+import type { DockCompanionButton, DockEntry } from '../../../client-api-platform/src/shapes';
 export declare const DockCompanionUpdatesPrefix = "dock-companion-updates";
+export declare const refreshDockBookmarksPanel: () => Promise<void>;
 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 setDefaultDockButtonsOrder: (defaultDockButtons: DockCompanionButton[]) => Promise<void>;
 export declare const getDockWorkspacesContextMenu: () => Promise<import("@common/api/action").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>;
+export declare const focusAndExpandSearchMenu: () => Promise<void>;

package/client-api-platform/src/init/browser-window-focus.d.ts

@@ -1,15 +1,18 @@
 import type OpenFin from '@openfin/core';
 /**
- * Get the last focused browser window.
- * @returns the last focused browser window.
+ * Gets the last focused browser window.
+ * @returns {Promise<OpenFin.Identity | undefined>} The last focused browser window identity, or undefined if not found.
+ * @throws {Error} If there is an error retrieving the last focused browser window.
  */
 export declare function getLastFocusedBrowserWindow(): Promise<OpenFin.Identity | undefined>;
 /**
- * Listen for a browser window to be focused.
- * When a browser window is focused, store it in local storage as the last focused browser window.
+ * Gets the last focused browser window that isn't minimized.
+ * @returns {Promise<OpenFin.Identity | undefined>} The last focused browser window identity that isn't minimized, or undefined if not found.
  */
-export declare function listenForBrowserWindowFocus(): Promise<void>;
+export declare function getLastFocusedUnminimizedBrowserWindow(): Promise<OpenFin.Identity | undefined>;
 /**
- * Stop listening for a browser window to be focused.
+ * Listen for a browser window to be focused or closed.
+ * When a browser window is focused, store it in local storage as the last focused browser window.
+ * When a browser window is closed, remove it from the LRU.
  */
-export declare function removeBrowserWindowFocusListener(): Promise<void>;
+export declare function listenForBrowserWindowFocus(): Promise<void>;

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

@@ -9,4 +9,4 @@ export declare const searchMenuIdentityBase: {
 /**
  * Applies default options to the creation of browser windows.
  */
-export declare function applyBrowserDefaults(options: OpenFin.PlatformWindowCreationOptions, initOptions: Pick<BrowserInitConfig, 'defaultWindowOptions' | 'defaultPageOptions' | 'defaultViewOptions'> | undefined, themeData?: PreloadedThemeData): Promise<OpenFin.PlatformWindowCreationOptions>;
+export declare function applyBrowserDefaults(options: OpenFin.PlatformWindowCreationOptions, initOptions: Pick<BrowserInitConfig, 'defaultWindowOptions' | 'defaultPageOptions' | 'defaultViewOptions' | 'browserIconSize'> | undefined, themeData?: PreloadedThemeData): Promise<OpenFin.PlatformWindowCreationOptions>;

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

@@ -1874,7 +1874,7 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      */
     _launchDockEntryInternal: (entry: DockEntry) => Promise<void>;
     _setDockFavoritesInternal: (favorites: DockEntry[]) => Promise<void>;
-    _setDockWorkspaceButtonsOrderInternal: (favorites: WorkspacePanelButton[]) => Promise<void>;
+    _setDefaultDockButtonsOrderInternal: (favorites: DockCompanionButton[]) => Promise<void>;
     _removeDockFavoriteInternal: (entry: DockEntry) => Promise<void>;
     _addDockFavoriteInternal: (entry: DockEntry) => Promise<void>;
     /**
@@ -1891,6 +1891,13 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      * @param payload
      */
     _handleDockWorkspacesMenuResponseInternal(payload: any): Promise<void>;
+    /**
+     *
+     * Finds a browser window with only a single tab on the landing page, brings it forward, and
+     * focuses and expands its search menu. If such a browser window doesn't exist, it will create one.
+     * @param payload
+     */
+    _focusAndExpandSearchInternal(): Promise<void>;
     /**
      * The browser window factory for the Workspace Platform.
      */
@@ -2154,7 +2161,7 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
     /** @internal */
     launchDockEntryInternal(entry: DockEntry): Promise<void>;
     /** @internal */
-    setDockWorkspaceButtonsOrderInternal(workspaceButtons: WorkspacePanelButton[]): Promise<void>;
+    setDefaultDockButtonsOrderInternal(workspaceButtons: DockCompanionButton[]): Promise<void>;
     /** @internal */
     setDockFavoritesOrderInternal(favorites: DockEntry[]): Promise<void>;
     /** @internal */
@@ -2163,6 +2170,8 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
     getDockWorkspacesContextMenuInternal(): Promise<BaseCustomDropdownItem[]>;
     /** @internal */
     handleDockWorkspacesMenuResponseInternal(payload: any): Promise<void>;
+    /** @internal */
+    focusAndExpandSearchInternal(): Promise<void>;
 }
 /**
  * The origins from which a custom action can be invoked
@@ -2445,12 +2454,13 @@ export interface CompanionDockConfig {
      * Favorites to be displayed in the dock
      */
     contentMenu?: ContentMenuEntry[];
-    workspacePanelButtons?: WorkspacePanelButton[];
+    defaultDockButtons?: DockCompanionButton[];
     /**
      * Taskbar Icon for the Browser Window. If light and dark icon are defined, then the taskbar icon will change when the scheme changes.
      */
     icon?: string | TaskbarIcon;
     title?: string;
+    windowType: 'enterprise' | undefined;
 }
 /**
  * Extend or replace default functionality in order to customize behavior of a Workspace Platform Provider.
@@ -2587,7 +2597,7 @@ export type WorkspacePlatformOverrideCallback = OpenFin.OverrideCallback<Workspa
  * @deprecated
  */
 export type BrowserOverrideCallback = WorkspacePlatformOverrideCallback;
-export type WorkspacePanelButton = Exclude<WorkspaceButton, 'store'> | 'contentMenu';
+export type DockCompanionButton = Exclude<WorkspaceButton, 'store'> | 'contentMenu' | 'bookmarks' | 'searchShortcut';
 /**
  * Content menu entry shape cloned and re-exported from UI Library.
  * @internal
@@ -2621,6 +2631,10 @@ export type DockEntry = {
     label: string;
     itemData?: any;
 };
+/**
+ * Configuration options for Browser window's icons.
+ */
+export type IconSize = 'large' | 'default';
 /**
  * Configuration for initializing a Browser.
  */
@@ -2640,6 +2654,13 @@ export interface BrowserInitConfig {
      * The platform title. UI friendly title for the platform in browser.
      */
     title?: string;
+    /**
+     * By default, the icons in the browser are displayed at the default size. If you
+     * want to display the icons at a larger size, set this property to 'large'. This
+     * will increase the size of the icons in the browser. If you have custom icons
+     * that are PNGs you will need to update these assets for best results.
+     */
+    browserIconSize?: IconSize;
     /**
      * Override workspace platform behavior
      *
@@ -2726,7 +2747,7 @@ export interface LaunchBookmarkPayload {
 type EnterpriseDockChannelProviderChannelActions = {
     'launch-entry': (entry: DockEntry) => void;
     'set-dock-favorites-order': (newFavorites: DockEntry[]) => void;
-    'set-dock-workspace-buttons-order': (newFavorites: WorkspacePanelButton[]) => void;
+    'set-default-dock-buttons-order': (newFavorites: DockCompanionButton[]) => void;
     'get-dock-workspaces-context-menu': () => BaseCustomDropdownItem[];
     'handle-dock-workspaces-menu-response': (payload: any) => void;
     'remove-favorite-entry': (entry: DockEntry) => void;

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

@@ -35,7 +35,8 @@ declare enum GeneralBrowserChannelActions {
     ShowBrowserIndicator = "show-browser-indicator",
     SetSelectedLanguage = "set-selected-language",
     RefreshBookmarksInternal = "refresh-bookmarks",
-    GetLayoutsWithSelectedViewsInternal = "get-layouts-with-selected-views"
+    GetLayoutsWithSelectedViewsInternal = "get-layouts-with-selected-views",
+    FocusAndExpandSearchInternal = "focus-and-expand-search"
 }
 /**
  * All of the remote procedures that can be called in the
@@ -105,6 +106,7 @@ export declare const BrowserChannelAction: {
     SetSelectedLanguage: GeneralBrowserChannelActions.SetSelectedLanguage;
     RefreshBookmarksInternal: GeneralBrowserChannelActions.RefreshBookmarksInternal;
     GetLayoutsWithSelectedViewsInternal: GeneralBrowserChannelActions.GetLayoutsWithSelectedViewsInternal;
+    FocusAndExpandSearchInternal: GeneralBrowserChannelActions.FocusAndExpandSearchInternal;
 };
 export type BrowserChannelAction = typeof BrowserChannelAction;
 export {};

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

@@ -82,11 +82,12 @@ export declare enum WorkspacePlatformChannelAction {
     LaunchDockEntryInternal = "launchDockEntryInternal",
     SetDockFavoritesOrderInternal = "setDockFavoritesOrderInternal",
     NavigateContentMenuInternal = "navigateContentMenuInternal",
-    SetDockWorkspaceButtonsOrderInternal = "setDockWorkspaceButtonsOrderInternal",
+    SetDefaultDockButtonsOrderInternal = "setDefaultDockButtonsOrderInternal",
     GetDockWorkspacesContextMenuInternal = "getDockWorkspacesContextMenuInternal",
     HandleDockWorkspacesMenuResponseInternal = "handleDockWorkspacesMenuResponseInternal",
     RemoveDockFavoriteInternal = "removeDockFavoriteInternal",
-    AddDockFavoriteInternal = "addDockFavoriteInternal"
+    AddDockFavoriteInternal = "addDockFavoriteInternal",
+    FocusAndExpandSearchInternal = "focusAndExpandSearchInternal"
 }
 export type PlatFormSupportedFeatures = boolean | {
     isWorkspacePlatform: boolean;

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

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

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

@@ -1,7 +1,9 @@
 import type OpenFin from '@openfin/core';
 import { BrowserInitConfig } from '../../../client-api-platform/src/shapes';
+export declare const DEFAULT_ENTERPRISE_WINDOW_HEIGHT = 600;
+export declare const DEFAULT_ENTERPRISE_WINDOW_WIDTH = 900;
 export declare const isEnterpriseBrowser: (id?: OpenFin.Identity) => Promise<boolean>;
-export declare const isEnterpriseBrowserPlatform: (browserInitOptions?: BrowserInitConfig) => boolean;
+export declare const isEnterpriseBrowserPlatform: (browserInitOptions: BrowserInitConfig) => boolean;
 export declare function formatUrl(url: string): string;
 export declare const getIsEnterpriseBrowser: (id?: OpenFin.Identity) => Promise<boolean>;
 export declare const getMenuWindowWidth: () => Promise<number>;

package/common/src/utils/landing-page.d.ts

@@ -6,5 +6,11 @@ interface LandingPageUrls {
 export declare const getLandingPageUrls: (winIdentity?: OpenFin.Identity) => Promise<LandingPageUrls>;
 export declare const checkHasNewTabUrl: () => Promise<boolean>;
 export declare const getNewLandingTabViewOptions: (target: OpenFin.Identity) => Promise<OpenFin.PlatformViewCreationOptions>;
+/**
+ * Makes a new landing page.
+ *
+ * If winIdentity is specified, it uses the newPageUrl defined by the browser window options.
+ * Otherwise, if the platform is Enterprise, it will use the landing page URL.
+ */
 export declare const makeNewLandingPage: (winIdentity?: OpenFin.Identity) => Promise<import("@client-platform/shapes").PageWithUpdatableRuntimeAttribs>;
 export {};

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

@@ -53,3 +53,9 @@ export declare const getIsWindowMaximizedOnWindows10Or11: (window: OpenFin.Windo
  * @returns A promise that resolves to the current window bounds.
  */
 export declare const getCurrentBounds: (windowIdentity: OpenFin.Identity) => Promise<OpenFin.WindowBounds>;
+export declare function getBoundsCenteredAndFitOnMonitor(height: number, width: number, monitorRect?: OpenFin.MonitorDetails): Promise<{
+    height: number;
+    width: number;
+    left: number;
+    top: number;
+}>;

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

@@ -12,7 +12,7 @@ type SearchViewExpansionState = {
     shouldExpand: boolean;
 };
 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 SearchMenuChannelUpdateState = {
+export type SearchMenuChannelMessage = {
     selectedViews: OpenFin.Identity[];
     openViews: OpenFin.Identity[];
     windowId: OpenFin.Identity;
@@ -21,6 +21,8 @@ export type SearchMenuChannelUpdateState = {
     shouldExpandMenu?: SearchViewExpansionState;
     offsetLeft?: number;
     type: 'update-search-menu-state';
+} | {
+    type: 'ready';
 };
 export type BrowserSearchMenuKeyboardEvent = {
     type: string;