@openfin/workspace-platform 16.0.7 → 17.0.0

package/client-api-platform/src/api/pages/index.d.ts

@@ -1,6 +1,6 @@
 import type OpenFin from '@openfin/core';
-import type { AttachedPage, DetachPagesFromWindowPayload, ExtendedAttachPagesToWindowPayload, ReorderPagesForWindowPayload, SetActivePageForWindowPayload, UpdatePageForWindowPayload } from '../../../../common/src/api/pages/shapes';
-import type { CreateSavedPageRequest, Page, UpdateSavedPageRequest } from '../../../../client-api-platform/src/shapes';
+import type { AttachedPage, CopyPagePayload, DetachPagesFromWindowPayload, ExtendedAttachPagesToWindowPayload, HandleSaveModalOnPageClosePayload, ReorderPagesForWindowPayload, SaveModalOnPageCloseResult, SetActivePageForWindowPayload, UpdatePageForWindowPayload } from '../../../../common/src/api/pages/shapes';
+import type { CreateSavedPageRequest, HandlePageChangesPayload, ModifiedPageState, Page, UpdateSavedPageRequest } from '../../../../client-api-platform/src/shapes';
 /**
  * Get all open pages in which are attached to a window.
  * @returns the list of attached pages.
@@ -30,3 +30,6 @@ export declare const getActivePageIdForWindow: (identity: OpenFin.Identity) => P
  * @returns string: a unique page name
  */
 export declare function getUniquePageTitle(initialName?: string): Promise<string>;
+export declare function handleSaveModalOnPageClose({ page }: HandleSaveModalOnPageClosePayload): Promise<SaveModalOnPageCloseResult>;
+export declare function copyPageOverride({ page }: CopyPagePayload): Promise<Page>;
+export declare function handlePageChanges(payload: HandlePageChangesPayload): Promise<ModifiedPageState>;

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

@@ -2,7 +2,8 @@ import type OpenFin from '@openfin/core';
 import { IconProps } from '@openfin/ui-library';
 import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/utils/usage-register';
 import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
-import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../common/src/api/pages/shapes';
+import type { AttachedPage, CopyPagePayload, HandleSaveModalOnPageClosePayload, Page, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult } from '../../common/src/api/pages/shapes';
+import { SetActivePageForWindowPayload } from '../../common/src/api/pages/shapes';
 import type { CustomThemes } from '../../common/src/api/theming';
 import type { App, DockProviderConfigWithIdentity, StoreButtonConfig } from '../../client-api/src/shapes';
 import type { WorkflowIntegration } from '../../client-api/src/shapes/integrations';
@@ -30,6 +31,15 @@ export interface UpdateSavedPageRequest {
     /** The updated page. */
     page: Page;
 }
+export interface HandlePageChangesPayload {
+    /** The page with new changes. */
+    page: AttachedPage;
+    /** The OF window identity containing the page. */
+    identity: OpenFin.Identity;
+}
+export interface ModifiedPageState {
+    hasUnsavedChanges?: boolean;
+}
 /**
  * Request for reordering the pages attached to a window.
  */
@@ -1287,6 +1297,11 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
      * @param id of the id of the page to delete.
      */
     deleteSavedPage(id: string): Promise<void>;
+    /**
+     * Implementation for detecting if a page change qualifies as putting the page in an unsaved state.
+     * @param payload the page with new changes and the identity of the OF window where the page change occured.
+     */
+    handlePageChanges(payload: HandlePageChangesPayload): Promise<ModifiedPageState>;
     /**
      * Implementation for getting a list of saved workspaces from persistent storage.
      * @param query an optional query.
@@ -1373,6 +1388,21 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
      * @param req the payload received by the provider
      */
     handleAnalytics(req: AnalyticsEvent[]): Promise<void>;
+    /**
+     * Implementation for deciding whether a modal informing about loss of unsaved changes will be displayed when closing a page.
+     * The default implementation returns `{ shouldShowModal: true }` if the page has unsaved changes (`hasUnsavedChanges` page property)
+     * and `false` otherwise.
+     */
+    handleSaveModalOnPageClose(payload: HandleSaveModalOnPageClosePayload): Promise<SaveModalOnPageCloseResult>;
+    /**
+     * Implementation for setting the active page in a browser window.
+     * Called when the active page is changed and on browser window creation.
+     */
+    setActivePage(payload: SetActivePageForWindowPayload): Promise<void>;
+    /**
+     *  Implementation for creating a copy of a page. Called when a page is Saved-As or Duplicated.
+     */
+    copyPage(payload: CopyPagePayload): Promise<Page>;
 }
 /**
  * The origins from which a custom action can be invoked

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

@@ -187,4 +187,22 @@ export type PanelConfig = (PanelConfigHorizontal | PanelConfigVertical) & {
 export type ExtendedPanelConfig = PanelConfig & {
     viewOptions: PanelConfig['viewOptions'] & OpenFin.Identity;
 };
+export interface HandleSaveModalOnPageClosePayload {
+    /** The page that is closing. */
+    page: AttachedPage;
+    /** The OF window identity containing the page. */
+    identity: OpenFin.Identity;
+}
+export interface SaveModalOnPageCloseResult {
+    /** If false, a modal informing that unsaved changes will be lost will not be displayed. */
+    shouldShowModal: boolean;
+}
+export interface CopyPagePayload {
+    /** The OF browser identity containing the page to copy. */
+    identity: OpenFin.Identity;
+    /** The page to copy. */
+    page: Page;
+    /** Specifies the trigger for creating a copy. */
+    reason: 'save-as' | 'duplicate';
+}
 export {};

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

