@openfin/core 44.100.62 → 45.100.19

package/out/mock-alpha.d.ts

@@ -1421,29 +1421,26 @@ declare type ApplicationWindowInfo = {
 };
 
 /**
- * `appLogLevel` allows the verbosity of app logs that are collected for a Window or View to be controlled  when the app logging feature is enabled for its application.
+ * The `appLogLevel` option allows the verbosity of app logs that are collected for a Window or View to be controlled for its application.
  *
- * Please note, `enableAppLogging` must be specified in the application manifest's `platform` or `startup_app` key for this feature to be activated.
- *
- * If not specified, and `enableAppLogging` is true for the application, the default level will be 'silent'.
- *
- * This setting can also be specified in a Domain Setting Rule, allowing per url exceptions to the default behavior to be made. Please note, when a domain setting is actively
- * controlling a url's appLogLevel, its options will be ignored.
+ * This setting can also be specified in a Domain Setting Rule, allowing per url overrides to be defined. Please note, when a domain setting is actively
+ * controlling a url's appLogLevel, its view/window options will be ignored.
  *
  * @default 'debug'
  *
+ * Please note, if the manifest setting `platform.enableAppLogging`  or `startup_app.enableAppLogging` is set to `false`, this feature will be disabled.
+ *
  * @example Controlling App Logs With DefaultViewOptions + Domain Settings
  *
  * In this example manifest, we use `defaultViewOptions to set the default verbosity to 'warn'.
  *
- * We also use domain settings to suppress logs entirely for an example URL, and to lower verbosity to 'debug' for another.
+ * We also use domain settings to suppress logs for an example URL, and to lower verbosity to 'debug' for another.
  *
  * ```ts
  * {
  *   <rest of settings>
  *   "platform": {
  *      <rest of settings>
- *     "enableAppLogging": "true",
  *     "defaultViewOptions": {
  *       "appLogLevel": "warn"
  *     },
@@ -3132,6 +3129,25 @@ declare type ClickedMenuResult<Data extends unknown = unknown> = {
     data: Data;
 };
 
+/**
+ * client-changed-context-group is emitted whenever a client connected to the same InteropBroker
+ * (including the current client) change or leave a context group.
+ */
+declare type ClientChangedContextGroup = InteropClientEvent<'client-changed-context-group', {
+    /**
+     * The identity of the affected InteropClient
+     */
+    identity: ClientIdentity;
+    /**
+     * The new context group id, or null if removed from a group.
+     */
+    contextGroupId: string | null;
+    /**
+     * The previous context group id, or null if none exists.
+     */
+    previousContextGroupId: string | null;
+}>;
+
 /**
  * @interface
  */
@@ -3678,6 +3694,12 @@ declare type ConstViewOptions = {
      * Control which options to ignore when creating a Platform View.
      */
     excludeOptions: ExcludeOptions;
+    /**
+     * Determines whether window.open calls from web contents should use the specified target name as provided, or automatically generate a unique name.
+     * When true, each call generates a new unique target name, ensuring a new window is always created.
+     * When false, the target name passed to window.open is respected.
+     */
+    ignoreChildFrameName?: boolean;
 };
 
 /**
@@ -3945,6 +3967,12 @@ declare type ConstWindowOptions = {
      * Controls whether frameless window should have rounded corners. Default is false for Windows and true for MacOS. Setting this property to false will prevent the window from being fullscreenable on macOS. On Windows versions older than Windows 11 Build 22000 this property has no effect, and frameless windows will not have rounded corners.
      */
     roundedCorners: boolean;
+    /**
+     * Determines whether window.open calls from web contents should use the specified target name as provided, or automatically generate a unique name.
+     * When true, each call generates a new unique target name, ensuring a new window is always created.
+     * When false, the target name passed to window.open is respected.
+     */
+    ignoreChildFrameName?: boolean;
     /**
      * Configuration for download bubble UI.
      */
