@openfin/core 46.100.35 → 46.100.36

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.
@@ -3086,12 +3086,31 @@ declare interface ChildContentOptions {
3086
3086
  */
3087
3087
  declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
3088
3088
  type: 'child-view-created';
3089
+ /**
3090
+ * Recommended placement for the already-created child View.
3091
+ *
3092
+ * This is complementary to `disposition`: `disposition` describes the requested browser creation
3093
+ * behavior, while `destination` describes where the resulting View should be placed.
3094
+ */
3095
+ destination: ChildViewDestination;
3089
3096
  /**
3090
3097
  * The options the child View was created with.
3091
3098
  */
3092
3099
  childOptions: OpenFin_2.ViewOptions;
3093
3100
  };
3094
3101
 
3102
+ /**
3103
+ * Describes where an already-created View should be placed.
3104
+ */
3105
+ declare type ChildViewDestination = {
3106
+ /** Add the View to this existing window. */
3107
+ type: 'existing-window';
3108
+ identity: OpenFin_2.Identity;
3109
+ } | {
3110
+ /** Create a new window containing the View. */
3111
+ type: 'new-window';
3112
+ };
3113
+
3095
3114
  /**
3096
3115
  * Generated when a child Window is created.
3097
3116
  * @interface
@@ -3104,22 +3123,7 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
3104
3123
  childOptions: OpenFin_2.WindowOptions;
3105
3124
  };
3106
3125
 
3107
- /**
3108
- * End of Interop Client Events
3109
- */
3110
- /**
3111
- * Client-side handle for the chrome-browser feature.
3112
- *
3113
- * For Chrome extension integration to be active on a window, that window must be
3114
- * created with `chromeBrowser: true` in its window options. There is no separate
3115
- * `init()` step.
3116
- */
3117
- declare interface ChromeBrowser {
3118
- /**
3119
- * Extension action surface — observe and invoke installed Chrome extension actions.
3120
- */
3121
- readonly Actions: ChromeBrowserActions;
3122
- }
3126
+ /* Excluded from this release type: ChromeBrowser */
3123
3127
 
3124
3128
  /**
3125
3129
  * APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
@@ -3889,14 +3893,7 @@ declare type ConstWindowOptions = {
3889
3893
  * @default false
3890
3894
  */
3891
3895
  backgroundThrottling: boolean;
3892
- /**
3893
- * If `true`, the window is registered with Chromium as a `ChromeBrowser`,
3894
- * making it visible to Chrome extensions via the `chrome.windows` API.
3895
- * The window must be created with this option set; it cannot be flipped at runtime.
3896
- *
3897
- * @defaultValue false
3898
- */
3899
- chromeBrowser: boolean;
3896
+ /* Excluded from this release type: chromeBrowser */
3900
3897
  /**
3901
3898
  * Configures how new content (e,g, from `window.open` or a link) is opened.
3902
3899
  */
@@ -5642,6 +5639,11 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
5642
5639
  type: 'extension-tab-created';
5643
5640
  /** Identity of the auto-created view backing the new tab. */
5644
5641
  viewIdentity: OpenFin_2.Identity;
5642
+ /**
5643
+ * Recommended placement for the auto-created View. This is complementary to `disposition`, which
5644
+ * describes the requested browser creation behavior.
5645
+ */
5646
+ destination: WebContentsEvents.ChildViewDestination;
5645
5647
  /**
5646
5648
  * Identity of the view that was active when the extension triggered tab creation.
5647
5649
  * Undefined if no tab was active (e.g. the first tab in a newly-opened window).
@@ -6044,7 +6046,7 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
6044
6046
  readonly Interop: InteropModule;
6045
6047
  readonly SnapshotSource: SnapshotSourceModule;
6046
6048
  readonly NotificationManager: NotificationManagerModule;
6047
- readonly ChromeBrowser: OpenFin_2.ChromeBrowser;
6049
+ /* Excluded from this release type: ChromeBrowser */
6048
6050
  /**
6049
6051
  * Provides access to the OpenFin representation of the current code context (usually an entity
6050
6052
  * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
@@ -19443,6 +19445,7 @@ declare namespace WebContentsEvents {
19443
19445
  ContentCreationRulesEvent,
19444
19446
  ChildContentBlockedEvent,
19445
19447
  ChildContentOpenedInBrowserEvent,
19448
+ ChildViewDestination,
19446
19449
  ChildViewCreatedEvent,
19447
19450
  ChildWindowCreatedEvent,
19448
19451
  FileDownloadEvent,
@@ -3086,12 +3086,31 @@ declare interface ChildContentOptions {
3086
3086
  */
