@openfin/fdc3-api 43.101.4 → 43.102.1

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

@@ -3126,6 +3126,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
  */
@@ -5145,7 +5164,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
  */
 declare type Event_4 = (WebContentsEvents.Event<'view'> & {
     target: OpenFin.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
@@ -7708,6 +7727,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.InteropClientEvents['type'], listener: (event: OpenFin.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.InteropClientEvents['type'], listener: (event: OpenFin.InteropClientEvents['event']) => void) => Promise<void>;
     /**
      * Sets a context for the context group of the current entity.
      *
@@ -8077,6 +8110,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
  */
@@ -10762,6 +10805,9 @@ declare namespace OpenFin {
         ServeAssetOptions,
         ServedAssetInfo,
         ResolvedDomainSettings,
+        InteropClientEvent,
+        ClientChangedContextGroup,
+        InteropClientEvents,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -15298,6 +15344,11 @@ declare class System extends EmitterBase<OpenFin.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));
@@ -17956,6 +18007,7 @@ declare namespace ViewEvents {
         HotkeyEvent,
         ShownEvent,
         HostContextChangedEvent,
+        ViewOptionsChangedEvent,
         Event_4 as Event,
         ViewEvent,
         WillPropagateViewEvent,
@@ -18084,6 +18136,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.ViewOptions;
+    /**
+     * Diff between the previous value of options and new.
+     */
+    diff: OpenFin.ViewOptions;
+};
+
 /**
  * @interface
  */

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

@@ -3126,6 +3126,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
  */
@@ -5145,7 +5164,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
  */
 declare type Event_4 = (WebContentsEvents.Event<'view'> & {
     target: OpenFin.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
@@ -7708,6 +7727,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.InteropClientEvents['type'], listener: (event: OpenFin.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.InteropClientEvents['type'], listener: (event: OpenFin.InteropClientEvents['event']) => void) => Promise<void>;
     /**
      * Sets a context for the context group of the current entity.
      *
@@ -8077,6 +8110,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
  */
@@ -10762,6 +10805,9 @@ declare namespace OpenFin {
         ServeAssetOptions,
         ServedAssetInfo,
         ResolvedDomainSettings,
+        InteropClientEvent,
+        ClientChangedContextGroup,
+        InteropClientEvents,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -15298,6 +15344,11 @@ declare class System extends EmitterBase<OpenFin.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));
@@ -17956,6 +18007,7 @@ declare namespace ViewEvents {
         HotkeyEvent,
         ShownEvent,
         HostContextChangedEvent,
+        ViewOptionsChangedEvent,
         Event_4 as Event,
         ViewEvent,
         WillPropagateViewEvent,
@@ -18084,6 +18136,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.ViewOptions;
+    /**
+     * Diff between the previous value of options and new.
+     */
+    diff: OpenFin.ViewOptions;
+};
+
 /**
  * @interface
  */

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

@@ -3126,6 +3126,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
  */
@@ -5145,7 +5164,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
  */
 declare type Event_4 = (WebContentsEvents.Event<'view'> & {
     target: OpenFin.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
@@ -7708,6 +7727,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.InteropClientEvents['type'], listener: (event: OpenFin.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.InteropClientEvents['type'], listener: (event: OpenFin.InteropClientEvents['event']) => void) => Promise<void>;
     /**
      * Sets a context for the context group of the current entity.
      *
@@ -8077,6 +8110,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
  */
@@ -10762,6 +10805,9 @@ declare namespace OpenFin {
         ServeAssetOptions,
         ServedAssetInfo,
         ResolvedDomainSettings,
+        InteropClientEvent,
+        ClientChangedContextGroup,
+        InteropClientEvents,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -15298,6 +15344,11 @@ declare class System extends EmitterBase<OpenFin.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));
@@ -17956,6 +18007,7 @@ declare namespace ViewEvents {
         HotkeyEvent,
         ShownEvent,
         HostContextChangedEvent,
+        ViewOptionsChangedEvent,
         Event_4 as Event,
         ViewEvent,
         WillPropagateViewEvent,
@@ -18084,6 +18136,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.ViewOptions;
+    /**
+     * Diff between the previous value of options and new.
+     */
+    diff: OpenFin.ViewOptions;
+};
+
 /**
  * @interface
  */

package/out/fdc3-api.d.ts

@@ -3182,6 +3182,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
  */
@@ -5209,7 +5228,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
  */
 declare type Event_4 = (WebContentsEvents.Event<'view'> & {
     target: OpenFin.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
@@ -7820,6 +7839,20 @@ declare class InteropClient extends Base {
      * @internal
      */
     constructor(wire: Transport, clientPromise: Promise<OpenFin.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.InteropClientEvents['type'], listener: (event: OpenFin.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.InteropClientEvents['type'], listener: (event: OpenFin.InteropClientEvents['event']) => void) => Promise<void>;
     /**
      * Sets a context for the context group of the current entity.
      *
@@ -8194,6 +8227,16 @@ declare class InteropClient extends Base {
     static ferryFdc3Call(interopClient: OpenFin.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
  */
@@ -11096,6 +11139,9 @@ declare namespace OpenFin {
         ServeAssetOptions,
         ServedAssetInfo,
         ResolvedDomainSettings,
+        InteropClientEvent,
+        ClientChangedContextGroup,
+        InteropClientEvents,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -15721,6 +15767,11 @@ declare class System extends EmitterBase<OpenFin.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));
@@ -18423,6 +18474,7 @@ declare namespace ViewEvents {
         HotkeyEvent,
         ShownEvent,
         HostContextChangedEvent,
+        ViewOptionsChangedEvent,
         Event_4 as Event,
         ViewEvent,
         WillPropagateViewEvent,
@@ -18551,6 +18603,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.ViewOptions;
+    /**
+     * Diff between the previous value of options and new.
+     */
+    diff: OpenFin.ViewOptions;
+};
+
 /**
  * @interface
  */

package/out/fdc3-api.js

@@ -495,13 +495,13 @@ var InteropClient$1 = {};
 
 var base = {};
 
-var __classPrivateFieldSet$3 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+var __classPrivateFieldSet$4 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
     if (kind === "m") throw new TypeError("Private method is not writable");
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var __classPrivateFieldGet$3 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+var __classPrivateFieldGet$4 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldGet) || function (receiver, state, kind, f) {
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
@@ -585,9 +585,9 @@ class EmitterBase extends Base {
         this.emit = (eventType, payload, ...args) => {
             return this.hasEmitter() ? this.getOrCreateEmitter().emit(eventType, payload, ...args) : false;
         };
-        this.hasEmitter = () => this.wire.eventAggregator.has(__classPrivateFieldGet$3(this, _EmitterBase_emitterAccessor, "f"));
+        this.hasEmitter = () => this.wire.eventAggregator.has(__classPrivateFieldGet$4(this, _EmitterBase_emitterAccessor, "f"));
         this.getOrCreateEmitter = () => {
-            return this.wire.eventAggregator.getOrCreate(__classPrivateFieldGet$3(this, _EmitterBase_emitterAccessor, "f"));
+            return this.wire.eventAggregator.getOrCreate(__classPrivateFieldGet$4(this, _EmitterBase_emitterAccessor, "f"));
         };
         this.listeners = (type) => this.hasEmitter() ? this.getOrCreateEmitter().listeners(type) : [];
         this.listenerCount = (type) => this.hasEmitter() ? this.getOrCreateEmitter().listenerCount(type) : 0;
@@ -625,8 +625,8 @@ class EmitterBase extends Base {
             // This will only be reached if unsubscribe from event that does not exist but do not want to error here
             return Promise.resolve();
         };
-        __classPrivateFieldSet$3(this, _EmitterBase_emitterAccessor, [topic, ...additionalAccessors], "f");
-        __classPrivateFieldSet$3(this, _EmitterBase_deregisterOnceListeners, new WeakMap(), "f");
+        __classPrivateFieldSet$4(this, _EmitterBase_emitterAccessor, [topic, ...additionalAccessors], "f");
+        __classPrivateFieldSet$4(this, _EmitterBase_deregisterOnceListeners, new WeakMap(), "f");
     }
     /**
      * Adds a listener to the end of the listeners array for the specified event.
@@ -654,7 +654,7 @@ class EmitterBase extends Base {
      */
     async once(eventType, listener, options) {
         const deregister = () => this.deregisterEventListener(eventType);
-        __classPrivateFieldGet$3(this, _EmitterBase_deregisterOnceListeners, "f").set(listener, deregister);
+        __classPrivateFieldGet$4(this, _EmitterBase_deregisterOnceListeners, "f").set(listener, deregister);
         await this.registerEventListener(eventType, options, (emitter) => {
             emitter.once(eventType, deregister);
             emitter.once(eventType, listener);
@@ -685,7 +685,7 @@ class EmitterBase extends Base {
      */
     async prependOnceListener(eventType, listener, options) {
         const deregister = () => this.deregisterEventListener(eventType);
-        __classPrivateFieldGet$3(this, _EmitterBase_deregisterOnceListeners, "f").set(listener, deregister);
+        __classPrivateFieldGet$4(this, _EmitterBase_deregisterOnceListeners, "f").set(listener, deregister);
         await this.registerEventListener(eventType, options, (emitter) => {
             emitter.prependOnceListener(eventType, listener);
             emitter.once(eventType, deregister);
@@ -704,7 +704,7 @@ class EmitterBase extends Base {
         const emitter = await this.deregisterEventListener(eventType, options);
         if (emitter) {
             emitter.removeListener(eventType, listener);
-            const deregister = __classPrivateFieldGet$3(this, _EmitterBase_deregisterOnceListeners, "f").get(listener);
+            const deregister = __classPrivateFieldGet$4(this, _EmitterBase_deregisterOnceListeners, "f").get(listener);
             if (deregister) {
                 emitter.removeListener(eventType, deregister);
             }
@@ -750,7 +750,7 @@ class EmitterBase extends Base {
     deleteEmitterIfNothingRegistered(emitter) {
         // TODO: maybe emitterMap should clean up itself..
         if (emitter.eventNames().length === 0) {
-            this.wire.eventAggregator.delete(__classPrivateFieldGet$3(this, _EmitterBase_emitterAccessor, "f"));
+            this.wire.eventAggregator.delete(__classPrivateFieldGet$4(this, _EmitterBase_emitterAccessor, "f"));
         }
     }
 }
@@ -762,13 +762,13 @@ base.Reply = Reply;
 
 var SessionContextGroupClient$1 = {};
 
-var __classPrivateFieldSet$2 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+var __classPrivateFieldSet$3 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
     if (kind === "m") throw new TypeError("Private method is not writable");
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var __classPrivateFieldGet$2 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+var __classPrivateFieldGet$3 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldGet) || function (receiver, state, kind, f) {
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
@@ -782,7 +782,7 @@ class SessionContextGroupClient extends base_1$1.Base {
         super(wire);
         _SessionContextGroupClient_clientPromise.set(this, void 0);
         this.id = id;
-        __classPrivateFieldSet$2(this, _SessionContextGroupClient_clientPromise, client, "f");
+        __classPrivateFieldSet$3(this, _SessionContextGroupClient_clientPromise, client, "f");
     }
     /**
      * Sets a context for the session context group.
@@ -794,7 +794,7 @@ class SessionContextGroupClient extends base_1$1.Base {
         this.wire.sendAction('interop-session-context-group-set-context').catch((e) => {
             // don't expose, analytics-only call
         });
-        const client = await __classPrivateFieldGet$2(this, _SessionContextGroupClient_clientPromise, "f");
+        const client = await __classPrivateFieldGet$3(this, _SessionContextGroupClient_clientPromise, "f");
         return client.dispatch(`sessionContextGroup:setContext-${this.id}`, {
             sessionContextGroupId: this.id,
             context
@@ -804,7 +804,7 @@ class SessionContextGroupClient extends base_1$1.Base {
         this.wire.sendAction('interop-session-context-group-get-context').catch((e) => {
             // don't expose, analytics-only call
         });
-        const client = await __classPrivateFieldGet$2(this, _SessionContextGroupClient_clientPromise, "f");
+        const client = await __classPrivateFieldGet$3(this, _SessionContextGroupClient_clientPromise, "f");
         return client.dispatch(`sessionContextGroup:getContext-${this.id}`, {
             sessionContextGroupId: this.id,
             type
@@ -817,7 +817,7 @@ class SessionContextGroupClient extends base_1$1.Base {
         if (typeof contextHandler !== 'function') {
             throw new Error("Non-function argument passed to the first parameter 'handler'. Be aware that the argument order does not match the FDC3 standard.");
         }
-        const client = await __classPrivateFieldGet$2(this, _SessionContextGroupClient_clientPromise, "f");
+        const client = await __classPrivateFieldGet$3(this, _SessionContextGroupClient_clientPromise, "f");
         let handlerId;
         if (contextType) {
             handlerId = `sessionContextHandler:invoke-${this.id}-${contextType}-${(0, utils_1$4.generateId)()}`;
@@ -830,7 +830,7 @@ class SessionContextGroupClient extends base_1$1.Base {
         return { unsubscribe: await this.createUnsubscribeCb(handlerId) };
     }
     async createUnsubscribeCb(handlerId) {
-        const client = await __classPrivateFieldGet$2(this, _SessionContextGroupClient_clientPromise, "f");
+        const client = await __classPrivateFieldGet$3(this, _SessionContextGroupClient_clientPromise, "f");
         return async () => {
             client.remove(handlerId);
             await client.dispatch(`sessionContextGroup:handlerRemoved-${this.id}`, { handlerId });
@@ -848,6 +848,139 @@ class SessionContextGroupClient extends base_1$1.Base {
 SessionContextGroupClient$1.default = SessionContextGroupClient;
 _SessionContextGroupClient_clientPromise = new WeakMap();
 
+var channelEvents = {};
+
+var __classPrivateFieldSet$2 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet$2 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _a, _ChannelEvents_channelClient, _ChannelEvents_isChannelReady, _ChannelEvents_actionsByClient, _ChannelEvents_getActions, _ChannelEvents_createRegistration, _ChannelEvents_getRegistration, _ChannelEvents_getOrCreateRegistration;
+Object.defineProperty(channelEvents, "__esModule", { value: true });
+channelEvents.ChannelEvents = void 0;
+/**
+ * Channel events creates a event like syntax out of a channel action, allowing multiple events to be triggered
+ * from a single action (normally only one callback can be created per action).
+ *
+ * This Class essentially allows us to multiplex channel actions to multiple callbacks.
+ */
+class ChannelEvents {
+    constructor(channelClient) {
+        // eslint-disable-next-line
+        _ChannelEvents_channelClient.set(this, void 0);
+        _ChannelEvents_isChannelReady.set(this, false);
+        _ChannelEvents_getActions.set(this, async () => {
+            const channelClient = await __classPrivateFieldGet$2(this, _ChannelEvents_channelClient, "f");
+            let actions = __classPrivateFieldGet$2(ChannelEvents, _a, "f", _ChannelEvents_actionsByClient).get(channelClient);
+            if (!actions) {
+                actions = {};
+                __classPrivateFieldGet$2(ChannelEvents, _a, "f", _ChannelEvents_actionsByClient).set(channelClient, actions);
+            }
+            return actions;
+        });
+        _ChannelEvents_createRegistration.set(this, (actionId) => {
+            const callbacks = [];
+            let registrationPromise;
+            const onChannelAction = (data) => {
+                callbacks.forEach((callback) => callback(data));
+            };
+            return {
+                callbacks,
+                dispose: async (callback) => {
+                    const index = callbacks.indexOf(callback);
+                    if (index >= 0) {
+                        callbacks.splice(index, 1);
+                        if (callbacks.length === 0) {
+                            const client = await __classPrivateFieldGet$2(this, _ChannelEvents_channelClient, "f");
+                            client.remove(actionId);
+                        }
+                    }
+                },
+                waitForRegistration: async () => {
+                    // Use lazy eval to only setup and register the channel on first attempt.
+                    if (!registrationPromise) {
+                        registrationPromise = (async () => {
+                            const client = await __classPrivateFieldGet$2(this, _ChannelEvents_channelClient, "f");
+                            await client.register(actionId, onChannelAction);
+                        })();
+                    }
+                    await registrationPromise;
+                }
+            };
+        });
+        _ChannelEvents_getRegistration.set(this, async (actionId) => {
+            const actions = await __classPrivateFieldGet$2(this, _ChannelEvents_getActions, "f").call(this);
+            return actions[actionId];
+        });
+        _ChannelEvents_getOrCreateRegistration.set(this, async (actionId) => {
+            const actions = await __classPrivateFieldGet$2(this, _ChannelEvents_getActions, "f").call(this);
+            const registration = await __classPrivateFieldGet$2(this, _ChannelEvents_getRegistration, "f").call(this, actionId);
+            if (!registration) {
+                actions[actionId] = __classPrivateFieldGet$2(this, _ChannelEvents_createRegistration, "f").call(this, actionId);
+            }
+            return actions[actionId];
+        });
+        /**
+         * Add a listener for the given channel action.
+         *
+         * This will register a handler for the specified channel action if this is the first time we have requested one, or reuse an existing one if it exists.
+         *
+         * Note, only void channel actions are currently supported.
+         *
+         * @param action Action ID, must match the underlying channel action.
+         * @param callback Callback to be called whenever the action is dispatched.
+         */
+        this.addListener = async (action, callback) => {
+            const event = await __classPrivateFieldGet$2(this, _ChannelEvents_getOrCreateRegistration, "f").call(this, action);
+            event.callbacks.push(callback);
+            // This ensures we only resolve the subscription once the action is registered
+            await event.waitForRegistration();
+        };
+        /**
+         * Removes a callback associated with a given action if it exists.
+         *
+         * If this callback is the last one associated with the specified action, the underlying channel action registration is
+         * also removed.
+         * @param action Action ID to remove
+         * @param callback Callback to remove.
+         */
+        this.removeListener = async (action, callback) => {
+            if (!__classPrivateFieldGet$2(this, _ChannelEvents_isChannelReady, "f")) {
+                return;
+            }
+            const registration = await __classPrivateFieldGet$2(this, _ChannelEvents_getRegistration, "f").call(this, action);
+            if (registration) {
+                const event = await __classPrivateFieldGet$2(this, _ChannelEvents_getOrCreateRegistration, "f").call(this, action);
+                await event.dispose(callback);
+            }
+        };
+        __classPrivateFieldSet$2(this, _ChannelEvents_channelClient, channelClient, "f");
+        Promise.resolve(channelClient)
+            .then(() => {
+            __classPrivateFieldSet$2(this, _ChannelEvents_isChannelReady, true, "f");
+        })
+            .catch(() => {
+            // eslint-disable-next-line
+            console.warn('Channel Connection error occurred in channel client. Channel-events registrations will fail.');
+        });
+    }
+}
+channelEvents.ChannelEvents = ChannelEvents;
+_a = ChannelEvents, _ChannelEvents_channelClient = new WeakMap(), _ChannelEvents_isChannelReady = new WeakMap(), _ChannelEvents_getActions = new WeakMap(), _ChannelEvents_createRegistration = new WeakMap(), _ChannelEvents_getRegistration = new WeakMap(), _ChannelEvents_getOrCreateRegistration = new WeakMap();
+/**
+ * Static map of actions by channel client. This ensures we can reuse the same event and keep track of all its callbacks.
+ *
+ * Weak map will also ensure that when a channel is GC'ed we also tear down the actions/callbacks associated
+ * with it.
+ */
+_ChannelEvents_actionsByClient = { value: new WeakMap() };
+
 var __classPrivateFieldSet$1 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
     if (kind === "m") throw new TypeError("Private method is not writable");
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
@@ -862,12 +995,13 @@ var __classPrivateFieldGet$1 = (commonjsGlobal && commonjsGlobal.__classPrivateF
 var __importDefault$1 = (commonjsGlobal && commonjsGlobal.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _InteropClient_clientPromise, _InteropClient_sessionContextGroups, _InteropClient_fdc3Factory;
+var _InteropClient_clientPromise, _InteropClient_sessionContextGroups, _InteropClient_fdc3Factory, _InteropClient_channelEvents;
 Object.defineProperty(InteropClient$1, "__esModule", { value: true });
 InteropClient$1.InteropClient = void 0;
 const base_1 = base;
 const SessionContextGroupClient_1 = __importDefault$1(SessionContextGroupClient$1);
 const utils_1$3 = utils$2;
+const channel_events_1 = channelEvents;
 /**
  * The Interop Client API is broken up into two groups:
  *
@@ -926,13 +1060,43 @@ class InteropClient extends base_1.Base {
         _InteropClient_clientPromise.set(this, void 0);
         _InteropClient_sessionContextGroups.set(this, void 0);
         _InteropClient_fdc3Factory.set(this, void 0);
+        _InteropClient_channelEvents.set(this, void 0);
+        /*
+        Client APIs
+        */
+        /**
+         * `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.
+         */
+        this.addListener = async (type, listener) => {
+            try {
+                await __classPrivateFieldGet$1(this, _InteropClient_channelEvents, "f").addListener(type, listener);
+            }
+            catch (error) {
+                throw new Error(`An unexpected error occurred when adding a listener to the event ${type}. \n${error.stack}.`);
+            }
+        };
+        /**
+         * `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.
+         */
+        this.removeListener = async (type, listener) => {
+            try {
+                await __classPrivateFieldGet$1(this, _InteropClient_channelEvents, "f").removeListener(type, listener);
+            }
+            catch (error) {
+                throw new Error(`An unexpected error occurred when removing a listener for the event ${type}. \n${error.stack}.`);
+            }
+        };
         __classPrivateFieldSet$1(this, _InteropClient_sessionContextGroups, new Map(), "f");
         __classPrivateFieldSet$1(this, _InteropClient_clientPromise, clientPromise, "f");
         __classPrivateFieldSet$1(this, _InteropClient_fdc3Factory, fdc3Factory, "f");
+        __classPrivateFieldSet$1(this, _InteropClient_channelEvents, new channel_events_1.ChannelEvents(clientPromise), "f");
     }
-    /*
-    Client APIs
-    */
     /**
      * Sets a context for the context group of the current entity.
      *
@@ -1446,7 +1610,7 @@ class InteropClient extends base_1.Base {
     }
 }
 InteropClient$1.InteropClient = InteropClient;
-_InteropClient_clientPromise = new WeakMap(), _InteropClient_sessionContextGroups = new WeakMap(), _InteropClient_fdc3Factory = new WeakMap();
+_InteropClient_clientPromise = new WeakMap(), _InteropClient_sessionContextGroups = new WeakMap(), _InteropClient_fdc3Factory = new WeakMap(), _InteropClient_channelEvents = new WeakMap();
 
 var __classPrivateFieldGet = (commonjsGlobal && commonjsGlobal.__classPrivateFieldGet) || function (receiver, state, kind, f) {
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");

package/package.json

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