@openfin/core 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;
@@ -3522,7 +3515,7 @@ declare type ConstViewOptions = {
3522
3515
  /**
3523
3516
  * Configurations for API injection.
3524
3517
  */
3525
- api: Api;
3518
+ api: ApiSettings;
3526
3519
  /**
3527
3520
  * The name of the view.
3528
3521
  */
@@ -3839,6 +3832,10 @@ declare type ConstWindowOptions = {
3839
3832
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3840
3833
  */
3841
3834
  viewVisibility?: ViewVisibilityOptions;
3835
+ /**
3836
+ * 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.
3837
+ */
3838
+ inheritance?: Partial<InheritableOptions>;
3842
3839
  };
3843
3840
 
3844
3841
  declare interface Container extends EventEmitter_2 {
@@ -3938,7 +3935,12 @@ declare interface Container extends EventEmitter_2 {
3938
3935
  close(): boolean;
3939
3936
  }
3940
3937
 
3941
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3938
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3939
+
3940
+ /**
3941
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3942
+ */
3943
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3942
3944
 
3943
3945
  /**
3944
3946
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3962,7 +3964,7 @@ declare type ContentCreationOptions = {
3962
3964
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3963
3965
  * the specified `behavior` key.
3964
3966
  */
3965
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3967
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3966
3968
  behavior: Behavior;
3967
3969
  }>;
3968
3970
 
@@ -4847,6 +4849,25 @@ declare type DisplayMetadata_3 = {
4847
4849
  readonly glyph?: string;
4848
4850
  };
4849
4851
 
4852
+ /**
4853
+ * @interface
4854
+ *
4855
+ * Rules for domain-conditional `fin` API injection.
4856
+ *
4857
+ * @remarks Subset of {@link DomainSettings}.
4858
+ */
4859
+ declare type DomainApiSettings = {
4860
+ /**
4861
+ * Injection setting for the `fin` API for contexts on a matched domain.
4862
+ *
4863
+ * * 'none': The `fin` API will be not available.
4864
+ * * 'global': The entire `fin` API will be available.
4865
+ *
4866
+ * @defaultValue 'global'
4867
+ */
4868
+ fin: InjectionType;
4869
+ };
4870
+
4850
4871
  /**
4851
4872
  * @interface
4852
4873
  * Defines application settings that vary by the domain of the current context.
@@ -4885,7 +4906,7 @@ declare type DomainSettingsRule = {
4885
4906
  /**
4886
4907
  * {@inheritDoc ApiInjection}
4887
4908
  */
4888
- api?: ApiInjection;
4909
+ api?: DomainApiSettings;
4889
4910
  };
4890
4911
  };
4891
4912
 
