@openfin/core 45.100.114 → 45.100.115

package/out/mock-alpha.d.ts

@@ -926,6 +926,21 @@ declare class Application extends EmitterBase<OpenFin_2.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_2.GetPerformanceStatsOptions) => Promise<OpenFin_2.PerformanceStatsResult>;
 }
 
 /**
@@ -1377,6 +1392,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
 declare type ApplicationPermissions = {
     setFileDownloadLocation: boolean;
     getFileDownloadLocation: boolean;
+    getPerformanceStats: boolean;
 };
 
 /**
@@ -3132,7 +3148,12 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
     childOptions: OpenFin_2.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.
@@ -4110,7 +4131,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.
@@ -4433,6 +4454,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_.
@@ -4585,6 +4608,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.
      */
@@ -4674,8 +4723,69 @@ 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'];
 
+export declare type DefaultColorChannelId = keyof typeof defaultColorChannels;
+
+/**
+ * The default FDC3 user channels advertised by the Interop Broker.
+ */
+export declare const defaultColorChannels: {
+    readonly 'fdc3.channel.1': {
+        readonly name: "Channel 1";
+        readonly color: "red";
+        readonly glyph: "1";
+    };
+    readonly 'fdc3.channel.2': {
+        readonly name: "Channel 2";
+        readonly color: "orange";
+        readonly glyph: "2";
+    };
+    readonly 'fdc3.channel.3': {
+        readonly name: "Channel 3";
+        readonly color: "yellow";
+        readonly glyph: "3";
+    };
+    readonly 'fdc3.channel.4': {
+        readonly name: "Channel 4";
+        readonly color: "green";
+        readonly glyph: "4";
+    };
+    readonly 'fdc3.channel.5': {
+        readonly name: "Channel 5";
+        readonly color: "cyan";
+        readonly glyph: "5";
+    };
+    readonly 'fdc3.channel.6': {
+        readonly name: "Channel 6";
+        readonly color: "blue";
+        readonly glyph: "6";
+    };
+    readonly 'fdc3.channel.7': {
+        readonly name: "Channel 7";
+        readonly color: "magenta";
+        readonly glyph: "7";
+    };
+    readonly 'fdc3.channel.8': {
+        readonly name: "Channel 8";
+        readonly color: "purple";
+        readonly glyph: "8";
+    };
+};
+
 /**
  * @deprecated Use {@link OpenFin.DomainSettings} instead.
  * @interface
@@ -6373,6 +6483,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>;
 
 /**
@@ -7048,17 +7184,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"
  *                      }
  *                  },
  *              ]
@@ -7192,7 +7330,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_2.ClientIdentity | OpenFin_2.Identity;
     }, senderIdentity: OpenFin_2.ClientIdentity): Promise<void>;
@@ -7203,7 +7341,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_2.ClientIdentity): Promise<void>;
     /**
@@ -7616,6 +7754,8 @@ declare class InteropBroker extends Base {
     };
     private getClientState;
     private static toObject;
+    private normalizeContextGroupStates;
+    private normalizeContextGroupId;
     static checkContextIntegrity: (context: OpenFin_2.Context) => {
         isValid: true;
     } | {
@@ -7843,7 +7983,7 @@ declare class InteropClient extends Base {
      *
      * getLastFocusedView()
      *     .then(lastFocusedViewIdentity => {
-     *         joinViewToContextGroup('red', lastFocusedViewIdentity)
+     *         joinViewToContextGroup('fdc3.channel.1', lastFocusedViewIdentity)
      *     })
      * ```
      */
@@ -7878,7 +8018,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)
      *     })
@@ -7893,7 +8033,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)
@@ -7950,12 +8090,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');
@@ -8117,7 +8257,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;
     /**
@@ -8166,7 +8306,7 @@ declare class InteropModule extends Base {
      * @example
      * ```js
      * const interopConfig = {
-     *     currentContextGroup: 'green'
+     *     currentContextGroup: 'fdc3.channel.4'
      * }
      *
      * const interopBroker = await fin.Interop.init('openfin');
@@ -9196,8 +9336,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;
     };
 };
@@ -9270,6 +9428,20 @@ declare type LayoutSyncApi = {
     updateAccessibilityOptions(options: Partial<LayoutAccessibilityOptions>): void;
 };
 
+declare type LegacyColorChannelId = keyof typeof legacyColorChannelIds;
+
+declare const legacyColorChannelIds: {
+    readonly red: "fdc3.channel.1";
+    readonly orange: "fdc3.channel.2";
+    readonly yellow: "fdc3.channel.3";
+    readonly green: "fdc3.channel.4";
+    readonly teal: "fdc3.channel.5";
+    readonly blue: "fdc3.channel.6";
+    readonly pink: "fdc3.channel.7";
+    readonly indigo: "fdc3.channel.8";
+    readonly purple: "fdc3.channel.8";
+};
+
 /**
  * @interface
  */
