@openfin/core 30.73.27 → 31.74.1

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.
Files changed (80) hide show
  1. package/LICENSE.md +4 -0
  2. package/package.json +2 -2
  3. package/src/OpenFin.d.ts +1664 -173
  4. package/src/api/application/Factory.d.ts +1 -0
  5. package/src/api/application/Factory.js +1 -0
  6. package/src/api/application/Instance.d.ts +2 -1
  7. package/src/api/application/Instance.js +1 -0
  8. package/src/api/base.d.ts +2 -2
  9. package/src/api/clipboard/index.d.ts +1 -0
  10. package/src/api/clipboard/index.js +1 -0
  11. package/src/api/events/platform.d.ts +4 -5
  12. package/src/api/events/system.d.ts +5 -6
  13. package/src/api/events/webcontents.d.ts +23 -3
  14. package/src/api/external-application/Instance.d.ts +1 -1
  15. package/src/api/fin.d.ts +1 -1
  16. package/src/api/frame/Instance.d.ts +1 -1
  17. package/src/api/global-hotkey/index.d.ts +1 -1
  18. package/src/api/interappbus/channel/channel.d.ts +1 -1
  19. package/src/api/interappbus/channel/channels-docs.d.ts +7 -0
  20. package/src/api/interappbus/channel/channels-docs.js +7 -0
  21. package/src/api/interappbus/channel/client.d.ts +3 -2
  22. package/src/api/interappbus/channel/client.js +12 -5
  23. package/src/api/interappbus/channel/connection-manager.d.ts +1 -1
  24. package/src/api/interappbus/channel/index.d.ts +1 -1
  25. package/src/api/interappbus/channel/index.js +5 -7
  26. package/src/api/interappbus/channel/protocols/classic/message-receiver.d.ts +1 -1
  27. package/src/api/interappbus/channel/protocols/classic/strategy.d.ts +1 -1
  28. package/src/api/interappbus/channel/protocols/index.d.ts +3 -0
  29. package/src/api/interappbus/channel/protocols/rtc/endpoint.js +10 -2
  30. package/src/api/interappbus/channel/protocols/rtc/ice-manager.d.ts +1 -1
  31. package/src/api/interappbus/channel/protocols/rtc/strategy.js +1 -1
  32. package/src/api/interappbus/channel/provider.d.ts +1 -1
  33. package/src/api/interappbus/index.d.ts +1 -1
  34. package/src/api/interop/Factory.d.ts +1 -2
  35. package/src/api/interop/Factory.js +20 -4
  36. package/src/api/interop/InteropBroker.d.ts +16 -48
  37. package/src/api/interop/InteropBroker.js +33 -47
  38. package/src/api/interop/InteropClient.d.ts +10 -9
  39. package/src/api/interop/InteropClient.js +9 -8
  40. package/src/api/interop/SessionContextGroupClient.d.ts +1 -1
  41. package/src/api/interop/fdc3/fdc3-1.2.js +8 -8
  42. package/src/api/interop/fdc3/fdc3-2.0.d.ts +2 -2
  43. package/src/api/interop/fdc3/fdc3-2.0.js +15 -7
  44. package/src/api/interop/fdc3/fdc3.d.ts +4 -5
  45. package/src/api/interop/fdc3/overrideCheck.d.ts +4 -0
  46. package/src/api/interop/fdc3/overrideCheck.js +32 -0
  47. package/src/api/interop/fdc3/versions.d.ts +1 -0
  48. package/src/api/interop/fdc3/versions.js +2 -0
  49. package/src/api/me.d.ts +1 -1
  50. package/src/api/platform/Factory.d.ts +6 -1
  51. package/src/api/platform/Factory.js +5 -0
  52. package/src/api/platform/Instance.d.ts +4 -2
  53. package/src/api/platform/Instance.js +4 -2
  54. package/src/api/platform/layout/Factory.d.ts +4 -0
  55. package/src/api/platform/layout/Factory.js +4 -0
  56. package/src/api/platform/layout/Instance.d.ts +1 -1
  57. package/src/api/platform/layout/utils/view-overlay.d.ts +1 -1
  58. package/src/api/platform/provider.d.ts +162 -0
  59. package/src/api/platform/provider.js +2 -0
  60. package/src/api/snapshot-source/Factory.d.ts +1 -0
  61. package/src/api/snapshot-source/Factory.js +1 -0
  62. package/src/api/snapshot-source/Instance.d.ts +1 -1
  63. package/src/api/system/index.d.ts +1 -471
  64. package/src/api/system/index.js +6 -476
  65. package/src/api/view/Instance.d.ts +7 -3
  66. package/src/api/view/Instance.js +7 -4
  67. package/src/api/webcontents/main.d.ts +18 -4
  68. package/src/api/window/Instance.d.ts +21 -1
  69. package/src/api/window/Instance.js +20 -0
  70. package/src/browser.js +1 -1
  71. package/src/mock.js +1 -1
  72. package/src/namespaces.d.ts +21 -0
  73. package/src/namespaces.js +24 -0
  74. package/src/transport/fin_store.d.ts +1 -1
  75. package/src/transport/transport-errors.d.ts +6 -1
  76. package/src/transport/transport-errors.js +1 -2
  77. package/src/transport/transport.d.ts +9 -6
  78. package/src/transport/transport.js +11 -2
  79. package/src/util/inaccessibleObject.d.ts +2 -0
  80. package/src/util/inaccessibleObject.js +49 -0
