@openfin/workspace-platform 17.2.8 → 17.2.10

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

@@ -3,7 +3,7 @@ export declare const getThemes: () => CustomThemes;
 /**
  * initTheming()
  * Accepts an array of CustomThemes objects and stores it
- * @param customPaletteOptions - optional - array of custom color pallettes
+ * @param customThemes array of theme objects
  * @returns array of custom theme objects
  */
-export default function initTheming(customPalettes: CustomThemes): void;
+export default function initTheming(customThemes: CustomThemes): void;

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

@@ -0,0 +1 @@
+export {};

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

@@ -1,5 +1,5 @@
 import type OpenFin from '@openfin/core';
-import { IconProps } from '@openfin/ui-library';
+import { IconProps, Languages } from '@openfin/ui-library';
 import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/utils/usage-register';
 import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 import type { AttachedPage, CopyPagePayload, HandleSaveModalOnPageClosePayload, Page, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult } from '../../common/src/api/pages/shapes';
@@ -13,7 +13,7 @@ export type { App, AppIntent, Image } from '../../client-api/src/shapes';
 export type { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 export type { AttachedPage, Page, PageLayout, PageLayoutDetails, PageWithUpdatableRuntimeAttribs, PanelConfigHorizontal, PanelConfigVertical, PanelConfig, ExtendedPanelConfig, CopyPagePayload, HandleSaveModalOnPageClosePayload, SaveModalOnPageCloseResult, SetActivePageForWindowPayload } from '../../common/src/api/pages/shapes';
 export { PanelPosition } from '../../common/src/api/pages/shapes';
-export type { CustomThemes, CustomThemeOptions, CustomThemeOptionsWithScheme, CustomPaletteSet, BaseThemeOptions, ThemeExtension, WorkspaceThemePaletteSet, NotificationIndicatorColorsSet, NotificationIndicatorColorsSetDarkScheme, NotificationIndicatorColorsSetLightScheme, NotificationIndicatorColorsWithScheme } from '../../common/src/api/theming';
+export type { CustomThemes, CustomThemeOptions, CustomThemeOptionsWithScheme, CustomPaletteSet, BaseThemeOptions, ThemeExtension, WorkspaceThemeSet, NotificationIndicatorColorsSet, NotificationIndicatorColorsSetDarkScheme, NotificationIndicatorColorsSetLightScheme, NotificationIndicatorColorsWithScheme } from '../../common/src/api/theming';
 export type { AnalyticsEvent } from '../../common/src/utils/usage-register';
 export type { WorkflowIntegration } from '../../client-api/src/shapes/integrations';
 /**
@@ -1548,6 +1548,16 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
      * the original page will remain after 'Save As' is performed.
      */
     copyPage(payload: CopyPagePayload): Promise<Page>;
+    /**
+     * Implementation for getting current selected language
+     * @returns language in ISO language code
+     */
+    getLanguage(): Promise<Locale>;
+    /**
+     * Implementation for setting a language
+     * @param locale in ISO language code format
+     */
+    setLanguage(locale: Locale): Promise<void>;
 }
 /**
  * The origins from which a custom action can be invoked
@@ -1639,8 +1649,8 @@ export interface AnalyticsConfig {
      */
     sendToOpenFin: boolean;
 }
-export declare const SUPPORTED_LANGUAGES: readonly ["en-US", "ja-JP", "zh-CN", "ko-KR", "ru-RU", "de-DE", "zh-Hant"];
-export type Locale = (typeof SUPPORTED_LANGUAGES)[number];
+export { SUPPORTED_LANGUAGES } from '@openfin/ui-library';
+export type Locale = Languages;
 /**
  * Configuration for initializing a Workspace platform.
  */

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

@@ -1,6 +1,6 @@
 import type { DefaultTheme } from 'styled-components';
 import type OpenFin from '@openfin/core';
-import type { ThemePaletteSet } from '@openfin/ui-library';
+import { ColorSchemeType, ThemeSet } from '@openfin/ui-library';
 import { ColorSchemeOptionType } from '../../../client-api-platform/src/shapes';
 export type WorkspaceComponentSetSelectedSchemePayload = {
     newScheme: ColorSchemeOptionType;
@@ -10,10 +10,10 @@ export type ComputedThemes = ComputedTheme[];
 export interface ComputedTheme {
     label: string;
     logoUrl?: string;
-    theme: WorkspaceThemePaletteSet;
+    theme: WorkspaceThemeSet;
     defaultScheme?: ColorSchemeOptionType;
 }
-export interface WorkspaceThemePaletteSet extends ThemePaletteSet {
+export interface WorkspaceThemeSet extends ThemeSet {
     light: ThemeExtension;
     dark: ThemeExtension;
 }
@@ -74,7 +74,7 @@ export interface CustomThemeOptionsWithScheme extends BaseThemeOptions {
      *
      * @default 'dark'
      */
-    default?: 'light' | 'dark';
+    default?: Omit<ColorSchemeType, 'system'>;
     /**
      * The palette for this theme.
      *