@openfin/fdc3-api 42.100.10 → 42.100.12

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.
@@ -81,12 +81,6 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
81
81
  url: string;
82
82
  };
83
83
 
84
- /**
85
- * @interface
86
- * A string literal union that represents possible values for behaviors in {@link DomainSettings}
87
- */
88
- declare type AllowOrBlock = 'allow' | 'block';
89
-
90
84
  declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
91
85
 
92
86
  declare type AnyStrategy = ChannelStrategy<any>;
@@ -1688,7 +1682,7 @@ declare type BaseConfig = {
1688
1682
  timeout?: number;
1689
1683
  };
1690
1684
 
1691
- declare type BaseContentBehavior = AllowOrBlock;
1685
+ declare type BaseContentBehavior = 'allow' | 'block';
1692
1686
 
1693
1687
  /**
1694
1688
  * Properties shared by all content creation rules, regardless of context.
@@ -1833,10 +1827,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
1833
1827
  isMainFrame: boolean;
1834
1828
  };
1835
1829
 
1836
- declare type BaseStructuredContentBehavior = {
1837
- behavior: BaseContentBehavior;
1838
- };
1839
-
1840
1830
  declare type BaseUrlEvent = NamedEvent & {
1841
1831
  type: 'url-changed';
1842
1832
  url: string;
@@ -1937,11 +1927,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
1937
1927
 
1938
1928
  declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
1939
1929
 
1930
+ /**
1931
+ * Opens matched URLs in the browser.
1932
+ *
1933
+ * @interface
1934
+ */
1940
1935
  declare type BrowserContentBehavior = {
1941
1936
  behavior: 'browser';
1942
1937
  /**
1943
- * Additional property that can be specified when setting the behavior to browser.
1944
- * When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
1938
+ * When true, closes the window or view that initiated the navigation.
1945
1939
  */
1946
1940
  closeExisting?: boolean;
1947
1941
  };
@@ -3252,6 +3246,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
3252
3246
 
3253
3247
  /**
3254
3248
  * Clipboard Permissions
3249
+ * @interface
3255
3250
  */
3256
3251
  declare type ClipboardPermissions = {
3257
3252
  copy?: CopyPermissions;
@@ -3811,7 +3806,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3811
3806
  };
3812
3807
 
3813
3808
  /**
3814
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
3809
+ * Behavior when displaying content from matched URLs.
3815
3810
  *
3816
3811
  * 'allow': The content url is allowed.
3817
3812
  * 'block': The content url is blocked.
@@ -4048,6 +4043,7 @@ declare type CopyBlockedEventReason = 'disabled';
4048
4043
 
4049
4044
  /**
4050
4045
  * Control copy operations for a matched URL.
4046
+ * @interface
4051
4047
  */
