@openfin/workspace-platform 22.4.1 → 22.5.0

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

@@ -1,5 +1,10 @@
 import type OpenFin from '@openfin/core';
+import { PositioningType } from '../../../../common/src/utils/positioning';
 import { WorkspaceContextMenuItemData } from '../../../../client-api-platform/src/shapes';
+export declare const saveWorkspaceHandlerWithInjectables: ({ showModal, afterSuccessSave }: {
+    showModal?: () => Promise<void>;
+    afterSuccessSave?: () => Promise<void>;
+}) => Promise<void>;
 export declare const saveWorkspaceHandler: (identity: OpenFin.Identity) => Promise<void>;
 export declare const saveWorkspaceAsHandler: (identity: OpenFin.Identity) => void;
 /**
@@ -17,6 +22,11 @@ export declare const savePageHandler: (identity: OpenFin.Identity, pageId?: stri
  */
 export declare const savePageAsHandler: (identity: OpenFin.Identity, pageId?: string) => Promise<void>;
 export declare const switchWorkspaceHandler: (winIdentity: OpenFin.Identity, workspaceItemData: WorkspaceContextMenuItemData) => Promise<void>;
+export declare const deleteWorkspaceHandlerWithPayload: ({ workspaceItemData, winIdentity, positioning }: {
+    workspaceItemData: WorkspaceContextMenuItemData;
+    winIdentity?: OpenFin.Identity;
+    positioning?: PositioningType;
+}) => Promise<void>;
 export declare const deleteWorkspaceHandler: (winIdentity: OpenFin.Identity, workspaceItemData: WorkspaceContextMenuItemData) => Promise<void>;
 export declare const downloadsHandler: (identity: OpenFin.Identity) => Promise<void>;
 /**

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

@@ -2304,6 +2304,10 @@ export interface UpdateSavedWorkspaceRequest {
     /** The updated workspace. */
     workspace: Workspace;
 }
+export type OpenSaveWorkspaceMenuRequest = {
+    menuType: SaveModalType.SAVE_WORKSPACE | SaveModalType.SAVE_WORKSPACE_AS | SaveModalType.RENAME_WORKSPACE;
+    id?: never;
+};
 /**
  * Request to create a save modal.
  * @private
@@ -2311,10 +2315,7 @@ export interface UpdateSavedWorkspaceRequest {
 export type OpenSaveMenuRequest = {
     menuType: SaveModalType.SAVE_PAGE | SaveModalType.SAVE_PAGE_AS | SaveModalType.RENAME_PAGE;
     id: string;
-} | {
-    menuType: SaveModalType.SAVE_WORKSPACE | SaveModalType.SAVE_WORKSPACE_AS | SaveModalType.RENAME_WORKSPACE;
-    id?: never;
-};
+} | OpenSaveWorkspaceMenuRequest;
 export type TaskbarIcon = {
     dark: string;
     light: string;

package/common/src/components/IndicatorContainer/bounds.d.ts

@@ -0,0 +1,14 @@
+import type OpenFin from '@openfin/core';
+import { IndicatorBounds, IndicatorOptions, WindowSize } from './types';
+/**
+ * Gets the bounds of the parent window, with fallback to provided bounds.
+ */
+export declare const getParentWindowBounds: (parentWindow: OpenFin.Window | false, parentWindowBounds?: OpenFin.WindowBounds) => Promise<OpenFin.WindowBounds | undefined>;
+/**
+ * Checks if a window is maximized.
+ */
+export declare const isWindowMaximized: (parentWindow: OpenFin.Window | false) => Promise<boolean>;
+/**
+ * Pure function – returns the final indicator rectangle, nothing else.
+ */
+export declare function computeIndicatorBounds(identity: OpenFin.Identity | null | undefined, mySize: WindowSize, opts: IndicatorOptions): Promise<IndicatorBounds>;

package/common/src/components/IndicatorContainer/types.d.ts

