@openfin/core 34.78.15 → 34.78.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -867,7 +867,7 @@ declare type ApplicationEvent = {
867
867
  topic: 'application';
868
868
  } & (PropagatedViewEvent | PropagatedWindowEvent | ApplicationWindowEvent | WillPropagateApplicationEvent);
869
869
 
870
- declare type ApplicationEvent_2 = ApplicationEvents.ApplicationEvent;
870
+ declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
871
871
 
872
872
  declare namespace ApplicationEvents {
873
873
  export {
@@ -1626,7 +1626,7 @@ declare type BaseEvent = {
1626
1626
  type: string;
1627
1627
  };
1628
1628
 
1629
- declare type BaseEvent_2 = BaseEvents.BaseEvent;
1629
+ declare type BaseEvent_2 = Events.BaseEvents.BaseEvent;
1630
1630
 
1631
1631
  declare namespace BaseEvents {
1632
1632
  export {
@@ -3874,9 +3874,7 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
3874
3874
  protected identity: ApplicationIdentity;
3875
3875
  constructor(wire: Transport, topic: string, ...additionalAccessors: string[]);
3876
3876
  eventNames: () => (string | symbol)[];
3877
- emit: <EventType extends EmitterEventType>(eventType: EventType, payload: Extract<EmitterEvent, {
3878
- type: EventType;
3879
- }>, ...args: any[]) => boolean;
3877
+ /* Excluded from this release type: emit */
3880
3878
  private hasEmitter;
3881
3879
  private getOrCreateEmitter;
3882
3880
  listeners: (type: string | symbol) => Function[];
@@ -3885,6 +3883,8 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
3885
3883
  protected deregisterEventListener: (eventType: EmitterEventType, options?: OpenFin_2.SubscriptionOptions) => Promise<void | EventEmitter>;
3886
3884
  /**
3887
3885
  * Adds a listener to the end of the listeners array for the specified event.
3886
+ *
3887
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
3888
3888
  */
3889
3889
  on<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3890
3890
  /**
@@ -3893,15 +3893,21 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
3893
3893
  addListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3894
3894
  /**
3895
3895
  * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
3896
+ *
3897
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
3896
3898
  */
3897
3899
  once<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3898
3900
  /**
3899
3901
  * Adds a listener to the beginning of the listeners array for the specified event.
3902
+ *
3903
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
3900
3904
  */
3901
3905
  prependListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3902
3906
  /**
3903
3907
  * Adds a one time listener for the event. The listener is invoked only the first time the event is fired,
3904
3908
  * after which it is removed. The listener is added to the beginning of the listeners array.
3909
+ *
3910
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
3905
3911
  */
3906
3912
  prependOnceListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3907
3913
  /**
@@ -4060,6 +4066,21 @@ declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends stri
4060
4066
  type: EventType;
4061
4067
  }>, ...args: any[]) => void;
4062
4068
 
4069
+ declare namespace Events {
4070
+ export {
4071
+ ApplicationEvents,
4072
+ BaseEvents,
4073
+ ExternalApplicationEvents,
4074
+ FrameEvents,
4075
+ GlobalHotkeyEvents,
4076
+ PlatformEvents,
4077
+ SystemEvents,
4078
+ ViewEvents,
4079
+ WebContentsEvents,
4080
+ WindowEvents
4081
+ }
4082
+ }
4083
+
4063
4084
  /* Excluded from this release type: EventWithId */
4064
4085
 
4065
4086
  /* Excluded from this release type: ExcludeRequested */
@@ -4207,7 +4228,7 @@ declare type ExternalApplicationEvent = {
4207
4228
  topic: 'externalapplication';
4208
4229
  } & (ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent);
4209
4230
 
4210
- declare type ExternalApplicationEvent_2 = ExternalApplicationEvents.ExternalApplicationEvent;
4231
+ declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
4211
4232
 
4212
4233
  declare namespace ExternalApplicationEvents {
4213
4234
  export {
@@ -4702,7 +4723,7 @@ declare type FrameEvent = {
4702
4723
  topic: 'frame';
4703
4724
  } & (FrameConnectedEvent | FrameDisconnectedEvent);
4704
4725
 
4705
- declare type FrameEvent_2 = FrameEvents.FrameEvent;
4726
+ declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
4706
4727
 
4707
4728
  declare namespace FrameEvents {
4708
4729
  export {
@@ -4945,7 +4966,7 @@ declare type GlobalHotkeyEvent = {
4945
4966
  hotkey: 'string';
4946
4967
  } & (RegisteredEvent | UnregisteredEvent);
4947
4968
 
4948
- declare type GlobalHotkeyEvent_2 = GlobalHotkeyEvents.GlobalHotkeyEvent;
4969
+ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
4949
4970
 
4950
4971
  declare namespace GlobalHotkeyEvents {
4951
4972
  export {
@@ -8161,6 +8182,7 @@ declare namespace OpenFin_2 {
8161
8182
  ExternalApplicationModule,
8162
8183
  _Frame as Frame,
8163
8184
  _FrameModule,
8185
+ GlobalHotkey,
8164
8186
  Channel,
8165
8187
  ChannelClient,
8166
8188
  ChannelProvider,
@@ -8179,6 +8201,7 @@ declare namespace OpenFin_2 {
8179
8201
  InteropModule,
8180
8202
  SnapshotSource,
8181
8203
  SnapshotSourceModule,
8204
+ System,
8182
8205
  LayoutEntityDefinition,
8183
8206
  LayoutEntityTypes,
8184
8207
  LayoutPosition,
@@ -8430,16 +8453,7 @@ declare namespace OpenFin_2 {
8430
8453
  AppVersionErrorEvent,
8431
8454
  AppVersionCompleteEvent,
8432
8455
  AppVersionRuntimeStatusEvent,
8433
- BaseEvents,
8434
- WebContentsEvents,
8435
- SystemEvents,
8436
- ApplicationEvents,
8437
- WindowEvents,
8438
- ViewEvents,
8439
- GlobalHotkeyEvents,
8440
- FrameEvents,
8441
- PlatformEvents,
8442
- ExternalApplicationEvents,
8456
+ Events,
8443
8457
  BaseEvent_2 as BaseEvent,
8444
8458
  WebContentsEvent_2 as WebContentsEvent,
8445
8459
  SystemEvent_2 as SystemEvent,
@@ -8464,7 +8478,17 @@ declare namespace OpenFin_2 {
8464
8478
  ChannelClientConnectionListener,
8465
8479
  ChannelClientDisconnectionListener,
8466
8480
  ChannelProviderDisconnectionListener,
8467
- RoutingInfo
8481
+ RoutingInfo,
8482
+ ApplicationEvents,
8483
+ BaseEvents,
8484
+ ExternalApplicationEvents,
8485
+ FrameEvents,
8486
+ GlobalHotkeyEvents,
8487
+ PlatformEvents,
8488
+ SystemEvents,
8489
+ ViewEvents,
8490
+ WebContentsEvents,
8491
+ WindowEvents
8468
8492
  }
8469
8493
  }
8470
8494
  export default OpenFin_2;
@@ -8521,10 +8545,8 @@ declare type PickOfType<T extends Record<any, any>, TTarget> = {
8521
8545
 
8522
8546
  /** Manages the life cycle of windows and views in the application.
8523
8547
  *
8524
- * Enables taking snapshots of itself and applyi
8525
- * ng them to restore a previous configuration
8548
+ * Enables taking snapshots of itself and applying them to restore a previous configuration
8526
8549
  * as well as listen to {@link OpenFin.PlatformEvents platform events}.
8527
- *
8528
8550
  */
8529
8551
  declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
8530
8552
  #private;
@@ -9153,7 +9175,7 @@ declare type PlatformApiReadyEvent = BaseEvent & {
9153
9175
  */
9154
9176
  declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
9155
9177
 
9156
- declare type PlatformEvent_2 = PlatformEvents.PlatformEvent;
9178
+ declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
9157
9179
 
9158
9180
  declare namespace PlatformEvents {
9159
9181
  export {
@@ -12900,7 +12922,7 @@ declare type SystemEvent = {
12900
12922
  topic: 'system';
12901
12923
  } & (ExcludeRequested<PropagatedWindowEvent> | PropagatedViewEvent | PropagatedApplicationEvent | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent);
12902
12924
 
12903
- declare type SystemEvent_2 = SystemEvents.SystemEvent;
12925
+ declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
12904
12926
 
12905
12927
  declare namespace SystemEvents {
12906
12928
  export {
@@ -14035,7 +14057,7 @@ declare type ViewEvent = {
14035
14057
  topic: 'view';
14036
14058
  } & (NonPropagatedViewEvent | WillPropagateViewEvent);
14037
14059
 
14038
- declare type ViewEvent_2 = ViewEvents.ViewEvent;
14060
+ declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
14039
14061
 
14040
14062
  declare namespace ViewEvents {
14041
14063
  export {
@@ -15236,7 +15258,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
15236
15258
  */
15237
15259
  declare type WebContentsEvent = NonPropagatedWebContentsEvent | WillPropagateWebContentsEvent;
15238
15260
 
15239
- declare type WebContentsEvent_2 = WebContentsEvents.WebContentsEvent;
15261
+ declare type WebContentsEvent_2 = Events.WebContentsEvents.WebContentsEvent;
15240
15262
 
15241
15263
  declare namespace WebContentsEvents {
15242
15264
  export {
@@ -16993,7 +17015,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16993
17015
  topic: 'window';
16994
17016
  } & (WillPropagateWindowEvent | NonPropagatedWindowEvent | PropagatedViewEvent);
16995
17017
 
16996
- declare type WindowEvent_2 = WindowEvents.WindowEvent;
17018
+ declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
16997
17019
 
16998
17020
  declare namespace WindowEvents {
16999
17021
  export {
@@ -867,7 +867,7 @@ declare type ApplicationEvent = {
867
867
  topic: 'application';
868
868
  } & (PropagatedViewEvent | PropagatedWindowEvent | ApplicationWindowEvent | WillPropagateApplicationEvent);
869
869
 
870
- declare type ApplicationEvent_2 = ApplicationEvents.ApplicationEvent;
870
+ declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
871
871
 
872
872
  declare namespace ApplicationEvents {
873
873
  export {
@@ -1626,7 +1626,7 @@ declare type BaseEvent = {
1626
1626
  type: string;
1627
1627
  };
1628
1628
 
1629
- declare type BaseEvent_2 = BaseEvents.BaseEvent;
1629
+ declare type BaseEvent_2 = Events.BaseEvents.BaseEvent;
1630
1630
 
1631
1631
  declare namespace BaseEvents {
1632
1632
  export {
@@ -3874,9 +3874,7 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
3874
3874
  protected identity: ApplicationIdentity;
3875
3875
  constructor(wire: Transport, topic: string, ...additionalAccessors: string[]);
3876
3876
  eventNames: () => (string | symbol)[];
3877
- emit: <EventType extends EmitterEventType>(eventType: EventType, payload: Extract<EmitterEvent, {
3878
- type: EventType;
3879
- }>, ...args: any[]) => boolean;
3877
+ /* Excluded from this release type: emit */
3880
3878
  private hasEmitter;
3881
3879
  private getOrCreateEmitter;
3882
3880
  listeners: (type: string | symbol) => Function[];
@@ -3885,6 +3883,8 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
3885
3883
  protected deregisterEventListener: (eventType: EmitterEventType, options?: OpenFin_2.SubscriptionOptions) => Promise<void | EventEmitter>;
3886
3884
  /**
3887
3885
  * Adds a listener to the end of the listeners array for the specified event.
3886
+ *
3887
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
3888
3888
  */
3889
3889
  on<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3890
3890
  /**
@@ -3893,15 +3893,21 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
3893
3893
  addListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3894
3894
  /**
3895
3895
  * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
3896
+ *
3897
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
3896
3898
  */
3897
3899
  once<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3898
3900
  /**
3899
3901
  * Adds a listener to the beginning of the listeners array for the specified event.
3902
+ *
3903
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
3900
3904
  */
3901
3905
  prependListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3902
3906
  /**
3903
3907
  * Adds a one time listener for the event. The listener is invoked only the first time the event is fired,
3904
3908
  * after which it is removed. The listener is added to the beginning of the listeners array.
3909
+ *
3910
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
3905
3911
  */
3906
3912
  prependOnceListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3907
3913
  /**
@@ -4060,6 +4066,21 @@ declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends stri
4060
4066
  type: EventType;
4061
4067
  }>, ...args: any[]) => void;
4062
4068
 
4069
+ declare namespace Events {
4070
+ export {
4071
+ ApplicationEvents,
4072
+ BaseEvents,
4073
+ ExternalApplicationEvents,
4074
+ FrameEvents,
4075
+ GlobalHotkeyEvents,
4076
+ PlatformEvents,
4077
+ SystemEvents,
4078
+ ViewEvents,
4079
+ WebContentsEvents,
4080
+ WindowEvents
4081
+ }
4082
+ }
4083
+
4063
4084
  /* Excluded from this release type: EventWithId */
4064
4085
 
4065
4086
  /* Excluded from this release type: ExcludeRequested */
@@ -4207,7 +4228,7 @@ declare type ExternalApplicationEvent = {
4207
4228
  topic: 'externalapplication';
4208
4229
  } & (ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent);
4209
4230
 
4210
- declare type ExternalApplicationEvent_2 = ExternalApplicationEvents.ExternalApplicationEvent;
4231
+ declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
4211
4232
 
4212
4233
  declare namespace ExternalApplicationEvents {
4213
4234
  export {
@@ -4702,7 +4723,7 @@ declare type FrameEvent = {
4702
4723
  topic: 'frame';
4703
4724
  } & (FrameConnectedEvent | FrameDisconnectedEvent);
4704
4725
 
4705
- declare type FrameEvent_2 = FrameEvents.FrameEvent;
4726
+ declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
4706
4727
 
4707
4728
  declare namespace FrameEvents {
4708
4729
  export {
@@ -4945,7 +4966,7 @@ declare type GlobalHotkeyEvent = {
4945
4966
  hotkey: 'string';
4946
4967
  } & (RegisteredEvent | UnregisteredEvent);
4947
4968
 
4948
- declare type GlobalHotkeyEvent_2 = GlobalHotkeyEvents.GlobalHotkeyEvent;
4969
+ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
4949
4970
 
4950
4971
  declare namespace GlobalHotkeyEvents {
4951
4972
  export {
@@ -8161,6 +8182,7 @@ declare namespace OpenFin_2 {
8161
8182
  ExternalApplicationModule,
8162
8183
  _Frame as Frame,
8163
8184
  _FrameModule,
8185
+ GlobalHotkey,
8164
8186
  Channel,
8165
8187
  ChannelClient,
8166
8188
  ChannelProvider,
@@ -8179,6 +8201,7 @@ declare namespace OpenFin_2 {
8179
8201
  InteropModule,
8180
8202
  SnapshotSource,
8181
8203
  SnapshotSourceModule,
8204
+ System,
8182
8205
  LayoutEntityDefinition,
8183
8206
  LayoutEntityTypes,
8184
8207
  LayoutPosition,
@@ -8430,16 +8453,7 @@ declare namespace OpenFin_2 {
8430
8453
  AppVersionErrorEvent,
8431
8454
  AppVersionCompleteEvent,
8432
8455
  AppVersionRuntimeStatusEvent,
8433
- BaseEvents,
8434
- WebContentsEvents,
8435
- SystemEvents,
8436
- ApplicationEvents,
8437
- WindowEvents,
8438
- ViewEvents,
8439
- GlobalHotkeyEvents,
8440
- FrameEvents,
8441
- PlatformEvents,
8442
- ExternalApplicationEvents,
8456
+ Events,
8443
8457
  BaseEvent_2 as BaseEvent,
8444
8458
  WebContentsEvent_2 as WebContentsEvent,
8445
8459
  SystemEvent_2 as SystemEvent,
@@ -8464,7 +8478,17 @@ declare namespace OpenFin_2 {
8464
8478
  ChannelClientConnectionListener,
8465
8479
  ChannelClientDisconnectionListener,
8466
8480
  ChannelProviderDisconnectionListener,
8467
- RoutingInfo
8481
+ RoutingInfo,
8482
+ ApplicationEvents,
8483
+ BaseEvents,
8484
+ ExternalApplicationEvents,
8485
+ FrameEvents,
8486
+ GlobalHotkeyEvents,
8487
+ PlatformEvents,
8488
+ SystemEvents,
8489
+ ViewEvents,
8490
+ WebContentsEvents,
8491
+ WindowEvents
8468
8492
  }
8469
8493
  }
8470
8494
  export default OpenFin_2;
@@ -8521,10 +8545,8 @@ declare type PickOfType<T extends Record<any, any>, TTarget> = {
8521
8545
 
8522
8546
  /** Manages the life cycle of windows and views in the application.
8523
8547
  *
8524
- * Enables taking snapshots of itself and applyi
8525
- * ng them to restore a previous configuration
8548
+ * Enables taking snapshots of itself and applying them to restore a previous configuration
8526
8549
  * as well as listen to {@link OpenFin.PlatformEvents platform events}.
8527
- *
8528
8550
  */
8529
8551
  declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
8530
8552
  #private;
@@ -9153,7 +9175,7 @@ declare type PlatformApiReadyEvent = BaseEvent & {
9153
9175
  */
9154
9176
  declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
9155
9177
 
9156
- declare type PlatformEvent_2 = PlatformEvents.PlatformEvent;
9178
+ declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
9157
9179
 
9158
9180
  declare namespace PlatformEvents {
9159
9181
  export {
@@ -12900,7 +12922,7 @@ declare type SystemEvent = {
12900
12922
  topic: 'system';
12901
12923
  } & (ExcludeRequested<PropagatedWindowEvent> | PropagatedViewEvent | PropagatedApplicationEvent | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent);
12902
12924
 
12903
- declare type SystemEvent_2 = SystemEvents.SystemEvent;
12925
+ declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
12904
12926
 
12905
12927
  declare namespace SystemEvents {
12906
12928
  export {
@@ -14035,7 +14057,7 @@ declare type ViewEvent = {
14035
14057
  topic: 'view';
14036
14058
  } & (NonPropagatedViewEvent | WillPropagateViewEvent);
14037
14059
 
14038
- declare type ViewEvent_2 = ViewEvents.ViewEvent;
14060
+ declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
14039
14061
 
14040
14062
  declare namespace ViewEvents {
14041
14063
  export {
@@ -15236,7 +15258,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
15236
15258
  */
15237
15259
  declare type WebContentsEvent = NonPropagatedWebContentsEvent | WillPropagateWebContentsEvent;
15238
15260
 
15239
- declare type WebContentsEvent_2 = WebContentsEvents.WebContentsEvent;
15261
+ declare type WebContentsEvent_2 = Events.WebContentsEvents.WebContentsEvent;
15240
15262
 
15241
15263
  declare namespace WebContentsEvents {
15242
15264
  export {
@@ -16993,7 +17015,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16993
17015
  topic: 'window';
16994
17016
  } & (WillPropagateWindowEvent | NonPropagatedWindowEvent | PropagatedViewEvent);
16995
17017
 
16996
- declare type WindowEvent_2 = WindowEvents.WindowEvent;
17018
+ declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
16997
17019
 
16998
17020
  declare namespace WindowEvents {
16999
17021
  export {
@@ -867,7 +867,7 @@ declare type ApplicationEvent = {
867
867
  topic: 'application';
868
868
  } & (PropagatedViewEvent | PropagatedWindowEvent | ApplicationWindowEvent | WillPropagateApplicationEvent);
869
869
 
870
- declare type ApplicationEvent_2 = ApplicationEvents.ApplicationEvent;
870
+ declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
871
871
 
872
872
  declare namespace ApplicationEvents {
873
873
  export {
@@ -1626,7 +1626,7 @@ declare type BaseEvent = {
1626
1626
  type: string;
1627
1627
  };
1628
1628
 
1629
- declare type BaseEvent_2 = BaseEvents.BaseEvent;
1629
+ declare type BaseEvent_2 = Events.BaseEvents.BaseEvent;
1630
1630
 
1631
1631
  declare namespace BaseEvents {
1632
1632
  export {
@@ -3874,9 +3874,7 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
3874
3874
  protected identity: ApplicationIdentity;
3875
3875
  constructor(wire: Transport, topic: string, ...additionalAccessors: string[]);
3876
3876
  eventNames: () => (string | symbol)[];
3877
- emit: <EventType extends EmitterEventType>(eventType: EventType, payload: Extract<EmitterEvent, {
3878
- type: EventType;
3879
- }>, ...args: any[]) => boolean;
3877
+ /* Excluded from this release type: emit */
3880
3878
  private hasEmitter;
3881
3879
  private getOrCreateEmitter;
3882
3880
  listeners: (type: string | symbol) => Function[];
@@ -3885,6 +3883,8 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
3885
3883
  protected deregisterEventListener: (eventType: EmitterEventType, options?: OpenFin_2.SubscriptionOptions) => Promise<void | EventEmitter>;
3886
3884
  /**
3887
3885
  * Adds a listener to the end of the listeners array for the specified event.
3886
+ *
3887
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
3888
3888
  */
3889
3889
  on<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3890
3890
  /**
@@ -3893,15 +3893,21 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
3893
3893
  addListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3894
3894
  /**
3895
3895
  * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
3896
+ *
3897
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
3896
3898
  */
3897
3899
  once<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3898
3900
  /**
3899
3901
  * Adds a listener to the beginning of the listeners array for the specified event.
3902
+ *
3903
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
3900
3904
  */
3901
3905
  prependListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3902
3906
  /**
3903
3907
  * Adds a one time listener for the event. The listener is invoked only the first time the event is fired,
3904
3908
  * after which it is removed. The listener is added to the beginning of the listeners array.
3909
+ *
3910
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
3905
3911
  */
3906
3912
  prependOnceListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3907
3913
  /**
@@ -4060,6 +4066,21 @@ declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends stri
4060
4066
  type: EventType;
4061
4067
  }>, ...args: any[]) => void;
4062
4068
 
4069
+ declare namespace Events {
4070
+ export {
4071
+ ApplicationEvents,
4072
+ BaseEvents,
4073
+ ExternalApplicationEvents,
4074
+ FrameEvents,
4075
+ GlobalHotkeyEvents,
4076
+ PlatformEvents,
4077
+ SystemEvents,
4078
+ ViewEvents,
4079
+ WebContentsEvents,
4080
+ WindowEvents
4081
+ }
4082
+ }
4083
+
4063
4084
  /* Excluded from this release type: EventWithId */
4064
4085
 
4065
4086
  /* Excluded from this release type: ExcludeRequested */
@@ -4207,7 +4228,7 @@ declare type ExternalApplicationEvent = {
4207
4228
  topic: 'externalapplication';
4208
4229
  } & (ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent);
4209
4230
 
4210
- declare type ExternalApplicationEvent_2 = ExternalApplicationEvents.ExternalApplicationEvent;
4231
+ declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
4211
4232
 
4212
4233
  declare namespace ExternalApplicationEvents {
4213
4234
  export {
@@ -4702,7 +4723,7 @@ declare type FrameEvent = {
4702
4723
  topic: 'frame';
4703
4724
  } & (FrameConnectedEvent | FrameDisconnectedEvent);
4704
4725
 
4705
- declare type FrameEvent_2 = FrameEvents.FrameEvent;
4726
+ declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
4706
4727
 
4707
4728
  declare namespace FrameEvents {
4708
4729
  export {
@@ -4945,7 +4966,7 @@ declare type GlobalHotkeyEvent = {
4945
4966
  hotkey: 'string';
4946
4967
  } & (RegisteredEvent | UnregisteredEvent);
4947
4968
 
4948
- declare type GlobalHotkeyEvent_2 = GlobalHotkeyEvents.GlobalHotkeyEvent;
4969
+ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
4949
4970
 
4950
4971
  declare namespace GlobalHotkeyEvents {
4951
4972
  export {
@@ -8161,6 +8182,7 @@ declare namespace OpenFin_2 {
8161
8182
  ExternalApplicationModule,
8162
8183
  _Frame as Frame,
8163
8184
  _FrameModule,
8185
+ GlobalHotkey,
8164
8186
  Channel,
8165
8187
  ChannelClient,
8166
8188
  ChannelProvider,
@@ -8179,6 +8201,7 @@ declare namespace OpenFin_2 {
8179
8201
  InteropModule,
8180
8202
  SnapshotSource,
8181
8203
  SnapshotSourceModule,
8204
+ System,
8182
8205
  LayoutEntityDefinition,
8183
8206
  LayoutEntityTypes,
8184
8207
  LayoutPosition,
@@ -8430,16 +8453,7 @@ declare namespace OpenFin_2 {
8430
8453
  AppVersionErrorEvent,
8431
8454
  AppVersionCompleteEvent,
8432
8455
  AppVersionRuntimeStatusEvent,
8433
- BaseEvents,
8434
- WebContentsEvents,
8435
- SystemEvents,
8436
- ApplicationEvents,
8437
- WindowEvents,
8438
- ViewEvents,
8439
- GlobalHotkeyEvents,
8440
- FrameEvents,
8441
- PlatformEvents,
8442
- ExternalApplicationEvents,
8456
+ Events,
8443
8457
  BaseEvent_2 as BaseEvent,
8444
8458
  WebContentsEvent_2 as WebContentsEvent,
8445
8459
  SystemEvent_2 as SystemEvent,
@@ -8464,7 +8478,17 @@ declare namespace OpenFin_2 {
8464
8478
  ChannelClientConnectionListener,
8465
8479
  ChannelClientDisconnectionListener,
8466
8480
  ChannelProviderDisconnectionListener,
8467
- RoutingInfo
8481
+ RoutingInfo,
8482
+ ApplicationEvents,
8483
+ BaseEvents,
8484
+ ExternalApplicationEvents,
8485
+ FrameEvents,
8486
+ GlobalHotkeyEvents,
8487
+ PlatformEvents,
8488
+ SystemEvents,
8489
+ ViewEvents,
8490
+ WebContentsEvents,
8491
+ WindowEvents
8468
8492
  }
8469
8493
  }
8470
8494
  export default OpenFin_2;
@@ -8521,10 +8545,8 @@ declare type PickOfType<T extends Record<any, any>, TTarget> = {
8521
8545
 
8522
8546
  /** Manages the life cycle of windows and views in the application.
8523
8547
  *
8524
- * Enables taking snapshots of itself and applyi
8525
- * ng them to restore a previous configuration
8548
+ * Enables taking snapshots of itself and applying them to restore a previous configuration
8526
8549
  * as well as listen to {@link OpenFin.PlatformEvents platform events}.
8527
- *
8528
8550
  */
8529
8551
  declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
8530
8552
  #private;
@@ -9153,7 +9175,7 @@ declare type PlatformApiReadyEvent = BaseEvent & {
9153
9175
  */
9154
9176
  declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
9155
9177
 
9156
- declare type PlatformEvent_2 = PlatformEvents.PlatformEvent;
9178
+ declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
9157
9179
 
9158
9180
  declare namespace PlatformEvents {
9159
9181
  export {
@@ -12900,7 +12922,7 @@ declare type SystemEvent = {
12900
12922
  topic: 'system';
12901
12923
  } & (ExcludeRequested<PropagatedWindowEvent> | PropagatedViewEvent | PropagatedApplicationEvent | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent);
12902
12924
 
12903
- declare type SystemEvent_2 = SystemEvents.SystemEvent;
12925
+ declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
12904
12926
 
12905
12927
  declare namespace SystemEvents {
12906
12928
  export {
@@ -14035,7 +14057,7 @@ declare type ViewEvent = {
14035
14057
  topic: 'view';
14036
14058
  } & (NonPropagatedViewEvent | WillPropagateViewEvent);
14037
14059
 
14038
- declare type ViewEvent_2 = ViewEvents.ViewEvent;
14060
+ declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
14039
14061
 
14040
14062
  declare namespace ViewEvents {
14041
14063
  export {
@@ -15236,7 +15258,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
15236
15258
  */
15237
15259
  declare type WebContentsEvent = NonPropagatedWebContentsEvent | WillPropagateWebContentsEvent;
15238
15260
 
15239
- declare type WebContentsEvent_2 = WebContentsEvents.WebContentsEvent;
15261
+ declare type WebContentsEvent_2 = Events.WebContentsEvents.WebContentsEvent;
15240
15262
 
15241
15263
  declare namespace WebContentsEvents {
15242
15264
  export {
@@ -16993,7 +17015,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16993
17015
  topic: 'window';
16994
17016
  } & (WillPropagateWindowEvent | NonPropagatedWindowEvent | PropagatedViewEvent);
16995
17017
 
16996
- declare type WindowEvent_2 = WindowEvents.WindowEvent;
17018
+ declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
16997
17019
 
16998
17020
  declare namespace WindowEvents {
16999
17021
  export {
package/out/mock.d.ts CHANGED
@@ -873,7 +873,7 @@ declare type ApplicationEvent = {
873
873
  topic: 'application';
874
874
  } & (PropagatedViewEvent | PropagatedWindowEvent | ApplicationWindowEvent | WillPropagateApplicationEvent);
875
875
 
876
- declare type ApplicationEvent_2 = ApplicationEvents.ApplicationEvent;
876
+ declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
877
877
 
878
878
  declare namespace ApplicationEvents {
879
879
  export {
@@ -1646,7 +1646,7 @@ declare type BaseEvent = {
1646
1646
  type: string;
1647
1647
  };
1648
1648
 
1649
- declare type BaseEvent_2 = BaseEvents.BaseEvent;
1649
+ declare type BaseEvent_2 = Events.BaseEvents.BaseEvent;
1650
1650
 
1651
1651
  declare namespace BaseEvents {
1652
1652
  export {
@@ -3968,6 +3968,9 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
3968
3968
  protected identity: ApplicationIdentity;
3969
3969
  constructor(wire: Transport, topic: string, ...additionalAccessors: string[]);
3970
3970
  eventNames: () => (string | symbol)[];
3971
+ /**
3972
+ * @internal
3973
+ */
3971
3974
  emit: <EventType extends EmitterEventType>(eventType: EventType, payload: Extract<EmitterEvent, {
3972
3975
  type: EventType;
3973
3976
  }>, ...args: any[]) => boolean;
@@ -3979,6 +3982,8 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
3979
3982
  protected deregisterEventListener: (eventType: EmitterEventType, options?: OpenFin_2.SubscriptionOptions) => Promise<void | EventEmitter>;
3980
3983
  /**
3981
3984
  * Adds a listener to the end of the listeners array for the specified event.
3985
+ *
3986
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
3982
3987
  */
3983
3988
  on<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3984
3989
  /**
@@ -3987,15 +3992,21 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
3987
3992
  addListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3988
3993
  /**
3989
3994
  * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
3995
+ *
3996
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
3990
3997
  */
3991
3998
  once<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3992
3999
  /**
3993
4000
  * Adds a listener to the beginning of the listeners array for the specified event.
4001
+ *
4002
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
3994
4003
  */
3995
4004
  prependListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
3996
4005
  /**
3997
4006
  * Adds a one time listener for the event. The listener is invoked only the first time the event is fired,
3998
4007
  * after which it is removed. The listener is added to the beginning of the listeners array.
4008
+ *
4009
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
3999
4010
  */
4000
4011
  prependOnceListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
4001
4012
  /**
@@ -4154,6 +4165,21 @@ declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends stri
4154
4165
  type: EventType;
4155
4166
  }>, ...args: any[]) => void;
4156
4167
 
4168
+ declare namespace Events {
4169
+ export {
4170
+ ApplicationEvents,
4171
+ BaseEvents,
4172
+ ExternalApplicationEvents,
4173
+ FrameEvents,
4174
+ GlobalHotkeyEvents,
4175
+ PlatformEvents,
4176
+ SystemEvents,
4177
+ ViewEvents,
4178
+ WebContentsEvents,
4179
+ WindowEvents
4180
+ }
4181
+ }
4182
+
4157
4183
  /**
4158
4184
  * @internal
4159
4185
  */
@@ -4320,7 +4346,7 @@ declare type ExternalApplicationEvent = {
4320
4346
  topic: 'externalapplication';
4321
4347
  } & (ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent);
4322
4348
 
4323
- declare type ExternalApplicationEvent_2 = ExternalApplicationEvents.ExternalApplicationEvent;
4349
+ declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
4324
4350
 
4325
4351
  declare namespace ExternalApplicationEvents {
4326
4352
  export {
@@ -4818,7 +4844,7 @@ declare type FrameEvent = {
4818
4844
  topic: 'frame';
4819
4845
  } & (FrameConnectedEvent | FrameDisconnectedEvent);
4820
4846
 
4821
- declare type FrameEvent_2 = FrameEvents.FrameEvent;
4847
+ declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
4822
4848
 
4823
4849
  declare namespace FrameEvents {
4824
4850
  export {
@@ -5064,7 +5090,7 @@ declare type GlobalHotkeyEvent = {
5064
5090
  hotkey: 'string';
5065
5091
  } & (RegisteredEvent | UnregisteredEvent);
5066
5092
 
5067
- declare type GlobalHotkeyEvent_2 = GlobalHotkeyEvents.GlobalHotkeyEvent;
5093
+ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
5068
5094
 
5069
5095
  declare namespace GlobalHotkeyEvents {
5070
5096
  export {
@@ -8593,6 +8619,7 @@ declare namespace OpenFin_2 {
8593
8619
  ExternalApplicationModule,
8594
8620
  _Frame as Frame,
8595
8621
  _FrameModule,
8622
+ GlobalHotkey,
8596
8623
  Channel,
8597
8624
  ChannelClient,
8598
8625
  ChannelProvider,
@@ -8611,6 +8638,7 @@ declare namespace OpenFin_2 {
8611
8638
  InteropModule,
8612
8639
  SnapshotSource,
8613
8640
  SnapshotSourceModule,
8641
+ System,
8614
8642
  LayoutEntityDefinition,
8615
8643
  LayoutEntityTypes,
8616
8644
  LayoutPosition,
@@ -8862,16 +8890,7 @@ declare namespace OpenFin_2 {
8862
8890
  AppVersionErrorEvent,
8863
8891
  AppVersionCompleteEvent,
8864
8892
  AppVersionRuntimeStatusEvent,
8865
- BaseEvents,
8866
- WebContentsEvents,
8867
- SystemEvents,
8868
- ApplicationEvents,
8869
- WindowEvents,
8870
- ViewEvents,
8871
- GlobalHotkeyEvents,
8872
- FrameEvents,
8873
- PlatformEvents,
8874
- ExternalApplicationEvents,
8893
+ Events,
8875
8894
  BaseEvent_2 as BaseEvent,
8876
8895
  WebContentsEvent_2 as WebContentsEvent,
8877
8896
  SystemEvent_2 as SystemEvent,
@@ -8896,7 +8915,17 @@ declare namespace OpenFin_2 {
8896
8915
  ChannelClientConnectionListener,
8897
8916
  ChannelClientDisconnectionListener,
8898
8917
  ChannelProviderDisconnectionListener,
8899
- RoutingInfo
8918
+ RoutingInfo,
8919
+ ApplicationEvents,
8920
+ BaseEvents,
8921
+ ExternalApplicationEvents,
8922
+ FrameEvents,
8923
+ GlobalHotkeyEvents,
8924
+ PlatformEvents,
8925
+ SystemEvents,
8926
+ ViewEvents,
8927
+ WebContentsEvents,
8928
+ WindowEvents
8900
8929
  }
8901
8930
  }
8902
8931
  export default OpenFin_2;
@@ -8953,10 +8982,8 @@ declare type PickOfType<T extends Record<any, any>, TTarget> = {
8953
8982
 
8954
8983
  /** Manages the life cycle of windows and views in the application.
8955
8984
  *
8956
- * Enables taking snapshots of itself and applyi
8957
- * ng them to restore a previous configuration
8985
+ * Enables taking snapshots of itself and applying them to restore a previous configuration
8958
8986
  * as well as listen to {@link OpenFin.PlatformEvents platform events}.
8959
- *
8960
8987
  */
8961
8988
  declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
8962
8989
  #private;
@@ -9615,7 +9642,7 @@ declare type PlatformApiReadyEvent = BaseEvent & {
9615
9642
  */
9616
9643
  declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
9617
9644
 
9618
- declare type PlatformEvent_2 = PlatformEvents.PlatformEvent;
9645
+ declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
9619
9646
 
9620
9647
  declare namespace PlatformEvents {
9621
9648
  export {
@@ -13407,7 +13434,7 @@ declare type SystemEvent = {
13407
13434
  topic: 'system';
13408
13435
  } & (ExcludeRequested<PropagatedWindowEvent> | PropagatedViewEvent | PropagatedApplicationEvent | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent);
13409
13436
 
13410
- declare type SystemEvent_2 = SystemEvents.SystemEvent;
13437
+ declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
13411
13438
 
13412
13439
  declare namespace SystemEvents {
13413
13440
  export {
@@ -14636,7 +14663,7 @@ declare type ViewEvent = {
14636
14663
  topic: 'view';
14637
14664
  } & (NonPropagatedViewEvent | WillPropagateViewEvent);
14638
14665
 
14639
- declare type ViewEvent_2 = ViewEvents.ViewEvent;
14666
+ declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
14640
14667
 
14641
14668
  declare namespace ViewEvents {
14642
14669
  export {
@@ -15837,7 +15864,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
15837
15864
  */
15838
15865
  declare type WebContentsEvent = NonPropagatedWebContentsEvent | WillPropagateWebContentsEvent;
15839
15866
 
15840
- declare type WebContentsEvent_2 = WebContentsEvents.WebContentsEvent;
15867
+ declare type WebContentsEvent_2 = Events.WebContentsEvents.WebContentsEvent;
15841
15868
 
15842
15869
  declare namespace WebContentsEvents {
15843
15870
  export {
@@ -17678,7 +17705,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
17678
17705
  topic: 'window';
17679
17706
  } & (WillPropagateWindowEvent | NonPropagatedWindowEvent | PropagatedViewEvent);
17680
17707
 
17681
- declare type WindowEvent_2 = WindowEvents.WindowEvent;
17708
+ declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
17682
17709
 
17683
17710
  declare namespace WindowEvents {
17684
17711
  export {
package/out/mock.js CHANGED
@@ -11,18 +11,240 @@ var mock = {};
11
11
 
12
12
  var OpenFin$1 = {};
13
13
 
14
+ var events = {};
15
+
16
+ var application$1 = {};
17
+
18
+ /**
19
+ * Namespace for events that can be emitted by an {@link OpenFin.Application}. Includes events
20
+ * re-propagated from the {@link OpenFin.Window} (and, transitively, {@link OpenFin.View}) level, prefixed with `window-` (and also, if applicable, `view-`).
21
+ * For example, a view's "attached" event will fire as 'window-view-attached' at the application level.
22
+ *
23
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
24
+ *
25
+ * This namespace contains only payload shapes for events that are unique to `Application`. Events that propagate to `Application` from
26
+ * child {@link OpenFin.Window windows} and {@link OpenFin.View views} are defined in the {@link OpenFin.WindowEvents} and
27
+ * {@link OpenFin.ViewEvents} namespaces. For a list of valid string keys for *all* application events, see {@link Application.on Application.on}.
28
+ *
29
+ * {@link WillPropagateApplicationEvent Bespoke application events} re-propagate to the system level, prefixed with `application-`. For example,
30
+ * the `closed` event will fire as `application-closed` at the system level. Propagated events from {@link PropagatedWindowEvent windows}
31
+ * and {@link PropagatedViewEvent views} within an application will *not* transitively re-propagate to the system level, because they are already
32
+ * visible at the system level and contain the identity of the application.
33
+ *
34
+ * @packageDocumentation
35
+ */
36
+ Object.defineProperty(application$1, "__esModule", { value: true });
37
+
38
+ var base$1 = {};
39
+
40
+ Object.defineProperty(base$1, "__esModule", { value: true });
41
+
42
+ var externalApplication$1 = {};
43
+
44
+ /**
45
+ * Namespace for events that can be transmitted by an {@link OpenFin.ExternalApplication}.
46
+ *
47
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
48
+ *
49
+ * For a list of valid string keys for external application events, see {@link ExternalApplication.on ExternalApplication.on}.
50
+ *
51
+ * @packageDocumentation
52
+ */
53
+ Object.defineProperty(externalApplication$1, "__esModule", { value: true });
54
+
55
+ var frame$1 = {};
56
+
57
+ Object.defineProperty(frame$1, "__esModule", { value: true });
58
+
59
+ var globalHotkey$1 = {};
60
+
61
+ Object.defineProperty(globalHotkey$1, "__esModule", { value: true });
62
+
63
+ var platform$1 = {};
64
+
65
+ /**
66
+ *
67
+ * Namespace for events that can emitted by a {@link OpenFin.Platform}.
68
+ *
69
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
70
+ *
71
+ * The Platform `EventEmitter` is a superset of the {@link OpenFin.Application} `EventEmitter`,
72
+ * meaning it can listen to all {@link OpenFin.ApplicationEvents Application events} in addition to the
73
+ * Platform-specific events listed here. For a list of valid string keys for *all* platform events, see
74
+ * {@link Platform.on Platform.on}.
75
+ *
76
+ * @packageDocumentation
77
+ */
78
+ Object.defineProperty(platform$1, "__esModule", { value: true });
79
+
80
+ var system$1 = {};
81
+
14
82
  /**
15
- * Top-level namespace for types referenced by the OpenFin API. Contains:
83
+ * Namespace for runtime-wide OpenFin events emitted by {@link System.System}. Includes events
84
+ * re-propagated from {@link OpenFin.Application}, {@link OpenFin.Window}, and {@link OpenFin.View} (prefixed with `application-`, `window-`, and `view-`). All
85
+ * event propagations are visible at the System level. Propagated events from WebContents (windows, views, frames) to the Application level will *not*
86
+ * transitively re-propagate to the System level, because they are already visible at the system level and contain the identity
87
+ * of the application. For example, an application's "closed" event will fire as 'application-closed' at the system level. A view's 'shown' event
88
+ * will be visible as 'view-shown' at the system level, but *not* as `application-window-view-shown`.
16
89
  *
17
- * * The type of the global `fin` entry point ({@link FinApi})
18
- * * Classes that act as static namespaces returned from the `fin` global (e.g. {@link ApplicationModule}, accessible via `fin.Application`)
19
- * * Instance classes that are returned from API calls (e.g. {@link Application}, accessible via `fin.Application.getCurrentSync()`)
20
- * * Parameter shapes for API methods (e.g. {@link ApplicationOptions}, used in `fin.Application.start()`)
21
- * * Event namespaces and payload union types (e.g. {@link ApplicationEvents} and {@link ApplicationEvent})
90
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
91
+ *
92
+ * This namespace contains only payload shapes for events that are unique to `System`. Events that propagate to `System` from
93
+ * child {@link OpenFin.Application applications}, {@link OpenFin.Window windows}, and {@link OpenFin.View views} are defined in the
94
+ * {@link OpenFin.ApplicationEvents}, {@link OpenFin.WindowEvents}, and {@link OpenFin.ViewEvents} namespaces. For a list of valid string keys for *all*
95
+ * system events, see {@link System.on System.on}.
22
96
  *
23
97
  * @packageDocumentation
24
98
  */
25
- Object.defineProperty(OpenFin$1, "__esModule", { value: true });
99
+ Object.defineProperty(system$1, "__esModule", { value: true });
100
+
101
+ var view$1 = {};
102
+
103
+ /**
104
+ * Namespace for events that can be emitted by a {@link OpenFin.View}.
105
+ *
106
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
107
+ *
108
+ * This namespace contains only payload shapes for events that are unique to `View`. Events that are shared between all `WebContents`
109
+ * (i.e. {@link OpenFin.Window}, {@link OpenFin.View}) are defined in {@link OpenFin.WebContentsEvents}. For a list
110
+ * of valid string keys for *all* View events, see {@link View.on View.on}.
111
+ *
112
+ * View events fall into two categories: {@link WillPropagateViewEvent} and {@link NonPropagatedViewEvent}. Propagated events will
113
+ * be re-emitted on the parent {@link OpenFin.Window} of the target view, prefixed with "view-". For example,
114
+ * the "shown" event will be re-emitted on the parent window as "view-shown". Non-propagated events
115
+ * will not be re-emitted on the parent window.
116
+ *
117
+ * @packageDocumentation
118
+ */
119
+ Object.defineProperty(view$1, "__esModule", { value: true });
120
+
121
+ var webcontents = {};
122
+
123
+ /**
124
+ * Namespace for events shared by all OpenFin WebContents elements (i.e. {@link OpenFin.Window},
125
+ * {@link OpenFin.View}).
126
+ *
127
+ * WebContents events are divided into two groups: {@link WillPropagateWebContentsEvent} and {@link NonPropagatedWebContentsEvent}. Propagating events
128
+ * will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
129
+ * parent window, and propagating events in a window will also be emitted on the window's parent {@link OpenFin.Application}.
130
+ *
131
+ * Non-propagating events will not re-emit on parent entities.
132
+ *
133
+ * @packageDocumentation
134
+ */
135
+ Object.defineProperty(webcontents, "__esModule", { value: true });
136
+
137
+ var window$2 = {};
138
+
139
+ /**
140
+ *
141
+ * Namespace for events that can be emitted by a {@link OpenFin.Window}.
142
+ *
143
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
144
+ *
145
+ * This namespace contains only payload shapes for events that are unique to `Window`. Events that are shared between all `WebContents`
146
+ * (i.e. {@link OpenFin.Window}, {@link OpenFin.View}) are defined in {@link OpenFin.WebContentsEvents}. Events that
147
+ * propagate from `View` are defined in {@link OpenFin.ViewEvents}. For a list of valid string keys for *all* Window events, see
148
+ * {@link Window.on Window.on}
149
+ *
150
+ * Window events fall into two categories: {@link WillPropagateWindowEvent} and {@link NonPropagatedWindowEvent}.
151
+ * Propagated events will be re-emitted on the parent {@link OpenFin.Application} of the target window, prefixed with "window-". For example,
152
+ * a window's "reloaded" event will be re-emitted on the parent application as "window-reloaded". Non-propagated
153
+ * events will not be re-emitted on the parent application.
154
+ *
155
+ * @packageDocumentation
156
+ */
157
+ Object.defineProperty(window$2, "__esModule", { value: true });
158
+
159
+ /**
160
+ * Namespace for OpenFin event types. Each entity that emits OpenFin events has its own sub-namespace. Event payloads
161
+ * themselves are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
162
+ *
163
+ * #### Event emitters
164
+ *
165
+ * The following entities emit OpenFin events, and have corresponding sub-namespaces:
166
+ *
167
+ * * {@link OpenFin.Application}: {@link OpenFin.ApplicationEvents}
168
+ * * {@link OpenFin.ExternalApplication}: {@link OpenFin.ExternalApplicationEvents}
169
+ * * {@link OpenFin.Frame}: {@link OpenFin.FrameEvents}
170
+ * * {@link OpenFin.GlobalHotkey}: {@link OpenFin.GlobalHotkeyEvents}
171
+ * * {@link OpenFin.Platform}: {@link OpenFin.PlatformEvents}
172
+ * * {@link OpenFin.System}: {@link OpenFin.SystemEvents}
173
+ * * {@link OpenFin.View}: {@link OpenFin.ViewEvents}
174
+ * * {@link OpenFin.Window}: {@link OpenFin.WindowEvents}
175
+ *
176
+ * These `EventEmitter` entities share a common set of methods for interacting with the OpenFin event bus, which can be
177
+ * seen on the individual documentation pages for each entity type.
178
+ *
179
+ * Registering event handlers is an asynchronous operation. It is important to ensure that the returned Promises are awaited to reduce the
180
+ * risk of race conditions.
181
+ *
182
+ * When the `EventEmitter` receives an event from the browser process and emits on the renderer, all of the functions attached to that
183
+ * specific event are called synchronously. Any values returned by the called listeners are ignored and will be discarded. If the window document
184
+ * is destroyed by page navigation or reload, its registered event listeners will be removed.
185
+ *
186
+ * We recommend using Arrow Functions for event listeners to ensure the this scope is consistent with the original function context.
187
+ *
188
+ * Events re-propagate from smaller/more-local scopes to larger/more-global scopes. For example, an event emitted on a specific
189
+ * view will propagate to the window in which the view is embedded, and then to the application in which the window is running, and
190
+ * finally to the OpenFin runtime itself at the "system" level. For details on propagation semantics, see the namespace for
191
+ * the propagating (or propagated-to) entity.
192
+ *
193
+ * @packageDocumentation
194
+ */
195
+ Object.defineProperty(events, "__esModule", { value: true });
196
+ events.WindowEvents = events.WebContentsEvents = events.ViewEvents = events.SystemEvents = events.PlatformEvents = events.GlobalHotkeyEvents = events.FrameEvents = events.ExternalApplicationEvents = events.BaseEvents = events.ApplicationEvents = void 0;
197
+ const ApplicationEvents = application$1;
198
+ events.ApplicationEvents = ApplicationEvents;
199
+ const BaseEvents = base$1;
200
+ events.BaseEvents = BaseEvents;
201
+ const ExternalApplicationEvents = externalApplication$1;
202
+ events.ExternalApplicationEvents = ExternalApplicationEvents;
203
+ const FrameEvents = frame$1;
204
+ events.FrameEvents = FrameEvents;
205
+ const GlobalHotkeyEvents = globalHotkey$1;
206
+ events.GlobalHotkeyEvents = GlobalHotkeyEvents;
207
+ const PlatformEvents = platform$1;
208
+ events.PlatformEvents = PlatformEvents;
209
+ const SystemEvents = system$1;
210
+ events.SystemEvents = SystemEvents;
211
+ const ViewEvents = view$1;
212
+ events.ViewEvents = ViewEvents;
213
+ const WebContentsEvents = webcontents;
214
+ events.WebContentsEvents = WebContentsEvents;
215
+ const WindowEvents = window$2;
216
+ events.WindowEvents = WindowEvents;
217
+
218
+ (function (exports) {
219
+ /**
220
+ * Top-level namespace for types referenced by the OpenFin API. Contains:
221
+ *
222
+ * * The type of the global `fin` entry point ({@link FinApi})
223
+ * * Classes that act as static namespaces returned from the `fin` global (e.g. {@link ApplicationModule}, accessible via `fin.Application`)
224
+ * * Instance classes that are returned from API calls (e.g. {@link Application}, accessible via `fin.Application.getCurrentSync()`)
225
+ * * Parameter shapes for API methods (e.g. {@link ApplicationOptions}, used in `fin.Application.start()`)
226
+ * * Event namespaces and payload union types (e.g. {@link ApplicationEvents} and {@link ApplicationEvent})
227
+ *
228
+ * @packageDocumentation
229
+ */
230
+ var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
231
+ if (k2 === undefined) k2 = k;
232
+ var desc = Object.getOwnPropertyDescriptor(m, k);
233
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
234
+ desc = { enumerable: true, get: function() { return m[k]; } };
235
+ }
236
+ Object.defineProperty(o, k2, desc);
237
+ }) : (function(o, m, k, k2) {
238
+ if (k2 === undefined) k2 = k;
239
+ o[k2] = m[k];
240
+ }));
241
+ var __exportStar = (commonjsGlobal && commonjsGlobal.__exportStar) || function(m, exports) {
242
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
243
+ };
244
+ Object.defineProperty(exports, "__esModule", { value: true });
245
+ // Deprecated shim to preserve v30 namespace names
246
+ __exportStar(events, exports);
247
+ } (OpenFin$1));
26
248
 
27
249
  var fin = {};
28
250
 
@@ -134,6 +356,9 @@ class EmitterBase extends Base {
134
356
  this.topic = topic;
135
357
  _EmitterBase_emitterAccessor.set(this, void 0);
136
358
  this.eventNames = () => (this.hasEmitter() ? this.getOrCreateEmitter().eventNames() : []);
359
+ /**
360
+ * @internal
361
+ */
137
362
  this.emit = (eventType, payload, ...args) => {
138
363
  return this.hasEmitter() ? this.getOrCreateEmitter().emit(eventType, payload, ...args) : false;
139
364
  };
@@ -181,6 +406,8 @@ class EmitterBase extends Base {
181
406
  }
182
407
  /**
183
408
  * Adds a listener to the end of the listeners array for the specified event.
409
+ *
410
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
184
411
  */
185
412
  async on(eventType, listener, options) {
186
413
  await this.registerEventListener(eventType, options, (emitter) => {
@@ -198,6 +425,8 @@ class EmitterBase extends Base {
198
425
  }
199
426
  /**
200
427
  * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
428
+ *
429
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
201
430
  */
202
431
  async once(eventType, listener, options) {
203
432
  const deregister = () => this.deregisterEventListener(eventType);
@@ -212,6 +441,8 @@ class EmitterBase extends Base {
212
441
  }
213
442
  /**
214
443
  * Adds a listener to the beginning of the listeners array for the specified event.
444
+ *
445
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
215
446
  */
216
447
  async prependListener(eventType, listener, options) {
217
448
  await this.registerEventListener(eventType, options, (emitter) => {
@@ -224,6 +455,8 @@ class EmitterBase extends Base {
224
455
  /**
225
456
  * Adds a one time listener for the event. The listener is invoked only the first time the event is fired,
226
457
  * after which it is removed. The listener is added to the beginning of the listeners array.
458
+ *
459
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
227
460
  */
228
461
  async prependOnceListener(eventType, listener, options) {
229
462
  const deregister = () => this.deregisterEventListener(eventType);
@@ -11460,10 +11693,8 @@ const validate_1$1 = validate;
11460
11693
  const clientMap = new Map();
11461
11694
  /** Manages the life cycle of windows and views in the application.
11462
11695
  *
11463
- * Enables taking snapshots of itself and applyi
11464
- * ng them to restore a previous configuration
11696
+ * Enables taking snapshots of itself and applying them to restore a previous configuration
11465
11697
  * as well as listen to {@link OpenFin.PlatformEvents platform events}.
11466
- *
11467
11698
  */
11468
11699
  class Platform extends base_1$7.EmitterBase {
11469
11700
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "34.78.15",
3
+ "version": "34.78.17",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.MD",
6
6
  "main": "out/mock.js",