@openfin/workspace-platform 21.0.0 → 21.0.2

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

@@ -1,11 +1,3 @@
 import type OpenFin from '@openfin/core';
-import type { AttachedPage } from '../../../../common/src/api/pages/shapes';
-import { type BrowserCreateWindowRequest, type BrowserWindowModule } from '../../shapes';
-export declare const getBrowserApi: (identity: OpenFin.ApplicationIdentity) => {
-    wrapSync: (windowIdentity: OpenFin.Identity) => BrowserWindowModule;
-    createWindow: (options: BrowserCreateWindowRequest) => Promise<BrowserWindowModule>;
-    getAllAttachedPages: () => Promise<AttachedPage[]>;
-    getAllWindows: () => Promise<BrowserWindowModule[]>;
-    getUniquePageTitle: (title?: string) => Promise<any>;
-    getLastFocusedWindow: () => Promise<any>;
-};
+import type { BrowserWindowFactory } from '../../shapes';
+export declare const getBrowserApi: (identity: OpenFin.ApplicationIdentity) => BrowserWindowFactory;

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

@@ -1131,6 +1131,16 @@ export interface BrowserWindowFactory {
      * ```
      */
     getLastFocusedWindow(): Promise<OpenFin.Identity | undefined>;
+    /**
+     * Gets a page that contains a given view identity.
+     *
+     * @param viewIdentity the identity of the view to search for.
+     */
+    getPageByViewIdentity(viewIdentity: OpenFin.Identity): Promise<{
+        page: AttachedPage;
+        windowIdentity: OpenFin.Identity;
+        pageIndex: number;
+    }>;
 }
 /**
  * API for interacting with persistent storage.
@@ -1803,6 +1813,7 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
      * @param payload {@link AddDefaultPagePayload}
      */
     addDefaultPage(payload: AddDefaultPagePayload): Promise<void>;
+    getPageByViewIdentity(viewIdentity: OpenFin.Identity): Promise<Awaited<ReturnType<BrowserWindowFactory['getPageByViewIdentity']>>>;
 }
 /**
  * The origins from which a custom action can be invoked

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

@@ -79,6 +79,8 @@ type AttachedPageMetadata = {
     parentIdentity?: OpenFin.Identity;
     /** True if the page is the currently active page for its parent window. */
     isActive?: boolean;
+    /** The name of the layout this page contains, useful for interacting with OpenFin Core APIs. */
+    layoutName?: string;
     /** True if the page has unsaved changes. */
     hasUnsavedChanges?: boolean;
     /** Panel config with all view identities in place */

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

@@ -33,6 +33,7 @@ export declare enum WorkspacePlatformChannelAction {
     GetSavedPageMetadata = "getSavedPageMetadata",
     GetUniquePageTitle = "getUniquePageTitle",
     GetLastFocusedBrowserWindow = "getLastFocusedBrowserWindow",
+    GetPageByViewIdentity = "getPageByViewIdentity",
     GetThemes = "getThemes",
     GetSelectedScheme = "getSelectedScheme",
     SetSelectedScheme = "setSelectedScheme",