@openfin/workspace-platform 45.3.5 → 45.3.7

package/client-api-platform/src/api/app-directory.d.ts

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

package/client-api-platform/src/api/context-menu/browser-logo-handler.test.d.ts

@@ -0,0 +1 @@
+import '@common/test/fin-mocks';

package/client-api-platform/src/api/context-menu/browser-pagetab-handler.test.d.ts

@@ -0,0 +1 @@
+import '@common/test/fin-mocks';

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

@@ -0,0 +1,30 @@
+import { KeyboardCommand } from '../../../../common/src/utils/keyboard-commands';
+/**
+ * Maps a menu item's `data.type` to the keyboard command that performs the same action, or to a fixed
+ * `{ keys }` binding for shortcuts handled outside `getKeyboardCommands` (e.g. quit).
+ */
+type MenuShortcutCommands = Partial<Record<string, KeyboardCommand | {
+    keys: string;
+}>>;
+export declare const ENTERPRISE_GLOBAL_MENU_SHORTCUTS: MenuShortcutCommands;
+export declare const ENTERPRISE_PAGE_TAB_MENU_SHORTCUTS: MenuShortcutCommands;
+/**
+ * View tab New Tab / Close Tab act on the inner view, while Cmd/Ctrl+T and Cmd/Ctrl+W act on the whole
+ * page, so they are not labelled.
+ */
+export declare const ENTERPRISE_VIEW_TAB_MENU_SHORTCUTS: MenuShortcutCommands;
+type ShortcutMenuItem = {
+    data?: {
+        type?: string;
+    } | null;
+    submenu?: ShortcutMenuItem[];
+    shortcut?: string;
+};
+/**
+ * Returns a copy of `template` with each item that has a registered hotkey labelled with it (as the
+ * `shortcut` the Enterprise popup menu renders), formatted for the current OS.
+ */
+export declare const addKeyboardShortcuts: <T extends ShortcutMenuItem>(template: T[], shortcutCommands: MenuShortcutCommands) => Promise<(T & {
+    shortcut?: string;
+})[]>;
+export {};

package/client-api-platform/src/api/context-menu/keyboard-shortcuts.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,5 +1,6 @@
 import type OpenFin from '@openfin/core';
 import { PositioningType } from '../../../../common/src/utils/positioning';
