@openfin/fdc3-api 46.100.32 → 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.
@@ -3083,12 +3083,31 @@ declare interface ChildContentOptions {
3083
3083
  */
3084
3084
  declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
3085
3085
  type: 'child-view-created';
3086
+ /**
3087
+ * Recommended placement for the already-created child View.
3088
+ *
3089
+ * This is complementary to `disposition`: `disposition` describes the requested browser creation
3090
+ * behavior, while `destination` describes where the resulting View should be placed.
3091
+ */
3092
+ destination: ChildViewDestination;
3086
3093
  /**
3087
3094
  * The options the child View was created with.
3088
3095
  */
3089
3096
  childOptions: OpenFin.ViewOptions;
3090
3097
  };
3091
3098
 
3099
+ /**
3100
+ * Describes where an already-created View should be placed.
3101
+ */
3102
+ declare type ChildViewDestination = {
3103
+ /** Add the View to this existing window. */
3104
+ type: 'existing-window';
3105
+ identity: OpenFin.Identity;
3106
+ } | {
3107
+ /** Create a new window containing the View. */
3108
+ type: 'new-window';
3109
+ };
3110
+
3092
3111
  /**
3093
3112
  * Generated when a child Window is created.
3094
3113
  * @interface
@@ -3101,22 +3120,7 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
3101
3120
  childOptions: OpenFin.WindowOptions;
3102
3121
  };
3103
3122
 
3104
- /**
3105
- * End of Interop Client Events
3106
- */
3107
- /**
3108
- * Client-side handle for the chrome-browser feature.
3109
- *
3110
- * For Chrome extension integration to be active on a window, that window must be
3111
- * created with `chromeBrowser: true` in its window options. There is no separate
3112
- * `init()` step.
3113
- */
3114
- declare interface ChromeBrowser {
3115
- /**
3116
- * Extension action surface — observe and invoke installed Chrome extension actions.
3117
- */
3118
- readonly Actions: ChromeBrowserActions;
3119
- }
3123
+ /* Excluded from this release type: ChromeBrowser */
3120
3124
 
3121
3125
  /**
3122
3126
  * APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
@@ -3886,14 +3890,7 @@ declare type ConstWindowOptions = {
3886
3890
  * @default false
3887
3891
  */
3888
3892
  backgroundThrottling: boolean;
3889
- /**
3890
- * If `true`, the window is registered with Chromium as a `ChromeBrowser`,
3891
- * making it visible to Chrome extensions via the `chrome.windows` API.
3892
- * The window must be created with this option set; it cannot be flipped at runtime.
3893
- *
3894
- * @defaultValue false
3895
- */
3896
- chromeBrowser: boolean;
3893
+ /* Excluded from this release type: chromeBrowser */
3897
3894
  /**
3898
3895
  * Configures how new content (e,g, from `window.open` or a link) is opened.
3899
3896
  */
@@ -5639,6 +5636,11 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
5639
5636
  type: 'extension-tab-created';
5640
5637
  /** Identity of the auto-created view backing the new tab. */
5641
5638
  viewIdentity: OpenFin.Identity;
5639
+ /**
5640
+ * Recommended placement for the auto-created View. This is complementary to `disposition`, which
5641
+ * describes the requested browser creation behavior.
5642
+ */
5643
+ destination: WebContentsEvents.ChildViewDestination;
5642
5644
  /**
5643
5645
  * Identity of the view that was active when the extension triggered tab creation.
5644
5646
  * Undefined if no tab was active (e.g. the first tab in a newly-opened window).
@@ -6386,7 +6388,7 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
6386
6388
  readonly Interop: InteropModule;
6387
6389
  readonly SnapshotSource: SnapshotSourceModule;
6388
6390
  readonly NotificationManager: NotificationManagerModule;
6389
- readonly ChromeBrowser: OpenFin.ChromeBrowser;
6391
+ /* Excluded from this release type: ChromeBrowser */
6390
6392
  /**
6391
6393
  * Provides access to the OpenFin representation of the current code context (usually an entity
6392
6394
  * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
@@ -19889,6 +19891,7 @@ declare namespace WebContentsEvents {
19889
19891
  ContentCreationRulesEvent,
19890
19892
  ChildContentBlockedEvent,
19891
19893
  ChildContentOpenedInBrowserEvent,
19894
+ ChildViewDestination,
19892
19895
  ChildViewCreatedEvent,
19893
19896
  ChildWindowCreatedEvent,
19894
19897
  FileDownloadEvent,
@@ -3083,12 +3083,31 @@ declare interface ChildContentOptions {
3083
3083
  */
3084
3084
  declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
3085
3085
  type: 'child-view-created';
