@openfin/fdc3-api 45.100.114 → 45.100.115

package/out/fdc3-api.d.ts

@@ -929,6 +929,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>;
 }
 
 /**
@@ -1380,6 +1395,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
 declare type ApplicationPermissions = {
     setFileDownloadLocation: boolean;
     getFileDownloadLocation: boolean;
+    getPerformanceStats: boolean;
 };
 
 /**
@@ -3185,23 +3201,6 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
     childOptions: OpenFin.WindowOptions;
 };
 
-/**
- * End of Interop Client Events
- */
-/**
- * Client-side handle for the chrome-browser feature.
- *
- * For extension integration to be active on a window, that window must be
- * created with `chromeBrowser: true` in its window options.
- *
- * @remarks
- * This namespace is intended for internal experimentation only. Enabling the
- * `chromeBrowser` window option changes how the runtime manages content and standard
- * OpenFin content behavior is not guaranteed.
- *
- * @internal
- * @experimental This API is under active development and may change or be removed without notice.
- */
 declare interface ChromeBrowser {
     /**
      * Extension action surface — observe and invoke installed Chrome extension actions.
@@ -4209,6 +4208,32 @@ declare type ConstWindowOptions = {
     width: number;
     x: number;
     y: number;
+    /**
+     * Experimental window options. These options are not yet stable and may change without notice.
+     *
+     * Supported properties:
+     *
+     * - **`layoutEngine`** `'v1' | 'v2'` — Selects the layout engine used to render
+     *   layouts in this window. `'v1'` is the legacy engine, `'v2'` is the modernized engine.
+     *   Defaults to `'v1'`.
+     *
+     * - **`showFavicons`** `boolean` — When `true`, displays favicon icons on layout tabs.
+     *
+     * - **`defaultFaviconUrl`** `string` — URL of a fallback favicon to display when a view does not
+     *   provide its own.
+     *
+     * - **`windowLogLevel`** `string` — Sets the log level for layout-related window logging
+     *   (e.g. `'verbose'`, `'warn'`, `'error'`).
+     *
+     * - **`enableLayoutCollapsing`** `boolean` — When `true`, enables the Golden Layout restacking
+     *   feature by preserving minimum item dimensions.
+     *
+     * - **`showViewsOnResize`** `{ enabled: boolean; delayMs?: number }` — Controls whether views
+     *   are shown during window resize operations. Deprecated in favor of
+     *   `viewVisibility.showViewsOnWindowResize`.
+     *
+     * @internal
+     */
     experimental?: any;
     fdc3InteropApi?: string;
     /**
@@ -4532,6 +4557,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_.
@@ -4684,6 +4711,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.
      */
@@ -4773,6 +4826,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'];
 
 /**
@@ -6852,6 +6918,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>;
 
 /**
@@ -7545,17 +7637,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"
  *                      }
  *                  },
  *              ]
@@ -7692,7 +7786,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>;
@@ -7703,7 +7797,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>;
     /**
@@ -8116,6 +8210,8 @@ declare class InteropBroker extends Base {
     };
     private getClientState;
     private static toObject;
+    private normalizeContextGroupStates;
+    private normalizeContextGroupId;
     static checkContextIntegrity: (context: OpenFin.Context) => {
         isValid: true;
     } | {
@@ -8346,7 +8442,7 @@ declare class InteropClient extends Base {
      *
      * getLastFocusedView()
      *     .then(lastFocusedViewIdentity => {
-     *         joinViewToContextGroup('red', lastFocusedViewIdentity)
+     *         joinViewToContextGroup('fdc3.channel.1', lastFocusedViewIdentity)
      *     })
      * ```
      */
@@ -8381,7 +8477,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)
      *     })
@@ -8396,7 +8492,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)
@@ -8453,12 +8549,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');
@@ -8625,7 +8721,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;
     /**
@@ -8674,7 +8770,7 @@ declare class InteropModule extends Base {
      * @example
      * ```js
      * const interopConfig = {
-     *     currentContextGroup: 'green'
+     *     currentContextGroup: 'fdc3.channel.4'
      * }
      *
      * const interopBroker = await fin.Interop.init('openfin');
@@ -9896,8 +9992,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;
     };
 };
@@ -10564,6 +10678,24 @@ declare type MutableViewOptions = {
      * Used by Workspace to store custom data. Overwriting or modifying this field may impact the functionality of Workspace
      */
     _internalWorkspaceData: any;