3087
3087
  declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
3088
3088
  type: 'child-view-created';
3089
+ /**
3090
+ * Recommended placement for the already-created child View.
3091
+ *
3092
+ * This is complementary to `disposition`: `disposition` describes the requested browser creation
3093
+ * behavior, while `destination` describes where the resulting View should be placed.
3094
+ */
3095
+ destination: ChildViewDestination;
3089
3096
  /**
3090
3097
  * The options the child View was created with.
3091
3098
  */
3092
3099
  childOptions: OpenFin_2.ViewOptions;
3093
3100
  };
3094
3101
 
3102
+ /**
3103
+ * Describes where an already-created View should be placed.
3104
+ */
3105
+ declare type ChildViewDestination = {
3106
+ /** Add the View to this existing window. */
3107
+ type: 'existing-window';
3108
+ identity: OpenFin_2.Identity;
3109
+ } | {
3110
+ /** Create a new window containing the View. */
3111
+ type: 'new-window';
3112
+ };
3113
+
3095
3114
  /**
3096
3115
  * Generated when a child Window is created.
3097
3116
  * @interface
@@ -3104,22 +3123,7 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
3104
3123
  childOptions: OpenFin_2.WindowOptions;
3105
3124
  };
3106
3125
 
3107
- /**
3108
- * End of Interop Client Events
3109
- */
3110
- /**
3111
- * Client-side handle for the chrome-browser feature.
3112
- *
3113
- * For Chrome extension integration to be active on a window, that window must be
3114
- * created with `chromeBrowser: true` in its window options. There is no separate
3115
- * `init()` step.
3116
- */
3117
- declare interface ChromeBrowser {
3118
- /**
3119
- * Extension action surface — observe and invoke installed Chrome extension actions.
3120
- */
3121
- readonly Actions: ChromeBrowserActions;
3122
- }
3126
+ /* Excluded from this release type: ChromeBrowser */
3123
3127
 
3124
3128
  /**
3125
3129
  * APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
@@ -3889,14 +3893,7 @@ declare type ConstWindowOptions = {
3889
3893
  * @default false
3890
3894
  */
3891
3895
  backgroundThrottling: boolean;
3892
- /**
3893
- * If `true`, the window is registered with Chromium as a `ChromeBrowser`,
3894
- * making it visible to Chrome extensions via the `chrome.windows` API.
3895
- * The window must be created with this option set; it cannot be flipped at runtime.
3896
- *
3897
- * @defaultValue false
3898
- */
3899
- chromeBrowser: boolean;
3896
+ /* Excluded from this release type: chromeBrowser */
3900
3897
  /**
3901
3898
  * Configures how new content (e,g, from `window.open` or a link) is opened.
3902
3899
  */
@@ -5642,6 +5639,11 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
5642
5639
  type: 'extension-tab-created';
5643
5640
  /** Identity of the auto-created view backing the new tab. */
5644
5641
  viewIdentity: OpenFin_2.Identity;
5642
+ /**
5643
+ * Recommended placement for the auto-created View. This is complementary to `disposition`, which
5644
+ * describes the requested browser creation behavior.
5645
+ */
5646
+ destination: WebContentsEvents.ChildViewDestination;
5645
5647
  /**
5646
5648
  * Identity of the view that was active when the extension triggered tab creation.
5647
5649
  * Undefined if no tab was active (e.g. the first tab in a newly-opened window).
@@ -6044,7 +6046,7 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
6044
6046
  readonly Interop: InteropModule;
6045
6047
  readonly SnapshotSource: SnapshotSourceModule;
6046
6048
  readonly NotificationManager: NotificationManagerModule;
6047
- readonly ChromeBrowser: OpenFin_2.ChromeBrowser;
6049
+ /* Excluded from this release type: ChromeBrowser */
6048
6050
  /**
6049
6051
  * Provides access to the OpenFin representation of the current code context (usually an entity
6050
6052
  * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
@@ -19443,6 +19445,7 @@ declare namespace WebContentsEvents {
19443
19445
  ContentCreationRulesEvent,
19444
19446
  ChildContentBlockedEvent,
19445
19447
  ChildContentOpenedInBrowserEvent,
19448
+ ChildViewDestination,
19446
19449
  ChildViewCreatedEvent,
19447
19450
  ChildWindowCreatedEvent,
19448
19451
  FileDownloadEvent,
@@ -3086,12 +3086,31 @@ declare interface ChildContentOptions {
3086
3086
  */