3086
+ /**
3087
+ * Recommended placement for the already-created child View.
3088
+ *
3089
+ * This is complementary to `disposition`: `disposition` describes the requested browser creation
3090
+ * behavior, while `destination` describes where the resulting View should be placed.
3091
+ */
3092
+ destination: ChildViewDestination;
3086
3093
  /**
3087
3094
  * The options the child View was created with.
3088
3095
  */
3089
3096
  childOptions: OpenFin.ViewOptions;
3090
3097
  };
3091
3098
 
3099
+ /**
3100
+ * Describes where an already-created View should be placed.
3101
+ */
3102
+ declare type ChildViewDestination = {
3103
+ /** Add the View to this existing window. */
3104
+ type: 'existing-window';
3105
+ identity: OpenFin.Identity;
3106
+ } | {
3107
+ /** Create a new window containing the View. */
3108
+ type: 'new-window';
3109
+ };
3110
+
3092
3111
  /**
3093
3112
  * Generated when a child Window is created.
3094
3113
  * @interface
@@ -3101,22 +3120,7 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
3101
3120
  childOptions: OpenFin.WindowOptions;
3102
3121
  };
3103
3122
 
3104
- /**
3105
- * End of Interop Client Events
3106
- */
3107
- /**
3108
- * Client-side handle for the chrome-browser feature.
3109
- *
3110
- * For Chrome extension integration to be active on a window, that window must be
3111
- * created with `chromeBrowser: true` in its window options. There is no separate
3112
- * `init()` step.
3113
- */
3114
- declare interface ChromeBrowser {
3115
- /**
3116
- * Extension action surface — observe and invoke installed Chrome extension actions.
3117
- */
3118
- readonly Actions: ChromeBrowserActions;
3119
- }
3123
+ /* Excluded from this release type: ChromeBrowser */
3120
3124
 
3121
3125
  /**
3122
3126
  * APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
@@ -3886,14 +3890,7 @@ declare type ConstWindowOptions = {
3886
3890
  * @default false
3887
3891
  */
3888
3892
  backgroundThrottling: boolean;
3889
- /**
3890
- * If `true`, the window is registered with Chromium as a `ChromeBrowser`,
3891
- * making it visible to Chrome extensions via the `chrome.windows` API.
3892
- * The window must be created with this option set; it cannot be flipped at runtime.
3893
- *
3894
- * @defaultValue false
3895
- */
3896
- chromeBrowser: boolean;
3893
+ /* Excluded from this release type: chromeBrowser */
3897
3894
  /**
3898
3895
  * Configures how new content (e,g, from `window.open` or a link) is opened.
3899
3896
  */
@@ -5639,6 +5636,11 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
5639
5636
  type: 'extension-tab-created';
5640
5637
  /** Identity of the auto-created view backing the new tab. */
5641
5638
  viewIdentity: OpenFin.Identity;
5639
+ /**
5640
+ * Recommended placement for the auto-created View. This is complementary to `disposition`, which
5641
+ * describes the requested browser creation behavior.
5642
+ */
5643
+ destination: WebContentsEvents.ChildViewDestination;
5642
5644
  /**
5643
5645
  * Identity of the view that was active when the extension triggered tab creation.
5644
5646
  * Undefined if no tab was active (e.g. the first tab in a newly-opened window).
@@ -6386,7 +6388,7 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
6386
6388
  readonly Interop: InteropModule;
6387
6389
  readonly SnapshotSource: SnapshotSourceModule;
6388
6390
  readonly NotificationManager: NotificationManagerModule;
6389
- readonly ChromeBrowser: OpenFin.ChromeBrowser;
6391
+ /* Excluded from this release type: ChromeBrowser */
6390
6392
  /**
6391
6393
  * Provides access to the OpenFin representation of the current code context (usually an entity
6392
6394
  * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
@@ -19889,6 +19891,7 @@ declare namespace WebContentsEvents {
19889
19891
  ContentCreationRulesEvent,
19890
19892
  ChildContentBlockedEvent,
19891
19893
  ChildContentOpenedInBrowserEvent,
19894
+ ChildViewDestination,
19892
19895
  ChildViewCreatedEvent,
19893
19896
  ChildWindowCreatedEvent,
19894
19897
  FileDownloadEvent,
@@ -3083,12 +3083,31 @@ declare interface ChildContentOptions {
3083
3083
  */
3084
3084
  declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
3085
3085
  type: 'child-view-created';
3086
+ /**
3087
+ * Recommended placement for the already-created child View.
3088
+ *
3089
+ * This is complementary to `disposition`: `disposition` describes the requested browser creation
3090
+ * behavior, while `destination` describes where the resulting View should be placed.
3091
+ */
3092
+ destination: ChildViewDestination;
3086
3093
  /**
3087
3094
  * The options the child View was created with.
3088
3095
  */
3089
3096
  childOptions: OpenFin.ViewOptions;
