@openfin/workspace-platform 8.1.5 → 8.1.8

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

@@ -3,3 +3,11 @@ export type { Workspace } from '../../../common/src/api/workspaces';
 export type { LayoutExtended, LayoutContentExtended, LayoutSettingsExtended, LayoutContentItemExtended, LayoutComponentExtended, LayoutComponentStateExtended, LayoutStack } from '../../../common/src/utils/layout';
 export type { Page, PageLayout, PageLayoutDetails } from '../../../common/src/api/pages/shapes';
 export { SearchTagBackground } from '../../../search-api/src/shapes';
+export type { ProviderInfo } from './provider';
+export type { BaseCustomButtonConfig, BaseCustomDropdownConfig, BaseCustomDropdownItem, BaseCustomDropdownItems, CustomActionSpecifier, CustomButtonConfig, CustomDropdownConfig } from '../../../common/src/api/action';
+/**
+ * return by component.register function
+ */
+export interface RegisterMetaInfo {
+    workspaceVersion: string;
+}

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

@@ -0,0 +1,63 @@
+/// <reference types="@openfin/core" />
+import { CustomActionSpecifier, CustomButtonConfig, CustomDropdownConfig } from '../../../common/src/api/action';
+import { ProviderInfo } from './provider';
+/**
+ * Configuration of the workspace component buttons.
+ */
+export interface WorkspaceComponentButtonOptions {
+    /**
+     * If set, Workspaces button will be hidden from the dock.
+     */
+    hideWorkspacesButton?: boolean;
+    /**
+     * If set, Home button will be hidden from the dock.
+     */
+    hideHomeButton?: boolean;
+    /**
+     * If set, Notifications button will be hidden from the dock.
+     */
+    hideNotificationsButton?: boolean;
+    /**
+     * If set, Storefront button will be hidden from the dock.
+     */
+    hideStorefrontButton?: boolean;
+}
+/**
+ * Configuration of an option in the dock menu button context menu
+ */
+export interface DockMenuItemTemplate extends OpenFin.MenuItemTemplate {
+    data: CustomActionSpecifier;
+}
+/**
+ * Names of the dock buttons
+ */
+export declare enum DockButtonNames {
+    ActionButton = "ActionButton",
+    DropdownButton = "DropdownButton"
+}
+/**
+ * Configuration of a dock action button
+ */
+export interface DockButtonConfig extends CustomButtonConfig {
+    type?: DockButtonNames.ActionButton;
+}
+/**
+ * Configuration of a dock menu button
+ */
+export interface DockDropdownConfig extends CustomDropdownConfig {
+    type: DockButtonNames.DropdownButton;
+}
+/**
+ * Dock button types
+ */
+export declare type DockButton = DockButtonConfig | DockDropdownConfig;
+export interface DockProvider extends ProviderInfo {
+    /**
+     * Controls the visiblity of workspace component buttons on the Dock.
+     */
+    workspaceComponents?: WorkspaceComponentButtonOptions;
+    /**
+     * Platform specific custom buttons to display on the Dock.
+     */
+    buttons?: DockButton[];
+}

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

@@ -3,5 +3,7 @@
  */
 export * from './common';
 export * from './home';
+export * from './provider';
 export * from './store';
 export * from './templates';
+export * from './dock';

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

@@ -0,0 +1,18 @@
+export interface ProviderInfo {
+    /**
+     * Unique identifier for the provider.
+     */
+    id: string;
+    /**
+     * A UI friendly title for the provider platform.
+     */
+    title: string;
+    /**
+     * Icon for the provider.
+     */
+    icon: string;
+    /**
+     *  version of client SDK, set by the API
+     */
+    clientAPIVersion?: string;
+}

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

@@ -3,6 +3,7 @@
  * up the packaged typing files. When writing code examples,
  * for documentation, please use async/await syntax over .then()!
  */
