@openfin/workspace-platform 23.0.8 → 23.0.10
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/common/src/utils/layout.d.ts +14 -1
- package/common/src/utils/route.d.ts +1 -1
- package/common/src/utils/window.d.ts +2 -1
- package/dock3/src/api/utils.d.ts +11 -0
- package/dock3/src/shapes/shapes.d.ts +4 -0
- package/index.js +1 -1
- package/index.js.map +1 -1
- package/package.json +2 -2
- package/workspace_platform.zip +0 -0
|
@@ -7,7 +7,7 @@ import type { LaunchAppRequest, SearchSitesRequest, SearchSitesResponse, Site }
|
|
|
7
7
|
* @param app the app directory entry.
|
|
8
8
|
* @param opts launch options.
|
|
9
9
|
*/
|
|
10
|
-
export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Identity | OpenFin.
|
|
10
|
+
export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Identity | OpenFin.Application | OpenFin.View | OpenFin.Platform>;
|
|
11
11
|
export declare const enterpriseAppDirectoryChannelClient: () => Promise<OpenFin.ChannelClient>;
|
|
12
12
|
export declare function getResults(payload: {
|
|
13
13
|
req: SearchSitesRequest;
|
|
@@ -14,9 +14,15 @@ export type LayoutDOMEventType =
|
|
|
14
14
|
/**
|
|
15
15
|
* Fired when the layout container is ready to be used. (Emitted by us)
|
|
16
16
|
*/
|
|
17
|
-
| 'container-resized'
|
|
17
|
+
| 'container-resized'
|
|
18
|
+
/**
|
|
19
|
+
* Fired when a view item container is resized (e.g., via separator drag). (Emitted by us)
|
|
20
|
+
*/
|
|
21
|
+
| 'view-container-resized' | 'tab-closed';
|
|
18
22
|
export type LayoutDOMEvent = {
|
|
19
23
|
type: Extract<LayoutDOMEventType, 'container-resized'>;
|
|
24
|
+
} | {
|
|
25
|
+
type: Extract<LayoutDOMEventType, 'view-container-resized'>;
|
|
20
26
|
} | {
|
|
21
27
|
type: Extract<LayoutDOMEventType, 'tab-created' | 'tab-closed'>;
|
|
22
28
|
detail: {
|
|
@@ -85,6 +91,13 @@ export declare const isLayoutTabActive: (tabSelector: string) => boolean;
|
|
|
85
91
|
export declare const containerId = "layout_container";
|
|
86
92
|
export declare const viewTabslistSelectors = ".lm_tabs";
|
|
87
93
|
export declare const addLayoutEventListener: (event: LayoutDOMEventType, listener: LayoutDOMEventListener) => void;
|
|
94
|
+
export declare const removeLayoutEventListener: (event: LayoutDOMEventType, listener: LayoutDOMEventListener) => void;
|
|
95
|
+
/**
|
|
96
|
+
* Cleans up ResizeObservers and event listeners for a specific layout.
|
|
97
|
+
* Should be called when a layout is destroyed to prevent memory leaks.
|
|
98
|
+
* @param layoutName The layoutName/layoutContainerKey to cleanup
|
|
99
|
+
*/
|
|
100
|
+
export declare const cleanupLayoutObservers: (layoutName: string) => void;
|
|
88
101
|
/**
|
|
89
102
|
* Initialize the layout for the current OF window.
|
|
90
103
|
*/
|
|
@@ -34,7 +34,7 @@ declare enum BrowserRoute {
|
|
|
34
34
|
ZoomControlsDialog = "/zoom-controls-dialog/",
|
|
35
35
|
DesktopSignalsModal = "/popup-menu/desktop-signals-modal/",
|
|
36
36
|
IntentsResolverModal = "/popup-menu/intents-resolver-modal/",
|
|
37
|
-
FindInPageModal = "/find-in-page-modal/"
|
|
37
|
+
FindInPageModal = "/popup-menu/find-in-page-modal/"
|
|
38
38
|
}
|
|
39
39
|
declare const PageRoute: {
|
|
40
40
|
Browser: BrowserRoute.Browser;
|
|
@@ -156,6 +156,7 @@ export declare function getModalWindows(): Promise<OpenFin.Window[]>;
|
|
|
156
156
|
* Returns true if the OpenFin window for the provided identity is running.
|
|
157
157
|
* */
|
|
158
158
|
export declare const isWindowRunning: (identity: WindowIdentity) => Promise<boolean>;
|
|
159
|
+
export declare const isApplicationRunning: (uuid: string) => Promise<boolean>;
|
|
159
160
|
/**
|
|
160
161
|
* Check if Storefront window is running.
|
|
161
162
|
* @returns true if the Storefront window is running.
|
|
@@ -163,7 +164,7 @@ export declare const isWindowRunning: (identity: WindowIdentity) => Promise<bool
|
|
|
163
164
|
export declare const isStorefrontWindowRunning: () => Promise<boolean>;
|
|
164
165
|
export declare const isDockWindowRunning: () => Promise<boolean>;
|
|
165
166
|
export declare const isHomeWindowRunning: () => Promise<boolean>;
|
|
166
|
-
export declare const
|
|
167
|
+
export declare const isNotificationCenterRunning: () => Promise<boolean>;
|
|
167
168
|
export declare const showAndFocusStorefront: () => Promise<void>;
|
|
168
169
|
export declare const showAndFocusDock: () => Promise<void>;
|
|
169
170
|
export declare const getDisableMultiplePagesOption: (identity: WindowIdentity) => Promise<any>;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { CompanionDockConfig } from '../shapes/enterprise';
|
|
2
|
+
import type { DockAllowedWindowOptions } from '../shapes/shapes';
|
|
3
|
+
export declare const getSnapZone: (config: CompanionDockConfig | unknown, options?: DockAllowedWindowOptions) => {
|
|
4
|
+
enabled: boolean;
|
|
5
|
+
threshold?: number;
|
|
6
|
+
locationPreference?: Array<"top" | "bottom">;
|
|
7
|
+
} | {
|
|
8
|
+
enabled: boolean;
|
|
9
|
+
threshold: number;
|
|
10
|
+
locationPreference: readonly ["top", "bottom"];
|
|
11
|
+
};
|
|
@@ -83,4 +83,8 @@ export type DockAllowedWindowOptions = Partial<Pick<OpenFin.PlatformWindowOption
|
|
|
83
83
|
locationPreference?: Array<'top' | 'bottom'>;
|
|
84
84
|
};
|
|
85
85
|
};
|
|
86
|
+
contextMenuOptions?: {
|
|
87
|
+
enabled?: boolean;
|
|
88
|
+
template?: Array<'snapToTop' | 'snapToBottom' | 'inspect'>;
|
|
89
|
+
};
|
|
86
90
|
};
|