@openfin/workspace 45.1.0-alpha.3530b083 → 45.1.0-alpha.4ee5fa31

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

@@ -1,3 +1,4 @@
+import type { PlatformCapabilities } from '../../../client-api-platform/src/shapes';
 import { Locale } from '../../../client-api-platform/src/shapes';
 export declare function getLanguage(): Locale;
 export declare const dispatchLanguageToBrowserWindows: (language: Locale) => Promise<void[]>;
@@ -6,6 +7,14 @@ export declare function getLanguageResourcesInternal(): {
     currentLanguage: string;
     resources: import("i18next").Resource;
 };
+/**
+ * This API returns what functionality is supported by the platform.
+ * This is useful when Home/Dock/NC is of a higher version
+ * and may depend on functionality that is not available
+ * in the current Workspace Platform version.
+ * @internal
+ */
+export declare function getCapabilitiesInternal(): PlatformCapabilities;
 /**
  * initLanguage()
  * @param language - optional - ISO language code. Built-in languages are always accepted.

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

@@ -1,7 +1,7 @@
 import type OpenFin from '@openfin/core';
 import type { IconProps, IconType } from '@openfin/ui-library';
-import type { ModalResponseEvent } from '../../common/src/utils/menu-window-provider';
 import type { WorkspaceIndicatorConfig } from '../../common/src/utils/indicators/workspace-indicators';
+import type { ModalResponseEvent } from '../../common/src/utils/menu-window-provider';
 import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/utils/usage-register';
 import type { BaseCustomDropdownItem, CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 import type { Resource } from '../../common/src/api/i18next';
@@ -23,6 +23,17 @@ export { PanelPosition } from '../../common/src/api/pages/shapes';
 export type { CustomThemes, CustomThemeOptions, ThemeOptions, CustomThemeOptionsWithScheme, CustomPaletteSet, BaseThemeOptions, ThemeExtension, WorkspaceThemeSet, NotificationIndicatorColorsSet, NotificationIndicatorColorsSetDarkScheme, NotificationIndicatorColorsSetLightScheme, NotificationIndicatorColorsWithScheme } from '../../common/src/api/theming';
 export type { AnalyticsEvent } from '../../common/src/utils/usage-register';
 export type { WorkflowIntegration } from '../../client-api/src/shapes/integrations';
+/**
+ * Platform capabilities for feature detection by workspace components (Home, Dock).
+ * @internal
+ */
+export interface PlatformCapabilities {
+    languageBroadcast?: {
+        home?: boolean;
+        dock?: boolean;
+        notifications?: boolean;
+    };
+}
 /**
  * Request for creating a saved page in persistent storage.
  */
@@ -2105,6 +2116,11 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
         currentLanguage: Locale;
         resources: Resource;
     }>;
+    /**
+     * Returns platform capabilities for feature detection by workspace components.
+     * @internal
+     */
+    _getCapabilities(): Promise<PlatformCapabilities>;
     /**
      * Sets the language to ISO language code passed in
      * @param locale the ISO language code

package/common/src/api/protocol/shapes/workspace.d.ts

@@ -33,11 +33,16 @@ type HomeAPIClientChannelActions = Record<string, never>;
 type WorkspaceAPIClientChannelActions = StoreAPIClientChannelActions | DockAPIClientChannelActions | HomeAPIClientChannelActions;
 /****** End of API Client Channel Actions ******/
 /****** Workspace Component Channel Actions ******/
