@openfin/fdc3-api 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
  };
@@ -5977,7 +5999,12 @@ declare type FetchManifestPayload = {
5977
5999
  /**
5978
6000
  * Whether file downloads raise a user prompt.
5979
6001
  */
5980
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
6002
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
6003
+
6004
+ /**
6005
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
6006
+ */
6007
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5981
6008
 
5982
6009
  /**
5983
6010
  * Generated when a file download has completed.
@@ -6227,6 +6254,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
6227
6254
  * Returns a frame info object representing the window that the referenced iframe is
6228
6255
  * currently embedded in.
6229
6256
  *
6257
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
6258
+ *
6230
6259
  * @example
6231
6260
  * ```js
6232
6261
  * async function getParentWindow() {
@@ -7072,6 +7101,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
7072
7101
  metadata?: MetadataType;
7073
7102
  };
7074
7103
 
7104
+ declare type InheritableOptions = {
7105
+ customContext: boolean;
7106
+ customData: boolean;
7107
+ icon: boolean;
7108
+ preloadScripts: boolean;
7109
+ };
7110
+
7075
7111
  /**
7076
7112
  * Generated when an application has initialized.
7077
7113
  * @interface
@@ -8673,6 +8709,7 @@ declare type LaunchExternalProcessRule = {
8673
8709
  */
8674
8710
  declare type LaunchIntoPlatformPayload = {
8675
8711
  manifest: any;
8712
+ manifestUrl?: string;
8676
8713
  };
8677
8714
 
8678
8715
  /**
@@ -9850,7 +9887,7 @@ declare type MutableViewOptions = {
9850
9887
  /**
9851
9888
  * Configurations for API injection.
9852
9889
  */
9853
- api: Api;
9890
+ api: ApiSettings;
9854
9891
  /**
9855
9892
  * Restrict navigation to URLs that match an allowed pattern.
9856
9893
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10303,6 +10340,7 @@ declare namespace OpenFin {
10303
10340
  WindowState,
10304
10341
  AutoplayPolicyOptions,
10305
10342
  ConstWindowOptions,
10343
+ InheritableOptions,
10306
10344
  MutableWindowOptions,
10307
10345
  WorkspacePlatformOptions,
10308
10346
  WebRequestHeader,
@@ -10311,6 +10349,7 @@ declare namespace OpenFin {
10311
10349
  ResizeRegion,
10312
10350
  Accelerator,
10313
10351
  Api,
10352
+ ApiSettings,
10314
10353
  InjectionType,
10315
10354
  NavigationRules,
10316
10355
  ContentNavigation,
@@ -10462,7 +10501,9 @@ declare namespace OpenFin {
10462
10501
  DefaultDomainSettingsRule,
10463
10502
  DomainSettings,
10464
10503
  ApiInjection,
10504
+ DomainApiSettings,
10465
10505
  DomainSettingsRule,
10506
+ FileDownloadBehavior,
10466
10507
  FileDownloadBehaviorNames,
10467
10508
  FileDownloadSettings,
10468
10509
  DownloadRule,
@@ -10470,6 +10511,7 @@ declare namespace OpenFin {
10470
10511
  Intent_2 as Intent,
10471
10512
  IntentMetadata_3 as IntentMetadata,
10472
10513
  IntentHandler_2 as IntentHandler,
10514
+ ContentCreationBehavior,
10473
10515
  ContentCreationBehaviorNames,
10474
10516
  MatchPattern,
10475
10517
  BaseContentCreationRule,
@@ -11538,6 +11580,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11538
11580
  * The provider url.
11539
11581
  */
11540
11582
  providerUrl?: string;
11583
+ /**
11584
+ * @defaultValue true
11585
+ *
11586
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11587
+ *
11588
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11589
+ */
11590
+ allowLaunchIntoPlatform?: boolean;
11541
11591
  };
11542
11592
 
11543
11593
  /**
@@ -12297,7 +12347,7 @@ declare type PreloadScriptInfoRunning = {
12297
12347
  * @interface
12298
12348
  */
12299
12349
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
12300
- type: 'preload-script-state-changed';
12350
+ type: 'preload-scripts-state-changed';
12301
12351
  };
12302
12352
 
12303
12353
  /**
@@ -12314,7 +12364,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12314
12364
  * @interface
12315
12365
  */
12316
12366
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
12317
- type: 'preload-script-state-changing';
12367
+ type: 'preload-scripts-state-changing';
12318
12368
  };
12319
12369
 
12320
12370
  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;
@@ -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
  };
