@openfin/workspace 22.3.0 → 22.3.1

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/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

@@ -2,7 +2,6 @@ import type OpenFin from '@openfin/core';
 import { IconProps, IconType, Languages } from '@openfin/ui-library';
 import { ModalResponseEvent } from '../../common/src/utils/menu-window-provider';
 import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/utils/usage-register';
-import { Point } from '../../common/src/utils/window';
 import { BaseCustomDropdownItem, CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 import { Resource } from '../../common/src/api/i18next';
 import { TrackedSite } from '../../common/src/api/pages/idb';
@@ -10,8 +9,10 @@ import { AddDefaultPagePayload, AttachedPage, BookmarkNode, CopyPagePayload, Cre
 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';
+import { DockCompanionButton } from '../../dock3/src/shapes/index';
+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';
@@ -653,6 +654,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.
      *
@@ -1261,7 +1284,7 @@ export type AppSite = SiteInfo & {
  * @internal
  */
 export type WorkspaceSite = SiteInfo & {
-    type: 'page' | 'workspace';
+    type: 'page' | 'workspace' | 'collection';
 };
 /**
  * @internal
@@ -1608,6 +1631,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.
      *
@@ -1793,8 +1827,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.
@@ -2004,6 +2039,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
@@ -2275,6 +2315,9 @@ export interface ShowQuitPlatformDialogRequest {
     /** Should the dialog be centered on the monitor instead of on top of the platform window */
     shouldCenterOnMonitor?: boolean;
 }
+export interface GetCurrentWorkspaceOptions {
+    skipSnapshotUpdate?: boolean;
+}
 /**
  * Options for the {@link WorkspacePlatformModule.applyWorkspace applyWorkspace} method.
  *
@@ -2515,44 +2558,6 @@ export interface WorkspacePlatformInitConfig {
      */
     workspaceAsar?: WorkspaceAsarAssetConfig | WorkspaceAsarPathConfig;
 }
-/**
- * @internal
- */
-export interface CompanionDockConfig {
-    /**
-     * Base URL for the companion dock
-     */
-    baseUrl?: string;
-    /**
-     * Companion dock window position
-     */
-    dockPosition?: Point;
-    /**
-     * Favorites to be displayed in the dock
-     */
-    favorites?: DockEntry[];
-    /**
-     * Favorites to be displayed in the dock
-     */
-    contentMenu?: ContentMenuEntry[];
-    defaultDockButtons?: DockCompanionButton[];
-    /**
-     * Taskbar Icon for the Browser Window. If light and dark icon are defined, then the taskbar icon will change when the scheme changes.
-     */
-    icon?: string | TaskbarIcon;
-    title?: string;
-    windowType: 'enterprise' | undefined;
-    uiConfig?: {
-        hideDragHandle?: boolean;
-        providerIconContentMenu?: boolean;
-        moreMenu?: {
-            quitPlatform?: {
-                hidePlatformTitle?: boolean;
-                skipDialog?: boolean;
-            };
-        };
-    };
-}
 /**
  * Extend or replace default functionality in order to customize behavior of a Workspace Platform Provider.
  *
@@ -2688,7 +2693,6 @@ export type WorkspacePlatformOverrideCallback = OpenFin.OverrideCallback<Workspa
  * @deprecated
  */
 export type BrowserOverrideCallback = WorkspacePlatformOverrideCallback;
-export type DockCompanionButton = Exclude<WorkspaceButton, 'store'> | 'contentMenu' | 'bookmarks' | 'searchShortcut';
 /**
  * Content menu entry shape cloned and re-exported from UI Library.
  * @internal
@@ -2711,6 +2715,9 @@ export type LaunchDockEntryPayload = {
     entry: DockEntry;
     sourceEvent?: Pick<MouseEvent, 'ctrlKey' | 'metaKey' | 'shiftKey'>;
 };
+export type BookmarkDockEntryPayload = {
+    entry: DockEntry;
+};
 /**
  * Represents dock entry for favorites
  * @internal
@@ -2846,45 +2853,6 @@ export interface LaunchBookmarkPayload {
     sourceIdentity: OpenFin.Identity;
     sourceEvent: Pick<MouseEvent, 'ctrlKey' | 'metaKey' | 'shiftKey'>;
 }
-/**
- * These are channel actions registered by the platform.
- *
- * @internal
- */
-type EnterpriseDockChannelProviderChannelActions = {
-    'launch-entry': (payload: LaunchDockEntryPayload) => void;
-    'set-dock-favorites-order': (newFavorites: DockEntry[]) => void;
-    'set-default-dock-buttons-order': (newFavorites: DockCompanionButton[]) => void;
-    'get-dock-workspaces-context-menu': () => BaseCustomDropdownItem[];
-    'handle-dock-workspaces-menu-response': (payload: any) => void;
-    'remove-favorite-entry': (entry: DockEntry) => void;
-    'add-favorite-entry': (entry: DockEntry) => void;
-};
-/**
- * These are channel actions registered by the client (enterprise dock)
- * @internal
- */
-type EnterpriseDockChannelClientChannelActions = {
-    'update-favorite-entries': () => void;
-    'update-content-menu': () => void;
-    'navigate-content-menu': () => void;
-};
-/**
- * Used by Enterprise Dock for communication with the platform.
- * @internal
- */
-export interface EnterpriseDockChannelClient extends Omit<OpenFin.ChannelClient, 'dispatch' | 'register'> {
-    dispatch: <T extends keyof EnterpriseDockChannelProviderChannelActions>(action: T, payload: Parameters<EnterpriseDockChannelProviderChannelActions[T]>[0]) => Promise<Awaited<ReturnType<EnterpriseDockChannelProviderChannelActions[T]>>>;
-    register: <T extends keyof EnterpriseDockChannelClientChannelActions>(action: T, handler: (payload: Parameters<EnterpriseDockChannelClientChannelActions[T]>[0], id: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<Awaited<ReturnType<EnterpriseDockChannelClientChannelActions[T]>>>) => boolean;
-}
-/**
- * Used by the platform for communication with Enterprise Dock.
- * @internal
- */
-export interface EnterpriseDockChannelProvider extends Omit<OpenFin.ChannelProvider, 'dispatch' | 'register'> {
-    dispatch: <T extends keyof EnterpriseDockChannelClientChannelActions>(to: OpenFin.ClientIdentity, action: T, payload: Parameters<EnterpriseDockChannelClientChannelActions[T]>[0]) => Promise<Awaited<ReturnType<EnterpriseDockChannelClientChannelActions[T]>>>;
-    register: <T extends keyof EnterpriseDockChannelProviderChannelActions>(action: T, handler: (payload: Parameters<EnterpriseDockChannelProviderChannelActions[T]>[0], id: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<Awaited<ReturnType<EnterpriseDockChannelProviderChannelActions[T]>>>) => boolean;
-}
 export type SearchProviderFilter = {
     id: string;
     title: string;

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",

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

@@ -2,6 +2,8 @@ import type OpenFin from '@openfin/core';
 import { BrowserInitConfig } from '../../../client-api-platform/src/shapes';
 export declare const DEFAULT_ENTERPRISE_WINDOW_HEIGHT = 600;
 export declare const DEFAULT_ENTERPRISE_WINDOW_WIDTH = 900;
+export declare const ENTERPRISE_MIN_WINDOW_HEIGHT = 488;
+export declare const ENTERPRISE_MIN_WINDOW_WIDTH = 654;
 export declare const isEnterpriseBrowser: (id?: OpenFin.Identity) => Promise<boolean>;
 export declare const isEnterpriseBrowserPlatform: (browserInitOptions: BrowserInitConfig) => boolean;
 export declare function formatUrl(url: string): string;

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/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/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/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;

package/dock3/src/api/idb.d.ts

@@ -0,0 +1,3 @@
+import { Dock3Config } from '../../../client-api-platform/src/shapes';
+export declare function getDock3ProviderConfig(): Promise<Dock3Config | undefined>;
+export declare function saveDock3ProviderConfig(config: Dock3Config): Promise<void>;

package/dock3/src/api/index.d.ts

@@ -0,0 +1,14 @@
+import { Dock3Config, DockAllowedWindowOptions } from '../../../dock3/src/shapes';
+import { Dock3ConstructorOverride, Dock3Provider } from './provider';
+export type DockInitOptions = {
+    config: Dock3Config;
+    override: Dock3ConstructorOverride;
+    windowOptions?: DockAllowedWindowOptions;
+};
+/**
+ *
+ * @param config Dock3 configuration object
+ * @param override Constructor override to customize the Dock3Provider
+ * @returns instance of Dock3Provider
+ */
+export declare function init(options: DockInitOptions): Promise<Dock3Provider>;

package/dock3/src/api/launch.d.ts

@@ -0,0 +1,3 @@
+import type { CompanionDockConfig } from '../shapes/enterprise';
+import type { Dock3Config, DockAllowedWindowOptions } from '../shapes/shapes';
+export declare function launchDock(dockName: string, baseUrl: string, config: CompanionDockConfig | Dock3Config, additionalOptions?: DockAllowedWindowOptions): Promise<void>;

package/dock3/src/api/protocol.d.ts

@@ -0,0 +1,73 @@
+import type { OpenFin } from '@openfin/core';
+import { BaseCustomDropdownItem } from '../../../client-api/src/shapes';
+import { BookmarkDockEntryPayload, DockEntry, LaunchDockEntryPayload } from '../../../client-api-platform/src/shapes';
+import { Dock3Config, DockCompanionButton } from '../../../dock3/src/shapes';
+type ChannelActionMap = {
+    [action: string]: (...args: any[]) => any;
+};
+type TypedChannelClient<ProviderActions extends ChannelActionMap, ClientActions extends ChannelActionMap> = Omit<OpenFin.ChannelClient, 'dispatch' | 'register'> & {
+    dispatch: <T extends keyof ProviderActions>(action: T, payload: Parameters<ProviderActions[T]>[0]) => Promise<Awaited<ReturnType<ProviderActions[T]>>>;
+    register: <T extends keyof ClientActions>(action: T, handler: (payload: Parameters<ClientActions[T]>[0], id: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<Awaited<ReturnType<ClientActions[T]>>>) => boolean;
+};
+type TypedChannelProvider<ProviderActions extends ChannelActionMap, ClientActions extends ChannelActionMap> = Omit<OpenFin.ChannelProvider, 'dispatch' | 'register'> & {
+    dispatch: <T extends keyof ClientActions>(to: OpenFin.ClientIdentity, action: T, payload: Parameters<ClientActions[T]>[0]) => Promise<Awaited<ReturnType<ClientActions[T]>>>;
+    register: <T extends keyof ProviderActions>(action: T, handler: (payload: Parameters<ProviderActions[T]>[0], id: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<Awaited<ReturnType<ProviderActions[T]>>>) => boolean;
+};
+/**
+ * @internal
+ */
+export type Dock3ChannelProviderChannelActions = {
+    'launch-entry': (payload: LaunchDockEntryPayload) => void;
+    'ready': () => void;
+    'save-config': (payload: {
+        config: Dock3Config;
+    }) => Promise<void>;
+    'bookmark-content-menu-entry': (payload: BookmarkDockEntryPayload) => Promise<void>;
+};
+/**
+ * @internal
+ */
+export type Dock3ChannelClientChannelActions = {
+    'handle-dock-config-updated': (payload: Dock3Config) => void;
+};
+/**
+ * @internal
+ */
+export type Dock3ChannelProvider = TypedChannelProvider<Dock3ChannelProviderChannelActions, Dock3ChannelClientChannelActions>;
+/**
+ * @internal
+ */
+export type Dock3ChannelClient = TypedChannelClient<Dock3ChannelProviderChannelActions, Dock3ChannelClientChannelActions>;
+/**
+ * These are channel actions registered by the platform.
+ *
+ * @internal
+ */
+export type EnterpriseDockChannelProviderChannelActions = Dock3ChannelProviderChannelActions & {
+    'set-dock-favorites-order': (newFavorites: DockEntry[]) => void;
+    'set-default-dock-buttons-order': (newFavorites: DockCompanionButton[]) => void;
+    'get-dock-workspaces-context-menu': () => BaseCustomDropdownItem[];
+    'handle-dock-workspaces-menu-response': (payload: any) => void;
+    'remove-favorite-entry': (entry: DockEntry) => void;
+    'add-favorite-entry': (entry: DockEntry) => void;
+};
+/**
+ * These are channel actions registered by the client (enterprise dock)
+ * @internal
+ */
+export type EnterpriseDockChannelClientChannelActions = Dock3ChannelClientChannelActions & {
+    'update-favorite-entries': () => void;
+    'update-content-menu': () => void;
+    'navigate-content-menu': () => void;
+};
+/**
+ * Used by Enterprise Dock for communication with the platform.
+ * @internal
+ */
+export type EnterpriseDockChannelClient = TypedChannelClient<EnterpriseDockChannelProviderChannelActions, EnterpriseDockChannelClientChannelActions>;
+/**
+ * Used by the platform for communication with Enterprise Dock.
+ * @internal
+ */
+export type EnterpriseDockChannelProvider = TypedChannelProvider<EnterpriseDockChannelProviderChannelActions, EnterpriseDockChannelClientChannelActions>;
+export {};

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

@@ -0,0 +1,89 @@
+import type { OpenFin } from '@openfin/core';
+import { BookmarkDockEntryPayload, LaunchDockEntryPayload } from '../../../client-api-platform/src/index';
+import { Dock3Config } from '../../../dock3/src/shapes';
+import { Async, CamelCase } from '../../../dock3/src/utils';
+import { Dock3ChannelProvider, Dock3ChannelProviderChannelActions } from './protocol';
+type InternalDock3ChannelActions = 'ready';
+type Dock3ProviderAPI = {
+    [K in keyof Omit<Dock3ChannelProviderChannelActions, InternalDock3ChannelActions> as CamelCase<K>]: Async<Dock3ChannelProviderChannelActions[K]>;
+};
+type ExtendsProtocolProvider<T extends Dock3ProviderAPI> = T extends Dock3ProviderAPI ? T : never;
+export type EnsureProviderMatchesProtocol = ExtendsProtocolProvider<Dock3Provider>;
+export declare class Dock3Provider {
+    #private;
+    static getOverrideConstructor(...args: ConstructorParameters<typeof Dock3Provider>): new () => Dock3Provider;
+    static instance: Dock3Provider | null;
+    constructor(config: Dock3Config, channel: Dock3ChannelProvider);
+    launchEntry(payload: LaunchDockEntryPayload): Promise<void>;
+    /**
+     * Returns a promise that resolves when the Dock3Provider is ready.
+     * This is useful to ensure that the dock is fully initialized before performing any operations.
+     * The promise will resolve when the dock sends the 'ready' action.
+     */
+    get ready(): Promise<void>;
+    bookmarkContentMenuEntry(payload: BookmarkDockEntryPayload): Promise<void>;
+    /**
+     * Read-only access to the current configuration of the Dock3Provider.
+     */
+    get config(): Dock3Config;
+    /**
+     * Protected setter for the configuration of the Dock3Provider.
+     * This does not save the configuration in storage nor notify the dock about the change.
+     * Use `updateConfig` method to update the configuration and save it.
+     * This should only be used internally in a `saveConfig` override if `super.saveConfig` is not called.
+     */
+    protected set config(newConfig: Dock3Config);
+    /**
+     * Updates the configuration of the Dock3Provider.
+     * This method updates the configuration, notifies the dock about the change and saves the new configuration to storage (via `saveConfig`).
+     * @param newConfig The new configuration to be applied.
+     */
+    updateConfig(config: Dock3Config): Promise<void>;
+    /**
+     * Shuts down the Dock3Provider and closes the dock window.
+     * This method sends a shutdown message to the dock and then closes the window.
+     */
+    shutdown(): Promise<void>;
+    /**
+     * Called whenever the configuration is updated, this method saves the configuration to the storage.
+     * This should not be called directly, if you need to update the configuration, use `updateConfig` method instead.
+     */
+    saveConfig({ config }: {
+        config: Dock3Config;
+    }): Promise<void>;
+    private handleConfigChange;
+    /**
+     * Called on startup to load the current configuration of the Dock3Provider.
+     * If you've overridden the `saveConfig` method, this should load the configuration from your storage.
+     * By default it will load the configuration from local storage. This can  be overriden to prevent loading from local storage.
+     * @example Prevent loading from local storage:
+     * ```typescript
+     * class MyDock3Provider extends Dock3Provider {
+     *    async loadConfig(): Promise<Dock3Config> {
+     *       // Do not load from local storage, return the default config
+     *       return this.config;
+     *   }
+     *  }
+     * ```
+     * @example Load from a custom storage:
+     * ```typescript
+     * class MyDock3Provider extends Dock3Provider {
+     *   async loadConfig(): Promise<Dock3Config> {
+     *      // Load from a custom storage
+     *      const configFromStorage = await myCustomStorage.getDockConfig();
+     *      // Update local config to ensure it is used.
+     *      if (configFromStorage) {
+     *         this.config = configFromStorage;
+     *      }
+     *      return this.config;
+     *   }
+     * }
+     * ```
+     * @returns The current configuration of the Dock3Provider.
+     */
+    loadConfig(): Promise<Dock3Config>;
+    getWindowSync(): OpenFin.Window;
+    private registerChannelActions;
+}
+export type Dock3ConstructorOverride = (Base: new () => Dock3Provider) => new () => Dock3Provider;
+export {};

package/dock3/src/shapes/enterprise.d.ts

@@ -0,0 +1,22 @@
+import { Point } from '../../../common/src/utils/window';
+import { Dock3Button, Dock3Config } from './shapes';
+export type { EnterpriseDockChannelClient, EnterpriseDockChannelProvider } from '../api/protocol';
+/**
+ * @internal
+ */
+export type DockCompanionButton = Exclude<Dock3Button, 'store'> | 'bookmarks' | 'searchShortcut';
+/**
+ * @internal
+ */
+export type CompanionDockConfig = Omit<Dock3Config, 'defaultDockButtons'> & {
+    /**
+     * Companion dock window position
+     */
+    dockPosition?: Point;
+    /**
+     * Base URL for the companion dock
+     */
+    baseUrl?: string;
+    defaultDockButtons?: DockCompanionButton[];
+    windowType?: 'enterprise';
+};

package/dock3/src/shapes/index.d.ts

@@ -0,0 +1,2 @@
+export * from './shapes';
+export * from './enterprise';