@openfin/workspace-platform 24.1.0 → 24.1.2

package/client-api/src/internal/providers.d.ts

@@ -1,10 +1,36 @@
 import { ProviderType } from '../../../common/src/api/provider';
+/**
+ * Error thrown when attempting to use a provider that is not registered.
+ * @example
+ * ```typescript
+ * throw new ProviderNotRegisteredError('dock', 'my-dock-id');
+ * // Error: Dock Provider. Dock Provider with id my-dock-id is not currently registered.
+ * ```
+ */
 export declare class ProviderNotRegisteredError extends Error {
     constructor(providerType: ProviderType, id?: string);
 }
+/**
+ * Error thrown when attempting to register a provider that is already registered.
+ * Call `deregister` before registering again.
+ * @example
+ * ```typescript
+ * throw new ProviderAlreadyRegisteredError('home', 'my-home-id');
+ * // Error: Home Provider. Home Provider with id my-home-id is already registered.
+ * ```
+ */
 export declare class ProviderAlreadyRegisteredError extends Error {
     constructor(providerType: ProviderType, id?: string);
 }
+/**
+ * Error thrown when failing to retrieve a provider by ID.
+ * Typically thrown by `getProviderOrFail` when the requested provider does not exist.
+ * @example
+ * ```typescript
+ * throw new FailedToGetProviderError('storefront', 'unknown-id');
+ * // Error: Failed to get Storefront Provider. Storefront Provider with id unknown-id is not currently registered.
+ * ```
+ */
 export declare class FailedToGetProviderError extends Error {
     constructor(providerType: ProviderType, id?: string);
 }

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

@@ -1,5 +1,5 @@
 import type OpenFin from '@openfin/core';
-import { EnterpriseMenuType } from '../../../../common/src/utils/popup-window';
+import { PopupWindowMenuType } from '../../../../common/src/utils/popup-window';
 import { InternalOpenGlobalContextMenuRequest, InternalOpenPageTabContextMenuRequest, OpenGlobalContextMenuPayload, OpenPageTabContextMenuPayload, OpenSaveButtonContextMenuPayload, OpenSaveButtonContextMenuRequest, OpenViewTabContextMenuPayload, OpenViewTabContextMenuRequest, WorkspacePlatformProvider } from '../../../../client-api-platform/src/shapes';
 /**
  * Enum representing the possible anchor behaviors for positioning context menus.
@@ -17,7 +17,7 @@ export declare enum AnchorBehavior {
     Center = 4
 }
 type ContextMenuPayload = OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload;
-export declare const openCommonContextMenu: (payload: ContextMenuPayload, _callerIdentity: OpenFin.Identity, type?: EnterpriseMenuType, anchorBehavior?: AnchorBehavior) => Promise<void>;
+export declare const openCommonContextMenu: (payload: ContextMenuPayload, _callerIdentity: OpenFin.Identity, type?: PopupWindowMenuType, anchorBehavior?: AnchorBehavior) => Promise<void>;
 export declare function openGlobalContextMenuInternal(this: WorkspacePlatformProvider, payload: InternalOpenGlobalContextMenuRequest & {
     identity: OpenFin.Identity;
 }, callerIdentity: OpenFin.Identity): Promise<void>;

package/client-api-platform/src/api/controllers/__tests__/theme-storage-controller-store.test.d.ts

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

package/client-api-platform/src/api/controllers/theme-storage-controller.d.ts

@@ -31,7 +31,8 @@ export declare class ThemeStorageController {
     private generatedPalettes?;
     private workspaceStorage?;
     private recreateFactory?;
-    constructor(providerStorage: Pick<Storage, 'getItem' | 'setItem'>);
+    private isLegacySinglePaletteTheme;
+    constructor(providerStorage: Pick<Storage, 'getItem' | 'setItem' | 'removeItem'>);
     /**
      * Set the current Storage Proxy to enable Workspace Storage properties to be populated.
      */