@@ -2,10 +2,10 @@ import { TargetApp } from './fdc3/shapes/fdc3v1';
2
2
  import { AppIdentifier } from './fdc3/shapes/fdc3v2';
3
3
  import type * as OpenFin from '../../OpenFin';
4
4
  import { Base } from '../base';
5
- import type Transport from '../../transport/transport';
5
+ import type { Transport } from '../../transport/transport';
6
6
  declare type Identity = OpenFin.Identity;
7
7
  /**
8
- * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking **THE INTEROP API IS EXPERIMENTAL. IF YOU WOULD LIKE TO USE IT, PLEASE USE OUR DEFAULT IMPLEMENTATION IN BROWSER**}
8
+ * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
9
9
  *
10
10
  * The Interop Broker is responsible for keeping track of the Interop state of the Platform, and for directing messages to the proper locations.
11
11
  *
@@ -103,7 +103,7 @@ declare type Identity = OpenFin.Identity;
103
103
  * };
104
104
  * return new Override();
105
105
  * },
106
- * interopOverride: async (InteropBroker, provider, options, ...args) => {
106
+ * interopOverride: async (InteropBroker) => {
107
107
  * class Override extends InteropBroker {
108
108
  * async joinContextGroup(channelName = 'default', target) {
109
109
  * console.log('before super joinContextGroup')
@@ -112,37 +112,7 @@ declare type Identity = OpenFin.Identity;
112
112
  * }
113
113
  * }
114
114
  *
115
- * options.contextGroups = [
116
- * {
117
- * id: 'green',
118
- * displayMetadata: {
119
- * color: '#00CC88',
120
- * name: 'green'
121
- * }
122
- * },
123
- * {
124
- * id: 'purple',
125
- * displayMetadata: {
126
- * color: '#8C61FF',
127
- * name: 'purple'
128
- * }
129
- * },
130
- * {
131
- * id: 'orange',
132
- * displayMetadata: {
133
- * color: '#FF8C4C',
134
- * name: 'orange'
135
- * }
136
- * },
137
- * {
138
- * id: 'red',
139
- * displayMetadata: {
140
- * color: '#FF5E60',
141
- * name: 'red'
142
- * }
143
- * }
144
- * ];
145
- * return new Override(provider, options, ...args);
115
+ * return new Override();
146
116
  * }
147
117
  * });
148
118
  * ```
@@ -162,43 +132,54 @@ export declare class InteropBroker extends Base {
162
132
  private channel;
163
133
  private logging;
164
134
  constructor(wire: Transport, getProvider: () => Promise<OpenFin.ChannelProvider>, options?: any);
135
+ static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
136
+ new (): InteropBroker;
137
+ };
165
138
  /**
139
+ * @REMOVED
166
140
  * SetContextOptions interface
167
141
  * @typedef { object } SetContextOptions
168
142
  * @property { Context } {context} - New context to set.
169
143
  */
170
144
  /**
145
+ * @REMOVED
171
146
  * GetContextOptions interface
172
147
  * @typedef { object } GetContextOptions
173
148
  * @property { string } [contextType] - Context Type
174
149
  */
175
150
  /**
151
+ * @REMOVED
176
152
  * JoinContextGroupOptions interface
177
153
  * @typedef { object } JoinContextGroupOptions
178
154
  * @property { string } contextGroupId - Id of the context group.
179
155
  * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
180
156
  */
181
157
  /**
158
+ * @REMOVED
182
159
  * AddClientToContextGroupOptions interface
183
160
  * @typedef { object } AddClientToContextGroupOptions
184
161
  * @property { string } contextGroupId - Name of the context group.
185
162
  */
