@openfin/remote-adapter 36.80.1 → 36.80.3

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
  */
@@ -3546,7 +3539,7 @@ declare type ConstViewOptions = {
3546
3539
  /**
3547
3540
  * Configurations for API injection.
3548
3541
  */
3549
- api: Api;
3542
+ api: ApiSettings;
3550
3543
  /**
3551
3544
  * The name of the view.
3552
3545
  */
@@ -3966,7 +3959,12 @@ declare interface Container extends EventEmitter_2 {
3966
3959
  close(): boolean;
3967
3960
  }
3968
3961
 
3969
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3962
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3963
+
3964
+ /**
3965
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3966
+ */
3967
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3970
3968
 
3971
3969
  /**
3972
3970
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3990,7 +3988,7 @@ declare type ContentCreationOptions = {
3990
3988
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3991
3989
  * the specified `behavior` key.
3992
3990
  */
3993
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3991
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3994
3992
  behavior: Behavior;
3995
3993
  }>;
3996
3994
 
@@ -4875,6 +4873,25 @@ declare type DisplayMetadata_3 = {
4875
4873
  readonly glyph?: string;
4876
4874
  };
4877
4875
 
4876
+ /**
4877
+ * @interface
4878
+ *
4879
+ * Rules for domain-conditional `fin` API injection.
4880
+ *
4881
+ * @remarks Subset of {@link DomainSettings}.
4882
+ */
4883
+ declare type DomainApiSettings = {
4884
+ /**
4885
+ * Injection setting for the `fin` API for contexts on a matched domain.
4886
+ *
4887
+ * * 'none': The `fin` API will be not available.
4888
+ * * 'global': The entire `fin` API will be available.
4889
+ *
4890
+ * @defaultValue 'global'
4891
+ */
4892
+ fin: InjectionType;
4893
+ };
4894
+
4878
4895
  /**
4879
4896
  * @interface
4880
4897
  * Defines application settings that vary by the domain of the current context.
@@ -4913,7 +4930,7 @@ declare type DomainSettingsRule = {
4913
4930
  /**
4914
4931
  * {@inheritDoc ApiInjection}
4915
4932
  */
4916
- api?: ApiInjection;
4933
+ api?: DomainApiSettings;
4917
4934
  };
4918
4935
  };
4919
4936
 
