@openfin/workspace-platform 22.3.19 → 22.3.20

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.
@@ -463,6 +463,7 @@ export interface HomeRegistration extends RegistrationMetaInfo {
463
463
  * @throws An error if the Home Provider is no longer registered.
464
464
  *
465
465
  * @param query search string
466
+ * @param @optional additional options to set the search query
466
467
  *
467
468
  * @returns A promise that resolves when the search string has been injected into home search
468
469
  *
@@ -500,5 +501,15 @@ export interface HomeRegistration extends RegistrationMetaInfo {
500
501
  *
501
502
  * ```
502
503
  */
503
- setSearchQuery(query: string): Promise<void>;
504
+ setSearchQuery(query: string, options?: SetSearchQueryOptions): Promise<void>;
505
+ }
506
+ /**
507
+ * Options to set the search query
508
+ */
509
+ export interface SetSearchQueryOptions {
510
+ /**
511
+ * Whether to show home after setting the search query
512
+ * @default true
513
+ */
514
+ showHome?: boolean;
504
515
  }
@@ -47,9 +47,15 @@ export declare class ThemeStorageController {
47
47
  * `git revert 233e843cda6cd68968fd5831fb20597e0d5bb7cc --no-commit`
48
48
  */
49
49
  setWorkspaceStorage: (proxy: Pick<Storage, 'setItem'>) => void;
50
+ /**
51
+ * Check if there's an explicit user preference stored in localStorage.
52
+ * A user preference is indicated by the presence of a SelectedColorScheme key. Which is something assigned if you click on the Appearance dropdown.
53
+ * @returns true if user has manually selected a scheme, false if using defaults
54
+ */
55
+ private hasUserPreference;
50
56
  /**
51
57
  * Synchronize the current palette and scheme with workspace's storage instance if
52
- * storage based theming is enabled
58
+ * storage based theming is enabled. Only syncs when user has explicitly selected a scheme.
53
59
  */
54
60
  trySynchronizeWorkspaceStorage: () => void;
55
61
  /**
@@ -67,6 +73,11 @@ export declare class ThemeStorageController {
67
73
  * @param scheme 'light', 'dark' or 'system'.
68
74
  */
69
75
  setScheme(scheme: ColorSchemeOptionType): void;
76
+ /**
77
+ * Set the theme's default scheme from palette configuration
78
+ * @param scheme The default scheme specified in the palette
79
+ */
80
+ setThemeDefaultScheme(scheme: ColorSchemeOptionType): void;
70
81
  /**
71
82
  * Returns the current scheme
72
83
  * @returns 'light' | 'system' | 'dark'
@@ -1,13 +1,15 @@
1
1
  import type OpenFin from '@openfin/core';
2
- import { HomeSearchListenerRequest } from '../../../client-api/src/shapes';
2
+ import { HomeSearchListenerRequest, SetSearchQueryOptions } from '../../../client-api/src/shapes';
3
3
  export interface SearchQueryWithProviderID {
4
4
  providerID: string;
5
5
  query: string;
6
+ options?: SetSearchQueryOptions;
6
7
  }
7
8
  export interface SearchQueryWithProviderIdentity {
8
9
  providerID: string;
9
10
  platformIdentity: OpenFin.Identity;
10
11
  query: string;
12
+ options?: SetSearchQueryOptions;
11
13
  }
12
14
  /**
13
15
  * The ids of home providers that are built into Home.
@@ -8,6 +8,7 @@ declare enum LocalStorageKey {
8
8
  SelectedColorScheme = "SelectedColorScheme",
9
9
  ThemePaletteSheet = "ThemePaletteSheet",
10
10
  HasMovedStore = "HasMovedStore",
11
- PageDragState = "BrowserPageDragState"
11
+ PageDragState = "BrowserPageDragState",
12
+ ThemePaletteDefaultScheme = "ThemePaletteDefaultScheme"
12
13
  }
13
14
  export default LocalStorageKey;
@@ -38,18 +38,18 @@
38
38
  }
39
39
  ],
40
40
  "dexie": [
41
- {
42
- "type": "root-implicit",
43
- "version": "^4.0.11",
44
- "packageName": "dock3/package.json",
45
- "issuer": "dock3/src/api/idb.ts"
46
- },
47
41
  {
48
42
  "type": "explicit",
49
43
  "version": "^4.0.11",
50
44
  "packageName": "client-api-platform/package.json",
51
45
  "issuer": "client-api-platform/src/api/dock/idb.ts"
52
46
  },
47
+ {
48
+ "type": "root-implicit",
49
+ "version": "^4.0.11",
50
+ "packageName": "dock3/package.json",
51
+ "issuer": "dock3/src/api/idb.ts"
52
+ },
53
53
  {
54
54
  "type": "root-implicit",
55
55
  "version": "^4.0.11",