@openfin/fdc3-api 36.80.1 → 36.80.2

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.
@@ -76,14 +76,42 @@ declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-rig
76
76
 
77
77
  declare type AnyStrategy = ClassicStrategy | RTCStrategy | CombinedStrategy<PayloadTypeByStrategy<RTCStrategy>, PayloadTypeByStrategy<ClassicStrategy>>;
78
78
 
79
+ /**
80
+ * @deprecated Renamed to {@link ApiSettings}.
81
+ */
82
+ declare type Api = ApiSettings;
83
+
84
+ declare type ApiCall<Request, Response> = {
85
+ request: Request;
86
+ response: Response;
87
+ };
88
+
89
+ declare type ApiClient<T extends Record<any, any>> = {
90
+ [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
91
+ };
92
+
93
+ /**
94
+ * @deprecated Renamed to {@link DomainApiSettings}.
95
+ */
96
+ declare type ApiInjection = DomainApiSettings;
97
+
98
+ /**
99
+ * Generated when a new Platform's API becomes responsive.
100
+ * @interface
101
+ */
102
+ declare type ApiReadyEvent = BaseEvent & {
103
+ topic: 'application';
104
+ type: 'platform-api-ready';
105
+ };
106
+
79
107
  /**
80
108
  * Configurations for API injection.
81
109
  *
82
110
  * @interface
83
111
  */
84
- declare type Api = {
112
+ declare type ApiSettings = {
85
113
  /**
86
- * Configure injection of OpenFin API into iframes based on domain
114
+ * Configure conditional injection of OpenFin API into iframes
87
115
  */
88
116
  iframe?: {
89
117
  /**
@@ -114,41 +142,6 @@ declare type Api = {
114
142
  fin?: InjectionType;
115
143
  };
116
144
 
117
- declare type ApiCall<Request, Response> = {
118
- request: Request;
119
- response: Response;
120
- };
121
-
122
- declare type ApiClient<T extends Record<any, any>> = {
123
- [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
124
- };
125
-
126
- /**
127
- * @interface
128
- *
129
- * Rules for domain-conditional `fin` API injection.
130
- */
131
- declare type ApiInjection = {
132
- /**
133
- * Injection setting for the `fin` API for contexts on a matched domain.
134
- *
135
- * * 'none': The `fin` API will be not available.
136
- * * 'global': The entire `fin` API will be available.
137
- *
138
- * @defaultValue 'global'
139
- */
140
- fin: InjectionType;
141
- };
142
-
143
- /**
144
- * Generated when a new Platform's API becomes responsive.
145
- * @interface
146
- */
147
- declare type ApiReadyEvent = BaseEvent & {
148
- topic: 'application';
149
- type: 'platform-api-ready';
150
- };
151
-
152
145
  /**
153
146
  * @interface
154
147
  */
@@ -3522,7 +3515,7 @@ declare type ConstViewOptions = {
3522
3515
  /**
3523
3516
  * Configurations for API injection.
3524
3517
  */
3525
- api: Api;
3518
+ api: ApiSettings;
3526
3519
  /**
3527
3520
  * The name of the view.
3528
3521
  */
@@ -3942,7 +3935,12 @@ declare interface Container extends EventEmitter_2 {
3942
3935
  close(): boolean;
3943
3936
  }
3944
3937
 
3945
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3938
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3939
+
3940
+ /**
3941
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3942
+ */
3943
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3946
3944
 
3947
3945
  /**
3948
3946
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3966,7 +3964,7 @@ declare type ContentCreationOptions = {
3966
3964
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3967
3965
  * the specified `behavior` key.
3968
3966
  */
3969
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3967
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3970
3968
  behavior: Behavior;
3971
3969
  }>;
3972
3970
 
@@ -4851,6 +4849,25 @@ declare type DisplayMetadata_3 = {
4851
4849
  readonly glyph?: string;
4852
4850
  };
4853
4851
 
4852
+ /**
4853
+ * @interface
4854
+ *
4855
+ * Rules for domain-conditional `fin` API injection.
4856
+ *
4857
+ * @remarks Subset of {@link DomainSettings}.
4858
+ */
4859
+ declare type DomainApiSettings = {
4860
+ /**
4861
+ * Injection setting for the `fin` API for contexts on a matched domain.
4862
+ *
4863
+ * * 'none': The `fin` API will be not available.
4864
+ * * 'global': The entire `fin` API will be available.
4865
+ *
4866
+ * @defaultValue 'global'
4867
+ */
4868
+ fin: InjectionType;
4869
+ };
4870
+
4854
4871
  /**
4855
4872
  * @interface
4856
4873
  * Defines application settings that vary by the domain of the current context.
@@ -4889,7 +4906,7 @@ declare type DomainSettingsRule = {
4889
4906
  /**
4890
4907
  * {@inheritDoc ApiInjection}
4891
4908
  */
4892
- api?: ApiInjection;
4909
+ api?: DomainApiSettings;
4893
4910
  };
4894
4911
  };
4895
4912
 
@@ -4928,18 +4945,19 @@ declare type DownloadPreloadOption = {
4928
4945
  /**
4929
4946
  * @interface
4930
4947
  *
4931
- * A rule governing domain-conditional download behavior.
4948
+ * A rule that governs download behavior, discriminated by the URL of the download.
4932
4949
  */
4933
4950
  declare type DownloadRule = {
4934
4951
  /**
4935
- * {@inheritDoc FileDownloadBehaviorNames}
4952
+ * {@inheritDoc FileDownloadBehavior}
4936
4953
  */
4937
- behavior: FileDownloadBehaviorNames;
4954
+ behavior: FileDownloadBehavior;
4938
4955
  /**
4939
4956
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4940
- * the domain(s) for which the rule applies.
4957
+ * URL(s) of the resource(s) being downloaded.
4941
4958
  *
4942
- * @remarks The match is evaluated against the URL of the *download*.
4959
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4960
+ * of the page in which a file download link is embedded.
4943
4961
  */
4944
4962
  match: string[];
4945
4963
  };
@@ -5981,7 +5999,12 @@ declare type FetchManifestPayload = {
5981
5999
  /**
5982
6000
  * Whether file downloads raise a user prompt.
5983
6001
  */
5984
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
6002
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
6003
+
6004
+ /**
6005
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
6006
+ */
6007
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5985
6008
 
5986
6009
  /**
5987
6010
  * Generated when a file download has completed.
@@ -9864,7 +9887,7 @@ declare type MutableViewOptions = {
9864
9887
  /**
9865
9888
  * Configurations for API injection.
9866
9889
  */
9867
- api: Api;
9890
+ api: ApiSettings;
9868
9891
  /**
9869
9892
  * Restrict navigation to URLs that match an allowed pattern.
9870
9893
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10326,6 +10349,7 @@ declare namespace OpenFin {
10326
10349
  ResizeRegion,
10327
10350
  Accelerator,
10328
10351
  Api,
10352
+ ApiSettings,
10329
10353
  InjectionType,
10330
10354
  NavigationRules,
10331
10355
  ContentNavigation,
@@ -10477,7 +10501,9 @@ declare namespace OpenFin {
10477
10501
  DefaultDomainSettingsRule,
10478
10502
  DomainSettings,
10479
10503
  ApiInjection,
10504
+ DomainApiSettings,
10480
10505
  DomainSettingsRule,
10506
+ FileDownloadBehavior,
10481
10507
  FileDownloadBehaviorNames,
10482
10508
  FileDownloadSettings,
10483
10509
  DownloadRule,
@@ -10485,6 +10511,7 @@ declare namespace OpenFin {
10485
10511
  Intent_2 as Intent,
10486
10512
  IntentMetadata_3 as IntentMetadata,
10487
10513
  IntentHandler_2 as IntentHandler,
10514
+ ContentCreationBehavior,
10488
10515
  ContentCreationBehaviorNames,
10489
10516
  MatchPattern,
10490
10517
  BaseContentCreationRule,
@@ -76,14 +76,42 @@ declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-rig
76
76
 
77
77
  declare type AnyStrategy = ClassicStrategy | RTCStrategy | CombinedStrategy<PayloadTypeByStrategy<RTCStrategy>, PayloadTypeByStrategy<ClassicStrategy>>;
78
78
 
79
+ /**
80
+ * @deprecated Renamed to {@link ApiSettings}.
81
+ */
82
+ declare type Api = ApiSettings;
83
+
84
+ declare type ApiCall<Request, Response> = {
85
+ request: Request;
86
+ response: Response;
87
+ };
88
+
89
+ declare type ApiClient<T extends Record<any, any>> = {
90
+ [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
91
+ };
92
+
93
+ /**
94
+ * @deprecated Renamed to {@link DomainApiSettings}.
95
+ */
96
+ declare type ApiInjection = DomainApiSettings;
97
+
98
+ /**
99
+ * Generated when a new Platform's API becomes responsive.
100
+ * @interface
101
+ */
102
+ declare type ApiReadyEvent = BaseEvent & {
103
+ topic: 'application';
104
+ type: 'platform-api-ready';
105
+ };
106
+
79
107
  /**
80
108
  * Configurations for API injection.
81
109
  *
82
110
  * @interface
83
111
  */
84
- declare type Api = {
112
+ declare type ApiSettings = {
85
113
  /**
86
- * Configure injection of OpenFin API into iframes based on domain
114
+ * Configure conditional injection of OpenFin API into iframes
87
115
  */
88
116
  iframe?: {
89
117
  /**
@@ -114,41 +142,6 @@ declare type Api = {
114
142
  fin?: InjectionType;
115
143
  };
116
144
 
117
- declare type ApiCall<Request, Response> = {
118
- request: Request;
119
- response: Response;
120
- };
121
-
122
- declare type ApiClient<T extends Record<any, any>> = {
123
- [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
124
- };
125
-
126
- /**
127
- * @interface
128
- *
129
- * Rules for domain-conditional `fin` API injection.
130
- */
131
- declare type ApiInjection = {
132
- /**
133
- * Injection setting for the `fin` API for contexts on a matched domain.
134
- *
135
- * * 'none': The `fin` API will be not available.
136
- * * 'global': The entire `fin` API will be available.
137
- *
138
- * @defaultValue 'global'
139
- */
140
- fin: InjectionType;
141
- };
142
-
143
- /**
144
- * Generated when a new Platform's API becomes responsive.
145
- * @interface
146
- */
147
- declare type ApiReadyEvent = BaseEvent & {
148
- topic: 'application';
149
- type: 'platform-api-ready';
150
- };
151
-
152
145
  /**
153
146
  * @interface
154
147
  */
@@ -3522,7 +3515,7 @@ declare type ConstViewOptions = {
3522
3515
  /**
3523
3516
  * Configurations for API injection.
3524
3517
  */
3525
- api: Api;
3518
+ api: ApiSettings;
3526
3519
  /**
3527
3520
  * The name of the view.
3528
3521
  */
@@ -3942,7 +3935,12 @@ declare interface Container extends EventEmitter_2 {
3942
3935
  close(): boolean;
3943
3936
  }
3944
3937
 
3945
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3938
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3939
+
3940
+ /**
3941
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3942
+ */
3943
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3946
3944
 
3947
3945
  /**
3948
3946
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3966,7 +3964,7 @@ declare type ContentCreationOptions = {
3966
3964
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3967
3965
  * the specified `behavior` key.
3968
3966
  */
3969
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3967
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3970
3968
  behavior: Behavior;
3971
3969
  }>;
3972
3970
 
@@ -4851,6 +4849,25 @@ declare type DisplayMetadata_3 = {
4851
4849
  readonly glyph?: string;
4852
4850
  };
4853
4851
 
4852
+ /**
4853
+ * @interface
4854
+ *
4855
+ * Rules for domain-conditional `fin` API injection.
4856
+ *
4857
+ * @remarks Subset of {@link DomainSettings}.
4858
+ */
4859
+ declare type DomainApiSettings = {
4860
+ /**
4861
+ * Injection setting for the `fin` API for contexts on a matched domain.
4862
+ *
4863
+ * * 'none': The `fin` API will be not available.
4864
+ * * 'global': The entire `fin` API will be available.
4865
+ *
4866
+ * @defaultValue 'global'
4867
+ */
4868
+ fin: InjectionType;
4869
+ };
4870
+
4854
4871
  /**
4855
4872
  * @interface
4856
4873
  * Defines application settings that vary by the domain of the current context.
@@ -4889,7 +4906,7 @@ declare type DomainSettingsRule = {
4889
4906
  /**
4890
4907
  * {@inheritDoc ApiInjection}
4891
4908
  */
4892
- api?: ApiInjection;
4909
+ api?: DomainApiSettings;
4893
4910
  };
4894
4911
  };
4895
4912
 
@@ -4928,18 +4945,19 @@ declare type DownloadPreloadOption = {
4928
4945
  /**
4929
4946
  * @interface
4930
4947
  *
4931
- * A rule governing domain-conditional download behavior.
4948
+ * A rule that governs download behavior, discriminated by the URL of the download.
4932
4949
  */
4933
4950
  declare type DownloadRule = {
4934
4951
  /**
4935
- * {@inheritDoc FileDownloadBehaviorNames}
4952
+ * {@inheritDoc FileDownloadBehavior}
4936
4953
  */
4937
- behavior: FileDownloadBehaviorNames;
4954
+ behavior: FileDownloadBehavior;
4938
4955
  /**
4939
4956
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4940
- * the domain(s) for which the rule applies.
4957
+ * URL(s) of the resource(s) being downloaded.
4941
4958
  *
4942
- * @remarks The match is evaluated against the URL of the *download*.
4959
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4960
+ * of the page in which a file download link is embedded.
4943
4961
  */
4944
4962
  match: string[];
4945
4963
  };
@@ -5981,7 +5999,12 @@ declare type FetchManifestPayload = {
5981
5999
  /**
5982
6000
  * Whether file downloads raise a user prompt.
5983
6001
  */
5984
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
6002
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
6003
+
6004
+ /**
6005
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
6006
+ */
6007
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5985
6008
 
5986
6009
  /**
5987
6010
  * Generated when a file download has completed.
@@ -9864,7 +9887,7 @@ declare type MutableViewOptions = {
9864
9887
  /**
9865
9888
  * Configurations for API injection.
9866
9889
  */
9867
- api: Api;
9890
+ api: ApiSettings;
9868
9891
  /**
9869
9892
  * Restrict navigation to URLs that match an allowed pattern.
9870
9893
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10326,6 +10349,7 @@ declare namespace OpenFin {
10326
10349
  ResizeRegion,
10327
10350
  Accelerator,
10328
10351
  Api,
10352
+ ApiSettings,
10329
10353
  InjectionType,
10330
10354
  NavigationRules,
10331
10355
  ContentNavigation,
@@ -10477,7 +10501,9 @@ declare namespace OpenFin {
10477
10501
  DefaultDomainSettingsRule,
10478
10502
  DomainSettings,
10479
10503
  ApiInjection,
10504
+ DomainApiSettings,
10480
10505
  DomainSettingsRule,
10506
+ FileDownloadBehavior,
10481
10507
  FileDownloadBehaviorNames,
10482
10508
  FileDownloadSettings,
10483
10509
  DownloadRule,
@@ -10485,6 +10511,7 @@ declare namespace OpenFin {
10485
10511
  Intent_2 as Intent,
10486
10512
  IntentMetadata_3 as IntentMetadata,
10487
10513
  IntentHandler_2 as IntentHandler,
10514
+ ContentCreationBehavior,
10488
10515
  ContentCreationBehaviorNames,
10489
10516
  MatchPattern,
10490
10517
  BaseContentCreationRule,
@@ -76,14 +76,42 @@ declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-rig
76
76
 
77
77
  declare type AnyStrategy = ClassicStrategy | RTCStrategy | CombinedStrategy<PayloadTypeByStrategy<RTCStrategy>, PayloadTypeByStrategy<ClassicStrategy>>;
78
78
 
79
+ /**
80
+ * @deprecated Renamed to {@link ApiSettings}.
81
+ */
82
+ declare type Api = ApiSettings;
83
+
84
+ declare type ApiCall<Request, Response> = {
85
+ request: Request;
86
+ response: Response;
87
+ };
88
+
89
+ declare type ApiClient<T extends Record<any, any>> = {
90
+ [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
91
+ };
92
+
93
+ /**
94
+ * @deprecated Renamed to {@link DomainApiSettings}.
95
+ */
96
+ declare type ApiInjection = DomainApiSettings;
97
+
98
+ /**
99
+ * Generated when a new Platform's API becomes responsive.
100
+ * @interface
101
+ */
102
+ declare type ApiReadyEvent = BaseEvent & {
103
+ topic: 'application';
104
+ type: 'platform-api-ready';
105
+ };
106
+
79
107
  /**
80
108
  * Configurations for API injection.
81
109
  *
82
110
  * @interface
83
111
  */
84
- declare type Api = {
112
+ declare type ApiSettings = {
85
113
  /**
86
- * Configure injection of OpenFin API into iframes based on domain
114
+ * Configure conditional injection of OpenFin API into iframes
87
115
  */
88
116
  iframe?: {
89
117
  /**
@@ -114,41 +142,6 @@ declare type Api = {
114
142
  fin?: InjectionType;
115
143
  };
116
144
 
117
- declare type ApiCall<Request, Response> = {
118
- request: Request;
119
- response: Response;
120
- };
121
-
122
- declare type ApiClient<T extends Record<any, any>> = {
123
- [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
124
- };
125
-
126
- /**
127
- * @interface
128
- *
129
- * Rules for domain-conditional `fin` API injection.
130
- */
131
- declare type ApiInjection = {
132
- /**
133
- * Injection setting for the `fin` API for contexts on a matched domain.
134
- *
135
- * * 'none': The `fin` API will be not available.
136
- * * 'global': The entire `fin` API will be available.
137
- *
138
- * @defaultValue 'global'
139
- */
140
- fin: InjectionType;
141
- };
142
-
143
- /**
144
- * Generated when a new Platform's API becomes responsive.
145
- * @interface
146
- */
147
- declare type ApiReadyEvent = BaseEvent & {
148
- topic: 'application';
149
- type: 'platform-api-ready';
150
- };
151
-
152
145
  /**
153
146
  * @interface
154
147
  */
@@ -3522,7 +3515,7 @@ declare type ConstViewOptions = {
3522
3515
  /**
3523
3516
  * Configurations for API injection.
3524
3517
  */
3525
- api: Api;
3518
+ api: ApiSettings;
3526
3519
  /**
3527
3520
  * The name of the view.
3528
3521
  */
@@ -3942,7 +3935,12 @@ declare interface Container extends EventEmitter_2 {
3942
3935
  close(): boolean;
3943
3936
  }
3944
3937
 
3945
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3938
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3939
+
3940
+ /**
3941
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3942
+ */
3943
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3946
3944
 
3947
3945
  /**
3948
3946
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3966,7 +3964,7 @@ declare type ContentCreationOptions = {
3966
3964
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3967
3965
  * the specified `behavior` key.
3968
3966
  */
3969
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3967
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3970
3968
  behavior: Behavior;
3971
3969
  }>;
3972
3970
 
@@ -4851,6 +4849,25 @@ declare type DisplayMetadata_3 = {
4851
4849
  readonly glyph?: string;
4852
4850
  };
4853
4851
 
4852
+ /**
4853
+ * @interface
4854
+ *
4855
+ * Rules for domain-conditional `fin` API injection.
4856
+ *
4857
+ * @remarks Subset of {@link DomainSettings}.
4858
+ */
4859
+ declare type DomainApiSettings = {
4860
+ /**
4861
+ * Injection setting for the `fin` API for contexts on a matched domain.
4862
+ *
4863
+ * * 'none': The `fin` API will be not available.
4864
+ * * 'global': The entire `fin` API will be available.
4865
+ *
4866
+ * @defaultValue 'global'
4867
+ */
4868
+ fin: InjectionType;
4869
+ };
4870
+
4854
4871
  /**
4855
4872
  * @interface
4856
4873
  * Defines application settings that vary by the domain of the current context.
@@ -4889,7 +4906,7 @@ declare type DomainSettingsRule = {
4889
4906
  /**
4890
4907
  * {@inheritDoc ApiInjection}
4891
4908
  */
4892
- api?: ApiInjection;
4909
+ api?: DomainApiSettings;
4893
4910
  };
4894
4911
  };
4895
4912
 
@@ -4928,18 +4945,19 @@ declare type DownloadPreloadOption = {
4928
4945
  /**
4929
4946
  * @interface
4930
4947
  *
4931
- * A rule governing domain-conditional download behavior.
4948
+ * A rule that governs download behavior, discriminated by the URL of the download.
4932
4949
  */
4933
4950
  declare type DownloadRule = {
4934
4951
  /**
4935
- * {@inheritDoc FileDownloadBehaviorNames}
4952
+ * {@inheritDoc FileDownloadBehavior}
4936
4953
  */
4937
- behavior: FileDownloadBehaviorNames;
4954
+ behavior: FileDownloadBehavior;
4938
4955
  /**
4939
4956
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4940
- * the domain(s) for which the rule applies.
4957
+ * URL(s) of the resource(s) being downloaded.
4941
4958
  *
4942
- * @remarks The match is evaluated against the URL of the *download*.
4959
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4960
+ * of the page in which a file download link is embedded.
4943
4961
  */
4944
4962
  match: string[];
4945
4963
  };
@@ -5981,7 +5999,12 @@ declare type FetchManifestPayload = {
5981
5999
  /**
5982
6000
  * Whether file downloads raise a user prompt.
5983
6001
  */
5984
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
6002
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
6003
+
6004
+ /**
6005
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
6006
+ */
6007
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5985
6008
 
5986
6009
  /**
5987
6010
  * Generated when a file download has completed.
@@ -9864,7 +9887,7 @@ declare type MutableViewOptions = {
9864
9887
  /**
9865
9888
  * Configurations for API injection.
9866
9889
  */
9867
- api: Api;
9890
+ api: ApiSettings;
9868
9891
  /**
9869
9892
  * Restrict navigation to URLs that match an allowed pattern.
9870
9893
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10326,6 +10349,7 @@ declare namespace OpenFin {
10326
10349
  ResizeRegion,
10327
10350
  Accelerator,
10328
10351
  Api,
10352
+ ApiSettings,
10329
10353
  InjectionType,
10330
10354
  NavigationRules,
10331
10355
  ContentNavigation,
@@ -10477,7 +10501,9 @@ declare namespace OpenFin {
10477
10501
  DefaultDomainSettingsRule,
10478
10502
  DomainSettings,
10479
10503
  ApiInjection,
10504
+ DomainApiSettings,
10480
10505
  DomainSettingsRule,
10506
+ FileDownloadBehavior,
10481
10507
  FileDownloadBehaviorNames,
10482
10508
  FileDownloadSettings,
10483
10509
  DownloadRule,
@@ -10485,6 +10511,7 @@ declare namespace OpenFin {
10485
10511
  Intent_2 as Intent,
10486
10512
  IntentMetadata_3 as IntentMetadata,
10487
10513
  IntentHandler_2 as IntentHandler,
10514
+ ContentCreationBehavior,
10488
10515
  ContentCreationBehaviorNames,
10489
10516
  MatchPattern,
10490
10517
  BaseContentCreationRule,
package/out/fdc3-api.d.ts CHANGED
@@ -76,14 +76,42 @@ declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-rig
76
76
 
77
77
  declare type AnyStrategy = ClassicStrategy | RTCStrategy | CombinedStrategy<PayloadTypeByStrategy<RTCStrategy>, PayloadTypeByStrategy<ClassicStrategy>>;
78
78
 
79
+ /**
80
+ * @deprecated Renamed to {@link ApiSettings}.
81
+ */
82
+ declare type Api = ApiSettings;
83
+
84
+ declare type ApiCall<Request, Response> = {
85
+ request: Request;
86
+ response: Response;
87
+ };
88
+
89
+ declare type ApiClient<T extends Record<any, any>> = {
90
+ [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
91
+ };
92
+
93
+ /**
94
+ * @deprecated Renamed to {@link DomainApiSettings}.
95
+ */
96
+ declare type ApiInjection = DomainApiSettings;
97
+
98
+ /**
99
+ * Generated when a new Platform's API becomes responsive.
100
+ * @interface
101
+ */
102
+ declare type ApiReadyEvent = BaseEvent & {
103
+ topic: 'application';
104
+ type: 'platform-api-ready';
105
+ };
106
+
79
107
  /**
80
108
  * Configurations for API injection.
81
109
  *
82
110
  * @interface
83
111
  */
84
- declare type Api = {
112
+ declare type ApiSettings = {
85
113
  /**
86
- * Configure injection of OpenFin API into iframes based on domain
114
+ * Configure conditional injection of OpenFin API into iframes
87
115
  */
88
116
  iframe?: {
89
117
  /**
@@ -114,41 +142,6 @@ declare type Api = {
114
142
  fin?: InjectionType;
115
143
  };
116
144
 
117
- declare type ApiCall<Request, Response> = {
118
- request: Request;
119
- response: Response;
120
- };
121
-
122
- declare type ApiClient<T extends Record<any, any>> = {
123
- [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
124
- };
125
-
126
- /**
127
- * @interface
128
- *
129
- * Rules for domain-conditional `fin` API injection.
130
- */
131
- declare type ApiInjection = {
132
- /**
133
- * Injection setting for the `fin` API for contexts on a matched domain.
134
- *
135
- * * 'none': The `fin` API will be not available.
136
- * * 'global': The entire `fin` API will be available.
137
- *
138
- * @defaultValue 'global'
139
- */
140
- fin: InjectionType;
141
- };
142
-
143
- /**
144
- * Generated when a new Platform's API becomes responsive.
145
- * @interface
146
- */
147
- declare type ApiReadyEvent = BaseEvent & {
148
- topic: 'application';
149
- type: 'platform-api-ready';
150
- };
151
-
152
145
  /**
153
146
  * @interface
154
147
  */
@@ -3577,7 +3570,7 @@ declare type ConstViewOptions = {
3577
3570
  /**
3578
3571
  * Configurations for API injection.
3579
3572
  */
3580
- api: Api;
3573
+ api: ApiSettings;
3581
3574
  /**
3582
3575
  * The name of the view.
3583
3576
  */
@@ -3997,7 +3990,12 @@ declare interface Container extends EventEmitter_2 {
3997
3990
  close(): boolean;
3998
3991
  }
3999
3992
 
4000
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3993
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3994
+
3995
+ /**
3996
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3997
+ */
3998
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
4001
3999
 
4002
4000
  /**
4003
4001
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -4021,7 +4019,7 @@ declare type ContentCreationOptions = {
4021
4019
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
4022
4020
  * the specified `behavior` key.
4023
4021
  */
4024
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
4022
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
4025
4023
  behavior: Behavior;
4026
4024
  }>;
4027
4025
 
@@ -4906,6 +4904,25 @@ declare type DisplayMetadata_3 = {
4906
4904
  readonly glyph?: string;
4907
4905
  };
4908
4906
 
4907
+ /**
4908
+ * @interface
4909
+ *
4910
+ * Rules for domain-conditional `fin` API injection.
4911
+ *
4912
+ * @remarks Subset of {@link DomainSettings}.
4913
+ */
4914
+ declare type DomainApiSettings = {
4915
+ /**
4916
+ * Injection setting for the `fin` API for contexts on a matched domain.
4917
+ *
4918
+ * * 'none': The `fin` API will be not available.
4919
+ * * 'global': The entire `fin` API will be available.
4920
+ *
4921
+ * @defaultValue 'global'
4922
+ */
4923
+ fin: InjectionType;
4924
+ };
4925
+
4909
4926
  /**
4910
4927
  * @interface
4911
4928
  * Defines application settings that vary by the domain of the current context.
@@ -4944,7 +4961,7 @@ declare type DomainSettingsRule = {
4944
4961
  /**
4945
4962
  * {@inheritDoc ApiInjection}
4946
4963
  */
4947
- api?: ApiInjection;
4964
+ api?: DomainApiSettings;
4948
4965
  };
4949
4966
  };
4950
4967
 
@@ -4983,18 +5000,19 @@ declare type DownloadPreloadOption = {
4983
5000
  /**
4984
5001
  * @interface
4985
5002
  *
4986
- * A rule governing domain-conditional download behavior.
5003
+ * A rule that governs download behavior, discriminated by the URL of the download.
4987
5004
  */
4988
5005
  declare type DownloadRule = {
4989
5006
  /**
4990
- * {@inheritDoc FileDownloadBehaviorNames}
5007
+ * {@inheritDoc FileDownloadBehavior}
4991
5008
  */
4992
- behavior: FileDownloadBehaviorNames;
5009
+ behavior: FileDownloadBehavior;
4993
5010
  /**
4994
5011
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4995
- * the domain(s) for which the rule applies.
5012
+ * URL(s) of the resource(s) being downloaded.
4996
5013
  *
4997
- * @remarks The match is evaluated against the URL of the *download*.
5014
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
5015
+ * of the page in which a file download link is embedded.
4998
5016
  */
4999
5017
  match: string[];
5000
5018
  };
@@ -6062,7 +6080,12 @@ declare type FetchManifestPayload = {
6062
6080
  /**
6063
6081
  * Whether file downloads raise a user prompt.
6064
6082
  */
6065
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
6083
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
6084
+
6085
+ /**
6086
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
6087
+ */
6088
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
6066
6089
 
6067
6090
  /**
6068
6091
  * Generated when a file download has completed.
@@ -10153,7 +10176,7 @@ declare type MutableViewOptions = {
10153
10176
  /**
10154
10177
  * Configurations for API injection.
10155
10178
  */
10156
- api: Api;
10179
+ api: ApiSettings;
10157
10180
  /**
10158
10181
  * Restrict navigation to URLs that match an allowed pattern.
10159
10182
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10637,6 +10660,7 @@ declare namespace OpenFin {
10637
10660
  ResizeRegion,
10638
10661
  Accelerator,
10639
10662
  Api,
10663
+ ApiSettings,
10640
10664
  InjectionType,
10641
10665
  NavigationRules,
10642
10666
  ContentNavigation,
@@ -10788,7 +10812,9 @@ declare namespace OpenFin {
10788
10812
  DefaultDomainSettingsRule,
10789
10813
  DomainSettings,
10790
10814
  ApiInjection,
10815
+ DomainApiSettings,
10791
10816
  DomainSettingsRule,
10817
+ FileDownloadBehavior,
10792
10818
  FileDownloadBehaviorNames,
10793
10819
  FileDownloadSettings,
10794
10820
  DownloadRule,
@@ -10796,6 +10822,7 @@ declare namespace OpenFin {
10796
10822
  Intent_2 as Intent,
10797
10823
  IntentMetadata_3 as IntentMetadata,
10798
10824
  IntentHandler_2 as IntentHandler,
10825
+ ContentCreationBehavior,
10799
10826
  ContentCreationBehaviorNames,
10800
10827
  MatchPattern,
10801
10828
  BaseContentCreationRule,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "36.80.1",
3
+ "version": "36.80.2",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.MD",
6
6
  "private": false,