@openfin/workspace 45.1.19 → 45.2.0

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

@@ -1,7 +1,7 @@
 import type OpenFin from '@openfin/core';
 import { App } from '../../../client-api/src/shapes';
 import { SearchProvider } from '../../../client-api-platform/src/shapes';
-import type { LaunchAppRequest, SearchSitesRequest, SearchSitesResponse, Site } from '../shapes';
+import type { ContentSortRequest, LaunchAppRequest, SearchSitesRequest, SearchSitesResponse, Site } from '../shapes';
 /**
  * Launch the app described by an App Directory entry.
  * @param app the app directory entry.
@@ -19,7 +19,8 @@ export declare function getSearchProviders(payload: {
 }): Promise<SearchProvider[]>;
 export declare function getCuratedContent(payload: {
     identity: OpenFin.Identity;
+    req?: ContentSortRequest;
 }): Promise<Site[]>;
-export declare function getRecentlyVisited(payload: {
-    identity: OpenFin.Identity;
+export declare function getRecentlyVisited(payload: ContentSortRequest & {
+    identity?: OpenFin.Identity;
 }): Promise<App[]>;

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

@@ -1,2 +1,3 @@
 import { OpenFin } from '@openfin/core';
+export declare const INTERNAL_VIEW_PROCESS_AFFINITY = "eb-internal-ui";
 export declare const createNonLayoutViewComponents: (isEnterprise: boolean, overrideOptions: OpenFin.PlatformWindowCreationOptions) => Promise<void[]>;

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

@@ -1,8 +1,9 @@
 import type OpenFin from '@openfin/core';
+import type { BrowserCreateViewRequest } from '../../../../client-api-platform/src/shapes';
 type DefaultViewOptions = Partial<OpenFin.MutableViewOptions> & {
     downloadShelf?: OpenFin.ConstWindowOptions['downloadShelf'];
     hotkeys?: OpenFin.ViewOptions['hotkeys'];
 };
 export declare const DEFAULT_VIEW_OPTIONS: DefaultViewOptions;
-export declare function applyViewDefaults(options: Partial<OpenFin.ViewOptions>, initViewOptions?: Partial<OpenFin.ViewOptions>): Promise<any>;
+export declare function applyViewDefaults(options: Partial<BrowserCreateViewRequest>, initViewOptions?: Partial<BrowserCreateViewRequest>): Promise<any>;
 export {};

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

@@ -33,6 +33,12 @@ export interface PlatformCapabilities {
         dock?: boolean;
         notifications?: boolean;
     };
+    /**
+     * When true, co-bundled windows load locale JSON via i18next-http-backend
+     * instead of the `_getLanguageResources` IPC bulk transfer.
+     * @internal
+     */
+    httpLanguagePacks?: boolean;
 }
 /**
  * Request for creating a saved page in persistent storage.
@@ -200,7 +206,8 @@ export declare enum EnterpriseMainContextMenuOptionType {
     ManageDesktopSignals = "ManageDesktopSignals",// Enterprise
     FindInPage = "FindInPage",// Enterprise
     Print = "Print",
-    Pin = "Pin"
+    Pin = "Pin",
+    SetLanguage = "SetLanguage"
 }
 /** @internal */
 export declare enum BookmarkItemContextMenuOptionType {
@@ -216,6 +223,7 @@ export interface GlobalContextMenuItemData extends ContextMenuItemData {
 export interface EnterpriseMainContextMenuItemData extends ContextMenuItemData {
     type: GlobalContextMenuOptionType | EnterpriseMainContextMenuOptionType | ViewTabMenuOptionType;
     option?: string;
+    locale?: string;
 }
 export interface AddToChanel extends GlobalContextMenuItemData {
     workspaceId: string;
@@ -724,13 +732,23 @@ export interface BrowserWorkspacePlatformWindowOptions {
      */
     title?: WindowTitle | string;
     /**
-     * Landing page that shows up when you add a new tab from the plus button that exists in the tabstrip.
-     * If you do not provide a newTabUrl, then the plus button in the tabstrip will not be shown and users cannot create a new empty tab.
+     * URL used for new-tab actions: the plus button in the tabstrip, the new-tab hotkey, and the
+     * "New tab" context menu entry.
+     *
+     * If you do not provide a newTabUrl, then the plus button in the tabstrip will not be shown and
+     * users cannot create a new empty tab.
+     *
+     * This does not control a newly created window's initial content; that comes from `pages`.
      */
     newTabUrl?: string;
     /**
-     * Landing page that shows up when you add a new page from the plus button that exists in the window frame where the page selector is shown.
-     * If you do not provide a newPageUrl, then the new Page plus button will not be shown and you cannot create a new empty Page or Window.
+     * URL used for new-page and new-window actions.
+     *
+     * If you do not provide a newPageUrl, then the new Page plus button will not be shown and you
+     * cannot create a new empty Page or Window.
+     *
+     * This does not automatically control a newly created window's initial content; a caller of
+     * `Browser.createWindow` must include a page using this URL in `pages`.
      */
     newPageUrl?: string;
     toolbarOptions?: ToolbarOptions;
@@ -1266,10 +1284,8 @@ export interface BrowserWindowModule {
      * ```ts
      *
      * const newPage = await makeNewLandingPage();
-     * const { newPageUrl } = await getLandingPageUrls();
      * const browser = getCurrentSync().Browser.wrapSync(currentOFIdentity);
-     * const actualNewPageUrl = newPageUrl ? newPageUrl : undefined;
-     * await browser._addDefaultPage({ identity: currentOFIdentity, page: newPage, newPageUrl: actualNewPageUrl });
+     * await browser._addDefaultPage({ identity: currentOFIdentity, page: newPage });
      * ```
      * @param req the default page request object
      * @internal
@@ -1282,13 +1298,13 @@ export interface BrowserWindowModule {
     /** @internal */
     _trackVisitedSite(req: any): Promise<void>;
     /** @internal */
-    _getRecentlyVisitedSites(req?: number): Promise<any[]>;
+    _getRecentlyVisitedSites(req?: ContentSortRequest): Promise<any[]>;
     /** @internal */
     _getFrequentlyVisitedSites(req?: any): Promise<any[]>;
     /** @internal */
     _searchSites(req: SearchSitesRequest): Promise<SearchSitesResponse>;
     /** @internal */
-    _getCuratedContent(req?: any): Promise<Site[]>;
+    _getCuratedContent(req?: ContentSortRequest): Promise<Site[]>;
     /** @internal */
     _handleRequestNavigation(args: NavigationRequest): Promise<void>;
     /** @internal */
@@ -1339,6 +1355,7 @@ export type NavigationRequest = {
     action: 'result-selected';
     trigger?: SiteAction;
     site: Site;
+    openMode?: 'replace' | 'new-tab' | 'new-window';
 } | (SearchSitesRequest & {
     action: 'search-input';
 }));
@@ -1450,6 +1467,13 @@ export type CollectionSite = SiteInfo & {
  * @internal
  */
 export type Site = AppSite | WorkspaceSite;
+/**
+ * @internal
+ */
+export type ContentSortRequest = {
+    sortBy?: 'title' | 'timestamp' | 'createdAt';
+    sortOrder?: 'asc' | 'desc';
+};
 /**
  * @internal
  * action is undefined when the site is actioned with the default action.
@@ -3090,9 +3114,28 @@ export interface BrowserInitConfig {
     /** Default options when creating a new page. If `iconUrl`, `unsavedIconUrl`, `panels` or `closeButton` are not defined when creating a page, setting will default to `defaultPageOptions`. */
     defaultPageOptions?: Pick<Page, 'iconUrl' | 'unsavedIconUrl' | 'closeButton' | 'panels'>;
     /**
-     * The default options when creating a new browser window. Any option not included in WorkspacePlatform.getCurrentSync().Browser.createView(options) call will default to the value provided in this field.
+     * The default options when creating a new view. Any option not included in WorkspacePlatform.getCurrentSync().Browser.createView(options) call will default to the value provided in this field.
+     *
+     * @example
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * await WorkspacePlatform.init({
+     *   browser: {
+     *     defaultViewOptions: {
+     *       workspacePlatform: {
+     *         browserNavigationButtons: {
+     *           back: true,
+     *           forward: true,
+     *           reload: true
+     *         }
+     *       }
+     *     }
+     *   }
+     * });
+     * ```
      */
-    defaultViewOptions?: Partial<OpenFin.ViewOptions>;
+    defaultViewOptions?: Partial<BrowserCreateViewRequest>;
     /**
      * The platform title. UI friendly title for the platform in browser.
      */

package/common/src/api/flags/index.d.ts

@@ -0,0 +1,37 @@
+export declare enum Flag {
+    WorkspaceStorefrontEnabled = "WorkspaceStorefrontEnabled",
+    SentryEnabled = "SentryEnabled",
+    WorkspaceDockEnabled = "WorkspaceDockEnabled",
+    WorkspaceHomeEnabled = "WorkspaceHomeEnabled",
+    DevDebug = "DevDebug",
+    HttpLanguagePacksEnabled = "HttpLanguagePacksEnabled"
+}
+export type WorkspaceFlags = Record<Flag, boolean>;
+export declare const flags: Partial<WorkspaceFlags>;
+/**
+ * Initialize flags from overrides. This should be called early in the application lifecycle.
+ * This is a no-op if flags have already been initialized.
+ */
+export declare const initializeFlags: () => Promise<void>;
+/**
+ * Flag Interface --
+ *
+ * @example Enabled / Disabled Closures
+ * flag(
+ *     'feature',
+ *     () => 'Enabled Feature',
+ *     () => 'Disabled Feature'
+ * );
+ *
+ * @example Enabled only
+ * flag('feature', myFeatureFunc);
+ *
+ * @example Boolean
+ * flag('feature');
+ */
+export declare function flag<EnabledReturn, DisabledReturn>(flagName: Flag, cbEnabled?: () => EnabledReturn, cbDisabled?: () => DisabledReturn): EnabledReturn | DisabledReturn | boolean;
+declare global {
+    interface Window {
+        __WORKSPACE_FLAGS__: typeof flags;
+    }
+}

package/common/src/api/i18next-bundled-resources.d.ts

@@ -0,0 +1,7 @@
+import { type Resource } from 'i18next';
+/**
+ * All seven statically bundled locale dictionaries. Loaded only on the flag-off
+ * (legacy) path so the http regime does not pull non-English packs into the
+ * main common chunk.
+ */
+export declare const bundledResources: Resource;

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

@@ -1,5 +1,17 @@
 import i18next, { type Resource } from 'i18next';
 import { Locale } from '../../../client-api-platform/src/shapes';
+export type LanguagePacksRegime = 'http' | 'legacy';
+export declare const HTTP_BACKEND_REQUEST_OPTIONS: RequestInit;
+export declare const resolveLanguagePacksRegime: (httpFlagEnabled: boolean, languagePacksApiUrl?: string) => LanguagePacksRegime;
+export declare const getHttpBackendOptions: (loadPath: string) => {
+    loadPath: string;
+    requestOptions: RequestInit;
+};
+/**
+ * Overlay OFD's canonical en-US pack on the bootstrap stub.
+ * Fire-and-forget: first paint and the logo menu must not wait on this GET.
+ */
+export declare const overlayEnglishFromHttpBackend: () => 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>;

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

@@ -16,6 +16,16 @@ export interface Overrides {
     disableOpenFinAnalytics: boolean;
     analyticsEndpoint: string;
     translationOverridesUrl: string;
+    /**
+     * i18next-http-backend loadPath injected when org `languagePacks.enabled` is on
+     * (e.g. `${base}/platform/api/localization/{{lng}}/{{ns}}.json`).
+     */
+    languagePacksApiUrl: string;
+    /**
+     * BCP-47 tags shown in the Language submenu. This is the org Active set
+     * (HERE defaults and/or admin-uploaded packs), not only bundled client languages.
+     */
+    activeLanguages: string[];
     /**
      * WRK-4846
      * This property is internal but is being temporarily exposed for Wells Fargo.

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

@@ -272,8 +272,6 @@ export type AddDefaultPagePayload = {
     identity: OpenFin.Identity;
     /** The page to attach. */
     page: PageWithUpdatableRuntimeAttribs;
-    /** The newPageUrl provided. */
-    newPageUrl: string;
 };
 export type AddPagePayload = {
     /** The OF window identity to attach the pages to. */

package/common/src/utils/color-channels.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Kept in a standalone module with type-only imports so consumers can pull it in
+ * via the `@openfin/enterprise-api/color-channels` subpath without bundling the SDK.
+ *
+ * TODO: https://openfin.jira.com/browse/WRK-5704 - need to rewrite this to use color tokens
+ */
+export declare const ENTERPRISE_COLOR_CHANNELS: {
+    readonly blue: {
+        readonly name: "Blue";
+        readonly color: "#0091EB";
+    };
+    readonly indigo: {
+        readonly name: "Indigo";
+        readonly color: "#6450FF";
+    };
+    readonly pink: {
+        readonly name: "Pink";
+        readonly color: "#E878CF";
+    };
+    readonly teal: {
+        readonly name: "Teal";
+        readonly color: "#24D1D1";
+    };
+    readonly green: {
+        readonly name: "Green";
+        readonly color: "#00AF78";
+    };
+    readonly orange: {
+        readonly name: "Orange";
+        readonly color: "#FF7D37";
+    };
+    readonly red: {
+        readonly name: "Red";
+        readonly color: "#F94144";
+    };
+    readonly yellow: {
+        readonly name: "Yellow";
+        readonly color: "#F9C74F";
+    };
+    readonly gray: {
+        readonly name: "Gray";
+        readonly color: "#828788";
+    };
+};

package/common/src/utils/color-linking.d.ts

@@ -1,41 +1,4 @@
 import type OpenFin from '@openfin/core';
 import { ViewTabContextMenuTemplate } from '../../../client-api-platform/src/shapes';
 export declare const getChannelsMenuOptions: (channelsForViews: string[], colorGroups: OpenFin.ContextGroupInfo[]) => Promise<ViewTabContextMenuTemplate[]>;
-export declare const ENTERPRISE_COLOR_CHANNELS: {
-    readonly blue: {
-        readonly name: "Blue";
-        readonly color: "#0091EB";
-    };
-    readonly indigo: {
-        readonly name: "Indigo";
-        readonly color: "#6450FF";
-    };
-    readonly pink: {
-        readonly name: "Pink";
-        readonly color: "#E878CF";
-    };
-    readonly teal: {
-        readonly name: "Teal";
-        readonly color: "#24D1D1";
-    };
-    readonly green: {
-        readonly name: "Green";
-        readonly color: "#00AF78";
-    };
-    readonly orange: {
-        readonly name: "Orange";
-        readonly color: "#FF7D37";
-    };
-    readonly red: {
-        readonly name: "Red";
-        readonly color: "#F94144";
-    };
-    readonly yellow: {
-        readonly name: "Yellow";
-        readonly color: "#F9C74F";
-    };
-    readonly gray: {
-        readonly name: "Gray";
-        readonly color: "#828788";
-    };
-};
+export { ENTERPRISE_COLOR_CHANNELS } from './color-channels';

package/common/src/utils/enabled-locales.d.ts

@@ -0,0 +1,5 @@
+export type EnabledLocale = {
+    tag: string;
+    displayName: string;
+};
+export declare const getEnabledLocales: () => Promise<EnabledLocale[]>;

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

@@ -100,6 +100,9 @@ export declare const downloads: () => {
 export declare const appearance: () => {
     label: string;
 };
+export declare const language: () => {
+    label: string;
+};
 export declare const getSavedWorkspaceContextMenuOptions: (activeWorkspace: Workspace, savedWorkspaces: Pick<Workspace, "workspaceId" | "title">[], contextMenuOptionType: GlobalContextMenuOptionType) => {
     label: string;
     type: MenuItemType;
@@ -119,4 +122,13 @@ export declare const getAppearanceContextMenuOptions: () => Promise<{
         scheme: WP.ColorSchemeOptionType;
     };
 }[]>;
+export declare const getLanguageContextMenuOptions: () => Promise<{
+    label: string;
+    type: MenuItemType;
+    checked: boolean;
+    data: {
+        type: WP.EnterpriseMainContextMenuOptionType;
+        locale: string;
+    };
+}[]>;
 export declare const getGlobalContextMenuTemplate: (winIdentity: OpenFin.Identity, selectedViews?: OpenFin.Identity[]) => Promise<GlobalContextMenuItemTemplate[]>;

package/common/src/utils/landing-page.d.ts

@@ -3,14 +3,19 @@ interface LandingPageUrls {
     newPageUrl: string | false;
     newTabUrl: string | false;
 }
+/**
+ * Which window option supplies the landing URL: `newTabUrl` for a new tab, `newPageUrl` for a new
+ * page or window. Enterprise Browser presents pages as tabs, so both go through page creation.
+ */
+export type NewLandingPageUrlSource = 'newTab' | 'newPage';
 export declare const getLandingPageUrls: (winIdentity?: OpenFin.Identity) => Promise<LandingPageUrls>;
 export declare const checkHasNewTabUrl: () => Promise<boolean>;
 export declare const getNewLandingTabViewOptions: (target: OpenFin.Identity) => Promise<OpenFin.PlatformViewCreationOptions>;
 /**
  * Makes a new landing page.
  *
- * If winIdentity is specified, it uses the newPageUrl defined by the browser window options.
- * Otherwise, if the platform is Enterprise, it will use the landing page URL.
+ * If winIdentity is specified, it uses the URL defined by the browser window options for the given
+ * `urlSource`. Otherwise, if the platform is Enterprise, it will use the landing page URL.
  */
-export declare const makeNewLandingPage: (winIdentity?: OpenFin.Identity) => Promise<import("@client-platform/index").PageWithUpdatableRuntimeAttribs>;
+export declare const makeNewLandingPage: (winIdentity?: OpenFin.Identity, urlSource?: NewLandingPageUrlSource) => Promise<import("@client-platform/index").PageWithUpdatableRuntimeAttribs>;
 export {};

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

@@ -1,7 +1,7 @@
 import type OpenFin from '@openfin/core';
 import { WindowIdentity } from '../../../common/src/utils/window';
 import type { PagePinnedState } from '../../../common/src/api/pages/shapes';
-import { AttachedPage, PageLayout } from '../../../client-api-platform/src/shapes';
+import { AttachedPage, BrowserCreateViewRequest, PageLayout } from '../../../client-api-platform/src/shapes';
 export type LayoutDOMEventType = 
 /**
  * Fired when a tab is created in a container. (Emmitted by ??)
@@ -90,7 +90,7 @@ export declare const generateViewNameAndIdentifierNameIfNotExists: <T extends {
  * @param layout The Layout to be cloned
  * @returns A Promise resolving to a copy of the layout with view options converted
  */
-export declare const cloneLayoutAndConvertViewOptions: (layout: PageLayout, initViewOptions?: Partial<OpenFin.ViewOptions>) => Promise<PageLayout>;
+export declare const cloneLayoutAndConvertViewOptions: (layout: PageLayout, initViewOptions?: Partial<BrowserCreateViewRequest>) => Promise<PageLayout>;
 export declare const cloneViewComponentWithoutName: (componentState: any) => any;
 /**
  * Deep clones a layout and removes generated view names.

package/common/src/utils/local-storage-key.d.ts

@@ -6,6 +6,7 @@ declare enum LocalStorageKey {
     NewTabPageSort = "NewTabPageSort",
     DockPosition = "DockPosition",
     SelectedColorScheme = "SelectedColorScheme",
+    SelectedLanguage = "SelectedLanguage",
     ThemePaletteSheet = "ThemePaletteSheet",
     HasMovedStore = "HasMovedStore",
     PageDragState = "BrowserPageDragState",

package/common/src/utils/popup-window.d.ts

@@ -171,8 +171,5 @@ export type SearchMenuChannelResponse = {
 } | {
     type: 'single-provider-results-announcement';
     message: string;
-} | {
-    /** Landing page was clicked. Chrome collapses search if view-focused never arrived. */
-    type: 'page-clicked';
 };
 export {};

package/externals.report.json

@@ -2,7 +2,7 @@
     "@openfin/notifications": [
         {
             "type": "explicit",
-            "version": "45.1.0-alpha-5002",
+            "version": "45.2.0-alpha-5074",
             "packageName": "client-api/package.json",
             "issuer": "client-api/src/notifications.ts"
         }
@@ -46,7 +46,7 @@
     "react-i18next": [
         {
             "type": "explicit",
-            "version": "15.4.0",
+            "version": "^17.0.11",
             "packageName": "common/package.json",
             "issuer": "common/src/api/i18next.ts"
         }
@@ -54,7 +54,15 @@
     "i18next": [
         {
             "type": "explicit",
-            "version": "^23.7.16",
+            "version": "^26.3.6",
+            "packageName": "common/package.json",
+            "issuer": "common/src/api/i18next.ts"
+        }
+    ],
+    "i18next-http-backend": [
+        {
+            "type": "explicit",
+            "version": "^4.0.0",
             "packageName": "common/package.json",
             "issuer": "common/src/api/i18next.ts"
         }
@@ -68,6 +76,12 @@
         }
     ],
     "dexie": [
+        {
+            "type": "explicit",
+            "version": "^4.0.11",
+            "packageName": "common/package.json",
+            "issuer": "common/src/api/pages/idb.ts"
+        },
         {
             "type": "root-implicit",
             "version": "^4.0.11",
@@ -80,12 +94,6 @@
             "packageName": "client-api-platform/package.json",
             "issuer": "client-api-platform/src/api/dock/idb.ts"
         },
-        {
-            "type": "explicit",
-            "version": "^4.0.11",
-            "packageName": "common/package.json",
-            "issuer": "common/src/api/pages/idb.ts"
-        },
         {
             "type": "explicit",
             "version": "^4.0.11",