@openfin/workspace-platform 23.0.2 → 23.0.3

package/client-api-platform/src/api/app-directory.d.ts

@@ -7,7 +7,7 @@ import type { LaunchAppRequest, SearchSitesRequest, SearchSitesResponse, Site }
  * @param app the app directory entry.
  * @param opts launch options.
  */
-export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Identity | OpenFin.Application | OpenFin.View | OpenFin.Platform>;
+export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Identity | OpenFin.View | OpenFin.Platform | OpenFin.Application>;
 export declare const enterpriseAppDirectoryChannelClient: () => Promise<OpenFin.ChannelClient>;
 export declare function getResults(payload: {
     req: SearchSitesRequest;

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

@@ -1,5 +1,18 @@
 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) => GeneratedPalettes;
+/**
+ * Initialises the storage palettes from the custom themes. This function is called on platform init.
+ * This function takes both the legacy themes and the new theme system tokens and
+ * passes them into the theme engine to generate the css variables.
+ *
+ * @param customThemes the custom themes to initialise the storage palettes from.
+ * @param isWindows whether the operating system is Windows.
+ * @returns the generated palettes fromt the theme engine, theme palette sheet which is injected into the DOM, and legacy theme object if it exists.
+ */
+export declare const initialiseStoragePalettes: (customThemes: CustomThemes | undefined, isWindows: boolean) => {
+    generatedPalettes: GeneratedPalettes;
+    themePaletteSheet: string;
+    legacyTheme: CustomThemes | null;
+};
 export declare const getThemeStorageController: () => ThemeStorageController;

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

@@ -1,3 +1,4 @@
+import { GeneratedPalettes } from '../../../../common/src/api/theming';
 import { ColorSchemeOptionType, CustomPaletteSet } from '../../../../client-api-platform/src/shapes';
 /**
  * Palette extensions can be used to add new variables to the palette set.
@@ -40,8 +41,8 @@ export declare class ThemeStorageController {
     private lightPaletteVars?;
     private workspaceStorage?;
     private themePaletteSheet?;
+    private generatedPalettes?;
     constructor(providerStorage: Pick<Storage, 'getItem' | 'setItem'>);
-    private getVarsByScheme;
     /**
      * Set the current Storage Proxy to enable Workspace Storage properties to be populated.
      *
@@ -87,6 +88,7 @@ export declare class ThemeStorageController {
      * @param scheme The default scheme specified in the palette
      */
     setThemeDefaultScheme(scheme: ColorSchemeOptionType): void;
+    setGeneratedPalettes(generatedPalettes: GeneratedPalettes): void;
     /**
      * Returns the current scheme
      * @returns 'light' | 'system' | 'dark'

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

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

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

@@ -1420,12 +1420,27 @@ export interface LaunchAppRequest {
     target?: OpenFin.EntityInfo;
     app: App;
 }
-/**
- * Get Themes from API
- */
 export interface ThemeApi {
-    getThemes(): Promise<CustomThemes | GeneratedPalettes>;
+    /**
+     * @deprecated This method is deprecated. It is recommended to use {@link getGeneratedPalettes} instead.
+     * Get the legacy themes from the platform provider.
+     * @returns the legacy themes or null if the platform provider is using the new theme system.
+     */
+    getThemes(): Promise<CustomThemes | null>;
+    /**
+     * Get the generated palettes from the platform provider.
+     * @returns the generated palettes.
+     */
+    getGeneratedPalettes(): Promise<GeneratedPalettes>;
+    /**
+     * Set the selected scheme for the platform provider.
+     * @param newScheme the new scheme to set.
+     */
     setSelectedScheme(newScheme: ColorSchemeOptionType): Promise<void>;
+    /**
+     * Get the selected scheme from the platform provider.
+     * @returns the selected scheme.
+     */
     getSelectedScheme(): Promise<ColorSchemeOptionType>;
 }
 /**

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

@@ -35,6 +35,8 @@ export declare enum WorkspacePlatformChannelAction {
     GetLastFocusedBrowserWindow = "getLastFocusedBrowserWindow",
     GetPageByViewIdentity = "getPageByViewIdentity",
     GetThemes = "getThemes",
+    GetGeneratedPalettes = "getGeneratedPalettes",
+    GetThemePaletteSheet = "getThemePaletteSheet",
     GetSelectedScheme = "getSelectedScheme",
     SetSelectedScheme = "setSelectedScheme",
     OpenGlobalContextMenuInternal = "openGlobalContextMenuInternal",

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

@@ -19,8 +19,8 @@ export declare const launchProvider: () => Promise<void>;
  */
 export declare const getChannelClientAndLaunchProvider: () => Promise<WorkspaceComponentChannelClient>;
 /**
- * Launches the Workspace provider if it is not running.
+ * Gets the theme data from the Platform provider, then launches the Workspace provider if it is not running, and then dispatches the theme data to the Workspace provider.
  * Then gets a Channel Client that is connected to the Workspace Provider.
  * @returns the Channel Client that is connected to the Workspace Provider.
  */
-export declare const getClientAPIChannelClientAndLaunchProvider: () => Promise<WorkspaceAPIClientChannelClient>;
+export declare const getChannelClientAndInitializeWorkspaceProvider: () => Promise<WorkspaceAPIClientChannelClient>;

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

@@ -281,10 +281,11 @@ export declare const OpenFinDarkTheme: {
 export declare const DefaultOpenFinTheme: CustomThemes;
 export declare const getComputedPaletteSets: (customTheme: CustomThemeOptions | CustomThemeOptionsWithScheme) => WorkspaceThemeSet;
 export declare const getComputedPlatformTheme: (platformIdentity: OpenFin.Identity) => Promise<{
-    theme: GeneratedPalettes | CustomThemes;
+    theme: CustomThemes | GeneratedPalettes;
     defaultScheme: ColorSchemeOptionType;
 }>;
 export declare const setSelectedScheme: (ctx: ColorSchemeOptionType) => Promise<void>;
 export declare const getComputedScheme: (identity?: OpenFin.Identity) => Promise<Exclude<ColorSchemeType, "system">>;
-export declare const getComputedBackgroundColor: () => Promise<string>;
+export declare const getComputedBackgroundColor: (platformIdentity: OpenFin.Identity) => Promise<string>;
+export declare const constructThemePaletteSheet: (themes: GeneratedPalettes) => string;
 export {};