+import { ProviderInfo } from './provider';
 /**
  * Describes the type of the app directory entry `manifest` attributes.
  * Launch mechanics are determined by the manifest type.
@@ -212,21 +213,7 @@ export declare type StorefrontNavigationItem = StorefrontNavigationItemAppGrid |
  *  Render an item in the navigation bar of Storefront with a description and image.
  */
 export declare type StorefrontDetailedNavigationItem = StorefrontNavigationItem & StorefrontNavigationItemDetails;
-export interface StorefrontProviderInfo {
-    /**
-     * Unique identifier for the Storefront provider.
-     */
-    id: string;
-    /**
-     * A UI friendly title for the platform Storefront.
-     * This will be used in the Storefront selection dropdown.
-     */
-    title: string;
-    /**
-     * Icon for storefront provider.
-     * Visible next to title in storefront provider selector UI
-     */
-    icon: string;
+export interface StorefrontProviderInfo extends ProviderInfo {
 }
 /**
  * Describes a Storefront provided by a platform.

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

@@ -1,7 +1,8 @@
+/// <reference types="@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-adapter").View | import("openfin-adapter").Application | import("openfin-adapter/src/api/platform").Platform | import("openfin-adapter").Identity>;
+export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | import("@openfin/core/src/api/view").View | OpenFin.Identity | import("@openfin/core/src/api/application").Application | import("@openfin/core/src/api/platform").Platform>;

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

@@ -3,7 +3,7 @@ import { OpenPageTabContextMenuRequest } from '../../../../client-api-platform/s
 import { OpenGlobalContextMenuRequest, OpenSaveButtonContextMenuRequest, OpenSaveMenuRequest, OpenViewTabContextMenuRequest, ToolbarOptions, WindowStateButtonOptions } from '../../../../client-api-platform/src/shapes';
 export declare const getBrowserModule: (identity: OpenFin.Identity) => {
     identity: OpenFin.Identity;
-    openfinWindow: import("openfin-adapter").Window;
+    openfinWindow: import("@openfin/core/src/api/window")._Window;
     getPages: () => Promise<AttachedPage[]>;
     getPage: (pageId: string) => Promise<AttachedPage>;
     addPage: (page: PageWithUpdatableRuntimeAttribs) => Promise<void>;

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

@@ -1,10 +1,10 @@
-/// <reference types="openfin-adapter/fin" />
+/// <reference types="@openfin/core" />
 import type { AttachedPage } from '../../../../common/src/api/pages/shapes';
 import type { BrowserCreateWindowRequest, BrowserWindowModule } from '../../shapes';
 export declare const getBrowserApi: (identity: OpenFin.ApplicationIdentity) => {
     wrapSync: (windowIdentity: OpenFin.Identity) => {
         identity: OpenFin.Identity;
-        openfinWindow: import("openfin-adapter").Window;
+        openfinWindow: import("@openfin/core/src/api/window")._Window;
         getPages: () => Promise<AttachedPage[]>;
         getPage: (pageId: string) => Promise<AttachedPage>;
         addPage: (page: import("@common/api/pages/shapes").PageWithUpdatableRuntimeAttribs) => Promise<void>;

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

@@ -1,15 +1,15 @@
-import { NamedIdentity } from 'openfin-adapter/src/identity';
+/// <reference types="@openfin/core" />
 import { OpenGlobalContextMenuPayload, OpenGlobalContextMenuRequest, OpenPageTabContextMenuPayload, OpenPageTabContextMenuRequest, OpenSaveButtonContextMenuPayload, OpenSaveButtonContextMenuRequest, OpenViewTabContextMenuPayload, OpenViewTabContextMenuRequest } from '../../../../client-api-platform/src/shapes';
 export declare function openGlobalContextMenuInternal(payload: OpenGlobalContextMenuRequest & {
-    identity: NamedIdentity;
+    identity: OpenFin.Identity;
 }, callerIdentity: any): Promise<void>;
 export declare const openCommonContextMenu: (payload: OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload, callerIdentity: any) => Promise<void>;
 export declare function openViewTabContextMenuInternal(payload: OpenViewTabContextMenuRequest & {
-    identity: NamedIdentity;
+    identity: OpenFin.Identity;
 }, callerIdentity: any): Promise<void>;
 export declare function openPageTabContextMenuInternal(payload: OpenPageTabContextMenuRequest & {
-    identity: NamedIdentity;
+    identity: OpenFin.Identity;
 }, callerIdentity: any): Promise<void>;
 export declare function openSaveButtonContextMenuInternal(payload: OpenSaveButtonContextMenuRequest & {
-    identity: NamedIdentity;
+    identity: OpenFin.Identity;
 }, callerIdentity: any): Promise<void>;

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

@@ -1,16 +1,15 @@
-import { NamedIdentity } from 'openfin-adapter/src/identity';
 import { WorkspaceContextMenuItemData } from '../../../../client-api-platform/src/shapes';
-export declare const saveWorkspaceHandler: (identity: NamedIdentity) => Promise<void>;
-export declare const saveWorkspaceAsHandler: (identity: NamedIdentity) => void;
+export declare const saveWorkspaceHandler: (identity: OpenFin.Identity) => Promise<void>;
+export declare const saveWorkspaceAsHandler: (identity: OpenFin.Identity) => void;
 /**
  * @param identity Identity of browser window to execute save on.
  * @param pageId Id of a page to save. If omitted, active page is saved.
  */
-export declare const savePageHandler: (identity: NamedIdentity, pageId?: string) => Promise<void>;
+export declare const savePageHandler: (identity: OpenFin.Identity, pageId?: string) => Promise<void>;
 /**
  * @param identity Identity of browser window to execute save on.
  * @param pageId Id of a page to save. If omitted, active page is saved.
  */
-export declare const savePageAsHandler: (identity: NamedIdentity, pageId?: string) => Promise<void>;
-export declare const switchWorkspaceHandler: (winIdentity: NamedIdentity, workspaceItemData: WorkspaceContextMenuItemData) => Promise<void>;
-export declare const deleteWorkspaceHandler: (winIdentity: NamedIdentity, workspaceItemData: WorkspaceContextMenuItemData) => Promise<void>;
+export declare const savePageAsHandler: (identity: OpenFin.Identity, pageId?: string) => Promise<void>;
+export declare const switchWorkspaceHandler: (winIdentity: OpenFin.Identity, workspaceItemData: WorkspaceContextMenuItemData) => Promise<void>;
+export declare const deleteWorkspaceHandler: (winIdentity: OpenFin.Identity, workspaceItemData: WorkspaceContextMenuItemData) => Promise<void>;

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

@@ -1,4 +1,4 @@
-/// <reference types="openfin-adapter/fin" />
+/// <reference types="@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-adapter/fin" />
+/// <reference types="@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,4 +1,4 @@
-/// <reference types="openfin-adapter/fin" />
+/// <reference types="@openfin/core" />
 import type { AttachPagesToWindowPayload } from '../../../../common/src/api/pages/shapes';
 import type { CreateSavedPageRequest, Page, UpdateSavedPageRequest } from '../../../../client-api-platform/src/shapes';
 /**

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

@@ -1,7 +1,6 @@
-/// <reference types="openfin-adapter/fin" />
 import { Page } from '../../../common/src/api/pages/shapes';
 import type { CreateSavedPageRequest, CreateSavedWorkspaceRequest, UpdateSavedPageRequest, UpdateSavedWorkspaceRequest, Workspace } from '../shapes';
-export declare const getStorageApi: (identity: OpenFin.ApplicationIdentity) => {
+export declare const getStorageApi: (identity: any) => {
     createPage: (req: CreateSavedPageRequest) => Promise<any>;
     deletePage: (id: string) => Promise<any>;
     updatePage: (req: UpdateSavedPageRequest) => Promise<any>;

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

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

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

@@ -1,4 +1,4 @@
-/// <reference types="openfin-adapter/fin" />
+/// <reference types="@openfin/core" />
 /**
  * Get the last focused browser window.
  * @returns the last focused browser window.

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

@@ -1,4 +1,4 @@
-/// <reference types="openfin-adapter/fin" />
+/// <reference types="@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/utils.d.ts

@@ -1,11 +1,11 @@
-/// <reference types="openfin-adapter/fin" />
-import { Identity } from 'openfin-adapter';
+/// <reference types="@openfin/core" />
+import type { Page } from '../../../common/src/api/pages/shapes';
 import type { CustomThemeOptions } from '../../../common/src/api/theming';
 import type { BrowserInitConfig, BrowserSnapshot } from '..';
 export declare function overrideViewOptions(options: Partial<OpenFin.ViewOptions>, initOptions: OpenFin.ViewOptions): any;
 export declare function preserveInteropIfManifestConflict(opts: Partial<OpenFin.ViewOptions>, fetchManifest: ({ manifestUrl: string }: {
     manifestUrl: any;
-}, callerIdentity: Identity) => any, callerIdentity: Identity): Promise<any>;
+}, callerIdentity: OpenFin.Identity) => any, callerIdentity: OpenFin.Identity): Promise<any>;
 export declare const filterSnapshotWindows: (win: OpenFin.WindowOptions) => boolean;
 /**
  * fitToMonitor()
@@ -24,11 +24,11 @@ export declare const filterSnapshotWindows: (win: OpenFin.WindowOptions) => bool
  */
 export declare const fitToMonitor: (options: any) => Promise<any>;
 declare type LegacyWindowOptions = Omit<OpenFin.PlatformWindowCreationOptions, 'workspacePlatform'> & {
-    pages?: OpenFin.Page[];
-    workstacks?: OpenFin.Page[];
+    pages?: Page[];
+    workstacks?: Page[];
 };
 export declare const initWorkspacePlatformOptions: (options: LegacyWindowOptions | OpenFin.PlatformWindowCreationOptions) => OpenFin.PlatformWindowCreationOptions;
-export declare const applyPageDefaults: (pages: OpenFin.Page[], defaultPageOptions?: BrowserInitConfig['defaultPageOptions']) => Promise<{
+export declare const applyPageDefaults: (pages: Page[], defaultPageOptions?: BrowserInitConfig['defaultPageOptions']) => Promise<{
     title: string;
     layout: any;
     pageId: string;
@@ -37,6 +37,7 @@ export declare const applyPageDefaults: (pages: OpenFin.Page[], defaultPageOptio
     isReadOnly?: boolean;
     unsavedIconUrl?: string;
     iconUrl?: string;
+    isLocked?: boolean;
     closeButton?: {
         hidden?: boolean;
         disabled?: boolean;

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

@@ -1,7 +1,6 @@
-/// <reference types="openfin-adapter/fin" />
-import type { InteropBroker } from 'openfin-adapter/src/api/interop';
-import { NamedIdentity } from 'openfin-adapter/src/identity';
+/// <reference types="@openfin/core" />
 import { IconProps } from '@openfin/ui-library';
+import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../common/src/api/pages/shapes';
 import type { CustomThemes } from '../../common/src/api/theming';
 import type { App } from '../../client-api/src/shapes';
@@ -9,6 +8,7 @@ export { AppManifestType } from '../../client-api/src/shapes';
 export type { App, AppIntent, Image } from '../../client-api/src/shapes';
 export type { AttachedPage, Page, PageLayout, PageLayoutDetails, PageWithUpdatableRuntimeAttribs } from '../../common/src/api/pages/shapes';
 export type { CustomThemes } from '../../common/src/api/theming';
+export type { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 /**
  * Request for creating a saved page in persistent storage.
  */
@@ -120,7 +120,7 @@ export declare type OpenGlobalContextMenuPayload = OpenGlobalContextMenuRequest
     /** Template defining the options to show in the context menu. */
     template: GlobalContextMenuItemTemplate[];
     /** Identity of the Browser window where context menu should be shown. */
-    identity: NamedIdentity;
+    identity: OpenFin.Identity;
     /** Default function that handles stock context menu options. */
     callback: (data: GlobalContextMenuItemData, payload: OpenGlobalContextMenuPayload) => any;
 };
@@ -174,7 +174,7 @@ export interface ViewTabCustomActionPayload {
     /** Any data necessary for the functioning of specified custom action*/
     customData: any;
     /** Identity of the Browser window where context menu should be shown. */
-    windowIdentity: NamedIdentity;
+    windowIdentity: OpenFin.Identity;
     selectedViews: OpenFin.Identity[];
 }
 /**
@@ -182,7 +182,7 @@ export interface ViewTabCustomActionPayload {
  */
 export declare type OpenViewTabContextMenuPayload = OpenViewTabContextMenuRequest & {
     /** Identity of the Browser window where context menu should be shown. */
-    identity: NamedIdentity;
+    identity: OpenFin.Identity;
     /** Default function that handles stock context menu options. */
     callback: (data: ViewTabMenuData, req: OpenViewTabContextMenuPayload) => any;
 };
@@ -191,7 +191,7 @@ export declare type OpenViewTabContextMenuPayload = OpenViewTabContextMenuReques
  */
 export declare type OpenPageTabContextMenuPayload = OpenPageTabContextMenuRequest & {
     /** Identity of the Browser window where context menu should be shown. */
-    identity: NamedIdentity;
+    identity: OpenFin.Identity;
     /** Template defining the options to show in the context menu. */
     template: PageTabContextMenuItemTemplate[];
     /** Default function that handles stock context menu options. */
@@ -236,20 +236,23 @@ export interface CustomButtonActionPayload {
     /** Screen y-coordinate where custom button should be shown. */
     y: number;
 }
+/**
+ * The shape of the payload sent by a custom dropdown menu item to a custom action handler
+ */
+export interface CustomDropdownItemActionPayload {
+    /** Calling the CustomButton type */
+    callerType: CustomActionCallerType.CustomDropdownItem;
+    /** Identity for the current window. */
+    windowIdentity: OpenFin.Identity;
+    /** Any data necessary for the functioning of specified custom action*/
+    customData: any;
+}
 /**
  * Custom browser buttons
  */
-export interface CustomBrowserButtonConfig {
+export interface CustomBrowserButtonConfig extends CustomButtonConfig {
     /** Type of cutom browser button */
     type: BrowserButtonType.Custom;
-    /** Button name text when hovered over */
-    tooltip: string;
-    /** Disable custom button true or false */
-    disabled?: boolean;
-    /** icon URL for icon image */
-    iconUrl: string;
-    /** Custom action once the button is clicked */
-    action: CustomActionSpecifier;
 }
 /**
  * Default Browser Button types
@@ -325,7 +328,7 @@ export interface OpenSaveButtonContextMenuRequest {
  */
 export declare type OpenSaveButtonContextMenuPayload = OpenSaveButtonContextMenuRequest & {
     /** Identity of the Browser window where context menu should be shown. */
-    identity: NamedIdentity;
+    identity: OpenFin.Identity;
     /** Template defining the options to show in the context menu. */
     template: SaveButtonContextMenuItemTemplate[];
     /** Default function that handles stock context menu options. */
@@ -1158,6 +1161,7 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
  */
 export declare enum CustomActionCallerType {
     CustomButton = "CustomButton",
+    CustomDropdownItem = "CustomDropdownItem",
     GlobalContextMenu = "GlobalContextMenu",
     ViewTabContextMenu = "ViewTabContextMenu",
     PageTabContextMenu = "PageTabContextMenu",
@@ -1169,16 +1173,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 | GlobalContextMenuOptionActionPayload | ViewTabCustomActionPayload | PageTabContextMenuOptionActionPayload | OpenSaveContextMenuOptionActionPayload;
-/**
- * Configures a custom action when the control is invoked
- */
-export interface CustomActionSpecifier {
-    /** Identifier of a custom action defined at platform initialization*/
-    id: string;
-    /** Any data necessary for the functioning of specified custom action*/
-    customData?: any;
-}
+} | CustomButtonActionPayload | CustomDropdownItemActionPayload | GlobalContextMenuOptionActionPayload | ViewTabCustomActionPayload | PageTabContextMenuOptionActionPayload | OpenSaveContextMenuOptionActionPayload;
 /**
  * Defines custom action map where the key is the custom action ID and value is the action handler
  */
@@ -1246,7 +1241,7 @@ export interface WorkspacePlatformInitConfig {
      * Override workspace platform interop behavior
      * https://cdn.openfin.co/docs/javascript/stable/InteropBroker.html
      */
-    interopOverride?: OpenFin.OverrideCallback<InteropBroker, InteropBroker>;
+    interopOverride?: OpenFin.OverrideCallback<OpenFin.InteropBroker, OpenFin.InteropBroker>;
 }
 /**
  * Extend or replace default functionality in order to customize behavior of a Workspace Platform Provider.
@@ -1388,9 +1383,9 @@ export interface BrowserInitConfig {
     /**
      * @deprecated
      * Override workspace platform interop behavior
-     * https://cdn.openfin.co/docs/javascript/stable/InteropBroker.html
+     * https://cdn.openfin.co/docs/javascript/stable/OpenFin.InteropBroker.html
      */
-    interopOverride?: OpenFin.OverrideCallback<InteropBroker, InteropBroker>;
+    interopOverride?: OpenFin.OverrideCallback<OpenFin.InteropBroker, OpenFin.InteropBroker>;
 }
 interface WorkspaceMetadata {
     APIVersion: string;

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

@@ -0,0 +1,48 @@
+/**
+ * Configures a custom action when the control is invoked
+ */
+export interface CustomActionSpecifier {
+    /** Identifier of a custom action defined at platform initialization*/
+    id: string;
+    /** Any data necessary for the functioning of specified custom action*/
+    customData?: any;
+}
+/**
+ * Base configuration for a custom button
+ */
+export interface BaseCustomButtonConfig {
+    /** Button name text when hovered over */
+    tooltip: string;
+    /** Disable custom button true or false */
+    disabled?: boolean;
+    /** icon URL for icon image */
+    iconUrl?: string;
+}
+export interface BaseCustomDropdownItem extends BaseCustomButtonConfig {
+    /** Is this dropdown item checked? Any value other than undefined will decorate the dropdown option as a checkbox option. */
+    checked?: boolean;
+    /** icon URL for icon image */
+    action?: any;
+}
+export declare type BaseCustomDropdownItems = BaseCustomDropdownItem[] | (() => Promise<BaseCustomDropdownItem[]>);
+/**
+ * Base Configuration for a custom dropdown
+ */
+export interface BaseCustomDropdownConfig extends BaseCustomButtonConfig {
+    /** Dropdown options */
+    options: BaseCustomDropdownItems;
+}
+/**
+ * Configuration for a buttons with a custom action
+ */
+export interface CustomButtonConfig extends BaseCustomButtonConfig {
+    /** Custom action once the button is clicked */
+    action: CustomActionSpecifier;
+}
+/**
+ * Configuration for a button that presents a dropdown menu with options that dispatch custom actions when clicked.
+ */
+export interface CustomDropdownConfig extends BaseCustomDropdownConfig {
+    /** Options that will be displayed in the dropdown */
+    options: CustomButtonConfig[];
+}

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

@@ -0,0 +1,20 @@
+interface StyleOverrides {
+    iconUrl: string;
+}
+interface HotkeyOverrides {
+    toggleHomeVisibility: string;
+}
+export interface Overrides {
+    disableBrowserNewPageButton: boolean;
+    enableWorkspaceDock: boolean;
+    hotkeys: HotkeyOverrides;
+    style: StyleOverrides;
+    browserWindowTitle: string;
+    flags: {
+        [key: string]: boolean;
+    };
+    disableRuntimeValidation: boolean;
+}
+declare const overrides: Overrides;
+export default overrides;
+export declare const useOverrides: () => Overrides;

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

@@ -1,22 +1,5 @@
-/// <reference types="openfin-adapter/fin" />
+/// <reference types="@openfin/core" />
 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"

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

@@ -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) => PageWithUpdatableRuntimeAttribs;
+export declare const clonePage: (page: Page) => Promise<PageWithUpdatableRuntimeAttribs>;

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

@@ -1,4 +1,4 @@
-/// <reference types="openfin-adapter/fin" />
+/// <reference types="@openfin/core" />
 import type { LayoutExtended } from '../../utils/layout';
 export interface PageLayoutDetails {
     /** The id of the machine that created the page. */

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

@@ -0,0 +1,67 @@
+/// <reference types="@openfin/core" />
+export declare const getWindowChannelId: (identity: OpenFin.Identity) => string;
+export declare const getChannelClient: (identity: OpenFin.Identity) => Promise<import("@openfin/core/src/api/interappbus/channel/client").default>;
+/**
+ * If the browser window is reloaded too quickly, runtime will
+ * respond that the channel provider has already been created.
+ * Hence, we retry a couple of times to make sure this does not occur.
+ * (Should only happen in local development)
+ */
+export declare const createChannel: () => Promise<import("@openfin/core/src/api/interappbus/channel/provider").ChannelProvider>;
+export interface AddToChannelRequest {
+    newChannelId: string;
+    selectedViews: OpenFin.Identity[];
+}
+/**
+ * These actions are used to handle functionality activated by user in the UI (e.g. context menu)
+ * and hence show dialogs, indicators etc.
+ * Not to be confused with attached pages actions, which are for API use.
+ */
+declare enum GeneralBrowserChannelActions {
+    CloseBrowserWindow = "close-browser-window",
+    QuitPlatform = "quit-platform",
+    ClosePage = "close-page",
+    AddToChannel = "add-to-channel",
+    RemoveFromChannel = "remove-from-channel",
+    OpenSaveModalInternal = "open-save-modal-internal",
+    DuplicatePage = "duplicate-page"
+}
+/**
+ * All of the remote procedures that can be called in the
+ * platform window's address space regarding attached pages.
+ */
+export declare enum PageChannelAction {
+    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 const BrowserChannelAction: {
+    GetPages: PageChannelAction.GetPages;
+    GetActivePageForWindow: PageChannelAction.GetActivePageForWindow;
+    AttachPagesToWindow: PageChannelAction.AttachPagesToWindow;
+    DetachPagesFromWindow: PageChannelAction.DetachPagesFromWindow;
+    SetActivePageForWindow: PageChannelAction.SetActivePageForWindow;
+    RenamePage: PageChannelAction.RenamePage;
+    ReorderPagesForWindow: PageChannelAction.ReorderPagesForWindow;
+    UpdatePageForWindow: PageChannelAction.UpdatePageForWindow;
+    UpdatePagesWindowOptions: PageChannelAction.UpdatePagesWindowOptions;
+    IsDetachingPages: PageChannelAction.IsDetachingPages;
+    IsActivePageChanging: PageChannelAction.IsActivePageChanging;
+    CloseBrowserWindow: GeneralBrowserChannelActions.CloseBrowserWindow;
+    QuitPlatform: GeneralBrowserChannelActions.QuitPlatform;
+    ClosePage: GeneralBrowserChannelActions.ClosePage;
+    AddToChannel: GeneralBrowserChannelActions.AddToChannel;
+    RemoveFromChannel: GeneralBrowserChannelActions.RemoveFromChannel;
+    OpenSaveModalInternal: GeneralBrowserChannelActions.OpenSaveModalInternal;
+    DuplicatePage: GeneralBrowserChannelActions.DuplicatePage;
+};
+export declare type BrowserChannelAction = typeof BrowserChannelAction;
+export {};