@@ -63,6 +64,8 @@ export declare class ThemeStorageController {
     /**
      * Synchronize the current palette and scheme with workspace's storage instance if
      * storage based theming is enabled. Only syncs when user has explicitly selected a scheme.
+     *
+     * Wrapped in try/catch so it does not throw
      */
     trySynchronizeWorkspaceStorage: () => Promise<void>;
     /**
@@ -84,12 +87,23 @@ export declare class ThemeStorageController {
      * @param scheme 'light', 'dark' or 'system'.
      */
     setScheme(scheme: ColorSchemeOptionType): void;
+    /**
+     * Clears an explicit user scheme choice (e.g. from Appearance) so resolution falls back to theme default.
+     */
+    clearUserSelectedSchemePreference(): void;
+    setLegacySinglePaletteTheme(value: boolean): void;
     /**
      * Set the theme's default scheme from palette configuration
      * @param scheme The default scheme specified in the palette
      */
     setThemeDefaultScheme(scheme: ColorSchemeOptionType): void;
     setGeneratedPalettes(generatedPalettes: GeneratedPalettes): void;
+    /**
+     * Write the theme palette sheet to both in-memory state and providerStorage (namespaced localStorage)
+     * immediately. This ensures the theme is available for themeLoader on same-origin pages
+     * without waiting for the workspace storage proxy to be initialised.
+     */
+    setThemePaletteSheet(sheet: string): void;
     /**
      * Returns the current scheme
      * @returns 'light' | 'system' | 'dark'

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

@@ -26,10 +26,15 @@ export declare const getActivePageIdForWindow: (identity: OpenFin.Identity) => P
  *
  * If the name is not unique, it will append a number to the end of the name.
  *
+ * When `BrowserInitConfig.allowDuplicatePageTitles` is `true`, this function
+ * short-circuits and returns the supplied name (or the default title) as-is,
+ * without appending a numeric suffix.
+ *
  * @param initialName The initial name to test
- * @returns string: a unique page name
+ * @param allowDuplicatePageTitles Whether duplicate page titles are permitted
+ * @returns string: a unique page name (or the input unchanged when duplicates are allowed)
  */
-export declare function getUniquePageTitle(initialName?: string): Promise<string>;
+export declare function getUniquePageTitle(initialName?: string, allowDuplicatePageTitles?: boolean): Promise<string>;
 export declare function handleSaveModalOnPageClose({ page }: HandleSaveModalOnPageClosePayload): Promise<SaveModalOnPageCloseResult>;
 /**
  * Default implementation of shouldPageClose. If enableBeforeUnload isn't set to true, always returns True (proceed with close).

package/client-api-platform/src/api/theming.set-scheme.test.d.ts

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

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

@@ -3,7 +3,7 @@ export type StorageProxy = {
     setItem: (data: string, value: string) => Promise<void>;
     destroy: () => Promise<void>;
 };
-export declare const createStorageProxy: (url: string) => Promise<StorageProxy>;
+export declare const createStorageProxy: (url: string, isEnterprise: boolean) => Promise<StorageProxy>;
 /**
  * Ensure the workspace storage proxy window exists. Recreates it if it was previously destroyed
  * (e.g. when the last browser window closed with preventQuitOnLastWindowClosed true and a new

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

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

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

@@ -4,6 +4,10 @@ import type OpenFin from '@openfin/core';
  * @returns {Promise<OpenFin.Identity | undefined>} The last focused browser window identity, or undefined if not found.
  */
 export declare function getLastFocusedBrowserWindow(): Promise<OpenFin.Identity | undefined>;
+/**
+ * Gets all browser windows
+ */
+export declare function getAllBrowserWindows(): Promise<OpenFin.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.

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

@@ -35,4 +35,4 @@ import { WorkspacePlatformInitConfig } from '../../../client-api-platform/src/sh
  * ```
  * @param options options for configuring the platform.
  */
-export declare const init: ({ theme, customActions, language, ...rest }: WorkspacePlatformInitConfig) => Promise<OpenFin.Platform>;
+export declare const init: (config: WorkspacePlatformInitConfig) => Promise<OpenFin.Platform>;

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

@@ -4,4 +4,4 @@ import { BrowserInitConfig } from '../../../../client-api-platform/src/shapes';
 /**
  * Applies default options to the creation of browser windows.
  */
-export declare function applyBrowserDefaults(options: OpenFin.PlatformWindowCreationOptions, initOptions: Pick<BrowserInitConfig, 'defaultWindowOptions' | 'defaultPageOptions' | 'defaultViewOptions' | 'browserIconSize'> | undefined, themeData?: PreloadedThemeData): Promise<OpenFin.PlatformWindowCreationOptions>;
+export declare function applyBrowserDefaults(options: OpenFin.PlatformWindowCreationOptions, initOptions: Pick<BrowserInitConfig, 'defaultWindowOptions' | 'defaultPageOptions' | 'defaultViewOptions' | 'browserIconSize' | 'allowDuplicatePageTitles'> | undefined, themeData?: PreloadedThemeData): Promise<OpenFin.PlatformWindowCreationOptions>;

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

@@ -1,4 +1,4 @@
 import OpenFin from '@openfin/core';
 import type { AttachedPage, AttachedPageInternal } from '../../../../common/src/api/pages/shapes';
 import { BrowserInitConfig } from '../..';
-export declare const applyPageDefaults: (pages: AttachedPage[], initOptions?: Pick<BrowserInitConfig, "defaultPageOptions" | "defaultViewOptions" | "defaultWindowOptions">, overrideOptions?: OpenFin.PlatformWindowCreationOptions) => Promise<AttachedPageInternal[]>;
+export declare const applyPageDefaults: (pages: AttachedPage[], initOptions?: Pick<BrowserInitConfig, "defaultPageOptions" | "defaultViewOptions" | "defaultWindowOptions" | "allowDuplicatePageTitles">, overrideOptions?: OpenFin.PlatformWindowCreationOptions) => Promise<AttachedPageInternal[]>;

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

@@ -4,10 +4,11 @@ export declare const getThemes: () => CustomThemes | null;
 export declare const getGeneratedPalettes: () => GeneratedPalettes;
 export declare const getThemePaletteSheet: () => string;
 export declare const getNotificationIndicatorColorsInternal: () => NotificationIndicatorColorsParsed;
+export declare const isThemePreInitialised: () => boolean;
 /**
  * initTheming()
  * @param customThemes array of theme objects
- * Accepts an array of CustomThemes objects and stores it
- * @returns array of custom theme objects
+ * Accepts an array of CustomThemes objects and stores it.
+ * Sets themePreInitialised to true so subsequent calls are no-ops.
  */
-export default function initTheming(customThemes: CustomThemes | undefined): Promise<void>;
+export declare const initTheming: (customThemes: CustomThemes | undefined) => Promise<void>;

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

@@ -1,5 +1,6 @@
 import type OpenFin from '@openfin/core';
 import type { IconProps, IconType, Languages } from '@openfin/ui-library';
+import type { WorkspaceIndicatorConfig } from '../../common/src/utils/indicators/workspace-indicators';
 import type { AnalyticsEvent } from '../../common/src/utils/usage-register';
 import type { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 import type { AddDefaultPagePayload, AttachedPage, BookmarkNode, CopyPagePayload, HandlePagesAndWindowClosePayload, HandlePagesAndWindowCloseResult, HandleSaveModalOnPageClosePayload, Page, PageLayoutsWithSelectedViews, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult, SetActivePageForWindowPayload, ShouldPageClosePayload, ShouldPageCloseResult, ViewsPreventingUnloadPayload } from '../../common/src/api/pages/shapes';
@@ -154,7 +155,7 @@ export declare enum PageTabContextMenuOptionType {
     Rename = "Rename",
     Save = "Save",
     SaveAs = "Save As",
-    NewPage = "New Page",
+    NewPage = "New Page",// Enterprise
     DeletePage = "Delete Page",// Enterprise
     SaveWorkspaceAs = "SaveWorkspaceAs",// Enterprise
     Refresh = "Refresh",// Enterprise
@@ -615,6 +616,19 @@ export interface BrowserCreateViewRequest extends OpenFin.PlatformViewCreationOp
 export interface BrowserViewState extends OpenFin.ViewState {
     workspacePlatform?: BrowserWorkspacePlatformViewOptions;
 }
+/**
+ * Enables or disables the tab-search chevron button for a specific tab location.
+ */
+export interface TabSearchLocationOptions {
+    enabled: boolean;
+}
+/**
+ * Configures where tab-search chevron buttons should be shown in a browser window.
+ */
+export interface TabSearchButtonOptions {
+    pageTabs?: TabSearchLocationOptions;
+    viewTabs?: TabSearchLocationOptions;
+}
 export interface BrowserWorkspacePlatformWindowOptions {
     /** For internal usage.  Defaults to 'browser' when Browser is enabled when the WorkspacePlatform is initialized.  In order to use
      * non-Browser layout windows ('platform' windows) in a Browser-enabled workspace platform, set windowType to `platform`. In that instance, the other properties
@@ -664,6 +678,32 @@ export interface BrowserWorkspacePlatformWindowOptions {
         minWidth?: string;
         maxWidth?: string;
     };
+    /**
+     * Controls whether tab-search chevron buttons are shown for page tabs and view tabs.
+     *
+     * By default, both locations are disabled unless explicitly enabled.
+     *
+     * @example
+     * ```ts
+     * workspacePlatform: {
+     *   tabSearchButton: {
+     *     viewTabs: { enabled: true },
+     *     pageTabs: { enabled: true }
+     *   }
+     * }
+     * ```
+     *
+     * @example
+     * ```ts
+     * workspacePlatform: {
+     *   tabSearchButton: {
+     *     viewTabs: { enabled: true },
+     *     // pageTabs omitted: disabled
+     *   }
+     * }
+     * ```
+     */
+    tabSearchButton?: TabSearchButtonOptions;
     /**
      * Accessibility options for the browser window.
      * These options override the default accessibility options set at the platform or browser initialization level.
@@ -2304,6 +2344,26 @@ export type WorkspacePlatformOverrideCallback = OpenFin.OverrideCallback<Workspa
  * @deprecated
  */
 export type BrowserOverrideCallback = WorkspacePlatformOverrideCallback;
+/**
+ * Content menu entry shape cloned and re-exported from UI Library.
+ */
+export type ContentMenuEntry = {
+    bookmarked?: boolean;
+} & ({
+    type: 'folder';
+    id: string;
+    label: string;
+    children: ContentMenuEntry[];
+} | {
+    type: 'item';
+    id: string;
+    icon: string | {
+        dark: string;
+        light: string;
+    };
+    label: string;
+    itemData: any;
+});
 export type LaunchDockEntryPayload = {
     entry: DockEntry;
     sourceEvent?: Pick<MouseEvent, 'ctrlKey' | 'metaKey' | 'shiftKey'>;
@@ -2311,6 +2371,27 @@ export type LaunchDockEntryPayload = {
 export type BookmarkDockEntryPayload = {
     entry: DockEntry;
 };
+/**
+ * Represents dock entry for favorites
+ */
+export type DockEntry = {
+    type: 'folder';
+    id: string;
+    label: string;
+    icon?: string | {
+        dark: string;
+        light: string;
+    };
+} | {
+    type: 'item';
+    id: string;
+    icon: string | {
+        dark: string;
+        light: string;
+    };
+    label: string;
+    itemData?: any;
+};
 /**
  * Configuration options for Browser window's icons.
  */
@@ -2376,6 +2457,32 @@ export interface BrowserInitConfig {
      * https://developer.openfin.co/docs/javascript/stable/classes/OpenFin.InteropBroker.html
      */
     interopOverride?: OpenFin.OverrideCallback<OpenFin.InteropBroker, OpenFin.InteropBroker>;
+    /**
+     * When true, allows multiple pages to share the same title across browser
+     * windows. No numeric suffixes are appended and attach/add operations
+     * will not reject on title collision. `pageId` remains the unique
+     * identifier for all page operations.
+     *
+     * Defaults to `false` (current unique-title behavior preserved).
+     */
+    allowDuplicatePageTitles?: boolean;
+    /**
+     * Opt-in suppression flags for workspace success indicators.
+     * Both flags default to `false`; existing platforms see no behaviour change.
+     *
+     * @example
+     * ```ts
+     * await WorkspacePlatform.init({
+     *   browser: {
+     *     indicators: {
+     *       suppressWorkspaceSwitched: true,
+     *       suppressWorkspaceSaved: true,
+     *     },
+     *   },
+     * });
+     * ```
+     */
+    indicators?: WorkspaceIndicatorConfig;
 }
 interface WorkspaceMetadata {
     APIVersion: string;

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

@@ -61,11 +61,6 @@ export declare const updatePageForWindow: (payload: ExtendedUpdatePageForWindowP
  * @param identity the identity of the window to save the pages of in window options.
  */
 export declare const updatePagesWindowOptions: (identity: OpenFin.Identity) => Promise<void>;
-/**
- * Check if the window identity is currently detaching pages.
- * @param identity the OF window identity to check.
- */
-export declare const isDetachingPages: (identity: OpenFin.Identity) => Promise<boolean>;
 /**
  * Check if the window identity is in the middle of changing active pages.
  * @param identity the OF window identity to check.

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

@@ -32,8 +32,12 @@ export interface Page {
     panels?: PanelConfig[];
     /** Used to define the context group for the page */
     contextGroup?: string;
+    /** When true, view tab headers within this Supertab are hidden. */
+    viewTabsHidden?: boolean;
     /** Optional property to attach custom metadata to the page object, such as version or timestamp. Must be serializable. */
     customData?: any;
+    /** True when this page is an admin-published supertab. */
+    isPublished?: boolean;
 }
 type AttachedPageMetadata = {
     /** The window the page is currently attached to. */

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

@@ -52,7 +52,6 @@ export declare enum PageChannelAction {
     ReorderPagesForWindow = "reorder-pages-for-window",
     UpdatePageForWindow = "update-page-for-window",
     UpdatePagesWindowOptions = "update-pages-window-options",
-    IsDetachingPages = "is-detaching-pages",
     IsActivePageChanging = "is-active-page-changing"
 }
 export declare enum CompanionDockChannelAction {
@@ -77,7 +76,6 @@ export declare const BrowserChannelAction: {
     ReorderPagesForWindow: PageChannelAction.ReorderPagesForWindow;
     UpdatePageForWindow: PageChannelAction.UpdatePageForWindow;
     UpdatePagesWindowOptions: PageChannelAction.UpdatePagesWindowOptions;
-    IsDetachingPages: PageChannelAction.IsDetachingPages;
     IsActivePageChanging: PageChannelAction.IsActivePageChanging;
     CloseBrowserWindow: GeneralBrowserChannelActions.CloseBrowserWindow;
     QuitPlatform: GeneralBrowserChannelActions.QuitPlatform;

package/common/src/test/logger-mock.d.ts

@@ -0,0 +1,5 @@
+export declare const mockLogger: {
+    debug: jest.Mock<any, any, any>;
+    warn: jest.Mock<any, any, any>;
+    error: jest.Mock<any, any, any>;
+};

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

@@ -30,3 +30,10 @@ export declare const getWorkspaceOFApplication: () => OpenFin.Application;
  * @returns A Promise resolving to the application manifest
  */
 export declare const getCachedManifest: () => Promise<OpenFin.Manifest>;
+/**
+ * Gets application info, caching the result after the first call.
+ * Application info (manifestUrl, licenseKey, runtime version, etc.) never changes
+ * during the application lifecycle. Multiple callers (overrides, sentry, analytics)
+ * share a single IPC call.
+ */
+export declare const getCachedAppInfo: () => Promise<OpenFin.ApplicationInfo>;

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

@@ -1,7 +1,7 @@
 import type OpenFin from '@openfin/core';
 import { AnchorBehavior } from '../../../client-api-platform/src/api/context-menu';
 import { PageTabContextMenuItemTemplate, ViewTabContextMenuTemplate } from '../../../client-api-platform/src/shapes';
-import { EnterpriseMenuType } from './popup-window';
+import { PopupWindowMenuType } from './popup-window';
 export declare enum MenuItemType {
     Label = "normal",
     Separator = "separator",
@@ -13,7 +13,7 @@ export type ShowContextMenuResponse = OpenFin.MenuResult & {
     requestId?: string;
 };
 export declare function showContextMenu(opts: OpenFin.ShowPopupMenuOptions, win?: OpenFin.Window): Promise<ShowContextMenuResponse>;
-export declare const showEnterpriseContextMenu: (opts: OpenFin.ShowPopupMenuOptions, type: EnterpriseMenuType, anchorBehavior: AnchorBehavior, win?: OpenFin.Window) => Promise<ShowContextMenuResponse>;
+export declare const showEnterpriseContextMenu: (opts: OpenFin.ShowPopupMenuOptions, type: PopupWindowMenuType, anchorBehavior: AnchorBehavior, win?: OpenFin.Window) => Promise<ShowContextMenuResponse>;
 export declare const Separator: OpenFin.MenuItemTemplate;
 export declare const EmptyContextMenuItem: OpenFin.MenuItemTemplate;
 export declare const DefaultSaveMenuBounds: {

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

@@ -16,3 +16,6 @@ export declare const connectToEnterpriseContentChannel: (uuid: string) => Promis
 export declare const connectToEnterpriseModalChannel: (uuid: string) => Promise<OpenFin.ChannelClient>;
 export declare const createZoomControlsDialogChannel: () => Promise<OpenFin.ChannelProvider>;
 export declare const connectToZoomControlsDialogChannel: () => Promise<OpenFin.ChannelClient>;
+export declare const getTabSearchChannelName: () => string;
+export declare const createTabSearchChannel: () => Promise<OpenFin.ChannelProvider>;
+export declare const connectToTabSearchChannel: () => Promise<OpenFin.ChannelClient>;

package/common/src/utils/indicators/showIndicator.d.ts

@@ -50,6 +50,13 @@ export declare function showSuccess(payload: ShowSuccessPayload): Promise<void>;
  */
 export declare function showInfo(payload: ShowInfoPayload): Promise<void>;
 /**
- * Creates a window centered on monitor containing a success indicator for switching workspaces
+ * Creates a window centered on monitor containing a success indicator for switching workspaces.
+ * No-ops when `suppressWorkspaceSwitched` has been set via `BrowserInitConfig.indicators`.
  */
 export declare function showSwitchWorkspaceSuccess(): Promise<void>;
+/**
+ * Creates a success indicator for workspace save and save-as operations.
+ * No-ops when `suppressWorkspaceSaved` has been set via `BrowserInitConfig.indicators`.
+ * Rename operations are intentionally unaffected — use `showSuccess` directly for those.
+ */
+export declare const showWorkspaceSavedSuccess: (payload: ShowSuccessPayload) => Promise<void>;

package/common/src/utils/indicators/workspace-indicators.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Configuration for suppressing workspace success indicators.
+ */
+export interface WorkspaceIndicatorConfig {
+    /** Suppress the "Workspace Switched" indicator on all applyWorkspace calls. @default false */
+    suppressWorkspaceSwitched?: boolean;
+    /** Suppress the "Workspace Saved" indicator on regular workspace save only. Save-as and rename are unaffected. @default false */
+    suppressWorkspaceSaved?: boolean;
+}
+export declare const initWorkspaceIndicators: (config?: WorkspaceIndicatorConfig) => void;
+export declare const getSuppressWorkspaceSwitched: () => boolean;
+/** Returns true when the "Workspace Saved" indicator should be suppressed (save only; save-as and rename are unaffected). */
+export declare const getSuppressWorkspaceSaved: () => boolean;

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

@@ -1,4 +1,5 @@
 import type OpenFin from '@openfin/core';
+import { AnchorBehavior } from '../../../client-api-platform/src/api/context-menu';
 import { ResponseModalConfig } from './menu-config';
 import { Point } from './window';
 /**
@@ -59,3 +60,22 @@ export declare function getBoundsCenteredAndFitOnMonitor(height: number, width:
     left: number;
     top: number;
 }>;
+/**
+ * Calculates the final popup bounds relative to a parent window, accounting for:
+ * - Windows 10/11 maximized window shadow offset (Electron bug)
+ * - Anchor behavior (e.g. BottomRight, TopLeft)
+ * - Off-screen clamping to keep the popup within monitor bounds
+ *
+ * @param parentIdentity - The identity of the parent window.
+ * @param contentDimensions - The width and height of the popup content.
+ * @param position - The desired x/y position relative to the parent window.
+ * @param anchorBehavior - Optional anchor behavior to adjust positioning.
+ * @returns Bounds relative to the parent window, clamped to the nearest monitor.
+ */
+export declare const getPopupBoundsRelativeToParent: (parentIdentity: OpenFin.Identity, contentDimensions: {
+    width: number;
+    height: number;
+}, position: {
+    x: number;
+    y: number;
+}, anchorBehavior?: AnchorBehavior) => Promise<OpenFin.Bounds>;

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

@@ -39,19 +39,19 @@ export type BrowserSearchMenuKeyboardEvent = {
         altKey?: boolean;
     };
 };
-export declare enum EnterpriseMenuType {
+export declare enum PopupWindowMenuType {
     GlobalMenu = "global-menu",
     ContextMenu = "context-menu",
     RenameSupertab = "rename-supertab",
     AddEditBookmark = "add-edit-bookmark",
     DropdownMenu = "dropdown-menu",
-    ZoomControls = "zoom-controls"
+    TabSearch = "tab-search"
 }
 export type BookmarkButtonPayload = {
     selectedViewIdentity: OpenFin.Identity;
 };
-export type BaseEnterpriseMenuChannelMessage = {
-    type: EnterpriseMenuType;
+export type BasePopupMenuChannelMessage = {
+    type: PopupWindowMenuType;
     /**
      * The identity of the window the dialog/menu invocation came from.
      */
@@ -67,29 +67,35 @@ export type BaseEnterpriseMenuChannelMessage = {
     x: number;
     y: number;
 };
-export type ContextMenuChannelMessage = BaseEnterpriseMenuChannelMessage & {
-    type: EnterpriseMenuType.ContextMenu | EnterpriseMenuType.GlobalMenu;
+export type ContextMenuChannelMessage = BasePopupMenuChannelMessage & {
+    type: PopupWindowMenuType.ContextMenu | PopupWindowMenuType.GlobalMenu;
     /**
      * The unique request ID of the context menu invocation.
      */
     requestId: string;
     payload: OpenFin.ShowPopupMenuOptions;
 };
-export type BookmarkDialogChannelMessage = BaseEnterpriseMenuChannelMessage & {
-    type: EnterpriseMenuType.AddEditBookmark;
+export type BookmarkDialogChannelMessage = BasePopupMenuChannelMessage & {
+    type: PopupWindowMenuType.AddEditBookmark;
     payload: BookmarkButtonPayload;
 };
-export type ZoomControlsDialogPayload = {
-    selectedViewIdentity?: OpenFin.Identity;
-    zoomPercent?: number;
-    openedViaMouseClick?: boolean;
-};
-export type ZoomControlsDialogChannelMessage = BaseEnterpriseMenuChannelMessage & {
-    type: EnterpriseMenuType.ZoomControls;
-    payload: ZoomControlsDialogPayload;
+/** Sent from browser to zoom dialog window to position and hydrate UI (initial open or live sync). */
+export type ZoomControlsDialogStateMessage = {
+    /**
+     * The identity of the window the dialog/menu invocation came from.
+     */
+    parentIdentity: OpenFin.Identity;
+    x: number;
+    y: number;
+    payload: {
+        selectedViewIdentity?: OpenFin.Identity;
+        zoomPercent?: number;
+        openedViaMouseClick?: boolean;
+    };
 };
-export type DropdownMenuChannelMessage = BaseEnterpriseMenuChannelMessage & {
-    type: EnterpriseMenuType.DropdownMenu;
+export declare const ZOOM_DIALOG_CHANNEL_ACTION: "state";
+export type DropdownMenuChannelMessage = BasePopupMenuChannelMessage & {
+    type: PopupWindowMenuType.DropdownMenu;
     payload: {
         template: Array<OpenFin.MenuItemTemplate>;
         /**
@@ -98,8 +104,8 @@ export type DropdownMenuChannelMessage = BaseEnterpriseMenuChannelMessage & {
         width: number;
     };
 };
-export type RenameSupertabChannelMessage = BaseEnterpriseMenuChannelMessage & {
-    type: EnterpriseMenuType.RenameSupertab;
+export type RenameSupertabChannelMessage = BasePopupMenuChannelMessage & {
+    type: PopupWindowMenuType.RenameSupertab;
     payload: {
         /**
          * The pageId of the page being renamed.
@@ -107,6 +113,18 @@ export type RenameSupertabChannelMessage = BaseEnterpriseMenuChannelMessage & {
         pageId: string;
     };
 };
+export type TabSearchModalContent = {
+    variant: 'page' | 'view';
+    tabs: {
+        title: string;
+        id: string;
+    }[];
+};
+export type TabSearchChannelMessage = BasePopupMenuChannelMessage & {
+    type: PopupWindowMenuType.TabSearch;
+    requestId: string;
+    payload: TabSearchModalContent;
+};
 export type SearchMenuChannelResponse = {
     type: 'ready';
 } | {
@@ -135,5 +153,4 @@ export type SearchMenuChannelResponse = {
     type: 'single-provider-results-announcement';
     message: string;
 };
-export declare function showPopupWin<T extends keyof UserMenuParams>(parentWindow: OpenFin.Window, params: UserMenuParams[T], windowOpts: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
 export {};

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

@@ -31,6 +31,7 @@ declare enum BrowserRoute {
     EnterpriseAboutPage = "/popup-menu/about/",
     StorageProxy = "/storage-proxy",
     DropdownMenu = "/dropdown-menu/",
+    TabSearchModal = "/popup-menu/tab-search-modal/",
     EnterpriseDock = "/dock/",
     ZoomControlsDialog = "/zoom-controls-dialog/",
     DesktopSignalsModal = "/popup-menu/desktop-signals-modal/",
@@ -54,6 +55,7 @@ declare const PageRoute: {
     EnterpriseAboutPage: BrowserRoute.EnterpriseAboutPage;
     StorageProxy: BrowserRoute.StorageProxy;
     DropdownMenu: BrowserRoute.DropdownMenu;
+    TabSearchModal: BrowserRoute.TabSearchModal;
     EnterpriseDock: BrowserRoute.EnterpriseDock;
     ZoomControlsDialog: BrowserRoute.ZoomControlsDialog;
     DesktopSignalsModal: BrowserRoute.DesktopSignalsModal;

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

@@ -19,10 +19,12 @@ export declare enum WindowName {
     DockSaveWorkspaceMenu = "openfin-dock3-save-workspace-menu",
     DropdownMenu = "openfin-enterprise-dropdown-menu",
     EnterpriseContextMenu = "openfin-enterprise-context-menu",
+    TabSearchMenu = "openfin-browser-tab-search-menu",
     EnterpriseBookmarkDialogWindow = "openfin-enterprise-bookmark-dialog",
     ZoomControlsDialog = "here-zoom-controls-dialog",
     UpdateVersionModal = "here-update-version-modal",
     ApplyAndPublishModal = "here-apply-and-publish-modal",
+    PublishOnCloseModal = "here-publish-on-close-modal",
     DesktopSignalsModal = "here-desktop-signals-modal",
     IntentsResolverModal = "here-intents-resolver-modal"
 }
@@ -144,7 +146,6 @@ export declare function animateSize(width: number, height: number): Promise<void
  * @returns boolean
  */
 export declare const isBrowserWindow: (identity: OpenFin.Identity) => Promise<any>;
-export declare const isModalWindowExceptZoomDialog: (identity: OpenFin.Identity) => boolean;
 /**
  * Force document body size. Called when resizing or on scaling changes.
  */