@openfin/workspace 17.0.12 → 17.2.1

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

@@ -1,6 +1,7 @@
 /**
  * This module exports only notifications types that are not defined in 'openfin-notifications' npm package
  */
+import { NotificationsCustomManifestOptions } from '../../../common/src/api/shapes/notifications';
 /**
  * Platform object to pass to `register` function.
  *
@@ -36,4 +37,5 @@ export interface NotificationsPlatform {
 }
 export interface NotificationsRegisterOptions {
     notificationsPlatformOptions?: NotificationsPlatform;
+    notificationsCustomManifest?: NotificationsCustomManifestOptions;
 }

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

@@ -0,0 +1,13 @@
+import { Locale } from '../../../client-api-platform/src/shapes';
+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";
+    resources: import("i18next/typescript/options").Resource;
+};
+/**
+ * initLanguage()
+ * @param language - optional - ISO language code
+ */
+export default function initLanguage(language?: Locale): Promise<void>;

package/client-api-platform/src/api/translation-override.d.ts

@@ -0,0 +1,19 @@
+import type { i18next as i18n } from '../../../common/src/api/i18next';
+/**
+ * Returns a score for a version string depending on how specific it is. Higher == more specific.
+ * E.g. 16.x.0 gives a score of 101 whereas 16.5.0 returns 111
+ * @param versionString 3-fragment version string, e.g. 15.0.4, where fragments can be 'x' for generic templates
+ * @returns score from 0 to 111
+ */
+export declare const weighVersionString: (versionString: string) => number;
+/**
+ * Returns array of versions from less specific to more specific
+ * @param matchingVersions versions and templates relevant to the running build
+ */
+export declare const getVersionsSortedByPriority: (matchingVersions: string[]) => string[];
+/**
+ * Applies translation overrides to the i18next dictionary.
+ * In case of failure logs an error without preventing further execution.
+ * @param i18next i18next instance to which to apply the overrides
+ */
+export declare const applyTranslationOverrides: (i18next: typeof i18n) => Promise<void>;

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

@@ -34,4 +34,4 @@ import type { WorkspacePlatformInitConfig } from '../shapes';
  * ```
  * @param options options for configuring the platform.
  */
-export declare const init: ({ theme, customActions, ...rest }: WorkspacePlatformInitConfig) => Promise<void>;
+export declare const init: ({ theme, customActions, language, ...rest }: WorkspacePlatformInitConfig) => Promise<void>;

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

@@ -1,3 +1,4 @@
 import type OpenFin from '@openfin/core';
+import { NotificationsCustomManifestOptions } from '../../../../common/src/api/shapes/notifications';
 import { BrowserInitConfig, WorkspacePlatformOverrideCallback, WorkspacePlatformProvider } from '../../../../client-api-platform/src/shapes';
-export declare const getOverrideCallback: (browserInitOptions: BrowserInitConfig | null, overrideCallback?: WorkspacePlatformOverrideCallback) => OpenFin.OverrideCallback<WorkspacePlatformProvider>;
+export declare const getOverrideCallback: (browserInitOptions: BrowserInitConfig | null, overrideCallback?: WorkspacePlatformOverrideCallback, notificationsConfig?: NotificationsCustomManifestOptions) => OpenFin.OverrideCallback<WorkspacePlatformProvider>;

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

@@ -0,0 +1,2 @@
+import type OpenFin from '@openfin/core';
+export declare const getInteropOverrideCallback: (overrideCallback?: OpenFin.OverrideCallback<OpenFin.InteropBroker, OpenFin.InteropBroker>) => OpenFin.OverrideCallback<OpenFin.InteropBroker, OpenFin.InteropBroker>;

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

@@ -2,8 +2,10 @@ import type OpenFin from '@openfin/core';
 import { 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';
 import type { AttachedPage, CopyPagePayload, HandleSaveModalOnPageClosePayload, Page, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult } from '../../common/src/api/pages/shapes';
 import { SetActivePageForWindowPayload } from '../../common/src/api/pages/shapes';
+import { NotificationsCustomManifestOptions } from '../../common/src/api/shapes/notifications';
 import type { CustomThemes } from '../../common/src/api/theming';
 import type { App, DockProviderConfigWithIdentity, StoreButtonConfig } from '../../client-api/src/shapes';
 import type { WorkflowIntegration } from '../../client-api/src/shapes/integrations';
@@ -1413,6 +1415,43 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      * ```
      */
     applyWorkspace(workspace: Workspace, options?: ApplyWorkspaceOptions): Promise<boolean>;