186
163
  /**
164
+ * @REMOVED
187
165
  * RemoveFromContextGroupOptions interface
188
166
  * @typedef { object } RemoveFromContextGroupOptions
189
167
  * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
190
168
  */
191
169
  /**
170
+ * @REMOVED
192
171
  * GetInfoForContextGroupOptions interface
193
172
  * @typedef { object } GetInfoForContextGroupOptions
194
173
  * @property { string } contextGroupId - Name of the context group to get info for.
195
174
  */
196
175
  /**
176
+ * @REMOVED
197
177
  * GetAllClientsInContextGroupOptions interface
198
178
  * @typedef { object } GetAllClientsInContextGroupOptions
199
179
  * @property { string } contextGroupId - Name of the context group to get info for.
200
180
  */
201
181
  /**
182
+ * @PORTED
202
183
  * InfoForIntentOptions interface
203
184
  * @typedef { object } InfoForIntentOptions
204
185
  * @property { string } name Name of the intent to get info for.
@@ -209,7 +190,6 @@ export declare class InteropBroker extends Base {
209
190
  * @param { SetContextOptions } setContextOptions - New context to set.
210
191
  * @param { ClientIdentity } clientIdentity - Identity of the client sender.
211
192
  * @return { void }
212
- * @experimental
213
193
  */
