@genesislcap/foundation-fdc3 14.192.2-fdc3-enhancements.2 → 14.192.2-fdc3-enhancements.4
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/dts/fdc3.d.ts +7 -6
- 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 +2 -3
- package/dist/esm/util/fdc3-listener.js +8 -6
- package/dist/foundation-fdc3.api.json +25 -15
- package/dist/foundation-fdc3.d.ts +8 -7
- package/docs/api/foundation-fdc3.fdc3.addchannellistener.md +3 -3
- package/docs/api/{foundation-fdc3.fdc3.currentchannel_.md → foundation-fdc3.fdc3.currentchannelobs.md} +3 -3
- package/docs/api/foundation-fdc3.fdc3.md +2 -2
- package/docs/api-report.md +5 -5
- package/package.json +14 -14
package/dist/dts/fdc3.d.ts
CHANGED
|
@@ -44,8 +44,9 @@ export interface FDC3 {
|
|
|
44
44
|
/**
|
|
45
45
|
* Observable which emits the current channel
|
|
46
46
|
* When a new channel is joined a new value is emitted
|
|
47
|
+
* @public
|
|
47
48
|
*/
|
|
48
|
-
|
|
49
|
+
currentChannelObs: Observable<FDC3Channel>;
|
|
49
50
|
/**
|
|
50
51
|
* Adds intent listeners for the specified intents.
|
|
51
52
|
* @public
|
|
@@ -110,11 +111,11 @@ export interface FDC3 {
|
|
|
110
111
|
broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
|
|
111
112
|
/**
|
|
112
113
|
* Helper function to add a context listener on a channel with a handler for channel messages
|
|
113
|
-
* @param
|
|
114
|
-
* @param channelType - type of the channel
|
|
114
|
+
* @param channel - instance of a channel
|
|
115
|
+
* @param channelType - type of the channel context
|
|
115
116
|
* @param callback - handler to for the channel context listener
|
|
116
117
|
* */
|
|
117
|
-
addChannelListener(
|
|
118
|
+
addChannelListener(channel: FDC3Channel | Channel, channelType: string, callback: (any: any) => void): Promise<Channel>;
|
|
118
119
|
/**
|
|
119
120
|
* Helper function to get the current channel of the application
|
|
120
121
|
* */
|
|
@@ -127,7 +128,7 @@ export interface FDC3 {
|
|
|
127
128
|
export declare class DefaultFDC3 implements FDC3 {
|
|
128
129
|
isReady: boolean;
|
|
129
130
|
private _currentChannel$;
|
|
130
|
-
|
|
131
|
+
currentChannelObs: Observable<Channel>;
|
|
131
132
|
constructor();
|
|
132
133
|
private connect;
|
|
133
134
|
addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
|
|
@@ -139,7 +140,7 @@ export declare class DefaultFDC3 implements FDC3 {
|
|
|
139
140
|
broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
|
|
140
141
|
broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
|
|
141
142
|
broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
|
|
142
|
-
addChannelListener(
|
|
143
|
+
addChannelListener(channel: FDC3Channel | Channel, channelType: string, callback: (any: any) => void): Promise<FDC3Channel | Channel>;
|
|
143
144
|
getCurrentChannel(): Promise<Channel>;
|
|
144
145
|
private broadcastMessageOnChannel;
|
|
145
146
|
}
|
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
|
|
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,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;;YAMhE,OAAO;IAWd,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
|
@@ -16,7 +16,7 @@ export class DefaultFDC3 {
|
|
|
16
16
|
constructor() {
|
|
17
17
|
this.isReady = false;
|
|
18
18
|
this._currentChannel$ = new Subject();
|
|
19
|
-
this.
|
|
19
|
+
this.currentChannelObs = this._currentChannel$.asObservable();
|
|
20
20
|
this.connect();
|
|
21
21
|
}
|
|
22
22
|
connect() {
|
|
@@ -92,9 +92,8 @@ export class DefaultFDC3 {
|
|
|
92
92
|
});
|
|
93
93
|
});
|
|
94
94
|
}
|
|
95
|
-
addChannelListener(
|
|
95
|
+
addChannelListener(channel, channelType, callback) {
|
|
96
96
|
return __awaiter(this, void 0, void 0, function* () {
|
|
97
|
-
const channel = yield getOrCreateChannel(channelName);
|
|
98
97
|
channel.addContextListener(channelType, callback);
|
|
99
98
|
return channel;
|
|
100
99
|
});
|
|
@@ -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
|
-
this.channelSubscription.add(this.fdc3.
|
|
51
|
-
this.fdc3.addChannelListener(channel
|
|
52
|
+
this.channelSubscription.add(this.fdc3.currentChannelObs.subscribe((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
|
}
|
|
@@ -583,12 +593,12 @@
|
|
|
583
593
|
},
|
|
584
594
|
{
|
|
585
595
|
"kind": "PropertySignature",
|
|
586
|
-
"canonicalReference": "@genesislcap/foundation-fdc3!FDC3#
|
|
587
|
-
"docComment": "/**\n * Observable which emits the current channel When a new channel is joined a new value is emitted\n */\n",
|
|
596
|
+
"canonicalReference": "@genesislcap/foundation-fdc3!FDC3#currentChannelObs:member",
|
|
597
|
+
"docComment": "/**\n * Observable which emits the current channel When a new channel is joined a new value is emitted\n *\n * @public\n */\n",
|
|
588
598
|
"excerptTokens": [
|
|
589
599
|
{
|
|
590
600
|
"kind": "Content",
|
|
591
|
-
"text": "
|
|
601
|
+
"text": "currentChannelObs: "
|
|
592
602
|
},
|
|
593
603
|
{
|
|
594
604
|
"kind": "Reference",
|
|
@@ -616,7 +626,7 @@
|
|
|
616
626
|
"isReadonly": false,
|
|
617
627
|
"isOptional": false,
|
|
618
628
|
"releaseTag": "Public",
|
|
619
|
-
"name": "
|
|
629
|
+
"name": "currentChannelObs",
|
|
620
630
|
"propertyTypeTokenRange": {
|
|
621
631
|
"startIndex": 1,
|
|
622
632
|
"endIndex": 5
|
|
@@ -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
|
}
|
|
@@ -35,7 +35,7 @@ export declare interface ChannelConfig {
|
|
|
35
35
|
export declare class DefaultFDC3 implements FDC3 {
|
|
36
36
|
isReady: boolean;
|
|
37
37
|
private _currentChannel$;
|
|
38
|
-
|
|
38
|
+
currentChannelObs: Observable<Channel>;
|
|
39
39
|
constructor();
|
|
40
40
|
private connect;
|
|
41
41
|
addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
|
|
@@ -47,7 +47,7 @@ export declare class DefaultFDC3 implements FDC3 {
|
|
|
47
47
|
broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
|
|
48
48
|
broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
|
|
49
49
|
broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
|
|
50
|
-
addChannelListener(
|
|
50
|
+
addChannelListener(channel: FDC3Channel | Channel, channelType: string, callback: (any: any) => void): Promise<FDC3Channel | Channel>;
|
|
51
51
|
getCurrentChannel(): Promise<Channel>;
|
|
52
52
|
private broadcastMessageOnChannel;
|
|
53
53
|
}
|
|
@@ -65,8 +65,9 @@ export declare interface FDC3 {
|
|
|
65
65
|
/**
|
|
66
66
|
* Observable which emits the current channel
|
|
67
67
|
* When a new channel is joined a new value is emitted
|
|
68
|
+
* @public
|
|
68
69
|
*/
|
|
69
|
-
|
|
70
|
+
currentChannelObs: Observable<FDC3Channel>;
|
|
70
71
|
/**
|
|
71
72
|
* Adds intent listeners for the specified intents.
|
|
72
73
|
* @public
|
|
@@ -131,11 +132,11 @@ export declare interface FDC3 {
|
|
|
131
132
|
broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
|
|
132
133
|
/**
|
|
133
134
|
* Helper function to add a context listener on a channel with a handler for channel messages
|
|
134
|
-
* @param
|
|
135
|
-
* @param channelType - type of the channel
|
|
135
|
+
* @param channel - instance of a channel
|
|
136
|
+
* @param channelType - type of the channel context
|
|
136
137
|
* @param callback - handler to for the channel context listener
|
|
137
138
|
* */
|
|
138
|
-
addChannelListener(
|
|
139
|
+
addChannelListener(channel: FDC3Channel | Channel, channelType: string, callback: (any: any) => void): Promise<Channel>;
|
|
139
140
|
/**
|
|
140
141
|
* Helper function to get the current channel of the application
|
|
141
142
|
* */
|
|
@@ -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:**
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-fdc3](./foundation-fdc3.md) > [FDC3](./foundation-fdc3.fdc3.md) > [
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-fdc3](./foundation-fdc3.md) > [FDC3](./foundation-fdc3.fdc3.md) > [currentChannelObs](./foundation-fdc3.fdc3.currentchannelobs.md)
|
|
4
4
|
|
|
5
|
-
## FDC3.
|
|
5
|
+
## FDC3.currentChannelObs property
|
|
6
6
|
|
|
7
7
|
Observable which emits the current channel When a new channel is joined a new value is emitted
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
|
|
12
|
+
currentChannelObs: Observable<FDC3Channel>;
|
|
13
13
|
```
|
|
@@ -16,14 +16,14 @@ export interface FDC3
|
|
|
16
16
|
|
|
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
20
|
| [isReady](./foundation-fdc3.fdc3.isready.md) | | boolean | Whether the FDC3 API is ready. |
|
|
21
21
|
|
|
22
22
|
## Methods
|
|
23
23
|
|
|
24
24
|
| Method | Description |
|
|
25
25
|
| --- | --- |
|
|
26
|
-
| [addChannelListener(
|
|
26
|
+
| [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
27
|
| [addIntentListeners(listeners)](./foundation-fdc3.fdc3.addintentlisteners.md) | Adds intent listeners for the specified intents. |
|
|
28
28
|
| [broadcastOnChannel(channelName, type, payload)](./foundation-fdc3.fdc3.broadcastonchannel.md) | Broadcasts a message on a given channel with a given type |
|
|
29
29
|
| [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)
|
|
@@ -50,7 +50,7 @@ export class DefaultFDC3 implements FDC3 {
|
|
|
50
50
|
// (undocumented)
|
|
51
51
|
broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
|
|
52
52
|
// (undocumented)
|
|
53
|
-
|
|
53
|
+
currentChannelObs: Observable<Channel>;
|
|
54
54
|
// (undocumented)
|
|
55
55
|
findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
|
|
56
56
|
// (undocumented)
|
|
@@ -71,12 +71,12 @@ export class DefaultFDC3 implements FDC3 {
|
|
|
71
71
|
//
|
|
72
72
|
// @public
|
|
73
73
|
export interface FDC3 {
|
|
74
|
-
addChannelListener(
|
|
74
|
+
addChannelListener(channel: FDC3Channel | Channel, channelType: string, callback: (any: any) => void): Promise<Channel>;
|
|
75
75
|
addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
|
|
76
76
|
broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
|
|
77
77
|
broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
|
|
78
78
|
broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
|
|
79
|
-
|
|
79
|
+
currentChannelObs: Observable<FDC3Channel>;
|
|
80
80
|
findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
|
|
81
81
|
findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
|
|
82
82
|
getCurrentChannel(): Promise<Channel>;
|
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.4",
|
|
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.4",
|
|
63
|
+
"@genesislcap/genx": "14.192.2-fdc3-enhancements.4",
|
|
64
|
+
"@genesislcap/rollup-builder": "14.192.2-fdc3-enhancements.4",
|
|
65
|
+
"@genesislcap/ts-builder": "14.192.2-fdc3-enhancements.4",
|
|
66
|
+
"@genesislcap/uvu-playwright-builder": "14.192.2-fdc3-enhancements.4",
|
|
67
|
+
"@genesislcap/vite-builder": "14.192.2-fdc3-enhancements.4",
|
|
68
|
+
"@genesislcap/webpack-builder": "14.192.2-fdc3-enhancements.4",
|
|
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.4",
|
|
74
|
+
"@genesislcap/foundation-notifications": "14.192.2-fdc3-enhancements.4",
|
|
75
|
+
"@genesislcap/foundation-ui": "14.192.2-fdc3-enhancements.4",
|
|
76
|
+
"@genesislcap/foundation-utils": "14.192.2-fdc3-enhancements.4",
|
|
77
|
+
"@genesislcap/web-core": "14.192.2-fdc3-enhancements.4",
|
|
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": "d7f7350aa56a095dd9d9b989a7a5c3ea18ca48f9"
|
|
93
93
|
}
|