+    /**
+     * Returns ISO language code of current set language
+     *
+     * @returns One of the seven ISO language codes Browser supports
+     *
+     * @example Example of how to get the current language on Browser
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     * WorkspacePlatform.getCurrentSync().getLanguage();
+     * ```
+     */
+    getLanguage(): Promise<Locale>;
+    /**
+     * Fetches currently selected language and language resources from platform provider.
+     * @internal
+     */
+    _getLanguageResources(): Promise<{
+        currentLanguage: Locale;
+        resources: Resource;
+    }>;
+    /**
+     * Sets the language to ISO language code passed in
+     * @param locale the ISO language code
+     *
+     * @example Example of how to set a different language on Browser
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     * WorkspacePlatform.getCurrentSync().setLanguage('zh-CN');
+     * ```
+     */
+    setLanguage(locale: Locale): Promise<void>;
+    /**
+     * Implementation for getting the notifications workspace platform configuration.
+     */
+    getNotificationsConfig(): Promise<NotificationsCustomManifestOptions | undefined>;
     /**
      * The browser window factory for the Workspace Platform.
      */
@@ -1675,6 +1714,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];
 /**
  * Configuration for initializing a Workspace platform.
  */
@@ -1738,6 +1779,27 @@ 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'
+     *
+     * @example
+     * ```ts
+     * await WorkspacePlatform.init({
+     *   browser: {
+     *      title: "My Browser"
+     *   },
+     *   language: {
+     *      initialLanguage: 'ru-RU'
+     *   }
+     * });
+     * ```
+     * @default 'en-EN'
+     *
+     */
+    language?: {
+        initialLanguage?: Locale;
+    };
     /**
      * Override workspace platform behavior
      */
