@openfin/node-adapter 36.79.19 → 36.80.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/out/node-adapter-alpha.d.ts +101 -51
- package/out/node-adapter-beta.d.ts +101 -51
- package/out/node-adapter-public.d.ts +101 -51
- package/out/node-adapter.d.ts +101 -51
- package/out/node-adapter.js +5 -3
- package/package.json +1 -1
@@ -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
|
112
|
+
declare type ApiSettings = {
|
85
113
|
/**
|
86
|
-
* Configure injection of OpenFin API into iframes
|
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;
|
@@ -3526,7 +3519,7 @@ declare type ConstViewOptions = {
|
|
3526
3519
|
/**
|
3527
3520
|
* Configurations for API injection.
|
3528
3521
|
*/
|
3529
|
-
api:
|
3522
|
+
api: ApiSettings;
|
3530
3523
|
/**
|
3531
3524
|
* The name of the view.
|
3532
3525
|
*/
|
@@ -3843,6 +3836,10 @@ declare type ConstWindowOptions = {
|
|
3843
3836
|
* _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
3844
3837
|
*/
|
3845
3838
|
viewVisibility?: ViewVisibilityOptions;
|
3839
|
+
/**
|
3840
|
+
* 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.
|
3841
|
+
*/
|
3842
|
+
inheritance?: Partial<InheritableOptions>;
|
3846
3843
|
};
|
3847
3844
|
|
3848
3845
|
declare interface Container extends EventEmitter_2 {
|
@@ -3942,7 +3939,12 @@ declare interface Container extends EventEmitter_2 {
|
|
3942
3939
|
close(): boolean;
|
3943
3940
|
}
|
3944
3941
|
|
3945
|
-
declare type
|
3942
|
+
declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
|
3943
|
+
|
3944
|
+
/**
|
3945
|
+
* @deprecated Renamed to {@link ContentCreationBehavior}.
|
3946
|
+
*/
|
3947
|
+
declare type ContentCreationBehaviorNames = ContentCreationBehavior;
|
3946
3948
|
|
3947
3949
|
/**
|
3948
3950
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
@@ -3966,7 +3968,7 @@ declare type ContentCreationOptions = {
|
|
3966
3968
|
* @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
|
3967
3969
|
* the specified `behavior` key.
|
3968
3970
|
*/
|
3969
|
-
declare type ContentCreationRule<Behavior extends
|
3971
|
+
declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
|
3970
3972
|
behavior: Behavior;
|
3971
3973
|
}>;
|
3972
3974
|
|
@@ -4851,6 +4853,25 @@ declare type DisplayMetadata_3 = {
|
|
4851
4853
|
readonly glyph?: string;
|
4852
4854
|
};
|
4853
4855
|
|
4856
|
+
/**
|
4857
|
+
* @interface
|
4858
|
+
*
|
4859
|
+
* Rules for domain-conditional `fin` API injection.
|
4860
|
+
*
|
4861
|
+
* @remarks Subset of {@link DomainSettings}.
|
4862
|
+
*/
|
4863
|
+
declare type DomainApiSettings = {
|
4864
|
+
/**
|
4865
|
+
* Injection setting for the `fin` API for contexts on a matched domain.
|
4866
|
+
*
|
4867
|
+
* * 'none': The `fin` API will be not available.
|
4868
|
+
* * 'global': The entire `fin` API will be available.
|
4869
|
+
*
|
4870
|
+
* @defaultValue 'global'
|
4871
|
+
*/
|
4872
|
+
fin: InjectionType;
|
4873
|
+
};
|
4874
|
+
|
4854
4875
|
/**
|
4855
4876
|
* @interface
|
4856
4877
|
* Defines application settings that vary by the domain of the current context.
|
@@ -4889,7 +4910,7 @@ declare type DomainSettingsRule = {
|
|
4889
4910
|
/**
|
4890
4911
|
* {@inheritDoc ApiInjection}
|
4891
4912
|
*/
|
4892
|
-
api?:
|
4913
|
+
api?: DomainApiSettings;
|
4893
4914
|
};
|
4894
4915
|
};
|
4895
4916
|
|
@@ -4928,18 +4949,19 @@ declare type DownloadPreloadOption = {
|
|
4928
4949
|
/**
|
4929
4950
|
* @interface
|
4930
4951
|
*
|
4931
|
-
* A rule
|
4952
|
+
* A rule that governs download behavior, discriminated by the URL of the download.
|
4932
4953
|
*/
|
4933
4954
|
declare type DownloadRule = {
|
4934
4955
|
/**
|
4935
|
-
* {@inheritDoc
|
4956
|
+
* {@inheritDoc FileDownloadBehavior}
|
4936
4957
|
*/
|
4937
|
-
behavior:
|
4958
|
+
behavior: FileDownloadBehavior;
|
4938
4959
|
/**
|
4939
4960
|
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
4940
|
-
*
|
4961
|
+
* URL(s) of the resource(s) being downloaded.
|
4941
4962
|
*
|
4942
|
-
* @remarks The match is evaluated against the URL of the *
|
4963
|
+
* @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
|
4964
|
+
* of the page in which a file download link is embedded.
|
4943
4965
|
*/
|
4944
4966
|
match: string[];
|
4945
4967
|
};
|
@@ -5649,7 +5671,12 @@ declare type FetchManifestPayload = {
|
|
5649
5671
|
/**
|
5650
5672
|
* Whether file downloads raise a user prompt.
|
5651
5673
|
*/
|
5652
|
-
declare type
|
5674
|
+
declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
|
5675
|
+
|
5676
|
+
/**
|
5677
|
+
* @deprecated Renamed to {@link FileDownloadBehavior}.
|
5678
|
+
*/
|
5679
|
+
declare type FileDownloadBehaviorNames = FileDownloadBehavior;
|
5653
5680
|
|
5654
5681
|
/**
|
5655
5682
|
* Generated when a file download has completed.
|
@@ -5901,6 +5928,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
5901
5928
|
* Returns a frame info object representing the window that the referenced iframe is
|
5902
5929
|
* currently embedded in.
|
5903
5930
|
*
|
5931
|
+
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
5932
|
+
*
|
5904
5933
|
* @example
|
5905
5934
|
* ```js
|
5906
5935
|
* async function getParentWindow() {
|
@@ -6746,6 +6775,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
6746
6775
|
metadata?: MetadataType;
|
6747
6776
|
};
|
6748
6777
|
|
6778
|
+
declare type InheritableOptions = {
|
6779
|
+
customContext: boolean;
|
6780
|
+
customData: boolean;
|
6781
|
+
icon: boolean;
|
6782
|
+
preloadScripts: boolean;
|
6783
|
+
};
|
6784
|
+
|
6749
6785
|
/**
|
6750
6786
|
* Generated when an application has initialized.
|
6751
6787
|
* @interface
|
@@ -8349,6 +8385,7 @@ declare type LaunchExternalProcessRule = {
|
|
8349
8385
|
*/
|
8350
8386
|
declare type LaunchIntoPlatformPayload = {
|
8351
8387
|
manifest: any;
|
8388
|
+
manifestUrl?: string;
|
8352
8389
|
};
|
8353
8390
|
|
8354
8391
|
/**
|
@@ -9526,7 +9563,7 @@ declare type MutableViewOptions = {
|
|
9526
9563
|
/**
|
9527
9564
|
* Configurations for API injection.
|
9528
9565
|
*/
|
9529
|
-
api:
|
9566
|
+
api: ApiSettings;
|
9530
9567
|
/**
|
9531
9568
|
* Restrict navigation to URLs that match an allowed pattern.
|
9532
9569
|
* In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
|
@@ -9979,6 +10016,7 @@ declare namespace OpenFin {
|
|
9979
10016
|
WindowState,
|
9980
10017
|
AutoplayPolicyOptions,
|
9981
10018
|
ConstWindowOptions,
|
10019
|
+
InheritableOptions,
|
9982
10020
|
MutableWindowOptions,
|
9983
10021
|
WorkspacePlatformOptions,
|
9984
10022
|
WebRequestHeader,
|
@@ -9987,6 +10025,7 @@ declare namespace OpenFin {
|
|
9987
10025
|
ResizeRegion,
|
9988
10026
|
Accelerator,
|
9989
10027
|
Api,
|
10028
|
+
ApiSettings,
|
9990
10029
|
InjectionType,
|
9991
10030
|
NavigationRules,
|
9992
10031
|
ContentNavigation,
|
@@ -10138,7 +10177,9 @@ declare namespace OpenFin {
|
|
10138
10177
|
DefaultDomainSettingsRule,
|
10139
10178
|
DomainSettings,
|
10140
10179
|
ApiInjection,
|
10180
|
+
DomainApiSettings,
|
10141
10181
|
DomainSettingsRule,
|
10182
|
+
FileDownloadBehavior,
|
10142
10183
|
FileDownloadBehaviorNames,
|
10143
10184
|
FileDownloadSettings,
|
10144
10185
|
DownloadRule,
|
@@ -10146,6 +10187,7 @@ declare namespace OpenFin {
|
|
10146
10187
|
Intent_2 as Intent,
|
10147
10188
|
IntentMetadata_3 as IntentMetadata,
|
10148
10189
|
IntentHandler_2 as IntentHandler,
|
10190
|
+
ContentCreationBehavior,
|
10149
10191
|
ContentCreationBehaviorNames,
|
10150
10192
|
MatchPattern,
|
10151
10193
|
BaseContentCreationRule,
|
@@ -11215,6 +11257,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
|
|
11215
11257
|
* The provider url.
|
11216
11258
|
*/
|
11217
11259
|
providerUrl?: string;
|
11260
|
+
/**
|
11261
|
+
* @defaultValue true
|
11262
|
+
*
|
11263
|
+
* Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
|
11264
|
+
*
|
11265
|
+
* NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
|
11266
|
+
*/
|
11267
|
+
allowLaunchIntoPlatform?: boolean;
|
11218
11268
|
};
|
11219
11269
|
|
11220
11270
|
/**
|
@@ -11974,7 +12024,7 @@ declare type PreloadScriptInfoRunning = {
|
|
11974
12024
|
* @interface
|
11975
12025
|
*/
|
11976
12026
|
declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
|
11977
|
-
type: 'preload-
|
12027
|
+
type: 'preload-scripts-state-changed';
|
11978
12028
|
};
|
11979
12029
|
|
11980
12030
|
/**
|
@@ -11991,7 +12041,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
|
|
11991
12041
|
* @interface
|
11992
12042
|
*/
|
11993
12043
|
declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
|
11994
|
-
type: 'preload-
|
12044
|
+
type: 'preload-scripts-state-changing';
|
11995
12045
|
};
|
11996
12046
|
|
11997
12047
|
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
|
112
|
+
declare type ApiSettings = {
|
85
113
|
/**
|
86
|
-
* Configure injection of OpenFin API into iframes
|
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;
|
@@ -3526,7 +3519,7 @@ declare type ConstViewOptions = {
|
|
3526
3519
|
/**
|
3527
3520
|
* Configurations for API injection.
|
3528
3521
|
*/
|
3529
|
-
api:
|
3522
|
+
api: ApiSettings;
|
3530
3523
|
/**
|
3531
3524
|
* The name of the view.
|
3532
3525
|
*/
|
@@ -3843,6 +3836,10 @@ declare type ConstWindowOptions = {
|
|
3843
3836
|
* _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
3844
3837
|
*/
|
3845
3838
|
viewVisibility?: ViewVisibilityOptions;
|
3839
|
+
/**
|
3840
|
+
* 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.
|
3841
|
+
*/
|
3842
|
+
inheritance?: Partial<InheritableOptions>;
|
3846
3843
|
};
|
3847
3844
|
|
3848
3845
|
declare interface Container extends EventEmitter_2 {
|
@@ -3942,7 +3939,12 @@ declare interface Container extends EventEmitter_2 {
|
|
3942
3939
|
close(): boolean;
|
3943
3940
|
}
|
3944
3941
|
|
3945
|
-
declare type
|
3942
|
+
declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
|
3943
|
+
|
3944
|
+
/**
|
3945
|
+
* @deprecated Renamed to {@link ContentCreationBehavior}.
|
3946
|
+
*/
|
3947
|
+
declare type ContentCreationBehaviorNames = ContentCreationBehavior;
|
3946
3948
|
|
3947
3949
|
/**
|
3948
3950
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
@@ -3966,7 +3968,7 @@ declare type ContentCreationOptions = {
|
|
3966
3968
|
* @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
|
3967
3969
|
* the specified `behavior` key.
|
3968
3970
|
*/
|
3969
|
-
declare type ContentCreationRule<Behavior extends
|
3971
|
+
declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
|
3970
3972
|
behavior: Behavior;
|
3971
3973
|
}>;
|
3972
3974
|
|
@@ -4851,6 +4853,25 @@ declare type DisplayMetadata_3 = {
|
|
4851
4853
|
readonly glyph?: string;
|
4852
4854
|
};
|
4853
4855
|
|
4856
|
+
/**
|
4857
|
+
* @interface
|
4858
|
+
*
|
4859
|
+
* Rules for domain-conditional `fin` API injection.
|
4860
|
+
*
|
4861
|
+
* @remarks Subset of {@link DomainSettings}.
|
4862
|
+
*/
|
4863
|
+
declare type DomainApiSettings = {
|
4864
|
+
/**
|
4865
|
+
* Injection setting for the `fin` API for contexts on a matched domain.
|
4866
|
+
*
|
4867
|
+
* * 'none': The `fin` API will be not available.
|
4868
|
+
* * 'global': The entire `fin` API will be available.
|
4869
|
+
*
|
4870
|
+
* @defaultValue 'global'
|
4871
|
+
*/
|
4872
|
+
fin: InjectionType;
|
4873
|
+
};
|
4874
|
+
|
4854
4875
|
/**
|
4855
4876
|
* @interface
|
4856
4877
|
* Defines application settings that vary by the domain of the current context.
|
@@ -4889,7 +4910,7 @@ declare type DomainSettingsRule = {
|
|
4889
4910
|
/**
|
4890
4911
|
* {@inheritDoc ApiInjection}
|
4891
4912
|
*/
|
4892
|
-
api?:
|
4913
|
+
api?: DomainApiSettings;
|
4893
4914
|
};
|
4894
4915
|
};
|
4895
4916
|
|
@@ -4928,18 +4949,19 @@ declare type DownloadPreloadOption = {
|
|
4928
4949
|
/**
|
4929
4950
|
* @interface
|
4930
4951
|
*
|
4931
|
-
* A rule
|
4952
|
+
* A rule that governs download behavior, discriminated by the URL of the download.
|
4932
4953
|
*/
|
4933
4954
|
declare type DownloadRule = {
|
4934
4955
|
/**
|
4935
|
-
* {@inheritDoc
|
4956
|
+
* {@inheritDoc FileDownloadBehavior}
|
4936
4957
|
*/
|
4937
|
-
behavior:
|
4958
|
+
behavior: FileDownloadBehavior;
|
4938
4959
|
/**
|
4939
4960
|
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
4940
|
-
*
|
4961
|
+
* URL(s) of the resource(s) being downloaded.
|
4941
4962
|
*
|
4942
|
-
* @remarks The match is evaluated against the URL of the *
|
4963
|
+
* @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
|
4964
|
+
* of the page in which a file download link is embedded.
|
4943
4965
|
*/
|
4944
4966
|
match: string[];
|
4945
4967
|
};
|
@@ -5649,7 +5671,12 @@ declare type FetchManifestPayload = {
|
|
5649
5671
|
/**
|
5650
5672
|
* Whether file downloads raise a user prompt.
|
5651
5673
|
*/
|
5652
|
-
declare type
|
5674
|
+
declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
|
5675
|
+
|
5676
|
+
/**
|
5677
|
+
* @deprecated Renamed to {@link FileDownloadBehavior}.
|
5678
|
+
*/
|
5679
|
+
declare type FileDownloadBehaviorNames = FileDownloadBehavior;
|
5653
5680
|
|
5654
5681
|
/**
|
5655
5682
|
* Generated when a file download has completed.
|
@@ -5901,6 +5928,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
5901
5928
|
* Returns a frame info object representing the window that the referenced iframe is
|
5902
5929
|
* currently embedded in.
|
5903
5930
|
*
|
5931
|
+
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
5932
|
+
*
|
5904
5933
|
* @example
|
5905
5934
|
* ```js
|
5906
5935
|
* async function getParentWindow() {
|
@@ -6746,6 +6775,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
6746
6775
|
metadata?: MetadataType;
|
6747
6776
|
};
|
6748
6777
|
|
6778
|
+
declare type InheritableOptions = {
|
6779
|
+
customContext: boolean;
|
6780
|
+
customData: boolean;
|
6781
|
+
icon: boolean;
|
6782
|
+
preloadScripts: boolean;
|
6783
|
+
};
|
6784
|
+
|
6749
6785
|
/**
|
6750
6786
|
* Generated when an application has initialized.
|
6751
6787
|
* @interface
|
@@ -8349,6 +8385,7 @@ declare type LaunchExternalProcessRule = {
|
|
8349
8385
|
*/
|
8350
8386
|
declare type LaunchIntoPlatformPayload = {
|
8351
8387
|
manifest: any;
|
8388
|
+
manifestUrl?: string;
|
8352
8389
|
};
|
8353
8390
|
|
8354
8391
|
/**
|
@@ -9526,7 +9563,7 @@ declare type MutableViewOptions = {
|
|
9526
9563
|
/**
|
9527
9564
|
* Configurations for API injection.
|
9528
9565
|
*/
|
9529
|
-
api:
|
9566
|
+
api: ApiSettings;
|
9530
9567
|
/**
|
9531
9568
|
* Restrict navigation to URLs that match an allowed pattern.
|
9532
9569
|
* In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
|
@@ -9979,6 +10016,7 @@ declare namespace OpenFin {
|
|
9979
10016
|
WindowState,
|
9980
10017
|
AutoplayPolicyOptions,
|
9981
10018
|
ConstWindowOptions,
|
10019
|
+
InheritableOptions,
|
9982
10020
|
MutableWindowOptions,
|
9983
10021
|
WorkspacePlatformOptions,
|
9984
10022
|
WebRequestHeader,
|
@@ -9987,6 +10025,7 @@ declare namespace OpenFin {
|
|
9987
10025
|
ResizeRegion,
|
9988
10026
|
Accelerator,
|
9989
10027
|
Api,
|
10028
|
+
ApiSettings,
|
9990
10029
|
InjectionType,
|
9991
10030
|
NavigationRules,
|
9992
10031
|
ContentNavigation,
|
@@ -10138,7 +10177,9 @@ declare namespace OpenFin {
|
|
10138
10177
|
DefaultDomainSettingsRule,
|
10139
10178
|
DomainSettings,
|
10140
10179
|
ApiInjection,
|
10180
|
+
DomainApiSettings,
|
10141
10181
|
DomainSettingsRule,
|
10182
|
+
FileDownloadBehavior,
|
10142
10183
|
FileDownloadBehaviorNames,
|
10143
10184
|
FileDownloadSettings,
|
10144
10185
|
DownloadRule,
|
@@ -10146,6 +10187,7 @@ declare namespace OpenFin {
|
|
10146
10187
|
Intent_2 as Intent,
|
10147
10188
|
IntentMetadata_3 as IntentMetadata,
|
10148
10189
|
IntentHandler_2 as IntentHandler,
|
10190
|
+
ContentCreationBehavior,
|
10149
10191
|
ContentCreationBehaviorNames,
|
10150
10192
|
MatchPattern,
|
10151
10193
|
BaseContentCreationRule,
|
@@ -11215,6 +11257,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
|
|
11215
11257
|
* The provider url.
|
11216
11258
|
*/
|
11217
11259
|
providerUrl?: string;
|
11260
|
+
/**
|
11261
|
+
* @defaultValue true
|
11262
|
+
*
|
11263
|
+
* Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
|
11264
|
+
*
|
11265
|
+
* NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
|
11266
|
+
*/
|
11267
|
+
allowLaunchIntoPlatform?: boolean;
|
11218
11268
|
};
|
11219
11269
|
|
11220
11270
|
/**
|
@@ -11974,7 +12024,7 @@ declare type PreloadScriptInfoRunning = {
|
|
11974
12024
|
* @interface
|
11975
12025
|
*/
|
11976
12026
|
declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
|
11977
|
-
type: 'preload-
|
12027
|
+
type: 'preload-scripts-state-changed';
|
11978
12028
|
};
|
11979
12029
|
|
11980
12030
|
/**
|
@@ -11991,7 +12041,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
|
|
11991
12041
|
* @interface
|
11992
12042
|
*/
|
11993
12043
|
declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
|
11994
|
-
type: 'preload-
|
12044
|
+
type: 'preload-scripts-state-changing';
|
11995
12045
|
};
|
11996
12046
|
|
11997
12047
|
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
|
112
|
+
declare type ApiSettings = {
|
85
113
|
/**
|
86
|
-
* Configure injection of OpenFin API into iframes
|
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;
|
@@ -3526,7 +3519,7 @@ declare type ConstViewOptions = {
|
|
3526
3519
|
/**
|
3527
3520
|
* Configurations for API injection.
|
3528
3521
|
*/
|
3529
|
-
api:
|
3522
|
+
api: ApiSettings;
|
3530
3523
|
/**
|
3531
3524
|
* The name of the view.
|
3532
3525
|
*/
|
@@ -3843,6 +3836,10 @@ declare type ConstWindowOptions = {
|
|
3843
3836
|
* _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
3844
3837
|
*/
|
3845
3838
|
viewVisibility?: ViewVisibilityOptions;
|
3839
|
+
/**
|
3840
|
+
* 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.
|
3841
|
+
*/
|
3842
|
+
inheritance?: Partial<InheritableOptions>;
|
3846
3843
|
};
|
3847
3844
|
|
3848
3845
|
declare interface Container extends EventEmitter_2 {
|
@@ -3942,7 +3939,12 @@ declare interface Container extends EventEmitter_2 {
|
|
3942
3939
|
close(): boolean;
|
3943
3940
|
}
|
3944
3941
|
|
3945
|
-
declare type
|
3942
|
+
declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
|
3943
|
+
|
3944
|
+
/**
|
3945
|
+
* @deprecated Renamed to {@link ContentCreationBehavior}.
|
3946
|
+
*/
|
3947
|
+
declare type ContentCreationBehaviorNames = ContentCreationBehavior;
|
3946
3948
|
|
3947
3949
|
/**
|
3948
3950
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
@@ -3966,7 +3968,7 @@ declare type ContentCreationOptions = {
|
|
3966
3968
|
* @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
|
3967
3969
|
* the specified `behavior` key.
|
3968
3970
|
*/
|
3969
|
-
declare type ContentCreationRule<Behavior extends
|
3971
|
+
declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
|
3970
3972
|
behavior: Behavior;
|
3971
3973
|
}>;
|
3972
3974
|
|
@@ -4851,6 +4853,25 @@ declare type DisplayMetadata_3 = {
|
|
4851
4853
|
readonly glyph?: string;
|
4852
4854
|
};
|
4853
4855
|
|
4856
|
+
/**
|
4857
|
+
* @interface
|
4858
|
+
*
|
4859
|
+
* Rules for domain-conditional `fin` API injection.
|
4860
|
+
*
|
4861
|
+
* @remarks Subset of {@link DomainSettings}.
|
4862
|
+
*/
|
4863
|
+
declare type DomainApiSettings = {
|
4864
|
+
/**
|
4865
|
+
* Injection setting for the `fin` API for contexts on a matched domain.
|
4866
|
+
*
|
4867
|
+
* * 'none': The `fin` API will be not available.
|
4868
|
+
* * 'global': The entire `fin` API will be available.
|
4869
|
+
*
|
4870
|
+
* @defaultValue 'global'
|
4871
|
+
*/
|
4872
|
+
fin: InjectionType;
|
4873
|
+
};
|
4874
|
+
|
4854
4875
|
/**
|
4855
4876
|
* @interface
|
4856
4877
|
* Defines application settings that vary by the domain of the current context.
|
@@ -4889,7 +4910,7 @@ declare type DomainSettingsRule = {
|
|
4889
4910
|
/**
|
4890
4911
|
* {@inheritDoc ApiInjection}
|
4891
4912
|
*/
|
4892
|
-
api?:
|
4913
|
+
api?: DomainApiSettings;
|
4893
4914
|
};
|
4894
4915
|
};
|
4895
4916
|
|
@@ -4928,18 +4949,19 @@ declare type DownloadPreloadOption = {
|
|
4928
4949
|
/**
|
4929
4950
|
* @interface
|
4930
4951
|
*
|
4931
|
-
* A rule
|
4952
|
+
* A rule that governs download behavior, discriminated by the URL of the download.
|
4932
4953
|
*/
|
4933
4954
|
declare type DownloadRule = {
|
4934
4955
|
/**
|
4935
|
-
* {@inheritDoc
|
4956
|
+
* {@inheritDoc FileDownloadBehavior}
|
4936
4957
|
*/
|
4937
|
-
behavior:
|
4958
|
+
behavior: FileDownloadBehavior;
|
4938
4959
|
/**
|
4939
4960
|
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
4940
|
-
*
|
4961
|
+
* URL(s) of the resource(s) being downloaded.
|
4941
4962
|
*
|
4942
|
-
* @remarks The match is evaluated against the URL of the *
|
4963
|
+
* @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
|
4964
|
+
* of the page in which a file download link is embedded.
|
4943
4965
|
*/
|
4944
4966
|
match: string[];
|
4945
4967
|
};
|
@@ -5649,7 +5671,12 @@ declare type FetchManifestPayload = {
|
|
5649
5671
|
/**
|
5650
5672
|
* Whether file downloads raise a user prompt.
|
5651
5673
|
*/
|
5652
|
-
declare type
|
5674
|
+
declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
|
5675
|
+
|
5676
|
+
/**
|
5677
|
+
* @deprecated Renamed to {@link FileDownloadBehavior}.
|
5678
|
+
*/
|
5679
|
+
declare type FileDownloadBehaviorNames = FileDownloadBehavior;
|
5653
5680
|
|
5654
5681
|
/**
|
5655
5682
|
* Generated when a file download has completed.
|
@@ -5901,6 +5928,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
5901
5928
|
* Returns a frame info object representing the window that the referenced iframe is
|
5902
5929
|
* currently embedded in.
|
5903
5930
|
*
|
5931
|
+
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
5932
|
+
*
|
5904
5933
|
* @example
|
5905
5934
|
* ```js
|
5906
5935
|
* async function getParentWindow() {
|
@@ -6746,6 +6775,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
6746
6775
|
metadata?: MetadataType;
|
6747
6776
|
};
|
6748
6777
|
|
6778
|
+
declare type InheritableOptions = {
|
6779
|
+
customContext: boolean;
|
6780
|
+
customData: boolean;
|
6781
|
+
icon: boolean;
|
6782
|
+
preloadScripts: boolean;
|
6783
|
+
};
|
6784
|
+
|
6749
6785
|
/**
|
6750
6786
|
* Generated when an application has initialized.
|
6751
6787
|
* @interface
|
@@ -8349,6 +8385,7 @@ declare type LaunchExternalProcessRule = {
|
|
8349
8385
|
*/
|
8350
8386
|
declare type LaunchIntoPlatformPayload = {
|
8351
8387
|
manifest: any;
|
8388
|
+
manifestUrl?: string;
|
8352
8389
|
};
|
8353
8390
|
|
8354
8391
|
/**
|
@@ -9526,7 +9563,7 @@ declare type MutableViewOptions = {
|
|
9526
9563
|
/**
|
9527
9564
|
* Configurations for API injection.
|
9528
9565
|
*/
|
9529
|
-
api:
|
9566
|
+
api: ApiSettings;
|
9530
9567
|
/**
|
9531
9568
|
* Restrict navigation to URLs that match an allowed pattern.
|
9532
9569
|
* In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
|
@@ -9979,6 +10016,7 @@ declare namespace OpenFin {
|
|
9979
10016
|
WindowState,
|
9980
10017
|
AutoplayPolicyOptions,
|
9981
10018
|
ConstWindowOptions,
|
10019
|
+
InheritableOptions,
|
9982
10020
|
MutableWindowOptions,
|
9983
10021
|
WorkspacePlatformOptions,
|
9984
10022
|
WebRequestHeader,
|
@@ -9987,6 +10025,7 @@ declare namespace OpenFin {
|
|
9987
10025
|
ResizeRegion,
|
9988
10026
|
Accelerator,
|
9989
10027
|
Api,
|
10028
|
+
ApiSettings,
|
9990
10029
|
InjectionType,
|
9991
10030
|
NavigationRules,
|
9992
10031
|
ContentNavigation,
|
@@ -10138,7 +10177,9 @@ declare namespace OpenFin {
|
|
10138
10177
|
DefaultDomainSettingsRule,
|
10139
10178
|
DomainSettings,
|
10140
10179
|
ApiInjection,
|
10180
|
+
DomainApiSettings,
|
10141
10181
|
DomainSettingsRule,
|
10182
|
+
FileDownloadBehavior,
|
10142
10183
|
FileDownloadBehaviorNames,
|
10143
10184
|
FileDownloadSettings,
|
10144
10185
|
DownloadRule,
|
@@ -10146,6 +10187,7 @@ declare namespace OpenFin {
|
|
10146
10187
|
Intent_2 as Intent,
|
10147
10188
|
IntentMetadata_3 as IntentMetadata,
|
10148
10189
|
IntentHandler_2 as IntentHandler,
|
10190
|
+
ContentCreationBehavior,
|
10149
10191
|
ContentCreationBehaviorNames,
|
10150
10192
|
MatchPattern,
|
10151
10193
|
BaseContentCreationRule,
|
@@ -11215,6 +11257,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
|
|
11215
11257
|
* The provider url.
|
11216
11258
|
*/
|
11217
11259
|
providerUrl?: string;
|
11260
|
+
/**
|
11261
|
+
* @defaultValue true
|
11262
|
+
*
|
11263
|
+
* Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
|
11264
|
+
*
|
11265
|
+
* NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
|
11266
|
+
*/
|
11267
|
+
allowLaunchIntoPlatform?: boolean;
|
11218
11268
|
};
|
11219
11269
|
|
11220
11270
|
/**
|
@@ -11974,7 +12024,7 @@ declare type PreloadScriptInfoRunning = {
|
|
11974
12024
|
* @interface
|
11975
12025
|
*/
|
11976
12026
|
declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
|
11977
|
-
type: 'preload-
|
12027
|
+
type: 'preload-scripts-state-changed';
|
11978
12028
|
};
|
11979
12029
|
|
11980
12030
|
/**
|
@@ -11991,7 +12041,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
|
|
11991
12041
|
* @interface
|
11992
12042
|
*/
|
11993
12043
|
declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
|
11994
|
-
type: 'preload-
|
12044
|
+
type: 'preload-scripts-state-changing';
|
11995
12045
|
};
|
11996
12046
|
|
11997
12047
|
declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
|
package/out/node-adapter.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
|
112
|
+
declare type ApiSettings = {
|
85
113
|
/**
|
86
|
-
* Configure injection of OpenFin API into iframes
|
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;
|
@@ -3581,7 +3574,7 @@ declare type ConstViewOptions = {
|
|
3581
3574
|
/**
|
3582
3575
|
* Configurations for API injection.
|
3583
3576
|
*/
|
3584
|
-
api:
|
3577
|
+
api: ApiSettings;
|
3585
3578
|
/**
|
3586
3579
|
* The name of the view.
|
3587
3580
|
*/
|
@@ -3898,6 +3891,10 @@ declare type ConstWindowOptions = {
|
|
3898
3891
|
* _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
3899
3892
|
*/
|
3900
3893
|
viewVisibility?: ViewVisibilityOptions;
|
3894
|
+
/**
|
3895
|
+
* 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.
|
3896
|
+
*/
|
3897
|
+
inheritance?: Partial<InheritableOptions>;
|
3901
3898
|
};
|
3902
3899
|
|
3903
3900
|
declare interface Container extends EventEmitter_2 {
|
@@ -3997,7 +3994,12 @@ declare interface Container extends EventEmitter_2 {
|
|
3997
3994
|
close(): boolean;
|
3998
3995
|
}
|
3999
3996
|
|
4000
|
-
declare type
|
3997
|
+
declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
|
3998
|
+
|
3999
|
+
/**
|
4000
|
+
* @deprecated Renamed to {@link ContentCreationBehavior}.
|
4001
|
+
*/
|
4002
|
+
declare type ContentCreationBehaviorNames = ContentCreationBehavior;
|
4001
4003
|
|
4002
4004
|
/**
|
4003
4005
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
@@ -4021,7 +4023,7 @@ declare type ContentCreationOptions = {
|
|
4021
4023
|
* @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
|
4022
4024
|
* the specified `behavior` key.
|
4023
4025
|
*/
|
4024
|
-
declare type ContentCreationRule<Behavior extends
|
4026
|
+
declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
|
4025
4027
|
behavior: Behavior;
|
4026
4028
|
}>;
|
4027
4029
|
|
@@ -4906,6 +4908,25 @@ declare type DisplayMetadata_3 = {
|
|
4906
4908
|
readonly glyph?: string;
|
4907
4909
|
};
|
4908
4910
|
|
4911
|
+
/**
|
4912
|
+
* @interface
|
4913
|
+
*
|
4914
|
+
* Rules for domain-conditional `fin` API injection.
|
4915
|
+
*
|
4916
|
+
* @remarks Subset of {@link DomainSettings}.
|
4917
|
+
*/
|
4918
|
+
declare type DomainApiSettings = {
|
4919
|
+
/**
|
4920
|
+
* Injection setting for the `fin` API for contexts on a matched domain.
|
4921
|
+
*
|
4922
|
+
* * 'none': The `fin` API will be not available.
|
4923
|
+
* * 'global': The entire `fin` API will be available.
|
4924
|
+
*
|
4925
|
+
* @defaultValue 'global'
|
4926
|
+
*/
|
4927
|
+
fin: InjectionType;
|
4928
|
+
};
|
4929
|
+
|
4909
4930
|
/**
|
4910
4931
|
* @interface
|
4911
4932
|
* Defines application settings that vary by the domain of the current context.
|
@@ -4944,7 +4965,7 @@ declare type DomainSettingsRule = {
|
|
4944
4965
|
/**
|
4945
4966
|
* {@inheritDoc ApiInjection}
|
4946
4967
|
*/
|
4947
|
-
api?:
|
4968
|
+
api?: DomainApiSettings;
|
4948
4969
|
};
|
4949
4970
|
};
|
4950
4971
|
|
@@ -4983,18 +5004,19 @@ declare type DownloadPreloadOption = {
|
|
4983
5004
|
/**
|
4984
5005
|
* @interface
|
4985
5006
|
*
|
4986
|
-
* A rule
|
5007
|
+
* A rule that governs download behavior, discriminated by the URL of the download.
|
4987
5008
|
*/
|
4988
5009
|
declare type DownloadRule = {
|
4989
5010
|
/**
|
4990
|
-
* {@inheritDoc
|
5011
|
+
* {@inheritDoc FileDownloadBehavior}
|
4991
5012
|
*/
|
4992
|
-
behavior:
|
5013
|
+
behavior: FileDownloadBehavior;
|
4993
5014
|
/**
|
4994
5015
|
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
4995
|
-
*
|
5016
|
+
* URL(s) of the resource(s) being downloaded.
|
4996
5017
|
*
|
4997
|
-
* @remarks The match is evaluated against the URL of the *
|
5018
|
+
* @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
|
5019
|
+
* of the page in which a file download link is embedded.
|
4998
5020
|
*/
|
4999
5021
|
match: string[];
|
5000
5022
|
};
|
@@ -5730,7 +5752,12 @@ declare type FetchManifestPayload = {
|
|
5730
5752
|
/**
|
5731
5753
|
* Whether file downloads raise a user prompt.
|
5732
5754
|
*/
|
5733
|
-
declare type
|
5755
|
+
declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
|
5756
|
+
|
5757
|
+
/**
|
5758
|
+
* @deprecated Renamed to {@link FileDownloadBehavior}.
|
5759
|
+
*/
|
5760
|
+
declare type FileDownloadBehaviorNames = FileDownloadBehavior;
|
5734
5761
|
|
5735
5762
|
/**
|
5736
5763
|
* Generated when a file download has completed.
|
@@ -6007,6 +6034,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
6007
6034
|
* Returns a frame info object representing the window that the referenced iframe is
|
6008
6035
|
* currently embedded in.
|
6009
6036
|
*
|
6037
|
+
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
6038
|
+
*
|
6010
6039
|
* @example
|
6011
6040
|
* ```js
|
6012
6041
|
* async function getParentWindow() {
|
@@ -6858,6 +6887,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
6858
6887
|
metadata?: MetadataType;
|
6859
6888
|
};
|
6860
6889
|
|
6890
|
+
declare type InheritableOptions = {
|
6891
|
+
customContext: boolean;
|
6892
|
+
customData: boolean;
|
6893
|
+
icon: boolean;
|
6894
|
+
preloadScripts: boolean;
|
6895
|
+
};
|
6896
|
+
|
6861
6897
|
/**
|
6862
6898
|
* Generated when an application has initialized.
|
6863
6899
|
* @interface
|
@@ -8484,6 +8520,7 @@ declare type LaunchExternalProcessRule = {
|
|
8484
8520
|
*/
|
8485
8521
|
declare type LaunchIntoPlatformPayload = {
|
8486
8522
|
manifest: any;
|
8523
|
+
manifestUrl?: string;
|
8487
8524
|
};
|
8488
8525
|
|
8489
8526
|
/**
|
@@ -9837,7 +9874,7 @@ declare type MutableViewOptions = {
|
|
9837
9874
|
/**
|
9838
9875
|
* Configurations for API injection.
|
9839
9876
|
*/
|
9840
|
-
api:
|
9877
|
+
api: ApiSettings;
|
9841
9878
|
/**
|
9842
9879
|
* Restrict navigation to URLs that match an allowed pattern.
|
9843
9880
|
* In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
|
@@ -10312,6 +10349,7 @@ declare namespace OpenFin {
|
|
10312
10349
|
WindowState,
|
10313
10350
|
AutoplayPolicyOptions,
|
10314
10351
|
ConstWindowOptions,
|
10352
|
+
InheritableOptions,
|
10315
10353
|
MutableWindowOptions,
|
10316
10354
|
WorkspacePlatformOptions,
|
10317
10355
|
WebRequestHeader,
|
@@ -10320,6 +10358,7 @@ declare namespace OpenFin {
|
|
10320
10358
|
ResizeRegion,
|
10321
10359
|
Accelerator,
|
10322
10360
|
Api,
|
10361
|
+
ApiSettings,
|
10323
10362
|
InjectionType,
|
10324
10363
|
NavigationRules,
|
10325
10364
|
ContentNavigation,
|
@@ -10471,7 +10510,9 @@ declare namespace OpenFin {
|
|
10471
10510
|
DefaultDomainSettingsRule,
|
10472
10511
|
DomainSettings,
|
10473
10512
|
ApiInjection,
|
10513
|
+
DomainApiSettings,
|
10474
10514
|
DomainSettingsRule,
|
10515
|
+
FileDownloadBehavior,
|
10475
10516
|
FileDownloadBehaviorNames,
|
10476
10517
|
FileDownloadSettings,
|
10477
10518
|
DownloadRule,
|
@@ -10479,6 +10520,7 @@ declare namespace OpenFin {
|
|
10479
10520
|
Intent_2 as Intent,
|
10480
10521
|
IntentMetadata_3 as IntentMetadata,
|
10481
10522
|
IntentHandler_2 as IntentHandler,
|
10523
|
+
ContentCreationBehavior,
|
10482
10524
|
ContentCreationBehaviorNames,
|
10483
10525
|
MatchPattern,
|
10484
10526
|
BaseContentCreationRule,
|
@@ -11581,6 +11623,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
|
|
11581
11623
|
* The provider url.
|
11582
11624
|
*/
|
11583
11625
|
providerUrl?: string;
|
11626
|
+
/**
|
11627
|
+
* @defaultValue true
|
11628
|
+
*
|
11629
|
+
* Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
|
11630
|
+
*
|
11631
|
+
* NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
|
11632
|
+
*/
|
11633
|
+
allowLaunchIntoPlatform?: boolean;
|
11584
11634
|
};
|
11585
11635
|
|
11586
11636
|
/**
|
@@ -12385,7 +12435,7 @@ declare type PreloadScriptInfoRunning = {
|
|
12385
12435
|
* @interface
|
12386
12436
|
*/
|
12387
12437
|
declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
|
12388
|
-
type: 'preload-
|
12438
|
+
type: 'preload-scripts-state-changed';
|
12389
12439
|
};
|
12390
12440
|
|
12391
12441
|
/**
|
@@ -12402,7 +12452,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
|
|
12402
12452
|
* @interface
|
12403
12453
|
*/
|
12404
12454
|
declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
|
12405
|
-
type: 'preload-
|
12455
|
+
type: 'preload-scripts-state-changing';
|
12406
12456
|
};
|
12407
12457
|
|
12408
12458
|
declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
|
package/out/node-adapter.js
CHANGED
@@ -10224,6 +10224,8 @@ class _Frame extends base_1$a.EmitterBase {
|
|
10224
10224
|
* Returns a frame info object representing the window that the referenced iframe is
|
10225
10225
|
* currently embedded in.
|
10226
10226
|
*
|
10227
|
+
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
10228
|
+
*
|
10227
10229
|
* @example
|
10228
10230
|
* ```js
|
10229
10231
|
* async function getParentWindow() {
|
@@ -11152,12 +11154,12 @@ class Platform extends base_1$7.EmitterBase {
|
|
11152
11154
|
* @experimental
|
11153
11155
|
*/
|
11154
11156
|
async launchContentManifest(manifestUrl) {
|
11155
|
-
this.wire.sendAction('platform-launch-content-manifest', this.identity).catch((
|
11157
|
+
this.wire.sendAction('platform-launch-content-manifest', this.identity).catch(() => {
|
11156
11158
|
// don't expose
|
11157
11159
|
});
|
11158
11160
|
const client = await this.getClient();
|
11159
11161
|
const manifest = await this.fetchManifest(manifestUrl);
|
11160
|
-
client.dispatch('launch-into-platform', { manifest });
|
11162
|
+
client.dispatch('launch-into-platform', { manifest, manifestUrl });
|
11161
11163
|
return this;
|
11162
11164
|
}
|
11163
11165
|
/**
|
@@ -11822,7 +11824,7 @@ class LayoutModule extends base_1$5.Base {
|
|
11822
11824
|
return this.wrapSync(this.fin.me.identity);
|
11823
11825
|
};
|
11824
11826
|
_LayoutModule_getLayoutManagerSpy.set(this, (layoutIdentity, layoutManager) => {
|
11825
|
-
const msg = '[Layout] You are using a deprecated property `layoutManager` - it will
|
11827
|
+
const msg = '[Layout] You are using a deprecated property `layoutManager` - it will throw if you access it starting in v37.';
|
11826
11828
|
const managerProxy = new Proxy(layoutManager, {
|
11827
11829
|
get(target, key) {
|
11828
11830
|
console.warn(`[Layout-mgr-proxy] accessing ${key.toString()}`);
|