@openfin/workspace-platform 22.0.1 → 22.0.3

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

@@ -1,5 +1,5 @@
 import type OpenFin from '@openfin/core';
-import { ContextMenuType } from '../../../../common/src/utils/popup-window';
+import { EnterpriseMenuType } from '../../../../common/src/utils/popup-window';
 import { InternalOpenGlobalContextMenuRequest, InternalOpenPageTabContextMenuRequest, OpenGlobalContextMenuPayload, OpenPageTabContextMenuPayload, OpenSaveButtonContextMenuPayload, OpenSaveButtonContextMenuRequest, OpenViewTabContextMenuPayload, OpenViewTabContextMenuRequest, WorkspacePlatformProvider } from '../../../../client-api-platform/src/shapes';
 /**
  * Enum representing the possible anchor behaviors for positioning context menus.
@@ -17,7 +17,7 @@ export declare enum AnchorBehavior {
     Center = 4
 }
 type ContextMenuPayload = OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload;
-export declare const openCommonContextMenu: (payload: ContextMenuPayload, _callerIdentity: OpenFin.Identity, type?: ContextMenuType, anchorBehavior?: AnchorBehavior) => Promise<void>;
+export declare const openCommonContextMenu: (payload: ContextMenuPayload, _callerIdentity: OpenFin.Identity, type?: EnterpriseMenuType, anchorBehavior?: AnchorBehavior) => Promise<void>;
 export declare function openGlobalContextMenuInternal(this: WorkspacePlatformProvider, payload: InternalOpenGlobalContextMenuRequest & {
     identity: OpenFin.Identity;
 }, callerIdentity: OpenFin.Identity): Promise<void>;

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

@@ -1,11 +1,11 @@
 import { ContentMenuEntry } from '@openfin/ui-library';
-import type { DockCompanionButton, DockEntry } from '../../../client-api-platform/src/shapes';
+import { DockCompanionButton, DockEntry, LaunchDockEntryPayload } from '../../../client-api-platform/src/shapes';
 export declare const DockCompanionUpdatesPrefix = "dock-companion-updates";
 export declare const refreshDockBookmarksPanel: () => Promise<void>;
 export declare const updateDockFavoriteEntries: (favorites: DockEntry[]) => Promise<void>;
 export declare const updateContentMenu: (contentMenu: ContentMenuEntry[]) => Promise<void>;
 export declare const navigateContentMenu: (id: string) => Promise<void>;
-export declare const launchDockEntry: (entry: DockEntry) => Promise<void>;
+export declare const launchDockEntry: (payload: LaunchDockEntryPayload) => Promise<void>;
 export declare const setDockFavoritesOrder: (favorites: DockEntry[]) => Promise<void>;
 export declare const setDefaultDockButtonsOrder: (defaultDockButtons: DockCompanionButton[]) => Promise<void>;
 export declare const getDockWorkspacesContextMenu: () => Promise<import("@client/index").BaseCustomDropdownItem[]>;

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

@@ -0,0 +1,4 @@
+import type OpenFin from '@openfin/core';
+import { SendUpdateVersionModalResponsePayload } from '../../../client-api-platform/src/shapes';
+export declare const enterpriseModalChannelClient: () => Promise<OpenFin.ChannelClient>;
+export declare function sendUpdateVersionModalResponse(payload: SendUpdateVersionModalResponsePayload): Promise<void>;

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

@@ -1,3 +1,4 @@
 import type OpenFin from '@openfin/core';
-import { ShowQuitPlatformDialogRequest } from '../../../../client-api-platform/src/shapes';
+import { ShowQuitPlatformDialogRequest, ShowUpdateVersionModalRequest } from '../../../../client-api-platform/src/shapes';
 export declare const showQuitPlatformDialogInternal: (req: ShowQuitPlatformDialogRequest, identity: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<void>;
+export declare const showUpdateVersionModalInternal: (req: ShowUpdateVersionModalRequest, identity: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<void>;

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

@@ -161,12 +161,16 @@ export declare enum PageTabContextMenuOptionType {
     Print = "Print",
     PrintAll = "PrintAll",
     PrintScreen = "PrintScreen",
+    AddToChannel = "AddToChannel",
     Custom = "Custom"
 }
 /**Shape of the data property of a global context menu template item */
 export interface GlobalContextMenuItemData extends ContextMenuItemData {
     type: GlobalContextMenuOptionType;
 }
