@openfin/core 33.77.7 → 33.77.8
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/mock-alpha.d.ts +2160 -591
- package/out/mock-beta.d.ts +2160 -591
- package/out/mock-public.d.ts +2160 -591
- package/out/mock.d.ts +2162 -575
- package/out/mock.js +811 -327
- package/package.json +1 -1
package/out/mock.js
CHANGED
|
@@ -10,7 +10,251 @@ var mock = {};
|
|
|
10
10
|
|
|
11
11
|
var OpenFin$1 = {};
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
var events$1 = {};
|
|
14
|
+
|
|
15
|
+
var application$1 = {};
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Namespace for events that can be emitted by an {@link OpenFin.Application}. Includes events
|
|
19
|
+
* re-propagated from the {@link OpenFin.Window} (and, transitively, {@link OpenFin.View}) level, prefixed with `window-` (and also, if applicable, `view-`).
|
|
20
|
+
* For example, a view's "attached" event will fire as 'window-view-attached' at the application level.
|
|
21
|
+
*
|
|
22
|
+
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
|
23
|
+
*
|
|
24
|
+
* This namespace contains only payload shapes for events that are unique to `Application`. Events that propagate to `Application` from
|
|
25
|
+
* child {@link OpenFin.Window windows} and {@link OpenFin.View views} are defined in the {@link OpenFin.WindowEvents} and
|
|
26
|
+
* {@link OpenFin.ViewEvents} namespaces. For a list of valid string keys for *all* application events, see {@link Application.on Application.on}.
|
|
27
|
+
*
|
|
28
|
+
* {@link ApplicationSourcedEvent Application-sourced events} (i.e. those that have not propagated from {@link OpenFin.ViewEvents Views}
|
|
29
|
+
* or {@link OpenFin.WindowEvents Windows} re-propagate to {@link OpenFin.SystemEvents System} with their type string prefixed with `application-`.
|
|
30
|
+
* {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
|
31
|
+
* are propagated to `System` without any type string prefixing.
|
|
32
|
+
*
|
|
33
|
+
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
|
34
|
+
*
|
|
35
|
+
* @packageDocumentation
|
|
36
|
+
*/
|
|
37
|
+
Object.defineProperty(application$1, "__esModule", { value: true });
|
|
38
|
+
|
|
39
|
+
var base$1 = {};
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* Namespace for shared event payloads and utility types common to all event emitters.
|
|
43
|
+
*
|
|
44
|
+
* @packageDocumentation
|
|
45
|
+
*/
|
|
46
|
+
Object.defineProperty(base$1, "__esModule", { value: true });
|
|
47
|
+
|
|
48
|
+
var externalApplication$1 = {};
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Namespace for events that can be transmitted by an {@link OpenFin.ExternalApplication}.
|
|
52
|
+
*
|
|
53
|
+
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
|
54
|
+
*
|
|
55
|
+
* For a list of valid string keys for external application events, see {@link ExternalApplication.on ExternalApplication.on}.
|
|
56
|
+
*
|
|
57
|
+
* @packageDocumentation
|
|
58
|
+
*/
|
|
59
|
+
Object.defineProperty(externalApplication$1, "__esModule", { value: true });
|
|
60
|
+
|
|
61
|
+
var frame$1 = {};
|
|
62
|
+
|
|
63
|
+
Object.defineProperty(frame$1, "__esModule", { value: true });
|
|
64
|
+
|
|
65
|
+
var globalHotkey$1 = {};
|
|
66
|
+
|
|
67
|
+
Object.defineProperty(globalHotkey$1, "__esModule", { value: true });
|
|
68
|
+
|
|
69
|
+
var platform$1 = {};
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* Namespace for events that can emitted by a {@link OpenFin.Platform}.
|
|
74
|
+
*
|
|
75
|
+
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
|
76
|
+
*
|
|
77
|
+
* The Platform `EventEmitter` is a superset of the {@link OpenFin.Application} `EventEmitter`,
|
|
78
|
+
* meaning it can listen to all {@link OpenFin.ApplicationEvents Application events} in addition to the
|
|
79
|
+
* Platform-specific events listed here. For a list of valid string keys for *all* platform events, see
|
|
80
|
+
* {@link Platform.on Platform.on}.
|
|
81
|
+
*
|
|
82
|
+
* @packageDocumentation
|
|
83
|
+
*/
|
|
84
|
+
Object.defineProperty(platform$1, "__esModule", { value: true });
|
|
85
|
+
|
|
86
|
+
var system$1 = {};
|
|
87
|
+
|
|
88
|
+
/**
|
|
89
|
+
* Namespace for runtime-wide OpenFin events emitted by {@link System.System}. Includes events
|
|
90
|
+
* re-propagated from {@link OpenFin.Application}, {@link OpenFin.Window}, and {@link OpenFin.View} (prefixed with `application-`, `window-`, and `view-`). All
|
|
91
|
+
* event propagations are visible at the System level. Propagated events from WebContents (windows, views, frames) to the Application level will *not*
|
|
92
|
+
* transitively re-propagate to the System level, because they are already visible at the system level and contain the identity
|
|
93
|
+
* of the application. For example, an application's "closed" event will fire as 'application-closed' at the system level. A view's 'shown' event
|
|
94
|
+
* will be visible as 'view-shown' at the system level, but *not* as `application-window-view-shown`.
|
|
95
|
+
*
|
|
96
|
+
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
|
97
|
+
*
|
|
98
|
+
* This namespace contains only payload shapes for events that are unique to `System`. Events that propagate to `System` from
|
|
99
|
+
* child {@link OpenFin.Application applications}, {@link OpenFin.Window windows}, and {@link OpenFin.View views} are defined in the
|
|
100
|
+
* {@link OpenFin.ApplicationEvents}, {@link OpenFin.WindowEvents}, and {@link OpenFin.ViewEvents} namespaces. For a list of valid string keys for *all*
|
|
101
|
+
* system events, see {@link System.on System.on}.
|
|
102
|
+
*
|
|
103
|
+
* @packageDocumentation
|
|
104
|
+
*/
|
|
105
|
+
Object.defineProperty(system$1, "__esModule", { value: true });
|
|
106
|
+
|
|
107
|
+
var view$1 = {};
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* Namespace for events that can be emitted by a {@link OpenFin.View}.
|
|
111
|
+
*
|
|
112
|
+
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
|
113
|
+
*
|
|
114
|
+
* This namespace contains only payload shapes for events that are unique to `View`. Events that are shared between all `WebContents`
|
|
115
|
+
* (i.e. {@link OpenFin.Window}, {@link OpenFin.View}) are defined in {@link OpenFin.WebContentsEvents}. For a list
|
|
116
|
+
* of valid string keys for *all* View events, see {@link View.on View.on}.
|
|
117
|
+
*
|
|
118
|
+
* View events propagate to their parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
|
|
119
|
+
* and {@link OpenFin.SystemEvents System} with an added `viewIdentity` property and their event types prefixed with `'view-'`.
|
|
120
|
+
*
|
|
121
|
+
* @packageDocumentation
|
|
122
|
+
*/
|
|
123
|
+
Object.defineProperty(view$1, "__esModule", { value: true });
|
|
124
|
+
|
|
125
|
+
var webcontents = {};
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* Namespace for events shared by all OpenFin WebContents elements (i.e. {@link OpenFin.Window},
|
|
129
|
+
* {@link OpenFin.View}).
|
|
130
|
+
*
|
|
131
|
+
* WebContents events are divided into two groups: {@link WillPropagateWebContentsEvent} and {@link NonPropagatedWebContentsEvent}. Propagating events
|
|
132
|
+
* will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
|
|
133
|
+
* parent window, and propagating events in a window will also be emitted on the window's parent {@link OpenFin.Application}.
|
|
134
|
+
*
|
|
135
|
+
* Non-propagating events will not re-emit on parent entities.
|
|
136
|
+
*
|
|
137
|
+
* @packageDocumentation
|
|
138
|
+
*/
|
|
139
|
+
Object.defineProperty(webcontents, "__esModule", { value: true });
|
|
140
|
+
|
|
141
|
+
var window$2 = {};
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* Namespace for events that can be emitted by a {@link OpenFin.Window}.
|
|
145
|
+
*
|
|
146
|
+
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
|
147
|
+
*
|
|
148
|
+
* This namespace contains only payload shapes for events that are unique to `Window`. Events that are shared between all `WebContents`
|
|
149
|
+
* (i.e. {@link OpenFin.Window}, {@link OpenFin.View}) are defined in {@link OpenFin.WebContentsEvents}. Events that
|
|
150
|
+
* propagate from `View` are defined in {@link OpenFin.ViewEvents}. For a list of valid string keys for *all* Window events, see
|
|
151
|
+
* {@link Window.on Window.on}
|
|
152
|
+
*
|
|
153
|
+
* {@link OpenFin.WindowEvents.WindowSourcedEvent Window-sourced events} (i.e. those that are not propagated from a
|
|
154
|
+
* {@link OpenFin.ViewEvents View}) propagate to their parent {@link OpenFin.ApplicationEvents Application} and
|
|
155
|
+
* {@link OpenFin.SystemEvents System} with their event types prefixed with `'window-'`).
|
|
156
|
+
*
|
|
157
|
+
* "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System. The {@link OpenFin.WindowEvents.WindowCloseRequestedEvent}
|
|
158
|
+
* does not propagate at all.
|
|
159
|
+
*
|
|
160
|
+
* @packageDocumentation
|
|
161
|
+
*/
|
|
162
|
+
Object.defineProperty(window$2, "__esModule", { value: true });
|
|
163
|
+
|
|
164
|
+
/**
|
|
165
|
+
* Namespace for OpenFin event types. Each entity that emits OpenFin events has its own sub-namespace. Event payloads
|
|
166
|
+
* themselves are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
|
167
|
+
*
|
|
168
|
+
* #### Event emitters
|
|
169
|
+
*
|
|
170
|
+
* The following entities emit OpenFin events, and have corresponding sub-namespaces:
|
|
171
|
+
*
|
|
172
|
+
* * {@link OpenFin.Application}: {@link OpenFin.ApplicationEvents}
|
|
173
|
+
* * {@link OpenFin.ExternalApplication}: {@link OpenFin.ExternalApplicationEvents}
|
|
174
|
+
* * {@link OpenFin.Frame}: {@link OpenFin.FrameEvents}
|
|
175
|
+
* * {@link OpenFin.GlobalHotkey}: {@link OpenFin.GlobalHotkeyEvents}
|
|
176
|
+
* * {@link OpenFin.Platform}: {@link OpenFin.PlatformEvents}
|
|
177
|
+
* * {@link OpenFin.System}: {@link OpenFin.SystemEvents}
|
|
178
|
+
* * {@link OpenFin.View}: {@link OpenFin.ViewEvents}
|
|
179
|
+
* * {@link OpenFin.Window}: {@link OpenFin.WindowEvents}
|
|
180
|
+
*
|
|
181
|
+
* These `EventEmitter` entities share a common set of methods for interacting with the OpenFin event bus, which can be
|
|
182
|
+
* seen on the individual documentation pages for each entity type.
|
|
183
|
+
*
|
|
184
|
+
* Registering event handlers is an asynchronous operation. It is important to ensure that the returned Promises are awaited to reduce the
|
|
185
|
+
* risk of race conditions.
|
|
186
|
+
*
|
|
187
|
+
* When the `EventEmitter` receives an event from the browser process and emits on the renderer, all of the functions attached to that
|
|
188
|
+
* specific event are called synchronously. Any values returned by the called listeners are ignored and will be discarded. If the window document
|
|
189
|
+
* is destroyed by page navigation or reload, its registered event listeners will be removed.
|
|
190
|
+
*
|
|
191
|
+
* We recommend using Arrow Functions for event listeners to ensure the this scope is consistent with the original function context.
|
|
192
|
+
*
|
|
193
|
+
* Events re-propagate from smaller/more-local scopes to larger/more-global scopes. For example, an event emitted on a specific
|
|
194
|
+
* view will propagate to the window in which the view is embedded, and then to the application in which the window is running, and
|
|
195
|
+
* finally to the OpenFin runtime itself at the "system" level. For details on propagation semantics, see the namespace for
|
|
196
|
+
* the propagating (or propagated-to) entity.
|
|
197
|
+
*
|
|
198
|
+
* If you need the payload type for a specific type of event (especially propagated events), use the emitting topic's `Payload` generic
|
|
199
|
+
* (e.g. {@link WindowEvents.Payload}) with the event's `type` string. For example, the payload of
|
|
200
|
+
* a {@link ViewEvents.CreatedEvent} after it has propagated to its parent {@link WindowEvents Window} can be found with
|
|
201
|
+
* `WindowEvents.Payload<'view-created'>`.
|
|
202
|
+
*
|
|
203
|
+
* @packageDocumentation
|
|
204
|
+
*/
|
|
205
|
+
Object.defineProperty(events$1, "__esModule", { value: true });
|
|
206
|
+
events$1.WindowEvents = events$1.WebContentsEvents = events$1.ViewEvents = events$1.SystemEvents = events$1.PlatformEvents = events$1.GlobalHotkeyEvents = events$1.FrameEvents = events$1.ExternalApplicationEvents = events$1.BaseEvents = events$1.ApplicationEvents = void 0;
|
|
207
|
+
const ApplicationEvents = application$1;
|
|
208
|
+
events$1.ApplicationEvents = ApplicationEvents;
|
|
209
|
+
const BaseEvents = base$1;
|
|
210
|
+
events$1.BaseEvents = BaseEvents;
|
|
211
|
+
const ExternalApplicationEvents = externalApplication$1;
|
|
212
|
+
events$1.ExternalApplicationEvents = ExternalApplicationEvents;
|
|
213
|
+
const FrameEvents = frame$1;
|
|
214
|
+
events$1.FrameEvents = FrameEvents;
|
|
215
|
+
const GlobalHotkeyEvents = globalHotkey$1;
|
|
216
|
+
events$1.GlobalHotkeyEvents = GlobalHotkeyEvents;
|
|
217
|
+
const PlatformEvents = platform$1;
|
|
218
|
+
events$1.PlatformEvents = PlatformEvents;
|
|
219
|
+
const SystemEvents = system$1;
|
|
220
|
+
events$1.SystemEvents = SystemEvents;
|
|
221
|
+
const ViewEvents = view$1;
|
|
222
|
+
events$1.ViewEvents = ViewEvents;
|
|
223
|
+
const WebContentsEvents = webcontents;
|
|
224
|
+
events$1.WebContentsEvents = WebContentsEvents;
|
|
225
|
+
const WindowEvents = window$2;
|
|
226
|
+
events$1.WindowEvents = WindowEvents;
|
|
227
|
+
|
|
228
|
+
(function (exports) {
|
|
229
|
+
/**
|
|
230
|
+
* Top-level namespace for types referenced by the OpenFin API. Contains:
|
|
231
|
+
*
|
|
232
|
+
* * The type of the global `fin` entry point ({@link FinApi})
|
|
233
|
+
* * Classes that act as static namespaces returned from the `fin` global (e.g. {@link ApplicationModule}, accessible via `fin.Application`)
|
|
234
|
+
* * Instance classes that are returned from API calls (e.g. {@link Application}, accessible via `fin.Application.getCurrentSync()`)
|
|
235
|
+
* * Parameter shapes for API methods (e.g. {@link ApplicationOptions}, used in `fin.Application.start()`)
|
|
236
|
+
* * Event namespaces and payload union types (e.g. {@link ApplicationEvents} and {@link ApplicationEvent})
|
|
237
|
+
*
|
|
238
|
+
* @packageDocumentation
|
|
239
|
+
*/
|
|
240
|
+
var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
241
|
+
if (k2 === undefined) k2 = k;
|
|
242
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
243
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
244
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
245
|
+
}
|
|
246
|
+
Object.defineProperty(o, k2, desc);
|
|
247
|
+
}) : (function(o, m, k, k2) {
|
|
248
|
+
if (k2 === undefined) k2 = k;
|
|
249
|
+
o[k2] = m[k];
|
|
250
|
+
}));
|
|
251
|
+
var __exportStar = (commonjsGlobal && commonjsGlobal.__exportStar) || function(m, exports) {
|
|
252
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
253
|
+
};
|
|
254
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
255
|
+
// Deprecated shim to preserve v30 namespace names
|
|
256
|
+
__exportStar(events$1, exports);
|
|
257
|
+
} (OpenFin$1));
|
|
14
258
|
|
|
15
259
|
var fin = {};
|
|
16
260
|
|
|
@@ -561,6 +805,13 @@ class Base {
|
|
|
561
805
|
get fin() {
|
|
562
806
|
return this.wire.getFin();
|
|
563
807
|
}
|
|
808
|
+
/**
|
|
809
|
+
* Provides access to the OpenFin representation of the current code context (usually a document
|
|
810
|
+
* such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
|
|
811
|
+
*
|
|
812
|
+
* Useful for debugging in the devtools console, where this will intelligently type itself based
|
|
813
|
+
* on the context in which the devtools panel was opened.
|
|
814
|
+
*/
|
|
564
815
|
get me() {
|
|
565
816
|
return this.wire.me;
|
|
566
817
|
}
|
|
@@ -595,6 +846,9 @@ class EmitterBase extends Base {
|
|
|
595
846
|
this.topic = topic;
|
|
596
847
|
_EmitterBase_emitterAccessor.set(this, void 0);
|
|
597
848
|
this.eventNames = () => (this.hasEmitter() ? this.getOrCreateEmitter().eventNames() : []);
|
|
849
|
+
/**
|
|
850
|
+
* @internal
|
|
851
|
+
*/
|
|
598
852
|
this.emit = (eventType, payload, ...args) => {
|
|
599
853
|
return this.hasEmitter() ? this.getOrCreateEmitter().emit(eventType, payload, ...args) : false;
|
|
600
854
|
};
|
|
@@ -637,16 +891,13 @@ class EmitterBase extends Base {
|
|
|
637
891
|
// This will only be reached if unsubscribe from event that does not exist but do not want to error here
|
|
638
892
|
return Promise.resolve();
|
|
639
893
|
};
|
|
640
|
-
this.addListener = this.on;
|
|
641
894
|
__classPrivateFieldSet$d(this, _EmitterBase_emitterAccessor, [topic, ...additionalAccessors], "f");
|
|
642
895
|
this.listeners = (event) => this.hasEmitter() ? this.getOrCreateEmitter().listeners(event) : [];
|
|
643
896
|
}
|
|
644
897
|
/**
|
|
645
898
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
646
899
|
*
|
|
647
|
-
* @
|
|
648
|
-
* @param listener
|
|
649
|
-
* @param options
|
|
900
|
+
* @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
|
|
650
901
|
*/
|
|
651
902
|
async on(eventType, listener, options) {
|
|
652
903
|
await this.registerEventListener(eventType, options, (emitter) => {
|
|
@@ -656,12 +907,16 @@ class EmitterBase extends Base {
|
|
|
656
907
|
});
|
|
657
908
|
return this;
|
|
658
909
|
}
|
|
910
|
+
/**
|
|
911
|
+
* Adds a listener to the end of the listeners array for the specified event.
|
|
912
|
+
*/
|
|
913
|
+
async addListener(eventType, listener, options) {
|
|
914
|
+
return this.on(eventType, listener, options);
|
|
915
|
+
}
|
|
659
916
|
/**
|
|
660
917
|
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
|
661
918
|
*
|
|
662
|
-
* @
|
|
663
|
-
* @param listener
|
|
664
|
-
* @param options
|
|
919
|
+
* @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
|
|
665
920
|
*/
|
|
666
921
|
async once(eventType, listener, options) {
|
|
667
922
|
const deregister = () => this.deregisterEventListener(eventType);
|
|
@@ -677,9 +932,7 @@ class EmitterBase extends Base {
|
|
|
677
932
|
/**
|
|
678
933
|
* Adds a listener to the beginning of the listeners array for the specified event.
|
|
679
934
|
*
|
|
680
|
-
* @
|
|
681
|
-
* @param listener
|
|
682
|
-
* @param options
|
|
935
|
+
* @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
|
|
683
936
|
*/
|
|
684
937
|
async prependListener(eventType, listener, options) {
|
|
685
938
|
await this.registerEventListener(eventType, options, (emitter) => {
|
|
@@ -693,9 +946,7 @@ class EmitterBase extends Base {
|
|
|
693
946
|
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired,
|
|
694
947
|
* after which it is removed. The listener is added to the beginning of the listeners array.
|
|
695
948
|
*
|
|
696
|
-
* @
|
|
697
|
-
* @param listener
|
|
698
|
-
* @param options
|
|
949
|
+
* @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
|
|
699
950
|
*/
|
|
700
951
|
async prependOnceListener(eventType, listener, options) {
|
|
701
952
|
const deregister = () => this.deregisterEventListener(eventType);
|
|
@@ -712,10 +963,6 @@ class EmitterBase extends Base {
|
|
|
712
963
|
* Remove a listener from the listener array for the specified event.
|
|
713
964
|
*
|
|
714
965
|
* @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
715
|
-
*
|
|
716
|
-
* @param eventType
|
|
717
|
-
* @param listener
|
|
718
|
-
* @param options
|
|
719
966
|
*/
|
|
720
967
|
async removeListener(eventType, listener, options) {
|
|
721
968
|
const emitter = await this.deregisterEventListener(eventType, options);
|
|
@@ -742,7 +989,6 @@ class EmitterBase extends Base {
|
|
|
742
989
|
/**
|
|
743
990
|
* Removes all listeners, or those of the specified event.
|
|
744
991
|
*
|
|
745
|
-
* @param eventType
|
|
746
992
|
*/
|
|
747
993
|
async removeAllListeners(eventType) {
|
|
748
994
|
const removeByEvent = async (event) => {
|
|
@@ -883,15 +1129,35 @@ var view = {};
|
|
|
883
1129
|
|
|
884
1130
|
var Factory$6 = {};
|
|
885
1131
|
|
|
1132
|
+
var warnings = {};
|
|
1133
|
+
|
|
1134
|
+
Object.defineProperty(warnings, "__esModule", { value: true });
|
|
1135
|
+
warnings.handleDeprecatedWarnings = void 0;
|
|
1136
|
+
const handleDeprecatedWarnings = (options) => {
|
|
1137
|
+
var _a, _b, _c, _d;
|
|
1138
|
+
if (((_a = options.contentNavigation) === null || _a === void 0 ? void 0 : _a.whitelist) ||
|
|
1139
|
+
((_b = options.contentNavigation) === null || _b === void 0 ? void 0 : _b.blacklist) ||
|
|
1140
|
+
((_c = options.contentRedirect) === null || _c === void 0 ? void 0 : _c.whitelist) ||
|
|
1141
|
+
((_d = options.contentRedirect) === null || _d === void 0 ? void 0 : _d.blacklist)) {
|
|
1142
|
+
console.warn(`The properties 'whitelist' and 'blacklist' have been marked as deprecated and will be removed in a future version. Please use 'allowlist' and 'denylist'.`);
|
|
1143
|
+
}
|
|
1144
|
+
};
|
|
1145
|
+
warnings.handleDeprecatedWarnings = handleDeprecatedWarnings;
|
|
1146
|
+
|
|
886
1147
|
var hasRequiredFactory$3;
|
|
887
1148
|
|
|
888
1149
|
function requireFactory$3 () {
|
|
889
1150
|
if (hasRequiredFactory$3) return Factory$6;
|
|
890
1151
|
hasRequiredFactory$3 = 1;
|
|
891
1152
|
Object.defineProperty(Factory$6, "__esModule", { value: true });
|
|
1153
|
+
Factory$6.ViewModule = void 0;
|
|
892
1154
|
const base_1 = base;
|
|
893
1155
|
const validate_1 = validate;
|
|
894
1156
|
const index_1 = requireView();
|
|
1157
|
+
const warnings_1 = warnings;
|
|
1158
|
+
/**
|
|
1159
|
+
* Static namespace for OpenFin API methods that interact with the {@link View} class, available under `fin.View`.
|
|
1160
|
+
*/
|
|
895
1161
|
class ViewModule extends base_1.Base {
|
|
896
1162
|
/**
|
|
897
1163
|
* Creates a new View.
|
|
@@ -920,13 +1186,13 @@ function requireFactory$3 () {
|
|
|
920
1186
|
* ```
|
|
921
1187
|
* Note that created views needs to navigate somewhere for them to actually render a website.
|
|
922
1188
|
* @experimental
|
|
923
|
-
* @static
|
|
924
1189
|
*/
|
|
925
1190
|
async create(options) {
|
|
926
1191
|
const { uuid } = this.wire.me;
|
|
927
1192
|
if (!options.name || typeof options.name !== 'string') {
|
|
928
1193
|
throw new Error('Please provide a name property as a string in order to create a View.');
|
|
929
1194
|
}
|
|
1195
|
+
(0, warnings_1.handleDeprecatedWarnings)(options);
|
|
930
1196
|
if (this.wire.environment.childViews) {
|
|
931
1197
|
await this.wire.environment.createChildContent({
|
|
932
1198
|
entityType: 'view',
|
|
@@ -940,7 +1206,6 @@ function requireFactory$3 () {
|
|
|
940
1206
|
}
|
|
941
1207
|
/**
|
|
942
1208
|
* Asynchronously returns a View object that represents an existing view.
|
|
943
|
-
* @param identity
|
|
944
1209
|
*
|
|
945
1210
|
* @example
|
|
946
1211
|
* ```js
|
|
@@ -949,7 +1214,6 @@ function requireFactory$3 () {
|
|
|
949
1214
|
* .catch(err => console.log(err));
|
|
950
1215
|
* ```
|
|
951
1216
|
* @experimental
|
|
952
|
-
* @static
|
|
953
1217
|
*/
|
|
954
1218
|
async wrap(identity) {
|
|
955
1219
|
this.wire.sendAction('view-wrap');
|
|
@@ -961,7 +1225,6 @@ function requireFactory$3 () {
|
|
|
961
1225
|
}
|
|
962
1226
|
/**
|
|
963
1227
|
* Synchronously returns a View object that represents an existing view.
|
|
964
|
-
* @param identity
|
|
965
1228
|
*
|
|
966
1229
|
* @example
|
|
967
1230
|
* ```js
|
|
@@ -969,7 +1232,6 @@ function requireFactory$3 () {
|
|
|
969
1232
|
* await view.hide();
|
|
970
1233
|
* ```
|
|
971
1234
|
* @experimental
|
|
972
|
-
* @static
|
|
973
1235
|
*/
|
|
974
1236
|
wrapSync(identity) {
|
|
975
1237
|
this.wire.sendAction('view-wrap-sync').catch((e) => {
|
|
@@ -992,7 +1254,6 @@ function requireFactory$3 () {
|
|
|
992
1254
|
*
|
|
993
1255
|
* ```
|
|
994
1256
|
* @experimental
|
|
995
|
-
* @static
|
|
996
1257
|
*/
|
|
997
1258
|
getCurrent() {
|
|
998
1259
|
this.wire.sendAction('view-get-current').catch((e) => {
|
|
@@ -1014,7 +1275,6 @@ function requireFactory$3 () {
|
|
|
1014
1275
|
*
|
|
1015
1276
|
* ```
|
|
1016
1277
|
* @experimental
|
|
1017
|
-
* @static
|
|
1018
1278
|
*/
|
|
1019
1279
|
getCurrentSync() {
|
|
1020
1280
|
this.wire.sendAction('view-get-current-sync').catch((e) => {
|
|
@@ -1027,7 +1287,7 @@ function requireFactory$3 () {
|
|
|
1027
1287
|
return this.wrapSync({ uuid, name });
|
|
1028
1288
|
}
|
|
1029
1289
|
}
|
|
1030
|
-
Factory$6.
|
|
1290
|
+
Factory$6.ViewModule = ViewModule;
|
|
1031
1291
|
return Factory$6;
|
|
1032
1292
|
}
|
|
1033
1293
|
|
|
@@ -1859,6 +2119,10 @@ Object.defineProperty(main, "__esModule", { value: true });
|
|
|
1859
2119
|
main.WebContents = void 0;
|
|
1860
2120
|
const base_1$k = base;
|
|
1861
2121
|
class WebContents extends base_1$k.EmitterBase {
|
|
2122
|
+
/**
|
|
2123
|
+
* @param identity The identity of the {@link OpenFin.WebContentsEvents WebContents}.
|
|
2124
|
+
* @param entityType The type of the {@link OpenFin.WebContentsEvents WebContents}.
|
|
2125
|
+
*/
|
|
1862
2126
|
constructor(wire, identity, entityType) {
|
|
1863
2127
|
super(wire, entityType, identity.uuid, identity.name);
|
|
1864
2128
|
this.identity = identity;
|
|
@@ -1866,10 +2130,7 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
1866
2130
|
}
|
|
1867
2131
|
/**
|
|
1868
2132
|
* Gets a base64 encoded image of all or part of the WebContents.
|
|
1869
|
-
* @function capturePage
|
|
1870
2133
|
* @param options Options for the capturePage call.
|
|
1871
|
-
* @memberOf View
|
|
1872
|
-
* @instance
|
|
1873
2134
|
*
|
|
1874
2135
|
* @example
|
|
1875
2136
|
*
|
|
@@ -1914,6 +2175,11 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
1914
2175
|
* }
|
|
1915
2176
|
* console.log(await wnd.capturePage(options));
|
|
1916
2177
|
* ```
|
|
2178
|
+
*
|
|
2179
|
+
* @remarks
|
|
2180
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2181
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2182
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
1917
2183
|
*/
|
|
1918
2184
|
capturePage(options) {
|
|
1919
2185
|
return this.wire.sendAction('capture-page', { options, ...this.identity }).then(({ payload }) => payload.data);
|
|
@@ -1922,9 +2188,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
1922
2188
|
* Executes Javascript on the WebContents, restricted to contents you own or contents owned by
|
|
1923
2189
|
* applications you have created.
|
|
1924
2190
|
* @param code JavaScript code to be executed on the view.
|
|
1925
|
-
* @function executeJavaScript
|
|
1926
|
-
* @memberOf View
|
|
1927
|
-
* @instance
|
|
1928
2191
|
*
|
|
1929
2192
|
* @example
|
|
1930
2193
|
* View:
|
|
@@ -1952,6 +2215,10 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
1952
2215
|
*
|
|
1953
2216
|
* executeJavaScript(`console.log('Hello, Openfin')`).then(() => console.log('Javascript excuted')).catch(err => console.log(err));
|
|
1954
2217
|
* ```
|
|
2218
|
+
* @remarks
|
|
2219
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2220
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2221
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
1955
2222
|
*/
|
|
1956
2223
|
executeJavaScript(code) {
|
|
1957
2224
|
return this.wire
|
|
@@ -1960,9 +2227,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
1960
2227
|
}
|
|
1961
2228
|
/**
|
|
1962
2229
|
* Returns the zoom level of the WebContents.
|
|
1963
|
-
* @function getZoomLevel
|
|
1964
|
-
* @memberOf View
|
|
1965
|
-
* @instance
|
|
1966
2230
|
*
|
|
1967
2231
|
* @example
|
|
1968
2232
|
* View:
|
|
@@ -1994,6 +2258,10 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
1994
2258
|
*
|
|
1995
2259
|
* getZoomLevel().then(zoomLevel => console.log(zoomLevel)).catch(err => console.log(err));
|
|
1996
2260
|
* ```
|
|
2261
|
+
* @remarks
|
|
2262
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2263
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2264
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
1997
2265
|
*/
|
|
1998
2266
|
getZoomLevel() {
|
|
1999
2267
|
return this.wire.sendAction('get-zoom-level', this.identity).then(({ payload }) => payload.data);
|
|
@@ -2001,9 +2269,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2001
2269
|
/**
|
|
2002
2270
|
* Sets the zoom level of the WebContents.
|
|
2003
2271
|
* @param level The zoom level
|
|
2004
|
-
* @function setZoomLevel
|
|
2005
|
-
* @memberOf View
|
|
2006
|
-
* @instance
|
|
2007
2272
|
*
|
|
2008
2273
|
* @example
|
|
2009
2274
|
* View:
|
|
@@ -2035,6 +2300,10 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2035
2300
|
*
|
|
2036
2301
|
* setZoomLevel(4).then(() => console.log('Setting a zoom level')).catch(err => console.log(err));
|
|
2037
2302
|
* ```
|
|
2303
|
+
* @remarks
|
|
2304
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2305
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2306
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2038
2307
|
*/
|
|
2039
2308
|
setZoomLevel(level) {
|
|
2040
2309
|
return this.wire.sendAction('set-zoom-level', { ...this.identity, level }).then(() => undefined);
|
|
@@ -2042,12 +2311,9 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2042
2311
|
/**
|
|
2043
2312
|
* Navigates the WebContents to a specified URL.
|
|
2044
2313
|
*
|
|
2045
|
-
*
|
|
2314
|
+
* Note: The url must contain the protocol prefix such as http:// or https://.
|
|
2046
2315
|
* @param url - The URL to navigate the WebContents to.
|
|
2047
2316
|
*
|
|
2048
|
-
* @function navigate
|
|
2049
|
-
* @memberof View
|
|
2050
|
-
* @instance
|
|
2051
2317
|
* @example
|
|
2052
2318
|
* View:
|
|
2053
2319
|
* ```js
|
|
@@ -2075,15 +2341,16 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2075
2341
|
* navigate().then(() => console.log('Navigate to tutorial')).catch(err => console.log(err));
|
|
2076
2342
|
* ```
|
|
2077
2343
|
* @experimental
|
|
2344
|
+
* @remarks
|
|
2345
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2346
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2347
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2078
2348
|
*/
|
|
2079
2349
|
navigate(url) {
|
|
2080
2350
|
return this.wire.sendAction('navigate-window', { ...this.identity, url }).then(() => undefined);
|
|
2081
2351
|
}
|
|
2082
2352
|
/**
|
|
2083
2353
|
* Navigates the WebContents back one page.
|
|
2084
|
-
* @function navigateBack
|
|
2085
|
-
* @memberOf View
|
|
2086
|
-
* @instance
|
|
2087
2354
|
*
|
|
2088
2355
|
* @example
|
|
2089
2356
|
* View:
|
|
@@ -2105,15 +2372,16 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2105
2372
|
* }
|
|
2106
2373
|
* navigateBack().then(() => console.log('Navigated back')).catch(err => console.log(err));
|
|
2107
2374
|
* ```
|
|
2375
|
+
* @remarks
|
|
2376
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2377
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2378
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2108
2379
|
*/
|
|
2109
2380
|
navigateBack() {
|
|
2110
2381
|
return this.wire.sendAction('navigate-window-back', { ...this.identity }).then(() => undefined);
|
|
2111
2382
|
}
|
|
2112
2383
|
/**
|
|
2113
2384
|
* Navigates the WebContents forward one page.
|
|
2114
|
-
* @function navigateForward
|
|
2115
|
-
* @memberOf View
|
|
2116
|
-
* @instance
|
|
2117
2385
|
*
|
|
2118
2386
|
* @example
|
|
2119
2387
|
* View:
|
|
@@ -2137,15 +2405,16 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2137
2405
|
* }
|
|
2138
2406
|
* navigateForward().then(() => console.log('Navigated forward')).catch(err => console.log(err));
|
|
2139
2407
|
* ```
|
|
2408
|
+
* @remarks
|
|
2409
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2410
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2411
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2140
2412
|
*/
|
|
2141
2413
|
async navigateForward() {
|
|
2142
2414
|
await this.wire.sendAction('navigate-window-forward', { ...this.identity });
|
|
2143
2415
|
}
|
|
2144
2416
|
/**
|
|
2145
2417
|
* Stops any current navigation the WebContents is performing.
|
|
2146
|
-
* @function stopNavigation
|
|
2147
|
-
* @memberOf View
|
|
2148
|
-
* @instance
|
|
2149
2418
|
*
|
|
2150
2419
|
* @example
|
|
2151
2420
|
* View:
|
|
@@ -2167,15 +2436,16 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2167
2436
|
* }
|
|
2168
2437
|
* stopNavigation().then(() => console.log('you shall not navigate')).catch(err => console.log(err));
|
|
2169
2438
|
* ```
|
|
2439
|
+
* @remarks
|
|
2440
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2441
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2442
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2170
2443
|
*/
|
|
2171
2444
|
stopNavigation() {
|
|
2172
2445
|
return this.wire.sendAction('stop-window-navigation', { ...this.identity }).then(() => undefined);
|
|
2173
2446
|
}
|
|
2174
2447
|
/**
|
|
2175
2448
|
* Reloads the WebContents
|
|
2176
|
-
* @function reload
|
|
2177
|
-
* @memberOf View
|
|
2178
|
-
* @instance
|
|
2179
2449
|
*
|
|
2180
2450
|
* @example
|
|
2181
2451
|
* View:
|
|
@@ -2207,6 +2477,10 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2207
2477
|
* console.log('Reloaded window')
|
|
2208
2478
|
* }).catch(err => console.log(err));
|
|
2209
2479
|
* ```
|
|
2480
|
+
* @remarks
|
|
2481
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2482
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2483
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2210
2484
|
*/
|
|
2211
2485
|
reload(ignoreCache = false) {
|
|
2212
2486
|
return this.wire
|
|
@@ -2219,11 +2493,8 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2219
2493
|
/**
|
|
2220
2494
|
* Prints the WebContents.
|
|
2221
2495
|
* @param options Printer Options
|
|
2222
|
-
* @function print
|
|
2223
|
-
* @memberOf View
|
|
2224
|
-
* @instance
|
|
2225
2496
|
*
|
|
2226
|
-
*
|
|
2497
|
+
* Note: When `silent` is set to `true`, the API will pick the system's default printer if deviceName
|
|
2227
2498
|
* is empty and the default settings for printing.
|
|
2228
2499
|
*
|
|
2229
2500
|
* Use the CSS style `page-break-before: always;` to force print to a new page.
|
|
@@ -2236,6 +2507,10 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2236
2507
|
* console.log('print call has been sent to the system');
|
|
2237
2508
|
* });
|
|
2238
2509
|
* ```
|
|
2510
|
+
* @remarks
|
|
2511
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2512
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2513
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2239
2514
|
*/
|
|
2240
2515
|
print(options = {}) {
|
|
2241
2516
|
return this.wire.sendAction('print', { ...this.identity, options }).then(() => undefined);
|
|
@@ -2244,11 +2519,8 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2244
2519
|
* Find and highlight text on a page.
|
|
2245
2520
|
* @param searchTerm Term to find in page
|
|
2246
2521
|
* @param options Search options
|
|
2247
|
-
* @function findInPage
|
|
2248
|
-
* @memberOf View
|
|
2249
|
-
* @instance
|
|
2250
2522
|
*
|
|
2251
|
-
*
|
|
2523
|
+
* Note: By default, each subsequent call will highlight the next text that matches the search term.
|
|
2252
2524
|
*
|
|
2253
2525
|
* Returns a promise with the results for the request. By subscribing to the
|
|
2254
2526
|
* found-in-page event, you can get the results of this call as well.
|
|
@@ -2283,6 +2555,10 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2283
2555
|
* console.log(result)
|
|
2284
2556
|
* });
|
|
2285
2557
|
* ```
|
|
2558
|
+
* @remarks
|
|
2559
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2560
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2561
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2286
2562
|
*/
|
|
2287
2563
|
findInPage(searchTerm, options) {
|
|
2288
2564
|
return this.wire
|
|
@@ -2326,6 +2602,10 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2326
2602
|
* console.log(results);
|
|
2327
2603
|
* });
|
|
2328
2604
|
* ```
|
|
2605
|
+
* @remarks
|
|
2606
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2607
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2608
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2329
2609
|
*/
|
|
2330
2610
|
stopFindInPage(action) {
|
|
2331
2611
|
return this.wire.sendAction('stop-find-in-page', { ...this.identity, action }).then(() => undefined);
|
|
@@ -2333,9 +2613,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2333
2613
|
/**
|
|
2334
2614
|
* Returns an array with all system printers
|
|
2335
2615
|
* @deprecated use System.getPrinters instead
|
|
2336
|
-
* @function getPrinters
|
|
2337
|
-
* @memberOf View
|
|
2338
|
-
* @instance
|
|
2339
2616
|
*
|
|
2340
2617
|
* @example
|
|
2341
2618
|
* View:
|
|
@@ -2371,6 +2648,10 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2371
2648
|
* console.log(err);
|
|
2372
2649
|
* });
|
|
2373
2650
|
* ```
|
|
2651
|
+
* @remarks
|
|
2652
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2653
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2654
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2374
2655
|
*/
|
|
2375
2656
|
getPrinters() {
|
|
2376
2657
|
return this.wire.sendAction('get-printers', { ...this.identity }).then(({ payload }) => payload.data);
|
|
@@ -2378,10 +2659,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2378
2659
|
/**
|
|
2379
2660
|
* Gives focus to the WebContents.
|
|
2380
2661
|
*
|
|
2381
|
-
* @function focus
|
|
2382
|
-
* @emits focused
|
|
2383
|
-
* @memberOf Window
|
|
2384
|
-
* @instance
|
|
2385
2662
|
* @example
|
|
2386
2663
|
* ```js
|
|
2387
2664
|
* async function focusWindow() {
|
|
@@ -2397,15 +2674,16 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2397
2674
|
*
|
|
2398
2675
|
* focusWindow().then(() => console.log('Window focused')).catch(err => console.log(err));
|
|
2399
2676
|
* ```
|
|
2677
|
+
* @remarks
|
|
2678
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2679
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2680
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2400
2681
|
*/
|
|
2401
2682
|
async focus({ emitSynthFocused } = { emitSynthFocused: true }) {
|
|
2402
2683
|
await this.wire.sendAction('focus-window', { emitSynthFocused, ...this.identity });
|
|
2403
2684
|
}
|
|
2404
2685
|
/**
|
|
2405
2686
|
* Shows the Chromium Developer Tools
|
|
2406
|
-
* @function showDeveloperTools
|
|
2407
|
-
* @memberOf View
|
|
2408
|
-
* @instance
|
|
2409
2687
|
*
|
|
2410
2688
|
* @example
|
|
2411
2689
|
* View:
|
|
@@ -2431,6 +2709,10 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2431
2709
|
* .then(() => console.log('Showing dev tools'))
|
|
2432
2710
|
* .catch(err => console.error(err));
|
|
2433
2711
|
* ```
|
|
2712
|
+
* @remarks
|
|
2713
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2714
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2715
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2434
2716
|
*/
|
|
2435
2717
|
async showDeveloperTools() {
|
|
2436
2718
|
// Note this hits the system action map in core state for legacy reasons.
|
|
@@ -2439,11 +2721,7 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2439
2721
|
/**
|
|
2440
2722
|
* Retrieves the process information associated with a WebContents.
|
|
2441
2723
|
*
|
|
2442
|
-
*
|
|
2443
|
-
*
|
|
2444
|
-
* @function getProcessInfo
|
|
2445
|
-
* @memberOf View
|
|
2446
|
-
* @instance
|
|
2724
|
+
* Note: This includes any iframes associated with the WebContents
|
|
2447
2725
|
*
|
|
2448
2726
|
* @example
|
|
2449
2727
|
* View:
|
|
@@ -2457,6 +2735,10 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2457
2735
|
* const win = await fin.Window.getCurrent();
|
|
2458
2736
|
* const processInfo = await win.getProcessInfo();
|
|
2459
2737
|
* ```
|
|
2738
|
+
* @remarks
|
|
2739
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2740
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2741
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2460
2742
|
*/
|
|
2461
2743
|
async getProcessInfo() {
|
|
2462
2744
|
const { payload: { data } } = await this.wire.sendAction('get-process-info', this.identity);
|
|
@@ -2464,9 +2746,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2464
2746
|
}
|
|
2465
2747
|
/**
|
|
2466
2748
|
* Retrieves information on all Shared Workers.
|
|
2467
|
-
* @function getSharedWorkers
|
|
2468
|
-
* @memberOf View
|
|
2469
|
-
* @instance
|
|
2470
2749
|
*
|
|
2471
2750
|
* @example
|
|
2472
2751
|
* View:
|
|
@@ -2495,15 +2774,16 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2495
2774
|
* const win = await fin.Window.create(winOption);
|
|
2496
2775
|
* const sharedWorkers = await win.getSharedWorkers();
|
|
2497
2776
|
* ```
|
|
2777
|
+
* @remarks
|
|
2778
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2779
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2780
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2498
2781
|
*/
|
|
2499
2782
|
async getSharedWorkers() {
|
|
2500
2783
|
return this.wire.sendAction('get-shared-workers', this.identity).then(({ payload }) => payload.data);
|
|
2501
2784
|
}
|
|
2502
2785
|
/**
|
|
2503
2786
|
* Opens the developer tools for the shared worker context.
|
|
2504
|
-
* @function inspectSharedWorker
|
|
2505
|
-
* @memberOf View
|
|
2506
|
-
* @instance
|
|
2507
2787
|
*
|
|
2508
2788
|
* @example
|
|
2509
2789
|
* View:
|
|
@@ -2532,6 +2812,10 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2532
2812
|
* const win = await fin.Window.create(winOption);
|
|
2533
2813
|
* await win.inspectSharedWorker();
|
|
2534
2814
|
* ```
|
|
2815
|
+
* @remarks
|
|
2816
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2817
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2818
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2535
2819
|
*/
|
|
2536
2820
|
async inspectSharedWorker() {
|
|
2537
2821
|
await this.wire.sendAction('inspect-shared-worker', { ...this.identity });
|
|
@@ -2539,9 +2823,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2539
2823
|
/**
|
|
2540
2824
|
* Inspects the shared worker based on its ID.
|
|
2541
2825
|
* @param workerId - The id of the shared worker.
|
|
2542
|
-
* @function inspectSharedWorkerById
|
|
2543
|
-
* @memberOf View
|
|
2544
|
-
* @instance
|
|
2545
2826
|
*
|
|
2546
2827
|
* @example
|
|
2547
2828
|
* View:
|
|
@@ -2572,15 +2853,16 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2572
2853
|
* const sharedWorkers = await win.getSharedWorkers();
|
|
2573
2854
|
* await win.inspectSharedWorkerById(sharedWorkers[0].id);
|
|
2574
2855
|
* ```
|
|
2856
|
+
* @remarks
|
|
2857
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2858
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2859
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2575
2860
|
*/
|
|
2576
2861
|
async inspectSharedWorkerById(workerId) {
|
|
2577
2862
|
await this.wire.sendAction('inspect-shared-worker-by-id', { ...this.identity, workerId });
|
|
2578
2863
|
}
|
|
2579
2864
|
/**
|
|
2580
2865
|
* Opens the developer tools for the service worker context.
|
|
2581
|
-
* @function inspectServiceWorker
|
|
2582
|
-
* @memberOf View
|
|
2583
|
-
* @instance
|
|
2584
2866
|
*
|
|
2585
2867
|
* @example
|
|
2586
2868
|
* View:
|
|
@@ -2609,6 +2891,10 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2609
2891
|
* const win = await fin.Window.create(winOption);
|
|
2610
2892
|
* await win.inspectServiceWorker();
|
|
2611
2893
|
* ```
|
|
2894
|
+
* @remarks
|
|
2895
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
2896
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
2897
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2612
2898
|
*/
|
|
2613
2899
|
async inspectServiceWorker() {
|
|
2614
2900
|
await this.wire.sendAction('inspect-service-worker', { ...this.identity });
|
|
@@ -2616,7 +2902,7 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2616
2902
|
/**
|
|
2617
2903
|
* Shows a popup window.
|
|
2618
2904
|
*
|
|
2619
|
-
*
|
|
2905
|
+
* Note: If this WebContents is a view and its attached window has a popup open, this will close it.
|
|
2620
2906
|
*
|
|
2621
2907
|
* Shows a popup window. Including a `name` in `options` will attempt to show an existing window as a popup, if
|
|
2622
2908
|
* that window doesn't exist or no `name` is included a window will be created. If the caller view or the caller
|
|
@@ -2624,7 +2910,7 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2624
2910
|
* open popup window before showing the new popup window. Also, if the caller view is destroyed or detached, the popup
|
|
2625
2911
|
* will be dismissed.
|
|
2626
2912
|
*
|
|
2627
|
-
*
|
|
2913
|
+
* Note: in the case where the window being shown as a popup needs to be created, it is a child of the caller view's parent window.
|
|
2628
2914
|
*
|
|
2629
2915
|
* @example
|
|
2630
2916
|
*
|
|
@@ -2819,11 +3105,10 @@ class WebContents extends base_1$k.EmitterBase {
|
|
|
2819
3105
|
* onPopupReady: popupWindowCallback;
|
|
2820
3106
|
* });
|
|
2821
3107
|
* ```
|
|
2822
|
-
* @
|
|
2823
|
-
* @
|
|
2824
|
-
*
|
|
2825
|
-
* @
|
|
2826
|
-
*
|
|
3108
|
+
* @remarks
|
|
3109
|
+
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
|
3110
|
+
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
3111
|
+
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
2827
3112
|
*/
|
|
2828
3113
|
async showPopupWindow(options) {
|
|
2829
3114
|
this.wire.sendAction(`${this.entityType}-show-popup-window`, this.identity).catch(() => {
|
|
@@ -3108,7 +3393,6 @@ function requireInstance$2 () {
|
|
|
3108
3393
|
* Attaches the current view to the given window identity.
|
|
3109
3394
|
* Identity must be the identity of a window in the same application.
|
|
3110
3395
|
* This detaches the view from its current window, and sets the view to be destroyed when its new window closes.
|
|
3111
|
-
* @param target {Identity}
|
|
3112
3396
|
*
|
|
3113
3397
|
* @example
|
|
3114
3398
|
* ```js
|
|
@@ -3237,7 +3521,6 @@ function requireInstance$2 () {
|
|
|
3237
3521
|
};
|
|
3238
3522
|
/**
|
|
3239
3523
|
* Sets the bounds (top, left, width, height) of the view relative to its window.
|
|
3240
|
-
* @param bounds {ViewBounds}
|
|
3241
3524
|
*
|
|
3242
3525
|
* @remarks View position is relative to the bounds of the window.
|
|
3243
3526
|
* ({top: 0, left: 0} represents the top left corner of the window)
|
|
@@ -3402,7 +3685,6 @@ function requireInstance$2 () {
|
|
|
3402
3685
|
};
|
|
3403
3686
|
/**
|
|
3404
3687
|
* Updates the view's options.
|
|
3405
|
-
* @param options
|
|
3406
3688
|
*
|
|
3407
3689
|
* @example
|
|
3408
3690
|
* ```js
|
|
@@ -3443,7 +3725,6 @@ function requireInstance$2 () {
|
|
|
3443
3725
|
/**
|
|
3444
3726
|
* Retrieves the window the view is currently attached to.
|
|
3445
3727
|
*
|
|
3446
|
-
* @experimental
|
|
3447
3728
|
* @example
|
|
3448
3729
|
* ```js
|
|
3449
3730
|
* const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
|
|
@@ -3451,6 +3732,7 @@ function requireInstance$2 () {
|
|
|
3451
3732
|
* .then(win => console.log('current window', win))
|
|
3452
3733
|
* .catch(err => console.log(err));)
|
|
3453
3734
|
* ```
|
|
3735
|
+
* @experimental
|
|
3454
3736
|
*/
|
|
3455
3737
|
this.getCurrentWindow = async () => {
|
|
3456
3738
|
const { payload: { data } } = await this.wire.sendAction('get-view-window', { ...this.identity });
|
|
@@ -3556,10 +3838,6 @@ function requireInstance$2 () {
|
|
|
3556
3838
|
/**
|
|
3557
3839
|
* Focuses the view
|
|
3558
3840
|
*
|
|
3559
|
-
* @function focus
|
|
3560
|
-
* @memberof View
|
|
3561
|
-
* @emits focused
|
|
3562
|
-
* @instance
|
|
3563
3841
|
* @example
|
|
3564
3842
|
* ```js
|
|
3565
3843
|
* const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
|
|
@@ -3601,16 +3879,17 @@ function requireView () {
|
|
|
3601
3879
|
};
|
|
3602
3880
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3603
3881
|
/**
|
|
3604
|
-
* Entry
|
|
3882
|
+
* Entry points for the OpenFin `View` API (`fin.View`).
|
|
3883
|
+
*
|
|
3884
|
+
* * {@link ViewModule} contains static members of the `View` API, accessible through `fin.View`.
|
|
3885
|
+
* * {@link View} describes an instance of an OpenFin View, e.g. as returned by `fin.View.getCurrent`.
|
|
3605
3886
|
*
|
|
3606
|
-
*
|
|
3607
|
-
*
|
|
3608
|
-
* instances of the OpenFin `View` class.
|
|
3887
|
+
* These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
|
|
3888
|
+
* both of these were documented on the same page.
|
|
3609
3889
|
*
|
|
3610
3890
|
* @packageDocumentation
|
|
3611
3891
|
*/
|
|
3612
|
-
|
|
3613
|
-
exports.default = Factory_1.default;
|
|
3892
|
+
__exportStar(requireFactory$3(), exports);
|
|
3614
3893
|
__exportStar(requireInstance$2(), exports);
|
|
3615
3894
|
} (view));
|
|
3616
3895
|
return view;
|
|
@@ -4099,6 +4378,7 @@ function requireInstance$1 () {
|
|
|
4099
4378
|
/**
|
|
4100
4379
|
* Sets or removes a custom JumpList for the application. Only applicable in Windows OS.
|
|
4101
4380
|
* If categories is null the previously set custom JumpList (if any) will be replaced by the standard JumpList for the app (managed by Windows).
|
|
4381
|
+
*
|
|
4102
4382
|
* Note: If the "name" property is omitted it defaults to "tasks".
|
|
4103
4383
|
* @param jumpListCategories An array of JumpList Categories to populate. If null, remove any existing JumpList configuration and set to Windows default.
|
|
4104
4384
|
*
|
|
@@ -4399,6 +4679,7 @@ function requireInstance$1 () {
|
|
|
4399
4679
|
}
|
|
4400
4680
|
/**
|
|
4401
4681
|
* Sets file auto download location. It's only allowed in the same application.
|
|
4682
|
+
*
|
|
4402
4683
|
* Note: This method is restricted by default and must be enabled via
|
|
4403
4684
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
4404
4685
|
* @param downloadLocation file auto download location
|
|
@@ -4424,6 +4705,7 @@ function requireInstance$1 () {
|
|
|
4424
4705
|
}
|
|
4425
4706
|
/**
|
|
4426
4707
|
* Gets file auto download location. It's only allowed in the same application. If file auto download location is not set, it will return the default location.
|
|
4708
|
+
*
|
|
4427
4709
|
* Note: This method is restricted by default and must be enabled via
|
|
4428
4710
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
4429
4711
|
*
|
|
@@ -4450,13 +4732,16 @@ function requireFactory$2 () {
|
|
|
4450
4732
|
if (hasRequiredFactory$2) return Factory$7;
|
|
4451
4733
|
hasRequiredFactory$2 = 1;
|
|
4452
4734
|
Object.defineProperty(Factory$7, "__esModule", { value: true });
|
|
4735
|
+
Factory$7.ApplicationModule = void 0;
|
|
4453
4736
|
const base_1 = base;
|
|
4454
4737
|
const validate_1 = validate;
|
|
4455
4738
|
const Instance_1 = requireInstance$1();
|
|
4739
|
+
/**
|
|
4740
|
+
* Static namespace for OpenFin API methods that interact with the {@link Application} class, available under `fin.Application`.
|
|
4741
|
+
*/
|
|
4456
4742
|
class ApplicationModule extends base_1.Base {
|
|
4457
4743
|
/**
|
|
4458
4744
|
* Asynchronously returns an Application object that represents an existing application.
|
|
4459
|
-
* @param identity
|
|
4460
4745
|
*
|
|
4461
4746
|
* @example
|
|
4462
4747
|
*
|
|
@@ -4467,7 +4752,6 @@ function requireFactory$2 () {
|
|
|
4467
4752
|
* .catch(err => console.log(err));
|
|
4468
4753
|
* ```
|
|
4469
4754
|
*
|
|
4470
|
-
* @static
|
|
4471
4755
|
*/
|
|
4472
4756
|
async wrap(identity) {
|
|
4473
4757
|
this.wire.sendAction('wrap-application').catch((e) => {
|
|
@@ -4481,7 +4765,6 @@ function requireFactory$2 () {
|
|
|
4481
4765
|
}
|
|
4482
4766
|
/**
|
|
4483
4767
|
* Synchronously returns an Application object that represents an existing application.
|
|
4484
|
-
* @param identity
|
|
4485
4768
|
*
|
|
4486
4769
|
* @example
|
|
4487
4770
|
*
|
|
@@ -4490,7 +4773,6 @@ function requireFactory$2 () {
|
|
|
4490
4773
|
* await app.close();
|
|
4491
4774
|
* ```
|
|
4492
4775
|
*
|
|
4493
|
-
* @static
|
|
4494
4776
|
*/
|
|
4495
4777
|
wrapSync(identity) {
|
|
4496
4778
|
this.wire.sendAction('wrap-application-sync').catch((e) => {
|
|
@@ -4515,8 +4797,6 @@ function requireFactory$2 () {
|
|
|
4515
4797
|
}
|
|
4516
4798
|
/**
|
|
4517
4799
|
* DEPRECATED method to create a new Application. Use {@link Application.ApplicationModule.start Application.start} instead.
|
|
4518
|
-
* @param appOptions
|
|
4519
|
-
*
|
|
4520
4800
|
*
|
|
4521
4801
|
* @example
|
|
4522
4802
|
*
|
|
@@ -4545,7 +4825,6 @@ function requireFactory$2 () {
|
|
|
4545
4825
|
}
|
|
4546
4826
|
/**
|
|
4547
4827
|
* Creates and starts a new Application.
|
|
4548
|
-
* @param appOptions
|
|
4549
4828
|
*
|
|
4550
4829
|
* @example
|
|
4551
4830
|
*
|
|
@@ -4561,8 +4840,6 @@ function requireFactory$2 () {
|
|
|
4561
4840
|
* start().then(() => console.log('Application is running')).catch(err => console.log(err));
|
|
4562
4841
|
* ```
|
|
4563
4842
|
*
|
|
4564
|
-
*
|
|
4565
|
-
* @static
|
|
4566
4843
|
*/
|
|
4567
4844
|
async start(appOptions) {
|
|
4568
4845
|
this.wire.sendAction('start-application').catch((e) => {
|
|
@@ -4575,10 +4852,8 @@ function requireFactory$2 () {
|
|
|
4575
4852
|
/**
|
|
4576
4853
|
* Asynchronously starts a batch of applications given an array of application identifiers and manifestUrls.
|
|
4577
4854
|
* Returns once the RVM is finished attempting to launch the applications.
|
|
4578
|
-
* @param applications
|
|
4579
4855
|
* @param opts - Parameters that the RVM will use.
|
|
4580
4856
|
*
|
|
4581
|
-
* @static
|
|
4582
4857
|
* @example
|
|
4583
4858
|
*
|
|
4584
4859
|
* ```js
|
|
@@ -4630,8 +4905,6 @@ function requireFactory$2 () {
|
|
|
4630
4905
|
* });
|
|
4631
4906
|
*
|
|
4632
4907
|
* ```
|
|
4633
|
-
*
|
|
4634
|
-
* @static
|
|
4635
4908
|
*/
|
|
4636
4909
|
getCurrent() {
|
|
4637
4910
|
this.wire.sendAction('get-current-application').catch((e) => {
|
|
@@ -4657,8 +4930,6 @@ function requireFactory$2 () {
|
|
|
4657
4930
|
* });
|
|
4658
4931
|
*
|
|
4659
4932
|
* ```
|
|
4660
|
-
*
|
|
4661
|
-
* @static
|
|
4662
4933
|
*/
|
|
4663
4934
|
getCurrentSync() {
|
|
4664
4935
|
this.wire.sendAction('get-current-application-sync').catch((e) => {
|
|
@@ -4679,8 +4950,6 @@ function requireFactory$2 () {
|
|
|
4679
4950
|
* // For a local manifest file:
|
|
4680
4951
|
* fin.Application.startFromManifest('file:///C:/somefolder/app.json').then(app => console.log('App is running')).catch(err => console.log(err));
|
|
4681
4952
|
* ```
|
|
4682
|
-
*
|
|
4683
|
-
* @static
|
|
4684
4953
|
*/
|
|
4685
4954
|
async startFromManifest(manifestUrl, opts) {
|
|
4686
4955
|
this.wire.sendAction('application-start-from-manifest').catch((e) => {
|
|
@@ -4725,7 +4994,7 @@ function requireFactory$2 () {
|
|
|
4725
4994
|
});
|
|
4726
4995
|
}
|
|
4727
4996
|
}
|
|
4728
|
-
Factory$7.
|
|
4997
|
+
Factory$7.ApplicationModule = ApplicationModule;
|
|
4729
4998
|
return Factory$7;
|
|
4730
4999
|
}
|
|
4731
5000
|
|
|
@@ -4751,17 +5020,18 @@ function requireApplication () {
|
|
|
4751
5020
|
};
|
|
4752
5021
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4753
5022
|
/**
|
|
4754
|
-
* Entry
|
|
5023
|
+
* Entry points for the OpenFin `Application` API (`fin.Application`).
|
|
4755
5024
|
*
|
|
4756
|
-
*
|
|
4757
|
-
*
|
|
4758
|
-
*
|
|
5025
|
+
* * {@link ApplicationModule} contains static members of the `Application` API, accessible through `fin.Application`.
|
|
5026
|
+
* * {@link Application} describes an instance of an OpenFin Application, e.g. as returned by `fin.Application.getCurrent`.
|
|
5027
|
+
*
|
|
5028
|
+
* These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
|
|
5029
|
+
* both of these were documented on the same page.
|
|
4759
5030
|
*
|
|
4760
5031
|
* @packageDocumentation
|
|
4761
5032
|
*/
|
|
4762
|
-
|
|
5033
|
+
__exportStar(requireFactory$2(), exports);
|
|
4763
5034
|
__exportStar(requireInstance$1(), exports);
|
|
4764
|
-
exports.default = Factory_1.default;
|
|
4765
5035
|
} (application));
|
|
4766
5036
|
return application;
|
|
4767
5037
|
}
|
|
@@ -4780,6 +5050,7 @@ function requireInstance () {
|
|
|
4780
5050
|
const application_1 = requireApplication();
|
|
4781
5051
|
const main_1 = main;
|
|
4782
5052
|
const view_1 = requireView();
|
|
5053
|
+
const warnings_1 = warnings;
|
|
4783
5054
|
/**
|
|
4784
5055
|
* @PORTED
|
|
4785
5056
|
* @typedef { object } Margins
|
|
@@ -5264,7 +5535,6 @@ function requireInstance () {
|
|
|
5264
5535
|
*/
|
|
5265
5536
|
constructor(wire, identity) {
|
|
5266
5537
|
super(wire, identity, 'window');
|
|
5267
|
-
this.identity = identity;
|
|
5268
5538
|
}
|
|
5269
5539
|
/**
|
|
5270
5540
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
@@ -5390,6 +5660,7 @@ function requireInstance () {
|
|
|
5390
5660
|
if (options.autoShow === undefined) {
|
|
5391
5661
|
options.autoShow = true;
|
|
5392
5662
|
}
|
|
5663
|
+
(0, warnings_1.handleDeprecatedWarnings)(options);
|
|
5393
5664
|
const windowCreation = this.wire.environment.createChildContent({ entityType: 'window', options });
|
|
5394
5665
|
Promise.all([pageResponse, windowCreation])
|
|
5395
5666
|
.then((resolvedArr) => {
|
|
@@ -6095,11 +6366,12 @@ function requireInstance () {
|
|
|
6095
6366
|
* moveBy(580, 300).then(() => console.log('Moved')).catch(err => console.log(err));
|
|
6096
6367
|
* ```
|
|
6097
6368
|
*/
|
|
6098
|
-
moveBy(deltaLeft, deltaTop) {
|
|
6369
|
+
moveBy(deltaLeft, deltaTop, positioningOptions) {
|
|
6099
6370
|
return this.wire
|
|
6100
6371
|
.sendAction('move-window-by', {
|
|
6101
6372
|
deltaLeft,
|
|
6102
6373
|
deltaTop,
|
|
6374
|
+
positioningOptions,
|
|
6103
6375
|
...this.identity
|
|
6104
6376
|
})
|
|
6105
6377
|
.then(() => undefined);
|
|
@@ -6129,11 +6401,12 @@ function requireInstance () {
|
|
|
6129
6401
|
* moveTo(580, 300).then(() => console.log('Moved')).catch(err => console.log(err))
|
|
6130
6402
|
* ```
|
|
6131
6403
|
*/
|
|
6132
|
-
moveTo(left, top) {
|
|
6404
|
+
moveTo(left, top, positioningOptions) {
|
|
6133
6405
|
return this.wire
|
|
6134
6406
|
.sendAction('move-window', {
|
|
6135
6407
|
left,
|
|
6136
6408
|
top,
|
|
6409
|
+
positioningOptions,
|
|
6137
6410
|
...this.identity
|
|
6138
6411
|
})
|
|
6139
6412
|
.then(() => undefined);
|
|
@@ -6166,12 +6439,13 @@ function requireInstance () {
|
|
|
6166
6439
|
* resizeBy(580, 300, 'top-right').then(() => console.log('Resized')).catch(err => console.log(err));
|
|
6167
6440
|
* ```
|
|
6168
6441
|
*/
|
|
6169
|
-
resizeBy(deltaWidth, deltaHeight, anchor) {
|
|
6442
|
+
resizeBy(deltaWidth, deltaHeight, anchor, positioningOptions) {
|
|
6170
6443
|
return this.wire
|
|
6171
6444
|
.sendAction('resize-window-by', {
|
|
6172
6445
|
deltaWidth: Math.floor(deltaWidth),
|
|
6173
6446
|
deltaHeight: Math.floor(deltaHeight),
|
|
6174
6447
|
anchor,
|
|
6448
|
+
positioningOptions,
|
|
6175
6449
|
...this.identity
|
|
6176
6450
|
})
|
|
6177
6451
|
.then(() => undefined);
|
|
@@ -6204,12 +6478,13 @@ function requireInstance () {
|
|
|
6204
6478
|
* resizeTo(580, 300, 'top-left').then(() => console.log('Resized')).catch(err => console.log(err));
|
|
6205
6479
|
* ```
|
|
6206
6480
|
*/
|
|
6207
|
-
resizeTo(width, height, anchor) {
|
|
6481
|
+
resizeTo(width, height, anchor, positioningOptions) {
|
|
6208
6482
|
return this.wire
|
|
6209
6483
|
.sendAction('resize-window', {
|
|
6210
6484
|
width: Math.floor(width),
|
|
6211
6485
|
height: Math.floor(height),
|
|
6212
6486
|
anchor,
|
|
6487
|
+
positioningOptions,
|
|
6213
6488
|
...this.identity
|
|
6214
6489
|
})
|
|
6215
6490
|
.then(() => undefined);
|
|
@@ -6268,7 +6543,6 @@ function requireInstance () {
|
|
|
6268
6543
|
}
|
|
6269
6544
|
/**
|
|
6270
6545
|
* Sets the window's size and position.
|
|
6271
|
-
* @property { Bounds } bounds This is a * @type {string} name - name of the window.object that holds the propertys of
|
|
6272
6546
|
*
|
|
6273
6547
|
* @example
|
|
6274
6548
|
* ```js
|
|
@@ -6295,8 +6569,10 @@ function requireInstance () {
|
|
|
6295
6569
|
* }).then(() => console.log('Bounds set to window')).catch(err => console.log(err));
|
|
6296
6570
|
* ```
|
|
6297
6571
|
*/
|
|
6298
|
-
setBounds(bounds) {
|
|
6299
|
-
return this.wire
|
|
6572
|
+
setBounds(bounds, positioningOptions) {
|
|
6573
|
+
return this.wire
|
|
6574
|
+
.sendAction('set-window-bounds', { ...bounds, ...this.identity, positioningOptions })
|
|
6575
|
+
.then(() => undefined);
|
|
6300
6576
|
}
|
|
6301
6577
|
/**
|
|
6302
6578
|
* Shows the window if it is hidden.
|
|
@@ -6438,7 +6714,10 @@ function requireInstance () {
|
|
|
6438
6714
|
* Calling this method will close previously opened menus.
|
|
6439
6715
|
* @experimental
|
|
6440
6716
|
* @param options
|
|
6441
|
-
*
|
|
6717
|
+
* @typeParam Data User-defined shape for data returned upon menu item click. Should be a
|
|
6718
|
+
* [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
|
|
6719
|
+
* of all possible data shapes for the entire menu, and the click handler should process
|
|
6720
|
+
* these with a "reducer" pattern.
|
|
6442
6721
|
* @example
|
|
6443
6722
|
* This could be used to show a drop down menu over views in a platform window:
|
|
6444
6723
|
* ```js
|
|
@@ -6528,6 +6807,7 @@ function requireInstance () {
|
|
|
6528
6807
|
return this.wire.sendAction('close-popup-menu', { ...this.identity }).then(() => undefined);
|
|
6529
6808
|
}
|
|
6530
6809
|
/**
|
|
6810
|
+
* @PORTED
|
|
6531
6811
|
* @typedef {object} PopupOptions
|
|
6532
6812
|
* @property {string} [name] - If a window with this `name` exists, it will be shown as a popup. Otherwise, a new window with this `name` will be created. If this `name` is undefined, `initialOptions.name` will be used. If this `name` and `intialOptions.name` are both undefined, a `name` will be generated.
|
|
6533
6813
|
* @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
|
|
@@ -6545,6 +6825,7 @@ function requireInstance () {
|
|
|
6545
6825
|
* @property {boolean} [hideOnClose] - Hide the popup window instead of closing whenever `close` is called on it. Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
|
6546
6826
|
*/
|
|
6547
6827
|
/**
|
|
6828
|
+
* @PORTED
|
|
6548
6829
|
* @typedef {object} PopupResult
|
|
6549
6830
|
* @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
|
|
6550
6831
|
* @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
|
|
@@ -6634,13 +6915,16 @@ function requireFactory$1 () {
|
|
|
6634
6915
|
if (hasRequiredFactory$1) return Factory$8;
|
|
6635
6916
|
hasRequiredFactory$1 = 1;
|
|
6636
6917
|
Object.defineProperty(Factory$8, "__esModule", { value: true });
|
|
6918
|
+
Factory$8._WindowModule = void 0;
|
|
6637
6919
|
const base_1 = base;
|
|
6638
6920
|
const validate_1 = validate;
|
|
6639
6921
|
const Instance_1 = requireInstance();
|
|
6922
|
+
/**
|
|
6923
|
+
* Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
|
|
6924
|
+
*/
|
|
6640
6925
|
class _WindowModule extends base_1.Base {
|
|
6641
6926
|
/**
|
|
6642
6927
|
* Asynchronously returns a Window object that represents an existing window.
|
|
6643
|
-
* @param identity
|
|
6644
6928
|
*
|
|
6645
6929
|
* @example
|
|
6646
6930
|
* ```js
|
|
@@ -6657,7 +6941,6 @@ function requireFactory$1 () {
|
|
|
6657
6941
|
* .then(win => console.log('wrapped window'))
|
|
6658
6942
|
* .catch(err => console.log(err));
|
|
6659
6943
|
* ```
|
|
6660
|
-
* @static
|
|
6661
6944
|
*/
|
|
6662
6945
|
async wrap(identity) {
|
|
6663
6946
|
this.wire.sendAction('window-wrap').catch((e) => {
|
|
@@ -6671,7 +6954,6 @@ function requireFactory$1 () {
|
|
|
6671
6954
|
}
|
|
6672
6955
|
/**
|
|
6673
6956
|
* Synchronously returns a Window object that represents an existing window.
|
|
6674
|
-
* @param identity
|
|
6675
6957
|
*
|
|
6676
6958
|
* @example
|
|
6677
6959
|
* ```js
|
|
@@ -6687,7 +6969,6 @@ function requireFactory$1 () {
|
|
|
6687
6969
|
* await createWin();
|
|
6688
6970
|
* let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
|
|
6689
6971
|
* ```
|
|
6690
|
-
* @static
|
|
6691
6972
|
*/
|
|
6692
6973
|
wrapSync(identity) {
|
|
6693
6974
|
this.wire.sendAction('window-wrap-sync').catch((e) => {
|
|
@@ -6719,7 +7000,6 @@ function requireFactory$1 () {
|
|
|
6719
7000
|
*
|
|
6720
7001
|
* createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
|
|
6721
7002
|
* ```
|
|
6722
|
-
* @static
|
|
6723
7003
|
*/
|
|
6724
7004
|
create(options) {
|
|
6725
7005
|
this.wire.sendAction('create-window').catch((e) => {
|
|
@@ -6738,7 +7018,6 @@ function requireFactory$1 () {
|
|
|
6738
7018
|
* .catch(err => console.log(err));
|
|
6739
7019
|
*
|
|
6740
7020
|
* ```
|
|
6741
|
-
* @static
|
|
6742
7021
|
*/
|
|
6743
7022
|
getCurrent() {
|
|
6744
7023
|
this.wire.sendAction('get-current-window').catch((e) => {
|
|
@@ -6760,7 +7039,6 @@ function requireFactory$1 () {
|
|
|
6760
7039
|
* console.log(info);
|
|
6761
7040
|
*
|
|
6762
7041
|
* ```
|
|
6763
|
-
* @static
|
|
6764
7042
|
*/
|
|
6765
7043
|
getCurrentSync() {
|
|
6766
7044
|
this.wire.sendAction('get-current-window-sync').catch((e) => {
|
|
@@ -6773,7 +7051,7 @@ function requireFactory$1 () {
|
|
|
6773
7051
|
return this.wrapSync({ uuid, name });
|
|
6774
7052
|
}
|
|
6775
7053
|
}
|
|
6776
|
-
Factory$8.
|
|
7054
|
+
Factory$8._WindowModule = _WindowModule;
|
|
6777
7055
|
return Factory$8;
|
|
6778
7056
|
}
|
|
6779
7057
|
|
|
@@ -6799,24 +7077,33 @@ function requireWindow () {
|
|
|
6799
7077
|
};
|
|
6800
7078
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6801
7079
|
/**
|
|
6802
|
-
* Entry
|
|
7080
|
+
* Entry points for the OpenFin `Window` API (`fin.Window`).
|
|
6803
7081
|
*
|
|
6804
|
-
*
|
|
6805
|
-
*
|
|
6806
|
-
* instances of the OpenFin `Window` class.
|
|
7082
|
+
* * {@link _WindowModule} contains static members of the `Window` API, accessible through `fin.Window`.
|
|
7083
|
+
* * {@link _Window} describes an instance of an OpenFin Window, e.g. as returned by `fin.Window.getCurrent`.
|
|
6807
7084
|
*
|
|
6808
|
-
*
|
|
7085
|
+
* These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
|
|
7086
|
+
* both of these were documented on the same page.
|
|
7087
|
+
*
|
|
7088
|
+
* Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
|
|
6809
7089
|
*
|
|
6810
7090
|
* @packageDocumentation
|
|
6811
7091
|
*/
|
|
6812
|
-
|
|
6813
|
-
exports.default = Factory_1.default;
|
|
7092
|
+
__exportStar(requireFactory$1(), exports);
|
|
6814
7093
|
__exportStar(requireInstance(), exports);
|
|
6815
7094
|
} (window$1));
|
|
6816
7095
|
return window$1;
|
|
6817
7096
|
}
|
|
6818
7097
|
|
|
7098
|
+
/**
|
|
7099
|
+
* Entry point for the OpenFin `System` API (`fin.System`).
|
|
7100
|
+
*
|
|
7101
|
+
* * {@link System} contains static members of the `System` API (available under `fin.System`)
|
|
7102
|
+
*
|
|
7103
|
+
* @packageDocumentation
|
|
7104
|
+
*/
|
|
6819
7105
|
Object.defineProperty(system, "__esModule", { value: true });
|
|
7106
|
+
system.System = void 0;
|
|
6820
7107
|
const base_1$j = base;
|
|
6821
7108
|
const transport_errors_1$1 = transportErrors;
|
|
6822
7109
|
const window_1 = requireWindow();
|
|
@@ -7132,7 +7419,6 @@ class System extends base_1$j.EmitterBase {
|
|
|
7132
7419
|
* ```js
|
|
7133
7420
|
* fin.System.getUniqueUserId().then(id => console.log(id)).catch(err => console.log(err));
|
|
7134
7421
|
* ```
|
|
7135
|
-
* @static
|
|
7136
7422
|
*/
|
|
7137
7423
|
getUniqueUserId() {
|
|
7138
7424
|
return this.wire.sendAction('get-unique-user-id').then(({ payload }) => payload.data);
|
|
@@ -7823,7 +8109,8 @@ class System extends base_1$j.EmitterBase {
|
|
|
7823
8109
|
}
|
|
7824
8110
|
/**
|
|
7825
8111
|
* Attempt to close an external process. The process will be terminated if it
|
|
7826
|
-
* has not closed after the elapsed timeout in milliseconds
|
|
8112
|
+
* has not closed after the elapsed timeout in milliseconds.
|
|
8113
|
+
*
|
|
7827
8114
|
* Note: This method is restricted by default and must be enabled via
|
|
7828
8115
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
7829
8116
|
* @param options A object defined in the TerminateExternalRequestType interface
|
|
@@ -7859,7 +8146,8 @@ class System extends base_1$j.EmitterBase {
|
|
|
7859
8146
|
return this.wire.sendAction('update-proxy', options).then(() => undefined);
|
|
7860
8147
|
}
|
|
7861
8148
|
/**
|
|
7862
|
-
* Downloads the given application asset
|
|
8149
|
+
* Downloads the given application asset.
|
|
8150
|
+
*
|
|
7863
8151
|
* Note: This method is restricted by default and must be enabled via
|
|
7864
8152
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
|
7865
8153
|
* @param appAsset App asset object
|
|
@@ -8403,7 +8691,6 @@ class System extends base_1$j.EmitterBase {
|
|
|
8403
8691
|
* }
|
|
8404
8692
|
* });
|
|
8405
8693
|
* ```
|
|
8406
|
-
* @static
|
|
8407
8694
|
*/
|
|
8408
8695
|
async launchManifest(manifestUrl, opts = {}) {
|
|
8409
8696
|
const { subscribe, ..._sendOpts } = opts;
|
|
@@ -8663,7 +8950,7 @@ class System extends base_1$j.EmitterBase {
|
|
|
8663
8950
|
await this.wire.sendAction('set-domain-settings', { domainSettings, ...this.identity });
|
|
8664
8951
|
}
|
|
8665
8952
|
}
|
|
8666
|
-
system.
|
|
8953
|
+
system.System = System;
|
|
8667
8954
|
|
|
8668
8955
|
var interappbus = {};
|
|
8669
8956
|
|
|
@@ -9074,6 +9361,7 @@ var __classPrivateFieldSet$b = (commonjsGlobal && commonjsGlobal.__classPrivateF
|
|
|
9074
9361
|
};
|
|
9075
9362
|
var _ChannelClient_protectedObj, _ChannelClient_strategy, _ChannelClient_close;
|
|
9076
9363
|
Object.defineProperty(client, "__esModule", { value: true });
|
|
9364
|
+
client.ChannelClient = void 0;
|
|
9077
9365
|
const channel_1$1 = channel;
|
|
9078
9366
|
const channelClientsByEndpointId = new Map();
|
|
9079
9367
|
/**
|
|
@@ -9082,17 +9370,17 @@ const channelClientsByEndpointId = new Map();
|
|
|
9082
9370
|
* provider via {@link ChannelClient#dispatch dispatch} and to listen for communication
|
|
9083
9371
|
* from the provider by registering an action via {@link ChannelClient#register register}.
|
|
9084
9372
|
*
|
|
9085
|
-
* Synchronous Methods:
|
|
9373
|
+
* ### Synchronous Methods:
|
|
9086
9374
|
* * {@link ChannelClient#onDisconnection onDisconnection(listener)}
|
|
9087
9375
|
* * {@link ChannelClient#register register(action, listener)}
|
|
9088
9376
|
* * {@link ChannelClient#remove remove(action)}
|
|
9089
9377
|
*
|
|
9090
|
-
* Asynchronous Methods:
|
|
9378
|
+
* ### Asynchronous Methods:
|
|
9091
9379
|
* * {@link ChannelClient#disconnect disconnect()}
|
|
9092
9380
|
* * {@link ChannelClient#dispatch dispatch(action, payload)}
|
|
9093
9381
|
*
|
|
9094
|
-
* Middleware:
|
|
9095
|
-
*
|
|
9382
|
+
* ### Middleware:
|
|
9383
|
+
* Middleware functions receive the following arguments: (action, payload, senderId).
|
|
9096
9384
|
* The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
|
|
9097
9385
|
* unless it is undefined, in which case the original payload is used. Middleware can be used for side effects.
|
|
9098
9386
|
* * {@link ChannelClient#setDefaultAction setDefaultAction(middleware)}
|
|
@@ -9239,7 +9527,7 @@ class ChannelClient extends channel_1$1.ChannelBase {
|
|
|
9239
9527
|
});
|
|
9240
9528
|
}
|
|
9241
9529
|
}
|
|
9242
|
-
client.
|
|
9530
|
+
client.ChannelClient = ChannelClient;
|
|
9243
9531
|
_ChannelClient_protectedObj = new WeakMap(), _ChannelClient_strategy = new WeakMap(), _ChannelClient_close = new WeakMap();
|
|
9244
9532
|
|
|
9245
9533
|
var connectionManager = {};
|
|
@@ -9782,20 +10070,20 @@ const runtimeVersioning_1 = runtimeVersioning;
|
|
|
9782
10070
|
* a single client via {@link ChannelProvider#dispatch dispatch} or all clients via {@link ChannelProvider#publish publish}
|
|
9783
10071
|
* and to listen for communication from clients by registering an action via {@link ChannelProvider#register register}.
|
|
9784
10072
|
*
|
|
9785
|
-
* Synchronous Methods:
|
|
10073
|
+
* ### Synchronous Methods:
|
|
9786
10074
|
* * {@link ChannelProvider#onConnection onConnection(listener)}
|
|
9787
10075
|
* * {@link ChannelProvider#onDisconnection onDisconnection(listener)}
|
|
9788
10076
|
* * {@link ChannelProvider#publish publish(action, payload)}
|
|
9789
10077
|
* * {@link ChannelProvider#register register(action, listener)}
|
|
9790
10078
|
* * {@link ChannelProvider#remove remove(action)}
|
|
9791
10079
|
*
|
|
9792
|
-
* Asynchronous Methods:
|
|
10080
|
+
* ### Asynchronous Methods:
|
|
9793
10081
|
* * {@link ChannelProvider#destroy destroy()}
|
|
9794
10082
|
* * {@link ChannelProvider#dispatch dispatch(to, action, payload)}
|
|
9795
10083
|
* * {@link ChannelProvider#getAllClientInfo getAllClientInfo()}
|
|
9796
10084
|
*
|
|
9797
|
-
* Middleware:
|
|
9798
|
-
*
|
|
10085
|
+
* ### Middleware:
|
|
10086
|
+
* Middleware functions receive the following arguments: (action, payload, senderId).
|
|
9799
10087
|
* The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
|
|
9800
10088
|
* unless it is undefined, in which case the most recently defined payload is used. Middleware can be used for side effects.
|
|
9801
10089
|
* * {@link ChannelProvider#setDefaultAction setDefaultAction(middleware)}
|
|
@@ -10164,7 +10452,7 @@ class MessageReceiver extends base_1$h.Base {
|
|
|
10164
10452
|
const endpointIdFromPreviousConnection = this.latestEndpointIdByChannelId.get(channelId);
|
|
10165
10453
|
if (endpointIdFromPreviousConnection) {
|
|
10166
10454
|
// Not convinced by this way of doing things, but pushing up for now.
|
|
10167
|
-
client_1$1.
|
|
10455
|
+
client_1$1.ChannelClient.closeChannelByEndpointId(endpointIdFromPreviousConnection);
|
|
10168
10456
|
// eslint-disable-next-line no-console
|
|
10169
10457
|
console.warn('You have created a second connection to an older provider. First connection has been removed from the clientMap');
|
|
10170
10458
|
// eslint-disable-next-line no-console
|
|
@@ -10525,6 +10813,15 @@ class ConnectionManager extends base_1$g.Base {
|
|
|
10525
10813
|
connectionManager.ConnectionManager = ConnectionManager;
|
|
10526
10814
|
_ConnectionManager_messageReceiver = new WeakMap(), _ConnectionManager_rtcConnectionManager = new WeakMap();
|
|
10527
10815
|
|
|
10816
|
+
/**
|
|
10817
|
+
* Entry points for the `Channel` subset of the `InterApplicationBus` API (`fin.InterApplicationBus.Channel`).
|
|
10818
|
+
*
|
|
10819
|
+
* * {@link Channel} contains static members of the `Channel` API, accessible through `fin.InterApplicationBus.Channel`.
|
|
10820
|
+
* * {@link OpenFin.ChannelClient} describes a client of a channel, e.g. as returned by `fin.InterApplicationBus.Channel.connect`.
|
|
10821
|
+
* * {@link OpenFin.ChannelProvider} describes a provider of a channel, e.g. as returned by `fin.InterApplicationBus.Channel.create`.
|
|
10822
|
+
*
|
|
10823
|
+
* @packageDocumentation
|
|
10824
|
+
*/
|
|
10528
10825
|
var __classPrivateFieldSet$5 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
|
|
10529
10826
|
if (kind === "m") throw new TypeError("Private method is not writable");
|
|
10530
10827
|
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
|
|
@@ -10585,7 +10882,7 @@ class Channel extends base_1$f.EmitterBase {
|
|
|
10585
10882
|
_Channel_readyToConnect.set(this, new lazy_1$1.AsyncRetryableLazy(async () => {
|
|
10586
10883
|
await Promise.all([
|
|
10587
10884
|
this.on('disconnected', (eventPayload) => {
|
|
10588
|
-
client_1.
|
|
10885
|
+
client_1.ChannelClient.handleProviderDisconnect(eventPayload);
|
|
10589
10886
|
}),
|
|
10590
10887
|
this.on('connected', (...args) => {
|
|
10591
10888
|
__classPrivateFieldGet$7(this, _Channel_internalEmitter, "f").emit('connected', ...args);
|
|
@@ -10776,7 +11073,7 @@ class Channel extends base_1$f.EmitterBase {
|
|
|
10776
11073
|
};
|
|
10777
11074
|
const routingInfo = await this.safeConnect(channelName, opts.wait, connectPayload);
|
|
10778
11075
|
const strategy = await __classPrivateFieldGet$7(this, _Channel_connectionManager, "f").createClientStrategy(rtcPacket, routingInfo);
|
|
10779
|
-
const channel = new client_1.
|
|
11076
|
+
const channel = new client_1.ChannelClient(routingInfo, this.wire, strategy);
|
|
10780
11077
|
// It is the client's responsibility to handle endpoint disconnection to the provider.
|
|
10781
11078
|
// If the endpoint dies, the client will force a disconnection through the core.
|
|
10782
11079
|
// The provider does not care about endpoint disconnection.
|
|
@@ -10788,7 +11085,7 @@ class Channel extends base_1$f.EmitterBase {
|
|
|
10788
11085
|
console.warn(`Something went wrong during disconnect for client with uuid: ${routingInfo.uuid} / name: ${routingInfo.name} / endpointId: ${routingInfo.endpointId}.`);
|
|
10789
11086
|
}
|
|
10790
11087
|
finally {
|
|
10791
|
-
client_1.
|
|
11088
|
+
client_1.ChannelClient.handleProviderDisconnect(routingInfo);
|
|
10792
11089
|
}
|
|
10793
11090
|
});
|
|
10794
11091
|
return channel;
|
|
@@ -10859,7 +11156,14 @@ channel$1.Channel = Channel;
|
|
|
10859
11156
|
_Channel_connectionManager = new WeakMap(), _Channel_internalEmitter = new WeakMap(), _Channel_readyToConnect = new WeakMap();
|
|
10860
11157
|
|
|
10861
11158
|
Object.defineProperty(interappbus, "__esModule", { value: true });
|
|
10862
|
-
interappbus.InterAppPayload = void 0;
|
|
11159
|
+
interappbus.InterAppPayload = interappbus.InterApplicationBus = void 0;
|
|
11160
|
+
/**
|
|
11161
|
+
* Entry point for the OpenFin `InterApplicationBus` API (`fin.InterApplicationBus`).
|
|
11162
|
+
*
|
|
11163
|
+
* * {@link InterApplicationBus} contains static members of the `InterApplicationBus` API, accessible through `fin.InterApplicationBus`.
|
|
11164
|
+
*
|
|
11165
|
+
* @packageDocumentation
|
|
11166
|
+
*/
|
|
10863
11167
|
const events_1$4 = eventsExports;
|
|
10864
11168
|
const base_1$e = base;
|
|
10865
11169
|
const ref_counter_1 = refCounter;
|
|
@@ -11051,7 +11355,7 @@ class InterApplicationBus extends base_1$e.Base {
|
|
|
11051
11355
|
return true;
|
|
11052
11356
|
}
|
|
11053
11357
|
}
|
|
11054
|
-
interappbus.
|
|
11358
|
+
interappbus.InterApplicationBus = InterApplicationBus;
|
|
11055
11359
|
/**
|
|
11056
11360
|
* @internal
|
|
11057
11361
|
*/
|
|
@@ -11068,7 +11372,15 @@ function createKey(...toHash) {
|
|
|
11068
11372
|
|
|
11069
11373
|
var clipboard = {};
|
|
11070
11374
|
|
|
11375
|
+
/**
|
|
11376
|
+
* Entry point for the OpenFin `Clipboard` API (`fin.Clipboard`).
|
|
11377
|
+
*
|
|
11378
|
+
* * {@link Clipboard} contains static members of the `Clipboard` API, accessible through `fin.Clipboard`.
|
|
11379
|
+
*
|
|
11380
|
+
* @packageDocumentation
|
|
11381
|
+
*/
|
|
11071
11382
|
Object.defineProperty(clipboard, "__esModule", { value: true });
|
|
11383
|
+
clipboard.Clipboard = void 0;
|
|
11072
11384
|
const base_1$d = base;
|
|
11073
11385
|
/**
|
|
11074
11386
|
* @PORTED
|
|
@@ -11266,7 +11578,7 @@ class Clipboard extends base_1$d.Base {
|
|
|
11266
11578
|
return payload.data;
|
|
11267
11579
|
}
|
|
11268
11580
|
}
|
|
11269
|
-
clipboard.
|
|
11581
|
+
clipboard.Clipboard = Clipboard;
|
|
11270
11582
|
|
|
11271
11583
|
var externalApplication = {};
|
|
11272
11584
|
|
|
@@ -11281,7 +11593,7 @@ const base_1$c = base;
|
|
|
11281
11593
|
/**
|
|
11282
11594
|
* An ExternalApplication object representing native language adapter connections to the runtime. Allows
|
|
11283
11595
|
* the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
|
|
11284
|
-
* Discovery of connections is provided by
|
|
11596
|
+
* Discovery of connections is provided by {@link System.System.getAllExternalApplications getAllExternalApplications}.</a>
|
|
11285
11597
|
*
|
|
11286
11598
|
* Processes that can be wrapped as `ExternalApplication`s include the following:
|
|
11287
11599
|
* - Processes which have connected to an OpenFin runtime via an adapter
|
|
@@ -11392,8 +11704,12 @@ class ExternalApplication extends base_1$c.EmitterBase {
|
|
|
11392
11704
|
Instance$4.ExternalApplication = ExternalApplication;
|
|
11393
11705
|
|
|
11394
11706
|
Object.defineProperty(Factory$5, "__esModule", { value: true });
|
|
11707
|
+
Factory$5.ExternalApplicationModule = void 0;
|
|
11395
11708
|
const base_1$b = base;
|
|
11396
11709
|
const Instance_1$4 = Instance$4;
|
|
11710
|
+
/**
|
|
11711
|
+
* Static namespace for OpenFin API methods that interact with the {@link ExternalApplication} class, available under `fin.ExternalApplication`.
|
|
11712
|
+
*/
|
|
11397
11713
|
class ExternalApplicationModule extends base_1$b.Base {
|
|
11398
11714
|
/**
|
|
11399
11715
|
* Asynchronously returns an External Application object that represents an external application.
|
|
@@ -11407,7 +11723,6 @@ class ExternalApplicationModule extends base_1$b.Base {
|
|
|
11407
11723
|
* .then(extApp => console.log('wrapped external application'))
|
|
11408
11724
|
* .catch(err => console.log(err));
|
|
11409
11725
|
* ```
|
|
11410
|
-
* @static
|
|
11411
11726
|
*/
|
|
11412
11727
|
wrap(uuid) {
|
|
11413
11728
|
this.wire.sendAction('external-application-wrap').catch((e) => {
|
|
@@ -11427,7 +11742,6 @@ class ExternalApplicationModule extends base_1$b.Base {
|
|
|
11427
11742
|
* const info = await extApp.getInfo();
|
|
11428
11743
|
* console.log(info);
|
|
11429
11744
|
* ```
|
|
11430
|
-
* @static
|
|
11431
11745
|
*/
|
|
11432
11746
|
wrapSync(uuid) {
|
|
11433
11747
|
this.wire.sendAction('external-application-wrap-sync').catch((e) => {
|
|
@@ -11436,18 +11750,9 @@ class ExternalApplicationModule extends base_1$b.Base {
|
|
|
11436
11750
|
return new Instance_1$4.ExternalApplication(this.wire, { uuid });
|
|
11437
11751
|
}
|
|
11438
11752
|
}
|
|
11439
|
-
Factory$5.
|
|
11753
|
+
Factory$5.ExternalApplicationModule = ExternalApplicationModule;
|
|
11440
11754
|
|
|
11441
11755
|
(function (exports) {
|
|
11442
|
-
/**
|
|
11443
|
-
* Entry point for the OpenFin ExternalApplication namespace.
|
|
11444
|
-
*
|
|
11445
|
-
* Because TypeDoc does not currently support multiple modules with the same name, the module alias "ExternalApplicationModule" is used for
|
|
11446
|
-
* the module containing static members of the `ExternalApplication` namespace (available under `fin.ExternalApplication`), while `ExternalApplication`
|
|
11447
|
-
* documents instances of the OpenFin `ExternalApplication` class.
|
|
11448
|
-
*
|
|
11449
|
-
* @packageDocumentation
|
|
11450
|
-
*/
|
|
11451
11756
|
var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
11452
11757
|
if (k2 === undefined) k2 = k;
|
|
11453
11758
|
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
@@ -11463,8 +11768,18 @@ Factory$5.default = ExternalApplicationModule;
|
|
|
11463
11768
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
11464
11769
|
};
|
|
11465
11770
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
11466
|
-
|
|
11467
|
-
|
|
11771
|
+
/**
|
|
11772
|
+
* Entry points for the OpenFin `ExternalApplication` API (`fin.ExternalApplication`).
|
|
11773
|
+
*
|
|
11774
|
+
* * {@link ExternalApplicationModule} contains static members of the `ExternalApplication` type, accessible through `fin.ExternalApplication`.
|
|
11775
|
+
* * {@link ExternalApplication} describes an instance of an OpenFin ExternalApplication, e.g. as returned by `fin.ExternalApplication.getCurrent`.
|
|
11776
|
+
*
|
|
11777
|
+
* These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
|
|
11778
|
+
* both of these were documented on the same page.
|
|
11779
|
+
*
|
|
11780
|
+
* @packageDocumentation
|
|
11781
|
+
*/
|
|
11782
|
+
__exportStar(Factory$5, exports);
|
|
11468
11783
|
__exportStar(Instance$4, exports);
|
|
11469
11784
|
} (externalApplication));
|
|
11470
11785
|
|
|
@@ -11618,9 +11933,13 @@ class _Frame extends base_1$a.EmitterBase {
|
|
|
11618
11933
|
Instance$3._Frame = _Frame;
|
|
11619
11934
|
|
|
11620
11935
|
Object.defineProperty(Factory$4, "__esModule", { value: true });
|
|
11936
|
+
Factory$4._FrameModule = void 0;
|
|
11621
11937
|
const base_1$9 = base;
|
|
11622
11938
|
const validate_1$2 = validate;
|
|
11623
11939
|
const Instance_1$3 = Instance$3;
|
|
11940
|
+
/**
|
|
11941
|
+
* Static namespace for OpenFin API methods that interact with the {@link _Frame} class, available under `fin.Frame`.
|
|
11942
|
+
*/
|
|
11624
11943
|
class _FrameModule extends base_1$9.Base {
|
|
11625
11944
|
/**
|
|
11626
11945
|
* Asynchronously returns a reference to the specified frame. The frame does not have to exist
|
|
@@ -11632,7 +11951,6 @@ class _FrameModule extends base_1$9.Base {
|
|
|
11632
11951
|
* .then(frm => console.log('wrapped frame'))
|
|
11633
11952
|
* .catch(err => console.log(err));
|
|
11634
11953
|
* ```
|
|
11635
|
-
* @static
|
|
11636
11954
|
*/
|
|
11637
11955
|
async wrap(identity) {
|
|
11638
11956
|
this.wire.sendAction('frame-wrap').catch((e) => {
|
|
@@ -11654,7 +11972,6 @@ class _FrameModule extends base_1$9.Base {
|
|
|
11654
11972
|
* const info = await frm.getInfo();
|
|
11655
11973
|
* console.log(info);
|
|
11656
11974
|
* ```
|
|
11657
|
-
* @static
|
|
11658
11975
|
*/
|
|
11659
11976
|
wrapSync(identity) {
|
|
11660
11977
|
this.wire.sendAction('frame-wrap-sync').catch((e) => {
|
|
@@ -11675,7 +11992,6 @@ class _FrameModule extends base_1$9.Base {
|
|
|
11675
11992
|
* .then(frm => console.log('current frame'))
|
|
11676
11993
|
* .catch(err => console.log(err));
|
|
11677
11994
|
* ```
|
|
11678
|
-
* @static
|
|
11679
11995
|
*/
|
|
11680
11996
|
getCurrent() {
|
|
11681
11997
|
this.wire.sendAction('frame-get-current').catch((e) => {
|
|
@@ -11692,7 +12008,6 @@ class _FrameModule extends base_1$9.Base {
|
|
|
11692
12008
|
* const info = await frm.getInfo();
|
|
11693
12009
|
* console.log(info);
|
|
11694
12010
|
* ```
|
|
11695
|
-
* @static
|
|
11696
12011
|
*/
|
|
11697
12012
|
getCurrentSync() {
|
|
11698
12013
|
this.wire.sendAction('frame-get-current-sync').catch((e) => {
|
|
@@ -11701,17 +12016,19 @@ class _FrameModule extends base_1$9.Base {
|
|
|
11701
12016
|
return new Instance_1$3._Frame(this.wire, this.wire.environment.getCurrentEntityIdentity());
|
|
11702
12017
|
}
|
|
11703
12018
|
}
|
|
11704
|
-
Factory$4.
|
|
12019
|
+
Factory$4._FrameModule = _FrameModule;
|
|
11705
12020
|
|
|
11706
12021
|
(function (exports) {
|
|
11707
12022
|
/**
|
|
11708
|
-
* Entry
|
|
12023
|
+
* Entry points for the OpenFin `Frame` API (`fin.Frame`).
|
|
11709
12024
|
*
|
|
11710
|
-
*
|
|
11711
|
-
*
|
|
11712
|
-
* instances of the OpenFin `Frame` class.
|
|
12025
|
+
* * {@link _FrameModule} contains static members of the `Frame` API, accessible through `fin.Frame`.
|
|
12026
|
+
* * {@link _Frame} describes an instance of an OpenFin Frame, e.g. as returned by `fin.Frame.getCurrent`.
|
|
11713
12027
|
*
|
|
11714
|
-
*
|
|
12028
|
+
* These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
|
|
12029
|
+
* both of these were documented on the same page.
|
|
12030
|
+
*
|
|
12031
|
+
* Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
|
|
11715
12032
|
*
|
|
11716
12033
|
* @packageDocumentation
|
|
11717
12034
|
*/
|
|
@@ -11730,14 +12047,14 @@ Factory$4.default = _FrameModule;
|
|
|
11730
12047
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
11731
12048
|
};
|
|
11732
12049
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
11733
|
-
|
|
11734
|
-
exports.default = Factory_1.default;
|
|
12050
|
+
__exportStar(Factory$4, exports);
|
|
11735
12051
|
__exportStar(Instance$3, exports);
|
|
11736
12052
|
} (frame));
|
|
11737
12053
|
|
|
11738
12054
|
var globalHotkey = {};
|
|
11739
12055
|
|
|
11740
12056
|
Object.defineProperty(globalHotkey, "__esModule", { value: true });
|
|
12057
|
+
globalHotkey.GlobalHotkey = void 0;
|
|
11741
12058
|
const base_1$8 = base;
|
|
11742
12059
|
/**
|
|
11743
12060
|
* The GlobalHotkey module can register/unregister a global hotkeys.
|
|
@@ -11867,7 +12184,7 @@ class GlobalHotkey extends base_1$8.EmitterBase {
|
|
|
11867
12184
|
return data;
|
|
11868
12185
|
}
|
|
11869
12186
|
}
|
|
11870
|
-
globalHotkey.
|
|
12187
|
+
globalHotkey.GlobalHotkey = GlobalHotkey;
|
|
11871
12188
|
|
|
11872
12189
|
var platform = {};
|
|
11873
12190
|
|
|
@@ -11890,10 +12207,8 @@ const validate_1$1 = validate;
|
|
|
11890
12207
|
const clientMap = new Map();
|
|
11891
12208
|
/** Manages the life cycle of windows and views in the application.
|
|
11892
12209
|
*
|
|
11893
|
-
* Enables taking snapshots of itself and
|
|
11894
|
-
* ng them to restore a previous configuration
|
|
12210
|
+
* Enables taking snapshots of itself and applying them to restore a previous configuration
|
|
11895
12211
|
* as well as listen to {@link OpenFin.PlatformEvents platform events}.
|
|
11896
|
-
*
|
|
11897
12212
|
*/
|
|
11898
12213
|
class Platform extends base_1$7.EmitterBase {
|
|
11899
12214
|
/**
|
|
@@ -12252,12 +12567,11 @@ class Platform extends base_1$7.EmitterBase {
|
|
|
12252
12567
|
});
|
|
12253
12568
|
}
|
|
12254
12569
|
/**
|
|
12255
|
-
* ***DEPRECATED - please use Platform.createView.***
|
|
12570
|
+
* ***DEPRECATED - please use {@link Platform.createView Platform.createView}.***
|
|
12256
12571
|
* Reparents a specified view in a new target window.
|
|
12257
12572
|
* @param viewIdentity View identity
|
|
12258
12573
|
* @param target new owner window identity
|
|
12259
12574
|
*
|
|
12260
|
-
* @tutorial Platform.createView
|
|
12261
12575
|
*/
|
|
12262
12576
|
async reparentView(viewIdentity, target) {
|
|
12263
12577
|
var _a;
|
|
@@ -12751,6 +13065,138 @@ const base_1$6 = base;
|
|
|
12751
13065
|
const common_utils_1 = commonUtils;
|
|
12752
13066
|
const layout_entities_1 = layoutEntities;
|
|
12753
13067
|
const layout_constants_1 = layout_constants;
|
|
13068
|
+
/**
|
|
13069
|
+
*
|
|
13070
|
+
* Layouts give app providers the ability to embed multiple views in a single window. The Layout namespace
|
|
13071
|
+
* enables the initialization and manipulation of a window's Layout. A Layout will
|
|
13072
|
+
* emit events locally on the DOM element representing the layout-container.
|
|
13073
|
+
*
|
|
13074
|
+
*
|
|
13075
|
+
* ### Layout.DOMEvents
|
|
13076
|
+
*
|
|
13077
|
+
* When a Layout is created, it emits events onto the DOM element representing the Layout container.
|
|
13078
|
+
* This Layout container is the DOM element referenced by containerId in {@link Layout.LayoutModule#init Layout.init}.
|
|
13079
|
+
* You can use the built-in event emitter to listen to these events using [addEventListener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener).
|
|
13080
|
+
* The events are emitted synchronously and only in the process where the Layout exists.
|
|
13081
|
+
* Any values returned by the called listeners are ignored and will be discarded.
|
|
13082
|
+
* If the target DOM element is destroyed, any events that have been set up on that element will be destroyed.
|
|
13083
|
+
*
|
|
13084
|
+
* @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
|
|
13085
|
+
*
|
|
13086
|
+
* #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
|
|
13087
|
+
* Adds a listener to the end of the listeners array for the specified event.
|
|
13088
|
+
* @example
|
|
13089
|
+
* ```js
|
|
13090
|
+
* const myLayoutContainer = document.getElementById('layout-container');
|
|
13091
|
+
*
|
|
13092
|
+
* myLayoutContainer.addEventListener('tab-created', function(event) {
|
|
13093
|
+
* const { tabSelector } = event.detail;
|
|
13094
|
+
* const tabElement = document.getElementById(tabSelector);
|
|
13095
|
+
* const existingColor = tabElement.style.backgroundColor;
|
|
13096
|
+
* tabElement.style.backgroundColor = "red";
|
|
13097
|
+
* setTimeout(() => {
|
|
13098
|
+
* tabElement.style.backgroundColor = existingColor;
|
|
13099
|
+
* }, 2000);
|
|
13100
|
+
* });
|
|
13101
|
+
* ```
|
|
13102
|
+
*
|
|
13103
|
+
* #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
|
|
13104
|
+
* Adds a listener to the end of the listeners array for the specified event.
|
|
13105
|
+
* @example
|
|
13106
|
+
* ```js
|
|
13107
|
+
* const myLayoutContainer = document.getElementById('layout-container');
|
|
13108
|
+
*
|
|
13109
|
+
* const listener = function(event) {
|
|
13110
|
+
* console.log(event.detail);
|
|
13111
|
+
* console.log('container-created event fired once, removing listener');
|
|
13112
|
+
* myLayoutContainer.removeEventListener('container-created', listener);
|
|
13113
|
+
* };
|
|
13114
|
+
*
|
|
13115
|
+
* myLayoutContainer.addEventListener('container-created', listener);
|
|
13116
|
+
* ```
|
|
13117
|
+
*
|
|
13118
|
+
* ### Supported event types are:
|
|
13119
|
+
*
|
|
13120
|
+
* * tab-created
|
|
13121
|
+
* * container-created
|
|
13122
|
+
* * layout-state-changed
|
|
13123
|
+
* * tab-closed
|
|
13124
|
+
* * tab-dropped
|
|
13125
|
+
*
|
|
13126
|
+
* ### Layout DOM Node Events
|
|
13127
|
+
*
|
|
13128
|
+
* #### tab-created
|
|
13129
|
+
* Generated when a tab is created. As a user drags and drops tabs within window, new tabs are created. A single view may have multiple tabs created and destroyed during its lifetime attached to a single window.
|
|
13130
|
+
* ```js
|
|
13131
|
+
* // The response has the following shape in event.detail:
|
|
13132
|
+
* {
|
|
13133
|
+
* containerSelector: "container-component_A",
|
|
13134
|
+
* name: "component_A",
|
|
13135
|
+
* tabSelector: "tab-component_A",
|
|
13136
|
+
* topic: "openfin-DOM-event",
|
|
13137
|
+
* type: "tab-created",
|
|
13138
|
+
* uuid: "OpenFin POC"
|
|
13139
|
+
* }
|
|
13140
|
+
* ```
|
|
13141
|
+
*
|
|
13142
|
+
* #### container-created
|
|
13143
|
+
* Generated when a container is created. A single view will have only one container during its lifetime attached to a single window and the container's lifecycle is tied to the view. To discover when the container is destroyed, please listen to view-detached event.
|
|
13144
|
+
* ```js
|
|
13145
|
+
* // The response has the following shape in event.detail:
|
|
13146
|
+
* {
|
|
13147
|
+
* containerSelector: "container-component_A",
|
|
13148
|
+
* name: "component_A",
|
|
13149
|
+
* tabSelector: "tab-component_A",
|
|
13150
|
+
* topic: "openfin-DOM-event",
|
|
13151
|
+
* type: "container-created",
|
|
13152
|
+
* uuid: "OpenFin POC"
|
|
13153
|
+
* }
|
|
13154
|
+
* ```
|
|
13155
|
+
*
|
|
13156
|
+
* ### layout-state-changed
|
|
13157
|
+
* Generated when the state of the layout changes in any way, such as a view added/removed/replaced. Note that this event can fire frequently as the underlying layout can change multiple components from all kinds of changes (resizing for example). Given this, it is recommended to debounce this event and then you can use the {@link Layout#getConfig Layout.getConfig} API to retrieve the most up-to-date state.
|
|
13158
|
+
* ```js
|
|
13159
|
+
* // The response has the following shape in event.detail
|
|
13160
|
+
* {
|
|
13161
|
+
* containerSelector: "container-component_A",
|
|
13162
|
+
* name: "component_A",
|
|
13163
|
+
* tabSelector: "tab-component_A",
|
|
13164
|
+
* topic: "openfin-DOM-event",
|
|
13165
|
+
* type: "layout-state-changed",
|
|
13166
|
+
* uuid: "OpenFin POC"
|
|
13167
|
+
* }
|
|
13168
|
+
* ```
|
|
13169
|
+
*
|
|
13170
|
+
* #### tab-closed
|
|
13171
|
+
* Generated when a tab is closed.
|
|
13172
|
+
* ```js
|
|
13173
|
+
* // The response has the following shape in event.detail:
|
|
13174
|
+
* {
|
|
13175
|
+
* containerSelector: "container-component_A",
|
|
13176
|
+
* name: "component_A",
|
|
13177
|
+
* tabSelector: "tab-component_A",
|
|
13178
|
+
* topic: "openfin-DOM-event",
|
|
13179
|
+
* type: "tab-closed",
|
|
13180
|
+
* uuid: "OpenFin POC",
|
|
13181
|
+
* url: "http://openfin.co" // The url of the view that was closed.
|
|
13182
|
+
* }
|
|
13183
|
+
* ```
|
|
13184
|
+
*
|
|
13185
|
+
* #### tab-dropped
|
|
13186
|
+
* Generated when a tab is dropped.
|
|
13187
|
+
* ```js
|
|
13188
|
+
* // The response has the following shape in event.detail:
|
|
13189
|
+
* {
|
|
13190
|
+
* containerSelector: "container-component_A",
|
|
13191
|
+
* name: "component_A",
|
|
13192
|
+
* tabSelector: "tab-component_A",
|
|
13193
|
+
* topic: "openfin-DOM-event",
|
|
13194
|
+
* type: "tab-dropped",
|
|
13195
|
+
* uuid: "OpenFin POC",
|
|
13196
|
+
* url: "http://openfin.co" // The url of the view linked to the dropped tab.
|
|
13197
|
+
* }
|
|
13198
|
+
* ```
|
|
13199
|
+
*/
|
|
12754
13200
|
class Layout extends base_1$6.Base {
|
|
12755
13201
|
/**
|
|
12756
13202
|
* @internal
|
|
@@ -12978,20 +13424,50 @@ Factory$2.LayoutModule = void 0;
|
|
|
12978
13424
|
/* eslint-disable no-undef, import/prefer-default-export */
|
|
12979
13425
|
const base_1$5 = base;
|
|
12980
13426
|
const Instance_1$2 = Instance$1;
|
|
13427
|
+
/**
|
|
13428
|
+
* Static namespace for OpenFin API methods that interact with the {@link Layout} class, available under `fin.Platform.Layout`.
|
|
13429
|
+
*/
|
|
12981
13430
|
class LayoutModule extends base_1$5.Base {
|
|
12982
13431
|
constructor() {
|
|
12983
13432
|
super(...arguments);
|
|
12984
13433
|
_LayoutModule_layoutInitializationAttempted.set(this, false);
|
|
12985
13434
|
/**
|
|
12986
|
-
* Initialize the window's Layout.
|
|
13435
|
+
* Initialize the window's Layout.
|
|
13436
|
+
*
|
|
13437
|
+
* @remarks Must be called from a custom window that has a 'layout' option set upon creation of that window.
|
|
12987
13438
|
* If a containerId is not provided, this method attempts to find an element with the id `layout-container`.
|
|
12988
|
-
* A Layout will
|
|
13439
|
+
* A Layout will emit events locally on the DOM element representing the layout-container.
|
|
12989
13440
|
* In order to capture the relevant events during Layout initiation, set up the listeners on the DOM element prior to calling `init`.
|
|
12990
13441
|
* @param options - Layout init options.
|
|
12991
13442
|
*
|
|
12992
|
-
* @static
|
|
12993
13443
|
* @experimental
|
|
12994
|
-
*
|
|
13444
|
+
*
|
|
13445
|
+
* @example
|
|
13446
|
+
* ```js
|
|
13447
|
+
* // If no options are included, the layout in the window options is initialized in an element with the id `layout-container`
|
|
13448
|
+
* const layout = await fin.Platform.Layout.init();
|
|
13449
|
+
* ```
|
|
13450
|
+
* <br>
|
|
13451
|
+
*
|
|
13452
|
+
* ```js
|
|
13453
|
+
* const containerId = 'my-custom-container-id';
|
|
13454
|
+
*
|
|
13455
|
+
* const myLayoutContainer = document.getElementById(containerId);
|
|
13456
|
+
*
|
|
13457
|
+
* myLayoutContainer.addEventListener('tab-created', function(event) {
|
|
13458
|
+
* const { tabSelector } = event.detail;
|
|
13459
|
+
* const tabElement = document.getElementById(tabSelector);
|
|
13460
|
+
* const existingColor = tabElement.style.backgroundColor;
|
|
13461
|
+
* tabElement.style.backgroundColor = "red";
|
|
13462
|
+
* setTimeout(() => {
|
|
13463
|
+
* tabElement.style.backgroundColor = existingColor;
|
|
13464
|
+
* }, 2000);
|
|
13465
|
+
* });
|
|
13466
|
+
*
|
|
13467
|
+
* // initialize the layout into an existing HTML element with the div `my-custom-container-id`
|
|
13468
|
+
* // the window must have been created with a layout in its window options
|
|
13469
|
+
* const layout = await fin.Platform.Layout.init({ containerId });
|
|
13470
|
+
* ```
|
|
12995
13471
|
*/
|
|
12996
13472
|
this.init = async (options = {}) => {
|
|
12997
13473
|
this.wire.sendAction('layout-init').catch((e) => {
|
|
@@ -13009,7 +13485,6 @@ class LayoutModule extends base_1$5.Base {
|
|
|
13009
13485
|
}
|
|
13010
13486
|
/**
|
|
13011
13487
|
* Asynchronously returns a Layout object that represents a Window's layout.
|
|
13012
|
-
* @param identity
|
|
13013
13488
|
*
|
|
13014
13489
|
* @example
|
|
13015
13490
|
* ```js
|
|
@@ -13026,9 +13501,7 @@ class LayoutModule extends base_1$5.Base {
|
|
|
13026
13501
|
* // Use wrapped instance to control layout, e.g.:
|
|
13027
13502
|
* const layoutConfig = await layout.getConfig();
|
|
13028
13503
|
* ```
|
|
13029
|
-
* @static
|
|
13030
13504
|
*/
|
|
13031
|
-
// eslint-disable-next-line class-methods-use-this
|
|
13032
13505
|
async wrap(identity) {
|
|
13033
13506
|
this.wire.sendAction('layout-wrap').catch((e) => {
|
|
13034
13507
|
// don't expose
|
|
@@ -13037,7 +13510,6 @@ class LayoutModule extends base_1$5.Base {
|
|
|
13037
13510
|
}
|
|
13038
13511
|
/**
|
|
13039
13512
|
* Synchronously returns a Layout object that represents a Window's layout.
|
|
13040
|
-
* @param identity
|
|
13041
13513
|
*
|
|
13042
13514
|
* @example
|
|
13043
13515
|
* ```js
|
|
@@ -13054,9 +13526,7 @@ class LayoutModule extends base_1$5.Base {
|
|
|
13054
13526
|
* // Use wrapped instance to control layout, e.g.:
|
|
13055
13527
|
* const layoutConfig = await layout.getConfig();
|
|
13056
13528
|
* ```
|
|
13057
|
-
* @static
|
|
13058
13529
|
*/
|
|
13059
|
-
// eslint-disable-next-line class-methods-use-this
|
|
13060
13530
|
wrapSync(identity) {
|
|
13061
13531
|
this.wire.sendAction('layout-wrap-sync').catch((e) => {
|
|
13062
13532
|
// don't expose
|
|
@@ -13072,7 +13542,6 @@ class LayoutModule extends base_1$5.Base {
|
|
|
13072
13542
|
* // Use wrapped instance to control layout, e.g.:
|
|
13073
13543
|
* const layoutConfig = await layout.getConfig();
|
|
13074
13544
|
* ```
|
|
13075
|
-
* @static
|
|
13076
13545
|
*/
|
|
13077
13546
|
async getCurrent() {
|
|
13078
13547
|
this.wire.sendAction('layout-get-current').catch((e) => {
|
|
@@ -13096,7 +13565,6 @@ class LayoutModule extends base_1$5.Base {
|
|
|
13096
13565
|
* // Use wrapped instance to control layout, e.g.:
|
|
13097
13566
|
* const layoutConfig = await layout.getConfig();
|
|
13098
13567
|
* ```
|
|
13099
|
-
* @static
|
|
13100
13568
|
*/
|
|
13101
13569
|
getCurrentSync() {
|
|
13102
13570
|
this.wire.sendAction('layout-get-current-sync').catch((e) => {
|
|
@@ -13114,13 +13582,16 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap();
|
|
|
13114
13582
|
|
|
13115
13583
|
(function (exports) {
|
|
13116
13584
|
/**
|
|
13117
|
-
* Entry point for the OpenFin Layout
|
|
13585
|
+
* Entry point for the OpenFin `Layout` subset of the `Platform` API (`fin.Platform.Layout`).
|
|
13586
|
+
*
|
|
13587
|
+
* * {@link LayoutModule} contains static members of the `Layout` API, accessible through `fin.Platform.Layout`.
|
|
13588
|
+
* * {@link Layout} describes an instance of an OpenFin Layout, e.g. as returned by `fin.Platform.Layout.getCurrent`.
|
|
13118
13589
|
*
|
|
13119
|
-
*
|
|
13120
|
-
*
|
|
13121
|
-
* instances of the OpenFin `Layout` class.
|
|
13590
|
+
* These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
|
|
13591
|
+
* both of these were documented on the same page.
|
|
13122
13592
|
*
|
|
13123
13593
|
* @packageDocumentation
|
|
13594
|
+
*
|
|
13124
13595
|
*/
|
|
13125
13596
|
var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
13126
13597
|
if (k2 === undefined) k2 = k;
|
|
@@ -13142,9 +13613,13 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap();
|
|
|
13142
13613
|
} (layout));
|
|
13143
13614
|
|
|
13144
13615
|
Object.defineProperty(Factory$3, "__esModule", { value: true });
|
|
13616
|
+
Factory$3.PlatformModule = void 0;
|
|
13145
13617
|
const base_1$4 = base;
|
|
13146
13618
|
const Instance_1$1 = Instance$2;
|
|
13147
13619
|
const index_1$1 = layout;
|
|
13620
|
+
/**
|
|
13621
|
+
* Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
|
|
13622
|
+
*/
|
|
13148
13623
|
class PlatformModule extends base_1$4.Base {
|
|
13149
13624
|
/**
|
|
13150
13625
|
* @internal
|
|
@@ -13210,14 +13685,12 @@ class PlatformModule extends base_1$4.Base {
|
|
|
13210
13685
|
* fin.Platform.init({overrideCallback});
|
|
13211
13686
|
* ```
|
|
13212
13687
|
* @experimental
|
|
13213
|
-
* @static
|
|
13214
13688
|
*/
|
|
13215
13689
|
async init(options) {
|
|
13216
13690
|
return this.wire.environment.initPlatform(this.fin, options);
|
|
13217
13691
|
}
|
|
13218
13692
|
/**
|
|
13219
13693
|
* Asynchronously returns a Platform object that represents an existing platform.
|
|
13220
|
-
* @param identity
|
|
13221
13694
|
*
|
|
13222
13695
|
* @example
|
|
13223
13696
|
* ```js
|
|
@@ -13226,7 +13699,6 @@ class PlatformModule extends base_1$4.Base {
|
|
|
13226
13699
|
* // Use wrapped instance to control layout, e.g.:
|
|
13227
13700
|
* const snapshot = await platform.getSnapshot();
|
|
13228
13701
|
* ```
|
|
13229
|
-
* @static
|
|
13230
13702
|
*/
|
|
13231
13703
|
async wrap(identity) {
|
|
13232
13704
|
this.wire.sendAction('platform-wrap').catch((e) => {
|
|
@@ -13236,7 +13708,6 @@ class PlatformModule extends base_1$4.Base {
|
|
|
13236
13708
|
}
|
|
13237
13709
|
/**
|
|
13238
13710
|
* Synchronously returns a Platform object that represents an existing platform.
|
|
13239
|
-
* @param identity
|
|
13240
13711
|
*
|
|
13241
13712
|
* @example
|
|
13242
13713
|
* ```js
|
|
@@ -13245,7 +13716,6 @@ class PlatformModule extends base_1$4.Base {
|
|
|
13245
13716
|
* // Use wrapped instance to control layout, e.g.:
|
|
13246
13717
|
* const snapshot = await platform.getSnapshot();
|
|
13247
13718
|
* ```
|
|
13248
|
-
* @static
|
|
13249
13719
|
*/
|
|
13250
13720
|
wrapSync(identity) {
|
|
13251
13721
|
this.wire.sendAction('platform-wrap-sync').catch((e) => {
|
|
@@ -13262,7 +13732,6 @@ class PlatformModule extends base_1$4.Base {
|
|
|
13262
13732
|
* // Use wrapped instance to control layout, e.g.:
|
|
13263
13733
|
* const snapshot = await platform.getSnapshot();
|
|
13264
13734
|
* ```
|
|
13265
|
-
* @static
|
|
13266
13735
|
*/
|
|
13267
13736
|
async getCurrent() {
|
|
13268
13737
|
this.wire.sendAction('platform-get-current').catch((e) => {
|
|
@@ -13279,7 +13748,6 @@ class PlatformModule extends base_1$4.Base {
|
|
|
13279
13748
|
* // Use wrapped instance to control layout, e.g.:
|
|
13280
13749
|
* const snapshot = await platform.getSnapshot();
|
|
13281
13750
|
* ```
|
|
13282
|
-
* @static
|
|
13283
13751
|
*/
|
|
13284
13752
|
getCurrentSync() {
|
|
13285
13753
|
this.wire.sendAction('platform-get-current-sync').catch((e) => {
|
|
@@ -13290,7 +13758,6 @@ class PlatformModule extends base_1$4.Base {
|
|
|
13290
13758
|
/**
|
|
13291
13759
|
* Creates and starts a Platform and returns a wrapped and running Platform instance. The wrapped Platform methods can
|
|
13292
13760
|
* be used to launch content into the platform. Promise will reject if the platform is already running.
|
|
13293
|
-
* @param platformOptions
|
|
13294
13761
|
*
|
|
13295
13762
|
* @example
|
|
13296
13763
|
* ```js
|
|
@@ -13311,7 +13778,6 @@ class PlatformModule extends base_1$4.Base {
|
|
|
13311
13778
|
* console.error(e);
|
|
13312
13779
|
* }
|
|
13313
13780
|
* ```
|
|
13314
|
-
* @static
|
|
13315
13781
|
*/
|
|
13316
13782
|
start(platformOptions) {
|
|
13317
13783
|
this.wire.sendAction('platform-start').catch((e) => {
|
|
@@ -13356,7 +13822,6 @@ class PlatformModule extends base_1$4.Base {
|
|
|
13356
13822
|
* console.error(e);
|
|
13357
13823
|
* }
|
|
13358
13824
|
* ```
|
|
13359
|
-
* @static
|
|
13360
13825
|
*/
|
|
13361
13826
|
startFromManifest(manifestUrl, opts) {
|
|
13362
13827
|
this.wire.sendAction('platform-start-from-manifest').catch((e) => {
|
|
@@ -13379,18 +13844,9 @@ class PlatformModule extends base_1$4.Base {
|
|
|
13379
13844
|
});
|
|
13380
13845
|
}
|
|
13381
13846
|
}
|
|
13382
|
-
Factory$3.
|
|
13847
|
+
Factory$3.PlatformModule = PlatformModule;
|
|
13383
13848
|
|
|
13384
13849
|
(function (exports) {
|
|
13385
|
-
/**
|
|
13386
|
-
* Entry point for the OpenFin Platform namespace.
|
|
13387
|
-
*
|
|
13388
|
-
* Because TypeDoc does not currently support multiple modules with the same name, the module alias "PlatformModule" is used for
|
|
13389
|
-
* the module containing static members of the `Platform` namespace (available under `fin.Platform`), while `Platform` documents
|
|
13390
|
-
* instances of the OpenFin `Platform` class.
|
|
13391
|
-
*
|
|
13392
|
-
* @packageDocumentation
|
|
13393
|
-
*/
|
|
13394
13850
|
var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
13395
13851
|
if (k2 === undefined) k2 = k;
|
|
13396
13852
|
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
@@ -13406,8 +13862,18 @@ Factory$3.default = PlatformModule;
|
|
|
13406
13862
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
13407
13863
|
};
|
|
13408
13864
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
13409
|
-
|
|
13410
|
-
|
|
13865
|
+
/**
|
|
13866
|
+
* Entry points for the OpenFin `Platform` API (`fin.Platform`)
|
|
13867
|
+
*
|
|
13868
|
+
* * {@link PlatformModule} contains static members of the `Platform` API, accessible through `fin.Platform`.
|
|
13869
|
+
* * {@link Platform} describes an instance of an OpenFin Platform, e.g. as returned by `fin.Platform.getCurrent`.
|
|
13870
|
+
*
|
|
13871
|
+
* These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
|
|
13872
|
+
* both of these were documented on the same page.
|
|
13873
|
+
*
|
|
13874
|
+
* @packageDocumentation
|
|
13875
|
+
*/
|
|
13876
|
+
__exportStar(Factory$3, exports);
|
|
13411
13877
|
__exportStar(Instance$2, exports);
|
|
13412
13878
|
} (platform));
|
|
13413
13879
|
|
|
@@ -14655,7 +15121,8 @@ function requireInteropBroker () {
|
|
|
14655
15121
|
* ```
|
|
14656
15122
|
*/
|
|
14657
15123
|
// eslint-disable-next-line class-methods-use-this
|
|
14658
|
-
async handleFiredIntent(intent, clientIdentity)
|
|
15124
|
+
async handleFiredIntent(intent, clientIdentity // TODO(CORE-811): remove inline intersected type
|
|
15125
|
+
) {
|
|
14659
15126
|
const warning = (0, utils_1.generateOverrideWarning)('fdc3.raiseIntent', 'InteropBroker.handleFiredIntent', clientIdentity, 'interopClient.fireIntent');
|
|
14660
15127
|
console.warn(warning);
|
|
14661
15128
|
throw new Error(utils_1.BROKER_ERRORS.fireIntent);
|
|
@@ -14722,7 +15189,7 @@ function requireInteropBroker () {
|
|
|
14722
15189
|
* More information on the AppIntent type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/AppIntent).
|
|
14723
15190
|
*
|
|
14724
15191
|
* @param options
|
|
14725
|
-
* @param
|
|
15192
|
+
* @param clientIdentity Identity of the Client making the request.
|
|
14726
15193
|
*
|
|
14727
15194
|
* @example
|
|
14728
15195
|
* ```js
|
|
@@ -14739,7 +15206,8 @@ function requireInteropBroker () {
|
|
|
14739
15206
|
* ```
|
|
14740
15207
|
*/
|
|
14741
15208
|
// eslint-disable-next-line class-methods-use-this
|
|
14742
|
-
async handleInfoForIntent(options, clientIdentity)
|
|
15209
|
+
async handleInfoForIntent(options, clientIdentity // TODO(CORE-811): remove inline intersected type
|
|
15210
|
+
) {
|
|
14743
15211
|
const warning = (0, utils_1.generateOverrideWarning)('fdc3.findIntent', 'InteropBroker.handleInfoForIntent', clientIdentity, 'interopClient.getInfoForIntent');
|
|
14744
15212
|
console.warn(warning);
|
|
14745
15213
|
throw new Error(utils_1.BROKER_ERRORS.getInfoForIntent);
|
|
@@ -14785,7 +15253,8 @@ function requireInteropBroker () {
|
|
|
14785
15253
|
* ```
|
|
14786
15254
|
*/
|
|
14787
15255
|
// eslint-disable-next-line class-methods-use-this
|
|
14788
|
-
async handleInfoForIntentsByContext(context, clientIdentity)
|
|
15256
|
+
async handleInfoForIntentsByContext(context, clientIdentity // TODO(CORE-811): remove inline intersected type
|
|
15257
|
+
) {
|
|
14789
15258
|
const warning = (0, utils_1.generateOverrideWarning)('fdc3.findIntentsByContext', 'InteropBroker.handleInfoForIntentsByContext', clientIdentity, 'interopClient.getInfoForIntentsByContext');
|
|
14790
15259
|
console.warn(warning);
|
|
14791
15260
|
throw new Error(utils_1.BROKER_ERRORS.getInfoForIntentsByContext);
|
|
@@ -14811,7 +15280,7 @@ function requireInteropBroker () {
|
|
|
14811
15280
|
* More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
|
|
14812
15281
|
*
|
|
14813
15282
|
* @param contextForIntent Data passed between entities and applications.
|
|
14814
|
-
* @param
|
|
15283
|
+
* @param clientIdentity Identity of the Client making the request.
|
|
14815
15284
|
*
|
|
14816
15285
|
* @example
|
|
14817
15286
|
* ```js
|
|
@@ -14872,7 +15341,7 @@ function requireInteropBroker () {
|
|
|
14872
15341
|
/**
|
|
14873
15342
|
* Responsible for resolving the fdc3.findInstances call.
|
|
14874
15343
|
* Must be overridden
|
|
14875
|
-
* @param
|
|
15344
|
+
* @param app AppIdentifier that was passed to fdc3.findInstances
|
|
14876
15345
|
* @param clientIdentity Identity of the Client making the request.
|
|
14877
15346
|
*/
|
|
14878
15347
|
// eslint-disable-next-line class-methods-use-this
|
|
@@ -14907,7 +15376,7 @@ function requireInteropBroker () {
|
|
|
14907
15376
|
* fin.Platform.init({
|
|
14908
15377
|
* interopOverride: async (InteropBroker) => {
|
|
14909
15378
|
* class Override extends InteropBroker {
|
|
14910
|
-
* async invokeContextHandler(
|
|
15379
|
+
* async invokeContextHandler(clientIdentity, handlerId, context) {
|
|
14911
15380
|
* return super.invokeContextHandler(clientIdentity, handlerId, {
|
|
14912
15381
|
* ...context,
|
|
14913
15382
|
* contextMetadata: {
|
|
@@ -14947,7 +15416,7 @@ function requireInteropBroker () {
|
|
|
14947
15416
|
* fin.Platform.init({
|
|
14948
15417
|
* interopOverride: async (InteropBroker) => {
|
|
14949
15418
|
* class Override extends InteropBroker {
|
|
14950
|
-
* async invokeIntentHandler(
|
|
15419
|
+
* async invokeIntentHandler(clientIdentity, handlerId, context) {
|
|
14951
15420
|
* const { context } = intent;
|
|
14952
15421
|
* return super.invokeIntentHandler(clientIdentity, handlerId, {
|
|
14953
15422
|
* ...intent,
|
|
@@ -15286,7 +15755,8 @@ function requireInteropBroker () {
|
|
|
15286
15755
|
}
|
|
15287
15756
|
// Setup Channel Connection Logic
|
|
15288
15757
|
wireChannel(channel) {
|
|
15289
|
-
channel.onConnection(async (clientIdentity,
|
|
15758
|
+
channel.onConnection(async (clientIdentity, // TODO(CORE-811): remove inline intersected type
|
|
15759
|
+
payload) => {
|
|
15290
15760
|
if (!(await this.isConnectionAuthorized(clientIdentity, payload))) {
|
|
15291
15761
|
throw new Error(`Connection not authorized for ${clientIdentity.uuid}, ${clientIdentity.name}`);
|
|
15292
15762
|
}
|
|
@@ -16166,39 +16636,46 @@ class InteropClient extends base_1$2.Base {
|
|
|
16166
16636
|
InteropClient$1.InteropClient = InteropClient;
|
|
16167
16637
|
_InteropClient_clientPromise = new WeakMap(), _InteropClient_sessionContextGroups = new WeakMap();
|
|
16168
16638
|
|
|
16169
|
-
var overrideCheck
|
|
16639
|
+
var overrideCheck = {};
|
|
16170
16640
|
|
|
16171
|
-
|
|
16172
|
-
|
|
16173
|
-
|
|
16174
|
-
|
|
16175
|
-
|
|
16176
|
-
|
|
16177
|
-
|
|
16178
|
-
|
|
16179
|
-
|
|
16180
|
-
|
|
16181
|
-
|
|
16182
|
-
|
|
16183
|
-
|
|
16184
|
-
|
|
16185
|
-
|
|
16186
|
-
|
|
16187
|
-
|
|
16188
|
-
|
|
16189
|
-
|
|
16190
|
-
|
|
16191
|
-
|
|
16192
|
-
|
|
16193
|
-
|
|
16194
|
-
|
|
16195
|
-
|
|
16196
|
-
|
|
16197
|
-
|
|
16198
|
-
|
|
16199
|
-
|
|
16641
|
+
var hasRequiredOverrideCheck;
|
|
16642
|
+
|
|
16643
|
+
function requireOverrideCheck () {
|
|
16644
|
+
if (hasRequiredOverrideCheck) return overrideCheck;
|
|
16645
|
+
hasRequiredOverrideCheck = 1;
|
|
16646
|
+
Object.defineProperty(overrideCheck, "__esModule", { value: true });
|
|
16647
|
+
overrideCheck.overrideCheck = overrideCheck.getDefaultViewFdc3VersionFromAppInfo = void 0;
|
|
16648
|
+
const InteropBroker_1 = requireInteropBroker();
|
|
16649
|
+
function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }) {
|
|
16650
|
+
var _a, _b, _c, _d;
|
|
16651
|
+
const setVersion = (_c = (_b = (_a = manifest.platform) === null || _a === void 0 ? void 0 : _a.defaultViewOptions) === null || _b === void 0 ? void 0 : _b.fdc3InteropApi) !== null && _c !== void 0 ? _c : (_d = initialOptions.defaultViewOptions) === null || _d === void 0 ? void 0 : _d.fdc3InteropApi;
|
|
16652
|
+
return ['1.2', '2.0'].includes(setVersion !== null && setVersion !== void 0 ? setVersion : '') ? setVersion : undefined;
|
|
16653
|
+
}
|
|
16654
|
+
overrideCheck.getDefaultViewFdc3VersionFromAppInfo = getDefaultViewFdc3VersionFromAppInfo;
|
|
16655
|
+
// TODO: Unit test this
|
|
16656
|
+
function overrideCheck$1(overriddenBroker, fdc3InteropApi) {
|
|
16657
|
+
if (fdc3InteropApi && fdc3InteropApi === '2.0') {
|
|
16658
|
+
const mustOverrideAPIs = [
|
|
16659
|
+
'fdc3HandleFindInstances',
|
|
16660
|
+
'handleInfoForIntent',
|
|
16661
|
+
'handleInfoForIntentsByContext',
|
|
16662
|
+
'fdc3HandleGetAppMetadata',
|
|
16663
|
+
'fdc3HandleGetInfo',
|
|
16664
|
+
'fdc3HandleOpen',
|
|
16665
|
+
'handleFiredIntent',
|
|
16666
|
+
'handleFiredIntentForContext'
|
|
16667
|
+
];
|
|
16668
|
+
const notOverridden = mustOverrideAPIs.filter((api) => {
|
|
16669
|
+
return overriddenBroker[api] === InteropBroker_1.InteropBroker.prototype[api];
|
|
16670
|
+
});
|
|
16671
|
+
if (notOverridden.length > 0) {
|
|
16672
|
+
console.warn(`WARNING: FDC3 2.0 has been set as a default option for Views in this Platform, but the required InteropBroker APIs for FDC3 2.0 compliance have not all been overridden.\nThe following APIs need to be overridden:\n${notOverridden.join('\n')}`);
|
|
16673
|
+
}
|
|
16674
|
+
}
|
|
16675
|
+
}
|
|
16676
|
+
overrideCheck.overrideCheck = overrideCheck$1;
|
|
16677
|
+
return overrideCheck;
|
|
16200
16678
|
}
|
|
16201
|
-
overrideCheck$1.overrideCheck = overrideCheck;
|
|
16202
16679
|
|
|
16203
16680
|
var hasRequiredFactory;
|
|
16204
16681
|
|
|
@@ -16206,12 +16683,13 @@ function requireFactory () {
|
|
|
16206
16683
|
if (hasRequiredFactory) return Factory$1;
|
|
16207
16684
|
hasRequiredFactory = 1;
|
|
16208
16685
|
Object.defineProperty(Factory$1, "__esModule", { value: true });
|
|
16686
|
+
Factory$1.InteropModule = void 0;
|
|
16209
16687
|
const lodash_1 = require$$3;
|
|
16210
16688
|
const inaccessibleObject_1 = inaccessibleObject;
|
|
16211
16689
|
const base_1 = base;
|
|
16212
16690
|
const InteropBroker_1 = requireInteropBroker();
|
|
16213
16691
|
const InteropClient_1 = InteropClient$1;
|
|
16214
|
-
const overrideCheck_1 =
|
|
16692
|
+
const overrideCheck_1 = requireOverrideCheck();
|
|
16215
16693
|
const common_utils_1 = commonUtils;
|
|
16216
16694
|
const defaultOverride = (Class) => new Class();
|
|
16217
16695
|
const BrokerParamAccessError = 'You have attempted to use or modify InteropBroker parameters, which is not allowed. You are likely using an older InteropBroker override scheme. Please consult our Interop docs for guidance on migrating to the new override scheme.';
|
|
@@ -16242,7 +16720,6 @@ function requireFactory () {
|
|
|
16242
16720
|
* const contextGroups = await interopBroker.getContextGroups();
|
|
16243
16721
|
* console.log(contextGroups);
|
|
16244
16722
|
* ```
|
|
16245
|
-
* @static
|
|
16246
16723
|
*/
|
|
16247
16724
|
async init(name, override = defaultOverride) {
|
|
16248
16725
|
var _a;
|
|
@@ -16300,7 +16777,6 @@ function requireFactory () {
|
|
|
16300
16777
|
* const contextGroupInfo = await client.getInfoForContextGroup();
|
|
16301
16778
|
* console.log(contextGroupInfo);
|
|
16302
16779
|
* ```
|
|
16303
|
-
* @static
|
|
16304
16780
|
*/
|
|
16305
16781
|
connectSync(name, interopConfig) {
|
|
16306
16782
|
this.wire.sendAction('interop-connect-sync').catch(() => {
|
|
@@ -16309,7 +16785,7 @@ function requireFactory () {
|
|
|
16309
16785
|
return new InteropClient_1.InteropClient(this.wire, name, interopConfig);
|
|
16310
16786
|
}
|
|
16311
16787
|
}
|
|
16312
|
-
Factory$1.
|
|
16788
|
+
Factory$1.InteropModule = InteropModule;
|
|
16313
16789
|
return Factory$1;
|
|
16314
16790
|
}
|
|
16315
16791
|
|
|
@@ -16320,10 +16796,10 @@ function requireInterop () {
|
|
|
16320
16796
|
hasRequiredInterop = 1;
|
|
16321
16797
|
(function (exports) {
|
|
16322
16798
|
/**
|
|
16323
|
-
* Entry point for the OpenFin Interop
|
|
16799
|
+
* Entry point for the OpenFin `Interop` API (`fin.Interop`).
|
|
16324
16800
|
*
|
|
16325
|
-
*
|
|
16326
|
-
*
|
|
16801
|
+
* * {@link InteropModule} contains static members of the `Interop` API (available under `fin.Interop`)
|
|
16802
|
+
* * {@link InteropClient} and {@link InteropBroker} document instances of their respective classes.
|
|
16327
16803
|
*
|
|
16328
16804
|
* @packageDocumentation
|
|
16329
16805
|
*/
|
|
@@ -16342,8 +16818,7 @@ function requireInterop () {
|
|
|
16342
16818
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
16343
16819
|
};
|
|
16344
16820
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16345
|
-
|
|
16346
|
-
exports.default = Factory_1.default;
|
|
16821
|
+
__exportStar(requireFactory(), exports);
|
|
16347
16822
|
__exportStar(InteropClient$1, exports);
|
|
16348
16823
|
__exportStar(requireInteropBroker(), exports);
|
|
16349
16824
|
} (interop));
|
|
@@ -16385,6 +16860,8 @@ const connectionMap = new Map();
|
|
|
16385
16860
|
/**
|
|
16386
16861
|
* Enables configuring a SnapshotSource with custom getSnapshot and applySnapshot methods.
|
|
16387
16862
|
*
|
|
16863
|
+
* @typeParam Snapshot Implementation-defined shape of an application snapshot. Allows
|
|
16864
|
+
* custom snapshot implementations for legacy applications to define their own snapshot format.
|
|
16388
16865
|
*/
|
|
16389
16866
|
class SnapshotSource extends base_1$1.Base {
|
|
16390
16867
|
/**
|
|
@@ -16519,13 +16996,19 @@ Instance.SnapshotSource = SnapshotSource;
|
|
|
16519
16996
|
_SnapshotSource_identity = new WeakMap(), _SnapshotSource_getConnection = new WeakMap(), _SnapshotSource_getClient = new WeakMap(), _SnapshotSource_startConnection = new WeakMap(), _SnapshotSource_setUpConnectionListener = new WeakMap();
|
|
16520
16997
|
|
|
16521
16998
|
Object.defineProperty(Factory, "__esModule", { value: true });
|
|
16999
|
+
Factory.SnapshotSourceModule = void 0;
|
|
16522
17000
|
const base_1 = base;
|
|
16523
17001
|
const Instance_1 = Instance;
|
|
16524
17002
|
const utils_1 = utils;
|
|
17003
|
+
/**
|
|
17004
|
+
* Static namespace for OpenFin API methods that interact with the {@link SnapshotSource} class, available under `fin.SnapshotSource`.
|
|
17005
|
+
*/
|
|
16525
17006
|
class SnapshotSourceModule extends base_1.Base {
|
|
16526
17007
|
/**
|
|
16527
17008
|
* Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
|
|
16528
|
-
*
|
|
17009
|
+
*
|
|
17010
|
+
* @typeParam Snapshot Implementation-defined shape of an application snapshot. Allows
|
|
17011
|
+
* custom snapshot implementations for legacy applications to define their own snapshot format.
|
|
16529
17012
|
*
|
|
16530
17013
|
* @example
|
|
16531
17014
|
* ```js
|
|
@@ -16542,7 +17025,7 @@ class SnapshotSourceModule extends base_1.Base {
|
|
|
16542
17025
|
*
|
|
16543
17026
|
* await fin.SnapshotSource.init(snapshotProvider);
|
|
16544
17027
|
* ```
|
|
16545
|
-
*
|
|
17028
|
+
*
|
|
16546
17029
|
*/
|
|
16547
17030
|
async init(provider) {
|
|
16548
17031
|
this.wire.sendAction('snapshot-source-init').catch((e) => {
|
|
@@ -16562,7 +17045,6 @@ class SnapshotSourceModule extends base_1.Base {
|
|
|
16562
17045
|
}
|
|
16563
17046
|
/**
|
|
16564
17047
|
* Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
|
|
16565
|
-
* @param identity
|
|
16566
17048
|
*
|
|
16567
17049
|
* @example
|
|
16568
17050
|
* ```js
|
|
@@ -16570,7 +17052,6 @@ class SnapshotSourceModule extends base_1.Base {
|
|
|
16570
17052
|
* // Use wrapped instance's getSnapshot method, e.g.:
|
|
16571
17053
|
* const snapshot = await snapshotSource.getSnapshot();
|
|
16572
17054
|
* ```
|
|
16573
|
-
* @static
|
|
16574
17055
|
*/
|
|
16575
17056
|
wrapSync(identity) {
|
|
16576
17057
|
this.wire.sendAction('snapshot-source-wrap-sync').catch((e) => {
|
|
@@ -16580,7 +17061,6 @@ class SnapshotSourceModule extends base_1.Base {
|
|
|
16580
17061
|
}
|
|
16581
17062
|
/**
|
|
16582
17063
|
* Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.
|
|
16583
|
-
* @param identity
|
|
16584
17064
|
*
|
|
16585
17065
|
* @example
|
|
16586
17066
|
* ```js
|
|
@@ -16588,7 +17068,6 @@ class SnapshotSourceModule extends base_1.Base {
|
|
|
16588
17068
|
* // Use wrapped instance's getSnapshot method, e.g.:
|
|
16589
17069
|
* const snapshot = await snapshotSource.getSnapshot();
|
|
16590
17070
|
* ```
|
|
16591
|
-
* @static
|
|
16592
17071
|
*/
|
|
16593
17072
|
async wrap(identity) {
|
|
16594
17073
|
this.wire.sendAction('snapshot-source-wrap').catch((e) => {
|
|
@@ -16597,15 +17076,17 @@ class SnapshotSourceModule extends base_1.Base {
|
|
|
16597
17076
|
return this.wrapSync(identity);
|
|
16598
17077
|
}
|
|
16599
17078
|
}
|
|
16600
|
-
Factory.
|
|
17079
|
+
Factory.SnapshotSourceModule = SnapshotSourceModule;
|
|
16601
17080
|
|
|
16602
17081
|
(function (exports) {
|
|
16603
17082
|
/**
|
|
16604
|
-
* Entry
|
|
17083
|
+
* Entry points for the OpenFin `SnapshotSource` API (`fin.SnapshotSource`).
|
|
16605
17084
|
*
|
|
16606
|
-
*
|
|
16607
|
-
*
|
|
16608
|
-
*
|
|
17085
|
+
* * {@link SnapshotSourceModule} contains static members of the `SnapshotSource` API, accessible through `fin.SnapshotSource`.
|
|
17086
|
+
* * {@link SnapshotSource} describes an instance of an OpenFin SnapshotSource, e.g. as returned by `fin.SnapshotSource.wrap`.
|
|
17087
|
+
*
|
|
17088
|
+
* These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
|
|
17089
|
+
* both of these were documented on the same page.
|
|
16609
17090
|
*
|
|
16610
17091
|
* @packageDocumentation
|
|
16611
17092
|
*/
|
|
@@ -16624,12 +17105,12 @@ Factory.default = SnapshotSourceModule;
|
|
|
16624
17105
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
16625
17106
|
};
|
|
16626
17107
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16627
|
-
|
|
16628
|
-
exports.default = Factory_1.default;
|
|
17108
|
+
__exportStar(Factory, exports);
|
|
16629
17109
|
__exportStar(Instance, exports);
|
|
16630
17110
|
} (snapshotSource));
|
|
16631
17111
|
|
|
16632
17112
|
Object.defineProperty(fin, "__esModule", { value: true });
|
|
17113
|
+
fin.Fin = void 0;
|
|
16633
17114
|
const events_1$3 = eventsExports;
|
|
16634
17115
|
// Import from the file rather than the directory in case someone consuming types is using module resolution other than "node"
|
|
16635
17116
|
const index_1 = system;
|
|
@@ -16645,6 +17126,9 @@ const index_10 = platform;
|
|
|
16645
17126
|
const me_1$2 = me;
|
|
16646
17127
|
const interop_1 = requireInterop();
|
|
16647
17128
|
const snapshot_source_1 = snapshotSource;
|
|
17129
|
+
/**
|
|
17130
|
+
* @internal
|
|
17131
|
+
*/
|
|
16648
17132
|
class Fin extends events_1$3.EventEmitter {
|
|
16649
17133
|
/**
|
|
16650
17134
|
* @internal
|
|
@@ -16652,18 +17136,18 @@ class Fin extends events_1$3.EventEmitter {
|
|
|
16652
17136
|
constructor(wire) {
|
|
16653
17137
|
super();
|
|
16654
17138
|
this.wire = wire;
|
|
16655
|
-
this.System = new index_1.
|
|
16656
|
-
this.Window = new index_2.
|
|
16657
|
-
this.Application = new index_3.
|
|
16658
|
-
this.InterApplicationBus = new index_4.
|
|
16659
|
-
this.Clipboard = new index_5.
|
|
16660
|
-
this.ExternalApplication = new index_6.
|
|
16661
|
-
this.Frame = new index_7.
|
|
16662
|
-
this.GlobalHotkey = new index_8.
|
|
16663
|
-
this.Platform = new index_10.
|
|
16664
|
-
this.View = new index_9.
|
|
16665
|
-
this.Interop = new interop_1.
|
|
16666
|
-
this.SnapshotSource = new snapshot_source_1.
|
|
17139
|
+
this.System = new index_1.System(wire);
|
|
17140
|
+
this.Window = new index_2._WindowModule(wire);
|
|
17141
|
+
this.Application = new index_3.ApplicationModule(wire);
|
|
17142
|
+
this.InterApplicationBus = new index_4.InterApplicationBus(wire);
|
|
17143
|
+
this.Clipboard = new index_5.Clipboard(wire);
|
|
17144
|
+
this.ExternalApplication = new index_6.ExternalApplicationModule(wire);
|
|
17145
|
+
this.Frame = new index_7._FrameModule(wire);
|
|
17146
|
+
this.GlobalHotkey = new index_8.GlobalHotkey(wire);
|
|
17147
|
+
this.Platform = new index_10.PlatformModule(wire, this.InterApplicationBus.Channel);
|
|
17148
|
+
this.View = new index_9.ViewModule(wire);
|
|
17149
|
+
this.Interop = new interop_1.InteropModule(wire);
|
|
17150
|
+
this.SnapshotSource = new snapshot_source_1.SnapshotSourceModule(wire);
|
|
16667
17151
|
wire.registerFin(this);
|
|
16668
17152
|
this.me = (0, me_1$2.getMe)(wire);
|
|
16669
17153
|
// Handle disconnect events
|
|
@@ -16672,7 +17156,7 @@ class Fin extends events_1$3.EventEmitter {
|
|
|
16672
17156
|
});
|
|
16673
17157
|
}
|
|
16674
17158
|
}
|
|
16675
|
-
fin.
|
|
17159
|
+
fin.Fin = Fin;
|
|
16676
17160
|
|
|
16677
17161
|
var transport = {};
|
|
16678
17162
|
|
|
@@ -17112,7 +17596,7 @@ exports.fin = mock.fin = ((typeof window !== 'undefined' && (window === null ||
|
|
|
17112
17596
|
uuid: '',
|
|
17113
17597
|
name: ''
|
|
17114
17598
|
});
|
|
17115
|
-
return new fin_1.
|
|
17599
|
+
return new fin_1.Fin(transport);
|
|
17116
17600
|
})());
|
|
17117
17601
|
var _default = mock.default = OpenFin;
|
|
17118
17602
|
|