@openfin/workspace 8.1.7 → 8.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/client-api/src/dock.d.ts +19 -0
  2. package/client-api/src/dock.test.d.ts +1 -0
  3. package/client-api/src/home.d.ts +2 -1
  4. package/client-api/src/index.d.ts +6 -0
  5. package/client-api/src/shapes/common.d.ts +8 -0
  6. package/client-api/src/shapes/dock.d.ts +63 -0
  7. package/client-api/src/shapes/index.d.ts +2 -0
  8. package/client-api/src/shapes/provider.d.ts +18 -0
  9. package/client-api/src/shapes/store.d.ts +2 -15
  10. package/client-api/src/store.d.ts +1 -1
  11. package/client-api-platform/src/api/app-directory.d.ts +2 -1
  12. package/client-api-platform/src/api/browser/browser-module.d.ts +1 -1
  13. package/client-api-platform/src/api/browser/index.d.ts +1 -1
  14. package/client-api-platform/src/api/context-menu/index.d.ts +5 -5
  15. package/client-api-platform/src/api/context-menu/utils.d.ts +7 -7
  16. package/client-api-platform/src/api/pages/helper.d.ts +1 -1
  17. package/client-api-platform/src/api/pages/index.d.ts +1 -1
  18. package/client-api-platform/src/api/storage.d.ts +1 -1
  19. package/client-api-platform/src/init/browser-window-focus.d.ts +2 -2
  20. package/client-api-platform/src/init/override-callback.d.ts +1 -1
  21. package/client-api-platform/src/init/utils.d.ts +7 -6
  22. package/client-api-platform/src/shapes.d.ts +26 -31
  23. package/common/src/api/action.d.ts +48 -0
  24. package/common/src/api/overrides.d.ts +20 -0
  25. package/common/src/api/pages/attached.d.ts +1 -18
  26. package/common/src/api/pages/shapes.d.ts +1 -1
  27. package/common/src/api/protocol/browser.d.ts +67 -0
  28. package/{client-api-platform/src/api/protocol.d.ts → common/src/api/protocol/workspace-platform.d.ts} +4 -3
  29. package/common/src/api/{protocol.d.ts → protocol/workspace.d.ts} +10 -10
  30. package/common/src/api/provider.d.ts +48 -0
  31. package/common/src/api/storefront.d.ts +1 -15
  32. package/common/src/api/workspaces/index.d.ts +1 -1
  33. package/common/src/utils/application.d.ts +3 -11
  34. package/common/src/utils/channels.d.ts +1 -1
  35. package/common/src/utils/context-menu.d.ts +2 -3
  36. package/common/src/utils/defer-show.d.ts +9 -5
  37. package/common/src/utils/env.d.ts +1 -1
  38. package/common/src/utils/global-context-menu.d.ts +2 -2
  39. package/common/src/utils/indicators/helper.d.ts +1 -1
  40. package/common/src/utils/landing-page.d.ts +3 -4
  41. package/common/src/utils/layout.d.ts +2 -3
  42. package/common/src/utils/local-storage-key.d.ts +2 -1
  43. package/common/src/utils/menu-config.d.ts +1 -1
  44. package/common/src/utils/menu-window-provider.d.ts +4 -5
  45. package/common/src/utils/page-tab-context-menu.d.ts +2 -2
  46. package/common/src/utils/route.d.ts +1 -1
  47. package/common/src/utils/router/base.d.ts +2 -1
  48. package/common/src/utils/snapshot.d.ts +1 -1
  49. package/common/src/utils/usage-register.d.ts +2 -0
  50. package/common/src/utils/window.d.ts +17 -10
  51. package/common/src/utils/workspace-modals.d.ts +2 -2
  52. package/home.js +1 -1
  53. package/home.js.map +1 -1
  54. package/index.js +1 -1
  55. package/index.js.map +1 -1
  56. package/notifications.js +126 -51
  57. package/notifications.js.LICENSE.txt +2 -15
  58. package/notifications.js.map +1 -1
  59. package/package.json +1 -1
  60. package/search-api/src/provider/remote/registration.d.ts +4 -1
  61. package/search-api/src/shapes.d.ts +10 -14
  62. package/store.js +1 -1
  63. package/store.js.map +1 -1
  64. package/common/src/api/browser-protocol.d.ts +0 -28
