@openfin/workspace-platform 22.5.21 → 23.0.0

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 (40) hide show
  1. package/client-api/src/integrations/microsoft.utils.d.ts +6 -6
  2. package/client-api-platform/src/api/controllers/theme-storage-controller-store.d.ts +2 -1
  3. package/client-api-platform/src/api/controllers/theme-storage-controller.d.ts +18 -4
  4. package/client-api-platform/src/api/dock.d.ts +4 -2
  5. package/client-api-platform/src/api/language.d.ts +1 -1
  6. package/client-api-platform/src/api/pages/open-pages.d.ts +2 -2
  7. package/client-api-platform/src/api/theming.d.ts +11 -0
  8. package/client-api-platform/src/api/theming.test.d.ts +1 -0
  9. package/client-api-platform/src/init/override-callback/page-defaults.d.ts +1 -1
  10. package/client-api-platform/src/init/override-callback/view-options.d.ts +1 -1
  11. package/client-api-platform/src/init/theming.d.ts +2 -1
  12. package/client-api-platform/src/shapes.d.ts +16 -12
  13. package/common/src/api/pages/idb.d.ts +2 -4
  14. package/common/src/api/protocol/browser.d.ts +8 -6
  15. package/common/src/api/protocol/shapes/workspace.d.ts +8 -0
  16. package/common/src/api/protocol/workspace-platform.d.ts +25 -23
  17. package/common/src/api/provider.d.ts +1 -1
  18. package/common/src/api/storefront.d.ts +5 -5
  19. package/common/src/api/theming.d.ts +16 -6
  20. package/common/src/utils/enterprise-menu.d.ts +1 -1
  21. package/common/src/utils/global-context-menu.d.ts +1 -1
  22. package/common/src/utils/layout.d.ts +1 -2
  23. package/common/src/utils/logger.d.ts +22 -0
  24. package/common/src/utils/menu-window-provider.d.ts +6 -6
  25. package/common/src/utils/modal-bounds.d.ts +1 -1
  26. package/common/src/utils/namespaced-local-storage.d.ts +2 -2
  27. package/common/src/utils/popup-window.d.ts +15 -0
  28. package/common/src/utils/shared-emitter.d.ts +4 -4
  29. package/common/src/utils/types.d.ts +1 -1
  30. package/common/src/utils/window.d.ts +8 -0
  31. package/common/src/utils/workspace-modals.d.ts +1 -1
  32. package/dock3/src/shapes/shapes.d.ts +9 -1
  33. package/externals.report.json +51 -0
  34. package/index.js +1486 -1
  35. package/index.js.LICENSE.txt +1 -0
  36. package/index.js.map +1 -1
  37. package/package.json +11 -3
  38. package/search-api/src/provider/remote/info.d.ts +1 -1
  39. package/search-api/src/shapes.d.ts +22 -1
  40. package/workspace_platform.zip +0 -0