@@ -4924,18 +4945,19 @@ declare type DownloadPreloadOption = {
4924
4945
  /**
4925
4946
  * @interface
4926
4947
  *
4927
- * A rule governing domain-conditional download behavior.
4948
+ * A rule that governs download behavior, discriminated by the URL of the download.
4928
4949
  */
4929
4950
  declare type DownloadRule = {
4930
4951
  /**
4931
- * {@inheritDoc FileDownloadBehaviorNames}
4952
+ * {@inheritDoc FileDownloadBehavior}
4932
4953
  */
4933
- behavior: FileDownloadBehaviorNames;
4954
+ behavior: FileDownloadBehavior;
4934
4955
  /**
4935
4956
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4936
- * the domain(s) for which the rule applies.
4957
+ * URL(s) of the resource(s) being downloaded.
4937
4958
  *
4938
- * @remarks The match is evaluated against the URL of the *download*.
4959
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4960
+ * of the page in which a file download link is embedded.
4939
4961
  */
4940
4962
  match: string[];
4941
4963
  };
@@ -5641,7 +5663,12 @@ declare type FetchManifestPayload = {
5641
5663
  /**
5642
5664
  * Whether file downloads raise a user prompt.
5643
5665
  */
5644
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5666
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5667
+
5668
+ /**
5669
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5670
+ */
5671
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5645
5672
 
5646
5673
  /**
5647
5674
  * Generated when a file download has completed.
@@ -5893,6 +5920,8 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5893
5920
  * Returns a frame info object representing the window that the referenced iframe is
5894
5921
  * currently embedded in.
5895
5922
  *
5923
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5924
+ *
5896
5925
  * @example
5897
5926
  * ```js
5898
5927
  * async function getParentWindow() {
@@ -6738,6 +6767,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6738
6767
  metadata?: MetadataType;
6739
6768
  };
6740
6769
 
6770
+ declare type InheritableOptions = {
6771
+ customContext: boolean;
6772
+ customData: boolean;
6773
+ icon: boolean;
6774
+ preloadScripts: boolean;
6775
+ };
6776
+
6741
6777
  /**
6742
6778
  * Generated when an application has initialized.
6743
6779
  * @interface
@@ -8339,6 +8375,7 @@ declare type LaunchExternalProcessRule = {
8339
8375
  */
8340
8376
  declare type LaunchIntoPlatformPayload = {
8341
8377
  manifest: any;
8378
+ manifestUrl?: string;
8342
8379
  };
8343
8380
 
8344
8381
  /**
@@ -9516,7 +9553,7 @@ declare type MutableViewOptions = {
9516
9553
  /**
9517
9554
  * Configurations for API injection.
9518
9555
  */
9519
- api: Api;
9556
+ api: ApiSettings;
9520
9557
  /**
9521
9558
  * Restrict navigation to URLs that match an allowed pattern.
9522
9559
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -9969,6 +10006,7 @@ declare namespace OpenFin_2 {
9969
10006
  WindowState,
9970
10007
  AutoplayPolicyOptions,
9971
10008
  ConstWindowOptions,
10009
+ InheritableOptions,
9972
10010
  MutableWindowOptions,
9973
10011
  WorkspacePlatformOptions,
9974
10012
  WebRequestHeader,
@@ -9977,6 +10015,7 @@ declare namespace OpenFin_2 {
9977
10015
  ResizeRegion,
9978
10016
  Accelerator,
9979
10017
  Api,
10018
+ ApiSettings,
9980
10019
  InjectionType,
9981
10020
  NavigationRules,
9982
10021
  ContentNavigation,
@@ -10128,7 +10167,9 @@ declare namespace OpenFin_2 {
10128
10167
  DefaultDomainSettingsRule,
10129
10168
  DomainSettings,
10130
10169
  ApiInjection,
10170
+ DomainApiSettings,
10131
10171
  DomainSettingsRule,
10172
+ FileDownloadBehavior,
10132
10173
  FileDownloadBehaviorNames,
10133
10174
  FileDownloadSettings,
10134
10175
  DownloadRule,
@@ -10136,6 +10177,7 @@ declare namespace OpenFin_2 {
10136
10177
  Intent_2 as Intent,
10137
10178
  IntentMetadata_3 as IntentMetadata,
10138
10179
  IntentHandler_2 as IntentHandler,
10180
+ ContentCreationBehavior,
10139
10181
  ContentCreationBehaviorNames,
10140
10182
  MatchPattern,
10141
10183
  BaseContentCreationRule,
@@ -11205,6 +11247,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11205
11247
  * The provider url.
11206
11248
  */
11207
11249
  providerUrl?: string;
11250
+ /**
11251
+ * @defaultValue true
11252
+ *
11253
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11254
+ *
11255
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11256
+ */
11257
+ allowLaunchIntoPlatform?: boolean;
11208
11258
  };
11209
11259
 
11210
11260
  /**
@@ -11964,7 +12014,7 @@ declare type PreloadScriptInfoRunning = {
11964
12014
  * @interface
11965
12015
  */
11966
12016
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
11967
- type: 'preload-script-state-changed';
12017
+ type: 'preload-scripts-state-changed';
11968
12018
  };
11969
12019
 
11970
12020
  /**
@@ -11981,7 +12031,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
11981
12031
  * @interface
11982
12032
  */
11983
12033
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
11984
- type: 'preload-script-state-changing';
12034
+ type: 'preload-scripts-state-changing';
11985
12035
  };
11986
12036
 
11987
12037
  declare type PresetLayoutOptions = OpenFin_2.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;
