@openfin/workspace 13.0.7 → 13.1.0

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

@@ -5,6 +5,7 @@ import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/
 import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../common/src/api/pages/shapes';
 import type { CustomThemes } from '../../common/src/api/theming';
 import type { App, DockProviderConfigWithIdentity, StoreButtonConfig } from '../../client-api/src/shapes';
+import { WorkflowIntegration } from '../../client-api/src/shapes/integrations';
 export { AppManifestType } from '../../client-api/src/shapes';
 export type { App, AppIntent, Image } from '../../client-api/src/shapes';
 export type { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
@@ -45,6 +46,8 @@ export interface OpenGlobalContextMenuRequest {
     y: number;
     /** Miscellaneous options necessary for implementing custom logic in the provider override. */
     customData?: any;
+    /** Identities of the currently selected views */
+    selectedViews?: OpenFin.Identity[];
 }
 /**Shape of the data property of a context menu template item */
 export interface ContextMenuItemData {
@@ -58,6 +61,9 @@ export declare enum GlobalContextMenuOptionType {
     NewPage = "NewPage",
     SavePage = "SavePage",
     SavePageAs = "SavePageAs",
+    Print = "Print",
+    PrintAll = "PrintAll",
+    PrintScreen = "PrintScreen",
     CloseWindow = "CloseWindow",
     RestoreChanges = "RestoreChanges",
     SaveWorkspace = "SaveWorkspace",
@@ -213,6 +219,14 @@ export declare enum ViewTabMenuOptionType {
      * Print the selected view.
      */
     Print = "Print",
+    /**
+     * Prints visible views.
+     */
+    PrintAll = "PrintAll",
+    /**
+     * Prints a screenshot of the browser window.
+     */
+    PrintScreen = "PrintScreen",
     /**
      * Custom context menu option defined by API client.
      */
@@ -319,7 +333,7 @@ export interface CustomDropdownItemActionPayload {
  * Custom browser buttons
  */
 export interface CustomBrowserButtonConfig extends CustomButtonConfig {
-    /** Type of cutom browser button */
+    /** Type of custom browser button */
     type: BrowserButtonType.Custom;
 }
 /**
@@ -828,7 +842,7 @@ export interface BrowserWindowFactory {
      *          pages: [page],
      *          title: 'My Window Title',
      *          favicon: 'https://google.com/favicon.ico',
-     *          disableMultiplePages: true,  // disable page functonality for the window
+     *          disableMultiplePages: true,  // disable page functionality for the window
      *          toolbarOptions: {  // configure the set of tray icons for the window
      *              buttons: [
      *                  {  // adding a custom tray icon for the window
@@ -868,7 +882,7 @@ export interface BrowserWindowFactory {
      *                       disabled: false,
      *                       iconUrl: 'https://www.openfin.co/favicon.ico',
      *                       action: {
-     *                          // This action needs to be registed in customActions property in the call WorkspacePlatform.init
+     *                          // This action needs to be registered in customActions property in the call WorkspacePlatform.init
      *                           id: 'sample-window-state-custom-action',
      *                           customData: {
      *                               message: 'Clicked on custom Window State button'
@@ -1425,7 +1439,7 @@ export interface ApplyWorkspaceOptions {
      */
     promptContainerWindowIdentity?: OpenFin.Identity;
     /**
-     * Options to apply the workspace spanshot with.
+     * Options to apply the workspace snapshot with.
      */
     applySnapshotOptions?: ApplySnapshotOptions;
 }
@@ -1467,7 +1481,7 @@ export interface AnalyticsConfig {
 export interface WorkspacePlatformInitConfig {
     customActions?: CustomActionsMap;
     /** Config for overriding browser options and behavior.
-     *  Set to null to initalize the platform without the browser
+     *  Set to null to initialize the platform without the browser
      */
     browser?: BrowserInitConfig | null;
     /** Custom Themes object
@@ -1528,6 +1542,29 @@ export interface WorkspacePlatformInitConfig {
      * Config for Workspace Platform analytics
      */
     analytics?: AnalyticsConfig;
+    /**
+     * Config for Workspace Platform Integrations
+     *
+     * @example
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     * import { Integrations } from '@openfin/workspace';
+     *
+     * const microsoftIntegration = new Integrations.Microsoft365WorkflowIntegration({
+     *     connect: {
+     *         clientId: '',
+     *         redirectUri: '',
+     *         tenantId: ''
+     *     }
+     * });
+     *
+     * await WorkspacePlatform.init({
+     *   browser: { },
+     *   integrations: [microsoftIntegration]
+     * });
+     * ```
+     */
+    integrations?: WorkflowIntegration[];
 }
 /**
  * Extend or replace default functionality in order to customize behavior of a Workspace Platform Provider.
@@ -1542,7 +1579,7 @@ export interface WorkspacePlatformInitConfig {
  *    WorkspacePlatformProvider
  * ) => {
  *   class Override extends WorkspacePlatformProvider {
- *       // ovrride default behavior of updateSavedPage
+ *       // Override the default behavior of updateSavedPage
  *       updateSavedPage = async (req: UpdateSavedPageRequest): Promise<void> => {
  *           console.log(`saving page ${req.page.pageId}`);
  *           // calling custom function to the save page here
@@ -1560,7 +1597,7 @@ export interface WorkspacePlatformInitConfig {
  *                           data: {
  *                               type: GlobalContextMenuOptionType.Custom,
  *                               action: {
- *                                      // This action needs to be registed in customActions property in the call WorkspacePlatform.init
+ *                                      // This action needs to be registered in customActions property in the call WorkspacePlatform.init
  *                                   id: 'sample-custom-global-menu-action'
  *                               }
  *                           }
@@ -1586,7 +1623,7 @@ export interface WorkspacePlatformInitConfig {
  *                       data: {
  *                           type: ViewTabMenuOptionType.Custom,
  *                           action: {
- *                                  // This action needs to be registed in customActions property in the call WorkspacePlatform.init
+ *                                  // This action needs to be registered in customActions property in the call WorkspacePlatform.init
  *                               id: 'sample-viewtab-action',
  *                               customData: 'Custom View Tab Action'
  *                           }
@@ -1643,7 +1680,7 @@ export interface WorkspacePlatformInitConfig {
  *
  * await WorkspacePlatform.init({
  *  browser: {
- *      title: "My Workpace Platform"
+ *      title: "My Workspace Platform"
  *  }
  *  overrideCallback,
  *  customActions: {

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

@@ -67,6 +67,8 @@ export interface Page {
     };
     /** Used to configure fixed views on the edges of the browser window. Only one panel per side is supported. */
     panels?: PanelConfig[];
+    /** Optional property to attach custom metadata to the page object, such as version or timestamp. Must be serializable. */
+    customData?: any;
 }
 declare type AttachedPageMetadata = {
     /** The window the page is currently attached to. */

package/common/src/api/protocol/shapes/workspace.d.ts

@@ -0,0 +1,157 @@
+import type OpenFin from '@openfin/core';
+import type { Awaitable } from '../../../../../common/src/utils/types';
+import type { dockOFIdentity, homeOFIdentity, storefrontOFIdentity } from '../../../../../common/src/utils/window';
+import type { ProviderChannelPayload, ProviderDeregisterPayload, ProviderInfoInternal, ProviderRegisterPayload, ProviderUpdatePayload } from '../../../../../common/src/api/provider';
+import type { ClientAPILaunchStorefrontProviderAppRequest, LaunchStorefrontProviderAppRequest } from '../../../../../common/src/api/storefront';
+import type { WorkspaceComponentSetSelectedSchemePayload } from '../../../../../common/src/api/theming';
+import type { Workspace as LegacyWorkspace } from '../../../../../common/src/api/workspaces';
+import type { HomeSearchListenerRequest, SearchQueryWithProviderID } from '../../../../../client-api/src/home';
+import type { RegisterMetaInfoInternal } from '../../../../../client-api/src/index';
+import type { StorefrontFooter, StorefrontLandingPage, StorefrontNavigationSection, UpdateButtonConfigRequest } from '../../../../../client-api/src/store';
+import type { App, ColorSchemeOptionType, Page } from '../../../../../client-api-platform/src/shapes';
+export declare type WorkspaceChannelAction = keyof WorkspaceChannelTypes;
+/****** API Client Channel Actions ******/
+/**
+ * Channel actions, related to store, **registered** by the Workspace Platform Provider e.g. Studio.
+ */
+declare type StoreAPIClientChannelActions = {
+    'get-storefront-provider-apps': (id: string) => Promise<App[]>;
+    'get-storefront-provider-footer': (id: string) => Promise<StorefrontFooter>;
+    'get-storefront-provider-landing-page': (id: string) => Promise<StorefrontLandingPage>;
+    'get-storefront-provider-navigation': (id: string) => Promise<[StorefrontNavigationSection?, StorefrontNavigationSection?, StorefrontNavigationSection?]>;
+    'launch-storefront-provider-app': (payload: ClientAPILaunchStorefrontProviderAppRequest) => Promise<void>;
+};
+/**
+ * Channel actions, related to dock, **registered** by the Workspace Platform Provider e.g. Studio.
+ */
+declare type DockAPIClientChannelActions = Record<string, never>;
+/**
+ * Channel actions, related to home, **registered** by the Workspace Platform Provider e.g. Studio.
+ */
+declare type HomeAPIClientChannelActions = Record<string, never>;
+declare type WorkspaceAPIClientChannelActions = StoreAPIClientChannelActions | DockAPIClientChannelActions | HomeAPIClientChannelActions;
+/****** End of API Client Channel Actions ******/
+/****** Workspace Component Channel Actions ******/
+/**
+ * Channel Actions **registered** by all workspace components.
+ */
+declare type SharedChannelActions = {
+    'set-selected-scheme': (ctx: WorkspaceComponentSetSelectedSchemePayload) => Promise<void>;
+};
+/**
+ * Channel Actions **registered** by the Home workspace component.
+ */
+declare type HomeChannelActions = {
+    'assign-home-search-context': (payload: Partial<HomeSearchListenerRequest['context']>) => Promise<void>;
+    'set-search-query': (payload: SearchQueryWithProviderID) => Promise<void>;
+    'open-home-and-set-search-query': (payload: SearchQueryWithProviderID) => Promise<void>;
+    'temporary-is-home-ready': () => Promise<boolean>;
+};
+/**
+ * Channel Actions **registered** by the Storefront workspace component.
+ */
+declare type StoreChannelActions = {
+    'update-app-card-button-config': (payload: UpdateButtonConfigRequest & ProviderInfoInternal<'storefront'>) => Promise<void>;
+};
+/**
+ * Channel Actions **registered** by the Dock workspace component.
+ */
+interface DockChannelActions {
+}
+declare type WorkspaceComponentChannelActions = SharedChannelActions & HomeChannelActions & StoreChannelActions & DockChannelActions;
+/****** End of Workspace Component Channel Actions ******/
+/****** Workspace Provider Channel Actions ******/
+/**
+ * These are channel actions that can be accessed by the client API OR the workspace component.
+ * In other words these are channel actions that are **registered** by the workspace provider.
+ *
+ * The handlers for these actions are defined [here](https://github.com/openfin/workspace/blob/develop/provider/src/api/protocol.ts#L32)
+ */
+declare type WorkspaceChannelTypes = {
+    'register-provider': (payload: ProviderRegisterPayload) => RegisterMetaInfoInternal;
+    'deregister-provider': (payload: ProviderDeregisterPayload) => Promise<void>;
+    'get-providers': (payload: ProviderChannelPayload) => Promise<ProviderInfoInternal[]>;
+    'show-provider-window': (payload: ProviderChannelPayload) => Promise<void>;
+    'hide-provider-window': (payload: ProviderChannelPayload) => Promise<void>;
+    'update-provider': (payload: ProviderUpdatePayload) => Promise<void>;
+    'get-storefront-provider-apps': (payload: ProviderInfoInternal<'storefront'>) => Promise<App[]>;
+    'get-storefront-provider-landing-page': (payload: ProviderInfoInternal<'storefront'>) => Promise<StorefrontLandingPage | undefined>;
+    'get-storefront-provider-footer': (payload: ProviderInfoInternal<'storefront'>) => Promise<StorefrontFooter>;
+    'get-storefront-provider-navigation': (payload: ProviderInfoInternal<'storefront'>) => Promise<Promise<[StorefrontNavigationSection?, StorefrontNavigationSection?]>>;
+    'launch-storefront-provider-app': (payload: LaunchStorefrontProviderAppRequest) => Promise<void>;
+    'update-app-card-button-config': (payload: UpdateButtonConfigRequest & Omit<ProviderInfoInternal<'storefront'>, 'uniqueId'>) => Promise<void>;
+    'show-home': (payload: undefined) => Promise<void>;
+    'hide-home': (payload: undefined) => Promise<void>;
+    'set-search-query': (payload: SearchQueryWithProviderID) => Promise<void>;
+    'assign-home-search-context': (payload: Partial<HomeSearchListenerRequest['context']>) => Promise<void>;
+    'set-selected-scheme': (ctx: ColorSchemeOptionType) => Promise<void>;
+    'get-legacy-pages': () => Promise<Page[]>;
+    'get-legacy-workspaces': (payload: undefined) => Promise<LegacyWorkspace[]>;
+    'register-storefront-provider': () => Promise<void>;
+    'deregister-storefront-provider': () => Promise<void>;
+    'hide-storefront': () => Promise<void>;
+    'show-storefront': () => Promise<void>;
+};
+/****** End of Workspace Provider Channel Actions ******/
+/**
+ * This is a shared interface between the client API and the workspace components.
+ *
+ * Since all actions are dispatched to the channel provider, the `dispatch` function is the same for both the client API and the workspace components.
+ */
+interface WorkspaceChannelClientBase extends Omit<OpenFin.ChannelClient, 'dispatch' | 'register'> {
+    /**
+     * Dispatches an action to the Workspace Provider.
+     * @param action The action to dispatch
+     * @param payload The payload to send with the action
+     */
+    dispatch: <T extends WorkspaceChannelAction>(action: T, payload: Parameters<WorkspaceChannelTypes[T]>[0]) => Promise<Awaited<ReturnType<WorkspaceChannelTypes[T]>>>;
+}
+/**
+ * This is the Workspace Component Channel Client.
+ * This is used to communicate with the workspace provider from a workspace component (home, storefront, dock).
+ *
+ * This extends `WorkspaceChannelClientBase`.
+ */
+export interface WorkspaceComponentChannelClient extends WorkspaceChannelClientBase {
+    /**
+     * Registers a handler for a channel action.
+     * @param action
+     * @param handler
+     * @returns
+     */
+    register: <T extends keyof WorkspaceComponentChannelActions>(action: T, handler: (payload: Parameters<WorkspaceComponentChannelActions[T]>[0], id: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Awaitable<ReturnType<WorkspaceComponentChannelActions[T]>>) => boolean;
+}
+/**
+ * This is the Client API channel client.
+ * This is used to communicate with the Workspace Provider from the client API. (`@openfin/workspace` / `client-api`)
+ *
+ * This extends `WorkspaceChannelClientBase`.
+ */
+export interface WorkspaceAPIClientChannelClient extends WorkspaceChannelClientBase {
+    /**
+     * Registers a handler for a channel action.
+     * This function is ONLY used from within `client-api` and should not be used by the workspace components.
+     *
+     * @param action The action to register a handler for.
+     * @param handler The handler to register.
+     */
+    register: <T extends keyof WorkspaceAPIClientChannelActions>(action: T, handler: (payload: Parameters<WorkspaceAPIClientChannelActions[T]>[0], id: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Awaitable<ReturnType<WorkspaceAPIClientChannelActions[T]>>) => boolean;
+}
+export interface WorkspaceChannelProvider extends Omit<OpenFin.ChannelProvider, 'register' | 'dispatch'> {
+    /**
+     * Used for dispatching a channel action to a channel client
+     *
+     * @param to The identity of the client to send the action to.
+     * @param action The action to send.
+     * @param payload The payload to send with the action.
+     */
+    dispatch: <I extends OpenFin.ClientIdentity | OpenFin.Identity, T extends I['name'] extends (typeof homeOFIdentity)['name'] ? keyof SharedChannelActions | keyof HomeChannelActions : I['name'] extends (typeof dockOFIdentity)['name'] ? keyof SharedChannelActions | keyof DockChannelActions : I['name'] extends (typeof storefrontOFIdentity)['name'] ? keyof SharedChannelActions | keyof StoreChannelActions : keyof SharedChannelActions | keyof WorkspaceAPIClientChannelActions>(to: I, action: T, payload: T extends keyof SharedChannelActions ? Parameters<SharedChannelActions[T]>[0] : I['name'] extends (typeof homeOFIdentity)['name'] ? T extends keyof HomeChannelActions ? Parameters<HomeChannelActions[T]>[0] : never : I['name'] extends (typeof dockOFIdentity)['name'] ? T extends keyof DockChannelActions ? Parameters<DockChannelActions[T]>[0] : never : I['name'] extends (typeof storefrontOFIdentity)['name'] ? T extends keyof StoreChannelActions ? Parameters<StoreChannelActions[T]>[0] : never : T extends keyof WorkspaceAPIClientChannelActions ? Parameters<WorkspaceAPIClientChannelActions[T]>[0] : never) => Promise<Awaited<I['name'] extends (typeof homeOFIdentity)['name'] ? T extends keyof HomeChannelActions ? ReturnType<HomeChannelActions[T]> : never : I['name'] extends (typeof dockOFIdentity)['name'] ? T extends keyof DockChannelActions ? ReturnType<DockChannelActions[T]> : never : I['name'] extends (typeof storefrontOFIdentity)['name'] ? T extends keyof StoreChannelActions ? ReturnType<StoreChannelActions[T]> : never : never>>;
+    /**
+     * Used for registering a channel action handler for a channel client
+     *
+     * @param action The action to register a handler for.
+     * @param handler The handler to register.
+     */
+    register: <T extends WorkspaceChannelAction>(action: T, handler: (payload: Parameters<WorkspaceChannelTypes[T]>[0], id: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Awaitable<ReturnType<WorkspaceChannelTypes[T]>>) => boolean;
+}
+export {};

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

@@ -1,61 +1,9 @@
-import type OpenFin from '@openfin/core';
+import type { WorkspaceAPIClientChannelClient, WorkspaceChannelProvider, WorkspaceComponentChannelClient } from './shapes/workspace';
+export type { WorkspaceAPIClientChannelClient, WorkspaceComponentChannelClient, WorkspaceChannelProvider };
 /** The name of the channel for the centralized workspace protocol. */
-export declare const channelName = "__of_workspace_protocol__";
-/**
- * All of the remote procedures that can be called in the
- * Workspace Provider's address space.
- *
- * When adding a new channel action make sure to register a
- * handler for the remote procedure in the Workspace Provider.
- * All of the registered channel action handlers can be found here:
- * @see link: [Provider Protocol Handlers](https://github.com/openfin/workspace/provider/src/api/protocol.ts)
- */
-export declare enum WorkspaceChannelAction {
-    RegisterProvider = "register-provider",
-    DeregisterProvider = "deregister-provider",
-    UpdateProvider = "update-provider",
-    CreateProviderWindow = "create-provider-window",
-    GetProviders = "get-providers",
-    ShowProviderWindow = "show-provider-window",
-    HideProviderWindow = "hide-provider-window",
-    GetStorefrontProviderApps = "get-storefront-provider-apps",
-    GetStorefrontProviderLandingPage = "get-storefront-provider-landing-page",
-    GetStorefrontProviderFooter = "get-storefront-provider-footer",
-    GetStorefrontProviderNavigation = "get-storefront-provider-navigation",
-    LaunchStorefrontProviderApp = "launch-storefront-provider-app",
-    UpdateAppCardButtonConfig = "update-app-card-button-config",
-    ShowHome = "show-home",
-    HideHome = "hide-home",
-    AssignHomeSearchContext = "assign-home-search-context",
-    SetSearchQuery = "set-search-query",
-    OpenHomeAndSetSearchQuery = "open-home-and-set-search-query",
-    TemporaryIsHomeReady = "temporary-is-home-ready",
-    GetLegacyPages = "get-legacy-pages",
-    GetLegacyWorkspaces = "get-legacy-workspaces",
-    GetComputedPlatformTheme = "get-computed-platform-theme",
-    SetSelectedScheme = "set-selected-scheme",
-    RegisterStorefrontProvider = "register-storefront-provider",
-    DeregisterStorefrontProvider = "deregister-storefront-provider",
-    HideStorefront = "hide-storefront",
-    ShowStorefront = "show-storefront"
-}
-export interface ChannelClient extends OpenFin.ChannelClient {
-    dispatch: (action: WorkspaceChannelAction, payload: any) => Promise<any>;
-}
-/**
- * Get a channel client for the centralized Workspace protocol.
- *
- * The channel client is automatically connected to the Workspace Provider,
- * in which acts as a centralized location for executing Workspace API logic.
- *
- * The channel client can execute remote procedures on the provider via its `dispatch` function.
- * A call to the `dispatch` function will block until the channel action has concluded execution
- * in the Workspace Provider's address space.
- * For a list of supported procedures, see the `WorkspaceChannelAction` enum.
- *
- * @returns the channel client for the centralized workspace protocol.
- */
-export declare const getChannelClient: () => Promise<ChannelClient>;
+export declare const channelName: "__of_workspace_protocol__";
+export declare const getChannelClient: () => Promise<WorkspaceComponentChannelClient>;
+export declare const getClientAPIChannelClient: () => Promise<WorkspaceAPIClientChannelClient>;
 /**
  * Launches the Workspace Provider.
  * If the Workspace Provider is already running, does nothing.
@@ -66,4 +14,10 @@ export declare const launchProvider: () => Promise<void>;
  * Then gets a Channel Client that is connected to the Workspace Provider.
  * @returns the Channel Client that is connected to the Workspace Provider.
  */
-export declare const getChannelClientAndLaunchProvider: () => Promise<ChannelClient>;
+export declare const getChannelClientAndLaunchProvider: () => Promise<WorkspaceComponentChannelClient>;
+/**
+ * Launches the Workspace provider if it is not running.
+ * Then gets a Channel Client that is connected to the Workspace Provider.
+ * @returns the Channel Client that is connected to the Workspace Provider.
+ */
+export declare const getClientAPIChannelClientAndLaunchProvider: () => Promise<WorkspaceAPIClientChannelClient>;

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

@@ -71,6 +71,10 @@ export declare type ProviderDisconnectionPayload = {
     provider: StorefrontProviderInternal;
 };
 export interface ProviderUpdatePayload {
+    providerType: 'dock';
+    provider: RemoveFunctions<DockProvider> | DockProviderInternal;
+}
+export interface ProviderUpdateEventPayload {
     providerType: 'dock';
     provider: DockProviderInternal;
 }
@@ -88,7 +92,7 @@ export declare const getProviders: <T extends ProviderType>(providerType: T) =>
  * A function to dispatch showing the component window of current OF identity
  * @returns action to show Component Window
  */
-export declare const showProviderWindow: (providerType: ProviderType) => Promise<any>;
+export declare const showProviderWindow: (providerType: ProviderType) => Promise<void>;
 /**
  * A function to dispatch hiding the component window of current OF identity
  * @returns action to hide Component Window

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

@@ -1,4 +1,3 @@
-import { searchTopic as homeSearchTopic } from '../../../common/src/api/home';
 import { CLISearchResultWithTemplate } from '../../../client-api/src/shapes';
 import { DispatchedAction, SearchProviderInfo, SearchProviderResponse, SearchTopicClient } from '../../../search-api/src/shapes';
 export declare type TemplateActionMap = Record<string, Action>;
@@ -15,6 +14,5 @@ export interface SearchItem {
     onFocus?: () => any;
     requestReload?: () => any;
 }
-export declare type Topic = typeof homeSearchTopic;
 export declare function getHomeSearchTopic(): Promise<SearchTopicClient>;
-export declare function mapSearchResponsesToItems(topic: Topic, responses: SearchProviderResponse[]): SearchItem[];
+export declare function mapSearchResponsesToItems(responses: SearchProviderResponse[]): SearchItem[];

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

@@ -2,6 +2,7 @@ import { App, StorefrontFooter, StorefrontLandingPage, StorefrontNavigationItemA
 import { ProviderInfoInternal } from './provider';
 /**
  * Request object to launch an app.
+ * Passed from Storefront to Provider.
  */
 export interface LaunchStorefrontProviderAppRequest extends ProviderInfoInternal<'storefront'> {
     /**
@@ -9,6 +10,16 @@ export interface LaunchStorefrontProviderAppRequest extends ProviderInfoInternal
      */
     app: App;
 }
+/**
+ * Request object to launch an app.
+ * Passed from Workspace Provider to the Workspace Platform
+ */
+export interface ClientAPILaunchStorefrontProviderAppRequest extends Pick<ProviderInfoInternal<'storefront'>, 'id' | 'platformIdentity'> {
+    /**
+     * App to launch.
+     */
+    app: App;
+}
 /**
  * Launch a Storefront app.
  * @param req LaunchStorefrontProviderAppRequest request object.

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

@@ -1,6 +1,11 @@
 import type OpenFin from '@openfin/core';
 import type { ThemePaletteSet } from '@openfin/ui-library';
 import { ColorSchemeOptionType } from '../../../client-api-platform/src/shapes';
+export declare type WorkspaceComponentSetSelectedSchemePayload = {
+    newScheme: ColorSchemeOptionType;
+    identity: OpenFin.Identity;
+};
+export declare type BrowserSetSelectedSchemePayload = string;
 export interface ComputedThemes extends Array<ComputedTheme> {
 }
 export interface ComputedTheme {
@@ -62,6 +67,7 @@ export interface CustomPaletteSet extends DefaultPaletteSet {
     inputPlaceholder?: string;
     inputDisabled?: string;
     inputFocused?: string;
+    inputBorder?: string;
     textDefault?: string;
     textHelp?: string;
     textInactive?: string;

package/common/src/utils/a11y/search.a11y.d.ts

@@ -26,6 +26,7 @@ export interface AriaSearchInput {
     searchLabelID: string;
     searchResultID: string;
     searchInputID: string;
+    landingPageLabelText: string;
     labelText: string;
 }
 export declare const A11ySearch: AriaSearchInput;

package/common/src/utils/global-context-menu.d.ts

@@ -2,6 +2,7 @@ import type OpenFin from '@openfin/core';
 import { MenuItemType } from '../../../common/src/utils/context-menu';
 import * as WP from '../../../client-api-platform/src/index';
 import { GlobalContextMenuItemTemplate, GlobalContextMenuOptionType, Workspace } from '../../../client-api-platform/src/shapes';
+export declare const isOSWindows: () => Promise<boolean>;
 export declare const savePage: {
     type: MenuItemType;
     label: string;
@@ -30,6 +31,7 @@ export declare const saveWorkspaceAs: {
         type: WP.GlobalContextMenuOptionType;
     };
 };
+export declare const printMenuOptions: (isViewSelected: boolean) => Promise<GlobalContextMenuItemTemplate>;
 export declare const getSavedWorkspaceContextMenuOptions: (activeWorkspace: Workspace, savedWorkspaces: Workspace[], contextMenuOptionType: GlobalContextMenuOptionType) => {
     label: string;
     type: MenuItemType;
@@ -49,4 +51,4 @@ export declare const getAppearanceContextMenuOptions: () => Promise<{
         scheme: WP.ColorSchemeOptionType;
     };
 }[]>;
-export declare const getGlobalContextMenuTemplate: (winIdentity: OpenFin.Identity) => Promise<GlobalContextMenuItemTemplate[]>;
+export declare const getGlobalContextMenuTemplate: (winIdentity: OpenFin.Identity, selectedViews?: OpenFin.Identity[]) => Promise<GlobalContextMenuItemTemplate[]>;

package/common/src/utils/lru-cache.d.ts

@@ -0,0 +1,11 @@
+/**
+ * LRU Cache
+ */
+export default class LRUCache<T> {
+    #private;
+    constructor(capacity: number);
+    get(key: string): T | undefined;
+    has(key: string): boolean;
+    put(key: string, value: T): void;
+    private updateQueue;
+}

package/common/src/utils/menu-window-provider.d.ts

@@ -1,24 +1,22 @@
 import type OpenFin from '@openfin/core';
 import { ModalResponseContent } from '../../../common/src/utils/menu-config';
-import { Listener } from '../../../common/src/utils/shared-emitter';
 import type { OptionalExceptFor } from '../../../common/src/utils/types';
-export declare enum MenuEvent {
-    Ready = "ready",
-    Update = "update",
-    Response = "response"
-}
-export declare enum ModalResponse {
-    Canceled = "canceled",
-    Negative = "negative",
-    Affirmative = "affirmative"
+declare type MenuEventTypes = {
+    response: [ModalResponseEvent];
+    ready: [OpenFin.Identity];
+    update: [string, Partial<OpenFin.Bounds>, string];
+};
+export interface ModalResponseEvent {
+    data: 'canceled' | 'negative' | 'affirmative';
+    name: string;
 }
 export declare const menuEvents: {
-    emit: (event: MenuEvent, ...payload: any[]) => Promise<void>;
-    addListener: (event: MenuEvent, listener: Listener) => void;
-    removeListener: (event: MenuEvent, listener: Listener) => void;
-    once: (event: MenuEvent, listener: Listener) => void;
+    emit: <EventKey extends keyof MenuEventTypes>(event: EventKey, ...payload: MenuEventTypes[EventKey]) => Promise<void>;
+    addListener: <EventKey_1 extends keyof MenuEventTypes>(event: EventKey_1, listener: (...payload: MenuEventTypes[EventKey_1]) => void) => void;
+    removeListener: <EventKey_2 extends keyof MenuEventTypes>(event: EventKey_2, listener: (...payload: MenuEventTypes[EventKey_2]) => void) => void;
+    once: <EventKey_3 extends keyof MenuEventTypes>(event: EventKey_3, listener: (...payload: MenuEventTypes[EventKey_3]) => void) => void;
 };
-export declare const emitMenuResponse: (data: ModalResponse) => Promise<void>;
+export declare const emitMenuResponse: (data: ModalResponseEvent['data']) => Promise<void>;
 declare type WindowOptionsWithBounds = OptionalExceptFor<OpenFin.WindowOptions, 'name' | 'url'> & {
     top: number;
     left: number;
@@ -38,6 +36,6 @@ export declare function createMenuPosition(windowOptions: OptionalExceptFor<Open
 }>;
 export declare function showChildWindow({ options, parameters }: ShowChildOptions): Promise<OpenFin.Window>;
 export declare const waitForModalResponse: ({ options, content }: ResponseModalOptions) => Promise<{
-    data: ModalResponse;
+    data: ModalResponseEvent['data'];
 }>;
 export {};

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

@@ -23,43 +23,31 @@ export declare enum PageRoute {
     DeprecatedAlert = "/provider/deprecated-alert/",
     Analytics = "/provider/analytics/"
 }
-/**
- * All routes that serve assets. (icons, json, etc.)
- */
-export declare enum AssetRoute {
-    IconOpenFinLogo = "/icons/openfinlogo.svg",
-    IconFilter = "/icons/filter.svg",
-    LightStorefront = "/icons/lightstorefront.png",
-    DarkStorefront = "/icons/darkstorefront.png"
-}
+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 CallIconLight: "/icons/call-icon-light.svg";
+    readonly CallIconDark: "/icons/call-icon-dark.svg";
+    readonly ChatIconLight: "/icons/chat-icon-light.svg";
+    readonly ChatIconDark: "/icons/chat-icon-dark.svg";
+    readonly MessageIconLight: "/icons/message-icon-light.svg";
+    readonly MessageIconDark: "/icons/message-icon-dark.svg";
+    readonly Microsoft365Assets: {
+        readonly Microsoft365DocumentIcon: "/microsoft-365-integration-assets/microsoft-365-document-icon.svg";
+        readonly Microsoft365ExcelIcon: "/microsoft-365-integration-assets/microsoft-365-excel-icon.svg";
+        readonly Microsoft365PowerpointIcon: "/microsoft-365-integration-assets/microsoft-365-powerpoint-icon.svg";
+        readonly Microsoft365OutlookIcon: "/microsoft-365-integration-assets/microsoft-365-outlook-icon.svg";
+        readonly Microsoft365TeamsIcon: "/microsoft-365-integration-assets/microsoft-365-teams-icon.svg";
+        readonly Microsoft365Icon: "/microsoft-365-integration-assets/microsoft-365-icon.svg";
+        readonly PDFFileIcon: "/microsoft-365-integration-assets/pdf-file-icon.svg";
+    };
+};
 /**
  * Home DeepLink Options
  */
 export declare enum HomeDeepLink {
     Search = "search"
 }
-declare const _default: {
-    Home: PageRoute.Home;
-    HomeSearch: PageRoute.HomeSearch;
-    HomePagesRename: PageRoute.HomePagesRename;
-    Dock: PageRoute.Dock;
-    HomeIndicator: PageRoute.HomeIndicator;
-    Browser: PageRoute.Browser;
-    BrowserPopupMenu: PageRoute.BrowserPopupMenu;
-    Provider: PageRoute.Provider;
-    BrowserPopupMenuSharePage: PageRoute.BrowserPopupMenuSharePage;
-    BrowserPopupMenuSaveModal: PageRoute.BrowserPopupMenuSaveModal;
-    BrowserPopupMenuLayouts: PageRoute.BrowserPopupMenuLayouts;
-    BrowserPopupMenuColorLinking: PageRoute.BrowserPopupMenuColorLinking;
-    BrowserIndicator: PageRoute.BrowserIndicator;
-    ResponseModal: PageRoute.ResponseModal;
-    Docs: PageRoute.Docs;
-    Storefront: PageRoute.Storefront;
-    DeprecatedAlert: PageRoute.DeprecatedAlert;
-    Analytics: PageRoute.Analytics;
-    IconOpenFinLogo: AssetRoute.IconOpenFinLogo;
-    IconFilter: AssetRoute.IconFilter;
-    LightStorefront: AssetRoute.LightStorefront;
-    DarkStorefront: AssetRoute.DarkStorefront;
-};
-export default _default;
+export default PageRoute;