+    /**
+     * @internal
+     * Used by Workspace to store platform-specific options (including `viewTab`). Overwriting or modifying this field may impact the functionality of Workspace.
+     * Persisted on create, {@link View.View#updateOptions updateOptions}, snapshot, and {@link View.View#getOptions getOptions} — the same way windows persist `workspacePlatform`.
+     */
+    workspacePlatform?: WorkspacePlatformOptions;
+    /**
+     * 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}
      *
@@ -11328,6 +11460,7 @@ declare namespace OpenFin {
         ViewInfo,
         WindowThrottling,
         ViewThrottling,
+        ViewTabIcon,
         UpdatableViewOptions,
         ViewCreationOptions,
         MutableViewOptions,
@@ -11500,6 +11633,7 @@ declare namespace OpenFin {
         ScreenCaptureBehavior,
         DomainSettingsPreloadScripts,
         PerDomainSettings,
+        UrlRestoreSettings,
         CopyPermissions,
         PastePermissions,
         ClipboardPermissions,
@@ -11567,6 +11701,7 @@ declare namespace OpenFin {
         LayoutManagerOverride,
         LayoutManager,
         HeaderControlsContext,
+        CustomTabControlsContext,
         CreateLayoutOptions,
         MultiInstanceViewBehavior,
         LayoutAccessibilityOptions,
@@ -11640,6 +11775,12 @@ declare namespace OpenFin {
         InteropClientEvent,
         ClientChangedContextGroup,
         InteropClientEvents,
+        GetPerformanceStatsOptions,
+        SerializedPerformanceOptions,
+        CorePerformanceEntry,
+        WebContentPerformanceStats,
+        WindowPerformanceStats,
+        PerformanceStatsResult,
         ChromeBrowser,
         LanguageInfo,
         PageTranslateOptions,
@@ -11924,6 +12065,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;
 };
 
 /**
@@ -11934,6 +12081,15 @@ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
     type: 'performance-report';
 };
 
+declare type PerformanceStatsResult = {
+    mainWindow: WindowPerformanceStats;
+    childWindows: WindowPerformanceStats[];
+    browser?: {
+        timeOrigin: number;
+        entries: CorePerformanceEntry[];
+    };
+};
+
 /**
  * @interface
  *
@@ -14143,6 +14299,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>;
@@ -15528,6 +15689,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 = {
@@ -18541,6 +18712,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
  */
@@ -19491,10 +19672,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[];
     /**
@@ -19526,7 +19707,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.
@@ -19580,6 +19768,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';
@@ -22190,6 +22394,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;
 
 /**

package/out/fdc3-api.js

@@ -900,7 +900,7 @@ class InteropClient extends Base {
      *
      * getLastFocusedView()
      *     .then(lastFocusedViewIdentity => {
-     *         joinViewToContextGroup('red', lastFocusedViewIdentity)
+     *         joinViewToContextGroup('fdc3.channel.1', lastFocusedViewIdentity)
      *     })
      * ```
      */
@@ -950,7 +950,7 @@ class InteropClient extends Base {
      *
      * @example
      * ```js
-     * fin.me.interop.getAllClientsInContextGroup('red')
+     * fin.me.interop.getAllClientsInContextGroup('fdc3.channel.1')
      *     .then(clientsInContextGroup => {
      *         console.log(clientsInContextGroup)
      *     })
@@ -974,7 +974,7 @@ 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)
@@ -1063,12 +1063,12 @@ 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');
@@ -1374,15 +1374,18 @@ class FDC3ModuleBase {
     async joinChannel(channelId) {
         this.wire.recordAnalytic('fdc3-join-channel');
         try {
+            const contextGroup = await this.client.getInfoForContextGroup(channelId);
+            if (!contextGroup) {
+                console.error(`No User Channel was found with the ID "${channelId}". If this is an App Channel, use getOrCreateChannel instead.`);
+                throw new Error(ChannelError.NoChannelFound);
+            }
             return await this.client.joinContextGroup(channelId);
         }
         catch (error) {
-            if (error.message === BROKER_ERRORS.joinSessionContextGroupWithJoinContextGroup) {
-                console.error('The Channel you have tried to join is an App Channel. Custom Channels can only be defined by the Interop Broker through code or manifest configuration. Please use getOrCreateChannel.');
-            }
-            else {
-                console.error(error.message);
+            if (error.message === ChannelError.NoChannelFound) {
+                throw new Error(ChannelError.NoChannelFound);
             }
+            console.error(error.message);
             if (error.message.startsWith('Attempting to join a context group that does not exist')) {
                 throw new Error(ChannelError.NoChannelFound);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfin/fdc3-api",
-  "version": "45.100.114",
+  "version": "45.100.115",
   "description": "OpenFin fdc3 module utilities and types.",
   "license": "SEE LICENSE IN LICENSE.md",
   "private": false,