@openfin/workspace 20.1.4 → 20.1.6
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/browser/src/components/PanelContainer/BookmarksPanel/BookmarkItem.d.ts +2 -2
- package/browser/src/components/PanelContainer/BookmarksPanel/BookmarksResults.d.ts +1 -1
- package/browser/src/components/PanelContainer/BookmarksPanel/useBookmarkNavigation.d.ts +8 -0
- package/browser/src/components/PanelContainer/BookmarksPanel/useBookmarksSearch.d.ts +1 -1
- package/browser/src/components/PanelContainer/BookmarksPanel/utils.d.ts +7 -0
- package/client-api-platform/src/index.d.ts +1 -1
- package/client-api-platform/src/init/index.d.ts +2 -4
- package/client-api-platform/src/shapes.d.ts +4 -173
- package/common/src/api/overrides.d.ts +2 -0
- package/common/src/api/protocol/browser.d.ts +1 -12
- package/common/src/api/protocol/workspace-platform.d.ts +1 -12
- package/common/src/api/theming.d.ts +4 -31
- package/common/src/api/workspace-events.d.ts +1 -1
- package/common/src/components/BaseButton/BaseButton.d.ts +4 -2
- package/common/src/utils/bookmark-item-context-menu.d.ts +0 -5
- package/common/src/utils/bookmarks.d.ts +3 -7
- package/common/src/utils/menu-window-provider.d.ts +0 -1
- package/common/src/utils/modal-bounds.d.ts +0 -7
- package/common/src/utils/popup-window.d.ts +7 -4
- package/common/src/utils/route.d.ts +1 -2
- package/common/src/utils/router/base.d.ts +1 -1
- package/common/src/utils/shared-emitter.d.ts +0 -5
- package/common/src/utils/usage-register.d.ts +0 -1
- package/common/src/utils/window.d.ts +1 -2
- package/home.js +4 -4
- package/home.js.map +1 -1
- package/index.js +4 -4
- package/index.js.map +1 -1
- package/notifications.js +99 -99
- package/notifications.js.map +1 -1
- package/package.json +4 -4
- package/search-api/src/client/internal.d.ts +4 -4
- package/search-api/src/client/remote/channel-client-factory.d.ts +1 -2
- package/search-api/src/client/remote/channel-client.d.ts +4 -4
- package/search-api/src/fin/index.d.ts +3 -2
- package/search-api/src/fin/shapes.d.ts +23 -0
- package/search-api/src/index.d.ts +1 -1
- package/search-api/src/internal-shapes.d.ts +1 -1
- package/search-api/src/provider/internal.d.ts +1 -3
- package/search-api/src/provider/remote/channel-factory.d.ts +1 -2
- package/search-api/src/provider/remote/channel.d.ts +4 -4
- package/search-api/src/shapes.d.ts +2 -17
- package/store.js +37 -37
- package/store.js.map +1 -1
- package/browser/src/components/ControlBar/SearchMenu/BookmarkButton.d.ts +0 -9
- package/browser/src/components/ControlBar/SearchMenu/useBookmarkButtonHover.d.ts +0 -2
- package/browser/src/components/ControlBar/SearchMenu/useEnterpriseBookmarkDialogWindow.d.ts +0 -2
- package/browser/src/components/ControlBar/SearchMenu/useIsBookmarked.d.ts +0 -1
- package/browser/src/components/ControlBar/SearchMenu/useIsSelectedViewNavigated.d.ts +0 -5
- package/browser/src/components/ControlBar/SearchMenu/useSelectedAndOpenViewsBroadcastChannel.d.ts +0 -8
- package/browser/src/components/ControlBar/SearchMenu/utils.d.ts +0 -11
- package/client-api-platform/src/api/bookmarks.d.ts +0 -2
- package/client-api-platform/src/api/dock.d.ts +0 -13
- package/common/src/brand/default-brand.d.ts +0 -8
- package/common/src/components/CloseButton/CloseButtonLarge.d.ts +0 -4
- package/common/src/hooks/useAddEditBookmarkDialog.d.ts +0 -7
- package/common/src/hooks/usePreloadedWindow.d.ts +0 -13
- package/common/src/utils/enterprise-dock.d.ts +0 -3
- package/common/src/utils/get-browser-window.d.ts +0 -3
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
import { BookmarkNode } from '../../../../../common/src/api/pages/shapes';
|
|
3
|
-
import { BaseButtonProps } from '../../../../../common/src/components/BaseButton/BaseButton';
|
|
3
|
+
import { Props as BaseButtonProps } from '../../../../../common/src/components/BaseButton/BaseButton';
|
|
4
4
|
interface BookmarkItemProps {
|
|
5
5
|
bookmark: BookmarkNode;
|
|
6
6
|
isRenaming: boolean;
|
|
@@ -9,7 +9,7 @@ interface BookmarkItemProps {
|
|
|
9
9
|
}
|
|
10
10
|
declare const _default: import("react").NamedExoticComponent<BookmarkItemProps>;
|
|
11
11
|
export default _default;
|
|
12
|
-
export declare const BookmarkItemButton: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<BaseButtonProps & import("react").RefAttributes<HTMLButtonElement>>, import("styled-components").DefaultTheme, BaseButtonProps & {
|
|
12
|
+
export declare const BookmarkItemButton: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<BaseButtonProps & import("react").HTMLAttributes<HTMLButtonElement> & import("react").RefAttributes<HTMLButtonElement>>, import("styled-components").DefaultTheme, BaseButtonProps & {
|
|
13
13
|
isRenaming?: boolean;
|
|
14
14
|
}, never>;
|
|
15
15
|
export declare const BookmarkItemButtonContent: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
|
-
import { CategorizedBookmarkSearchResults } from '../../../../../common/src/utils/bookmarks';
|
|
3
2
|
import { BookmarkNode } from '../../../../../common/src/api/pages/shapes';
|
|
3
|
+
import { CategorizedBookmarkSearchResults } from './utils';
|
|
4
4
|
interface BookmarksResultsProps {
|
|
5
5
|
currentFolder: BookmarkNode;
|
|
6
6
|
bookmarksList: BookmarkNode[];
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { MouseEvent } from 'react';
|
|
2
|
+
import { BookmarkNode } from '../../../../../common/src/api/pages/shapes';
|
|
3
|
+
/**
|
|
4
|
+
* Custom hook that returns function to handle navigation for a click on a bookmark item.
|
|
5
|
+
*
|
|
6
|
+
* @returns {Function} Function to handle bookmark navigation click.
|
|
7
|
+
*/
|
|
8
|
+
export declare const useBookmarkNavigation: () => (bookmark: BookmarkNode, event: MouseEvent<HTMLButtonElement>) => Promise<void>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { CategorizedBookmarkSearchResults } from '../../../../../common/src/utils/bookmarks';
|
|
2
1
|
import { BookmarkNode } from '../../../../../common/src/api/pages/shapes';
|
|
2
|
+
import { CategorizedBookmarkSearchResults } from './utils';
|
|
3
3
|
/**
|
|
4
4
|
* Custom hook that manages and sorts bookmark search results and returns an object of categorized bookmarks
|
|
5
5
|
* and actions to update the search query.
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { BookmarkNode } from '../../../../../common/src/api/pages/shapes';
|
|
2
|
+
export type CategorizedBookmarkSearchResults = {
|
|
3
|
+
bookmarksInFolder: BookmarkNode[];
|
|
4
|
+
bookmarksOutsideFolder: BookmarkNode[];
|
|
5
|
+
};
|
|
6
|
+
export declare const renderBookmarkNodeTitle: (title: string) => string;
|
|
7
|
+
export declare const categorizeSearchResults: (bookmarks: BookmarkNode[], folderId: string) => CategorizedBookmarkSearchResults;
|
|
@@ -1,6 +1,4 @@
|
|
|
1
|
-
import
|
|
2
|
-
import { CompanionDockConfig, WorkspacePlatformInitConfig } from '../shapes';
|
|
3
|
-
export declare function initDockCompanion(config: CompanionDockConfig, platform: OpenFin.Platform): Promise<void>;
|
|
1
|
+
import type { WorkspacePlatformInitConfig } from '../shapes';
|
|
4
2
|
/**
|
|
5
3
|
* Initilaize a Workspace Platform.
|
|
6
4
|
*
|
|
@@ -36,4 +34,4 @@ export declare function initDockCompanion(config: CompanionDockConfig, platform:
|
|
|
36
34
|
* ```
|
|
37
35
|
* @param options options for configuring the platform.
|
|
38
36
|
*/
|
|
39
|
-
export declare const init: ({ theme, customActions, language, ...rest }: WorkspacePlatformInitConfig) => Promise<
|
|
37
|
+
export declare const init: ({ theme, customActions, language, ...rest }: WorkspacePlatformInitConfig) => Promise<void>;
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
import type OpenFin from '@openfin/core';
|
|
2
2
|
import { IconProps, Languages } from '@openfin/ui-library';
|
|
3
3
|
import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/utils/usage-register';
|
|
4
|
-
import {
|
|
5
|
-
import { BaseCustomDropdownItem, CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
|
|
4
|
+
import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
|
|
6
5
|
import { Resource } from '../../common/src/api/i18next';
|
|
7
6
|
import { TrackedSite } from '../../common/src/api/pages/idb';
|
|
8
7
|
import { AddDefaultPagePayload, AttachedPage, BookmarkNode, CopyPagePayload, CreateBookmarkNodeRequest, HandlePagesAndWindowClosePayload, HandlePagesAndWindowCloseResult, HandleSaveModalOnPageClosePayload, Page, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult, ShouldPageClosePayload, ShouldPageCloseResult, UpdateBookmarkNodeRequest, ViewsPreventingUnloadPayload } from '../../common/src/api/pages/shapes';
|
|
9
8
|
import { SetActivePageForWindowPayload } from '../../common/src/api/pages/shapes';
|
|
10
9
|
import { NotificationsCustomManifestOptions } from '../../common/src/api/shapes/notifications';
|
|
11
10
|
import type { CustomThemes } from '../../common/src/api/theming';
|
|
12
|
-
import { App, DockProviderConfigWithIdentity, StoreButtonConfig
|
|
11
|
+
import type { App, DockProviderConfigWithIdentity, StoreButtonConfig } from '../../client-api/src/shapes';
|
|
13
12
|
import type { WorkflowIntegration } from '../../client-api/src/shapes/integrations';
|
|
14
13
|
export { AppManifestType } from '../../client-api/src/shapes';
|
|
15
14
|
export type { App, AppIntent, Image } from '../../client-api/src/shapes';
|
|
@@ -199,7 +198,7 @@ export type EnterpriseMainContextMenuItemTemplate = OpenFin.MenuItemTemplate<Ent
|
|
|
199
198
|
/** @internal */
|
|
200
199
|
export interface BookmarkItemContextMenuItemData extends ContextMenuItemData {
|
|
201
200
|
type: BookmarkItemContextMenuOptionType;
|
|
202
|
-
|
|
201
|
+
parentId?: string;
|
|
203
202
|
}
|
|
204
203
|
/** @internal */
|
|
205
204
|
export type BookmarkItemContextMenuItemTemplate = OpenFin.MenuItemTemplate<BookmarkItemContextMenuItemData>;
|
|
@@ -1061,14 +1060,6 @@ export interface BrowserWindowModule {
|
|
|
1061
1060
|
_addPage(page: PageWithUpdatableRuntimeAttribs, opts?: {
|
|
1062
1061
|
index?: number;
|
|
1063
1062
|
}): Promise<void>;
|
|
1064
|
-
/**
|
|
1065
|
-
* Internal implementation to retrieve selected view ids from available layouts in a browser window instances
|
|
1066
|
-
*/
|
|
1067
|
-
_getLayoutsWithSelectedViews(): Promise<Array<{
|
|
1068
|
-
layoutContainerKey: string;
|
|
1069
|
-
isActive: boolean;
|
|
1070
|
-
selectedViews: OpenFin.Identity[];
|
|
1071
|
-
}>>;
|
|
1072
1063
|
/**
|
|
1073
1064
|
* Internal implementation that supports adding at a specific index
|
|
1074
1065
|
* @param req the reparent page request.
|
|
@@ -1374,7 +1365,7 @@ export interface BrowserWindowFactory {
|
|
|
1374
1365
|
* const windowIdentity = await workspacePlatform.Browser.getLastFocusedWindow();
|
|
1375
1366
|
* ```
|
|
1376
1367
|
*/
|
|
1377
|
-
getLastFocusedWindow(): Promise<OpenFin.Identity
|
|
1368
|
+
getLastFocusedWindow(): Promise<OpenFin.Identity>;
|
|
1378
1369
|
}
|
|
1379
1370
|
/**
|
|
1380
1371
|
* API for interacting with persistent storage.
|
|
@@ -1797,44 +1788,6 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
|
|
|
1797
1788
|
* @internal
|
|
1798
1789
|
*/
|
|
1799
1790
|
_refreshBookmarksInternal(): Promise<void>;
|
|
1800
|
-
/**
|
|
1801
|
-
* Launches a bookmark in the browser window.
|
|
1802
|
-
* @param payload
|
|
1803
|
-
*/
|
|
1804
|
-
_launchBookmarkInternal: (payload: LaunchBookmarkPayload) => Promise<void>;
|
|
1805
|
-
/**
|
|
1806
|
-
* Updates companion dock favorites list.
|
|
1807
|
-
* @param favorites
|
|
1808
|
-
*/
|
|
1809
|
-
_updateDockFavoritesInternal: (favorites: DockEntry[]) => Promise<void>;
|
|
1810
|
-
/**
|
|
1811
|
-
* Updates companion dock content menu.
|
|
1812
|
-
* @param contentMenu
|
|
1813
|
-
*/
|
|
1814
|
-
_updateContentMenuInternal: (contentMenu: ContentMenuEntry[]) => Promise<void>;
|
|
1815
|
-
/**
|
|
1816
|
-
* Launches companion dock content menu item.
|
|
1817
|
-
* @param id
|
|
1818
|
-
*/
|
|
1819
|
-
_launchDockEntryInternal: (entry: DockEntry) => Promise<void>;
|
|
1820
|
-
_setDockFavoritesInternal: (favorites: DockEntry[]) => Promise<void>;
|
|
1821
|
-
_setDockWorkspaceButtonsOrderInternal: (favorites: WorkspacePanelButton[]) => Promise<void>;
|
|
1822
|
-
_removeDockFavoriteInternal: (entry: DockEntry) => Promise<void>;
|
|
1823
|
-
_addDockFavoriteInternal: (entry: DockEntry) => Promise<void>;
|
|
1824
|
-
/**
|
|
1825
|
-
* Navigates companion dock content menu to a specified folder.
|
|
1826
|
-
* @param id
|
|
1827
|
-
*/
|
|
1828
|
-
_navigateContentMenuInternal(id: string): Promise<void>;
|
|
1829
|
-
/**
|
|
1830
|
-
* Retrieves companion dock workspaces dropdown context menu.
|
|
1831
|
-
*/
|
|
1832
|
-
_openDockWorkspacesContextMenuInternal(): Promise<BaseCustomDropdownItem[]>;
|
|
1833
|
-
/**
|
|
1834
|
-
* Handles companion dock workspaces dropdown context menu response.
|
|
1835
|
-
* @param payload
|
|
1836
|
-
*/
|
|
1837
|
-
_handleDockWorkspacesMenuResponseInternal(payload: any): Promise<void>;
|
|
1838
1791
|
/**
|
|
1839
1792
|
* The browser window factory for the Workspace Platform.
|
|
1840
1793
|
*/
|
|
@@ -2088,24 +2041,6 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
|
|
|
2088
2041
|
handleRequestNavigationInternal(req: NavigationRequest): Promise<void>;
|
|
2089
2042
|
/** @internal */
|
|
2090
2043
|
refreshBookmarksInternal(): Promise<void>;
|
|
2091
|
-
/** @internal */
|
|
2092
|
-
launchBookmarkInternal(payload: LaunchBookmarkPayload): Promise<void>;
|
|
2093
|
-
/** @internal */
|
|
2094
|
-
updateDockFavoritesInternal(favorites: DockEntry[]): Promise<void>;
|
|
2095
|
-
/** @internal */
|
|
2096
|
-
updateContentMenuInternal(contentMenu: ContentMenuEntry[]): Promise<void>;
|
|
2097
|
-
/** @internal */
|
|
2098
|
-
launchDockEntryInternal(entry: DockEntry): Promise<void>;
|
|
2099
|
-
/** @internal */
|
|
2100
|
-
setDockWorkspaceButtonsOrderInternal(workspaceButtons: WorkspacePanelButton[]): Promise<void>;
|
|
2101
|
-
/** @internal */
|
|
2102
|
-
setDockFavoritesOrderInternal(favorites: DockEntry[]): Promise<void>;
|
|
2103
|
-
/** @internal */
|
|
2104
|
-
navigateContentMenuInternal(id: string): Promise<void>;
|
|
2105
|
-
/** @internal */
|
|
2106
|
-
getDockWorkspacesContextMenuInternal(): Promise<BaseCustomDropdownItem[]>;
|
|
2107
|
-
/** @internal */
|
|
2108
|
-
handleDockWorkspacesMenuResponseInternal(payload: any): Promise<void>;
|
|
2109
2044
|
}
|
|
2110
2045
|
/**
|
|
2111
2046
|
* The origins from which a custom action can be invoked
|
|
@@ -2372,29 +2307,6 @@ export interface WorkspacePlatformInitConfig {
|
|
|
2372
2307
|
*/
|
|
2373
2308
|
workspaceAsar?: WorkspaceAsarAssetConfig | WorkspaceAsarPathConfig;
|
|
2374
2309
|
}
|
|
2375
|
-
/**
|
|
2376
|
-
* @internal
|
|
2377
|
-
*/
|
|
2378
|
-
export interface CompanionDockConfig {
|
|
2379
|
-
/**
|
|
2380
|
-
* Companion dock window position
|
|
2381
|
-
*/
|
|
2382
|
-
dockPosition?: Point;
|
|
2383
|
-
/**
|
|
2384
|
-
* Favorites to be displayed in the dock
|
|
2385
|
-
*/
|
|
2386
|
-
favorites?: DockEntry[];
|
|
2387
|
-
/**
|
|
2388
|
-
* Favorites to be displayed in the dock
|
|
2389
|
-
*/
|
|
2390
|
-
contentMenu?: ContentMenuEntry[];
|
|
2391
|
-
workspacePanelButtons?: WorkspacePanelButton[];
|
|
2392
|
-
/**
|
|
2393
|
-
* Taskbar Icon for the Browser Window. If light and dark icon are defined, then the taskbar icon will change when the scheme changes.
|
|
2394
|
-
*/
|
|
2395
|
-
icon?: string | TaskbarIcon;
|
|
2396
|
-
title?: string;
|
|
2397
|
-
}
|
|
2398
2310
|
/**
|
|
2399
2311
|
* Extend or replace default functionality in order to customize behavior of a Workspace Platform Provider.
|
|
2400
2312
|
*
|
|
@@ -2530,40 +2442,6 @@ export type WorkspacePlatformOverrideCallback = OpenFin.OverrideCallback<Workspa
|
|
|
2530
2442
|
* @deprecated
|
|
2531
2443
|
*/
|
|
2532
2444
|
export type BrowserOverrideCallback = WorkspacePlatformOverrideCallback;
|
|
2533
|
-
export type WorkspacePanelButton = Exclude<WorkspaceButton, 'store'> | 'contentMenu';
|
|
2534
|
-
/**
|
|
2535
|
-
* Content menu entry shape cloned and re-exported from UI Library.
|
|
2536
|
-
* @internal
|
|
2537
|
-
*/
|
|
2538
|
-
export type ContentMenuEntry = {
|
|
2539
|
-
bookmarked?: boolean;
|
|
2540
|
-
} & ({
|
|
2541
|
-
type: 'folder';
|
|
2542
|
-
id: string;
|
|
2543
|
-
label: string;
|
|
2544
|
-
children: ContentMenuEntry[];
|
|
2545
|
-
} | {
|
|
2546
|
-
type: 'item';
|
|
2547
|
-
id: string;
|
|
2548
|
-
icon: string;
|
|
2549
|
-
label: string;
|
|
2550
|
-
itemData: any;
|
|
2551
|
-
});
|
|
2552
|
-
/**
|
|
2553
|
-
* Represents dock entry for favorites
|
|
2554
|
-
* @internal
|
|
2555
|
-
*/
|
|
2556
|
-
export type DockEntry = {
|
|
2557
|
-
type: 'folder';
|
|
2558
|
-
id: string;
|
|
2559
|
-
label: string;
|
|
2560
|
-
} | {
|
|
2561
|
-
type: 'item';
|
|
2562
|
-
id: string;
|
|
2563
|
-
icon: string;
|
|
2564
|
-
label: string;
|
|
2565
|
-
itemData?: any;
|
|
2566
|
-
};
|
|
2567
2445
|
/**
|
|
2568
2446
|
* Configuration for initializing a Browser.
|
|
2569
2447
|
*/
|
|
@@ -2649,50 +2527,3 @@ export type TaskbarIcon = {
|
|
|
2649
2527
|
dark: string;
|
|
2650
2528
|
light: string;
|
|
2651
2529
|
};
|
|
2652
|
-
/**
|
|
2653
|
-
* Launch bookmark request payload
|
|
2654
|
-
*/
|
|
2655
|
-
export interface LaunchBookmarkPayload {
|
|
2656
|
-
bookmark: BookmarkNode;
|
|
2657
|
-
sourceIdentity: OpenFin.Identity;
|
|
2658
|
-
sourceEvent: Pick<MouseEvent, 'ctrlKey' | 'metaKey' | 'shiftKey'>;
|
|
2659
|
-
}
|
|
2660
|
-
/**
|
|
2661
|
-
* These are channel actions registered by the platform.
|
|
2662
|
-
*
|
|
2663
|
-
* @internal
|
|
2664
|
-
*/
|
|
2665
|
-
type EnterpriseDockChannelProviderChannelActions = {
|
|
2666
|
-
'launch-entry': (entry: DockEntry) => void;
|
|
2667
|
-
'set-dock-favorites-order': (newFavorites: DockEntry[]) => void;
|
|
2668
|
-
'set-dock-workspace-buttons-order': (newFavorites: WorkspacePanelButton[]) => void;
|
|
2669
|
-
'get-dock-workspaces-context-menu': () => BaseCustomDropdownItem[];
|
|
2670
|
-
'handle-dock-workspaces-menu-response': (payload: any) => void;
|
|
2671
|
-
'remove-favorite-entry': (entry: DockEntry) => void;
|
|
2672
|
-
'add-favorite-entry': (entry: DockEntry) => void;
|
|
2673
|
-
};
|
|
2674
|
-
/**
|
|
2675
|
-
* These are channel actions registered by the client (enterprise dock)
|
|
2676
|
-
* @internal
|
|
2677
|
-
*/
|
|
2678
|
-
type EnterpriseDockChannelClientChannelActions = {
|
|
2679
|
-
'update-favorite-entries': () => void;
|
|
2680
|
-
'update-content-menu': () => void;
|
|
2681
|
-
'navigate-content-menu': () => void;
|
|
2682
|
-
};
|
|
2683
|
-
/**
|
|
2684
|
-
* Used by Enterprise Dock for communication with the platform.
|
|
2685
|
-
* @internal
|
|
2686
|
-
*/
|
|
2687
|
-
export interface EnterpriseDockChannelClient extends Omit<OpenFin.ChannelClient, 'dispatch' | 'register'> {
|
|
2688
|
-
dispatch: <T extends keyof EnterpriseDockChannelProviderChannelActions>(action: T, payload: Parameters<EnterpriseDockChannelProviderChannelActions[T]>[0]) => Promise<Awaited<ReturnType<EnterpriseDockChannelProviderChannelActions[T]>>>;
|
|
2689
|
-
register: <T extends keyof EnterpriseDockChannelClientChannelActions>(action: T, handler: (payload: Parameters<EnterpriseDockChannelClientChannelActions[T]>[0], id: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<Awaited<ReturnType<EnterpriseDockChannelClientChannelActions[T]>>>) => boolean;
|
|
2690
|
-
}
|
|
2691
|
-
/**
|
|
2692
|
-
* Used by the platform for communication with Enterprise Dock.
|
|
2693
|
-
* @internal
|
|
2694
|
-
*/
|
|
2695
|
-
export interface EnterpriseDockChannelProvider extends Omit<OpenFin.ChannelProvider, 'dispatch' | 'register'> {
|
|
2696
|
-
dispatch: <T extends keyof EnterpriseDockChannelClientChannelActions>(to: OpenFin.ClientIdentity, action: T, payload: Parameters<EnterpriseDockChannelClientChannelActions[T]>[0]) => Promise<Awaited<ReturnType<EnterpriseDockChannelClientChannelActions[T]>>>;
|
|
2697
|
-
register: <T extends keyof EnterpriseDockChannelProviderChannelActions>(action: T, handler: (payload: Parameters<EnterpriseDockChannelProviderChannelActions[T]>[0], id: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<Awaited<ReturnType<EnterpriseDockChannelProviderChannelActions[T]>>>) => boolean;
|
|
2698
|
-
}
|
|
@@ -3,7 +3,6 @@ export declare const getWindowChannelId: (identity: OpenFin.Identity, prefix?: s
|
|
|
3
3
|
export interface ChannelClient extends OpenFin.ChannelClient {
|
|
4
4
|
dispatch: (action: (typeof BrowserChannelAction)[keyof BrowserChannelAction], payload?: any) => Promise<any>;
|
|
5
5
|
}
|
|
6
|
-
export declare const getNamedChannelClient: (channelName: string) => Promise<ChannelClient>;
|
|
7
6
|
export declare const getChannelClient: (identity: OpenFin.Identity, prefix?: string) => Promise<ChannelClient>;
|
|
8
7
|
/**
|
|
9
8
|
* If the browser window is reloaded too quickly, runtime will
|
|
@@ -34,8 +33,7 @@ declare enum GeneralBrowserChannelActions {
|
|
|
34
33
|
SetSelectedScheme = "set-selected-scheme",
|
|
35
34
|
ShowBrowserIndicator = "show-browser-indicator",
|
|
36
35
|
SetSelectedLanguage = "set-selected-language",
|
|
37
|
-
RefreshBookmarksInternal = "refresh-bookmarks"
|
|
38
|
-
GetLayoutsWithSelectedViewsInternal = "get-layouts-with-selected-views"
|
|
36
|
+
RefreshBookmarksInternal = "refresh-bookmarks"
|
|
39
37
|
}
|
|
40
38
|
/**
|
|
41
39
|
* All of the remote procedures that can be called in the
|
|
@@ -72,15 +70,7 @@ export declare enum EnterpriseBookmarkChannelAction {
|
|
|
72
70
|
UpdateBookmarkNode = "update-bookmark-node",
|
|
73
71
|
DeleteBookmarkNode = "delete-bookmark-node"
|
|
74
72
|
}
|
|
75
|
-
export declare enum CompanionDockChannelAction {
|
|
76
|
-
UpdateFavoriteEntries = "update-favorite-entries",
|
|
77
|
-
UpdateContentMenu = "update-content-menu",
|
|
78
|
-
NavigateContentMenu = "navigate-content-menu"
|
|
79
|
-
}
|
|
80
73
|
export declare const BrowserChannelAction: {
|
|
81
|
-
UpdateFavoriteEntries: CompanionDockChannelAction.UpdateFavoriteEntries;
|
|
82
|
-
UpdateContentMenu: CompanionDockChannelAction.UpdateContentMenu;
|
|
83
|
-
NavigateContentMenu: CompanionDockChannelAction.NavigateContentMenu;
|
|
84
74
|
GetPages: PageChannelAction.GetPages;
|
|
85
75
|
GetActivePageForWindow: PageChannelAction.GetActivePageForWindow;
|
|
86
76
|
AttachPagesToWindow: PageChannelAction.AttachPagesToWindow;
|
|
@@ -103,7 +93,6 @@ export declare const BrowserChannelAction: {
|
|
|
103
93
|
ShowBrowserIndicator: GeneralBrowserChannelActions.ShowBrowserIndicator;
|
|
104
94
|
SetSelectedLanguage: GeneralBrowserChannelActions.SetSelectedLanguage;
|
|
105
95
|
RefreshBookmarksInternal: GeneralBrowserChannelActions.RefreshBookmarksInternal;
|
|
106
|
-
GetLayoutsWithSelectedViewsInternal: GeneralBrowserChannelActions.GetLayoutsWithSelectedViewsInternal;
|
|
107
96
|
};
|
|
108
97
|
export type BrowserChannelAction = typeof BrowserChannelAction;
|
|
109
98
|
export {};
|
|
@@ -73,18 +73,7 @@ export declare enum WorkspacePlatformChannelAction {
|
|
|
73
73
|
GetCuratedContentInternal = "getCuratedContentInternal",
|
|
74
74
|
HandleRequestNavigationInternal = "handleRequestNavigationInternal",
|
|
75
75
|
RefreshBookmarksInternal = "refreshBookmarksInternal",
|
|
76
|
-
|
|
77
|
-
GetNotificationsConfig = "getNotificationsConfig",
|
|
78
|
-
UpdateDockFavoritesInternal = "updateDockFavoritesInternal",
|
|
79
|
-
UpdateContentMenuInternal = "updateContentMenuInternal",
|
|
80
|
-
LaunchDockEntryInternal = "launchDockEntryInternal",
|
|
81
|
-
SetDockFavoritesOrderInternal = "setDockFavoritesOrderInternal",
|
|
82
|
-
NavigateContentMenuInternal = "navigateContentMenuInternal",
|
|
83
|
-
SetDockWorkspaceButtonsOrderInternal = "setDockWorkspaceButtonsOrderInternal",
|
|
84
|
-
GetDockWorkspacesContextMenuInternal = "getDockWorkspacesContextMenuInternal",
|
|
85
|
-
HandleDockWorkspacesMenuResponseInternal = "handleDockWorkspacesMenuResponseInternal",
|
|
86
|
-
RemoveDockFavoriteInternal = "removeDockFavoriteInternal",
|
|
87
|
-
AddDockFavoriteInternal = "addDockFavoriteInternal"
|
|
76
|
+
GetNotificationsConfig = "getNotificationsConfig"
|
|
88
77
|
}
|
|
89
78
|
export type PlatFormSupportedFeatures = boolean | {
|
|
90
79
|
isWorkspacePlatform: boolean;
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import type { DefaultTheme } from 'styled-components';
|
|
2
2
|
import type OpenFin from '@openfin/core';
|
|
3
3
|
import { ColorSchemeType, ThemeSet } from '@openfin/ui-library';
|
|
4
|
-
import { Palette } from '@openfin/ui-library';
|
|
5
4
|
import { ColorSchemeOptionType } from '../../../client-api-platform/src/shapes';
|
|
6
5
|
export type WorkspaceComponentSetSelectedSchemePayload = {
|
|
7
6
|
newScheme: ColorSchemeOptionType;
|
|
@@ -18,24 +17,10 @@ export interface WorkspaceThemeSet extends ThemeSet {
|
|
|
18
17
|
light: ThemeExtension;
|
|
19
18
|
dark: ThemeExtension;
|
|
20
19
|
}
|
|
21
|
-
interface EnterpriseBrandIcons {
|
|
22
|
-
/**
|
|
23
|
-
* @internal
|
|
24
|
-
* Internal brand options for Enterprise Browser
|
|
25
|
-
*/
|
|
26
|
-
symbol: string;
|
|
27
|
-
}
|
|
28
20
|
export interface ThemeExtension extends DefaultTheme {
|
|
29
21
|
notificationIndicatorColors?: Record<string, Omit<NotificationIndicatorColorsSet, 'foreground'> & {
|
|
30
22
|
foreground: string;
|
|
31
23
|
}>;
|
|
32
|
-
/**
|
|
33
|
-
* @internal
|
|
34
|
-
* Internal brand options for Enterprise Browser
|
|
35
|
-
*/
|
|
36
|
-
brand: {
|
|
37
|
-
icons: EnterpriseBrandIcons;
|
|
38
|
-
};
|
|
39
24
|
}
|
|
40
25
|
export interface NotificationIndicatorColorsSet {
|
|
41
26
|
background: string;
|
|
@@ -53,18 +38,8 @@ export type NotificationIndicatorColorsWithScheme = Record<string, NotificationI
|
|
|
53
38
|
export interface BaseThemeOptions {
|
|
54
39
|
label: string;
|
|
55
40
|
logoUrl?: string;
|
|
56
|
-
/**
|
|
57
|
-
* @internal
|
|
58
|
-
* Internal brand options for Enterprise Browser
|
|
59
|
-
*/
|
|
60
|
-
brand?: {
|
|
61
|
-
icons?: {
|
|
62
|
-
dark?: EnterpriseBrandIcons;
|
|
63
|
-
light?: EnterpriseBrandIcons;
|
|
64
|
-
};
|
|
65
|
-
};
|
|
66
41
|
}
|
|
67
|
-
export
|
|
42
|
+
export interface CustomThemeOptions extends BaseThemeOptions {
|
|
68
43
|
palette: CustomPaletteSet;
|
|
69
44
|
/**
|
|
70
45
|
* NOTE: Only used in Notifications
|
|
@@ -90,8 +65,8 @@ export type CustomThemeOptions = BaseThemeOptions & {
|
|
|
90
65
|
* ```
|
|
91
66
|
*/
|
|
92
67
|
notificationIndicatorColors?: Record<string, NotificationIndicatorColorsSet>;
|
|
93
|
-
}
|
|
94
|
-
export
|
|
68
|
+
}
|
|
69
|
+
export interface CustomThemeOptionsWithScheme extends BaseThemeOptions {
|
|
95
70
|
/**
|
|
96
71
|
* The default color scheme for this theme.
|
|
97
72
|
*
|
|
@@ -144,7 +119,7 @@ export type CustomThemeOptionsWithScheme = BaseThemeOptions & {
|
|
|
144
119
|
* ```
|
|
145
120
|
*/
|
|
146
121
|
notificationIndicatorColors?: NotificationIndicatorColorsWithScheme;
|
|
147
|
-
}
|
|
122
|
+
}
|
|
148
123
|
export type CustomThemes = (CustomThemeOptions | CustomThemeOptionsWithScheme)[];
|
|
149
124
|
export interface PreloadedThemeData {
|
|
150
125
|
themes: CustomThemes;
|
|
@@ -272,5 +247,3 @@ export declare const computeThemes: (customThemes: CustomThemes, storedScheme?:
|
|
|
272
247
|
export declare const getComputedPlatformTheme: (platformIdentity: OpenFin.Identity) => Promise<ComputedTheme>;
|
|
273
248
|
export declare const setSelectedScheme: (ctx: ColorSchemeOptionType) => Promise<void>;
|
|
274
249
|
export declare const getComputedScheme: (identity?: OpenFin.Identity) => Promise<Exclude<ColorSchemeType, 'system'>>;
|
|
275
|
-
export declare const getComputedBackgroundColor: (paletteKey: keyof typeof Palette, defaultColor?: string) => Promise<string>;
|
|
276
|
-
export {};
|
|
@@ -45,5 +45,5 @@ type EventTypeTypes = {
|
|
|
45
45
|
*/
|
|
46
46
|
'component-navigation': [NavigatePayload];
|
|
47
47
|
};
|
|
48
|
-
export declare const addListener: <EventKey extends keyof EventTypeTypes>(event: EventKey, listener: (...payload: EventTypeTypes[EventKey]) => void) => void, removeListener: <EventKey extends keyof EventTypeTypes>(event: EventKey, listener: (...payload: EventTypeTypes[EventKey]) => void) => void,
|
|
48
|
+
export declare const addListener: <EventKey extends keyof EventTypeTypes>(event: EventKey, listener: (...payload: EventTypeTypes[EventKey]) => void) => void, removeListener: <EventKey extends keyof EventTypeTypes>(event: EventKey, listener: (...payload: EventTypeTypes[EventKey]) => void) => void, emit: <EventKey extends keyof EventTypeTypes>(event: EventKey, ...payload: EventTypeTypes[EventKey]) => Promise<void>;
|
|
49
49
|
export {};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { SizeType } from '@openfin/ui-library';
|
|
3
|
-
export interface
|
|
3
|
+
export interface Props {
|
|
4
4
|
/**
|
|
5
5
|
* Icon to be shown for the control.
|
|
6
6
|
*
|
|
@@ -26,6 +26,8 @@ export interface BaseButtonProps extends React.HTMLAttributes<HTMLButtonElement>
|
|
|
26
26
|
disabled?: boolean;
|
|
27
27
|
/** Button selected state. Can be used to implement sticky buttons. */
|
|
28
28
|
selected?: boolean;
|
|
29
|
+
/** Use wide button */
|
|
30
|
+
wide?: boolean;
|
|
29
31
|
/** Disable hover/active background-color change */
|
|
30
32
|
hoverless?: boolean;
|
|
31
33
|
/** If not set, svgs in the button will be forced to 13px */
|
|
@@ -49,5 +51,5 @@ export interface BaseButtonProps extends React.HTMLAttributes<HTMLButtonElement>
|
|
|
49
51
|
*
|
|
50
52
|
* Note: This relies on global CSS and is written to run within the context of the Browser window which contains these globals.
|
|
51
53
|
*/
|
|
52
|
-
declare const BaseButton: React.ForwardRefExoticComponent<
|
|
54
|
+
declare const BaseButton: React.ForwardRefExoticComponent<Props & React.HTMLAttributes<HTMLButtonElement> & React.RefAttributes<HTMLButtonElement>>;
|
|
53
55
|
export default BaseButton;
|
|
@@ -1,8 +1,3 @@
|
|
|
1
1
|
import { OpenFin } from '@openfin/core';
|
|
2
2
|
import { BookmarkItemContextMenuItemTemplate } from '../../../client-api-platform/src/shapes';
|
|
3
|
-
import { BookmarkFolder } from './bookmarks';
|
|
4
|
-
export declare const getSortedBookmarkFoldersContextMenuOptions: (bookmarkFolders: BookmarkFolder[], checkedNodeId: string, separators?: {
|
|
5
|
-
afterAllBookmarks?: boolean;
|
|
6
|
-
afterFavorites?: boolean;
|
|
7
|
-
}) => BookmarkItemContextMenuItemTemplate[];
|
|
8
3
|
export declare const getBookmarkItemContextMenuTemplate: (callerIdentity: OpenFin.Identity, bookmarkId: string) => Promise<BookmarkItemContextMenuItemTemplate[]>;
|
|
@@ -5,12 +5,8 @@ export type BookmarkFolder = {
|
|
|
5
5
|
id: string;
|
|
6
6
|
title: string;
|
|
7
7
|
};
|
|
8
|
-
export type CategorizedBookmarkSearchResults = {
|
|
9
|
-
bookmarksInFolder: BookmarkNode[];
|
|
10
|
-
bookmarksOutsideFolder: BookmarkNode[];
|
|
11
|
-
};
|
|
12
|
-
export declare const getBookmarkNodeTitle: (title: string) => string;
|
|
13
|
-
export declare const categorizeSearchResults: (bookmarks: BookmarkNode[], folderId: string) => CategorizedBookmarkSearchResults;
|
|
14
8
|
export declare const sortBookmarks: (a: BookmarkNode, b: BookmarkNode) => number;
|
|
15
|
-
export declare const collectFolders: (nodes: BookmarkNode
|
|
9
|
+
export declare const collectFolders: (nodes: Array<BookmarkNode>) => Array<BookmarkFolder>;
|
|
10
|
+
export declare const collectFoldersExcludingBuiltin: (nodes: Array<BookmarkNode>) => Array<BookmarkFolder>;
|
|
11
|
+
export declare const prioritizeFolders: (folders: Array<BookmarkFolder>) => Array<BookmarkFolder>;
|
|
16
12
|
export declare const getBookmarkFoldersList: (rootNode: BookmarkNode) => BookmarkFolder[];
|
|
@@ -18,7 +18,6 @@ export interface ModalResponseEvent {
|
|
|
18
18
|
export declare const menuEvents: {
|
|
19
19
|
emit: <EventKey extends keyof MenuEventTypes>(event: EventKey, ...payload: MenuEventTypes[EventKey]) => Promise<void>;
|
|
20
20
|
addListener: <EventKey_1 extends keyof MenuEventTypes>(event: EventKey_1, listener: (...payload: MenuEventTypes[EventKey_1]) => void) => void;
|
|
21
|
-
addListenerWithUUID: (uuid: string) => <EventKey_1 extends keyof MenuEventTypes>(event: EventKey_1, listener: (...payload: MenuEventTypes[EventKey_1]) => void) => void;
|
|
22
21
|
removeListener: <EventKey_2 extends keyof MenuEventTypes>(event: EventKey_2, listener: (...payload: MenuEventTypes[EventKey_2]) => void) => void;
|
|
23
22
|
once: <EventKey_3 extends keyof MenuEventTypes>(event: EventKey_3, listener: (...payload: MenuEventTypes[EventKey_3]) => void) => void;
|
|
24
23
|
};
|
|
@@ -1,12 +1,5 @@
|
|
|
1
1
|
import type OpenFin from '@openfin/core';
|
|
2
2
|
import { ResponseModalConfig } from './menu-config';
|
|
3
|
-
import { Point } from './window';
|
|
4
|
-
/**
|
|
5
|
-
*
|
|
6
|
-
* @param parentWindowIdentity parent window for the modal
|
|
7
|
-
* @returns a point (top/left) that represents the center of the monitor the parent window is on
|
|
8
|
-
*/
|
|
9
|
-
export declare const getCenterOfParentWindowMonitor: (parentWindowIdentity?: OpenFin.Identity) => Promise<Point>;
|
|
10
3
|
/**
|
|
11
4
|
* returns the correct bounds for the response modal to be displayed at
|
|
12
5
|
* this will return the correct bounds regardless of whether the window is maximized
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type OpenFin from '@openfin/core';
|
|
2
|
+
import { BookmarkFolder } from '../../../common/src/utils/bookmarks';
|
|
2
3
|
import { UserMenuParams } from '../../../common/src/utils/menu';
|
|
3
4
|
import { OptionalExceptFor } from '../../../common/src/utils/types';
|
|
4
5
|
import { AnchorBehavior } from '../../../client-api-platform/src/api/context-menu';
|
|
@@ -52,14 +53,16 @@ export type BookmarkButtonPayload = {
|
|
|
52
53
|
export type ContextMenuChannelMessageData = {
|
|
53
54
|
parentIdentity: OpenFin.Identity;
|
|
54
55
|
responseIdentity: OpenFin.Identity;
|
|
56
|
+
anchorBehavior: AnchorBehavior;
|
|
55
57
|
type: ContextMenuType;
|
|
56
58
|
x: number;
|
|
57
59
|
y: number;
|
|
58
|
-
|
|
59
|
-
payload: (OpenFin.ShowPopupMenuOptions | {
|
|
60
|
+
payload: OpenFin.ShowPopupMenuOptions | {
|
|
60
61
|
pageId: string;
|
|
61
|
-
} | BookmarkButtonPayload
|
|
62
|
-
|
|
62
|
+
} | BookmarkButtonPayload | {
|
|
63
|
+
dropdownOptions: Array<BookmarkFolder>;
|
|
64
|
+
width: number;
|
|
65
|
+
selected: BookmarkFolder;
|
|
63
66
|
};
|
|
64
67
|
};
|
|
65
68
|
export type SearchMenuChannelResponse = {
|
|
@@ -25,8 +25,7 @@ export declare enum PageRoute {
|
|
|
25
25
|
EnterpriseBrowser = "/browser/enterprise/",
|
|
26
26
|
EnterpriseContextMenu = "/browser/enterprise/context-menu/",
|
|
27
27
|
EnterpriseBookmarkDialog = "/browser/enterprise/bookmark-dialog/",
|
|
28
|
-
DropdownMenu = "/browser/enterprise/dropdown-menu/"
|
|
29
|
-
EnterpriseDock = "/browser/enterprise/dock/"
|
|
28
|
+
DropdownMenu = "/browser/enterprise/dropdown-menu/"
|
|
30
29
|
}
|
|
31
30
|
export declare const Assets: {
|
|
32
31
|
readonly IconOpenFinLogo: "/icons/openfinlogo.svg";
|
|
@@ -37,7 +37,7 @@ export declare function getAbsoluteRoutePath(route: PageRoute | string): string;
|
|
|
37
37
|
* The base path of the router contains the router's zone as a postfix.
|
|
38
38
|
*/
|
|
39
39
|
export declare function getBasePath(): string;
|
|
40
|
-
export declare function resolveAbsolutePath(path: string): string;
|
|
40
|
+
export declare function resolveAbsolutePath(path: string, baseUrl?: URL): string;
|
|
41
41
|
/**
|
|
42
42
|
* Gets the path to the route with the router's base path.
|
|
43
43
|
* @param route the route.
|
|
@@ -6,11 +6,6 @@ export default function makeSharedEmitter<EventMap extends {
|
|
|
6
6
|
}>(id: string): {
|
|
7
7
|
emit: <EventKey extends keyof EventMap>(event: EventKey, ...payload: EventMap[EventKey]) => Promise<void>;
|
|
8
8
|
addListener: <EventKey_1 extends keyof EventMap>(event: EventKey_1, listener: (...payload: EventMap[EventKey_1]) => void) => void;
|
|
9
|
-
/**
|
|
10
|
-
* Creates a listener for a particular UUID instead of ApplicationUUID.Workspace.
|
|
11
|
-
* @param uuid The UUID of the application to subscribe to.
|
|
12
|
-
*/
|
|
13
|
-
addListenerWithUUID: (uuid: string) => <EventKey_1 extends keyof EventMap>(event: EventKey_1, listener: (...payload: EventMap[EventKey_1]) => void) => void;
|
|
14
9
|
removeListener: <EventKey_2 extends keyof EventMap>(event: EventKey_2, listener: (...payload: EventMap[EventKey_2]) => void) => void;
|
|
15
10
|
once: <EventKey_3 extends keyof EventMap>(event: EventKey_3, listener: (...payload: EventMap[EventKey_3]) => void) => void;
|
|
16
11
|
};
|
|
@@ -13,8 +13,7 @@ export declare enum WindowName {
|
|
|
13
13
|
EnterpriseContextMenu = "openfin-enterprise-context-menu",
|
|
14
14
|
BrowserAddressSearchPrefix = "openfin-browser-menu-address-search-",
|
|
15
15
|
EnterpriseBookmarkDialogWindow = "openfin-enterprise-bookmark-dialog",
|
|
16
|
-
DropdownMenu = "openfin-enterprise-dropdown-menu"
|
|
17
|
-
DockCompanion = "openfin-dock-companion"
|
|
16
|
+
DropdownMenu = "openfin-enterprise-dropdown-menu"
|
|
18
17
|
}
|
|
19
18
|
export interface WindowIdentity {
|
|
20
19
|
uuid: ApplicationUUID | string;
|