@openfin/workspace 24.1.1 → 24.1.2-alpha.c84bc0a1

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

@@ -7,7 +7,7 @@ import type { LaunchAppRequest, SearchSitesRequest, SearchSitesResponse, Site }
  * @param app the app directory entry.
  * @param opts launch options.
  */
-export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Identity | OpenFin.Platform | OpenFin.View | OpenFin.Application>;
+export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.View | OpenFin.Identity | OpenFin.Platform | OpenFin.Application>;
 export declare const enterpriseAppDirectoryChannelClient: () => Promise<OpenFin.ChannelClient>;
 export declare function getResults(payload: {
     req: SearchSitesRequest;

package/client-api-platform/src/api/controllers/storage-proxies/channel-storage-proxy.d.ts

@@ -0,0 +1,19 @@
+import { StorageProxy } from '../../../../../client-api-platform/src/api/utils';
+/**
+ * Channel Storage Proxy allows population of storage keys in a different origin, assuming that origin has set up
+ * a storage proxy on the specified URL.
+ *
+ * This is useful for writing to the localStorage of workspace when the provider is on a different origin.
+ */
+export declare class ChannelStorageProxy implements StorageProxy {
+    #private;
+    constructor(url: string);
+    get isDestroyed(): boolean;
+    /**
+     * Sets a key in the proxied storage partition.
+     * @param key Key to set
+     * @param value Value.
+     */
+    setItem(key: string, value: string): Promise<void>;
+    destroy(): Promise<void>;
+}

package/client-api-platform/src/api/controllers/storage-proxies/local-storage-proxy.d.ts

@@ -0,0 +1,12 @@
+import { StorageProxy } from '../../../../../client-api-platform/src/api/utils';
+/**
+ * LocalStorage backed StorageProxy, for use in same origin scenarios (i.e. when the provider and workspace UI are guaranteed
+ * to share a storage partition).
+ */
+export declare class LocalStorageProxy implements StorageProxy {
+    #private;
+    constructor(storage: Pick<Storage, 'setItem'>);
+    setItem(key: string, value: string): Promise<void>;
+    destroy(): Promise<void>;
+    get isDestroyed(): boolean;
+}

package/client-api-platform/src/api/controllers/theme-storage-controller-store.d.ts

@@ -17,3 +17,20 @@ export declare const initialiseStoragePalettes: (customThemes: CustomThemes | un
     notificationIndicatorColors: NotificationIndicatorColorsParsed | null;
 };
 export declare const getThemeStorageController: () => ThemeStorageController;
+/**
+ * Resolves when the first theme sync completes. Use this to ensure that we do not launch UI such as browser until this has completed.
+ *
+ * @param allowFailure Whether to suppress rejections and continue anyway. Recommended for most use cases.
+ */
+export declare const waitForFirstThemeSync: (allowFailure?: boolean) => Promise<void>;
+/**
+ * Creates and initialises the Theme Storage Controller singleton.
+ *
+ * Triggers the first theme sync, but does not await it. To ensure dependent UI can guarantee the theme palette is synced,
+ * you can call `await waitForFirstThemeSync` (e.g. in the createWindow provider override).
+ *
+ * @param isEnterprise Whether in enterprise mode (allows using local storage proxy directly).
+ * @param baseUrl Base url of the hosted workspace UI.
+ * @param syncTimeout How long `waitForFirstThemeSync` should wait before rejecting.
+ */
+export declare const initialiseThemeController: (isEnterprise: boolean, baseUrl: string, syncTimeout: number) => void;

package/client-api-platform/src/api/controllers/theme-storage-controller.d.ts

@@ -24,37 +24,29 @@ export type Palettes = {
     dark: string;
 };
 export declare class ThemeStorageController {
+    #private;
     private providerStorage;
     private darkPaletteVars?;
     private lightPaletteVars?;
     private themePaletteSheet?;
     private generatedPalettes?;
     private workspaceStorage?;
-    private recreateFactory?;
+    private storageFactory?;
     private isLegacySinglePaletteTheme;
     constructor(providerStorage: Pick<Storage, 'getItem' | 'setItem' | 'removeItem'>);
     /**
-     * Set the current Storage Proxy to enable Workspace Storage properties to be populated.
-     */
-    setWorkspaceStorageProxy: (proxy: StorageProxy) => void;
-    /**
-     * Set a factory to recreate the storage proxy if it was destroyed (e.g. when a new browser
-     * window is opened after the last one closed with preventQuitOnLastWindowClosed true).
-     * Called once at platform init; avoids createWindow needing URL/env dependencies.
+     * Sets the storage factory. This can only be done once, and will throw for subsequent calls.
+     *
+     * All storage writes will be pending until the factory is created.
+     * @param factory
      */
-    setRecreateFactory: (factory: () => Promise<StorageProxy>) => void;
+    setStorageFactory: (factory: () => StorageProxy) => void;
     /**
      * Close the storage proxy window and clear the reference. Called when the last browser window
      * closes so the platform can quit (storage proxy would otherwise keep the process alive).
-     * Clears the reference before awaiting destroy() to avoid a race with ensureWorkspaceStorageProxy.
+     * Clears the reference before awaiting destroy() to avoid a race with getOrCreateStorageProxy.
      */
     destroyWorkspaceStorageProxy: () => Promise<void>;
-    /**
-     * Ensure the workspace storage proxy exists, recreating via the factory set at init if it was
-     * previously destroyed. No-op if no factory was set (e.g. in tests). Call before using
-     * workspace storage (e.g. when creating a browser window).
-     */
-    ensureWorkspaceStorageProxy: () => Promise<void>;
     /**
      * Check if there's an explicit user preference stored in localStorage.
      * A user preference is indicated by the presence of a SelectedColorScheme key. Which is something assigned if you click on the Appearance dropdown.
@@ -63,11 +55,9 @@ export declare class ThemeStorageController {
     private hasUserPreference;
     /**
      * 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.
-     *
-     * Wrapped in try/catch so it does not throw
+     * storage based theming is enabled.
      */
-    trySynchronizeWorkspaceStorage: () => Promise<void>;
+    synchronizeWorkspaceStorage: () => 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

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

@@ -2,11 +2,6 @@ export declare const listenForStoreClose: () => void;
 export type StorageProxy = {
     setItem: (data: string, value: string) => Promise<void>;
     destroy: () => Promise<void>;
+    isDestroyed: boolean;
 };
-export declare const createStorageProxy: (url: string, isEnterprise: boolean) => Promise<StorageProxy>;
-/**
- * Ensure the workspace storage proxy window exists. Recreates it if it was previously destroyed
- * (e.g. when the last browser window closed with preventQuitOnLastWindowClosed true and a new
- * browser window is now being created). Uses the factory registered at init; no-op in tests.
- */
-export declare const ensureWorkspaceStorageProxy: () => Promise<void>;
+export declare const getStorageFactory: (isEnterprise: boolean, baseUrl: string) => (() => StorageProxy);

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

@@ -1,5 +1,6 @@
 import OpenFin from '@openfin/core';
 import { WorkspacePlatformInitConfig } from '../../../client-api-platform/src/shapes';
+export declare const MAX_FIRST_THEME_SYNC_WAIT = 3000;
 /**
  * Initilaize a Workspace Platform.
  *
@@ -35,4 +36,4 @@ import { WorkspacePlatformInitConfig } from '../../../client-api-platform/src/sh
  * ```
  * @param options options for configuring the platform.
  */
-export declare const init: ({ theme, customActions, language, ...rest }: WorkspacePlatformInitConfig) => Promise<OpenFin.Platform>;
+export declare const init: (config: WorkspacePlatformInitConfig) => Promise<OpenFin.Platform>;

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

@@ -1,6 +1,7 @@
 import type OpenFin from '@openfin/core';
 import type { IconProps, IconType, Languages } from '@openfin/ui-library';
 import type { ModalResponseEvent } from '../../common/src/utils/menu-window-provider';
+import type { WorkspaceIndicatorConfig } from '../../common/src/utils/indicators/workspace-indicators';
 import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/utils/usage-register';
 import type { BaseCustomDropdownItem, CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 import type { Resource } from '../../common/src/api/i18next';
@@ -160,6 +161,10 @@ export declare enum PageTabContextMenuOptionType {
     Save = "Save",
     SaveAs = "Save As",
     NewPage = "New Page",
+    /** Enterprise Browser: toggle Golden Layout view tab headers (multi-view Supertabs).
+     * @internal
+     */
+    ShowHideTabs = "ShowHideTabs",// Enterprise
     DeletePage = "Delete Page",// Enterprise
     SaveWorkspaceAs = "SaveWorkspaceAs",// Enterprise
     Refresh = "Refresh",// Enterprise
@@ -175,7 +180,6 @@ export declare enum PageTabContextMenuOptionType {
 /** @internal */
 export declare enum EnterpriseMainContextMenuOptionType {
     Lock = "Lock",
-    ShowHideTabs = "ShowHideTabs",
     AddToChanel = "AddToChannel",
     ManageDesktopSignals = "ManageDesktopSignals",// Enterprise
     FindInPage = "FindInPage",// Enterprise
@@ -848,6 +852,13 @@ export interface BrowserWorkspacePlatformWindowOptions {
      * When true, disables the ability to close pages in the window. False by default.
      */
     preventPageClose?: boolean;
+    /**
+     * When true, disables the find in page feature for the window.
+     * The find in page view will not be created and no find in page logic will run.
+     * This option must be set at window creation time and cannot be changed dynamically.
+     * False by default.
+     */
+    disableFindInPage?: boolean;
     /**
      * Taskbar Icon for the Browser Window. If light and dark icon are defined, then the taskbar icon will change when the scheme changes.
      */
@@ -3020,6 +3031,23 @@ export interface BrowserInitConfig {
      * Defaults to `false` (current unique-title behavior preserved).
      */
     allowDuplicatePageTitles?: boolean;
+    /**
+     * Opt-in suppression flags for workspace success indicators.
+     * Both flags default to `false`; existing platforms see no behaviour change.
+     *
+     * @example
+     * ```ts
+     * await WorkspacePlatform.init({
+     *   browser: {
+     *     indicators: {
+     *       suppressWorkspaceSwitched: true,
+     *       suppressWorkspaceSaved: true,
+     *     },
+     *   },
+     * });
+     * ```
+     */
+    indicators?: WorkspaceIndicatorConfig;
 }
 interface WorkspaceMetadata {
     APIVersion: string;

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

@@ -32,6 +32,8 @@ export interface Page {
     panels?: PanelConfig[];
     /** Used to define the context group for the page */
     contextGroup?: string;
+    /** When true, view tab headers within this Supertab are hidden. */
+    viewTabsHidden?: boolean;
     /** Optional property to attach custom metadata to the page object, such as version or timestamp. Must be serializable. */
     customData?: any;
     /** True when this page is an admin-published supertab. */

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

@@ -96,12 +96,20 @@ export type AttachedPageInternal = {
     isLayoutCreated?: boolean;
     pageIcon?: string;
     isPublished?: boolean;
+    /** Enterprise Browser: hide Golden Layout view tab headers (multi-view Supertabs).
+     * @internal
+     */
+    viewTabsHidden?: boolean;
 } & AttachedPage;
 export type ReparentAttachedPage = AttachedPage & {
     multiInstanceViewBehavior?: 'reparent';
 };
 export type PageWithUpdatableRuntimeAttribs = Page & Pick<AttachedPage, 'hasUnsavedChanges'> & {
     multiInstanceViewBehavior?: OpenFin.MultiInstanceViewBehavior;
+    /** Enterprise Browser: hide Golden Layout view tab headers (multi-view Supertabs).
+     * @internal
+     */
+    viewTabsHidden?: boolean;
 };
 export interface DetachPagesFromWindowPayload {
     /** The OF window identity to detach the pages from. */

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

@@ -11,7 +11,7 @@ export declare const isDocumentDefined: boolean;
 export declare const isWindowDefinedWithIndexDB: boolean;
 export declare const finUUID: string;
 export declare const finName: string;
-export declare const finEntityType: "" | "view" | "window";
+export declare const finEntityType: "" | "window" | "view";
 export declare const isEnvLocal: boolean;
 export declare const isEnvDev: boolean;
 export declare const isEnvStaging: boolean;

package/common/src/utils/indicators/showIndicator.d.ts

@@ -50,6 +50,13 @@ export declare function showSuccess(payload: ShowSuccessPayload): Promise<void>;
  */
 export declare function showInfo(payload: ShowInfoPayload): Promise<void>;
 /**
- * Creates a window centered on monitor containing a success indicator for switching workspaces
+ * Creates a window centered on monitor containing a success indicator for switching workspaces.
+ * No-ops when `suppressWorkspaceSwitched` has been set via `BrowserInitConfig.indicators`.
  */
 export declare function showSwitchWorkspaceSuccess(): Promise<void>;
+/**
+ * Creates a success indicator for workspace save and save-as operations.
+ * No-ops when `suppressWorkspaceSaved` has been set via `BrowserInitConfig.indicators`.
+ * Rename operations are intentionally unaffected — use `showSuccess` directly for those.
+ */
+export declare const showWorkspaceSavedSuccess: (payload: ShowSuccessPayload) => Promise<void>;

package/common/src/utils/indicators/workspace-indicators.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Configuration for suppressing workspace success indicators.
+ */
+export interface WorkspaceIndicatorConfig {
+    /** Suppress the "Workspace Switched" indicator on all applyWorkspace calls. @default false */
+    suppressWorkspaceSwitched?: boolean;
+    /** Suppress the "Workspace Saved" indicator on regular workspace save only. Save-as and rename are unaffected. @default false */
+    suppressWorkspaceSaved?: boolean;
+}
+export declare const initWorkspaceIndicators: (config?: WorkspaceIndicatorConfig) => void;
+export declare const getSuppressWorkspaceSwitched: () => boolean;
+/** Returns true when the "Workspace Saved" indicator should be suppressed (save only; save-as and rename are unaffected). */
+export declare const getSuppressWorkspaceSaved: () => boolean;

package/dock3/src/api/protocol.d.ts

@@ -1,6 +1,7 @@
 import type { OpenFin } from '@openfin/core';
 import { BaseCustomDropdownItem } from '../../../client-api/src/shapes';
 import { BookmarkDockEntryPayload, DockEntry, LaunchDockEntryPayload, Collection } from '../../../client-api-platform/src/shapes';
+import { WorkspaceIndicatorConfig } from '../../../common/src/utils/indicators/workspace-indicators';
 import { Dock3Config, DockCompanionButton } from '../../../dock3/src/shapes';
 /**
  * Payload for more menu custom option actions
@@ -40,6 +41,7 @@ export type Dock3ChannelClientChannelActions = {
     'navigate-content-menu': (payload: {
         targetId: string;
     }) => void;
+    'handle-indicator-config': (payload: WorkspaceIndicatorConfig) => void;
 };
 /**
  * @internal

package/externals.report.json

@@ -2,7 +2,7 @@
     "@openfin/notifications": [
         {
             "type": "explicit",
-            "version": "2.14.0-alpha-4543",
+            "version": "2.14.0-alpha-4620",
             "packageName": "client-api/package.json",
             "issuer": "client-api/src/notifications.ts"
         }
@@ -43,14 +43,6 @@
             "issuer": "common/src/utils/layout.ts"
         }
     ],
-    "lodash.clonedeep": [
-        {
-            "type": "explicit",
-            "version": "4.5.0",
-            "packageName": "common/package.json",
-            "issuer": "common/src/utils/layout.ts"
-        }
-    ],
     "react-i18next": [
         {
             "type": "explicit",
@@ -67,6 +59,14 @@
             "issuer": "common/src/api/i18next.ts"
         }
     ],
+    "lodash.clonedeep": [
+        {
+            "type": "explicit",
+            "version": "4.5.0",
+            "packageName": "common/package.json",
+            "issuer": "common/src/utils/layout.ts"
+        }
+    ],
     "dexie": [
         {
             "type": "root-implicit",