@@ -5139,7 +5167,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
  */
 declare type Event_4 = (WebContentsEvents.Event<'view'> & {
     target: OpenFin_2.Identity;
-}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent;
+}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent | ViewOptionsChangedEvent;
 
 /**
  *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
@@ -6282,7 +6310,28 @@ declare type Hotkey = {
      */
     keys: string;
     /**
-     * Prevent default key handling before emitting the event.
+     * Controls the event phase at which the hotkey is triggered.
+     *
+     * - `'capture'`: The hotkey fires **before** the event is sent to the renderer/page.
+     * This is the only phase where the `preventDefault` property is effective.
+     *
+     * - `'bubble'`: The hotkey fires **after** the page has processed the key event.
+     * This behaves exactly like a standard JavaScript event listener attached to the window:
+     * 1. If the page calls `event.preventDefault()` (on either **keydown** or **keyup**), this hotkey will **not** fire.
+     * 2. If the hotkey is browser-reserved (e.g. `Ctrl+Tab` to switch tabs for which keyup/keydown do not fire in a web browser), that action takes precedence and this hotkey will **not** fire.
+     *
+     * @default 'capture'
+     */
+    phase?: 'capture' | 'bubble';
+    /**
+     * Determines if the event should continue to the renderer.
+     *
+     * - `true`: The event is consumed immediately. It will **never** reach the renderer/page.
+     * - `false`: The event is sent to the renderer after this hotkey executes.
+     *
+     * @remarks
+     * This property is **only valid** when `phase` is set to `'capture'`.
+     * If `phase` is `'bubble'`, this property is ignored (as the renderer has already received and processed the event).
      *
      * @default false
      */
