@openfin/node-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[];
@@ -3612,13 +3625,13 @@ declare type ConstWindowOptions = {
3612
3625
  /**
3613
3626
  * Restrict navigation to URLs that match an allowed pattern.
3614
3627
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
3615
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3628
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3616
3629
  */
3617
3630
  contentNavigation: ContentNavigation;
3618
3631
  /**
3619
3632
  * Restrict redirects to URLs that match an allowed pattern.
3620
3633
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
3621
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3634
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3622
3635
  */
3623
3636
  contentRedirect: Partial<ContentRedirect>;
3624
3637
  /**
@@ -4163,7 +4176,7 @@ declare interface ContentItem extends EventEmitter_2 {
4163
4176
  /**
4164
4177
  * Restrict navigation to URLs that match an allowed pattern.
4165
4178
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4166
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4179
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4167
4180
  *
4168
4181
  * @interface
4169
4182
  */
@@ -4172,7 +4185,7 @@ declare type ContentNavigation = NavigationRules;
4172
4185
  /**
4173
4186
  * Restrict redirects to URLs that match an allowed pattern.
4174
4187
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4175
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4188
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4176
4189
  *
4177
4190
  * @interface
4178
4191
  */
@@ -4776,19 +4789,42 @@ declare type DisplayMetadata_3 = {
4776
4789
 
4777
4790
  /**
4778
4791
  * @interface
4779
- * 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.
4792
+ * Defines application settings that vary by the domain of the current context.
4793
+ *
4794
+ * @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
4795
+ * domain should be represented with a single rule.
4780
4796
  */
4781
4797
  declare type DomainSettings = {
4798
+ /**
4799
+ * {@inheritDoc DomainSettingsRule}
4800
+ */
4782
4801
  rules: DomainSettingsRule[];
4783
4802
  };
4784
4803
 
4785
4804
  /**
4786
4805
  * @interface
4806
+ *
4807
+ * Defines domain-conditional settings for an OpenFin application.
4787
4808
  */
4788
4809
  declare type DomainSettingsRule = {
4810
+ /**
4811
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4812
+ * the domain(s) for which the rule applies.
4813
+ */
4789
4814
  match: string[];
4815
+ /**
4816
+ * Settings applied when a webcontents has been navigated to a matched domain.
4817
+ */
4790
4818
  options: {
4819
+ /**
4820
+ * {@inheritDoc FileDownloadSettings}
4821
+ *
4822
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
4823
+ */
4791
4824
  downloadSettings?: FileDownloadSettings;
4825
+ /**
4826
+ * {@inheritDoc ApiInjection}
4827
+ */
4792
4828
  api?: ApiInjection;
4793
4829
  };
4794
4830
  };
@@ -4827,9 +4863,20 @@ declare type DownloadPreloadOption = {
4827
4863
 
4828
4864
  /**
4829
4865
  * @interface
4866
+ *
4867
+ * A rule governing domain-conditional download behavior.
4830
4868
  */
4831
4869
  declare type DownloadRule = {
4870
+ /**
4871
+ * {@inheritDoc FileDownloadBehaviorNames}
4872
+ */
4832
4873
  behavior: FileDownloadBehaviorNames;
4874
+ /**
4875
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4876
+ * the domain(s) for which the rule applies.
4877
+ *
4878
+ * @remarks The match is evaluated against the URL of the *download*.
4879
+ */
4833
4880
  match: string[];
4834
4881
  };
4835
4882
 
@@ -5529,6 +5576,9 @@ declare type FetchManifestPayload = {
5529
5576
  manifestUrl: string;
5530
5577
  };
5531
5578
 
5579
+ /**
5580
+ * Whether file downloads raise a user prompt.
5581
+ */
5532
5582
  declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5533
5583
 
5534
5584
  /**
@@ -5611,9 +5661,14 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5611
5661
  };
5612
5662
 
5613
5663
  /**
5614
- * @interface
5664
+ * Domain-conditional rules for file downloads.
5665
+ *
5666
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5615
5667
  */
5616
5668
  declare type FileDownloadSettings = {
5669
+ /**
5670
+ * {@inheritDoc DownloadRule}
5671
+ */
5617
5672
  rules: DownloadRule[];
5618
5673
  };
5619
5674
 
@@ -6678,9 +6733,10 @@ declare type InitPlatformOptions = {
6678
6733
  };
6679
6734
 
6680
6735
  /**
6681
- * * 'none': The `fin` API will be not available from within this context.
6682
- * * 'global': The entire `fin` API will be available from within this context.
6683
- * @defaultValue 'global'
6736
+ * Injection setting for the `fin` API.
6737
+ *
6738
+ * * 'none': The `fin` API will be not available.
6739
+ * * 'global': The entire `fin` API will be available.
6684
6740
  */
6685
6741
  declare type InjectionType = 'none' | 'global';
6686
6742
 
@@ -9383,7 +9439,7 @@ declare type MutableViewOptions = {
9383
9439
  /**
9384
9440
  * Restrict navigation to URLs that match an allowed pattern.
9385
9441
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
9386
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
9442
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
9387
9443
  */
9388
9444
  contentNavigation: ContentNavigation;
9389
9445
  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[];
@@ -3612,13 +3625,13 @@ declare type ConstWindowOptions = {
3612
3625
  /**
3613
3626
  * Restrict navigation to URLs that match an allowed pattern.
3614
3627
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
3615
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3628
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3616
3629
  */
3617
3630
  contentNavigation: ContentNavigation;
3618
3631
  /**
3619
3632
  * Restrict redirects to URLs that match an allowed pattern.
3620
3633
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
3621
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3634
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3622
3635
  */
3623
3636
  contentRedirect: Partial<ContentRedirect>;
3624
3637
  /**
@@ -4163,7 +4176,7 @@ declare interface ContentItem extends EventEmitter_2 {
4163
4176
  /**
4164
4177
  * Restrict navigation to URLs that match an allowed pattern.
4165
4178
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4166
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4179
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4167
4180
  *
4168
4181
  * @interface
4169
4182
  */
@@ -4172,7 +4185,7 @@ declare type ContentNavigation = NavigationRules;
4172
4185
  /**
4173
4186
  * Restrict redirects to URLs that match an allowed pattern.
4174
4187
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4175
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4188
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4176
4189
  *
4177
4190
  * @interface
4178
4191
  */
@@ -4776,19 +4789,42 @@ declare type DisplayMetadata_3 = {
4776
4789
 
4777
4790
  /**
4778
4791
  * @interface
4779
- * 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.
4792
+ * Defines application settings that vary by the domain of the current context.
4793
+ *
4794
+ * @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
4795
+ * domain should be represented with a single rule.
4780
4796
  */
4781
4797
  declare type DomainSettings = {
4798
+ /**
4799
+ * {@inheritDoc DomainSettingsRule}
4800
+ */
4782
4801
  rules: DomainSettingsRule[];
4783
4802
  };
4784
4803
 
4785
4804
  /**
4786
4805
  * @interface
4806
+ *
4807
+ * Defines domain-conditional settings for an OpenFin application.
4787
4808
  */
4788
4809
  declare type DomainSettingsRule = {
4810
+ /**
4811
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4812
+ * the domain(s) for which the rule applies.
4813
+ */
4789
4814
  match: string[];
4815
+ /**
4816
+ * Settings applied when a webcontents has been navigated to a matched domain.
4817
+ */
4790
4818
  options: {
4819
+ /**
4820
+ * {@inheritDoc FileDownloadSettings}
4821
+ *
4822
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
4823
+ */
4791
4824
  downloadSettings?: FileDownloadSettings;
4825
+ /**
4826
+ * {@inheritDoc ApiInjection}
4827
+ */
4792
4828
  api?: ApiInjection;
4793
4829
  };
4794
4830
  };
@@ -4827,9 +4863,20 @@ declare type DownloadPreloadOption = {
4827
4863
 
4828
4864
  /**
4829
4865
  * @interface
4866
+ *
4867
+ * A rule governing domain-conditional download behavior.
4830
4868
  */
4831
4869
  declare type DownloadRule = {
4870
+ /**
4871
+ * {@inheritDoc FileDownloadBehaviorNames}
4872
+ */
4832
4873
  behavior: FileDownloadBehaviorNames;
4874
+ /**
4875
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4876
+ * the domain(s) for which the rule applies.
4877
+ *
4878
+ * @remarks The match is evaluated against the URL of the *download*.
4879
+ */
4833
4880
  match: string[];
4834
4881
  };
4835
4882
 
@@ -5529,6 +5576,9 @@ declare type FetchManifestPayload = {
5529
5576
  manifestUrl: string;
5530
5577
  };
5531
5578
 
5579
+ /**
5580
+ * Whether file downloads raise a user prompt.
5581
+ */
5532
5582
  declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5533
5583
 
5534
5584
  /**
@@ -5611,9 +5661,14 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5611
5661
  };
5612
5662
 
5613
5663
  /**
5614
- * @interface
5664
+ * Domain-conditional rules for file downloads.
5665
+ *
5666
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5615
5667
  */
5616
5668
  declare type FileDownloadSettings = {
5669
+ /**
5670
+ * {@inheritDoc DownloadRule}
5671
+ */
5617
5672
  rules: DownloadRule[];
5618
5673
  };
5619
5674
 
@@ -6678,9 +6733,10 @@ declare type InitPlatformOptions = {
6678
6733
  };
6679
6734
 
6680
6735
  /**
6681
- * * 'none': The `fin` API will be not available from within this context.
6682
- * * 'global': The entire `fin` API will be available from within this context.
6683
- * @defaultValue 'global'
6736
+ * Injection setting for the `fin` API.
6737
+ *
6738
+ * * 'none': The `fin` API will be not available.
6739
+ * * 'global': The entire `fin` API will be available.
6684
6740
  */
6685
6741
  declare type InjectionType = 'none' | 'global';
6686
6742
 
@@ -9383,7 +9439,7 @@ declare type MutableViewOptions = {
9383
9439
  /**
9384
9440
  * Restrict navigation to URLs that match an allowed pattern.
9385
9441
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
9386
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
9442
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
9387
9443
  */
9388
9444
  contentNavigation: ContentNavigation;
9389
9445
  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[];
@@ -3612,13 +3625,13 @@ declare type ConstWindowOptions = {
3612
3625
  /**
3613
3626
  * Restrict navigation to URLs that match an allowed pattern.
3614
3627
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
3615
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3628
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3616
3629
  */
3617
3630
  contentNavigation: ContentNavigation;
3618
3631
  /**
3619
3632
  * Restrict redirects to URLs that match an allowed pattern.
3620
3633
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
3621
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3634
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3622
3635
  */
3623
3636
  contentRedirect: Partial<ContentRedirect>;
3624
3637
  /**
@@ -4163,7 +4176,7 @@ declare interface ContentItem extends EventEmitter_2 {
4163
4176
  /**
4164
4177
  * Restrict navigation to URLs that match an allowed pattern.
4165
4178
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4166
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4179
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4167
4180
  *
4168
4181
  * @interface
4169
4182
  */
@@ -4172,7 +4185,7 @@ declare type ContentNavigation = NavigationRules;
4172
4185
  /**
4173
4186
  * Restrict redirects to URLs that match an allowed pattern.
4174
4187
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4175
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4188
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4176
4189
  *
4177
4190
  * @interface
4178
4191
  */
@@ -4776,19 +4789,42 @@ declare type DisplayMetadata_3 = {
4776
4789
 
4777
4790
  /**
4778
4791
  * @interface
4779
- * 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.
4792
+ * Defines application settings that vary by the domain of the current context.
4793
+ *
4794
+ * @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
4795
+ * domain should be represented with a single rule.
4780
4796
  */
4781
4797
  declare type DomainSettings = {
4798
+ /**
4799
+ * {@inheritDoc DomainSettingsRule}
4800
+ */
4782
4801
  rules: DomainSettingsRule[];
4783
4802
  };
4784
4803
 
4785
4804
  /**
4786
4805
  * @interface
4806
+ *
4807
+ * Defines domain-conditional settings for an OpenFin application.
4787
4808
  */
4788
4809
  declare type DomainSettingsRule = {
4810
+ /**
4811
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4812
+ * the domain(s) for which the rule applies.
4813
+ */
4789
4814
  match: string[];
4815
+ /**
4816
+ * Settings applied when a webcontents has been navigated to a matched domain.
4817
+ */
4790
4818
  options: {
4819
+ /**
4820
+ * {@inheritDoc FileDownloadSettings}
4821
+ *
4822
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
4823
+ */
4791
4824
  downloadSettings?: FileDownloadSettings;
4825
+ /**
4826
+ * {@inheritDoc ApiInjection}
4827
+ */
4792
4828
  api?: ApiInjection;
4793
4829
  };
4794
4830
  };
@@ -4827,9 +4863,20 @@ declare type DownloadPreloadOption = {
4827
4863
 
4828
4864
  /**
4829
4865
  * @interface
4866
+ *
4867
+ * A rule governing domain-conditional download behavior.
4830
4868
  */
4831
4869
  declare type DownloadRule = {
4870
+ /**
4871
+ * {@inheritDoc FileDownloadBehaviorNames}
4872
+ */
4832
4873
  behavior: FileDownloadBehaviorNames;
4874
+ /**
4875
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4876
+ * the domain(s) for which the rule applies.
4877
+ *
4878
+ * @remarks The match is evaluated against the URL of the *download*.
4879
+ */
4833
4880
  match: string[];
4834
4881
  };
4835
4882
 
@@ -5529,6 +5576,9 @@ declare type FetchManifestPayload = {
5529
5576
  manifestUrl: string;
5530
5577
  };
5531
5578
 
5579
+ /**
5580
+ * Whether file downloads raise a user prompt.
5581
+ */
5532
5582
  declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5533
5583
 
5534
5584
  /**
@@ -5611,9 +5661,14 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5611
5661
  };
5612
5662
 
5613
5663
  /**
5614
- * @interface
5664
+ * Domain-conditional rules for file downloads.
5665
+ *
5666
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5615
5667
  */
5616
5668
  declare type FileDownloadSettings = {
5669
+ /**
5670
+ * {@inheritDoc DownloadRule}
5671
+ */
5617
5672
  rules: DownloadRule[];
5618
5673
  };
5619
5674
 
@@ -6678,9 +6733,10 @@ declare type InitPlatformOptions = {
6678
6733
  };
6679
6734
 
6680
6735
  /**
6681
- * * 'none': The `fin` API will be not available from within this context.
6682
- * * 'global': The entire `fin` API will be available from within this context.
6683
- * @defaultValue 'global'
6736
+ * Injection setting for the `fin` API.
6737
+ *
6738
+ * * 'none': The `fin` API will be not available.
6739
+ * * 'global': The entire `fin` API will be available.
6684
6740
  */
6685
6741
  declare type InjectionType = 'none' | 'global';
6686
6742
 
@@ -9383,7 +9439,7 @@ declare type MutableViewOptions = {
9383
9439
  /**
9384
9440
  * Restrict navigation to URLs that match an allowed pattern.
9385
9441
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
9386
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
9442
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
9387
9443
  */
9388
9444
  contentNavigation: ContentNavigation;
9389
9445
  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[];
@@ -3655,13 +3668,13 @@ declare type ConstWindowOptions = {
3655
3668
  /**
3656
3669
  * Restrict navigation to URLs that match an allowed pattern.
3657
3670
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
3658
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3671
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3659
3672
  */
3660
3673
  contentNavigation: ContentNavigation;
3661
3674
  /**
3662
3675
  * Restrict redirects to URLs that match an allowed pattern.
3663
3676
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
3664
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3677
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3665
3678
  */
3666
3679
  contentRedirect: Partial<ContentRedirect>;
3667
3680
  /**
@@ -4206,7 +4219,7 @@ declare interface ContentItem extends EventEmitter_2 {
4206
4219
  /**
4207
4220
  * Restrict navigation to URLs that match an allowed pattern.
4208
4221
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4209
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4222
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4210
4223
  *
4211
4224
  * @interface
4212
4225
  */
@@ -4215,7 +4228,7 @@ declare type ContentNavigation = NavigationRules;
4215
4228
  /**
4216
4229
  * Restrict redirects to URLs that match an allowed pattern.
4217
4230
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4218
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4231
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4219
4232
  *
4220
4233
  * @interface
4221
4234
  */
@@ -4819,19 +4832,42 @@ declare type DisplayMetadata_3 = {
4819
4832
 
4820
4833
  /**
4821
4834
  * @interface
4822
- * 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.
4835
+ * Defines application settings that vary by the domain of the current context.
4836
+ *
4837
+ * @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
4838
+ * domain should be represented with a single rule.
4823
4839
  */
4824
4840
  declare type DomainSettings = {
4841
+ /**
4842
+ * {@inheritDoc DomainSettingsRule}
4843
+ */
4825
4844
  rules: DomainSettingsRule[];
4826
4845
  };
4827
4846
 
4828
4847
  /**
4829
4848
  * @interface
4849
+ *
4850
+ * Defines domain-conditional settings for an OpenFin application.
4830
4851
  */
4831
4852
  declare type DomainSettingsRule = {
4853
+ /**
4854
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4855
+ * the domain(s) for which the rule applies.
4856
+ */
4832
4857
  match: string[];
4858
+ /**
4859
+ * Settings applied when a webcontents has been navigated to a matched domain.
4860
+ */
4833
4861
  options: {
4862
+ /**
4863
+ * {@inheritDoc FileDownloadSettings}
4864
+ *
4865
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
4866
+ */
4834
4867
  downloadSettings?: FileDownloadSettings;
4868
+ /**
4869
+ * {@inheritDoc ApiInjection}
4870
+ */
4835
4871
  api?: ApiInjection;
4836
4872
  };
4837
4873
  };
@@ -4870,9 +4906,20 @@ declare type DownloadPreloadOption = {
4870
4906
 
4871
4907
  /**
4872
4908
  * @interface
4909
+ *
4910
+ * A rule governing domain-conditional download behavior.
4873
4911
  */
4874
4912
  declare type DownloadRule = {
4913
+ /**
4914
+ * {@inheritDoc FileDownloadBehaviorNames}
4915
+ */
4875
4916
  behavior: FileDownloadBehaviorNames;
4917
+ /**
4918
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4919
+ * the domain(s) for which the rule applies.
4920
+ *
4921
+ * @remarks The match is evaluated against the URL of the *download*.
4922
+ */
4876
4923
  match: string[];
4877
4924
  };
4878
4925
 
@@ -5598,6 +5645,9 @@ declare type FetchManifestPayload = {
5598
5645
  manifestUrl: string;
5599
5646
  };
5600
5647
 
5648
+ /**
5649
+ * Whether file downloads raise a user prompt.
5650
+ */
5601
5651
  declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5602
5652
 
5603
5653
  /**
@@ -5680,9 +5730,14 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5680
5730
  };
5681
5731
 
5682
5732
  /**
5683
- * @interface
5733
+ * Domain-conditional rules for file downloads.
5734
+ *
5735
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5684
5736
  */
5685
5737
  declare type FileDownloadSettings = {
5738
+ /**
5739
+ * {@inheritDoc DownloadRule}
5740
+ */
5686
5741
  rules: DownloadRule[];
5687
5742
  };
5688
5743
 
@@ -6778,9 +6833,10 @@ declare type InitPlatformOptions = {
6778
6833
  };
6779
6834
 
6780
6835
  /**
6781
- * * 'none': The `fin` API will be not available from within this context.
6782
- * * 'global': The entire `fin` API will be available from within this context.
6783
- * @defaultValue 'global'
6836
+ * Injection setting for the `fin` API.
6837
+ *
6838
+ * * 'none': The `fin` API will be not available.
6839
+ * * 'global': The entire `fin` API will be available.
6784
6840
  */
6785
6841
  declare type InjectionType = 'none' | 'global';
6786
6842
 
@@ -9682,7 +9738,7 @@ declare type MutableViewOptions = {
9682
9738
  /**
9683
9739
  * Restrict navigation to URLs that match an allowed pattern.
9684
9740
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
9685
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
9741
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
9686
9742
  */
9687
9743
  contentNavigation: ContentNavigation;
9688
9744
  contentRedirect: ContentRedirect;
@@ -37,7 +37,7 @@ function getDefaultExportFromCjs (x) {
37
37
 
38
38
  var main$1 = {};
39
39
 
40
- var fin = {};
40
+ var fin$1 = {};
41
41
 
42
42
  var system$1 = {};
43
43
 
@@ -12042,6 +12042,9 @@ class PlatformModule extends base_1$4.Base {
12042
12042
  * @experimental
12043
12043
  */
12044
12044
  async init(options) {
12045
+ if (!fin.__internal_.isPlatform || fin.me.name !== fin.me.uuid) {
12046
+ throw new Error('fin.Platform.init should only be called from a custom platform provider running in the main window of the application.');
12047
+ }
12045
12048
  return this.wire.environment.initPlatform(this.fin, options);
12046
12049
  }
12047
12050
  /**
@@ -15316,8 +15319,8 @@ Factory.SnapshotSourceModule = SnapshotSourceModule;
15316
15319
  __exportStar(Instance, exports);
15317
15320
  } (snapshotSource));
15318
15321
 
15319
- Object.defineProperty(fin, "__esModule", { value: true });
15320
- fin.Fin = void 0;
15322
+ Object.defineProperty(fin$1, "__esModule", { value: true });
15323
+ fin$1.Fin = void 0;
15321
15324
  const events_1$3 = require$$0;
15322
15325
  // Import from the file rather than the directory in case someone consuming types is using module resolution other than "node"
15323
15326
  const index_1 = system$1;
@@ -15363,7 +15366,7 @@ class Fin extends events_1$3.EventEmitter {
15363
15366
  });
15364
15367
  }
15365
15368
  }
15366
- fin.Fin = Fin;
15369
+ fin$1.Fin = Fin;
15367
15370
 
15368
15371
  var wire = {};
15369
15372
 
@@ -16716,7 +16719,7 @@ function requireMain () {
16716
16719
  (function (exports) {
16717
16720
  Object.defineProperty(exports, "__esModule", { value: true });
16718
16721
  exports.ChannelProvider = exports.ChannelClient = exports.Frame = exports.View = exports.System = exports.Window = exports.Application = exports.Fin = exports.launch = exports.connect = void 0;
16719
- const fin_1 = fin;
16722
+ const fin_1 = fin$1;
16720
16723
  Object.defineProperty(exports, "Fin", { enumerable: true, get: function () { return fin_1.Fin; } });
16721
16724
  const index_1 = requireApplication();
16722
16725
  Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return index_1.Application; } });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/node-adapter",
3
- "version": "36.79.4",
3
+ "version": "36.79.9",
4
4
  "description": "See README.md",
5
5
  "main": "out/node-adapter.js",
6
6
  "types": "out/node-adapter.d.ts",