@openfin/node-adapter 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
  */
@@ -3526,7 +3519,7 @@ declare type ConstViewOptions = {
3526
3519
  /**
3527
3520
  * Configurations for API injection.
3528
3521
  */
3529
- api: Api;
3522
+ api: ApiSettings;
3530
3523
  /**
3531
3524
  * The name of the view.
3532
3525
  */
@@ -3946,7 +3939,12 @@ declare interface Container extends EventEmitter_2 {
3946
3939
  close(): boolean;
3947
3940
  }
3948
3941
 
3949
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3942
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3943
+
3944
+ /**
3945
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3946
+ */
3947
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3950
3948
 
3951
3949
  /**
3952
3950
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3970,7 +3968,7 @@ declare type ContentCreationOptions = {
3970
3968
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3971
3969
  * the specified `behavior` key.
3972
3970
  */
3973
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3971
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3974
3972
  behavior: Behavior;
3975
3973
  }>;
3976
3974
 
@@ -4855,6 +4853,25 @@ declare type DisplayMetadata_3 = {
4855
4853
  readonly glyph?: string;
4856
4854
  };
4857
4855
 
4856
+ /**
4857
+ * @interface
4858
+ *
4859
+ * Rules for domain-conditional `fin` API injection.
4860
+ *
4861
+ * @remarks Subset of {@link DomainSettings}.
4862
+ */
4863
+ declare type DomainApiSettings = {
4864
+ /**
4865
+ * Injection setting for the `fin` API for contexts on a matched domain.
4866
+ *
4867
+ * * 'none': The `fin` API will be not available.
4868
+ * * 'global': The entire `fin` API will be available.
4869
+ *
4870
+ * @defaultValue 'global'
4871
+ */
4872
+ fin: InjectionType;
4873
+ };
4874
+
4858
4875
  /**
4859
4876
  * @interface
4860
4877
  * Defines application settings that vary by the domain of the current context.
@@ -4893,7 +4910,7 @@ declare type DomainSettingsRule = {
4893
4910
  /**
4894
4911
  * {@inheritDoc ApiInjection}
4895
4912
  */
4896
- api?: ApiInjection;
4913
+ api?: DomainApiSettings;
4897
4914
  };
4898
4915
  };
4899
4916
 