@@ -4952,18 +4969,19 @@ declare type DownloadPreloadOption = {
4952
4969
  /**
4953
4970
  * @interface
4954
4971
  *
4955
- * A rule governing domain-conditional download behavior.
4972
+ * A rule that governs download behavior, discriminated by the URL of the download.
4956
4973
  */
4957
4974
  declare type DownloadRule = {
4958
4975
  /**
4959
- * {@inheritDoc FileDownloadBehaviorNames}
4976
+ * {@inheritDoc FileDownloadBehavior}
4960
4977
  */
4961
- behavior: FileDownloadBehaviorNames;
4978
+ behavior: FileDownloadBehavior;
4962
4979
  /**
4963
4980
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4964
- * the domain(s) for which the rule applies.
4981
+ * URL(s) of the resource(s) being downloaded.
4965
4982
  *
4966
- * @remarks The match is evaluated against the URL of the *download*.
4983
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4984
+ * of the page in which a file download link is embedded.
4967
4985
  */
4968
4986
  match: string[];
4969
4987
  };
@@ -5669,7 +5687,12 @@ declare type FetchManifestPayload = {
5669
5687
  /**
5670
5688
  * Whether file downloads raise a user prompt.
5671
5689
  */
5672
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5690
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5691
+
5692
+ /**
5693
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5694
+ */
5695
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5673
5696
 
5674
5697
  /**
5675
5698
  * Generated when a file download has completed.
@@ -9573,7 +9596,7 @@ declare type MutableViewOptions = {
9573
9596
  /**
9574
9597
  * Configurations for API injection.
9575
9598
  */
9576
- api: Api;
9599
+ api: ApiSettings;
9577
9600
  /**
9578
9601
  * Restrict navigation to URLs that match an allowed pattern.
9579
9602
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10035,6 +10058,7 @@ declare namespace OpenFin {
10035
10058
  ResizeRegion,
10036
10059
  Accelerator,
10037
10060
  Api,
10061
+ ApiSettings,
10038
10062
  InjectionType,
10039
10063
  NavigationRules,
10040
10064
  ContentNavigation,
@@ -10186,7 +10210,9 @@ declare namespace OpenFin {
10186
10210
  DefaultDomainSettingsRule,
10187
10211
  DomainSettings,
10188
10212
  ApiInjection,
10213
+ DomainApiSettings,
10189
10214
  DomainSettingsRule,
10215
+ FileDownloadBehavior,
10190
10216
  FileDownloadBehaviorNames,
10191
10217
  FileDownloadSettings,
10192
10218
  DownloadRule,
@@ -10194,6 +10220,7 @@ declare namespace OpenFin {
10194
10220
  Intent_2 as Intent,
10195
10221
  IntentMetadata_3 as IntentMetadata,
10196
10222
  IntentHandler_2 as IntentHandler,
10223
+ ContentCreationBehavior,
10197
10224
  ContentCreationBehaviorNames,
10198
10225
  MatchPattern,
10199
10226
  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
  */
@@ -3546,7 +3539,7 @@ declare type ConstViewOptions = {
3546
3539
  /**
3547
3540
  * Configurations for API injection.
3548
3541
  */
3549
- api: Api;
3542
+ api: ApiSettings;
3550
3543
  /**
3551
3544
  * The name of the view.
3552
3545
  */
@@ -3966,7 +3959,12 @@ declare interface Container extends EventEmitter_2 {
3966
3959
  close(): boolean;
3967
3960
  }
3968
3961
 
3969
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3962
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3963
+
3964
+ /**
3965
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3966
+ */
3967
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3970
3968
 
3971
3969
  /**
3972
3970
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3990,7 +3988,7 @@ declare type ContentCreationOptions = {
3990
3988
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3991
3989
  * the specified `behavior` key.
3992
3990
  */
3993
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3991
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3994
3992
  behavior: Behavior;
3995
3993
  }>;
3996
3994
 
@@ -4875,6 +4873,25 @@ declare type DisplayMetadata_3 = {
4875
4873
  readonly glyph?: string;
4876
4874
  };
4877
4875
 
4876
+ /**
4877
+ * @interface
4878
+ *
4879
+ * Rules for domain-conditional `fin` API injection.
4880
+ *
4881
+ * @remarks Subset of {@link DomainSettings}.
4882
+ */
4883
+ declare type DomainApiSettings = {
4884
+ /**
4885
+ * Injection setting for the `fin` API for contexts on a matched domain.
4886
+ *
4887
+ * * 'none': The `fin` API will be not available.
4888
+ * * 'global': The entire `fin` API will be available.
4889
+ *
4890
+ * @defaultValue 'global'
4891
+ */
4892
+ fin: InjectionType;
4893
+ };
4894
+
4878
4895
  /**
4879
4896
  * @interface
4880
4897
  * Defines application settings that vary by the domain of the current context.
@@ -4913,7 +4930,7 @@ declare type DomainSettingsRule = {
4913
4930
  /**
4914
4931
  * {@inheritDoc ApiInjection}
4915
4932
  */
4916
- api?: ApiInjection;
4933
+ api?: DomainApiSettings;
4917
4934
  };
4918
4935
  };
4919
4936
 
