@genesislcap/foundation-fdc3 14.174.0 → 14.176.0
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/dist/dts/index.d.ts +1 -0
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/dts/notifications/interop-notifications-listener.d.ts +30 -0
- package/dist/dts/notifications/interop-notifications-listener.d.ts.map +1 -0
- package/dist/esm/index.js +1 -0
- package/dist/esm/notifications/interop-notifications-listener.js +43 -0
- package/dist/foundation-fdc3.api.json +229 -1
- package/dist/foundation-fdc3.d.ts +34 -0
- package/docs/api/foundation-fdc3.interopfoundationnotificationlistener.md +26 -0
- package/docs/api/foundation-fdc3.interopnotificationslistener.ioconnectnotificationoptions.md +11 -0
- package/docs/api/foundation-fdc3.interopnotificationslistener.md +29 -0
- package/docs/api/foundation-fdc3.interopnotificationslistener.shownotificationtoast.md +22 -0
- package/docs/api/foundation-fdc3.md +12 -0
- package/docs/api-report.md +25 -0
- package/package.json +15 -12
- package/tsdoc.json +20 -0
package/dist/dts/index.d.ts
CHANGED
package/dist/dts/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,sBAAsB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,sBAAsB,CAAC;AACrC,cAAc,gDAAgD,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { NotificationDataRow } from '@genesislcap/foundation-notifications';
|
|
2
|
+
import { NotificationListener } from '@genesislcap/foundation-ui';
|
|
3
|
+
import { IOConnectDesktop } from '@interopio/desktop';
|
|
4
|
+
/**
|
|
5
|
+
* @tagname %%prefix%%-interop-notification-listener
|
|
6
|
+
* @public
|
|
7
|
+
* @remarks
|
|
8
|
+
* This component extends the notification listener class and overrides the logic for showing the toast message to instead dispatch the event to the interop notifications bus.
|
|
9
|
+
*/
|
|
10
|
+
export declare class InteropNotificationsListener extends NotificationListener {
|
|
11
|
+
iOConnectNotificationOptions: IOConnectDesktop.Notifications.IOConnectNotificationOptions;
|
|
12
|
+
protected showNotificationToast(row: NotificationDataRow): void;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* The Foundation Interop Notification Listener
|
|
16
|
+
*
|
|
17
|
+
* @public
|
|
18
|
+
* @remarks
|
|
19
|
+
* HTML Element: \<foundation-interop-notification-listener\>
|
|
20
|
+
*/
|
|
21
|
+
export declare const interopFoundationNotificationListener: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
|
|
22
|
+
baseName: string;
|
|
23
|
+
template: import("@microsoft/fast-element").ViewTemplate<NotificationListener, any>;
|
|
24
|
+
shadowOptions: ShadowRootInit;
|
|
25
|
+
}>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
|
|
26
|
+
baseName: string;
|
|
27
|
+
template: import("@microsoft/fast-element").ViewTemplate<NotificationListener, any>;
|
|
28
|
+
shadowOptions: ShadowRootInit;
|
|
29
|
+
}, typeof InteropNotificationsListener>;
|
|
30
|
+
//# sourceMappingURL=interop-notifications-listener.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"interop-notifications-listener.d.ts","sourceRoot":"","sources":["../../../src/notifications/interop-notifications-listener.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAoB,MAAM,uCAAuC,CAAC;AAC9F,OAAO,EAGL,oBAAoB,EACrB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAmBtD;;;;;GAKG;AACH,qBAAa,4BAA6B,SAAQ,oBAAoB;IACpE,4BAA4B,EAAE,gBAAgB,CAAC,aAAa,CAAC,4BAA4B,CAAC;IAE1F,SAAS,CAAC,qBAAqB,CAAC,GAAG,EAAE,mBAAmB,GAAG,IAAI;CAgBhE;AAED;;;;;;GAMG;AACH,eAAO,MAAM,qCAAqC;;;;;;;;uCAIhD,CAAC"}
|
package/dist/esm/index.js
CHANGED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { foundationNotificationListenerShadowOptions, foundationNotificationListenerTemplate, NotificationListener, } from '@genesislcap/foundation-ui';
|
|
2
|
+
import { logger } from '../utils';
|
|
3
|
+
const InteropNotificationSeverityMap = {
|
|
4
|
+
Critical: 'error',
|
|
5
|
+
High: 'warning',
|
|
6
|
+
Medium: 'success',
|
|
7
|
+
};
|
|
8
|
+
const mapNotificationTypeToInteropSeverity = (type) => {
|
|
9
|
+
return InteropNotificationSeverityMap[type];
|
|
10
|
+
};
|
|
11
|
+
/**
|
|
12
|
+
* @tagname %%prefix%%-interop-notification-listener
|
|
13
|
+
* @public
|
|
14
|
+
* @remarks
|
|
15
|
+
* This component extends the notification listener class and overrides the logic for showing the toast message to instead dispatch the event to the interop notifications bus.
|
|
16
|
+
*/
|
|
17
|
+
export class InteropNotificationsListener extends NotificationListener {
|
|
18
|
+
showNotificationToast(row) {
|
|
19
|
+
var _a, _b;
|
|
20
|
+
const { HEADER: title, MESSAGE: body, NOTIFY_SEVERITY: type } = row;
|
|
21
|
+
const severity = mapNotificationTypeToInteropSeverity(type === null || type === void 0 ? void 0 : type.toLowerCase());
|
|
22
|
+
if ((_b = (_a = window.io) === null || _a === void 0 ? void 0 : _a.notifications) === null || _b === void 0 ? void 0 : _b.raise) {
|
|
23
|
+
window.io.notifications.raise(Object.assign(Object.assign({}, this.iOConnectNotificationOptions), { title,
|
|
24
|
+
body,
|
|
25
|
+
severity, timestamp: row.CREATED_AT }));
|
|
26
|
+
}
|
|
27
|
+
else {
|
|
28
|
+
logger.warn('Interop IO.notifications is not defined');
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* The Foundation Interop Notification Listener
|
|
34
|
+
*
|
|
35
|
+
* @public
|
|
36
|
+
* @remarks
|
|
37
|
+
* HTML Element: \<foundation-interop-notification-listener\>
|
|
38
|
+
*/
|
|
39
|
+
export const interopFoundationNotificationListener = InteropNotificationsListener.compose({
|
|
40
|
+
baseName: 'interop-notification-listener',
|
|
41
|
+
template: foundationNotificationListenerTemplate,
|
|
42
|
+
shadowOptions: foundationNotificationListenerShadowOptions,
|
|
43
|
+
});
|
|
@@ -125,6 +125,16 @@
|
|
|
125
125
|
{
|
|
126
126
|
"tagName": "@preapproved",
|
|
127
127
|
"syntaxKind": "modifier"
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"tagName": "@tagname",
|
|
131
|
+
"syntaxKind": "block",
|
|
132
|
+
"allowMultiple": true
|
|
133
|
+
},
|
|
134
|
+
{
|
|
135
|
+
"tagName": "@fires",
|
|
136
|
+
"syntaxKind": "block",
|
|
137
|
+
"allowMultiple": true
|
|
128
138
|
}
|
|
129
139
|
],
|
|
130
140
|
"supportForTags": {
|
|
@@ -155,7 +165,9 @@
|
|
|
155
165
|
"@virtual": true,
|
|
156
166
|
"@betaDocumentation": true,
|
|
157
167
|
"@internalRemarks": true,
|
|
158
|
-
"@preapproved": true
|
|
168
|
+
"@preapproved": true,
|
|
169
|
+
"@tagname": true,
|
|
170
|
+
"@fires": true
|
|
159
171
|
},
|
|
160
172
|
"reportUnsupportedHtmlElements": false
|
|
161
173
|
}
|
|
@@ -942,6 +954,222 @@
|
|
|
942
954
|
"startIndex": 1,
|
|
943
955
|
"endIndex": 2
|
|
944
956
|
}
|
|
957
|
+
},
|
|
958
|
+
{
|
|
959
|
+
"kind": "Variable",
|
|
960
|
+
"canonicalReference": "@genesislcap/foundation-fdc3!interopFoundationNotificationListener:var",
|
|
961
|
+
"docComment": "/**\n * The Foundation Interop Notification Listener\n *\n * @remarks\n *\n * HTML Element: \\<foundation-interop-notification-listener\\>\n *\n * @public\n */\n",
|
|
962
|
+
"excerptTokens": [
|
|
963
|
+
{
|
|
964
|
+
"kind": "Content",
|
|
965
|
+
"text": "interopFoundationNotificationListener: "
|
|
966
|
+
},
|
|
967
|
+
{
|
|
968
|
+
"kind": "Content",
|
|
969
|
+
"text": "(overrideDefinition?: import(\"@microsoft/fast-foundation\")."
|
|
970
|
+
},
|
|
971
|
+
{
|
|
972
|
+
"kind": "Reference",
|
|
973
|
+
"text": "OverrideFoundationElementDefinition",
|
|
974
|
+
"canonicalReference": "@microsoft/fast-foundation!OverrideFoundationElementDefinition:type"
|
|
975
|
+
},
|
|
976
|
+
{
|
|
977
|
+
"kind": "Content",
|
|
978
|
+
"text": "<{\n baseName: string;\n template: import(\"@microsoft/fast-element\")."
|
|
979
|
+
},
|
|
980
|
+
{
|
|
981
|
+
"kind": "Reference",
|
|
982
|
+
"text": "ViewTemplate",
|
|
983
|
+
"canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
|
|
984
|
+
},
|
|
985
|
+
{
|
|
986
|
+
"kind": "Content",
|
|
987
|
+
"text": "<"
|
|
988
|
+
},
|
|
989
|
+
{
|
|
990
|
+
"kind": "Reference",
|
|
991
|
+
"text": "NotificationListener",
|
|
992
|
+
"canonicalReference": "@genesislcap/foundation-ui!NotificationListener:class"
|
|
993
|
+
},
|
|
994
|
+
{
|
|
995
|
+
"kind": "Content",
|
|
996
|
+
"text": ", any>;\n shadowOptions: "
|
|
997
|
+
},
|
|
998
|
+
{
|
|
999
|
+
"kind": "Reference",
|
|
1000
|
+
"text": "ShadowRootInit",
|
|
1001
|
+
"canonicalReference": "!ShadowRootInit:interface"
|
|
1002
|
+
},
|
|
1003
|
+
{
|
|
1004
|
+
"kind": "Content",
|
|
1005
|
+
"text": ";\n}>) => import(\"@microsoft/fast-foundation\")."
|
|
1006
|
+
},
|
|
1007
|
+
{
|
|
1008
|
+
"kind": "Reference",
|
|
1009
|
+
"text": "FoundationElementRegistry",
|
|
1010
|
+
"canonicalReference": "@microsoft/fast-foundation!FoundationElementRegistry:class"
|
|
1011
|
+
},
|
|
1012
|
+
{
|
|
1013
|
+
"kind": "Content",
|
|
1014
|
+
"text": "<{\n baseName: string;\n template: import(\"@microsoft/fast-element\")."
|
|
1015
|
+
},
|
|
1016
|
+
{
|
|
1017
|
+
"kind": "Reference",
|
|
1018
|
+
"text": "ViewTemplate",
|
|
1019
|
+
"canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
|
|
1020
|
+
},
|
|
1021
|
+
{
|
|
1022
|
+
"kind": "Content",
|
|
1023
|
+
"text": "<"
|
|
1024
|
+
},
|
|
1025
|
+
{
|
|
1026
|
+
"kind": "Reference",
|
|
1027
|
+
"text": "NotificationListener",
|
|
1028
|
+
"canonicalReference": "@genesislcap/foundation-ui!NotificationListener:class"
|
|
1029
|
+
},
|
|
1030
|
+
{
|
|
1031
|
+
"kind": "Content",
|
|
1032
|
+
"text": ", any>;\n shadowOptions: "
|
|
1033
|
+
},
|
|
1034
|
+
{
|
|
1035
|
+
"kind": "Reference",
|
|
1036
|
+
"text": "ShadowRootInit",
|
|
1037
|
+
"canonicalReference": "!ShadowRootInit:interface"
|
|
1038
|
+
},
|
|
1039
|
+
{
|
|
1040
|
+
"kind": "Content",
|
|
1041
|
+
"text": ";\n}, typeof "
|
|
1042
|
+
},
|
|
1043
|
+
{
|
|
1044
|
+
"kind": "Reference",
|
|
1045
|
+
"text": "InteropNotificationsListener",
|
|
1046
|
+
"canonicalReference": "@genesislcap/foundation-fdc3!InteropNotificationsListener:class"
|
|
1047
|
+
},
|
|
1048
|
+
{
|
|
1049
|
+
"kind": "Content",
|
|
1050
|
+
"text": ">"
|
|
1051
|
+
}
|
|
1052
|
+
],
|
|
1053
|
+
"fileUrlPath": "src/notifications/interop-notifications-listener.ts",
|
|
1054
|
+
"isReadonly": true,
|
|
1055
|
+
"releaseTag": "Public",
|
|
1056
|
+
"name": "interopFoundationNotificationListener",
|
|
1057
|
+
"variableTypeTokenRange": {
|
|
1058
|
+
"startIndex": 1,
|
|
1059
|
+
"endIndex": 20
|
|
1060
|
+
}
|
|
1061
|
+
},
|
|
1062
|
+
{
|
|
1063
|
+
"kind": "Class",
|
|
1064
|
+
"canonicalReference": "@genesislcap/foundation-fdc3!InteropNotificationsListener:class",
|
|
1065
|
+
"docComment": "/**\n * @remarks\n *\n * This component extends the notification listener class and overrides the logic for showing the toast message to instead dispatch the event to the interop notifications bus.\n *\n * @tagname\n *\n * %%prefix%%-interop-notification-listener\n *\n * @public\n */\n",
|
|
1066
|
+
"excerptTokens": [
|
|
1067
|
+
{
|
|
1068
|
+
"kind": "Content",
|
|
1069
|
+
"text": "export declare class InteropNotificationsListener extends "
|
|
1070
|
+
},
|
|
1071
|
+
{
|
|
1072
|
+
"kind": "Reference",
|
|
1073
|
+
"text": "NotificationListener",
|
|
1074
|
+
"canonicalReference": "@genesislcap/foundation-ui!NotificationListener:class"
|
|
1075
|
+
},
|
|
1076
|
+
{
|
|
1077
|
+
"kind": "Content",
|
|
1078
|
+
"text": " "
|
|
1079
|
+
}
|
|
1080
|
+
],
|
|
1081
|
+
"fileUrlPath": "src/notifications/interop-notifications-listener.ts",
|
|
1082
|
+
"releaseTag": "Public",
|
|
1083
|
+
"isAbstract": false,
|
|
1084
|
+
"name": "InteropNotificationsListener",
|
|
1085
|
+
"preserveMemberOrder": false,
|
|
1086
|
+
"members": [
|
|
1087
|
+
{
|
|
1088
|
+
"kind": "Property",
|
|
1089
|
+
"canonicalReference": "@genesislcap/foundation-fdc3!InteropNotificationsListener#iOConnectNotificationOptions:member",
|
|
1090
|
+
"docComment": "",
|
|
1091
|
+
"excerptTokens": [
|
|
1092
|
+
{
|
|
1093
|
+
"kind": "Content",
|
|
1094
|
+
"text": "iOConnectNotificationOptions: "
|
|
1095
|
+
},
|
|
1096
|
+
{
|
|
1097
|
+
"kind": "Reference",
|
|
1098
|
+
"text": "IOConnectDesktop.Notifications.IOConnectNotificationOptions",
|
|
1099
|
+
"canonicalReference": "@interopio/desktop!IOConnectDesktop.Notifications.IOConnectNotificationOptions:interface"
|
|
1100
|
+
},
|
|
1101
|
+
{
|
|
1102
|
+
"kind": "Content",
|
|
1103
|
+
"text": ";"
|
|
1104
|
+
}
|
|
1105
|
+
],
|
|
1106
|
+
"isReadonly": false,
|
|
1107
|
+
"isOptional": false,
|
|
1108
|
+
"releaseTag": "Public",
|
|
1109
|
+
"name": "iOConnectNotificationOptions",
|
|
1110
|
+
"propertyTypeTokenRange": {
|
|
1111
|
+
"startIndex": 1,
|
|
1112
|
+
"endIndex": 2
|
|
1113
|
+
},
|
|
1114
|
+
"isStatic": false,
|
|
1115
|
+
"isProtected": false,
|
|
1116
|
+
"isAbstract": false
|
|
1117
|
+
},
|
|
1118
|
+
{
|
|
1119
|
+
"kind": "Method",
|
|
1120
|
+
"canonicalReference": "@genesislcap/foundation-fdc3!InteropNotificationsListener#showNotificationToast:member(1)",
|
|
1121
|
+
"docComment": "",
|
|
1122
|
+
"excerptTokens": [
|
|
1123
|
+
{
|
|
1124
|
+
"kind": "Content",
|
|
1125
|
+
"text": "protected showNotificationToast(row: "
|
|
1126
|
+
},
|
|
1127
|
+
{
|
|
1128
|
+
"kind": "Reference",
|
|
1129
|
+
"text": "NotificationDataRow",
|
|
1130
|
+
"canonicalReference": "@genesislcap/foundation-notifications!NotificationDataRow:interface"
|
|
1131
|
+
},
|
|
1132
|
+
{
|
|
1133
|
+
"kind": "Content",
|
|
1134
|
+
"text": "): "
|
|
1135
|
+
},
|
|
1136
|
+
{
|
|
1137
|
+
"kind": "Content",
|
|
1138
|
+
"text": "void"
|
|
1139
|
+
},
|
|
1140
|
+
{
|
|
1141
|
+
"kind": "Content",
|
|
1142
|
+
"text": ";"
|
|
1143
|
+
}
|
|
1144
|
+
],
|
|
1145
|
+
"isStatic": false,
|
|
1146
|
+
"returnTypeTokenRange": {
|
|
1147
|
+
"startIndex": 3,
|
|
1148
|
+
"endIndex": 4
|
|
1149
|
+
},
|
|
1150
|
+
"releaseTag": "Public",
|
|
1151
|
+
"isProtected": true,
|
|
1152
|
+
"overloadIndex": 1,
|
|
1153
|
+
"parameters": [
|
|
1154
|
+
{
|
|
1155
|
+
"parameterName": "row",
|
|
1156
|
+
"parameterTypeTokenRange": {
|
|
1157
|
+
"startIndex": 1,
|
|
1158
|
+
"endIndex": 2
|
|
1159
|
+
},
|
|
1160
|
+
"isOptional": false
|
|
1161
|
+
}
|
|
1162
|
+
],
|
|
1163
|
+
"isOptional": false,
|
|
1164
|
+
"isAbstract": false,
|
|
1165
|
+
"name": "showNotificationToast"
|
|
1166
|
+
}
|
|
1167
|
+
],
|
|
1168
|
+
"extendsTokenRange": {
|
|
1169
|
+
"startIndex": 1,
|
|
1170
|
+
"endIndex": 2
|
|
1171
|
+
},
|
|
1172
|
+
"implementsTokenRanges": []
|
|
945
1173
|
}
|
|
946
1174
|
]
|
|
947
1175
|
}
|
|
@@ -3,9 +3,15 @@ import { Channel } from '@finos/fdc3';
|
|
|
3
3
|
import { Context } from '@finos/fdc3';
|
|
4
4
|
import { ContextHandler } from '@finos/fdc3';
|
|
5
5
|
import { FASTElement } from '@genesislcap/web-core';
|
|
6
|
+
import { FoundationElementRegistry } from '@microsoft/fast-foundation';
|
|
6
7
|
import { IntentResolution } from '@finos/fdc3';
|
|
7
8
|
import { Intents } from '@finos/fdc3';
|
|
8
9
|
import { InterfaceSymbol } from '@microsoft/fast-foundation';
|
|
10
|
+
import { IOConnectDesktop } from '@interopio/desktop';
|
|
11
|
+
import { NotificationDataRow } from '@genesislcap/foundation-notifications';
|
|
12
|
+
import { NotificationListener } from '@genesislcap/foundation-ui';
|
|
13
|
+
import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
|
|
14
|
+
import { ViewTemplate } from '@microsoft/fast-element';
|
|
9
15
|
|
|
10
16
|
/**
|
|
11
17
|
* The FDC3 implementation.
|
|
@@ -147,4 +153,32 @@ export declare interface FDC3IntentResolution extends IntentResolution {
|
|
|
147
153
|
*/
|
|
148
154
|
export declare type FDC3Intents = Intents;
|
|
149
155
|
|
|
156
|
+
/**
|
|
157
|
+
* The Foundation Interop Notification Listener
|
|
158
|
+
*
|
|
159
|
+
* @public
|
|
160
|
+
* @remarks
|
|
161
|
+
* HTML Element: \<foundation-interop-notification-listener\>
|
|
162
|
+
*/
|
|
163
|
+
export declare const interopFoundationNotificationListener: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
164
|
+
baseName: string;
|
|
165
|
+
template: ViewTemplate<NotificationListener, any>;
|
|
166
|
+
shadowOptions: ShadowRootInit;
|
|
167
|
+
}>) => FoundationElementRegistry< {
|
|
168
|
+
baseName: string;
|
|
169
|
+
template: ViewTemplate<NotificationListener, any>;
|
|
170
|
+
shadowOptions: ShadowRootInit;
|
|
171
|
+
}, typeof InteropNotificationsListener>;
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* @tagname %%prefix%%-interop-notification-listener
|
|
175
|
+
* @public
|
|
176
|
+
* @remarks
|
|
177
|
+
* This component extends the notification listener class and overrides the logic for showing the toast message to instead dispatch the event to the interop notifications bus.
|
|
178
|
+
*/
|
|
179
|
+
export declare class InteropNotificationsListener extends NotificationListener {
|
|
180
|
+
iOConnectNotificationOptions: IOConnectDesktop.Notifications.IOConnectNotificationOptions;
|
|
181
|
+
protected showNotificationToast(row: NotificationDataRow): void;
|
|
182
|
+
}
|
|
183
|
+
|
|
150
184
|
export { }
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-fdc3](./foundation-fdc3.md) > [interopFoundationNotificationListener](./foundation-fdc3.interopfoundationnotificationlistener.md)
|
|
4
|
+
|
|
5
|
+
## interopFoundationNotificationListener variable
|
|
6
|
+
|
|
7
|
+
The Foundation Interop Notification Listener
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
interopFoundationNotificationListener: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
|
|
13
|
+
baseName: string;
|
|
14
|
+
template: import("@microsoft/fast-element").ViewTemplate<NotificationListener, any>;
|
|
15
|
+
shadowOptions: ShadowRootInit;
|
|
16
|
+
}>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
|
|
17
|
+
baseName: string;
|
|
18
|
+
template: import("@microsoft/fast-element").ViewTemplate<NotificationListener, any>;
|
|
19
|
+
shadowOptions: ShadowRootInit;
|
|
20
|
+
}, typeof InteropNotificationsListener>
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Remarks
|
|
24
|
+
|
|
25
|
+
HTML Element: <<!-- -->foundation-interop-notification-listener<!-- -->>
|
|
26
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-fdc3](./foundation-fdc3.md) > [InteropNotificationsListener](./foundation-fdc3.interopnotificationslistener.md) > [iOConnectNotificationOptions](./foundation-fdc3.interopnotificationslistener.ioconnectnotificationoptions.md)
|
|
4
|
+
|
|
5
|
+
## InteropNotificationsListener.iOConnectNotificationOptions property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
iOConnectNotificationOptions: IOConnectDesktop.Notifications.IOConnectNotificationOptions;
|
|
11
|
+
```
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-fdc3](./foundation-fdc3.md) > [InteropNotificationsListener](./foundation-fdc3.interopnotificationslistener.md)
|
|
4
|
+
|
|
5
|
+
## InteropNotificationsListener class
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
export declare class InteropNotificationsListener extends NotificationListener
|
|
11
|
+
```
|
|
12
|
+
**Extends:** NotificationListener
|
|
13
|
+
|
|
14
|
+
## Remarks
|
|
15
|
+
|
|
16
|
+
This component extends the notification listener class and overrides the logic for showing the toast message to instead dispatch the event to the interop notifications bus.
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
| Property | Modifiers | Type | Description |
|
|
21
|
+
| --- | --- | --- | --- |
|
|
22
|
+
| [iOConnectNotificationOptions](./foundation-fdc3.interopnotificationslistener.ioconnectnotificationoptions.md) | | IOConnectDesktop.Notifications.IOConnectNotificationOptions | |
|
|
23
|
+
|
|
24
|
+
## Methods
|
|
25
|
+
|
|
26
|
+
| Method | Modifiers | Description |
|
|
27
|
+
| --- | --- | --- |
|
|
28
|
+
| [showNotificationToast(row)](./foundation-fdc3.interopnotificationslistener.shownotificationtoast.md) | <code>protected</code> | |
|
|
29
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-fdc3](./foundation-fdc3.md) > [InteropNotificationsListener](./foundation-fdc3.interopnotificationslistener.md) > [showNotificationToast](./foundation-fdc3.interopnotificationslistener.shownotificationtoast.md)
|
|
4
|
+
|
|
5
|
+
## InteropNotificationsListener.showNotificationToast() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
protected showNotificationToast(row: NotificationDataRow): void;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| row | NotificationDataRow | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
void
|
|
22
|
+
|
|
@@ -4,6 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
## foundation-fdc3 package
|
|
6
6
|
|
|
7
|
+
## Classes
|
|
8
|
+
|
|
9
|
+
| Class | Description |
|
|
10
|
+
| --- | --- |
|
|
11
|
+
| [InteropNotificationsListener](./foundation-fdc3.interopnotificationslistener.md) | |
|
|
12
|
+
|
|
7
13
|
## Interfaces
|
|
8
14
|
|
|
9
15
|
| Interface | Description |
|
|
@@ -14,6 +20,12 @@
|
|
|
14
20
|
| [FDC3Context](./foundation-fdc3.fdc3context.md) | |
|
|
15
21
|
| [FDC3IntentResolution](./foundation-fdc3.fdc3intentresolution.md) | |
|
|
16
22
|
|
|
23
|
+
## Variables
|
|
24
|
+
|
|
25
|
+
| Variable | Description |
|
|
26
|
+
| --- | --- |
|
|
27
|
+
| [interopFoundationNotificationListener](./foundation-fdc3.interopfoundationnotificationlistener.md) | The Foundation Interop Notification Listener |
|
|
28
|
+
|
|
17
29
|
## Type Aliases
|
|
18
30
|
|
|
19
31
|
| Type Alias | Description |
|
package/docs/api-report.md
CHANGED
|
@@ -9,9 +9,15 @@ import { Channel } from '@finos/fdc3';
|
|
|
9
9
|
import { Context } from '@finos/fdc3';
|
|
10
10
|
import { ContextHandler } from '@finos/fdc3';
|
|
11
11
|
import { FASTElement } from '@genesislcap/web-core';
|
|
12
|
+
import { FoundationElementRegistry } from '@microsoft/fast-foundation';
|
|
12
13
|
import { IntentResolution } from '@finos/fdc3';
|
|
13
14
|
import { Intents } from '@finos/fdc3';
|
|
14
15
|
import { InterfaceSymbol } from '@microsoft/fast-foundation';
|
|
16
|
+
import { IOConnectDesktop } from '@interopio/desktop';
|
|
17
|
+
import { NotificationDataRow } from '@genesislcap/foundation-notifications';
|
|
18
|
+
import { NotificationListener } from '@genesislcap/foundation-ui';
|
|
19
|
+
import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
|
|
20
|
+
import { ViewTemplate } from '@microsoft/fast-element';
|
|
15
21
|
|
|
16
22
|
// Warning: (ae-internal-missing-underscore) The name "DefaultFDC3" should be prefixed with an underscore because the declaration is marked as @internal
|
|
17
23
|
//
|
|
@@ -96,6 +102,25 @@ export interface FDC3IntentResolution extends IntentResolution {
|
|
|
96
102
|
// @public (undocumented)
|
|
97
103
|
export type FDC3Intents = Intents;
|
|
98
104
|
|
|
105
|
+
// @public
|
|
106
|
+
export const interopFoundationNotificationListener: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
107
|
+
baseName: string;
|
|
108
|
+
template: ViewTemplate<NotificationListener, any>;
|
|
109
|
+
shadowOptions: ShadowRootInit;
|
|
110
|
+
}>) => FoundationElementRegistry< {
|
|
111
|
+
baseName: string;
|
|
112
|
+
template: ViewTemplate<NotificationListener, any>;
|
|
113
|
+
shadowOptions: ShadowRootInit;
|
|
114
|
+
}, typeof InteropNotificationsListener>;
|
|
115
|
+
|
|
116
|
+
// @public (undocumented)
|
|
117
|
+
export class InteropNotificationsListener extends NotificationListener {
|
|
118
|
+
// (undocumented)
|
|
119
|
+
iOConnectNotificationOptions: IOConnectDesktop.Notifications.IOConnectNotificationOptions;
|
|
120
|
+
// (undocumented)
|
|
121
|
+
protected showNotificationToast(row: NotificationDataRow): void;
|
|
122
|
+
}
|
|
123
|
+
|
|
99
124
|
// (No @packageDocumentation comment for this package)
|
|
100
125
|
|
|
101
126
|
```
|
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.
|
|
4
|
+
"version": "14.176.0",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -51,20 +51,23 @@
|
|
|
51
51
|
"test:debug": "genx test --debug"
|
|
52
52
|
},
|
|
53
53
|
"devDependencies": {
|
|
54
|
-
"@genesislcap/foundation-testing": "14.
|
|
55
|
-
"@genesislcap/genx": "14.
|
|
56
|
-
"@genesislcap/rollup-builder": "14.
|
|
57
|
-
"@genesislcap/ts-builder": "14.
|
|
58
|
-
"@genesislcap/uvu-playwright-builder": "14.
|
|
59
|
-
"@genesislcap/vite-builder": "14.
|
|
60
|
-
"@genesislcap/webpack-builder": "14.
|
|
54
|
+
"@genesislcap/foundation-testing": "14.176.0",
|
|
55
|
+
"@genesislcap/genx": "14.176.0",
|
|
56
|
+
"@genesislcap/rollup-builder": "14.176.0",
|
|
57
|
+
"@genesislcap/ts-builder": "14.176.0",
|
|
58
|
+
"@genesislcap/uvu-playwright-builder": "14.176.0",
|
|
59
|
+
"@genesislcap/vite-builder": "14.176.0",
|
|
60
|
+
"@genesislcap/webpack-builder": "14.176.0",
|
|
61
61
|
"rimraf": "^3.0.2"
|
|
62
62
|
},
|
|
63
63
|
"dependencies": {
|
|
64
64
|
"@finos/fdc3": "^1.2.0",
|
|
65
|
-
"@genesislcap/foundation-logger": "14.
|
|
66
|
-
"@genesislcap/foundation-
|
|
67
|
-
"@genesislcap/
|
|
65
|
+
"@genesislcap/foundation-logger": "14.176.0",
|
|
66
|
+
"@genesislcap/foundation-notifications": "14.176.0",
|
|
67
|
+
"@genesislcap/foundation-ui": "14.176.0",
|
|
68
|
+
"@genesislcap/foundation-utils": "14.176.0",
|
|
69
|
+
"@genesislcap/web-core": "14.176.0",
|
|
70
|
+
"@interopio/desktop": "^6.3.1",
|
|
68
71
|
"@microsoft/fast-element": "^1.12.0",
|
|
69
72
|
"@microsoft/fast-foundation": "^2.49.4",
|
|
70
73
|
"tslib": "^2.3.1"
|
|
@@ -77,5 +80,5 @@
|
|
|
77
80
|
"publishConfig": {
|
|
78
81
|
"access": "public"
|
|
79
82
|
},
|
|
80
|
-
"gitHead": "
|
|
83
|
+
"gitHead": "e8d311eaf27cd3d155813081ad70a18aa0a826fd"
|
|
81
84
|
}
|
package/tsdoc.json
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
3
|
+
"extends": ["@microsoft/api-extractor/extends/tsdoc-base.json"],
|
|
4
|
+
"tagDefinitions": [
|
|
5
|
+
{
|
|
6
|
+
"tagName": "@tagname",
|
|
7
|
+
"syntaxKind": "block",
|
|
8
|
+
"allowMultiple": true
|
|
9
|
+
},
|
|
10
|
+
{
|
|
11
|
+
"tagName": "@fires",
|
|
12
|
+
"syntaxKind": "block",
|
|
13
|
+
"allowMultiple": true
|
|
14
|
+
}
|
|
15
|
+
],
|
|
16
|
+
"supportForTags": {
|
|
17
|
+
"@tagname": true,
|
|
18
|
+
"@fires": true
|
|
19
|
+
}
|
|
20
|
+
}
|