@openfin/workspace 18.1.28 → 18.1.30

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) => Promise<void>;
+export declare const pageTabContextMenuItemHandler: (data: PageTabContextMenuItemData, payload: OpenPageTabContextMenuPayload, pageTabRect?: DOMRect) => Promise<void>;

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

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

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

@@ -352,6 +352,14 @@ 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.
  */
@@ -999,7 +1007,7 @@ export interface BrowserWindowModule {
     /** @internal */
     _openViewTabContextMenu(req: OpenViewTabContextMenuRequest): Promise<void>;
     /** @internal */
-    _openPageTabContextMenu(req: OpenPageTabContextMenuRequest): Promise<void>;
+    _openPageTabContextMenu(req: InternalOpenPageTabContextMenuRequest): Promise<void>;
     /** @internal */
     _openSaveButtonContextMenu(req: OpenSaveButtonContextMenuRequest): Promise<void>;
     /**

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

@@ -1,5 +1,6 @@
 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,7 +11,7 @@ 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, win?: OpenFin.Window, anchorBehavior?: AnchorBehavior) => Promise<ShowContextMenuResponse>;
+export declare const showEnterpriseContextMenu: (opts: OpenFin.ShowPopupMenuOptions, type: ContextMenuType, anchorBehavior: AnchorBehavior, 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/menu.d.ts

@@ -0,0 +1,22 @@
+import { SaveModalType } from '../../../client-api-platform/src/shapes';
+export declare enum Menu {
+    SAVE = "SAVE_MENU",
+    SHARE = "SHARE_MENU",
+    COLOR_LINK = "COLOR_LINK_MENU",
+    LAYOUT = "LAYOUT_MENU"
+}
+export interface UserMenuParams {
+    [Menu.SAVE]: {
+        id: string;
+        menuType: SaveModalType;
+        invocationId?: string;
+    };
+    [Menu.SHARE]: {
+        id: string;
+        title: string;
+    };
+    [Menu.LAYOUT]: null;
+    [Menu.COLOR_LINK]: {
+        selectedViews: string;
+    } | null;
+}

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

@@ -0,0 +1,59 @@
+import type OpenFin from '@openfin/core';
+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 declare enum SaveMenuType {
+    Save = "Save",
+    SaveAs = "SaveAs"
+}
+/**
+ * getSaveContextMenuTemplate
+ * @param saveMenuType accepts SaveMenuTypes, default SaveMenuType.Save
+ * @returns an array of objects for context menu
+ */
+export declare const getSaveContextMenuTemplate: (saveMenuType?: SaveMenuType) => OpenFin.MenuItemTemplate[];
+export declare function showModalWin<T extends keyof UserMenuParams>(params: UserMenuParams[T], windowOpts: OptionalExceptFor<OpenFin.WindowOptions, 'x' | 'y' | 'defaultWidth' | 'url' | 'name'>): Promise<OpenFin.Window>;
+export interface SearchMenuChannelRequest {
+    selectedViews: OpenFin.Identity[];
+    openViews: OpenFin.Identity[];
+    windowId: OpenFin.Identity;
+    type?: 'focus-view';
+}
+export declare enum ContextMenuType {
+    GlobalMenu = "global-menu",
+    ContextMenu = "context-menu",
+    RenameSupertab = "rename-supertab"
+}
+export type ContextMenuChannelMessageData = {
+    parentIdentity: OpenFin.Identity;
+    anchorBehavior: AnchorBehavior;
+    type: ContextMenuType;
+    x: number;
+    y: number;
+    payload: OpenFin.ShowPopupMenuOptions | {
+        pageId: string;
+    };
+};
+export type SearchMenuChannelResponse = {
+    type: 'search-response';
+    selectedSite?: Site;
+    searchText?: string;
+    selectedView: OpenFin.Identity;
+    inputUpdate?: string;
+    trigger?: SiteAction;
+} | {
+    type: 'expand-status-changed';
+    isExpanded: boolean;
+} | {
+    type: 'update-input';
+    inputText: string;
+    isSecure: boolean;
+    landingPage: boolean;
+} | {
+    type: 'resize-view';
+    isExpanded: boolean;
+    height: number;
+    width: number;
+};
+export declare function showPopupWin<T extends keyof UserMenuParams>(parentWindow: OpenFin.Window, params: UserMenuParams[T], windowOpts: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;