@@ -0,0 +1,35 @@
+import type OpenFin from '@openfin/core';
+import { PositioningType } from '../../../../common/src/utils/positioning';
+export declare enum ShowAtType {
+    Top = "top",
+    Below = "below"
+}
+export interface IndicatorOptions {
+    /**
+     * Where to place the indicator relative to its parent.
+     */
+    showAt: ShowAtType;
+    /**
+     * When `true`, we use the "enterprise" timing + vertical offset rules.
+     */
+    isEnterprise: boolean;
+    /**
+     * The bounds of the parent window if the parent is not available at
+     * runtime (e.g. the browser window launched the indicator and closed).
+     */
+    fallbackParentBounds?: OpenFin.WindowBounds;
+    /**
+     * Determines whether to position relative to parent window or monitor.
+     */
+    positioning?: PositioningType;
+}
+export interface IndicatorBounds {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+}
+export interface WindowSize {
+    width: number;
+    height: number;
+}

package/common/src/utils/indicators/showIndicator.d.ts

@@ -0,0 +1,55 @@
+import { IconType } from '@openfin/ui-library';
+import { PositioningType } from '../../../../common/src/utils/positioning';
+import { IndicatorType } from '../../../../common/src/components/Indicator/Indicator.constants';
+export type IndicatorIcon = Extract<IconType, 'LockClosedIcon' | 'LockOpen1Icon' | 'PageIcon' | 'BlockedIcon' | 'SupertabIcon' | 'BookmarkFilled'>;
+export interface ShowIndicatorPayload {
+    type: IndicatorType;
+    message: string;
+    parentBrowserName?: string;
+    secondaryMessage?: string;
+    icon?: IndicatorIcon;
+    isEnterprise?: boolean;
+    positioning?: PositioningType;
+}
+export interface ShowErrorPayload {
+    message: string;
+    parentBrowserName?: string;
+    icon?: IndicatorIcon;
+    isEnterprise?: boolean;
+    positioning?: PositioningType;
+}
+export interface ShowSuccessPayload {
+    message: string;
+    parentBrowserName?: string;
+    secondaryMessage?: string;
+    icon?: IndicatorIcon;
+    isEnterprise?: boolean;
+    positioning?: PositioningType;
+}
+export interface ShowInfoPayload {
+    message: string;
+    parentBrowserName?: string;
+    icon?: IndicatorIcon;
+    isEnterprise?: boolean;
+}
+/**
+ * Creates a window containing a visual indicator contained in a Browser Window
+ * This function decides whether to call browser function or direct function
+ */
+export declare function showIndicator(payload: ShowIndicatorPayload): Promise<void>;
+/**
+ * Creates a window containing an error indicator
+ */
+export declare function showError(payload: ShowErrorPayload): Promise<void>;
+/**
+ * Creates a window containing a success indicator
+ */
+export declare function showSuccess(payload: ShowSuccessPayload): Promise<void>;
+/**
+ * Creates a window containing an info indicator
+ */
+export declare function showInfo(payload: ShowInfoPayload): Promise<void>;
+/**
+ * Creates a window centered on monitor containing a success indicator for switching workspaces
+ */
+export declare function showSwitchWorkspaceSuccess(): Promise<void>;

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

@@ -0,0 +1,4 @@
+export declare enum PositioningType {
+    RelativeToParentWindow = "relative-to-parent-window",
+    RelativeToMonitor = "relative-to-monitor"
+}

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

@@ -1,2 +1,2 @@
 import { SaveButtonContextMenuItemTemplate } from '../../../client-api-platform/src/shapes';
-export declare const getSaveButtonMenuTemplate: () => Promise<SaveButtonContextMenuItemTemplate[]>;
+export declare const getSaveButtonMenuTemplate: (pageId: string) => Promise<SaveButtonContextMenuItemTemplate[]>;

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