@@ -3522,7 +3515,7 @@ declare type ConstViewOptions = {
3522
3515
  /**
3523
3516
  * Configurations for API injection.
3524
3517
  */
3525
- api: Api;
3518
+ api: ApiSettings;
3526
3519
  /**
3527
3520
  * The name of the view.
3528
3521
  */
@@ -3839,6 +3832,10 @@ declare type ConstWindowOptions = {
3839
3832
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3840
3833
  */
3841
3834
  viewVisibility?: ViewVisibilityOptions;
3835
+ /**
3836
+ * 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.
3837
+ */
3838
+ inheritance?: Partial<InheritableOptions>;
3842
3839
  };
3843
3840
 
3844
3841
  declare interface Container extends EventEmitter_2 {
@@ -3938,7 +3935,12 @@ declare interface Container extends EventEmitter_2 {
3938
3935
  close(): boolean;
3939
3936
  }
3940
3937
 
3941
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3938
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3939
+
3940
+ /**
3941
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3942
+ */
3943
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3942
3944
 
3943
3945
  /**
3944
3946
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3962,7 +3964,7 @@ declare type ContentCreationOptions = {
3962
3964
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3963
3965
  * the specified `behavior` key.
3964
3966
  */
3965
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3967
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3966
3968
  behavior: Behavior;
3967
3969
  }>;
3968
3970
 
@@ -4847,6 +4849,25 @@ declare type DisplayMetadata_3 = {
4847
4849
  readonly glyph?: string;
4848
4850
  };
4849
4851
 
4852
+ /**
4853
+ * @interface
4854
+ *
4855
+ * Rules for domain-conditional `fin` API injection.
4856
+ *
4857
+ * @remarks Subset of {@link DomainSettings}.
4858
+ */
4859
+ declare type DomainApiSettings = {
4860
+ /**
4861
+ * Injection setting for the `fin` API for contexts on a matched domain.
4862
+ *
4863
+ * * 'none': The `fin` API will be not available.
4864
+ * * 'global': The entire `fin` API will be available.
4865
+ *
4866
+ * @defaultValue 'global'
4867
+ */
4868
+ fin: InjectionType;
4869
+ };
4870
+
4850
4871
  /**
4851
4872
  * @interface
4852
4873
  * Defines application settings that vary by the domain of the current context.
@@ -4885,7 +4906,7 @@ declare type DomainSettingsRule = {
4885
4906
  /**
4886
4907
  * {@inheritDoc ApiInjection}
4887
4908
  */
4888
- api?: ApiInjection;
4909
+ api?: DomainApiSettings;
4889
4910
  };
4890
4911
  };
4891
4912
 
