@openfin/workspace-platform 24.1.0 → 24.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. package/client-api/src/internal/providers.d.ts +26 -0
  2. package/client-api-platform/src/api/context-menu/index.d.ts +2 -2
  3. package/client-api-platform/src/api/controllers/__tests__/theme-storage-controller-store.test.d.ts +2 -0
  4. package/client-api-platform/src/api/controllers/theme-storage-controller.d.ts +15 -1
  5. package/client-api-platform/src/api/pages/index.d.ts +7 -2
  6. package/client-api-platform/src/api/theming.set-scheme.test.d.ts +1 -0
  7. package/client-api-platform/src/api/utils.d.ts +1 -1
  8. package/client-api-platform/src/api/utils.test.d.ts +1 -0
  9. package/client-api-platform/src/init/browser-window-focus.d.ts +4 -0
  10. package/client-api-platform/src/init/override-callback/browser-defaults.d.ts +1 -1
  11. package/client-api-platform/src/init/override-callback/page-defaults.d.ts +1 -1
  12. package/client-api-platform/src/init/theming.d.ts +4 -3
  13. package/client-api-platform/src/shapes.d.ts +89 -0
  14. package/common/src/api/pages/attached.d.ts +0 -5
  15. package/common/src/api/pages/enterprise-shapes.d.ts +2 -0
  16. package/common/src/api/protocol/browser.d.ts +0 -2
  17. package/common/src/test/logger-mock.d.ts +5 -0
  18. package/common/src/utils/application.d.ts +7 -0
  19. package/common/src/utils/context-menu.d.ts +2 -2
  20. package/common/src/utils/enterprise-channels.d.ts +3 -0
  21. package/common/src/utils/modal-bounds.d.ts +20 -0
  22. package/common/src/utils/popup-window.d.ts +38 -21
  23. package/common/src/utils/route.d.ts +2 -0
  24. package/common/src/utils/window.d.ts +2 -1
  25. package/common/src/utils/workspace-modals.d.ts +3 -0
  26. package/externals.report.json +8 -8
  27. package/index.js +1 -2
  28. package/index.js.map +1 -1
  29. package/package.json +6 -2
  30. package/index.js.LICENSE.txt +0 -1
@@ -1,10 +1,36 @@
1
1
  import { ProviderType } from '../../../common/src/api/provider';
2
+ /**
3
+ * Error thrown when attempting to use a provider that is not registered.
4
+ * @example
5
+ * ```typescript
6
+ * throw new ProviderNotRegisteredError('dock', 'my-dock-id');
7
+ * // Error: Dock Provider. Dock Provider with id my-dock-id is not currently registered.
8
+ * ```
9
+ */
2
10
  export declare class ProviderNotRegisteredError extends Error {
3
11
  constructor(providerType: ProviderType, id?: string);
4
12
  }
13
+ /**
14
+ * Error thrown when attempting to register a provider that is already registered.
15
+ * Call `deregister` before registering again.
16
+ * @example
17
+ * ```typescript
18
+ * throw new ProviderAlreadyRegisteredError('home', 'my-home-id');
19
+ * // Error: Home Provider. Home Provider with id my-home-id is already registered.
20
+ * ```
21
+ */
5
22
  export declare class ProviderAlreadyRegisteredError extends Error {
6
23
  constructor(providerType: ProviderType, id?: string);
7
24
  }
25
+ /**
26
+ * Error thrown when failing to retrieve a provider by ID.
27
+ * Typically thrown by `getProviderOrFail` when the requested provider does not exist.
28
+ * @example
29
+ * ```typescript
30
+ * throw new FailedToGetProviderError('storefront', 'unknown-id');
31
+ * // Error: Failed to get Storefront Provider. Storefront Provider with id unknown-id is not currently registered.
32
+ * ```
33
+ */
8
34
  export declare class FailedToGetProviderError extends Error {
9
35
  constructor(providerType: ProviderType, id?: string);
10
36
  }
@@ -1,5 +1,5 @@
1
1
  import type OpenFin from '@openfin/core';
2
- import { EnterpriseMenuType } from '../../../../common/src/utils/popup-window';
2
+ import { PopupWindowMenuType } from '../../../../common/src/utils/popup-window';
3
3
  import { InternalOpenGlobalContextMenuRequest, InternalOpenPageTabContextMenuRequest, OpenGlobalContextMenuPayload, OpenPageTabContextMenuPayload, OpenSaveButtonContextMenuPayload, OpenSaveButtonContextMenuRequest, OpenViewTabContextMenuPayload, OpenViewTabContextMenuRequest, WorkspacePlatformProvider } from '../../../../client-api-platform/src/shapes';