4052
4048
  declare type CopyPermissions = {
4053
4049
  /**
@@ -4059,7 +4055,7 @@ declare type CopyPermissions = {
4059
4055
  * block: Disables all copy operations.
4060
4056
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4061
4057
  */
4062
- behavior: AllowOrBlock | 'protect';
4058
+ behavior: 'allow' | 'block' | 'protect';
4063
4059
  /**
4064
4060
  * Additional copy operation options
4065
4061
  */
@@ -4300,6 +4296,7 @@ declare type DefaultDomainSettings = DomainSettings;
4300
4296
 
4301
4297
  /**
4302
4298
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
4299
+ * @interface
4303
4300
  */
4304
4301
  declare type DefaultDomainSettingsRule = DomainSettingsRule;
4305
4302
 
@@ -4503,9 +4500,8 @@ declare type DomainSettings = {
4503
4500
  };
4504
4501
 
4505
4502
  /**
4506
- * @interface
4507
- *
4508
4503
  * Defines domain-conditional settings for an OpenFin application.
4504
+ * @interface
4509
4505
  */
4510
4506
  declare type DomainSettingsRule = {
4511
4507
  /**
@@ -5810,6 +5806,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5810
5806
  * Domain-conditional rules for file downloads.
5811
5807
  *
5812
5808
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5809
+ * @interface
5813
5810
  */
5814
5811
  declare type FileDownloadSettings = {
5815
5812
  /**
@@ -8016,7 +8013,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
8016
8013
  * @interface
8017
8014
  */
8018
8015
  declare type LaunchExternalProcessRule = {
8019
- behavior: AllowOrBlock;
8016
+ behavior: 'allow' | 'block';
8020
8017
  match: string[];
8021
8018
  };
8022
8019
 
@@ -10017,12 +10014,10 @@ declare namespace OpenFin {
10017
10014
  DomainApiSettings,
10018
10015
  BaseContentBehavior,
10019
10016
  ContentBehavior,
10020
- BaseStructuredContentBehavior,
10021
10017
  BrowserContentBehavior,
10022
10018
  StructuredContentBehavior,
10023
10019
  StructuredContentPermissions,
10024
10020
  ContentPermission,
10025
- AllowOrBlock,
10026
10021
  ScreenCaptureBehavior,
10027
10022
  PerDomainSettings,
10028
10023
  CopyPermissions,
@@ -10216,6 +10211,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10216
10211
 
10217
10212
  /**
10218
10213
  * Control copy operations for a matched URL.
10214
+ * @interface
10219
10215
  */
10220
10216
  declare type PastePermissions = {
10221
10217
  /**
@@ -10386,11 +10382,11 @@ declare type PerDomainSettings = {
10386
10382
  * Defaults to 'allow'.
10387
10383
  * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
10388
10384
  */
10389
- print?: AllowOrBlock;
10385
+ print?: 'allow' | 'block';
10390
10386
  /**
10391
10387
  * * Controls whether HTML5 dragging for this content is allowed or blocked.
10392
10388
  */
10393
- drag?: AllowOrBlock;
10389
+ drag?: 'allow' | 'block';
10394
10390
  };
10395
10391
  };
10396
10392
 
@@ -11786,6 +11782,14 @@ declare interface PlatformProvider {
11786
11782
  * ```
11787
11783
  */
11788
11784
  handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
11785
+ /**
11786
+ * Determines whether a given window should prevent the application from quitting when it is closed.
11787
+ * This method is called when checking if closing a window should trigger application termination.
11788
+ *
11789
+ * @param windowIdentity - The identity of the window being checked.
11790
+ * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
11791
+ */
11792
+ shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
11789
11793
  }
11790
11794
 
11791
11795
  /**
@@ -13576,10 +13580,9 @@ declare type RvmLaunchOptions = {
13576
13580
  };
13577
13581
 
13578
13582
  /**
13579
- * @interface
13580
13583
  * Controls whether this content should be allowed or blocked when capturing the screen.
13581
13584
  */
13582
- declare type ScreenCaptureBehavior = AllowOrBlock;
13585
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13583
13586
 
13584
13587
  /**
13585
13588
  * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
@@ -14068,12 +14071,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
14068
14071
  };
14069
14072
 
14070
14073
  /**
14071
- * Allows more control over content behaviors
14074
+ * Behavior when displaying content from matched URLs.
14072
14075
  */
14073
- declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
14076
+ declare type StructuredContentBehavior = {
14077
+ behavior: BaseContentBehavior;
14078
+ } | BrowserContentBehavior;
14074
14079
 
14075
14080
  /**
14076
- * Specify rules for specific actions.
14081
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
14082
+ * @interface
14077
14083
  */
14078
14084
  declare type StructuredContentPermissions = {
14079
14085
  /**
@@ -81,12 +81,6 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
81
81
  url: string;
82
82
  };
83
83
 
84
- /**
85
- * @interface
86
- * A string literal union that represents possible values for behaviors in {@link DomainSettings}
87
- */
88
- declare type AllowOrBlock = 'allow' | 'block';
89
-
90
84
  declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
91
85
 
92
86
  declare type AnyStrategy = ChannelStrategy<any>;
@@ -1688,7 +1682,7 @@ declare type BaseConfig = {
1688
1682
  timeout?: number;
1689
1683
  };
1690
1684
 
1691
- declare type BaseContentBehavior = AllowOrBlock;
1685
+ declare type BaseContentBehavior = 'allow' | 'block';
1692
1686
 
1693
1687
  /**
1694
1688
  * Properties shared by all content creation rules, regardless of context.
@@ -1833,10 +1827,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
1833
1827
  isMainFrame: boolean;
1834
1828
  };
1835
1829
 
1836
- declare type BaseStructuredContentBehavior = {
1837
- behavior: BaseContentBehavior;
1838
- };
1839
-
1840
1830
  declare type BaseUrlEvent = NamedEvent & {
1841
1831
  type: 'url-changed';
1842
1832
  url: string;
@@ -1937,11 +1927,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
1937
1927
 
1938
1928
  declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
1939
1929
 
1930
+ /**
1931
+ * Opens matched URLs in the browser.
1932
+ *
1933
+ * @interface
1934
+ */
1940
1935
  declare type BrowserContentBehavior = {
1941
1936
  behavior: 'browser';
1942
1937
  /**
1943
- * Additional property that can be specified when setting the behavior to browser.
1944
- * When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
1938
+ * When true, closes the window or view that initiated the navigation.
1945
1939
  */
1946
1940
  closeExisting?: boolean;
1947
1941
  };
@@ -3252,6 +3246,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
3252
3246
 
3253
3247
  /**
3254
3248
  * Clipboard Permissions
3249
+ * @interface
3255
3250
  */
3256
3251
  declare type ClipboardPermissions = {
3257
3252
  copy?: CopyPermissions;
@@ -3811,7 +3806,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3811
3806
  };
3812
3807
 
3813
3808
  /**
3814
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
3809
+ * Behavior when displaying content from matched URLs.
3815
3810
  *
3816
3811
  * 'allow': The content url is allowed.
3817
3812
  * 'block': The content url is blocked.
@@ -4048,6 +4043,7 @@ declare type CopyBlockedEventReason = 'disabled';
4048
4043
 
4049
4044
  /**
4050
4045
  * Control copy operations for a matched URL.
4046
+ * @interface
4051
4047
  */
4052
4048
  declare type CopyPermissions = {
4053
4049
  /**
@@ -4059,7 +4055,7 @@ declare type CopyPermissions = {
4059
4055
  * block: Disables all copy operations.
4060
4056
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4061
4057
  */
4062
- behavior: AllowOrBlock | 'protect';
4058
+ behavior: 'allow' | 'block' | 'protect';
4063
4059
  /**
4064
4060
  * Additional copy operation options
4065
4061
  */
@@ -4300,6 +4296,7 @@ declare type DefaultDomainSettings = DomainSettings;
4300
4296
 
4301
4297
  /**
4302
4298
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
4299
+ * @interface
4303
4300
  */
4304
4301
  declare type DefaultDomainSettingsRule = DomainSettingsRule;
4305
4302
 
@@ -4503,9 +4500,8 @@ declare type DomainSettings = {
4503
4500
  };
4504
4501
 
4505
4502
  /**
4506
- * @interface
4507
- *
4508
4503
  * Defines domain-conditional settings for an OpenFin application.
4504
+ * @interface
4509
4505
  */
4510
4506
  declare type DomainSettingsRule = {
4511
4507
  /**
@@ -5810,6 +5806,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5810
5806
  * Domain-conditional rules for file downloads.
5811
5807
  *
5812
5808
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5809
+ * @interface
5813
5810
  */
5814
5811
  declare type FileDownloadSettings = {
5815
5812
  /**
@@ -8016,7 +8013,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
8016
8013
  * @interface
8017
8014
  */
8018
8015
  declare type LaunchExternalProcessRule = {
8019
- behavior: AllowOrBlock;
8016
+ behavior: 'allow' | 'block';
8020
8017
  match: string[];
8021
8018
  };
8022
8019
 
@@ -10017,12 +10014,10 @@ declare namespace OpenFin {
10017
10014
  DomainApiSettings,
10018
10015
  BaseContentBehavior,
10019
10016
  ContentBehavior,
10020
- BaseStructuredContentBehavior,
10021
10017
  BrowserContentBehavior,
10022
10018
  StructuredContentBehavior,
10023
10019
  StructuredContentPermissions,
10024
10020
  ContentPermission,
10025
- AllowOrBlock,
10026
10021
  ScreenCaptureBehavior,
10027
10022
  PerDomainSettings,
10028
10023
  CopyPermissions,
@@ -10216,6 +10211,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10216
10211
 
10217
10212
  /**
10218
10213
  * Control copy operations for a matched URL.
10214
+ * @interface
10219
10215
  */
10220
10216
  declare type PastePermissions = {
10221
10217
  /**
@@ -10386,11 +10382,11 @@ declare type PerDomainSettings = {
10386
10382
  * Defaults to 'allow'.
10387
10383
  * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
10388
10384
  */
10389
- print?: AllowOrBlock;
10385
+ print?: 'allow' | 'block';
10390
10386
  /**
10391
10387
  * * Controls whether HTML5 dragging for this content is allowed or blocked.
10392
10388
  */
10393
- drag?: AllowOrBlock;
10389
+ drag?: 'allow' | 'block';
10394
10390
  };
10395
10391
  };
10396
10392
 
@@ -11786,6 +11782,14 @@ declare interface PlatformProvider {
11786
11782
  * ```
11787
11783
  */
11788
11784
  handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
11785
+ /**
11786
+ * Determines whether a given window should prevent the application from quitting when it is closed.
11787
+ * This method is called when checking if closing a window should trigger application termination.
11788
+ *
11789
+ * @param windowIdentity - The identity of the window being checked.
11790
+ * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
11791
+ */
11792
+ shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
11789
11793
  }
11790
11794
 
11791
11795
  /**
@@ -13576,10 +13580,9 @@ declare type RvmLaunchOptions = {
13576
13580
  };
13577
13581
 
13578
13582
  /**
13579
- * @interface
13580
13583
  * Controls whether this content should be allowed or blocked when capturing the screen.
13581
13584
  */
13582
- declare type ScreenCaptureBehavior = AllowOrBlock;
13585
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13583
13586
 
13584
13587
  /**
13585
13588
  * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
@@ -14068,12 +14071,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
14068
14071
  };
14069
14072
 
14070
14073
  /**
14071
- * Allows more control over content behaviors
14074
+ * Behavior when displaying content from matched URLs.
14072
14075
  */
14073
- declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
14076
+ declare type StructuredContentBehavior = {
14077
+ behavior: BaseContentBehavior;
14078
+ } | BrowserContentBehavior;
14074
14079
 
14075
14080
  /**
14076
- * Specify rules for specific actions.
14081
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
14082
+ * @interface
14077
14083
  */
14078
14084
  declare type StructuredContentPermissions = {
14079
14085
  /**
@@ -81,12 +81,6 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
81
81
  url: string;
82
82
  };
83
83
 
84
- /**
85
- * @interface
86
- * A string literal union that represents possible values for behaviors in {@link DomainSettings}
87
- */
88
- declare type AllowOrBlock = 'allow' | 'block';
89
-
90
84
  declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
91
85
 
92
86
  declare type AnyStrategy = ChannelStrategy<any>;
@@ -1688,7 +1682,7 @@ declare type BaseConfig = {
1688
1682
  timeout?: number;
1689
1683
  };
1690
1684
 
1691
- declare type BaseContentBehavior = AllowOrBlock;
1685
+ declare type BaseContentBehavior = 'allow' | 'block';
1692
1686
 
1693
1687
  /**
1694
1688
  * Properties shared by all content creation rules, regardless of context.
@@ -1833,10 +1827,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
1833
1827
  isMainFrame: boolean;
1834
1828
  };
1835
1829
 
1836
- declare type BaseStructuredContentBehavior = {
1837
- behavior: BaseContentBehavior;
1838
- };
1839
-
1840
1830
  declare type BaseUrlEvent = NamedEvent & {
1841
1831
  type: 'url-changed';
1842
1832
  url: string;
@@ -1937,11 +1927,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
1937
1927
 
1938
1928
  declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
1939
1929
 
1930
+ /**
1931
+ * Opens matched URLs in the browser.
1932
+ *
1933
+ * @interface
1934
+ */
1940
1935
  declare type BrowserContentBehavior = {
1941
1936
  behavior: 'browser';
1942
1937
  /**
1943
- * Additional property that can be specified when setting the behavior to browser.
1944
- * When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
1938
+ * When true, closes the window or view that initiated the navigation.
1945
1939
  */
1946
1940
  closeExisting?: boolean;
1947
1941
  };
@@ -3252,6 +3246,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
3252
3246
 
3253
3247
  /**
3254
3248
  * Clipboard Permissions
3249
+ * @interface
3255
3250
  */
3256
3251
  declare type ClipboardPermissions = {
3257
3252
  copy?: CopyPermissions;
@@ -3811,7 +3806,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3811
3806
  };
3812
3807
 
3813
3808
  /**
3814
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
3809
+ * Behavior when displaying content from matched URLs.
3815
3810
  *
3816
3811
  * 'allow': The content url is allowed.
3817
3812
  * 'block': The content url is blocked.
@@ -4048,6 +4043,7 @@ declare type CopyBlockedEventReason = 'disabled';
4048
4043
 
4049
4044
  /**
4050
4045
  * Control copy operations for a matched URL.
4046
+ * @interface
4051
4047
  */
4052
4048
  declare type CopyPermissions = {
4053
4049
  /**
@@ -4059,7 +4055,7 @@ declare type CopyPermissions = {
4059
4055
  * block: Disables all copy operations.
4060
4056
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4061
4057
  */
4062
- behavior: AllowOrBlock | 'protect';
4058
+ behavior: 'allow' | 'block' | 'protect';
4063
4059
  /**
4064
4060
  * Additional copy operation options
4065
4061
  */
@@ -4300,6 +4296,7 @@ declare type DefaultDomainSettings = DomainSettings;
4300
4296
 
4301
4297
  /**
4302
4298
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
4299
+ * @interface
4303
4300
  */
4304
4301
  declare type DefaultDomainSettingsRule = DomainSettingsRule;
4305
4302
 
@@ -4503,9 +4500,8 @@ declare type DomainSettings = {
4503
4500
  };
4504
4501
 
4505
4502
  /**
4506
- * @interface
4507
- *
4508
4503
  * Defines domain-conditional settings for an OpenFin application.
4504
+ * @interface
4509
4505
  */
4510
4506
  declare type DomainSettingsRule = {
4511
4507
  /**
@@ -5810,6 +5806,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5810
5806
  * Domain-conditional rules for file downloads.
5811
5807
  *
5812
5808
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5809
+ * @interface
5813
5810
  */
5814
5811
  declare type FileDownloadSettings = {
5815
5812
  /**
@@ -8016,7 +8013,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
8016
8013
  * @interface
8017
8014
  */
8018
8015
  declare type LaunchExternalProcessRule = {
8019
- behavior: AllowOrBlock;
8016
+ behavior: 'allow' | 'block';
8020
8017
  match: string[];
8021
8018
  };
8022
8019
 
@@ -10017,12 +10014,10 @@ declare namespace OpenFin {
10017
10014
  DomainApiSettings,
10018
10015
  BaseContentBehavior,
10019
10016
  ContentBehavior,
10020
- BaseStructuredContentBehavior,
10021
10017
  BrowserContentBehavior,
10022
10018
  StructuredContentBehavior,
10023
10019
  StructuredContentPermissions,
10024
10020
  ContentPermission,
10025
- AllowOrBlock,
10026
10021
  ScreenCaptureBehavior,
10027
10022
  PerDomainSettings,
10028
10023
  CopyPermissions,
@@ -10216,6 +10211,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10216
10211
 
10217
10212
  /**
10218
10213
  * Control copy operations for a matched URL.
10214
+ * @interface
10219
10215
  */
10220
10216
  declare type PastePermissions = {
10221
10217
  /**
@@ -10386,11 +10382,11 @@ declare type PerDomainSettings = {
10386
10382
  * Defaults to 'allow'.
10387
10383
  * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
10388
10384
  */
10389
- print?: AllowOrBlock;
10385
+ print?: 'allow' | 'block';
10390
10386
  /**
10391
10387
  * * Controls whether HTML5 dragging for this content is allowed or blocked.
10392
10388
  */
10393
- drag?: AllowOrBlock;
10389
+ drag?: 'allow' | 'block';
10394
10390
  };
10395
10391
  };
10396
10392
 
@@ -11786,6 +11782,14 @@ declare interface PlatformProvider {
11786
11782
  * ```
11787
11783
  */
11788
11784
  handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
11785
+ /**
11786
+ * Determines whether a given window should prevent the application from quitting when it is closed.
11787
+ * This method is called when checking if closing a window should trigger application termination.
11788
+ *
11789
+ * @param windowIdentity - The identity of the window being checked.
11790
+ * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
11791
+ */
11792
+ shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
11789
11793
  }
11790
11794
 
11791
11795
  /**
@@ -13576,10 +13580,9 @@ declare type RvmLaunchOptions = {
13576
13580
  };
13577
13581
 
13578
13582
  /**
13579
- * @interface
13580
13583
  * Controls whether this content should be allowed or blocked when capturing the screen.
13581
13584
  */
13582
- declare type ScreenCaptureBehavior = AllowOrBlock;
13585
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13583
13586
 
13584
13587
  /**
13585
13588
  * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
@@ -14068,12 +14071,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
14068
14071
  };
14069
14072
 
14070
14073
  /**
14071
- * Allows more control over content behaviors
14074
+ * Behavior when displaying content from matched URLs.
14072
14075
  */
14073
- declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
14076
+ declare type StructuredContentBehavior = {
14077
+ behavior: BaseContentBehavior;
14078
+ } | BrowserContentBehavior;
14074
14079
 
14075
14080
  /**
14076
- * Specify rules for specific actions.
14081
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
14082
+ * @interface
14077
14083
  */
14078
14084
  declare type StructuredContentPermissions = {
14079
14085
  /**
package/out/fdc3-api.d.ts CHANGED
@@ -81,12 +81,6 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
81
81
  url: string;
82
82
  };
83
83
 
84
- /**
85
- * @interface
86
- * A string literal union that represents possible values for behaviors in {@link DomainSettings}
87
- */
88
- declare type AllowOrBlock = 'allow' | 'block';
89
-
90
84
  declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
91
85
 
92
86
  declare type AnyStrategy = ChannelStrategy<any>;
@@ -1720,7 +1714,7 @@ declare type BaseConfig = {
1720
1714
  timeout?: number;
1721
1715
  };
1722
1716
 
1723
- declare type BaseContentBehavior = AllowOrBlock;
1717
+ declare type BaseContentBehavior = 'allow' | 'block';
1724
1718
 
1725
1719
  /**
1726
1720
  * Properties shared by all content creation rules, regardless of context.
@@ -1865,10 +1859,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
1865
1859
  isMainFrame: boolean;
1866
1860
  };
1867
1861
 
1868
- declare type BaseStructuredContentBehavior = {
1869
- behavior: BaseContentBehavior;
1870
- };
1871
-
1872
1862
  declare type BaseUrlEvent = NamedEvent & {
1873
1863
  type: 'url-changed';
1874
1864
  url: string;
@@ -1969,11 +1959,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
1969
1959
 
1970
1960
  declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
1971
1961
 
1962
+ /**
1963
+ * Opens matched URLs in the browser.
1964
+ *
1965
+ * @interface
1966
+ */
1972
1967
  declare type BrowserContentBehavior = {
1973
1968
  behavior: 'browser';
1974
1969
  /**
1975
- * Additional property that can be specified when setting the behavior to browser.
1976
- * When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
1970
+ * When true, closes the window or view that initiated the navigation.
1977
1971
  */
1978
1972
  closeExisting?: boolean;
1979
1973
  };
@@ -3308,6 +3302,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
3308
3302
 
3309
3303
  /**
3310
3304
  * Clipboard Permissions
3305
+ * @interface
3311
3306
  */
3312
3307
  declare type ClipboardPermissions = {
3313
3308
  copy?: CopyPermissions;
@@ -3870,7 +3865,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3870
3865
  };
3871
3866
 
3872
3867
  /**
3873
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
3868
+ * Behavior when displaying content from matched URLs.
3874
3869
  *
3875
3870
  * 'allow': The content url is allowed.
3876
3871
  * 'block': The content url is blocked.
@@ -4107,6 +4102,7 @@ declare type CopyBlockedEventReason = 'disabled';
4107
4102
 
4108
4103
  /**
4109
4104
  * Control copy operations for a matched URL.
4105
+ * @interface
4110
4106
  */
4111
4107
  declare type CopyPermissions = {
4112
4108
  /**
@@ -4118,7 +4114,7 @@ declare type CopyPermissions = {
4118
4114
  * block: Disables all copy operations.
4119
4115
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4120
4116
  */
4121
- behavior: AllowOrBlock | 'protect';
4117
+ behavior: 'allow' | 'block' | 'protect';
4122
4118
  /**
4123
4119
  * Additional copy operation options
4124
4120
  */
@@ -4359,6 +4355,7 @@ declare type DefaultDomainSettings = DomainSettings;
4359
4355
 
4360
4356
  /**
4361
4357
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
4358
+ * @interface
4362
4359
  */
4363
4360
  declare type DefaultDomainSettingsRule = DomainSettingsRule;
4364
4361
 
@@ -4562,9 +4559,8 @@ declare type DomainSettings = {
4562
4559
  };
4563
4560
 
4564
4561
  /**
4565
- * @interface
4566
- *
4567
4562
  * Defines domain-conditional settings for an OpenFin application.
4563
+ * @interface
4568
4564
  */
4569
4565
  declare type DomainSettingsRule = {
4570
4566
  /**
@@ -5895,6 +5891,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5895
5891
  * Domain-conditional rules for file downloads.
5896
5892
  *
5897
5893
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5894
+ * @interface
5898
5895
  */
5899
5896
  declare type FileDownloadSettings = {
5900
5897
  /**
@@ -8133,7 +8130,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
8133
8130
  * @interface
8134
8131
  */
8135
8132
  declare type LaunchExternalProcessRule = {
8136
- behavior: AllowOrBlock;
8133
+ behavior: 'allow' | 'block';
8137
8134
  match: string[];
8138
8135
  };
8139
8136
 
@@ -10335,12 +10332,10 @@ declare namespace OpenFin {
10335
10332
  DomainApiSettings,
10336
10333
  BaseContentBehavior,
10337
10334
  ContentBehavior,
10338
- BaseStructuredContentBehavior,
10339
10335
  BrowserContentBehavior,
10340
10336
  StructuredContentBehavior,
10341
10337
  StructuredContentPermissions,
10342
10338
  ContentPermission,
10343
- AllowOrBlock,
10344
10339
  ScreenCaptureBehavior,
10345
10340
  PerDomainSettings,
10346
10341
  CopyPermissions,
@@ -10534,6 +10529,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10534
10529
 
10535
10530
  /**
10536
10531
  * Control copy operations for a matched URL.
10532
+ * @interface
10537
10533
  */
10538
10534
  declare type PastePermissions = {
10539
10535
  /**
@@ -10704,11 +10700,11 @@ declare type PerDomainSettings = {
10704
10700
  * Defaults to 'allow'.
10705
10701
  * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
10706
10702
  */
10707
- print?: AllowOrBlock;
10703
+ print?: 'allow' | 'block';
10708
10704
  /**
10709
10705
  * * Controls whether HTML5 dragging for this content is allowed or blocked.
10710
10706
  */
10711
- drag?: AllowOrBlock;
10707
+ drag?: 'allow' | 'block';
10712
10708
  };
10713
10709
  };
10714
10710
 
@@ -12187,6 +12183,14 @@ declare interface PlatformProvider {
12187
12183
  * ```
12188
12184
  */
12189
12185
  handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
12186
+ /**
12187
+ * Determines whether a given window should prevent the application from quitting when it is closed.
12188
+ * This method is called when checking if closing a window should trigger application termination.
12189
+ *
12190
+ * @param windowIdentity - The identity of the window being checked.
12191
+ * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
12192
+ */
12193
+ shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
12190
12194
  }
12191
12195
 
12192
12196
  /**
@@ -13977,10 +13981,9 @@ declare type RvmLaunchOptions = {
13977
13981
  };
13978
13982
 
13979
13983
  /**
13980
- * @interface
13981
13984
  * Controls whether this content should be allowed or blocked when capturing the screen.
13982
13985
  */
13983
- declare type ScreenCaptureBehavior = AllowOrBlock;
13986
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13984
13987
 
13985
13988
  /**
13986
13989
  * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
@@ -14472,12 +14475,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
14472
14475
  };
14473
14476
 
14474
14477
  /**
14475
- * Allows more control over content behaviors
14478
+ * Behavior when displaying content from matched URLs.
14476
14479
  */
14477
- declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
14480
+ declare type StructuredContentBehavior = {
14481
+ behavior: BaseContentBehavior;
14482
+ } | BrowserContentBehavior;
14478
14483
 
14479
14484
  /**
14480
- * Specify rules for specific actions.
14485
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
14486
+ * @interface
14481
14487
  */
14482
14488
  declare type StructuredContentPermissions = {
14483
14489
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "42.100.10",
3
+ "version": "42.100.12",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,