@openfin/workspace-platform 8.1.6 → 8.2.0

package/{client-api-platform/src/api/protocol.d.ts → common/src/api/protocol/workspace-platform.d.ts}

@@ -1,4 +1,3 @@
-/// <reference types="openfin-adapter/fin" />
 /**
  * All of the remote procedures that can be called in the
  * a Workspace Platform's address space.
@@ -8,7 +7,7 @@
  * 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 {
+export declare enum WorkspacePlatformChannelAction {
     LaunchApp = "launchApp",
     SavePage = "savePage",
     GetSavedPage = "getSavedPage",
@@ -49,6 +48,7 @@ export declare enum ChannelAction {
     SetActiveWorkspace = "setActiveWorkspace",
     IsBrowserInitialized = "isBrowserInitialized"
 }
+export declare const internalGetWorkspacePlatformChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<any>;
 /**
  * Get a channel client for a specific Workspace platform.
  *
@@ -59,7 +59,7 @@ export declare enum ChannelAction {
  *
  * @returns the channel client for the Workspace platform.
  */
-export declare const getChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<import("openfin-adapter").ChannelClient>;
+export declare const getWorkspacePlatformChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<import("@openfin/core/src/api/interappbus/channel/client").default>;
 /**
  * Get a channel client for a specific Workspace platform.
  *
@@ -67,4 +67,4 @@ export declare const getChannelClient: (identity: OpenFin.ApplicationIdentity) =
  *
  * @returns the channel client for the Workspace platform.
  */
-export declare const getBrowserChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<import("openfin-adapter").ChannelClient>;
+export declare const getBrowserChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<import("@openfin/core/src/api/interappbus/channel/client").default>;

package/common/src/api/{protocol.d.ts → protocol/workspace.d.ts}

@@ -1,4 +1,4 @@
-/// <reference types="openfin-adapter/fin" />
+/// <reference types="@openfin/core" />
 /** The name of the channel for the centralized workspace protocol. */
 export declare const channelName = "__of_workspace_protocol__";
 /**
@@ -10,18 +10,18 @@ export declare const channelName = "__of_workspace_protocol__";
  * All of the registered channel action handlers can be found here:
  * @see link: [Provider Protocol Handlers](https://github.com/openfin/workspace/provider/src/api/protocol.ts)
  */
