@genesislcap/foundation-fdc3 14.192.2-fdc3-enhancements.3 → 14.192.2-fdc3-enhancements.5
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/dts/fdc3.d.ts +10 -4
- package/dist/dts/fdc3.d.ts.map +1 -1
- package/dist/dts/util/fdc3-listener.d.ts +1 -1
- package/dist/dts/util/fdc3-listener.d.ts.map +1 -1
- package/dist/esm/fdc3.js +13 -2
- package/dist/esm/util/fdc3-listener.js +7 -5
- package/dist/foundation-fdc3.api.json +48 -11
- package/dist/foundation-fdc3.d.ts +11 -5
- package/docs/api/foundation-fdc3.fdc3.addchannellistener.md +3 -3
- package/docs/api/foundation-fdc3.fdc3.isinteropfdc3.md +13 -0
- package/docs/api/foundation-fdc3.fdc3.md +2 -1
- package/docs/api-report.md +6 -3
- package/package.json +14 -14
- package/test/fdc3.mock.ts +5 -0
package/dist/dts/fdc3.d.ts
CHANGED
|
@@ -41,6 +41,11 @@ export interface FDC3 {
|
|
|
41
41
|
* @public
|
|
42
42
|
*/
|
|
43
43
|
isReady: boolean;
|
|
44
|
+
/**
|
|
45
|
+
* Check if the interop global is available.
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
isInteropFdc3: () => boolean;
|
|
44
49
|
/**
|
|
45
50
|
* Observable which emits the current channel
|
|
46
51
|
* When a new channel is joined a new value is emitted
|
|
@@ -111,11 +116,11 @@ export interface FDC3 {
|
|
|
111
116
|
broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
|
|
112
117
|
/**
|
|
113
118
|
* Helper function to add a context listener on a channel with a handler for channel messages
|
|
114
|
-
* @param
|
|
115
|
-
* @param channelType - type of the channel
|
|
119
|
+
* @param channel - instance of a channel
|
|
120
|
+
* @param channelType - type of the channel context
|
|
116
121
|
* @param callback - handler to for the channel context listener
|
|
117
122
|
* */
|
|
118
|
-
addChannelListener(
|
|
123
|
+
addChannelListener(channel: FDC3Channel | Channel, channelType: string, callback: (any: any) => void): Promise<Channel>;
|
|
119
124
|
/**
|
|
120
125
|
* Helper function to get the current channel of the application
|
|
121
126
|
* */
|
|
@@ -129,6 +134,7 @@ export declare class DefaultFDC3 implements FDC3 {
|
|
|
129
134
|
isReady: boolean;
|
|
130
135
|
private _currentChannel$;
|
|
131
136
|
currentChannelObs: Observable<Channel>;
|
|
137
|
+
isInteropFdc3: () => boolean;
|
|
132
138
|
constructor();
|
|
133
139
|
private connect;
|
|
134
140
|
addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
|
|
@@ -140,7 +146,7 @@ export declare class DefaultFDC3 implements FDC3 {
|
|
|
140
146
|
broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
|
|
141
147
|
broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
|
|
142
148
|
broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
|
|
143
|
-
addChannelListener(
|
|
149
|
+
addChannelListener(channel: FDC3Channel | Channel, channelType: string, callback: (any: any) => void): Promise<FDC3Channel | Channel>;
|
|
144
150
|
getCurrentChannel(): Promise<Channel>;
|
|
145
151
|
private broadcastMessageOnChannel;
|
|
146
152
|
}
|
package/dist/dts/fdc3.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fdc3.d.ts","sourceRoot":"","sources":["../../src/fdc3.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAEL,SAAS,EACT,OAAO,EACP,OAAO,EACP,cAAc,EAOd,OAAO,EACP,gBAAgB,EAKjB,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,UAAU,EAAW,MAAM,MAAM,CAAC;AAI3C;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC;AAElC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,cAAc,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,SAAS;CAAG;AAEnD;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO;CAAG;AAE/C;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;CAAG;AAEjE;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO;CAAG;AAE/C;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;;OAIG;IACH,iBAAiB,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IAE3C;;;;OAIG;IACH,kBAAkB,CAAC,SAAS,EAAE,GAAG,CAAC,WAAW,EAAE,kBAAkB,CAAC,GAAG,IAAI,CAAC;IAE1E;;;;;;OAMG;IACH,UAAU,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAE/E;;;;;OAKG;IACH,oBAAoB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAErE;;;;;;OAMG;IACH,WAAW,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEvF;;;;;OAKG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAE5D;;;;;OAKG;IACH,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnF;;;;OAIG;IACH,yBAAyB,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtE;;;;OAIG;IACH,8BAA8B,CAC5B,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAEtC;;;;;SAKK;IACL,kBAAkB,CAChB,
|
|
1
|
+
{"version":3,"file":"fdc3.d.ts","sourceRoot":"","sources":["../../src/fdc3.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAEL,SAAS,EACT,OAAO,EACP,OAAO,EACP,cAAc,EAOd,OAAO,EACP,gBAAgB,EAKjB,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,UAAU,EAAW,MAAM,MAAM,CAAC;AAI3C;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC;AAElC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,cAAc,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,SAAS;CAAG;AAEnD;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO;CAAG;AAE/C;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;CAAG;AAEjE;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO;CAAG;AAE/C;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,aAAa,EAAE,MAAM,OAAO,CAAC;IAE7B;;;;OAIG;IACH,iBAAiB,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IAE3C;;;;OAIG;IACH,kBAAkB,CAAC,SAAS,EAAE,GAAG,CAAC,WAAW,EAAE,kBAAkB,CAAC,GAAG,IAAI,CAAC;IAE1E;;;;;;OAMG;IACH,UAAU,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAE/E;;;;;OAKG;IACH,oBAAoB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAErE;;;;;;OAMG;IACH,WAAW,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEvF;;;;;OAKG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAE5D;;;;;OAKG;IACH,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnF;;;;OAIG;IACH,yBAAyB,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtE;;;;OAIG;IACH,8BAA8B,CAC5B,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAEtC;;;;;SAKK;IACL,kBAAkB,CAChB,OAAO,EAAE,WAAW,GAAG,OAAO,EAC9B,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,CAAC,GAAG,KAAA,KAAK,IAAI,GACtB,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpB;;SAEK;IACL,iBAAiB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CACvC;AAED;;;GAGG;AACH,qBAAa,WAAY,YAAW,IAAI;IAE/B,OAAO,UAAS;IAEvB,OAAO,CAAC,gBAAgB,CAA0B;IAElD,iBAAiB,EAAE,UAAU,CAAC,OAAO,CAAC,CAAwC;IAE9E,aAAa,QAAO,OAAO,CAAyB;;YAMtC,OAAO;IAuBd,kBAAkB,CAAC,SAAS,EAAE,GAAG,CAAC,WAAW,EAAE,kBAAkB,CAAC,GAAG,IAAI;IAOzE,UAAU,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC;IAK9E,oBAAoB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAKpE,WAAW,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAchF,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnD,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAKrD,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAKlF,yBAAyB,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKrE,8BAA8B,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,eAC1D,GAAG;IAOT,kBAAkB,CAC7B,OAAO,EAAE,WAAW,GAAG,OAAO,EAC9B,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,CAAC,GAAG,KAAA,KAAK,IAAI;IAMZ,iBAAiB,IAAI,OAAO,CAAC,OAAO,CAAC;IAIlD,OAAO,CAAC,yBAAyB;CAUlC;AAED;;;GAGG;AACH,eAAO,MAAM,IAAI,4DAA4D,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fdc3-listener.d.ts","sourceRoot":"","sources":["../../../src/util/fdc3-listener.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"fdc3-listener.d.ts","sourceRoot":"","sources":["../../../src/util/fdc3-listener.ts"],"names":[],"mappings":"AAEA,OAAO,EAAiB,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAEzE,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAE/B;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,CAAC,GAAG,KAAA,KAAK,IAAI,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,CAAC,GAAG,KAAA,KAAK,IAAI,CAAC;CACzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAED;;;GAGG;AACH,qBAGa,YAAa,SAAQ,iBAAiC;IAC3D,IAAI,EAAE,IAAI,CAAC;IAEjB,YAAY,EAAE,YAAY,EAAE,CAAM;IAElC,aAAa,EAAE,aAAa,EAAE,CAAM;IAEpC,OAAO,CAAC,mBAAmB,CAAsB;IAExC,SAAS,IAAI,IAAI;IA0B1B,iBAAiB;IAsBjB,oBAAoB;CAIrB"}
|
package/dist/esm/fdc3.js
CHANGED
|
@@ -17,14 +17,26 @@ export class DefaultFDC3 {
|
|
|
17
17
|
this.isReady = false;
|
|
18
18
|
this._currentChannel$ = new Subject();
|
|
19
19
|
this.currentChannelObs = this._currentChannel$.asObservable();
|
|
20
|
+
this.isInteropFdc3 = () => !!window.io;
|
|
20
21
|
this.connect();
|
|
21
22
|
}
|
|
22
23
|
connect() {
|
|
24
|
+
var _a, _b;
|
|
23
25
|
return __awaiter(this, void 0, void 0, function* () {
|
|
24
26
|
try {
|
|
25
27
|
this.isReady = false;
|
|
26
28
|
yield fdc3Ready();
|
|
27
29
|
logger.debug('fdc3 connection success');
|
|
30
|
+
const channel = yield getCurrentChannel();
|
|
31
|
+
if (channel) {
|
|
32
|
+
this._currentChannel$.next(channel);
|
|
33
|
+
}
|
|
34
|
+
if (this.isInteropFdc3()) {
|
|
35
|
+
// Listen to changes from the io channel selector.
|
|
36
|
+
// This can be done on the interop container window which is outside this app scope
|
|
37
|
+
// Any changes made there will be emitted here and keep channel state in sync
|
|
38
|
+
(_b = (_a = window.io) === null || _a === void 0 ? void 0 : _a.channels) === null || _b === void 0 ? void 0 : _b.onChanged((ioChannel) => this._currentChannel$.next(ioChannel));
|
|
39
|
+
}
|
|
28
40
|
}
|
|
29
41
|
catch (err) {
|
|
30
42
|
logger.error('fdc3 connection error', err);
|
|
@@ -92,9 +104,8 @@ export class DefaultFDC3 {
|
|
|
92
104
|
});
|
|
93
105
|
});
|
|
94
106
|
}
|
|
95
|
-
addChannelListener(
|
|
107
|
+
addChannelListener(channel, channelType, callback) {
|
|
96
108
|
return __awaiter(this, void 0, void 0, function* () {
|
|
97
|
-
const channel = yield getOrCreateChannel(channelName);
|
|
98
109
|
channel.addContextListener(channelType, callback);
|
|
99
110
|
return channel;
|
|
100
111
|
});
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import { __decorate } from "tslib";
|
|
1
|
+
import { __awaiter, __decorate } from "tslib";
|
|
2
|
+
import { getOrCreateChannel } from '@finos/fdc3';
|
|
2
3
|
import { LifecycleMixin } from '@genesislcap/foundation-utils';
|
|
3
4
|
import { customElement, FoundationElement } from '@genesislcap/web-core';
|
|
4
5
|
import { Subscription } from 'rxjs';
|
|
@@ -42,16 +43,17 @@ let Fdc3Listener = class Fdc3Listener extends LifecycleMixin(FoundationElement)
|
|
|
42
43
|
const listeners = new Map();
|
|
43
44
|
this.intentConfig.forEach((intent) => listeners.set(intent.intent, intent.callback));
|
|
44
45
|
this.fdc3.addIntentListeners(listeners);
|
|
45
|
-
this.channelConfig.forEach((c) => {
|
|
46
|
+
this.channelConfig.forEach((c) => __awaiter(this, void 0, void 0, function* () {
|
|
46
47
|
if (c.channelName) {
|
|
47
|
-
|
|
48
|
+
const channel = yield getOrCreateChannel(c.channelName);
|
|
49
|
+
this.fdc3.addChannelListener(channel, c.channelType, c.callback);
|
|
48
50
|
}
|
|
49
51
|
else {
|
|
50
52
|
this.channelSubscription.add(this.fdc3.currentChannelObs.subscribe((channel) => {
|
|
51
|
-
this.fdc3.addChannelListener(channel
|
|
53
|
+
this.fdc3.addChannelListener(channel, c.channelType, c.callback);
|
|
52
54
|
}));
|
|
53
55
|
}
|
|
54
|
-
});
|
|
56
|
+
}));
|
|
55
57
|
}
|
|
56
58
|
}
|
|
57
59
|
disconnectedCallback() {
|
|
@@ -202,15 +202,25 @@
|
|
|
202
202
|
{
|
|
203
203
|
"kind": "MethodSignature",
|
|
204
204
|
"canonicalReference": "@genesislcap/foundation-fdc3!FDC3#addChannelListener:member(1)",
|
|
205
|
-
"docComment": "/**\n * Helper function to add a context listener on a channel with a handler for channel messages\n *\n * @param
|
|
205
|
+
"docComment": "/**\n * Helper function to add a context listener on a channel with a handler for channel messages\n *\n * @param channel - instance of a channel\n *\n * @param channelType - type of the channel context\n *\n * @param callback - handler to for the channel context listener\n */\n",
|
|
206
206
|
"excerptTokens": [
|
|
207
207
|
{
|
|
208
208
|
"kind": "Content",
|
|
209
|
-
"text": "addChannelListener(
|
|
209
|
+
"text": "addChannelListener(channel: "
|
|
210
|
+
},
|
|
211
|
+
{
|
|
212
|
+
"kind": "Reference",
|
|
213
|
+
"text": "FDC3Channel",
|
|
214
|
+
"canonicalReference": "@genesislcap/foundation-fdc3!FDC3Channel:interface"
|
|
210
215
|
},
|
|
211
216
|
{
|
|
212
217
|
"kind": "Content",
|
|
213
|
-
"text": "
|
|
218
|
+
"text": " | "
|
|
219
|
+
},
|
|
220
|
+
{
|
|
221
|
+
"kind": "Reference",
|
|
222
|
+
"text": "Channel",
|
|
223
|
+
"canonicalReference": "@finos/fdc3!Channel:interface"
|
|
214
224
|
},
|
|
215
225
|
{
|
|
216
226
|
"kind": "Content",
|
|
@@ -257,33 +267,33 @@
|
|
|
257
267
|
],
|
|
258
268
|
"isOptional": false,
|
|
259
269
|
"returnTypeTokenRange": {
|
|
260
|
-
"startIndex":
|
|
261
|
-
"endIndex":
|
|
270
|
+
"startIndex": 9,
|
|
271
|
+
"endIndex": 13
|
|
262
272
|
},
|
|
263
273
|
"releaseTag": "Public",
|
|
264
274
|
"overloadIndex": 1,
|
|
265
275
|
"parameters": [
|
|
266
276
|
{
|
|
267
|
-
"parameterName": "
|
|
277
|
+
"parameterName": "channel",
|
|
268
278
|
"parameterTypeTokenRange": {
|
|
269
279
|
"startIndex": 1,
|
|
270
|
-
"endIndex":
|
|
280
|
+
"endIndex": 4
|
|
271
281
|
},
|
|
272
282
|
"isOptional": false
|
|
273
283
|
},
|
|
274
284
|
{
|
|
275
285
|
"parameterName": "channelType",
|
|
276
286
|
"parameterTypeTokenRange": {
|
|
277
|
-
"startIndex":
|
|
278
|
-
"endIndex":
|
|
287
|
+
"startIndex": 5,
|
|
288
|
+
"endIndex": 6
|
|
279
289
|
},
|
|
280
290
|
"isOptional": false
|
|
281
291
|
},
|
|
282
292
|
{
|
|
283
293
|
"parameterName": "callback",
|
|
284
294
|
"parameterTypeTokenRange": {
|
|
285
|
-
"startIndex":
|
|
286
|
-
"endIndex":
|
|
295
|
+
"startIndex": 7,
|
|
296
|
+
"endIndex": 8
|
|
287
297
|
},
|
|
288
298
|
"isOptional": false
|
|
289
299
|
}
|
|
@@ -860,6 +870,33 @@
|
|
|
860
870
|
],
|
|
861
871
|
"name": "getOrCreateChannel"
|
|
862
872
|
},
|
|
873
|
+
{
|
|
874
|
+
"kind": "PropertySignature",
|
|
875
|
+
"canonicalReference": "@genesislcap/foundation-fdc3!FDC3#isInteropFdc3:member",
|
|
876
|
+
"docComment": "/**\n * Check if the interop global is available.\n *\n * @public\n */\n",
|
|
877
|
+
"excerptTokens": [
|
|
878
|
+
{
|
|
879
|
+
"kind": "Content",
|
|
880
|
+
"text": "isInteropFdc3: "
|
|
881
|
+
},
|
|
882
|
+
{
|
|
883
|
+
"kind": "Content",
|
|
884
|
+
"text": "() => boolean"
|
|
885
|
+
},
|
|
886
|
+
{
|
|
887
|
+
"kind": "Content",
|
|
888
|
+
"text": ";"
|
|
889
|
+
}
|
|
890
|
+
],
|
|
891
|
+
"isReadonly": false,
|
|
892
|
+
"isOptional": false,
|
|
893
|
+
"releaseTag": "Public",
|
|
894
|
+
"name": "isInteropFdc3",
|
|
895
|
+
"propertyTypeTokenRange": {
|
|
896
|
+
"startIndex": 1,
|
|
897
|
+
"endIndex": 2
|
|
898
|
+
}
|
|
899
|
+
},
|
|
863
900
|
{
|
|
864
901
|
"kind": "PropertySignature",
|
|
865
902
|
"canonicalReference": "@genesislcap/foundation-fdc3!FDC3#isReady:member",
|
|
@@ -23,7 +23,7 @@ import { ViewTemplate } from '@microsoft/fast-element';
|
|
|
23
23
|
* @alpha
|
|
24
24
|
*/
|
|
25
25
|
export declare interface ChannelConfig {
|
|
26
|
-
channelName
|
|
26
|
+
channelName?: string;
|
|
27
27
|
channelType: string;
|
|
28
28
|
callback: (any: any) => void;
|
|
29
29
|
}
|
|
@@ -36,6 +36,7 @@ export declare class DefaultFDC3 implements FDC3 {
|
|
|
36
36
|
isReady: boolean;
|
|
37
37
|
private _currentChannel$;
|
|
38
38
|
currentChannelObs: Observable<Channel>;
|
|
39
|
+
isInteropFdc3: () => boolean;
|
|
39
40
|
constructor();
|
|
40
41
|
private connect;
|
|
41
42
|
addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
|
|
@@ -47,7 +48,7 @@ export declare class DefaultFDC3 implements FDC3 {
|
|
|
47
48
|
broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
|
|
48
49
|
broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
|
|
49
50
|
broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
|
|
50
|
-
addChannelListener(
|
|
51
|
+
addChannelListener(channel: FDC3Channel | Channel, channelType: string, callback: (any: any) => void): Promise<FDC3Channel | Channel>;
|
|
51
52
|
getCurrentChannel(): Promise<Channel>;
|
|
52
53
|
private broadcastMessageOnChannel;
|
|
53
54
|
}
|
|
@@ -62,6 +63,11 @@ export declare interface FDC3 {
|
|
|
62
63
|
* @public
|
|
63
64
|
*/
|
|
64
65
|
isReady: boolean;
|
|
66
|
+
/**
|
|
67
|
+
* Check if the interop global is available.
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
isInteropFdc3: () => boolean;
|
|
65
71
|
/**
|
|
66
72
|
* Observable which emits the current channel
|
|
67
73
|
* When a new channel is joined a new value is emitted
|
|
@@ -132,11 +138,11 @@ export declare interface FDC3 {
|
|
|
132
138
|
broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
|
|
133
139
|
/**
|
|
134
140
|
* Helper function to add a context listener on a channel with a handler for channel messages
|
|
135
|
-
* @param
|
|
136
|
-
* @param channelType - type of the channel
|
|
141
|
+
* @param channel - instance of a channel
|
|
142
|
+
* @param channelType - type of the channel context
|
|
137
143
|
* @param callback - handler to for the channel context listener
|
|
138
144
|
* */
|
|
139
|
-
addChannelListener(
|
|
145
|
+
addChannelListener(channel: FDC3Channel | Channel, channelType: string, callback: (any: any) => void): Promise<Channel>;
|
|
140
146
|
/**
|
|
141
147
|
* Helper function to get the current channel of the application
|
|
142
148
|
* */
|
|
@@ -9,15 +9,15 @@ Helper function to add a context listener on a channel with a handler for channe
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
addChannelListener(
|
|
12
|
+
addChannelListener(channel: FDC3Channel | Channel, channelType: string, callback: (any: any) => void): Promise<Channel>;
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
17
17
|
| Parameter | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
|
-
|
|
|
20
|
-
| channelType | string | type of the channel |
|
|
19
|
+
| channel | [FDC3Channel](./foundation-fdc3.fdc3channel.md) \| Channel | instance of a channel |
|
|
20
|
+
| channelType | string | type of the channel context |
|
|
21
21
|
| callback | (any: any) => void | handler to for the channel context listener |
|
|
22
22
|
|
|
23
23
|
**Returns:**
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-fdc3](./foundation-fdc3.md) > [FDC3](./foundation-fdc3.fdc3.md) > [isInteropFdc3](./foundation-fdc3.fdc3.isinteropfdc3.md)
|
|
4
|
+
|
|
5
|
+
## FDC3.isInteropFdc3 property
|
|
6
|
+
|
|
7
|
+
Check if the interop global is available.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
isInteropFdc3: () => boolean;
|
|
13
|
+
```
|
|
@@ -17,13 +17,14 @@ export interface FDC3
|
|
|
17
17
|
| Property | Modifiers | Type | Description |
|
|
18
18
|
| --- | --- | --- | --- |
|
|
19
19
|
| [currentChannelObs](./foundation-fdc3.fdc3.currentchannelobs.md) | | Observable<[FDC3Channel](./foundation-fdc3.fdc3channel.md)<!-- -->> | Observable which emits the current channel When a new channel is joined a new value is emitted |
|
|
20
|
+
| [isInteropFdc3](./foundation-fdc3.fdc3.isinteropfdc3.md) | | () => boolean | Check if the interop global is available. |
|
|
20
21
|
| [isReady](./foundation-fdc3.fdc3.isready.md) | | boolean | Whether the FDC3 API is ready. |
|
|
21
22
|
|
|
22
23
|
## Methods
|
|
23
24
|
|
|
24
25
|
| Method | Description |
|
|
25
26
|
| --- | --- |
|
|
26
|
-
| [addChannelListener(
|
|
27
|
+
| [addChannelListener(channel, channelType, callback)](./foundation-fdc3.fdc3.addchannellistener.md) | Helper function to add a context listener on a channel with a handler for channel messages |
|
|
27
28
|
| [addIntentListeners(listeners)](./foundation-fdc3.fdc3.addintentlisteners.md) | Adds intent listeners for the specified intents. |
|
|
28
29
|
| [broadcastOnChannel(channelName, type, payload)](./foundation-fdc3.fdc3.broadcastonchannel.md) | Broadcasts a message on a given channel with a given type |
|
|
29
30
|
| [broadcastOnChannelEventHandler(channelName, type)](./foundation-fdc3.fdc3.broadcastonchanneleventhandler.md) | Helper function to broadcast message on channel in response to dispatched event |
|
package/docs/api-report.md
CHANGED
|
@@ -29,7 +29,7 @@ export interface ChannelConfig {
|
|
|
29
29
|
// (undocumented)
|
|
30
30
|
callback: (any: any) => void;
|
|
31
31
|
// (undocumented)
|
|
32
|
-
channelName
|
|
32
|
+
channelName?: string;
|
|
33
33
|
// (undocumented)
|
|
34
34
|
channelType: string;
|
|
35
35
|
}
|
|
@@ -40,7 +40,7 @@ export interface ChannelConfig {
|
|
|
40
40
|
export class DefaultFDC3 implements FDC3 {
|
|
41
41
|
constructor();
|
|
42
42
|
// (undocumented)
|
|
43
|
-
addChannelListener(
|
|
43
|
+
addChannelListener(channel: FDC3Channel | Channel, channelType: string, callback: (any: any) => void): Promise<FDC3Channel | Channel>;
|
|
44
44
|
// (undocumented)
|
|
45
45
|
addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
|
|
46
46
|
// (undocumented)
|
|
@@ -60,6 +60,8 @@ export class DefaultFDC3 implements FDC3 {
|
|
|
60
60
|
// (undocumented)
|
|
61
61
|
getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
|
|
62
62
|
// (undocumented)
|
|
63
|
+
isInteropFdc3: () => boolean;
|
|
64
|
+
// (undocumented)
|
|
63
65
|
isReady: boolean;
|
|
64
66
|
// (undocumented)
|
|
65
67
|
joinChannel(channelId: string): Promise<void>;
|
|
@@ -71,7 +73,7 @@ export class DefaultFDC3 implements FDC3 {
|
|
|
71
73
|
//
|
|
72
74
|
// @public
|
|
73
75
|
export interface FDC3 {
|
|
74
|
-
addChannelListener(
|
|
76
|
+
addChannelListener(channel: FDC3Channel | Channel, channelType: string, callback: (any: any) => void): Promise<Channel>;
|
|
75
77
|
addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
|
|
76
78
|
broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
|
|
77
79
|
broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
|
|
@@ -81,6 +83,7 @@ export interface FDC3 {
|
|
|
81
83
|
findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
|
|
82
84
|
getCurrentChannel(): Promise<Channel>;
|
|
83
85
|
getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
|
|
86
|
+
isInteropFdc3: () => boolean;
|
|
84
87
|
isReady: boolean;
|
|
85
88
|
joinChannel(channelId: string): Promise<void>;
|
|
86
89
|
raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/foundation-fdc3",
|
|
3
3
|
"description": "Genesis Foundation FDC3",
|
|
4
|
-
"version": "14.192.2-fdc3-enhancements.
|
|
4
|
+
"version": "14.192.2-fdc3-enhancements.5",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -59,22 +59,22 @@
|
|
|
59
59
|
}
|
|
60
60
|
},
|
|
61
61
|
"devDependencies": {
|
|
62
|
-
"@genesislcap/foundation-testing": "14.192.2-fdc3-enhancements.
|
|
63
|
-
"@genesislcap/genx": "14.192.2-fdc3-enhancements.
|
|
64
|
-
"@genesislcap/rollup-builder": "14.192.2-fdc3-enhancements.
|
|
65
|
-
"@genesislcap/ts-builder": "14.192.2-fdc3-enhancements.
|
|
66
|
-
"@genesislcap/uvu-playwright-builder": "14.192.2-fdc3-enhancements.
|
|
67
|
-
"@genesislcap/vite-builder": "14.192.2-fdc3-enhancements.
|
|
68
|
-
"@genesislcap/webpack-builder": "14.192.2-fdc3-enhancements.
|
|
62
|
+
"@genesislcap/foundation-testing": "14.192.2-fdc3-enhancements.5",
|
|
63
|
+
"@genesislcap/genx": "14.192.2-fdc3-enhancements.5",
|
|
64
|
+
"@genesislcap/rollup-builder": "14.192.2-fdc3-enhancements.5",
|
|
65
|
+
"@genesislcap/ts-builder": "14.192.2-fdc3-enhancements.5",
|
|
66
|
+
"@genesislcap/uvu-playwright-builder": "14.192.2-fdc3-enhancements.5",
|
|
67
|
+
"@genesislcap/vite-builder": "14.192.2-fdc3-enhancements.5",
|
|
68
|
+
"@genesislcap/webpack-builder": "14.192.2-fdc3-enhancements.5",
|
|
69
69
|
"rimraf": "^5.0.0"
|
|
70
70
|
},
|
|
71
71
|
"dependencies": {
|
|
72
72
|
"@finos/fdc3": "^1.2.0",
|
|
73
|
-
"@genesislcap/foundation-logger": "14.192.2-fdc3-enhancements.
|
|
74
|
-
"@genesislcap/foundation-notifications": "14.192.2-fdc3-enhancements.
|
|
75
|
-
"@genesislcap/foundation-ui": "14.192.2-fdc3-enhancements.
|
|
76
|
-
"@genesislcap/foundation-utils": "14.192.2-fdc3-enhancements.
|
|
77
|
-
"@genesislcap/web-core": "14.192.2-fdc3-enhancements.
|
|
73
|
+
"@genesislcap/foundation-logger": "14.192.2-fdc3-enhancements.5",
|
|
74
|
+
"@genesislcap/foundation-notifications": "14.192.2-fdc3-enhancements.5",
|
|
75
|
+
"@genesislcap/foundation-ui": "14.192.2-fdc3-enhancements.5",
|
|
76
|
+
"@genesislcap/foundation-utils": "14.192.2-fdc3-enhancements.5",
|
|
77
|
+
"@genesislcap/web-core": "14.192.2-fdc3-enhancements.5",
|
|
78
78
|
"@interopio/desktop": "^6.3.1",
|
|
79
79
|
"@microsoft/fast-element": "^1.12.0",
|
|
80
80
|
"@microsoft/fast-foundation": "^2.49.4",
|
|
@@ -89,5 +89,5 @@
|
|
|
89
89
|
"publishConfig": {
|
|
90
90
|
"access": "public"
|
|
91
91
|
},
|
|
92
|
-
"gitHead": "
|
|
92
|
+
"gitHead": "a84534e0125d148af6d676c5db9ee422769d9edd"
|
|
93
93
|
}
|
package/test/fdc3.mock.ts
CHANGED
|
@@ -4,8 +4,10 @@ export const mockFdc3 = () => {
|
|
|
4
4
|
if (!('fdc3' in window)) {
|
|
5
5
|
const broadcast = sinon.stub();
|
|
6
6
|
const addContextListener = sinon.stub();
|
|
7
|
+
const channel = sinon.stub();
|
|
7
8
|
window.fdc3 = {
|
|
8
9
|
broadcast,
|
|
10
|
+
channel,
|
|
9
11
|
addContextListener,
|
|
10
12
|
getOrCreateChannel: sinon.stub().returns({
|
|
11
13
|
broadcast,
|
|
@@ -19,6 +21,9 @@ export const mockFdc3 = () => {
|
|
|
19
21
|
fireIntent: (value) => callback(value),
|
|
20
22
|
});
|
|
21
23
|
},
|
|
24
|
+
getCurrentChannel: sinon.stub().returns({
|
|
25
|
+
channel,
|
|
26
|
+
}),
|
|
22
27
|
};
|
|
23
28
|
}
|
|
24
29
|
};
|