@@ -5977,7 +5999,12 @@ declare type FetchManifestPayload = {
5977
5999
  /**
5978
6000
  * Whether file downloads raise a user prompt.
5979
6001
  */
5980
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
6002
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
6003
+
6004
+ /**
6005
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
6006
+ */
6007
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5981
6008
 
5982
6009
  /**
5983
6010
  * Generated when a file download has completed.
@@ -6227,6 +6254,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
6227
6254
  * Returns a frame info object representing the window that the referenced iframe is
6228
6255
  * currently embedded in.
6229
6256
  *
6257
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
6258
+ *
6230
6259
  * @example
6231
6260
  * ```js
6232
6261
  * async function getParentWindow() {
@@ -7072,6 +7101,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
7072
7101
  metadata?: MetadataType;
7073
7102
  };
7074
7103
 
7104
+ declare type InheritableOptions = {
7105
+ customContext: boolean;
7106
+ customData: boolean;
7107
+ icon: boolean;
7108
+ preloadScripts: boolean;
7109
+ };
7110
+
7075
7111
  /**
7076
7112
  * Generated when an application has initialized.
7077
7113
  * @interface
@@ -8673,6 +8709,7 @@ declare type LaunchExternalProcessRule = {
8673
8709
  */
8674
8710
  declare type LaunchIntoPlatformPayload = {
8675
8711
  manifest: any;
8712
+ manifestUrl?: string;
8676
8713
  };
8677
8714
 
8678
8715
  /**
@@ -9850,7 +9887,7 @@ declare type MutableViewOptions = {
9850
9887
  /**
9851
9888
  * Configurations for API injection.
9852
9889
  */
9853
- api: Api;
9890
+ api: ApiSettings;
9854
9891
  /**
9855
9892
  * Restrict navigation to URLs that match an allowed pattern.
9856
9893
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10303,6 +10340,7 @@ declare namespace OpenFin {
10303
10340
  WindowState,
10304
10341
  AutoplayPolicyOptions,
10305
10342
  ConstWindowOptions,
10343
+ InheritableOptions,
10306
10344
  MutableWindowOptions,
10307
10345
  WorkspacePlatformOptions,
10308
10346
  WebRequestHeader,
@@ -10311,6 +10349,7 @@ declare namespace OpenFin {
10311
10349
  ResizeRegion,
10312
10350
  Accelerator,
10313
10351
  Api,
10352
+ ApiSettings,
10314
10353
  InjectionType,
10315
10354
  NavigationRules,
10316
10355
  ContentNavigation,
@@ -10462,7 +10501,9 @@ declare namespace OpenFin {
10462
10501
  DefaultDomainSettingsRule,
10463
10502
  DomainSettings,
10464
10503
  ApiInjection,
10504
+ DomainApiSettings,
10465
10505
  DomainSettingsRule,
10506
+ FileDownloadBehavior,
10466
10507
  FileDownloadBehaviorNames,
10467
10508
  FileDownloadSettings,
10468
10509
  DownloadRule,
@@ -10470,6 +10511,7 @@ declare namespace OpenFin {
10470
10511
  Intent_2 as Intent,
10471
10512
  IntentMetadata_3 as IntentMetadata,
10472
10513
  IntentHandler_2 as IntentHandler,
10514
+ ContentCreationBehavior,
10473
10515
  ContentCreationBehaviorNames,
10474
10516
  MatchPattern,
10475
10517
  BaseContentCreationRule,
@@ -11538,6 +11580,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11538
11580
  * The provider url.
11539
11581
  */
11540
11582
  providerUrl?: string;
11583
+ /**
11584
+ * @defaultValue true
11585
+ *
11586
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11587
+ *
11588
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11589
+ */
11590
+ allowLaunchIntoPlatform?: boolean;
11541
11591
  };
11542
11592
 
11543
11593
  /**
@@ -12297,7 +12347,7 @@ declare type PreloadScriptInfoRunning = {
12297
12347
  * @interface
12298
12348
  */
12299
12349
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
12300
- type: 'preload-script-state-changed';
12350
+ type: 'preload-scripts-state-changed';
12301
12351
  };
12302
12352
 
12303
12353
  /**
@@ -12314,7 +12364,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12314
12364
  * @interface
12315
12365
  */
12316
12366
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
12317
- type: 'preload-script-state-changing';
12367
+ type: 'preload-scripts-state-changing';
12318
12368
  };
12319
12369
 
12320
12370
  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;
@@ -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
  };
