@openfin/workspace-platform 12.1.0 → 12.1.2
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.
- package/client-api-platform/src/api/app-directory.d.ts +1 -1
- package/client-api-platform/src/init/panels.d.ts +2 -1
- package/common/src/api/protocol/browser.d.ts +2 -2
- package/common/src/api/protocol/workspace-platform.d.ts +2 -2
- package/common/src/utils/application.d.ts +2 -2
- package/common/src/utils/channels.d.ts +2 -1
- package/common/src/utils/defer-show.d.ts +1 -1
- package/common/src/utils/layout.d.ts +1 -31
- package/common/src/utils/menu-window-provider.d.ts +1 -2
- package/common/src/utils/window.d.ts +4 -4
- package/index.js +1 -1
- package/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -5,4 +5,4 @@ import type { LaunchAppRequest } from '../shapes';
|
|
|
5
5
|
* @param app the app directory entry.
|
|
6
6
|
* @param opts launch options.
|
|
7
7
|
*/
|
|
8
|
-
export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void |
|
|
8
|
+
export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Application | OpenFin.Identity | OpenFin.View | OpenFin.Platform>;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
+
import type OpenFin from '@openfin/core';
|
|
1
2
|
import { AttachedPage, ExtendedPanelConfig, PanelConfig } from '../../../common/src/api/pages/shapes';
|
|
2
3
|
export declare function convertPanelViewOpts(panels: PanelConfig[]): ExtendedPanelConfig[];
|
|
3
4
|
export declare function createPanelViewsForPages(pages: AttachedPage[]): Promise<void>;
|
|
4
|
-
export declare function createPanelViews(panels: PanelConfig[]): Promise<(void |
|
|
5
|
+
export declare function createPanelViews(panels: PanelConfig[]): Promise<(void | OpenFin.View)[]>;
|
|
@@ -10,8 +10,8 @@ export declare const getChannelClient: (identity: OpenFin.Identity) => Promise<C
|
|
|
10
10
|
* Hence, we retry a couple of times to make sure this does not occur.
|
|
11
11
|
* (Should only happen in local development)
|
|
12
12
|
*/
|
|
13
|
-
export declare const createChannel: () => Promise<
|
|
14
|
-
export declare const makeGetBrowserChannelClient: () => Promise<
|
|
13
|
+
export declare const createChannel: () => Promise<OpenFin.ChannelProvider>;
|
|
14
|
+
export declare const makeGetBrowserChannelClient: () => Promise<OpenFin.ChannelProvider>;
|
|
15
15
|
export interface AddToChannelRequest {
|
|
16
16
|
newChannelId: string;
|
|
17
17
|
selectedViews: OpenFin.Identity[];
|
|
@@ -72,7 +72,7 @@ export declare const internalGetWorkspacePlatformChannelClient: (identity: OpenF
|
|
|
72
72
|
*
|
|
73
73
|
* @returns the channel client for the Workspace platform.
|
|
74
74
|
*/
|
|
75
|
-
export declare const getWorkspacePlatformChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<
|
|
75
|
+
export declare const getWorkspacePlatformChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<OpenFin.ChannelClient>;
|
|
76
76
|
/**
|
|
77
77
|
* Get a channel client for a specific Workspace platform.
|
|
78
78
|
*
|
|
@@ -80,4 +80,4 @@ export declare const getWorkspacePlatformChannelClient: (identity: OpenFin.Appli
|
|
|
80
80
|
*
|
|
81
81
|
* @returns the channel client for the Workspace platform.
|
|
82
82
|
*/
|
|
83
|
-
export declare const getBrowserChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<
|
|
83
|
+
export declare const getBrowserChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<OpenFin.ChannelClient>;
|
|
@@ -21,5 +21,5 @@ export declare type ApplicationInfoExtended = OpenFin.ApplicationInfo & {
|
|
|
21
21
|
userAppConfigArgs: any;
|
|
22
22
|
};
|
|
23
23
|
};
|
|
24
|
-
export declare const getCurrentOFApplication: () =>
|
|
25
|
-
export declare const getWorkspaceOFApplication: () =>
|
|
24
|
+
export declare const getCurrentOFApplication: () => OpenFin.Application;
|
|
25
|
+
export declare const getWorkspaceOFApplication: () => OpenFin.Application;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type OpenFin from '@openfin/core';
|
|
1
2
|
/**
|
|
2
3
|
* Make a function that connects to a channel.
|
|
3
4
|
* If already connected to the channel, will return the channel connection.
|
|
@@ -5,4 +6,4 @@
|
|
|
5
6
|
* @param channelName the name of the channel to connect to.
|
|
6
7
|
* @returns the function to connect to the channel.
|
|
7
8
|
*/
|
|
8
|
-
export default function makeGetChannelClient(channelName: string): () => Promise<
|
|
9
|
+
export default function makeGetChannelClient(channelName: string): () => Promise<OpenFin.ChannelClient>;
|
|
@@ -32,7 +32,7 @@ export declare const applyDeferShowOptions: (opts: OpenFin.PlatformWindowCreatio
|
|
|
32
32
|
* @param superCreateWindow the create window method to decorate.
|
|
33
33
|
* @returns the `createWindow` method wrapped with this middleware.
|
|
34
34
|
*/
|
|
35
|
-
export declare const withDeferShow: (superCreateWindow: (opts: OpenFin.PlatformWindowCreationOptions, callerIdentity: OpenFin.Identity) => Promise<OpenFin.Window>) => (opts: OpenFin.PlatformWindowCreationOptions, callerIdentity: OpenFin.Identity) => Promise<
|
|
35
|
+
export declare const withDeferShow: (superCreateWindow: (opts: OpenFin.PlatformWindowCreationOptions, callerIdentity: OpenFin.Identity) => Promise<OpenFin.Window>) => (opts: OpenFin.PlatformWindowCreationOptions, callerIdentity: OpenFin.Identity) => Promise<OpenFin.Window>;
|
|
36
36
|
/**
|
|
37
37
|
* Assert if the window is able to be shown or not.
|
|
38
38
|
* Upon calling `setCanShow(true)`, if the window was previously prevented
|
|
@@ -67,37 +67,7 @@ export declare const cloneViewComponentWithoutName: (componentState: any) => any
|
|
|
67
67
|
*/
|
|
68
68
|
export declare const cloneLayoutAndRemoveNames: (layout: PageLayout) => any;
|
|
69
69
|
export declare const mapContentComponentState: (content: OpenFin.LayoutContent | LayoutContentExtended) => LayoutComponentStateExtended[];
|
|
70
|
-
export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<
|
|
71
|
-
content: {
|
|
72
|
-
type: string;
|
|
73
|
-
content: {
|
|
74
|
-
type: string;
|
|
75
|
-
componentName: string;
|
|
76
|
-
componentState: {
|
|
77
|
-
title: string;
|
|
78
|
-
url: string;
|
|
79
|
-
};
|
|
80
|
-
}[];
|
|
81
|
-
}[];
|
|
82
|
-
settings?: {
|
|
83
|
-
popoutWholeStack?: boolean;
|
|
84
|
-
constrainDragToContainer?: boolean;
|
|
85
|
-
showPopoutIcon?: boolean;
|
|
86
|
-
showMaximiseIcon?: boolean;
|
|
87
|
-
showCloseIcon?: boolean;
|
|
88
|
-
constrainDragToHeaders?: boolean;
|
|
89
|
-
hasHeaders?: boolean;
|
|
90
|
-
reorderEnabled?: boolean;
|
|
91
|
-
preventDragOut?: boolean;
|
|
92
|
-
preventDragIn?: boolean;
|
|
93
|
-
};
|
|
94
|
-
dimensions?: {
|
|
95
|
-
borderWidth?: number;
|
|
96
|
-
minItemHeight?: number;
|
|
97
|
-
minItemWidth?: number;
|
|
98
|
-
headerHeight?: number;
|
|
99
|
-
};
|
|
100
|
-
}>;
|
|
70
|
+
export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<any>;
|
|
101
71
|
export declare const isLayoutTabActive: (tabSelector: string) => boolean;
|
|
102
72
|
export declare const containerId = "layout_container";
|
|
103
73
|
export declare const getViewComponents: () => LayoutContentExtended;
|
|
@@ -2,7 +2,6 @@ import type OpenFin from '@openfin/core';
|
|
|
2
2
|
import { ModalResponseContent } from '../../../common/src/utils/menu-config';
|
|
3
3
|
import { Listener } from '../../../common/src/utils/shared-emitter';
|
|
4
4
|
import type { OptionalExceptFor } from '../../../common/src/utils/types';
|
|
5
|
-
import { _Window } from '@openfin/core/src/api/window';
|
|
6
5
|
export declare enum MenuEvent {
|
|
7
6
|
Ready = "ready",
|
|
8
7
|
Update = "update",
|
|
@@ -37,7 +36,7 @@ export declare function createMenuPosition(windowOptions: OptionalExceptFor<Open
|
|
|
37
36
|
top: number;
|
|
38
37
|
left: number;
|
|
39
38
|
}>;
|
|
40
|
-
export declare function showChildWindow({ options, parameters }: ShowChildOptions): Promise<
|
|
39
|
+
export declare function showChildWindow({ options, parameters }: ShowChildOptions): Promise<OpenFin.Window>;
|
|
41
40
|
export declare const waitForModalResponse: ({ options, content }: ResponseModalOptions) => Promise<{
|
|
42
41
|
data: ModalResponse;
|
|
43
42
|
}>;
|
|
@@ -47,7 +47,7 @@ export declare const getBoundsFromCenter: (center: Point, size: Size) => OpenFin
|
|
|
47
47
|
* @param identity the window identity.
|
|
48
48
|
* @returns the wrapped OpenFin window identity.
|
|
49
49
|
*/
|
|
50
|
-
export declare function getOFWindow(identity: WindowIdentity):
|
|
50
|
+
export declare function getOFWindow(identity: WindowIdentity): OpenFin.Window;
|
|
51
51
|
/**
|
|
52
52
|
* The OpenFin identity for the current window.
|
|
53
53
|
*/
|
|
@@ -55,7 +55,7 @@ export declare const currentOFIdentity: WindowIdentity;
|
|
|
55
55
|
/**
|
|
56
56
|
* Get the current OpenFin window.
|
|
57
57
|
*/
|
|
58
|
-
export declare function getCurrentOFWindow():
|
|
58
|
+
export declare function getCurrentOFWindow(): OpenFin.Window;
|
|
59
59
|
/**
|
|
60
60
|
* The OpenFin identity for Home.
|
|
61
61
|
*/
|
|
@@ -67,8 +67,8 @@ export declare const providerOFIdentity: WindowIdentity;
|
|
|
67
67
|
/**
|
|
68
68
|
* Get the Home OpenFin window.
|
|
69
69
|
*/
|
|
70
|
-
export declare function getHomeOFWindow():
|
|
71
|
-
export declare function getDockOFWindow():
|
|
70
|
+
export declare function getHomeOFWindow(): OpenFin.Window;
|
|
71
|
+
export declare function getDockOFWindow(): OpenFin.Window;
|
|
72
72
|
/**
|
|
73
73
|
* Helper for max and restoring a window.
|
|
74
74
|
* @param identity the identity of the window to maximize or restore.
|