@openfin/workspace 23.2.15 → 23.2.16

package/client-api/src/dock.test.d.ts

@@ -1 +1,2 @@
 import '@common/test/fin-mocks';
+import '@common/test/logger-mock';

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/theme-storage-controller.d.ts

@@ -31,7 +31,8 @@ export declare class ThemeStorageController {
     private generatedPalettes?;
     private workspaceStorage?;
     private recreateFactory?;
-    constructor(providerStorage: Pick<Storage, 'getItem' | 'setItem'>);
+    private isLegacySinglePaletteTheme;
+    constructor(providerStorage: Pick<Storage, 'getItem' | 'setItem' | 'removeItem'>);
     /**
      * Set the current Storage Proxy to enable Workspace Storage properties to be populated.
      */
@@ -63,6 +64,8 @@ export declare class ThemeStorageController {
     /**
      * 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
      */
     trySynchronizeWorkspaceStorage: () => Promise<void>;
     /**
@@ -84,6 +87,13 @@ export declare class ThemeStorageController {
      * @param scheme 'light', 'dark' or 'system'.
      */
     setScheme(scheme: ColorSchemeOptionType): void;
+    /**
+     * Clears an explicit user scheme choice (e.g. from Appearance) so resolution falls back to theme default.
+     */
+    clearUserSelectedSchemePreference(): void;
+    setLegacySinglePaletteTheme(value: boolean): void;
+    /** @internal */
+    getIsLegacySinglePaletteTheme(): boolean;
     /**
      * Set the theme's default scheme from palette configuration
      * @param scheme The default scheme specified in the palette

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

@@ -12,6 +12,8 @@ export declare const dispatchThemeToWorkspaceProvider: (themeData: {
 }) => Promise<void>;
 export declare const setSelectedScheme: (schemeType: ColorSchemeOptionType) => Promise<void>;
 export declare const getSelectedScheme: () => ColorSchemeOptionType | null | undefined;
+/** @internal */
+export declare const getIsLegacySinglePaletteTheme: () => boolean;
 export declare const getThemePaletteSheet: () => string | undefined;
 export declare const mapLegacyThemeToCustomTheme: (legacyTheme: CustomTheme) => GenerateThemeParams;
 export declare const mapLegacyBrandIcons: (legacyBrand: BaseThemeOptions["brand"]) => GenerateThemeParams[1];

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

@@ -3,7 +3,7 @@ export type StorageProxy = {
     setItem: (data: string, value: string) => Promise<void>;
     destroy: () => Promise<void>;
 };
-export declare const createStorageProxy: (url: string) => Promise<StorageProxy>;
+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

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

@@ -1807,6 +1807,11 @@ export interface ThemeApi {
      * @returns the selected scheme.
      */
     getSelectedScheme(): Promise<ColorSchemeOptionType>;
+    /**
+     * @internal
+     * Whether the active platform theme is a legacy theme defined with a single shared palette (light and dark are not independently specified).
+     */
+    getIsLegacySinglePaletteTheme(): Promise<boolean>;
     /**
      * @internal
      * Get the notification indicator colors from the platform provider.
@@ -2243,6 +2248,11 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
      * @param schemeType {@link ColorSchemeOptionType scheme} to be set
      */
     setSelectedScheme(schemeType: ColorSchemeOptionType): Promise<void>;
+    /**
+     * @internal
+     * Whether the active platform theme is a legacy single-palette theme (Appearance scheme switching is not supported).
+     */
+    getIsLegacySinglePaletteTheme(): boolean;
     /**
      * Implementation for handling Workspace analytics events
      * @param req the payload received by the provider

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

@@ -96,7 +96,9 @@ export declare enum WorkspacePlatformChannelAction {
     FocusAndExpandSearchInternal = "focusAndExpandSearchInternal",// Enterprise
     SendUpdateVersionModalResponseInternal = "sendUpdateVersionModalResponseInternal",// Enterprise
     ShowUpdateVersionModalInternal = "showUpdateVersionModalInternal",// Enterprise
-    GetNotificationIndicatorColorsInternal = "getNotificationIndicatorColorsInternal"
+    GetNotificationIndicatorColorsInternal = "getNotificationIndicatorColorsInternal",// Custom Notification Indicators Colors
+    /** @internal */
+    GetIsLegacySinglePaletteTheme = "getIsLegacySinglePaletteTheme"
 }
 export type PlatFormSupportedFeatures = boolean | {
     isWorkspacePlatform: boolean;

package/common/src/test/logger-mock.d.ts

@@ -0,0 +1,5 @@
+export declare const mockLogger: {
+    debug: jest.Mock<any, any, any>;
+    warn: jest.Mock<any, any, any>;
+    error: jest.Mock<any, any, any>;
+};

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/externals.report.json

@@ -7,14 +7,6 @@
             "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",
@@ -43,14 +43,6 @@
             "issuer": "common/src/utils/layout.ts"
         }
     ],
-    "lodash.clonedeep": [
-        {
-            "type": "root-implicit",
-            "version": "4.5.0",
-            "packageName": "common/package.json",
-            "issuer": "common/src/utils/layout.ts"
-        }
-    ],
     "react-i18next": [
         {
             "type": "root-implicit",
@@ -67,6 +59,14 @@
             "issuer": "common/src/api/i18next.ts"
         }
     ],
+    "lodash.clonedeep": [
+        {
+            "type": "root-implicit",
+            "version": "4.5.0",
+            "packageName": "common/package.json",
+            "issuer": "common/src/utils/layout.ts"
+        }
+    ],
     "dexie": [
         {
             "type": "root-implicit",