@@ -0,0 +1,67 @@
1
+ /// <reference types="@openfin/core" />
2
+ export declare const getWindowChannelId: (identity: OpenFin.Identity) => string;
3
+ export declare const getChannelClient: (identity: OpenFin.Identity) => Promise<import("@openfin/core/src/api/interappbus/channel/client").default>;
4
+ /**
5
+ * If the browser window is reloaded too quickly, runtime will
6
+ * respond that the channel provider has already been created.
7
+ * Hence, we retry a couple of times to make sure this does not occur.
8
+ * (Should only happen in local development)
9
+ */
10
+ export declare const createChannel: () => Promise<import("@openfin/core/src/api/interappbus/channel/provider").ChannelProvider>;
11
+ export interface AddToChannelRequest {
12
+ newChannelId: string;
13
+ selectedViews: OpenFin.Identity[];
14
+ }
15
+ /**
16
+ * These actions are used to handle functionality activated by user in the UI (e.g. context menu)
17
+ * and hence show dialogs, indicators etc.
18
+ * Not to be confused with attached pages actions, which are for API use.
19
+ */
20
+ declare enum GeneralBrowserChannelActions {
21
+ CloseBrowserWindow = "close-browser-window",
22
+ QuitPlatform = "quit-platform",
23
+ ClosePage = "close-page",
24
+ AddToChannel = "add-to-channel",
25
+ RemoveFromChannel = "remove-from-channel",
26
+ OpenSaveModalInternal = "open-save-modal-internal",
27
+ DuplicatePage = "duplicate-page"
28
+ }
29
+ /**
30
+ * All of the remote procedures that can be called in the
31
+ * platform window's address space regarding attached pages.
32
+ */
33
+ export declare enum PageChannelAction {
34
+ GetPages = "get-pages",
35
+ GetActivePageForWindow = "get-active-page-for-window",
36
+ AttachPagesToWindow = "attach-pages-to-window",
37
+ DetachPagesFromWindow = "detach-pages-from-window",
38
+ SetActivePageForWindow = "set-active-page-for-window",
39
+ RenamePage = "rename-page",
40
+ ReorderPagesForWindow = "reorder-pages-for-window",
41
+ UpdatePageForWindow = "update-page-for-window",
42
+ UpdatePagesWindowOptions = "update-pages-window-options",
43
+ IsDetachingPages = "is-detaching-pages",
44
+ IsActivePageChanging = "is-active-page-changing"
45
+ }
46
+ export declare const BrowserChannelAction: {
47
+ GetPages: PageChannelAction.GetPages;
48
+ GetActivePageForWindow: PageChannelAction.GetActivePageForWindow;
49
+ AttachPagesToWindow: PageChannelAction.AttachPagesToWindow;
50
+ DetachPagesFromWindow: PageChannelAction.DetachPagesFromWindow;
51
+ SetActivePageForWindow: PageChannelAction.SetActivePageForWindow;
52
+ RenamePage: PageChannelAction.RenamePage;
53
+ ReorderPagesForWindow: PageChannelAction.ReorderPagesForWindow;
54
+ UpdatePageForWindow: PageChannelAction.UpdatePageForWindow;
55
+ UpdatePagesWindowOptions: PageChannelAction.UpdatePagesWindowOptions;
56
+ IsDetachingPages: PageChannelAction.IsDetachingPages;
57
+ IsActivePageChanging: PageChannelAction.IsActivePageChanging;
58
+ CloseBrowserWindow: GeneralBrowserChannelActions.CloseBrowserWindow;
59
+ QuitPlatform: GeneralBrowserChannelActions.QuitPlatform;
60
+ ClosePage: GeneralBrowserChannelActions.ClosePage;
61
+ AddToChannel: GeneralBrowserChannelActions.AddToChannel;
62
+ RemoveFromChannel: GeneralBrowserChannelActions.RemoveFromChannel;
63
+ OpenSaveModalInternal: GeneralBrowserChannelActions.OpenSaveModalInternal;
64
+ DuplicatePage: GeneralBrowserChannelActions.DuplicatePage;
65
+ };
66
+ export declare type BrowserChannelAction = typeof BrowserChannelAction;
67
+ export {};
@@ -7,7 +7,7 @@
7
7
  * All of the registered channel action handlers can be found here in the platform's overrides:
