@openfin/workspace-platform 4.3.0 → 4.7.0

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

@@ -0,0 +1,48 @@
+/// <reference types="openfin-adapter/fin" />
+/**
+ * All of the remote procedures that can be called in the
+ * a Workspace Platform's address space.
+ *
+ * When adding a new channel action make sure to add a function that's name matches
+ * the value of the enum for the remote procedure in the Workspace Platform overrides.
+ * All of the registered channel action handlers can be found here in the platform's overrides:
+ * @see link: [Provider Protocol Handlers](https://github.com/openfin/workspace/client-api-platform/src/init/override-callback.ts)
+ */
+export declare enum ChannelAction {
+    LaunchApp = "launchApp",
+    SavePage = "savePage",
+    GetSavedPage = "getSavedPage",
+    CreateSavedPage = "createSavedPage",
+    UpdateSavedPage = "updateSavedPage",
+    DeleteSavedPage = "deleteSavedPage",
+    GetSavedPages = "getSavedPages",
+    CreateSavedPageInternal = "createSavedPageInternal",
+    UpdateSavedPageInternal = "updateSavedPageInternal",
+    DeleteSavedPageInternal = "deleteSavedPageInternal",
+    SharePage = "sharePage",
+    LaunchPage = "launchPage",
+    UpdatePageForWindow = "updatePageForWindow",
+    AttachPagesToWindow = "attachPagesToWindow",
+    DetachPagesFromWindow = "detachPagesFromWindow",
+    ReorderPagesForWindow = "reorderPagesForWindow",
+    SetActivePageForWindow = "setActivePageForWindow",
+    GetAllAttachedPages = "getAllAttachedPages",
+    GetActivePageIdForWindow = "getActivePageIdForWindow",
+    GetPagesForWindow = "getPagesForWindow",
+    GetPageForWindow = "getPageForWindow",
+    GetSavedPageMetadata = "getSavedPageMetadata",
+    GetUniquePageTitle = "getUniquePageTitle",
+    GetLastFocusedBrowserWindow = "getLastFocusedBrowserWindow",
+    GetThemes = "getThemes"
+}
+/**
+ * Get a channel client for a specific Workspace platform.
+ *
+ * The channel client can execute remote procedures on the platform via its `dispatch` function.
+ * A call to the `dispatch` function will block until the channel action has concluded execution
+ * in the Workspace platform's address space.
+ * For a list of supported procedures, see the `ChannelAction` enum.
+ *
+ * @returns the channel client for the Workspace platform.
+ */
+export declare const getChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<import("openfin-adapter").ChannelClient>;

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

@@ -0,0 +1,10 @@
+import { Page } from '@common/api/pages/shapes';
+import type { CreateSavedPageRequest, UpdateSavedPageRequest } from '../shapes';
+export declare const getStorageApi: (identity: any) => {
+    createPage: (req: CreateSavedPageRequest) => Promise<any>;
+    deletePage: (id: string) => Promise<any>;
+    updatePage: (req: UpdateSavedPageRequest) => Promise<any>;
+    getPage: (id: string) => Promise<any>;
+    getPages: (query?: string) => Promise<Page[]>;
+    savePage: (page: Page) => Promise<any>;
+};

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

@@ -0,0 +1,5 @@
+/// <reference types="openfin-adapter/fin" />
+import type { CustomThemes } from '@common/api/theming';
+export declare const getThemingApi: (identity: OpenFin.ApplicationIdentity) => {
+    getThemes: () => Promise<CustomThemes>;
+};

package/client-api-platform/src/api/workspace-module.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="openfin-adapter/fin" />
+import type { WorkspacePlatformModule } from '../shapes';
+export declare const getWorkspacePlatformModule: (identity: OpenFin.ApplicationIdentity) => WorkspacePlatformModule;

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

@@ -0,0 +1,6 @@
+/// <reference types="openfin-adapter/fin" />
+import type { WorkspacePlatformInitConfig, WorkspacePlatformModule } from './shapes';
+export * from './shapes';
+export declare const init: (options: WorkspacePlatformInitConfig) => Promise<void>;
+export declare const wrapSync: (identity: OpenFin.ApplicationIdentity) => WorkspacePlatformModule;
+export declare const getCurrentSync: () => WorkspacePlatformModule;

