@openfin/core 40.103.11 → 40.103.13

Sign up to get free protection for your applications and to get access to all the features.
@@ -84,12 +84,6 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
84
84
  url: string;
85
85
  };
86
86
 
87
- /**
88
- * @interface
89
- * A string literal union that represents possible values for behaviors in {@link DomainSettings}
90
- */
91
- declare type AllowOrBlock = 'allow' | 'block';
92
-
93
87
  declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
94
88
 
95
89
  declare type AnyStrategy = ChannelStrategy<any>;
@@ -1691,7 +1685,7 @@ declare type BaseConfig = {
1691
1685
  timeout?: number;
1692
1686
  };
1693
1687
 
1694
- declare type BaseContentBehavior = AllowOrBlock;
1688
+ declare type BaseContentBehavior = 'allow' | 'block';
1695
1689
 
1696
1690
  /**
1697
1691
  * Properties shared by all content creation rules, regardless of context.
@@ -1836,10 +1830,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
1836
1830
  isMainFrame: boolean;
1837
1831
  };
1838
1832
 
1839
- declare type BaseStructuredContentBehavior = {
1840
- behavior: BaseContentBehavior;
1841
- };
1842
-
1843
1833
  declare type BaseUrlEvent = NamedEvent & {
1844
1834
  type: 'url-changed';
1845
1835
  url: string;
@@ -1940,11 +1930,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
1940
1930
 
1941
1931
  declare type BoundsEvent = BaseEvent_5 & OpenFin_2.Bounds;
1942
1932
 
1933
+ /**
1934
+ * Opens matched URLs in the browser.
1935
+ *
1936
+ * @interface
1937
+ */
1943
1938
  declare type BrowserContentBehavior = {
1944
1939
  behavior: 'browser';
1945
1940
  /**
1946
- * Additional property that can be specified when setting the behavior to browser.
1947
- * When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
1941
+ * When true, closes the window or view that initiated the navigation.
1948
1942
  */
1949
1943
  closeExisting?: boolean;
1950
1944
  };
@@ -3255,6 +3249,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
3255
3249
 
3256
3250
  /**
3257
3251
  * Clipboard Permissions
3252
+ * @interface
3258
3253
  */
3259
3254
  declare type ClipboardPermissions = {
3260
3255
  copy?: CopyPermissions;
@@ -3807,7 +3802,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3807
3802
  };
3808
3803
 
3809
3804
  /**
3810
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
3805
+ * Behavior when displaying content from matched URLs.
3811
3806
  *
3812
3807
  * 'allow': The content url is allowed.
3813
3808
  * 'block': The content url is blocked.
@@ -4044,6 +4039,7 @@ declare type CopyBlockedEventReason = 'disabled';
4044
4039
 
4045
4040
  /**
4046
4041
  * Control copy operations for a matched URL.
4042
+ * @interface
4047
4043
  */
