@openfin/workspace-platform 18.1.21 → 18.1.23

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

@@ -2,7 +2,7 @@ import type OpenFin from '@openfin/core';
 import { IconProps, Languages } 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, 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';
@@ -152,6 +152,7 @@ export declare enum PageTabContextMenuOptionType {
     Rename = "Rename",
     Save = "Save",
     SaveAs = "Save As",
+    DeletePage = "Delete Page",
     SaveWorkspaceAs = "SaveWorkspaceAs",
     Refresh = "Refresh",
     CloseOthers = "Close others",
@@ -1662,6 +1663,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>;
 }
 /**
  * The origins from which a custom action can be invoked

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/browser.d.ts

@@ -11,7 +11,8 @@ export declare const getChannelClient: (identity: OpenFin.Identity, prefix?: str
  * (Should only happen in local development)
  */
 export declare const createChannel: (identity?: OpenFin.Identity, prefix?: string) => Promise<OpenFin.ChannelProvider>;
-export declare const makeGetBrowserChannelClient: () => Promise<OpenFin.ChannelProvider>;
+export declare const getBrowserChannelClient: () => Promise<OpenFin.ChannelProvider>;
+export declare const getViewThemeChannelClient: () => Promise<OpenFin.ChannelProvider>;
 export interface AddToChannelRequest {
     newChannelId: string;
     selectedViews: OpenFin.Identity[];

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/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>;