@openfin/workspace-platform 20.2.1 → 20.2.2

package/browser/src/components/ControlBar/SearchMenu/useSelectedAndOpenViewsBroadcastChannel.d.ts

@@ -1,7 +1,7 @@
 import { MutableRefObject } from 'react';
 import type OpenFin from '@openfin/core';
-import { SearchMenuChannelRequest } from '../../../../../common/src/utils/popup-window';
-export declare const useSelectedAndOpenViewsBroadcastChannel: (additionalCallBack?: (ev: MessageEvent<SearchMenuChannelRequest>) => void) => {
+import { SearchMenuChannelUpdateState } from '../../../../../common/src/utils/popup-window';
+export declare const useSelectedAndOpenViewsBroadcastChannel: (additionalCallBack?: (ev: MessageEvent<SearchMenuChannelUpdateState>) => void) => {
     selectedViews: OpenFin.Identity[];
     openViews: OpenFin.Identity[];
     searchMenuChannel: MutableRefObject<BroadcastChannel>;

package/browser/src/hooks/EnterpriseSearchMenu/AdjustSearchMenuDimensions/useAdjustSearchMenuViewDimensions.d.ts

@@ -1,4 +1,3 @@
-import { SearchSitesResponse, Site } from '../../../../../client-api-platform/src/index';
 export declare const MENU_BOUNDS: {
     expanded: {
         minWidth: number;
@@ -20,10 +19,7 @@ export declare const MENU_BOUNDS: {
  * @param {React.RefObject<HTMLElement>} containerRef - Ref object pointing to the container element of the search menu.
  * @param {boolean} shouldExpand - Boolean indicating if the search results view should expand.
  * @param {React.RefObject<BroadcastChannel>} searchMenuChannel - Ref object for the broadcast channel used to communicate with the browser window.
- * @param {SearchSitesResponse} searchResults - The current search results. (Displayed in the ResultsContainer)
- * @param {string} searchText - String representing the current text in the address input.
- * @param {Site[]} recentlyVisited - Array of recently visited sites. (Displayed in the EmptySearchInputContainer)
- * @param {Site[]} curatedContent - Array of curated content sites. (Displayed in the EmptySearchInputContainer)
+ * @param {boolean} shouldShowEmptySearchContainer - Boolean indicating if the emptySearchInputContainer container should be shown.
  */
-declare const useAdjustSearchMenuViewDimensions: (containerRef: React.RefObject<HTMLElement>, shouldExpand: boolean, searchMenuChannel: React.RefObject<BroadcastChannel>, searchResults: SearchSitesResponse, recentlyVisited: Site[], curatedContent: Site[], shouldShowEmptySearchContainer: boolean) => void;
+declare const useAdjustSearchMenuViewDimensions: (containerRef: React.RefObject<HTMLElement>, shouldExpand: boolean, searchMenuChannel: React.RefObject<BroadcastChannel>, shouldShowEmptySearchContainer: boolean) => void;
 export default useAdjustSearchMenuViewDimensions;

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

@@ -1,10 +1,20 @@
 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';
+/**
+ * Enum representing the possible anchor behaviors for positioning context menus.
+ * These are relative to an element/cursor position (as opposed to a corner of the context menu window).
+ *
+ * e.g. AnchorBehavior.BottomRight implies a context menu will expand aligned with the bottom and right edge of an element.
+ *
+ * @enum {number}
+ */
 export declare enum AnchorBehavior {
-    BottomLeft = 0,
-    BottomRight = 1,
-    Center = 2
+    TopLeft = 0,
+    TopRight = 1,
+    BottomLeft = 2,
+    BottomRight = 3,
+    Center = 4
 }
 type ContextMenuPayload = OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload;
 export declare const openCommonContextMenu: (payload: ContextMenuPayload, _callerIdentity: OpenFin.Identity, type?: ContextMenuType, anchorBehavior?: AnchorBehavior) => Promise<void>;

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

@@ -18,3 +18,10 @@ export declare const DefaultSaveMenuBounds: {
     width: number;
     height: number;
 };
+export declare const getBoundsBasedOnAnchorBehavior: (bounds: OpenFin.Bounds, anchorBehavior: AnchorBehavior) => OpenFin.Bounds | {
+    bottom: number;
+    top: number;
+    left: number;
+    height: number;
+    width: number;
+};

package/common/src/utils/modal-bounds.d.ts

@@ -18,3 +18,19 @@ export declare const getCenterOfParentWindowMonitor: (parentWindowIdentity?: Ope
  */
 export declare const getResponseModalBounds: (modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean) => Promise<OpenFin.Bounds>;
 export declare function getResponseModalBoundsAndCenterParentIfModalOffScreen(modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean): Promise<OpenFin.Bounds>;
+/**
+ * Adjusts the given bounds to be within the closest monitor's available bounds if they are offscreen.
+ *
+ * @param {OpenFin.Bounds} bounds - The bounds to be adjusted.
+ * @returns {Promise<OpenFin.Bounds>} - The adjusted bounds that are within the closest monitor's available bounds.
+ */
+export declare function getClosestBoundsIfModalBoundsOffscreen(bounds: OpenFin.Bounds): Promise<OpenFin.Bounds>;
+/**
+ * Adjusts the given bounds if they are offscreen to be within the closest monitor's available bounds.
+ * Returns bounds relative to the parent window's bounds (as opposed to bounds relative to the monitor).
+ *
+ * @param {OpenFin.WindowBounds} parentWindowBounds - The bounds of the parent window.
+ * @param {OpenFin.Bounds} bounds - The bounds to be adjusted.
+ * @returns {Promise<OpenFin.Bounds>} - The adjusted bounds that are within the closest monitor's available bounds relative to the parent window's bounds.
+ */
+export declare const getClosestRelativeBoundsIfModalBoundsOffscreen: (parentWindowBounds: OpenFin.WindowBounds, bounds: OpenFin.Bounds) => Promise<OpenFin.Bounds>;

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

@@ -9,11 +9,6 @@ export declare enum SaveMenuType {
     SaveAs = "SaveAs"
 }
 export declare function showModalWin<T extends keyof UserMenuParams>(params: UserMenuParams[T], windowOpts: OptionalExceptFor<OpenFin.WindowOptions, 'x' | 'y' | 'defaultWidth' | 'url' | 'name'>): Promise<OpenFin.Window>;
-export type SearchMenuChannelViewResized = {
-    type: 'view-resized';
-    height: number;
-    width: number;
-};
 export type SearchMenuChannelUpdateState = {
     selectedViews: OpenFin.Identity[];
     openViews: OpenFin.Identity[];
@@ -32,7 +27,6 @@ export type BrowserSearchMenuKeyboardEvent = {
         altKey?: boolean;
     };
 };
-export type SearchMenuChannelRequest = SearchMenuChannelViewResized | SearchMenuChannelUpdateState;
 export declare enum ContextMenuType {
     GlobalMenu = "global-menu",
     ContextMenu = "context-menu",

package/common/src/utils/router/base.d.ts

@@ -37,7 +37,7 @@ export declare function getAbsoluteRoutePath(route: PageRoute | string): string;
  * The base path of the router contains the router's zone as a postfix.
  */
 export declare function getBasePath(): string;
-export declare function resolveAbsolutePath(path: string): string;
+export declare function resolveAbsolutePath(path: string, baseUrl?: URL): string;
 /**
  * Gets the path to the route with the router's base path.
  * @param route the route.

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

@@ -174,5 +174,5 @@ export declare const getWindowBounds: (window: OpenFin.Window) => Promise<OpenFi
  * @param monitor the monitor to check against
  */
 export declare function getPercentageOfBoundsInMonitor(bounds: OpenFin.Bounds, monitor: OpenFin.MonitorDetails): number;
-export declare function getMonitorWindowMaximizedOn(parentWindowBounds: OpenFin.WindowBounds): Promise<OpenFin.MonitorDetails>;
+export declare function getMonitorWindowMaximizedOn(parentWindowBounds: OpenFin.Bounds): Promise<OpenFin.MonitorDetails>;
 export {};