@@ -4932,18 +4949,19 @@ declare type DownloadPreloadOption = {
4932
4949
  /**
4933
4950
  * @interface
4934
4951
  *
4935
- * A rule governing domain-conditional download behavior.
4952
+ * A rule that governs download behavior, discriminated by the URL of the download.
4936
4953
  */
4937
4954
  declare type DownloadRule = {
4938
4955
  /**
4939
- * {@inheritDoc FileDownloadBehaviorNames}
4956
+ * {@inheritDoc FileDownloadBehavior}
4940
4957
  */
4941
- behavior: FileDownloadBehaviorNames;
4958
+ behavior: FileDownloadBehavior;
4942
4959
  /**
4943
4960
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4944
- * the domain(s) for which the rule applies.
4961
+ * URL(s) of the resource(s) being downloaded.
4945
4962
  *
4946
- * @remarks The match is evaluated against the URL of the *download*.
4963
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4964
+ * of the page in which a file download link is embedded.
4947
4965
  */
4948
4966
  match: string[];
4949
4967
  };
@@ -5653,7 +5671,12 @@ declare type FetchManifestPayload = {
5653
5671
  /**
5654
5672
  * Whether file downloads raise a user prompt.
5655
5673
  */
5656
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5674
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5675
+
5676
+ /**
5677
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5678
+ */
5679
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5657
5680
 
5658
5681
  /**
5659
5682
  * Generated when a file download has completed.
@@ -9540,7 +9563,7 @@ declare type MutableViewOptions = {
9540
9563
  /**
9541
9564
  * Configurations for API injection.
9542
9565
  */
9543
- api: Api;
9566
+ api: ApiSettings;
9544
9567
  /**
9545
9568
  * Restrict navigation to URLs that match an allowed pattern.
9546
9569
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10002,6 +10025,7 @@ declare namespace OpenFin {
10002
10025
  ResizeRegion,
10003
10026
  Accelerator,
10004
10027
  Api,
10028
+ ApiSettings,
10005
10029
  InjectionType,
10006
10030
  NavigationRules,
10007
10031
  ContentNavigation,
@@ -10153,7 +10177,9 @@ declare namespace OpenFin {
10153
10177
  DefaultDomainSettingsRule,
10154
10178
  DomainSettings,
10155
10179
  ApiInjection,
10180
+ DomainApiSettings,
10156
10181
  DomainSettingsRule,
10182
+ FileDownloadBehavior,
10157
10183
  FileDownloadBehaviorNames,
10158
10184
  FileDownloadSettings,
10159
10185
  DownloadRule,
@@ -10161,6 +10187,7 @@ declare namespace OpenFin {
10161
10187
  Intent_2 as Intent,
10162
10188
  IntentMetadata_3 as IntentMetadata,
10163
10189
  IntentHandler_2 as IntentHandler,
10190
+ ContentCreationBehavior,
10164
10191
  ContentCreationBehaviorNames,
10165
10192
  MatchPattern,
10166
10193
  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
  */
@@ -3526,7 +3519,7 @@ declare type ConstViewOptions = {
3526
3519
  /**
3527
3520
  * Configurations for API injection.
3528
3521
  */
3529
- api: Api;
3522
+ api: ApiSettings;
3530
3523
  /**
3531
3524
  * The name of the view.
3532
3525
  */
@@ -3946,7 +3939,12 @@ declare interface Container extends EventEmitter_2 {
3946
3939
  close(): boolean;
3947
3940
  }
3948
3941
 
3949
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3942
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3943
+
3944
+ /**
3945
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3946
+ */
3947
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3950
3948
 
3951
3949
  /**
3952
3950
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3970,7 +3968,7 @@ declare type ContentCreationOptions = {
3970
3968
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3971
3969
  * the specified `behavior` key.
3972
3970
  */
3973
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3971
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3974
3972
  behavior: Behavior;
3975
3973
  }>;
3976
3974
 
@@ -4855,6 +4853,25 @@ declare type DisplayMetadata_3 = {
4855
4853
  readonly glyph?: string;
4856
4854
  };
4857
4855
 
4856
+ /**
4857
+ * @interface
4858
+ *
4859
+ * Rules for domain-conditional `fin` API injection.
4860
+ *
4861
+ * @remarks Subset of {@link DomainSettings}.
4862
+ */
4863
+ declare type DomainApiSettings = {
4864
+ /**
4865
+ * Injection setting for the `fin` API for contexts on a matched domain.
4866
+ *
4867
+ * * 'none': The `fin` API will be not available.
4868
+ * * 'global': The entire `fin` API will be available.
4869
+ *
4870
+ * @defaultValue 'global'
4871
+ */
4872
+ fin: InjectionType;
4873
+ };
4874
+
4858
4875
  /**
4859
4876
  * @interface
4860
4877
  * Defines application settings that vary by the domain of the current context.
@@ -4893,7 +4910,7 @@ declare type DomainSettingsRule = {
4893
4910
  /**
4894
4911
  * {@inheritDoc ApiInjection}
4895
4912
  */
4896
- api?: ApiInjection;
4913
+ api?: DomainApiSettings;
4897
4914
  };
4898
4915
  };
4899
4916
 