@@ -4952,18 +4969,19 @@ declare type DownloadPreloadOption = {
4952
4969
  /**
4953
4970
  * @interface
4954
4971
  *
4955
- * A rule governing domain-conditional download behavior.
4972
+ * A rule that governs download behavior, discriminated by the URL of the download.
4956
4973
  */
4957
4974
  declare type DownloadRule = {
4958
4975
  /**
4959
- * {@inheritDoc FileDownloadBehaviorNames}
4976
+ * {@inheritDoc FileDownloadBehavior}
4960
4977
  */
4961
- behavior: FileDownloadBehaviorNames;
4978
+ behavior: FileDownloadBehavior;
4962
4979
  /**
4963
4980
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4964
- * the domain(s) for which the rule applies.
4981
+ * URL(s) of the resource(s) being downloaded.
4965
4982
  *
4966
- * @remarks The match is evaluated against the URL of the *download*.
4983
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4984
+ * of the page in which a file download link is embedded.
4967
4985
  */
4968
4986
  match: string[];
4969
4987
  };
@@ -5669,7 +5687,12 @@ declare type FetchManifestPayload = {
5669
5687
  /**
5670
5688
  * Whether file downloads raise a user prompt.
5671
5689
  */
5672
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5690
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5691
+
5692
+ /**
5693
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5694
+ */
5695
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5673
5696
 
5674
5697
  /**
5675
5698
  * Generated when a file download has completed.
@@ -9573,7 +9596,7 @@ declare type MutableViewOptions = {
9573
9596
  /**
9574
9597
  * Configurations for API injection.
9575
9598
  */
9576
- api: Api;
9599
+ api: ApiSettings;
9577
9600
  /**
9578
9601
  * Restrict navigation to URLs that match an allowed pattern.
9579
9602
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10035,6 +10058,7 @@ declare namespace OpenFin {
10035
10058
  ResizeRegion,
10036
10059
  Accelerator,
10037
10060
  Api,
10061
+ ApiSettings,
10038
10062
  InjectionType,
10039
10063
  NavigationRules,
10040
10064
  ContentNavigation,
@@ -10186,7 +10210,9 @@ declare namespace OpenFin {
10186
10210
  DefaultDomainSettingsRule,
10187
10211
  DomainSettings,
10188
10212
  ApiInjection,
10213
+ DomainApiSettings,
10189
10214
  DomainSettingsRule,
10215
+ FileDownloadBehavior,
10190
10216
  FileDownloadBehaviorNames,
10191
10217
  FileDownloadSettings,
10192
10218
  DownloadRule,
@@ -10194,6 +10220,7 @@ declare namespace OpenFin {
10194
10220
  Intent_2 as Intent,
10195
10221
  IntentMetadata_3 as IntentMetadata,
10196
10222
  IntentHandler_2 as IntentHandler,
10223
+ ContentCreationBehavior,
10197
10224
  ContentCreationBehaviorNames,
10198
10225
  MatchPattern,
10199
10226
  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
  */
@@ -3546,7 +3539,7 @@ declare type ConstViewOptions = {
3546
3539
  /**
3547
3540
  * Configurations for API injection.
3548
3541
  */
3549
- api: Api;
3542
+ api: ApiSettings;
3550
3543
  /**
3551
3544
  * The name of the view.
3552
3545
  */
@@ -3966,7 +3959,12 @@ declare interface Container extends EventEmitter_2 {
3966
3959
  close(): boolean;
3967
3960
  }
3968
3961
 
3969
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3962
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3963
+
3964
+ /**
3965
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3966
+ */
3967
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3970
3968
 
3971
3969
  /**
3972
3970
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3990,7 +3988,7 @@ declare type ContentCreationOptions = {
3990
3988
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3991
3989
  * the specified `behavior` key.
3992
3990
  */
3993
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3991
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3994
3992
  behavior: Behavior;
3995
3993
  }>;
3996
3994
 
@@ -4875,6 +4873,25 @@ declare type DisplayMetadata_3 = {
4875
4873
  readonly glyph?: string;
4876
4874
  };
4877
4875
 
4876
+ /**
4877
+ * @interface
4878
+ *
4879
+ * Rules for domain-conditional `fin` API injection.
4880
+ *
4881
+ * @remarks Subset of {@link DomainSettings}.
4882
+ */
4883
+ declare type DomainApiSettings = {
4884
+ /**
4885
+ * Injection setting for the `fin` API for contexts on a matched domain.
4886
+ *
4887
+ * * 'none': The `fin` API will be not available.
4888
+ * * 'global': The entire `fin` API will be available.
4889
+ *
4890
+ * @defaultValue 'global'
4891
+ */
4892
+ fin: InjectionType;
4893
+ };
4894
+
4878
4895
  /**
4879
4896
  * @interface
4880
4897
  * Defines application settings that vary by the domain of the current context.
@@ -4913,7 +4930,7 @@ declare type DomainSettingsRule = {
4913
4930
  /**
4914
4931
  * {@inheritDoc ApiInjection}
4915
4932
  */
4916
- api?: ApiInjection;
4933
+ api?: DomainApiSettings;
4917
4934
  };
4918
4935
  };