@@ -7336,6 +7385,20 @@ declare type InteropBrokerOptions = {
 declare class InteropClient extends Base {
     #private;
     /* Excluded from this release type: __constructor */
+    /**
+     * `addListener` allows the InteropClient to subscribe to events emitted by the connected InteropBroker.
+     * @param type The event type to subscribe to.
+     * @param listener Callback invoked whenever the event occurs.
+     * @returns Promise resolving with void once the listener is registered.
+     */
+    addListener: (type: OpenFin_2.InteropClientEvents['type'], listener: (event: OpenFin_2.InteropClientEvents['event']) => void) => Promise<void>;
+    /**
+     * `removeListener` removes a registered event listener.
+     * @param type The event type to subscribe to.
+     * @param listener Callback to be removed.
+     * @returns Promise resolving with void even if no callback was found.
+     */
+    removeListener: (type: OpenFin_2.InteropClientEvents['type'], listener: (event: OpenFin_2.InteropClientEvents['event']) => void) => Promise<void>;
     /**
      * Sets a context for the context group of the current entity.
      *
@@ -7705,6 +7768,16 @@ declare class InteropClient extends Base {
     /* Excluded from this release type: ferryFdc3Call */
 }
 
+/**
+ * Interop Client Events
+ */
+declare type InteropClientEvent<TName, TEventType = void> = {
+    type: TName;
+    event: TEventType;
+};
+
+declare type InteropClientEvents = ClientChangedContextGroup;
+
 /**
  * @interface
  */
@@ -9496,10 +9569,12 @@ declare type MutableWindowOptions = {
      */
     customData: any;
     /**
-     * @deprecated Will be removed in runtime version 45
      *
      * Show the window's frame.
      *
+     * @remarks
+     * This property will not be updatable starting runtime version 45.
+     *
      * @default true
      */
     frame: boolean;
@@ -10388,6 +10463,9 @@ declare namespace OpenFin_2 {
         ServeAssetOptions,
         ServedAssetInfo,
         ResolvedDomainSettings,
+        InteropClientEvent,
+        ClientChangedContextGroup,
+        InteropClientEvents,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -14926,6 +15004,11 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
     /**
      * Returns a unique identifier (UUID) provided by the machine.
      *
+     * On Windows, the machine ID is the `MachineGuid` value located in the Windows Registry at:
+     * `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Cryptography`.
+     *
+     * On macOS, the machine ID is the hardware UUID of the machine, obtained via native OS APIs.
+     *
      * @example
      * ```js
      * fin.System.getMachineId().then(id => console.log(id)).catch(err => console.log(err));
@@ -17478,6 +17561,7 @@ declare namespace ViewEvents {
         HotkeyEvent,
         ShownEvent,
         HostContextChangedEvent,
+        ViewOptionsChangedEvent,
         Event_4 as Event,
         ViewEvent,
         WillPropagateViewEvent,
@@ -17606,6 +17690,23 @@ declare class ViewModule extends Base {
  */
 declare type ViewOptions = ConstViewOptions & MutableViewOptions;
 
+/**
+ * Generated whenever a view's options are changed.
+ * @remarks Will not emit if an updateOptions call does not result in a new diff.
+ * @interface
+ */
+declare type ViewOptionsChangedEvent = BaseEvent_4 & {
+    type: 'options-changed';
+    /**
+     * The new state of the view's options.
+     */
+    options: OpenFin_2.ViewOptions;
+    /**
+     * Diff between the previous value of options and new.
+     */
+    diff: OpenFin_2.ViewOptions;
+};
+
 /**
  * @interface
  */

package/out/mock-beta.d.ts

@@ -1421,29 +1421,26 @@ declare type ApplicationWindowInfo = {
 };
 
 /**
- * `appLogLevel` allows the verbosity of app logs that are collected for a Window or View to be controlled  when the app logging feature is enabled for its application.
+ * The `appLogLevel` option allows the verbosity of app logs that are collected for a Window or View to be controlled for its application.
  *
- * Please note, `enableAppLogging` must be specified in the application manifest's `platform` or `startup_app` key for this feature to be activated.
- *
- * If not specified, and `enableAppLogging` is true for the application, the default level will be 'silent'.
- *
- * This setting can also be specified in a Domain Setting Rule, allowing per url exceptions to the default behavior to be made. Please note, when a domain setting is actively
- * controlling a url's appLogLevel, its options will be ignored.
+ * This setting can also be specified in a Domain Setting Rule, allowing per url overrides to be defined. Please note, when a domain setting is actively
+ * controlling a url's appLogLevel, its view/window options will be ignored.
  *
  * @default 'debug'
  *
+ * Please note, if the manifest setting `platform.enableAppLogging`  or `startup_app.enableAppLogging` is set to `false`, this feature will be disabled.
+ *
  * @example Controlling App Logs With DefaultViewOptions + Domain Settings
  *
  * In this example manifest, we use `defaultViewOptions to set the default verbosity to 'warn'.
  *
- * We also use domain settings to suppress logs entirely for an example URL, and to lower verbosity to 'debug' for another.
+ * We also use domain settings to suppress logs for an example URL, and to lower verbosity to 'debug' for another.
  *
  * ```ts
  * {
  *   <rest of settings>
  *   "platform": {
  *      <rest of settings>
- *     "enableAppLogging": "true",
  *     "defaultViewOptions": {
  *       "appLogLevel": "warn"
  *     },
@@ -3132,6 +3129,25 @@ declare type ClickedMenuResult<Data extends unknown = unknown> = {
     data: Data;
 };
 
+/**
+ * client-changed-context-group is emitted whenever a client connected to the same InteropBroker
+ * (including the current client) change or leave a context group.
+ */
+declare type ClientChangedContextGroup = InteropClientEvent<'client-changed-context-group', {
+    /**
+     * The identity of the affected InteropClient
+     */
+    identity: ClientIdentity;
+    /**
+     * The new context group id, or null if removed from a group.
+     */
+    contextGroupId: string | null;
+    /**
+     * The previous context group id, or null if none exists.
+     */
+    previousContextGroupId: string | null;
+}>;
+
 /**
  * @interface
  */
@@ -3678,6 +3694,12 @@ declare type ConstViewOptions = {
      * Control which options to ignore when creating a Platform View.
      */
     excludeOptions: ExcludeOptions;
+    /**
+     * Determines whether window.open calls from web contents should use the specified target name as provided, or automatically generate a unique name.
+     * When true, each call generates a new unique target name, ensuring a new window is always created.
+     * When false, the target name passed to window.open is respected.
+     */
+    ignoreChildFrameName?: boolean;
 };
 
 /**
@@ -3945,6 +3967,12 @@ declare type ConstWindowOptions = {
      * Controls whether frameless window should have rounded corners. Default is false for Windows and true for MacOS. Setting this property to false will prevent the window from being fullscreenable on macOS. On Windows versions older than Windows 11 Build 22000 this property has no effect, and frameless windows will not have rounded corners.
      */
     roundedCorners: boolean;
+    /**
+     * Determines whether window.open calls from web contents should use the specified target name as provided, or automatically generate a unique name.
+     * When true, each call generates a new unique target name, ensuring a new window is always created.
+     * When false, the target name passed to window.open is respected.
+     */
+    ignoreChildFrameName?: boolean;
     /**
      * Configuration for download bubble UI.
      */
@@ -5139,7 +5167,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
  */
 declare type Event_4 = (WebContentsEvents.Event<'view'> & {
     target: OpenFin_2.Identity;
-}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent;
+}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent | ViewOptionsChangedEvent;
 
 /**
  *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
@@ -6282,7 +6310,28 @@ declare type Hotkey = {
      */
     keys: string;
     /**
-     * Prevent default key handling before emitting the event.
+     * Controls the event phase at which the hotkey is triggered.
+     *
+     * - `'capture'`: The hotkey fires **before** the event is sent to the renderer/page.
+     * This is the only phase where the `preventDefault` property is effective.
+     *
+     * - `'bubble'`: The hotkey fires **after** the page has processed the key event.
+     * This behaves exactly like a standard JavaScript event listener attached to the window:
+     * 1. If the page calls `event.preventDefault()` (on either **keydown** or **keyup**), this hotkey will **not** fire.
+     * 2. If the hotkey is browser-reserved (e.g. `Ctrl+Tab` to switch tabs for which keyup/keydown do not fire in a web browser), that action takes precedence and this hotkey will **not** fire.
+     *
+     * @default 'capture'
+     */
+    phase?: 'capture' | 'bubble';
+    /**
+     * Determines if the event should continue to the renderer.
+     *
+     * - `true`: The event is consumed immediately. It will **never** reach the renderer/page.
+     * - `false`: The event is sent to the renderer after this hotkey executes.
+     *
+     * @remarks
+     * This property is **only valid** when `phase` is set to `'capture'`.
+     * If `phase` is `'bubble'`, this property is ignored (as the renderer has already received and processed the event).
      *
      * @default false
      */
@@ -7336,6 +7385,20 @@ declare type InteropBrokerOptions = {
 declare class InteropClient extends Base {
     #private;
     /* Excluded from this release type: __constructor */
+    /**
+     * `addListener` allows the InteropClient to subscribe to events emitted by the connected InteropBroker.
+     * @param type The event type to subscribe to.
+     * @param listener Callback invoked whenever the event occurs.
+     * @returns Promise resolving with void once the listener is registered.
+     */
+    addListener: (type: OpenFin_2.InteropClientEvents['type'], listener: (event: OpenFin_2.InteropClientEvents['event']) => void) => Promise<void>;
+    /**
+     * `removeListener` removes a registered event listener.
+     * @param type The event type to subscribe to.
+     * @param listener Callback to be removed.
+     * @returns Promise resolving with void even if no callback was found.
+     */
+    removeListener: (type: OpenFin_2.InteropClientEvents['type'], listener: (event: OpenFin_2.InteropClientEvents['event']) => void) => Promise<void>;
     /**
      * Sets a context for the context group of the current entity.
      *
@@ -7705,6 +7768,16 @@ declare class InteropClient extends Base {
     /* Excluded from this release type: ferryFdc3Call */
 }
 
+/**
+ * Interop Client Events
+ */
+declare type InteropClientEvent<TName, TEventType = void> = {
+    type: TName;
+    event: TEventType;
+};
+
+declare type InteropClientEvents = ClientChangedContextGroup;
+
 /**
  * @interface
  */
@@ -9496,10 +9569,12 @@ declare type MutableWindowOptions = {
      */
     customData: any;
     /**
-     * @deprecated Will be removed in runtime version 45
      *
      * Show the window's frame.
      *
+     * @remarks
+     * This property will not be updatable starting runtime version 45.
+     *
      * @default true
      */
     frame: boolean;
@@ -10388,6 +10463,9 @@ declare namespace OpenFin_2 {
         ServeAssetOptions,
         ServedAssetInfo,
         ResolvedDomainSettings,
+        InteropClientEvent,
+        ClientChangedContextGroup,
+        InteropClientEvents,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -14926,6 +15004,11 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
     /**
      * Returns a unique identifier (UUID) provided by the machine.
      *
+     * On Windows, the machine ID is the `MachineGuid` value located in the Windows Registry at:
+     * `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Cryptography`.
+     *
+     * On macOS, the machine ID is the hardware UUID of the machine, obtained via native OS APIs.
+     *
      * @example
      * ```js
      * fin.System.getMachineId().then(id => console.log(id)).catch(err => console.log(err));
@@ -17478,6 +17561,7 @@ declare namespace ViewEvents {
         HotkeyEvent,
         ShownEvent,
         HostContextChangedEvent,
+        ViewOptionsChangedEvent,
         Event_4 as Event,
         ViewEvent,
         WillPropagateViewEvent,
@@ -17606,6 +17690,23 @@ declare class ViewModule extends Base {
  */
 declare type ViewOptions = ConstViewOptions & MutableViewOptions;
 
+/**
+ * Generated whenever a view's options are changed.
+ * @remarks Will not emit if an updateOptions call does not result in a new diff.
+ * @interface
+ */
+declare type ViewOptionsChangedEvent = BaseEvent_4 & {
+    type: 'options-changed';
+    /**
+     * The new state of the view's options.
+     */
+    options: OpenFin_2.ViewOptions;
+    /**
+     * Diff between the previous value of options and new.
+     */
+    diff: OpenFin_2.ViewOptions;
+};
+
 /**
  * @interface
  */