@@ -5977,7 +5999,12 @@ declare type FetchManifestPayload = {
5977
5999
  /**
5978
6000
  * Whether file downloads raise a user prompt.
5979
6001
  */
5980
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
6002
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
6003
+
6004
+ /**
6005
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
6006
+ */
6007
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5981
6008
 
5982
6009
  /**
5983
6010
  * Generated when a file download has completed.
@@ -6227,6 +6254,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
6227
6254
  * Returns a frame info object representing the window that the referenced iframe is
6228
6255
  * currently embedded in.
6229
6256
  *
6257
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
6258
+ *
6230
6259
  * @example
6231
6260
  * ```js
6232
6261
  * async function getParentWindow() {
@@ -7072,6 +7101,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
7072
7101
  metadata?: MetadataType;
7073
7102
  };
7074
7103
 
7104
+ declare type InheritableOptions = {
7105
+ customContext: boolean;
7106
+ customData: boolean;
7107
+ icon: boolean;
7108
+ preloadScripts: boolean;
7109
+ };
7110
+
7075
7111
  /**
7076
7112
  * Generated when an application has initialized.
7077
7113
  * @interface
@@ -8673,6 +8709,7 @@ declare type LaunchExternalProcessRule = {
8673
8709
  */
8674
8710
  declare type LaunchIntoPlatformPayload = {
8675
8711
  manifest: any;
8712
+ manifestUrl?: string;
8676
8713
  };
8677
8714
 
8678
8715
  /**
@@ -9850,7 +9887,7 @@ declare type MutableViewOptions = {
9850
9887
  /**
9851
9888
  * Configurations for API injection.
9852
9889
  */
9853
- api: Api;
9890
+ api: ApiSettings;
9854
9891
  /**
9855
9892
  * Restrict navigation to URLs that match an allowed pattern.
9856
9893
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10303,6 +10340,7 @@ declare namespace OpenFin {
10303
10340
  WindowState,
10304
10341
  AutoplayPolicyOptions,
10305
10342
  ConstWindowOptions,
10343
+ InheritableOptions,
10306
10344
  MutableWindowOptions,
10307
10345
  WorkspacePlatformOptions,
10308
10346
  WebRequestHeader,
@@ -10311,6 +10349,7 @@ declare namespace OpenFin {
10311
10349
  ResizeRegion,
10312
10350
  Accelerator,
10313
10351
  Api,
10352
+ ApiSettings,
10314
10353
  InjectionType,
10315
10354
  NavigationRules,
10316
10355
  ContentNavigation,
@@ -10462,7 +10501,9 @@ declare namespace OpenFin {
10462
10501
  DefaultDomainSettingsRule,
10463
10502
  DomainSettings,
10464
10503
  ApiInjection,
10504
+ DomainApiSettings,
10465
10505
  DomainSettingsRule,
10506
+ FileDownloadBehavior,
10466
10507
  FileDownloadBehaviorNames,
10467
10508
  FileDownloadSettings,
10468
10509
  DownloadRule,
@@ -10470,6 +10511,7 @@ declare namespace OpenFin {
10470
10511
  Intent_2 as Intent,
10471
10512
  IntentMetadata_3 as IntentMetadata,
10472
10513
  IntentHandler_2 as IntentHandler,
10514
+ ContentCreationBehavior,
10473
10515
  ContentCreationBehaviorNames,
10474
10516
  MatchPattern,
10475
10517
  BaseContentCreationRule,
@@ -11538,6 +11580,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11538
11580
  * The provider url.
11539
11581
  */
11540
11582
  providerUrl?: string;
11583
+ /**
11584
+ * @defaultValue true
11585
+ *
11586
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11587
+ *
11588
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11589
+ */
11590
+ allowLaunchIntoPlatform?: boolean;
11541
11591
  };
11542
11592
 
11543
11593
  /**
@@ -12297,7 +12347,7 @@ declare type PreloadScriptInfoRunning = {
12297
12347
  * @interface
12298
12348
  */
12299
12349
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
12300
- type: 'preload-script-state-changed';
12350
+ type: 'preload-scripts-state-changed';
12301
12351
  };
12302
12352
 
12303
12353
  /**
@@ -12314,7 +12364,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12314
12364
  * @interface
12315
12365
  */
12316
12366
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
12317
- type: 'preload-script-state-changing';
12367
+ type: 'preload-scripts-state-changing';
12318
12368
  };
12319
12369
 
12320
12370
  declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
package/out/fdc3-api.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
  };
