@openfin/fdc3-api 40.103.10 → 40.103.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;
@@ -3804,7 +3799,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3804
3799
  };
3805
3800
 
3806
3801
  /**
3807
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
3802
+ * Behavior when displaying content from matched URLs.
3808
3803
  *
3809
3804
  * 'allow': The content url is allowed.
3810
3805
  * 'block': The content url is blocked.
@@ -4041,6 +4036,7 @@ declare type CopyBlockedEventReason = 'disabled';
4041
4036
 
4042
4037
  /**
4043
4038
  * Control copy operations for a matched URL.
4039
+ * @interface
4044
4040
  */
4045
4041
  declare type CopyPermissions = {
4046
4042
  /**
@@ -4052,7 +4048,7 @@ declare type CopyPermissions = {
4052
4048
  * block: Disables all copy operations.
4053
4049
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4054
4050
  */
4055
- behavior: AllowOrBlock | 'protect';
4051
+ behavior: 'allow' | 'block' | 'protect';
4056
4052
  /**
4057
4053
  * Additional copy operation options
4058
4054
  */
@@ -4293,6 +4289,7 @@ declare type DefaultDomainSettings = DomainSettings;
4293
4289
 
4294
4290
  /**
4295
4291
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
4292
+ * @interface
4296
4293
  */
4297
4294
  declare type DefaultDomainSettingsRule = DomainSettingsRule;
4298
4295
 
@@ -4496,9 +4493,8 @@ declare type DomainSettings = {
4496
4493
  };
4497
4494
 
4498
4495
  /**
4499
- * @interface
4500
- *
4501
4496
  * Defines domain-conditional settings for an OpenFin application.
4497
+ * @interface
4502
4498
  */
4503
4499
  declare type DomainSettingsRule = {
4504
4500
  /**
@@ -5799,6 +5795,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5799
5795
  * Domain-conditional rules for file downloads.
5800
5796
  *
5801
5797
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5798
+ * @interface
5802
5799
  */
5803
5800
  declare type FileDownloadSettings = {
5804
5801
  /**
@@ -8005,7 +8002,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
8005
8002
  * @interface
8006
8003
  */
8007
8004
  declare type LaunchExternalProcessRule = {
8008
- behavior: AllowOrBlock;
8005
+ behavior: 'allow' | 'block';
8009
8006
  match: string[];
8010
8007
  };
8011
8008
 
@@ -9975,12 +9972,10 @@ declare namespace OpenFin {
9975
9972
  DomainApiSettings,
9976
9973
  BaseContentBehavior,
9977
9974
  ContentBehavior,
9978
- BaseStructuredContentBehavior,
9979
9975
  BrowserContentBehavior,
9980
9976
  StructuredContentBehavior,
9981
9977
  StructuredContentPermissions,
9982
9978
  ContentPermission,
9983
- AllowOrBlock,
9984
9979
  ScreenCaptureBehavior,
9985
9980
  PerDomainSettings,
9986
9981
  CopyPermissions,
@@ -10174,6 +10169,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10174
10169
 
10175
10170
  /**
10176
10171
  * Control copy operations for a matched URL.
10172
+ * @interface
10177
10173
  */
10178
10174
  declare type PastePermissions = {
10179
10175
  /**
@@ -10344,11 +10340,11 @@ declare type PerDomainSettings = {
10344
10340
  * Defaults to 'allow'.
10345
10341
  * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
10346
10342
  */
10347
- print?: AllowOrBlock;
10343
+ print?: 'allow' | 'block';
10348
10344
  /**
10349
10345
  * * Controls whether HTML5 dragging for this content is allowed or blocked.
10350
10346
  */
10351
- drag?: AllowOrBlock;
10347
+ drag?: 'allow' | 'block';
10352
10348
  };
10353
10349
  };
10354
10350
 
@@ -11744,6 +11740,14 @@ declare interface PlatformProvider {
11744
11740
  * ```
11745
11741
  */
11746
11742
  handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
11743
+ /**
11744
+ * Determines whether a given window should prevent the application from quitting when it is closed.
11745
+ * This method is called when checking if closing a window should trigger application termination.
11746
+ *
11747
+ * @param windowIdentity - The identity of the window being checked.
11748
+ * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
11749
+ */
11750
+ shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
11747
11751
  }
11748
11752
 
11749
11753
  /**
@@ -13534,10 +13538,9 @@ declare type RvmLaunchOptions = {
13534
13538
  };
13535
13539
 
13536
13540
  /**
13537
- * @interface
13538
13541
  * Controls whether this content should be allowed or blocked when capturing the screen.
13539
13542
  */
13540
- declare type ScreenCaptureBehavior = AllowOrBlock;
13543
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13541
13544
 
13542
13545
  /**
13543
13546
  * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
@@ -14026,12 +14029,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
14026
14029
  };
14027
14030
 
14028
14031
  /**
14029
- * Allows more control over content behaviors
14032
+ * Behavior when displaying content from matched URLs.
14030
14033
  */
14031
- declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
14034
+ declare type StructuredContentBehavior = {
14035
+ behavior: BaseContentBehavior;
14036
+ } | BrowserContentBehavior;
14032
14037
 
14033
14038
  /**
14034
- * Specify rules for specific actions.
14039
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
14040
+ * @interface
14035
14041
  */
14036
14042
  declare type StructuredContentPermissions = {
14037
14043
  /**
@@ -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;
@@ -3804,7 +3799,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3804
3799
  };
3805
3800
 
3806
3801
  /**
3807
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
3802
+ * Behavior when displaying content from matched URLs.
3808
3803
  *
3809
3804
  * 'allow': The content url is allowed.
3810
3805
  * 'block': The content url is blocked.
@@ -4041,6 +4036,7 @@ declare type CopyBlockedEventReason = 'disabled';
4041
4036
 
4042
4037
  /**
4043
4038
  * Control copy operations for a matched URL.
4039
+ * @interface
4044
4040
  */
4045
4041
  declare type CopyPermissions = {
4046
4042
  /**
@@ -4052,7 +4048,7 @@ declare type CopyPermissions = {
4052
4048
  * block: Disables all copy operations.
4053
4049
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4054
4050
  */
4055
- behavior: AllowOrBlock | 'protect';
4051
+ behavior: 'allow' | 'block' | 'protect';
4056
4052
  /**
4057
4053
  * Additional copy operation options
4058
4054
  */
@@ -4293,6 +4289,7 @@ declare type DefaultDomainSettings = DomainSettings;
4293
4289
 
4294
4290
  /**
4295
4291
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
4292
+ * @interface
4296
4293
  */
4297
4294
  declare type DefaultDomainSettingsRule = DomainSettingsRule;
4298
4295
 
@@ -4496,9 +4493,8 @@ declare type DomainSettings = {
4496
4493
  };
4497
4494
 
4498
4495
  /**
4499
- * @interface
4500
- *
4501
4496
  * Defines domain-conditional settings for an OpenFin application.
4497
+ * @interface
4502
4498
  */
4503
4499
  declare type DomainSettingsRule = {
4504
4500
  /**
@@ -5799,6 +5795,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5799
5795
  * Domain-conditional rules for file downloads.
5800
5796
  *
5801
5797
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5798
+ * @interface
5802
5799
  */
5803
5800
  declare type FileDownloadSettings = {
5804
5801
  /**
@@ -8005,7 +8002,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
8005
8002
  * @interface
8006
8003
  */
8007
8004
  declare type LaunchExternalProcessRule = {
8008
- behavior: AllowOrBlock;
8005
+ behavior: 'allow' | 'block';
8009
8006
  match: string[];
8010
8007
  };
8011
8008
 
@@ -9975,12 +9972,10 @@ declare namespace OpenFin {
9975
9972
  DomainApiSettings,
9976
9973
  BaseContentBehavior,
9977
9974
  ContentBehavior,
9978
- BaseStructuredContentBehavior,
9979
9975
  BrowserContentBehavior,
9980
9976
  StructuredContentBehavior,
9981
9977
  StructuredContentPermissions,
9982
9978
  ContentPermission,
9983
- AllowOrBlock,
9984
9979
  ScreenCaptureBehavior,
9985
9980
  PerDomainSettings,
9986
9981
  CopyPermissions,
@@ -10174,6 +10169,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10174
10169
 
10175
10170
  /**
10176
10171
  * Control copy operations for a matched URL.
10172
+ * @interface
10177
10173
  */
10178
10174
  declare type PastePermissions = {
10179
10175
  /**
@@ -10344,11 +10340,11 @@ declare type PerDomainSettings = {
10344
10340
  * Defaults to 'allow'.
10345
10341
  * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
10346
10342
  */
10347
- print?: AllowOrBlock;
10343
+ print?: 'allow' | 'block';
10348
10344
  /**
10349
10345
  * * Controls whether HTML5 dragging for this content is allowed or blocked.
10350
10346
  */
10351
- drag?: AllowOrBlock;
10347
+ drag?: 'allow' | 'block';
10352
10348
  };
10353
10349
  };
10354
10350
 
@@ -11744,6 +11740,14 @@ declare interface PlatformProvider {
11744
11740
  * ```
11745
11741
  */
11746
11742
  handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
11743
+ /**
11744
+ * Determines whether a given window should prevent the application from quitting when it is closed.
11745
+ * This method is called when checking if closing a window should trigger application termination.
11746
+ *
11747
+ * @param windowIdentity - The identity of the window being checked.
11748
+ * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
11749
+ */
11750
+ shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
11747
11751
  }
11748
11752
 
11749
11753
  /**
@@ -13534,10 +13538,9 @@ declare type RvmLaunchOptions = {
13534
13538
  };
13535
13539
 
13536
13540
  /**
13537
- * @interface
13538
13541
  * Controls whether this content should be allowed or blocked when capturing the screen.
13539
13542
  */
13540
- declare type ScreenCaptureBehavior = AllowOrBlock;
13543
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13541
13544
 
13542
13545
  /**
13543
13546
  * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
@@ -14026,12 +14029,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
14026
14029
  };
14027
14030
 
14028
14031
  /**
14029
- * Allows more control over content behaviors
14032
+ * Behavior when displaying content from matched URLs.
14030
14033
  */
14031
- declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
14034
+ declare type StructuredContentBehavior = {
14035
+ behavior: BaseContentBehavior;
14036
+ } | BrowserContentBehavior;
14032
14037
 
14033
14038
  /**
14034
- * Specify rules for specific actions.
14039
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
14040
+ * @interface
14035
14041
  */
14036
14042
  declare type StructuredContentPermissions = {
14037
14043
  /**
@@ -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;
@@ -3804,7 +3799,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3804
3799
  };
3805
3800
 
3806
3801
  /**
3807
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
3802
+ * Behavior when displaying content from matched URLs.
3808
3803
  *
3809
3804
  * 'allow': The content url is allowed.
3810
3805
  * 'block': The content url is blocked.
@@ -4041,6 +4036,7 @@ declare type CopyBlockedEventReason = 'disabled';
4041
4036
 
4042
4037
  /**
4043
4038
  * Control copy operations for a matched URL.
4039
+ * @interface
4044
4040
  */
4045
4041
  declare type CopyPermissions = {
4046
4042
  /**
@@ -4052,7 +4048,7 @@ declare type CopyPermissions = {
4052
4048
  * block: Disables all copy operations.
4053
4049
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4054
4050
  */
4055
- behavior: AllowOrBlock | 'protect';
4051
+ behavior: 'allow' | 'block' | 'protect';
4056
4052
  /**
4057
4053
  * Additional copy operation options
4058
4054
  */
@@ -4293,6 +4289,7 @@ declare type DefaultDomainSettings = DomainSettings;
4293
4289
 
4294
4290
  /**
4295
4291
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
4292
+ * @interface
4296
4293
  */
4297
4294
  declare type DefaultDomainSettingsRule = DomainSettingsRule;
4298
4295
 
@@ -4496,9 +4493,8 @@ declare type DomainSettings = {
4496
4493
  };
4497
4494
 
4498
4495
  /**
4499
- * @interface
4500
- *
4501
4496
  * Defines domain-conditional settings for an OpenFin application.
4497
+ * @interface
4502
4498
  */
4503
4499
  declare type DomainSettingsRule = {
4504
4500
  /**
@@ -5799,6 +5795,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5799
5795
  * Domain-conditional rules for file downloads.
5800
5796
  *
5801
5797
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5798
+ * @interface
5802
5799
  */
5803
5800
  declare type FileDownloadSettings = {
5804
5801
  /**
@@ -8005,7 +8002,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
8005
8002
  * @interface
8006
8003
  */
8007
8004
  declare type LaunchExternalProcessRule = {
8008
- behavior: AllowOrBlock;
8005
+ behavior: 'allow' | 'block';
8009
8006
  match: string[];
8010
8007
  };
8011
8008
 
@@ -9975,12 +9972,10 @@ declare namespace OpenFin {
9975
9972
  DomainApiSettings,
9976
9973
  BaseContentBehavior,
9977
9974
  ContentBehavior,
9978
- BaseStructuredContentBehavior,
9979
9975
  BrowserContentBehavior,
9980
9976
  StructuredContentBehavior,
9981
9977
  StructuredContentPermissions,
9982
9978
  ContentPermission,
9983
- AllowOrBlock,
9984
9979
  ScreenCaptureBehavior,
9985
9980
  PerDomainSettings,
9986
9981
  CopyPermissions,
@@ -10174,6 +10169,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10174
10169
 
10175
10170
  /**
10176
10171
  * Control copy operations for a matched URL.
10172
+ * @interface
10177
10173
  */
10178
10174
  declare type PastePermissions = {
10179
10175
  /**
@@ -10344,11 +10340,11 @@ declare type PerDomainSettings = {
10344
10340
  * Defaults to 'allow'.
10345
10341
  * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
10346
10342
  */
10347
- print?: AllowOrBlock;
10343
+ print?: 'allow' | 'block';
10348
10344
  /**
10349
10345
  * * Controls whether HTML5 dragging for this content is allowed or blocked.
10350
10346
  */
10351
- drag?: AllowOrBlock;
10347
+ drag?: 'allow' | 'block';
10352
10348
  };
10353
10349
  };
10354
10350
 
@@ -11744,6 +11740,14 @@ declare interface PlatformProvider {
11744
11740
  * ```
11745
11741
  */
11746
11742
  handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
11743
+ /**
11744
+ * Determines whether a given window should prevent the application from quitting when it is closed.
11745
+ * This method is called when checking if closing a window should trigger application termination.
11746
+ *
11747
+ * @param windowIdentity - The identity of the window being checked.
11748
+ * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
11749
+ */
11750
+ shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
11747
11751
  }
11748
11752
 
11749
11753
  /**
@@ -13534,10 +13538,9 @@ declare type RvmLaunchOptions = {
13534
13538
  };
13535
13539
 
13536
13540
  /**
13537
- * @interface
13538
13541
  * Controls whether this content should be allowed or blocked when capturing the screen.
13539
13542
  */
13540
- declare type ScreenCaptureBehavior = AllowOrBlock;
13543
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13541
13544
 
13542
13545
  /**
13543
13546
  * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
@@ -14026,12 +14029,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
14026
14029
  };
14027
14030
 
14028
14031
  /**
14029
- * Allows more control over content behaviors
14032
+ * Behavior when displaying content from matched URLs.
14030
14033
  */
14031
- declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
14034
+ declare type StructuredContentBehavior = {
14035
+ behavior: BaseContentBehavior;
14036
+ } | BrowserContentBehavior;
14032
14037
 
14033
14038
  /**
14034
- * Specify rules for specific actions.
14039
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
14040
+ * @interface
14035
14041
  */
14036
14042
  declare type StructuredContentPermissions = {
14037
14043
  /**
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;
@@ -3863,7 +3858,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3863
3858
  };
3864
3859
 
3865
3860
  /**
3866
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
3861
+ * Behavior when displaying content from matched URLs.
3867
3862
  *
3868
3863
  * 'allow': The content url is allowed.
3869
3864
  * 'block': The content url is blocked.
@@ -4100,6 +4095,7 @@ declare type CopyBlockedEventReason = 'disabled';
4100
4095
 
4101
4096
  /**
4102
4097
  * Control copy operations for a matched URL.
4098
+ * @interface
4103
4099
  */
4104
4100
  declare type CopyPermissions = {
4105
4101
  /**
@@ -4111,7 +4107,7 @@ declare type CopyPermissions = {
4111
4107
  * block: Disables all copy operations.
4112
4108
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4113
4109
  */
4114
- behavior: AllowOrBlock | 'protect';
4110
+ behavior: 'allow' | 'block' | 'protect';
4115
4111
  /**
4116
4112
  * Additional copy operation options
4117
4113
  */
@@ -4352,6 +4348,7 @@ declare type DefaultDomainSettings = DomainSettings;
4352
4348
 
4353
4349
  /**
4354
4350
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
4351
+ * @interface
4355
4352
  */
4356
4353
  declare type DefaultDomainSettingsRule = DomainSettingsRule;
4357
4354
 
@@ -4555,9 +4552,8 @@ declare type DomainSettings = {
4555
4552
  };
4556
4553
 
4557
4554
  /**
4558
- * @interface
4559
- *
4560
4555
  * Defines domain-conditional settings for an OpenFin application.
4556
+ * @interface
4561
4557
  */
4562
4558
  declare type DomainSettingsRule = {
4563
4559
  /**
@@ -5884,6 +5880,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5884
5880
  * Domain-conditional rules for file downloads.
5885
5881
  *
5886
5882
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5883
+ * @interface
5887
5884
  */
5888
5885
  declare type FileDownloadSettings = {
5889
5886
  /**
@@ -8122,7 +8119,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
8122
8119
  * @interface
8123
8120
  */
8124
8121
  declare type LaunchExternalProcessRule = {
8125
- behavior: AllowOrBlock;
8122
+ behavior: 'allow' | 'block';
8126
8123
  match: string[];
8127
8124
  };
8128
8125
 
@@ -10293,12 +10290,10 @@ declare namespace OpenFin {
10293
10290
  DomainApiSettings,
10294
10291
  BaseContentBehavior,
10295
10292
  ContentBehavior,
10296
- BaseStructuredContentBehavior,
10297
10293
  BrowserContentBehavior,
10298
10294
  StructuredContentBehavior,
10299
10295
  StructuredContentPermissions,
10300
10296
  ContentPermission,
10301
- AllowOrBlock,
10302
10297
  ScreenCaptureBehavior,
10303
10298
  PerDomainSettings,
10304
10299
  CopyPermissions,
@@ -10492,6 +10487,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10492
10487
 
10493
10488
  /**
10494
10489
  * Control copy operations for a matched URL.
10490
+ * @interface
10495
10491
  */
10496
10492
  declare type PastePermissions = {
10497
10493
  /**
@@ -10662,11 +10658,11 @@ declare type PerDomainSettings = {
10662
10658
  * Defaults to 'allow'.
10663
10659
  * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
10664
10660
  */
10665
- print?: AllowOrBlock;
10661
+ print?: 'allow' | 'block';
10666
10662
  /**
10667
10663
  * * Controls whether HTML5 dragging for this content is allowed or blocked.
10668
10664
  */
10669
- drag?: AllowOrBlock;
10665
+ drag?: 'allow' | 'block';
10670
10666
  };
10671
10667
  };
10672
10668
 
@@ -12145,6 +12141,14 @@ declare interface PlatformProvider {
12145
12141
  * ```
12146
12142
  */
12147
12143
  handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
12144
+ /**
12145
+ * Determines whether a given window should prevent the application from quitting when it is closed.
12146
+ * This method is called when checking if closing a window should trigger application termination.
12147
+ *
12148
+ * @param windowIdentity - The identity of the window being checked.
12149
+ * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
12150
+ */
12151
+ shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
12148
12152
  }
12149
12153
 
12150
12154
  /**
@@ -13935,10 +13939,9 @@ declare type RvmLaunchOptions = {
13935
13939
  };
13936
13940
 
13937
13941
  /**
13938
- * @interface
13939
13942
  * Controls whether this content should be allowed or blocked when capturing the screen.
13940
13943
  */
13941
- declare type ScreenCaptureBehavior = AllowOrBlock;
13944
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13942
13945
 
13943
13946
  /**
13944
13947
  * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
@@ -14430,12 +14433,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
14430
14433
  };
14431
14434
 
14432
14435
  /**
14433
- * Allows more control over content behaviors
14436
+ * Behavior when displaying content from matched URLs.
14434
14437
  */
14435
- declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
14438
+ declare type StructuredContentBehavior = {
14439
+ behavior: BaseContentBehavior;
14440
+ } | BrowserContentBehavior;
14436
14441
 
14437
14442
  /**
14438
- * Specify rules for specific actions.
14443
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
14444
+ * @interface
14439
14445
  */
14440
14446
  declare type StructuredContentPermissions = {
14441
14447
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "40.103.10",
3
+ "version": "40.103.12",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,