3087
3087
  declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
3088
3088
  type: 'child-view-created';
3089
+ /**
3090
+ * Recommended placement for the already-created child View.
3091
+ *
3092
+ * This is complementary to `disposition`: `disposition` describes the requested browser creation
3093
+ * behavior, while `destination` describes where the resulting View should be placed.
3094
+ */
3095
+ destination: ChildViewDestination;
3089
3096
  /**
3090
3097
  * The options the child View was created with.
3091
3098
  */
3092
3099
  childOptions: OpenFin_2.ViewOptions;
3093
3100
  };
3094
3101
 
3102
+ /**
3103
+ * Describes where an already-created View should be placed.
3104
+ */
3105
+ declare type ChildViewDestination = {
3106
+ /** Add the View to this existing window. */
3107
+ type: 'existing-window';
3108
+ identity: OpenFin_2.Identity;
3109
+ } | {
3110
+ /** Create a new window containing the View. */
3111
+ type: 'new-window';
3112
+ };
3113
+
3095
3114
  /**
3096
3115
  * Generated when a child Window is created.
3097
3116
  * @interface
@@ -3104,22 +3123,7 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
3104
3123
  childOptions: OpenFin_2.WindowOptions;
3105
3124
  };
3106
3125
 
3107
- /**
3108
- * End of Interop Client Events
3109
- */
3110
- /**
3111
- * Client-side handle for the chrome-browser feature.
3112
- *
3113
- * For Chrome extension integration to be active on a window, that window must be
3114
- * created with `chromeBrowser: true` in its window options. There is no separate
3115
- * `init()` step.
3116
- */
3117
- declare interface ChromeBrowser {
3118
- /**
3119
- * Extension action surface — observe and invoke installed Chrome extension actions.
3120
- */
3121
- readonly Actions: ChromeBrowserActions;
3122
- }
3126
+ /* Excluded from this release type: ChromeBrowser */
3123
3127
 
3124
3128
  /**
3125
3129
  * APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
@@ -3889,14 +3893,7 @@ declare type ConstWindowOptions = {
3889
3893
  * @default false
3890
3894
  */
3891
3895
  backgroundThrottling: boolean;
3892
- /**
3893
- * If `true`, the window is registered with Chromium as a `ChromeBrowser`,
3894
- * making it visible to Chrome extensions via the `chrome.windows` API.
3895
- * The window must be created with this option set; it cannot be flipped at runtime.
3896
- *
3897
- * @defaultValue false
3898
- */
3899
- chromeBrowser: boolean;
3896
+ /* Excluded from this release type: chromeBrowser */
3900
3897
  /**
3901
3898
  * Configures how new content (e,g, from `window.open` or a link) is opened.
3902
3899
  */
@@ -5642,6 +5639,11 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
5642
5639
  type: 'extension-tab-created';
5643
5640
  /** Identity of the auto-created view backing the new tab. */
5644
5641
  viewIdentity: OpenFin_2.Identity;
