@openfin/fdc3-api 45.100.114 → 45.100.116

package/out/fdc3-api-alpha.d.ts

@@ -923,6 +923,21 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
      * ```
      */
     closeTrayIconPopupMenu(): Promise<void>;
+    /**
+     * @experimental
+     * Retrieves a performance snapshot for all Windows, Views and Frames in the Application.
+     *
+     * By default, all custom marks and measures are collected, along with navigation/paint entries
+     * and resource timing (`resources` defaults to `true`). Pass `include` to restrict custom
+     * marks/measures to matching names (string substring or RegExp). Pass `browser: true` to also
+     * include hereio internal runtime metrics.
+     *
+     * See also [MDN | Performance Mark API](https://developer.mozilla.org/en-US/docs/Web/API/Performance/mark)
+     *
+     * Note - only currently running WebContents will be captured, and performance entries can only be
+     * captured for the current navigation of each.
+     */
+    getPerformanceStats: (options?: OpenFin.GetPerformanceStatsOptions) => Promise<OpenFin.PerformanceStatsResult>;
 }
 
 /**
@@ -1374,6 +1389,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
 declare type ApplicationPermissions = {
     setFileDownloadLocation: boolean;
     getFileDownloadLocation: boolean;
+    getPerformanceStats: boolean;
 };
 
 /**
@@ -3129,7 +3145,12 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
     childOptions: OpenFin.WindowOptions;
 };
 
-/* Excluded from this release type: ChromeBrowser */
+declare interface ChromeBrowser {
+    /**
+     * Extension action surface — observe and invoke installed Chrome extension actions.
+     */
+    readonly Actions: ChromeBrowserActions;
+}
 
 /**
  * APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
@@ -4107,7 +4128,7 @@ declare type ConstWindowOptions = {
     width: number;
     x: number;
     y: number;
-    experimental?: any;
+    /* Excluded from this release type: experimental */
     fdc3InteropApi?: string;
     /**
      * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
@@ -4430,6 +4451,8 @@ declare type CopyPermissions = {
     };
 };
 
+declare type CorePerformanceEntry = Omit<PerformanceEntry, 'toJSON'>;
+
 /**
  * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
  *  average of _height_ and _width_.
@@ -4582,6 +4605,32 @@ declare type CreateLayoutOptions = {
      * @experimental
      */
     renderCustomHeaderControls?: (controlsElement: HTMLElement, context: HeaderControlsContext) => (() => void) | void;
+    /**
+     * Callback invoked once per tab after core has finished building the tab DOM.
+     * Use this to inject custom controls (e.g. action icons) into view tab hats.
+     *
+     * Optionally return a cleanup function that will be called when the tab is destroyed.
+     *
+     * Custom controls are not serialized into snapshots since callbacks are not
+     * serializable. The callback is re-invoked when tabs are recreated.
+     *
+     * **NOTE**: This feature is only supported with layout engine `'v2'` (GL2) and
+     * `settings.tabOverflowBehavior: 'scroll'`.
+     *
+     * Optionally add the `lm_tab_custom_control` class to each injected control as a direct child of
+     * `tabElement`. That opts the control into {@link LayoutAccessibilityOptions} keyboard
+     * navigation (roving tabindex, arrow keys in DOM order, Enter/Space without switching tabs),
+     * pointer isolation so clicks do not activate or close the tab (press-and-drag still
+     * reorders/tears out tab, matching the close button), and default 20×20 flex sizing
+     * (override using `--layout-tab-custom-control-size`).
+     *
+     * @param tabElement The `.lm_tab` DOM element for the view tab.
+     * @param context Context object with DOM anchors for the tab.
+     * @returns A callback to be called when the rendered elements need to be cleaned up.
+     *
+     * @experimental
+     */
+    renderCustomTabControls?: (tabElement: HTMLElement, context: CustomTabControlsContext) => (() => void) | void;
     /**
      * Accessibility options for the layout. Controls ARIA attributes and keyboard navigation.
      */
@@ -4671,6 +4720,19 @@ declare type CustomRequestHeaders = {
     headers: WebRequestHeader[];
 };
 
+/**
+ * @interface @experimental
+ */
+declare type CustomTabControlsContext = {
+    viewIdentity: Identity_4;
+    /** Anchor for inserting controls adjacent to the tab text. */
+    titleElement: HTMLElement;
+    /** Anchor for the trailing outer edge. Absent when the view is not closable. */
+    closeElement?: HTMLElement;
+    /** The favicon element. Hidden when favicons are disabled. */
+    faviconElement?: HTMLElement;
+};
+
 declare type DataChannelReadyState = RTCDataChannel['readyState'];
 
 /**
@@ -5329,7 +5391,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
  *  under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
  *  from which they propagate).
  */
-declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | ExtensionsEnabledEvent | ExtensionsDisabledEvent | ExtensionsExcludedEvent | ExtensionsInstalledEvent | ExtensionInstalledEvent | ExtensionsInstallFailedEvent | ExtensionInstallFailedEvent | ExtensionsInitializationFailedEvent | ThemePaletteChangedEvent | NativeThemeUpdatedEvent;
+declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | ExtensionsEnabledEvent | ExtensionsDisabledEvent | ExtensionsExcludedEvent | ExtensionsInstalledEvent | ExtensionInstalledEvent | ExtensionsInstallFailedEvent | ExtensionInstallFailedEvent | ExtensionsInitializationFailedEvent | ExtensionLoadedEvent | ExtensionReadyEvent | ThemePaletteChangedEvent | NativeThemeUpdatedEvent;
 
 /**
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by the HTMLElement Layout container.
@@ -5569,6 +5631,30 @@ declare type ExtensionInstallFailedEvent = ExtensionEvent & {
     type: 'extension-install-failed';
 };
 
+declare type ExtensionLifecycleEvent = BaseEvent_9 & {
+    extensionId: string;
+    name: string;
+    version: string;
+};
+
+/**
+ * Fired when the Runtime finishes loading an extension's scripts into the renderer process.
+ *
+ * @interface
+ */
+declare type ExtensionLoadedEvent = ExtensionLifecycleEvent & {
+    type: 'extension-loaded';
+};
+
+/**
+ * Fired when an extension is fully functional (permissions granted, service worker running).
+ *
+ * @interface
+ */
+declare type ExtensionReadyEvent = ExtensionLifecycleEvent & {
+    type: 'extension-ready';
+};
+
 /**
  * An event that fires when extensions are disabled in the security realm.
  *
@@ -6715,6 +6801,32 @@ declare type GetLogRequestType = {
     name: string;
 };
 
+/**
+ * End of Interop Client Events
+ */
+/**
+ * Performance Entry Types
+ */
+declare type GetPerformanceStatsOptions = {
+    /**
+     * Optional filter for custom performance marks and measures.
+     * When omitted, all custom marks and measures are collected.
+     * When specified, only entries whose names match one of the filters are collected.
+     * Strings match by substring; RegExp matches by test.
+     */
+    include?: (string | RegExp)[];
+    /**
+     * Include `resource` timing entries from each View / Frame / Window.
+     * Defaults to `true`. Pass `false` to omit them.
+     */
+    resources?: boolean;
+    /**
+     * Whether to include hereio internal runtime metrics.
+     * Defaults to `false`. Pass `true` to include.
+     */
+    browser?: boolean;
+};
+
 declare type GetterCall<T> = ApiCall<void, T>;
 
 /**
@@ -7390,17 +7502,19 @@ declare type InteropActionLoggingOption = {
  *          "interopBrokerConfiguration": {
  *              "contextGroups": [
  *                  {
- *                      "id": "green",
+ *                      "id": "fdc3.channel.4",
  *                      "displayMetadata": {
- *                          "color": "#00CC88",
- *                          "name": "green"
+ *                          "color": "green",
+ *                          "name": "Channel 4",
+ *                          "glyph": "4"
  *                      }
  *                  },
  *                  {
- *                      "id": "purple",
+ *                      "id": "fdc3.channel.8",
  *                      "displayMetadata": {
- *                          "color": "#8C61FF",
- *                          "name": "purple"
+ *                          "color": "purple",
+ *                          "name": "Channel 8",
+ *                          "glyph": "8"
  *                      }
  *                  },
  *              ]
@@ -7534,7 +7648,7 @@ declare class InteropBroker extends Base {
      * @param joinContextGroupOptions - Id of the Context Group and identity of the entity to join to the group.
      * @param senderIdentity - Identity of the client sender.
      */
-    joinContextGroup({ contextGroupId, target }: {
+    joinContextGroup({ contextGroupId: requestedContextGroupId, target }: {
         contextGroupId: string;
         target?: OpenFin.ClientIdentity | OpenFin.Identity;
     }, senderIdentity: OpenFin.ClientIdentity): Promise<void>;
@@ -7545,7 +7659,7 @@ declare class InteropBroker extends Base {
      * @param addClientToContextGroupOptions - Contains the contextGroupId
      * @param clientIdentity - Identity of the client sender.
      */
-    addClientToContextGroup({ contextGroupId }: {
+    addClientToContextGroup({ contextGroupId: requestedContextGroupId }: {
         contextGroupId: string;
     }, clientIdentity: OpenFin.ClientIdentity): Promise<void>;
     /**
@@ -7958,6 +8072,8 @@ declare class InteropBroker extends Base {
     };
     private getClientState;
     private static toObject;
+    private normalizeContextGroupStates;
+    private normalizeContextGroupId;
     static checkContextIntegrity: (context: OpenFin.Context) => {
         isValid: true;
     } | {
@@ -8185,7 +8301,7 @@ declare class InteropClient extends Base {
      *
      * getLastFocusedView()
      *     .then(lastFocusedViewIdentity => {
-     *         joinViewToContextGroup('red', lastFocusedViewIdentity)
+     *         joinViewToContextGroup('fdc3.channel.1', lastFocusedViewIdentity)
      *     })
      * ```
      */
