@openfin/workspace-platform 10.3.8 → 11.0.0

package/client-api/src/home.d.ts

@@ -8,14 +8,14 @@ export * from './shapes/home';
 export declare const register: (provider: HomeProvider | CLIProvider) => Promise<HomeRegistration>;
 /**
  * Deregister a provider.
- * @param provider the Home provider implementation.
+ * @param providerId the Home provider ID.
  */
 export declare const deregister: (providerId: string) => Promise<void>;
 /**
  * Show the Home UI.
  */
-export declare function show(): Promise<any>;
+export declare function show(): Promise<void>;
 /**
  * Hide the Home UI.
  */
-export declare function hide(): Promise<any>;
+export declare function hide(): Promise<void>;

package/client-api/src/internal.d.ts

@@ -13,4 +13,5 @@ export interface ChannelDispatch {
  * @param fallbackResponse optional response for the fallback action.
  * @returns channel response is returned if action was succesful. If fallback was used, fallbackResponse is returned instead.
  */
-export declare function tryDispatch<T = void>(action: ChannelDispatch, fallback: ChannelDispatch, fallbackResponse?: T): Promise<T>;
+export declare function tryDispatch(action: ChannelDispatch, fallback: ChannelDispatch): Promise<void>;
+export declare function tryDispatch<T = undefined>(action: ChannelDispatch, fallback: ChannelDispatch, fallbackResponse: T): Promise<T>;

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

@@ -3,7 +3,7 @@
  * up the packaged typing files. When writing code examples,
  * for documentation, please use async/await syntax over .then()!
  */
-import { RegistrationMetaInfo } from './common';
+import { CustomButtonConfig, RegistrationMetaInfo } from './common';
 import { ProviderInfo } from './provider';
 /**
  * Describes the type of the app directory entry `manifest` attributes.
@@ -41,6 +41,12 @@ export interface Image {
     size?: string;
     purpose?: string;
 }
+/**
+ * Store custom button configuration
+ */
+export interface StoreButtonConfig extends Omit<CustomButtonConfig, 'tooltip' | 'iconUrl'> {
+    title: string;
+}
 /**
  * Detailed metadata describing an application.
  */
@@ -56,7 +62,7 @@ export interface App {
     /**
      * URL to application manifest.
      */
-    manifest: string;
+    manifest?: string;
     /**
      * UI friendly description for an application.
      */
@@ -65,7 +71,7 @@ export interface App {
      * Describes the type of manifest resolved by the `manifest` field.
      * Launch mechanics are determined by the manifest type.
      */
-    manifestType: AppManifestType | string;
+    manifestType?: AppManifestType | string;
     /**
      * A list of icons that can be rendered in UI for this application.
      */
@@ -74,6 +80,14 @@ export interface App {
      * A list of optional images that highlight application functionality.
      */
     images?: Image[];
+    /**
+     * Primary button configuration.
+     */
+    primaryButton?: StoreButtonConfig;
+    /**
+     * Array of secondary button configurations.
+     */
+    secondaryButtons?: StoreButtonConfig[];
     intents?: AppIntent[];
     tags?: string[];
     version?: string;
@@ -133,6 +147,30 @@ export interface StorefrontNavigationSection {
         StorefrontNavigationItem?
     ];
 }
+/**
+ * Represents the existing StorefrontDetailedNavigationItem and existing App interfaces
+ * Used by StorefrontLandingPage to represent items in the bottom, middle and top rows.
+ */
+export declare type StorefrontLandingPageItem = StorefrontDetailedNavigationItem | App;
+export declare type StorefrontLandingPageTopRow = [
+    StorefrontLandingPageItem?,
+    StorefrontLandingPageItem?,
+    StorefrontLandingPageItem?,
+    StorefrontLandingPageItem?
+];
+export declare type StorefrontLandingPageMiddleRow = [
+    StorefrontLandingPageItem?,
+    StorefrontLandingPageItem?,
+    StorefrontLandingPageItem?,
+    StorefrontLandingPageItem?,
+    StorefrontLandingPageItem?,
+    StorefrontLandingPageItem?
+];
+export declare type StorefrontLandingPageBottomRow = [
+    StorefrontLandingPageItem?,
+    StorefrontLandingPageItem?,
+    StorefrontLandingPageItem?
+];
 export interface StorefrontLandingPage {
     hero?: {
         title: string;
@@ -142,24 +180,15 @@ export interface StorefrontLandingPage {
     };
     topRow: {
         title: string;
-        items: [
-            StorefrontDetailedNavigationItem?,
-            StorefrontDetailedNavigationItem?,
-            StorefrontDetailedNavigationItem?,
-            StorefrontDetailedNavigationItem?
-        ];
+        items: StorefrontLandingPageTopRow;
     };
     middleRow: {
         title: string;
-        apps: [App?, App?, App?, App?, App?, App?];
+        apps: StorefrontLandingPageMiddleRow;
     };
     bottomRow: {
         title: string;
-        items: [
-            StorefrontDetailedNavigationItem?,
-            StorefrontDetailedNavigationItem?,
-            StorefrontDetailedNavigationItem?
-        ];
+        items: StorefrontLandingPageBottomRow;
     };
 }
 /**

package/client-api-platform/src/api/app-directory.d.ts

@@ -1,8 +1,8 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import type { LaunchAppRequest } from '../shapes';
 /**
  * Launch the app described by an App Directory entry.
  * @param app the app directory entry.
  * @param opts launch options.
  */
-export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | import("@openfin/core/src/api/view").View | OpenFin.Identity | import("@openfin/core/src/api/platform").Platform | import("@openfin/core/src/api/application").Application>;
+export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | import("@openfin/core/src/api/application").Application | OpenFin.Identity | import("@openfin/core/src/api/view").View | import("@openfin/core/src/api/platform").Platform>;

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

@@ -1,2 +1,3 @@
+import type OpenFin from '@openfin/core';
 import { BrowserWindowModule } from '../../../../client-api-platform/src/shapes';
 export declare const getBrowserModule: (identity: OpenFin.Identity) => BrowserWindowModule;

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import type { AttachedPage } from '../../../../common/src/api/pages/shapes';
 import type { BrowserCreateWindowRequest, BrowserWindowModule } from '../../shapes';
 export declare const getBrowserApi: (identity: OpenFin.ApplicationIdentity) => {

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import { OpenGlobalContextMenuPayload, OpenGlobalContextMenuRequest, OpenPageTabContextMenuPayload, OpenPageTabContextMenuRequest, OpenSaveButtonContextMenuPayload, OpenSaveButtonContextMenuRequest, OpenViewTabContextMenuPayload, OpenViewTabContextMenuRequest, WorkspacePlatformProvider } from '../../../../client-api-platform/src/shapes';
 export declare function openGlobalContextMenuInternal(this: WorkspacePlatformProvider, payload: OpenGlobalContextMenuRequest & {
     identity: OpenFin.Identity;

package/client-api-platform/src/api/context-menu/utils.d.ts

@@ -1,3 +1,4 @@
+import type OpenFin from '@openfin/core';
 import { WorkspaceContextMenuItemData } from '../../../../client-api-platform/src/shapes';
 export declare const saveWorkspaceHandler: (identity: OpenFin.Identity) => Promise<void>;
 export declare const saveWorkspaceAsHandler: (identity: OpenFin.Identity) => void;

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import { WorkspacePlatformModule } from '../shapes';
 export declare const wrapSync: (identity: OpenFin.ApplicationIdentity) => WorkspacePlatformModule;
 export declare const getCurrentSync: () => WorkspacePlatformModule;

package/client-api-platform/src/api/pages/helper.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import { SnapshotExtended } from '../../../../common/src/utils/snapshot';
 /**
  * Get a snapshot with pages.

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

@@ -1,5 +1,5 @@
-/// <reference types="@openfin/core" />
-import type { AttachedPage, AttachPagesToWindowPayload, DetachPagesFromWindowPayload, ReorderPagesForWindowPayload, SetActivePageForWindowPayload, UpdatePageForWindowPayload } from '../../../../common/src/api/pages/shapes';
+import type OpenFin from '@openfin/core';
+import type { AttachedPage, DetachPagesFromWindowPayload, ExtendedAttachPagesToWindowPayload, ReorderPagesForWindowPayload, SetActivePageForWindowPayload, UpdatePageForWindowPayload } from '../../../../common/src/api/pages/shapes';
 import type { CreateSavedPageRequest, Page, UpdateSavedPageRequest } from '../../../../client-api-platform/src/shapes';
 /**
  * Get all open pages in which are attached to a window.
@@ -10,7 +10,7 @@ export declare const createSavedPageInternal: ({ page }: CreateSavedPageRequest)
 export declare const deleteSavedPageInternal: (id: string) => Promise<void>;
 export declare const updateSavedPageInternal: ({ pageId, page }: UpdateSavedPageRequest) => Promise<any>;
 export declare const savePage: (page: Page) => Promise<any>;
-export declare const attachPagesToWindow: (payload: AttachPagesToWindowPayload) => Promise<void>;
+export declare const attachPagesToWindow: (payload: ExtendedAttachPagesToWindowPayload) => Promise<void>;
 export declare const updatePageForWindow: (payload: UpdatePageForWindowPayload) => Promise<void>;
 export declare const detachPagesFromWindow: (payload: DetachPagesFromWindowPayload) => Promise<void>;
 export declare const setActivePage: (payload: SetActivePageForWindowPayload) => Promise<void>;

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import { Page } from '../../../common/src/api/pages/shapes';
 import type { CreateSavedPageRequest, CreateSavedWorkspaceRequest, UpdateSavedPageRequest, UpdateSavedWorkspaceRequest, Workspace } from '../shapes';
 export declare const getStorageApi: (identity: OpenFin.ApplicationIdentity) => {

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import { ColorSchemeOptionType, ThemeApi } from '../../../client-api-platform/src/shapes';
 export declare const getThemingApi: (identity: OpenFin.ApplicationIdentity) => ThemeApi;
 export declare const setSelectedScheme: (schemeType: ColorSchemeOptionType) => Promise<void>;

package/client-api-platform/src/api/workspaces/idb.d.ts

@@ -1,6 +1,6 @@
 import { Workspace } from '../../../../client-api-platform/src/shapes';
 export declare const store: import("idb-keyval").UseStore;
-export declare function getWorkspace(id: string): Promise<Workspace>;
+export declare function getWorkspace(id: string): Promise<Workspace | undefined>;
 export declare function getWorkspaceList(filter?: string): Promise<Workspace[]>;
 export declare function createWorkspace({ workspace }: {
     workspace: Workspace;

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 /**
  * Get the last focused browser window.
  * @returns the last focused browser window.

package/client-api-platform/src/init/custom-actions.d.ts

@@ -1,3 +1,3 @@
 import { CustomActionsMap, InvokeCustomActionRequest } from '..';
 export declare const initCustomActions: (actions: CustomActionsMap) => void;
-export declare const invokeCustomActionInternal: ({ actionId, payload }: InvokeCustomActionRequest) => any;
+export declare const makeInvokeCustomActionInternal: (identity: OpenFin.ApplicationIdentity) => ({ actionId, payload }: InvokeCustomActionRequest) => Promise<any>;

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

@@ -1,3 +1,3 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import { ShowQuitPlatformDialogRequest } from '..';
 export declare const showQuitPlatformDialogInternal: (req: ShowQuitPlatformDialogRequest, identity: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<void>;

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

@@ -1 +1 @@
-import '../test/fin-mocks';
+import '@common/test/fin-mocks';

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import type { BrowserInitConfig } from '../../../client-api-platform/src/shapes';
 import { WorkspacePlatformOverrideCallback, WorkspacePlatformProvider } from '..';
 export declare const getOverrideCallback: (browserInitOptions: BrowserInitConfig, overrideCallback?: WorkspacePlatformOverrideCallback) => OpenFin.OverrideCallback<WorkspacePlatformProvider>;

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

@@ -0,0 +1,4 @@
+import { AttachedPage, ExtendedPanelConfig, PanelConfig } from '../../../common/src/api/pages/shapes';
+export declare function convertPanelViewOpts(panels: PanelConfig[]): ExtendedPanelConfig[];
+export declare function createPanelViewsForPages(pages: AttachedPage[]): Promise<import("@openfin/core/src/api/view").View[][]>;
+export declare function createPanelViews(panels: PanelConfig[]): Promise<import("@openfin/core/src/api/view").View[]>;

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

@@ -1,5 +1,5 @@
-/// <reference types="@openfin/core" />
-import type { Page } from '../../../common/src/api/pages/shapes';
+import type OpenFin from '@openfin/core';
+import type { AttachedPage, Page } from '../../../common/src/api/pages/shapes';
 import type { CustomThemeOptions, CustomThemeOptionsWithScheme } from '../../../common/src/api/theming';
 import type { BrowserInitConfig, BrowserSnapshot } from '..';
 export declare function overrideViewOptions(options: Partial<OpenFin.ViewOptions>, initOptions: OpenFin.ViewOptions): any;
@@ -28,21 +28,7 @@ declare type LegacyWindowOptions = Omit<OpenFin.PlatformWindowCreationOptions, '
     workstacks?: Page[];
 };
 export declare const initWorkspacePlatformOptions: (options: LegacyWindowOptions | OpenFin.PlatformWindowCreationOptions) => OpenFin.PlatformWindowCreationOptions;
-export declare const applyPageDefaults: (pages: Page[], defaultPageOptions?: BrowserInitConfig['defaultPageOptions']) => Promise<{
-    title: string;
-    layout: any;
-    pageId: string;
-    description?: string;
-    tooltip?: string;
-    isReadOnly?: boolean;
-    unsavedIconUrl?: string;
-    iconUrl?: string;
-    isLocked?: boolean;
-    closeButton?: {
-        hidden?: boolean;
-        disabled?: boolean;
-    };
-}[]>;
+export declare const applyPageDefaults: (pages: Page[], defaultPageOptions?: BrowserInitConfig['defaultPageOptions']) => Promise<AttachedPage[]>;
 export declare const applyBrowserDefaults: (options: OpenFin.PlatformWindowCreationOptions, initOptions: Pick<BrowserInitConfig, 'title' | 'defaultWindowOptions' | 'defaultPageOptions'>, theme: CustomThemeOptions | CustomThemeOptionsWithScheme) => Promise<OpenFin.PlatformWindowCreationOptions>;
 export declare enum WindowType {
     Browser = "browser",

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import { IconProps } from '@openfin/ui-library';
 import type { AnalyticsEvent } from '../../common/src/utils/usage-register';
 import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
@@ -8,7 +8,8 @@ import type { App } from '../../client-api/src/shapes';
 export { AppManifestType } from '../../client-api/src/shapes';
 export type { App, AppIntent, Image } from '../../client-api/src/shapes';
 export type { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
-export type { AttachedPage, Page, PageLayout, PageLayoutDetails, PageWithUpdatableRuntimeAttribs } from '../../common/src/api/pages/shapes';
+export type { AttachedPage, Page, PageLayout, PageLayoutDetails, PageWithUpdatableRuntimeAttribs, PanelConfigHorizontal, PanelConfigVertical, PanelConfig, ExtendedPanelConfig } from '../../common/src/api/pages/shapes';
+export { PanelPosition } from '../../common/src/api/pages/shapes';
 export type { CustomThemes, CustomThemeOptions, CustomThemeOptionsWithScheme, CustomPaletteSet } from '../../common/src/api/theming';
 export type { AnalyticsEvent } from '../../common/src/utils/usage-register';
 /**
@@ -289,6 +290,56 @@ export interface CustomButtonActionPayload {
     /** Screen y-coordinate where custom button should be shown. */
     y: number;
 }
+/**
+ * The shape that is used by {@link StoreCustomButtonActionPayload.updateButtonState} method payload parameter in  {@link StoreCustomButtonActionPayload}.
+ */
+export interface UpdateStoreCustomButtonStateRequest {
+    /**
+     * New title for the primary button.
+     */
+    title: string;
+    /**
+     * New disabled state for the primary button.
+     */
+    disabled?: boolean;
+}
+/**
+ * The shape of the payload that is sent by a store app primary button or secondary button click to a platform custom action handler
+ */
+export interface StoreCustomButtonActionPayload extends Omit<CustomButtonActionPayload, 'callerType'> {
+    /**
+     * Invoking application id.
+     */
+    appId: string;
+    /**
+     * Callback that allows the update of app's primary button config properties, such as: title and disabled flag.
+     * Below of `updateButtonState` use in the context of platform custom actions.
+     *
+     * ```ts
+     * WorkspacePlatform.init({
+     *         customActions: {
+     *          'changeButtonState': async (payload: StoreCustomButtonActionPayload) => {
+     *                 await payload.updateButtonState({
+     *                     title: 'Disabled Primary Button For 2 Seconds',
+     *                     disabled: true
+     *                 });
+     *                 setTimeout(async () => {
+     *                     await payload.updateButtonState({
+     *                         disabled: false,
+     *                         title: 'Active Test Primary Button'
+     *                     });
+     *                 }, 2000);
+     *             }
+     *        }
+     * });
+     * ```
+     */
+    updateButtonState: (updateRequest: UpdateStoreCustomButtonStateRequest) => Promise<void>;
+    /**
+     * callerType - StoreCustomButton type.
+     */
+    callerType: CustomActionCallerType.StoreCustomButton;
+}
 /**
  * The shape of the payload sent by a custom dropdown menu item to a custom action handler
  */
@@ -1231,6 +1282,7 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
  */
 export declare enum CustomActionCallerType {
     CustomButton = "CustomButton",
+    StoreCustomButton = "StoreCustomButton",
     CustomDropdownItem = "CustomDropdownItem",
     GlobalContextMenu = "GlobalContextMenu",
     ViewTabContextMenu = "ViewTabContextMenu",
@@ -1243,7 +1295,7 @@ export declare enum CustomActionCallerType {
  * When `callerType == CustomActionCallerType.API`, the payload is defined by the code directly invoking the action.*/
 export declare type CustomActionPayload = {
     callerType: CustomActionCallerType.API;
-} | CustomButtonActionPayload | CustomDropdownItemActionPayload | GlobalContextMenuOptionActionPayload | ViewTabCustomActionPayload | PageTabContextMenuOptionActionPayload | OpenSaveContextMenuOptionActionPayload;
+} | CustomButtonActionPayload | StoreCustomButtonActionPayload | CustomDropdownItemActionPayload | GlobalContextMenuOptionActionPayload | ViewTabCustomActionPayload | PageTabContextMenuOptionActionPayload | OpenSaveContextMenuOptionActionPayload;
 /**
  * Defines custom action map where the key is the custom action ID and value is the action handler
  */

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

@@ -16,6 +16,6 @@ export interface Overrides {
     disableRuntimeValidation: boolean;
     enableOpenFinAnalytics: boolean;
 }
-export declare function getOverrides(): Promise<Overrides>;
-export declare const useOverrides: () => Overrides;
+export declare function getOverrides(): Promise<Partial<Overrides>>;
+export declare const useOverrides: () => Partial<Overrides>;
 export {};

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

@@ -1,15 +1,5 @@
-/// <reference types="@openfin/core" />
-import type { AttachedPage, AttachPagesToWindowPayload, DetachPagesFromWindowPayload, ReorderPagesForWindowPayload, SetActivePageForWindowPayload, UpdatePageForWindowPayload } from './shapes';
-export declare enum EventType {
-    AttachedPagesToWindow = "attached-pages-to-window",
-    DetachedPagesFromWindow = "detached-pages-from-window"
-}
-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;
-};
+import type OpenFin from '@openfin/core';
+import type { AttachedPage, DetachPagesFromWindowPayload, ExtendedAttachPagesToWindowPayload, ExtendedUpdatePageForWindowPayload, ReorderPagesForWindowPayload, SetActivePageForWindowPayload } from './shapes';
 /**
  * Get the pages attached to a window.
  * @param identity the identity of the window to get the attached pages of.
@@ -33,7 +23,7 @@ export declare const setActivePageForWindow: (payload: SetActivePageForWindowPay
  *
  * @param payload the attach pages to window payload.
  */
-export declare const attachPagesToWindow: (payload: AttachPagesToWindowPayload) => Promise<void>;
+export declare const attachPagesToWindow: (payload: ExtendedAttachPagesToWindowPayload) => Promise<void>;
 /**
  * Detach pages from the window they are currently attached to.
  * A detached page will not have its views cleaned up.
@@ -65,7 +55,7 @@ export declare const reorderPagesForWindow: (payload: ReorderPagesForWindowPaylo
  * Update a page attached to a window.
  * @param payload the update page for window payload.
  */
-export declare const updatePageForWindow: (payload: UpdatePageForWindowPayload) => Promise<void>;
+export declare const updatePageForWindow: (payload: ExtendedUpdatePageForWindowPayload) => 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.

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

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

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

@@ -1,7 +1,7 @@
 import { LayoutExtended } from '../../../../common/src/utils/layout';
 import type { AttachedPage, Page, PageLayout, PageWithUpdatableRuntimeAttribs } from './shapes';
 export declare function getLegacyPages(): Promise<Page[]>;
-export declare function cleanPage(page: AttachedPage): Page;
+export declare function cleanPage<T extends AttachedPage | Page>(page: T): T;
 /**
  * Get a page layout.
  * @param layout the layout to add details to.
@@ -19,4 +19,4 @@ export declare const makePage: (title: string, layout: LayoutExtended) => Promis
  * @param page the page to clone.
  * @returns a clone of the given page.
  */
-export declare const clonePage: (page: Page) => Promise<PageWithUpdatableRuntimeAttribs>;
+export declare const clonePage: <T extends Page | AttachedPage>(page: T) => Promise<T>;

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import type { LayoutExtended } from '../../utils/layout';
 export interface PageLayoutDetails {
     /** The id of the machine that created the page. */
@@ -35,6 +35,8 @@ export interface Page {
         hidden?: boolean;
         disabled?: boolean;
     };
+    /** Used to configure fixed views on the edges of the browser window. Only one panel per side is supported. */
+    panels?: PanelConfig[];
 }
 declare type AttachedPageMetadata = {
     /** The window the page is currently attached to. */
@@ -43,6 +45,8 @@ declare type AttachedPageMetadata = {
     isActive?: boolean;
     /** True if the page has unsaved changes. */
     hasUnsavedChanges?: boolean;
+    /** Panel config with all view identities in place */
+    panels?: ExtendedPanelConfig[];
 };
 export declare type AttachedPage = Page & AttachedPageMetadata;
 export declare type PageWithUpdatableRuntimeAttribs = Page & Pick<AttachedPage, 'hasUnsavedChanges'>;
@@ -75,16 +79,55 @@ export interface UpdatePageForWindowPayload {
     /** The partial updated state of the page. */
     page: Partial<PageWithUpdatableRuntimeAttribs>;
 }
+export interface ExtendedUpdatePageForWindowPayload extends UpdatePageForWindowPayload {
+    /** The partial updated state of the page. */
+    page: Partial<AttachedPage>;
+}
 export interface AttachPagesToWindowPayload {
     /** The OF window identity to attach the pages to. */
     identity: OpenFin.Identity;
     /** The pages to attach. */
     pages: PageWithUpdatableRuntimeAttribs[];
 }
+export interface ExtendedAttachPagesToWindowPayload extends AttachPagesToWindowPayload {
+    /** The pages to attach. */
+    pages: AttachedPage[];
+}
 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 declare enum PanelPosition {
+    Left = "Left",
+    Right = "Right",
+    Top = "Top",
+    Bottom = "Bottom"
+}
+export interface PanelConfigHorizontal {
+    /** Position of the panel in the page. */
+    position: PanelPosition.Top | PanelPosition.Bottom;
+    /** Size of the top/bottom panel, formatted as CSS property value with units. E.g. "0px", "10%", "3rem". */
+    height: string;
+}
+export interface PanelConfigVertical {
+    /** Position of the panel in the page. */
+    position: PanelPosition.Left | PanelPosition.Right;
+    /** Size of the left/right panel, formatted as CSS property value with units. E.g. "0px", "10%", "3rem". */
+    width: string;
+    /** When true, the left/right panel extends all the way to the top of the window,
+     * thus taking priority over the top panel.*/
+    extendToTop?: boolean;
+    /** When true, the left/right panel extends all the way to the bottom of the window,
+     * thus taking priority over the bottom panel.*/
+    extendToBottom?: boolean;
+}
+export declare type PanelConfig = (PanelConfigHorizontal | PanelConfigVertical) & {
+    /** The options with which to initialize the panel view.*/
+    viewOptions: Omit<OpenFin.PlatformViewCreationOptions, 'bounds' | 'target'>;
+};
+export declare type ExtendedPanelConfig = PanelConfig & {
+    viewOptions: PanelConfig['viewOptions'] & OpenFin.Identity;
+};
 export {};

package/common/src/api/protocol/browser.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 export declare const getWindowChannelId: (identity: OpenFin.Identity) => string;
 export interface ChannelClient extends OpenFin.ChannelClient {
     dispatch: (action: typeof BrowserChannelAction[keyof BrowserChannelAction], payload?: any) => Promise<any>;

package/common/src/api/protocol/notifications.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import { ColorSchemeOptionType } from '../../../../client-api-platform/src/shapes';
 export declare const NOTIFICATIONS_SYNC_CHANNEL = "of-workspace-notifications-sync";
 export declare enum NotificationsChannelAction {

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

@@ -1,3 +1,4 @@
+import type OpenFin from '@openfin/core';
 /**
  * All of the remote procedures that can be called in the
  * a Workspace Platform's address space.

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 /** The name of the channel for the centralized workspace protocol. */
 export declare const channelName = "__of_workspace_protocol__";
 /**
@@ -27,6 +27,7 @@ export declare enum WorkspaceChannelAction {
     AssignHomeSearchContext = "assign-home-search-context",
     SetSearchQuery = "set-search-query",
     OpenHomeAndSetSearchQuery = "open-home-and-set-search-query",
+    SetStoreButtonState = "set-store-button-state",
     GetLegacyPages = "get-legacy-pages",
     GetLegacyWorkspaces = "get-legacy-workspaces",
     GetComputedPlatformTheme = "get-computed-platform-theme",

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import { ProviderInfo } from '../../../client-api/src/shapes';
 export declare enum ProviderType {
     Storefront = "storefront",