@openfin/workspace-platform 19.1.18 → 19.1.19

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

@@ -1,5 +1,6 @@
 import { type CustomButtonConfig, type CustomDropdownConfig } from '../../../common/src/api/action';
 import { type RegistrationMetaInfo } from '../../../client-api/src/shapes/common';
+import { TaskbarIcon } from '../../../client-api-platform/src/shapes';
 import { type ProviderInfo } from './provider';
 /**
  * Allows you to hide buttons for different Workspace components in the Dock UI.
@@ -177,7 +178,7 @@ export interface DockProviderConfig {
     /**
      * Icon for the provider.
      */
-    icon: string;
+    icon: string | TaskbarIcon;
 }
 export interface DockProviderConfigWithIdentity extends ProviderInfo, DockProviderConfig {
 }

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

@@ -1,3 +1,4 @@
+import { TaskbarIcon } from '../../../client-api-platform/src/shapes';
 export interface ProviderInfo {
     /**
      * Unique identifier for the provider.
@@ -12,9 +13,13 @@ export interface ProviderInfo {
     /**
      * Icon for the provider.
      */
-    icon: string;
+    icon: string | TaskbarIcon;
     /**
      *  version of client SDK, set by the API
      */
     clientAPIVersion?: string;
+    /**
+     * The group name to group the taskbar icon with.
+     */
+    taskbarIconGroup?: string;
 }

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

@@ -663,11 +663,15 @@ export interface BrowserWorkspacePlatformWindowOptions {
      * When true, disables the ability to close pages in the window. False by default.
      */
     preventPageClose?: boolean;
+    /**
+     * Taskbar Icon for the Browser Window. If light and dark icon are defined, then the taskbar icon will change when the scheme changes.
+     */
+    icon?: string | TaskbarIcon;
 }
 /**
  * Request for creating a browser window.
  */
-export interface BrowserCreateWindowRequest extends Omit<OpenFin.PlatformWindowCreationOptions, 'workspacePlatform'> {
+export interface BrowserCreateWindowRequest extends Omit<OpenFin.PlatformWindowCreationOptions, 'workspacePlatform' | 'icon'> {
     /** WorkspacePlatform specific window options. These options will not work unless a workspace platform has been initialized. */
     workspacePlatform: BrowserWorkspacePlatformWindowOptions | {
         /** For internal usage.  Defaults to 'browser' when Browser is enabled when the WorkspacePlatform is initialized.  In order to use
@@ -676,6 +680,10 @@ export interface BrowserCreateWindowRequest extends Omit<OpenFin.PlatformWindowC
          * */
         windowType: WindowType.Platform;
     };
+    /** The icon to display on the taskbar.
+     * @deprecated Use the icon property in the workspacePlatform object instead.
+     */
+    icon?: string;
 }
 /**
  * A window that is part of a browser snapshot.
@@ -2105,3 +2113,7 @@ export type OpenSaveMenuRequest = {
     menuType: SaveModalType.SAVE_WORKSPACE | SaveModalType.SAVE_WORKSPACE_AS | SaveModalType.RENAME_WORKSPACE;
     id?: never;
 };
+export type TaskbarIcon = {
+    dark: string;
+    light: string;
+};

package/common/src/api/pages/shapes.d.ts

@@ -227,5 +227,7 @@ export type AddPagePayload = {
     identity: OpenFin.Identity;
     /** The page to attach. */
     page: PageWithUpdatableRuntimeAttribs;
+    /** Index at which the page should be added */
+    insertionIndex?: number;
 };
 export {};

package/common/src/utils/route.d.ts

@@ -28,8 +28,8 @@ export declare enum PageRoute {
 export declare const Assets: {
     readonly IconOpenFinLogo: "/icons/openfinlogo.svg";
     readonly IconFilter: "/icons/filter.svg";
-    readonly LightStorefront: "/icons/lightstorefront.png";
-    readonly DarkStorefront: "/icons/darkstorefront.png";
+    readonly LightStorefront: "/icons/store-icon-light.png";
+    readonly DarkStorefront: "/icons/store-icon-dark.png";
     readonly CallIconLight: "/icons/call-icon-light.svg";
     readonly CallIconDark: "/icons/call-icon-dark.svg";
     readonly ChatIconLight: "/icons/chat-icon-light.svg";
@@ -45,6 +45,8 @@ export declare const Assets: {
         readonly Microsoft365Icon: "/microsoft-365-integration-assets/microsoft-365-icon.svg";
         readonly PDFFileIcon: "/microsoft-365-integration-assets/pdf-file-icon.svg";
     };
+    readonly DockIconLight: "/icons/dock-icon-light.png";
+    readonly DockIconDark: "/icons/dock-icon-dark.png";
 };
 /**
  * Home DeepLink Options