@@ -4932,18 +4949,19 @@ declare type DownloadPreloadOption = {
4932
4949
  /**
4933
4950
  * @interface
4934
4951
  *
4935
- * A rule governing domain-conditional download behavior.
4952
+ * A rule that governs download behavior, discriminated by the URL of the download.
4936
4953
  */
4937
4954
  declare type DownloadRule = {
4938
4955
  /**
4939
- * {@inheritDoc FileDownloadBehaviorNames}
4956
+ * {@inheritDoc FileDownloadBehavior}
4940
4957
  */
4941
- behavior: FileDownloadBehaviorNames;
4958
+ behavior: FileDownloadBehavior;
4942
4959
  /**
4943
4960
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4944
- * the domain(s) for which the rule applies.
4961
+ * URL(s) of the resource(s) being downloaded.
4945
4962
  *
4946
- * @remarks The match is evaluated against the URL of the *download*.
4963
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4964
+ * of the page in which a file download link is embedded.
4947
4965
  */
4948
4966
  match: string[];
4949
4967
  };
@@ -5653,7 +5671,12 @@ declare type FetchManifestPayload = {
5653
5671
  /**
5654
5672
  * Whether file downloads raise a user prompt.
5655
5673
  */
5656
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5674
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5675
+
5676
+ /**
5677
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5678
+ */
5679
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5657
5680
 
5658
5681
  /**
5659
5682
  * Generated when a file download has completed.
@@ -9540,7 +9563,7 @@ declare type MutableViewOptions = {
9540
9563
  /**
9541
9564
  * Configurations for API injection.
9542
9565
  */
9543
- api: Api;
9566
+ api: ApiSettings;
9544
9567
  /**
9545
9568
  * Restrict navigation to URLs that match an allowed pattern.
9546
9569
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10002,6 +10025,7 @@ declare namespace OpenFin {
10002
10025
  ResizeRegion,
10003
10026
  Accelerator,
10004
10027
  Api,
10028
+ ApiSettings,
10005
10029
  InjectionType,
10006
10030
  NavigationRules,
10007
10031
  ContentNavigation,
@@ -10153,7 +10177,9 @@ declare namespace OpenFin {
10153
10177
  DefaultDomainSettingsRule,
10154
10178
  DomainSettings,
10155
10179
  ApiInjection,
10180
+ DomainApiSettings,
10156
10181
  DomainSettingsRule,
10182
+ FileDownloadBehavior,
10157
10183
  FileDownloadBehaviorNames,
10158
10184
  FileDownloadSettings,
10159
10185
  DownloadRule,
@@ -10161,6 +10187,7 @@ declare namespace OpenFin {
10161
10187
  Intent_2 as Intent,
10162
10188
  IntentMetadata_3 as IntentMetadata,
10163
10189
  IntentHandler_2 as IntentHandler,
10190
+ ContentCreationBehavior,
10164
10191
  ContentCreationBehaviorNames,
10165
10192
  MatchPattern,
10166
10193
  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
  */
@@ -3526,7 +3519,7 @@ declare type ConstViewOptions = {
3526
3519
  /**
3527
3520
  * Configurations for API injection.
3528
3521
  */
3529
- api: Api;
3522
+ api: ApiSettings;
3530
3523
  /**
3531
3524
  * The name of the view.
3532
3525
  */
@@ -3946,7 +3939,12 @@ declare interface Container extends EventEmitter_2 {
3946
3939
  close(): boolean;
3947
3940
  }
3948
3941
 
3949
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3942
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3943
+
3944
+ /**
3945
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3946
+ */
3947
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3950
3948
 
3951
3949
  /**
3952
3950
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3970,7 +3968,7 @@ declare type ContentCreationOptions = {
3970
3968
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3971
3969
  * the specified `behavior` key.
3972
3970
  */
3973
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3971
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3974
3972
  behavior: Behavior;
3975
3973
  }>;
3976
3974
 
@@ -4855,6 +4853,25 @@ declare type DisplayMetadata_3 = {
4855
4853
  readonly glyph?: string;
4856
4854
  };
4857
4855
 
4856
+ /**
4857
+ * @interface
4858
+ *
4859
+ * Rules for domain-conditional `fin` API injection.
4860
+ *
4861
+ * @remarks Subset of {@link DomainSettings}.
4862
+ */
4863
+ declare type DomainApiSettings = {
4864
+ /**
4865
+ * Injection setting for the `fin` API for contexts on a matched domain.
4866
+ *
4867
+ * * 'none': The `fin` API will be not available.
4868
+ * * 'global': The entire `fin` API will be available.
4869
+ *
4870
+ * @defaultValue 'global'
4871
+ */
4872
+ fin: InjectionType;
4873
+ };
4874
+
4858
4875
  /**
4859
4876
  * @interface
4860
4877
  * Defines application settings that vary by the domain of the current context.
@@ -4893,7 +4910,7 @@ declare type DomainSettingsRule = {
4893
4910
  /**
4894
4911
  * {@inheritDoc ApiInjection}
4895
4912
  */
4896
- api?: ApiInjection;
4913
+ api?: DomainApiSettings;
4897
4914
  };
4898
4915
  };
4899
4916
 