package/client-api-platform/src/init/browser-window-focus.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="openfin-adapter/fin" />
+/**
+ * Get the last focused browser window.
+ * @returns the last focused browser window.
+ */
+export declare function getLastFocusedBrowserWindow(): Promise<OpenFin.Identity>;
+/**
+ * Set the OpenFin identity of the last focused browser window.
+ */
+export declare function setLastFocusedBrowserWindow(identity?: OpenFin.Identity): void;
+/**
+ * Listen for a browser window to be focused.
+ * When a browser window is focused, store it in local storage as the last focused browser window.
+ */
+export declare function listenForBrowserWindowFocus(): Promise<void>;
+/**
+ * Stop listening for a browser window to be focused.
+ */
+export declare function removeBrowserWindowFocusListener(): Promise<void>;

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

@@ -0,0 +1 @@
+export default function registerViewCleanUp(): void;

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

@@ -0,0 +1,5 @@
+import { BrowserInitConfig } from '../shapes';
+/**
+ * Initializing the Workspace Platform.
+ */
+export default function init(options: BrowserInitConfig): Promise<void>;

package/client-api-platform/src/init/override-callback.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="openfin-adapter/fin" />
+import type { BrowserInitConfig } from '@client-platform/shapes';
+export declare const getOverrideCallback: (initOptions: BrowserInitConfig) => OpenFin.OverrideCallback<OpenFin.PlatformProvider>;

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

@@ -0,0 +1,9 @@
+import { CustomThemes } from '../shapes';
+export declare const getThemes: () => CustomThemes;
+/**
+ * initTheming()
+ * Accepts an array of CustomThemes objects and stores it
+ * @param customPaletteOptions - optional - array of custom color pallettes
+ * @returns array of custom theme objects
+ */
+export default function initTheming(customPalettes: CustomThemes): void;

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

@@ -0,0 +1,39 @@
+/// <reference types="openfin-adapter/fin" />
+export declare function overrideViewOptions(options: Partial<OpenFin.ViewOptions>): void;
+export declare const filterSnapshotWindows: (win: OpenFin.WindowOptions) => boolean;
+/**
+ * fitToMonitor()
+ * Function to determine if window size is too large
+ * for available rectangle area.
+ *
+ * - Checks monitor data for available rectangle coords
+ * - Defines max width/height for current monitor
+ * - Defines default width/height if property is not set
+ * - Updates options object default width/height if they exceed max values
+ *
+ * Ticket: WRK-1084
+ *
+ * @param options - Object passed into createWindow -> contains height and width
+ * @returns unprocessed or processed options object
+ */
+export declare const fitToMonitor: (options: any) => Promise<any>;
+declare type LegacyWindowOptions = Omit<OpenFin.PlatformWindowCreationOptions, 'workspacePlatform'> & {
+    pages?: OpenFin.Page[];
+    workstacks?: OpenFin.Page[];
+};
+export declare const initWorkspacePlatformOptions: (options: LegacyWindowOptions | OpenFin.PlatformWindowCreationOptions) => OpenFin.PlatformWindowCreationOptions;
+/**
+ * hasLayout()
+ * Function to force layout settings
+ * - Check if layout property exists if so process data, else return as is
+ * - Define behavior settings
+ * - Force dimension options
+ * - Validate icon
+ *
+ * Ticket: WRK-???
+ *
+ * @param options - options used to handle layout settings
+ * @returns processed or unprocesseed options
+ */
+export declare const applyBrowserDefaults: (options: OpenFin.PlatformWindowCreationOptions) => OpenFin.PlatformWindowCreationOptions;
+export {};

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