@@ -9860,6 +10032,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}
      *
@@ -10348,6 +10533,14 @@ declare type NonTabInjectionRule = {
     matchOptions?: RuleMatchOptions;
 };
 
+/**
+ * Converts a legacy color-named channel ID to its canonical FDC3 user-channel ID.
+ * The removed legacy gray channel resolves to no channel.
+ */
+export declare function normalizeColorChannelId<T extends string>(colorChannelId: T): NormalizedColorChannelId<T>;
+
+declare type NormalizedColorChannelId<T extends string> = string extends T ? string | undefined : T extends 'gray' ? undefined : T extends LegacyColorChannelId ? (typeof legacyColorChannelIds)[T] : T;
+
 /* Excluded from this release type: NotCloseRequested */
 
 declare type NotificationEvent = {
@@ -10603,6 +10796,7 @@ declare namespace OpenFin_2 {
         ViewInfo,
         WindowThrottling,
         ViewThrottling,
+        ViewTabIcon,
         UpdatableViewOptions,
         ViewCreationOptions,
         MutableViewOptions,
@@ -10775,6 +10969,7 @@ declare namespace OpenFin_2 {
         ScreenCaptureBehavior,
         DomainSettingsPreloadScripts,
         PerDomainSettings,
+        UrlRestoreSettings,
         CopyPermissions,
         PastePermissions,
         ClipboardPermissions,
@@ -10842,6 +11037,7 @@ declare namespace OpenFin_2 {
         LayoutManagerOverride,
         LayoutManager,
         HeaderControlsContext,
+        CustomTabControlsContext,
         CreateLayoutOptions,
         MultiInstanceViewBehavior,
         LayoutAccessibilityOptions,
@@ -10915,6 +11111,12 @@ declare namespace OpenFin_2 {
         InteropClientEvent,
         ClientChangedContextGroup,
         InteropClientEvents,
+        GetPerformanceStatsOptions,
+        SerializedPerformanceOptions,
+        CorePerformanceEntry,
+        WebContentPerformanceStats,
+        WindowPerformanceStats,
+        PerformanceStatsResult,
         ChromeBrowser,
         LanguageInfo,
         PageTranslateOptions,
@@ -11201,6 +11403,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;
 };
 
 /**
@@ -11211,6 +11419,15 @@ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
     type: 'performance-report';
 };
 
+declare type PerformanceStatsResult = {
+    mainWindow: WindowPerformanceStats;
+    childWindows: WindowPerformanceStats[];
+    browser?: {
+        timeOrigin: number;
+        entries: CorePerformanceEntry[];
+    };
+};
+
 /**
  * @interface
  *
@@ -13337,6 +13554,11 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         response: OpenFin_2.MenuResult;
     };
     'close-tray-icon-popup-menu': IdentityCall<{}, void>;
+    'get-application-performance-stats': ApplicationIdentityCall<OpenFin_2.SerializedPerformanceOptions, OpenFin_2.PerformanceStatsResult> & {
+        secure: true;
+        namespace: 'Application';
+        apiPath: '.getPerformanceStats';
+    };
     'create-application': ApiCall<OpenFin_2.ApplicationCreationOptions, void>;
     'run-applications': ApiCall<{
         applications: Array<OpenFin_2.ManifestInfo>;
@@ -14722,6 +14944,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 = {
@@ -17722,6 +17954,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
  */
@@ -18529,10 +18771,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[];
     /**
@@ -18564,7 +18806,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.
@@ -18618,6 +18867,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_2.Identity;
     entityType: 'window' | 'view';
@@ -21225,6 +21490,13 @@ declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsCha
  */
 declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
 
+declare type WindowPerformanceStats = (WebContentPerformanceStatBase & {
+    views: WebContentPerformanceStats[];
+}) | {
+    error: string;
+    url: string;
+};
+
 declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
 
 /**