4
4
  /**
5
5
  * Enum representing the possible anchor behaviors for positioning context menus.
@@ -17,7 +17,7 @@ export declare enum AnchorBehavior {
17
17
  Center = 4
18
18
  }
19
19
  type ContextMenuPayload = OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload;
20
- export declare const openCommonContextMenu: (payload: ContextMenuPayload, _callerIdentity: OpenFin.Identity, type?: EnterpriseMenuType, anchorBehavior?: AnchorBehavior) => Promise<void>;
20
+ export declare const openCommonContextMenu: (payload: ContextMenuPayload, _callerIdentity: OpenFin.Identity, type?: PopupWindowMenuType, anchorBehavior?: AnchorBehavior) => Promise<void>;
21
21
  export declare function openGlobalContextMenuInternal(this: WorkspacePlatformProvider, payload: InternalOpenGlobalContextMenuRequest & {
22
22
  identity: OpenFin.Identity;
23
23
  }, callerIdentity: OpenFin.Identity): Promise<void>;
@@ -0,0 +1,2 @@
1
+ import '@common/test/fin-mocks';
2
+ import '@common/test/logger-mock';
@@ -31,7 +31,8 @@ export declare class ThemeStorageController {
31
31
  private generatedPalettes?;
32
32
  private workspaceStorage?;
33
33
  private recreateFactory?;
34
- constructor(providerStorage: Pick<Storage, 'getItem' | 'setItem'>);
34
+ private isLegacySinglePaletteTheme;
35
+ constructor(providerStorage: Pick<Storage, 'getItem' | 'setItem' | 'removeItem'>);
35
36
  /**
36
37
  * Set the current Storage Proxy to enable Workspace Storage properties to be populated.
37
38
  */