@@ -54,5 +54,5 @@ type MissingKeys<T, U> = Exclude<keyof T, U>;
  * fooChecker(['bar', 'qux', 'baz']); // 'baz' is not assignable to type keyof Foo;
  * ```
  */
-export declare const makeKeyChecker: <T extends object>() => <const K extends (keyof T)[]>(arr: K & (Exclude<keyof T, K[number]> extends never ? unknown : `Error: Missing keys: ${string & Exclude<keyof T, K[number]>}`)) => K;
+export declare const makeKeyChecker: <T extends object>() => <K extends (keyof T)[]>(arr: K & (Exclude<keyof T, K[number]> extends never ? unknown : `Error: Missing keys: ${string & Exclude<keyof T, K[number]>}`)) => K;
 export {};

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

@@ -7,6 +7,7 @@ export declare enum WindowName {
     HomeInternal = "openfin-home-internal",
     BrowserMenu = "openfin-browser-menu",
     BrowserSaveMenu = "openfin-browser-save-menu",
+    DockSaveWorkspaceMenu = "openfin-dock3-save-workspace-menu",
     BrowserIndicator = "openfin-browser-indicator",
     BrowserWindow = "internal-generated-window",
     ClassicWindow = "internal-generated-classic-window",
@@ -179,5 +180,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.Bounds): Promise<OpenFin.MonitorDetails>;
+export declare function getMonitorWindowMostOn(parentWindowBounds: OpenFin.Bounds): Promise<OpenFin.MonitorDetails>;
 export {};

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

@@ -1,6 +1,10 @@
 import type OpenFin from '@openfin/core';
 import { ResponseModalConfig } from '../../../common/src/utils/menu-config';
 import { ModalResponseEvent } from './menu-window-provider';
+export type DeleteWorkspaceMenuPayload = {
+    workspaceTitle: string;
+    windowIdentity?: OpenFin.Identity;
+};
 export declare const restoreChangesMenu: (windowIdentity: OpenFin.Identity) => Promise<ResponseModalConfig>;
 export declare const deletePageMenu: (windowIdentity: OpenFin.Identity, pageTitle: string) => Promise<ResponseModalConfig>;
 /**
@@ -11,7 +15,7 @@ export declare const deletePageMenu: (windowIdentity: OpenFin.Identity, pageTitl
  * @returns Boolean - Affirmative or Negative response from user
  */
 export declare const showSwitchWorkspaceModal: (targetWindowIdentity: OpenFin.Identity | undefined, workspaceTitle: string, shouldCenterOnMonitor?: boolean) => Promise<boolean>;
-export declare const showDeleteWorkspaceModal: (windowIdentity: OpenFin.Identity, workspaceTitle: string) => Promise<boolean>;
+export declare const showDeleteWorkspaceModal: ({ workspaceTitle, windowIdentity }: DeleteWorkspaceMenuPayload) => Promise<boolean>;
 /**
  *
  * @param windowIdentity Parent or Current OpenFin Window Identity

package/dock3/src/shapes/shapes.d.ts

@@ -2,7 +2,7 @@ import type { OpenFin } from '@openfin/core';
 import { WorkspaceButton } from '../../../client-api/src/dock';
 import { ContentMenuEntry, DockEntry, TaskbarIcon } from '../../../client-api-platform/src/shapes';
 export type { Dock3Provider, Dock3ConstructorOverride } from '../api/provider';
-export type Dock3Button = WorkspaceButton | 'contentMenu';
+export type Dock3Button = WorkspaceButton | 'contentMenu' | 'manageWorkspaces';
 /**
  * Configuration for the Dock 3.0 provider.
  */
@@ -58,6 +58,12 @@ export interface Dock3Config {
                 skipDialog?: boolean;
             };
         };
+        manageWorkspaces?: {
+            newWindow?: {
+                behavior: 'view';
+                viewOptions: OpenFin.PlatformViewCreationOptions;
+            };
+        };
     };
 }
 export type DockAllowedWindowOptions = Partial<Pick<OpenFin.PlatformWindowOptions, 'defaultCentered' | 'saveWindowState' | 'taskbarIconGroup' | 'defaultTop' | 'defaultLeft'>>;