@openfin/workspace 18.1.22 → 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

@@ -4,7 +4,7 @@ import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/ut
 import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 import { Resource } from '../../common/src/api/i18next';
 import { TrackedSite } from '../../common/src/api/pages/idb';
-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';
@@ -154,6 +154,7 @@ export declare enum PageTabContextMenuOptionType {
     Rename = "Rename",
     Save = "Save",
     SaveAs = "Save As",
+    DeletePage = "Delete Page",
     SaveWorkspaceAs = "SaveWorkspaceAs",
     Refresh = "Refresh",
     CloseOthers = "Close others",
@@ -1028,6 +1029,19 @@ export interface BrowserWindowModule {
     _reparentPage(req: ReparentPageRequest & {
         index?: number;
     }): Promise<void>;
+    /**
+     * ```ts
+     *
+     * const newPage = await makeNewLandingPage();
+     * const { newPageUrl } = await getLandingPageUrls();
+     * const browser = getCurrentSync().Browser.wrapSync(currentOFIdentity);
+     * const actualNewPageUrl = newPageUrl ? newPageUrl : undefined;
+     * await browser._addDefaultPage({ identity: currentOFIdentity, page: newPage, newPageUrl: actualNewPageUrl });
+     * ```
+     * @param req the default page request object
+     * @internal
+     */
+    _addDefaultPage(req: AddDefaultPagePayload): Promise<void>;
     /** @internal */
     _trackRemovedTab(req: any): Promise<void>;
     /** @internal */
@@ -1820,6 +1834,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>;
     /** @internal */
     restoreRemovedTabInternal(): Promise<void>;
     /** @internal */

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