@openfin/workspace-platform 22.3.18 → 22.3.20

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

@@ -463,6 +463,7 @@ export interface HomeRegistration extends RegistrationMetaInfo {
      * @throws An error if the Home Provider is no longer registered.
      *
      * @param query search string
+     * @param @optional additional options to set the search query
      *
      * @returns A promise that resolves when the search string has been injected into home search
      *
@@ -500,5 +501,15 @@ export interface HomeRegistration extends RegistrationMetaInfo {
      *
      * ```
      */
-    setSearchQuery(query: string): Promise<void>;
+    setSearchQuery(query: string, options?: SetSearchQueryOptions): Promise<void>;
+}
+/**
+ * Options to set the search query
+ */
+export interface SetSearchQueryOptions {
+    /**
+     * Whether to show home after setting the search query
+     * @default true
+     */
+    showHome?: boolean;
 }

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

@@ -47,9 +47,15 @@ export declare class ThemeStorageController {
      * `git revert 233e843cda6cd68968fd5831fb20597e0d5bb7cc --no-commit`
      */
     setWorkspaceStorage: (proxy: Pick<Storage, 'setItem'>) => 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.
+     * @returns true if user has manually selected a scheme, false if using defaults
+     */
+    private hasUserPreference;
     /**
      * Synchronize the current palette and scheme with workspace's storage instance if
-     * storage based theming is enabled
+     * storage based theming is enabled. Only syncs when user has explicitly selected a scheme.
      */
     trySynchronizeWorkspaceStorage: () => void;
     /**
@@ -67,6 +73,11 @@ export declare class ThemeStorageController {
      * @param scheme 'light', 'dark' or 'system'.
      */
     setScheme(scheme: ColorSchemeOptionType): void;
+    /**
+     * Set the theme's default scheme from palette configuration
+     * @param scheme The default scheme specified in the palette
+     */
+    setThemeDefaultScheme(scheme: ColorSchemeOptionType): void;
     /**
      * Returns the current scheme
      * @returns 'light' | 'system' | 'dark'

package/common/src/api/home.d.ts

@@ -1,13 +1,15 @@
 import type OpenFin from '@openfin/core';
-import { HomeSearchListenerRequest } from '../../../client-api/src/shapes';
+import { HomeSearchListenerRequest, SetSearchQueryOptions } from '../../../client-api/src/shapes';
 export interface SearchQueryWithProviderID {
     providerID: string;
     query: string;
+    options?: SetSearchQueryOptions;
 }
 export interface SearchQueryWithProviderIdentity {
     providerID: string;
     platformIdentity: OpenFin.Identity;
     query: string;
+    options?: SetSearchQueryOptions;
 }
 /**
  * The ids of home providers that are built into Home.

package/common/src/utils/local-storage-key.d.ts

@@ -8,6 +8,7 @@ declare enum LocalStorageKey {
     SelectedColorScheme = "SelectedColorScheme",
     ThemePaletteSheet = "ThemePaletteSheet",
     HasMovedStore = "HasMovedStore",
-    PageDragState = "BrowserPageDragState"
+    PageDragState = "BrowserPageDragState",
+    ThemePaletteDefaultScheme = "ThemePaletteDefaultScheme"
 }
 export default LocalStorageKey;

package/externals.report.json

@@ -38,18 +38,18 @@
         }
     ],
     "dexie": [
-        {
-            "type": "root-implicit",
-            "version": "^4.0.11",
-            "packageName": "dock3/package.json",
-            "issuer": "dock3/src/api/idb.ts"
-        },
         {
             "type": "explicit",
             "version": "^4.0.11",
             "packageName": "client-api-platform/package.json",
             "issuer": "client-api-platform/src/api/dock/idb.ts"
         },
+        {
+            "type": "root-implicit",
+            "version": "^4.0.11",
+            "packageName": "dock3/package.json",
+            "issuer": "dock3/src/api/idb.ts"
+        },
         {
             "type": "root-implicit",
             "version": "^4.0.11",