@@ -1774,6 +1836,11 @@ export interface WorkspacePlatformInitConfig {
      * ```
      */
     integrations?: WorkflowIntegration[];
+    /**
+     * Config for overriding default notifications behaviour.
+     * Leave undefined to use OpenFin hosted Notification Center.
+     */
+    notifications?: NotificationsCustomManifestOptions;
 }
 /**
  * Extend or replace default functionality in order to customize behavior of a Workspace Platform Provider.

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

@@ -0,0 +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 const t: import("i18next").TFunction<["translation", ...string[]], undefined>;
+export { initI18next, i18next, t, type Resource };
+export { useTranslation } from 'react-i18next';

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

@@ -17,6 +17,7 @@ export interface Overrides {
     browserBaseUrl: string;
     disableOpenFinAnalytics: boolean;
     analyticsEndpoint: string;
+    translationOverridesUrl: string;
 }
 export declare function getOverrides(): Promise<Partial<Overrides>>;
 export declare const useOverrides: () => Partial<Overrides>;

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

@@ -30,7 +30,8 @@ declare enum GeneralBrowserChannelActions {
     OpenSaveModalInternal = "open-save-modal-internal",
     DuplicatePage = "duplicate-page",
     SetSelectedScheme = "set-selected-scheme",
-    ShowBrowserIndicator = "show-browser-indicator"
+    ShowBrowserIndicator = "show-browser-indicator",
+    SetSelectedLanguage = "set-selected-language"
 }
 /**
  * All of the remote procedures that can be called in the
@@ -70,6 +71,7 @@ export declare const BrowserChannelAction: {
     DuplicatePage: GeneralBrowserChannelActions.DuplicatePage;
     SetSelectedScheme: GeneralBrowserChannelActions.SetSelectedScheme;
     ShowBrowserIndicator: GeneralBrowserChannelActions.ShowBrowserIndicator;
+    SetSelectedLanguage: GeneralBrowserChannelActions.SetSelectedLanguage;
 };
 export type BrowserChannelAction = typeof BrowserChannelAction;
 export {};

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

@@ -51,11 +51,15 @@ export declare enum WorkspacePlatformChannelAction {
     SetActiveWorkspace = "setActiveWorkspace",
     IsBrowserInitialized = "isBrowserInitialized",
     Analytics = "analyticsInternal",
+    GetLanguage = "getLanguage",
+    GetLanguageResourcesInternal = "getLanguageResourcesInternal",
+    SetLanguage = "setLanguage",
     GetDockProviderConfig = "getDockProviderConfig",
     SaveDockProviderConfig = "saveDockProviderConfig",
     HandleSaveModalOnPageClose = "handleSaveModalOnPageClose",
     CopyPage = "copyPage",
-    HandlePageChanges = "handlePageChanges"
+    HandlePageChanges = "handlePageChanges",
+    GetNotificationsConfig = "getNotificationsConfig"
 }
 export type PlatFormSupportedFeatures = boolean | {
     isWorkspacePlatform: boolean;

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

@@ -0,0 +1,15 @@
+/**
+ * Options for using privately hosted notification service.
+ */
+export type NotificationsCustomManifestOptions = {
+    /**
+     * A custom manifest location to start the notification service from.
+     * The UUID cannot be OpenFin hosted Notification Service UUID, 'notifications-service'.
+     */
+    manifestUrl: string;
+    /**
+     * The UUID of the provided custom notifications service manifest.
+     * This value **MUST** match the UUID of the manifest provided in `manifestUrl`.
+     */
+    manifestUuid: string;
+};

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

@@ -1,54 +1,4 @@
 import type OpenFin from '@openfin/core';
-import { MenuItemType } from '../../../common/src/utils/context-menu';
-import * as WP from '../../../client-api-platform/src/index';
-import { GlobalContextMenuItemTemplate, GlobalContextMenuOptionType, Workspace } from '../../../client-api-platform/src/shapes';
+import { GlobalContextMenuItemTemplate } from '../../../client-api-platform/src/shapes';
 export declare const isOSWindows: () => Promise<boolean>;
-export declare const savePage: {
-    type: MenuItemType;
-    label: string;
-    data: {
-        type: WP.GlobalContextMenuOptionType;
-    };
-};
-export declare const savePageAs: {
-    type: MenuItemType;
-    label: string;
-    data: {
-        type: WP.GlobalContextMenuOptionType;
-    };
-};
-export declare const saveWorkspace: {
-    type: MenuItemType;
-    label: string;
-    data: {
-        type: WP.GlobalContextMenuOptionType;
-    };
-};
-export declare const saveWorkspaceAs: {
-    type: MenuItemType;
-    label: string;
-    data: {
-        type: WP.GlobalContextMenuOptionType;
-    };
-};
-export declare const printMenuOptions: (isViewSelected: boolean) => Promise<GlobalContextMenuItemTemplate>;
-export declare const getSavedWorkspaceContextMenuOptions: (activeWorkspace: Workspace, savedWorkspaces: Workspace[], contextMenuOptionType: GlobalContextMenuOptionType) => {
-    label: string;
-    type: MenuItemType;
-    enabled: boolean;
-    checked: boolean;
-    data: {
-        type: WP.GlobalContextMenuOptionType;
-        workspaceId: string;
-    };
-}[];
-export declare const getAppearanceContextMenuOptions: () => Promise<{
-    label: string;
-    type: MenuItemType;
-    checked: boolean;
-    data: {
-        type: WP.GlobalContextMenuOptionType;
-        scheme: WP.ColorSchemeOptionType;
-    };
-}[]>;
 export declare const getGlobalContextMenuTemplate: (winIdentity: OpenFin.Identity, selectedViews?: OpenFin.Identity[]) => Promise<GlobalContextMenuItemTemplate[]>;

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

@@ -62,8 +62,6 @@ export declare const mapContentComponentState: (content: OpenFin.LayoutContent)
 export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<any>;
 export declare const isLayoutTabActive: (tabSelector: string) => boolean;
 export declare const containerId = "layout_container";
-export declare const getViewComponents: () => OpenFin.LayoutContent;
-export declare const removeLayoutView: (name: string) => Promise<void>;
 export declare const addLayoutEventListener: (event: LayoutDOMEventType, listener: LayoutDOMEventListener) => void;
 /**
  * Initialize the layout for the current OF window.

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

@@ -36,4 +36,5 @@ export interface RightButtonConfig {
 export type ButtonConfig = {
     label: string;
     type: 'primary' | 'secondary';
+    id: string;
 };