5642
+ /**
5643
+ * Recommended placement for the auto-created View. This is complementary to `disposition`, which
5644
+ * describes the requested browser creation behavior.
5645
+ */
5646
+ destination: WebContentsEvents.ChildViewDestination;
5645
5647
  /**
5646
5648
  * Identity of the view that was active when the extension triggered tab creation.
5647
5649
  * Undefined if no tab was active (e.g. the first tab in a newly-opened window).
@@ -6044,7 +6046,7 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
6044
6046
  readonly Interop: InteropModule;
6045
6047
  readonly SnapshotSource: SnapshotSourceModule;
6046
6048
  readonly NotificationManager: NotificationManagerModule;
6047
- readonly ChromeBrowser: OpenFin_2.ChromeBrowser;
6049
+ /* Excluded from this release type: ChromeBrowser */
6048
6050
  /**
6049
6051
  * Provides access to the OpenFin representation of the current code context (usually an entity
6050
6052
  * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
@@ -19443,6 +19445,7 @@ declare namespace WebContentsEvents {
19443
19445
  ContentCreationRulesEvent,
19444
19446
  ChildContentBlockedEvent,
19445
19447
  ChildContentOpenedInBrowserEvent,
19448
+ ChildViewDestination,
19446
19449
  ChildViewCreatedEvent,
19447
19450
  ChildWindowCreatedEvent,
19448
19451
  FileDownloadEvent,
package/out/stub.d.ts CHANGED
@@ -3142,12 +3142,31 @@ declare interface ChildContentOptions {
3142
3142
  */
3143
3143
  declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
3144
3144
  type: 'child-view-created';
3145
+ /**
3146
+ * Recommended placement for the already-created child View.
3147
+ *
3148
+ * This is complementary to `disposition`: `disposition` describes the requested browser creation
3149
+ * behavior, while `destination` describes where the resulting View should be placed.
3150
+ */
3151
+ destination: ChildViewDestination;
3145
3152
  /**
3146
3153
  * The options the child View was created with.
3147
3154
  */
3148
3155
  childOptions: OpenFin_2.ViewOptions;
3149
3156
  };
3150
3157
 
3158
+ /**
3159
+ * Describes where an already-created View should be placed.
3160
+ */
3161
+ declare type ChildViewDestination = {
3162
+ /** Add the View to this existing window. */
3163
+ type: 'existing-window';
3164
+ identity: OpenFin_2.Identity;
3165
+ } | {
3166
+ /** Create a new window containing the View. */
3167
+ type: 'new-window';
3168
+ };
3169
+
3151
3170
  /**
3152
3171
  * Generated when a child Window is created.
3153
3172
  * @interface
@@ -3166,9 +3185,16 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
3166
3185
  /**
3167
3186
  * Client-side handle for the chrome-browser feature.
3168
3187
  *
3169
- * For Chrome extension integration to be active on a window, that window must be
3170
- * created with `chromeBrowser: true` in its window options. There is no separate
3171
- * `init()` step.
3188
+ * For extension integration to be active on a window, that window must be
3189
+ * created with `chromeBrowser: true` in its window options.
3190
+ *
3191
+ * @remarks
3192
+ * This namespace is intended for internal experimentation only. Enabling the
3193
+ * `chromeBrowser` window option changes how the runtime manages content and standard
3194
+ * OpenFin content behavior is not guaranteed.
3195
+ *
3196
+ * @internal
3197
+ * @experimental This API is under active development and may change or be removed without notice.
3172
3198
  */