@@ -4924,18 +4945,19 @@ declare type DownloadPreloadOption = {
4924
4945
  /**
4925
4946
  * @interface
4926
4947
  *
4927
- * A rule governing domain-conditional download behavior.
4948
+ * A rule that governs download behavior, discriminated by the URL of the download.
4928
4949
  */
4929
4950
  declare type DownloadRule = {
4930
4951
  /**
4931
- * {@inheritDoc FileDownloadBehaviorNames}
4952
+ * {@inheritDoc FileDownloadBehavior}
4932
4953
  */
4933
- behavior: FileDownloadBehaviorNames;
4954
+ behavior: FileDownloadBehavior;
4934
4955
  /**
4935
4956
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4936
- * the domain(s) for which the rule applies.
4957
+ * URL(s) of the resource(s) being downloaded.
4937
4958
  *
4938
- * @remarks The match is evaluated against the URL of the *download*.
4959
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4960
+ * of the page in which a file download link is embedded.
4939
4961
  */
4940
4962
  match: string[];
4941
4963
  };
@@ -5641,7 +5663,12 @@ declare type FetchManifestPayload = {
5641
5663
  /**
5642
5664
  * Whether file downloads raise a user prompt.
5643
5665
  */
5644
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5666
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5667
+
5668
+ /**
5669
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5670
+ */
5671
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5645
5672
 
5646
5673
  /**
5647
5674
  * Generated when a file download has completed.
@@ -5893,6 +5920,8 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5893
5920
  * Returns a frame info object representing the window that the referenced iframe is
5894
5921
  * currently embedded in.
5895
5922
  *
5923
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5924
+ *
5896
5925
  * @example
5897
5926
  * ```js
5898
5927
  * async function getParentWindow() {
@@ -6738,6 +6767,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6738
6767
  metadata?: MetadataType;
6739
6768
  };
6740
6769
 
6770
+ declare type InheritableOptions = {
6771
+ customContext: boolean;
6772
+ customData: boolean;
6773
+ icon: boolean;
6774
+ preloadScripts: boolean;
6775
+ };
6776
+
6741
6777
  /**
6742
6778
  * Generated when an application has initialized.
6743
6779
  * @interface
@@ -8339,6 +8375,7 @@ declare type LaunchExternalProcessRule = {
8339
8375
  */
8340
8376
  declare type LaunchIntoPlatformPayload = {
8341
8377
  manifest: any;
8378
+ manifestUrl?: string;
8342
8379
  };
8343
8380
 
8344
8381
  /**
@@ -9516,7 +9553,7 @@ declare type MutableViewOptions = {
9516
9553
  /**
9517
9554
  * Configurations for API injection.
9518
9555
  */
9519
- api: Api;
9556
+ api: ApiSettings;
9520
9557
  /**
9521
9558
  * Restrict navigation to URLs that match an allowed pattern.
9522
9559
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -9969,6 +10006,7 @@ declare namespace OpenFin_2 {
9969
10006
  WindowState,
9970
10007
  AutoplayPolicyOptions,
9971
10008
  ConstWindowOptions,
10009
+ InheritableOptions,
9972
10010
  MutableWindowOptions,
9973
10011
  WorkspacePlatformOptions,
9974
10012
  WebRequestHeader,
@@ -9977,6 +10015,7 @@ declare namespace OpenFin_2 {
9977
10015
  ResizeRegion,
9978
10016
  Accelerator,
9979
10017
  Api,
10018
+ ApiSettings,
9980
10019
  InjectionType,
9981
10020
  NavigationRules,
9982
10021
  ContentNavigation,
@@ -10128,7 +10167,9 @@ declare namespace OpenFin_2 {
10128
10167
  DefaultDomainSettingsRule,
10129
10168
  DomainSettings,
10130
10169
  ApiInjection,
10170
+ DomainApiSettings,
10131
10171
  DomainSettingsRule,
10172
+ FileDownloadBehavior,
10132
10173
  FileDownloadBehaviorNames,
10133
10174
  FileDownloadSettings,
10134
10175
  DownloadRule,
@@ -10136,6 +10177,7 @@ declare namespace OpenFin_2 {
10136
10177
  Intent_2 as Intent,
10137
10178
  IntentMetadata_3 as IntentMetadata,
10138
10179
  IntentHandler_2 as IntentHandler,
10180
+ ContentCreationBehavior,
10139
10181
  ContentCreationBehaviorNames,
10140
10182
  MatchPattern,
10141
10183
  BaseContentCreationRule,
@@ -11205,6 +11247,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11205
11247
  * The provider url.
11206
11248
  */
11207
11249
  providerUrl?: string;
11250
+ /**
11251
+ * @defaultValue true
11252
+ *
11253
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11254
+ *
11255
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11256
+ */
11257
+ allowLaunchIntoPlatform?: boolean;
11208
11258
  };
11209
11259
 
11210
11260
  /**
@@ -11964,7 +12014,7 @@ declare type PreloadScriptInfoRunning = {
11964
12014
  * @interface
11965
12015
  */
11966
12016
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
11967
- type: 'preload-script-state-changed';
12017
+ type: 'preload-scripts-state-changed';
11968
12018
  };
11969
12019
 
11970
12020
  /**
@@ -11981,7 +12031,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
11981
12031
  * @interface
11982
12032
  */
11983
12033
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
11984
- type: 'preload-script-state-changing';
12034
+ type: 'preload-scripts-state-changing';
11985
12035
  };
11986
12036
 
11987
12037
  declare type PresetLayoutOptions = OpenFin_2.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;