8
8
  * @see link: [Provider Protocol Handlers](https://github.com/openfin/workspace/client-api-platform/src/init/override-callback.ts)
9
9
  */
10
- export declare enum ChannelAction {
10
+ export declare enum WorkspacePlatformChannelAction {
11
11
  LaunchApp = "launchApp",
12
12
  SavePage = "savePage",
13
13
  GetSavedPage = "getSavedPage",
@@ -48,6 +48,7 @@ export declare enum ChannelAction {
48
48
  SetActiveWorkspace = "setActiveWorkspace",
49
49
  IsBrowserInitialized = "isBrowserInitialized"
50
50
  }
51
+ export declare const internalGetWorkspacePlatformChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<any>;
51
52
  /**
52
53
  * Get a channel client for a specific Workspace platform.
53
54
  *
@@ -58,7 +59,7 @@ export declare enum ChannelAction {
58
59
  *
59
60
  * @returns the channel client for the Workspace platform.
60
61
  */
61
- export declare const getChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<import("openfin-adapter").ChannelClient>;
62
+ export declare const getWorkspacePlatformChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<import("@openfin/core/src/api/interappbus/channel/client").default>;
62
63
  /**
63
64
  * Get a channel client for a specific Workspace platform.
64
65
  *
@@ -66,4 +67,4 @@ export declare const getChannelClient: (identity: OpenFin.ApplicationIdentity) =
66
67
  *
67
68
  * @returns the channel client for the Workspace platform.
68
69
  */
69
- export declare const getBrowserChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<import("openfin-adapter").ChannelClient>;
70
+ export declare const getBrowserChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<import("@openfin/core/src/api/interappbus/channel/client").default>;
@@ -1,4 +1,4 @@
1
- /// <reference types="openfin-adapter/fin" />
1
+ /// <reference types="@openfin/core" />
2
2
  /** The name of the channel for the centralized workspace protocol. */
3
3
  export declare const channelName = "__of_workspace_protocol__";
4
4
  /**
@@ -10,18 +10,18 @@ export declare const channelName = "__of_workspace_protocol__";
10
10
  * All of the registered channel action handlers can be found here:
11
11
  * @see link: [Provider Protocol Handlers](https://github.com/openfin/workspace/provider/src/api/protocol.ts)
12
12
  */
13
- export declare enum ChannelAction {
14
- RegisterStorefrontProvider = "register-storefront-provider",
15
- DeregisterStorefrontProvider = "deregister-storefront-provider",
16
- GetStorefrontProviders = "get-storefront-providers",
17
- HideStorefront = "hide-storefront",
13
+ export declare enum WorkspaceChannelAction {
14
+ RegisterProvider = "register-provider",
15
+ DeregisterProvider = "deregister-provider",
16
+ CreateProviderWindow = "create-provider-window",
17
+ GetProviders = "get-providers",
18
+ ShowProviderWindow = "show-provider-window",
19
+ HideProviderWindow = "hide-provider-window",
18
20
  GetStorefrontProviderApps = "get-storefront-provider-apps",
19
21
  GetStorefrontProviderLandingPage = "get-storefront-provider-landing-page",
20
22
  GetStorefrontProviderFooter = "get-storefront-provider-footer",
21
23
  GetStorefrontProviderNavigation = "get-storefront-provider-navigation",
22
24
  LaunchStorefrontProviderApp = "launch-storefront-provider-app",
23
- ShowStorefront = "show-storefront",
24
- CreateStorefrontWindow = "create-storefront-window",
25
25
  ShowHome = "show-home",
26
26
  HideHome = "hide-home",
27
27
  AssignHomeSearchContext = "assign-home-search-context",
@@ -30,7 +30,7 @@ export declare enum ChannelAction {
30
30
  GetComputedPlatformTheme = "get-computed-platform-theme"
31
31
  }
32
32
  export interface ChannelClient extends OpenFin.ChannelClient {
33
- dispatch: (action: ChannelAction, payload: any) => Promise<any>;
33
+ dispatch: (action: WorkspaceChannelAction, payload: any) => Promise<any>;
34
34
  }
35
35
  /**
36
36
  * Get a channel client for the centralized Workspace protocol.
@@ -41,7 +41,7 @@ export interface ChannelClient extends OpenFin.ChannelClient {
41
41
  * The channel client can execute remote procedures on the provider via its `dispatch` function.
42
42
  * A call to the `dispatch` function will block until the channel action has concluded execution
43
43
  * in the Workspace Provider's address space.
44
- * For a list of supported procedures, see the `ChannelAction` enum.
44
+ * For a list of supported procedures, see the `WorkspaceChannelAction` enum.
45
45
  *
46
46
  * @returns the channel client for the centralized workspace protocol.
47
47
  */
@@ -0,0 +1,48 @@
1
+ /// <reference types="@openfin/core" />
2
+ import { ProviderInfo } from '../../../client-api/src/shapes';
3
+ export declare enum ProviderType {
4
+ Storefront = "storefront",
5
+ Dock = "dock"
6
+ }
7
+ export interface ProviderIdentity {
8
+ /**
9
+ * The ID of the Provider.
10
+ */
11
+ id: string;
12
+ /**
13
+ * The platform identity that registered the Provider.
14
+ */
15
+ platformIdentity: OpenFin.Identity;
16
+ }
17
+ export interface ProviderInfoWithIdentity extends ProviderInfo {
18
+ platformIdentity: OpenFin.Identity;
19
+ }
20
+ export interface ProviderChannelPayload {
21
+ providerType: ProviderType;
22
+ }
23
+ export interface ProviderRegisterPayload extends ProviderChannelPayload {
24
+ info: ProviderInfo;
25
+ }
26
+ export interface ProviderDeregisterPayload extends ProviderChannelPayload {
27
+ id?: string;
28
+ }
29
+ export interface ProviderConnectionPayload extends ProviderChannelPayload {
30
+ provider: ProviderInfoWithIdentity;
31
+ }
32
+ export interface ProviderDisconnectionPayload extends ProviderChannelPayload {
33
+ provider: ProviderInfoWithIdentity;
34
+ }
35
+ /**
36
+ * Get a list of all providers that have registered with the provider API.
37
+ */
38
+ export declare const getProviders: (providerType: ProviderType) => Promise<ProviderInfoWithIdentity[]>;
39
+ /**
40
+ * A function to dispatch showing the component window of current OF identity
41
+ * @returns action to show Component Window
42
+ */
43
+ export declare const showProviderWindow: (providerType: ProviderType) => Promise<any>;
44
+ /**
45
+ * A function to dispatch hiding the component window of current OF identity
46
+ * @returns action to hide Component Window
47
+ */
48
+ export declare const hideProviderWindow: (providerType: ProviderType) => Promise<void>;
@@ -1,4 +1,4 @@
1
- /// <reference types="openfin-adapter/fin" />
1
+ /// <reference types="@openfin/core" />
2
2
  import { App, StorefrontFooter, StorefrontLandingPage, StorefrontNavigationItemAppGrid, StorefrontNavigationSection, StorefrontProviderInfo } from '../../../client-api/src/shapes';
3
3
  export interface StorefrontProviderInfoWithIdentity extends StorefrontProviderInfo {
4
4
  platformIdentity: OpenFin.Identity;
@@ -31,11 +31,6 @@ export declare const launchStorefrontApp: (req: LaunchStorefrontProviderAppReque
31
31
  * @returns the list of Storefront apps for the platform.
32
32
  */
33
33
  export declare const getStorefrontApps: (identity: StorefrontProviderIdentity) => Promise<App[]>;
34
- /**
35
- * Get a list of all providers that have registered with the Storefront API.
36
- */
37
- export declare const getStorefrontProviders: () => Promise<StorefrontProviderInfoWithIdentity[]>;
38
- export declare const showStorefront: () => Promise<any>;
39
34
  /**
40
35
  * Get the platform's landing page for Storefront.
41
36
  * @param platformIdentity the identity of the platform to get the landing page of.
@@ -61,12 +56,3 @@ export declare const getStorefrontNavigation: (identity: StorefrontProviderIdent
61
56
  * @returns the navigation item with the ID.
62
57
  */
63
58
  export declare const getStorefrontNavigationItemAppGrid: (navigationItemId: string, identity: StorefrontProviderIdentity) => Promise<StorefrontNavigationItemAppGrid | undefined>;
64
- /**
65
- * A function to dispatch hiding the Storefront of current OF identity
66
- * @returns action to hide Storefront
67
- */
68
- export declare const hideStorefront: () => Promise<void>;
69
- /**
70
- * Create the Storefront main window.
71
- */
72
- export declare function createStorefrontWindow(): Promise<any>;
@@ -1,4 +1,4 @@
1
- /// <reference types="openfin-adapter/fin" />
1
+ /// <reference types="@openfin/core" />
2
2
  export interface Workspace {
3
3
  workspaceId: string;
4
4
  title: string;
@@ -1,4 +1,4 @@
1
- /// <reference types="openfin-adapter/fin" />
1
+ /// <reference types="@openfin/core" />
2
2
  export declare enum ApplicationUUID {
3
3
  /**
4
4
  * The UUID of workspace.
@@ -26,13 +26,5 @@ export declare type ApplicationInfoExtended = OpenFin.ApplicationInfo & {
26
26
  userAppConfigArgs: any;
27
27
  };
28
28
  };
29
- export declare const currentOFAppIdentity: {
30
- uuid: string;
31
- name: string;
32
- };
33
- export declare const workspaceOFAppIdentity: {
34
- name: ApplicationUUID;
35
- uuid: ApplicationUUID;
36
- };
37
- export declare const getCurrentOFApplication: () => import("openfin-adapter").Application;
38
- export declare const getWorkspaceOFApplication: () => import("openfin-adapter").Application;
29
+ export declare const getCurrentOFApplication: () => import("@openfin/core/src/api/application").Application;
30
+ export declare const getWorkspaceOFApplication: () => import("@openfin/core/src/api/application").Application;
@@ -5,4 +5,4 @@
5
5
  * @param channelName the name of the channel to connect to.
6
6
  * @returns the function to connect to the channel.
7
7
  */
8
- export default function makeGetChannelClient(channelName: string): () => Promise<import("openfin-adapter").ChannelClient>;
8
+ export default function makeGetChannelClient(channelName: string): () => Promise<import("@openfin/core/src/api/interappbus/channel/client").default>;
@@ -1,5 +1,4 @@
1
- /// <reference types="openfin-adapter/fin" />
2
- import { _Window } from 'openfin-adapter/src/api/window';
1
+ /// <reference types="@openfin/core" />
3
2
  export declare enum MenuItemType {
4
3
  Label = "normal",
5
4
  Separator = "separator",
@@ -9,7 +8,7 @@ export declare enum MenuItemType {
9
8
  export declare type ShowContextMenuResponse = OpenFin.MenuResult & {
10
9
  data: string;
11
10
  };
12
- export default function showContextMenu(opts: OpenFin.ShowPopupMenuOptions, win?: _Window): Promise<ShowContextMenuResponse>;
11
+ export default function showContextMenu(opts: OpenFin.ShowPopupMenuOptions, win?: OpenFin.Window): Promise<ShowContextMenuResponse>;
13
12
  export declare const Separator: OpenFin.MenuItemTemplate;
14
13
  export declare const DefaultSaveMenuBounds: {
15
14
  width: number;
@@ -1,8 +1,11 @@
1
- /// <reference types="openfin-adapter/fin" />
1
+ /// <reference types="@openfin/core" />
2
2
  interface InternalWindowOptions extends OpenFin.PlatformWindowCreationOptions {
3
3
  workspacePlatform: OpenFin.WindowOptions['workspacePlatform'] & {
4
- _internalAutoShow: boolean;
5
- _internalDeferShowEnabled: boolean;
4
+ _internalDeferShowOptions?: {
5
+ setAsForeground?: boolean;
6
+ autoShow?: boolean;
7
+ deferShowEnabled?: boolean;
8
+ };
6
9
  };
7
10
  }
8
11
  /**
@@ -18,9 +21,10 @@ interface InternalWindowOptions extends OpenFin.PlatformWindowCreationOptions {
18
21
  * its show requested listener.
19
22
  *
20
23
  * @param opts the options to modify.
24
+ * @param setAsForeground the option to focus the window when it is shown
21
25
  * @returns the modified options.
22
26
  */
23
- export declare const applyDeferShowOptions: (opts: OpenFin.PlatformWindowCreationOptions) => InternalWindowOptions;
27
+ export declare const applyDeferShowOptions: (opts: OpenFin.PlatformWindowCreationOptions, setAsForeground?: boolean) => InternalWindowOptions;
24
28
  /**
25
29
  * This function is a middleware that can be applied to a platform's `createWindow` function.
26
30
  * If the defer show API has been enabled in window options using the `applyDeferShowOptions` function
@@ -28,7 +32,7 @@ export declare const applyDeferShowOptions: (opts: OpenFin.PlatformWindowCreatio
28
32
  * @param superCreateWindow the create window method to decorate.
29
33
  * @returns the `createWindow` method wrapped with this middleware.
30
34
  */
31
- 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>;
35
+ 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>;
32
36
  /**
33
37
  * Assert if the window is able to be shown or not.
34
38
  * Upon calling `setCanShow(true)`, if the window was previously prevented
@@ -11,7 +11,7 @@ export declare const isDocumentDefined: boolean;
11
11
  export declare const isWindowDefinedWithIndexDB: boolean;
12
12
  export declare const finUUID: string;
13
13
  export declare const finName: string;
14
- export declare const finEntityType: "" | import("openfin-adapter/src/shapes/EntityType").EntityType;
14
+ export declare const finEntityType: "" | "window" | "view" | "iframe" | "external connection" | "unknown";
15
15
  export declare const isEnvLocal: boolean;
16
16
  export declare const isEnvDev: boolean;
17
17
  export declare const isEnvStaging: boolean;
@@ -1,4 +1,4 @@
1
- import { NamedIdentity } from 'openfin-adapter/src/identity';
1
+ /// <reference types="@openfin/core" />
2
2
  import { MenuItemType } from '../../../common/src/utils/context-menu';
3
3
  import * as WP from '../../../client-api-platform/src/index';
4
4
  import { GlobalContextMenuItemTemplate, GlobalContextMenuOptionType, Workspace } from '../../../client-api-platform/src/shapes';
@@ -40,4 +40,4 @@ export declare const getSavedWorkspaceContextMenuOptions: (activeWorkspace: Work
40
40
  workspaceId: string;
41
41
  };
42
42
  }[];
43
- export declare const getGlobalContextMenuTemplate: (winIdentity: NamedIdentity) => Promise<GlobalContextMenuItemTemplate[]>;
43
+ export declare const getGlobalContextMenuTemplate: (winIdentity: OpenFin.Identity) => Promise<GlobalContextMenuItemTemplate[]>;
@@ -1,2 +1,2 @@
1
- /// <reference types="openfin-adapter/fin" />
1
+ /// <reference types="@openfin/core" />
2
2
  export default function makeShowIndicator(opts?: OpenFin.PlatformWindowCreationOptions): (namespace: string, url: string, message: string, type: string) => Promise<void>;
@@ -1,11 +1,10 @@
1
- /// <reference types="openfin-adapter/fin" />
2
- import { NamedIdentity } from 'openfin-adapter/src/identity';
1
+ /// <reference types="@openfin/core" />
3
2
  interface LandingPageUrls {
4
3
  newPageUrl: string | false;
5
4
  newTabUrl: string | false;
6
5
  }
7
- export declare const getLandingPageUrls: (winIdentity?: NamedIdentity) => Promise<LandingPageUrls>;
6
+ export declare const getLandingPageUrls: (winIdentity?: OpenFin.Identity) => Promise<LandingPageUrls>;
8
7
  export declare const checkHasNewTabUrl: () => Promise<boolean>;
9
8
  export declare const getNewLandingTabViewOptions: (target: OpenFin.Identity) => Promise<OpenFin.PlatformViewCreationOptions>;
10
- export declare const makeNewLandingPage: (winIdentity?: NamedIdentity) => Promise<import("@client-platform/").PageWithUpdatableRuntimeAttribs>;
9
+ export declare const makeNewLandingPage: (winIdentity?: OpenFin.Identity) => Promise<import("@client-platform/").PageWithUpdatableRuntimeAttribs>;
11
10
  export {};
@@ -1,5 +1,4 @@
1
- /// <reference types="openfin-adapter/fin" />
2
- import { NamedIdentity } from 'openfin-adapter/src/identity';
1
+ /// <reference types="@openfin/core" />
3
2
  import { AttachedPage, PageLayout } from '../../../client-api-platform/src/shapes';
4
3
  export declare type LayoutComponentStateExtended = OpenFin.LayoutComponent['componentState'] & {
5
4
  name: string;
@@ -48,7 +47,7 @@ export declare const cloneLayoutAndFillInViewNames: (layout: any) => any;
48
47
  */
49
48
  export declare const cloneLayoutAndRemoveNames: (layout: any) => any;
50
49
  export declare const mapContentComponentState: (content: OpenFin.LayoutContent | LayoutContentExtended) => LayoutComponentStateExtended[];
51
- export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: NamedIdentity) => Promise<any>;
50
+ export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<any>;
52
51
  export declare const isLayoutTabActive: (tabSelector: string) => boolean;
53
52
  export declare const containerId = "layout_container";
54
53
  export declare const getViewComponents: () => LayoutContentExtended;
@@ -3,6 +3,7 @@ declare enum LocalStorageKey {
3
3
  LastFocusedBrowserWindow = "lastFocusedBrowserWindow",
4
4
  MachineName = "machineName",
5
5
  NewTabPageLayout = "NewTabPageLayout",
6
- NewTabPageSort = "NewTabPageSort"
6
+ NewTabPageSort = "NewTabPageSort",
7
+ DockPosition = "DockPosition"
7
8
  }
8
9
  export default LocalStorageKey;
@@ -1,4 +1,4 @@
1
- /// <reference types="openfin-adapter/fin" />
1
+ /// <reference types="@openfin/core" />
2
2
  import type { OptionalExceptFor } from '../../../common/src/utils/types';
3
3
  export interface ModalResponseContent {
4
4
  title: string;
@@ -1,5 +1,4 @@
1
- /// <reference types="openfin-adapter/fin" />
2
- import { NamedIdentity } from 'openfin-adapter/src/identity';
1
+ /// <reference types="@openfin/core" />
3
2
  import { ModalResponseContent, ResponseModalConfig } from '../../../common/src/utils/menu-config';
4
3
  import { Listener } from '../../../common/src/utils/shared-emitter';
5
4
  import type { OptionalExceptFor } from '../../../common/src/utils/types';
@@ -36,9 +35,9 @@ export declare function createMenuPosition(windowOptions: OptionalExceptFor<Open
36
35
  top: number;
37
36
  left: number;
38
37
  }>;
39
- export declare function showChildWindow({ options, parameters }: ShowChildOptions): Promise<import("openfin-adapter").Window>;
40
- export declare const getResponseModalBounds: (modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: NamedIdentity) => Promise<import("@common/utils/window").Point>;
41
- export declare const waitForModalResponse: ({ options, content }: ResponseModalOptions) => Promise<{
38
+ export declare function showChildWindow({ options, parameters }: ShowChildOptions, shouldCenterOnMonitor?: boolean): Promise<import("@openfin/core/src/api/window")._Window>;
39
+ export declare const getResponseModalBounds: (modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, shouldCenterOnMonitor?: boolean) => Promise<import("@common/utils/window").Point>;
40
+ export declare const waitForModalResponse: ({ options, content }: ResponseModalOptions, shouldCenterOnMonitor?: boolean) => Promise<{
42
41
  data: ModalResponse;
43
42
  }>;
44
43
  export {};
@@ -1,3 +1,3 @@
1
- import { NamedIdentity } from 'openfin-adapter/src/identity';
1
+ /// <reference types="@openfin/core" />
2
2
  import { PageTabContextMenuItemTemplate } from '../../../client-api-platform/src/shapes';
3
- export declare const getPageTabMenuTemplate: (pageId: string, winIdentity: NamedIdentity) => Promise<PageTabContextMenuItemTemplate[]>;
3
+ export declare const getPageTabMenuTemplate: (pageId: string, winIdentity: OpenFin.Identity) => Promise<PageTabContextMenuItemTemplate[]>;
@@ -7,7 +7,7 @@ export declare enum PageRoute {
7
7
  Home = "/home/",
8
8
  HomeSearch = "/home/?deeplink=search",
9
9
  HomePagesRename = "/home/pages/rename/",
10
- Dock = "/home/dock/",
10
+ Dock = "/dock/",
11
11
  BrowserPagesLanding = "/browser/pages/landing/",
12
12
  HomeIndicator = "/home/indicator/",
13
13
  Browser = "/browser/",
@@ -9,7 +9,8 @@ export declare enum Zone {
9
9
  Home = "/home",
10
10
  Browser = "/browser",
11
11
  Provider = "/provider",
12
- Storefront = "/storefront"
12
+ Storefront = "/storefront",
13
+ Dock = "/dock"
13
14
  }
14
15
  export declare function getRouterZone(): "" | Zone;
15
16
  /**
@@ -1,4 +1,4 @@
1
- /// <reference types="openfin-adapter/fin" />
1
+ /// <reference types="@openfin/core" />
2
2
  export declare type SnapshotDetailsExtended = OpenFin.Snapshot['snapshotDetails'] & {
3
3
  machineId: string;
4
4
  machineName?: string;
@@ -1,11 +1,13 @@
1
1
  export interface RegisterUsageStatus {
2
2
  apiVersion?: string;
3
+ componentVersion?: string;
3
4
  allowed: boolean;
4
5
  rejectionCode?: string;
5
6
  }
6
7
  export declare const registerBrowserUsage: (status: RegisterUsageStatus) => Promise<void>;
7
8
  export declare const registerHomeUsage: (status: RegisterUsageStatus) => Promise<void>;
8
9
  export declare const registerStorefrontUsage: (status: RegisterUsageStatus) => Promise<void>;
10
+ export declare const registerDockUsage: (status: RegisterUsageStatus) => Promise<void>;
9
11
  export declare const registerNotificationUsage: (status: RegisterUsageStatus) => Promise<void>;
10
12
  export declare const registerPlatformUsage: (status: RegisterUsageStatus) => Promise<void>;
11
13
  export declare const registerThemingUsage: (status: RegisterUsageStatus) => Promise<void>;
@@ -1,8 +1,5 @@
1
- /// <reference types="openfin-adapter/fin" />
2
- import type { Fin } from 'openfin-adapter';
3
- import type { _Window } from 'openfin-adapter/src/api/window';
1
+ /// <reference types="@openfin/core" />
4
2
  import { ApplicationUUID } from './application';
5
- export declare type WindowFin = Fin<'window'>;
6
3
  export declare enum WindowName {
7
4
  Home = "openfin-home",
8
5
  Dock = "openfin-dock",
@@ -18,6 +15,7 @@ export declare enum WindowEvent {
18
15
  LayoutReady = "layout-ready",
19
16
  EndUserBoundsChanging = "end-user-bounds-changing",
20
17
  Blurred = "blurred",
18
+ Closed = "closed",
21
19
  CloseRequested = "close-requested",
22
20
  Focused = "focused",
23
21
  ShowRequested = "show-requested",
@@ -65,7 +63,7 @@ export declare const getBoundsFromCenter: (center: Point, size: Size) => Point;
65
63
  * @param identity the window identity.
66
64
  * @returns the wrapped OpenFin window identity.
67
65
  */
68
- export declare function getOFWindow(identity: WindowIdentity): _Window;
66
+ export declare function getOFWindow(identity: WindowIdentity): import("@openfin/core/src/api/window")._Window;
69
67
  /**
70
68
  * The OpenFin identity for the current window.
71
69
  */
@@ -73,19 +71,20 @@ export declare const currentOFIdentity: WindowIdentity;
73
71
  /**
74
72
  * Get the current OpenFin window.
75
73
  */
76
- export declare function getCurrentOFWindow(): _Window;
74
+ export declare function getCurrentOFWindow(): import("@openfin/core/src/api/window")._Window;
77
75
  /**
78
76
  * The OpenFin identity for Home.
79
77
  */
80
78
  export declare const homeOFIdentity: WindowIdentity;
81
79
  export declare const dockOFIdentity: WindowIdentity;
80
+ export declare const notificationCenterOFIdentity: WindowIdentity;
82
81
  export declare const StorefrontOFIdentity: WindowIdentity;
83
82
  export declare const providerOFIdentity: WindowIdentity;
84
83
  /**
85
84
  * Get the Home OpenFin window.
86
85
  */
87
- export declare function getHomeOFWindow(): _Window;
88
- export declare function getDockOFWindow(): _Window;
86
+ export declare function getHomeOFWindow(): import("@openfin/core/src/api/window")._Window;
87
+ export declare function getDockOFWindow(): import("@openfin/core/src/api/window")._Window;
89
88
  /**
90
89
  * Helper for max and restoring a window.
91
90
  * @param identity the identity of the window to maximize or restore.
@@ -110,13 +109,13 @@ export declare function hideAndBlur(identity: WindowIdentity): Promise<void>;
110
109
  */
111
110
  export declare function toggleVisibility(identity: WindowIdentity): Promise<void>;
112
111
  export declare const toggleDock: () => Promise<void>;
113
- export declare const showAndFocusDock: () => Promise<void>;
114
112
  export declare function isAnimatingSize(): boolean;
115
113
  /**
116
114
  * Resizes a window to width and height saved in the store
117
115
  * if they differ from current window size.
118
116
  */
119
117
  export declare function restoreWindowSize(): Promise<void>;
118
+ export declare function setSize(width: number, height: number): Promise<void>;
120
119
  export declare function animateSize(width: number, height: number): Promise<void>;
121
120
  /**
122
121
  * Returns true if the window name is that of a browser window.
@@ -131,7 +130,7 @@ export declare function forceBodySize(): void;
131
130
  /**
132
131
  * Gets all currently open browser windows.
133
132
  */
134
- export declare function getBrowserWindows(): Promise<_Window[]>;
133
+ export declare function getBrowserWindows(): Promise<OpenFin.Window[]>;
135
134
  /**
136
135
  * Closes all currently open Browser windows.
137
136
  */
@@ -145,10 +144,18 @@ export declare const isWindowRunning: (identity: WindowIdentity) => Promise<bool
145
144
  * @returns true if the Storefront window is running.
146
145
  */
147
146
  export declare const isStorefrontWindowRunning: () => Promise<boolean>;
147
+ export declare const isDockWindowRunning: () => Promise<boolean>;
148
+ export declare const isNotificationCenterRunning: () => Promise<boolean>;
148
149
  export declare const isHomeWindowRunning: () => Promise<boolean>;
149
150
  export declare const showAndFocusStorefront: () => Promise<void>;
151
+ export declare const showAndFocusDock: () => Promise<void>;
150
152
  export declare const centerWindowIfOffScreen: (windowIdentity?: WindowIdentity) => Promise<void>;
151
153
  export declare const getDisableMultiplePagesOption: (identity: WindowIdentity) => Promise<any>;
152
154
  export declare const getIsLockedOption: (identity: WindowIdentity) => Promise<any>;
153
155
  export declare const getPlatformWindowTitle: (identity: WindowIdentity) => Promise<any>;
156
+ export declare const getComponentWindowStatus: () => Promise<{
157
+ storefrontRunning: boolean;
158
+ homeRunning: boolean;
159
+ notificationCenterRunning: boolean;
160
+ }>;
154
161
  export {};
@@ -1,4 +1,4 @@
1
- /// <reference types="openfin-adapter/fin" />
1
+ /// <reference types="@openfin/core" />
2
2
  import { ResponseModalConfig } from '../../../common/src/utils/menu-config';
3
3
  export declare const restoreChangesMenu: (windowIdentity: any) => Promise<ResponseModalConfig>;
4
4
  export declare const showSwitchWorkspaceModal: (windowIdentity: OpenFin.Identity, workspaceTitle: string) => Promise<boolean>;
@@ -9,6 +9,6 @@ export declare const showDeleteWorkspaceModal: (windowIdentity: OpenFin.Identity
9
9
  * @param workspaceTitle The platform label
10
10
  * @returns Boolean - Affirmative or Negative response from user
11
11
  */
12
- export declare const showPlatformQuitModal: (windowIdentity: OpenFin.Identity, workspaceTitle: string) => Promise<boolean>;
12
+ export declare const showPlatformQuitModal: (windowIdentity: OpenFin.Identity, workspaceTitle: string, shouldCenterOnMonitor?: boolean) => Promise<boolean>;
13
13
  export declare const showRestoreChangesModal: (windowIdentity: any) => Promise<boolean>;
14
14
  export declare const getOverwriteWorkspaceMenu: (workspaceTitle: string) => Promise<ResponseModalConfig>;