4048
4044
  declare type CopyPermissions = {
4049
4045
  /**
@@ -4055,7 +4051,7 @@ declare type CopyPermissions = {
4055
4051
  * block: Disables all copy operations.
4056
4052
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4057
4053
  */
4058
- behavior: AllowOrBlock | 'protect';
4054
+ behavior: 'allow' | 'block' | 'protect';
4059
4055
  /**
4060
4056
  * Additional copy operation options
4061
4057
  */
@@ -4296,6 +4292,7 @@ declare type DefaultDomainSettings = DomainSettings;
4296
4292
 
4297
4293
  /**
4298
4294
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
4295
+ * @interface
4299
4296
  */
4300
4297
  declare type DefaultDomainSettingsRule = DomainSettingsRule;
4301
4298
 
@@ -4499,9 +4496,8 @@ declare type DomainSettings = {
4499
4496
  };
4500
4497
 
4501
4498
  /**
4502
- * @interface
4503
- *
4504
4499
  * Defines domain-conditional settings for an OpenFin application.
4500
+ * @interface
4505
4501
  */
4506
4502
  declare type DomainSettingsRule = {
4507
4503
  /**
@@ -5455,6 +5451,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5455
5451
  * Domain-conditional rules for file downloads.
5456
5452
  *
5457
5453
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5454
+ * @interface
5458
5455
  */
5459
5456
  declare type FileDownloadSettings = {
5460
5457
  /**
@@ -7663,7 +7660,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
7663
7660
  * @interface
7664
7661
  */
7665
7662
  declare type LaunchExternalProcessRule = {
7666
- behavior: AllowOrBlock;
7663
+ behavior: 'allow' | 'block';
7667
7664
  match: string[];
7668
7665
  };
7669
7666
 
@@ -9633,12 +9630,10 @@ declare namespace OpenFin_2 {
9633
9630
  DomainApiSettings,
9634
9631
  BaseContentBehavior,
9635
9632
  ContentBehavior,
9636
- BaseStructuredContentBehavior,
9637
9633
  BrowserContentBehavior,
9638
9634
  StructuredContentBehavior,
9639
9635
  StructuredContentPermissions,
9640
9636
  ContentPermission,
9641
- AllowOrBlock,
9642
9637
  ScreenCaptureBehavior,
9643
9638
  PerDomainSettings,
9644
9639
  CopyPermissions,
@@ -9834,6 +9829,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
9834
9829
 
9835
9830
  /**
9836
9831
  * Control copy operations for a matched URL.
9832
+ * @interface
9837
9833
  */
9838
9834
  declare type PastePermissions = {
9839
9835
  /**
@@ -10004,11 +10000,11 @@ declare type PerDomainSettings = {
10004
10000
  * Defaults to 'allow'.
10005
10001
  * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
10006
10002
  */
10007
- print?: AllowOrBlock;
10003
+ print?: 'allow' | 'block';
10008
10004
  /**
10009
10005
  * * Controls whether HTML5 dragging for this content is allowed or blocked.
10010
10006
  */
10011
- drag?: AllowOrBlock;
10007
+ drag?: 'allow' | 'block';
10012
10008
  };
10013
10009
  };
10014
10010
 
@@ -11404,6 +11400,14 @@ declare interface PlatformProvider {
11404
11400
  * ```
11405
11401
  */
11406
11402
  handleFailedViewCreation(viewIdentity: OpenFin_2.Identity, error: Error): Promise<OpenFin_2.ViewCreationSuccess | void>;
11403
+ /**
11404
+ * Determines whether a given window should prevent the application from quitting when it is closed.
11405
+ * This method is called when checking if closing a window should trigger application termination.
11406
+ *
11407
+ * @param windowIdentity - The identity of the window being checked.
11408
+ * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
11409
+ */
11410
+ shouldWindowPreventQuit(windowIdentity: OpenFin_2.Identity): Promise<boolean>;
11407
11411
  }
11408
11412
 
11409
11413
  /**
@@ -13194,10 +13198,9 @@ declare type RvmLaunchOptions = {
13194
13198
  };
13195
13199
 
13196
13200
  /**
13197
- * @interface
13198
13201
  * Controls whether this content should be allowed or blocked when capturing the screen.
13199
13202
  */
13200
- declare type ScreenCaptureBehavior = AllowOrBlock;
13203
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13201
13204
 
13202
13205
  /**
13203
13206
  * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
@@ -13686,12 +13689,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
13686
13689
  };
13687
13690
 
13688
13691
  /**
13689
- * Allows more control over content behaviors
13692
+ * Behavior when displaying content from matched URLs.
13690
13693
  */
13691
- declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
13694
+ declare type StructuredContentBehavior = {
13695
+ behavior: BaseContentBehavior;
13696
+ } | BrowserContentBehavior;
13692
13697
 
13693
13698
  /**
13694
- * Specify rules for specific actions.
13699
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
13700
+ * @interface
13695
13701
  */
13696
13702
  declare type StructuredContentPermissions = {
13697
13703
  /**
@@ -84,12 +84,6 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
84
84
  url: string;
85
85
  };
86
86
 
87
- /**
88
- * @interface
89
- * A string literal union that represents possible values for behaviors in {@link DomainSettings}
90
- */
91
- declare type AllowOrBlock = 'allow' | 'block';
92
-
93
87
  declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
94
88
 
95
89
  declare type AnyStrategy = ChannelStrategy<any>;
@@ -1691,7 +1685,7 @@ declare type BaseConfig = {
1691
1685
  timeout?: number;
1692
1686
  };
1693
1687
 
1694
- declare type BaseContentBehavior = AllowOrBlock;
1688
+ declare type BaseContentBehavior = 'allow' | 'block';
1695
1689
 
1696
1690
  /**
1697
1691
  * Properties shared by all content creation rules, regardless of context.
@@ -1836,10 +1830,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
1836
1830
  isMainFrame: boolean;
1837
1831
  };
1838
1832
 
1839
- declare type BaseStructuredContentBehavior = {
1840
- behavior: BaseContentBehavior;
1841
- };
1842
-
1843
1833
  declare type BaseUrlEvent = NamedEvent & {
1844
1834
  type: 'url-changed';
1845
1835
  url: string;
@@ -1940,11 +1930,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
1940
1930
 
1941
1931
  declare type BoundsEvent = BaseEvent_5 & OpenFin_2.Bounds;
1942
1932
 
1933
+ /**
1934
+ * Opens matched URLs in the browser.
1935
+ *
1936
+ * @interface
1937
+ */
1943
1938
  declare type BrowserContentBehavior = {
1944
1939
  behavior: 'browser';
1945
1940
  /**
1946
- * Additional property that can be specified when setting the behavior to browser.
1947
- * When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
1941
+ * When true, closes the window or view that initiated the navigation.
1948
1942
  */
1949
1943
  closeExisting?: boolean;
1950
1944
  };
@@ -3255,6 +3249,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
3255
3249
 
3256
3250
  /**
3257
3251
  * Clipboard Permissions
3252
+ * @interface
3258
3253
  */
3259
3254
  declare type ClipboardPermissions = {
3260
3255
  copy?: CopyPermissions;
@@ -3807,7 +3802,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3807
3802
  };
3808
3803
 
3809
3804
  /**
3810
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
3805
+ * Behavior when displaying content from matched URLs.
3811
3806
  *
3812
3807
  * 'allow': The content url is allowed.
3813
3808
  * 'block': The content url is blocked.
@@ -4044,6 +4039,7 @@ declare type CopyBlockedEventReason = 'disabled';
4044
4039
 
4045
4040
  /**
4046
4041
  * Control copy operations for a matched URL.
4042
+ * @interface
4047
4043
  */
4048
4044
  declare type CopyPermissions = {
4049
4045
  /**
@@ -4055,7 +4051,7 @@ declare type CopyPermissions = {
4055
4051
  * block: Disables all copy operations.
4056
4052
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4057
4053
  */
4058
- behavior: AllowOrBlock | 'protect';
4054
+ behavior: 'allow' | 'block' | 'protect';
4059
4055
  /**
4060
4056
  * Additional copy operation options
4061
4057
  */
@@ -4296,6 +4292,7 @@ declare type DefaultDomainSettings = DomainSettings;
4296
4292
 
4297
4293
  /**
4298
4294
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
4295
+ * @interface
4299
4296
  */
4300
4297
  declare type DefaultDomainSettingsRule = DomainSettingsRule;
4301
4298
 
@@ -4499,9 +4496,8 @@ declare type DomainSettings = {
4499
4496
  };
4500
4497
 
4501
4498
  /**
4502
- * @interface
4503
- *
4504
4499
  * Defines domain-conditional settings for an OpenFin application.
4500
+ * @interface
4505
4501
  */
4506
4502
  declare type DomainSettingsRule = {
4507
4503
  /**
@@ -5455,6 +5451,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5455
5451
  * Domain-conditional rules for file downloads.
5456
5452
  *
5457
5453
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5454
+ * @interface
5458
5455
  */
5459
5456
  declare type FileDownloadSettings = {
5460
5457
  /**
@@ -7663,7 +7660,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
7663
7660
  * @interface
7664
7661
  */
7665
7662
  declare type LaunchExternalProcessRule = {
7666
- behavior: AllowOrBlock;
7663
+ behavior: 'allow' | 'block';
7667
7664
  match: string[];
7668
7665
  };
7669
7666
 
@@ -9633,12 +9630,10 @@ declare namespace OpenFin_2 {
9633
9630
  DomainApiSettings,
9634
9631
  BaseContentBehavior,
9635
9632
  ContentBehavior,
9636
- BaseStructuredContentBehavior,
9637
9633
  BrowserContentBehavior,
9638
9634
  StructuredContentBehavior,
9639
9635
  StructuredContentPermissions,
9640
9636
  ContentPermission,
9641
- AllowOrBlock,
9642
9637
  ScreenCaptureBehavior,
9643
9638
  PerDomainSettings,
9644
9639
  CopyPermissions,
@@ -9834,6 +9829,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
9834
9829
 
9835
9830
  /**
9836
9831
  * Control copy operations for a matched URL.
9832
+ * @interface
9837
9833
  */
9838
9834
  declare type PastePermissions = {
9839
9835
  /**
@@ -10004,11 +10000,11 @@ declare type PerDomainSettings = {
10004
10000
  * Defaults to 'allow'.
10005
10001
  * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
10006
10002
  */
10007
- print?: AllowOrBlock;
10003
+ print?: 'allow' | 'block';
10008
10004
  /**
10009
10005
  * * Controls whether HTML5 dragging for this content is allowed or blocked.
10010
10006
  */
10011
- drag?: AllowOrBlock;
10007
+ drag?: 'allow' | 'block';
10012
10008
  };
10013
10009
  };
10014
10010
 
@@ -11404,6 +11400,14 @@ declare interface PlatformProvider {
11404
11400
  * ```
11405
11401
  */
11406
11402
  handleFailedViewCreation(viewIdentity: OpenFin_2.Identity, error: Error): Promise<OpenFin_2.ViewCreationSuccess | void>;
11403
+ /**
11404
+ * Determines whether a given window should prevent the application from quitting when it is closed.
11405
+ * This method is called when checking if closing a window should trigger application termination.
11406
+ *
11407
+ * @param windowIdentity - The identity of the window being checked.
11408
+ * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
11409
+ */
11410
+ shouldWindowPreventQuit(windowIdentity: OpenFin_2.Identity): Promise<boolean>;
11407
11411
  }
11408
11412
 
11409
11413
  /**
@@ -13194,10 +13198,9 @@ declare type RvmLaunchOptions = {
13194
13198
  };
13195
13199
 
13196
13200
  /**
13197
- * @interface
13198
13201
  * Controls whether this content should be allowed or blocked when capturing the screen.
13199
13202
  */
13200
- declare type ScreenCaptureBehavior = AllowOrBlock;
13203
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13201
13204
 
13202
13205
  /**
13203
13206
  * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
@@ -13686,12 +13689,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
13686
13689
  };
13687
13690
 
13688
13691
  /**
13689
- * Allows more control over content behaviors
13692
+ * Behavior when displaying content from matched URLs.
13690
13693
  */
13691
- declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
13694
+ declare type StructuredContentBehavior = {
13695
+ behavior: BaseContentBehavior;
13696
+ } | BrowserContentBehavior;
13692
13697
 
13693
13698
  /**
13694
- * Specify rules for specific actions.
13699
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
13700
+ * @interface
13695
13701
  */
13696
13702
  declare type StructuredContentPermissions = {
13697
13703
  /**
@@ -84,12 +84,6 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
84
84
  url: string;
85
85
  };
86
86
 
87
- /**
88
- * @interface
89
- * A string literal union that represents possible values for behaviors in {@link DomainSettings}
90
- */
91
- declare type AllowOrBlock = 'allow' | 'block';
92
-
93
87
  declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
94
88
 
95
89
  declare type AnyStrategy = ChannelStrategy<any>;
@@ -1691,7 +1685,7 @@ declare type BaseConfig = {
1691
1685
  timeout?: number;
1692
1686
  };
1693
1687
 
1694
- declare type BaseContentBehavior = AllowOrBlock;
1688
+ declare type BaseContentBehavior = 'allow' | 'block';
1695
1689
 
1696
1690
  /**
1697
1691
  * Properties shared by all content creation rules, regardless of context.
@@ -1836,10 +1830,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
1836
1830
  isMainFrame: boolean;
1837
1831
  };
1838
1832
 
1839
- declare type BaseStructuredContentBehavior = {
1840
- behavior: BaseContentBehavior;
1841
- };
1842
-
1843
1833
  declare type BaseUrlEvent = NamedEvent & {
1844
1834
  type: 'url-changed';
1845
1835
  url: string;
@@ -1940,11 +1930,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
1940
1930
 
1941
1931
  declare type BoundsEvent = BaseEvent_5 & OpenFin_2.Bounds;
1942
1932
 
1933
+ /**
1934
+ * Opens matched URLs in the browser.
1935
+ *
1936
+ * @interface
1937
+ */
1943
1938
  declare type BrowserContentBehavior = {
1944
1939
  behavior: 'browser';
1945
1940
  /**
1946
- * Additional property that can be specified when setting the behavior to browser.
1947
- * When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
1941
+ * When true, closes the window or view that initiated the navigation.
1948
1942
  */
1949
1943
  closeExisting?: boolean;
1950
1944
  };
@@ -3255,6 +3249,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
3255
3249
 
3256
3250
  /**
3257
3251
  * Clipboard Permissions
3252
+ * @interface
3258
3253
  */
3259
3254
  declare type ClipboardPermissions = {
3260
3255
  copy?: CopyPermissions;
@@ -3807,7 +3802,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3807
3802
  };
3808
3803
 
3809
3804
  /**
3810
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
3805
+ * Behavior when displaying content from matched URLs.
3811
3806
  *
3812
3807
  * 'allow': The content url is allowed.
3813
3808
  * 'block': The content url is blocked.
@@ -4044,6 +4039,7 @@ declare type CopyBlockedEventReason = 'disabled';
4044
4039
 
4045
4040
  /**
4046
4041
  * Control copy operations for a matched URL.
4042
+ * @interface
4047
4043
  */
4048
4044
  declare type CopyPermissions = {
4049
4045
  /**
@@ -4055,7 +4051,7 @@ declare type CopyPermissions = {
4055
4051
  * block: Disables all copy operations.
4056
4052
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4057
4053
  */
4058
- behavior: AllowOrBlock | 'protect';
4054
+ behavior: 'allow' | 'block' | 'protect';
4059
4055
  /**
4060
4056
  * Additional copy operation options
4061
4057
  */
@@ -4296,6 +4292,7 @@ declare type DefaultDomainSettings = DomainSettings;
4296
4292
 
4297
4293
  /**
4298
4294
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
4295
+ * @interface
4299
4296
  */
4300
4297
  declare type DefaultDomainSettingsRule = DomainSettingsRule;
4301
4298
 
@@ -4499,9 +4496,8 @@ declare type DomainSettings = {
4499
4496
  };
4500
4497
 
4501
4498
  /**
4502
- * @interface
4503
- *
4504
4499
  * Defines domain-conditional settings for an OpenFin application.
4500
+ * @interface
4505
4501
  */
4506
4502
  declare type DomainSettingsRule = {
4507
4503
  /**
@@ -5455,6 +5451,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5455
5451
  * Domain-conditional rules for file downloads.
5456
5452
  *
5457
5453
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5454
+ * @interface
5458
5455
  */
5459
5456
  declare type FileDownloadSettings = {
5460
5457
  /**
@@ -7663,7 +7660,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
7663
7660
  * @interface
7664
7661
  */
7665
7662
  declare type LaunchExternalProcessRule = {
7666
- behavior: AllowOrBlock;
7663
+ behavior: 'allow' | 'block';
7667
7664
  match: string[];
7668
7665
  };
7669
7666
 
@@ -9633,12 +9630,10 @@ declare namespace OpenFin_2 {
9633
9630
  DomainApiSettings,
9634
9631
  BaseContentBehavior,
9635
9632
  ContentBehavior,
9636
- BaseStructuredContentBehavior,
9637
9633
  BrowserContentBehavior,
9638
9634
  StructuredContentBehavior,
9639
9635
  StructuredContentPermissions,
9640
9636
  ContentPermission,
9641
- AllowOrBlock,
9642
9637
  ScreenCaptureBehavior,
9643
9638
  PerDomainSettings,
9644
9639
  CopyPermissions,
@@ -9834,6 +9829,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
9834
9829
 
9835
9830
  /**
9836
9831
  * Control copy operations for a matched URL.
9832
+ * @interface
9837
9833
  */
9838
9834
  declare type PastePermissions = {
9839
9835
  /**
@@ -10004,11 +10000,11 @@ declare type PerDomainSettings = {
10004
10000
  * Defaults to 'allow'.
10005
10001
  * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
10006
10002
  */
10007
- print?: AllowOrBlock;
10003
+ print?: 'allow' | 'block';
10008
10004
  /**
10009
10005
  * * Controls whether HTML5 dragging for this content is allowed or blocked.
10010
10006
  */
10011
- drag?: AllowOrBlock;
10007
+ drag?: 'allow' | 'block';
10012
10008
  };
10013
10009
  };
10014
10010
 
@@ -11404,6 +11400,14 @@ declare interface PlatformProvider {
11404
11400
  * ```
11405
11401
  */
11406
11402
  handleFailedViewCreation(viewIdentity: OpenFin_2.Identity, error: Error): Promise<OpenFin_2.ViewCreationSuccess | void>;
11403
+ /**
11404
+ * Determines whether a given window should prevent the application from quitting when it is closed.
11405
+ * This method is called when checking if closing a window should trigger application termination.
11406
+ *
11407
+ * @param windowIdentity - The identity of the window being checked.
11408
+ * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
11409
+ */
11410
+ shouldWindowPreventQuit(windowIdentity: OpenFin_2.Identity): Promise<boolean>;
11407
11411
  }
11408
11412
 
11409
11413
  /**
@@ -13194,10 +13198,9 @@ declare type RvmLaunchOptions = {
13194
13198
  };
13195
13199
 
13196
13200
  /**
13197
- * @interface
13198
13201
  * Controls whether this content should be allowed or blocked when capturing the screen.
13199
13202
  */
13200
- declare type ScreenCaptureBehavior = AllowOrBlock;
13203
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13201
13204
 
13202
13205
  /**
13203
13206
  * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
@@ -13686,12 +13689,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
13686
13689
  };
13687
13690
 
13688
13691
  /**
13689
- * Allows more control over content behaviors
13692
+ * Behavior when displaying content from matched URLs.
13690
13693
  */
13691
- declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
13694
+ declare type StructuredContentBehavior = {
13695
+ behavior: BaseContentBehavior;
13696
+ } | BrowserContentBehavior;
13692
13697
 
13693
13698
  /**
13694
- * Specify rules for specific actions.
13699
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
13700
+ * @interface
13695
13701
  */
13696
13702
  declare type StructuredContentPermissions = {
13697
13703
  /**
package/out/stub.d.ts CHANGED
@@ -84,12 +84,6 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
84
84
  url: string;
85
85
  };
86
86
 
87
- /**
88
- * @interface
89
- * A string literal union that represents possible values for behaviors in {@link DomainSettings}
90
- */
91
- declare type AllowOrBlock = 'allow' | 'block';
92
-
93
87
  declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
94
88
 
95
89
  declare type AnyStrategy = ChannelStrategy<any>;
@@ -1723,7 +1717,7 @@ declare type BaseConfig = {
1723
1717
  timeout?: number;
1724
1718
  };
1725
1719
 
1726
- declare type BaseContentBehavior = AllowOrBlock;
1720
+ declare type BaseContentBehavior = 'allow' | 'block';
1727
1721
 
1728
1722
  /**
1729
1723
  * Properties shared by all content creation rules, regardless of context.
@@ -1868,10 +1862,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
1868
1862
  isMainFrame: boolean;
1869
1863
  };
1870
1864
 
1871
- declare type BaseStructuredContentBehavior = {
1872
- behavior: BaseContentBehavior;
1873
- };
1874
-
1875
1865
  declare type BaseUrlEvent = NamedEvent & {
1876
1866
  type: 'url-changed';
1877
1867
  url: string;
@@ -1972,11 +1962,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
1972
1962
 
1973
1963
  declare type BoundsEvent = BaseEvent_5 & OpenFin_2.Bounds;
1974
1964
 
1965
+ /**
1966
+ * Opens matched URLs in the browser.
1967
+ *
1968
+ * @interface
1969
+ */
1975
1970
  declare type BrowserContentBehavior = {
1976
1971
  behavior: 'browser';
1977
1972
  /**
1978
- * Additional property that can be specified when setting the behavior to browser.
1979
- * When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
1973
+ * When true, closes the window or view that initiated the navigation.
1980
1974
  */
1981
1975
  closeExisting?: boolean;
1982
1976
  };
@@ -3311,6 +3305,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
3311
3305
 
3312
3306
  /**
3313
3307
  * Clipboard Permissions
3308
+ * @interface
3314
3309
  */
3315
3310
  declare type ClipboardPermissions = {
3316
3311
  copy?: CopyPermissions;
@@ -3866,7 +3861,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3866
3861
  };
3867
3862
 
3868
3863
  /**
3869
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
3864
+ * Behavior when displaying content from matched URLs.
3870
3865
  *
3871
3866
  * 'allow': The content url is allowed.
3872
3867
  * 'block': The content url is blocked.
@@ -4103,6 +4098,7 @@ declare type CopyBlockedEventReason = 'disabled';
4103
4098
 
4104
4099
  /**
4105
4100
  * Control copy operations for a matched URL.
4101
+ * @interface
4106
4102
  */
4107
4103
  declare type CopyPermissions = {
4108
4104
  /**
@@ -4114,7 +4110,7 @@ declare type CopyPermissions = {
4114
4110
  * block: Disables all copy operations.
4115
4111
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4116
4112
  */
4117
- behavior: AllowOrBlock | 'protect';
4113
+ behavior: 'allow' | 'block' | 'protect';
4118
4114
  /**
4119
4115
  * Additional copy operation options
4120
4116
  */
@@ -4355,6 +4351,7 @@ declare type DefaultDomainSettings = DomainSettings;
4355
4351
 
4356
4352
  /**
4357
4353
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
4354
+ * @interface
4358
4355
  */
4359
4356
  declare type DefaultDomainSettingsRule = DomainSettingsRule;
4360
4357
 
@@ -4558,9 +4555,8 @@ declare type DomainSettings = {
4558
4555
  };
4559
4556
 
4560
4557
  /**
4561
- * @interface
4562
- *
4563
4558
  * Defines domain-conditional settings for an OpenFin application.
4559
+ * @interface
4564
4560
  */
4565
4561
  declare type DomainSettingsRule = {
4566
4562
  /**
@@ -5540,6 +5536,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5540
5536
  * Domain-conditional rules for file downloads.
5541
5537
  *
5542
5538
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5539
+ * @interface
5543
5540
  */
5544
5541
  declare type FileDownloadSettings = {
5545
5542
  /**
@@ -7780,7 +7777,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
7780
7777
  * @interface
7781
7778
  */
7782
7779
  declare type LaunchExternalProcessRule = {
7783
- behavior: AllowOrBlock;
7780
+ behavior: 'allow' | 'block';
7784
7781
  match: string[];
7785
7782
  };
7786
7783
 
@@ -9951,12 +9948,10 @@ declare namespace OpenFin_2 {
9951
9948
  DomainApiSettings,
9952
9949
  BaseContentBehavior,
9953
9950
  ContentBehavior,
9954
- BaseStructuredContentBehavior,
9955
9951
  BrowserContentBehavior,
9956
9952
  StructuredContentBehavior,
9957
9953
  StructuredContentPermissions,
9958
9954
  ContentPermission,
9959
- AllowOrBlock,
9960
9955
  ScreenCaptureBehavior,
9961
9956
  PerDomainSettings,
9962
9957
  CopyPermissions,
@@ -10152,6 +10147,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10152
10147
 
10153
10148
  /**
10154
10149
  * Control copy operations for a matched URL.
10150
+ * @interface
10155
10151
  */
10156
10152
  declare type PastePermissions = {
10157
10153
  /**
@@ -10322,11 +10318,11 @@ declare type PerDomainSettings = {
10322
10318
  * Defaults to 'allow'.
10323
10319
  * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
10324
10320
  */
10325
- print?: AllowOrBlock;
10321
+ print?: 'allow' | 'block';
10326
10322
  /**
10327
10323
  * * Controls whether HTML5 dragging for this content is allowed or blocked.
10328
10324
  */
10329
- drag?: AllowOrBlock;
10325
+ drag?: 'allow' | 'block';
10330
10326
  };
10331
10327
  };
10332
10328
 
@@ -11805,6 +11801,14 @@ declare interface PlatformProvider {
11805
11801
  * ```
11806
11802
  */
11807
11803
  handleFailedViewCreation(viewIdentity: OpenFin_2.Identity, error: Error): Promise<OpenFin_2.ViewCreationSuccess | void>;
11804
+ /**
11805
+ * Determines whether a given window should prevent the application from quitting when it is closed.
11806
+ * This method is called when checking if closing a window should trigger application termination.
11807
+ *
11808
+ * @param windowIdentity - The identity of the window being checked.
11809
+ * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
11810
+ */
11811
+ shouldWindowPreventQuit(windowIdentity: OpenFin_2.Identity): Promise<boolean>;
11808
11812
  }
11809
11813
 
11810
11814
  /**
@@ -13595,10 +13599,9 @@ declare type RvmLaunchOptions = {
13595
13599
  };
13596
13600
 
13597
13601
  /**
13598
- * @interface
13599
13602
  * Controls whether this content should be allowed or blocked when capturing the screen.
13600
13603
  */
13601
- declare type ScreenCaptureBehavior = AllowOrBlock;
13604
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13602
13605
 
13603
13606
  /**
13604
13607
  * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
@@ -14090,12 +14093,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
14090
14093
  };
14091
14094
 
14092
14095
  /**
14093
- * Allows more control over content behaviors
14096
+ * Behavior when displaying content from matched URLs.
14094
14097
  */
14095
- declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
14098
+ declare type StructuredContentBehavior = {
14099
+ behavior: BaseContentBehavior;
14100
+ } | BrowserContentBehavior;
14096
14101
 
14097
14102
  /**
14098
- * Specify rules for specific actions.
14103
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
14104
+ * @interface
14099
14105
  */
14100
14106
  declare type StructuredContentPermissions = {
14101
14107
  /**
package/out/stub.js CHANGED
@@ -16818,42 +16818,49 @@ function requireInteropClient () {
16818
16818
  return InteropClient;
16819
16819
  }
16820
16820
 
16821
- var overrideCheck$1 = {};
16821
+ var overrideCheck = {};
16822
16822
 
16823
- Object.defineProperty(overrideCheck$1, "__esModule", { value: true });
16824
- overrideCheck$1.overrideCheck = overrideCheck$1.checkFDC32Overrides = overrideCheck$1.getDefaultViewFdc3VersionFromAppInfo = void 0;
16825
- const InteropBroker_1 = requireInteropBroker();
16826
- function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }) {
16827
- const setVersion = manifest?.platform?.defaultViewOptions?.fdc3InteropApi ?? initialOptions.defaultViewOptions?.fdc3InteropApi;
16828
- return ['1.2', '2.0'].includes(setVersion ?? '') ? setVersion : undefined;
16829
- }
16830
- overrideCheck$1.getDefaultViewFdc3VersionFromAppInfo = getDefaultViewFdc3VersionFromAppInfo;
16831
- function checkFDC32Overrides(overriddenBroker) {
16832
- // These are the APIs that must be overridden for FDC3 2.0 compliance
16833
- const mustOverrideAPIs = [
16834
- 'fdc3HandleFindInstances',
16835
- 'handleInfoForIntent',
16836
- 'handleInfoForIntentsByContext',
16837
- 'fdc3HandleGetAppMetadata',
16838
- 'fdc3HandleGetInfo',
16839
- 'fdc3HandleOpen',
16840
- 'handleFiredIntent',
16841
- 'handleFiredIntentForContext'
16842
- ];
16843
- return mustOverrideAPIs.filter((api) => {
16844
- return overriddenBroker[api] === InteropBroker_1.InteropBroker.prototype[api];
16845
- });
16846
- }
16847
- overrideCheck$1.checkFDC32Overrides = checkFDC32Overrides;
16848
- function overrideCheck(overriddenBroker, fdc3InteropApi) {
16849
- if (fdc3InteropApi && fdc3InteropApi === '2.0') {
16850
- const notOverridden = checkFDC32Overrides(overriddenBroker);
16851
- if (notOverridden.length > 0) {
16852
- console.warn(`WARNING: FDC3 2.0 has been set as a default option for Views in this Platform, but the required InteropBroker APIs for FDC3 2.0 compliance have not all been overridden.\nThe following APIs need to be overridden:\n${notOverridden.join('\n')}`);
16853
- }
16854
- }
16823
+ var hasRequiredOverrideCheck;
16824
+
16825
+ function requireOverrideCheck () {
16826
+ if (hasRequiredOverrideCheck) return overrideCheck;
16827
+ hasRequiredOverrideCheck = 1;
16828
+ Object.defineProperty(overrideCheck, "__esModule", { value: true });
16829
+ overrideCheck.overrideCheck = overrideCheck.checkFDC32Overrides = overrideCheck.getDefaultViewFdc3VersionFromAppInfo = void 0;
16830
+ const InteropBroker_1 = requireInteropBroker();
16831
+ function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }) {
16832
+ const setVersion = manifest?.platform?.defaultViewOptions?.fdc3InteropApi ?? initialOptions.defaultViewOptions?.fdc3InteropApi;
16833
+ return ['1.2', '2.0'].includes(setVersion ?? '') ? setVersion : undefined;
16834
+ }
16835
+ overrideCheck.getDefaultViewFdc3VersionFromAppInfo = getDefaultViewFdc3VersionFromAppInfo;
16836
+ function checkFDC32Overrides(overriddenBroker) {
16837
+ // These are the APIs that must be overridden for FDC3 2.0 compliance
16838
+ const mustOverrideAPIs = [
16839
+ 'fdc3HandleFindInstances',
16840
+ 'handleInfoForIntent',
16841
+ 'handleInfoForIntentsByContext',
16842
+ 'fdc3HandleGetAppMetadata',
16843
+ 'fdc3HandleGetInfo',
16844
+ 'fdc3HandleOpen',
16845
+ 'handleFiredIntent',
16846
+ 'handleFiredIntentForContext'
16847
+ ];
16848
+ return mustOverrideAPIs.filter((api) => {
16849
+ return overriddenBroker[api] === InteropBroker_1.InteropBroker.prototype[api];
16850
+ });
16851
+ }
16852
+ overrideCheck.checkFDC32Overrides = checkFDC32Overrides;
16853
+ function overrideCheck$1(overriddenBroker, fdc3InteropApi) {
16854
+ if (fdc3InteropApi && fdc3InteropApi === '2.0') {
16855
+ const notOverridden = checkFDC32Overrides(overriddenBroker);
16856
+ if (notOverridden.length > 0) {
16857
+ console.warn(`WARNING: FDC3 2.0 has been set as a default option for Views in this Platform, but the required InteropBroker APIs for FDC3 2.0 compliance have not all been overridden.\nThe following APIs need to be overridden:\n${notOverridden.join('\n')}`);
16858
+ }
16859
+ }
16860
+ }
16861
+ overrideCheck.overrideCheck = overrideCheck$1;
16862
+ return overrideCheck;
16855
16863
  }
16856
- overrideCheck$1.overrideCheck = overrideCheck;
16857
16864
 
16858
16865
  var hasRequiredFactory;
16859
16866
 
@@ -16870,7 +16877,7 @@ function requireFactory () {
16870
16877
  const base_1 = base;
16871
16878
  const InteropBroker_1 = requireInteropBroker();
16872
16879
  const InteropClient_1 = requireInteropClient();
16873
- const overrideCheck_1 = overrideCheck$1;
16880
+ const overrideCheck_1 = requireOverrideCheck();
16874
16881
  const common_utils_1 = commonUtils;
16875
16882
  const defaultOverride = (Class) => new Class();
16876
16883
  const BrokerParamAccessError = 'You have attempted to use or modify InteropBroker parameters, which is not allowed. You are likely using an older InteropBroker override scheme. Please consult our Interop docs for guidance on migrating to the new override scheme.';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "40.103.11",
3
+ "version": "40.103.13",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/stub.js",