@openfin/workspace 24.0.8 → 24.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1,2 @@
1
1
  import '@common/test/fin-mocks';
2
+ import '@common/test/logger-mock';
@@ -31,7 +31,8 @@ export declare class ThemeStorageController {
31
31
  private generatedPalettes?;
32
32
  private workspaceStorage?;
33
33
  private recreateFactory?;
34
- constructor(providerStorage: Pick<Storage, 'getItem' | 'setItem'>);
34
+ private isLegacySinglePaletteTheme;
35
+ constructor(providerStorage: Pick<Storage, 'getItem' | 'setItem' | 'removeItem'>);
35
36
  /**
36
37
  * Set the current Storage Proxy to enable Workspace Storage properties to be populated.
37
38
  */
@@ -63,6 +64,8 @@ export declare class ThemeStorageController {
63
64
  /**
64
65
  * Synchronize the current palette and scheme with workspace's storage instance if
65
66
  * storage based theming is enabled. Only syncs when user has explicitly selected a scheme.
67
+ *
68
+ * Wrapped in try/catch so it does not throw
66
69
  */
67
70
  trySynchronizeWorkspaceStorage: () => Promise<void>;
68
71
  /**
@@ -84,6 +87,13 @@ export declare class ThemeStorageController {
84
87
  * @param scheme 'light', 'dark' or 'system'.
85
88
  */
86
89
  setScheme(scheme: ColorSchemeOptionType): void;
90
+ /**
91
+ * Clears an explicit user scheme choice (e.g. from Appearance) so resolution falls back to theme default.
92
+ */
93
+ clearUserSelectedSchemePreference(): void;
94
+ setLegacySinglePaletteTheme(value: boolean): void;
95
+ /** @internal */
96
+ getIsLegacySinglePaletteTheme(): boolean;
87
97
  /**
88
98
  * Set the theme's default scheme from palette configuration
89
99
  * @param scheme The default scheme specified in the palette
@@ -12,6 +12,8 @@ export declare const dispatchThemeToWorkspaceProvider: (themeData: {
12
12
  }) => Promise<void>;
13
13
  export declare const setSelectedScheme: (schemeType: ColorSchemeOptionType) => Promise<void>;
14
14
  export declare const getSelectedScheme: () => ColorSchemeOptionType | null | undefined;
15
+ /** @internal */
16
+ export declare const getIsLegacySinglePaletteTheme: () => boolean;
15
17
  export declare const getThemePaletteSheet: () => string | undefined;
16
18
  export declare const mapLegacyThemeToCustomTheme: (legacyTheme: CustomTheme) => GenerateThemeParams;
17
19
  export declare const mapLegacyBrandIcons: (legacyBrand: BaseThemeOptions["brand"]) => GenerateThemeParams[1];
@@ -3,7 +3,7 @@ export type StorageProxy = {
3
3
  setItem: (data: string, value: string) => Promise<void>;
4
4
  destroy: () => Promise<void>;
5
5
  };
6
- export declare const createStorageProxy: (url: string) => Promise<StorageProxy>;
6
+ export declare const createStorageProxy: (url: string, isEnterprise: boolean) => Promise<StorageProxy>;
7
7
  /**
8
8
  * Ensure the workspace storage proxy window exists. Recreates it if it was previously destroyed
9
9
  * (e.g. when the last browser window closed with preventQuitOnLastWindowClosed true and a new
@@ -1863,6 +1863,11 @@ export interface ThemeApi {
1863
1863
  * @returns the selected scheme.
1864
1864
  */
1865
1865
  getSelectedScheme(): Promise<ColorSchemeOptionType>;
1866
+ /**
1867
+ * @internal
1868
+ * Whether the active platform theme is a legacy theme defined with a single shared palette (light and dark are not independently specified).
1869
+ */
1870
+ getIsLegacySinglePaletteTheme(): Promise<boolean>;
1866
1871
  /**
1867
1872
  * @internal
1868
1873
  * Get the notification indicator colors from the platform provider.
@@ -2304,6 +2309,11 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
2304
2309
  * @param schemeType {@link ColorSchemeOptionType scheme} to be set
2305
2310
  */
2306
2311
  setSelectedScheme(schemeType: ColorSchemeOptionType): Promise<void>;
2312
+ /**
2313
+ * @internal
2314
+ * Whether the active platform theme is a legacy single-palette theme (Appearance scheme switching is not supported).
2315
+ */
2316
+ getIsLegacySinglePaletteTheme(): boolean;
2307
2317
  /**
2308
2318
  * Implementation for handling Workspace analytics events
2309
2319
  * @param req the payload received by the provider
@@ -61,11 +61,6 @@ export declare const updatePageForWindow: (payload: ExtendedUpdatePageForWindowP
61
61
  * @param identity the identity of the window to save the pages of in window options.
62
62
  */
63
63
  export declare const updatePagesWindowOptions: (identity: OpenFin.Identity) => Promise<void>;
64
- /**
65
- * Check if the window identity is currently detaching pages.
66
- * @param identity the OF window identity to check.
67
- */
68
- export declare const isDetachingPages: (identity: OpenFin.Identity) => Promise<boolean>;
69
64
  /**
70
65
  * Check if the window identity is in the middle of changing active pages.
71
66
  * @param identity the OF window identity to check.
@@ -34,6 +34,8 @@ export interface Page {
34
34
  contextGroup?: string;
35
35
  /** Optional property to attach custom metadata to the page object, such as version or timestamp. Must be serializable. */
36
36
  customData?: any;
37
+ /** True when this page is an admin-published supertab. */
38
+ isPublished?: boolean;
37
39
  }
38
40
  type AttachedPageMetadata = {
39
41
  /** The window the page is currently attached to. */
@@ -52,7 +52,6 @@ export declare enum PageChannelAction {
52
52
  ReorderPagesForWindow = "reorder-pages-for-window",
53
53
  UpdatePageForWindow = "update-page-for-window",
54
54
  UpdatePagesWindowOptions = "update-pages-window-options",
55
- IsDetachingPages = "is-detaching-pages",
56
55
  IsActivePageChanging = "is-active-page-changing"
57
56
  }
58
57
  /**
@@ -103,7 +102,6 @@ export declare const BrowserChannelAction: {
103
102
  ReorderPagesForWindow: PageChannelAction.ReorderPagesForWindow;
104
103
  UpdatePageForWindow: PageChannelAction.UpdatePageForWindow;
105
104
  UpdatePagesWindowOptions: PageChannelAction.UpdatePagesWindowOptions;
106
- IsDetachingPages: PageChannelAction.IsDetachingPages;
107
105
  IsActivePageChanging: PageChannelAction.IsActivePageChanging;
108
106
  CloseBrowserWindow: GeneralBrowserChannelActions.CloseBrowserWindow;
109
107
  QuitPlatform: GeneralBrowserChannelActions.QuitPlatform;
@@ -97,7 +97,9 @@ export declare enum WorkspacePlatformChannelAction {
97
97
  SendUpdateVersionModalResponseInternal = "sendUpdateVersionModalResponseInternal",// Enterprise
98
98
  ShowUpdateVersionModalInternal = "showUpdateVersionModalInternal",// Enterprise
99
99
  ShowApplyAndPublishModalInternal = "showApplyAndPublishModalInternal",// Enterprise
100
- GetNotificationIndicatorColorsInternal = "getNotificationIndicatorColorsInternal"
100
+ GetNotificationIndicatorColorsInternal = "getNotificationIndicatorColorsInternal",// Custom Notification Indicators Colors
101
+ /** @internal */
102
+ GetIsLegacySinglePaletteTheme = "getIsLegacySinglePaletteTheme"
101
103
  }
102
104
  export type PlatFormSupportedFeatures = boolean | {
103
105
  isWorkspacePlatform: boolean;
@@ -0,0 +1,5 @@
1
+ export declare const mockLogger: {
2
+ debug: jest.Mock<any, any, any>;
3
+ warn: jest.Mock<any, any, any>;
4
+ error: jest.Mock<any, any, any>;
5
+ };
@@ -11,7 +11,7 @@ export declare const isDocumentDefined: boolean;
11
11
  export declare const isWindowDefinedWithIndexDB: boolean;
12
12
  export declare const finUUID: string;
13
13
  export declare const finName: string;
14
- export declare const finEntityType: "" | "window" | "view";
14
+ export declare const finEntityType: "" | "view" | "window";
15
15
  export declare const isEnvLocal: boolean;
16
16
  export declare const isEnvDev: boolean;
17
17
  export declare const isEnvStaging: boolean;
@@ -24,6 +24,7 @@ export declare enum WindowName {
24
24
  ZoomControlsDialog = "here-zoom-controls-dialog",
25
25
  UpdateVersionModal = "here-update-version-modal",
26
26
  ApplyAndPublishModal = "here-apply-and-publish-modal",
27
+ PublishOnCloseModal = "here-publish-on-close-modal",
27
28
  DesktopSignalsModal = "here-desktop-signals-modal",
28
29
  IntentsResolverModal = "here-intents-resolver-modal"
29
30
  }
@@ -35,6 +35,9 @@ export declare const showUpdateVersionModal: ({ identity, title, description }:
35
35
  description: string;
36
36
  }) => Promise<ModalResponseEvent["data"]>;
37
37
  export declare const showApplyAndPublishModal: (identity: OpenFin.Identity) => Promise<boolean>;
38
+ export declare const showPublishOnCloseModal: (windowIdentity: OpenFin.Identity) => Promise<{
39
+ data: ModalResponseEvent["data"];
40
+ }>;
38
41
  /**
39
42
  * Shows the intents resolver modal and returns the user's selection
40
43
  * @param request - The request containing modal configuration
@@ -2,11 +2,19 @@
2
2
  "@openfin/notifications": [
3
3
  {
4
4
  "type": "explicit",
5
- "version": "2.14.0-alpha-4520",
5
+ "version": "2.14.0-alpha-4528",
6
6
  "packageName": "client-api/package.json",
7
7
  "issuer": "client-api/src/notifications.ts"
8
8
  }
9
9
  ],
10
+ "@openfin/microsoft365": [
11
+ {
12
+ "type": "explicit",
13
+ "version": "^1.1.0",
14
+ "packageName": "client-api/package.json",
15
+ "issuer": "client-api/src/integrations/microsoft.ts"
16
+ }
17
+ ],
10
18
  "title-case": [
11
19
  {
12
20
  "type": "explicit",
@@ -21,14 +29,6 @@
21
29
  "issuer": "common/src/utils/color-linking.ts"
22
30
  }
23
31
  ],
24
- "@openfin/microsoft365": [
25
- {
26
- "type": "explicit",
27
- "version": "^1.1.0",
28
- "packageName": "client-api/package.json",
29
- "issuer": "client-api/src/integrations/microsoft.ts"
30
- }
31
- ],
32
32
  "lodash.debounce": [
33
33
  {
34
34
  "type": "explicit",