@@ -63,6 +64,8 @@ export declare class ThemeStorageController {
63
64
  /**
64
65
  * Synchronize the current palette and scheme with workspace's storage instance if
65
66
  * storage based theming is enabled. Only syncs when user has explicitly selected a scheme.
67
+ *
68
+ * Wrapped in try/catch so it does not throw
66
69
  */
67
70
  trySynchronizeWorkspaceStorage: () => Promise<void>;
68
71
  /**
@@ -84,12 +87,23 @@ export declare class ThemeStorageController {
84
87
  * @param scheme 'light', 'dark' or 'system'.
85
88
  */
86
89
  setScheme(scheme: ColorSchemeOptionType): void;
90
+ /**
91
+ * Clears an explicit user scheme choice (e.g. from Appearance) so resolution falls back to theme default.
92
+ */
93
+ clearUserSelectedSchemePreference(): void;
94
+ setLegacySinglePaletteTheme(value: boolean): void;
87
95
  /**
88
96
  * Set the theme's default scheme from palette configuration
89
97
  * @param scheme The default scheme specified in the palette
90
98
  */
91
99
  setThemeDefaultScheme(scheme: ColorSchemeOptionType): void;
92
100
  setGeneratedPalettes(generatedPalettes: GeneratedPalettes): void;
101
+ /**
102
+ * Write the theme palette sheet to both in-memory state and providerStorage (namespaced localStorage)
103
+ * immediately. This ensures the theme is available for themeLoader on same-origin pages
104
+ * without waiting for the workspace storage proxy to be initialised.
105
+ */
106
+ setThemePaletteSheet(sheet: string): void;
93
107
  /**
94
108
  * Returns the current scheme
95
109
  * @returns 'light' | 'system' | 'dark'
@@ -26,10 +26,15 @@ export declare const getActivePageIdForWindow: (identity: OpenFin.Identity) => P
26
26
  *
27
27
  * If the name is not unique, it will append a number to the end of the name.
28
28
  *
29
+ * When `BrowserInitConfig.allowDuplicatePageTitles` is `true`, this function
30
+ * short-circuits and returns the supplied name (or the default title) as-is,
31
+ * without appending a numeric suffix.
32
+ *
29
33
  * @param initialName The initial name to test
30
- * @returns string: a unique page name
34
+ * @param allowDuplicatePageTitles Whether duplicate page titles are permitted
35
+ * @returns string: a unique page name (or the input unchanged when duplicates are allowed)
31
36
  */
32
- export declare function getUniquePageTitle(initialName?: string): Promise<string>;
37
+ export declare function getUniquePageTitle(initialName?: string, allowDuplicatePageTitles?: boolean): Promise<string>;
33
38
  export declare function handleSaveModalOnPageClose({ page }: HandleSaveModalOnPageClosePayload): Promise<SaveModalOnPageCloseResult>;
34
39
  /**
35
40
  * Default implementation of shouldPageClose. If enableBeforeUnload isn't set to true, always returns True (proceed with close).
@@ -0,0 +1 @@
1
+ import '@common/test/fin-mocks';
@@ -3,7 +3,7 @@ export type StorageProxy = {
3
3
  setItem: (data: string, value: string) => Promise<void>;
4
4
  destroy: () => Promise<void>;
5
5
  };
6
- export declare const createStorageProxy: (url: string) => Promise<StorageProxy>;
6
+ export declare const createStorageProxy: (url: string, isEnterprise: boolean) => Promise<StorageProxy>;
7
7
  /**
8
8
  * Ensure the workspace storage proxy window exists. Recreates it if it was previously destroyed
9
9
  * (e.g. when the last browser window closed with preventQuitOnLastWindowClosed true and a new
@@ -0,0 +1 @@
1
+ import '@common/test/fin-mocks';
@@ -4,6 +4,10 @@ import type OpenFin from '@openfin/core';
4
4
  * @returns {Promise<OpenFin.Identity | undefined>} The last focused browser window identity, or undefined if not found.
5
5
  */
6
6
  export declare function getLastFocusedBrowserWindow(): Promise<OpenFin.Identity | undefined>;
7
+ /**
8
+ * Gets all browser windows
9
+ */
10
+ export declare function getAllBrowserWindows(): Promise<OpenFin.Window[]>;
7
11
  /**
8
12
  * Gets the last focused browser window that isn't minimized.
9
13
  * @returns {Promise<OpenFin.Identity | undefined>} The last focused browser window identity that isn't minimized, or undefined if not found.
@@ -4,4 +4,4 @@ import { BrowserInitConfig } from '../../../../client-api-platform/src/shapes';
4
4
  /**
5
5
  * Applies default options to the creation of browser windows.
6
6
  */
7
- export declare function applyBrowserDefaults(options: OpenFin.PlatformWindowCreationOptions, initOptions: Pick<BrowserInitConfig, 'defaultWindowOptions' | 'defaultPageOptions' | 'defaultViewOptions' | 'browserIconSize'> | undefined, themeData?: PreloadedThemeData): Promise<OpenFin.PlatformWindowCreationOptions>;
7
+ export declare function applyBrowserDefaults(options: OpenFin.PlatformWindowCreationOptions, initOptions: Pick<BrowserInitConfig, 'defaultWindowOptions' | 'defaultPageOptions' | 'defaultViewOptions' | 'browserIconSize' | 'allowDuplicatePageTitles'> | undefined, themeData?: PreloadedThemeData): Promise<OpenFin.PlatformWindowCreationOptions>;
@@ -1,4 +1,4 @@
1
1
  import OpenFin from '@openfin/core';
2
2
  import type { AttachedPage, AttachedPageInternal } from '../../../../common/src/api/pages/shapes';
3
3
  import { BrowserInitConfig } from '../..';
4
- export declare const applyPageDefaults: (pages: AttachedPage[], initOptions?: Pick<BrowserInitConfig, "defaultPageOptions" | "defaultViewOptions" | "defaultWindowOptions">, overrideOptions?: OpenFin.PlatformWindowCreationOptions) => Promise<AttachedPageInternal[]>;
4
+ export declare const applyPageDefaults: (pages: AttachedPage[], initOptions?: Pick<BrowserInitConfig, "defaultPageOptions" | "defaultViewOptions" | "defaultWindowOptions" | "allowDuplicatePageTitles">, overrideOptions?: OpenFin.PlatformWindowCreationOptions) => Promise<AttachedPageInternal[]>;
@@ -4,10 +4,11 @@ export declare const getThemes: () => CustomThemes | null;
4
4
  export declare const getGeneratedPalettes: () => GeneratedPalettes;
5
5
  export declare const getThemePaletteSheet: () => string;
6
6
  export declare const getNotificationIndicatorColorsInternal: () => NotificationIndicatorColorsParsed;
7
+ export declare const isThemePreInitialised: () => boolean;
7
8
  /**
8
9
  * initTheming()
9
10
  * @param customThemes array of theme objects
10
- * Accepts an array of CustomThemes objects and stores it
11
- * @returns array of custom theme objects
11
+ * Accepts an array of CustomThemes objects and stores it.
12
+ * Sets themePreInitialised to true so subsequent calls are no-ops.
12
13
  */
13
- export default function initTheming(customThemes: CustomThemes | undefined): Promise<void>;
14
+ export declare const initTheming: (customThemes: CustomThemes | undefined) => Promise<void>;
@@ -615,6 +615,19 @@ export interface BrowserCreateViewRequest extends OpenFin.PlatformViewCreationOp
615
615
  export interface BrowserViewState extends OpenFin.ViewState {
616
616
  workspacePlatform?: BrowserWorkspacePlatformViewOptions;
617
617
  }
618
+ /**
619
+ * Enables or disables the tab-search chevron button for a specific tab location.
620
+ */
621
+ export interface TabSearchLocationOptions {
622
+ enabled: boolean;
623
+ }
624
+ /**
625
+ * Configures where tab-search chevron buttons should be shown in a browser window.
626
+ */
627
+ export interface TabSearchButtonOptions {
628
+ pageTabs?: TabSearchLocationOptions;
629
+ viewTabs?: TabSearchLocationOptions;
630
+ }
618
631
  export interface BrowserWorkspacePlatformWindowOptions {
619
632
  /** For internal usage. Defaults to 'browser' when Browser is enabled when the WorkspacePlatform is initialized. In order to use
620
633
  * non-Browser layout windows ('platform' windows) in a Browser-enabled workspace platform, set windowType to `platform`. In that instance, the other properties
@@ -664,6 +677,32 @@ export interface BrowserWorkspacePlatformWindowOptions {
664
677
  minWidth?: string;
665
678
  maxWidth?: string;
666
679
  };
680
+ /**
681
+ * Controls whether tab-search chevron buttons are shown for page tabs and view tabs.
682
+ *
683
+ * By default, both locations are disabled unless explicitly enabled.
684
+ *
685
+ * @example
686
+ * ```ts
687
+ * workspacePlatform: {
688
+ * tabSearchButton: {
689
+ * viewTabs: { enabled: true },
690
+ * pageTabs: { enabled: true }
691
+ * }
692
+ * }
693
+ * ```
694
+ *
695
+ * @example
696
+ * ```ts
697
+ * workspacePlatform: {
698
+ * tabSearchButton: {
699
+ * viewTabs: { enabled: true },
700
+ * // pageTabs omitted: disabled
701
+ * }
702
+ * }
703
+ * ```
704
+ */
705
+ tabSearchButton?: TabSearchButtonOptions;
667
706
  /**
668
707
  * Accessibility options for the browser window.
669
708
  * These options override the default accessibility options set at the platform or browser initialization level.
@@ -2304,6 +2343,26 @@ export type WorkspacePlatformOverrideCallback = OpenFin.OverrideCallback<Workspa
2304
2343
  * @deprecated
2305
2344
  */
2306
2345
  export type BrowserOverrideCallback = WorkspacePlatformOverrideCallback;
2346
+ /**
2347
+ * Content menu entry shape cloned and re-exported from UI Library.
2348
+ */
2349
+ export type ContentMenuEntry = {
2350
+ bookmarked?: boolean;
2351
+ } & ({
2352
+ type: 'folder';
2353
+ id: string;
2354
+ label: string;
2355
+ children: ContentMenuEntry[];
2356
+ } | {
2357
+ type: 'item';
2358
+ id: string;
2359
+ icon: string | {
2360
+ dark: string;
2361
+ light: string;
2362
+ };
2363
+ label: string;
2364
+ itemData: any;
2365
+ });
2307
2366
  export type LaunchDockEntryPayload = {
2308
2367
  entry: DockEntry;
2309
2368
  sourceEvent?: Pick<MouseEvent, 'ctrlKey' | 'metaKey' | 'shiftKey'>;
@@ -2311,6 +2370,27 @@ export type LaunchDockEntryPayload = {
2311
2370
  export type BookmarkDockEntryPayload = {
2312
2371
  entry: DockEntry;
2313
2372
  };
2373
+ /**
2374
+ * Represents dock entry for favorites
2375
+ */
2376
+ export type DockEntry = {
2377
+ type: 'folder';
2378
+ id: string;
2379
+ label: string;
2380
+ icon?: string | {
2381
+ dark: string;
2382
+ light: string;
2383
+ };
2384
+ } | {
2385
+ type: 'item';
2386
+ id: string;
2387
+ icon: string | {
2388
+ dark: string;
2389
+ light: string;
2390
+ };
2391
+ label: string;
2392
+ itemData?: any;
2393
+ };
2314
2394
  /**
2315
2395
  * Configuration options for Browser window's icons.
2316
2396
  */
@@ -2376,6 +2456,15 @@ export interface BrowserInitConfig {
2376
2456
  * https://developer.openfin.co/docs/javascript/stable/classes/OpenFin.InteropBroker.html
2377
2457
  */
2378
2458
  interopOverride?: OpenFin.OverrideCallback<OpenFin.InteropBroker, OpenFin.InteropBroker>;
2459
+ /**
2460
+ * When true, allows multiple pages to share the same title across browser
2461
+ * windows. No numeric suffixes are appended and attach/add operations
2462
+ * will not reject on title collision. `pageId` remains the unique
2463
+ * identifier for all page operations.
2464
+ *
2465
+ * Defaults to `false` (current unique-title behavior preserved).
2466
+ */
2467
+ allowDuplicatePageTitles?: boolean;
2379
2468
  }
2380
2469
  interface WorkspaceMetadata {
2381
2470
  APIVersion: string;
@@ -61,11 +61,6 @@ export declare const updatePageForWindow: (payload: ExtendedUpdatePageForWindowP
61
61
  * @param identity the identity of the window to save the pages of in window options.
62
62
  */
63
63
  export declare const updatePagesWindowOptions: (identity: OpenFin.Identity) => Promise<void>;
64
- /**
65
- * Check if the window identity is currently detaching pages.
66
- * @param identity the OF window identity to check.
67
- */
68
- export declare const isDetachingPages: (identity: OpenFin.Identity) => Promise<boolean>;
69
64
  /**
70
65
  * Check if the window identity is in the middle of changing active pages.
71
66
  * @param identity the OF window identity to check.
@@ -34,6 +34,8 @@ export interface Page {
34
34
  contextGroup?: string;
35
35
  /** Optional property to attach custom metadata to the page object, such as version or timestamp. Must be serializable. */
36
36
  customData?: any;
37
+ /** True when this page is an admin-published supertab. */
38
+ isPublished?: boolean;
37
39
  }
38
40
  type AttachedPageMetadata = {
39
41
  /** The window the page is currently attached to. */
@@ -52,7 +52,6 @@ export declare enum PageChannelAction {
52
52
  ReorderPagesForWindow = "reorder-pages-for-window",
53
53
  UpdatePageForWindow = "update-page-for-window",
54
54
  UpdatePagesWindowOptions = "update-pages-window-options",
55
- IsDetachingPages = "is-detaching-pages",
56
55
  IsActivePageChanging = "is-active-page-changing"
57
56
  }
58
57
  export declare enum CompanionDockChannelAction {
@@ -77,7 +76,6 @@ export declare const BrowserChannelAction: {
77
76
  ReorderPagesForWindow: PageChannelAction.ReorderPagesForWindow;
78
77
  UpdatePageForWindow: PageChannelAction.UpdatePageForWindow;
79
78
  UpdatePagesWindowOptions: PageChannelAction.UpdatePagesWindowOptions;
80
- IsDetachingPages: PageChannelAction.IsDetachingPages;
81
79
  IsActivePageChanging: PageChannelAction.IsActivePageChanging;
82
80
  CloseBrowserWindow: GeneralBrowserChannelActions.CloseBrowserWindow;
83
81
  QuitPlatform: GeneralBrowserChannelActions.QuitPlatform;
@@ -0,0 +1,5 @@
1
+ export declare const mockLogger: {
2
+ debug: jest.Mock<any, any, any>;
3
+ warn: jest.Mock<any, any, any>;
4
+ error: jest.Mock<any, any, any>;
5
+ };
@@ -30,3 +30,10 @@ export declare const getWorkspaceOFApplication: () => OpenFin.Application;
30
30
  * @returns A Promise resolving to the application manifest
31
31
  */
32
32
  export declare const getCachedManifest: () => Promise<OpenFin.Manifest>;
33
+ /**
34
+ * Gets application info, caching the result after the first call.
35
+ * Application info (manifestUrl, licenseKey, runtime version, etc.) never changes
36
+ * during the application lifecycle. Multiple callers (overrides, sentry, analytics)
37
+ * share a single IPC call.
38
+ */
39
+ export declare const getCachedAppInfo: () => Promise<OpenFin.ApplicationInfo>;
@@ -1,7 +1,7 @@
1
1
  import type OpenFin from '@openfin/core';
2
2
  import { AnchorBehavior } from '../../../client-api-platform/src/api/context-menu';
3
3
  import { PageTabContextMenuItemTemplate, ViewTabContextMenuTemplate } from '../../../client-api-platform/src/shapes';
4
- import { EnterpriseMenuType } from './popup-window';
4
+ import { PopupWindowMenuType } from './popup-window';
5
5
  export declare enum MenuItemType {
6
6
  Label = "normal",
7
7
  Separator = "separator",
@@ -13,7 +13,7 @@ export type ShowContextMenuResponse = OpenFin.MenuResult & {
13
13
  requestId?: string;
14
14
  };
15
15
  export declare function showContextMenu(opts: OpenFin.ShowPopupMenuOptions, win?: OpenFin.Window): Promise<ShowContextMenuResponse>;
16
- export declare const showEnterpriseContextMenu: (opts: OpenFin.ShowPopupMenuOptions, type: EnterpriseMenuType, anchorBehavior: AnchorBehavior, win?: OpenFin.Window) => Promise<ShowContextMenuResponse>;
16
+ export declare const showEnterpriseContextMenu: (opts: OpenFin.ShowPopupMenuOptions, type: PopupWindowMenuType, anchorBehavior: AnchorBehavior, win?: OpenFin.Window) => Promise<ShowContextMenuResponse>;
17
17
  export declare const Separator: OpenFin.MenuItemTemplate;
18
18
  export declare const EmptyContextMenuItem: OpenFin.MenuItemTemplate;
19
19
  export declare const DefaultSaveMenuBounds: {
@@ -16,3 +16,6 @@ export declare const connectToEnterpriseContentChannel: (uuid: string) => Promis
16
16
  export declare const connectToEnterpriseModalChannel: (uuid: string) => Promise<OpenFin.ChannelClient>;
17
17
  export declare const createZoomControlsDialogChannel: () => Promise<OpenFin.ChannelProvider>;
18
18
  export declare const connectToZoomControlsDialogChannel: () => Promise<OpenFin.ChannelClient>;
19
+ export declare const getTabSearchChannelName: () => string;
20
+ export declare const createTabSearchChannel: () => Promise<OpenFin.ChannelProvider>;
21
+ export declare const connectToTabSearchChannel: () => Promise<OpenFin.ChannelClient>;
@@ -1,4 +1,5 @@
1
1
  import type OpenFin from '@openfin/core';
2
+ import { AnchorBehavior } from '../../../client-api-platform/src/api/context-menu';
2
3
  import { ResponseModalConfig } from './menu-config';
3
4
  import { Point } from './window';
4
5
  /**
@@ -59,3 +60,22 @@ export declare function getBoundsCenteredAndFitOnMonitor(height: number, width:
59
60
  left: number;
60
61
  top: number;
61
62
  }>;
63
+ /**
64
+ * Calculates the final popup bounds relative to a parent window, accounting for:
65
+ * - Windows 10/11 maximized window shadow offset (Electron bug)
66
+ * - Anchor behavior (e.g. BottomRight, TopLeft)
67
+ * - Off-screen clamping to keep the popup within monitor bounds
68
+ *
69
+ * @param parentIdentity - The identity of the parent window.
70
+ * @param contentDimensions - The width and height of the popup content.
71
+ * @param position - The desired x/y position relative to the parent window.
72
+ * @param anchorBehavior - Optional anchor behavior to adjust positioning.
73
+ * @returns Bounds relative to the parent window, clamped to the nearest monitor.
74
+ */
75
+ export declare const getPopupBoundsRelativeToParent: (parentIdentity: OpenFin.Identity, contentDimensions: {
76
+ width: number;
77
+ height: number;
78
+ }, position: {
79
+ x: number;
80
+ y: number;
81
+ }, anchorBehavior?: AnchorBehavior) => Promise<OpenFin.Bounds>;
@@ -39,19 +39,19 @@ export type BrowserSearchMenuKeyboardEvent = {
39
39
  altKey?: boolean;
40
40
  };
41
41
  };
42
- export declare enum EnterpriseMenuType {
42
+ export declare enum PopupWindowMenuType {
43
43
  GlobalMenu = "global-menu",
44
44
  ContextMenu = "context-menu",
45
45
  RenameSupertab = "rename-supertab",
46
46
  AddEditBookmark = "add-edit-bookmark",
47
47
  DropdownMenu = "dropdown-menu",
48
- ZoomControls = "zoom-controls"
48
+ TabSearch = "tab-search"
49
49
  }
50
50
  export type BookmarkButtonPayload = {
51
51
  selectedViewIdentity: OpenFin.Identity;
52
52
  };
53
- export type BaseEnterpriseMenuChannelMessage = {
54
- type: EnterpriseMenuType;
53
+ export type BasePopupMenuChannelMessage = {
54
+ type: PopupWindowMenuType;
55
55
  /**
56
56
  * The identity of the window the dialog/menu invocation came from.
57
57
  */
@@ -67,29 +67,35 @@ export type BaseEnterpriseMenuChannelMessage = {
67
67
  x: number;
68
68
  y: number;
69
69
  };
70
- export type ContextMenuChannelMessage = BaseEnterpriseMenuChannelMessage & {
71
- type: EnterpriseMenuType.ContextMenu | EnterpriseMenuType.GlobalMenu;
70
+ export type ContextMenuChannelMessage = BasePopupMenuChannelMessage & {
71
+ type: PopupWindowMenuType.ContextMenu | PopupWindowMenuType.GlobalMenu;
72
72
  /**
73
73
  * The unique request ID of the context menu invocation.
74
74
  */
75
75
  requestId: string;
76
76
  payload: OpenFin.ShowPopupMenuOptions;
77
77
  };
78
- export type BookmarkDialogChannelMessage = BaseEnterpriseMenuChannelMessage & {
79
- type: EnterpriseMenuType.AddEditBookmark;
78
+ export type BookmarkDialogChannelMessage = BasePopupMenuChannelMessage & {
79
+ type: PopupWindowMenuType.AddEditBookmark;
80
80
  payload: BookmarkButtonPayload;
81
81
  };
82
- export type ZoomControlsDialogPayload = {
83
- selectedViewIdentity?: OpenFin.Identity;
84
- zoomPercent?: number;
85
- openedViaMouseClick?: boolean;
86
- };
87
- export type ZoomControlsDialogChannelMessage = BaseEnterpriseMenuChannelMessage & {
88
- type: EnterpriseMenuType.ZoomControls;
89
- payload: ZoomControlsDialogPayload;
82
+ /** Sent from browser to zoom dialog window to position and hydrate UI (initial open or live sync). */
83
+ export type ZoomControlsDialogStateMessage = {
84
+ /**
85
+ * The identity of the window the dialog/menu invocation came from.
86
+ */
87
+ parentIdentity: OpenFin.Identity;
88
+ x: number;
89
+ y: number;
90
+ payload: {
91
+ selectedViewIdentity?: OpenFin.Identity;
92
+ zoomPercent?: number;
93
+ openedViaMouseClick?: boolean;
94
+ };
90
95
  };
91
- export type DropdownMenuChannelMessage = BaseEnterpriseMenuChannelMessage & {
92
- type: EnterpriseMenuType.DropdownMenu;
96
+ export declare const ZOOM_DIALOG_CHANNEL_ACTION: "state";
97
+ export type DropdownMenuChannelMessage = BasePopupMenuChannelMessage & {
98
+ type: PopupWindowMenuType.DropdownMenu;
93
99
  payload: {
94
100
  template: Array<OpenFin.MenuItemTemplate>;
95
101
  /**
@@ -98,8 +104,8 @@ export type DropdownMenuChannelMessage = BaseEnterpriseMenuChannelMessage & {
98
104
  width: number;
99
105
  };
100
106
  };
101
- export type RenameSupertabChannelMessage = BaseEnterpriseMenuChannelMessage & {
102
- type: EnterpriseMenuType.RenameSupertab;
107
+ export type RenameSupertabChannelMessage = BasePopupMenuChannelMessage & {
108
+ type: PopupWindowMenuType.RenameSupertab;
103
109
  payload: {
104
110
  /**
105
111
  * The pageId of the page being renamed.
@@ -107,6 +113,18 @@ export type RenameSupertabChannelMessage = BaseEnterpriseMenuChannelMessage & {
107
113
  pageId: string;
108
114
  };
109
115
  };
116
+ export type TabSearchModalContent = {
117
+ variant: 'page' | 'view';
118
+ tabs: {
119
+ title: string;
120
+ id: string;
121
+ }[];
122
+ };
123
+ export type TabSearchChannelMessage = BasePopupMenuChannelMessage & {
124
+ type: PopupWindowMenuType.TabSearch;
125
+ requestId: string;
126
+ payload: TabSearchModalContent;
127
+ };
110
128
  export type SearchMenuChannelResponse = {
111
129
  type: 'ready';
112
130
  } | {
@@ -135,5 +153,4 @@ export type SearchMenuChannelResponse = {
135
153
  type: 'single-provider-results-announcement';
136
154
  message: string;
137
155
  };
138
- export declare function showPopupWin<T extends keyof UserMenuParams>(parentWindow: OpenFin.Window, params: UserMenuParams[T], windowOpts: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
139
156
  export {};
@@ -31,6 +31,7 @@ declare enum BrowserRoute {
31
31
  EnterpriseAboutPage = "/popup-menu/about/",
32
32
  StorageProxy = "/storage-proxy",
33
33
  DropdownMenu = "/dropdown-menu/",
34
+ TabSearchModal = "/popup-menu/tab-search-modal/",
34
35
  EnterpriseDock = "/dock/",
35
36
  ZoomControlsDialog = "/zoom-controls-dialog/",
36
37
  DesktopSignalsModal = "/popup-menu/desktop-signals-modal/",
@@ -54,6 +55,7 @@ declare const PageRoute: {
54
55
  EnterpriseAboutPage: BrowserRoute.EnterpriseAboutPage;
55
56
  StorageProxy: BrowserRoute.StorageProxy;
56
57
  DropdownMenu: BrowserRoute.DropdownMenu;
58
+ TabSearchModal: BrowserRoute.TabSearchModal;
57
59
  EnterpriseDock: BrowserRoute.EnterpriseDock;
58
60
  ZoomControlsDialog: BrowserRoute.ZoomControlsDialog;
59
61
  DesktopSignalsModal: BrowserRoute.DesktopSignalsModal;
@@ -19,10 +19,12 @@ export declare enum WindowName {
19
19
  DockSaveWorkspaceMenu = "openfin-dock3-save-workspace-menu",
20
20
  DropdownMenu = "openfin-enterprise-dropdown-menu",
21
21
  EnterpriseContextMenu = "openfin-enterprise-context-menu",
22
+ TabSearchMenu = "openfin-browser-tab-search-menu",
22
23
  EnterpriseBookmarkDialogWindow = "openfin-enterprise-bookmark-dialog",
23
24
  ZoomControlsDialog = "here-zoom-controls-dialog",
24
25
  UpdateVersionModal = "here-update-version-modal",
25
26
  ApplyAndPublishModal = "here-apply-and-publish-modal",
27
+ PublishOnCloseModal = "here-publish-on-close-modal",
26
28
  DesktopSignalsModal = "here-desktop-signals-modal",
27
29
  IntentsResolverModal = "here-intents-resolver-modal"
28
30
  }
@@ -144,7 +146,6 @@ export declare function animateSize(width: number, height: number): Promise<void
144
146
  * @returns boolean
145
147
  */
146
148
  export declare const isBrowserWindow: (identity: OpenFin.Identity) => Promise<any>;
147
- export declare const isModalWindowExceptZoomDialog: (identity: OpenFin.Identity) => boolean;
148
149
  /**
149
150
  * Force document body size. Called when resizing or on scaling changes.
150
151
  */
@@ -35,6 +35,9 @@ export declare const showUpdateVersionModal: ({ identity, title, description }:
35
35
  description: string;
36
36
  }) => Promise<ModalResponseEvent["data"]>;
37
37
  export declare const showApplyAndPublishModal: (identity: OpenFin.Identity) => Promise<boolean>;
38
+ export declare const showPublishOnCloseModal: (windowIdentity: OpenFin.Identity) => Promise<{
39
+ data: ModalResponseEvent["data"];
40
+ }>;
38
41
  /**
39
42
  * Shows the intents resolver modal and returns the user's selection
40
43
  * @param request - The request containing modal configuration
@@ -13,6 +13,14 @@
13
13
  "issuer": "common/src/utils/layout.ts"
14
14
  }
15
15
  ],
16
+ "title-case": [
17
+ {
18
+ "type": "explicit",
19
+ "version": "3.0.3",
20
+ "packageName": "common/package.json",
21
+ "issuer": "common/src/utils/color-linking.ts"
22
+ }
23
+ ],
16
24
  "react-i18next": [
17
25
  {
18
26
  "type": "explicit",
@@ -37,14 +45,6 @@
37
45
  "issuer": "common/src/utils/layout.ts"
38
46
  }
39
47
  ],
40
- "title-case": [
41
- {
42
- "type": "explicit",
43
- "version": "3.0.3",
44
- "packageName": "common/package.json",
45
- "issuer": "common/src/utils/color-linking.ts"
46
- }
47
- ],
48
48
  "dexie": [
49
49
  {
50
50
  "type": "root-implicit",