@@ -36,9 +36,9 @@ export declare const MICROSOFT_365_SEARCH_RESULT_ACTIONS: {
36
36
  * @param req The user input request object from which to extract the selected filters.
37
37
  * @returns An array of CLIFilter objects representing the validated filters.
38
38
  */
39
- export declare const getValidFilters: (req: Parameters<HomeProvider['onUserInput']>[0], searchTypePossibleFilters: Set<Microsoft365DocumentType>) => CLIFilter[];
40
- export declare const getValidContactFilters: (users: MicrosoftGraphTypes.User[], req: Parameters<HomeProvider['onUserInput']>[0]) => CLIFilter[];
41
- export declare const getContactFiltersFromRequest: (req: Parameters<HomeProvider['onUserInput']>[0]) => {
39
+ export declare const getValidFilters: (req: Parameters<HomeProvider["onUserInput"]>[0], searchTypePossibleFilters: Set<Microsoft365DocumentType>) => CLIFilter[];
40
+ export declare const getValidContactFilters: (users: MicrosoftGraphTypes.User[], req: Parameters<HomeProvider["onUserInput"]>[0]) => CLIFilter[];
41
+ export declare const getContactFiltersFromRequest: (req: Parameters<HomeProvider["onUserInput"]>[0]) => {
42
42
  department: string[];
43
43
  jobTitle: string[];
44
44
  };
@@ -58,7 +58,7 @@ export declare const filterContactFromRequest: (items: MicrosoftGraphTypes.User[
58
58
  * If no types are selected or all types are deselected, the function marks all types to be shown.
59
59
  * Otherwise, it marks only the selected types to be shown.
60
60
  */
61
- export declare const getTypeFiltersFromRequest: (req: Parameters<HomeProvider['onUserInput']>[0], searchTypePossibleFilters: Set<Microsoft365DocumentType>) => {
61
+ export declare const getTypeFiltersFromRequest: (req: Parameters<HomeProvider["onUserInput"]>[0], searchTypePossibleFilters: Set<Microsoft365DocumentType>) => {
62
62
  readonly showDocuments: boolean;
63
63
  readonly showContacts: boolean;
64
64
  /** Teams Messages */
@@ -70,7 +70,7 @@ export declare const getTypeFiltersFromRequest: (req: Parameters<HomeProvider['o
70
70
  /** SharePoint Lists */
71
71
  readonly showLists: boolean;
72
72
  };
73
- export declare const getDocumentFiltersFromRequest: (req: Parameters<HomeProvider['onUserInput']>[0]) => {
73
+ export declare const getDocumentFiltersFromRequest: (req: Parameters<HomeProvider["onUserInput"]>[0]) => {
74
74
  readonly filterFiles: boolean;
75
75
  readonly showWord: boolean;
76
76
  readonly showExcel: boolean;
@@ -81,6 +81,6 @@ export declare const getDocumentFiltersFromRequest: (req: Parameters<HomeProvide
81
81
  export declare const filterDocumentsFromRequest: (items: MicrosoftGraphTypes.DriveItem[], filter: ReturnType<typeof getDocumentFiltersFromRequest>) => MicrosoftGraphTypes.DriveItem[];
82
82
  export declare const getFileType: (fileName?: string) => string;
83
83
  export declare const getFileIcon: (fileName?: string) => string;
84
- export declare const mapMicrosoftAvailabilityToPresence: (availability: Presence) => CLISearchResultContact['templateContent']['onlineStatus'] | undefined;
84
+ export declare const mapMicrosoftAvailabilityToPresence: (availability: Presence) => CLISearchResultContact["templateContent"]["onlineStatus"] | undefined;
85
85
  /** base64IdToUrl converts a base64 encoded id to a url safe id */
86
86
  export declare const base64IdToUrl: (b64Id: string) => string;
@@ -1,4 +1,5 @@
1
+ import { GeneratedPalettes } from '../../../../common/src/api/theming';
1
2
  import { ThemeStorageController } from '../../../../client-api-platform/src/api/controllers/theme-storage-controller';
2
3
  import { CustomThemes } from '../../../../client-api-platform/src/shapes';
3
- export declare const initialiseStoragePalettes: (customThemes: CustomThemes | undefined, isWindows: boolean) => CustomThemes;
4
+ export declare const initialiseStoragePalettes: (customThemes: CustomThemes | undefined, isWindows: boolean) => CustomThemes | GeneratedPalettes;
4
5
  export declare const getThemeStorageController: () => ThemeStorageController;
@@ -4,7 +4,7 @@ import { ColorSchemeOptionType, CustomPaletteSet } from '../../../../client-api-
4
4
  *
5
5
  * This is particularly useful if a value uses a different palette constant depending on scheme.
6
6
  */
7
- export declare const getPaletteExtensions: (palette: CustomPaletteSet, paletteScheme: 'light' | 'dark', isWindows: boolean) => {
7
+ export declare const getPaletteExtensions: (palette: CustomPaletteSet, paletteScheme: "light" | "dark", isWindows: boolean) => {
8
8
  dockExpandedContainerBorderColor: string;
9
9
  dockExpandedContainerBorderRadius: string;
10
10
  dockExpandedContainerBackground: string;
@@ -26,15 +26,20 @@ export declare const getPaletteExtensions: (palette: CustomPaletteSet, paletteSc
26
26
  'scrollbar-track-rgb': string;
27
27
  selectedTab: string;
28
28
  };
29
- export type Palettes = {
29
+ export type LegacyPalettes = {
30
30
  dark: CustomPaletteSet;
31
31
  light: CustomPaletteSet;
32
32
  };
33
+ export type Palettes = {
34
+ light: string;
35
+ dark: string;
36
+ };
33
37
  export declare class ThemeStorageController {
34
38
  private providerStorage;
35
39
  private darkPaletteVars?;
36
40
  private lightPaletteVars?;
37
41
  private workspaceStorage?;
42
+ private themePaletteSheet?;
38
43
  constructor(providerStorage: Pick<Storage, 'getItem' | 'setItem'>);
39
44
  private getVarsByScheme;
40
45
  /**
@@ -46,7 +51,7 @@ export declare class ThemeStorageController {
46
51
  * A workaround that can be leveraged in cross origin scenarios (which is the majority of the workspace use case) is available in this commit: 233e843cda6cd68968fd5831fb20597e0d5bb7cc
47
52
  * `git revert 233e843cda6cd68968fd5831fb20597e0d5bb7cc --no-commit`
48
53
  */
49
- setWorkspaceStorage: (proxy: Pick<Storage, 'setItem'>) => void;
54
+ setWorkspaceStorage: (proxy: Pick<Storage, "setItem">) => void;
50
55
  /**
51
56
  * Check if there's an explicit user preference stored in localStorage.
52
57
  * A user preference is indicated by the presence of a SelectedColorScheme key. Which is something assigned if you click on the Appearance dropdown.
@@ -64,7 +69,11 @@ export declare class ThemeStorageController {
64
69
  * to allow workspace UI elements to load the palette before their first paint.
65
70
  * @param palettes Light and Dark Palette constants
66
71
  */
67
- setPalettes: ({ light, dark }: Palettes, isWindows: boolean) => Promise<void>;
72
+ setLegacyPalettes: ({ light, dark }: LegacyPalettes, isWindows: boolean) => Promise<void>;
73
+ setPalettes: ({ light, dark }: {
74
+ light: string;
75
+ dark: string;
76
+ }) => Promise<void>;
68
77
  /**
69
78
  * Set the current scheme of workspace. Specifically setting light or dark
70
79
  * will ignore the OS scheme, whereas 'system' will always respect it.
@@ -83,4 +92,9 @@ export declare class ThemeStorageController {
83
92
  * @returns 'light' | 'system' | 'dark'
84
93
  */
85
94
  getScheme(): ColorSchemeOptionType;
95
+ getThemePaletteSheet(): string | undefined;
96
+ getThemePalette(): {
97
+ light: string;
98
+ dark: string;
99
+ };
86
100
  }
@@ -1,15 +1,17 @@
1
1
  import { ContentMenuEntry } from '@openfin/ui-library';
2
- import { DockCompanionButton, DockEntry, LaunchDockEntryPayload } from '../../../client-api-platform/src/shapes';
2
+ import { DockCompanionButton, DockEntry, LaunchDockEntryPayload, Collection } from '../../../client-api-platform/src/shapes';
3
3
  export declare const DockCompanionUpdatesPrefix = "dock-companion-updates";
4
4
  export declare const refreshDockBookmarksPanel: () => Promise<void>;
5
5
  export declare const updateDockFavoriteEntries: (favorites: DockEntry[]) => Promise<void>;
6
6
  export declare const updateContentMenu: (contentMenu: ContentMenuEntry[]) => Promise<void>;
7
7
  export declare const navigateContentMenu: (id: string) => Promise<void>;
8
+ export declare const refreshDockCollectionMenu: (collections: Collection[]) => Promise<void>;
8
9
  export declare const launchDockEntry: (payload: LaunchDockEntryPayload) => Promise<void>;
9
10
  export declare const setDockFavoritesOrder: (favorites: DockEntry[]) => Promise<void>;
10
11
  export declare const setDefaultDockButtonsOrder: (defaultDockButtons: DockCompanionButton[]) => Promise<void>;
11
- export declare const getDockWorkspacesContextMenu: () => Promise<import("@client/index").BaseCustomDropdownItem<any>[]>;
12
+ export declare const getDockWorkspacesContextMenu: () => Promise<import("@client/shapes").BaseCustomDropdownItem<any>[]>;
12
13
  export declare const handleDockWorkspacesMenuResponse: (payload: any) => Promise<void>;
14
+ export declare const launchCollection: (collection: Collection) => Promise<void>;
13
15
  export declare const removeFavoriteEntry: (entry: DockEntry) => Promise<void>;
14
16
  export declare const addFavoriteEntry: (entry: DockEntry) => Promise<void>;
15
17
  export declare const focusAndExpandSearchMenu: () => Promise<void>;
@@ -4,7 +4,7 @@ export declare const dispatchLanguageToBrowserWindows: (language: Locale) => Pro
4
4
  export declare const setLanguage: (locale: Locale) => Promise<void>;
5
5
  export declare function getLanguageResourcesInternal(): {
6
6
  currentLanguage: "en-US" | "ja-JP" | "zh-CN" | "ko-KR" | "ru-RU" | "de-DE" | "zh-Hant";
7
- resources: import("i18next/typescript/options").Resource;
7
+ resources: import("i18next").Resource;
8
8
  };
9
9
  /**
10
10
  * initLanguage()
@@ -1,5 +1,5 @@
1
1
  import { AnalyticsEventInternal } from '../../../../common/src/utils/usage-register';
2
2
  import { Page } from '../../../../client-api-platform/src/shapes';
3
3
  export declare const getOpenPages: () => Map<string, AnalyticsEventInternal>;
4
- export declare const addOpenPageToCache: (pageId: Page['pageId'], event: AnalyticsEventInternal) => void;
5
- export declare const removeOpenPageFromCache: (pageId: Page['pageId']) => boolean;
4
+ export declare const addOpenPageToCache: (pageId: Page["pageId"], event: AnalyticsEventInternal) => void;
5
+ export declare const removeOpenPageFromCache: (pageId: Page["pageId"]) => boolean;
@@ -1,5 +1,16 @@
1
1
  import type OpenFin from '@openfin/core';
2
+ import type { GenerateThemeParams, LegacyPalettes } from '../../../common/src/api/theming';
2
3
  import { ColorSchemeOptionType, ThemeApi } from '../../../client-api-platform/src/shapes';
3
4
  export declare const getThemingApi: (identity: OpenFin.ApplicationIdentity) => ThemeApi;
5
+ export declare const dispatchThemeToWorkspaceProvider: (themeData: {
6
+ themePaletteSheet: string;
7
+ selectedScheme: ColorSchemeOptionType;
8
+ themePalette: {
9
+ light: string;
10
+ dark: string;
11
+ };
12
+ }) => Promise<void>;
4
13
  export declare const setSelectedScheme: (schemeType: ColorSchemeOptionType) => Promise<void>;
5
14
  export declare const getSelectedScheme: () => ColorSchemeOptionType | null | undefined;
15
+ export declare const getThemePaletteSheet: () => string | undefined;
16
+ export declare const mapLegacyThemeToCustomTheme: (legacyTheme: LegacyPalettes) => GenerateThemeParams;
@@ -0,0 +1 @@
1
+ export {};
@@ -1,4 +1,4 @@
1
1
  import OpenFin from '@openfin/core';
2
2
  import type { AttachedPage, AttachedPageInternal } from '../../../../common/src/api/pages/shapes';
3
3
  import { BrowserInitConfig } from '../..';
4
- export declare const applyPageDefaults: (pages: AttachedPage[], initOptions?: Pick<BrowserInitConfig, 'defaultPageOptions' | 'defaultViewOptions' | 'defaultWindowOptions'>, overrideOptions?: OpenFin.PlatformWindowCreationOptions) => Promise<AttachedPageInternal[]>;
4
+ export declare const applyPageDefaults: (pages: AttachedPage[], initOptions?: Pick<BrowserInitConfig, "defaultPageOptions" | "defaultViewOptions" | "defaultWindowOptions">, overrideOptions?: OpenFin.PlatformWindowCreationOptions) => Promise<AttachedPageInternal[]>;
@@ -7,5 +7,5 @@ type ViewStateBase = Pick<BrowserViewState, '_internalWorkspaceData' | 'workspac
7
7
  export declare const mapInternalWorkspaceDataToWorkspacePlatform: <T extends ViewStateBase>(viewState: T) => T;
8
8
  export declare const mapWorkspacePlatformToInternalWorkspaceData: <T extends ViewStateBase>(viewState: T) => T;
9
9
  export declare const setHotkeysIfNavigationButtonsEnabled: (options: BrowserCreateViewRequest) => Promise<BrowserCreateViewRequest>;
10
- export declare const registerHotkeyListenersIfEnabled: (viewIdentity: OpenFin.Identity, buttonOptions?: BrowserWorkspacePlatformViewOptions['browserNavigationButtons']) => void;
10
+ export declare const registerHotkeyListenersIfEnabled: (viewIdentity: OpenFin.Identity, buttonOptions?: BrowserWorkspacePlatformViewOptions["browserNavigationButtons"]) => void;
11
11
  export {};
@@ -1,5 +1,6 @@
1
+ import { GeneratedPalettes } from '../../../common/src/api/theming';
1
2
  import { CustomThemes } from '../shapes';
2
- export declare const getThemes: () => CustomThemes;
3
+ export declare const getThemes: () => CustomThemes | GeneratedPalettes;
3
4
  /**
4
5
  * initTheming()
5
6
  * @param customThemes array of theme objects
@@ -4,7 +4,7 @@ import type { AnalyticsEvent } from '../../common/src/utils/usage-register';
4
4
  import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
5
5
  import { AddDefaultPagePayload, AttachedPage, BookmarkNode, CopyPagePayload, HandlePagesAndWindowClosePayload, HandlePagesAndWindowCloseResult, HandleSaveModalOnPageClosePayload, Page, PageLayoutsWithSelectedViews, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult, SetActivePageForWindowPayload, ShouldPageClosePayload, ShouldPageCloseResult, ViewsPreventingUnloadPayload } from '../../common/src/api/pages/shapes';
6
6
  import { NotificationsCustomManifestOptions } from '../../common/src/api/shapes/notifications';
7
- import type { CustomThemes } from '../../common/src/api/theming';
7
+ import type { CustomThemes, GeneratedPalettes } from '../../common/src/api/theming';
8
8
  import { App, DockProviderConfigWithIdentity, StoreButtonConfig } from '../../client-api/src/shapes';
9
9
  import type { WorkflowIntegration } from '../../client-api/src/shapes/integrations';
10
10
  export * from '../../dock3/src/shapes';
@@ -154,16 +154,16 @@ export declare enum PageTabContextMenuOptionType {
154
154
  Save = "Save",
155
155
  SaveAs = "Save As",
156
156
  NewPage = "New Page",
157
- DeletePage = "Delete Page",
158
- SaveWorkspaceAs = "SaveWorkspaceAs",
159
- Refresh = "Refresh",
160
- CloseOthers = "Close others",
161
- Delete = "Delete",
162
- Print = "Print",
163
- PrintAll = "PrintAll",
164
- PrintScreen = "PrintScreen",
165
- ManageDesktopSignals = "ManageDesktopSignals",
166
- AddToChannel = "AddToChannel",
157
+ DeletePage = "Delete Page",// Enterprise
158
+ SaveWorkspaceAs = "SaveWorkspaceAs",// Enterprise
159
+ Refresh = "Refresh",// Enterprise
160
+ CloseOthers = "Close others",// Enterprise
161
+ Delete = "Delete",// Enterprise
162
+ Print = "Print",// Enterprise
163
+ PrintAll = "PrintAll",// Enterprise
164
+ PrintScreen = "PrintScreen",// Enterprise
165
+ ManageDesktopSignals = "ManageDesktopSignals",// Enterprise
166
+ AddToChannel = "AddToChannel",// Enterprise
167
167
  Custom = "Custom"
168
168
  }
169
169
  /**Shape of the data property of a global context menu template item */
@@ -1422,7 +1422,7 @@ export interface LaunchAppRequest {
1422
1422
  * Get Themes from API
1423
1423
  */
1424
1424
  export interface ThemeApi {
1425
- getThemes(): Promise<CustomThemes>;
1425
+ getThemes(): Promise<CustomThemes | GeneratedPalettes>;
1426
1426
  setSelectedScheme(newScheme: ColorSchemeOptionType): Promise<void>;
1427
1427
  getSelectedScheme(): Promise<ColorSchemeOptionType>;
1428
1428
  }
@@ -2288,6 +2288,10 @@ export interface Workspace {
2288
2288
  metadata?: WorkspaceMetadata;
2289
2289
  snapshot: BrowserSnapshot;
2290
2290
  }
2291
+ export interface Collection {
2292
+ collectionId: string;
2293
+ title: string;
2294
+ }
2291
2295
  /**
2292
2296
  * Request for creating a saved workspace in persistent storage.
2293
2297
  */
@@ -14,10 +14,8 @@ export declare function updatePage({ pageId, page }: {
14
14
  export declare const addRemovedTab: (payload: TrackedTab) => Promise<void>;
15
15
  export declare const popLastRemovedTab: () => Promise<TrackedTab | undefined>;
16
16
  export declare const trackVisitedSite: (payload: Site) => Promise<void>;
17
- export declare const getRecentVisitedSites: (numOfSites?: number) => Promise<TrackedSite[] | [
18
- ]>;
19
- export declare const getFrequentlyVisitedSites: () => Promise<TrackedSite[] | [
20
- ]>;
17
+ export declare const getRecentVisitedSites: (numOfSites?: number) => Promise<TrackedSite[] | []>;
18
+ export declare const getFrequentlyVisitedSites: () => Promise<TrackedSite[] | []>;
21
19
  export declare const searchSites: (payload: {
22
20
  req: SearchSitesRequest;
23
21
  } & {
@@ -34,8 +34,8 @@ declare enum GeneralBrowserChannelActions {
34
34
  SetSelectedScheme = "set-selected-scheme",
35
35
  ShowBrowserIndicator = "show-browser-indicator",
36
36
  SetSelectedLanguage = "set-selected-language",
37
- RefreshBookmarksInternal = "refresh-bookmarks",
38
- GetLayoutsWithSelectedViewsInternal = "get-layouts-with-selected-views",
37
+ RefreshBookmarksInternal = "refresh-bookmarks",// Enterprise
38
+ GetLayoutsWithSelectedViewsInternal = "get-layouts-with-selected-views",// Enterprise
39
39
  FocusAndExpandSearchInternal = "focus-and-expand-search"
40
40
  }
41
41
  /**
@@ -56,16 +56,18 @@ export declare enum PageChannelAction {
56
56
  IsActivePageChanging = "is-active-page-changing"
57
57
  }
58
58
  export declare enum CompanionDockChannelAction {
59
- UpdateFavoriteEntries = "update-favorite-entries",
60
- UpdateContentMenu = "update-content-menu",
61
- NavigateContentMenu = "navigate-content-menu",
62
- MoreMenuCustomOptionClicked = "more-menu-custom-option-clicked"
59
+ UpdateFavoriteEntries = "update-favorite-entries",// Enterprise
60
+ UpdateContentMenu = "update-content-menu",// Enterprise
61
+ NavigateContentMenu = "navigate-content-menu",// Enterprise
62
+ MoreMenuCustomOptionClicked = "more-menu-custom-option-clicked",// Enterprise
63
+ RefreshDockCollectionMenu = "refresh-dock-collection-menu"
63
64
  }
64
65
  export declare const BrowserChannelAction: {
65
66
  UpdateFavoriteEntries: CompanionDockChannelAction.UpdateFavoriteEntries;
66
67
  UpdateContentMenu: CompanionDockChannelAction.UpdateContentMenu;
67
68
  NavigateContentMenu: CompanionDockChannelAction.NavigateContentMenu;
68
69
  MoreMenuCustomOptionClicked: CompanionDockChannelAction.MoreMenuCustomOptionClicked;
70
+ RefreshDockCollectionMenu: CompanionDockChannelAction.RefreshDockCollectionMenu;
69
71
  GetPages: PageChannelAction.GetPages;
70
72
  GetActivePageForWindow: PageChannelAction.GetActivePageForWindow;
71
73
  AttachPagesToWindow: PageChannelAction.AttachPagesToWindow;
@@ -85,6 +85,14 @@ type WorkspaceChannelTypes = {
85
85
  'set-search-query': (payload: SearchQueryWithProviderID) => Promise<void>;
86
86
  'assign-home-search-context': (payload: Partial<HomeSearchListenerRequest['context']>) => Promise<void>;
87
87
  'set-selected-scheme': (ctx: ColorSchemeOptionType) => Promise<void>;
88
+ 'initialize-theme': (themeData: {
89
+ themePaletteSheet: string;
90
+ selectedScheme: ColorSchemeOptionType;
91
+ themePalette: {
92
+ light: string;
93
+ dark: string;
94
+ };
95
+ }) => Promise<void>;
88
96
  'get-legacy-pages': () => Promise<Page[]>;
89
97
  'get-legacy-workspaces': (payload: undefined) => Promise<LegacyWorkspace[]>;
90
98
  'register-storefront-provider': () => Promise<void>;
@@ -67,30 +67,32 @@ export declare enum WorkspacePlatformChannelAction {
67
67
  CopyPage = "copyPage",
68
68
  HandlePageChanges = "handlePageChanges",
69
69
  MarkUnsavedPagesAsSavedInternal = "markUnsavedPagesAsSavedInternal",
70
- TrackRemovedTabInternal = "trackRemovedTabInternal",
71
- RestoreRemovedTabInternal = "restoreRemovedTabInternal",
72
- TrackVisitedSiteInternal = "trackVisitedSiteInternal",
73
- GetRecentlyVisitedSitesInternal = "getRecentlyVisitedSitesInternal",
74
- GetFrequentlyVisitedSitesInternal = "getFrequentlyVisitedSitesInternal",
75
- SearchSitesInternal = "searchSitesInternal",
76
- GetSearchProvidersInternal = "getSearchProvidersInternal",
77
- GetCuratedContentInternal = "getCuratedContentInternal",
78
- HandleRequestNavigationInternal = "handleRequestNavigationInternal",
79
- RefreshBookmarksInternal = "refreshBookmarksInternal",
80
- LaunchBookmarkInternal = "launchBookmarkInternal",
70
+ TrackRemovedTabInternal = "trackRemovedTabInternal",// Enterprise
71
+ RestoreRemovedTabInternal = "restoreRemovedTabInternal",// Enterprise
72
+ TrackVisitedSiteInternal = "trackVisitedSiteInternal",// Enterprise
73
+ GetRecentlyVisitedSitesInternal = "getRecentlyVisitedSitesInternal",// Enterprise
74
+ GetFrequentlyVisitedSitesInternal = "getFrequentlyVisitedSitesInternal",// Enterprise
75
+ SearchSitesInternal = "searchSitesInternal",// Enterprise
76
+ GetSearchProvidersInternal = "getSearchProvidersInternal",// Enterprise
77
+ GetCuratedContentInternal = "getCuratedContentInternal",// Enterprise
78
+ HandleRequestNavigationInternal = "handleRequestNavigationInternal",// Enterprise
79
+ RefreshBookmarksInternal = "refreshBookmarksInternal",// Enterprise
80
+ LaunchBookmarkInternal = "launchBookmarkInternal",// Enterprise
81
81
  GetNotificationsConfig = "getNotificationsConfig",
82
- UpdateDockFavoritesInternal = "updateDockFavoritesInternal",
83
- UpdateContentMenuInternal = "updateContentMenuInternal",
84
- LaunchDockEntryInternal = "launchDockEntryInternal",
85
- SetDockFavoritesOrderInternal = "setDockFavoritesOrderInternal",
86
- NavigateContentMenuInternal = "navigateContentMenuInternal",
87
- SetDefaultDockButtonsOrderInternal = "setDefaultDockButtonsOrderInternal",
88
- GetDockWorkspacesContextMenuInternal = "getDockWorkspacesContextMenuInternal",
89
- HandleDockWorkspacesMenuResponseInternal = "handleDockWorkspacesMenuResponseInternal",
90
- RemoveDockFavoriteInternal = "removeDockFavoriteInternal",
91
- AddDockFavoriteInternal = "addDockFavoriteInternal",
92
- FocusAndExpandSearchInternal = "focusAndExpandSearchInternal",
93
- SendUpdateVersionModalResponseInternal = "sendUpdateVersionModalResponseInternal",
82
+ UpdateDockFavoritesInternal = "updateDockFavoritesInternal",// Enterprise
83
+ UpdateContentMenuInternal = "updateContentMenuInternal",// Enterprise
84
+ LaunchDockEntryInternal = "launchDockEntryInternal",// Enterprise
85
+ SetDockFavoritesOrderInternal = "setDockFavoritesOrderInternal",// Enterprise
86
+ NavigateContentMenuInternal = "navigateContentMenuInternal",// Enterprise
87
+ SetDefaultDockButtonsOrderInternal = "setDefaultDockButtonsOrderInternal",// Enterprise
88
+ GetDockWorkspacesContextMenuInternal = "getDockWorkspacesContextMenuInternal",// Enterprise
89
+ HandleDockWorkspacesMenuResponseInternal = "handleDockWorkspacesMenuResponseInternal",// Enterprise
90
+ RefreshDockCollectionMenuInternal = "refreshDockCollectionMenuInternal",// Enterprise
91
+ LaunchCollectionInternal = "launchCollectionInternal",//Enterprise
92
+ RemoveDockFavoriteInternal = "removeDockFavoriteInternal",// Enterprise
93
+ AddDockFavoriteInternal = "addDockFavoriteInternal",// Enterprise
94
+ FocusAndExpandSearchInternal = "focusAndExpandSearchInternal",// Enterprise
95
+ SendUpdateVersionModalResponseInternal = "sendUpdateVersionModalResponseInternal",// Enterprise
94
96
  ShowUpdateVersionModalInternal = "showUpdateVersionModalInternal"
95
97
  }
96
98
  export type PlatFormSupportedFeatures = boolean | {
@@ -98,7 +98,7 @@ export interface ProviderUpdateEventPayload {
98
98
  *
99
99
  * This allows for different providers to be registered with the same id.
100
100
  */
101
- export declare const getUniqueProviderIdentifier: ({ platformIdentity, id }: Pick<ProviderInfoInternal, 'platformIdentity' | 'id'>) => string;
101
+ export declare const getUniqueProviderIdentifier: ({ platformIdentity, id }: Pick<ProviderInfoInternal, "platformIdentity" | "id">) => string;
102
102
  /**
103
103
  * Get a list of all providers that have registered with the provider API.
104
104
  */
@@ -30,29 +30,29 @@ export declare const launchStorefrontApp: (req: LaunchStorefrontProviderAppReque
30
30
  * @param identity of the platform to get the apps from.
31
31
  * @returns the list of Storefront apps for the platform.
32
32
  */
33
- export declare const getStorefrontApps: (provider: ProviderInfoInternal<'storefront'>) => Promise<App[]>;
33
+ export declare const getStorefrontApps: (provider: ProviderInfoInternal<"storefront">) => Promise<App[]>;
34
34
  /**
35
35
  * Get the platform's landing page for Storefront.
36
36
  * @param identity of the platform to get the landing page of.
37
37
  * @returns the platform's landing page.
38
38
  */
39
- export declare const getStorefrontLandingPage: (provider: ProviderInfoInternal<'storefront'>) => Promise<StorefrontLandingPage | undefined>;
39
+ export declare const getStorefrontLandingPage: (provider: ProviderInfoInternal<"storefront">) => Promise<StorefrontLandingPage | undefined>;
40
40
  /**
41
41
  * Get the platform's footer for Storefront.
42
42
  * @param identity of the platform to get the footer of.
43
43
  * @returns the platform's footer.
44
44
  */
45
- export declare const getStorefrontFooter: (provider: ProviderInfoInternal<'storefront'>) => Promise<StorefrontFooter>;
45
+ export declare const getStorefrontFooter: (provider: ProviderInfoInternal<"storefront">) => Promise<StorefrontFooter>;
46
46
  /**
47
47
  * Get the platform's navigation for Storefront.
48
48
  * @param identity of the platform to get the navigation of.
49
49
  * @returns the platform's navigation.
50
50
  */
51
- export declare const getStorefrontNavigation: (provider: ProviderInfoInternal<'storefront'>) => Promise<[StorefrontNavigationSection?, StorefrontNavigationSection?]>;
51
+ export declare const getStorefrontNavigation: (provider: ProviderInfoInternal<"storefront">) => Promise<[StorefrontNavigationSection?, StorefrontNavigationSection?]>;
52
52
  /**
53
53
  * A helper method that gets a Storefront navigation item by ID.
54
54
  * @param navigationItemId the id of the Storefront navigation item.
55
55
  * @param identity of the platform.
56
56
  * @returns the navigation item with the ID.
57
57
  */
58
- export declare const getStorefrontNavigationItemAppGrid: (navigationItemId: string, provider: ProviderInfoInternal<'storefront'>) => Promise<StorefrontNavigationItemAppGrid | undefined>;
58
+ export declare const getStorefrontNavigationItemAppGrid: (navigationItemId: string, provider: ProviderInfoInternal<"storefront">) => Promise<StorefrontNavigationItemAppGrid | undefined>;
@@ -1,8 +1,8 @@
1
1
  import type { DefaultTheme } from 'styled-components';
2
2
  import type OpenFin from '@openfin/core';
3
- import { type ColorSchemeType, type ThemeSet } from '@openfin/ui-library';
4
- import { Palette } from '@openfin/ui-library/dist/theme';
3
+ import { type ColorSchemeType, type ThemeSet, Palette } from '@openfin/ui-library';
5
4
  import { ColorSchemeOptionType } from '../../../client-api-platform/src/shapes';
5
+ import type { generateTheme } from '@openfin/theme-engine';
6
6
  export type WorkspaceComponentSetSelectedSchemePayload = {
7
7
  newScheme: ColorSchemeOptionType;
8
8
  identity: OpenFin.Identity;
@@ -121,10 +121,19 @@ export type CustomThemeOptionsWithScheme = BaseThemeOptions & {
121
121
  */
122
122
  notificationIndicatorColors?: NotificationIndicatorColorsWithScheme;
123
123
  };
124
- export type CustomThemes = (CustomThemeOptions | CustomThemeOptionsWithScheme)[];
124
+ export type ThemeOptions = BaseThemeOptions & {
125
+ seed: Parameters<typeof generateTheme>[0];
126
+ overrides?: Parameters<typeof generateTheme>[1];
127
+ };
128
+ type GenerateThemeReturn = ReturnType<typeof generateTheme>;
129
+ export type GeneratedPalettes = Pick<GenerateThemeReturn, 'dark' | 'light'>;
130
+ export type LegacyPalettes = CustomThemeOptions | CustomThemeOptionsWithScheme;
131
+ export type GenerateThemeParams = Parameters<typeof generateTheme>;
132
+ export type CustomThemes = (CustomThemeOptions | CustomThemeOptionsWithScheme | ThemeOptions)[];
125
133
  export interface PreloadedThemeData {
126
- themes: CustomThemes;
134
+ themes: CustomThemes | GeneratedPalettes;
127
135
  selectedScheme: ColorSchemeOptionType;
136
+ themePaletteSheet?: string;
128
137
  }
129
138
  export interface DefaultPaletteSet {
130
139
  brandPrimary: string;
@@ -273,8 +282,9 @@ export declare const getComputedPaletteSets: (customTheme: CustomThemeOptions |
273
282
  * @param storedScheme sets the default scheme if provided
274
283
  * @returns array of {@link ComputedThemes | computed themes}
275
284
  */
276
- export declare const computeThemes: (customThemes: CustomThemes, storedScheme?: ColorSchemeOptionType) => ComputedThemes;
285
+ export declare const computeThemes: (customThemes: CustomThemes | GeneratedPalettes, storedScheme?: ColorSchemeOptionType) => ComputedThemes;
277
286
  export declare const getComputedPlatformTheme: (platformIdentity: OpenFin.Identity) => Promise<ComputedTheme>;
278
287
  export declare const setSelectedScheme: (ctx: ColorSchemeOptionType) => Promise<void>;
279
- export declare const getComputedScheme: (identity?: OpenFin.Identity) => Promise<Exclude<ColorSchemeType, 'system'>>;
288
+ export declare const getComputedScheme: (identity?: OpenFin.Identity) => Promise<Exclude<ColorSchemeType, "system">>;
280
289
  export declare const getComputedBackgroundColor: (paletteKey: keyof typeof Palette, defaultColor?: string) => Promise<string>;
290
+ export {};
@@ -1,6 +1,6 @@
1
1
  import type OpenFin from '@openfin/core';
2
2
  import { EnterpriseMainContextMenuItemData, EnterpriseMainContextMenuItemTemplate, OpenGlobalContextMenuPayload } from '../../../client-api-platform/src/shapes';
3
- export declare const getEnterpriseContextMenuTemplate: ({ identity, selectedViews }: {
3
+ export declare const getEnterpriseContextMenuTemplate: ({ identity }: {
4
4
  identity: OpenFin.Identity;
5
5
  selectedViews: OpenFin.Identity[];
6
6
  }) => Promise<EnterpriseMainContextMenuItemTemplate[]>;
@@ -93,7 +93,7 @@ export declare const downloads: () => {
93
93
  export declare const appearance: () => {
94
94
  label: string;
95
95
  };
96
- export declare const getSavedWorkspaceContextMenuOptions: (activeWorkspace: Workspace, savedWorkspaces: Pick<Workspace, 'workspaceId' | 'title'>[], contextMenuOptionType: GlobalContextMenuOptionType) => {
96
+ export declare const getSavedWorkspaceContextMenuOptions: (activeWorkspace: Workspace, savedWorkspaces: Pick<Workspace, "workspaceId" | "title">[], contextMenuOptionType: GlobalContextMenuOptionType) => {
97
97
  label: string;
98
98
  type: MenuItemType;
99
99
  enabled: boolean;
@@ -1,4 +1,3 @@
1
- /// <reference types="lodash" />
2
1
  import type OpenFin from '@openfin/core';
3
2
  import { WindowIdentity } from '../../../common/src/utils/window';
4
3
  import { AttachedPageInternal } from '../../../common/src/api/pages/shapes';
@@ -79,7 +78,7 @@ export declare const cloneLayoutAndRemoveNames: (layout: PageLayout) => any;
79
78
  * @returns A copy of the layout with generated names removed
80
79
  */
81
80
  export declare const cloneLayoutAndRemoveGeneratedNames: (layout: PageLayout) => any;
82
- export declare const mapContentComponentState: (content: OpenFin.LayoutContent) => OpenFin.LayoutComponent['componentState'][];
81
+ export declare const mapContentComponentState: (content: OpenFin.LayoutContent) => OpenFin.LayoutComponent["componentState"][];
83
82
  export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<any>;
84
83
  export declare const layoutNameInitializedMap: Map<string, boolean>;
85
84
  export declare const isLayoutTabActive: (tabSelector: string) => boolean;
@@ -0,0 +1,22 @@
1
+ export declare const log: {
2
+ /**
3
+ * Calls console.debug with provided parameters and stringifies JS objects prior to logging
4
+ */
5
+ debug: (...args: unknown[]) => void;
6
+ /**
7
+ * Calls console.info with provided parameters and stringifies JS objects prior to logging
8
+ */
9
+ info: (...args: unknown[]) => void;
10
+ /**
11
+ * Calls console.warn with provided parameters and stringifies JS objects prior to logging
12
+ */
13
+ warn: (...args: unknown[]) => void;
14
+ /**
15
+ * Calls console.error with provided parameters and stringifies JS objects prior to logging
16
+ */
17
+ error: (...args: unknown[]) => void;
18
+ /**
19
+ * Calls console.trace with provided parameters and stringifies JS objects prior to logging
20
+ */
21
+ trace: (...args: unknown[]) => void;
22
+ };
@@ -17,12 +17,12 @@ export interface ModalResponseEvent {
17
17
  }
18
18
  export declare const menuEvents: {
19
19
  emit: <EventKey extends keyof MenuEventTypes>(event: EventKey, ...payload: MenuEventTypes[EventKey]) => Promise<void>;
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
- removeListener: <EventKey_2 extends keyof MenuEventTypes>(event: EventKey_2, listener: (...payload: MenuEventTypes[EventKey_2]) => void) => void;
23
- once: <EventKey_3 extends keyof MenuEventTypes>(event: EventKey_3, listener: (...payload: MenuEventTypes[EventKey_3]) => void) => void;
20
+ addListener: <EventKey extends keyof MenuEventTypes>(event: EventKey, listener: (...payload: MenuEventTypes[EventKey]) => void) => void;
21
+ addListenerWithUUID: (uuid: string) => <EventKey extends keyof MenuEventTypes>(event: EventKey, listener: (...payload: MenuEventTypes[EventKey]) => void) => void;
22
+ removeListener: <EventKey extends keyof MenuEventTypes>(event: EventKey, listener: (...payload: MenuEventTypes[EventKey]) => void) => void;
23
+ once: <EventKey extends keyof MenuEventTypes>(event: EventKey, listener: (...payload: MenuEventTypes[EventKey]) => void) => void;
24
24
  };
25
- export declare const emitMenuResponse: (data: ModalResponseEvent['data']) => Promise<void>;
25
+ export declare const emitMenuResponse: (data: ModalResponseEvent["data"]) => Promise<void>;
26
26
  type WindowOptionsWithBounds = OptionalExceptFor<OpenFin.WindowOptions, 'name' | 'url'> & {
27
27
  top: number;
28
28
  left: number;
@@ -49,6 +49,6 @@ export declare function createMenuPosition(windowOptions: OptionalExceptFor<Open
49
49
  }>;
50
50
  export declare function showChildWindow({ options, parameters }: ShowChildOptions): Promise<OpenFin.Window>;
51
51
  export declare const waitForModalResponse: ({ options, content, parameters }: ResponseModalOptions) => Promise<{
52
- data: ModalResponseEvent['data'];
52
+ data: ModalResponseEvent["data"];
53
53
  }>;
54
54
  export {};
@@ -16,7 +16,7 @@ export declare const getCenterOfParentWindowMonitor: (parentWindowIdentity?: Ope
16
16
  * @param centerOnMonitor whether the modal should be centered on the monitor
17
17
  * @returns the bounds for where the modal is to be displayed
18
18
  */
19
- export declare const getResponseModalBounds: (modalOptions: Pick<ResponseModalConfig['windowOptions'], 'defaultWidth' | 'defaultHeight'>, parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean) => Promise<OpenFin.Bounds>;
19
+ export declare const getResponseModalBounds: (modalOptions: Pick<ResponseModalConfig["windowOptions"], "defaultWidth" | "defaultHeight">, parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean) => Promise<OpenFin.Bounds>;
20
20
  export declare function getResponseModalBoundsAndCenterParentIfModalOffScreen(modalOptions: Parameters<typeof getResponseModalBounds>[0], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean, relativeBounds?: boolean): Promise<OpenFin.Bounds>;
21
21
  /**
22
22
  * Adjusts the given bounds to be within the closest monitor's available bounds if they are offscreen.
@@ -1,4 +1,4 @@
1
- export declare const createNamespacedLocalStorage: <TKey extends string>(namespace: string) => Pick<Storage, 'setItem' | 'getItem' | 'removeItem'>;
1
+ export declare const createNamespacedLocalStorage: <TKey extends string>(namespace: string) => Pick<Storage, "setItem" | "getItem" | "removeItem">;
2
2
  export declare const setItem: (key: string, value: string) => void;
3
- export declare const getItem: (key: string) => string;
3
+ export declare const getItem: (key: string) => string | null;
4
4
  export declare const removeItem: (key: string) => void;
@@ -3,6 +3,12 @@ import { UserMenuParams } from '../../../common/src/utils/menu';
3
3
  import { OptionalExceptFor } from '../../../common/src/utils/types';
4
4
  import { AnchorBehavior } from '../../../client-api-platform/src/api/context-menu';
5
5
  import { Site, SiteAction } from '../../../client-api-platform/src/shapes';
6
+ export type ViewMoreButton = {
7
+ type: 'view-more-result';
8
+ id: string;
9
+ providerId: string;
10
+ };
11
+ export type SelectableResult = Site | ViewMoreButton;
6
12
  export declare enum SaveMenuType {
7
13
  Save = "Save",
8
14
  SaveAs = "SaveAs"
@@ -116,8 +122,17 @@ export type SearchMenuChannelResponse = {
116
122
  } | {
117
123
  type: 'keyboard-event';
118
124
  keyboardEvent: BrowserSearchMenuKeyboardEvent;
125
+ } | {
126
+ type: 'focused-changed';
127
+ payload: SelectableResult;
119
128
  } | {
120
129
  type: 'search-provider-changed';
130
+ } | {
131
+ type: 'all-providers-results-announcement';
132
+ message: string;
133
+ } | {
134
+ type: 'single-provider-results-announcement';
135
+ message: string;
121
136
  };
122
137
  export declare function showPopupWin<T extends keyof UserMenuParams>(parentWindow: OpenFin.Window, params: UserMenuParams[T], windowOpts: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
123
138
  export {};