+export interface AddToChanel extends GlobalContextMenuItemData {
+    workspaceId: string;
+}
 export interface WorkspaceContextMenuItemData extends GlobalContextMenuItemData {
     workspaceId: string;
 }
@@ -178,6 +182,9 @@ export type GlobalContextMenuItemTemplate = OpenFin.MenuItemTemplate<GlobalConte
 /**Shape of the data property of a page tab context menu template item */
 export interface PageTabContextMenuItemData extends ContextMenuItemData {
     type: PageTabContextMenuOptionType;
+    /** Property to specify which option was selected when there are
+     * several options of the same type (e.g. which channel was selected) */
+    option?: string;
 }
 /**Configuration of an option in the page tab context menu */
 export interface PageTabContextMenuItemTemplate extends OpenFin.MenuItemTemplate {
@@ -1563,7 +1570,7 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      * Launches companion dock content menu item.
      * @param id
      */
-    _launchDockEntryInternal: (entry: DockEntry) => Promise<void>;
+    _launchDockEntryInternal: (payload: LaunchDockEntryPayload) => Promise<void>;
     _setDockFavoritesInternal: (favorites: DockEntry[]) => Promise<void>;
     _setDefaultDockButtonsOrderInternal: (favorites: DockCompanionButton[]) => Promise<void>;
     _removeDockFavoriteInternal: (entry: DockEntry) => Promise<void>;
@@ -2209,6 +2216,10 @@ export type WorkspacePlatformOverrideCallback = OpenFin.OverrideCallback<Workspa
  */
 export type BrowserOverrideCallback = WorkspacePlatformOverrideCallback;
 export type DockCompanionButton = Exclude<WorkspaceButton, 'store'> | 'contentMenu' | 'bookmarks' | 'searchShortcut';
+export type LaunchDockEntryPayload = {
+    entry: DockEntry;
+    sourceEvent?: Pick<MouseEvent, 'ctrlKey' | 'metaKey' | 'shiftKey'>;
+};
 /**
  * Configuration options for Browser window's icons.
  */

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

@@ -0,0 +1,57 @@
+import { OpenFin } from '@openfin/core';
+import { ExtendedPanelConfig, PageLayout, PanelConfig } from '../../../../client-api-platform/src/index';
+export interface Page {
+    /** A UI friendly title for the page. */
+    title: string;
+    /** The unique ID of the page. */
+    pageId: string;
+    /** An optional UI friendly description of the page. */
+    description?: string;
+    /** A optional UI friendly tooltip for the page. */
+    tooltip?: string;
+    /**
+     * True if the page is read only. In this state, the page is locked and cannot be unlocked.
+     *
+     * @deprecated This property is deprecated and will be removed in a future release. Setting it has no effect. To _"lock"_ a page, and prevent the ability to close pages, drag pages within the window and drag pages into/out of the window, use the `isLocked` property.
+     */
+    isReadOnly?: boolean;
+    /** Icon that appears on a page tab if there are unsaved changes (dirty state). If 'undefined', default icon will appear. */
+    unsavedIconUrl?: string;
+    /** Icon that appears on a page tab if there are no unsaved changes. If 'undefined', default icon will appear. */
+    iconUrl?: string;
+    /** The layout of the page. */
+    layout: PageLayout;
+    /** True if the page is locked. */
+    isLocked?: boolean;
+    /** Used to manipulate behaviour of a close button on a page tab. If `undefined`, then close button is visible and actionable.
+     * If either property true, this page tab's context menu will disable its 'Close Page' option.
+     */
+    closeButton?: {
+        hidden?: boolean;
+        disabled?: boolean;
+    };
+    /** Used to configure fixed views on the edges of the browser window. Only one panel per side is supported. */
+    panels?: PanelConfig[];
+    /** Used to define the context group for the page */
+    contextGroup?: string;
+    /** Optional property to attach custom metadata to the page object, such as version or timestamp. Must be serializable. */
+    customData?: any;
+}
+type AttachedPageMetadata = {
+    /** The window the page is currently attached to. */
+    parentIdentity?: OpenFin.Identity;
+    /** True if the page is the currently active page for its parent window. */
+    isActive?: boolean;
+    /** True if the page has unsaved changes. */
+    hasUnsavedChanges?: boolean;
+    /** Panel config with all view identities in place */
+    panels?: ExtendedPanelConfig[];
+};
+export type AttachedPage = Page & AttachedPageMetadata;
+export type AttachedPageInternal = {
+    layoutContainerKey?: string;
+    singleViewName?: string;
+    attachedPageType?: 'singleView' | 'multiView' | undefined;
+    isLayoutCreated?: boolean;
+} & AttachedPage;
+export {};

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

@@ -87,7 +87,9 @@ export declare enum WorkspacePlatformChannelAction {
     HandleDockWorkspacesMenuResponseInternal = "handleDockWorkspacesMenuResponseInternal",
     RemoveDockFavoriteInternal = "removeDockFavoriteInternal",
     AddDockFavoriteInternal = "addDockFavoriteInternal",
-    FocusAndExpandSearchInternal = "focusAndExpandSearchInternal"
+    FocusAndExpandSearchInternal = "focusAndExpandSearchInternal",
+    SendUpdateVersionModalResponseInternal = "sendUpdateVersionModalResponseInternal",
+    ShowUpdateVersionModalInternal = "showUpdateVersionModalInternal"
 }
 export type PlatFormSupportedFeatures = boolean | {
     isWorkspacePlatform: boolean;

package/common/src/utils/color-linking.d.ts

@@ -0,0 +1,4 @@
+import type OpenFin from '@openfin/core';
+import { ViewTabContextMenuTemplate } from '../../../client-api-platform/src/shapes';
+export declare const getChannelsMenuOptions: (channelsForViews: string[], colorGroups: OpenFin.ContextGroupInfo[]) => Promise<ViewTabContextMenuTemplate[]>;
+export declare const ENTERPRISE_COLOR_CHANNELS: Map<string, OpenFin.ContextGroupInfo['displayMetadata']>;

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

@@ -1,7 +1,7 @@
 import type OpenFin from '@openfin/core';
 import { AnchorBehavior } from '../../../client-api-platform/src/api/context-menu';
 import { PageTabContextMenuItemTemplate, ViewTabContextMenuTemplate } from '../../../client-api-platform/src/shapes';
-import { ContextMenuType } from './popup-window';
+import { EnterpriseMenuType } from './popup-window';
 export declare enum MenuItemType {
     Label = "normal",
     Separator = "separator",
@@ -10,9 +10,10 @@ export declare enum MenuItemType {
 }
 export type ShowContextMenuResponse = OpenFin.MenuResult & {
     data: any;
+    requestId?: string;
 };
 export declare function showContextMenu(opts: OpenFin.ShowPopupMenuOptions, win?: OpenFin.Window): Promise<ShowContextMenuResponse>;
-export declare const showEnterpriseContextMenu: (opts: OpenFin.ShowPopupMenuOptions, type: ContextMenuType, anchorBehavior: AnchorBehavior, win?: OpenFin.Window) => Promise<ShowContextMenuResponse>;
+export declare const showEnterpriseContextMenu: (opts: OpenFin.ShowPopupMenuOptions, type: EnterpriseMenuType, anchorBehavior: AnchorBehavior, win?: OpenFin.Window) => Promise<ShowContextMenuResponse>;
 export declare const Separator: OpenFin.MenuItemTemplate;
 export declare const EmptyContextMenuItem: OpenFin.MenuItemTemplate;
 export declare const DefaultSaveMenuBounds: {

package/common/src/utils/enterprise-channels.d.ts

@@ -12,3 +12,4 @@ export declare const connectToBookmarkPanelActionsMonitor: () => Promise<OpenFin
 export declare const createContextMenuChannel: () => Promise<OpenFin.ChannelProvider>;
 export declare const connectToContextMenuChannel: () => Promise<OpenFin.ChannelClient>;
 export declare const connectToEnterpriseContentChannel: (uuid: string) => Promise<OpenFin.ChannelClient>;
+export declare const connectToEnterpriseModalChannel: (uuid: string) => Promise<OpenFin.ChannelClient>;

package/common/src/utils/menu-config.d.ts

@@ -1,7 +1,10 @@
 import type OpenFin from '@openfin/core';
 import type { OptionalExceptFor } from '../../../common/src/utils/types';
 export interface MenuConfig {
-    windowOptions: OptionalExceptFor<OpenFin.WindowOptions, 'url' | 'name' | 'defaultHeight' | 'defaultWidth'>;
+    windowOptions: OptionalExceptFor<OpenFin.WindowOptions, 'url' | 'name' | 'defaultHeight' | 'defaultWidth'> & {
+        preventBlur?: boolean;
+        closeOnResponse?: boolean;
+    };
     title: string;
     parameters?: URLSearchParams;
 }
@@ -39,4 +42,5 @@ export type ButtonConfig = {
     type: 'primary' | 'secondary';
     id: string;
     variant?: 'critical' | 'outline' | 'submit';
+    dataTestId?: string;
 };

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

@@ -27,13 +27,19 @@ type WindowOptionsWithBounds = OptionalExceptFor<OpenFin.WindowOptions, 'name' |
     top: number;
     left: number;
 };
-export declare function createChildWindow(opts: OptionalExceptFor<OpenFin.WindowOptions, 'name' | 'url'>, route?: string, bounds?: Partial<OpenFin.Bounds>): Promise<OpenFin.Window>;
+type ModalWindowOptions = WindowOptionsWithBounds & {
+    preventBlur?: boolean;
+    closeOnResponse?: boolean;
+};
+export declare function createChildWindow(opts: OptionalExceptFor<OpenFin.WindowOptions, 'name' | 'url'> & {
+    preventBlur?: boolean;
+}, route?: string, bounds?: Partial<OpenFin.Bounds>): Promise<OpenFin.Window>;
 export interface ShowChildOptions {
-    options: WindowOptionsWithBounds;
+    options: ModalWindowOptions;
     parameters?: URLSearchParams;
 }
 export interface ResponseModalOptions {
-    options: WindowOptionsWithBounds;
+    options: ModalWindowOptions;
     content: ResponseModalContent;
     parameters?: URLSearchParams;
 }

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

@@ -33,7 +33,7 @@ export type BrowserSearchMenuKeyboardEvent = {
         altKey?: boolean;
     };
 };
-export declare enum ContextMenuType {
+export declare enum EnterpriseMenuType {
     GlobalMenu = "global-menu",
     ContextMenu = "context-menu",
     RenameSupertab = "rename-supertab",
@@ -41,19 +41,54 @@ export declare enum ContextMenuType {
     DropdownMenu = "dropdown-menu"
 }
 export type BookmarkButtonPayload = {
-    selectedViewIdentity?: OpenFin.Identity;
+    selectedViewIdentity: OpenFin.Identity;
 };
-export type ContextMenuChannelMessageData = {
+export type BaseEnterpriseMenuChannelMessage = {
+    type: EnterpriseMenuType;
+    /**
+     * The identity of the window the dialog/menu invocation came from.
+     */
     parentIdentity: OpenFin.Identity;
+    /**
+     * The identity of the window the dialog/menu should respond to.
+     *
+     * This may differ from the parentIdentity, such as in the case of custom context menus, where the
+     * parent is a browser window but the context menu should respond to the provider window.
+     */
     responseIdentity: OpenFin.Identity;
-    type: ContextMenuType;
+    anchorBehavior?: AnchorBehavior;
     x: number;
     y: number;
-    anchorBehavior?: AnchorBehavior;
-    payload: (OpenFin.ShowPopupMenuOptions | {
+};
+export type ContextMenuChannelMessage = BaseEnterpriseMenuChannelMessage & {
+    type: EnterpriseMenuType.ContextMenu | EnterpriseMenuType.GlobalMenu;
+    /**
+     * The unique request ID of the context menu invocation.
+     */
+    requestId: string;
+    payload: OpenFin.ShowPopupMenuOptions;
+};
+export type BookmarkDialogChannelMessage = BaseEnterpriseMenuChannelMessage & {
+    type: EnterpriseMenuType.AddEditBookmark;
+    payload: BookmarkButtonPayload;
+};
+export type DropdownMenuChannelMessage = BaseEnterpriseMenuChannelMessage & {
+    type: EnterpriseMenuType.DropdownMenu;
+    payload: {
+        template: Array<OpenFin.MenuItemTemplate>;
+        /**
+         * The width of the dropdown element in the DOM to determine the width of the menu window.
+         */
+        width: number;
+    };
+};
+export type RenameSupertabChannelMessage = BaseEnterpriseMenuChannelMessage & {
+    type: EnterpriseMenuType.RenameSupertab;
+    payload: {
+        /**
+         * The pageId of the page being renamed.
+         */
         pageId: string;
-    } | BookmarkButtonPayload) & {
-        width?: number;
     };
 };
 export type SearchMenuChannelResponse = {

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

@@ -15,7 +15,8 @@ export declare enum WindowName {
     EnterpriseBookmarkDialogWindow = "openfin-enterprise-bookmark-dialog",
     DropdownMenu = "openfin-enterprise-dropdown-menu",
     DockCompanion = "openfin-dock-companion",
-    AICompanionPrefix = "openfin-ai-companion-"
+    AICompanionPrefix = "openfin-ai-companion-",
+    UpdateVersionModal = "here-update-version-modal"
 }
 export interface WindowIdentity {
     uuid: ApplicationUUID | string;

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

@@ -1,5 +1,6 @@
 import type OpenFin from '@openfin/core';
 import { ResponseModalConfig } from '../../../common/src/utils/menu-config';
+import { ModalResponseEvent } from './menu-window-provider';
 export declare const restoreChangesMenu: (windowIdentity: OpenFin.Identity) => Promise<ResponseModalConfig>;
 export declare const deletePageMenu: (windowIdentity: OpenFin.Identity, pageTitle: string) => Promise<ResponseModalConfig>;
 /**
@@ -23,3 +24,8 @@ export declare const showQuitBrowserModal: (windowIdentity: OpenFin.Identity) =>
 export declare const showRestoreChangesModal: (windowIdentity: OpenFin.Identity) => Promise<boolean>;
 export declare const getOverwriteWorkspaceMenu: (workspaceTitle: string) => Promise<ResponseModalConfig>;
 export declare const showDeletePageModal: (windowIdentity: OpenFin.Identity, pageTitle: string) => Promise<boolean>;
+export declare const showUpdateVersionModal: ({ identity, title, description }: {
+    identity: OpenFin.Identity;
+    title: string;
+    description: string;
+}) => Promise<ModalResponseEvent['data']>;

package/externals.report.json

@@ -13,6 +13,14 @@
             "issuer": "common/src/utils/layout.ts"
         }
     ],
+    "title-case": [
+        {
+            "type": "root-implicit",
+            "version": "3.0.3",
+            "packageName": "common/package.json",
+            "issuer": "common/src/utils/color-linking.ts"
+        }
+    ],
     "react-i18next": [
         {
             "type": "root-implicit",