@@ -4932,18 +4949,19 @@ declare type DownloadPreloadOption = {
4932
4949
  /**
4933
4950
  * @interface
4934
4951
  *
4935
- * A rule governing domain-conditional download behavior.
4952
+ * A rule that governs download behavior, discriminated by the URL of the download.
4936
4953
  */
4937
4954
  declare type DownloadRule = {
4938
4955
  /**
4939
- * {@inheritDoc FileDownloadBehaviorNames}
4956
+ * {@inheritDoc FileDownloadBehavior}
4940
4957
  */
4941
- behavior: FileDownloadBehaviorNames;
4958
+ behavior: FileDownloadBehavior;
4942
4959
  /**
4943
4960
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4944
- * the domain(s) for which the rule applies.
4961
+ * URL(s) of the resource(s) being downloaded.
4945
4962
  *
4946
- * @remarks The match is evaluated against the URL of the *download*.
4963
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4964
+ * of the page in which a file download link is embedded.
4947
4965
  */
4948
4966
  match: string[];
4949
4967
  };
@@ -5653,7 +5671,12 @@ declare type FetchManifestPayload = {
5653
5671
  /**
5654
5672
  * Whether file downloads raise a user prompt.
5655
5673
  */
5656
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5674
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5675
+
5676
+ /**
5677
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5678
+ */
5679
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5657
5680
 
5658
5681
  /**
5659
5682
  * Generated when a file download has completed.
@@ -9540,7 +9563,7 @@ declare type MutableViewOptions = {
9540
9563
  /**
9541
9564
  * Configurations for API injection.
9542
9565
  */
9543
- api: Api;
9566
+ api: ApiSettings;
9544
9567
  /**
9545
9568
  * Restrict navigation to URLs that match an allowed pattern.
9546
9569
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10002,6 +10025,7 @@ declare namespace OpenFin {
10002
10025
  ResizeRegion,
10003
10026
  Accelerator,
10004
10027
  Api,
10028
+ ApiSettings,
10005
10029
  InjectionType,
10006
10030
  NavigationRules,
10007
10031
  ContentNavigation,
@@ -10153,7 +10177,9 @@ declare namespace OpenFin {
10153
10177
  DefaultDomainSettingsRule,
10154
10178
  DomainSettings,
10155
10179
  ApiInjection,
10180
+ DomainApiSettings,
10156
10181
  DomainSettingsRule,
10182
+ FileDownloadBehavior,
10157
10183
  FileDownloadBehaviorNames,
10158
10184
  FileDownloadSettings,
10159
10185
  DownloadRule,
@@ -10161,6 +10187,7 @@ declare namespace OpenFin {
10161
10187
  Intent_2 as Intent,
10162
10188
  IntentMetadata_3 as IntentMetadata,
10163
10189
  IntentHandler_2 as IntentHandler,
10190
+ ContentCreationBehavior,
10164
10191
  ContentCreationBehaviorNames,
10165
10192
  MatchPattern,
10166
10193
  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
  */
@@ -3581,7 +3574,7 @@ declare type ConstViewOptions = {
3581
3574
  /**
3582
3575
  * Configurations for API injection.
3583
3576
  */
3584
- api: Api;
3577
+ api: ApiSettings;
3585
3578
  /**
3586
3579
  * The name of the view.
3587
3580
  */
@@ -4001,7 +3994,12 @@ declare interface Container extends EventEmitter_2 {
4001
3994
  close(): boolean;
4002
3995
  }
4003
3996
 
4004
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3997
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3998
+
3999
+ /**
4000
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
4001
+ */
4002
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
4005
4003
 
4006
4004
  /**
4007
4005
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -4025,7 +4023,7 @@ declare type ContentCreationOptions = {
4025
4023
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
4026
4024
  * the specified `behavior` key.
4027
4025
  */
4028
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
4026
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
4029
4027
  behavior: Behavior;
4030
4028
  }>;
4031
4029
 
@@ -4910,6 +4908,25 @@ declare type DisplayMetadata_3 = {
4910
4908
  readonly glyph?: string;
4911
4909
  };
4912
4910
 
4911
+ /**
4912
+ * @interface
4913
+ *
4914
+ * Rules for domain-conditional `fin` API injection.
4915
+ *
4916
+ * @remarks Subset of {@link DomainSettings}.
4917
+ */
4918
+ declare type DomainApiSettings = {
4919
+ /**
4920
+ * Injection setting for the `fin` API for contexts on a matched domain.
4921
+ *
4922
+ * * 'none': The `fin` API will be not available.
4923
+ * * 'global': The entire `fin` API will be available.
4924
+ *
4925
+ * @defaultValue 'global'
4926
+ */
4927
+ fin: InjectionType;
4928
+ };
4929
+
4913
4930
  /**
4914
4931
  * @interface
4915
4932
  * Defines application settings that vary by the domain of the current context.
@@ -4948,7 +4965,7 @@ declare type DomainSettingsRule = {
4948
4965
  /**
4949
4966
  * {@inheritDoc ApiInjection}
4950
4967
  */
4951
- api?: ApiInjection;
4968
+ api?: DomainApiSettings;
4952
4969
  };
4953
4970
  };