214
194
  setContext({ context }: {
215
195
  context: OpenFin.Context;
@@ -231,7 +211,6 @@ export declare class InteropBroker extends Base {
231
211
  * @return { Promise<void> }
232
212
  * @param { JoinContextGroupOptions } joinContextGroupOptions - Id of the Context Group and identity of the entity to join to the group.
233
213
  * @param { ClientIdentity } senderIdentity - Identity of the client sender.
234
- * @experimental
235
214
  */
236
215
  joinContextGroup({ contextGroupId, target }: {
237
216
  contextGroupId: string;
@@ -243,7 +222,6 @@ export declare class InteropBroker extends Base {
243
222
  * @return { Promise<void> }
244
223
  * @param { AddClientToContextGroupOptions } addClientToContextGroupOptions - Contains the contextGroupId
245
224
  * @param { ClientIdentity } clientIdentity - Identity of the client sender.
246
- * @experimental
247
225
  */
248
226
  addClientToContextGroup({ contextGroupId }: {
249
227
  contextGroupId: string;
@@ -256,7 +234,6 @@ export declare class InteropBroker extends Base {
256
234
  * @return { Promise<void> }
257
235
  * @param { RemoveFromContextGroupOptions } removeFromContextGroupOptions - Contains the target identity to remove.
258
236
  * @param { ClientIdentity } senderIdentity - Identity of the client sender.
259
- * @experimental
260
237
  */
261
238
  removeFromContextGroup({ target }: {
262
239
  target: OpenFin.Identity;
@@ -266,14 +243,12 @@ export declare class InteropBroker extends Base {
266
243
  * Used by Platform Windows.
267
244
  * @return { Promise<void> }
268
245
  * @property { ClientIdentity } clientIdentity - Identity of the client sender.
269
- * @experimental
270
246
  */
271
247
  removeClientFromContextGroup(clientIdentity: OpenFin.ClientIdentity): Promise<void>;
272
248
  /**
273
249
  * Returns the Interop-Broker-defined context groups available for an entity to join. Because this function is used in the rest of the Interop Broker to fetch the Context Groups, overriding this allows you to customize the Context Groups for the Interop Broker. However, we recommend customizing the context groups through configuration instead.
274
250
  * Used by Platform Windows.
275
251
  * @return { Promise<ContextGroupInfo[]>}
276
- * @experimental
277
252
  */
278
253
  getContextGroups(): Readonly<OpenFin.ContextGroupInfo[]>;
279
254
  /**
@@ -281,7 +256,6 @@ export declare class InteropBroker extends Base {
281
256
  * Used by Platform Windows.
282
257
  * @param { GetInfoForContextGroupOptions } getInfoForContextGroupOptions - Contains contextGroupId, the context group you wish to get display info for.
283
258
  * @return { Promise<ContextGroupInfo>}
284
- * @experimental
285
259
  */
286
260
  getInfoForContextGroup({ contextGroupId }: {
287
261
  contextGroupId: string;
@@ -291,7 +265,6 @@ export declare class InteropBroker extends Base {
291
265
  * Used by Platform Windows.
292
266
  * @param { GetAllClientsInContextGroupOptions } getAllClientsInContextGroupOptions - Contains contextGroupId, the context group you wish to get clients for.
293
267
  * @return { Promise<ClientIdentity[]>}
294
- * @experimental
295
268
  */
296
269
  getAllClientsInContextGroup({ contextGroupId }: {
297
270
  contextGroupId: string;
@@ -303,7 +276,6 @@ export declare class InteropBroker extends Base {
303
276
  * @param { ClientIdentity } clientIdentity Identity of the Client making the request.
304
277
  * @return { Promise<unknown> }
305
278
  * @tutorial interop.handleFiredIntent
306
- * @experimental
307
279
  */
308
280
  handleFiredIntent(intent: OpenFin.Intent, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
309
281
  /**
@@ -312,7 +284,6 @@ export declare class InteropBroker extends Base {
312
284
  * @param { Intent } intent The combination of an action and a context that is passed to an application for resolution.
313
285
  * @param { Identity } target - Identity of the target that will handle the intent.
314
286
  * @return { Promise<void> }
315
- * @experimental
316
287
  */
317
288
  setIntentTarget(intent: OpenFin.Intent, target: OpenFin.Identity): Promise<void>;
318
289
  /**
@@ -322,7 +293,6 @@ export declare class InteropBroker extends Base {
322
293
  * @param { ClientIdentity } clientIdentity Identity of the Client making the request.
323
294
  * @return { Promise<unknown> }
324
295
  * @tutorial interop.handleInfoForIntent
325
- * @experimental
326
296
  */
327
297
  handleInfoForIntent(options: OpenFin.InfoForIntentOptions, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
328
298
  /**
@@ -332,7 +302,6 @@ export declare class InteropBroker extends Base {
332
302
  * @param { ClientIdentity } clientIdentity Identity of the Client making the request.
333
303
  * @return { Promise<unknown> }
334
304
  * @tutorial interop.handleInfoForIntentsByContext
335
- * @experimental
336
305
  */
337
306
  handleInfoForIntentsByContext(context: OpenFin.Context | OpenFin.FindIntentsByContextOptions, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
338
307
  /**
@@ -342,7 +311,6 @@ export declare class InteropBroker extends Base {
342
311
  * @param { ClientIdentity } clientIdentity Identity of the Client making the request.
343
312
  * @return { Promise<unknown> }
344
313
  * @tutorial interop.handleFiredIntentForContext
345
- * @experimental
346
314
  */
347
315
  handleFiredIntentForContext(contextForIntent: OpenFin.ContextForIntent, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
348
316
  /**
@@ -416,7 +384,7 @@ export declare class InteropBroker extends Base {
416
384
  * FDC3 2.0: Use the endpointId in the ClientInfo as the instanceId when generating
417
385
  * an AppIdentifier.
418
386
  * @return { Promise<Array<ClientInfo>> }
419
- * @tutorial interop.getAllClientInfo()
387
+ * @tutorial interop.getAllClientInfo
420
388
  */
421
389
  getAllClientInfo(): Promise<Array<OpenFin.ClientInfo>>;
422
390
  decorateSnapshot(snapshot: OpenFin.Snapshot): OpenFin.Snapshot;
@@ -4,6 +4,7 @@ exports.InteropBroker = void 0;
4
4
  const base_1 = require("../base");
5
5
  const SessionContextGroupBroker_1 = require("./SessionContextGroupBroker");
6
6
  const utils_1 = require("./utils");
7
+ const lodash_1 = require("lodash");
7
8
  let contextGroups = [
8
9
  {
9
10
  id: 'green',
@@ -49,7 +50,7 @@ let contextGroups = [
49
50
  }
50
51
  ];
51
52
  /**
52
- * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking **THE INTEROP API IS EXPERIMENTAL. IF YOU WOULD LIKE TO USE IT, PLEASE USE OUR DEFAULT IMPLEMENTATION IN BROWSER**}
53
+ * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
53
54
  *
54
55
  * The Interop Broker is responsible for keeping track of the Interop state of the Platform, and for directing messages to the proper locations.
55
56
  *
@@ -147,7 +148,7 @@ let contextGroups = [
147
148
  * };
148
149
  * return new Override();
149
150
  * },
150
- * interopOverride: async (InteropBroker, provider, options, ...args) => {
151
+ * interopOverride: async (InteropBroker) => {
151
152
  * class Override extends InteropBroker {
152
153
  * async joinContextGroup(channelName = 'default', target) {
153
154
  * console.log('before super joinContextGroup')
@@ -156,37 +157,7 @@ let contextGroups = [
156
157
  * }
157
158
  * }
158
159
  *
159
- * options.contextGroups = [
160
- * {
161
- * id: 'green',
162
- * displayMetadata: {
163
- * color: '#00CC88',
164
- * name: 'green'
165
- * }
166
- * },
167
- * {
168
- * id: 'purple',
169
- * displayMetadata: {
170
- * color: '#8C61FF',
171
- * name: 'purple'
172
- * }
173
- * },
174
- * {
175
- * id: 'orange',
176
- * displayMetadata: {
177
- * color: '#FF8C4C',
178
- * name: 'orange'
179
- * }
180
- * },
181
- * {
182
- * id: 'red',
183
- * displayMetadata: {
184
- * color: '#FF5E60',
185
- * name: 'red'
186
- * }
187
- * }
188
- * ];
189
- * return new Override(provider, options, ...args);
160
+ * return new Override();
190
161
  * }
191
162
  * });
192
163
  * ```
@@ -198,6 +169,7 @@ let contextGroups = [
198
169
  */
199
170
  class InteropBroker extends base_1.Base {
200
171
  constructor(wire, getProvider, options) {
172
+ // Tip from Pierre and Michael from the overrideCheck work: Don't use bound methods for overrideable InteropBroker functions.
201
173
  super(wire);
202
174
  this.getProvider = getProvider;
203
175
  this.interopClients = new Map();
@@ -214,46 +186,73 @@ class InteropBroker extends base_1.Base {
214
186
  this.setContextGroupMap();
215
187
  this.setupChannelProvider();
216
188
  }
189
+ static createClosedConstructor(...args) {
190
+ return class OverrideableBroker extends InteropBroker {
191
+ constructor(...unused) {
192
+ if (unused.length) {
193
+ const [_ignore1, ignore2, opts] = unused;
194
+ if (opts && typeof opts === 'object' && !(0, lodash_1.isEqual)(opts, args[2])) {
195
+ // eslint-disable-next-line no-console
196
+ console.warn('You have modified the parameters of the InteropOverride constructor. This behavior is deprecated and will be removed in a future version. You can modify these options in your manifest. Please consult our Interop docs for guidance on migrating to the new override scheme.');
197
+ super(args[0], args[1], opts);
198
+ return;
199
+ }
200
+ // eslint-disable-next-line no-console
201
+ console.warn('You are attempting to pass arguments to the InteropOverride constructor. This is not necessary, and these passed arguments will be ignored. You are likely using an older InteropBroker override scheme. Please consult our Interop docs for guidance on migrating to the new override scheme.');
202
+ }
203
+ super(...args);
204
+ }
205
+ };
206
+ }
217
207
  /*
218
208
  Client API
219
209
  */
220
210
  /**
211
+ * @REMOVED
221
212
  * SetContextOptions interface
222
213
  * @typedef { object } SetContextOptions
223
214
  * @property { Context } {context} - New context to set.
224
215
  */
225
216
  /**
217
+ * @REMOVED
226
218
  * GetContextOptions interface
227
219
  * @typedef { object } GetContextOptions
228
220
  * @property { string } [contextType] - Context Type
229
221
  */
222
+ // TODO: extract inline type and do proper comments
230
223
  /**
224
+ * @REMOVED
231
225
  * JoinContextGroupOptions interface
232
226
  * @typedef { object } JoinContextGroupOptions
233
227
  * @property { string } contextGroupId - Id of the context group.
234
228
  * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
235
229
  */
236
230
  /**
231
+ * @REMOVED
237
232
  * AddClientToContextGroupOptions interface
238
233
  * @typedef { object } AddClientToContextGroupOptions
239
234
  * @property { string } contextGroupId - Name of the context group.
240
235
  */
241
236
  /**
237
+ * @REMOVED
242
238
  * RemoveFromContextGroupOptions interface
243
239
  * @typedef { object } RemoveFromContextGroupOptions
244
240
  * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
245
241
  */
246
242
  /**
243
+ * @REMOVED
247
244
  * GetInfoForContextGroupOptions interface
248
245
  * @typedef { object } GetInfoForContextGroupOptions
249
246
  * @property { string } contextGroupId - Name of the context group to get info for.
250
247
  */
251
248
  /**
249
+ * @REMOVED
252
250
  * GetAllClientsInContextGroupOptions interface
253
251
  * @typedef { object } GetAllClientsInContextGroupOptions
254
252
  * @property { string } contextGroupId - Name of the context group to get info for.
255
253
  */
256
254
  /**
255
+ * @PORTED
257
256
  * InfoForIntentOptions interface
258
257
  * @typedef { object } InfoForIntentOptions
259
258
  * @property { string } name Name of the intent to get info for.
@@ -264,7 +263,6 @@ class InteropBroker extends base_1.Base {
264
263
  * @param { SetContextOptions } setContextOptions - New context to set.
265
264
  * @param { ClientIdentity } clientIdentity - Identity of the client sender.
266
265
  * @return { void }
267
- * @experimental
268
266
  */
269
267
  setContext({ context }, clientIdentity) {
270
268
  this.wire.sendAction('interop-broker-set-context').catch((e) => {
@@ -338,7 +336,6 @@ class InteropBroker extends base_1.Base {
338
336
  * @return { Promise<void> }
339
337
  * @param { JoinContextGroupOptions } joinContextGroupOptions - Id of the Context Group and identity of the entity to join to the group.
340
338
  * @param { ClientIdentity } senderIdentity - Identity of the client sender.
341
- * @experimental
342
339
  */
343
340
  async joinContextGroup({ contextGroupId, target }, senderIdentity) {
344
341
  this.wire.sendAction('interop-broker-join-context-group').catch((e) => {
@@ -384,7 +381,6 @@ class InteropBroker extends base_1.Base {
384
381
  * @return { Promise<void> }
385
382
  * @param { AddClientToContextGroupOptions } addClientToContextGroupOptions - Contains the contextGroupId
386
383
  * @param { ClientIdentity } clientIdentity - Identity of the client sender.
387
- * @experimental
388
384
  */
389
385
  async addClientToContextGroup({ contextGroupId }, clientIdentity) {
390
386
  this.wire.sendAction('interop-broker-add-client-to-context-group').catch((e) => {
@@ -428,7 +424,6 @@ class InteropBroker extends base_1.Base {
428
424
  * @return { Promise<void> }
429
425
  * @param { RemoveFromContextGroupOptions } removeFromContextGroupOptions - Contains the target identity to remove.
430
426
  * @param { ClientIdentity } senderIdentity - Identity of the client sender.
431
- * @experimental
432
427
  */
433
428
  async removeFromContextGroup({ target }, senderIdentity) {
434
429
  this.wire.sendAction('interop-broker-remove-from-context-group').catch((e) => {
@@ -469,7 +464,6 @@ class InteropBroker extends base_1.Base {
469
464
  * Used by Platform Windows.
470
465
  * @return { Promise<void> }
471
466
  * @property { ClientIdentity } clientIdentity - Identity of the client sender.
472
- * @experimental
473
467
  */
474
468
  async removeClientFromContextGroup(clientIdentity) {
475
469
  this.wire.sendAction('interop-broker-remove-client-from-context-group').catch((e) => {
@@ -486,7 +480,6 @@ class InteropBroker extends base_1.Base {
486
480
  * Returns the Interop-Broker-defined context groups available for an entity to join. Because this function is used in the rest of the Interop Broker to fetch the Context Groups, overriding this allows you to customize the Context Groups for the Interop Broker. However, we recommend customizing the context groups through configuration instead.
487
481
  * Used by Platform Windows.
488
482
  * @return { Promise<ContextGroupInfo[]>}
489
- * @experimental
490
483
  */
491
484
  // eslint-disable-next-line class-methods-use-this
492
485
  getContextGroups() {
@@ -504,7 +497,6 @@ class InteropBroker extends base_1.Base {
504
497
  * Used by Platform Windows.
505
498
  * @param { GetInfoForContextGroupOptions } getInfoForContextGroupOptions - Contains contextGroupId, the context group you wish to get display info for.
506
499
  * @return { Promise<ContextGroupInfo>}
507
- * @experimental
508
500
  */
509
501
  getInfoForContextGroup({ contextGroupId }) {
510
502
  this.wire.sendAction('interop-broker-get-info-for-context-group').catch((e) => {
@@ -518,7 +510,6 @@ class InteropBroker extends base_1.Base {
518
510
  * Used by Platform Windows.
519
511
  * @param { GetAllClientsInContextGroupOptions } getAllClientsInContextGroupOptions - Contains contextGroupId, the context group you wish to get clients for.
520
512
  * @return { Promise<ClientIdentity[]>}
521
- * @experimental
522
513
  */
523
514
  getAllClientsInContextGroup({ contextGroupId }) {
524
515
  this.wire.sendAction('interop-broker-get-all-clients-in-context-group').catch((e) => {
@@ -538,7 +529,6 @@ class InteropBroker extends base_1.Base {
538
529
  * @param { ClientIdentity } clientIdentity Identity of the Client making the request.
539
530
  * @return { Promise<unknown> }
540
531
  * @tutorial interop.handleFiredIntent
541
- * @experimental
542
532
  */
543
533
  // eslint-disable-next-line class-methods-use-this
544
534
  async handleFiredIntent(intent, clientIdentity) {
@@ -552,7 +542,6 @@ class InteropBroker extends base_1.Base {
552
542
  * @param { Intent } intent The combination of an action and a context that is passed to an application for resolution.
553
543
  * @param { Identity } target - Identity of the target that will handle the intent.
554
544
  * @return { Promise<void> }
555
- * @experimental
556
545
  */
557
546
  async setIntentTarget(intent, target) {
558
547
  this.wire.sendAction('interop-broker-set-intent-target').catch((e) => {
@@ -596,7 +585,6 @@ class InteropBroker extends base_1.Base {
596
585
  * @param { ClientIdentity } clientIdentity Identity of the Client making the request.
597
586
  * @return { Promise<unknown> }
598
587
  * @tutorial interop.handleInfoForIntent
599
- * @experimental
600
588
  */
601
589
  // eslint-disable-next-line class-methods-use-this
602
590
  async handleInfoForIntent(options, clientIdentity) {
@@ -611,7 +599,6 @@ class InteropBroker extends base_1.Base {
611
599
  * @param { ClientIdentity } clientIdentity Identity of the Client making the request.
612
600
  * @return { Promise<unknown> }
613
601
  * @tutorial interop.handleInfoForIntentsByContext
614
- * @experimental
615
602
  */
616
603
  // eslint-disable-next-line class-methods-use-this
617
604
  async handleInfoForIntentsByContext(context, clientIdentity) {
@@ -626,7 +613,6 @@ class InteropBroker extends base_1.Base {
626
613
  * @param { ClientIdentity } clientIdentity Identity of the Client making the request.
627
614
  * @return { Promise<unknown> }
628
615
  * @tutorial interop.handleFiredIntentForContext
629
- * @experimental
630
616
  */
631
617
  // eslint-disable-next-line class-methods-use-this
632
618
  async handleFiredIntentForContext(contextForIntent, clientIdentity) {
@@ -746,7 +732,7 @@ class InteropBroker extends base_1.Base {
746
732
  * FDC3 2.0: Use the endpointId in the ClientInfo as the instanceId when generating
747
733
  * an AppIdentifier.
748
734
  * @return { Promise<Array<ClientInfo>> }
749
- * @tutorial interop.getAllClientInfo()
735
+ * @tutorial interop.getAllClientInfo
750
736
  */
751
737
  async getAllClientInfo() {
752
738
  const provider = await this.getProvider();
@@ -1,13 +1,15 @@
1
1
  import type * as OpenFin from '../../OpenFin';
2
- import Transport from '../../transport/transport';
2
+ import { Transport } from '../../transport/transport';
3
3
  import { Base } from '../base';
4
4
  /**
5
+ * @PORTED
5
6
  * @typedef { object } Intent
6
7
  * @summary The combination of an action and a context that is passed to an application for resolution.
7
8
  * @property { string } name Name of the intent.
8
9
  * @property { Context } context Data associated with the intent
9
10
  */
10
11
  /**
12
+ * @REMOVED
11
13
  * @typedef { object } Subscription
12
14
  * @summary Object returned when subscribing a handler.
13
15
  * @property { function } unsubscribe Function to unsubscribe the handler.
@@ -21,6 +23,7 @@ import { Base } from '../base';
21
23
  * @summary Subscription function for registerIntentHandler
22
24
  */
23
25
  /**
26
+ * @PORTED
24
27
  * @typedef { object } ClientIdentity
25
28
  * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
26
29
  * @property {string} uuid GUID of an application.
@@ -28,12 +31,14 @@ import { Base } from '../base';
28
31
  * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
29
32
  */
30
33
  /**
34
+ * @PORTED
31
35
  * @typedef { object } ContextGroupInfo
32
36
  * @summary Information for a Context Group. Contains metadata for displaying the group properly.
33
37
  * @property {string} id Name of the context group
34
38
  * @property {DisplayMetadata} displayMetadata Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.
35
39
  */
36
40
  /**
41
+ * @PORTED
37
42
  * @typedef { object } DisplayMetadata
38
43
  * @summary The display data for a Context Group.
39
44
  * @property {string} name A user-readable name for this context group, e.g: `"Red"`
@@ -41,6 +46,7 @@ import { Base } from '../base';
41
46
  * @property {string} [glyph] A URL of an image that can be used to display this context group
42
47
  */
43
48
  /**
49
+ * @PORTED
44
50
  * @typedef { object } Context
45
51
  * @summary Data passed between entities and applications.
46
52
  * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
@@ -48,6 +54,7 @@ import { Base } from '../base';
48
54
  * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
49
55
  */
50
56
  /**
57
+ * @REMOVED
51
58
  * @typedef { object } ContextForIntent
52
59
  * @summary Data passed between entities and applications, including an optional metadata.
53
60
  * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
@@ -56,6 +63,7 @@ import { Base } from '../base';
56
63
  * @property {any} [metadata]
57
64
  */
58
65
  /**
66
+ * @REMOVED
59
67
  * @typedef { object } SessionContextGroup
60
68
  * @summary An instance of a SessionContextGroup
61
69
  * @property {string} id The SessionContextGroup's id.
@@ -83,7 +91,7 @@ import { Base } from '../base';
83
91
  * @return {Promise<void>}
84
92
  */
85
93
  /**
86
- * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking **THE INTEROP API IS EXPERIMENTAL. IF YOU WOULD LIKE TO USE IT, PLEASE USE OUR DEFAULT IMPLEMENTATION IN BROWSER**}
94
+ * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
87
95
  *
88
96
  * The Interop Client API is broken up into two groups:
89
97
  *
@@ -207,7 +215,6 @@ export declare class InteropClient extends Base {
207
215
  * @param { Intent } intent - The combination of an action and a context that is passed to an application for resolution.
208
216
  * @return { Promise<unknown>}
209
217
  * @tutorial interop.fireIntent
210
- * @experimental
211
218
  */
212
219
  fireIntent<T = unknown>(intent: OpenFin.Intent): Promise<T>;
213
220
  /**
@@ -216,7 +223,6 @@ export declare class InteropClient extends Base {
216
223
  * @param { string } intentName - The name of an intent.
217
224
  * @return { Promise<Subscription> }
218
225
  * @tutorial interop.registerIntentHandler
219
- * @experimental
220
226
  */
221
227
  registerIntentHandler(handler: OpenFin.IntentHandler, intentName: string, options?: any): Promise<{
222
228
  unsubscribe: () => Promise<void>;
@@ -227,7 +233,6 @@ export declare class InteropClient extends Base {
227
233
  * @param { string } [contextType]
228
234
  * @return { Promise<Context> }
229
235
  * @tutorial interop.getCurrentContext
230
- * @experimental
231
236
  */
232
237
  getCurrentContext(contextType?: string): Promise<OpenFin.Context>;
233
238
  /**
@@ -235,7 +240,6 @@ export declare class InteropClient extends Base {
235
240
  * @param { InfoForIntentOptions } options
236
241
  * @return { Promise<unknown> }
237
242
  * @tutorial interop.getInfoForIntent
238
- * @experimental
239
243
  */
240
244
  getInfoForIntent<T = unknown>(options: OpenFin.InfoForIntentOptions): Promise<T>;
241
245
  /**
@@ -243,7 +247,6 @@ export declare class InteropClient extends Base {
243
247
  * @param { Context } context
244
248
  * @return { Promise<unknown> }
245
249
  * @tutorial interop.getInfoForIntentsByContext
246
- * @experimental
247
250
  */
248
251
  getInfoForIntentsByContext<T = unknown>(context: OpenFin.Context): Promise<T>;
249
252
  /**
@@ -252,7 +255,6 @@ export declare class InteropClient extends Base {
252
255
  * @param { ContextForIntent } context
253
256
  * @return { Promise<unknown> }
254
257
  * @tutorial interop.fireIntentForContext
255
- * @experimental
256
258
  */
257
259
  fireIntentForContext<T = unknown>(context: OpenFin.ContextForIntent): Promise<T>;
258
260
  /**
@@ -262,7 +264,6 @@ export declare class InteropClient extends Base {
262
264
  * @param { string } sessionContextGroupId - Id of the context group.
263
265
  * @return { Promise<SessionContextGroup>}
264
266
  * @tutorial interop.joinSessionContextGroup
265
- * @experimental
266
267
  */
267
268
  joinSessionContextGroup(sessionContextGroupId: string): Promise<OpenFin.SessionContextGroup>;
268
269
  /**