@@ -53,7 +53,10 @@ export declare enum WorkspacePlatformChannelAction {
     IsBrowserInitialized = "isBrowserInitialized",
     Analytics = "analyticsInternal",
     GetDockProviderConfig = "getDockProviderConfig",
-    SaveDockProviderConfig = "saveDockProviderConfig"
+    SaveDockProviderConfig = "saveDockProviderConfig",
+    HandleSaveModalOnPageClose = "handleSaveModalOnPageClose",
+    CopyPage = "copyPage",
+    HandlePageChanges = "handlePageChanges"
 }
 export type PlatFormSupportedFeatures = boolean | {
     isWorkspacePlatform: boolean;

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

@@ -1,22 +1,39 @@
 import type OpenFin from '@openfin/core';
 import type { OptionalExceptFor } from '../../../common/src/utils/types';
-export interface ModalResponseContent {
-    title: string;
-    body: string;
-    affirmativeButton: string;
-    negativeButton?: string;
-    canceledButton?: string;
-}
 export interface MenuConfig {
     windowOptions: OptionalExceptFor<OpenFin.WindowOptions, 'url' | 'name' | 'defaultHeight' | 'defaultWidth'>;
     title: string;
 }
-export interface ResponseModalConfig extends MenuConfig {
-    content: ModalResponseContent;
-}
 export interface RightMenuConfig extends MenuConfig {
     windowOffset?: {
         x?: number;
         y?: number;
     };
 }
+export interface ResponseModalConfig extends MenuConfig {
+    content: ResponseModalContent;
+}
+export interface ResponseModalContent {
+    title: string;
+    body: string;
+    closeType?: 'page' | 'workspace';
+    buttons: ResponseModalButtons;
+    textInputOptions?: {
+        placeholder?: string;
+        defaultValue?: string;
+    };
+    invocationId?: string;
+}
+export type ResponseModalButtons = LeftButtonConfig | RightButtonConfig;
+export interface LeftButtonConfig {
+    left: ButtonConfig[];
+    right?: ButtonConfig[];
+}
+export interface RightButtonConfig {
+    left?: ButtonConfig[];
+    right: ButtonConfig[];
+}
+export type ButtonConfig = {
+    label: string;
+    type: 'primary' | 'secondary';
+};

package/common/src/utils/menu-window-provider.d.ts

@@ -1,5 +1,5 @@
 import type OpenFin from '@openfin/core';
-import { ModalResponseContent } from '../../../common/src/utils/menu-config';
+import { ResponseModalContent } from '../../../common/src/utils/menu-config';
 import type { OptionalExceptFor } from '../../../common/src/utils/types';
 type MenuEventTypes = {
     response: [ModalResponseEvent];
@@ -7,7 +7,12 @@ type MenuEventTypes = {
     update: [string, Partial<OpenFin.Bounds>, string];
 };
 export interface ModalResponseEvent {
-    data: 'canceled' | 'negative' | 'affirmative';
+    data: {
+        actionName: string;
+        data?: {
+            textInputValue?: string;
+        };
+    };
     name: string;
 }
 export declare const menuEvents: {
@@ -28,7 +33,7 @@ export interface ShowChildOptions {
 }
 export interface ResponseModalOptions {
     options: WindowOptionsWithBounds;
-    content: ModalResponseContent;
+    content: ResponseModalContent;
 }
 export declare function createMenuPosition(windowOptions: OptionalExceptFor<OpenFin.WindowOptions, 'x' | 'y' | 'defaultWidth'>): Promise<{
     top: number;

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

@@ -17,6 +17,7 @@ export declare enum PageRoute {
     BrowserPopupMenuColorLinking = "/browser/popup-menu/color-linking/color-linking/",
     BrowserIndicator = "/browser/indicator/",
     ResponseModal = "/browser/popup-menu/response-modal/",
+    CloseConfirmationModal = "/browser/popup-menu/close-confirmation-modal/",
     Docs = "/provider/docs/",
     Storefront = "/storefront/",
     DeprecatedAlert = "/provider/deprecated-alert/",