@openfin/remote-adapter 36.79.4 → 36.79.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -97,7 +97,10 @@ declare type Api = {
97
97
  enableDeprecatedSharedName?: boolean;
98
98
  };
99
99
  /**
100
- * Prevent fin API injection. If 'none', `fin` won't be available in this context.
100
+ * Configure injection of the `fin` API in this context.
101
+ *
102
+ * * 'none': The `fin` API will be not available in this context.
103
+ * * 'global': The entire `fin` API will be available in this context.
101
104
  */
102
105
  fin?: InjectionType;
103
106
  };
@@ -113,8 +116,18 @@ declare type ApiClient<T extends Record<any, any>> = {
113
116
 
114
117
  /**
115
118
  * @interface
119
+ *
120
+ * Rules for domain-conditional `fin` API injection.
116
121
  */
117
122
  declare type ApiInjection = {
123
+ /**
124
+ * Injection setting for the `fin` API for contexts on a matched domain.
125
+ *
126
+ * * 'none': The `fin` API will be not available.
127
+ * * 'global': The entire `fin` API will be available.
128
+ *
129
+ * @defaultValue 'global'
130
+ */
118
131
  fin: InjectionType;
119
132
  };
120
133
 
@@ -1712,7 +1725,7 @@ declare type BaseConfig = {
1712
1725
  */
1713
1726
  declare type BaseContentCreationRule = {
1714
1727
  /**
1715
- * List of [match patterns](https://developer.chrome.com/extensions/match_patterns) that indicate the specified
1728
+ * List of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) that indicate the specified
1716
1729
  * behavior should be used
1717
1730
  */
1718
1731
  match: MatchPattern[];
@@ -3632,13 +3645,13 @@ declare type ConstWindowOptions = {
3632
3645
  /**
3633
3646
  * Restrict navigation to URLs that match an allowed pattern.
3634
3647
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
3635
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3648
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3636
3649
  */
3637
3650
  contentNavigation: ContentNavigation;
3638
3651
  /**
3639
3652
  * Restrict redirects to URLs that match an allowed pattern.
3640
3653
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
3641
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3654
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3642
3655
  */
3643
3656
  contentRedirect: Partial<ContentRedirect>;
3644
3657
  /**
@@ -4183,7 +4196,7 @@ declare interface ContentItem extends EventEmitter_2 {
4183
4196
  /**
4184
4197
  * Restrict navigation to URLs that match an allowed pattern.
4185
4198
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4186
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4199
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4187
4200
  *
4188
4201
  * @interface
4189
4202
  */
@@ -4192,7 +4205,7 @@ declare type ContentNavigation = NavigationRules;
4192
4205
  /**
4193
4206
  * Restrict redirects to URLs that match an allowed pattern.
4194
4207
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4195
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4208
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4196
4209
  *
4197
4210
  * @interface
4198
4211
  */
@@ -4796,19 +4809,42 @@ declare type DisplayMetadata_3 = {
4796
4809
 
4797
4810
  /**
4798
4811
  * @interface
4799
- * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
4812
+ * Defines application settings that vary by the domain of the current context.
4813
+ *
4814
+ * @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
4815
+ * domain should be represented with a single rule.
4800
4816
  */
4801
4817
  declare type DomainSettings = {
4818
+ /**
4819
+ * {@inheritDoc DomainSettingsRule}
4820
+ */
4802
4821
  rules: DomainSettingsRule[];
4803
4822
  };
4804
4823
 
4805
4824
  /**
4806
4825
  * @interface
4826
+ *
4827
+ * Defines domain-conditional settings for an OpenFin application.
4807
4828
  */
4808
4829
  declare type DomainSettingsRule = {
4830
+ /**
4831
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4832
+ * the domain(s) for which the rule applies.
4833
+ */
4809
4834
  match: string[];
4835
+ /**
4836
+ * Settings applied when a webcontents has been navigated to a matched domain.
4837
+ */
4810
4838
  options: {
4839
+ /**
4840
+ * {@inheritDoc FileDownloadSettings}
4841
+ *
4842
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
4843
+ */
4811
4844
  downloadSettings?: FileDownloadSettings;
4845
+ /**
4846
+ * {@inheritDoc ApiInjection}
4847
+ */
4812
4848
  api?: ApiInjection;
4813
4849
  };
4814
4850
  };
@@ -4847,9 +4883,20 @@ declare type DownloadPreloadOption = {
4847
4883
 
4848
4884
  /**
4849
4885
  * @interface
4886
+ *
4887
+ * A rule governing domain-conditional download behavior.
4850
4888
  */
4851
4889
  declare type DownloadRule = {
4890
+ /**
4891
+ * {@inheritDoc FileDownloadBehaviorNames}
4892
+ */
4852
4893
  behavior: FileDownloadBehaviorNames;
4894
+ /**
4895
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4896
+ * the domain(s) for which the rule applies.
4897
+ *
4898
+ * @remarks The match is evaluated against the URL of the *download*.
4899
+ */
4853
4900
  match: string[];
4854
4901
  };
4855
4902
 
@@ -5545,6 +5592,9 @@ declare type FetchManifestPayload = {
5545
5592
  manifestUrl: string;
5546
5593
  };
5547
5594
 
5595
+ /**
5596
+ * Whether file downloads raise a user prompt.
5597
+ */
5548
5598
  declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5549
5599
 
5550
5600
  /**
@@ -5627,9 +5677,14 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5627
5677
  };
5628
5678
 
5629
5679
  /**
5630
- * @interface
5680
+ * Domain-conditional rules for file downloads.
5681
+ *
5682
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5631
5683
  */
5632
5684
  declare type FileDownloadSettings = {
5685
+ /**
5686
+ * {@inheritDoc DownloadRule}
5687
+ */
5633
5688
  rules: DownloadRule[];
5634
5689
  };
5635
5690
 
@@ -6713,9 +6768,10 @@ declare type InitPlatformOptions = {
6713
6768
  };
6714
6769
 
6715
6770
  /**
6716
- * * 'none': The `fin` API will be not available from within this context.
6717
- * * 'global': The entire `fin` API will be available from within this context.
6718
- * @defaultValue 'global'
6771
+ * Injection setting for the `fin` API.
6772
+ *
6773
+ * * 'none': The `fin` API will be not available.
6774
+ * * 'global': The entire `fin` API will be available.
6719
6775
  */
6720
6776
  declare type InjectionType = 'none' | 'global';
6721
6777
 
@@ -9416,7 +9472,7 @@ declare type MutableViewOptions = {
9416
9472
  /**
9417
9473
  * Restrict navigation to URLs that match an allowed pattern.
9418
9474
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
9419
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
9475
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
9420
9476
  */
9421
9477
  contentNavigation: ContentNavigation;
9422
9478
  contentRedirect: ContentRedirect;
@@ -97,7 +97,10 @@ declare type Api = {
97
97
  enableDeprecatedSharedName?: boolean;
98
98
  };
99
99
  /**
100
- * Prevent fin API injection. If 'none', `fin` won't be available in this context.
100
+ * Configure injection of the `fin` API in this context.
101
+ *
102
+ * * 'none': The `fin` API will be not available in this context.
103
+ * * 'global': The entire `fin` API will be available in this context.
101
104
  */
102
105
  fin?: InjectionType;
103
106
  };
@@ -113,8 +116,18 @@ declare type ApiClient<T extends Record<any, any>> = {
113
116
 
114
117
  /**
115
118
  * @interface
119
+ *
120
+ * Rules for domain-conditional `fin` API injection.
116
121
  */
117
122
  declare type ApiInjection = {
123
+ /**
124
+ * Injection setting for the `fin` API for contexts on a matched domain.
125
+ *
126
+ * * 'none': The `fin` API will be not available.
127
+ * * 'global': The entire `fin` API will be available.
128
+ *
129
+ * @defaultValue 'global'
130
+ */
118
131
  fin: InjectionType;
119
132
  };
120
133
 
@@ -1712,7 +1725,7 @@ declare type BaseConfig = {
1712
1725
  */
1713
1726
  declare type BaseContentCreationRule = {
1714
1727
  /**
1715
- * List of [match patterns](https://developer.chrome.com/extensions/match_patterns) that indicate the specified
1728
+ * List of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) that indicate the specified
1716
1729
  * behavior should be used
1717
1730
  */
1718
1731
  match: MatchPattern[];
@@ -3632,13 +3645,13 @@ declare type ConstWindowOptions = {
3632
3645
  /**
3633
3646
  * Restrict navigation to URLs that match an allowed pattern.
3634
3647
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
3635
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3648
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3636
3649
  */
3637
3650
  contentNavigation: ContentNavigation;
3638
3651
  /**
3639
3652
  * Restrict redirects to URLs that match an allowed pattern.
3640
3653
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
3641
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3654
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3642
3655
  */
3643
3656
  contentRedirect: Partial<ContentRedirect>;
3644
3657
  /**
@@ -4183,7 +4196,7 @@ declare interface ContentItem extends EventEmitter_2 {
4183
4196
  /**
4184
4197
  * Restrict navigation to URLs that match an allowed pattern.
4185
4198
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4186
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4199
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4187
4200
  *
4188
4201
  * @interface
4189
4202
  */
@@ -4192,7 +4205,7 @@ declare type ContentNavigation = NavigationRules;
4192
4205
  /**
4193
4206
  * Restrict redirects to URLs that match an allowed pattern.
4194
4207
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4195
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4208
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4196
4209
  *
4197
4210
  * @interface
4198
4211
  */
@@ -4796,19 +4809,42 @@ declare type DisplayMetadata_3 = {
4796
4809
 
4797
4810
  /**
4798
4811
  * @interface
4799
- * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
4812
+ * Defines application settings that vary by the domain of the current context.
4813
+ *
4814
+ * @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
4815
+ * domain should be represented with a single rule.
4800
4816
  */
4801
4817
  declare type DomainSettings = {
4818
+ /**
4819
+ * {@inheritDoc DomainSettingsRule}
4820
+ */
4802
4821
  rules: DomainSettingsRule[];
4803
4822
  };
4804
4823
 
4805
4824
  /**
4806
4825
  * @interface
4826
+ *
4827
+ * Defines domain-conditional settings for an OpenFin application.
4807
4828
  */
4808
4829
  declare type DomainSettingsRule = {
4830
+ /**
4831
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4832
+ * the domain(s) for which the rule applies.
4833
+ */
4809
4834
  match: string[];
4835
+ /**
4836
+ * Settings applied when a webcontents has been navigated to a matched domain.
4837
+ */
4810
4838
  options: {
4839
+ /**
4840
+ * {@inheritDoc FileDownloadSettings}
4841
+ *
4842
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
4843
+ */
4811
4844
  downloadSettings?: FileDownloadSettings;
4845
+ /**
4846
+ * {@inheritDoc ApiInjection}
4847
+ */
4812
4848
  api?: ApiInjection;
4813
4849
  };
4814
4850
  };
@@ -4847,9 +4883,20 @@ declare type DownloadPreloadOption = {
4847
4883
 
4848
4884
  /**
4849
4885
  * @interface
4886
+ *
4887
+ * A rule governing domain-conditional download behavior.
4850
4888
  */
4851
4889
  declare type DownloadRule = {
4890
+ /**
4891
+ * {@inheritDoc FileDownloadBehaviorNames}
4892
+ */
4852
4893
  behavior: FileDownloadBehaviorNames;
4894
+ /**
4895
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4896
+ * the domain(s) for which the rule applies.
4897
+ *
4898
+ * @remarks The match is evaluated against the URL of the *download*.
4899
+ */
4853
4900
  match: string[];
4854
4901
  };
4855
4902
 
@@ -5545,6 +5592,9 @@ declare type FetchManifestPayload = {
5545
5592
  manifestUrl: string;
5546
5593
  };
5547
5594
 
5595
+ /**
5596
+ * Whether file downloads raise a user prompt.
5597
+ */
5548
5598
  declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5549
5599
 
5550
5600
  /**
@@ -5627,9 +5677,14 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5627
5677
  };
5628
5678
 
5629
5679
  /**
5630
- * @interface
5680
+ * Domain-conditional rules for file downloads.
5681
+ *
5682
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5631
5683
  */
5632
5684
  declare type FileDownloadSettings = {
5685
+ /**
5686
+ * {@inheritDoc DownloadRule}
5687
+ */
5633
5688
  rules: DownloadRule[];
5634
5689
  };
5635
5690
 
@@ -6713,9 +6768,10 @@ declare type InitPlatformOptions = {
6713
6768
  };
6714
6769
 
6715
6770
  /**
6716
- * * 'none': The `fin` API will be not available from within this context.
6717
- * * 'global': The entire `fin` API will be available from within this context.
6718
- * @defaultValue 'global'
6771
+ * Injection setting for the `fin` API.
6772
+ *
6773
+ * * 'none': The `fin` API will be not available.
6774
+ * * 'global': The entire `fin` API will be available.
6719
6775
  */
6720
6776
  declare type InjectionType = 'none' | 'global';
6721
6777
 
@@ -9416,7 +9472,7 @@ declare type MutableViewOptions = {
9416
9472
  /**
9417
9473
  * Restrict navigation to URLs that match an allowed pattern.
9418
9474
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
9419
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
9475
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
9420
9476
  */
9421
9477
  contentNavigation: ContentNavigation;
9422
9478
  contentRedirect: ContentRedirect;
@@ -97,7 +97,10 @@ declare type Api = {
97
97
  enableDeprecatedSharedName?: boolean;
98
98
  };
99
99
  /**
100
- * Prevent fin API injection. If 'none', `fin` won't be available in this context.
100
+ * Configure injection of the `fin` API in this context.
101
+ *
102
+ * * 'none': The `fin` API will be not available in this context.
103
+ * * 'global': The entire `fin` API will be available in this context.
101
104
  */
102
105
  fin?: InjectionType;
103
106
  };
@@ -113,8 +116,18 @@ declare type ApiClient<T extends Record<any, any>> = {
113
116
 
114
117
  /**
115
118
  * @interface
119
+ *
120
+ * Rules for domain-conditional `fin` API injection.
116
121
  */
117
122
  declare type ApiInjection = {
123
+ /**
124
+ * Injection setting for the `fin` API for contexts on a matched domain.
125
+ *
126
+ * * 'none': The `fin` API will be not available.
127
+ * * 'global': The entire `fin` API will be available.
128
+ *
129
+ * @defaultValue 'global'
130
+ */
118
131
  fin: InjectionType;
119
132
  };
120
133
 
@@ -1712,7 +1725,7 @@ declare type BaseConfig = {
1712
1725
  */
1713
1726
  declare type BaseContentCreationRule = {
1714
1727
  /**
1715
- * List of [match patterns](https://developer.chrome.com/extensions/match_patterns) that indicate the specified
1728
+ * List of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) that indicate the specified
1716
1729
  * behavior should be used
1717
1730
  */
1718
1731
  match: MatchPattern[];
@@ -3632,13 +3645,13 @@ declare type ConstWindowOptions = {
3632
3645
  /**
3633
3646
  * Restrict navigation to URLs that match an allowed pattern.
3634
3647
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
3635
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3648
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3636
3649
  */
3637
3650
  contentNavigation: ContentNavigation;
3638
3651
  /**
3639
3652
  * Restrict redirects to URLs that match an allowed pattern.
3640
3653
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
3641
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3654
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3642
3655
  */
3643
3656
  contentRedirect: Partial<ContentRedirect>;
3644
3657
  /**
@@ -4183,7 +4196,7 @@ declare interface ContentItem extends EventEmitter_2 {
4183
4196
  /**
4184
4197
  * Restrict navigation to URLs that match an allowed pattern.
4185
4198
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4186
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4199
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4187
4200
  *
4188
4201
  * @interface
4189
4202
  */
@@ -4192,7 +4205,7 @@ declare type ContentNavigation = NavigationRules;
4192
4205
  /**
4193
4206
  * Restrict redirects to URLs that match an allowed pattern.
4194
4207
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4195
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4208
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4196
4209
  *
4197
4210
  * @interface
4198
4211
  */
@@ -4796,19 +4809,42 @@ declare type DisplayMetadata_3 = {
4796
4809
 
4797
4810
  /**
4798
4811
  * @interface
4799
- * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
4812
+ * Defines application settings that vary by the domain of the current context.
4813
+ *
4814
+ * @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
4815
+ * domain should be represented with a single rule.
4800
4816
  */
4801
4817
  declare type DomainSettings = {
4818
+ /**
4819
+ * {@inheritDoc DomainSettingsRule}
4820
+ */
4802
4821
  rules: DomainSettingsRule[];
4803
4822
  };
4804
4823
 
4805
4824
  /**
4806
4825
  * @interface
4826
+ *
4827
+ * Defines domain-conditional settings for an OpenFin application.
4807
4828
  */
4808
4829
  declare type DomainSettingsRule = {
4830
+ /**
4831
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4832
+ * the domain(s) for which the rule applies.
4833
+ */
4809
4834
  match: string[];
4835
+ /**
4836
+ * Settings applied when a webcontents has been navigated to a matched domain.
4837
+ */
4810
4838
  options: {
4839
+ /**
4840
+ * {@inheritDoc FileDownloadSettings}
4841
+ *
4842
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
4843
+ */
4811
4844
  downloadSettings?: FileDownloadSettings;
4845
+ /**
4846
+ * {@inheritDoc ApiInjection}
4847
+ */
4812
4848
  api?: ApiInjection;
4813
4849
  };
4814
4850
  };
@@ -4847,9 +4883,20 @@ declare type DownloadPreloadOption = {
4847
4883
 
4848
4884
  /**
4849
4885
  * @interface
4886
+ *
4887
+ * A rule governing domain-conditional download behavior.
4850
4888
  */
4851
4889
  declare type DownloadRule = {
4890
+ /**
4891
+ * {@inheritDoc FileDownloadBehaviorNames}
4892
+ */
4852
4893
  behavior: FileDownloadBehaviorNames;
4894
+ /**
4895
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4896
+ * the domain(s) for which the rule applies.
4897
+ *
4898
+ * @remarks The match is evaluated against the URL of the *download*.
4899
+ */
4853
4900
  match: string[];
4854
4901
  };
4855
4902
 
@@ -5545,6 +5592,9 @@ declare type FetchManifestPayload = {
5545
5592
  manifestUrl: string;
5546
5593
  };
5547
5594
 
5595
+ /**
5596
+ * Whether file downloads raise a user prompt.
5597
+ */
5548
5598
  declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5549
5599
 
5550
5600
  /**
@@ -5627,9 +5677,14 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5627
5677
  };
5628
5678
 
5629
5679
  /**
5630
- * @interface
5680
+ * Domain-conditional rules for file downloads.
5681
+ *
5682
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5631
5683
  */
5632
5684
  declare type FileDownloadSettings = {
5685
+ /**
5686
+ * {@inheritDoc DownloadRule}
5687
+ */
5633
5688
  rules: DownloadRule[];
5634
5689
  };
5635
5690
 
@@ -6713,9 +6768,10 @@ declare type InitPlatformOptions = {
6713
6768
  };
6714
6769
 
6715
6770
  /**
6716
- * * 'none': The `fin` API will be not available from within this context.
6717
- * * 'global': The entire `fin` API will be available from within this context.
6718
- * @defaultValue 'global'
6771
+ * Injection setting for the `fin` API.
6772
+ *
6773
+ * * 'none': The `fin` API will be not available.
6774
+ * * 'global': The entire `fin` API will be available.
6719
6775
  */
6720
6776
  declare type InjectionType = 'none' | 'global';
6721
6777
 
@@ -9416,7 +9472,7 @@ declare type MutableViewOptions = {
9416
9472
  /**
9417
9473
  * Restrict navigation to URLs that match an allowed pattern.
9418
9474
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
9419
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
9475
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
9420
9476
  */
9421
9477
  contentNavigation: ContentNavigation;
9422
9478
  contentRedirect: ContentRedirect;
@@ -97,7 +97,10 @@ declare type Api = {
97
97
  enableDeprecatedSharedName?: boolean;
98
98
  };
99
99
  /**
100
- * Prevent fin API injection. If 'none', `fin` won't be available in this context.
100
+ * Configure injection of the `fin` API in this context.
101
+ *
102
+ * * 'none': The `fin` API will be not available in this context.
103
+ * * 'global': The entire `fin` API will be available in this context.
101
104
  */
102
105
  fin?: InjectionType;
103
106
  };
@@ -113,8 +116,18 @@ declare type ApiClient<T extends Record<any, any>> = {
113
116
 
114
117
  /**
115
118
  * @interface
119
+ *
120
+ * Rules for domain-conditional `fin` API injection.
116
121
  */
117
122
  declare type ApiInjection = {
123
+ /**
124
+ * Injection setting for the `fin` API for contexts on a matched domain.
125
+ *
126
+ * * 'none': The `fin` API will be not available.
127
+ * * 'global': The entire `fin` API will be available.
128
+ *
129
+ * @defaultValue 'global'
130
+ */
118
131
  fin: InjectionType;
119
132
  };
120
133
 
@@ -1732,7 +1745,7 @@ declare type BaseConfig = {
1732
1745
  */
1733
1746
  declare type BaseContentCreationRule = {
1734
1747
  /**
1735
- * List of [match patterns](https://developer.chrome.com/extensions/match_patterns) that indicate the specified
1748
+ * List of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) that indicate the specified
1736
1749
  * behavior should be used
1737
1750
  */
1738
1751
  match: MatchPattern[];
@@ -3675,13 +3688,13 @@ declare type ConstWindowOptions = {
3675
3688
  /**
3676
3689
  * Restrict navigation to URLs that match an allowed pattern.
3677
3690
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
3678
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3691
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3679
3692
  */
3680
3693
  contentNavigation: ContentNavigation;
3681
3694
  /**
3682
3695
  * Restrict redirects to URLs that match an allowed pattern.
3683
3696
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
3684
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3697
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3685
3698
  */
3686
3699
  contentRedirect: Partial<ContentRedirect>;
3687
3700
  /**
@@ -4226,7 +4239,7 @@ declare interface ContentItem extends EventEmitter_2 {
4226
4239
  /**
4227
4240
  * Restrict navigation to URLs that match an allowed pattern.
4228
4241
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4229
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4242
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4230
4243
  *
4231
4244
  * @interface
4232
4245
  */
@@ -4235,7 +4248,7 @@ declare type ContentNavigation = NavigationRules;
4235
4248
  /**
4236
4249
  * Restrict redirects to URLs that match an allowed pattern.
4237
4250
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4238
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4251
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4239
4252
  *
4240
4253
  * @interface
4241
4254
  */
@@ -4839,19 +4852,42 @@ declare type DisplayMetadata_3 = {
4839
4852
 
4840
4853
  /**
4841
4854
  * @interface
4842
- * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
4855
+ * Defines application settings that vary by the domain of the current context.
4856
+ *
4857
+ * @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
4858
+ * domain should be represented with a single rule.
4843
4859
  */
4844
4860
  declare type DomainSettings = {
4861
+ /**
4862
+ * {@inheritDoc DomainSettingsRule}
4863
+ */
4845
4864
  rules: DomainSettingsRule[];
4846
4865
  };
4847
4866
 
4848
4867
  /**
4849
4868
  * @interface
4869
+ *
4870
+ * Defines domain-conditional settings for an OpenFin application.
4850
4871
  */
4851
4872
  declare type DomainSettingsRule = {
4873
+ /**
4874
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4875
+ * the domain(s) for which the rule applies.
4876
+ */
4852
4877
  match: string[];
4878
+ /**
4879
+ * Settings applied when a webcontents has been navigated to a matched domain.
4880
+ */
4853
4881
  options: {
4882
+ /**
4883
+ * {@inheritDoc FileDownloadSettings}
4884
+ *
4885
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
4886
+ */
4854
4887
  downloadSettings?: FileDownloadSettings;
4888
+ /**
4889
+ * {@inheritDoc ApiInjection}
4890
+ */
4855
4891
  api?: ApiInjection;
4856
4892
  };
4857
4893
  };
@@ -4890,9 +4926,20 @@ declare type DownloadPreloadOption = {
4890
4926
 
4891
4927
  /**
4892
4928
  * @interface
4929
+ *
4930
+ * A rule governing domain-conditional download behavior.
4893
4931
  */
4894
4932
  declare type DownloadRule = {
4933
+ /**
4934
+ * {@inheritDoc FileDownloadBehaviorNames}
4935
+ */
4895
4936
  behavior: FileDownloadBehaviorNames;
4937
+ /**
4938
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4939
+ * the domain(s) for which the rule applies.
4940
+ *
4941
+ * @remarks The match is evaluated against the URL of the *download*.
4942
+ */
4896
4943
  match: string[];
4897
4944
  };
4898
4945
 
@@ -5614,6 +5661,9 @@ declare type FetchManifestPayload = {
5614
5661
  manifestUrl: string;
5615
5662
  };
5616
5663
 
5664
+ /**
5665
+ * Whether file downloads raise a user prompt.
5666
+ */
5617
5667
  declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5618
5668
 
5619
5669
  /**
@@ -5696,9 +5746,14 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5696
5746
  };
5697
5747
 
5698
5748
  /**
5699
- * @interface
5749
+ * Domain-conditional rules for file downloads.
5750
+ *
5751
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5700
5752
  */
5701
5753
  declare type FileDownloadSettings = {
5754
+ /**
5755
+ * {@inheritDoc DownloadRule}
5756
+ */
5702
5757
  rules: DownloadRule[];
5703
5758
  };
5704
5759
 
@@ -6791,9 +6846,10 @@ declare type InitPlatformOptions = {
6791
6846
  };
6792
6847
 
6793
6848
  /**
6794
- * * 'none': The `fin` API will be not available from within this context.
6795
- * * 'global': The entire `fin` API will be available from within this context.
6796
- * @defaultValue 'global'
6849
+ * Injection setting for the `fin` API.
6850
+ *
6851
+ * * 'none': The `fin` API will be not available.
6852
+ * * 'global': The entire `fin` API will be available.
6797
6853
  */
6798
6854
  declare type InjectionType = 'none' | 'global';
6799
6855
 
@@ -9693,7 +9749,7 @@ declare type MutableViewOptions = {
9693
9749
  /**
9694
9750
  * Restrict navigation to URLs that match an allowed pattern.
9695
9751
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
9696
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
9752
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
9697
9753
  */
9698
9754
  contentNavigation: ContentNavigation;
9699
9755
  contentRedirect: ContentRedirect;
@@ -6493,7 +6493,7 @@ class WebSocketTransport extends events_1$4.EventEmitter {
6493
6493
  }
6494
6494
  var _default = websocket.default = WebSocketTransport;
6495
6495
 
6496
- var fin = {};
6496
+ var fin$1 = {};
6497
6497
 
6498
6498
  var system = {};
6499
6499
 
@@ -12633,6 +12633,9 @@ class PlatformModule extends base_1$4.Base {
12633
12633
  * @experimental
12634
12634
  */
12635
12635
  async init(options) {
12636
+ if (!fin.__internal_.isPlatform || fin.me.name !== fin.me.uuid) {
12637
+ throw new Error('fin.Platform.init should only be called from a custom platform provider running in the main window of the application.');
12638
+ }
12636
12639
  return this.wire.environment.initPlatform(this.fin, options);
12637
12640
  }
12638
12641
  /**
@@ -15769,8 +15772,8 @@ Factory.SnapshotSourceModule = SnapshotSourceModule;
15769
15772
  __exportStar(Instance, exports);
15770
15773
  } (snapshotSource));
15771
15774
 
15772
- Object.defineProperty(fin, "__esModule", { value: true });
15773
- var Fin_1 = fin.Fin = void 0;
15775
+ Object.defineProperty(fin$1, "__esModule", { value: true });
15776
+ var Fin_1 = fin$1.Fin = void 0;
15774
15777
  const events_1 = require$$0;
15775
15778
  // Import from the file rather than the directory in case someone consuming types is using module resolution other than "node"
15776
15779
  const index_1 = system;
@@ -15816,13 +15819,13 @@ class Fin extends events_1.EventEmitter {
15816
15819
  });
15817
15820
  }
15818
15821
  }
15819
- Fin_1 = fin.Fin = Fin;
15822
+ Fin_1 = fin$1.Fin = Fin;
15820
15823
 
15821
15824
  var browser = {};
15822
15825
 
15823
15826
  Object.defineProperty(browser, "__esModule", { value: true });
15824
15827
  browser.remoteConnectInterop = browser.remoteConnect = getRemoteConnectionPayload_1 = browser.getRemoteConnectionPayload = void 0;
15825
- const fin_1 = fin;
15828
+ const fin_1 = fin$1;
15826
15829
  const browser_1 = browser$1;
15827
15830
  const transport_1 = transport;
15828
15831
  const websocket_1 = websocket;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/remote-adapter",
3
- "version": "36.79.4",
3
+ "version": "36.79.9",
4
4
  "description": "Establish intermachine runtime connections using webRTC.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,