@genesislcap/foundation-fdc3 14.192.2-fdc3-enhancements.11 → 14.192.2-fdc3-enhancements.12
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/dts/fdc3.d.ts +9 -1
- package/dist/dts/fdc3.d.ts.map +1 -1
- package/dist/esm/fdc3.js +9 -13
- package/dist/foundation-fdc3.api.json +60 -0
- package/dist/foundation-fdc3.d.ts +9 -1
- package/docs/api/foundation-fdc3.fdc3.md +1 -0
- package/docs/api/foundation-fdc3.fdc3.raiseintentforcontext.md +26 -0
- package/docs/api-report.md +4 -1
- package/package.json +14 -14
package/dist/dts/fdc3.d.ts
CHANGED
@@ -73,6 +73,13 @@ export interface FDC3 {
|
|
73
73
|
* @returns A promise that resolves with an array of all matching intents and their metadata.
|
74
74
|
*/
|
75
75
|
findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
|
76
|
+
/**
|
77
|
+
* Raises an intent against an application based purely on the context data.
|
78
|
+
* @public
|
79
|
+
* @param context - The context to use.
|
80
|
+
* @returns A promise that resolves with the result of the intent resolution.
|
81
|
+
*/
|
82
|
+
raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
|
76
83
|
/**
|
77
84
|
* Raises the specified intent with the specified context.
|
78
85
|
* @public
|
@@ -141,7 +148,8 @@ export declare class DefaultFDC3 implements FDC3 {
|
|
141
148
|
addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
|
142
149
|
findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
|
143
150
|
findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
|
144
|
-
|
151
|
+
raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
|
152
|
+
raiseIntent(context: FDC3Context, intent: FDC3Intents): Promise<FDC3IntentResolution>;
|
145
153
|
joinChannel(channelId: string): Promise<void>;
|
146
154
|
getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
|
147
155
|
broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
|
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,
|
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,EAMd,OAAO,EACP,gBAAgB,EAIjB,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,UAAU,EAAiB,MAAM,MAAM,CAAC;AAIjD;;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;;;;;OAKG;IACH,qBAAqB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAE3E;;;;;;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,CAAgC;IAExD,OAAO,CAAC,eAAe,CAAwB;IAE/C,iBAAiB,EAAE,UAAU,CAAC,OAAO,CAAC,CAAwC;IAE9E,aAAa,QAAO,OAAO,CAAyB;;YAMtC,OAAO;IA4Bd,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;IAK9D,qBAAqB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAK1E,WAAW,CACtB,OAAO,EAAE,WAAW,EACpB,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,oBAAoB,CAAC;IAKnB,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYnD,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;IAOrE,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"}
|
package/dist/esm/fdc3.js
CHANGED
@@ -2,7 +2,7 @@ import { __awaiter, __decorate } from "tslib";
|
|
2
2
|
/**
|
3
3
|
* See https://fdc3.finos.org/docs/fdc3-intro, and https://github.com/finos/FDC3/tree/master/src/api
|
4
4
|
*/
|
5
|
-
import { addIntentListener, fdc3Ready, findIntent, findIntentsByContext, getCurrentChannel, getOrCreateChannel,
|
5
|
+
import { addIntentListener, fdc3Ready, findIntent, findIntentsByContext, getCurrentChannel, getOrCreateChannel, joinChannel, raiseIntent, raiseIntentForContext, } from '@finos/fdc3';
|
6
6
|
import { observable } from '@microsoft/fast-element';
|
7
7
|
import { DI } from '@microsoft/fast-foundation';
|
8
8
|
import { ReplaySubject } from 'rxjs';
|
@@ -66,20 +66,16 @@ export class DefaultFDC3 {
|
|
66
66
|
logger.debug(`fdc3 findIntentsByContext '${context}'`);
|
67
67
|
return findIntentsByContext(context);
|
68
68
|
}
|
69
|
+
raiseIntentForContext(context) {
|
70
|
+
return __awaiter(this, void 0, void 0, function* () {
|
71
|
+
logger.debug(`fdc3 raiseIntentForContext '${context}'`);
|
72
|
+
return raiseIntentForContext(context);
|
73
|
+
});
|
74
|
+
}
|
69
75
|
raiseIntent(context, intent) {
|
70
76
|
return __awaiter(this, void 0, void 0, function* () {
|
71
|
-
|
72
|
-
|
73
|
-
return raiseIntent(intent, context);
|
74
|
-
}
|
75
|
-
if (getInfo) {
|
76
|
-
const fdc3Metadata = yield Promise.resolve(getInfo());
|
77
|
-
if (fdc3Metadata && versionIsAtLeast(fdc3Metadata, '1.2')) {
|
78
|
-
logger.debug(`fdc3 raiseIntentForContext '${context}'`);
|
79
|
-
return raiseIntentForContext(context);
|
80
|
-
}
|
81
|
-
}
|
82
|
-
logger.error(`fdc3 unable to raiseIntent using context '${context}' and intent '${intent}'.`);
|
77
|
+
logger.debug(`fdc3 raiseIntent '${intent}' '${context}'`);
|
78
|
+
return raiseIntent(intent, context);
|
83
79
|
});
|
84
80
|
}
|
85
81
|
joinChannel(channelId) {
|
@@ -1050,6 +1050,66 @@
|
|
1050
1050
|
}
|
1051
1051
|
],
|
1052
1052
|
"name": "raiseIntent"
|
1053
|
+
},
|
1054
|
+
{
|
1055
|
+
"kind": "MethodSignature",
|
1056
|
+
"canonicalReference": "@genesislcap/foundation-fdc3!FDC3#raiseIntentForContext:member(1)",
|
1057
|
+
"docComment": "/**\n * Raises an intent against an application based purely on the context data.\n *\n * @param context - The context to use.\n *\n * @returns A promise that resolves with the result of the intent resolution.\n *\n * @public\n */\n",
|
1058
|
+
"excerptTokens": [
|
1059
|
+
{
|
1060
|
+
"kind": "Content",
|
1061
|
+
"text": "raiseIntentForContext(context: "
|
1062
|
+
},
|
1063
|
+
{
|
1064
|
+
"kind": "Reference",
|
1065
|
+
"text": "FDC3Context",
|
1066
|
+
"canonicalReference": "@genesislcap/foundation-fdc3!FDC3Context:interface"
|
1067
|
+
},
|
1068
|
+
{
|
1069
|
+
"kind": "Content",
|
1070
|
+
"text": "): "
|
1071
|
+
},
|
1072
|
+
{
|
1073
|
+
"kind": "Reference",
|
1074
|
+
"text": "Promise",
|
1075
|
+
"canonicalReference": "!Promise:interface"
|
1076
|
+
},
|
1077
|
+
{
|
1078
|
+
"kind": "Content",
|
1079
|
+
"text": "<"
|
1080
|
+
},
|
1081
|
+
{
|
1082
|
+
"kind": "Reference",
|
1083
|
+
"text": "FDC3IntentResolution",
|
1084
|
+
"canonicalReference": "@genesislcap/foundation-fdc3!FDC3IntentResolution:interface"
|
1085
|
+
},
|
1086
|
+
{
|
1087
|
+
"kind": "Content",
|
1088
|
+
"text": ">"
|
1089
|
+
},
|
1090
|
+
{
|
1091
|
+
"kind": "Content",
|
1092
|
+
"text": ";"
|
1093
|
+
}
|
1094
|
+
],
|
1095
|
+
"isOptional": false,
|
1096
|
+
"returnTypeTokenRange": {
|
1097
|
+
"startIndex": 3,
|
1098
|
+
"endIndex": 7
|
1099
|
+
},
|
1100
|
+
"releaseTag": "Public",
|
1101
|
+
"overloadIndex": 1,
|
1102
|
+
"parameters": [
|
1103
|
+
{
|
1104
|
+
"parameterName": "context",
|
1105
|
+
"parameterTypeTokenRange": {
|
1106
|
+
"startIndex": 1,
|
1107
|
+
"endIndex": 2
|
1108
|
+
},
|
1109
|
+
"isOptional": false
|
1110
|
+
}
|
1111
|
+
],
|
1112
|
+
"name": "raiseIntentForContext"
|
1053
1113
|
}
|
1054
1114
|
],
|
1055
1115
|
"extendsTokenRanges": []
|
@@ -43,7 +43,8 @@ export declare class DefaultFDC3 implements FDC3 {
|
|
43
43
|
addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
|
44
44
|
findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
|
45
45
|
findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
|
46
|
-
|
46
|
+
raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
|
47
|
+
raiseIntent(context: FDC3Context, intent: FDC3Intents): Promise<FDC3IntentResolution>;
|
47
48
|
joinChannel(channelId: string): Promise<void>;
|
48
49
|
getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
|
49
50
|
broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
|
@@ -96,6 +97,13 @@ export declare interface FDC3 {
|
|
96
97
|
* @returns A promise that resolves with an array of all matching intents and their metadata.
|
97
98
|
*/
|
98
99
|
findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
|
100
|
+
/**
|
101
|
+
* Raises an intent against an application based purely on the context data.
|
102
|
+
* @public
|
103
|
+
* @param context - The context to use.
|
104
|
+
* @returns A promise that resolves with the result of the intent resolution.
|
105
|
+
*/
|
106
|
+
raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
|
99
107
|
/**
|
100
108
|
* Raises the specified intent with the specified context.
|
101
109
|
* @public
|
@@ -35,4 +35,5 @@ export interface FDC3
|
|
35
35
|
| [getOrCreateChannel(channelId)](./foundation-fdc3.fdc3.getorcreatechannel.md) | Gets or creates the specified channel. |
|
36
36
|
| [joinChannel(channelId)](./foundation-fdc3.fdc3.joinchannel.md) | Joins the specified channel. |
|
37
37
|
| [raiseIntent(context, intent)](./foundation-fdc3.fdc3.raiseintent.md) | Raises the specified intent with the specified context. |
|
38
|
+
| [raiseIntentForContext(context)](./foundation-fdc3.fdc3.raiseintentforcontext.md) | Raises an intent against an application based purely on the context data. |
|
38
39
|
|
@@ -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) > [FDC3](./foundation-fdc3.fdc3.md) > [raiseIntentForContext](./foundation-fdc3.fdc3.raiseintentforcontext.md)
|
4
|
+
|
5
|
+
## FDC3.raiseIntentForContext() method
|
6
|
+
|
7
|
+
Raises an intent against an application based purely on the context data.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
|
13
|
+
```
|
14
|
+
|
15
|
+
## Parameters
|
16
|
+
|
17
|
+
| Parameter | Type | Description |
|
18
|
+
| --- | --- | --- |
|
19
|
+
| context | [FDC3Context](./foundation-fdc3.fdc3context.md) | The context to use. |
|
20
|
+
|
21
|
+
**Returns:**
|
22
|
+
|
23
|
+
Promise<[FDC3IntentResolution](./foundation-fdc3.fdc3intentresolution.md)<!-- -->>
|
24
|
+
|
25
|
+
A promise that resolves with the result of the intent resolution.
|
26
|
+
|
package/docs/api-report.md
CHANGED
@@ -66,7 +66,9 @@ export class DefaultFDC3 implements FDC3 {
|
|
66
66
|
// (undocumented)
|
67
67
|
joinChannel(channelId: string): Promise<void>;
|
68
68
|
// (undocumented)
|
69
|
-
raiseIntent(context: FDC3Context, intent
|
69
|
+
raiseIntent(context: FDC3Context, intent: FDC3Intents): Promise<FDC3IntentResolution>;
|
70
|
+
// (undocumented)
|
71
|
+
raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
|
70
72
|
}
|
71
73
|
|
72
74
|
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "FDC3" because one of its declarations is marked as @internal
|
@@ -87,6 +89,7 @@ export interface FDC3 {
|
|
87
89
|
isReady: boolean;
|
88
90
|
joinChannel(channelId: string): Promise<void>;
|
89
91
|
raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
|
92
|
+
raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
|
90
93
|
}
|
91
94
|
|
92
95
|
// @internal
|
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.12",
|
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.12",
|
63
|
+
"@genesislcap/genx": "14.192.2-fdc3-enhancements.12",
|
64
|
+
"@genesislcap/rollup-builder": "14.192.2-fdc3-enhancements.12",
|
65
|
+
"@genesislcap/ts-builder": "14.192.2-fdc3-enhancements.12",
|
66
|
+
"@genesislcap/uvu-playwright-builder": "14.192.2-fdc3-enhancements.12",
|
67
|
+
"@genesislcap/vite-builder": "14.192.2-fdc3-enhancements.12",
|
68
|
+
"@genesislcap/webpack-builder": "14.192.2-fdc3-enhancements.12",
|
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.12",
|
74
|
+
"@genesislcap/foundation-notifications": "14.192.2-fdc3-enhancements.12",
|
75
|
+
"@genesislcap/foundation-ui": "14.192.2-fdc3-enhancements.12",
|
76
|
+
"@genesislcap/foundation-utils": "14.192.2-fdc3-enhancements.12",
|
77
|
+
"@genesislcap/web-core": "14.192.2-fdc3-enhancements.12",
|
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": "5ddad21f943a8957e8e774c69af30414433bc595"
|
93
93
|
}
|