3173
3199
  declare interface ChromeBrowser {
3174
3200
  /**
@@ -3949,13 +3975,27 @@ declare type ConstWindowOptions = {
3949
3975
  */
3950
3976
  backgroundThrottling: boolean;
3951
3977
  /**
3952
- * If `true`, the window is registered with Chromium as a `ChromeBrowser`,
3953
- * making it visible to Chrome extensions via the `chrome.windows` API.
3954
- * The window must be created with this option set; it cannot be flipped at runtime.
3978
+ * Registers the window with Chromium as a `ChromeBrowser`, making it visible to
3979
+ * Chrome extensions via the `chrome.windows` API. The window must be created with
3980
+ * this option set; it cannot be flipped at runtime.
3981
+ *
3982
+ * Pass `true` (equivalent to `{ type: 'normal' }`) to register as a normal tabbed
3983
+ * chrome-browser host, or `{ type: 'popup' }` to register as a popup chrome-browser
3984
+ * host (no tab strip; the window's own content is the single tab) — the same
3985
+ * registration that `window.open` popups and extension popups receive internally.
3986
+ *
3987
+ * @remarks
3988
+ * Enabling this option changes how Chromium manages the window's content. Standard
3989
+ * OpenFin content behavior is not guaranteed; for example, configured
3990
+ * {@link ContentCreationOptions content creation rules} will no longer be respected.
3955
3991
  *
3992
+ * @internal
3993
+ * @experimental This option is under active development and may change or be removed without notice.
3956
3994
  * @defaultValue false
3957
3995
  */
3958
- chromeBrowser: boolean;
3996
+ chromeBrowser: boolean | {
3997
+ type: 'normal' | 'popup';
3998
+ };
3959
3999
  /**
3960
4000
  * Configures how new content (e,g, from `window.open` or a link) is opened.
3961
4001
  */
@@ -5724,6 +5764,11 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
5724
5764
  type: 'extension-tab-created';
5725
5765
  /** Identity of the auto-created view backing the new tab. */
5726
5766
  viewIdentity: OpenFin_2.Identity;
5767
+ /**
5768
+ * Recommended placement for the auto-created View. This is complementary to `disposition`, which
5769
+ * describes the requested browser creation behavior.
5770
+ */
5771
+ destination: WebContentsEvents.ChildViewDestination;
5727
5772
  /**
5728
5773
  * Identity of the view that was active when the extension triggered tab creation.
5729
5774
  * Undefined if no tab was active (e.g. the first tab in a newly-opened window).
@@ -6129,6 +6174,12 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
6129
6174
  readonly Interop: InteropModule;
6130
6175
  readonly SnapshotSource: SnapshotSourceModule;
6131
6176
  readonly NotificationManager: NotificationManagerModule;
6177
+ /**
6178
+ * Internal, experimental APIs for Chrome extension integration.
6179
+ *
6180
+ * @internal
6181
+ * @experimental This API may change or be removed without notice.
6182
+ */
6132
6183
  readonly ChromeBrowser: OpenFin_2.ChromeBrowser;
6133
6184
  /**
6134
6185
  * Provides access to the OpenFin representation of the current code context (usually an entity
@@ -19910,6 +19961,7 @@ declare namespace WebContentsEvents {
19910
19961
  ContentCreationRulesEvent,
19911
19962
  ChildContentBlockedEvent,
19912
19963
  ChildContentOpenedInBrowserEvent,
19964
+ ChildViewDestination,
19913
19965
  ChildViewCreatedEvent,
19914
19966
  ChildWindowCreatedEvent,
19915
19967
  FileDownloadEvent,
package/out/stub.js CHANGED
@@ -16789,8 +16789,14 @@ _ChromeBrowserActionsImpl_wire = new WeakMap(), _ChromeBrowserActionsImpl_state
16789
16789
  * Client-side handle for the chrome-browser feature on the current window.
16790
16790
  *
16791
16791
  * The window must have been created with `chromeBrowser: true` for these APIs to do
16792
- * anything meaningful — there is no separate `init()` step. From a view or a non
16792
+ * anything meaningful. From a view or a non
16793
16793
  * chrome-browser window, calls into `Actions` will resolve to empty results.
16794
+ *
16795
+ * Enabling the `chromeBrowser` window option changes how the runtime manages content,
16796
+ * and standard OpenFin content behavior is not guaranteed.
16797
+ *
16798
+ * @internal
16799
+ * @experimental This API may change or be removed without notice.
16794
16800
  */
16795
16801
  class ChromeBrowserModule {
16796
16802
  constructor(wire, isWindow) {
package/out/stub.mjs CHANGED
@@ -16785,8 +16785,14 @@ _ChromeBrowserActionsImpl_wire = new WeakMap(), _ChromeBrowserActionsImpl_state
16785
16785
  * Client-side handle for the chrome-browser feature on the current window.
16786
16786
  *
16787
16787
  * The window must have been created with `chromeBrowser: true` for these APIs to do
16788
- * anything meaningful — there is no separate `init()` step. From a view or a non
16788
+ * anything meaningful. From a view or a non
16789
16789
  * chrome-browser window, calls into `Actions` will resolve to empty results.
16790
+ *
16791
+ * Enabling the `chromeBrowser` window option changes how the runtime manages content,
16792
+ * and standard OpenFin content behavior is not guaranteed.
16793
+ *
16794
+ * @internal
16795
+ * @experimental This API may change or be removed without notice.
16790
16796
  */
16791
16797
  class ChromeBrowserModule {
16792
16798
  constructor(wire, isWindow) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "46.100.35",
3
+ "version": "46.100.36",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/stub.js",