@@ -8220,7 +8336,7 @@ declare class InteropClient extends Base {
      *
      * @example
      * ```js
-     * fin.me.interop.getAllClientsInContextGroup('red')
+     * fin.me.interop.getAllClientsInContextGroup('fdc3.channel.1')
      *     .then(clientsInContextGroup => {
      *         console.log(clientsInContextGroup)
      *     })
@@ -8235,7 +8351,7 @@ declare class InteropClient extends Base {
      *
      * @example
      * ```js
-     * fin.me.interop.getInfoForContextGroup('red')
+     * fin.me.interop.getInfoForContextGroup('fdc3.channel.1')
      *     .then(contextGroupInfo => {
      *         console.log(contextGroupInfo.displayMetadata.name)
      *         console.log(contextGroupInfo.displayMetadata.color)
@@ -8292,12 +8408,12 @@ declare class InteropClient extends Base {
      *
      * @example
      * ```js
-     * await fin.me.interop.joinContextGroup('yellow');
+     * await fin.me.interop.joinContextGroup('fdc3.channel.3');
      * await fin.me.interop.setContext({ type: 'instrument', id: { ticker: 'FOO' }});
      * const currentContext = await fin.me.interop.getCurrentContext();
      *
      * // with a specific context
-     * await fin.me.interop.joinContextGroup('yellow');
+     * await fin.me.interop.joinContextGroup('fdc3.channel.3');
      * await fin.me.interop.setContext({ type: 'country', id: { ISOALPHA3: 'US' }});
      * await fin.me.interop.setContext({ type: 'instrument', id: { ticker: 'FOO' }});
      * const currentContext = await fin.me.interop.getCurrentContext('country');
@@ -8459,7 +8575,7 @@ declare type InteropClientOnDisconnectionListener = (InteropBrokerDisconnectionE
  */
 declare type InteropConfig = {
     /**
-     * Context Group for the client. (green, yellow, red, etc.).
+     * Context Group ID for the client (for example, `fdc3.channel.4`).
      */
     currentContextGroup?: string | null;
     /**
@@ -8508,7 +8624,7 @@ declare class InteropModule extends Base {
      * @example
      * ```js
      * const interopConfig = {
-     *     currentContextGroup: 'green'
+     *     currentContextGroup: 'fdc3.channel.4'
      * }
      *
      * const interopBroker = await fin.Interop.init('openfin');
@@ -9538,8 +9654,26 @@ declare type LayoutOptions = {
     content?: LayoutContent;
     dimensions?: {
         borderWidth?: number;
+        /**
+         * Minimum height a layout item can be resized to, in pixels.
+         * On web layouts this is mapped to Golden Layout 2 `defaultMinItemHeight`.
+         */
         minItemHeight?: number;
+        /**
+         * Minimum width a layout item can be resized to, in pixels.
+         * On web layouts this is mapped to Golden Layout 2 `defaultMinItemWidth`.
+         */
         minItemWidth?: number;
+        /**
+         * Minimum height a layout item can be resized to (CSS size, e.g. `'500px'`).
+         * Web layouts only. Takes precedence over {@link LayoutOptions.dimensions.minItemHeight} when both are set.
+         */
+        defaultMinItemHeight?: string;
+        /**
+         * Minimum width a layout item can be resized to (CSS size, e.g. `'500px'`).
+         * Web layouts only. Takes precedence over {@link LayoutOptions.dimensions.minItemWidth} when both are set.
+         */
+        defaultMinItemWidth?: string;
         headerHeight?: number;
     };
 };
@@ -10202,6 +10336,19 @@ declare type MutableViewOptions = {
     preventDragOut: boolean;
     interop?: InteropConfig;
     /* Excluded from this release type: _internalWorkspaceData */
+    /* Excluded from this release type: workspacePlatform */
+    /**
+     * Per-view tab icon. Exception to `showFavicons` / `defaultFaviconUrl`.
+     *
+     * Distinct from Window `icon` (taskbar).
+     *
+     * - Omitted / `''` / `'unset'`: inherit — if `showFavicons`, page favicon then `defaultFaviconUrl`, else hide
+     * - URL string: always show that URL, even when `showFavicons` is false. Load failure uses `defaultFaviconUrl`
+     * - `'hide'`: always hide, even when `showFavicons` is true
+     *
+     * On `updateOptions`, omitted keys are a no-op; set `'unset'` to return to inherit.
+     */
+    icon?: ViewTabIcon;
     /**
      * {@inheritDoc ViewThrottling}
      *
@@ -10945,6 +11092,7 @@ declare namespace OpenFin {
         ViewInfo,
         WindowThrottling,
         ViewThrottling,
+        ViewTabIcon,
         UpdatableViewOptions,
         ViewCreationOptions,
         MutableViewOptions,
@@ -11117,6 +11265,7 @@ declare namespace OpenFin {
         ScreenCaptureBehavior,
         DomainSettingsPreloadScripts,
         PerDomainSettings,
+        UrlRestoreSettings,
         CopyPermissions,
         PastePermissions,
         ClipboardPermissions,
@@ -11184,6 +11333,7 @@ declare namespace OpenFin {
         LayoutManagerOverride,
         LayoutManager,
         HeaderControlsContext,
+        CustomTabControlsContext,
         CreateLayoutOptions,
         MultiInstanceViewBehavior,
         LayoutAccessibilityOptions,
@@ -11257,6 +11407,12 @@ declare namespace OpenFin {
         InteropClientEvent,
         ClientChangedContextGroup,
         InteropClientEvents,
+        GetPerformanceStatsOptions,
+        SerializedPerformanceOptions,
+        CorePerformanceEntry,
+        WebContentPerformanceStats,
+        WindowPerformanceStats,
+        PerformanceStatsResult,
         ChromeBrowser,
         LanguageInfo,
         PageTranslateOptions,
@@ -11541,6 +11697,12 @@ declare type PerDomainSettings = {
      * See also {@link AppLogLevel} for more information.
      */
     appLogLevel?: AppLogLevel;
+    /**
+     * When the live URL matches this rule, remap inbound
+     * {@link View.ViewModule.navigate View.navigate} / {@link Window.WindowModule.navigate Window.navigate}
+     * to {@link UrlRestoreSettings.url}.
+     */
+    urlRestore?: UrlRestoreSettings;
 };
 
 /**
@@ -11551,6 +11713,15 @@ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
     type: 'performance-report';
 };
 
+declare type PerformanceStatsResult = {
+    mainWindow: WindowPerformanceStats;
+    childWindows: WindowPerformanceStats[];
+    browser?: {
+        timeOrigin: number;
+        entries: CorePerformanceEntry[];
+    };
+};
+
 /**
  * @interface
  *
@@ -13677,6 +13848,11 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         response: OpenFin.MenuResult;
     };
     'close-tray-icon-popup-menu': IdentityCall<{}, void>;
+    'get-application-performance-stats': ApplicationIdentityCall<OpenFin.SerializedPerformanceOptions, OpenFin.PerformanceStatsResult> & {
+        secure: true;
+        namespace: 'Application';
+        apiPath: '.getPerformanceStats';
+    };
     'create-application': ApiCall<OpenFin.ApplicationCreationOptions, void>;
     'run-applications': ApiCall<{
         applications: Array<OpenFin.ManifestInfo>;
@@ -15062,6 +15238,16 @@ declare type SentMessage<Value> = Promise<Value> & {
     messageId: ReturnType<Environment['getNextMessageId']>;
 };
 
+declare type SerializedFilter = string | {
+    type: 'regex';
+    expression: string;
+    flags?: string;
+};
+
+declare type SerializedPerformanceOptions = Omit<GetPerformanceStatsOptions, 'include'> & {
+    include?: SerializedFilter[];
+};
+
 declare type ServeAssetOptions = AppAssetServeRequest | PathServeRequest;
 
 declare type ServedAssetInfo = {
@@ -17351,6 +17537,8 @@ declare namespace SystemEvents {
         ExtensionsInstallFailedEvent,
         ExtensionInstallFailedEvent,
         ExtensionsInitializationFailedEvent,
+        ExtensionLoadedEvent,
+        ExtensionReadyEvent,
         ThemePaletteChangedEvent,
         NativeThemeUpdatedEvent,
         Event_11 as Event,
@@ -18062,6 +18250,16 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
     httpStatusText: string;
 });
 
+/**
+ * Domain-settings policy that replaces a matched live URL with a configured start URI.
+ */
+declare type UrlRestoreSettings = {
+    /**
+     * Absolute replacement URL. Full URL replace, not prefix rewrite.
+     */
+    url: string;
+};
+
 /**
  * @interface
  */
@@ -18975,10 +19173,10 @@ declare type ViewTabAccessibilityOptions = {
      * Uses roving tabindex pattern - only one element focusable at a time.
      * @default ['active-tab', 'add-tab-button']
      */
-    tabNavigation?: ViewTabElements[];
+    tabNavigation?: Exclude<ViewTabElements, 'active-tab-custom-control' | 'inactive-tab-custom-control'>[];
     /**
      * Controls which elements are navigable via Arrow keys.
-     * @default ['inactive-tab', 'active-tab', 'active-tab-close-button', 'inactive-tab-close-button', 'add-tab-button']
+     * @default ['inactive-tab', 'active-tab', 'active-tab-close-button', 'inactive-tab-close-button', 'add-tab-button', 'active-tab-custom-control', 'inactive-tab-custom-control']
      */
     arrowNavigation?: ViewTabElements[];
     /**
@@ -19010,7 +19208,14 @@ declare type ViewTabAccessibilityOptions = {
 /**
  * Elements that can be navigated in view tabs.
  */
-declare type ViewTabElements = 'active-tab' | 'inactive-tab' | 'active-tab-close-button' | 'inactive-tab-close-button' | 'add-tab-button';
+declare type ViewTabElements = 'active-tab' | 'inactive-tab' | 'active-tab-close-button' | 'inactive-tab-close-button' | 'add-tab-button' | 'active-tab-custom-control' | 'inactive-tab-custom-control';
+
+/**
+ * Per-view tab icon. A URL, or the reserved sentinels `'hide'` / `'unset'`.
+ *
+ * `'hide'` and `'unset'` are not URLs. `''` is also unset (inherit) and is the default.
+ */
+declare type ViewTabIcon = string | 'hide' | 'unset';
 
 /**
  * View throttling state.
@@ -19064,6 +19269,22 @@ declare type VoidCall = ApiCall<void, void>;
 
 declare type WebContent = View_2 | _Window;
 
+declare type WebContentPerformanceStatBase = {
+    name: string;
+    entries: CorePerformanceEntry[];
+    navigation: {
+        historyLength: number;
+        timeOrigin: number;
+    };
+    url: string;
+    frames: WebContentPerformanceStats[];
+};
+
+declare type WebContentPerformanceStats = WebContentPerformanceStatBase | {
+    error: string;
+    url: string;
+};
+
 declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
     identity: OpenFin.Identity;
     entityType: 'window' | 'view';
@@ -21671,6 +21892,13 @@ declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChang
  */
 declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
 
+declare type WindowPerformanceStats = (WebContentPerformanceStatBase & {
+    views: WebContentPerformanceStats[];
+}) | {
+    error: string;
+    url: string;
+};
+
 declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
 
 /**