3090
3097
  };
3091
3098
 
3099
+ /**
3100
+ * Describes where an already-created View should be placed.
3101
+ */
3102
+ declare type ChildViewDestination = {
3103
+ /** Add the View to this existing window. */
3104
+ type: 'existing-window';
3105
+ identity: OpenFin.Identity;
3106
+ } | {
3107
+ /** Create a new window containing the View. */
3108
+ type: 'new-window';
3109
+ };
3110
+
3092
3111
  /**
3093
3112
  * Generated when a child Window is created.
3094
3113
  * @interface
@@ -3101,22 +3120,7 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
3101
3120
  childOptions: OpenFin.WindowOptions;
3102
3121
  };
3103
3122
 
3104
- /**
3105
- * End of Interop Client Events
3106
- */
3107
- /**
3108
- * Client-side handle for the chrome-browser feature.
3109
- *
3110
- * For Chrome extension integration to be active on a window, that window must be
3111
- * created with `chromeBrowser: true` in its window options. There is no separate
3112
- * `init()` step.
3113
- */
3114
- declare interface ChromeBrowser {
3115
- /**
3116
- * Extension action surface — observe and invoke installed Chrome extension actions.
3117
- */
3118
- readonly Actions: ChromeBrowserActions;
3119
- }
3123
+ /* Excluded from this release type: ChromeBrowser */
3120
3124
 
3121
3125
  /**
3122
3126
  * APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
@@ -3886,14 +3890,7 @@ declare type ConstWindowOptions = {
3886
3890
  * @default false
3887
3891
  */
3888
3892
  backgroundThrottling: boolean;
3889
- /**
3890
- * If `true`, the window is registered with Chromium as a `ChromeBrowser`,
3891
- * making it visible to Chrome extensions via the `chrome.windows` API.
3892
- * The window must be created with this option set; it cannot be flipped at runtime.
3893
- *
3894
- * @defaultValue false
3895
- */
3896
- chromeBrowser: boolean;
3893
+ /* Excluded from this release type: chromeBrowser */
3897
3894
  /**
3898
3895
  * Configures how new content (e,g, from `window.open` or a link) is opened.
3899
3896
  */
@@ -5639,6 +5636,11 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
5639
5636
  type: 'extension-tab-created';
5640
5637
  /** Identity of the auto-created view backing the new tab. */
5641
5638
  viewIdentity: OpenFin.Identity;
5639
+ /**
5640
+ * Recommended placement for the auto-created View. This is complementary to `disposition`, which
5641
+ * describes the requested browser creation behavior.
5642
+ */
5643
+ destination: WebContentsEvents.ChildViewDestination;
5642
5644
  /**
5643
5645
  * Identity of the view that was active when the extension triggered tab creation.
5644
5646
  * Undefined if no tab was active (e.g. the first tab in a newly-opened window).
@@ -6386,7 +6388,7 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
6386
6388
  readonly Interop: InteropModule;
6387
6389
  readonly SnapshotSource: SnapshotSourceModule;
6388
6390
  readonly NotificationManager: NotificationManagerModule;
6389
- readonly ChromeBrowser: OpenFin.ChromeBrowser;
6391
+ /* Excluded from this release type: ChromeBrowser */
6390
6392
  /**
6391
6393
  * Provides access to the OpenFin representation of the current code context (usually an entity
6392
6394
  * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
@@ -19889,6 +19891,7 @@ declare namespace WebContentsEvents {
19889
19891
  ContentCreationRulesEvent,
19890
19892
  ChildContentBlockedEvent,
19891
19893
  ChildContentOpenedInBrowserEvent,
19894
+ ChildViewDestination,
19892
19895
  ChildViewCreatedEvent,
19893
19896
  ChildWindowCreatedEvent,
19894
19897
  FileDownloadEvent,
package/out/fdc3-api.d.ts CHANGED
@@ -3139,12 +3139,31 @@ declare interface ChildContentOptions {
3139
3139
  */
3140
3140
  declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
3141
3141
  type: 'child-view-created';
3142
+ /**
3143
+ * Recommended placement for the already-created child View.
3144
+ *
3145
+ * This is complementary to `disposition`: `disposition` describes the requested browser creation
3146
+ * behavior, while `destination` describes where the resulting View should be placed.
3147
+ */
3148
+ destination: ChildViewDestination;
3142
3149
  /**
3143
3150
  * The options the child View was created with.
3144
3151
  */
3145
3152
  childOptions: OpenFin.ViewOptions;
3146
3153
  };
3147
3154
 