@@ -0,0 +1,278 @@
+/// <reference types="openfin-adapter/fin" />
+import type { InteropBroker } from 'openfin-adapter/src/api/interop';
+import type { App } from '../../client-api/src/shapes';
+import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../common/src/api/pages/shapes';
+import type { CustomThemes } from '../../common/src/api/theming';
+export type { CustomThemes } from '../../common/src/api/theming';
+export type { App, Image, AppIntent } from '../../client-api/src/shapes';
+export { AppManifestType } from '../../client-api/src/shapes';
+export type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs, PageLayout, PageLayoutDetails } from '../../common/src/api/pages/shapes';
+/**
+ * Request for creating a saved page in persistent storage.
+ */
+export interface CreateSavedPageRequest {
+    /** The page to create. */
+    page: Page;
+}
+/**
+ * Request for updating a saved page in persistent storage.
+ */
+export interface UpdateSavedPageRequest {
+    /** The ID of the page to update. */
+    pageId: string;
+    /** The updated page. */
+    page: Page;
+}
+/**
+ * Request for reordering the pages attached to a window.
+ */
+export interface ReorderPagesRequest {
+    /** An array of page ids that specify the order of the pages attached to the window. */
+    pageIds: string[];
+}
+/**
+ * Request to update the attributes of a page in which is attached to a running browser window.
+ */
+export interface UpdateAttachedPageRequest {
+    /** The ID of the page to update. */
+    pageId: string;
+    /** The updated page. */
+    page: Partial<PageWithUpdatableRuntimeAttribs>;
+}
+/**
+ * Request for creating a browser window.
+ */
+export interface BrowserCreateWindowRequest extends Omit<OpenFin.PlatformWindowCreationOptions, 'workspacePlatform'> {
+    workspacePlatform: {
+        /** The initial set of pages to add to the created browser window. */
+        pages: Page[];
+        /** The favicon to display on the top right of the created browser window. */
+        favicon?: string;
+        /** A UI friendly title for the created browser window. */
+        title?: string;
+        /** A URL to use when creating a new tab. */
+        newTabUrl?: string;
+        /** A URL to use when creating the initial tab in a new page. */
+        newPageUrl?: string;
+    };
+}
+/**
+ * A window that is part of a browser snapshot.
+ */
+export declare type BrowserSnapshotWindow = OpenFin.WindowCreationOptions & BrowserCreateWindowRequest;
+/**
+ * A browser snapshot.
+ */
+export interface BrowserSnapshot {
+    /** The state of the windows that were running at the time the snapshot was taken. */
+    windows: BrowserSnapshotWindow[];
+}
+/**
+ * Controller for interacting with a browser window.
+ */
+export interface BrowserWindowModule {
+    /** The identity of the browser window. */
+    identity: OpenFin.Identity;
+    /** Underlying OpenFin window Controller. */
+    openfinWindow: OpenFin.Window;
+    /**
+     * Get a page that is attached to the browser window.
+     * @param id the id of the page to get.
+     */
+    getPage(id: string): Promise<AttachedPage>;
+    /**
+     * Return all the pages that are attached to a browser window.
+     */
+    getPages(): Promise<AttachedPage[]>;
+    /**
+     * Set the active page for the browser window.
+     * @param id the id of the attached page to set as active.
+     */
+    setActivePage(id: string): Promise<void>;
+    /**
+     * Attach a page to a browser window.
+     * If a page with same id or title is attached to an existing browser window, an error will be thrown.
+     *
+     * @param page the attach page to a browser window.
+     */
+    addPage(page: PageWithUpdatableRuntimeAttribs): Promise<void>;
+    /**
+     * Remove an attached page from the browser window.
+     * @param id the id of the attached page to remove from the browser window.
+     */
+    removePage(id: string): Promise<void>;
+    /**
+     * Update a page in which is attached to the browser window.
+     * @param req the update request.
+     */
+    updatePage(req: UpdateAttachedPageRequest): Promise<void>;
+    /**
+     * Reorder pages attached to the browser window.
+     * @param req the reorder pages request.
+     */
+    reorderPages(req: ReorderPagesRequest): Promise<void>;
+}
+/**
+ * Factory for wrapping browser windows and global operations.
+ */
+export interface BrowserWindowFactory {
+    /**
+     * Synchronously returns a Browser Window object that represents an existing window
+     *
+     * @param identity of the window
+     */
+    wrapSync: (identity: OpenFin.Identity) => BrowserWindowModule;
+    /**
+     * Get a list of all pages that are attached to any running browser window.
+     */
+    getAllAttachedPages(): Promise<AttachedPage[]>;
+    /**
+     *  Get all the Browser Windows that are running in the Workspace Platform.
+     */
+    getAllWindows(): Promise<BrowserWindowModule[]>;
+    /**
+     * Create a new browser window.
+     * @param options the browser window creation options
+     */
+    createWindow(options: BrowserCreateWindowRequest): Promise<BrowserWindowModule>;
+    /**
+     * Get a unique title for a page.
+     * @param title a prefix for the title.
+     */
+    getUniquePageTitle(title?: string): Promise<string>;
+    /**
+     * Get the identity of the last focused Browser window.
+     */
+    getLastFocusedWindow(): Promise<OpenFin.Identity>;
+}
+/**
+ * API for interacting with persistent storage.
+ */
+export interface WorkspacePlatformStorage {
+    /**
+     * Get all pages that are saved in persistent storage.
+     */
+    getPages(): Promise<Page[]>;
+    /**
+     * Get a specific page in persistent storage.
+     * @param id the id of the page to get.
+     */
+    getPage(id: string): Promise<Page>;
+    /**
+     * Create a page in persistent storage.
+     * @param page the page to create in persistent storage.
+     */
+    createPage(page: CreateSavedPageRequest): Promise<void>;
+    /**
+     * Update a page in persistent storage.
+     * @param req the update saved page request.
+     */
+    updatePage(req: UpdateSavedPageRequest): Promise<void>;
+    /**
+     * Delete a page from persistent storage.
+     * @param id the id of the page to delete.
+     */
+    deletePage(id: string): Promise<void>;
+    /**
+     * Save a page in persistent storage.
+     *
+     * This is a helper function that will call `getPage` to determine if a page is already in storage.
+     * If the page is already in storage, it will call `updatePage`.
+     * If it does not exist in storage, the function will call `createPage` instead.
+     * @param page the page to save.
+     */
+    savePage(page: Page): Promise<void>;
+}
+/**
+ * Request for launching an application.
+ */
+export interface LaunchAppRequest {
+    target?: OpenFin.EntityInfo;
+    app: App;
+}
+/**
+ * Get Themes from API
+ */
+export interface ThemeApi {
+    getThemes(): Promise<CustomThemes>;
+}
+/**
+ * Controller for a Workspace Platform.
+ */
+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.
+     */
+    applySnapshot(snapshot: BrowserSnapshot | string): Promise<OpenFin.Platform>;
+    /**
+     * Get a snapshot that contains browser windows with pages.
+     */
+    getSnapshot(): Promise<BrowserSnapshot>;
+    /**
+     * Launch an application.
+     * @param req the launch app request.
+     */
+    launchApp(req: LaunchAppRequest): Promise<void>;
+    /**
+     * The browser window factory for the Workspace Platform.
+     */
+    Browser: BrowserWindowFactory;
+    /**
+     * The storage API for the Workspace Platform.
+     */
+    Storage: WorkspacePlatformStorage;
+    Theme: ThemeApi;
+}
+export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
+    /**
+     * Implementation for getting a list of saved pages from persistent storage.
+     * @param query an optional query.
+     */
+    getSavedPages(query?: string): Promise<Page[]>;
+    /**
+     * Implementation for getting a single page in persistent storage.
+     * @param id
+     */
+    getSavedPage(id: string): Promise<Page>;
+    /**
+     * Implementation for creating a saved page in persistent storage.
+     * @param req the create saved page request.
+     */
+    createSavedPage(req: CreateSavedPageRequest): Promise<void>;
+    /**
+     * Implementation for updating a saved page in persistent storage.
+     * @param req the update saved page request.
+     */
+    updateSavedPage(req: UpdateSavedPageRequest): Promise<void>;
+    /**
+     * Implementation for deleting a saved page in persistent storage.
+     * @param id of the id of the page to delete.
+     */
+    deleteSavedPage(id: string): Promise<void>;
+}
+/**
+ * Configuration for initializing a Workspace platform.
+ */
+export interface WorkspacePlatformInitConfig {
+    /** Config for overriding browser options and behavior. */
+    browser?: BrowserInitConfig;
+    /** License key for Workspace Platform. */
+    licenseKey: string;
+    /** Custom Themes object */
+    theme?: CustomThemes;
+}
+/**
+ * Callback for overriding a Workspace Platform Provider.
+ */
+export declare type BrowserOverrideCallback = OpenFin.OverrideCallback<WorkspacePlatformProvider>;
+/**
+ * Configuration for initializing a Browser.
+ */
+export interface BrowserInitConfig {
+    defaultWindowOptions?: BrowserCreateWindowRequest;
+    defaultViewOptions?: OpenFin.ViewOptions;
+    overrideCallback?: BrowserOverrideCallback;
+    interopOverride?: OpenFin.OverrideCallback<InteropBroker, InteropBroker>;
+}

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,101 @@
+/// <reference types="openfin-adapter/fin" />
+import type { AttachedPage, AttachPagesToWindowPayload, DetachPagesFromWindowPayload, ReorderPagesForWindowPayload, SetActivePageForWindowPayload, UpdatePageForWindowPayload } from './shapes';
+/**
+ * All of the remote procedures that can be called in the
+ * platform window's address space regarding attached pages.
+ */
+export declare enum ChannelAction {
+    GetPages = "get-pages",
+    GetActivePageForWindow = "get-active-page-for-window",
+    AttachPagesToWindow = "attach-pages-to-window",
+    DetachPagesFromWindow = "detach-pages-from-window",
+    SetActivePageForWindow = "set-active-page-for-window",
+    RenamePage = "rename-page",
+    ReorderPagesForWindow = "reorder-pages-for-window",
+    UpdatePageForWindow = "update-page-for-window",
+    UpdatePagesWindowOptions = "update-pages-window-options",
+    IsDetachingPages = "is-detaching-pages",
+    IsActivePageChanging = "is-active-page-changing"
+}
+export declare enum EventType {
+    AttachedPagesToWindow = "attached-pages-to-window",
+    DetachedPagesFromWindow = "detached-pages-from-window"
+}
+export declare const getWindowChannelId: (identity: OpenFin.Identity) => string;
+export declare const getEventEmitter: (identity: OpenFin.Identity) => {
+    emit: (event: string | number, ...payload: any[]) => Promise<void>;
+    addListener: (event: string | number, listener: import("@common/utils/shared-emitter").Listener) => void;
+    removeListener: (event: string | number, listener: import("@common/utils/shared-emitter").Listener) => void;
+    once: (event: string | number, listener: import("@common/utils/shared-emitter").Listener) => void;
+};
+/**
+ * Get the pages attached to a window.
+ * @param identity the identity of the window to get the attached pages of.
+ * @returns the pages attached to the window.
+ */
+export declare const getPages: (identity: OpenFin.Identity) => Promise<AttachedPage[]>;
+/**
+ * Get the active attached page for the specified window.
+ * @param identity the window identity to get the active attached page of.
+ * @returns the active attached page for the window.
+ */
+export declare const getActivePageForWindow: (identity: OpenFin.Identity) => Promise<AttachedPage>;
+/**
+ * Set the active attached page for the specified window.
+ * @param identity the window identity to set the active attached page of.
+ */
+export declare const setActivePageForWindow: (payload: SetActivePageForWindowPayload) => Promise<void>;
+/**
+ * Attach a page to an open window.
+ * If the page is already attached to a window, an error will be thrown.
+ *
+ * @param payload the attach pages to window payload.
+ */
+export declare const attachPagesToWindow: (payload: AttachPagesToWindowPayload) => Promise<void>;
+/**
+ * Detach pages from the window they are currently attached to.
+ * A detached page will not have its views cleaned up.
+ *
+ * @param payload the detach pages from window payload.
+ */
+export declare const detachPagesFromWindow: (payload: DetachPagesFromWindowPayload) => Promise<void>;
+export interface RenamePagePayload {
+    /** The OF window identity the page is attached to. */
+    identity: OpenFin.Identity;
+    /** The id of the page to change the name of. */
+    pageId: string;
+    /** The new title of the page. */
+    newTitle: string;
+}
+/**
+ * Rename an attached page.
+ * The page must be attached to the specified window.
+ *
+ * @param page the page to rename.
+ */
+export declare const renamePage: (payload: RenamePagePayload) => Promise<void>;
+/**
+ * Reorder pages attached to an open window.
+ * @param payload the reorder pages for window payload.
+ */
+export declare const reorderPagesForWindow: (payload: ReorderPagesForWindowPayload) => Promise<void>;
+/**
+ * Update a page attached to a window.
+ * @param payload the update page for window payload.
+ */
+export declare const updatePageForWindow: (payload: UpdatePageForWindowPayload) => Promise<void>;
+/**
+ * Forces a window to save its attached page state to window options.
+ * @param identity the identity of the window to save the pages of in window options.
+ */
+export declare const updatePagesWindowOptions: (identity: OpenFin.Identity) => Promise<void>;
+/**
+ * Check if the window identity is currently detaching pages.
+ * @param identity the OF window identity to check.
+ */
+export declare const isDetachingPages: (identity: OpenFin.Identity) => Promise<boolean>;
+/**
+ * Check if the window identity is in the middle of changing active pages.
+ * @param identity the OF window identity to check.
+ */
+export declare const isActivePageChanging: (identity: OpenFin.Identity) => Promise<boolean>;

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