@@ -3522,7 +3515,7 @@ declare type ConstViewOptions = {
3522
3515
  /**
3523
3516
  * Configurations for API injection.
3524
3517
  */
3525
- api: Api;
3518
+ api: ApiSettings;
3526
3519
  /**
3527
3520
  * The name of the view.
3528
3521
  */
@@ -3839,6 +3832,10 @@ declare type ConstWindowOptions = {
3839
3832
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3840
3833
  */
3841
3834
  viewVisibility?: ViewVisibilityOptions;
3835
+ /**
3836
+ * 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.
3837
+ */
3838
+ inheritance?: Partial<InheritableOptions>;
3842
3839
  };
3843
3840
 
3844
3841
  declare interface Container extends EventEmitter_2 {
@@ -3938,7 +3935,12 @@ declare interface Container extends EventEmitter_2 {
3938
3935
  close(): boolean;
3939
3936
  }
3940
3937
 
3941
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3938
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3939
+
3940
+ /**
3941
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3942
+ */
3943
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3942
3944
 
3943
3945
  /**
3944
3946
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3962,7 +3964,7 @@ declare type ContentCreationOptions = {
3962
3964
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3963
3965
  * the specified `behavior` key.
3964
3966
  */
3965
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3967
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3966
3968
  behavior: Behavior;
3967
3969
  }>;
3968
3970
 
@@ -4847,6 +4849,25 @@ declare type DisplayMetadata_3 = {
4847
4849
  readonly glyph?: string;
4848
4850
  };
4849
4851
 
4852
+ /**
4853
+ * @interface
4854
+ *
4855
+ * Rules for domain-conditional `fin` API injection.
4856
+ *
4857
+ * @remarks Subset of {@link DomainSettings}.
4858
+ */
4859
+ declare type DomainApiSettings = {
4860
+ /**
4861
+ * Injection setting for the `fin` API for contexts on a matched domain.
4862
+ *
4863
+ * * 'none': The `fin` API will be not available.
4864
+ * * 'global': The entire `fin` API will be available.
4865
+ *
4866
+ * @defaultValue 'global'
4867
+ */
4868
+ fin: InjectionType;
4869
+ };
4870
+
4850
4871
  /**
4851
4872
  * @interface
4852
4873
  * Defines application settings that vary by the domain of the current context.
@@ -4885,7 +4906,7 @@ declare type DomainSettingsRule = {
4885
4906
  /**
4886
4907
  * {@inheritDoc ApiInjection}
4887
4908
  */
4888
- api?: ApiInjection;
4909
+ api?: DomainApiSettings;
4889
4910
  };
4890
4911
  };
4891
4912
 
@@ -4924,18 +4945,19 @@ declare type DownloadPreloadOption = {
4924
4945
  /**
4925
4946
  * @interface
4926
4947
  *
4927
- * A rule governing domain-conditional download behavior.
4948
+ * A rule that governs download behavior, discriminated by the URL of the download.
4928
4949
  */
4929
4950
  declare type DownloadRule = {
4930
4951
  /**
4931
- * {@inheritDoc FileDownloadBehaviorNames}
4952
+ * {@inheritDoc FileDownloadBehavior}
4932
4953
  */
4933
- behavior: FileDownloadBehaviorNames;
4954
+ behavior: FileDownloadBehavior;
4934
4955
  /**
4935
4956
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4936
- * the domain(s) for which the rule applies.
4957
+ * URL(s) of the resource(s) being downloaded.
4937
4958
  *
4938
- * @remarks The match is evaluated against the URL of the *download*.
4959
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4960
+ * of the page in which a file download link is embedded.
4939
4961
  */
4940
4962
  match: string[];
4941
4963
  };
@@ -5641,7 +5663,12 @@ declare type FetchManifestPayload = {
5641
5663
  /**
5642
5664
  * Whether file downloads raise a user prompt.
5643
5665
  */
5644
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5666
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5667
+
5668
+ /**
5669
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5670
+ */
5671
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5645
5672
 
5646
5673
  /**
5647
5674
  * Generated when a file download has completed.
@@ -5893,6 +5920,8 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5893
5920
  * Returns a frame info object representing the window that the referenced iframe is
5894
5921
  * currently embedded in.
5895
5922
  *
5923
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5924
+ *
5896
5925
  * @example
5897
5926
  * ```js
5898
5927
  * async function getParentWindow() {
@@ -6738,6 +6767,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6738
6767
  metadata?: MetadataType;
6739
6768
  };
6740
6769
 
6770
+ declare type InheritableOptions = {
6771
+ customContext: boolean;
6772
+ customData: boolean;
6773
+ icon: boolean;
6774
+ preloadScripts: boolean;
6775
+ };
6776
+
6741
6777
  /**
6742
6778
  * Generated when an application has initialized.
6743
6779
  * @interface
@@ -8339,6 +8375,7 @@ declare type LaunchExternalProcessRule = {
8339
8375
  */
8340
8376
  declare type LaunchIntoPlatformPayload = {
8341
8377
  manifest: any;
8378
+ manifestUrl?: string;
8342
8379
  };
8343
8380
 
8344
8381
  /**
@@ -9516,7 +9553,7 @@ declare type MutableViewOptions = {
9516
9553
  /**
9517
9554
  * Configurations for API injection.
9518
9555
  */
9519
- api: Api;
9556
+ api: ApiSettings;
9520
9557
  /**
9521
9558
  * Restrict navigation to URLs that match an allowed pattern.
9522
9559
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -9969,6 +10006,7 @@ declare namespace OpenFin_2 {
9969
10006
  WindowState,
9970
10007
  AutoplayPolicyOptions,
9971
10008
  ConstWindowOptions,
10009
+ InheritableOptions,
9972
10010
  MutableWindowOptions,
9973
10011
  WorkspacePlatformOptions,
9974
10012
  WebRequestHeader,
@@ -9977,6 +10015,7 @@ declare namespace OpenFin_2 {
9977
10015
  ResizeRegion,
9978
10016
  Accelerator,
9979
10017
  Api,
10018
+ ApiSettings,
9980
10019
  InjectionType,
9981
10020
  NavigationRules,
9982
10021
  ContentNavigation,
@@ -10128,7 +10167,9 @@ declare namespace OpenFin_2 {
10128
10167
  DefaultDomainSettingsRule,
10129
10168
  DomainSettings,
10130
10169
  ApiInjection,
10170
+ DomainApiSettings,
10131
10171
  DomainSettingsRule,
10172
+ FileDownloadBehavior,
10132
10173
  FileDownloadBehaviorNames,
10133
10174
  FileDownloadSettings,
10134
10175
  DownloadRule,
@@ -10136,6 +10177,7 @@ declare namespace OpenFin_2 {
10136
10177
  Intent_2 as Intent,
10137
10178
  IntentMetadata_3 as IntentMetadata,
10138
10179
  IntentHandler_2 as IntentHandler,
10180
+ ContentCreationBehavior,
10139
10181
  ContentCreationBehaviorNames,
10140
10182
  MatchPattern,
10141
10183
  BaseContentCreationRule,
@@ -11205,6 +11247,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11205
11247
  * The provider url.
11206
11248
  */
11207
11249
  providerUrl?: string;
11250
+ /**
11251
+ * @defaultValue true
11252
+ *
11253
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11254
+ *
11255
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11256
+ */
11257
+ allowLaunchIntoPlatform?: boolean;
11208
11258
  };
11209
11259
 
11210
11260
  /**
@@ -11964,7 +12014,7 @@ declare type PreloadScriptInfoRunning = {
11964
12014
  * @interface
11965
12015
  */
11966
12016
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
11967
- type: 'preload-script-state-changed';
12017
+ type: 'preload-scripts-state-changed';
11968
12018
  };