3155
+ /**
3156
+ * Describes where an already-created View should be placed.
3157
+ */
3158
+ declare type ChildViewDestination = {
3159
+ /** Add the View to this existing window. */
3160
+ type: 'existing-window';
3161
+ identity: OpenFin.Identity;
3162
+ } | {
3163
+ /** Create a new window containing the View. */
3164
+ type: 'new-window';
3165
+ };
3166
+
3148
3167
  /**
3149
3168
  * Generated when a child Window is created.
3150
3169
  * @interface
@@ -3163,9 +3182,16 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
3163
3182
  /**
3164
3183
  * Client-side handle for the chrome-browser feature.
3165
3184
  *
3166
- * For Chrome extension integration to be active on a window, that window must be
3167
- * created with `chromeBrowser: true` in its window options. There is no separate
3168
- * `init()` step.
3185
+ * For extension integration to be active on a window, that window must be
3186
+ * created with `chromeBrowser: true` in its window options.
3187
+ *
3188
+ * @remarks
3189
+ * This namespace is intended for internal experimentation only. Enabling the
3190
+ * `chromeBrowser` window option changes how the runtime manages content and standard
3191
+ * OpenFin content behavior is not guaranteed.
3192
+ *
3193
+ * @internal
3194
+ * @experimental This API is under active development and may change or be removed without notice.
3169
3195
  */
3170
3196
  declare interface ChromeBrowser {
3171
3197
  /**
@@ -3946,13 +3972,27 @@ declare type ConstWindowOptions = {
3946
3972
  */
3947
3973
  backgroundThrottling: boolean;
3948
3974
  /**
3949
- * If `true`, the window is registered with Chromium as a `ChromeBrowser`,
3950
- * making it visible to Chrome extensions via the `chrome.windows` API.
3951
- * The window must be created with this option set; it cannot be flipped at runtime.
3975
+ * Registers the window with Chromium as a `ChromeBrowser`, making it visible to
3976
+ * Chrome extensions via the `chrome.windows` API. The window must be created with
3977
+ * this option set; it cannot be flipped at runtime.
3978
+ *
3979
+ * Pass `true` (equivalent to `{ type: 'normal' }`) to register as a normal tabbed
3980
+ * chrome-browser host, or `{ type: 'popup' }` to register as a popup chrome-browser
3981
+ * host (no tab strip; the window's own content is the single tab) — the same
3982
+ * registration that `window.open` popups and extension popups receive internally.
3983
+ *
3984
+ * @remarks
3985
+ * Enabling this option changes how Chromium manages the window's content. Standard
3986
+ * OpenFin content behavior is not guaranteed; for example, configured
3987
+ * {@link ContentCreationOptions content creation rules} will no longer be respected.
3952
3988
  *
3989
+ * @internal
3990
+ * @experimental This option is under active development and may change or be removed without notice.
3953
3991
  * @defaultValue false
3954
3992
  */
3955
- chromeBrowser: boolean;
3993
+ chromeBrowser: boolean | {
3994
+ type: 'normal' | 'popup';
3995
+ };
3956
3996
  /**
3957
3997
  * Configures how new content (e,g, from `window.open` or a link) is opened.
3958
3998
  */
@@ -5721,6 +5761,11 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
5721
5761
  type: 'extension-tab-created';
5722
5762
  /** Identity of the auto-created view backing the new tab. */
5723
5763
  viewIdentity: OpenFin.Identity;
5764
+ /**
5765
+ * Recommended placement for the auto-created View. This is complementary to `disposition`, which
5766
+ * describes the requested browser creation behavior.
5767
+ */
5768
+ destination: WebContentsEvents.ChildViewDestination;
5724
5769
  /**
5725
5770
  * Identity of the view that was active when the extension triggered tab creation.
5726
5771
  * Undefined if no tab was active (e.g. the first tab in a newly-opened window).
@@ -6471,6 +6516,12 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
6471
6516
  readonly Interop: InteropModule;
6472
6517
  readonly SnapshotSource: SnapshotSourceModule;
6473
6518
  readonly NotificationManager: NotificationManagerModule;
6519
+ /**
6520
+ * Internal, experimental APIs for Chrome extension integration.
6521
+ *
6522
+ * @internal
6523
+ * @experimental This API may change or be removed without notice.
6524
+ */
6474
6525
  readonly ChromeBrowser: OpenFin.ChromeBrowser;
6475
6526
  /**
6476
6527
  * Provides access to the OpenFin representation of the current code context (usually an entity
@@ -20356,6 +20407,7 @@ declare namespace WebContentsEvents {
20356
20407
  ContentCreationRulesEvent,
20357
20408
  ChildContentBlockedEvent,
20358
20409
  ChildContentOpenedInBrowserEvent,
20410
+ ChildViewDestination,
20359
20411
  ChildViewCreatedEvent,
20360
20412
  ChildWindowCreatedEvent,
20361
20413
  FileDownloadEvent,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "46.100.32",
3
+ "version": "46.100.36",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,