@@ -6058,7 +6080,12 @@ declare type FetchManifestPayload = {
6058
6080
  /**
6059
6081
  * Whether file downloads raise a user prompt.
6060
6082
  */
6061
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
6083
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
6084
+
6085
+ /**
6086
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
6087
+ */
6088
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
6062
6089
 
6063
6090
  /**
6064
6091
  * Generated when a file download has completed.
@@ -6311,6 +6338,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
6311
6338
  * Returns a frame info object representing the window that the referenced iframe is
6312
6339
  * currently embedded in.
6313
6340
  *
6341
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
6342
+ *
6314
6343
  * @example
6315
6344
  * ```js
6316
6345
  * async function getParentWindow() {
@@ -7162,6 +7191,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
7162
7191
  metadata?: MetadataType;
7163
7192
  };
7164
7193
 
7194
+ declare type InheritableOptions = {
7195
+ customContext: boolean;
7196
+ customData: boolean;
7197
+ icon: boolean;
7198
+ preloadScripts: boolean;
7199
+ };
7200
+
7165
7201
  /**
7166
7202
  * Generated when an application has initialized.
7167
7203
  * @interface
@@ -8786,6 +8822,7 @@ declare type LaunchExternalProcessRule = {
8786
8822
  */
8787
8823
  declare type LaunchIntoPlatformPayload = {
8788
8824
  manifest: any;
8825
+ manifestUrl?: string;
8789
8826
  };
8790
8827
 
8791
8828
  /**
@@ -10139,7 +10176,7 @@ declare type MutableViewOptions = {
10139
10176
  /**
10140
10177
  * Configurations for API injection.
10141
10178
  */
10142
- api: Api;
10179
+ api: ApiSettings;
10143
10180
  /**
10144
10181
  * Restrict navigation to URLs that match an allowed pattern.
10145
10182
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -10614,6 +10651,7 @@ declare namespace OpenFin {
10614
10651
  WindowState,
10615
10652
  AutoplayPolicyOptions,
10616
10653
  ConstWindowOptions,
10654
+ InheritableOptions,
10617
10655
  MutableWindowOptions,
10618
10656
  WorkspacePlatformOptions,
10619
10657
  WebRequestHeader,
@@ -10622,6 +10660,7 @@ declare namespace OpenFin {
10622
10660
  ResizeRegion,
10623
10661
  Accelerator,
10624
10662
  Api,
10663
+ ApiSettings,
10625
10664
  InjectionType,
10626
10665
  NavigationRules,
10627
10666
  ContentNavigation,
@@ -10773,7 +10812,9 @@ declare namespace OpenFin {
10773
10812
  DefaultDomainSettingsRule,
10774
10813
  DomainSettings,
10775
10814
  ApiInjection,
10815
+ DomainApiSettings,
10776
10816
  DomainSettingsRule,
10817
+ FileDownloadBehavior,
10777
10818
  FileDownloadBehaviorNames,
10778
10819
  FileDownloadSettings,
10779
10820
  DownloadRule,
@@ -10781,6 +10822,7 @@ declare namespace OpenFin {
10781
10822
  Intent_2 as Intent,
10782
10823
  IntentMetadata_3 as IntentMetadata,
10783
10824
  IntentHandler_2 as IntentHandler,
10825
+ ContentCreationBehavior,
10784
10826
  ContentCreationBehaviorNames,
10785
10827
  MatchPattern,
10786
10828
  BaseContentCreationRule,
@@ -11882,6 +11924,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11882
11924
  * The provider url.
11883
11925
  */
11884
11926
  providerUrl?: string;
11927
+ /**
11928
+ * @defaultValue true
11929
+ *
11930
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11931
+ *
11932
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11933
+ */
11934
+ allowLaunchIntoPlatform?: boolean;
11885
11935
  };
11886
11936
 
11887
11937
  /**
@@ -12686,7 +12736,7 @@ declare type PreloadScriptInfoRunning = {
12686
12736
  * @interface
12687
12737
  */
12688
12738
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
12689
- type: 'preload-script-state-changed';
12739
+ type: 'preload-scripts-state-changed';
12690
12740
  };
12691
12741
 
12692
12742
  /**
@@ -12703,7 +12753,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12703
12753
  * @interface
12704
12754
  */
12705
12755
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
12706
- type: 'preload-script-state-changing';
12756
+ type: 'preload-scripts-state-changing';
12707
12757
  };
12708
12758
 
12709
12759
  declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "36.79.19",
3
+ "version": "36.80.2",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.MD",
6
6
  "private": false,