@openfin/workspace 24.1.3 → 24.1.4

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.
  *

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

@@ -852,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.
      */

package/externals.report.json

@@ -2,19 +2,11 @@
     "@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"
         }
     ],
-    "@openfin/microsoft365": [
-        {
-            "type": "explicit",
-            "version": "^1.1.0",
-            "packageName": "client-api/package.json",
-            "issuer": "client-api/src/integrations/microsoft.ts"
-        }
-    ],
     "title-case": [
         {
             "type": "explicit",
@@ -29,6 +21,14 @@
             "issuer": "common/src/utils/color-linking.ts"
         }
     ],
+    "@openfin/microsoft365": [
+        {
+            "type": "explicit",
+            "version": "^1.1.0",
+            "packageName": "client-api/package.json",
+            "issuer": "client-api/src/integrations/microsoft.ts"
+        }
+    ],
     "lodash.debounce": [
         {
             "type": "explicit",