11969
12019
 
11970
12020
  /**
@@ -11981,7 +12031,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
11981
12031
  * @interface
11982
12032
  */
11983
12033
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
11984
- type: 'preload-script-state-changing';
12034
+ type: 'preload-scripts-state-changing';
11985
12035
  };
11986
12036
 
11987
12037
  declare type PresetLayoutOptions = OpenFin_2.PresetLayoutOptions;
package/out/mock.d.ts CHANGED
@@ -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;
@@ -3577,7 +3570,7 @@ declare type ConstViewOptions = {
3577
3570
  /**
3578
3571
  * Configurations for API injection.
3579
3572
  */
3580
- api: Api;
3573
+ api: ApiSettings;
3581
3574
  /**
3582
3575
  * The name of the view.
3583
3576
  */
@@ -3894,6 +3887,10 @@ declare type ConstWindowOptions = {
3894
3887
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3895
3888
  */
3896
3889
  viewVisibility?: ViewVisibilityOptions;
3890
+ /**
3891
+ * 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.
3892
+ */
3893
+ inheritance?: Partial<InheritableOptions>;
3897
3894
  };
3898
3895
 
3899
3896
  declare interface Container extends EventEmitter_2 {
@@ -3993,7 +3990,12 @@ declare interface Container extends EventEmitter_2 {
3993
3990
  close(): boolean;
3994
3991
  }
3995
3992
 
3996
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3993
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3994
+
3995
+ /**
3996
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3997
+ */
3998
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3997
3999
 
3998
4000
  /**
3999
4001
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -4017,7 +4019,7 @@ declare type ContentCreationOptions = {
4017
4019
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
4018
4020
  * the specified `behavior` key.
4019
4021
  */
4020
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
4022
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
4021
4023
  behavior: Behavior;
4022
4024
  }>;
4023
4025
 
@@ -4902,6 +4904,25 @@ declare type DisplayMetadata_3 = {
4902
4904
  readonly glyph?: string;
4903
4905
  };
4904
4906
 
4907
+ /**
4908
+ * @interface
4909
+ *
4910
+ * Rules for domain-conditional `fin` API injection.
4911
+ *
4912
+ * @remarks Subset of {@link DomainSettings}.
4913
+ */
4914
+ declare type DomainApiSettings = {
4915
+ /**
4916
+ * Injection setting for the `fin` API for contexts on a matched domain.
4917
+ *
4918
+ * * 'none': The `fin` API will be not available.
4919
+ * * 'global': The entire `fin` API will be available.
4920
+ *
4921
+ * @defaultValue 'global'
4922
+ */
4923
+ fin: InjectionType;
4924
+ };
4925
+
4905
4926
  /**
4906
4927
  * @interface
4907
4928
  * Defines application settings that vary by the domain of the current context.
@@ -4940,7 +4961,7 @@ declare type DomainSettingsRule = {
4940
4961
  /**
4941
4962
  * {@inheritDoc ApiInjection}
4942
4963
  */
4943
- api?: ApiInjection;
4964
+ api?: DomainApiSettings;
4944
4965
  };
