@openfin/workspace-platform 17.2.13 → 17.4.0

package/client-api-platform/src/init/cleanup.d.ts

@@ -1,4 +1,3 @@
-export declare function registerViewCleanUp(): void;
 /**
  * Cleanup browser modals.
  *

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

@@ -97,6 +97,20 @@ export declare const enum ColorSchemeOptionType {
     Dark = "dark",
     System = "system"
 }
+/**
+ * Defines the title used for the browser window.
+ * `custom` - uses the value of `value` property
+ * `page-title` - uses the title of the active page
+ * `view-title` - uses the title of the active view
+ */
+export type WindowTitle = {
+    type: 'custom';
+    value: string;
+} | {
+    type: 'page-title';
+} | {
+    type: 'view-title';
+};
 /**Types of page tab context menu options, including pre-defined ones.
  * User-defined context menu items should use the value `Custom` */
 export declare enum PageTabContextMenuOptionType {
@@ -283,6 +297,10 @@ export interface UpdateAttachedPageRequest {
     /** The updated page. */
     page: Partial<PageWithUpdatableRuntimeAttribs>;
 }
+export interface ReparentPageRequest {
+    /** The ID of the page to reparent. */
+    pageId: string;
+}
 /**
  * Types of buttons on browser windows
  */
@@ -518,8 +536,11 @@ export interface BrowserWorkspacePlatformWindowOptions {
     pages: Page[];
     /** The favicon to display on the top left of the created browser window. */
     favicon?: string;
-    /** A UI friendly title for the created browser window. */
-    title?: string;
+    /**
+     * A UI friendly title for the created browser window.
+     * Type string for window title is deprecated, please use WindowTitle type instead.
+     */
+    title?: WindowTitle | string;
     /**
      * Landing page that shows up when you add a new tab from the plus button that exists in the tabstrip.
      * If you do not provide a newTabUrl, then the plus button in the tabstrip will not be shown and users cannot create a new empty tab.
@@ -716,6 +737,28 @@ export interface BrowserWindowModule {
      * @param page the attach page to a browser window.
      */
     addPage(page: PageWithUpdatableRuntimeAttribs): Promise<void>;
+    /**
+     * Remove an existing page from an existing browser window and reparent it to another existing browser window.
+     * If `multiplePagesDisabled` is `true` an error will be thrown.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     *
+     * // assume a page and multiple browser windows already exists
+     * const wrappedTargetWindow = workspacePlatform.Browser.wrapSync(identity)
+     * const reparentPageRequest = { pageId: 'my-target-page' }
+     * // wrap the window to which you wish to move the page and call reparentPage
+     * await wrappedTargetWindow.reparentPage(reparentPageRequest);
+     * // focus window
+     * await wrappedTargetWindow.openfinWindow.focus();
+     * // restore window if minimized
+     * await wrappedTargetWindow.openfinWindow.restore();
+     * ```
+     * @param req the reparent page request.
+     */
+    reparentPage(req: ReparentPageRequest): Promise<void>;
     /**
      * Remove an attached page from the browser window.
      *
@@ -842,6 +885,31 @@ export interface BrowserWindowModule {
      * @param options new window state options.
      */
     replaceWindowStateButtonOptions(options: WindowStateButtonOptions): Promise<void>;
+    /**
+     * Updates the browser window title based on the provided title object.
+     *
+     * @param title The new title object for the browser window.
+     *
+     * @example
+     * ```typescript
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * workspacePlatform.Browser.wrapSync(identity).updateBrowserWindowTitle({type: 'view-title'});
+     * ```
+     *
+     * @example
+     * ```typescript
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * workspacePlatform.Browser.wrapSync(identity).updateBrowserWindowTitle({type: 'custom', value: 'My Custom Title'});
+     * ```
+     *
+     * @typedef WindowTitle
+     * @type {Object}
+     * @property {string} type - The type of the window title ('custom', 'page-title', or 'view-title').
+     * @property {string} [value] - The value associated with the 'custom' type.
+     */
+    updateBrowserWindowTitle(title: WindowTitle): Promise<void>;
     _openViewTabContextMenu(req: OpenViewTabContextMenuRequest): Promise<void>;
     _openPageTabContextMenu(req: OpenPageTabContextMenuRequest): Promise<void>;
     _openSaveButtonContextMenu(req: OpenSaveButtonContextMenuRequest): Promise<void>;
@@ -1245,6 +1313,7 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      * Launch a browser snapshot that contains windows with pages.
      *
      * @param snapshot the browser snapshot to launch or a url or filepath to retrieve a JSON snapshot.
+     * @param options options for launching the snapshot.
      */
     applySnapshot(snapshot: BrowserSnapshot | string, options?: OpenFin.ApplySnapshotOptions): Promise<OpenFin.Platform>;
     /**
@@ -1475,7 +1544,7 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
     deleteSavedWorkspace(id: string): Promise<void>;
     /**
      * Applies a workspace to the user's desktop.  Makes that workspace the active workspace.
-     * @param applyWorkspacePayload {@link ApplyWorkspacePayload}
+     * @param payload {@link ApplyWorkspacePayload}
      *
      * @returns true if the workspace was applied, false if the workspace was not applied.
      */
@@ -1950,6 +2019,7 @@ interface WorkspaceMetadata {
 }
 export interface Workspace {
     workspaceId: string;
+    /** While not required, it is suggested that Workspace titles be unique. */
     title: string;
     metadata?: WorkspaceMetadata;
     snapshot: BrowserSnapshot;

package/common/src/api/overrides.d.ts

@@ -19,6 +19,7 @@ export interface Overrides {
     analyticsEndpoint: string;
     translationOverridesUrl: string;
 }
+export declare function getManifestOverrides(): Promise<Partial<Overrides>>;
 export declare function getOverrides(): Promise<Partial<Overrides>>;
 export declare const useOverrides: () => Partial<Overrides>;
 export {};

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

@@ -0,0 +1,13 @@
+import type OpenFin from '@openfin/core';
+import type { AttachedPage, Page } from '../../../../client-api-platform/src/shapes';
+export interface PagesLayoutSnapshot {
+    layouts: {
+        [pageId: string]: OpenFin.LayoutOptions;
+    };
+    pages: Page[];
+}
+export declare const convertPagesToLayoutSnapshot: (pages: Page[]) => {
+    layouts: Record<string, OpenFin.LayoutOptions>;
+    pages: Page[];
+};
+export declare const convertLayoutSnapshotToPages: ({ pages, layouts }: PagesLayoutSnapshot) => AttachedPage[];

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

@@ -85,6 +85,9 @@ type AttachedPageMetadata = {
     panels?: ExtendedPanelConfig[];
 };
 export type AttachedPage = Page & AttachedPageMetadata;
+export type ReparentAttachedPage = AttachedPage & {
+    multiInstanceViewBehavior?: 'reparent';
+};
 export type PageWithUpdatableRuntimeAttribs = Page & Pick<AttachedPage, 'hasUnsavedChanges'>;
 export interface DetachPagesFromWindowPayload {
     /** The OF window identity to detach the pages from. */

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

@@ -63,7 +63,7 @@ export declare const addLayoutEventListener: (event: LayoutDOMEventType, listene
 /**
  * Initialize the layout for the current OF window.
  */
-export declare const initLayout: () => Promise<void>;
+export declare const initLayoutListeners: () => Promise<void>;
 /**
  * Deep clones a layout and changes its settings to make it "locked".
  * @param layout The Layout to be locked

package/common/src/utils/usage-register.d.ts

@@ -29,7 +29,7 @@ export declare enum AnalyticsSource {
     Dock = "Dock",
     Home = "Home",
     Notification = "Notification",
-    Storefront = "Storefront",
+    Storefront = "Store",
     Platform = "Platform",
     Theming = "Theming",
     Interop = "Interop"