@openfin/remote-adapter 36.79.19 → 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
  */
@@ -966,7 +959,7 @@ declare type ApplicationIdentity_2 = {
966
959
  * @interface
967
960
  */
968
961
  declare type ApplicationInfo = {
969
- initialOptions: ApplicationCreationOptions;
962
+ initialOptions: ApplicationCreationOptions | PlatformOptions;
970
963
  launchMode: string;
971
964
  manifest: Manifest & {
972
965
  [key: string]: any;
@@ -3546,7 +3539,7 @@ declare type ConstViewOptions = {
3546
3539
  /**
3547
3540
  * Configurations for API injection.
3548
3541
  */
3549
- api: Api;
3542
+ api: ApiSettings;
3550
3543
  /**
3551
3544
  * The name of the view.
3552
3545
  */
@@ -3863,6 +3856,10 @@ declare type ConstWindowOptions = {
3863
3856
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3864
3857
  */
3865
3858
  viewVisibility?: ViewVisibilityOptions;
3859
+ /**
3860
+ * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
3861
+ */
3862
+ inheritance?: Partial<InheritableOptions>;
3866
3863
  };
3867
3864
 
3868
3865
  declare interface Container extends EventEmitter_2 {
@@ -3962,7 +3959,12 @@ declare interface Container extends EventEmitter_2 {
3962
3959
  close(): boolean;
3963
3960
  }
3964
3961
 
3965
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3962
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3963
+
3964
+ /**
3965
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3966
+ */
3967
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3966
3968
 
3967
3969
  /**
3968
3970
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3986,7 +3988,7 @@ declare type ContentCreationOptions = {
3986
3988
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3987
3989
  * the specified `behavior` key.
3988
3990
  */
3989
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3991
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3990
3992
  behavior: Behavior;
3991
3993
  }>;
3992
3994
 
@@ -4871,6 +4873,25 @@ declare type DisplayMetadata_3 = {
4871
4873
  readonly glyph?: string;
4872
4874
  };
4873
4875
 
4876
+ /**
4877
+ * @interface
4878
+ *
4879
+ * Rules for domain-conditional `fin` API injection.
4880
+ *
4881
+ * @remarks Subset of {@link DomainSettings}.
4882
+ */
4883
+ declare type DomainApiSettings = {
4884
+ /**
4885
+ * Injection setting for the `fin` API for contexts on a matched domain.
4886
+ *
4887
+ * * 'none': The `fin` API will be not available.
4888
+ * * 'global': The entire `fin` API will be available.
4889
+ *
4890
+ * @defaultValue 'global'
4891
+ */
4892
+ fin: InjectionType;
4893
+ };
4894
+
4874
4895
  /**
4875
4896
  * @interface
4876
4897
  * Defines application settings that vary by the domain of the current context.
@@ -4909,7 +4930,7 @@ declare type DomainSettingsRule = {
4909
4930
  /**
4910
4931
  * {@inheritDoc ApiInjection}
4911
4932
  */
4912
- api?: ApiInjection;
4933
+ api?: DomainApiSettings;
4913
4934
  };
4914
4935
  };
4915
4936
 
@@ -4948,18 +4969,19 @@ declare type DownloadPreloadOption = {
4948
4969
  /**
4949
4970
  * @interface
4950
4971
  *
4951
- * A rule governing domain-conditional download behavior.
4972
+ * A rule that governs download behavior, discriminated by the URL of the download.
4952
4973
  */
4953
4974
  declare type DownloadRule = {
4954
4975
  /**
4955
- * {@inheritDoc FileDownloadBehaviorNames}
4976
+ * {@inheritDoc FileDownloadBehavior}
4956
4977
  */
4957
- behavior: FileDownloadBehaviorNames;
4978
+ behavior: FileDownloadBehavior;
4958
4979
  /**
4959
4980
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4960
- * the domain(s) for which the rule applies.
4981
+ * URL(s) of the resource(s) being downloaded.
4961
4982
  *
4962
- * @remarks The match is evaluated against the URL of the *download*.
4983
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4984
+ * of the page in which a file download link is embedded.
4963
4985
  */
4964
4986
  match: string[];
4965
4987
  };
@@ -5665,7 +5687,12 @@ declare type FetchManifestPayload = {
5665
5687
  /**
5666
5688
  * Whether file downloads raise a user prompt.
5667
5689
  */
5668
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5690
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5691
+
5692
+ /**
5693
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5694
+ */
5695
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5669
5696
 
5670
5697
  /**
5671
5698
  * Generated when a file download has completed.
@@ -5915,6 +5942,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5915
5942
  * Returns a frame info object representing the window that the referenced iframe is
5916
5943
  * currently embedded in.
5917
5944
  *
5945
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5946
+ *
5918
5947
  * @example
5919
5948
  * ```js
5920
5949
  * async function getParentWindow() {
@@ -6760,6 +6789,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6760
6789
  metadata?: MetadataType;
6761
6790
  };
6762
6791
 
6792
+ declare type InheritableOptions = {
6793
+ customContext: boolean;
6794
+ customData: boolean;
6795
+ icon: boolean;
6796
+ preloadScripts: boolean;
6797
+ };
6798
+
6763
6799
  /**
6764
6800
  * Initialize a remote connection as a "host" application.
6765
6801
  * @param {InitOptions} options init options
@@ -8382,6 +8418,7 @@ declare type LaunchExternalProcessRule = {
8382
8418
  */
8383
8419
  declare type LaunchIntoPlatformPayload = {
8384
8420
  manifest: any;
8421
+ manifestUrl?: string;
8385
8422
  };
8386
8423
 
8387
8424
  /**
@@ -9559,7 +9596,7 @@ declare type MutableViewOptions = {
9559
9596
  /**
9560
9597
  * Configurations for API injection.
9561
9598
  */
9562
- api: Api;
9599
+ api: ApiSettings;
9563
9600
  /**
9564
9601
  * Restrict navigation to URLs that match an allowed pattern.
9565
9602
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10012,6 +10049,7 @@ declare namespace OpenFin {
10012
10049
  WindowState,
10013
10050
  AutoplayPolicyOptions,
10014
10051
  ConstWindowOptions,
10052
+ InheritableOptions,
10015
10053
  MutableWindowOptions,
10016
10054
  WorkspacePlatformOptions,
10017
10055
  WebRequestHeader,
@@ -10020,6 +10058,7 @@ declare namespace OpenFin {
10020
10058
  ResizeRegion,
10021
10059
  Accelerator,
10022
10060
  Api,
10061
+ ApiSettings,
10023
10062
  InjectionType,
10024
10063
  NavigationRules,
10025
10064
  ContentNavigation,
@@ -10171,7 +10210,9 @@ declare namespace OpenFin {
10171
10210
  DefaultDomainSettingsRule,
10172
10211
  DomainSettings,
10173
10212
  ApiInjection,
10213
+ DomainApiSettings,
10174
10214
  DomainSettingsRule,
10215
+ FileDownloadBehavior,
10175
10216
  FileDownloadBehaviorNames,
10176
10217
  FileDownloadSettings,
10177
10218
  DownloadRule,
@@ -10179,6 +10220,7 @@ declare namespace OpenFin {
10179
10220
  Intent_2 as Intent,
10180
10221
  IntentMetadata_3 as IntentMetadata,
10181
10222
  IntentHandler_2 as IntentHandler,
10223
+ ContentCreationBehavior,
10182
10224
  ContentCreationBehaviorNames,
10183
10225
  MatchPattern,
10184
10226
  BaseContentCreationRule,
@@ -11247,6 +11289,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11247
11289
  * The provider url.
11248
11290
  */
11249
11291
  providerUrl?: string;
11292
+ /**
11293
+ * @defaultValue true
11294
+ *
11295
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11296
+ *
11297
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11298
+ */
11299
+ allowLaunchIntoPlatform?: boolean;
11250
11300
  };
11251
11301
 
11252
11302
  /**
@@ -12006,7 +12056,7 @@ declare type PreloadScriptInfoRunning = {
12006
12056
  * @interface
12007
12057
  */
12008
12058
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
12009
- type: 'preload-script-state-changed';
12059
+ type: 'preload-scripts-state-changed';
12010
12060
  };
12011
12061
 
12012
12062
  /**
@@ -12023,7 +12073,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12023
12073
  * @interface
12024
12074
  */
12025
12075
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
12026
- type: 'preload-script-state-changing';
12076
+ type: 'preload-scripts-state-changing';
12027
12077
  };
12028
12078
 
12029
12079
  declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
@@ -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
  */
@@ -966,7 +959,7 @@ declare type ApplicationIdentity_2 = {
966
959
  * @interface
967
960
  */
968
961
  declare type ApplicationInfo = {
969
- initialOptions: ApplicationCreationOptions;
962
+ initialOptions: ApplicationCreationOptions | PlatformOptions;
970
963
  launchMode: string;
971
964
  manifest: Manifest & {
972
965
  [key: string]: any;
@@ -3546,7 +3539,7 @@ declare type ConstViewOptions = {
3546
3539
  /**
3547
3540
  * Configurations for API injection.
3548
3541
  */
3549
- api: Api;
3542
+ api: ApiSettings;
3550
3543
  /**
3551
3544
  * The name of the view.
3552
3545
  */
@@ -3863,6 +3856,10 @@ declare type ConstWindowOptions = {
3863
3856
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3864
3857
  */
3865
3858
  viewVisibility?: ViewVisibilityOptions;
3859
+ /**
3860
+ * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
3861
+ */
3862
+ inheritance?: Partial<InheritableOptions>;
3866
3863
  };
3867
3864
 
3868
3865
  declare interface Container extends EventEmitter_2 {
@@ -3962,7 +3959,12 @@ declare interface Container extends EventEmitter_2 {
3962
3959
  close(): boolean;
3963
3960
  }
3964
3961
 
3965
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3962
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3963
+
3964
+ /**
3965
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3966
+ */
3967
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3966
3968
 
3967
3969
  /**
3968
3970
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3986,7 +3988,7 @@ declare type ContentCreationOptions = {
3986
3988
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3987
3989
  * the specified `behavior` key.
3988
3990
  */
3989
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3991
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3990
3992
  behavior: Behavior;
3991
3993
  }>;
3992
3994
 
@@ -4871,6 +4873,25 @@ declare type DisplayMetadata_3 = {
4871
4873
  readonly glyph?: string;
4872
4874
  };
4873
4875
 
4876
+ /**
4877
+ * @interface
4878
+ *
4879
+ * Rules for domain-conditional `fin` API injection.
4880
+ *
4881
+ * @remarks Subset of {@link DomainSettings}.
4882
+ */
4883
+ declare type DomainApiSettings = {
4884
+ /**
4885
+ * Injection setting for the `fin` API for contexts on a matched domain.
4886
+ *
4887
+ * * 'none': The `fin` API will be not available.
4888
+ * * 'global': The entire `fin` API will be available.
4889
+ *
4890
+ * @defaultValue 'global'
4891
+ */
4892
+ fin: InjectionType;
4893
+ };
4894
+
4874
4895
  /**
4875
4896
  * @interface
4876
4897
  * Defines application settings that vary by the domain of the current context.
@@ -4909,7 +4930,7 @@ declare type DomainSettingsRule = {
4909
4930
  /**
4910
4931
  * {@inheritDoc ApiInjection}
4911
4932
  */
4912
- api?: ApiInjection;
4933
+ api?: DomainApiSettings;
4913
4934
  };
4914
4935
  };
4915
4936
 
@@ -4948,18 +4969,19 @@ declare type DownloadPreloadOption = {
4948
4969
  /**
4949
4970
  * @interface
4950
4971
  *
4951
- * A rule governing domain-conditional download behavior.
4972
+ * A rule that governs download behavior, discriminated by the URL of the download.
4952
4973
  */
4953
4974
  declare type DownloadRule = {
4954
4975
  /**
4955
- * {@inheritDoc FileDownloadBehaviorNames}
4976
+ * {@inheritDoc FileDownloadBehavior}
4956
4977
  */
4957
- behavior: FileDownloadBehaviorNames;
4978
+ behavior: FileDownloadBehavior;
4958
4979
  /**
4959
4980
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4960
- * the domain(s) for which the rule applies.
4981
+ * URL(s) of the resource(s) being downloaded.
4961
4982
  *
4962
- * @remarks The match is evaluated against the URL of the *download*.
4983
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4984
+ * of the page in which a file download link is embedded.
4963
4985
  */
4964
4986
  match: string[];
4965
4987
  };
@@ -5665,7 +5687,12 @@ declare type FetchManifestPayload = {
5665
5687
  /**
5666
5688
  * Whether file downloads raise a user prompt.
5667
5689
  */
5668
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5690
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5691
+
5692
+ /**
5693
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5694
+ */
5695
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5669
5696
 
5670
5697
  /**
5671
5698
  * Generated when a file download has completed.
@@ -5915,6 +5942,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5915
5942
  * Returns a frame info object representing the window that the referenced iframe is
5916
5943
  * currently embedded in.
5917
5944
  *
5945
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5946
+ *
5918
5947
  * @example
5919
5948
  * ```js
5920
5949
  * async function getParentWindow() {
@@ -6760,6 +6789,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6760
6789
  metadata?: MetadataType;
6761
6790
  };
6762
6791
 
6792
+ declare type InheritableOptions = {
6793
+ customContext: boolean;
6794
+ customData: boolean;
6795
+ icon: boolean;
6796
+ preloadScripts: boolean;
6797
+ };
6798
+
6763
6799
  /**
6764
6800
  * Initialize a remote connection as a "host" application.
6765
6801
  * @param {InitOptions} options init options
@@ -8382,6 +8418,7 @@ declare type LaunchExternalProcessRule = {
8382
8418
  */
8383
8419
  declare type LaunchIntoPlatformPayload = {
8384
8420
  manifest: any;
8421
+ manifestUrl?: string;
8385
8422
  };
8386
8423
 
8387
8424
  /**
@@ -9559,7 +9596,7 @@ declare type MutableViewOptions = {
9559
9596
  /**
9560
9597
  * Configurations for API injection.
9561
9598
  */
9562
- api: Api;
9599
+ api: ApiSettings;
9563
9600
  /**
9564
9601
  * Restrict navigation to URLs that match an allowed pattern.
9565
9602
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10012,6 +10049,7 @@ declare namespace OpenFin {
10012
10049
  WindowState,
10013
10050
  AutoplayPolicyOptions,
10014
10051
  ConstWindowOptions,
10052
+ InheritableOptions,
10015
10053
  MutableWindowOptions,
10016
10054
  WorkspacePlatformOptions,
10017
10055
  WebRequestHeader,
@@ -10020,6 +10058,7 @@ declare namespace OpenFin {
10020
10058
  ResizeRegion,
10021
10059
  Accelerator,
10022
10060
  Api,
10061
+ ApiSettings,
10023
10062
  InjectionType,
10024
10063
  NavigationRules,
10025
10064
  ContentNavigation,
@@ -10171,7 +10210,9 @@ declare namespace OpenFin {
10171
10210
  DefaultDomainSettingsRule,
10172
10211
  DomainSettings,
10173
10212
  ApiInjection,
10213
+ DomainApiSettings,
10174
10214
  DomainSettingsRule,
10215
+ FileDownloadBehavior,
10175
10216
  FileDownloadBehaviorNames,
10176
10217
  FileDownloadSettings,
10177
10218
  DownloadRule,
@@ -10179,6 +10220,7 @@ declare namespace OpenFin {
10179
10220
  Intent_2 as Intent,
10180
10221
  IntentMetadata_3 as IntentMetadata,
10181
10222
  IntentHandler_2 as IntentHandler,
10223
+ ContentCreationBehavior,
10182
10224
  ContentCreationBehaviorNames,
10183
10225
  MatchPattern,
10184
10226
  BaseContentCreationRule,
@@ -11247,6 +11289,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11247
11289
  * The provider url.
11248
11290
  */
11249
11291
  providerUrl?: string;
11292
+ /**
11293
+ * @defaultValue true
11294
+ *
11295
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11296
+ *
11297
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11298
+ */
11299
+ allowLaunchIntoPlatform?: boolean;
11250
11300
  };
11251
11301
 
11252
11302
  /**
@@ -12006,7 +12056,7 @@ declare type PreloadScriptInfoRunning = {
12006
12056
  * @interface
12007
12057
  */
12008
12058
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
12009
- type: 'preload-script-state-changed';
12059
+ type: 'preload-scripts-state-changed';
12010
12060
  };
12011
12061
 
12012
12062
  /**
@@ -12023,7 +12073,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12023
12073
  * @interface
12024
12074
  */
12025
12075
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
12026
- type: 'preload-script-state-changing';
12076
+ type: 'preload-scripts-state-changing';
12027
12077
  };
12028
12078
 
12029
12079
  declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
@@ -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
  */
@@ -966,7 +959,7 @@ declare type ApplicationIdentity_2 = {
966
959
  * @interface
967
960
  */
968
961
  declare type ApplicationInfo = {
969
- initialOptions: ApplicationCreationOptions;
962
+ initialOptions: ApplicationCreationOptions | PlatformOptions;
970
963
  launchMode: string;
971
964
  manifest: Manifest & {
972
965
  [key: string]: any;
@@ -3546,7 +3539,7 @@ declare type ConstViewOptions = {
3546
3539
  /**
3547
3540
  * Configurations for API injection.
3548
3541
  */
3549
- api: Api;
3542
+ api: ApiSettings;
3550
3543
  /**
3551
3544
  * The name of the view.
3552
3545
  */
@@ -3863,6 +3856,10 @@ declare type ConstWindowOptions = {
3863
3856
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3864
3857
  */
3865
3858
  viewVisibility?: ViewVisibilityOptions;
3859
+ /**
3860
+ * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
3861
+ */
3862
+ inheritance?: Partial<InheritableOptions>;
3866
3863
  };
3867
3864
 
3868
3865
  declare interface Container extends EventEmitter_2 {
@@ -3962,7 +3959,12 @@ declare interface Container extends EventEmitter_2 {
3962
3959
  close(): boolean;
3963
3960
  }
3964
3961
 
3965
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3962
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3963
+
3964
+ /**
3965
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3966
+ */
3967
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3966
3968
 
3967
3969
  /**
3968
3970
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3986,7 +3988,7 @@ declare type ContentCreationOptions = {
3986
3988
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3987
3989
  * the specified `behavior` key.
3988
3990
  */
3989
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3991
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3990
3992
  behavior: Behavior;
3991
3993
  }>;
3992
3994
 
@@ -4871,6 +4873,25 @@ declare type DisplayMetadata_3 = {
4871
4873
  readonly glyph?: string;
4872
4874
  };
4873
4875
 
4876
+ /**
4877
+ * @interface
4878
+ *
4879
+ * Rules for domain-conditional `fin` API injection.
4880
+ *
4881
+ * @remarks Subset of {@link DomainSettings}.
4882
+ */
4883
+ declare type DomainApiSettings = {
4884
+ /**
4885
+ * Injection setting for the `fin` API for contexts on a matched domain.
4886
+ *
4887
+ * * 'none': The `fin` API will be not available.
4888
+ * * 'global': The entire `fin` API will be available.
4889
+ *
4890
+ * @defaultValue 'global'
4891
+ */
4892
+ fin: InjectionType;
4893
+ };
4894
+
4874
4895
  /**
4875
4896
  * @interface
4876
4897
  * Defines application settings that vary by the domain of the current context.
@@ -4909,7 +4930,7 @@ declare type DomainSettingsRule = {
4909
4930
  /**
4910
4931
  * {@inheritDoc ApiInjection}
4911
4932
  */
4912
- api?: ApiInjection;
4933
+ api?: DomainApiSettings;
4913
4934
  };
4914
4935
  };
4915
4936
 
@@ -4948,18 +4969,19 @@ declare type DownloadPreloadOption = {
4948
4969
  /**
4949
4970
  * @interface
4950
4971
  *
4951
- * A rule governing domain-conditional download behavior.
4972
+ * A rule that governs download behavior, discriminated by the URL of the download.
4952
4973
  */
4953
4974
  declare type DownloadRule = {
4954
4975
  /**
4955
- * {@inheritDoc FileDownloadBehaviorNames}
4976
+ * {@inheritDoc FileDownloadBehavior}
4956
4977
  */
4957
- behavior: FileDownloadBehaviorNames;
4978
+ behavior: FileDownloadBehavior;
4958
4979
  /**
4959
4980
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4960
- * the domain(s) for which the rule applies.
4981
+ * URL(s) of the resource(s) being downloaded.
4961
4982
  *
4962
- * @remarks The match is evaluated against the URL of the *download*.
4983
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4984
+ * of the page in which a file download link is embedded.
4963
4985
  */
4964
4986
  match: string[];
4965
4987
  };
@@ -5665,7 +5687,12 @@ declare type FetchManifestPayload = {
5665
5687
  /**
5666
5688
  * Whether file downloads raise a user prompt.
5667
5689
  */
5668
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5690
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5691
+
5692
+ /**
5693
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5694
+ */
5695
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5669
5696
 
5670
5697
  /**
5671
5698
  * Generated when a file download has completed.
@@ -5915,6 +5942,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5915
5942
  * Returns a frame info object representing the window that the referenced iframe is
5916
5943
  * currently embedded in.
5917
5944
  *
5945
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5946
+ *
5918
5947
  * @example
5919
5948
  * ```js
5920
5949
  * async function getParentWindow() {
@@ -6760,6 +6789,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6760
6789
  metadata?: MetadataType;
6761
6790
  };
6762
6791
 
6792
+ declare type InheritableOptions = {
6793
+ customContext: boolean;
6794
+ customData: boolean;
6795
+ icon: boolean;
6796
+ preloadScripts: boolean;
6797
+ };
6798
+
6763
6799
  /**
6764
6800
  * Initialize a remote connection as a "host" application.
6765
6801
  * @param {InitOptions} options init options
@@ -8382,6 +8418,7 @@ declare type LaunchExternalProcessRule = {
8382
8418
  */
8383
8419
  declare type LaunchIntoPlatformPayload = {
8384
8420
  manifest: any;
8421
+ manifestUrl?: string;
8385
8422
  };
8386
8423
 
8387
8424
  /**
@@ -9559,7 +9596,7 @@ declare type MutableViewOptions = {
9559
9596
  /**
9560
9597
  * Configurations for API injection.
9561
9598
  */
9562
- api: Api;
9599
+ api: ApiSettings;
9563
9600
  /**
9564
9601
  * Restrict navigation to URLs that match an allowed pattern.
9565
9602
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10012,6 +10049,7 @@ declare namespace OpenFin {
10012
10049
  WindowState,
10013
10050
  AutoplayPolicyOptions,
10014
10051
  ConstWindowOptions,
10052
+ InheritableOptions,
10015
10053
  MutableWindowOptions,
10016
10054
  WorkspacePlatformOptions,
10017
10055
  WebRequestHeader,
@@ -10020,6 +10058,7 @@ declare namespace OpenFin {
10020
10058
  ResizeRegion,
10021
10059
  Accelerator,
10022
10060
  Api,
10061
+ ApiSettings,
10023
10062
  InjectionType,
10024
10063
  NavigationRules,
10025
10064
  ContentNavigation,
@@ -10171,7 +10210,9 @@ declare namespace OpenFin {
10171
10210
  DefaultDomainSettingsRule,
10172
10211
  DomainSettings,
10173
10212
  ApiInjection,
10213
+ DomainApiSettings,
10174
10214
  DomainSettingsRule,
10215
+ FileDownloadBehavior,
10175
10216
  FileDownloadBehaviorNames,
10176
10217
  FileDownloadSettings,
10177
10218
  DownloadRule,
@@ -10179,6 +10220,7 @@ declare namespace OpenFin {
10179
10220
  Intent_2 as Intent,
10180
10221
  IntentMetadata_3 as IntentMetadata,
10181
10222
  IntentHandler_2 as IntentHandler,
10223
+ ContentCreationBehavior,
10182
10224
  ContentCreationBehaviorNames,
10183
10225
  MatchPattern,
10184
10226
  BaseContentCreationRule,
@@ -11247,6 +11289,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11247
11289
  * The provider url.
11248
11290
  */
11249
11291
  providerUrl?: string;
11292
+ /**
11293
+ * @defaultValue true
11294
+ *
11295
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11296
+ *
11297
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11298
+ */
11299
+ allowLaunchIntoPlatform?: boolean;
11250
11300
  };
11251
11301
 
11252
11302
  /**
@@ -12006,7 +12056,7 @@ declare type PreloadScriptInfoRunning = {
12006
12056
  * @interface
12007
12057
  */
12008
12058
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
12009
- type: 'preload-script-state-changed';
12059
+ type: 'preload-scripts-state-changed';
12010
12060
  };
12011
12061
 
12012
12062
  /**
@@ -12023,7 +12073,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12023
12073
  * @interface
12024
12074
  */
12025
12075
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
12026
- type: 'preload-script-state-changing';
12076
+ type: 'preload-scripts-state-changing';
12027
12077
  };
12028
12078
 
12029
12079
  declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
@@ -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
  */
@@ -972,7 +965,7 @@ declare type ApplicationIdentity_2 = {
972
965
  * @interface
973
966
  */
974
967
  declare type ApplicationInfo = {
975
- initialOptions: ApplicationCreationOptions;
968
+ initialOptions: ApplicationCreationOptions | PlatformOptions;
976
969
  launchMode: string;
977
970
  manifest: Manifest & {
978
971
  [key: string]: any;
@@ -3601,7 +3594,7 @@ declare type ConstViewOptions = {
3601
3594
  /**
3602
3595
  * Configurations for API injection.
3603
3596
  */
3604
- api: Api;
3597
+ api: ApiSettings;
3605
3598
  /**
3606
3599
  * The name of the view.
3607
3600
  */
@@ -3918,6 +3911,10 @@ declare type ConstWindowOptions = {
3918
3911
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3919
3912
  */
3920
3913
  viewVisibility?: ViewVisibilityOptions;
3914
+ /**
3915
+ * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
3916
+ */
3917
+ inheritance?: Partial<InheritableOptions>;
3921
3918
  };
3922
3919
 
3923
3920
  declare interface Container extends EventEmitter_2 {
@@ -4017,7 +4014,12 @@ declare interface Container extends EventEmitter_2 {
4017
4014
  close(): boolean;
4018
4015
  }
4019
4016
 
4020
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
4017
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
4018
+
4019
+ /**
4020
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
4021
+ */
4022
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
4021
4023
 
4022
4024
  /**
4023
4025
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -4041,7 +4043,7 @@ declare type ContentCreationOptions = {
4041
4043
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
4042
4044
  * the specified `behavior` key.
4043
4045
  */
4044
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
4046
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
4045
4047
  behavior: Behavior;
4046
4048
  }>;
4047
4049
 
@@ -4926,6 +4928,25 @@ declare type DisplayMetadata_3 = {
4926
4928
  readonly glyph?: string;
4927
4929
  };
4928
4930
 
4931
+ /**
4932
+ * @interface
4933
+ *
4934
+ * Rules for domain-conditional `fin` API injection.
4935
+ *
4936
+ * @remarks Subset of {@link DomainSettings}.
4937
+ */
4938
+ declare type DomainApiSettings = {
4939
+ /**
4940
+ * Injection setting for the `fin` API for contexts on a matched domain.
4941
+ *
4942
+ * * 'none': The `fin` API will be not available.
4943
+ * * 'global': The entire `fin` API will be available.
4944
+ *
4945
+ * @defaultValue 'global'
4946
+ */
4947
+ fin: InjectionType;
4948
+ };
4949
+
4929
4950
  /**
4930
4951
  * @interface
4931
4952
  * Defines application settings that vary by the domain of the current context.
@@ -4964,7 +4985,7 @@ declare type DomainSettingsRule = {
4964
4985
  /**
4965
4986
  * {@inheritDoc ApiInjection}
4966
4987
  */
4967
- api?: ApiInjection;
4988
+ api?: DomainApiSettings;
4968
4989
  };
4969
4990
  };
4970
4991
 
@@ -5003,18 +5024,19 @@ declare type DownloadPreloadOption = {
5003
5024
  /**
5004
5025
  * @interface
5005
5026
  *
5006
- * A rule governing domain-conditional download behavior.
5027
+ * A rule that governs download behavior, discriminated by the URL of the download.
5007
5028
  */
5008
5029
  declare type DownloadRule = {
5009
5030
  /**
5010
- * {@inheritDoc FileDownloadBehaviorNames}
5031
+ * {@inheritDoc FileDownloadBehavior}
5011
5032
  */
5012
- behavior: FileDownloadBehaviorNames;
5033
+ behavior: FileDownloadBehavior;
5013
5034
  /**
5014
5035
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
5015
- * the domain(s) for which the rule applies.
5036
+ * URL(s) of the resource(s) being downloaded.
5016
5037
  *
5017
- * @remarks The match is evaluated against the URL of the *download*.
5038
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
5039
+ * of the page in which a file download link is embedded.
5018
5040
  */
5019
5041
  match: string[];
5020
5042
  };
@@ -5746,7 +5768,12 @@ declare type FetchManifestPayload = {
5746
5768
  /**
5747
5769
  * Whether file downloads raise a user prompt.
5748
5770
  */
5749
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5771
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5772
+
5773
+ /**
5774
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5775
+ */
5776
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5750
5777
 
5751
5778
  /**
5752
5779
  * Generated when a file download has completed.
@@ -5999,6 +6026,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5999
6026
  * Returns a frame info object representing the window that the referenced iframe is
6000
6027
  * currently embedded in.
6001
6028
  *
6029
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
6030
+ *
6002
6031
  * @example
6003
6032
  * ```js
6004
6033
  * async function getParentWindow() {
@@ -6850,6 +6879,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6850
6879
  metadata?: MetadataType;
6851
6880
  };
6852
6881
 
6882
+ declare type InheritableOptions = {
6883
+ customContext: boolean;
6884
+ customData: boolean;
6885
+ icon: boolean;
6886
+ preloadScripts: boolean;
6887
+ };
6888
+
6853
6889
  /**
6854
6890
  * Initialize a remote connection as a "host" application.
6855
6891
  * @param {InitOptions} options init options
@@ -8495,6 +8531,7 @@ declare type LaunchExternalProcessRule = {
8495
8531
  */
8496
8532
  declare type LaunchIntoPlatformPayload = {
8497
8533
  manifest: any;
8534
+ manifestUrl?: string;
8498
8535
  };
8499
8536
 
8500
8537
  /**
@@ -9848,7 +9885,7 @@ declare type MutableViewOptions = {
9848
9885
  /**
9849
9886
  * Configurations for API injection.
9850
9887
  */
9851
- api: Api;
9888
+ api: ApiSettings;
9852
9889
  /**
9853
9890
  * Restrict navigation to URLs that match an allowed pattern.
9854
9891
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10323,6 +10360,7 @@ declare namespace OpenFin {
10323
10360
  WindowState,
10324
10361
  AutoplayPolicyOptions,
10325
10362
  ConstWindowOptions,
10363
+ InheritableOptions,
10326
10364
  MutableWindowOptions,
10327
10365
  WorkspacePlatformOptions,
10328
10366
  WebRequestHeader,
@@ -10331,6 +10369,7 @@ declare namespace OpenFin {
10331
10369
  ResizeRegion,
10332
10370
  Accelerator,
10333
10371
  Api,
10372
+ ApiSettings,
10334
10373
  InjectionType,
10335
10374
  NavigationRules,
10336
10375
  ContentNavigation,
@@ -10482,7 +10521,9 @@ declare namespace OpenFin {
10482
10521
  DefaultDomainSettingsRule,
10483
10522
  DomainSettings,
10484
10523
  ApiInjection,
10524
+ DomainApiSettings,
10485
10525
  DomainSettingsRule,
10526
+ FileDownloadBehavior,
10486
10527
  FileDownloadBehaviorNames,
10487
10528
  FileDownloadSettings,
10488
10529
  DownloadRule,
@@ -10490,6 +10531,7 @@ declare namespace OpenFin {
10490
10531
  Intent_2 as Intent,
10491
10532
  IntentMetadata_3 as IntentMetadata,
10492
10533
  IntentHandler_2 as IntentHandler,
10534
+ ContentCreationBehavior,
10493
10535
  ContentCreationBehaviorNames,
10494
10536
  MatchPattern,
10495
10537
  BaseContentCreationRule,
@@ -11591,6 +11633,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11591
11633
  * The provider url.
11592
11634
  */
11593
11635
  providerUrl?: string;
11636
+ /**
11637
+ * @defaultValue true
11638
+ *
11639
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11640
+ *
11641
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11642
+ */
11643
+ allowLaunchIntoPlatform?: boolean;
11594
11644
  };
11595
11645
 
11596
11646
  /**
@@ -12395,7 +12445,7 @@ declare type PreloadScriptInfoRunning = {
12395
12445
  * @interface
12396
12446
  */
12397
12447
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
12398
- type: 'preload-script-state-changed';
12448
+ type: 'preload-scripts-state-changed';
12399
12449
  };
12400
12450
 
12401
12451
  /**
@@ -12412,7 +12462,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12412
12462
  * @interface
12413
12463
  */
12414
12464
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
12415
- type: 'preload-script-state-changing';
12465
+ type: 'preload-scripts-state-changing';
12416
12466
  };
12417
12467
 
12418
12468
  declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
@@ -8530,6 +8530,8 @@ class _Frame extends base_1$h.EmitterBase {
8530
8530
  * Returns a frame info object representing the window that the referenced iframe is
8531
8531
  * currently embedded in.
8532
8532
  *
8533
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
8534
+ *
8533
8535
  * @example
8534
8536
  * ```js
8535
8537
  * async function getParentWindow() {
@@ -14471,12 +14473,12 @@ class Platform extends base_1$5.EmitterBase {
14471
14473
  * @experimental
14472
14474
  */
14473
14475
  async launchContentManifest(manifestUrl) {
14474
- this.wire.sendAction('platform-launch-content-manifest', this.identity).catch((e) => {
14476
+ this.wire.sendAction('platform-launch-content-manifest', this.identity).catch(() => {
14475
14477
  // don't expose
14476
14478
  });
14477
14479
  const client = await this.getClient();
14478
14480
  const manifest = await this.fetchManifest(manifestUrl);
14479
- client.dispatch('launch-into-platform', { manifest });
14481
+ client.dispatch('launch-into-platform', { manifest, manifestUrl });
14480
14482
  return this;
14481
14483
  }
14482
14484
  /**
@@ -15119,7 +15121,7 @@ class LayoutModule extends base_1$3.Base {
15119
15121
  return this.wrapSync(this.fin.me.identity);
15120
15122
  };
15121
15123
  _LayoutModule_getLayoutManagerSpy.set(this, (layoutIdentity, layoutManager) => {
15122
- const msg = '[Layout] You are using a deprecated property `layoutManager` - it will be removed in v39.';
15124
+ const msg = '[Layout] You are using a deprecated property `layoutManager` - it will throw if you access it starting in v37.';
15123
15125
  const managerProxy = new Proxy(layoutManager, {
15124
15126
  get(target, key) {
15125
15127
  console.warn(`[Layout-mgr-proxy] accessing ${key.toString()}`);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/remote-adapter",
3
- "version": "36.79.19",
3
+ "version": "36.80.2",
4
4
  "description": "Establish intermachine runtime connections using webRTC.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,