@openfin/workspace 22.5.20 → 23.0.0

package/client-api/src/integrations/microsoft.utils.d.ts

@@ -36,9 +36,9 @@ export declare const MICROSOFT_365_SEARCH_RESULT_ACTIONS: {
  * @param req The user input request object from which to extract the selected filters.
  * @returns An array of CLIFilter objects representing the validated filters.
  */
-export declare const getValidFilters: (req: Parameters<HomeProvider['onUserInput']>[0], searchTypePossibleFilters: Set<Microsoft365DocumentType>) => CLIFilter[];
-export declare const getValidContactFilters: (users: MicrosoftGraphTypes.User[], req: Parameters<HomeProvider['onUserInput']>[0]) => CLIFilter[];
-export declare const getContactFiltersFromRequest: (req: Parameters<HomeProvider['onUserInput']>[0]) => {
+export declare const getValidFilters: (req: Parameters<HomeProvider["onUserInput"]>[0], searchTypePossibleFilters: Set<Microsoft365DocumentType>) => CLIFilter[];
+export declare const getValidContactFilters: (users: MicrosoftGraphTypes.User[], req: Parameters<HomeProvider["onUserInput"]>[0]) => CLIFilter[];
+export declare const getContactFiltersFromRequest: (req: Parameters<HomeProvider["onUserInput"]>[0]) => {
     department: string[];
     jobTitle: string[];
 };
@@ -58,7 +58,7 @@ export declare const filterContactFromRequest: (items: MicrosoftGraphTypes.User[
  * If no types are selected or all types are deselected, the function marks all types to be shown.
  * Otherwise, it marks only the selected types to be shown.
  */
-export declare const getTypeFiltersFromRequest: (req: Parameters<HomeProvider['onUserInput']>[0], searchTypePossibleFilters: Set<Microsoft365DocumentType>) => {
+export declare const getTypeFiltersFromRequest: (req: Parameters<HomeProvider["onUserInput"]>[0], searchTypePossibleFilters: Set<Microsoft365DocumentType>) => {
     readonly showDocuments: boolean;
     readonly showContacts: boolean;
     /** Teams Messages */
@@ -70,7 +70,7 @@ export declare const getTypeFiltersFromRequest: (req: Parameters<HomeProvider['o
     /** SharePoint Lists */
     readonly showLists: boolean;
 };
-export declare const getDocumentFiltersFromRequest: (req: Parameters<HomeProvider['onUserInput']>[0]) => {
+export declare const getDocumentFiltersFromRequest: (req: Parameters<HomeProvider["onUserInput"]>[0]) => {
     readonly filterFiles: boolean;
     readonly showWord: boolean;
     readonly showExcel: boolean;
@@ -81,6 +81,6 @@ export declare const getDocumentFiltersFromRequest: (req: Parameters<HomeProvide
 export declare const filterDocumentsFromRequest: (items: MicrosoftGraphTypes.DriveItem[], filter: ReturnType<typeof getDocumentFiltersFromRequest>) => MicrosoftGraphTypes.DriveItem[];
 export declare const getFileType: (fileName?: string) => string;
 export declare const getFileIcon: (fileName?: string) => string;
-export declare const mapMicrosoftAvailabilityToPresence: (availability: Presence) => CLISearchResultContact['templateContent']['onlineStatus'] | undefined;
+export declare const mapMicrosoftAvailabilityToPresence: (availability: Presence) => CLISearchResultContact["templateContent"]["onlineStatus"] | undefined;
 /** base64IdToUrl converts a base64 encoded id to a url safe id */
 export declare const base64IdToUrl: (b64Id: string) => string;

package/client-api/src/shapes/home.d.ts

@@ -463,6 +463,7 @@ export interface HomeRegistration extends RegistrationMetaInfo {
      * @throws An error if the Home Provider is no longer registered.
      *
      * @param query search string
+     * @param @optional additional options to set the search query
      *
      * @returns A promise that resolves when the search string has been injected into home search
      *
@@ -500,5 +501,15 @@ export interface HomeRegistration extends RegistrationMetaInfo {
      *
      * ```
      */
-    setSearchQuery(query: string): Promise<void>;
+    setSearchQuery(query: string, options?: SetSearchQueryOptions): Promise<void>;
+}
+/**
+ * Options to set the search query
+ */
+export interface SetSearchQueryOptions {
+    /**
+     * Whether to show home after setting the search query
+     * @default true
+     */
+    showHome?: boolean;
 }

package/client-api-platform/src/api/controllers/theme-storage-controller-store.d.ts

@@ -1,4 +1,5 @@
+import { GeneratedPalettes } from '../../../../common/src/api/theming';
 import { ThemeStorageController } from '../../../../client-api-platform/src/api/controllers/theme-storage-controller';
 import { CustomThemes } from '../../../../client-api-platform/src/shapes';
-export declare const initialiseStoragePalettes: (customThemes: CustomThemes | undefined, isWindows: boolean) => CustomThemes;
+export declare const initialiseStoragePalettes: (customThemes: CustomThemes | undefined, isWindows: boolean) => CustomThemes | GeneratedPalettes;
 export declare const getThemeStorageController: () => ThemeStorageController;

package/client-api-platform/src/api/controllers/theme-storage-controller.d.ts

@@ -4,7 +4,7 @@ import { ColorSchemeOptionType, CustomPaletteSet } from '../../../../client-api-
  *
  * This is particularly useful if a value uses a different palette constant depending on scheme.
  */
-export declare const getPaletteExtensions: (palette: CustomPaletteSet, paletteScheme: 'light' | 'dark', isWindows: boolean) => {
+export declare const getPaletteExtensions: (palette: CustomPaletteSet, paletteScheme: "light" | "dark", isWindows: boolean) => {
     dockExpandedContainerBorderColor: string;
     dockExpandedContainerBorderRadius: string;
     dockExpandedContainerBackground: string;
@@ -26,15 +26,20 @@ export declare const getPaletteExtensions: (palette: CustomPaletteSet, paletteSc
     'scrollbar-track-rgb': string;
     selectedTab: string;
 };
-export type Palettes = {
+export type LegacyPalettes = {
     dark: CustomPaletteSet;
     light: CustomPaletteSet;
 };
+export type Palettes = {
+    light: string;
+    dark: string;
+};
 export declare class ThemeStorageController {
     private providerStorage;
     private darkPaletteVars?;
     private lightPaletteVars?;
     private workspaceStorage?;
+    private themePaletteSheet?;
     constructor(providerStorage: Pick<Storage, 'getItem' | 'setItem'>);
     private getVarsByScheme;
     /**
@@ -46,7 +51,7 @@ export declare class ThemeStorageController {
      * 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
      * `git revert 233e843cda6cd68968fd5831fb20597e0d5bb7cc --no-commit`
      */
-    setWorkspaceStorage: (proxy: Pick<Storage, 'setItem'>) => void;
+    setWorkspaceStorage: (proxy: Pick<Storage, "setItem">) => void;
     /**
      * Check if there's an explicit user preference stored in localStorage.
      * 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 {
      * to allow workspace UI elements to load the palette before their first paint.
      * @param palettes Light and Dark Palette constants
      */
-    setPalettes: ({ light, dark }: Palettes, isWindows: boolean) => Promise<void>;
+    setLegacyPalettes: ({ light, dark }: LegacyPalettes, isWindows: boolean) => Promise<void>;
+    setPalettes: ({ light, dark }: {
+        light: string;
+        dark: string;
+    }) => Promise<void>;
     /**
      * Set the current scheme of workspace. Specifically setting light or dark
      * will ignore the OS scheme, whereas 'system' will always respect it.
@@ -83,4 +92,9 @@ export declare class ThemeStorageController {
      * @returns 'light' | 'system' | 'dark'
      */
     getScheme(): ColorSchemeOptionType;
+    getThemePaletteSheet(): string | undefined;
+    getThemePalette(): {
+        light: string;
+        dark: string;
+    };
 }

package/client-api-platform/src/api/dock.d.ts

@@ -1,15 +1,17 @@
 import { ContentMenuEntry } from '@openfin/ui-library';
-import { DockCompanionButton, DockEntry, LaunchDockEntryPayload } from '../../../client-api-platform/src/shapes';
+import { DockCompanionButton, DockEntry, LaunchDockEntryPayload, Collection } from '../../../client-api-platform/src/shapes';
 export declare const DockCompanionUpdatesPrefix = "dock-companion-updates";
 export declare const refreshDockBookmarksPanel: () => Promise<void>;
 export declare const updateDockFavoriteEntries: (favorites: DockEntry[]) => Promise<void>;
 export declare const updateContentMenu: (contentMenu: ContentMenuEntry[]) => Promise<void>;
 export declare const navigateContentMenu: (id: string) => Promise<void>;
+export declare const refreshDockCollectionMenu: (collections: Collection[]) => Promise<void>;
 export declare const launchDockEntry: (payload: LaunchDockEntryPayload) => Promise<void>;
 export declare const setDockFavoritesOrder: (favorites: DockEntry[]) => Promise<void>;
 export declare const setDefaultDockButtonsOrder: (defaultDockButtons: DockCompanionButton[]) => Promise<void>;
-export declare const getDockWorkspacesContextMenu: () => Promise<import("@common/api/action").BaseCustomDropdownItem<any>[]>;
+export declare const getDockWorkspacesContextMenu: () => Promise<import("@client/shapes").BaseCustomDropdownItem<any>[]>;
 export declare const handleDockWorkspacesMenuResponse: (payload: any) => Promise<void>;
+export declare const launchCollection: (collection: Collection) => Promise<void>;
 export declare const removeFavoriteEntry: (entry: DockEntry) => Promise<void>;
 export declare const addFavoriteEntry: (entry: DockEntry) => Promise<void>;
 export declare const focusAndExpandSearchMenu: () => Promise<void>;

package/client-api-platform/src/api/language.d.ts

@@ -4,7 +4,7 @@ export declare const dispatchLanguageToBrowserWindows: (language: Locale) => Pro
 export declare const setLanguage: (locale: Locale) => Promise<void>;
 export declare function getLanguageResourcesInternal(): {
     currentLanguage: "en-US" | "ja-JP" | "zh-CN" | "ko-KR" | "ru-RU" | "de-DE" | "zh-Hant";
-    resources: import("i18next/typescript/options").Resource;
+    resources: import("i18next").Resource;
 };
 /**
  * initLanguage()

package/client-api-platform/src/api/pages/open-pages.d.ts

@@ -1,5 +1,5 @@
 import { AnalyticsEventInternal } from '../../../../common/src/utils/usage-register';
 import { Page } from '../../../../client-api-platform/src/shapes';
 export declare const getOpenPages: () => Map<string, AnalyticsEventInternal>;
-export declare const addOpenPageToCache: (pageId: Page['pageId'], event: AnalyticsEventInternal) => void;
-export declare const removeOpenPageFromCache: (pageId: Page['pageId']) => boolean;
+export declare const addOpenPageToCache: (pageId: Page["pageId"], event: AnalyticsEventInternal) => void;
+export declare const removeOpenPageFromCache: (pageId: Page["pageId"]) => boolean;

package/client-api-platform/src/api/theming.d.ts

@@ -1,5 +1,16 @@
 import type OpenFin from '@openfin/core';
+import type { GenerateThemeParams, LegacyPalettes } from '../../../common/src/api/theming';
 import { ColorSchemeOptionType, ThemeApi } from '../../../client-api-platform/src/shapes';
 export declare const getThemingApi: (identity: OpenFin.ApplicationIdentity) => ThemeApi;
+export declare const dispatchThemeToWorkspaceProvider: (themeData: {
+    themePaletteSheet: string;
+    selectedScheme: ColorSchemeOptionType;
+    themePalette: {
+        light: string;
+        dark: string;
+    };
+}) => Promise<void>;
 export declare const setSelectedScheme: (schemeType: ColorSchemeOptionType) => Promise<void>;
 export declare const getSelectedScheme: () => ColorSchemeOptionType | null | undefined;
+export declare const getThemePaletteSheet: () => string | undefined;
+export declare const mapLegacyThemeToCustomTheme: (legacyTheme: LegacyPalettes) => GenerateThemeParams;

package/client-api-platform/src/init/override-callback/page-defaults.d.ts

@@ -1,4 +1,4 @@
 import OpenFin from '@openfin/core';
 import type { AttachedPage, AttachedPageInternal } from '../../../../common/src/api/pages/shapes';
 import { BrowserInitConfig } from '../..';
-export declare const applyPageDefaults: (pages: AttachedPage[], initOptions?: Pick<BrowserInitConfig, 'defaultPageOptions' | 'defaultViewOptions' | 'defaultWindowOptions'>, overrideOptions?: OpenFin.PlatformWindowCreationOptions) => Promise<AttachedPageInternal[]>;
+export declare const applyPageDefaults: (pages: AttachedPage[], initOptions?: Pick<BrowserInitConfig, "defaultPageOptions" | "defaultViewOptions" | "defaultWindowOptions">, overrideOptions?: OpenFin.PlatformWindowCreationOptions) => Promise<AttachedPageInternal[]>;

package/client-api-platform/src/init/override-callback/view-options.d.ts

@@ -7,5 +7,5 @@ type ViewStateBase = Pick<BrowserViewState, '_internalWorkspaceData' | 'workspac
 export declare const mapInternalWorkspaceDataToWorkspacePlatform: <T extends ViewStateBase>(viewState: T) => T;
 export declare const mapWorkspacePlatformToInternalWorkspaceData: <T extends ViewStateBase>(viewState: T) => T;
 export declare const setHotkeysIfNavigationButtonsEnabled: (options: BrowserCreateViewRequest) => Promise<BrowserCreateViewRequest>;
-export declare const registerHotkeyListenersIfEnabled: (viewIdentity: OpenFin.Identity, buttonOptions?: BrowserWorkspacePlatformViewOptions['browserNavigationButtons']) => void;
+export declare const registerHotkeyListenersIfEnabled: (viewIdentity: OpenFin.Identity, buttonOptions?: BrowserWorkspacePlatformViewOptions["browserNavigationButtons"]) => void;
 export {};

package/client-api-platform/src/init/theming.d.ts

@@ -1,5 +1,6 @@
+import { GeneratedPalettes } from '../../../common/src/api/theming';
 import { CustomThemes } from '../shapes';
-export declare const getThemes: () => CustomThemes;
+export declare const getThemes: () => CustomThemes | GeneratedPalettes;
 /**
  * initTheming()
  * @param customThemes array of theme objects

package/client-api-platform/src/shapes.d.ts

@@ -7,7 +7,7 @@ import { Resource } from '../../common/src/api/i18next';
 import { TrackedSite } from '../../common/src/api/pages/idb';
 import { AddDefaultPagePayload, AttachedPage, BookmarkNode, CopyPagePayload, CreateBookmarkNodeRequest, HandlePagesAndWindowClosePayload, HandlePagesAndWindowCloseResult, HandleSaveModalOnPageClosePayload, Page, PageLayoutsWithSelectedViews, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult, SetActivePageForWindowPayload, ShouldPageClosePayload, ShouldPageCloseResult, UpdateBookmarkNodeRequest, ViewsPreventingUnloadPayload } from '../../common/src/api/pages/shapes';
 import { NotificationsCustomManifestOptions } from '../../common/src/api/shapes/notifications';
-import type { CustomThemes } from '../../common/src/api/theming';
+import type { CustomThemes, GeneratedPalettes } from '../../common/src/api/theming';
 import { App, DockProviderConfigWithIdentity, StoreButtonConfig } from '../../client-api/src/shapes';
 import type { WorkflowIntegration } from '../../client-api/src/shapes/integrations';
 import { DockCompanionButton } from '../../dock3/src/shapes/index';
@@ -159,16 +159,16 @@ export declare enum PageTabContextMenuOptionType {
     Save = "Save",
     SaveAs = "Save As",
     NewPage = "New Page",
-    DeletePage = "Delete Page",
-    SaveWorkspaceAs = "SaveWorkspaceAs",
-    Refresh = "Refresh",
-    CloseOthers = "Close others",
-    Delete = "Delete",
-    Print = "Print",
-    PrintAll = "PrintAll",
-    PrintScreen = "PrintScreen",
-    ManageDesktopSignals = "ManageDesktopSignals",
-    AddToChannel = "AddToChannel",
+    DeletePage = "Delete Page",// Enterprise
+    SaveWorkspaceAs = "SaveWorkspaceAs",// Enterprise
+    Refresh = "Refresh",// Enterprise
+    CloseOthers = "Close others",// Enterprise
+    Delete = "Delete",// Enterprise
+    Print = "Print",// Enterprise
+    PrintAll = "PrintAll",// Enterprise
+    PrintScreen = "PrintScreen",// Enterprise
+    ManageDesktopSignals = "ManageDesktopSignals",// Enterprise
+    AddToChannel = "AddToChannel",// Enterprise
     Custom = "Custom"
 }
 /** @internal */
@@ -176,7 +176,7 @@ export declare enum EnterpriseMainContextMenuOptionType {
     Lock = "Lock",
     ShowHideTabs = "ShowHideTabs",
     AddToChanel = "AddToChannel",
-    ManageDesktopSignals = "ManageDesktopSignals",
+    ManageDesktopSignals = "ManageDesktopSignals",// Enterprise
     Print = "Print",
     Pin = "Pin"
 }
@@ -1722,7 +1722,7 @@ export interface LaunchAppRequest {
  * Get Themes from API
  */
 export interface ThemeApi {
-    getThemes(): Promise<CustomThemes>;
+    getThemes(): Promise<CustomThemes | GeneratedPalettes>;
     setSelectedScheme(newScheme: ColorSchemeOptionType): Promise<void>;
     getSelectedScheme(): Promise<ColorSchemeOptionType>;
 }
@@ -1988,6 +1988,18 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      * @internal
      */
     _handleDockWorkspacesMenuResponseInternal(payload: any): Promise<void>;
+    /**
+     * Retrieves companion dock content dropdown context menu.
+     * @param collections
+     * @internal
+     */
+    _refreshDockCollectionMenuInternal(collections: Collection[]): Promise<void>;
+    /**
+     * Launch companion dock collection
+     * @param collection
+     * @internal
+     */
+    _launchCollectionInternal(collection: Collection): Promise<void>;
     /**
      *
      * Finds a browser window with only a single tab on the landing page, brings it forward, and
@@ -2286,6 +2298,10 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
     /** @internal */
     handleDockWorkspacesMenuResponseInternal(payload: any): Promise<void>;
     /** @internal */
+    refreshDockCollectionMenuInternal(collections: Collection[]): Promise<void>;
+    /** @internal */
+    launchCollectionInternal(collection: Collection): Promise<void>;
+    /** @internal */
     focusAndExpandSearchInternal(): Promise<void>;
     /** @internal */
     sendUpdateVersionModalResponseInternal(payload: SendUpdateVersionModalResponsePayload): Promise<void>;
@@ -2825,6 +2841,10 @@ export interface Workspace {
     metadata?: WorkspaceMetadata;
     snapshot: BrowserSnapshot;
 }
+export interface Collection {
+    collectionId: string;
+    title: string;
+}
 /**
  * Request for creating a saved workspace in persistent storage.
  */

package/common/src/api/home.d.ts

@@ -1,13 +1,15 @@
 import type OpenFin from '@openfin/core';
-import { HomeSearchListenerRequest } from '../../../client-api/src/shapes';
+import { HomeSearchListenerRequest, SetSearchQueryOptions } from '../../../client-api/src/shapes';
 export interface SearchQueryWithProviderID {
     providerID: string;
     query: string;
+    options?: SetSearchQueryOptions;
 }
 export interface SearchQueryWithProviderIdentity {
     providerID: string;
     platformIdentity: OpenFin.Identity;
     query: string;
+    options?: SetSearchQueryOptions;
 }
 /**
  * The ids of home providers that are built into Home.

package/common/src/api/pages/idb.d.ts

@@ -14,10 +14,8 @@ export declare function updatePage({ pageId, page }: {
 export declare const addRemovedTab: (payload: TrackedTab) => Promise<void>;
 export declare const popLastRemovedTab: () => Promise<TrackedTab | undefined>;
 export declare const trackVisitedSite: (payload: Site) => Promise<void>;
-export declare const getRecentVisitedSites: (numOfSites?: number) => Promise<TrackedSite[] | [
-]>;
-export declare const getFrequentlyVisitedSites: () => Promise<TrackedSite[] | [
-]>;
+export declare const getRecentVisitedSites: (numOfSites?: number) => Promise<TrackedSite[] | []>;
+export declare const getFrequentlyVisitedSites: () => Promise<TrackedSite[] | []>;
 export declare const searchSites: (payload: {
     req: SearchSitesRequest;
 } & {

package/common/src/api/protocol/browser.d.ts

@@ -34,8 +34,8 @@ declare enum GeneralBrowserChannelActions {
     SetSelectedScheme = "set-selected-scheme",
     ShowBrowserIndicator = "show-browser-indicator",
     SetSelectedLanguage = "set-selected-language",
-    RefreshBookmarksInternal = "refresh-bookmarks",
-    GetLayoutsWithSelectedViewsInternal = "get-layouts-with-selected-views",
+    RefreshBookmarksInternal = "refresh-bookmarks",// Enterprise
+    GetLayoutsWithSelectedViewsInternal = "get-layouts-with-selected-views",// Enterprise
     FocusAndExpandSearchInternal = "focus-and-expand-search"
 }
 /**
@@ -68,23 +68,24 @@ export declare enum EnterpriseAppDirectoryChannelAction {
  * @internal
  */
 export declare enum EnterpriseBookmarkChannelAction {
-    CreateBookmarkNode = "create-bookmark-node",
-    GetBookmarkNode = "get-bookmark-node",
-    SearchBookmarkNodes = "search-bookmark-nodes",
-    UpdateBookmarkNode = "update-bookmark-node",
+    CreateBookmarkNode = "create-bookmark-node",// Enterprise
+    GetBookmarkNode = "get-bookmark-node",// Enterprise
+    SearchBookmarkNodes = "search-bookmark-nodes",// Enterprise
+    UpdateBookmarkNode = "update-bookmark-node",// Enterprise
     DeleteBookmarkNode = "delete-bookmark-node"
 }
 export declare enum CompanionDockChannelAction {
-    UpdateFavoriteEntries = "update-favorite-entries",
-    UpdateContentMenu = "update-content-menu",
-    NavigateContentMenu = "navigate-content-menu",
-    MoreMenuCustomOptionClicked = "more-menu-custom-option-clicked"
+    UpdateFavoriteEntries = "update-favorite-entries",// Enterprise
+    UpdateContentMenu = "update-content-menu",// Enterprise
+    NavigateContentMenu = "navigate-content-menu",// Enterprise
+    MoreMenuCustomOptionClicked = "more-menu-custom-option-clicked",// Enterprise
+    RefreshDockCollectionMenu = "refresh-dock-collection-menu"
 }
 /**
  * @internal
  */
 export declare enum EnterpriseRequestModalChannelAction {
-    SendUpdateVersionModalResponse = "send-update-version-modal-response",
+    SendUpdateVersionModalResponse = "send-update-version-modal-response",// Enterprise
     SendIntentResolverModalResponse = "send-intent-resolver-modal-response"
 }
 export declare const BrowserChannelAction: {
@@ -92,6 +93,7 @@ export declare const BrowserChannelAction: {
     UpdateContentMenu: CompanionDockChannelAction.UpdateContentMenu;
     NavigateContentMenu: CompanionDockChannelAction.NavigateContentMenu;
     MoreMenuCustomOptionClicked: CompanionDockChannelAction.MoreMenuCustomOptionClicked;
+    RefreshDockCollectionMenu: CompanionDockChannelAction.RefreshDockCollectionMenu;
     GetPages: PageChannelAction.GetPages;
     GetActivePageForWindow: PageChannelAction.GetActivePageForWindow;
     AttachPagesToWindow: PageChannelAction.AttachPagesToWindow;

package/common/src/api/protocol/shapes/workspace.d.ts

@@ -85,6 +85,14 @@ type WorkspaceChannelTypes = {
     'set-search-query': (payload: SearchQueryWithProviderID) => Promise<void>;
     'assign-home-search-context': (payload: Partial<HomeSearchListenerRequest['context']>) => Promise<void>;
     'set-selected-scheme': (ctx: ColorSchemeOptionType) => Promise<void>;
+    'initialize-theme': (themeData: {
+        themePaletteSheet: string;
+        selectedScheme: ColorSchemeOptionType;
+        themePalette: {
+            light: string;
+            dark: string;
+        };
+    }) => Promise<void>;
     'get-legacy-pages': () => Promise<Page[]>;
     'get-legacy-workspaces': (payload: undefined) => Promise<LegacyWorkspace[]>;
     'register-storefront-provider': () => Promise<void>;

package/common/src/api/protocol/workspace-platform.d.ts

@@ -67,30 +67,32 @@ export declare enum WorkspacePlatformChannelAction {
     CopyPage = "copyPage",
     HandlePageChanges = "handlePageChanges",
     MarkUnsavedPagesAsSavedInternal = "markUnsavedPagesAsSavedInternal",
-    TrackRemovedTabInternal = "trackRemovedTabInternal",
-    RestoreRemovedTabInternal = "restoreRemovedTabInternal",
-    TrackVisitedSiteInternal = "trackVisitedSiteInternal",
-    GetRecentlyVisitedSitesInternal = "getRecentlyVisitedSitesInternal",
-    GetFrequentlyVisitedSitesInternal = "getFrequentlyVisitedSitesInternal",
-    SearchSitesInternal = "searchSitesInternal",
-    GetSearchProvidersInternal = "getSearchProvidersInternal",
-    GetCuratedContentInternal = "getCuratedContentInternal",
-    HandleRequestNavigationInternal = "handleRequestNavigationInternal",
-    RefreshBookmarksInternal = "refreshBookmarksInternal",
-    LaunchBookmarkInternal = "launchBookmarkInternal",
+    TrackRemovedTabInternal = "trackRemovedTabInternal",// Enterprise
+    RestoreRemovedTabInternal = "restoreRemovedTabInternal",// Enterprise
+    TrackVisitedSiteInternal = "trackVisitedSiteInternal",// Enterprise
+    GetRecentlyVisitedSitesInternal = "getRecentlyVisitedSitesInternal",// Enterprise
+    GetFrequentlyVisitedSitesInternal = "getFrequentlyVisitedSitesInternal",// Enterprise
+    SearchSitesInternal = "searchSitesInternal",// Enterprise
+    GetSearchProvidersInternal = "getSearchProvidersInternal",// Enterprise
+    GetCuratedContentInternal = "getCuratedContentInternal",// Enterprise
+    HandleRequestNavigationInternal = "handleRequestNavigationInternal",// Enterprise
+    RefreshBookmarksInternal = "refreshBookmarksInternal",// Enterprise
+    LaunchBookmarkInternal = "launchBookmarkInternal",// Enterprise
     GetNotificationsConfig = "getNotificationsConfig",
-    UpdateDockFavoritesInternal = "updateDockFavoritesInternal",
-    UpdateContentMenuInternal = "updateContentMenuInternal",
-    LaunchDockEntryInternal = "launchDockEntryInternal",
-    SetDockFavoritesOrderInternal = "setDockFavoritesOrderInternal",
-    NavigateContentMenuInternal = "navigateContentMenuInternal",
-    SetDefaultDockButtonsOrderInternal = "setDefaultDockButtonsOrderInternal",
-    GetDockWorkspacesContextMenuInternal = "getDockWorkspacesContextMenuInternal",
-    HandleDockWorkspacesMenuResponseInternal = "handleDockWorkspacesMenuResponseInternal",
-    RemoveDockFavoriteInternal = "removeDockFavoriteInternal",
-    AddDockFavoriteInternal = "addDockFavoriteInternal",
-    FocusAndExpandSearchInternal = "focusAndExpandSearchInternal",
-    SendUpdateVersionModalResponseInternal = "sendUpdateVersionModalResponseInternal",
+    UpdateDockFavoritesInternal = "updateDockFavoritesInternal",// Enterprise
+    UpdateContentMenuInternal = "updateContentMenuInternal",// Enterprise
+    LaunchDockEntryInternal = "launchDockEntryInternal",// Enterprise
+    SetDockFavoritesOrderInternal = "setDockFavoritesOrderInternal",// Enterprise
+    NavigateContentMenuInternal = "navigateContentMenuInternal",// Enterprise
+    SetDefaultDockButtonsOrderInternal = "setDefaultDockButtonsOrderInternal",// Enterprise
+    GetDockWorkspacesContextMenuInternal = "getDockWorkspacesContextMenuInternal",// Enterprise
+    HandleDockWorkspacesMenuResponseInternal = "handleDockWorkspacesMenuResponseInternal",// Enterprise
+    RefreshDockCollectionMenuInternal = "refreshDockCollectionMenuInternal",// Enterprise
+    LaunchCollectionInternal = "launchCollectionInternal",//Enterprise
+    RemoveDockFavoriteInternal = "removeDockFavoriteInternal",// Enterprise
+    AddDockFavoriteInternal = "addDockFavoriteInternal",// Enterprise
+    FocusAndExpandSearchInternal = "focusAndExpandSearchInternal",// Enterprise
+    SendUpdateVersionModalResponseInternal = "sendUpdateVersionModalResponseInternal",// Enterprise
     ShowUpdateVersionModalInternal = "showUpdateVersionModalInternal"
 }
 export type PlatFormSupportedFeatures = boolean | {

package/common/src/api/provider.d.ts

@@ -98,7 +98,7 @@ export interface ProviderUpdateEventPayload {
  *
  * This allows for different providers to be registered with the same id.
  */
-export declare const getUniqueProviderIdentifier: ({ platformIdentity, id }: Pick<ProviderInfoInternal, 'platformIdentity' | 'id'>) => string;
+export declare const getUniqueProviderIdentifier: ({ platformIdentity, id }: Pick<ProviderInfoInternal, "platformIdentity" | "id">) => string;
 /**
  * Get a list of all providers that have registered with the provider API.
  */

package/common/src/api/storefront.d.ts

@@ -30,29 +30,29 @@ export declare const launchStorefrontApp: (req: LaunchStorefrontProviderAppReque
  * @param identity of the platform to get the apps from.
  * @returns the list of Storefront apps for the platform.
  */
-export declare const getStorefrontApps: (provider: ProviderInfoInternal<'storefront'>) => Promise<App[]>;
+export declare const getStorefrontApps: (provider: ProviderInfoInternal<"storefront">) => Promise<App[]>;
 /**
  * Get the platform's landing page for Storefront.
  * @param identity of the platform to get the landing page of.
  * @returns the platform's landing page.
  */
-export declare const getStorefrontLandingPage: (provider: ProviderInfoInternal<'storefront'>) => Promise<StorefrontLandingPage | undefined>;
+export declare const getStorefrontLandingPage: (provider: ProviderInfoInternal<"storefront">) => Promise<StorefrontLandingPage | undefined>;
 /**
  * Get the platform's footer for Storefront.
  * @param identity of the platform to get the footer of.
  * @returns the platform's footer.
  */
-export declare const getStorefrontFooter: (provider: ProviderInfoInternal<'storefront'>) => Promise<StorefrontFooter>;
+export declare const getStorefrontFooter: (provider: ProviderInfoInternal<"storefront">) => Promise<StorefrontFooter>;
 /**
  * Get the platform's navigation for Storefront.
  * @param identity of the platform to get the navigation of.
  * @returns the platform's navigation.
  */
-export declare const getStorefrontNavigation: (provider: ProviderInfoInternal<'storefront'>) => Promise<[StorefrontNavigationSection?, StorefrontNavigationSection?]>;
+export declare const getStorefrontNavigation: (provider: ProviderInfoInternal<"storefront">) => Promise<[StorefrontNavigationSection?, StorefrontNavigationSection?]>;
 /**
  * A helper method that gets a Storefront navigation item by ID.
  * @param navigationItemId the id of the Storefront navigation item.
  * @param identity of the platform.
  * @returns the navigation item with the ID.
  */
-export declare const getStorefrontNavigationItemAppGrid: (navigationItemId: string, provider: ProviderInfoInternal<'storefront'>) => Promise<StorefrontNavigationItemAppGrid | undefined>;
+export declare const getStorefrontNavigationItemAppGrid: (navigationItemId: string, provider: ProviderInfoInternal<"storefront">) => Promise<StorefrontNavigationItemAppGrid | undefined>;

package/common/src/api/theming.d.ts

@@ -1,8 +1,8 @@
 import type { DefaultTheme } from 'styled-components';
 import type OpenFin from '@openfin/core';
-import { type ColorSchemeType, type ThemeSet } from '@openfin/ui-library';
-import { Palette } from '@openfin/ui-library/dist/theme';
+import { type ColorSchemeType, type ThemeSet, Palette } from '@openfin/ui-library';
 import { ColorSchemeOptionType } from '../../../client-api-platform/src/shapes';
+import type { generateTheme } from '@openfin/theme-engine';
 export type WorkspaceComponentSetSelectedSchemePayload = {
     newScheme: ColorSchemeOptionType;
     identity: OpenFin.Identity;
@@ -145,10 +145,19 @@ export type CustomThemeOptionsWithScheme = BaseThemeOptions & {
      */
     notificationIndicatorColors?: NotificationIndicatorColorsWithScheme;
 };
-export type CustomThemes = (CustomThemeOptions | CustomThemeOptionsWithScheme)[];
+export type ThemeOptions = BaseThemeOptions & {
+    seed: Parameters<typeof generateTheme>[0];
+    overrides?: Parameters<typeof generateTheme>[1];
+};
+type GenerateThemeReturn = ReturnType<typeof generateTheme>;
+export type GeneratedPalettes = Pick<GenerateThemeReturn, 'dark' | 'light'>;
+export type LegacyPalettes = CustomThemeOptions | CustomThemeOptionsWithScheme;
+export type GenerateThemeParams = Parameters<typeof generateTheme>;
+export type CustomThemes = (CustomThemeOptions | CustomThemeOptionsWithScheme | ThemeOptions)[];
 export interface PreloadedThemeData {
-    themes: CustomThemes;
+    themes: CustomThemes | GeneratedPalettes;
     selectedScheme: ColorSchemeOptionType;
+    themePaletteSheet?: string;
 }
 export interface DefaultPaletteSet {
     brandPrimary: string;
@@ -297,9 +306,9 @@ export declare const getComputedPaletteSets: (customTheme: CustomThemeOptions |
  * @param storedScheme sets the default scheme if provided
  * @returns array of {@link ComputedThemes | computed themes}
  */
-export declare const computeThemes: (customThemes: CustomThemes, storedScheme?: ColorSchemeOptionType) => ComputedThemes;
+export declare const computeThemes: (customThemes: CustomThemes | GeneratedPalettes, storedScheme?: ColorSchemeOptionType) => ComputedThemes;
 export declare const getComputedPlatformTheme: (platformIdentity: OpenFin.Identity) => Promise<ComputedTheme>;
 export declare const setSelectedScheme: (ctx: ColorSchemeOptionType) => Promise<void>;
-export declare const getComputedScheme: (identity?: OpenFin.Identity) => Promise<Exclude<ColorSchemeType, 'system'>>;
+export declare const getComputedScheme: (identity?: OpenFin.Identity) => Promise<Exclude<ColorSchemeType, "system">>;
 export declare const getComputedBackgroundColor: (paletteKey: keyof typeof Palette, defaultColor?: string) => Promise<string>;
 export {};

package/common/src/utils/enterprise-menu.d.ts

@@ -1,6 +1,6 @@
 import type OpenFin from '@openfin/core';
 import { EnterpriseMainContextMenuItemData, EnterpriseMainContextMenuItemTemplate, OpenGlobalContextMenuPayload } from '../../../client-api-platform/src/shapes';
-export declare const getEnterpriseContextMenuTemplate: ({ identity, selectedViews }: {
+export declare const getEnterpriseContextMenuTemplate: ({ identity }: {
     identity: OpenFin.Identity;
     selectedViews: OpenFin.Identity[];
 }) => Promise<EnterpriseMainContextMenuItemTemplate[]>;

package/common/src/utils/global-context-menu.d.ts

@@ -93,7 +93,7 @@ export declare const downloads: () => {
 export declare const appearance: () => {
     label: string;
 };
-export declare const getSavedWorkspaceContextMenuOptions: (activeWorkspace: Workspace, savedWorkspaces: Pick<Workspace, 'workspaceId' | 'title'>[], contextMenuOptionType: GlobalContextMenuOptionType) => {
+export declare const getSavedWorkspaceContextMenuOptions: (activeWorkspace: Workspace, savedWorkspaces: Pick<Workspace, "workspaceId" | "title">[], contextMenuOptionType: GlobalContextMenuOptionType) => {
     label: string;
     type: MenuItemType;
     enabled: boolean;

package/common/src/utils/layout.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="lodash" />
 import type OpenFin from '@openfin/core';
 import { WindowIdentity } from '../../../common/src/utils/window';
 import { AttachedPageInternal } from '../../../common/src/api/pages/shapes';
@@ -79,7 +78,7 @@ export declare const cloneLayoutAndRemoveNames: (layout: PageLayout) => any;
  * @returns A copy of the layout with generated names removed
  */
 export declare const cloneLayoutAndRemoveGeneratedNames: (layout: PageLayout) => any;
-export declare const mapContentComponentState: (content: OpenFin.LayoutContent) => OpenFin.LayoutComponent['componentState'][];
+export declare const mapContentComponentState: (content: OpenFin.LayoutContent) => OpenFin.LayoutComponent["componentState"][];
 export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<any>;
 export declare const layoutNameInitializedMap: Map<string, boolean>;
 export declare const isLayoutTabActive: (tabSelector: string) => boolean;

package/common/src/utils/logger.d.ts

@@ -0,0 +1,22 @@
+export declare const log: {
+    /**
+     * Calls console.debug with provided parameters and stringifies JS objects prior to logging
+     */
+    debug: (...args: unknown[]) => void;
+    /**
+     * Calls console.info with provided parameters and stringifies JS objects prior to logging
+     */
+    info: (...args: unknown[]) => void;
+    /**
+     * Calls console.warn with provided parameters and stringifies JS objects prior to logging
+     */
+    warn: (...args: unknown[]) => void;
+    /**
+     * Calls console.error with provided parameters and stringifies JS objects prior to logging
+     */
+    error: (...args: unknown[]) => void;
+    /**
+     * Calls console.trace with provided parameters and stringifies JS objects prior to logging
+     */
+    trace: (...args: unknown[]) => void;
+};