@openfin/fdc3-api 36.79.4 → 36.79.9
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.
- package/out/fdc3-api-alpha.d.ts +68 -12
- package/out/fdc3-api-beta.d.ts +68 -12
- package/out/fdc3-api-public.d.ts +68 -12
- package/out/fdc3-api.d.ts +68 -12
- package/package.json +1 -1
package/out/fdc3-api-alpha.d.ts
CHANGED
|
@@ -97,7 +97,10 @@ declare type Api = {
|
|
|
97
97
|
enableDeprecatedSharedName?: boolean;
|
|
98
98
|
};
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* Configure injection of the `fin` API in this context.
|
|
101
|
+
*
|
|
102
|
+
* * 'none': The `fin` API will be not available in this context.
|
|
103
|
+
* * 'global': The entire `fin` API will be available in this context.
|
|
101
104
|
*/
|
|
102
105
|
fin?: InjectionType;
|
|
103
106
|
};
|
|
@@ -113,8 +116,18 @@ declare type ApiClient<T extends Record<any, any>> = {
|
|
|
113
116
|
|
|
114
117
|
/**
|
|
115
118
|
* @interface
|
|
119
|
+
*
|
|
120
|
+
* Rules for domain-conditional `fin` API injection.
|
|
116
121
|
*/
|
|
117
122
|
declare type ApiInjection = {
|
|
123
|
+
/**
|
|
124
|
+
* Injection setting for the `fin` API for contexts on a matched domain.
|
|
125
|
+
*
|
|
126
|
+
* * 'none': The `fin` API will be not available.
|
|
127
|
+
* * 'global': The entire `fin` API will be available.
|
|
128
|
+
*
|
|
129
|
+
* @defaultValue 'global'
|
|
130
|
+
*/
|
|
118
131
|
fin: InjectionType;
|
|
119
132
|
};
|
|
120
133
|
|
|
@@ -1712,7 +1725,7 @@ declare type BaseConfig = {
|
|
|
1712
1725
|
*/
|
|
1713
1726
|
declare type BaseContentCreationRule = {
|
|
1714
1727
|
/**
|
|
1715
|
-
* List of [match patterns](https://developer.chrome.com/extensions/
|
|
1728
|
+
* List of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) that indicate the specified
|
|
1716
1729
|
* behavior should be used
|
|
1717
1730
|
*/
|
|
1718
1731
|
match: MatchPattern[];
|
|
@@ -3608,13 +3621,13 @@ declare type ConstWindowOptions = {
|
|
|
3608
3621
|
/**
|
|
3609
3622
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
3610
3623
|
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
3611
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
3624
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
3612
3625
|
*/
|
|
3613
3626
|
contentNavigation: ContentNavigation;
|
|
3614
3627
|
/**
|
|
3615
3628
|
* Restrict redirects to URLs that match an allowed pattern.
|
|
3616
3629
|
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
|
3617
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
3630
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
3618
3631
|
*/
|
|
3619
3632
|
contentRedirect: Partial<ContentRedirect>;
|
|
3620
3633
|
/**
|
|
@@ -4159,7 +4172,7 @@ declare interface ContentItem extends EventEmitter_2 {
|
|
|
4159
4172
|
/**
|
|
4160
4173
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
4161
4174
|
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
4162
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
4175
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
4163
4176
|
*
|
|
4164
4177
|
* @interface
|
|
4165
4178
|
*/
|
|
@@ -4168,7 +4181,7 @@ declare type ContentNavigation = NavigationRules;
|
|
|
4168
4181
|
/**
|
|
4169
4182
|
* Restrict redirects to URLs that match an allowed pattern.
|
|
4170
4183
|
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
|
4171
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
4184
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
4172
4185
|
*
|
|
4173
4186
|
* @interface
|
|
4174
4187
|
*/
|
|
@@ -4772,19 +4785,42 @@ declare type DisplayMetadata_3 = {
|
|
|
4772
4785
|
|
|
4773
4786
|
/**
|
|
4774
4787
|
* @interface
|
|
4775
|
-
*
|
|
4788
|
+
* Defines application settings that vary by the domain of the current context.
|
|
4789
|
+
*
|
|
4790
|
+
* @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
|
|
4791
|
+
* domain should be represented with a single rule.
|
|
4776
4792
|
*/
|
|
4777
4793
|
declare type DomainSettings = {
|
|
4794
|
+
/**
|
|
4795
|
+
* {@inheritDoc DomainSettingsRule}
|
|
4796
|
+
*/
|
|
4778
4797
|
rules: DomainSettingsRule[];
|
|
4779
4798
|
};
|
|
4780
4799
|
|
|
4781
4800
|
/**
|
|
4782
4801
|
* @interface
|
|
4802
|
+
*
|
|
4803
|
+
* Defines domain-conditional settings for an OpenFin application.
|
|
4783
4804
|
*/
|
|
4784
4805
|
declare type DomainSettingsRule = {
|
|
4806
|
+
/**
|
|
4807
|
+
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
|
4808
|
+
* the domain(s) for which the rule applies.
|
|
4809
|
+
*/
|
|
4785
4810
|
match: string[];
|
|
4811
|
+
/**
|
|
4812
|
+
* Settings applied when a webcontents has been navigated to a matched domain.
|
|
4813
|
+
*/
|
|
4786
4814
|
options: {
|
|
4815
|
+
/**
|
|
4816
|
+
* {@inheritDoc FileDownloadSettings}
|
|
4817
|
+
*
|
|
4818
|
+
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
|
4819
|
+
*/
|
|
4787
4820
|
downloadSettings?: FileDownloadSettings;
|
|
4821
|
+
/**
|
|
4822
|
+
* {@inheritDoc ApiInjection}
|
|
4823
|
+
*/
|
|
4788
4824
|
api?: ApiInjection;
|
|
4789
4825
|
};
|
|
4790
4826
|
};
|
|
@@ -4823,9 +4859,20 @@ declare type DownloadPreloadOption = {
|
|
|
4823
4859
|
|
|
4824
4860
|
/**
|
|
4825
4861
|
* @interface
|
|
4862
|
+
*
|
|
4863
|
+
* A rule governing domain-conditional download behavior.
|
|
4826
4864
|
*/
|
|
4827
4865
|
declare type DownloadRule = {
|
|
4866
|
+
/**
|
|
4867
|
+
* {@inheritDoc FileDownloadBehaviorNames}
|
|
4868
|
+
*/
|
|
4828
4869
|
behavior: FileDownloadBehaviorNames;
|
|
4870
|
+
/**
|
|
4871
|
+
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
|
4872
|
+
* the domain(s) for which the rule applies.
|
|
4873
|
+
*
|
|
4874
|
+
* @remarks The match is evaluated against the URL of the *download*.
|
|
4875
|
+
*/
|
|
4829
4876
|
match: string[];
|
|
4830
4877
|
};
|
|
4831
4878
|
|
|
@@ -5857,6 +5904,9 @@ declare type FetchManifestPayload = {
|
|
|
5857
5904
|
manifestUrl: string;
|
|
5858
5905
|
};
|
|
5859
5906
|
|
|
5907
|
+
/**
|
|
5908
|
+
* Whether file downloads raise a user prompt.
|
|
5909
|
+
*/
|
|
5860
5910
|
declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
|
|
5861
5911
|
|
|
5862
5912
|
/**
|
|
@@ -5939,9 +5989,14 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
|
5939
5989
|
};
|
|
5940
5990
|
|
|
5941
5991
|
/**
|
|
5942
|
-
*
|
|
5992
|
+
* Domain-conditional rules for file downloads.
|
|
5993
|
+
*
|
|
5994
|
+
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
|
5943
5995
|
*/
|
|
5944
5996
|
declare type FileDownloadSettings = {
|
|
5997
|
+
/**
|
|
5998
|
+
* {@inheritDoc DownloadRule}
|
|
5999
|
+
*/
|
|
5945
6000
|
rules: DownloadRule[];
|
|
5946
6001
|
};
|
|
5947
6002
|
|
|
@@ -7004,9 +7059,10 @@ declare type InitPlatformOptions = {
|
|
|
7004
7059
|
};
|
|
7005
7060
|
|
|
7006
7061
|
/**
|
|
7007
|
-
*
|
|
7008
|
-
*
|
|
7009
|
-
*
|
|
7062
|
+
* Injection setting for the `fin` API.
|
|
7063
|
+
*
|
|
7064
|
+
* * 'none': The `fin` API will be not available.
|
|
7065
|
+
* * 'global': The entire `fin` API will be available.
|
|
7010
7066
|
*/
|
|
7011
7067
|
declare type InjectionType = 'none' | 'global';
|
|
7012
7068
|
|
|
@@ -9707,7 +9763,7 @@ declare type MutableViewOptions = {
|
|
|
9707
9763
|
/**
|
|
9708
9764
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
9709
9765
|
* In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
|
|
9710
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
9766
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
9711
9767
|
*/
|
|
9712
9768
|
contentNavigation: ContentNavigation;
|
|
9713
9769
|
contentRedirect: ContentRedirect;
|
package/out/fdc3-api-beta.d.ts
CHANGED
|
@@ -97,7 +97,10 @@ declare type Api = {
|
|
|
97
97
|
enableDeprecatedSharedName?: boolean;
|
|
98
98
|
};
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* Configure injection of the `fin` API in this context.
|
|
101
|
+
*
|
|
102
|
+
* * 'none': The `fin` API will be not available in this context.
|
|
103
|
+
* * 'global': The entire `fin` API will be available in this context.
|
|
101
104
|
*/
|
|
102
105
|
fin?: InjectionType;
|
|
103
106
|
};
|
|
@@ -113,8 +116,18 @@ declare type ApiClient<T extends Record<any, any>> = {
|
|
|
113
116
|
|
|
114
117
|
/**
|
|
115
118
|
* @interface
|
|
119
|
+
*
|
|
120
|
+
* Rules for domain-conditional `fin` API injection.
|
|
116
121
|
*/
|
|
117
122
|
declare type ApiInjection = {
|
|
123
|
+
/**
|
|
124
|
+
* Injection setting for the `fin` API for contexts on a matched domain.
|
|
125
|
+
*
|
|
126
|
+
* * 'none': The `fin` API will be not available.
|
|
127
|
+
* * 'global': The entire `fin` API will be available.
|
|
128
|
+
*
|
|
129
|
+
* @defaultValue 'global'
|
|
130
|
+
*/
|
|
118
131
|
fin: InjectionType;
|
|
119
132
|
};
|
|
120
133
|
|
|
@@ -1712,7 +1725,7 @@ declare type BaseConfig = {
|
|
|
1712
1725
|
*/
|
|
1713
1726
|
declare type BaseContentCreationRule = {
|
|
1714
1727
|
/**
|
|
1715
|
-
* List of [match patterns](https://developer.chrome.com/extensions/
|
|
1728
|
+
* List of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) that indicate the specified
|
|
1716
1729
|
* behavior should be used
|
|
1717
1730
|
*/
|
|
1718
1731
|
match: MatchPattern[];
|
|
@@ -3608,13 +3621,13 @@ declare type ConstWindowOptions = {
|
|
|
3608
3621
|
/**
|
|
3609
3622
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
3610
3623
|
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
3611
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
3624
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
3612
3625
|
*/
|
|
3613
3626
|
contentNavigation: ContentNavigation;
|
|
3614
3627
|
/**
|
|
3615
3628
|
* Restrict redirects to URLs that match an allowed pattern.
|
|
3616
3629
|
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
|
3617
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
3630
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
3618
3631
|
*/
|
|
3619
3632
|
contentRedirect: Partial<ContentRedirect>;
|
|
3620
3633
|
/**
|
|
@@ -4159,7 +4172,7 @@ declare interface ContentItem extends EventEmitter_2 {
|
|
|
4159
4172
|
/**
|
|
4160
4173
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
4161
4174
|
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
4162
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
4175
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
4163
4176
|
*
|
|
4164
4177
|
* @interface
|
|
4165
4178
|
*/
|
|
@@ -4168,7 +4181,7 @@ declare type ContentNavigation = NavigationRules;
|
|
|
4168
4181
|
/**
|
|
4169
4182
|
* Restrict redirects to URLs that match an allowed pattern.
|
|
4170
4183
|
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
|
4171
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
4184
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
4172
4185
|
*
|
|
4173
4186
|
* @interface
|
|
4174
4187
|
*/
|
|
@@ -4772,19 +4785,42 @@ declare type DisplayMetadata_3 = {
|
|
|
4772
4785
|
|
|
4773
4786
|
/**
|
|
4774
4787
|
* @interface
|
|
4775
|
-
*
|
|
4788
|
+
* Defines application settings that vary by the domain of the current context.
|
|
4789
|
+
*
|
|
4790
|
+
* @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
|
|
4791
|
+
* domain should be represented with a single rule.
|
|
4776
4792
|
*/
|
|
4777
4793
|
declare type DomainSettings = {
|
|
4794
|
+
/**
|
|
4795
|
+
* {@inheritDoc DomainSettingsRule}
|
|
4796
|
+
*/
|
|
4778
4797
|
rules: DomainSettingsRule[];
|
|
4779
4798
|
};
|
|
4780
4799
|
|
|
4781
4800
|
/**
|
|
4782
4801
|
* @interface
|
|
4802
|
+
*
|
|
4803
|
+
* Defines domain-conditional settings for an OpenFin application.
|
|
4783
4804
|
*/
|
|
4784
4805
|
declare type DomainSettingsRule = {
|
|
4806
|
+
/**
|
|
4807
|
+
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
|
4808
|
+
* the domain(s) for which the rule applies.
|
|
4809
|
+
*/
|
|
4785
4810
|
match: string[];
|
|
4811
|
+
/**
|
|
4812
|
+
* Settings applied when a webcontents has been navigated to a matched domain.
|
|
4813
|
+
*/
|
|
4786
4814
|
options: {
|
|
4815
|
+
/**
|
|
4816
|
+
* {@inheritDoc FileDownloadSettings}
|
|
4817
|
+
*
|
|
4818
|
+
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
|
4819
|
+
*/
|
|
4787
4820
|
downloadSettings?: FileDownloadSettings;
|
|
4821
|
+
/**
|
|
4822
|
+
* {@inheritDoc ApiInjection}
|
|
4823
|
+
*/
|
|
4788
4824
|
api?: ApiInjection;
|
|
4789
4825
|
};
|
|
4790
4826
|
};
|
|
@@ -4823,9 +4859,20 @@ declare type DownloadPreloadOption = {
|
|
|
4823
4859
|
|
|
4824
4860
|
/**
|
|
4825
4861
|
* @interface
|
|
4862
|
+
*
|
|
4863
|
+
* A rule governing domain-conditional download behavior.
|
|
4826
4864
|
*/
|
|
4827
4865
|
declare type DownloadRule = {
|
|
4866
|
+
/**
|
|
4867
|
+
* {@inheritDoc FileDownloadBehaviorNames}
|
|
4868
|
+
*/
|
|
4828
4869
|
behavior: FileDownloadBehaviorNames;
|
|
4870
|
+
/**
|
|
4871
|
+
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
|
4872
|
+
* the domain(s) for which the rule applies.
|
|
4873
|
+
*
|
|
4874
|
+
* @remarks The match is evaluated against the URL of the *download*.
|
|
4875
|
+
*/
|
|
4829
4876
|
match: string[];
|
|
4830
4877
|
};
|
|
4831
4878
|
|
|
@@ -5857,6 +5904,9 @@ declare type FetchManifestPayload = {
|
|
|
5857
5904
|
manifestUrl: string;
|
|
5858
5905
|
};
|
|
5859
5906
|
|
|
5907
|
+
/**
|
|
5908
|
+
* Whether file downloads raise a user prompt.
|
|
5909
|
+
*/
|
|
5860
5910
|
declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
|
|
5861
5911
|
|
|
5862
5912
|
/**
|
|
@@ -5939,9 +5989,14 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
|
5939
5989
|
};
|
|
5940
5990
|
|
|
5941
5991
|
/**
|
|
5942
|
-
*
|
|
5992
|
+
* Domain-conditional rules for file downloads.
|
|
5993
|
+
*
|
|
5994
|
+
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
|
5943
5995
|
*/
|
|
5944
5996
|
declare type FileDownloadSettings = {
|
|
5997
|
+
/**
|
|
5998
|
+
* {@inheritDoc DownloadRule}
|
|
5999
|
+
*/
|
|
5945
6000
|
rules: DownloadRule[];
|
|
5946
6001
|
};
|
|
5947
6002
|
|
|
@@ -7004,9 +7059,10 @@ declare type InitPlatformOptions = {
|
|
|
7004
7059
|
};
|
|
7005
7060
|
|
|
7006
7061
|
/**
|
|
7007
|
-
*
|
|
7008
|
-
*
|
|
7009
|
-
*
|
|
7062
|
+
* Injection setting for the `fin` API.
|
|
7063
|
+
*
|
|
7064
|
+
* * 'none': The `fin` API will be not available.
|
|
7065
|
+
* * 'global': The entire `fin` API will be available.
|
|
7010
7066
|
*/
|
|
7011
7067
|
declare type InjectionType = 'none' | 'global';
|
|
7012
7068
|
|
|
@@ -9707,7 +9763,7 @@ declare type MutableViewOptions = {
|
|
|
9707
9763
|
/**
|
|
9708
9764
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
9709
9765
|
* In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
|
|
9710
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
9766
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
9711
9767
|
*/
|
|
9712
9768
|
contentNavigation: ContentNavigation;
|
|
9713
9769
|
contentRedirect: ContentRedirect;
|
package/out/fdc3-api-public.d.ts
CHANGED
|
@@ -97,7 +97,10 @@ declare type Api = {
|
|
|
97
97
|
enableDeprecatedSharedName?: boolean;
|
|
98
98
|
};
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* Configure injection of the `fin` API in this context.
|
|
101
|
+
*
|
|
102
|
+
* * 'none': The `fin` API will be not available in this context.
|
|
103
|
+
* * 'global': The entire `fin` API will be available in this context.
|
|
101
104
|
*/
|
|
102
105
|
fin?: InjectionType;
|
|
103
106
|
};
|
|
@@ -113,8 +116,18 @@ declare type ApiClient<T extends Record<any, any>> = {
|
|
|
113
116
|
|
|
114
117
|
/**
|
|
115
118
|
* @interface
|
|
119
|
+
*
|
|
120
|
+
* Rules for domain-conditional `fin` API injection.
|
|
116
121
|
*/
|
|
117
122
|
declare type ApiInjection = {
|
|
123
|
+
/**
|
|
124
|
+
* Injection setting for the `fin` API for contexts on a matched domain.
|
|
125
|
+
*
|
|
126
|
+
* * 'none': The `fin` API will be not available.
|
|
127
|
+
* * 'global': The entire `fin` API will be available.
|
|
128
|
+
*
|
|
129
|
+
* @defaultValue 'global'
|
|
130
|
+
*/
|
|
118
131
|
fin: InjectionType;
|
|
119
132
|
};
|
|
120
133
|
|
|
@@ -1712,7 +1725,7 @@ declare type BaseConfig = {
|
|
|
1712
1725
|
*/
|
|
1713
1726
|
declare type BaseContentCreationRule = {
|
|
1714
1727
|
/**
|
|
1715
|
-
* List of [match patterns](https://developer.chrome.com/extensions/
|
|
1728
|
+
* List of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) that indicate the specified
|
|
1716
1729
|
* behavior should be used
|
|
1717
1730
|
*/
|
|
1718
1731
|
match: MatchPattern[];
|
|
@@ -3608,13 +3621,13 @@ declare type ConstWindowOptions = {
|
|
|
3608
3621
|
/**
|
|
3609
3622
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
3610
3623
|
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
3611
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
3624
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
3612
3625
|
*/
|
|
3613
3626
|
contentNavigation: ContentNavigation;
|
|
3614
3627
|
/**
|
|
3615
3628
|
* Restrict redirects to URLs that match an allowed pattern.
|
|
3616
3629
|
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
|
3617
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
3630
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
3618
3631
|
*/
|
|
3619
3632
|
contentRedirect: Partial<ContentRedirect>;
|
|
3620
3633
|
/**
|
|
@@ -4159,7 +4172,7 @@ declare interface ContentItem extends EventEmitter_2 {
|
|
|
4159
4172
|
/**
|
|
4160
4173
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
4161
4174
|
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
4162
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
4175
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
4163
4176
|
*
|
|
4164
4177
|
* @interface
|
|
4165
4178
|
*/
|
|
@@ -4168,7 +4181,7 @@ declare type ContentNavigation = NavigationRules;
|
|
|
4168
4181
|
/**
|
|
4169
4182
|
* Restrict redirects to URLs that match an allowed pattern.
|
|
4170
4183
|
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
|
4171
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
4184
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
4172
4185
|
*
|
|
4173
4186
|
* @interface
|
|
4174
4187
|
*/
|
|
@@ -4772,19 +4785,42 @@ declare type DisplayMetadata_3 = {
|
|
|
4772
4785
|
|
|
4773
4786
|
/**
|
|
4774
4787
|
* @interface
|
|
4775
|
-
*
|
|
4788
|
+
* Defines application settings that vary by the domain of the current context.
|
|
4789
|
+
*
|
|
4790
|
+
* @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
|
|
4791
|
+
* domain should be represented with a single rule.
|
|
4776
4792
|
*/
|
|
4777
4793
|
declare type DomainSettings = {
|
|
4794
|
+
/**
|
|
4795
|
+
* {@inheritDoc DomainSettingsRule}
|
|
4796
|
+
*/
|
|
4778
4797
|
rules: DomainSettingsRule[];
|
|
4779
4798
|
};
|
|
4780
4799
|
|
|
4781
4800
|
/**
|
|
4782
4801
|
* @interface
|
|
4802
|
+
*
|
|
4803
|
+
* Defines domain-conditional settings for an OpenFin application.
|
|
4783
4804
|
*/
|
|
4784
4805
|
declare type DomainSettingsRule = {
|
|
4806
|
+
/**
|
|
4807
|
+
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
|
4808
|
+
* the domain(s) for which the rule applies.
|
|
4809
|
+
*/
|
|
4785
4810
|
match: string[];
|
|
4811
|
+
/**
|
|
4812
|
+
* Settings applied when a webcontents has been navigated to a matched domain.
|
|
4813
|
+
*/
|
|
4786
4814
|
options: {
|
|
4815
|
+
/**
|
|
4816
|
+
* {@inheritDoc FileDownloadSettings}
|
|
4817
|
+
*
|
|
4818
|
+
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
|
4819
|
+
*/
|
|
4787
4820
|
downloadSettings?: FileDownloadSettings;
|
|
4821
|
+
/**
|
|
4822
|
+
* {@inheritDoc ApiInjection}
|
|
4823
|
+
*/
|
|
4788
4824
|
api?: ApiInjection;
|
|
4789
4825
|
};
|
|
4790
4826
|
};
|
|
@@ -4823,9 +4859,20 @@ declare type DownloadPreloadOption = {
|
|
|
4823
4859
|
|
|
4824
4860
|
/**
|
|
4825
4861
|
* @interface
|
|
4862
|
+
*
|
|
4863
|
+
* A rule governing domain-conditional download behavior.
|
|
4826
4864
|
*/
|
|
4827
4865
|
declare type DownloadRule = {
|
|
4866
|
+
/**
|
|
4867
|
+
* {@inheritDoc FileDownloadBehaviorNames}
|
|
4868
|
+
*/
|
|
4828
4869
|
behavior: FileDownloadBehaviorNames;
|
|
4870
|
+
/**
|
|
4871
|
+
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
|
4872
|
+
* the domain(s) for which the rule applies.
|
|
4873
|
+
*
|
|
4874
|
+
* @remarks The match is evaluated against the URL of the *download*.
|
|
4875
|
+
*/
|
|
4829
4876
|
match: string[];
|
|
4830
4877
|
};
|
|
4831
4878
|
|
|
@@ -5857,6 +5904,9 @@ declare type FetchManifestPayload = {
|
|
|
5857
5904
|
manifestUrl: string;
|
|
5858
5905
|
};
|
|
5859
5906
|
|
|
5907
|
+
/**
|
|
5908
|
+
* Whether file downloads raise a user prompt.
|
|
5909
|
+
*/
|
|
5860
5910
|
declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
|
|
5861
5911
|
|
|
5862
5912
|
/**
|
|
@@ -5939,9 +5989,14 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
|
5939
5989
|
};
|
|
5940
5990
|
|
|
5941
5991
|
/**
|
|
5942
|
-
*
|
|
5992
|
+
* Domain-conditional rules for file downloads.
|
|
5993
|
+
*
|
|
5994
|
+
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
|
5943
5995
|
*/
|
|
5944
5996
|
declare type FileDownloadSettings = {
|
|
5997
|
+
/**
|
|
5998
|
+
* {@inheritDoc DownloadRule}
|
|
5999
|
+
*/
|
|
5945
6000
|
rules: DownloadRule[];
|
|
5946
6001
|
};
|
|
5947
6002
|
|
|
@@ -7004,9 +7059,10 @@ declare type InitPlatformOptions = {
|
|
|
7004
7059
|
};
|
|
7005
7060
|
|
|
7006
7061
|
/**
|
|
7007
|
-
*
|
|
7008
|
-
*
|
|
7009
|
-
*
|
|
7062
|
+
* Injection setting for the `fin` API.
|
|
7063
|
+
*
|
|
7064
|
+
* * 'none': The `fin` API will be not available.
|
|
7065
|
+
* * 'global': The entire `fin` API will be available.
|
|
7010
7066
|
*/
|
|
7011
7067
|
declare type InjectionType = 'none' | 'global';
|
|
7012
7068
|
|
|
@@ -9707,7 +9763,7 @@ declare type MutableViewOptions = {
|
|
|
9707
9763
|
/**
|
|
9708
9764
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
9709
9765
|
* In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
|
|
9710
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
9766
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
9711
9767
|
*/
|
|
9712
9768
|
contentNavigation: ContentNavigation;
|
|
9713
9769
|
contentRedirect: ContentRedirect;
|
package/out/fdc3-api.d.ts
CHANGED
|
@@ -97,7 +97,10 @@ declare type Api = {
|
|
|
97
97
|
enableDeprecatedSharedName?: boolean;
|
|
98
98
|
};
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* Configure injection of the `fin` API in this context.
|
|
101
|
+
*
|
|
102
|
+
* * 'none': The `fin` API will be not available in this context.
|
|
103
|
+
* * 'global': The entire `fin` API will be available in this context.
|
|
101
104
|
*/
|
|
102
105
|
fin?: InjectionType;
|
|
103
106
|
};
|
|
@@ -113,8 +116,18 @@ declare type ApiClient<T extends Record<any, any>> = {
|
|
|
113
116
|
|
|
114
117
|
/**
|
|
115
118
|
* @interface
|
|
119
|
+
*
|
|
120
|
+
* Rules for domain-conditional `fin` API injection.
|
|
116
121
|
*/
|
|
117
122
|
declare type ApiInjection = {
|
|
123
|
+
/**
|
|
124
|
+
* Injection setting for the `fin` API for contexts on a matched domain.
|
|
125
|
+
*
|
|
126
|
+
* * 'none': The `fin` API will be not available.
|
|
127
|
+
* * 'global': The entire `fin` API will be available.
|
|
128
|
+
*
|
|
129
|
+
* @defaultValue 'global'
|
|
130
|
+
*/
|
|
118
131
|
fin: InjectionType;
|
|
119
132
|
};
|
|
120
133
|
|
|
@@ -1732,7 +1745,7 @@ declare type BaseConfig = {
|
|
|
1732
1745
|
*/
|
|
1733
1746
|
declare type BaseContentCreationRule = {
|
|
1734
1747
|
/**
|
|
1735
|
-
* List of [match patterns](https://developer.chrome.com/extensions/
|
|
1748
|
+
* List of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) that indicate the specified
|
|
1736
1749
|
* behavior should be used
|
|
1737
1750
|
*/
|
|
1738
1751
|
match: MatchPattern[];
|
|
@@ -3651,13 +3664,13 @@ declare type ConstWindowOptions = {
|
|
|
3651
3664
|
/**
|
|
3652
3665
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
3653
3666
|
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
3654
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
3667
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
3655
3668
|
*/
|
|
3656
3669
|
contentNavigation: ContentNavigation;
|
|
3657
3670
|
/**
|
|
3658
3671
|
* Restrict redirects to URLs that match an allowed pattern.
|
|
3659
3672
|
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
|
3660
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
3673
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
3661
3674
|
*/
|
|
3662
3675
|
contentRedirect: Partial<ContentRedirect>;
|
|
3663
3676
|
/**
|
|
@@ -4202,7 +4215,7 @@ declare interface ContentItem extends EventEmitter_2 {
|
|
|
4202
4215
|
/**
|
|
4203
4216
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
4204
4217
|
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
4205
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
4218
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
4206
4219
|
*
|
|
4207
4220
|
* @interface
|
|
4208
4221
|
*/
|
|
@@ -4211,7 +4224,7 @@ declare type ContentNavigation = NavigationRules;
|
|
|
4211
4224
|
/**
|
|
4212
4225
|
* Restrict redirects to URLs that match an allowed pattern.
|
|
4213
4226
|
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
|
4214
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
4227
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
4215
4228
|
*
|
|
4216
4229
|
* @interface
|
|
4217
4230
|
*/
|
|
@@ -4815,19 +4828,42 @@ declare type DisplayMetadata_3 = {
|
|
|
4815
4828
|
|
|
4816
4829
|
/**
|
|
4817
4830
|
* @interface
|
|
4818
|
-
*
|
|
4831
|
+
* Defines application settings that vary by the domain of the current context.
|
|
4832
|
+
*
|
|
4833
|
+
* @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
|
|
4834
|
+
* domain should be represented with a single rule.
|
|
4819
4835
|
*/
|
|
4820
4836
|
declare type DomainSettings = {
|
|
4837
|
+
/**
|
|
4838
|
+
* {@inheritDoc DomainSettingsRule}
|
|
4839
|
+
*/
|
|
4821
4840
|
rules: DomainSettingsRule[];
|
|
4822
4841
|
};
|
|
4823
4842
|
|
|
4824
4843
|
/**
|
|
4825
4844
|
* @interface
|
|
4845
|
+
*
|
|
4846
|
+
* Defines domain-conditional settings for an OpenFin application.
|
|
4826
4847
|
*/
|
|
4827
4848
|
declare type DomainSettingsRule = {
|
|
4849
|
+
/**
|
|
4850
|
+
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
|
4851
|
+
* the domain(s) for which the rule applies.
|
|
4852
|
+
*/
|
|
4828
4853
|
match: string[];
|
|
4854
|
+
/**
|
|
4855
|
+
* Settings applied when a webcontents has been navigated to a matched domain.
|
|
4856
|
+
*/
|
|
4829
4857
|
options: {
|
|
4858
|
+
/**
|
|
4859
|
+
* {@inheritDoc FileDownloadSettings}
|
|
4860
|
+
*
|
|
4861
|
+
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
|
4862
|
+
*/
|
|
4830
4863
|
downloadSettings?: FileDownloadSettings;
|
|
4864
|
+
/**
|
|
4865
|
+
* {@inheritDoc ApiInjection}
|
|
4866
|
+
*/
|
|
4831
4867
|
api?: ApiInjection;
|
|
4832
4868
|
};
|
|
4833
4869
|
};
|
|
@@ -4866,9 +4902,20 @@ declare type DownloadPreloadOption = {
|
|
|
4866
4902
|
|
|
4867
4903
|
/**
|
|
4868
4904
|
* @interface
|
|
4905
|
+
*
|
|
4906
|
+
* A rule governing domain-conditional download behavior.
|
|
4869
4907
|
*/
|
|
4870
4908
|
declare type DownloadRule = {
|
|
4909
|
+
/**
|
|
4910
|
+
* {@inheritDoc FileDownloadBehaviorNames}
|
|
4911
|
+
*/
|
|
4871
4912
|
behavior: FileDownloadBehaviorNames;
|
|
4913
|
+
/**
|
|
4914
|
+
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
|
4915
|
+
* the domain(s) for which the rule applies.
|
|
4916
|
+
*
|
|
4917
|
+
* @remarks The match is evaluated against the URL of the *download*.
|
|
4918
|
+
*/
|
|
4872
4919
|
match: string[];
|
|
4873
4920
|
};
|
|
4874
4921
|
|
|
@@ -5926,6 +5973,9 @@ declare type FetchManifestPayload = {
|
|
|
5926
5973
|
manifestUrl: string;
|
|
5927
5974
|
};
|
|
5928
5975
|
|
|
5976
|
+
/**
|
|
5977
|
+
* Whether file downloads raise a user prompt.
|
|
5978
|
+
*/
|
|
5929
5979
|
declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
|
|
5930
5980
|
|
|
5931
5981
|
/**
|
|
@@ -6008,9 +6058,14 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
|
6008
6058
|
};
|
|
6009
6059
|
|
|
6010
6060
|
/**
|
|
6011
|
-
*
|
|
6061
|
+
* Domain-conditional rules for file downloads.
|
|
6062
|
+
*
|
|
6063
|
+
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
|
6012
6064
|
*/
|
|
6013
6065
|
declare type FileDownloadSettings = {
|
|
6066
|
+
/**
|
|
6067
|
+
* {@inheritDoc DownloadRule}
|
|
6068
|
+
*/
|
|
6014
6069
|
rules: DownloadRule[];
|
|
6015
6070
|
};
|
|
6016
6071
|
|
|
@@ -7082,9 +7137,10 @@ declare type InitPlatformOptions = {
|
|
|
7082
7137
|
};
|
|
7083
7138
|
|
|
7084
7139
|
/**
|
|
7085
|
-
*
|
|
7086
|
-
*
|
|
7087
|
-
*
|
|
7140
|
+
* Injection setting for the `fin` API.
|
|
7141
|
+
*
|
|
7142
|
+
* * 'none': The `fin` API will be not available.
|
|
7143
|
+
* * 'global': The entire `fin` API will be available.
|
|
7088
7144
|
*/
|
|
7089
7145
|
declare type InjectionType = 'none' | 'global';
|
|
7090
7146
|
|
|
@@ -9984,7 +10040,7 @@ declare type MutableViewOptions = {
|
|
|
9984
10040
|
/**
|
|
9985
10041
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
9986
10042
|
* In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
|
|
9987
|
-
* See [here](https://developer.chrome.com/extensions/
|
|
10043
|
+
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
|
9988
10044
|
*/
|
|
9989
10045
|
contentNavigation: ContentNavigation;
|
|
9990
10046
|
contentRedirect: ContentRedirect;
|