@@ -0,0 +1,12 @@
+import type { Page } from '@common/api/pages/shapes';
+export declare const store: import("idb-keyval").UseStore;
+export declare function getPage(id: string): Promise<Page>;
+export declare function getPageList(filter?: string): Promise<Page[]>;
+export declare function createPage({ page }: {
+    page: any;
+}): Promise<void>;
+export declare function deletePage(id: string): Promise<void>;
+export declare function updatePage({ pageId, page }: {
+    pageId: any;
+    page: any;
+}): Promise<void>;

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

@@ -0,0 +1,16 @@
+import { LayoutExtended } from '@common/utils/layout';
+import type { AttachedPage, Page, PageLayout, PageWithUpdatableRuntimeAttribs } from './shapes';
+export declare function getLegacyPages(): Promise<Page[]>;
+export declare function cleanPage(page: AttachedPage): Page;
+/**
+ * Get a page layout.
+ * @param layout the layout to add details to.
+ * @returns the layout with extra details.
+ */
+export declare const getPageLayout: (layout: any) => Promise<PageLayout>;
+/**
+ * Generates a Page object which represents a page.
+ * @param title the title for the page.
+ * @param layout the layout for the page.
+ */
+export declare const makePage: (title: string, layout: LayoutExtended) => Promise<PageWithUpdatableRuntimeAttribs>;

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

