@openfin/workspace 22.5.25 → 23.0.1-alpha.0966d5cc

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

@@ -0,0 +1,131 @@
+/**
+ * Logger Utility for OpenFin Workspace Monorepo
+ *
+ * Provides structured, contextual logging with consistent formatting
+ * across all workspaces and modules.
+ */
+export interface LogData {
+    [key: string]: any;
+}
+export interface Logger {
+    debug: (method: string, message: string, data?: LogData | (() => LogData)) => void;
+    info: (method: string, message: string, data?: LogData | (() => LogData)) => void;
+    warn: (method: string, message: string, data?: LogData | (() => LogData)) => void;
+    error: (method: string, message: string, data?: LogData | (() => LogData)) => void;
+}
+/**
+ * Configuration for the logger
+ */
+export interface LoggerConfig {
+    /** Include timestamp in logs (default: true) */
+    includeTimestamp?: boolean;
+    /** Custom prefix for logs */
+    customPrefix?: string;
+    /**
+     * Stringify log data before passing to console (default: true).
+     * When true, objects are serialized as JSON strings for safer logging.
+     * When false, raw objects are passed to console, allowing expandable/inspectable
+     * objects in browser dev tools.
+     *
+     * @example
+     * To disable safe stringify for local development, you can:
+     * 1. Set this option per-logger: createLogger('MyContext', { stringifyData: false })
+     * 2. Or call setGlobalStringifyEnabled(false) once at app startup
+     */
+    stringifyData?: boolean;
+}
+/**
+ * Enable or disable safe stringify globally for all loggers.
+ * Useful for local development when you want expandable objects in browser dev tools.
+ *
+ * This overrides the build-time LOG_STRINGIFY setting at runtime.
+ * Individual logger config (stringifyData option) takes precedence over this setting.
+ *
+ * @param enabled - Whether to stringify log data
+ *
+ * @example
+ * ```typescript
+ * // Override build-time setting at runtime:
+ * import { setGlobalStringifyEnabled } from 'common/src/utils/logger';
+ *
+ * // Disable stringify to get expandable objects in console
+ * setGlobalStringifyEnabled(false);
+ * ```
+ */
+export declare const setGlobalStringifyEnabled: (enabled: boolean) => void;
+/**
+ * Get the current global stringify setting.
+ */
+export declare const getGlobalStringifyEnabled: () => boolean;
+/**
+ * Create a structured logger for a specific context
+ *
+ * @param context - The context identifier (workspace, module, or component name)
+ * @param config - Optional configuration for the logger
+ * @returns Enhanced logger instance
+ *
+ * @example
+ * ```typescript
+ * const logger = createLogger('browser.TabList');
+ *
+ * logger.info('addTab', 'Adding new tab', { pageId: '123' });
+ * logger.error('addTab', 'Failed to add tab', { error: err.message });
+ * ```
+ */
+export declare const createLogger: (context: string, config?: LoggerConfig) => Logger;
+/**
+ * Create a logger with performance monitoring capabilities
+ * Useful for tracking execution times and performance metrics
+ */
+export declare const createPerformanceLogger: (context: string, config?: LoggerConfig) => {
+    /**
+     * Start a performance timer
+     */
+    startTimer: (timerId: string, method: string, message: string, data?: LogData) => void;
+    /**
+     * Clear a specific timer without logging
+     */
+    clearTimer: (timerId: string) => void;
+    /**
+     * End a performance timer and log the duration
+     */
+    endTimer: (timerId: string, method: string, message: string, data?: LogData) => void;
+    debug: (method: string, message: string, data?: LogData | (() => LogData)) => void;
+    info: (method: string, message: string, data?: LogData | (() => LogData)) => void;
+    warn: (method: string, message: string, data?: LogData | (() => LogData)) => void;
+    error: (method: string, message: string, data?: LogData | (() => LogData)) => void;
+};
+export type EnhancedLogger = ReturnType<typeof createPerformanceLogger>;
+/**
+ * Middleware function for wrapping async operations with logging
+ */
+export declare const withLogging: <T extends any[], R>(logger: Logger, method: string, operation: (...args: T) => Promise<R> | R) => (...args: T) => Promise<R>;
+/**
+ * Legacy logger instance for backwards compatibility.
+ * Use `createLogger` for new code to get structured, contextual logging.
+ *
+ * @deprecated Use createLogger() instead for new code
+ */
+export declare const log: {
+    /**
+     * Calls console.debug with provided parameters and stringifies JS objects prior to logging.
+     * Only logs when LOG_DEBUG is enabled.
+     */
+    debug: (...args: unknown[]) => void;
+    /**
+     * Calls console.info with provided parameters and stringifies JS objects prior to logging
+     */
+    info: (...args: unknown[]) => void;
+    /**
+     * Calls console.warn with provided parameters and stringifies JS objects prior to logging
+     */
+    warn: (...args: unknown[]) => void;
+    /**
+     * Calls console.error with provided parameters and stringifies JS objects prior to logging
+     */
+    error: (...args: unknown[]) => void;
+    /**
+     * Calls console.trace with provided parameters and stringifies JS objects prior to logging
+     */
+    trace: (...args: unknown[]) => void;
+};

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