4945
4966
  };
4946
4967
 
@@ -4979,18 +5000,19 @@ declare type DownloadPreloadOption = {
4979
5000
  /**
4980
5001
  * @interface
4981
5002
  *
4982
- * A rule governing domain-conditional download behavior.
5003
+ * A rule that governs download behavior, discriminated by the URL of the download.
4983
5004
  */
4984
5005
  declare type DownloadRule = {
4985
5006
  /**
4986
- * {@inheritDoc FileDownloadBehaviorNames}
5007
+ * {@inheritDoc FileDownloadBehavior}
4987
5008
  */
4988
- behavior: FileDownloadBehaviorNames;
5009
+ behavior: FileDownloadBehavior;
4989
5010
  /**
4990
5011
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4991
- * the domain(s) for which the rule applies.
5012
+ * URL(s) of the resource(s) being downloaded.
4992
5013
  *
4993
- * @remarks The match is evaluated against the URL of the *download*.
5014
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
5015
+ * of the page in which a file download link is embedded.
4994
5016
  */
4995
5017
  match: string[];
4996
5018
  };
@@ -5722,7 +5744,12 @@ declare type FetchManifestPayload = {
5722
5744
  /**
5723
5745
  * Whether file downloads raise a user prompt.
5724
5746
  */
5725
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5747
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5748
+
5749
+ /**
5750
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5751
+ */
5752
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5726
5753
 
5727
5754
  /**
5728
5755
  * Generated when a file download has completed.
@@ -5977,6 +6004,8 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5977
6004
  * Returns a frame info object representing the window that the referenced iframe is
5978
6005
  * currently embedded in.
5979
6006
  *
6007
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
6008
+ *
5980
6009
  * @example
5981
6010
  * ```js
5982
6011
  * async function getParentWindow() {
@@ -6828,6 +6857,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6828
6857
  metadata?: MetadataType;
6829
6858
  };
6830
6859
 
6860
+ declare type InheritableOptions = {
6861
+ customContext: boolean;
6862
+ customData: boolean;
6863
+ icon: boolean;
6864
+ preloadScripts: boolean;
6865
+ };
6866
+
6831
6867
  /**
6832
6868
  * Generated when an application has initialized.
6833
6869
  * @interface
@@ -8452,6 +8488,7 @@ declare type LaunchExternalProcessRule = {
8452
8488
  */
8453
8489
  declare type LaunchIntoPlatformPayload = {
8454
8490
  manifest: any;
8491
+ manifestUrl?: string;
8455
8492
  };
8456
8493
 
8457
8494
  /**
@@ -9805,7 +9842,7 @@ declare type MutableViewOptions = {
9805
9842
  /**
9806
9843
  * Configurations for API injection.
9807
9844
  */
9808
- api: Api;
9845
+ api: ApiSettings;
9809
9846
  /**
9810
9847
  * Restrict navigation to URLs that match an allowed pattern.
9811
9848
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10280,6 +10317,7 @@ declare namespace OpenFin_2 {
10280
10317
  WindowState,
10281
10318
  AutoplayPolicyOptions,
10282
10319
  ConstWindowOptions,
10320
+ InheritableOptions,
10283
10321
  MutableWindowOptions,
10284
10322
  WorkspacePlatformOptions,
10285
10323
  WebRequestHeader,
@@ -10288,6 +10326,7 @@ declare namespace OpenFin_2 {
10288
10326
  ResizeRegion,
10289
10327
  Accelerator,
10290
10328
  Api,
10329
+ ApiSettings,
10291
10330
  InjectionType,
10292
10331
  NavigationRules,
10293
10332
  ContentNavigation,
@@ -10439,7 +10478,9 @@ declare namespace OpenFin_2 {
10439
10478
  DefaultDomainSettingsRule,
10440
10479
  DomainSettings,
10441
10480
  ApiInjection,
10481
+ DomainApiSettings,
10442
10482
  DomainSettingsRule,
10483
+ FileDownloadBehavior,
10443
10484
  FileDownloadBehaviorNames,
10444
10485
  FileDownloadSettings,
10445
10486
  DownloadRule,
@@ -10447,6 +10488,7 @@ declare namespace OpenFin_2 {
10447
10488
  Intent_2 as Intent,
10448
10489
  IntentMetadata_3 as IntentMetadata,
10449
10490
  IntentHandler_2 as IntentHandler,
10491
+ ContentCreationBehavior,
10450
10492
  ContentCreationBehaviorNames,
10451
10493
  MatchPattern,
10452
10494
  BaseContentCreationRule,
@@ -11549,6 +11591,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11549
11591
  * The provider url.
11550
11592
  */
11551
11593
  providerUrl?: string;
11594
+ /**
11595
+ * @defaultValue true
11596
+ *
11597
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11598
+ *
11599
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11600
+ */
11601
+ allowLaunchIntoPlatform?: boolean;
11552
11602
  };
11553
11603
 
11554
11604
  /**
@@ -12353,7 +12403,7 @@ declare type PreloadScriptInfoRunning = {
12353
12403
  * @interface
12354
12404
  */
12355
12405
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
12356
- type: 'preload-script-state-changed';
12406
+ type: 'preload-scripts-state-changed';
12357
12407
  };