-export declare enum ChannelAction {
-    RegisterStorefrontProvider = "register-storefront-provider",
-    DeregisterStorefrontProvider = "deregister-storefront-provider",
-    GetStorefrontProviders = "get-storefront-providers",
-    HideStorefront = "hide-storefront",
+export declare enum WorkspaceChannelAction {
+    RegisterProvider = "register-provider",
+    DeregisterProvider = "deregister-provider",
+    CreateProviderWindow = "create-provider-window",
+    GetProviders = "get-providers",
+    ShowProviderWindow = "show-provider-window",
+    HideProviderWindow = "hide-provider-window",
     GetStorefrontProviderApps = "get-storefront-provider-apps",
     GetStorefrontProviderLandingPage = "get-storefront-provider-landing-page",
     GetStorefrontProviderFooter = "get-storefront-provider-footer",
     GetStorefrontProviderNavigation = "get-storefront-provider-navigation",
     LaunchStorefrontProviderApp = "launch-storefront-provider-app",
-    ShowStorefront = "show-storefront",
-    CreateStorefrontWindow = "create-storefront-window",
     ShowHome = "show-home",
     HideHome = "hide-home",
     AssignHomeSearchContext = "assign-home-search-context",
@@ -30,7 +30,7 @@ export declare enum ChannelAction {
     GetComputedPlatformTheme = "get-computed-platform-theme"
 }
 export interface ChannelClient extends OpenFin.ChannelClient {
-    dispatch: (action: ChannelAction, payload: any) => Promise<any>;
+    dispatch: (action: WorkspaceChannelAction, payload: any) => Promise<any>;
 }
 /**
  * Get a channel client for the centralized Workspace protocol.
@@ -41,7 +41,7 @@ export interface ChannelClient extends OpenFin.ChannelClient {
  * The channel client can execute remote procedures on the provider via its `dispatch` function.
  * A call to the `dispatch` function will block until the channel action has concluded execution
  * in the Workspace Provider's address space.
- * For a list of supported procedures, see the `ChannelAction` enum.
+ * For a list of supported procedures, see the `WorkspaceChannelAction` enum.
  *
  * @returns the channel client for the centralized workspace protocol.
  */

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

@@ -1,4 +1,4 @@
-/// <reference types="openfin-adapter/fin" />
+/// <reference types="@openfin/core" />
 import type { ThemePaletteSet } from '@openfin/ui-library';
 export interface ComputedThemes extends Array<ComputedTheme> {
 }

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

@@ -1,4 +1,4 @@
-/// <reference types="openfin-adapter/fin" />
+/// <reference types="@openfin/core" />
 export interface Workspace {
     workspaceId: string;
     title: string;

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

@@ -1,4 +1,4 @@
-/// <reference types="openfin-adapter/fin" />
+/// <reference types="@openfin/core" />
 export declare enum ApplicationUUID {
     /**
      * The UUID of workspace.
@@ -26,13 +26,5 @@ export declare type ApplicationInfoExtended = OpenFin.ApplicationInfo & {
         userAppConfigArgs: any;
     };
 };
-export declare const currentOFAppIdentity: {
-    uuid: string;
-    name: string;
-};
-export declare const workspaceOFAppIdentity: {
-    name: ApplicationUUID;
-    uuid: ApplicationUUID;
-};
-export declare const getCurrentOFApplication: () => import("openfin-adapter").Application;
-export declare const getWorkspaceOFApplication: () => import("openfin-adapter").Application;
+export declare const getCurrentOFApplication: () => import("@openfin/core/src/api/application").Application;
+export declare const getWorkspaceOFApplication: () => import("@openfin/core/src/api/application").Application;

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

@@ -5,4 +5,4 @@
  * @param channelName the name of the channel to connect to.
  * @returns the function to connect to the channel.
  */
-export default function makeGetChannelClient(channelName: string): () => Promise<import("openfin-adapter").ChannelClient>;
+export default function makeGetChannelClient(channelName: string): () => Promise<import("@openfin/core/src/api/interappbus/channel/client").default>;

package/common/src/utils/context-menu.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="openfin-adapter/fin" />
-import { _Window } from 'openfin-adapter/src/api/window';
+/// <reference types="@openfin/core" />
 export declare enum MenuItemType {
     Label = "normal",
     Separator = "separator",
@@ -9,7 +8,7 @@ export declare enum MenuItemType {
 export declare type ShowContextMenuResponse = OpenFin.MenuResult & {
     data: string;
 };
-export default function showContextMenu(opts: OpenFin.ShowPopupMenuOptions, win?: _Window): Promise<ShowContextMenuResponse>;
+export default function showContextMenu(opts: OpenFin.ShowPopupMenuOptions, win?: OpenFin.Window): Promise<ShowContextMenuResponse>;
 export declare const Separator: OpenFin.MenuItemTemplate;
 export declare const DefaultSaveMenuBounds: {
     width: number;

package/common/src/utils/defer-show.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="openfin-adapter/fin" />
+/// <reference types="@openfin/core" />
 interface InternalWindowOptions extends OpenFin.PlatformWindowCreationOptions {
     workspacePlatform: OpenFin.WindowOptions['workspacePlatform'] & {
         _internalAutoShow: boolean;
@@ -28,7 +28,7 @@ export declare const applyDeferShowOptions: (opts: OpenFin.PlatformWindowCreatio
  * @param superCreateWindow the create window method to decorate.
  * @returns the `createWindow` method wrapped with this middleware.
  */
-export declare const withDeferShow: (superCreateWindow: (opts: OpenFin.PlatformWindowCreationOptions, callerIdentity: OpenFin.Identity) => Promise<OpenFin.Window>) => (opts: OpenFin.PlatformWindowCreationOptions, callerIdentity?: OpenFin.Identity) => Promise<import("openfin-adapter").Window>;
+export declare const withDeferShow: (superCreateWindow: (opts: OpenFin.PlatformWindowCreationOptions, callerIdentity: OpenFin.Identity) => Promise<OpenFin.Window>) => (opts: OpenFin.PlatformWindowCreationOptions, callerIdentity?: OpenFin.Identity) => Promise<import("@openfin/core/src/api/window")._Window>;
 /**
  * Assert if the window is able to be shown or not.
  * Upon calling `setCanShow(true)`, if the window was previously prevented

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

@@ -11,7 +11,7 @@ export declare const isDocumentDefined: boolean;
 export declare const isWindowDefinedWithIndexDB: boolean;
 export declare const finUUID: string;
 export declare const finName: string;
-export declare const finEntityType: "" | import("openfin-adapter/src/shapes/EntityType").EntityType;
+export declare const finEntityType: "" | "window" | "view" | "iframe" | "external connection" | "unknown";
 export declare const isEnvLocal: boolean;
 export declare const isEnvDev: boolean;
 export declare const isEnvStaging: boolean;

package/common/src/utils/global-context-menu.d.ts

@@ -1,4 +1,3 @@
-import { NamedIdentity } from 'openfin-adapter/src/identity';
 import { MenuItemType } from '../../../common/src/utils/context-menu';
 import * as WP from '../../../client-api-platform/src/index';
 import { GlobalContextMenuItemTemplate, GlobalContextMenuOptionType, Workspace } from '../../../client-api-platform/src/shapes';
@@ -40,4 +39,4 @@ export declare const getSavedWorkspaceContextMenuOptions: (activeWorkspace: Work
         workspaceId: string;
     };
 }[];
-export declare const getGlobalContextMenuTemplate: (winIdentity: NamedIdentity) => Promise<GlobalContextMenuItemTemplate[]>;
+export declare const getGlobalContextMenuTemplate: (winIdentity: OpenFin.Identity) => Promise<GlobalContextMenuItemTemplate[]>;

package/common/src/utils/indicators/helper.d.ts

@@ -1,2 +1,2 @@
-/// <reference types="openfin-adapter/fin" />
+/// <reference types="@openfin/core" />
 export default function makeShowIndicator(opts?: OpenFin.PlatformWindowCreationOptions): (namespace: string, url: string, message: string, type: string) => Promise<void>;

package/common/src/utils/landing-page.d.ts

@@ -1,10 +1,9 @@
-import { NamedIdentity } from 'openfin-adapter/src/identity';
 interface LandingPageUrls {
     newPageUrl: string | false;
     newTabUrl: string | false;
 }
-export declare const getLandingPageUrls: (winIdentity?: NamedIdentity) => Promise<LandingPageUrls>;
+export declare const getLandingPageUrls: (winIdentity?: OpenFin.Identity) => Promise<LandingPageUrls>;
 export declare const checkHasNewTabUrl: () => Promise<boolean>;
 export declare const getNewLandingTabViewOptions: (target: OpenFin.Identity) => Promise<OpenFin.PlatformViewCreationOptions>;
-export declare const makeNewLandingPage: (winIdentity?: NamedIdentity) => Promise<import("client-api-platform").PageWithUpdatableRuntimeAttribs>;
+export declare const makeNewLandingPage: (winIdentity?: OpenFin.Identity) => Promise<import("client-api-platform").PageWithUpdatableRuntimeAttribs>;
 export {};

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

@@ -1,5 +1,4 @@
-/// <reference types="openfin-adapter/fin" />
-import { NamedIdentity } from 'openfin-adapter/src/identity';
+/// <reference types="@openfin/core" />
 import { AttachedPage, PageLayout } from '../../../client-api-platform/src/shapes';
 export declare type LayoutComponentStateExtended = OpenFin.LayoutComponent['componentState'] & {
     name: string;
@@ -48,7 +47,7 @@ export declare const cloneLayoutAndFillInViewNames: (layout: any) => any;
  */
 export declare const cloneLayoutAndRemoveNames: (layout: any) => any;
 export declare const mapContentComponentState: (content: OpenFin.LayoutContent | LayoutContentExtended) => LayoutComponentStateExtended[];
-export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: NamedIdentity) => Promise<any>;
+export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<any>;
 export declare const isLayoutTabActive: (tabSelector: string) => boolean;
 export declare const containerId = "layout_container";
 export declare const getViewComponents: () => LayoutContentExtended;

package/common/src/utils/local-storage-key.d.ts

@@ -3,6 +3,7 @@ declare enum LocalStorageKey {
     LastFocusedBrowserWindow = "lastFocusedBrowserWindow",
     MachineName = "machineName",
     NewTabPageLayout = "NewTabPageLayout",
-    NewTabPageSort = "NewTabPageSort"
+    NewTabPageSort = "NewTabPageSort",
+    DockPosition = "DockPosition"
 }
 export default LocalStorageKey;

package/common/src/utils/menu-config.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="openfin-adapter/fin" />
+/// <reference types="@openfin/core" />
 import type { OptionalExceptFor } from '../../../common/src/utils/types';
 export interface ModalResponseContent {
     title: string;

package/common/src/utils/menu-window-provider.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="openfin-adapter/fin" />
-import { NamedIdentity } from 'openfin-adapter/src/identity';
+/// <reference types="@openfin/core" />
 import { ModalResponseContent, ResponseModalConfig } from '../../../common/src/utils/menu-config';
 import { Listener } from '../../../common/src/utils/shared-emitter';
 import type { OptionalExceptFor } from '../../../common/src/utils/types';
@@ -36,9 +35,9 @@ export declare function createMenuPosition(windowOptions: OptionalExceptFor<Open
     top: number;
     left: number;
 }>;
-export declare function showChildWindow({ options, parameters }: ShowChildOptions): Promise<import("openfin-adapter").Window>;
-export declare const getResponseModalBounds: (modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: NamedIdentity) => Promise<import("@common/utils/window").Point>;
-export declare const waitForModalResponse: ({ options, content }: ResponseModalOptions) => Promise<{
+export declare function showChildWindow({ options, parameters }: ShowChildOptions, shouldCenterOnMonitor?: boolean): Promise<import("@openfin/core/src/api/window")._Window>;
+export declare const getResponseModalBounds: (modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, shouldCenterOnMonitor?: boolean) => Promise<import("@common/utils/window").Point>;
+export declare const waitForModalResponse: ({ options, content }: ResponseModalOptions, shouldCenterOnMonitor?: boolean) => Promise<{
     data: ModalResponse;
 }>;
 export {};

package/common/src/utils/page-tab-context-menu.d.ts

@@ -1,3 +1,2 @@
-import { NamedIdentity } from 'openfin-adapter/src/identity';
 import { PageTabContextMenuItemTemplate } from '../../../client-api-platform/src/shapes';
-export declare const getPageTabMenuTemplate: (pageId: string, winIdentity: NamedIdentity) => Promise<PageTabContextMenuItemTemplate[]>;
+export declare const getPageTabMenuTemplate: (pageId: string, winIdentity: OpenFin.Identity) => Promise<PageTabContextMenuItemTemplate[]>;

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

@@ -7,7 +7,7 @@ export declare enum PageRoute {
     Home = "/home/",
     HomeSearch = "/home/?deeplink=search",
     HomePagesRename = "/home/pages/rename/",
-    Dock = "/home/dock/",
+    Dock = "/dock/",
     BrowserPagesLanding = "/browser/pages/landing/",
     HomeIndicator = "/home/indicator/",
     Browser = "/browser/",

package/common/src/utils/router/base.d.ts

@@ -9,7 +9,8 @@ export declare enum Zone {
     Home = "/home",
     Browser = "/browser",
     Provider = "/provider",
-    Storefront = "/storefront"
+    Storefront = "/storefront",
+    Dock = "/dock"
 }
 export declare function getRouterZone(): "" | Zone;
 /**

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

@@ -1,4 +1,4 @@
-/// <reference types="openfin-adapter/fin" />
+/// <reference types="@openfin/core" />
 export declare type SnapshotDetailsExtended = OpenFin.Snapshot['snapshotDetails'] & {
     machineId: string;
     machineName?: string;

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

@@ -1,11 +1,13 @@
 export interface RegisterUsageStatus {
     apiVersion?: string;
+    componentVersion?: string;
     allowed: boolean;
     rejectionCode?: string;
 }
 export declare const registerBrowserUsage: (status: RegisterUsageStatus) => Promise<void>;
 export declare const registerHomeUsage: (status: RegisterUsageStatus) => Promise<void>;
 export declare const registerStorefrontUsage: (status: RegisterUsageStatus) => Promise<void>;
+export declare const registerDockUsage: (status: RegisterUsageStatus) => Promise<void>;
 export declare const registerNotificationUsage: (status: RegisterUsageStatus) => Promise<void>;
 export declare const registerPlatformUsage: (status: RegisterUsageStatus) => Promise<void>;
 export declare const registerThemingUsage: (status: RegisterUsageStatus) => Promise<void>;

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

@@ -1,8 +1,5 @@
-/// <reference types="openfin-adapter/fin" />
-import type { Fin } from 'openfin-adapter';
-import type { _Window } from 'openfin-adapter/src/api/window';
+/// <reference types="@openfin/core" />
 import { ApplicationUUID } from './application';
-export declare type WindowFin = Fin<'window'>;
 export declare enum WindowName {
     Home = "openfin-home",
     Dock = "openfin-dock",
@@ -18,6 +15,7 @@ export declare enum WindowEvent {
     LayoutReady = "layout-ready",
     EndUserBoundsChanging = "end-user-bounds-changing",
     Blurred = "blurred",
+    Closed = "closed",
     CloseRequested = "close-requested",
     Focused = "focused",
     ShowRequested = "show-requested",
@@ -65,7 +63,7 @@ export declare const getBoundsFromCenter: (center: Point, size: Size) => Point;
  * @param identity the window identity.
  * @returns the wrapped OpenFin window identity.
  */
-export declare function getOFWindow(identity: WindowIdentity): _Window;
+export declare function getOFWindow(identity: WindowIdentity): import("@openfin/core/src/api/window")._Window;
 /**
  * The OpenFin identity for the current window.
  */
@@ -73,19 +71,20 @@ export declare const currentOFIdentity: WindowIdentity;
 /**
  * Get the current OpenFin window.
  */
-export declare function getCurrentOFWindow(): _Window;
+export declare function getCurrentOFWindow(): import("@openfin/core/src/api/window")._Window;
 /**
  * The OpenFin identity for Home.
  */
 export declare const homeOFIdentity: WindowIdentity;
 export declare const dockOFIdentity: WindowIdentity;
+export declare const notificationCenterOFIdentity: WindowIdentity;
 export declare const StorefrontOFIdentity: WindowIdentity;
 export declare const providerOFIdentity: WindowIdentity;
 /**
  * Get the Home OpenFin window.
  */
-export declare function getHomeOFWindow(): _Window;
-export declare function getDockOFWindow(): _Window;
+export declare function getHomeOFWindow(): import("@openfin/core/src/api/window")._Window;
+export declare function getDockOFWindow(): import("@openfin/core/src/api/window")._Window;
 /**
  * Helper for max and restoring a window.
  * @param identity the identity of the window to maximize or restore.
@@ -110,13 +109,13 @@ export declare function hideAndBlur(identity: WindowIdentity): Promise<void>;
  */
 export declare function toggleVisibility(identity: WindowIdentity): Promise<void>;
 export declare const toggleDock: () => Promise<void>;
-export declare const showAndFocusDock: () => Promise<void>;
 export declare function isAnimatingSize(): boolean;
 /**
  * Resizes a window to width and height saved in the store
  * if they differ from current window size.
  */
 export declare function restoreWindowSize(): Promise<void>;
+export declare function setSize(width: number, height: number): Promise<void>;
 export declare function animateSize(width: number, height: number): Promise<void>;
 /**
  * Returns true if the window name is that of a browser window.
@@ -131,7 +130,7 @@ export declare function forceBodySize(): void;
 /**
  * Gets all currently open browser windows.
  */
-export declare function getBrowserWindows(): Promise<_Window[]>;
+export declare function getBrowserWindows(): Promise<OpenFin.Window[]>;
 /**
  * Closes all currently open Browser windows.
  */
@@ -145,10 +144,18 @@ export declare const isWindowRunning: (identity: WindowIdentity) => Promise<bool
  * @returns true if the Storefront window is running.
  */
 export declare const isStorefrontWindowRunning: () => Promise<boolean>;
+export declare const isDockWindowRunning: () => Promise<boolean>;
+export declare const isNotificationCenterRunning: () => Promise<boolean>;
 export declare const isHomeWindowRunning: () => Promise<boolean>;
 export declare const showAndFocusStorefront: () => Promise<void>;
+export declare const showAndFocusDock: () => Promise<void>;
 export declare const centerWindowIfOffScreen: (windowIdentity?: WindowIdentity) => Promise<void>;
 export declare const getDisableMultiplePagesOption: (identity: WindowIdentity) => Promise<any>;
 export declare const getIsLockedOption: (identity: WindowIdentity) => Promise<any>;
 export declare const getPlatformWindowTitle: (identity: WindowIdentity) => Promise<any>;
+export declare const getComponentWindowStatus: () => Promise<{
+    storefrontRunning: boolean;
+    homeRunning: boolean;
+    notificationCenterRunning: boolean;
+}>;
 export {};

package/common/src/utils/workspace-modals.d.ts

@@ -8,6 +8,6 @@ export declare const showDeleteWorkspaceModal: (windowIdentity: OpenFin.Identity
  * @param workspaceTitle The platform label
  * @returns Boolean - Affirmative or Negative response from user
  */
-export declare const showPlatformQuitModal: (windowIdentity: OpenFin.Identity, workspaceTitle: string) => Promise<boolean>;
+export declare const showPlatformQuitModal: (windowIdentity: OpenFin.Identity, workspaceTitle: string, shouldCenterOnMonitor?: boolean) => Promise<boolean>;
 export declare const showRestoreChangesModal: (windowIdentity: any) => Promise<boolean>;
 export declare const getOverwriteWorkspaceMenu: (workspaceTitle: string) => Promise<ResponseModalConfig>;