@openfin/workspace 18.1.22 → 18.1.24

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

@@ -1,9 +1,16 @@
 import type OpenFin from '@openfin/core';
-import { OpenGlobalContextMenuPayload, OpenGlobalContextMenuRequest, OpenPageTabContextMenuPayload, OpenPageTabContextMenuRequest, OpenSaveButtonContextMenuPayload, OpenSaveButtonContextMenuRequest, OpenViewTabContextMenuPayload, OpenViewTabContextMenuRequest, WorkspacePlatformProvider } from '../../../../client-api-platform/src/shapes';
-export declare function openGlobalContextMenuInternal(this: WorkspacePlatformProvider, payload: OpenGlobalContextMenuRequest & {
+import { InternalOpenGlobalContextMenuRequest, OpenGlobalContextMenuPayload, OpenPageTabContextMenuPayload, OpenPageTabContextMenuRequest, OpenSaveButtonContextMenuPayload, OpenSaveButtonContextMenuRequest, OpenViewTabContextMenuPayload, OpenViewTabContextMenuRequest, WorkspacePlatformProvider } from '../../../../client-api-platform/src/shapes';
+export declare enum AnchorBehavior {
+    BottomLeft = 0,
+    BottomRight = 1,
+    TopLeft = 2,
+    TopRight = 3,
+    Center = 4
+}
+export declare const openCommonContextMenu: (payload: OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload, _callerIdentity: OpenFin.Identity, anchorBehavior?: AnchorBehavior) => Promise<void>;
+export declare function openGlobalContextMenuInternal(this: WorkspacePlatformProvider, payload: InternalOpenGlobalContextMenuRequest & {
     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>;

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

@@ -40,3 +40,4 @@ export declare const closeOtherPagesHandler: (identity: OpenFin.Identity, pageId
  * @param viewIdentities Array of views to execute print on.
  */
 export declare const printSelectedViews: (viewIdentities: OpenFin.Identity[]) => Promise<void>;
+export declare const deletePageHandler: (identity: OpenFin.Identity, pageId?: string) => Promise<void>;

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

@@ -4,7 +4,7 @@ import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/ut
 import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 import { Resource } from '../../common/src/api/i18next';
 import { TrackedSite } from '../../common/src/api/pages/idb';
-import type { AttachedPage, CopyPagePayload, HandleSaveModalOnPageClosePayload, Page, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult } from '../../common/src/api/pages/shapes';
+import type { AddDefaultPagePayload, AttachedPage, CopyPagePayload, HandleSaveModalOnPageClosePayload, Page, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult } from '../../common/src/api/pages/shapes';
 import { SetActivePageForWindowPayload } from '../../common/src/api/pages/shapes';
 import { NotificationsCustomManifestOptions } from '../../common/src/api/shapes/notifications';
 import type { CustomThemes } from '../../common/src/api/theming';
@@ -87,9 +87,9 @@ export interface ReorderPagesRequest {
  * Request for opening a logo context menu in Browser.
  */
 export interface OpenGlobalContextMenuRequest {
-    /** Screen x-coordinate where context menu should be shown. */
+    /** Client x-coordinate where context menu should be shown. */
     x: number;
-    /** Screen y-coordinate where context menu should be shown. */
+    /** Client y-coordinate where context menu should be shown. */
     y: number;
     /** Miscellaneous options necessary for implementing custom logic in the provider override. */
     customData?: any;
@@ -154,6 +154,7 @@ export declare enum PageTabContextMenuOptionType {
     Rename = "Rename",
     Save = "Save",
     SaveAs = "Save As",
+    DeletePage = "Delete Page",
     SaveWorkspaceAs = "SaveWorkspaceAs",
     Refresh = "Refresh",
     CloseOthers = "Close others",
@@ -224,28 +225,37 @@ 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 {
-    /** Screen x-coordinate where context menu should be shown. */
+    /** Client x-coordinate where context menu should be shown. */
     x: number;
-    /** Screen y-coordinate where context menu should be shown. */
+    /** Client 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 {
-    /** Screen x-coordinate where context menu should be shown. */
+    /** Client x-coordinate where context menu should be shown. */
     x: number;
-    /** Screen y-coordinate where context menu should be shown. */
+    /** Client y-coordinate where context menu should be shown. */
     y: number;
     /** Miscellaneous options necessary for implementing custom logic in the provider override. */
     customData?: any;
@@ -522,9 +532,9 @@ export interface SaveButtonContextMenuItemTemplate extends OpenFin.MenuItemTempl
  * Request for opening a context menu from save button in Browser.
  */
 export interface OpenSaveButtonContextMenuRequest {
-    /** Screen x-coordinate where context menu should be shown. */
+    /** Client x-coordinate where context menu should be shown. */
     x: number;
-    /** Screen y-coordinate where context menu should be shown. */
+    /** Client y-coordinate where context menu should be shown. */
     y: number;
     /** Screen x-coordinate of save button */
     buttonLeft: number;
@@ -985,7 +995,7 @@ export interface BrowserWindowModule {
      * @param req the global context menu request.
      * @internal
      */
-    _openGlobalContextMenu(req: OpenGlobalContextMenuRequest): Promise<void>;
+    _openGlobalContextMenu(req: InternalOpenGlobalContextMenuRequest): Promise<void>;
     /** @internal */
     _openViewTabContextMenu(req: OpenViewTabContextMenuRequest): Promise<void>;
     /** @internal */
@@ -1028,6 +1038,19 @@ export interface BrowserWindowModule {
     _reparentPage(req: ReparentPageRequest & {
         index?: number;
     }): Promise<void>;
+    /**
+     * ```ts
+     *
+     * const newPage = await makeNewLandingPage();
+     * const { newPageUrl } = await getLandingPageUrls();
+     * const browser = getCurrentSync().Browser.wrapSync(currentOFIdentity);
+     * const actualNewPageUrl = newPageUrl ? newPageUrl : undefined;
+     * await browser._addDefaultPage({ identity: currentOFIdentity, page: newPage, newPageUrl: actualNewPageUrl });
+     * ```
+     * @param req the default page request object
+     * @internal
+     */
+    _addDefaultPage(req: AddDefaultPagePayload): Promise<void>;
     /** @internal */
     _trackRemovedTab(req: any): Promise<void>;
     /** @internal */
@@ -1053,6 +1076,7 @@ export type NavigationRequest = {
     viewIdentity: OpenFin.Identity;
 } & ({
     action: 'result-selected';
+    trigger?: SiteAction;
     site: Site;
 } | (SearchSitesRequest & {
     action: 'search-input';
@@ -1066,29 +1090,53 @@ export type SearchSitesRequest = {
 /**
  * @internal
  */
-export type SearchSitesResponse = {
-    suggestions?: Site[];
-    favorites?: Site[];
-    bookmarks?: Site[];
-    platformContent?: Site[];
+export type SearchSitesResponse = Record<string, Site[]>;
+/**
+ * @internal
+ */
+export type SiteAction = {
+    id: string;
+    title: string;
+    altText?: string;
+    lightIcon?: string;
+    darkIcon?: string;
 };
 /**
  * @internal
  */
-export type Site = {
+export type SiteInfo = {
     id: string;
     title: string;
+    subTitle?: string;
     cta?: string;
+    actions?: SiteAction[];
+};
+/**
+ * @internal
+ */
+export type AppSite = SiteInfo & {
     type: 'app' | 'website';
-    url: string;
+    url?: string;
     icon: string;
     customData?: unknown;
-} | {
-    id: string;
-    title: string;
-    cta?: string;
+};
+/**
+ * @internal
+ */
+export type WorkspaceSite = SiteInfo & {
     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.
  */
@@ -1820,6 +1868,11 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
      * @param locale in ISO language code format
      */
     setLanguage(locale: Locale): Promise<void>;
+    /**
+     * Implementation for adding custom default page
+     * @param payload {@link AddDefaultPagePayload}
+     */
+    addDefaultPage(payload: AddDefaultPagePayload): Promise<void>;
     /** @internal */
     restoreRemovedTabInternal(): Promise<void>;
     /** @internal */

package/common/src/api/pages/shapes.d.ts

@@ -213,4 +213,18 @@ export interface CopyPagePayload {
     /** Specifies the trigger for creating a copy. */
     reason: 'save-as' | 'duplicate';
 }
+export type AddDefaultPagePayload = {
+    /** The OF window identity to attach the pages to. */
+    identity: OpenFin.Identity;
+    /** The page to attach. */
+    page: PageWithUpdatableRuntimeAttribs;
+    /** The newPageUrl provided. */
+    newPageUrl: string;
+};
+export type AddPagePayload = {
+    /** The OF window identity to attach the pages to. */
+    identity: OpenFin.Identity;
+    /** The page to attach. */
+    page: PageWithUpdatableRuntimeAttribs;
+};
 export {};

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

@@ -24,6 +24,8 @@ export declare enum WorkspacePlatformChannelAction {
     DetachPagesFromWindow = "detachPagesFromWindow",
     ReorderPagesForWindow = "reorderPagesForWindow",
     SetActivePage = "setActivePage",
+    AddPage = "addPage",
+    AddDefaultPage = "addDefaultPage",
     GetAllAttachedPages = "getAllAttachedPages",
     GetActivePageIdForWindow = "getActivePageIdForWindow",
     GetPagesForWindow = "getPagesForWindow",

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

@@ -1,4 +1,5 @@
 import type OpenFin from '@openfin/core';
+import { AnchorBehavior } from '../../../client-api-platform/src/api/context-menu';
 export declare enum MenuItemType {
     Label = "normal",
     Separator = "separator",
@@ -8,7 +9,8 @@ export declare enum MenuItemType {
 export type ShowContextMenuResponse = OpenFin.MenuResult & {
     data: any;
 };
-export default function showContextMenu(opts: OpenFin.ShowPopupMenuOptions, win?: OpenFin.Window): Promise<ShowContextMenuResponse>;
+export declare function showContextMenu(opts: OpenFin.ShowPopupMenuOptions, win?: OpenFin.Window): Promise<ShowContextMenuResponse>;
+export declare const showEnterpriseContextMenu: (opts: OpenFin.ShowPopupMenuOptions, win?: OpenFin.Window, anchorBehavior?: AnchorBehavior) => 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,7 +22,8 @@ export declare enum PageRoute {
     Storefront = "/storefront/",
     DeprecatedAlert = "/provider/deprecated-alert/",
     Analytics = "/provider/analytics/",
-    EnterpriseBrowser = "/browser/enterprise/"
+    EnterpriseBrowser = "/browser/enterprise/",
+    EnterpriseContextMenu = "/browser/enterprise/context-menu/"
 }
 export declare const Assets: {
     readonly IconOpenFinLogo: "/icons/openfinlogo.svg";

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

@@ -10,6 +10,7 @@ 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 {

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

@@ -1,6 +1,7 @@
 import type OpenFin from '@openfin/core';
 import { ResponseModalConfig } from '../../../common/src/utils/menu-config';
 export declare const restoreChangesMenu: (windowIdentity: OpenFin.Identity) => Promise<ResponseModalConfig>;
+export declare const deletePageMenu: (windowIdentity: OpenFin.Identity, pageTitle: string) => Promise<ResponseModalConfig>;
 /**
  *
  * @param targetWindowIdentity Parent or Current OpenFin Window Identity
@@ -21,3 +22,4 @@ export declare const showPlatformQuitModal: (windowIdentity: OpenFin.Identity, w
 export declare const showQuitBrowserModal: (windowIdentity: OpenFin.Identity) => Promise<boolean>;
 export declare const showRestoreChangesModal: (windowIdentity: OpenFin.Identity) => Promise<boolean>;
 export declare const getOverwriteWorkspaceMenu: (workspaceTitle: string) => Promise<ResponseModalConfig>;
+export declare const showDeletePageModal: (windowIdentity: OpenFin.Identity, pageTitle: string) => Promise<boolean>;