4954
4971
 
@@ -4987,18 +5004,19 @@ declare type DownloadPreloadOption = {
4987
5004
  /**
4988
5005
  * @interface
4989
5006
  *
4990
- * A rule governing domain-conditional download behavior.
5007
+ * A rule that governs download behavior, discriminated by the URL of the download.
4991
5008
  */
4992
5009
  declare type DownloadRule = {
4993
5010
  /**
4994
- * {@inheritDoc FileDownloadBehaviorNames}
5011
+ * {@inheritDoc FileDownloadBehavior}
4995
5012
  */
4996
- behavior: FileDownloadBehaviorNames;
5013
+ behavior: FileDownloadBehavior;
4997
5014
  /**
4998
5015
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4999
- * the domain(s) for which the rule applies.
5016
+ * URL(s) of the resource(s) being downloaded.
5000
5017
  *
5001
- * @remarks The match is evaluated against the URL of the *download*.
5018
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
5019
+ * of the page in which a file download link is embedded.
5002
5020
  */
5003
5021
  match: string[];
5004
5022
  };
@@ -5734,7 +5752,12 @@ declare type FetchManifestPayload = {
5734
5752
  /**
5735
5753
  * Whether file downloads raise a user prompt.
5736
5754
  */
5737
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5755
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5756
+
5757
+ /**
5758
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5759
+ */
5760
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5738
5761
 
5739
5762
  /**
5740
5763
  * Generated when a file download has completed.
@@ -9851,7 +9874,7 @@ declare type MutableViewOptions = {
9851
9874
  /**
9852
9875
  * Configurations for API injection.
9853
9876
  */
9854
- api: Api;
9877
+ api: ApiSettings;
9855
9878
  /**
9856
9879
  * Restrict navigation to URLs that match an allowed pattern.
9857
9880
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10335,6 +10358,7 @@ declare namespace OpenFin {
10335
10358
  ResizeRegion,
10336
10359
  Accelerator,
10337
10360
  Api,
10361
+ ApiSettings,
10338
10362
  InjectionType,
10339
10363
  NavigationRules,
10340
10364
  ContentNavigation,
@@ -10486,7 +10510,9 @@ declare namespace OpenFin {
10486
10510
  DefaultDomainSettingsRule,
10487
10511
  DomainSettings,
10488
10512
  ApiInjection,
10513
+ DomainApiSettings,
10489
10514
  DomainSettingsRule,
10515
+ FileDownloadBehavior,
10490
10516
  FileDownloadBehaviorNames,
10491
10517
  FileDownloadSettings,
10492
10518
  DownloadRule,
@@ -10494,6 +10520,7 @@ declare namespace OpenFin {
10494
10520
  Intent_2 as Intent,
10495
10521
  IntentMetadata_3 as IntentMetadata,
10496
10522
  IntentHandler_2 as IntentHandler,
10523
+ ContentCreationBehavior,
10497
10524
  ContentCreationBehaviorNames,
10498
10525
  MatchPattern,
10499
10526
  BaseContentCreationRule,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/node-adapter",
3
- "version": "36.80.1",
3
+ "version": "36.80.2",
4
4
  "description": "See README.md",
5
5
  "main": "out/node-adapter.js",
6
6
  "types": "out/node-adapter.d.ts",