@@ -0,0 +1,16 @@
+import type { AttachedPage, PageLayout } from '@common/api/pages/shapes';
+interface Workstack {
+    id: string;
+    name: string;
+    isReadOnly: boolean;
+    layout: PageLayout;
+    isActive: boolean;
+}
+export declare function convertWorkstackToAttachedPage(workstack: Workstack & AttachedPage): AttachedPage;
+/**
+ * Attempts to fix any misconfigurations in a list of attached pages.
+ * @param pages the pages to fix.
+ * @returns the fixed pages.
+ */
+export declare const fixAttachedPages: (pages: AttachedPage[]) => AttachedPage[];
+export {};

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

@@ -0,0 +1,77 @@
+/// <reference types="openfin-adapter/fin" />
+import type { LayoutExtended } from '../../utils/layout';
+export interface PageLayoutDetails {
+    /** The id of the machine that created the page. */
+    machineId: string;
+    /** The name of the machine that created the page. */
+    machineName?: string;
+}
+export declare type PageLayout = LayoutExtended & {
+    layoutDetails?: PageLayoutDetails;
+};
+export interface Page {
+    /** A UI friendly title for the page. */
+    title: string;
+    /** The unique ID of the page. */
+    pageId: string;
+    /** An optional UI friendly description of the page. */
+    description?: string;
+    /** A optional UI friendly tooltip for the page. */
+    tooltip?: string;
+    /** True if the page is read only. In this state, the page is locked and cannot be unlocked. */
+    isReadOnly?: boolean;
+    /** The layout of the page. */
+    layout: PageLayout;
+}
+declare type AttachedPageMetadata = {
+    /** The window the page is currently attached to. */
+    parentIdentity?: OpenFin.Identity;
+    /** True if the page is the currently active page for its parent window. */
+    isActive?: boolean;
+    /** True if the page has unsaved changes. */
+    hasUnsavedChanges?: boolean;
+};
+export declare type AttachedPage = Page & AttachedPageMetadata;
+export declare type PageWithUpdatableRuntimeAttribs = Page & Pick<AttachedPage, 'hasUnsavedChanges'>;
+export interface DetachPagesFromWindowPayload {
+    /** The OF window identity to detach the pages from. */
+    identity: OpenFin.Identity;
+    /** The ids of the pages to detach. */
+    pageIds: string[];
+}
+export interface SetActivePageForWindowPayload {
+    /** The OF window identity to set the active page of. */
+    identity: OpenFin.Identity;
+    /**
+     * The id of the page to set as active.
+     * The page must be attached to the target window.
+     */
+    pageId: string;
+}
+export interface ReorderPagesForWindowPayload {
+    /** The OF window identity the pages to change the order of. */
+    identity: OpenFin.Identity;
+    /** The ordered ids of the attached pages. */
+    pageIds: string[];
+}
+export interface UpdatePageForWindowPayload {
+    /** The OF window identity the pages to change the order of. */
+    identity: OpenFin.Identity;
+    /** The id of the attached page to update. */
+    pageId: string;
+    /** The partial updated state of the page. */
+    page: Partial<PageWithUpdatableRuntimeAttribs>;
+}
+export interface AttachPagesToWindowPayload {
+    /** The OF window identity to attach the pages to. */
+    identity: OpenFin.Identity;
+    /** The pages to attach. */
+    pages: PageWithUpdatableRuntimeAttribs[];
+}
+export interface GetSavedPageMetadataPayload {
+    /** The OF window identity to attach the pages to. */
+    identity: OpenFin.Identity;
+    /** The id of the page to get the save state of. */
+    pageId: string;
+}
+export {};