@openfin/workspace 45.1.15 → 45.1.17

package/client-api-platform/src/api/app-directory.d.ts

@@ -7,7 +7,7 @@ import type { LaunchAppRequest, SearchSitesRequest, SearchSitesResponse, Site }
  * @param app the app directory entry.
  * @param opts launch options.
  */
-export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.View | OpenFin.Identity | OpenFin.Platform | OpenFin.Application>;
+export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Identity | OpenFin.Platform | OpenFin.View | OpenFin.Application>;
 export declare const enterpriseAppDirectoryChannelClient: () => Promise<OpenFin.ChannelClient>;
 export declare function getResults(payload: {
     req: SearchSitesRequest;

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/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/env.d.ts

@@ -11,7 +11,7 @@ export declare const isDocumentDefined: boolean;
 export declare const isWindowDefinedWithIndexDB: boolean;
 export declare const finUUID: string;
 export declare const finName: string;
-export declare const finEntityType: "" | "window" | "view";
+export declare const finEntityType: "" | "view" | "window";
 export declare const isEnvLocal: boolean;
 export declare const isEnvDev: boolean;
 export declare const isEnvStaging: boolean;

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

@@ -29,6 +29,10 @@ export type SearchMenuChannelMessage = {
     type: 'update-search-menu-state';
 } | {
     type: 'ready';
+} | {
+    /** Browser window asks the search view whether its webContents owns focus. */
+    type: 'focus-query';
+    requestId: string;
 };
 export type BrowserSearchMenuKeyboardEvent = {
     type: string;
@@ -171,5 +175,10 @@ export type SearchMenuChannelResponse = {
 } | {
     type: 'single-provider-results-announcement';
     message: string;
+} | {
+    /** Answer to a 'focus-query' message: whether the search view's webContents owns focus. */
+    type: 'focus-state';
+    requestId: string;
+    hasFocus: boolean;
 };
 export {};

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

@@ -180,6 +180,7 @@ 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>;