4919
4936
 
@@ -4952,18 +4969,19 @@ declare type DownloadPreloadOption = {
4952
4969
  /**
4953
4970
  * @interface
4954
4971
  *
4955
- * A rule governing domain-conditional download behavior.
4972
+ * A rule that governs download behavior, discriminated by the URL of the download.
4956
4973
  */
4957
4974
  declare type DownloadRule = {
4958
4975
  /**
4959
- * {@inheritDoc FileDownloadBehaviorNames}
4976
+ * {@inheritDoc FileDownloadBehavior}
4960
4977
  */
4961
- behavior: FileDownloadBehaviorNames;
4978
+ behavior: FileDownloadBehavior;
4962
4979
  /**
4963
4980
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4964
- * the domain(s) for which the rule applies.
4981
+ * URL(s) of the resource(s) being downloaded.
4965
4982
  *
4966
- * @remarks The match is evaluated against the URL of the *download*.
4983
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4984
+ * of the page in which a file download link is embedded.
4967
4985
  */
4968
4986
  match: string[];
4969
4987
  };
@@ -5669,7 +5687,12 @@ declare type FetchManifestPayload = {
5669
5687
  /**
5670
5688
  * Whether file downloads raise a user prompt.
5671
5689
  */
5672
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5690
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5691
+
5692
+ /**
5693
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5694
+ */
5695
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5673
5696
 
5674
5697
  /**
5675
5698
  * Generated when a file download has completed.
@@ -9573,7 +9596,7 @@ declare type MutableViewOptions = {
9573
9596
  /**
9574
9597
  * Configurations for API injection.
9575
9598
  */
9576
- api: Api;
9599
+ api: ApiSettings;
9577
9600
  /**
9578
9601
  * Restrict navigation to URLs that match an allowed pattern.
9579
9602
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10035,6 +10058,7 @@ declare namespace OpenFin {
10035
10058
  ResizeRegion,
10036
10059
  Accelerator,
10037
10060
  Api,
10061
+ ApiSettings,
10038
10062
  InjectionType,
10039
10063
  NavigationRules,
10040
10064
  ContentNavigation,
@@ -10186,7 +10210,9 @@ declare namespace OpenFin {
10186
10210
  DefaultDomainSettingsRule,
10187
10211
  DomainSettings,
10188
10212
  ApiInjection,
10213
+ DomainApiSettings,
10189
10214
  DomainSettingsRule,
10215
+ FileDownloadBehavior,
10190
10216
  FileDownloadBehaviorNames,
10191
10217
  FileDownloadSettings,
10192
10218
  DownloadRule,
@@ -10194,6 +10220,7 @@ declare namespace OpenFin {
10194
10220
  Intent_2 as Intent,
10195
10221
  IntentMetadata_3 as IntentMetadata,
10196
10222
  IntentHandler_2 as IntentHandler,
10223
+ ContentCreationBehavior,
10197
10224
  ContentCreationBehaviorNames,
10198
10225
  MatchPattern,
10199
10226
  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
  */
@@ -3601,7 +3594,7 @@ declare type ConstViewOptions = {
3601
3594
  /**
3602
3595
  * Configurations for API injection.
3603
3596
  */
3604
- api: Api;
3597
+ api: ApiSettings;
3605
3598
  /**
3606
3599
  * The name of the view.
3607
3600
  */
@@ -4021,7 +4014,12 @@ declare interface Container extends EventEmitter_2 {
4021
4014
  close(): boolean;
4022
4015
  }
4023
4016
 
4024
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
4017
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
4018
+
4019
+ /**
4020
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
4021
+ */
4022
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
4025
4023
 
4026
4024
  /**
4027
4025
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -4045,7 +4043,7 @@ declare type ContentCreationOptions = {
4045
4043
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
4046
4044
  * the specified `behavior` key.
4047
4045
  */
4048
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
4046
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
4049
4047
  behavior: Behavior;
4050
4048
  }>;
4051
4049
 
@@ -4930,6 +4928,25 @@ declare type DisplayMetadata_3 = {
4930
4928
  readonly glyph?: string;
4931
4929
  };
4932
4930
 
4931
+ /**
4932
+ * @interface
4933
+ *
4934
+ * Rules for domain-conditional `fin` API injection.
4935
+ *
4936
+ * @remarks Subset of {@link DomainSettings}.
4937
+ */
4938
+ declare type DomainApiSettings = {
4939
+ /**
4940
+ * Injection setting for the `fin` API for contexts on a matched domain.
4941
+ *
4942
+ * * 'none': The `fin` API will be not available.
4943
+ * * 'global': The entire `fin` API will be available.
4944
+ *
4945
+ * @defaultValue 'global'
4946
+ */
4947
+ fin: InjectionType;
4948
+ };
4949
+
4933
4950
  /**
4934
4951
  * @interface
4935
4952
  * Defines application settings that vary by the domain of the current context.
@@ -4968,7 +4985,7 @@ declare type DomainSettingsRule = {
4968
4985
  /**
4969
4986
  * {@inheritDoc ApiInjection}
4970
4987
  */
4971
- api?: ApiInjection;
4988
+ api?: DomainApiSettings;
4972
4989
  };
4973
4990
  };