+export type WorkspaceComponentSetSelectedLanguagePayload = {
+    locale: string;
+    identity: OpenFin.Identity;
+};
 /**
  * Channel Actions **registered** by all workspace components.
  */
 type SharedChannelActions = {
     'set-selected-scheme': (ctx: WorkspaceComponentSetSelectedSchemePayload) => Promise<void>;
+    'set-selected-language': (payload: WorkspaceComponentSetSelectedLanguagePayload) => Promise<void>;
 };
 /**
  * Channel Actions **registered** by the Home workspace component.
@@ -93,6 +98,7 @@ type WorkspaceChannelTypes = {
             dark: string;
         };
     }) => Promise<void>;
+    'set-selected-language': (locale: string) => Promise<void>;
     'get-legacy-pages': () => Promise<Page[]>;
     'get-legacy-workspaces': (payload: undefined) => Promise<LegacyWorkspace[]>;
     'register-storefront-provider': () => Promise<void>;

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

@@ -61,6 +61,7 @@ export declare enum WorkspacePlatformChannelAction {
     GetLanguage = "getLanguage",
     GetLanguageResourcesInternal = "getLanguageResourcesInternal",
     SetLanguage = "setLanguage",
+    GetCapabilitiesInternal = "getCapabilitiesInternal",
     GetDockProviderConfig = "getDockProviderConfig",
     SaveDockProviderConfig = "saveDockProviderConfig",
     HandleSaveModalOnPageClose = "handleSaveModalOnPageClose",

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

@@ -0,0 +1,44 @@
+/**
+ * Kept in a standalone module with type-only imports so consumers can pull it in
+ * via the `@openfin/enterprise-api/color-channels` subpath without bundling the SDK.
+ *
+ * TODO: https://openfin.jira.com/browse/WRK-5704 - need to rewrite this to use color tokens
+ */
+export declare const ENTERPRISE_COLOR_CHANNELS: {
+    readonly blue: {
+        readonly name: "Blue";
+        readonly color: "#0091EB";
+    };
+    readonly indigo: {
+        readonly name: "Indigo";
+        readonly color: "#6450FF";
+    };
+    readonly pink: {
+        readonly name: "Pink";
+        readonly color: "#E878CF";
+    };
+    readonly teal: {
+        readonly name: "Teal";
+        readonly color: "#24D1D1";
+    };
+    readonly green: {
+        readonly name: "Green";
+        readonly color: "#00AF78";
+    };
+    readonly orange: {
+        readonly name: "Orange";
+        readonly color: "#FF7D37";
+    };
+    readonly red: {
+        readonly name: "Red";
+        readonly color: "#F94144";
+    };
+    readonly yellow: {
+        readonly name: "Yellow";
+        readonly color: "#F9C74F";
+    };
+    readonly gray: {
+        readonly name: "Gray";
+        readonly color: "#828788";
+    };
+};

package/common/src/utils/color-linking.d.ts

@@ -1,41 +1,4 @@
 import type OpenFin from '@openfin/core';
 import { ViewTabContextMenuTemplate } from '../../../client-api-platform/src/shapes';
 export declare const getChannelsMenuOptions: (channelsForViews: string[], colorGroups: OpenFin.ContextGroupInfo[]) => Promise<ViewTabContextMenuTemplate[]>;
-export declare const ENTERPRISE_COLOR_CHANNELS: {
-    readonly blue: {
-        readonly name: "Blue";
-        readonly color: "#0091EB";
-    };
-    readonly indigo: {
-        readonly name: "Indigo";
-        readonly color: "#6450FF";
-    };
-    readonly pink: {
-        readonly name: "Pink";
-        readonly color: "#E878CF";
-    };
-    readonly teal: {
-        readonly name: "Teal";
-        readonly color: "#24D1D1";
-    };
-    readonly green: {
-        readonly name: "Green";
-        readonly color: "#00AF78";
-    };
-    readonly orange: {
-        readonly name: "Orange";
-        readonly color: "#FF7D37";
-    };
-    readonly red: {
-        readonly name: "Red";
-        readonly color: "#F94144";
-    };
-    readonly yellow: {
-        readonly name: "Yellow";
-        readonly color: "#F9C74F";
-    };
-    readonly gray: {
-        readonly name: "Gray";
-        readonly color: "#828788";
-    };
-};
+export { ENTERPRISE_COLOR_CHANNELS } from './color-channels';

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

