@openfin/workspace 18.1.30 → 19.0.1

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

@@ -1,5 +1,4 @@
 import type OpenFin from '@openfin/core';
-import { App } from '../../../client-api/src/shapes';
 import type { LaunchAppRequest, SearchSitesRequest, SearchSitesResponse, Site } from '../shapes';
 /**
  * Launch the app described by an App Directory entry.
@@ -16,6 +15,3 @@ export declare function getResults(payload: {
 export declare function getCuratedContent(payload: {
     identity: OpenFin.Identity;
 }): Promise<Site[]>;
-export declare function getRecentlyVisited(payload: {
-    identity: OpenFin.Identity;
-}): Promise<App[]>;

package/client-api-platform/src/api/context-menu/browser-pagetab-handler.d.ts

@@ -1,3 +1,3 @@
 import { OpenPageTabContextMenuPayload } from '../../../../client-api-platform/src/index';
 import { PageTabContextMenuItemData } from '../../../../client-api-platform/src/shapes';
-export declare const pageTabContextMenuItemHandler: (data: PageTabContextMenuItemData, payload: OpenPageTabContextMenuPayload, pageTabRect?: DOMRect) => Promise<void>;
+export declare const pageTabContextMenuItemHandler: (data: PageTabContextMenuItemData, payload: OpenPageTabContextMenuPayload) => Promise<void>;

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

@@ -1,19 +1,13 @@
 import type OpenFin from '@openfin/core';
-import { ContextMenuType } from '../../../../common/src/utils/popup-window';
-import { InternalOpenGlobalContextMenuRequest, InternalOpenPageTabContextMenuRequest, OpenGlobalContextMenuPayload, OpenPageTabContextMenuPayload, OpenSaveButtonContextMenuPayload, OpenSaveButtonContextMenuRequest, OpenViewTabContextMenuPayload, OpenViewTabContextMenuRequest, WorkspacePlatformProvider } from '../../../../client-api-platform/src/shapes';
-export declare enum AnchorBehavior {
-    BottomLeft = 0,
-    BottomRight = 1,
-    Center = 2
-}
-export declare const openCommonContextMenu: (payload: OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload, _callerIdentity: OpenFin.Identity, type?: ContextMenuType, anchorBehavior?: AnchorBehavior) => Promise<void>;
-export declare function openGlobalContextMenuInternal(this: WorkspacePlatformProvider, payload: InternalOpenGlobalContextMenuRequest & {
+import { OpenGlobalContextMenuPayload, OpenGlobalContextMenuRequest, OpenPageTabContextMenuPayload, OpenPageTabContextMenuRequest, OpenSaveButtonContextMenuPayload, OpenSaveButtonContextMenuRequest, OpenViewTabContextMenuPayload, OpenViewTabContextMenuRequest, WorkspacePlatformProvider } from '../../../../client-api-platform/src/shapes';
+export declare function openGlobalContextMenuInternal(this: WorkspacePlatformProvider, payload: OpenGlobalContextMenuRequest & {
     identity: OpenFin.Identity;
 }, callerIdentity: OpenFin.Identity): Promise<void>;
+export declare const openCommonContextMenu: (payload: OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload, _callerIdentity: OpenFin.Identity) => Promise<void>;
 export declare function openViewTabContextMenuInternal(this: WorkspacePlatformProvider, payload: OpenViewTabContextMenuRequest & {
     identity: OpenFin.Identity;
 }, callerIdentity: OpenFin.Identity): Promise<void>;
-export declare function openPageTabContextMenuInternal(this: WorkspacePlatformProvider, payload: InternalOpenPageTabContextMenuRequest & {
+export declare function openPageTabContextMenuInternal(this: WorkspacePlatformProvider, payload: OpenPageTabContextMenuRequest & {
     identity: OpenFin.Identity;
 }, callerIdentity: OpenFin.Identity): Promise<void>;
 export declare function openSaveButtonContextMenuInternal(this: WorkspacePlatformProvider, payload: OpenSaveButtonContextMenuRequest & {

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

@@ -87,9 +87,9 @@ export interface ReorderPagesRequest {
  * Request for opening a logo context menu in Browser.
  */
 export interface OpenGlobalContextMenuRequest {
-    /** Client x-coordinate where context menu should be shown. */
+    /** Screen x-coordinate where context menu should be shown. */
     x: number;
-    /** Client y-coordinate where context menu should be shown. */
+    /** Screen y-coordinate where context menu should be shown. */
     y: number;
     /** Miscellaneous options necessary for implementing custom logic in the provider override. */
     customData?: any;
@@ -225,37 +225,28 @@ export type OpenGlobalContextMenuPayload = OpenGlobalContextMenuRequest & {
     /** Default function that handles stock context menu options. */
     callback: (data: GlobalContextMenuItemData, payload: OpenGlobalContextMenuPayload) => any;
 };
-/**
- * Request for opening the global context menu with custom context menu in Enterprise Browser.
- * @internal
- */
-export type InternalOpenGlobalContextMenuRequest = OpenGlobalContextMenuRequest & {
-    /** Coordinates associated with a target element for a custom context menu request. */
-    rect?: DOMRect;
-};
 export type ViewTabContextMenuTemplate = OpenFin.MenuItemTemplate<ViewTabMenuData>;
 /**
  * Request for opening a view tab context menu in Browser.
  */
 export interface OpenViewTabContextMenuRequest {
-    /** Client x-coordinate where context menu should be shown. */
+    /** Screen x-coordinate where context menu should be shown. */
     x: number;
-    /** Client y-coordinate where context menu should be shown. */
+    /** Screen y-coordinate where context menu should be shown. */
     y: number;
     /** Miscellaneous options necessary for implementing custom logic in the provider override. */
     customData?: any;
     /** Template defining the options to show in the context menu. */
     template: ViewTabContextMenuTemplate[];
-    /** Ids of selected views */
     selectedViews: OpenFin.Identity[];
 }
 /**
  * Request for opening a page tab context menu in Browser.
  */
 export interface OpenPageTabContextMenuRequest {
-    /** Client x-coordinate where context menu should be shown. */
+    /** Screen x-coordinate where context menu should be shown. */
     x: number;
-    /** Client y-coordinate where context menu should be shown. */
+    /** Screen y-coordinate where context menu should be shown. */
     y: number;
     /** Miscellaneous options necessary for implementing custom logic in the provider override. */
     customData?: any;
@@ -352,14 +343,6 @@ export type OpenPageTabContextMenuPayload = OpenPageTabContextMenuRequest & {
     /** Default function that handles stock context menu options. */
     callback: (data: PageTabContextMenuItemData, req: OpenPageTabContextMenuPayload) => any;
 };
-/**
- * Request for opening the global context menu with custom context menu in Enterprise Browser.
- * @internal
- */
-export type InternalOpenPageTabContextMenuRequest = OpenPageTabContextMenuRequest & {
-    /** Coordinates associated with a target element for a custom context menu request. */
-    rect?: DOMRect;
-};
 /**
  * Request to update the attributes of a page in which is attached to a running browser window.
  */
@@ -540,9 +523,9 @@ export interface SaveButtonContextMenuItemTemplate extends OpenFin.MenuItemTempl
  * Request for opening a context menu from save button in Browser.
  */
 export interface OpenSaveButtonContextMenuRequest {
-    /** Client x-coordinate where context menu should be shown. */
+    /** Screen x-coordinate where context menu should be shown. */
     x: number;
-    /** Client y-coordinate where context menu should be shown. */
+    /** Screen y-coordinate where context menu should be shown. */
     y: number;
     /** Screen x-coordinate of save button */
     buttonLeft: number;
@@ -1003,11 +986,11 @@ export interface BrowserWindowModule {
      * @param req the global context menu request.
      * @internal
      */
-    _openGlobalContextMenu(req: InternalOpenGlobalContextMenuRequest): Promise<void>;
+    _openGlobalContextMenu(req: OpenGlobalContextMenuRequest): Promise<void>;
     /** @internal */
     _openViewTabContextMenu(req: OpenViewTabContextMenuRequest): Promise<void>;
     /** @internal */
-    _openPageTabContextMenu(req: InternalOpenPageTabContextMenuRequest): Promise<void>;
+    _openPageTabContextMenu(req: OpenPageTabContextMenuRequest): Promise<void>;
     /** @internal */
     _openSaveButtonContextMenu(req: OpenSaveButtonContextMenuRequest): Promise<void>;
     /**
@@ -1066,7 +1049,7 @@ export interface BrowserWindowModule {
     /** @internal */
     _trackVisitedSite(req: any): Promise<void>;
     /** @internal */
-    _getRecentlyVisitedSites(req?: number): Promise<any[]>;
+    _getRecentVisitedSites(req?: number): Promise<any[]>;
     /** @internal */
     _getFrequentlyVisitedSites(req?: any): Promise<any[]>;
     /** @internal */
@@ -1084,7 +1067,6 @@ export type NavigationRequest = {
     viewIdentity: OpenFin.Identity;
 } & ({
     action: 'result-selected';
-    trigger?: SiteAction;
     site: Site;
 } | (SearchSitesRequest & {
     action: 'search-input';
@@ -1098,58 +1080,29 @@ export type SearchSitesRequest = {
 /**
  * @internal
  */
-export type SearchSitesResponse = Record<string, Site[]>;
-/**
- * @internal
- */
-export type SiteAction = {
-    id: string;
-    title: string;
-    altText?: string;
-    lightIcon?: string;
-    darkIcon?: string;
+export type SearchSitesResponse = {
+    suggestions?: Site[];
+    favorites?: Site[];
+    bookmarks?: Site[];
+    platformContent?: Site[];
 };
 /**
  * @internal
  */
-export type SiteInfo = {
+export type Site = {
     id: string;
     title: string;
-    subTitle?: string;
     cta?: string;
-    actions?: SiteAction[];
-};
-/**
- * @internal
- */
-export type AppSite = SiteInfo & {
     type: 'app' | 'website';
-    url?: string;
+    url: string;
     icon: string;
-    options?: {
-        icon?: {
-            size?: 'standard' | 'large';
-        };
-    };
     customData?: unknown;
-};
-/**
- * @internal
- */
-export type WorkspaceSite = SiteInfo & {
+} | {
+    id: string;
+    title: string;
+    cta?: string;
     type: 'page' | 'workspace';
 };
-/**
- * @internal
- */
-export type Site = AppSite | WorkspaceSite;
-/**
- * @internal
- * action is undefined when the site is actioned with the default action.
- */
-export type ActionedSite = Site & {
-    action?: SiteAction;
-};
 /**
  * Factory for wrapping browser windows and global operations.
  */

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

@@ -56,8 +56,7 @@ export declare enum PageChannelAction {
  */
 export declare enum EnterpriseAppDirectoryChannelAction {
     GetApps = "get-apps",
-    GetCuratedContent = "get-curated-content",
-    GetRecentlyVisited = "get-recently-visited"
+    GetCuratedContent = "get-curated-content"
 }
 export declare const BrowserChannelAction: {
     GetPages: PageChannelAction.GetPages;

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

@@ -65,7 +65,7 @@ export declare enum WorkspacePlatformChannelAction {
     TrackRemovedTabInternal = "trackRemovedTabInternal",
     RestoreRemovedTabInternal = "restoreRemovedTabInternal",
     TrackVisitedSiteInternal = "trackVisitedSiteInternal",
-    GetRecentlyVisitedSitesInternal = "getRecentlyVisitedSitesInternal",
+    GetRecentVisitedSitesInternal = "getRecentVisitedSitesInternal",
     GetFrequentlyVisitedSitesInternal = "getFrequentlyVisitedSitesInternal",
     SearchSitesInternal = "searchSitesInternal",
     GetCuratedContentInternal = "getCuratedContentInternal",

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

@@ -121,6 +121,10 @@ export interface CustomThemeOptionsWithScheme extends BaseThemeOptions {
     notificationIndicatorColors?: NotificationIndicatorColorsWithScheme;
 }
 export type CustomThemes = (CustomThemeOptions | CustomThemeOptionsWithScheme)[];
+export interface PreloadedThemeData {
+    themes: CustomThemes;
+    selectedScheme: ColorSchemeOptionType;
+}
 export interface DefaultPaletteSet {
     brandPrimary: string;
     brandSecondary: string;

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

@@ -1,6 +1,4 @@
 import type OpenFin from '@openfin/core';
-import { AnchorBehavior } from '../../../client-api-platform/src/api/context-menu';
-import { ContextMenuType } from './popup-window';
 export declare enum MenuItemType {
     Label = "normal",
     Separator = "separator",
@@ -10,8 +8,7 @@ export declare enum MenuItemType {
 export type ShowContextMenuResponse = OpenFin.MenuResult & {
     data: any;
 };
-export declare function showContextMenu(opts: OpenFin.ShowPopupMenuOptions, win?: OpenFin.Window): Promise<ShowContextMenuResponse>;
-export declare const showEnterpriseContextMenu: (opts: OpenFin.ShowPopupMenuOptions, type: ContextMenuType, anchorBehavior: AnchorBehavior, win?: OpenFin.Window) => Promise<ShowContextMenuResponse>;
+export default function showContextMenu(opts: OpenFin.ShowPopupMenuOptions, 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/route.d.ts

@@ -22,8 +22,7 @@ export declare enum PageRoute {
     Storefront = "/storefront/",
     DeprecatedAlert = "/provider/deprecated-alert/",
     Analytics = "/provider/analytics/",
-    EnterpriseBrowser = "/browser/enterprise/",
-    EnterpriseContextMenu = "/browser/enterprise/context-menu/"
+    EnterpriseBrowser = "/browser/enterprise/"
 }
 export declare const Assets: {
     readonly IconOpenFinLogo: "/icons/openfinlogo.svg";

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

@@ -10,7 +10,6 @@ export declare enum WindowName {
     BrowserIndicator = "openfin-browser-indicator",
     BrowserWindow = "internal-generated-window",
     ClassicWindow = "internal-generated-classic-window",
-    EnterpriseContextMenu = "openfin-enterprise-context-menu",
     BrowserAddressSearchPrefix = "openfin-browser-menu-address-search-"
 }
 export interface WindowIdentity {