@@ -2,9 +2,13 @@ import type OpenFin from '@openfin/core';
 import { ResponseModalContent } from '../../../common/src/utils/menu-config';
 import type { OptionalExceptFor } from '../../../common/src/utils/types';
 type MenuEventTypes = {
-    response: [ModalResponseEvent];
-    ready: [OpenFin.Identity];
-    update: [string, Partial<OpenFin.Bounds>, string];
+    'response': [ModalResponseEvent];
+    'ready': [OpenFin.Identity];
+    'update': [string, Partial<OpenFin.Bounds>, string];
+    'modal-opened': [string];
+    'modal-closed': [string];
+    'search-menu-opening': [string];
+    'search-menu-closed': [string];
 };
 export interface ModalResponseEvent {
     data: {
@@ -17,12 +21,12 @@ 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;
+    addListener: <EventKey extends keyof MenuEventTypes>(event: EventKey, listener: (...payload: MenuEventTypes[EventKey]) => void) => void;
+    addListenerWithUUID: (uuid: string) => <EventKey extends keyof MenuEventTypes>(event: EventKey, listener: (...payload: MenuEventTypes[EventKey]) => void) => void;
+    removeListener: <EventKey extends keyof MenuEventTypes>(event: EventKey, listener: (...payload: MenuEventTypes[EventKey]) => void) => void;
+    once: <EventKey extends keyof MenuEventTypes>(event: EventKey, listener: (...payload: MenuEventTypes[EventKey]) => void) => void;
 };
-export declare const emitMenuResponse: (data: ModalResponseEvent['data']) => Promise<void>;
+export declare const emitMenuResponse: (data: ModalResponseEvent["data"]) => Promise<void>;
 type WindowOptionsWithBounds = OptionalExceptFor<OpenFin.WindowOptions, 'name' | 'url'> & {
     top: number;
     left: number;
@@ -49,6 +53,6 @@ export declare function createMenuPosition(windowOptions: OptionalExceptFor<Open
 }>;
 export declare function showChildWindow({ options, parameters }: ShowChildOptions): Promise<OpenFin.Window>;
 export declare const waitForModalResponse: ({ options, content, parameters }: ResponseModalOptions) => Promise<{
-    data: ModalResponseEvent['data'];
+    data: ModalResponseEvent["data"];
 }>;
 export {};

package/common/src/utils/merge-deep.d.ts

@@ -1,5 +1,6 @@
 /**
  * Deep merge a set of source objects into a single target object.
+ * Arrays are concatenated rather than overwritten.
  * @param target the target object to merge sources into.
  * @param sources the source objects to merge into the target. (FIFO)
  */

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

@@ -16,7 +16,7 @@ export declare const getCenterOfParentWindowMonitor: (parentWindowIdentity?: Ope
  * @param centerOnMonitor whether the modal should be centered on the monitor
  * @returns the bounds for where the modal is to be displayed
  */
-export declare const getResponseModalBounds: (modalOptions: Pick<ResponseModalConfig['windowOptions'], 'defaultWidth' | 'defaultHeight'>, parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean) => Promise<OpenFin.Bounds>;
+export declare const getResponseModalBounds: (modalOptions: Pick<ResponseModalConfig["windowOptions"], "defaultWidth" | "defaultHeight">, parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean) => Promise<OpenFin.Bounds>;
 export declare function getResponseModalBoundsAndCenterParentIfModalOffScreen(modalOptions: Parameters<typeof getResponseModalBounds>[0], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean, relativeBounds?: boolean): Promise<OpenFin.Bounds>;
 /**
  * Adjusts the given bounds to be within the closest monitor's available bounds if they are offscreen.

package/common/src/utils/namespaced-local-storage.d.ts

@@ -1,4 +1,5 @@
-export declare const createNamespacedLocalStorage: <TKey extends string>(namespace: string) => Pick<Storage, 'setItem' | 'getItem' | 'removeItem'>;
-export declare const setItem: (key: string, value: string) => void;
-export declare const getItem: (key: string) => string;
-export declare const removeItem: (key: string) => void;
+import LocalStorageKey from './local-storage-key';
+export declare const setItem: (key: LocalStorageKey, value: string) => void;
+export declare const getItem: (key: LocalStorageKey) => string;
+export declare const removeItem: (key: LocalStorageKey) => void;
+export declare const createNamespacedLocalStorage: <TKey extends string>(namespace: string) => Pick<Storage, "setItem" | "getItem" | "removeItem">;

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

@@ -3,6 +3,12 @@ import { UserMenuParams } from '../../../common/src/utils/menu';
 import { OptionalExceptFor } from '../../../common/src/utils/types';
 import { AnchorBehavior } from '../../../client-api-platform/src/api/context-menu';
 import { Site, SiteAction } from '../../../client-api-platform/src/shapes';
+export type ViewMoreButton = {
+    type: 'view-more-result';
+    id: string;
+    providerId: string;
+};
+export type SelectableResult = Site | ViewMoreButton;
 export declare enum SaveMenuType {
     Save = "Save",
     SaveAs = "SaveAs"
@@ -76,6 +82,7 @@ export type BookmarkDialogChannelMessage = BaseEnterpriseMenuChannelMessage & {
 export type ZoomControlsDialogPayload = {
     selectedViewIdentity?: OpenFin.Identity;
     zoomPercent?: number;
+    openedViaMouseClick?: boolean;
 };
 export type ZoomControlsDialogChannelMessage = BaseEnterpriseMenuChannelMessage & {
     type: EnterpriseMenuType.ZoomControls;
@@ -116,8 +123,17 @@ export type SearchMenuChannelResponse = {
 } | {
     type: 'keyboard-event';
     keyboardEvent: BrowserSearchMenuKeyboardEvent;
+} | {
+    type: 'focused-changed';
+    payload: SelectableResult;
 } | {
     type: 'search-provider-changed';
+} | {
+    type: 'all-providers-results-announcement';
+    message: string;
+} | {
+    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

@@ -29,11 +29,13 @@ declare enum BrowserRoute {
     EnterpriseContextMenu = "/context-menu/",
     EnterpriseBookmarkDialog = "/bookmark-dialog/",
     EnterpriseAboutPage = "/popup-menu/about/",
+    StorageProxy = "/storage-proxy",
     DropdownMenu = "/dropdown-menu/",
     EnterpriseDock = "/dock/",
     ZoomControlsDialog = "/zoom-controls-dialog/",
     DesktopSignalsModal = "/popup-menu/desktop-signals-modal/",
-    IntentsResolverModal = "/popup-menu/intents-resolver-modal/"
+    IntentsResolverModal = "/popup-menu/intents-resolver-modal/",
+    FindInPageModal = "/popup-menu/find-in-page-modal/"
 }
 declare const PageRoute: {
     Browser: BrowserRoute.Browser;
@@ -50,11 +52,13 @@ declare const PageRoute: {
     EnterpriseContextMenu: BrowserRoute.EnterpriseContextMenu;
     EnterpriseBookmarkDialog: BrowserRoute.EnterpriseBookmarkDialog;
     EnterpriseAboutPage: BrowserRoute.EnterpriseAboutPage;
+    StorageProxy: BrowserRoute.StorageProxy;
     DropdownMenu: BrowserRoute.DropdownMenu;
     EnterpriseDock: BrowserRoute.EnterpriseDock;
     ZoomControlsDialog: BrowserRoute.ZoomControlsDialog;
     DesktopSignalsModal: BrowserRoute.DesktopSignalsModal;
     IntentsResolverModal: BrowserRoute.IntentsResolverModal;
+    FindInPageModal: BrowserRoute.FindInPageModal;
     Home: WorkspaceRoute.Home;
     HomeSearch: WorkspaceRoute.HomeSearch;
     HomePagesRename: WorkspaceRoute.HomePagesRename;

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

@@ -5,12 +5,12 @@ export default function makeSharedEmitter<EventMap extends {
     [key: string | number]: any[];
 }>(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;
+    addListener: <EventKey extends keyof EventMap>(event: EventKey, listener: (...payload: EventMap[EventKey]) => 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;
+    addListenerWithUUID: (uuid: string) => <EventKey extends keyof EventMap>(event: EventKey, listener: (...payload: EventMap[EventKey]) => void) => void;
+    removeListener: <EventKey extends keyof EventMap>(event: EventKey, listener: (...payload: EventMap[EventKey]) => void) => void;
+    once: <EventKey extends keyof EventMap>(event: EventKey, listener: (...payload: EventMap[EventKey]) => void) => void;
 };

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

@@ -1,4 +1,10 @@
+import type OpenFin from '@openfin/core';
 import { BackgroundLayers, CustomPaletteSet } from '../../../common/src/api/theming';
+export type ColorSchemeValue = 'light' | 'dark' | 'system';
+export type WorkspaceSchemeSetting = 'light' | 'dark' | 'system';
+export type MediaSchemeValue = 'light' | 'dark';
+/** Maps a color scheme to OpenFin native theme preferences. */
+export declare const mapColorSchemeToNativeTheme: (scheme: ColorSchemeValue) => OpenFin.NativeTheme;
 /**
  * Parses a CSS color string (hex, rgb(a), or hsl(a)) into a structured RGB string and alpha value.
  *

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

@@ -54,5 +54,5 @@ type MissingKeys<T, U> = Exclude<keyof T, U>;
  * fooChecker(['bar', 'qux', 'baz']); // 'baz' is not assignable to type keyof Foo;
  * ```
  */
-export declare const makeKeyChecker: <T extends object>() => <K extends (keyof T)[]>(arr: K & (Exclude<keyof T, K[number]> extends never ? unknown : `Error: Missing keys: ${string & Exclude<keyof T, K[number]>}`)) => K;
+export declare const makeKeyChecker: <T extends object>() => <K extends (keyof T)[]>(arr: K & (MissingKeys<T, K[number]> extends never ? unknown : `Error: Missing keys: ${string & MissingKeys<T, K[number]>}`)) => K;
 export {};

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

@@ -1,25 +1,27 @@
 import type OpenFin from '@openfin/core';
+import type { SearchProviderInfo } from '../../../search-api/src/shapes';
 import { ApplicationUUID } from './application';
 export declare enum WindowName {
     Home = "openfin-home",
     Dock = "openfin-dock",
     Storefront = "openfin-storefront",
     HomeInternal = "openfin-home-internal",
-    BrowserMenu = "openfin-browser-menu",
-    BrowserSaveMenu = "openfin-browser-save-menu",
-    DockSaveWorkspaceMenu = "openfin-dock3-save-workspace-menu",
     BrowserIndicator = "openfin-browser-indicator",
     BrowserWindow = "internal-generated-window",
     ClassicWindow = "internal-generated-classic-window",
-    EnterpriseContextMenu = "openfin-enterprise-context-menu",
     BrowserAddressSearchPrefix = "openfin-browser-menu-address-search-",
-    EnterpriseBookmarkDialogWindow = "openfin-enterprise-bookmark-dialog",
-    DropdownMenu = "openfin-enterprise-dropdown-menu",
     DockCompanion = "openfin-dock-companion",
     AICompanionPrefix = "openfin-ai-companion-",
-    UpdateVersionModal = "here-update-version-modal",
-    ZoomControlsDialog = "here-zoom-controls-dialog",
     AboutPageWindow = "here-about-page",
+    FindInPageViewPrefix = "here-find-in-page-view-",
+    BrowserMenu = "openfin-browser-menu",
+    BrowserSaveMenu = "openfin-browser-save-menu",
+    DockSaveWorkspaceMenu = "openfin-dock3-save-workspace-menu",
+    DropdownMenu = "openfin-enterprise-dropdown-menu",
+    EnterpriseContextMenu = "openfin-enterprise-context-menu",
+    EnterpriseBookmarkDialogWindow = "openfin-enterprise-bookmark-dialog",
+    ZoomControlsDialog = "here-zoom-controls-dialog",
+    UpdateVersionModal = "here-update-version-modal",
     DesktopSignalsModal = "here-desktop-signals-modal",
     IntentsResolverModal = "here-intents-resolver-modal"
 }
@@ -141,6 +143,7 @@ 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.
  */
@@ -154,6 +157,7 @@ export declare function getModalWindows(): Promise<OpenFin.Window[]>;
  * Returns true if the OpenFin window for the provided identity is running.
  * */
 export declare const isWindowRunning: (identity: WindowIdentity) => Promise<boolean>;
+export declare const isApplicationRunning: (uuid: string) => Promise<boolean>;
 /**
  * Check if Storefront window is running.
  * @returns true if the Storefront window is running.
@@ -161,7 +165,7 @@ export declare const isWindowRunning: (identity: WindowIdentity) => Promise<bool
 export declare const isStorefrontWindowRunning: () => Promise<boolean>;
 export declare const isDockWindowRunning: () => Promise<boolean>;
 export declare const isHomeWindowRunning: () => Promise<boolean>;
-export declare const isNotificationCenterWindowRunning: () => Promise<boolean>;
+export declare const isNotificationCenterRunning: () => Promise<boolean>;
 export declare const showAndFocusStorefront: () => Promise<void>;
 export declare const showAndFocusDock: () => Promise<void>;
 export declare const getDisableMultiplePagesOption: (identity: WindowIdentity) => Promise<any>;
@@ -173,6 +177,13 @@ export declare const getComponentWindowStatus: () => Promise<{
 }>;
 export declare const deserializeWindowBounds: (serialized: string) => OpenFin.WindowBounds | null;
 export declare const serializeWindowBounds: (bounds: OpenFin.WindowBounds) => string;
+/**
+ * Calculates the dynamic height for the home window based on subheader configuration
+ * @param baseHeight - The base height for the home window
+ * @param subHeaderConfig - The subheader configuration from search provider
+ * @returns The calculated height based on missing subheader elements
+ */
+export declare const calculateHomeWindowHeight: (baseHeight: number, subHeaderConfig?: SearchProviderInfo["subHeader"]) => number;
 export declare const getWindowBounds: (window: OpenFin.Window) => Promise<OpenFin.RectangleByEdgePositions>;
 /**
  * calculates the percenage of the window that is present within the monitor (float in range 0-1)

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

@@ -33,7 +33,7 @@ export declare const showUpdateVersionModal: ({ identity, title, description }:
     identity: OpenFin.Identity;
     title: string;
     description: string;
-}) => Promise<ModalResponseEvent['data']>;
+}) => Promise<ModalResponseEvent["data"]>;
 /**
  * Shows the intents resolver modal and returns the user's selection
  * @param request - The request containing modal configuration

package/dock3/src/api/protocol.d.ts

@@ -1,6 +1,6 @@
 import type { OpenFin } from '@openfin/core';
 import { BaseCustomDropdownItem } from '../../../client-api/src/shapes';
-import { BookmarkDockEntryPayload, DockEntry, LaunchDockEntryPayload } from '../../../client-api-platform/src/shapes';
+import { BookmarkDockEntryPayload, DockEntry, LaunchDockEntryPayload, Collection } from '../../../client-api-platform/src/shapes';
 import { Dock3Config, DockCompanionButton } from '../../../dock3/src/shapes';
 /**
  * Payload for more menu custom option actions
@@ -37,6 +37,9 @@ export type Dock3ChannelProviderChannelActions = {
  */
 export type Dock3ChannelClientChannelActions = {
     'handle-dock-config-updated': (payload: Dock3Config) => void;
+    'navigate-content-menu': (payload: {
+        targetId: string;
+    }) => void;
 };
 /**
  * @internal
@@ -59,6 +62,8 @@ export type EnterpriseDockChannelProviderChannelActions = Dock3ChannelProviderCh
     'remove-favorite-entry': (entry: DockEntry) => void;
     'add-favorite-entry': (entry: DockEntry) => void;
     'more-menu-custom-option-clicked': (payload: MoreMenuCustomOptionPayload) => Promise<void>;
+    'refresh-dock-collection-menu': (collections: Collection[]) => Promise<void>;
+    'launch-collection': (collection: Collection) => void;
 };
 /**
  * These are channel actions registered by the client (enterprise dock)

package/dock3/src/api/utils.d.ts

@@ -0,0 +1,11 @@
+import type { CompanionDockConfig } from '../shapes/enterprise';
+import type { DockAllowedWindowOptions } from '../shapes/shapes';
+export declare const getSnapZone: (config: CompanionDockConfig | unknown, options?: DockAllowedWindowOptions) => {
+    enabled: boolean;
+    threshold?: number;
+    locationPreference?: Array<"top" | "bottom">;
+} | {
+    enabled: boolean;
+    threshold: number;
+    locationPreference: readonly ["top", "bottom"];
+};

package/dock3/src/shapes/enterprise.d.ts

@@ -1,10 +1,16 @@
 import { Point } from '../../../common/src/utils/window';
 import { Dock3Button, Dock3Config } from './shapes';
+import { Collection } from '../../../client-api-platform/src/shapes';
 export type { EnterpriseDockChannelClient, EnterpriseDockChannelProvider } from '../api/protocol';
 /**
  * @internal
  */
-export type DockCompanionButton = Exclude<Dock3Button, 'store'> | 'bookmarks' | 'searchShortcut';
+export type DockCompanionButton = Exclude<Dock3Button, 'store'> | 'bookmarks' | 'searchShortcut' | 'collectionMenu';
+/**
+ * @internal
+ * Supported context menu template items for the dock companion window
+ */
+export type DockContextMenuItem = 'snapToTop' | 'snapToBottom' | 'inspect';
 /**
  * @internal
  */
@@ -19,4 +25,22 @@ export type CompanionDockConfig = Omit<Dock3Config, 'defaultDockButtons'> & {
     baseUrl?: string;
     defaultDockButtons?: DockCompanionButton[];
     windowType?: 'enterprise';
+    collectionMenu?: Collection[];
+    /**
+     * Experimental snapzone configuration for the dock companion
+     */
+    experimental?: {
+        snapZone?: {
+            enabled: boolean;
+            threshold?: number;
+            locationPreference?: Array<'top' | 'bottom'>;
+        };
+    };
+    /**
+     * Context menu options for the dock companion window
+     */
+    contextMenuOptions?: {
+        enabled: boolean;
+        template?: DockContextMenuItem[];
+    };
 };

package/dock3/src/shapes/shapes.d.ts

@@ -75,4 +75,16 @@ export interface Dock3Config {
         };
     };
 }
-export type DockAllowedWindowOptions = Partial<Pick<OpenFin.PlatformWindowOptions, 'defaultCentered' | 'saveWindowState' | 'taskbarIconGroup' | 'defaultTop' | 'defaultLeft'>>;
+export type DockAllowedWindowOptions = Partial<Pick<OpenFin.PlatformWindowOptions, 'defaultCentered' | 'saveWindowState' | 'taskbarIconGroup' | 'defaultTop' | 'defaultLeft'>> & {
+    experimental?: {
+        snapZone?: {
+            enabled: boolean;
+            threshold?: number;
+            locationPreference?: Array<'top' | 'bottom'>;
+        };
+    };
+    contextMenuOptions?: {
+        enabled?: boolean;
+        template?: Array<'snapToTop' | 'snapToBottom' | 'inspect'>;
+    };
+};

package/externals.report.json

@@ -1,6 +1,8 @@
 {
-    "openfin-notifications/dist/client/without-auto-launch": [
+    "@openfin/notifications": [
         {
+            "type": "explicit",
+            "version": "2.14.0-alpha-4504",
             "packageName": "client-api/package.json",
             "issuer": "client-api/src/notifications.ts"
         }
@@ -8,7 +10,7 @@
     "@openfin/microsoft365": [
         {
             "type": "explicit",
-            "version": "^1.0.1",
+            "version": "^1.1.0",
             "packageName": "client-api/package.json",
             "issuer": "client-api/src/integrations/microsoft.ts"
         }
@@ -21,7 +23,7 @@
             "issuer": "client-api/src/internal/providers.ts"
         },
         {
-            "type": "root-implicit",
+            "type": "explicit",
             "version": "3.0.3",
             "packageName": "common/package.json",
             "issuer": "common/src/utils/color-linking.ts"
@@ -35,7 +37,7 @@
             "issuer": "client-api-platform/src/init/cleanup.ts"
         },
         {
-            "type": "root-implicit",
+            "type": "explicit",
             "version": "^4.0.8",
             "packageName": "common/package.json",
             "issuer": "common/src/utils/layout.ts"
@@ -43,7 +45,7 @@
     ],
     "react-i18next": [
         {
-            "type": "root-implicit",
+            "type": "explicit",
             "version": "15.4.0",
             "packageName": "common/package.json",
             "issuer": "common/src/api/i18next.ts"
@@ -51,12 +53,20 @@
     ],
     "i18next": [
         {
-            "type": "root-implicit",
+            "type": "explicit",
             "version": "^23.7.16",
             "packageName": "common/package.json",
             "issuer": "common/src/api/i18next.ts"
         }
     ],
+    "lodash.clonedeep": [
+        {
+            "type": "explicit",
+            "version": "4.5.0",
+            "packageName": "common/package.json",
+            "issuer": "common/src/utils/layout.ts"
+        }
+    ],
     "dexie": [
         {
             "type": "root-implicit",
@@ -71,13 +81,13 @@
             "issuer": "client-api-platform/src/api/dock/idb.ts"
         },
         {
-            "type": "root-implicit",
+            "type": "explicit",
             "version": "^4.0.11",
             "packageName": "common/package.json",
             "issuer": "common/src/api/pages/idb.ts"
         },
         {
-            "type": "root-implicit",
+            "type": "explicit",
             "version": "^4.0.11",
             "packageName": "common/package.json",
             "issuer": "common/src/utils/create-and-migrate-ibd-store.ts"