@openfin/core 33.77.6 → 33.77.8

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.
@@ -4387,7 +4387,7 @@ declare namespace ExternalApplicationEvents {
4387
4387
  }
4388
4388
 
4389
4389
  /**
4390
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
4390
+ * Union of possible `type` values for a {@link ApplicationEvent}.
4391
4391
  */
4392
4392
  declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
4393
4393
 
@@ -7261,8 +7261,7 @@ declare type LayoutInitializedEvent = BaseWindowEvent & {
7261
7261
 
7262
7262
  /**
7263
7263
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
7264
- * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
7265
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
7264
+ * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
7266
7265
  *
7267
7266
  * @interface
7268
7267
  */
@@ -7564,8 +7563,7 @@ declare type LayoutOptions = {
7564
7563
  };
7565
7564
  /**
7566
7565
  * Content of the layout. There can only be one top-level LayoutItem in the content array.
7567
- * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
7568
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
7566
+ * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
7569
7567
  */
7570
7568
  content?: LayoutContent;
7571
7569
  dimensions?: {
@@ -10613,7 +10611,7 @@ declare type PropagatedEventType<Topic extends string, Type extends string> = `$
10613
10611
 
10614
10612
  /**
10615
10613
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
10616
- * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
10614
+ * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
10617
10615
  * event type key with `'view-'`.
10618
10616
  */
10619
10617
  declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
@@ -10627,7 +10625,7 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
10627
10625
 
10628
10626
  /**
10629
10627
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
10630
- * prefixing the type string with `'window-'`. Only {@link NativeWindowEvent native window events} will propagate
10628
+ * prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
10631
10629
  * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
10632
10630
  * will *not* re-propagate.
10633
10631
  *
@@ -4387,7 +4387,7 @@ declare namespace ExternalApplicationEvents {
4387
4387
  }
4388
4388
 
4389
4389
  /**
4390
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
4390
+ * Union of possible `type` values for a {@link ApplicationEvent}.
4391
4391
  */
4392
4392
  declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
4393
4393
 
@@ -7261,8 +7261,7 @@ declare type LayoutInitializedEvent = BaseWindowEvent & {
7261
7261
 
7262
7262
  /**
7263
7263
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
7264
- * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
7265
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
7264
+ * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
7266
7265
  *
7267
7266
  * @interface
7268
7267
  */
@@ -7564,8 +7563,7 @@ declare type LayoutOptions = {
7564
7563
  };
7565
7564
  /**
7566
7565
  * Content of the layout. There can only be one top-level LayoutItem in the content array.
7567
- * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
7568
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
7566
+ * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
7569
7567
  */
7570
7568
  content?: LayoutContent;
7571
7569
  dimensions?: {
@@ -10613,7 +10611,7 @@ declare type PropagatedEventType<Topic extends string, Type extends string> = `$
10613
10611
 
10614
10612
  /**
10615
10613
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
10616
- * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
10614
+ * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
10617
10615
  * event type key with `'view-'`.
10618
10616
  */
10619
10617
  declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
@@ -10627,7 +10625,7 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
10627
10625
 
10628
10626
  /**
10629
10627
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
10630
- * prefixing the type string with `'window-'`. Only {@link NativeWindowEvent native window events} will propagate
10628
+ * prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
10631
10629
  * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
10632
10630
  * will *not* re-propagate.
10633
10631
  *
@@ -4387,7 +4387,7 @@ declare namespace ExternalApplicationEvents {
4387
4387
  }
4388
4388
 
4389
4389
  /**
4390
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
4390
+ * Union of possible `type` values for a {@link ApplicationEvent}.
4391
4391
  */
4392
4392
  declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
4393
4393
 
@@ -7261,8 +7261,7 @@ declare type LayoutInitializedEvent = BaseWindowEvent & {
7261
7261
 
7262
7262
  /**
7263
7263
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
7264
- * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
7265
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
7264
+ * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
7266
7265
  *
7267
7266
  * @interface
7268
7267
  */
@@ -7564,8 +7563,7 @@ declare type LayoutOptions = {
7564
7563
  };
7565
7564
  /**
7566
7565
  * Content of the layout. There can only be one top-level LayoutItem in the content array.
7567
- * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
7568
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
7566
+ * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
7569
7567
  */
7570
7568
  content?: LayoutContent;
7571
7569
  dimensions?: {
@@ -10613,7 +10611,7 @@ declare type PropagatedEventType<Topic extends string, Type extends string> = `$
10613
10611
 
10614
10612
  /**
10615
10613
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
10616
- * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
10614
+ * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
10617
10615
  * event type key with `'view-'`.
10618
10616
  */
10619
10617
  declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
@@ -10627,7 +10625,7 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
10627
10625
 
10628
10626
  /**
10629
10627
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
10630
- * prefixing the type string with `'window-'`. Only {@link NativeWindowEvent native window events} will propagate
10628
+ * prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
10631
10629
  * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
10632
10630
  * will *not* re-propagate.
10633
10631
  *
package/out/mock.d.ts CHANGED
@@ -4505,7 +4505,7 @@ declare namespace ExternalApplicationEvents {
4505
4505
  }
4506
4506
 
4507
4507
  /**
4508
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
4508
+ * Union of possible `type` values for a {@link ApplicationEvent}.
4509
4509
  */
4510
4510
  declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
4511
4511
 
@@ -7526,8 +7526,7 @@ declare type LayoutInitializedEvent = BaseWindowEvent & {
7526
7526
 
7527
7527
  /**
7528
7528
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
7529
- * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
7530
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
7529
+ * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
7531
7530
  *
7532
7531
  * @interface
7533
7532
  */
@@ -7990,8 +7989,7 @@ declare type LayoutOptions = {
7990
7989
  };
7991
7990
  /**
7992
7991
  * Content of the layout. There can only be one top-level LayoutItem in the content array.
7993
- * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
7994
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
7992
+ * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
7995
7993
  */
7996
7994
  content?: LayoutContent;
7997
7995
  dimensions?: {
@@ -11119,7 +11117,7 @@ declare type PropagatedEventType<Topic extends string, Type extends string> = `$
11119
11117
 
11120
11118
  /**
11121
11119
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
11122
- * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
11120
+ * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
11123
11121
  * event type key with `'view-'`.
11124
11122
  */
11125
11123
  declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
@@ -11133,7 +11131,7 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
11133
11131
 
11134
11132
  /**
11135
11133
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
11136
- * prefixing the type string with `'window-'`. Only {@link NativeWindowEvent native window events} will propagate
11134
+ * prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
11137
11135
  * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
11138
11136
  * will *not* re-propagate.
11139
11137
  *
package/out/mock.js CHANGED
@@ -25,9 +25,9 @@ var application$1 = {};
25
25
  * child {@link OpenFin.Window windows} and {@link OpenFin.View views} are defined in the {@link OpenFin.WindowEvents} and
26
26
  * {@link OpenFin.ViewEvents} namespaces. For a list of valid string keys for *all* application events, see {@link Application.on Application.on}.
27
27
  *
28
- * {@link NativeApplicationEvent Native application events} (i.e. those that have not propagated from {@link OpenFin.ViewEvents Views}
28
+ * {@link ApplicationSourcedEvent Application-sourced events} (i.e. those that have not propagated from {@link OpenFin.ViewEvents Views}
29
29
  * or {@link OpenFin.WindowEvents Windows} re-propagate to {@link OpenFin.SystemEvents System} with their type string prefixed with `application-`.
30
- * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
30
+ * {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
31
31
  * are propagated to `System` without any type string prefixing.
32
32
  *
33
33
  * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
@@ -150,7 +150,7 @@ var window$2 = {};
150
150
  * propagate from `View` are defined in {@link OpenFin.ViewEvents}. For a list of valid string keys for *all* Window events, see
151
151
  * {@link Window.on Window.on}
152
152
  *
153
- * {@link OpenFin.WindowEvents.NativeWindowEvent Native window events} (i.e. those that are not propagated from a
153
+ * {@link OpenFin.WindowEvents.WindowSourcedEvent Window-sourced events} (i.e. those that are not propagated from a
154
154
  * {@link OpenFin.ViewEvents View}) propagate to their parent {@link OpenFin.ApplicationEvents Application} and
155
155
  * {@link OpenFin.SystemEvents System} with their event types prefixed with `'window-'`).
156
156
  *
@@ -195,10 +195,10 @@ Object.defineProperty(window$2, "__esModule", { value: true });
195
195
  * finally to the OpenFin runtime itself at the "system" level. For details on propagation semantics, see the namespace for
196
196
  * the propagating (or propagated-to) entity.
197
197
  *
198
- * If you need the payload type for a specific type of event (especially propagated events), use the emitting topic's `EventPayload`
199
- * (e.g. {@link WindowEvents.WindowEventPayload}) generic with the event's `type` string. For example, the payload of
198
+ * If you need the payload type for a specific type of event (especially propagated events), use the emitting topic's `Payload` generic
199
+ * (e.g. {@link WindowEvents.Payload}) with the event's `type` string. For example, the payload of
200
200
  * a {@link ViewEvents.CreatedEvent} after it has propagated to its parent {@link WindowEvents Window} can be found with
201
- * `WindowEventPayload<'view-created'>`.
201
+ * `WindowEvents.Payload<'view-created'>`.
202
202
  *
203
203
  * @packageDocumentation
204
204
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "33.77.6",
3
+ "version": "33.77.8",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.MD",
6
6
  "main": "out/mock.js",