4974
4991
 
@@ -5007,18 +5024,19 @@ declare type DownloadPreloadOption = {
5007
5024
  /**
5008
5025
  * @interface
5009
5026
  *
5010
- * A rule governing domain-conditional download behavior.
5027
+ * A rule that governs download behavior, discriminated by the URL of the download.
5011
5028
  */
5012
5029
  declare type DownloadRule = {
5013
5030
  /**
5014
- * {@inheritDoc FileDownloadBehaviorNames}
5031
+ * {@inheritDoc FileDownloadBehavior}
5015
5032
  */
5016
- behavior: FileDownloadBehaviorNames;
5033
+ behavior: FileDownloadBehavior;
5017
5034
  /**
5018
5035
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
5019
- * the domain(s) for which the rule applies.
5036
+ * URL(s) of the resource(s) being downloaded.
5020
5037
  *
5021
- * @remarks The match is evaluated against the URL of the *download*.
5038
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
5039
+ * of the page in which a file download link is embedded.
5022
5040
  */
5023
5041
  match: string[];
5024
5042
  };
@@ -5750,7 +5768,12 @@ declare type FetchManifestPayload = {
5750
5768
  /**
5751
5769
  * Whether file downloads raise a user prompt.
5752
5770
  */
5753
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5771
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5772
+
5773
+ /**
5774
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5775
+ */
5776
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5754
5777
 
5755
5778
  /**
5756
5779
  * Generated when a file download has completed.
@@ -9862,7 +9885,7 @@ declare type MutableViewOptions = {
9862
9885
  /**
9863
9886
  * Configurations for API injection.
9864
9887
  */
9865
- api: Api;
9888
+ api: ApiSettings;
9866
9889
  /**
9867
9890
  * Restrict navigation to URLs that match an allowed pattern.
9868
9891
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10346,6 +10369,7 @@ declare namespace OpenFin {
10346
10369
  ResizeRegion,
10347
10370
  Accelerator,
10348
10371
  Api,
10372
+ ApiSettings,
10349
10373
  InjectionType,
10350
10374
  NavigationRules,
10351
10375
  ContentNavigation,
@@ -10497,7 +10521,9 @@ declare namespace OpenFin {
10497
10521
  DefaultDomainSettingsRule,
10498
10522
  DomainSettings,
10499
10523
  ApiInjection,
10524
+ DomainApiSettings,
10500
10525
  DomainSettingsRule,
10526
+ FileDownloadBehavior,
10501
10527
  FileDownloadBehaviorNames,
10502
10528
  FileDownloadSettings,
10503
10529
  DownloadRule,
@@ -10505,6 +10531,7 @@ declare namespace OpenFin {
10505
10531
  Intent_2 as Intent,
10506
10532
  IntentMetadata_3 as IntentMetadata,
10507
10533
  IntentHandler_2 as IntentHandler,
10534
+ ContentCreationBehavior,
10508
10535
  ContentCreationBehaviorNames,
10509
10536
  MatchPattern,
10510
10537
  BaseContentCreationRule,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/remote-adapter",
3
- "version": "36.80.1",
3
+ "version": "36.80.3",
4
4
  "description": "Establish intermachine runtime connections using webRTC.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,