@openfin/core 43.101.2 → 43.102.1

package/out/mock-alpha.d.ts

@@ -3129,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
  */
@@ -5148,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
@@ -7366,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.
      *
@@ -7735,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
  */
@@ -10420,6 +10463,9 @@ declare namespace OpenFin_2 {
         ServeAssetOptions,
         ServedAssetInfo,
         ResolvedDomainSettings,
+        InteropClientEvent,
+        ClientChangedContextGroup,
+        InteropClientEvents,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -14958,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));
@@ -17510,6 +17561,7 @@ declare namespace ViewEvents {
         HotkeyEvent,
         ShownEvent,
         HostContextChangedEvent,
+        ViewOptionsChangedEvent,
         Event_4 as Event,
         ViewEvent,
         WillPropagateViewEvent,
@@ -17638,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

@@ -3129,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
  */
@@ -5148,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
@@ -7366,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.
      *
@@ -7735,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
  */
@@ -10420,6 +10463,9 @@ declare namespace OpenFin_2 {
         ServeAssetOptions,
         ServedAssetInfo,
         ResolvedDomainSettings,
+        InteropClientEvent,
+        ClientChangedContextGroup,
+        InteropClientEvents,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -14958,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));
@@ -17510,6 +17561,7 @@ declare namespace ViewEvents {
         HotkeyEvent,
         ShownEvent,
         HostContextChangedEvent,
+        ViewOptionsChangedEvent,
         Event_4 as Event,
         ViewEvent,
         WillPropagateViewEvent,
@@ -17638,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-public.d.ts

@@ -3129,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
  */
@@ -5148,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
@@ -7366,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.
      *
@@ -7735,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
  */
@@ -10420,6 +10463,9 @@ declare namespace OpenFin_2 {
         ServeAssetOptions,
         ServedAssetInfo,
         ResolvedDomainSettings,
+        InteropClientEvent,
+        ClientChangedContextGroup,
+        InteropClientEvents,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -14958,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));
@@ -17510,6 +17561,7 @@ declare namespace ViewEvents {
         HotkeyEvent,
         ShownEvent,
         HostContextChangedEvent,
+        ViewOptionsChangedEvent,
         Event_4 as Event,
         ViewEvent,
         WillPropagateViewEvent,
@@ -17638,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/stub.d.ts

@@ -3185,6 +3185,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
  */
@@ -5212,7 +5231,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
@@ -7478,6 +7497,20 @@ declare class InteropClient extends Base {
      * @internal
      */
     constructor(wire: Transport, clientPromise: Promise<OpenFin_2.ChannelClient>, fdc3Factory: FDC3Factory);
+    /**
+     * `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.
      *
@@ -7852,6 +7885,16 @@ declare class InteropClient extends Base {
     static ferryFdc3Call(interopClient: OpenFin_2.InteropClient, action: string, payload?: any): Promise<any>;
 }
 
+/**
+ * Interop Client Events
+ */
+declare type InteropClientEvent<TName, TEventType = void> = {
+    type: TName;
+    event: TEventType;
+};
+
+declare type InteropClientEvents = ClientChangedContextGroup;
+
 /**
  * @interface
  */
@@ -10754,6 +10797,9 @@ declare namespace OpenFin_2 {
         ServeAssetOptions,
         ServedAssetInfo,
         ResolvedDomainSettings,
+        InteropClientEvent,
+        ClientChangedContextGroup,
+        InteropClientEvents,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -15381,6 +15427,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));
@@ -17977,6 +18028,7 @@ declare namespace ViewEvents {
         HotkeyEvent,
         ShownEvent,
         HostContextChangedEvent,
+        ViewOptionsChangedEvent,
         Event_4 as Event,
         ViewEvent,
         WillPropagateViewEvent,
@@ -18105,6 +18157,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
  */