@openfin/workspace-platform 22.4.1 → 22.4.3

package/client-api/src/integrations/microsoft.utils.d.ts

@@ -36,9 +36,9 @@ export declare const MICROSOFT_365_SEARCH_RESULT_ACTIONS: {
  * @param req The user input request object from which to extract the selected filters.
  * @returns An array of CLIFilter objects representing the validated filters.
  */
-export declare const getValidFilters: (req: Parameters<HomeProvider['onUserInput']>[0], searchTypePossibleFilters: Set<Microsoft365DocumentType>) => CLIFilter[];
-export declare const getValidContactFilters: (users: MicrosoftGraphTypes.User[], req: Parameters<HomeProvider['onUserInput']>[0]) => CLIFilter[];
-export declare const getContactFiltersFromRequest: (req: Parameters<HomeProvider['onUserInput']>[0]) => {
+export declare const getValidFilters: (req: Parameters<HomeProvider["onUserInput"]>[0], searchTypePossibleFilters: Set<Microsoft365DocumentType>) => CLIFilter[];
+export declare const getValidContactFilters: (users: MicrosoftGraphTypes.User[], req: Parameters<HomeProvider["onUserInput"]>[0]) => CLIFilter[];
+export declare const getContactFiltersFromRequest: (req: Parameters<HomeProvider["onUserInput"]>[0]) => {
     department: string[];
     jobTitle: string[];
 };
@@ -58,7 +58,7 @@ export declare const filterContactFromRequest: (items: MicrosoftGraphTypes.User[
  * If no types are selected or all types are deselected, the function marks all types to be shown.
  * Otherwise, it marks only the selected types to be shown.
  */
-export declare const getTypeFiltersFromRequest: (req: Parameters<HomeProvider['onUserInput']>[0], searchTypePossibleFilters: Set<Microsoft365DocumentType>) => {
+export declare const getTypeFiltersFromRequest: (req: Parameters<HomeProvider["onUserInput"]>[0], searchTypePossibleFilters: Set<Microsoft365DocumentType>) => {
     readonly showDocuments: boolean;
     readonly showContacts: boolean;
     /** Teams Messages */
@@ -70,7 +70,7 @@ export declare const getTypeFiltersFromRequest: (req: Parameters<HomeProvider['o
     /** SharePoint Lists */
     readonly showLists: boolean;
 };
-export declare const getDocumentFiltersFromRequest: (req: Parameters<HomeProvider['onUserInput']>[0]) => {
+export declare const getDocumentFiltersFromRequest: (req: Parameters<HomeProvider["onUserInput"]>[0]) => {
     readonly filterFiles: boolean;
     readonly showWord: boolean;
     readonly showExcel: boolean;
@@ -81,6 +81,6 @@ export declare const getDocumentFiltersFromRequest: (req: Parameters<HomeProvide
 export declare const filterDocumentsFromRequest: (items: MicrosoftGraphTypes.DriveItem[], filter: ReturnType<typeof getDocumentFiltersFromRequest>) => MicrosoftGraphTypes.DriveItem[];
 export declare const getFileType: (fileName?: string) => string;
 export declare const getFileIcon: (fileName?: string) => string;
-export declare const mapMicrosoftAvailabilityToPresence: (availability: Presence) => CLISearchResultContact['templateContent']['onlineStatus'] | undefined;
+export declare const mapMicrosoftAvailabilityToPresence: (availability: Presence) => CLISearchResultContact["templateContent"]["onlineStatus"] | undefined;
 /** base64IdToUrl converts a base64 encoded id to a url safe id */
 export declare const base64IdToUrl: (b64Id: string) => string;

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/context-menu/utils.d.ts

@@ -1,5 +1,10 @@
 import type OpenFin from '@openfin/core';
+import { PositioningType } from '../../../../common/src/utils/positioning';
 import { WorkspaceContextMenuItemData } from '../../../../client-api-platform/src/shapes';
+export declare const saveWorkspaceHandlerWithInjectables: ({ showModal, afterSuccessSave }: {
+    showModal?: () => Promise<void>;
+    afterSuccessSave?: () => Promise<void>;
+}) => Promise<void>;
 export declare const saveWorkspaceHandler: (identity: OpenFin.Identity) => Promise<void>;
 export declare const saveWorkspaceAsHandler: (identity: OpenFin.Identity) => void;
 /**
@@ -17,6 +22,11 @@ export declare const savePageHandler: (identity: OpenFin.Identity, pageId?: stri
  */
 export declare const savePageAsHandler: (identity: OpenFin.Identity, pageId?: string) => Promise<void>;
 export declare const switchWorkspaceHandler: (winIdentity: OpenFin.Identity, workspaceItemData: WorkspaceContextMenuItemData) => Promise<void>;
+export declare const deleteWorkspaceHandlerWithPayload: ({ workspaceItemData, winIdentity, positioning }: {
+    workspaceItemData: WorkspaceContextMenuItemData;
+    winIdentity?: OpenFin.Identity;
+    positioning?: PositioningType;
+}) => Promise<void>;
 export declare const deleteWorkspaceHandler: (winIdentity: OpenFin.Identity, workspaceItemData: WorkspaceContextMenuItemData) => Promise<void>;
 export declare const downloadsHandler: (identity: OpenFin.Identity) => Promise<void>;
 /**

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

@@ -4,7 +4,7 @@ import { ColorSchemeOptionType, CustomPaletteSet } from '../../../../client-api-
  *
  * This is particularly useful if a value uses a different palette constant depending on scheme.
  */
-export declare const getPaletteExtensions: (palette: CustomPaletteSet, paletteScheme: 'light' | 'dark', isWindows: boolean) => {
+export declare const getPaletteExtensions: (palette: CustomPaletteSet, paletteScheme: "light" | "dark", isWindows: boolean) => {
     dockExpandedContainerBorderColor: string;
     dockExpandedContainerBorderRadius: string;
     dockExpandedContainerBackground: string;
@@ -46,10 +46,16 @@ export declare class ThemeStorageController {
      * A workaround that can be leveraged in cross origin scenarios (which is the majority of the workspace use case) is available in this commit: 233e843cda6cd68968fd5831fb20597e0d5bb7cc
      * `git revert 233e843cda6cd68968fd5831fb20597e0d5bb7cc --no-commit`
      */
-    setWorkspaceStorage: (proxy: Pick<Storage, 'setItem'>) => void;
+    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/client-api-platform/src/api/pages/open-pages.d.ts

@@ -1,5 +1,5 @@
 import { AnalyticsEventInternal } from '../../../../common/src/utils/usage-register';
 import { Page } from '../../../../client-api-platform/src/shapes';
 export declare const getOpenPages: () => Map<string, AnalyticsEventInternal>;
-export declare const addOpenPageToCache: (pageId: Page['pageId'], event: AnalyticsEventInternal) => void;
-export declare const removeOpenPageFromCache: (pageId: Page['pageId']) => boolean;
+export declare const addOpenPageToCache: (pageId: Page["pageId"], event: AnalyticsEventInternal) => void;
+export declare const removeOpenPageFromCache: (pageId: Page["pageId"]) => boolean;

package/client-api-platform/src/init/override-callback/page-defaults.d.ts

@@ -1,4 +1,4 @@
 import OpenFin from '@openfin/core';
 import type { AttachedPage, AttachedPageInternal } from '../../../../common/src/api/pages/shapes';
 import { BrowserInitConfig } from '../..';
-export declare const applyPageDefaults: (pages: AttachedPage[], initOptions?: Pick<BrowserInitConfig, 'defaultPageOptions' | 'defaultViewOptions' | 'defaultWindowOptions'>, overrideOptions?: OpenFin.PlatformWindowCreationOptions) => Promise<AttachedPageInternal[]>;
+export declare const applyPageDefaults: (pages: AttachedPage[], initOptions?: Pick<BrowserInitConfig, "defaultPageOptions" | "defaultViewOptions" | "defaultWindowOptions">, overrideOptions?: OpenFin.PlatformWindowCreationOptions) => Promise<AttachedPageInternal[]>;

package/client-api-platform/src/init/override-callback/view-options.d.ts

@@ -7,5 +7,5 @@ type ViewStateBase = Pick<BrowserViewState, '_internalWorkspaceData' | 'workspac
 export declare const mapInternalWorkspaceDataToWorkspacePlatform: <T extends ViewStateBase>(viewState: T) => T;
 export declare const mapWorkspacePlatformToInternalWorkspaceData: <T extends ViewStateBase>(viewState: T) => T;
 export declare const setHotkeysIfNavigationButtonsEnabled: (options: BrowserCreateViewRequest) => Promise<BrowserCreateViewRequest>;
-export declare const registerHotkeyListenersIfEnabled: (viewIdentity: OpenFin.Identity, buttonOptions?: BrowserWorkspacePlatformViewOptions['browserNavigationButtons']) => void;
+export declare const registerHotkeyListenersIfEnabled: (viewIdentity: OpenFin.Identity, buttonOptions?: BrowserWorkspacePlatformViewOptions["browserNavigationButtons"]) => void;
 export {};

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

@@ -154,16 +154,16 @@ export declare enum PageTabContextMenuOptionType {
     Save = "Save",
     SaveAs = "Save As",
     NewPage = "New Page",
-    DeletePage = "Delete Page",
-    SaveWorkspaceAs = "SaveWorkspaceAs",
-    Refresh = "Refresh",
-    CloseOthers = "Close others",
-    Delete = "Delete",
-    Print = "Print",
-    PrintAll = "PrintAll",
-    PrintScreen = "PrintScreen",
-    ManageDesktopSignals = "ManageDesktopSignals",
-    AddToChannel = "AddToChannel",
+    DeletePage = "Delete Page",// Enterprise
+    SaveWorkspaceAs = "SaveWorkspaceAs",// Enterprise
+    Refresh = "Refresh",// Enterprise
+    CloseOthers = "Close others",// Enterprise
+    Delete = "Delete",// Enterprise
+    Print = "Print",// Enterprise
+    PrintAll = "PrintAll",// Enterprise
+    PrintScreen = "PrintScreen",// Enterprise
+    ManageDesktopSignals = "ManageDesktopSignals",// Enterprise
+    AddToChannel = "AddToChannel",// Enterprise
     Custom = "Custom"
 }
 /**Shape of the data property of a global context menu template item */
@@ -2304,6 +2304,10 @@ export interface UpdateSavedWorkspaceRequest {
     /** The updated workspace. */
     workspace: Workspace;
 }
+export type OpenSaveWorkspaceMenuRequest = {
+    menuType: SaveModalType.SAVE_WORKSPACE | SaveModalType.SAVE_WORKSPACE_AS | SaveModalType.RENAME_WORKSPACE;
+    id?: never;
+};
 /**
  * Request to create a save modal.
  * @private
@@ -2311,10 +2315,7 @@ export interface UpdateSavedWorkspaceRequest {
 export type OpenSaveMenuRequest = {
     menuType: SaveModalType.SAVE_PAGE | SaveModalType.SAVE_PAGE_AS | SaveModalType.RENAME_PAGE;
     id: string;
-} | {
-    menuType: SaveModalType.SAVE_WORKSPACE | SaveModalType.SAVE_WORKSPACE_AS | SaveModalType.RENAME_WORKSPACE;
-    id?: never;
-};
+} | OpenSaveWorkspaceMenuRequest;
 export type TaskbarIcon = {
     dark: string;
     light: string;

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/api/pages/idb.d.ts

@@ -14,10 +14,8 @@ export declare function updatePage({ pageId, page }: {
 export declare const addRemovedTab: (payload: TrackedTab) => Promise<void>;
 export declare const popLastRemovedTab: () => Promise<TrackedTab | undefined>;
 export declare const trackVisitedSite: (payload: Site) => Promise<void>;
-export declare const getRecentVisitedSites: (numOfSites?: number) => Promise<TrackedSite[] | [
-]>;
-export declare const getFrequentlyVisitedSites: () => Promise<TrackedSite[] | [
-]>;
+export declare const getRecentVisitedSites: (numOfSites?: number) => Promise<TrackedSite[] | []>;
+export declare const getFrequentlyVisitedSites: () => Promise<TrackedSite[] | []>;
 export declare const searchSites: (payload: {
     req: SearchSitesRequest;
 } & {

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

@@ -34,8 +34,8 @@ declare enum GeneralBrowserChannelActions {
     SetSelectedScheme = "set-selected-scheme",
     ShowBrowserIndicator = "show-browser-indicator",
     SetSelectedLanguage = "set-selected-language",
-    RefreshBookmarksInternal = "refresh-bookmarks",
-    GetLayoutsWithSelectedViewsInternal = "get-layouts-with-selected-views",
+    RefreshBookmarksInternal = "refresh-bookmarks",// Enterprise
+    GetLayoutsWithSelectedViewsInternal = "get-layouts-with-selected-views",// Enterprise
     FocusAndExpandSearchInternal = "focus-and-expand-search"
 }
 /**
@@ -56,8 +56,8 @@ export declare enum PageChannelAction {
     IsActivePageChanging = "is-active-page-changing"
 }
 export declare enum CompanionDockChannelAction {
-    UpdateFavoriteEntries = "update-favorite-entries",
-    UpdateContentMenu = "update-content-menu",
+    UpdateFavoriteEntries = "update-favorite-entries",// Enterprise
+    UpdateContentMenu = "update-content-menu",// Enterprise
     NavigateContentMenu = "navigate-content-menu"
 }
 export declare const BrowserChannelAction: {

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

@@ -67,30 +67,30 @@ export declare enum WorkspacePlatformChannelAction {
     CopyPage = "copyPage",
     HandlePageChanges = "handlePageChanges",
     MarkUnsavedPagesAsSavedInternal = "markUnsavedPagesAsSavedInternal",
-    TrackRemovedTabInternal = "trackRemovedTabInternal",
-    RestoreRemovedTabInternal = "restoreRemovedTabInternal",
-    TrackVisitedSiteInternal = "trackVisitedSiteInternal",
-    GetRecentlyVisitedSitesInternal = "getRecentlyVisitedSitesInternal",
-    GetFrequentlyVisitedSitesInternal = "getFrequentlyVisitedSitesInternal",
-    SearchSitesInternal = "searchSitesInternal",
-    GetSearchProvidersInternal = "getSearchProvidersInternal",
-    GetCuratedContentInternal = "getCuratedContentInternal",
-    HandleRequestNavigationInternal = "handleRequestNavigationInternal",
-    RefreshBookmarksInternal = "refreshBookmarksInternal",
-    LaunchBookmarkInternal = "launchBookmarkInternal",
+    TrackRemovedTabInternal = "trackRemovedTabInternal",// Enterprise
+    RestoreRemovedTabInternal = "restoreRemovedTabInternal",// Enterprise
+    TrackVisitedSiteInternal = "trackVisitedSiteInternal",// Enterprise
+    GetRecentlyVisitedSitesInternal = "getRecentlyVisitedSitesInternal",// Enterprise
+    GetFrequentlyVisitedSitesInternal = "getFrequentlyVisitedSitesInternal",// Enterprise
+    SearchSitesInternal = "searchSitesInternal",// Enterprise
+    GetSearchProvidersInternal = "getSearchProvidersInternal",// Enterprise
+    GetCuratedContentInternal = "getCuratedContentInternal",// Enterprise
+    HandleRequestNavigationInternal = "handleRequestNavigationInternal",// Enterprise
+    RefreshBookmarksInternal = "refreshBookmarksInternal",// Enterprise
+    LaunchBookmarkInternal = "launchBookmarkInternal",// Enterprise
     GetNotificationsConfig = "getNotificationsConfig",
-    UpdateDockFavoritesInternal = "updateDockFavoritesInternal",
-    UpdateContentMenuInternal = "updateContentMenuInternal",
-    LaunchDockEntryInternal = "launchDockEntryInternal",
-    SetDockFavoritesOrderInternal = "setDockFavoritesOrderInternal",
-    NavigateContentMenuInternal = "navigateContentMenuInternal",
-    SetDefaultDockButtonsOrderInternal = "setDefaultDockButtonsOrderInternal",
-    GetDockWorkspacesContextMenuInternal = "getDockWorkspacesContextMenuInternal",
-    HandleDockWorkspacesMenuResponseInternal = "handleDockWorkspacesMenuResponseInternal",
-    RemoveDockFavoriteInternal = "removeDockFavoriteInternal",
-    AddDockFavoriteInternal = "addDockFavoriteInternal",
-    FocusAndExpandSearchInternal = "focusAndExpandSearchInternal",
-    SendUpdateVersionModalResponseInternal = "sendUpdateVersionModalResponseInternal",
+    UpdateDockFavoritesInternal = "updateDockFavoritesInternal",// Enterprise
+    UpdateContentMenuInternal = "updateContentMenuInternal",// Enterprise
+    LaunchDockEntryInternal = "launchDockEntryInternal",// Enterprise
+    SetDockFavoritesOrderInternal = "setDockFavoritesOrderInternal",// Enterprise
+    NavigateContentMenuInternal = "navigateContentMenuInternal",// Enterprise
+    SetDefaultDockButtonsOrderInternal = "setDefaultDockButtonsOrderInternal",// Enterprise
+    GetDockWorkspacesContextMenuInternal = "getDockWorkspacesContextMenuInternal",// Enterprise
+    HandleDockWorkspacesMenuResponseInternal = "handleDockWorkspacesMenuResponseInternal",// Enterprise
+    RemoveDockFavoriteInternal = "removeDockFavoriteInternal",// Enterprise
+    AddDockFavoriteInternal = "addDockFavoriteInternal",// Enterprise
+    FocusAndExpandSearchInternal = "focusAndExpandSearchInternal",// Enterprise
+    SendUpdateVersionModalResponseInternal = "sendUpdateVersionModalResponseInternal",// Enterprise
     ShowUpdateVersionModalInternal = "showUpdateVersionModalInternal"
 }
 export type PlatFormSupportedFeatures = boolean | {

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

@@ -98,7 +98,7 @@ export interface ProviderUpdateEventPayload {
  *
  * This allows for different providers to be registered with the same id.
  */
-export declare const getUniqueProviderIdentifier: ({ platformIdentity, id }: Pick<ProviderInfoInternal, 'platformIdentity' | 'id'>) => string;
+export declare const getUniqueProviderIdentifier: ({ platformIdentity, id }: Pick<ProviderInfoInternal, "platformIdentity" | "id">) => string;
 /**
  * Get a list of all providers that have registered with the provider API.
  */

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

@@ -30,29 +30,29 @@ export declare const launchStorefrontApp: (req: LaunchStorefrontProviderAppReque
  * @param identity of the platform to get the apps from.
  * @returns the list of Storefront apps for the platform.
  */
-export declare const getStorefrontApps: (provider: ProviderInfoInternal<'storefront'>) => Promise<App[]>;
+export declare const getStorefrontApps: (provider: ProviderInfoInternal<"storefront">) => Promise<App[]>;
 /**
  * Get the platform's landing page for Storefront.
  * @param identity of the platform to get the landing page of.
  * @returns the platform's landing page.
  */
-export declare const getStorefrontLandingPage: (provider: ProviderInfoInternal<'storefront'>) => Promise<StorefrontLandingPage | undefined>;
+export declare const getStorefrontLandingPage: (provider: ProviderInfoInternal<"storefront">) => Promise<StorefrontLandingPage | undefined>;
 /**
  * Get the platform's footer for Storefront.
  * @param identity of the platform to get the footer of.
  * @returns the platform's footer.
  */
-export declare const getStorefrontFooter: (provider: ProviderInfoInternal<'storefront'>) => Promise<StorefrontFooter>;
+export declare const getStorefrontFooter: (provider: ProviderInfoInternal<"storefront">) => Promise<StorefrontFooter>;
 /**
  * Get the platform's navigation for Storefront.
  * @param identity of the platform to get the navigation of.
  * @returns the platform's navigation.
  */
-export declare const getStorefrontNavigation: (provider: ProviderInfoInternal<'storefront'>) => Promise<[StorefrontNavigationSection?, StorefrontNavigationSection?]>;
+export declare const getStorefrontNavigation: (provider: ProviderInfoInternal<"storefront">) => Promise<[StorefrontNavigationSection?, StorefrontNavigationSection?]>;
 /**
  * A helper method that gets a Storefront navigation item by ID.
  * @param navigationItemId the id of the Storefront navigation item.
  * @param identity of the platform.
  * @returns the navigation item with the ID.
  */
-export declare const getStorefrontNavigationItemAppGrid: (navigationItemId: string, provider: ProviderInfoInternal<'storefront'>) => Promise<StorefrontNavigationItemAppGrid | undefined>;
+export declare const getStorefrontNavigationItemAppGrid: (navigationItemId: string, provider: ProviderInfoInternal<"storefront">) => Promise<StorefrontNavigationItemAppGrid | undefined>;

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

@@ -276,5 +276,5 @@ export declare const getComputedPaletteSets: (customTheme: CustomThemeOptions |
 export declare const computeThemes: (customThemes: CustomThemes, storedScheme?: ColorSchemeOptionType) => ComputedThemes;
 export declare const getComputedPlatformTheme: (platformIdentity: OpenFin.Identity) => Promise<ComputedTheme>;
 export declare const setSelectedScheme: (ctx: ColorSchemeOptionType) => Promise<void>;
-export declare const getComputedScheme: (identity?: OpenFin.Identity) => Promise<Exclude<ColorSchemeType, 'system'>>;
+export declare const getComputedScheme: (identity?: OpenFin.Identity) => Promise<Exclude<ColorSchemeType, "system">>;
 export declare const getComputedBackgroundColor: (paletteKey: keyof typeof Palette, defaultColor?: string) => Promise<string>;

package/common/src/components/IndicatorContainer/bounds.d.ts

@@ -0,0 +1,14 @@
+import type OpenFin from '@openfin/core';
+import { IndicatorBounds, IndicatorOptions, WindowSize } from './types';
+/**
+ * Gets the bounds of the parent window, with fallback to provided bounds.
+ */
+export declare const getParentWindowBounds: (parentWindow: OpenFin.Window | false, parentWindowBounds?: OpenFin.WindowBounds) => Promise<OpenFin.WindowBounds | undefined>;
+/**
+ * Checks if a window is maximized.
+ */
+export declare const isWindowMaximized: (parentWindow: OpenFin.Window | false) => Promise<boolean>;
+/**
+ * Pure function – returns the final indicator rectangle, nothing else.
+ */
+export declare function computeIndicatorBounds(identity: OpenFin.Identity | null | undefined, mySize: WindowSize, opts: IndicatorOptions): Promise<IndicatorBounds>;

package/common/src/components/IndicatorContainer/types.d.ts

@@ -0,0 +1,35 @@
+import type OpenFin from '@openfin/core';
+import { PositioningType } from '../../../../common/src/utils/positioning';
+export declare enum ShowAtType {
+    Top = "top",
+    Below = "below"
+}
+export interface IndicatorOptions {
+    /**
+     * Where to place the indicator relative to its parent.
+     */
+    showAt: ShowAtType;
+    /**
+     * When `true`, we use the "enterprise" timing + vertical offset rules.
+     */
+    isEnterprise: boolean;
+    /**
+     * The bounds of the parent window if the parent is not available at
+     * runtime (e.g. the browser window launched the indicator and closed).
+     */
+    fallbackParentBounds?: OpenFin.WindowBounds;
+    /**
+     * Determines whether to position relative to parent window or monitor.
+     */
+    positioning?: PositioningType;
+}
+export interface IndicatorBounds {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+}
+export interface WindowSize {
+    width: number;
+    height: number;
+}

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

@@ -93,7 +93,7 @@ export declare const downloads: () => {
 export declare const appearance: () => {
     label: string;
 };
-export declare const getSavedWorkspaceContextMenuOptions: (activeWorkspace: Workspace, savedWorkspaces: Pick<Workspace, 'workspaceId' | 'title'>[], contextMenuOptionType: GlobalContextMenuOptionType) => {
+export declare const getSavedWorkspaceContextMenuOptions: (activeWorkspace: Workspace, savedWorkspaces: Pick<Workspace, "workspaceId" | "title">[], contextMenuOptionType: GlobalContextMenuOptionType) => {
     label: string;
     type: MenuItemType;
     enabled: boolean;

package/common/src/utils/indicators/showIndicator.d.ts

@@ -0,0 +1,55 @@
+import { IconType } from '@openfin/ui-library';
+import { PositioningType } from '../../../../common/src/utils/positioning';
+import { IndicatorType } from '../../../../common/src/components/Indicator/Indicator.constants';
+export type IndicatorIcon = Extract<IconType, 'LockClosedIcon' | 'LockOpen1Icon' | 'PageIcon' | 'BlockedIcon' | 'SupertabIcon' | 'BookmarkFilled'>;
+export interface ShowIndicatorPayload {
+    type: IndicatorType;
+    message: string;
+    parentBrowserName?: string;
+    secondaryMessage?: string;
+    icon?: IndicatorIcon;
+    isEnterprise?: boolean;
+    positioning?: PositioningType;
+}
+export interface ShowErrorPayload {
+    message: string;
+    parentBrowserName?: string;
+    icon?: IndicatorIcon;
+    isEnterprise?: boolean;
+    positioning?: PositioningType;
+}
+export interface ShowSuccessPayload {
+    message: string;
+    parentBrowserName?: string;
+    secondaryMessage?: string;
+    icon?: IndicatorIcon;
+    isEnterprise?: boolean;
+    positioning?: PositioningType;
+}
+export interface ShowInfoPayload {
+    message: string;
+    parentBrowserName?: string;
+    icon?: IndicatorIcon;
+    isEnterprise?: boolean;
+}
+/**
+ * Creates a window containing a visual indicator contained in a Browser Window
+ * This function decides whether to call browser function or direct function
+ */
+export declare function showIndicator(payload: ShowIndicatorPayload): Promise<void>;
+/**
+ * Creates a window containing an error indicator
+ */
+export declare function showError(payload: ShowErrorPayload): Promise<void>;
+/**
+ * Creates a window containing a success indicator
+ */
+export declare function showSuccess(payload: ShowSuccessPayload): Promise<void>;
+/**
+ * Creates a window containing an info indicator
+ */
+export declare function showInfo(payload: ShowInfoPayload): Promise<void>;
+/**
+ * Creates a window centered on monitor containing a success indicator for switching workspaces
+ */
+export declare function showSwitchWorkspaceSuccess(): Promise<void>;

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

@@ -1,4 +1,3 @@
-/// <reference types="lodash" />
 import type OpenFin from '@openfin/core';
 import { WindowIdentity } from '../../../common/src/utils/window';
 import { AttachedPageInternal } from '../../../common/src/api/pages/shapes';
@@ -79,7 +78,7 @@ export declare const cloneLayoutAndRemoveNames: (layout: PageLayout) => any;
  * @returns A copy of the layout with generated names removed
  */
 export declare const cloneLayoutAndRemoveGeneratedNames: (layout: PageLayout) => any;
-export declare const mapContentComponentState: (content: OpenFin.LayoutContent) => OpenFin.LayoutComponent['componentState'][];
+export declare const mapContentComponentState: (content: OpenFin.LayoutContent) => OpenFin.LayoutComponent["componentState"][];
 export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<any>;
 export declare const layoutNameInitializedMap: Map<string, boolean>;
 export declare const isLayoutTabActive: (tabSelector: string) => boolean;

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/common/src/utils/menu-window-provider.d.ts

@@ -17,12 +17,12 @@ export interface ModalResponseEvent {
 }
 export declare const menuEvents: {
     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;
-    addListenerWithUUID: (uuid: string) => <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;
+    addListener: <EventKey extends keyof MenuEventTypes>(event: EventKey, listener: (...payload: MenuEventTypes[EventKey]) => void) => void;
+    addListenerWithUUID: (uuid: string) => <EventKey extends keyof MenuEventTypes>(event: EventKey, listener: (...payload: MenuEventTypes[EventKey]) => void) => void;
+    removeListener: <EventKey extends keyof MenuEventTypes>(event: EventKey, listener: (...payload: MenuEventTypes[EventKey]) => void) => void;
+    once: <EventKey extends keyof MenuEventTypes>(event: EventKey, listener: (...payload: MenuEventTypes[EventKey]) => void) => void;
 };
-export declare const emitMenuResponse: (data: ModalResponseEvent['data']) => Promise<void>;
+export declare const emitMenuResponse: (data: ModalResponseEvent["data"]) => Promise<void>;
 type WindowOptionsWithBounds = OptionalExceptFor<OpenFin.WindowOptions, 'name' | 'url'> & {
     top: number;
     left: number;
@@ -49,6 +49,6 @@ export declare function createMenuPosition(windowOptions: OptionalExceptFor<Open
 }>;
 export declare function showChildWindow({ options, parameters }: ShowChildOptions): Promise<OpenFin.Window>;
 export declare const waitForModalResponse: ({ options, content, parameters }: ResponseModalOptions) => Promise<{
-    data: ModalResponseEvent['data'];
+    data: ModalResponseEvent["data"];
 }>;
 export {};

package/common/src/utils/modal-bounds.d.ts

@@ -16,7 +16,7 @@ export declare const getCenterOfParentWindowMonitor: (parentWindowIdentity?: Ope
  * @param centerOnMonitor whether the modal should be centered on the monitor
  * @returns the bounds for where the modal is to be displayed
  */
-export declare const getResponseModalBounds: (modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean) => Promise<OpenFin.Bounds>;
+export declare const getResponseModalBounds: (modalOptions: ResponseModalConfig["windowOptions"], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean) => Promise<OpenFin.Bounds>;
 export declare function getResponseModalBoundsAndCenterParentIfModalOffScreen(modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean): Promise<OpenFin.Bounds>;
 /**
  * Adjusts the given bounds to be within the closest monitor's available bounds if they are offscreen.

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

@@ -1,4 +1,4 @@
-export declare const createNamespacedLocalStorage: <TKey extends string>(namespace: string) => Pick<Storage, 'setItem' | 'getItem' | 'removeItem'>;
+export declare const createNamespacedLocalStorage: <TKey extends string>(namespace: string) => Pick<Storage, "setItem" | "getItem" | "removeItem">;
 export declare const setItem: (key: string, value: string) => void;
-export declare const getItem: (key: string) => string;
+export declare const getItem: (key: string) => string | null;
 export declare const removeItem: (key: string) => void;

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

@@ -0,0 +1,4 @@
+export declare enum PositioningType {
+    RelativeToParentWindow = "relative-to-parent-window",
+    RelativeToMonitor = "relative-to-monitor"
+}

package/common/src/utils/shared-emitter.d.ts

@@ -5,12 +5,12 @@ export default function makeSharedEmitter<EventMap extends {
     [key: string | number]: any[];
 }>(id: string): {
     emit: <EventKey extends keyof EventMap>(event: EventKey, ...payload: EventMap[EventKey]) => Promise<void>;
-    addListener: <EventKey_1 extends keyof EventMap>(event: EventKey_1, listener: (...payload: EventMap[EventKey_1]) => void) => void;
+    addListener: <EventKey extends keyof EventMap>(event: EventKey, listener: (...payload: EventMap[EventKey]) => void) => void;
     /**
      * Creates a listener for a particular UUID instead of ApplicationUUID.Workspace.
      * @param uuid The UUID of the application to subscribe to.
      */
-    addListenerWithUUID: (uuid: string) => <EventKey_1 extends keyof EventMap>(event: EventKey_1, listener: (...payload: EventMap[EventKey_1]) => void) => void;
-    removeListener: <EventKey_2 extends keyof EventMap>(event: EventKey_2, listener: (...payload: EventMap[EventKey_2]) => void) => void;
-    once: <EventKey_3 extends keyof EventMap>(event: EventKey_3, listener: (...payload: EventMap[EventKey_3]) => void) => void;
+    addListenerWithUUID: (uuid: string) => <EventKey extends keyof EventMap>(event: EventKey, listener: (...payload: EventMap[EventKey]) => void) => void;
+    removeListener: <EventKey extends keyof EventMap>(event: EventKey, listener: (...payload: EventMap[EventKey]) => void) => void;
+    once: <EventKey extends keyof EventMap>(event: EventKey, listener: (...payload: EventMap[EventKey]) => void) => void;
 };

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

@@ -54,5 +54,5 @@ type MissingKeys<T, U> = Exclude<keyof T, U>;
  * fooChecker(['bar', 'qux', 'baz']); // 'baz' is not assignable to type keyof Foo;
  * ```
  */
-export declare const makeKeyChecker: <T extends object>() => <const K extends (keyof T)[]>(arr: K & (Exclude<keyof T, K[number]> extends never ? unknown : `Error: Missing keys: ${string & Exclude<keyof T, K[number]>}`)) => K;
+export declare const makeKeyChecker: <T extends object>() => <K extends (keyof T)[]>(arr: K & (MissingKeys<T, K[number]> extends never ? unknown : `Error: Missing keys: ${string & MissingKeys<T, K[number]>}`)) => K;
 export {};

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

@@ -7,6 +7,7 @@ export declare enum WindowName {
     HomeInternal = "openfin-home-internal",
     BrowserMenu = "openfin-browser-menu",
     BrowserSaveMenu = "openfin-browser-save-menu",
+    DockSaveWorkspaceMenu = "openfin-dock3-save-workspace-menu",
     BrowserIndicator = "openfin-browser-indicator",
     BrowserWindow = "internal-generated-window",
     ClassicWindow = "internal-generated-classic-window",
@@ -179,5 +180,5 @@ export declare const getWindowBounds: (window: OpenFin.Window) => Promise<OpenFi
  * @param monitor the monitor to check against
  */
 export declare function getPercentageOfBoundsInMonitor(bounds: OpenFin.Bounds, monitor: OpenFin.MonitorDetails): number;
-export declare function getMonitorWindowMaximizedOn(parentWindowBounds: OpenFin.Bounds): Promise<OpenFin.MonitorDetails>;
+export declare function getMonitorWindowMostOn(parentWindowBounds: OpenFin.Bounds): Promise<OpenFin.MonitorDetails>;
 export {};