+import type { PageCreationOrigin } from '../../../../common/src/api/pages/shapes';
 import { WorkspaceContextMenuItemData } from '../../../../client-api-platform/src/shapes';
 export declare const saveWorkspaceHandlerWithInjectables: ({ showModal, afterSuccessSave }: {
     showModal?: () => Promise<void>;
@@ -9,8 +10,10 @@ export declare const saveWorkspaceHandler: (identity: OpenFin.Identity) => Promi
 export declare const saveWorkspaceAsHandler: (identity: OpenFin.Identity) => void;
 /**
  * @param identity Identity of browser window to create a new page on.
+ * @param origin User interaction that requested the page. Menu callers omit this.
  */
-export declare const createNewPageHandler: (identity: OpenFin.Identity) => Promise<void>;
+export declare const createNewPageHandler: (identity: OpenFin.Identity, origin?: PageCreationOrigin) => Promise<void>;
+export declare const createNewWindowHandler: (identity: OpenFin.Identity) => Promise<void>;
 /**
  * @param identity Identity of browser window to execute save on.
  * @param pageId Id of a page to save. If omitted, active page is saved.

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

@@ -0,0 +1 @@
+import '@common/test/fin-mocks';

package/client-api-platform/src/init/browser-window-focus.test.d.ts

@@ -0,0 +1 @@
+import '@common/test/fin-mocks';

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

@@ -1,6 +1,10 @@
 import type OpenFin from '@openfin/core';
-export declare const KEYBOARD_COMMANDS: {
-    readonly NEW_TAB: "workspace.newTab";
-    readonly FIND_IN_PAGE: "findInPage.show";
-};
+import { KEYBOARD_COMMANDS } from '../../../../common/src/utils/keyboard-commands';
+export { KEYBOARD_COMMANDS };
 export declare const getKeyboardCommands: (superGetKeyboardCommands: () => OpenFin.ShortcutOverride[]) => OpenFin.ShortcutOverride[];
+/**
+ * The first key binding registered for `command`, or `undefined` if it has none (never registered, or
+ * disabled via empty `keys`). Commands with several bindings list their primary one first, e.g. reload's
+ * `CommandOrControl+R` before `F5`.
+ */
+export declare const getRegisteredShortcutKeys: (command: string) => string | undefined;

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

@@ -0,0 +1 @@
+export {};

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

@@ -259,11 +259,15 @@ export interface CopyPagePayload {
     /** Specifies the trigger for creating a copy. */
     reason: 'save-as' | 'duplicate';
 }
+/** The user interaction that created a new page. Reported in the `Create Page` analytics event. */
+export type PageCreationOrigin = 'new-tab-button' | 'menu' | 'hotkey' | 'dock' | 'new-window';
 export type AddDefaultPagePayload = {
     /** The OF window identity to attach the pages to. */
     identity: OpenFin.Identity;
     /** The page to attach. */
     page: PageWithUpdatableRuntimeAttribs;
+    /** The user interaction that requested the page. */
+    origin?: PageCreationOrigin;
 };
 export type AddPagePayload = {
     /** The OF window identity to attach the pages to. */

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

@@ -307,7 +307,7 @@ export declare const constructThemePaletteSheet: (themes: GeneratedPalettes, leg
     dark: string;
 }) => string;
 export declare const getComputedPlatformTheme: (platformIdentity: OpenFin.Identity) => Promise<{
-    theme: CustomThemes | GeneratedPalettes;
+    theme: GeneratedPalettes | CustomThemes;
     defaultScheme: ColorSchemeOptionType;
     themePaletteSheet: string;
 }>;

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

@@ -95,7 +95,11 @@ export declare const deleteWorkspace: () => {
     label: string;
 };
 export declare const downloads: () => {
+    type: MenuItemType;
     label: string;
+    data: {
+        type: WP.GlobalContextMenuOptionType;
+    };
 };
 export declare const appearance: () => {
     label: string;

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

@@ -0,0 +1,30 @@
+import type OpenFin from '@openfin/core';
+export declare enum InteropEventType {
+    JoinedContextGroup = "joined-context-group",
+    RemovedFromContextGroup = "removed-from-context-group"
+}
+type InteropEventPayload<E extends InteropEventType> = {
+    [InteropEventType.JoinedContextGroup]: {
+        viewIdentity: OpenFin.Identity;
+        contextGroupId: string;
+    };
+    [InteropEventType.RemovedFromContextGroup]: {
+        viewIdentity: OpenFin.Identity;
+    };
+}[E];
+export type InteropListener<EventType extends InteropEventType> = (payload: InteropEventPayload<EventType>) => void;
+/**
+ * Returns contextGroup data.
+ * @returns Promise<ContextGroup[]>
+ */
+export declare function getContextGroups(): Promise<OpenFin.ContextGroupInfo[]>;
+export declare const joinContextGroup: (viewIdentity: OpenFin.Identity, contextGroupId: string) => Promise<void>;
+export declare const removeFromGroup: (viewIdentity: OpenFin.Identity) => Promise<void>;
+export declare function getViewContextGroupId(viewIdentity: OpenFin.Identity): Promise<string | null | undefined>;
+/**
+ * Listen for interop events.
+ * @param event the interop event to listen for.
+ * @param listener the function to call when the event occurs.
+ */
+export declare const addInteropListener: <Event extends InteropEventType>(event: Event, listener: InteropListener<Event>) => Promise<void>;
+export {};

package/common/src/utils/keyboard-commands.d.ts

@@ -0,0 +1,47 @@
+export declare const KEYBOARD_COMMANDS: {
+    readonly NEW_TAB: "workspace.newTab";
+    readonly FIND_IN_PAGE: "findInPage.show";
+    readonly RESTORE_TAB: "workspace.restoreTab";
+    readonly CLOSE_TAB: "workspace.closeTab";
+    readonly NEXT_TAB: "workspace.nextTab";
+    readonly PREVIOUS_TAB: "workspace.previousTab";
+    readonly LAST_TAB: "workspace.lastTab";
+    readonly NEW_WINDOW: "workspace.newWindow";
+    readonly CLOSE_WINDOW: "workspace.closeWindow";
+    readonly SAVE_PAGE: "workspace.savePage";
+    readonly SAVE_PAGE_AS: "workspace.savePageAs";
+    readonly NAVIGATE_BACK: "workspace.navigateBack";
+    readonly NAVIGATE_FORWARD: "workspace.navigateForward";
+    readonly RELOAD: "workspace.reload";
+    readonly PRINT: "workspace.print";
+    readonly FOCUS_ADDRESS_BAR: "workspace.focusAddressBar";
+    readonly BOOKMARK_PAGE: "workspace.bookmarkPage";
+    readonly ZOOM_IN_VIEW: "workspace.zoomInView";
+    readonly ZOOM_OUT_VIEW: "workspace.zoomOutView";
+    readonly ZOOM_IN_PAGE: "workspace.zoomInPage";
+    readonly ZOOM_OUT_PAGE: "workspace.zoomOutPage";
+};
+export type KeyboardCommand = (typeof KEYBOARD_COMMANDS)[keyof typeof KEYBOARD_COMMANDS];
+/**
+ * Which side wins when focused content binds the same shortcut as a HERE command.
+ *
+ * - `yieldable` (default): content wins. The key reaches the page first, like find-in-page; if the
+ *   page calls `event.preventDefault()` the HERE command does not run, otherwise it does.
+ * - `reserved`: HERE wins and the key never reaches content. Limited to the commands Chrome itself
+ *   does not let pages override (new/close/restore tab, new/close window, tab cycling) plus
+ *   focus address bar.
+ *
+ * Every new command must be classified here. Use `yieldable` unless a page must never be able to
+ * block the command.
+ */
+export declare const KEYBOARD_COMMAND_PRECEDENCE: Record<KeyboardCommand, 'reserved' | 'yieldable'>;
+/** Numbered tab commands and any command not in {@link KEYBOARD_COMMAND_PRECEDENCE} are yieldable. */
+export declare const isReservedKeyboardCommand: (command: string) => boolean;
+/** Tabs 1–8 have their own command; the ninth shortcut maps to {@link KEYBOARD_COMMANDS.LAST_TAB}. */
+export declare const NUMBERED_TAB_COUNT = 8;
+export declare const getSelectTabCommand: (tabNumber: number) => string;
+/**
+ * Formats an Electron-style accelerator (as registered in `getKeyboardCommands`) for display in a menu,
+ * e.g. `Shift+CommandOrControl+S` → `⇧⌘S` on Mac and `Ctrl+Shift+S` on Windows.
+ */
+export declare const formatKeyboardShortcut: (keys: string, isWindows: boolean) => string;

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

@@ -1,2 +1,4 @@
 export declare const isOSWindows: () => Promise<boolean>;
+/** For synchronous contexts */
+export declare const isOSWindowsSync: () => boolean;
 export declare const isWindows10Or11: () => Promise<boolean>;

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

@@ -37,6 +37,7 @@ export type BrowserSearchMenuKeyboardEvent = {
         metaKey?: boolean;
         ctrlKey?: boolean;
         altKey?: boolean;
+        shiftKey?: boolean;
     };
 };
 export declare enum PopupWindowMenuType {

package/common/src/utils/usage-register.d.ts

@@ -1,4 +1,5 @@
 import type OpenFin from '@openfin/core';
+import type { Page, PageCreationOrigin } from '../../../common/src/api/pages/shapes';
 import { AttachedPage } from '../../../client-api-platform/src/shapes';
 export interface RegisterUsageStatus {
     apiVersion?: string;
@@ -63,6 +64,10 @@ export interface AnalyticsEventInternal extends AnalyticsEvent {
 export type AnalyticsEventRaise = Omit<AnalyticsEventInternal, 'source'>;
 export declare const raiseBrowserAnalytics: (payload: AnalyticsEventRaise) => Promise<void>;
 export declare const raiseBrowserPageAnalytics: (pages: AttachedPage[], action: string) => Promise<void>;
+/**
+ * Raised when a new page ID is minted, as opposed to `Open Page`, which also fires for restored pages.
+ */
+export declare const raiseCreatePageAnalytics: (page: Pick<Page, "pageId" | "title">, windowName: string, origin?: PageCreationOrigin) => Promise<void>;
 export declare const raiseHomeAnalytics: (platformIdentity: OpenFin.Identity, payload: AnalyticsEventRaise) => Promise<void>;
 export declare const raiseDockAnalytics: (platformIdentity: OpenFin.Identity, payload: AnalyticsEventRaise) => Promise<void>;
 export declare const raiseStorefrontAnalytics: (platformIdentity: OpenFin.Identity, payload: AnalyticsEventRaise) => Promise<void>;

package/externals.report.json

@@ -72,6 +72,12 @@
         }
     ],
     "title-case": [
+        {
+            "type": "explicit",
+            "version": "3.0.3",
+            "packageName": "client-api-platform/package.json",
+            "issuer": "client-api-platform/src/api/context-menu/browser-pagetab-handler.ts"
+        },
         {
             "type": "explicit",
             "version": "3.0.3",