@openfin/workspace-platform 22.2.18 → 22.3.1

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-platform/src/api/app-directory.d.ts

@@ -7,7 +7,7 @@ import type { LaunchAppRequest, SearchSitesRequest, SearchSitesResponse, Site }
  * @param app the app directory entry.
  * @param opts launch options.
  */
-export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Application | OpenFin.Identity | OpenFin.Platform | OpenFin.View>;
+export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Identity | OpenFin.Application | OpenFin.View | OpenFin.Platform>;
 export declare const enterpriseAppDirectoryChannelClient: () => Promise<OpenFin.ChannelClient>;
 export declare function getResults(payload: {
     req: SearchSitesRequest;

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,7 +46,7 @@ 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;
     /**
      * Synchronize the current palette and scheme with workspace's storage instance if
      * storage based theming is enabled

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

@@ -0,0 +1,7 @@
+export declare const browserWindowPerformanceMarkStart: () => string;
+export declare const browserWindowPerformanceMarkAPIReturn: (performanceMarkTitle: string) => void;
+export declare const setupBrowserWindowShownPerformanceMark: (performanceMarkTitle: string) => void;
+export declare const contextMenuPerformanceMarkStart: () => string;
+export declare const contextMenuPerformanceMarkEnd: (performanceMarkTitle: string) => void;
+export declare const contextMenuPerformanceMarkAPIReturn: (performanceMarkTitle: string) => void;
+export declare const setupContextMenuPerformanceMark: (performanceMarkTitle: string) => void;

package/client-api-platform/src/api/workspaces/index.d.ts

@@ -1,4 +1,4 @@
-import type { ApplyWorkspacePayload, CreateSavedWorkspaceRequest, RestoreLastSavedWorkspacePayload, RestoreLastSavedWorkspaceResult, Workspace } from '../../../../client-api-platform/src/shapes';
+import type { ApplyWorkspacePayload, CreateSavedWorkspaceRequest, GetCurrentWorkspaceOptions, RestoreLastSavedWorkspacePayload, RestoreLastSavedWorkspaceResult, Workspace } from '../../../../client-api-platform/src/shapes';
 /**
  * Apply the given workspace and set it as active.
  * @param payload, the workspace to apply and the options to apply it with.
@@ -20,7 +20,7 @@ export declare function getInitialWorkspace(): Promise<Workspace>;
  * Get a workspace data structure that represents the users current desktop.
  * @returns the current active workspace.
  */
-export declare function getCurrentWorkspace(): Promise<Workspace>;
+export declare function getCurrentWorkspace(options?: GetCurrentWorkspaceOptions): Promise<Workspace>;
 export declare function getLastSavedWorkspace(): Promise<Workspace | undefined>;
 export declare const createWorkspaceInStorage: (req: CreateSavedWorkspaceRequest) => Promise<any>;
 export declare const getWorkspacesInStorage: () => Promise<Workspace[]>;

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

@@ -1,3 +1,4 @@
 export * from './shapes';
-export { init, initDockCompanion } from './init';
+export * as Dock from '../../dock3/src/api';
+export { init } from './init';
 export { getCurrentSync, wrapSync } from './api';

package/client-api-platform/src/init/index.d.ts

@@ -1,6 +1,5 @@
 import OpenFin from '@openfin/core';
-import { CompanionDockConfig, WorkspacePlatformInitConfig } from '../../../client-api-platform/src/shapes';
-export declare function initDockCompanion(config: CompanionDockConfig, platform: OpenFin.Platform): Promise<void>;
+import { WorkspacePlatformInitConfig } from '../../../client-api-platform/src/shapes';
 /**
  * Initilaize a Workspace Platform.
  *

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

@@ -34,4 +34,5 @@ export type WindowType = 'browser' | 'platform' | 'classic' | 'mixed' | 'enterpr
  */
 export declare function checkHasBrowserWindows(snapshot: BrowserSnapshot): boolean;
 export declare const copyObject: <T>(obj: T) => T;
+export declare function validateTabDimensionsIfAny(overrideOptions: OpenFin.PlatformWindowCreationOptions): void;
 export {};

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

@@ -6,8 +6,9 @@ import { AddDefaultPagePayload, AttachedPage, BookmarkNode, CopyPagePayload, Han
 import { SetActivePageForWindowPayload } from '../../common/src/api/pages/shapes';
 import { NotificationsCustomManifestOptions } from '../../common/src/api/shapes/notifications';
 import type { CustomThemes } from '../../common/src/api/theming';
-import { App, DockProviderConfigWithIdentity, StoreButtonConfig, WorkspaceButton } from '../../client-api/src/shapes';
+import { App, DockProviderConfigWithIdentity, StoreButtonConfig } from '../../client-api/src/shapes';
 import type { WorkflowIntegration } from '../../client-api/src/shapes/integrations';
+export * from '../../dock3/src/shapes';
 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';
@@ -153,15 +154,15 @@ export declare enum PageTabContextMenuOptionType {
     Save = "Save",
     SaveAs = "Save As",
     NewPage = "New Page",
-    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
-    AddToChannel = "AddToChannel",// Enterprise
+    DeletePage = "Delete Page",
+    SaveWorkspaceAs = "SaveWorkspaceAs",
+    Refresh = "Refresh",
+    CloseOthers = "Close others",
+    Delete = "Delete",
+    Print = "Print",
+    PrintAll = "PrintAll",
+    PrintScreen = "PrintScreen",
+    AddToChannel = "AddToChannel",
     Custom = "Custom"
 }
 /**Shape of the data property of a global context menu template item */
@@ -604,6 +605,28 @@ export interface BrowserWorkspacePlatformWindowOptions {
     newPageUrl?: string;
     toolbarOptions?: ToolbarOptions;
     windowStateButtonOptions?: WindowStateButtonOptions;
+    /** Specifies the min and max sizes for page tabs.
+     * Page tabs will expand to take all available space up to the specified maximum size.
+     * Similarly, they will collapse down to the specified minimum size.
+     * When there is not enough room to fit the tabs, the tabstrip will become scrollable.
+     * Sizes can be specified as pixels (e.g. "100px") or as percentage of tab strip width (e.g. "20%").
+     * The default value for both min and max is "120px". To maintain usability, minimum values below 28px will be ignored and 28px will be used as the minimum.
+     */
+    pageTabDimensions?: {
+        minWidth?: string;
+        maxWidth?: string;
+    };
+    /** Specifies the min and max sizes for view tabs in a layout.
+     * View tabs will expand to take all available space up to the specified maximum size.
+     * Similarly, they will collapse down to the specified minimum size.
+     * When there is not enough room to fit the tabs, the tabstrip will become scrollable.
+     * Sizes can be specified as pixels (e.g. "100px") or as percentage of tab strip width (e.g. "20%").
+     * The default value for both min and max is "120px". To maintain usability, minimum values below 28px will be ignored and 28px will be used as the minimum.
+     */
+    viewTabDimensions?: {
+        minWidth?: string;
+        maxWidth?: string;
+    };
     /**
      * Use when you want to display navigation buttons in Browser toolbar. Disabled by default.
      *
@@ -1315,6 +1338,17 @@ export interface WorkspacePlatformStorage {
      * ```
      */
     getWorkspaces(): Promise<Workspace[]>;
+    /**
+     * Get all workspaces metadata including the workspaceId and title that are saved in persistent storage.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const workspacesMetadata = await workspacePlatform.Storage.getWorkspacesMetadata();
+     * ```
+     */
+    getWorkspacesMetadata(): Promise<Pick<Workspace, 'workspaceId' | 'title'>[]>;
     /**
      * Get a specific workspace in persistent storage.
      *
@@ -1485,8 +1519,9 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
     launchApp(req: LaunchAppRequest): Promise<void>;
     /**
      * Gets a workspace data structure that represents the current state of the user's desktop.
+     * @param options Options for getting the current workspace.
      */
-    getCurrentWorkspace(): Promise<Workspace>;
+    getCurrentWorkspace(options?: GetCurrentWorkspaceOptions): Promise<Workspace>;
     /**
      * Sets the workspace as the current active workspace.  Does not apply the workspace to the user's desktop.
      * @param workspace the workspace to set as current active workspace.
@@ -1608,6 +1643,11 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
      * @param query an optional query.
      */
     getSavedWorkspaces(query?: string): Promise<Workspace[]>;
+    /**
+     * Implementation for getting a list of saved workspaces metadata from persistent storage.
+     * @param query an optional query.
+     */
+    getSavedWorkspacesMetadata(query?: string): Promise<Pick<Workspace, 'workspaceId' | 'title'>[]>;
     /**
      * Implementation for getting a single workspace in persistent storage.
      * @param id
@@ -1813,6 +1853,9 @@ export declare enum CustomActionCallerType {
 export type CustomActionPayload = {
     callerType: CustomActionCallerType.API;
 } | CustomButtonActionPayload | StoreCustomButtonActionPayload | CustomDropdownItemActionPayload | GlobalContextMenuOptionActionPayload | ViewTabCustomActionPayload | PageTabContextMenuOptionActionPayload | OpenSaveContextMenuOptionActionPayload;
+export interface GetCurrentWorkspaceOptions {
+    skipSnapshotUpdate?: boolean;
+}
 /**
  * Options for the {@link WorkspacePlatformModule.applyWorkspace applyWorkspace} method.
  *
@@ -2183,11 +2226,13 @@ export type WorkspacePlatformOverrideCallback = OpenFin.OverrideCallback<Workspa
  * @deprecated
  */
 export type BrowserOverrideCallback = WorkspacePlatformOverrideCallback;
-export type DockCompanionButton = Exclude<WorkspaceButton, 'store'> | 'contentMenu' | 'bookmarks' | 'searchShortcut';
 export type LaunchDockEntryPayload = {
     entry: DockEntry;
     sourceEvent?: Pick<MouseEvent, 'ctrlKey' | 'metaKey' | 'shiftKey'>;
 };
+export type BookmarkDockEntryPayload = {
+    entry: DockEntry;
+};
 /**
  * Configuration options for Browser window's icons.
  */

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

@@ -14,8 +14,10 @@ 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",// Enterprise
-    GetLayoutsWithSelectedViewsInternal = "get-layouts-with-selected-views",// Enterprise
+    RefreshBookmarksInternal = "refresh-bookmarks",
+    GetLayoutsWithSelectedViewsInternal = "get-layouts-with-selected-views",
     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",// Enterprise
-    UpdateContentMenu = "update-content-menu",// Enterprise
+    UpdateFavoriteEntries = "update-favorite-entries",
+    UpdateContentMenu = "update-content-menu",
     NavigateContentMenu = "navigate-content-menu"
 }
 export declare const BrowserChannelAction: {

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

@@ -48,6 +48,7 @@ export declare enum WorkspacePlatformChannelAction {
     UpdateSavedWorkspace = "updateSavedWorkspace",
     DeleteSavedWorkspace = "deleteSavedWorkspace",
     GetSavedWorkspaces = "getSavedWorkspaces",
+    GetSavedWorkspacesMetadata = "getSavedWorkspacesMetadata",
     SaveWorkspace = "saveWorkspace",
     GetCurrentWorkspace = "getCurrentWorkspace",
     ApplyWorkspace = "applyWorkspace",
@@ -66,30 +67,30 @@ export declare enum WorkspacePlatformChannelAction {
     CopyPage = "copyPage",
     HandlePageChanges = "handlePageChanges",
     MarkUnsavedPagesAsSavedInternal = "markUnsavedPagesAsSavedInternal",
-    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
+    TrackRemovedTabInternal = "trackRemovedTabInternal",
+    RestoreRemovedTabInternal = "restoreRemovedTabInternal",
+    TrackVisitedSiteInternal = "trackVisitedSiteInternal",
+    GetRecentlyVisitedSitesInternal = "getRecentlyVisitedSitesInternal",
+    GetFrequentlyVisitedSitesInternal = "getFrequentlyVisitedSitesInternal",
+    SearchSitesInternal = "searchSitesInternal",
+    GetSearchProvidersInternal = "getSearchProvidersInternal",
+    GetCuratedContentInternal = "getCuratedContentInternal",
+    HandleRequestNavigationInternal = "handleRequestNavigationInternal",
+    RefreshBookmarksInternal = "refreshBookmarksInternal",
+    LaunchBookmarkInternal = "launchBookmarkInternal",
     GetNotificationsConfig = "getNotificationsConfig",
-    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
+    UpdateDockFavoritesInternal = "updateDockFavoritesInternal",
+    UpdateContentMenuInternal = "updateContentMenuInternal",
+    LaunchDockEntryInternal = "launchDockEntryInternal",
+    SetDockFavoritesOrderInternal = "setDockFavoritesOrderInternal",
+    NavigateContentMenuInternal = "navigateContentMenuInternal",
+    SetDefaultDockButtonsOrderInternal = "setDefaultDockButtonsOrderInternal",
+    GetDockWorkspacesContextMenuInternal = "getDockWorkspacesContextMenuInternal",
+    HandleDockWorkspacesMenuResponseInternal = "handleDockWorkspacesMenuResponseInternal",
+    RemoveDockFavoriteInternal = "removeDockFavoriteInternal",
+    AddDockFavoriteInternal = "addDockFavoriteInternal",
+    FocusAndExpandSearchInternal = "focusAndExpandSearchInternal",
+    SendUpdateVersionModalResponseInternal = "sendUpdateVersionModalResponseInternal",
     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/utils/defer-show.d.ts

@@ -24,7 +24,7 @@ interface InternalWindowOptions extends OpenFin.PlatformWindowCreationOptions {
  * @param setAsForeground the option to focus the window when it is shown
  * @returns the modified options.
  */
-export declare const applyDeferShowOptions: (opts: OpenFin.PlatformWindowCreationOptions, setAsForeground?: boolean) => InternalWindowOptions;
+export declare const applyDeferShowOptions: <T>(opts: T, setAsForeground?: boolean) => InternalWindowOptions & T;
 /**
  * This function is a middleware that can be applied to a platform's `createWindow` function.
  * If the defer show API has been enabled in window options using the `applyDeferShowOptions` function

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

@@ -86,7 +86,7 @@ export declare const downloads: () => {
 export declare const appearance: () => {
     label: string;
 };
-export declare const getSavedWorkspaceContextMenuOptions: (activeWorkspace: Workspace, savedWorkspaces: Workspace[], 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/browser.d.ts

@@ -1,7 +1,7 @@
 import type OpenFin from '@openfin/core';
 import { IconType } from '@openfin/ui-library';
 import { IndicatorType } from '../../../../common/src/components/Indicator/Indicator.constants';
-export type BrowserIndicatorIcon = Extract<IconType, 'LockClosedIcon' | 'LockOpen1Icon' | 'PageIcon' | 'BlockedIcon' | 'SupertabIcon'>;
+export type BrowserIndicatorIcon = Extract<IconType, 'LockClosedIcon' | 'LockOpen1Icon' | 'PageIcon' | 'BlockedIcon' | 'SupertabIcon' | 'BookmarkFilled'>;
 export interface ShowBrowserIndicatorPayload {
     type: IndicatorType;
     message: string;

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

@@ -1,3 +1,4 @@
+/// <reference types="lodash" />
 import type OpenFin from '@openfin/core';
 import { WindowIdentity } from '../../../common/src/utils/window';
 import { AttachedPageInternal } from '../../../common/src/api/pages/shapes';
@@ -78,7 +79,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/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 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;
+    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;
 };
-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 | null;
+export declare const getItem: (key: string) => string;
 export declare const removeItem: (key: string) => void;

package/common/src/utils/page-tab-context-menu.d.ts

@@ -1,3 +1,3 @@
 import type OpenFin from '@openfin/core';
 import { PageTabContextMenuItemTemplate } from '../../../client-api-platform/src/shapes';
-export declare const getPageTabMenuTemplate: (pageId: string, winIdentity: OpenFin.Identity) => Promise<PageTabContextMenuItemTemplate[]>;
+export declare const getPageTabMenuTemplate: (pageId: string, winIdentity: OpenFin.Identity, isEnterprise: boolean) => Promise<PageTabContextMenuItemTemplate[]>;

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

@@ -0,0 +1,7 @@
+/**
+ * Pick specific keys from an object.
+ * lodash.pick is deprecated and says to use destructuring instead, but that has one key flaw, it adds undefined properties to the result if the key is not present in the object.
+ * ie `const { a, b } = obj; return {a,b};` will result in `{ a: undefined, b: undefined }` if `a` or `b` are not present in `obj`.
+ * pick({}, ['a', 'b']) will result in `{}` if `a` or `b` are not present in the object.
+ */
+export declare function pick<T extends object, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;

package/common/src/utils/promise-with-resolvers.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Polyfill for `Promise.withResolvers` which is not available in this typescript version.
+ */
+export declare function withResolvers<T>(): PromiseWithResolvers<T>;
+export type PromiseWithResolvers<T> = {
+    promise: Promise<T>;
+    resolve: (value: T | PromiseLike<T>) => void;
+    reject: (reason?: any) => void;
+};

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 extends keyof EventMap>(event: EventKey, listener: (...payload: EventMap[EventKey]) => void) => void;
+    addListener: <EventKey_1 extends keyof EventMap>(event: EventKey_1, listener: (...payload: EventMap[EventKey_1]) => 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 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;
+    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;
 };

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

@@ -33,3 +33,26 @@ export type Awaitable<T> = Awaited<T> | Promise<Awaited<T>>;
 export type RemoveFunctions<T> = Pick<T, {
     [K in keyof T]: T[K] extends Function ? never : K;
 }[keyof T]>;
+type MissingKeys<T, U> = Exclude<keyof T, U>;
+/**
+ * A utility function that checks if the provided keys are valid for the given type T.
+ * The key thing it does is to ensure that all keys in T are present in the array, typescript can check for extra keys but not missing keys.
+ * While it is a function, it is really just a type check. The function is needed to encapsulate the type logic.
+ * It will throw a type error if any of the keys are not present in T.
+ *
+ * @example
+ * ```ts
+ * type Foo = {
+ *     bar: string;
+ *     qux?: string;
+ * };
+ *
+ * const fooChecker = makeKeyChecker<Foo>();
+ * const allFooKeys = fooChecker(['bar', 'qux']); // Valid
+ * fooChecker(['bar']); // Error: Missing keys: qux
+ * fooChecker(['qux']); // Error: Missing keys: bar
+ * 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 {};

package/common/src/utils/workspace-modals.d.ts

@@ -28,4 +28,4 @@ export declare const showUpdateVersionModal: ({ identity, title, description }:
     identity: OpenFin.Identity;
     title: string;
     description: string;
-}) => Promise<ModalResponseEvent["data"]>;
+}) => Promise<ModalResponseEvent['data']>;

package/{common/src/utils/enterprise-dock.d.ts → dock3/src/api/constants.d.ts}

@@ -1,3 +1,5 @@
 export declare const DOCK_COMPANION_HEIGHT = 56;
 export declare const DOCK_COMPANION_WIDTH = 728;
 export declare const DOCK_COMPANION_TOP = 150;
+export declare const DOCK3_WINDOW_NAME = "dock3";
+export declare const getDock3ChannelName: (uuid?: string) => string;