@@ -15,7 +15,7 @@ export type ShowContextMenuResponse = OpenFin.MenuResult & {
 export declare function showContextMenu(opts: OpenFin.ShowPopupMenuOptions, 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 getEmptyContextMenuItem: () => OpenFin.MenuItemTemplate;
 export declare const DefaultSaveMenuBounds: {
     width: number;
     height: number;

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

@@ -153,6 +153,19 @@ export declare const findViewInLayout: (node: any, viewId: OpenFin.Identity) =>
  * @returns The total number of views in the layout configuration.
  */
 export declare const countViews: (node: OpenFin.LayoutContent) => number;
+/**
+ * Returns the sole view component when a page layout contains exactly one view.
+ * Used to decide whether a page-tab drag should emit a single-view merge payload.
+ *
+ * Importantly this counts views recursively across the layout tree, not just
+ * top-level sections — a one-section/tab-strip supertab with multiple views
+ * must not be treated as a single-view page.
+ *
+ * Also requires a non-empty `componentState.name`. Core types mark
+ * `componentState` / `name` as optional, and a merge payload without a name
+ * is invalid — treat those layouts as non-mergeable page drags instead.
+ */
+export declare const getSingleViewComponent: (content: OpenFin.LayoutContent | undefined) => OpenFin.LayoutComponent | null;
 export declare const getLayoutConfig: (layoutContainerKey: string) => Promise<any>;
 export declare const findPageForView: (viewName: string, browserWindowIdentity?: WindowIdentity) => Promise<AttachedPage | undefined>;
 /**

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

@@ -6,6 +6,8 @@ import { ComponentName } from '../../../common/src/utils/usage-register';
 export declare const NavigationSource: {
     readonly DOCK_SEARCH_BUTTON: "dock-search-button";
     readonly DOCK_STORE_BUTTON: "dock-store-button";
+    readonly DOCK3_SEARCH_BUTTON: "dock3-search-button";
+    readonly DOCK3_STORE_BUTTON: "dock3-store-button";
     readonly HOME_ESC: "home-esc";
     readonly HOME_COMMAND: "home-command";
 };
@@ -21,3 +23,10 @@ export interface NavigateToOptions {
     source?: NavigationSourceType | null;
 }
 export declare const navigateTo: (componentName: ComponentName, platformIdentity: OpenFin.Identity, options?: NavigateToOptions) => Promise<void>;
+/** True when Home/Storefront was opened from classic Dock or Dock3. */
+export declare const wasOpenedFromDock: (source: string | null | undefined) => boolean;
+/**
+ * Show/focus the dock that opened Home or Storefront (classic vs Dock3).
+ * @returns true if the source was a dock opener (whether or not that dock was running).
+ */
+export declare const showOpenerDockForNavigationSource: (source: string | null | undefined, platformUuid: string) => Promise<boolean>;

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

@@ -171,5 +171,8 @@ export type SearchMenuChannelResponse = {
 } | {
     type: 'single-provider-results-announcement';
     message: string;
+} | {
+    /** Landing page was clicked. Chrome collapses search if view-focused never arrived. */
+    type: 'page-clicked';
 };
 export {};

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

@@ -28,7 +28,11 @@ export declare enum WindowName {
     DesktopSignalsModal = "here-desktop-signals-modal",
     IntentsResolverModal = "here-intents-resolver-modal",
     /** Browser-zone Home VPW window (platform child window). */
-    HomeVpw = "home-vpw"
+    HomeVpw = "home-vpw",
+    /** Browser-zone Storefront VPW window (platform child window). */
+    StorefrontVpw = "storefront-vpw",
+    /** Dock3 window (platform child window). */
+    Dock3 = "dock3"
 }
 export interface WindowIdentity {
     uuid: ApplicationUUID | string;
@@ -105,6 +109,12 @@ export declare const providerOFIdentity: {
     readonly name: ApplicationUUID.Workspace;
     readonly uuid: ApplicationUUID.Workspace;
 };
+/** Home VPW window identity under a platform UUID. */
+export declare const getHomeVpwOFIdentity: (platformUuid: string) => WindowIdentity;
+/** Storefront VPW window identity under a platform UUID. */
+export declare const getStorefrontVpwOFIdentity: (platformUuid: string) => WindowIdentity;
+/** Dock3 window identity under a platform UUID. */
+export declare const getDock3OFIdentity: (platformUuid: string) => WindowIdentity;
 /**
  * Get the Home OpenFin window.
  */
@@ -170,12 +180,32 @@ export declare const isStorefrontWindowRunning: () => Promise<boolean>;
 export declare const isDockWindowRunning: () => Promise<boolean>;
 export declare const isHomeWindowRunning: () => Promise<boolean>;
 export declare const isNotificationCenterRunning: () => Promise<boolean>;
+export declare const isProviderWindowRunning: () => Promise<boolean>;
 export declare const showAndFocusStorefront: () => Promise<void>;
 export declare const showAndFocusDock: () => Promise<void>;
 export declare const getDisableMultiplePagesOption: (identity: WindowIdentity) => Promise<any>;
 export declare const getIsLockedOption: (identity: WindowIdentity) => Promise<any>;
 export declare const getPlatformWindowTitle: (identity: WindowIdentity) => Promise<any>;
-export declare const getComponentWindowStatus: () => Promise<{
+/**
+ * Prefer a running Home VPW window for the platform; fall back to classic Home.
+ */
+export declare const resolvePreferredHomeIdentity: (platformUuid: string) => Promise<WindowIdentity | null>;
+/**
+ * Prefer a running Storefront VPW window for the platform; fall back to classic Storefront.
+ */
+export declare const resolvePreferredStorefrontIdentity: (platformUuid: string) => Promise<WindowIdentity | null>;
+export declare const showPreferredHomeWindow: (platformUuid: string) => Promise<void>;
+export declare const showPreferredStorefrontWindow: (platformUuid: string) => Promise<void>;
+/**
+ * Prefer a running Dock3 window for the platform; fall back to classic Dock.
+ */
+export declare const resolvePreferredDockIdentity: (platformUuid: string) => Promise<WindowIdentity | null>;
+export declare const showPreferredDockWindow: (platformUuid: string) => Promise<void>;
+/**
+ * Whether classic and/or VPW Home/Storefront windows are running.
+ * When `platformUuid` is provided, VPW windows under that platform count as running.
+ */
+export declare const getComponentWindowStatus: (platformUuid?: string) => Promise<{
     storefrontRunning: boolean;
     homeRunning: boolean;
 }>;

package/externals.report.json

@@ -2,7 +2,7 @@
     "@openfin/notifications": [
         {
             "type": "explicit",
-            "version": "45.1.0-alpha-4945",
+            "version": "45.1.0-alpha-5002",
             "packageName": "client-api/package.json",
             "issuer": "client-api/src/notifications.ts"
         }
@@ -43,30 +43,12 @@
             "issuer": "common/src/utils/layout.ts"
         }
     ],
-    "dexie": [
-        {
-            "type": "root-implicit",
-            "version": "^4.0.11",
-            "packageName": "dock3/package.json",
-            "issuer": "dock3/src/api/idb.ts"
-        },
-        {
-            "type": "explicit",
-            "version": "^4.0.11",
-            "packageName": "client-api-platform/package.json",
-            "issuer": "client-api-platform/src/api/dock/idb.ts"
-        },
-        {
-            "type": "explicit",
-            "version": "^4.0.11",
-            "packageName": "common/package.json",
-            "issuer": "common/src/utils/create-and-migrate-ibd-store.ts"
-        },
+    "lodash.clonedeep": [
         {
             "type": "explicit",
-            "version": "^4.0.11",
+            "version": "4.5.0",
             "packageName": "common/package.json",
-            "issuer": "common/src/api/pages/idb.ts"
+            "issuer": "common/src/utils/layout.ts"
         }
     ],
     "react-i18next": [
@@ -85,12 +67,30 @@
             "issuer": "common/src/api/i18next.ts"
         }
     ],
-    "lodash.clonedeep": [
+    "dexie": [
+        {
+            "type": "root-implicit",
+            "version": "^4.0.11",
+            "packageName": "dock3/package.json",
+            "issuer": "dock3/src/api/idb.ts"
+        },
         {
             "type": "explicit",
-            "version": "4.5.0",
+            "version": "^4.0.11",
+            "packageName": "client-api-platform/package.json",
+            "issuer": "client-api-platform/src/api/dock/idb.ts"
+        },
+        {
+            "type": "explicit",
+            "version": "^4.0.11",
             "packageName": "common/package.json",
-            "issuer": "common/src/utils/layout.ts"
+            "issuer": "common/src/utils/create-and-migrate-ibd-store.ts"
+        },
+        {
+            "type": "explicit",
+            "version": "^4.0.11",
+            "packageName": "common/package.json",
+            "issuer": "common/src/api/pages/idb.ts"
         }
     ]
 }