@openfin/workspace 20.1.13 → 20.1.14

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

@@ -3,11 +3,12 @@ export declare function getLanguage(): Locale;
 export declare const dispatchLanguageToBrowserWindows: (language: Locale) => Promise<void[]>;
 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";
+    currentLanguage: string;
     resources: import("i18next/typescript/options").Resource;
 };
 /**
  * initLanguage()
- * @param language - optional - ISO language code
+ * @param language - optional - ISO language code. Built-in languages are always accepted.
+ * Any language code defined in the external `translation-override.json` is also accepted.
  */
 export default function initLanguage(language?: Locale): Promise<void>;

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

@@ -1,5 +1,5 @@
 import type OpenFin from '@openfin/core';
-import { IconProps, Languages } from '@openfin/ui-library';
+import type { IconProps } from '@openfin/ui-library';
 import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/utils/usage-register';
 import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 import { Resource } from '../../common/src/api/i18next';
@@ -1746,9 +1746,9 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      */
     applyWorkspace(workspace: Workspace, options?: ApplyWorkspaceOptions): Promise<boolean>;
     /**
-     * Returns ISO language code of current set language
+     * Returns the ISO language code of the currently active language.
      *
-     * @returns One of the seven ISO language codes Browser supports
+     * @returns The active language code (e.g. `'en-US'`, `'es-ES'`).
      *
      * @example Example of how to get the current language on Browser
      *
@@ -2152,8 +2152,73 @@ export interface AnalyticsConfig {
      */
     sendToOpenFin: boolean;
 }
-export { SUPPORTED_LANGUAGES } from '@openfin/ui-library';
-export type Locale = Languages;
+/**
+ * The built-in language codes supported by the Workspace Platform out of the box.
+ *
+ * @deprecated No longer used for language validation. The platform now accepts any language
+ * code that has a resource bundle registered in i18next, including codes defined in an
+ * external `translation-override.json`. This export will be removed in a future major version.
+ */
+export declare const SUPPORTED_LANGUAGES: string[];
+/**
+ * An ISO language code accepted by the Workspace Platform.
+ *
+ * **Built-in languages** (supported out of the box):
+ * - `en-US` — English (default)
+ * - `de-DE` — German
+ * - `ja-JP` — Japanese
+ * - `ko-KR` — Korean
+ * - `ru-RU` — Russian
+ * - `zh-CN` — Chinese (Simplified)
+ * - `zh-Hant` — Chinese (Traditional)
+ *
+ * **Adding custom languages** via `translationOverridesUrl`:
+ *
+ * Supply a `translationOverridesUrl` in your Desktop Owner Settings (DOS) or application manifest
+ * pointing to a `translation-override.json` file. Any language code defined in that file will be
+ * accepted at runtime in addition to the built-in list above.
+ *
+ * Example `translation-override.json`:
+ * ```json
+ * {
+ *   "x.x.x": {
+ *     "es-ES": {
+ *       "global.save": "Guardar",
+ *       "contextMenu.newWindow": "Nueva ventana"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * The `translationOverridesUrl` can be configured in two ways:
+ *
+ * _Via Desktop Owner Settings_ (`dos.json` on macOS, registry on Windows):
+ * ```json
+ * {
+ *     "desktopSettings": {
+ *         "systemApps": {
+ *             "workspace": {
+ *                 "customConfig": {
+ *                     "translationOverridesUrl": "https://example.com/translation-override.json"
+ *                 }
+ *             }
+ *         }
+ *     }
+ * }
+ * ```
+ *
+ * _Via the application manifest_ (under `platform.workspace`):
+ * ```json
+ * {
+ *   "platform": {
+ *     "workspace": {
+ *       "translationOverridesUrl": "https://example.com/translation-override.json"
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export type Locale = string;
 /**
  * Configures the workspace to self-host using an asar bundle at the
  * specified path.
@@ -2241,8 +2306,12 @@ export interface WorkspacePlatformInitConfig {
      */
     theme?: CustomThemes;
     /**
-     * Set a language on Browser by providing one of the seven languages that Workspace supports
-     * Must specify one of the ISO language codes 'en-US', 'ja-JP', 'zh-CN', 'ko-KR', 'ru-RU', 'de-DE' or 'zh-Hant'
+     * Set the initial language for the Browser.
+     *
+     * The built-in ISO language codes are `'en-US'`, `'ja-JP'`, `'zh-CN'`, `'ko-KR'`,
+     * `'ru-RU'`, `'de-DE'`, and `'zh-Hant'`. Any additional language code defined in an
+     * external `translation-override.json` (configured via `translationOverridesUrl`) is
+     * also accepted.
      *
      * @example
      * ```ts
@@ -2255,7 +2324,7 @@ export interface WorkspacePlatformInitConfig {
      *   }
      * });
      * ```
-     * @default 'en-EN'
+     * @default 'en-US'
      *
      */
     language?: {

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

@@ -1,7 +1,7 @@
 import i18next, { type Resource } from 'i18next';
 import { Locale } from '../../../client-api-platform/src/shapes';
-declare function initI18next(language?: Locale): void;
-export declare const setLanguageInI18next: (locale: Locale) => void;
+declare function initI18next(language?: Locale): Promise<void>;
+export declare const setLanguageInI18next: (locale: Locale) => Promise<void>;
 declare const t: import("i18next").TFunction<["translation", ...string[]], undefined>;
 export { initI18next, i18next, t, type Resource };
 export { useTranslation } from 'react-i18next';