@openfin/workspace-platform 23.0.1 → 23.0.3

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

@@ -1,5 +1,5 @@
 /**
- * WARNING: Do not export from './notifications' here. Not unless we move 'openfin-notifications' here.
+ * WARNING: Do not export from './notifications' here. Not unless we move '@here-io/notifications' here.
  */
 export * from './common';
 export * from './home';

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.
      *
@@ -62,7 +63,7 @@ export declare class ThemeStorageController {
      * Synchronize the current palette and scheme with workspace's storage instance if
      * storage based theming is enabled. Only syncs when user has explicitly selected a scheme.
      */
-    trySynchronizeWorkspaceStorage: () => void;
+    trySynchronizeWorkspaceStorage: () => Promise<void>;
     /**
      * Set the current Palette to be used by workspace. This palette will be converted into
      * css vars and combined into a single stylesheet. This stylesheet is exposed in localstorage
@@ -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

@@ -364,6 +364,7 @@ export declare enum BrowserButtonType {
     LockUnlockPage = "LockUnlockPage",
     SaveMenu = "SaveMenu",
     SavePage = "SavePage",
+    Download = "Download",
     Minimise = "Minimise",
     Maximise = "Maximise",
     Close = "Close",
@@ -1419,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>;
 }
 /**
@@ -1592,6 +1608,7 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
     setLanguage(locale: Locale): Promise<void>;
     /**
      * Implementation for getting the notifications workspace platform configuration.
+     * @deprecated Notifications config is now part of the platform manifest and is automatically resolved by the notifications API. Do not use this method as it will not return the correct configuration.
      */
     getNotificationsConfig(): Promise<NotificationsCustomManifestOptions | undefined>;
     /**
@@ -2086,6 +2103,7 @@ export interface WorkspacePlatformInitConfig {
     /**
      * Config for overriding default notifications behaviour.
      * Leave undefined to use OpenFin hosted Notification Center.
+     * @deprecated Notifications config is now part of the platform manifest and is automatically resolved by the notifications API. Do not use this property as it will not have any effect.
      */
     notifications?: NotificationsCustomManifestOptions;
     /**

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

@@ -1,5 +1,6 @@
 import type OpenFin from '@openfin/core';
 import { ColorSchemeOptionType } from '../../../../client-api-platform/src/shapes';
+import { NotificationsCustomManifestOptions } from '../shapes/notifications';
 export declare const NOTIFICATIONS_SYNC_CHANNEL = "of-workspace-notifications-sync";
 export declare enum NotificationsChannelAction {
     UpdatePlatformThemeScheme = "update-platform-theme-scheme"
@@ -10,5 +11,11 @@ export interface UpdatePlatformSchemePayload {
 interface NotificationsSyncChannelClient extends OpenFin.ChannelClient {
     dispatch(action: NotificationsChannelAction.UpdatePlatformThemeScheme, payload: UpdatePlatformSchemePayload): Promise<void>;
 }
+export type ManifestNotificationsConfig = {
+    notifications?: {
+        customManifest?: NotificationsCustomManifestOptions;
+    };
+};
+export declare function getNotificationCenterUuid(): Promise<string>;
 export declare const getNotificationsSyncChannelClient: () => Promise<NotificationsSyncChannelClient>;
 export {};

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",
@@ -78,7 +80,7 @@ export declare enum WorkspacePlatformChannelAction {
     HandleRequestNavigationInternal = "handleRequestNavigationInternal",// Enterprise
     RefreshBookmarksInternal = "refreshBookmarksInternal",// Enterprise
     LaunchBookmarkInternal = "launchBookmarkInternal",// Enterprise
-    GetNotificationsConfig = "getNotificationsConfig",
+    GetNotificationsConfig = "getNotificationsConfig",// Deprecated
     UpdateDockFavoritesInternal = "updateDockFavoritesInternal",// Enterprise
     UpdateContentMenuInternal = "updateContentMenuInternal",// Enterprise
     LaunchDockEntryInternal = "launchDockEntryInternal",// Enterprise

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/shapes/notifications.d.ts

@@ -1,5 +1,6 @@
 /**
  * Options for using privately hosted notification service.
+ * @deprecated Custom manifest is now part of the platform manifest and is automatically resolved by the notifications API. Do not use this type as it will be ignored.
  */
 export type NotificationsCustomManifestOptions = {
     /**

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

@@ -286,5 +286,6 @@ export declare const getComputedPlatformTheme: (platformIdentity: OpenFin.Identi
 }>;
 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 {};