12358
12408
 
12359
12409
  /**
@@ -12370,7 +12420,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12370
12420
  * @interface
12371
12421
  */
12372
12422
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
12373
- type: 'preload-script-state-changing';
12423
+ type: 'preload-scripts-state-changing';
12374
12424
  };
12375
12425
 
12376
12426
  declare type PresetLayoutOptions = OpenFin_2.PresetLayoutOptions;
package/out/mock.js CHANGED
@@ -10451,6 +10451,8 @@ class _Frame extends base_1$a.EmitterBase {
10451
10451
  * Returns a frame info object representing the window that the referenced iframe is
10452
10452
  * currently embedded in.
10453
10453
  *
10454
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
10455
+ *
10454
10456
  * @example
10455
10457
  * ```js
10456
10458
  * async function getParentWindow() {
@@ -11379,12 +11381,12 @@ class Platform extends base_1$7.EmitterBase {
11379
11381
  * @experimental
11380
11382
  */
11381
11383
  async launchContentManifest(manifestUrl) {
11382
- this.wire.sendAction('platform-launch-content-manifest', this.identity).catch((e) => {
11384
+ this.wire.sendAction('platform-launch-content-manifest', this.identity).catch(() => {
11383
11385
  // don't expose
11384
11386
  });
11385
11387
  const client = await this.getClient();
11386
11388
  const manifest = await this.fetchManifest(manifestUrl);
11387
- client.dispatch('launch-into-platform', { manifest });
11389
+ client.dispatch('launch-into-platform', { manifest, manifestUrl });
11388
11390
  return this;
11389
11391
  }
11390
11392
  /**
@@ -12049,7 +12051,7 @@ class LayoutModule extends base_1$5.Base {
12049
12051
  return this.wrapSync(this.fin.me.identity);
12050
12052
  };
12051
12053
  _LayoutModule_getLayoutManagerSpy.set(this, (layoutIdentity, layoutManager) => {
12052
- const msg = '[Layout] You are using a deprecated property `layoutManager` - it will be removed in v39.';
12054
+ const msg = '[Layout] You are using a deprecated property `layoutManager` - it will throw if you access it starting in v37.';
12053
12055
  const managerProxy = new Proxy(layoutManager, {
12054
12056
  get(target, key) {
12055
12057
  console.warn(`[Layout-mgr-proxy] accessing ${key.toString()}`);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "36.79.19",
3
+ "version": "36.80.2",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/mock.js",