@genesislcap/foundation-comms 14.169.0 → 14.170.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.
@@ -3,7 +3,6 @@ export * from './auth';
3
3
  export * from './connect';
4
4
  export * from './credentialManager';
5
5
  export * from './datasource';
6
- export * from './fdc3';
7
6
  export * from './metadata';
8
7
  export * from './networkMonitor';
9
8
  export * from './session';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC"}
package/dist/esm/index.js CHANGED
@@ -3,7 +3,6 @@ export * from './auth';
3
3
  export * from './connect';
4
4
  export * from './credentialManager';
5
5
  export * from './datasource';
6
- export * from './fdc3';
7
6
  export * from './metadata';
8
7
  export * from './networkMonitor';
9
8
  export * from './session';
@@ -17113,184 +17113,6 @@
17113
17113
  "endIndex": 6
17114
17114
  }
17115
17115
  },
17116
- {
17117
- "kind": "Interface",
17118
- "canonicalReference": "@genesislcap/foundation-comms!FDC3AppIntent:interface",
17119
- "docComment": "/**\n * @public\n */\n",
17120
- "excerptTokens": [
17121
- {
17122
- "kind": "Content",
17123
- "text": "export interface FDC3AppIntent extends "
17124
- },
17125
- {
17126
- "kind": "Reference",
17127
- "text": "AppIntent",
17128
- "canonicalReference": "@finos/fdc3!AppIntent:interface"
17129
- },
17130
- {
17131
- "kind": "Content",
17132
- "text": " "
17133
- }
17134
- ],
17135
- "fileUrlPath": "src/fdc3/fdc3.ts",
17136
- "releaseTag": "Public",
17137
- "name": "FDC3AppIntent",
17138
- "preserveMemberOrder": false,
17139
- "members": [],
17140
- "extendsTokenRanges": [
17141
- {
17142
- "startIndex": 1,
17143
- "endIndex": 2
17144
- }
17145
- ]
17146
- },
17147
- {
17148
- "kind": "Interface",
17149
- "canonicalReference": "@genesislcap/foundation-comms!FDC3Channel:interface",
17150
- "docComment": "/**\n * @public\n */\n",
17151
- "excerptTokens": [
17152
- {
17153
- "kind": "Content",
17154
- "text": "export interface FDC3Channel extends "
17155
- },
17156
- {
17157
- "kind": "Reference",
17158
- "text": "Channel",
17159
- "canonicalReference": "@finos/fdc3!Channel:interface"
17160
- },
17161
- {
17162
- "kind": "Content",
17163
- "text": " "
17164
- }
17165
- ],
17166
- "fileUrlPath": "src/fdc3/fdc3.ts",
17167
- "releaseTag": "Public",
17168
- "name": "FDC3Channel",
17169
- "preserveMemberOrder": false,
17170
- "members": [],
17171
- "extendsTokenRanges": [
17172
- {
17173
- "startIndex": 1,
17174
- "endIndex": 2
17175
- }
17176
- ]
17177
- },
17178
- {
17179
- "kind": "Interface",
17180
- "canonicalReference": "@genesislcap/foundation-comms!FDC3Context:interface",
17181
- "docComment": "/**\n * @public\n */\n",
17182
- "excerptTokens": [
17183
- {
17184
- "kind": "Content",
17185
- "text": "export interface FDC3Context extends "
17186
- },
17187
- {
17188
- "kind": "Reference",
17189
- "text": "Context",
17190
- "canonicalReference": "@finos/fdc3!Context:interface"
17191
- },
17192
- {
17193
- "kind": "Content",
17194
- "text": " "
17195
- }
17196
- ],
17197
- "fileUrlPath": "src/fdc3/fdc3.ts",
17198
- "releaseTag": "Public",
17199
- "name": "FDC3Context",
17200
- "preserveMemberOrder": false,
17201
- "members": [],
17202
- "extendsTokenRanges": [
17203
- {
17204
- "startIndex": 1,
17205
- "endIndex": 2
17206
- }
17207
- ]
17208
- },
17209
- {
17210
- "kind": "TypeAlias",
17211
- "canonicalReference": "@genesislcap/foundation-comms!FDC3ContextHandler:type",
17212
- "docComment": "/**\n * @public\n */\n",
17213
- "excerptTokens": [
17214
- {
17215
- "kind": "Content",
17216
- "text": "export type FDC3ContextHandler = "
17217
- },
17218
- {
17219
- "kind": "Reference",
17220
- "text": "ContextHandler",
17221
- "canonicalReference": "@finos/fdc3!ContextHandler:type"
17222
- },
17223
- {
17224
- "kind": "Content",
17225
- "text": ";"
17226
- }
17227
- ],
17228
- "fileUrlPath": "src/fdc3/fdc3.ts",
17229
- "releaseTag": "Public",
17230
- "name": "FDC3ContextHandler",
17231
- "typeTokenRange": {
17232
- "startIndex": 1,
17233
- "endIndex": 2
17234
- }
17235
- },
17236
- {
17237
- "kind": "Interface",
17238
- "canonicalReference": "@genesislcap/foundation-comms!FDC3IntentResolution:interface",
17239
- "docComment": "/**\n * @public\n */\n",
17240
- "excerptTokens": [
17241
- {
17242
- "kind": "Content",
17243
- "text": "export interface FDC3IntentResolution extends "
17244
- },
17245
- {
17246
- "kind": "Reference",
17247
- "text": "IntentResolution",
17248
- "canonicalReference": "@finos/fdc3!IntentResolution:interface"
17249
- },
17250
- {
17251
- "kind": "Content",
17252
- "text": " "
17253
- }
17254
- ],
17255
- "fileUrlPath": "src/fdc3/fdc3.ts",
17256
- "releaseTag": "Public",
17257
- "name": "FDC3IntentResolution",
17258
- "preserveMemberOrder": false,
17259
- "members": [],
17260
- "extendsTokenRanges": [
17261
- {
17262
- "startIndex": 1,
17263
- "endIndex": 2
17264
- }
17265
- ]
17266
- },
17267
- {
17268
- "kind": "TypeAlias",
17269
- "canonicalReference": "@genesislcap/foundation-comms!FDC3Intents:type",
17270
- "docComment": "/**\n * @public\n */\n",
17271
- "excerptTokens": [
17272
- {
17273
- "kind": "Content",
17274
- "text": "export type FDC3Intents = "
17275
- },
17276
- {
17277
- "kind": "Reference",
17278
- "text": "Intents",
17279
- "canonicalReference": "@finos/fdc3!Intents:enum"
17280
- },
17281
- {
17282
- "kind": "Content",
17283
- "text": ";"
17284
- }
17285
- ],
17286
- "fileUrlPath": "src/fdc3/fdc3.ts",
17287
- "releaseTag": "Public",
17288
- "name": "FDC3Intents",
17289
- "typeTokenRange": {
17290
- "startIndex": 1,
17291
- "endIndex": 2
17292
- }
17293
- },
17294
17116
  {
17295
17117
  "kind": "TypeAlias",
17296
17118
  "canonicalReference": "@genesislcap/foundation-comms!FieldMetadata:type",
@@ -1,14 +1,8 @@
1
1
  /// <reference types="webappsec-credential-management" />
2
2
 
3
- import { AppIntent } from '@finos/fdc3';
4
3
  import { BehaviorSubject } from 'rxjs';
5
4
  import { default as Bowser_2 } from 'bowser';
6
- import { Channel } from '@finos/fdc3';
7
- import { Context } from '@finos/fdc3';
8
- import { ContextHandler } from '@finos/fdc3';
9
5
  import type { DTOMapper } from '@genesislcap/foundation-utils';
10
- import { IntentResolution } from '@finos/fdc3';
11
- import { Intents } from '@finos/fdc3';
12
6
  import { InterfaceSymbol } from '@microsoft/fast-foundation';
13
7
  import { JSONSchema7 } from 'json-schema';
14
8
  import { JSONSerializer } from '@genesislcap/foundation-utils';
@@ -1299,23 +1293,6 @@ export declare class DefaultEntityDatasource<TDTO, TEntity> extends DefaultDatas
1299
1293
  protected processRowDataUpdate(rowData: RowData[], inserting?: boolean): void;
1300
1294
  }
1301
1295
 
1302
- /**
1303
- * The FDC3 implementation.
1304
- * @internal
1305
- */
1306
- export declare class DefaultFDC3 implements FDC3_2 {
1307
- isReady: boolean;
1308
- constructor();
1309
- private connect;
1310
- addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
1311
- findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
1312
- findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
1313
- raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
1314
- joinChannel(channelId: string): Promise<void>;
1315
- getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
1316
- broadcastOnChannel(channelId: string, context: FDC3Context): Promise<void>;
1317
- }
1318
-
1319
1296
  /**
1320
1297
  * The default implementation for the FoundationAnalytics interface.
1321
1298
  * @public
@@ -1933,115 +1910,6 @@ export declare const exponentialScheduler: SocketReconnectScheduler;
1933
1910
  */
1934
1911
  export declare const extractFieldDefinitions: (metadata: Metadata) => MetadataDetail[];
1935
1912
 
1936
- /**
1937
- * The DI token for the FDC3 interface.
1938
- * @internal
1939
- */
1940
- export declare const FDC3: InterfaceSymbol<FDC3_2>;
1941
-
1942
- /**
1943
- * The FDC3 API interface.
1944
- * @public
1945
- */
1946
- declare interface FDC3_2 {
1947
- /**
1948
- * Whether the FDC3 API is ready.
1949
- * @public
1950
- */
1951
- isReady: boolean;
1952
- /**
1953
- * Adds intent listeners for the specified intents.
1954
- * @public
1955
- * @param listeners - The intent listeners to add.
1956
- */
1957
- addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
1958
- /**
1959
- * Finds an app that supports the specified intent.
1960
- * @public
1961
- * @param intent - The intent to find an app for.
1962
- * @param context - The context to use.
1963
- * @returns A promise that resolves with the app and its metadata.
1964
- */
1965
- findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
1966
- /**
1967
- * Finds all the intents supported by the specified context.
1968
- * @public
1969
- * @param context - The context to use.
1970
- * @returns A promise that resolves with an array of all matching intents and their metadata.
1971
- */
1972
- findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
1973
- /**
1974
- * Raises the specified intent with the specified context.
1975
- * @public
1976
- * @param context - The context to use.
1977
- * @param intent - The intent to raise.
1978
- * @returns A promise that resolves with the result of the intent resolution.
1979
- */
1980
- raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
1981
- /**
1982
- * Joins the specified channel.
1983
- * @public
1984
- * @param channelId - The ID of the channel to join.
1985
- * @returns A promise that resolves when the join is successful.
1986
- */
1987
- joinChannel(channelId: string): Promise<void>;
1988
- /**
1989
- * Gets or creates the specified channel.
1990
- * @public
1991
- * @param channelId - The ID of the channel to get or create.
1992
- * @returns A promise that resolves with the channel object.
1993
- */
1994
- getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
1995
- /**
1996
- * Broadcasts the specified context on the specified channel.
1997
- * @public
1998
- * @param channelId - The ID of the channel to broadcast on.
1999
- * @param context - The context to broadcast.
2000
- * @returns A promise that resolves when the broadcast is successful.
2001
- */
2002
- broadcastOnChannel(channelId: string, context: FDC3Context): Promise<void>;
2003
- }
2004
-
2005
- /**
2006
- * The DI token for the FDC3 interface.
2007
- * @internal
2008
- */
2009
- declare const FDC3: InterfaceSymbol<FDC3_2>;
2010
-
2011
- /**
2012
- * @public
2013
- */
2014
- export declare interface FDC3AppIntent extends AppIntent {
2015
- }
2016
-
2017
- /**
2018
- * @public
2019
- */
2020
- export declare interface FDC3Channel extends Channel {
2021
- }
2022
-
2023
- /**
2024
- * @public
2025
- */
2026
- export declare interface FDC3Context extends Context {
2027
- }
2028
-
2029
- /**
2030
- * @public
2031
- */
2032
- export declare type FDC3ContextHandler = ContextHandler;
2033
-
2034
- /**
2035
- * @public
2036
- */
2037
- export declare interface FDC3IntentResolution extends IntentResolution {
2038
- }
2039
-
2040
- /**
2041
- * @public
2042
- */
2043
- export declare type FDC3Intents = Intents;
2044
-
2045
1913
  /**
2046
1914
  * Field Metadata definition.
2047
1915
  * @public
@@ -73,10 +73,6 @@
73
73
  | [DatasourceOptions](./foundation-comms.datasourceoptions.md) | Options that can be passed when initializing a datasource. |
74
74
  | [DataUpdate](./foundation-comms.dataupdate.md) | Data Update definition with details of what data to add, drop, and/or modify. |
75
75
  | [Dataview](./foundation-comms.dataview.md) | Dataview object |
76
- | [FDC3AppIntent](./foundation-comms.fdc3appintent.md) | |
77
- | [FDC3Channel](./foundation-comms.fdc3channel.md) | |
78
- | [FDC3Context](./foundation-comms.fdc3context.md) | |
79
- | [FDC3IntentResolution](./foundation-comms.fdc3intentresolution.md) | |
80
76
  | [FoundationAnalytics](./foundation-comms.foundationanalytics.md) | Represents an analytics tracking system. |
81
77
  | [Http](./foundation-comms.http.md) | An interface representing an HTTP client that can make GET and POST requests and return a promise with the response data. |
82
78
  | [HttpConnectConfig](./foundation-comms.httpconnectconfig.md) | Configuration options for the Connect (HTTP) instance. |
@@ -146,8 +142,6 @@
146
142
  | [CommitParams](./foundation-comms.commitparams.md) | Parameters for a COMMIT message |
147
143
  | [ConnectionStatus](./foundation-comms.connectionstatus.md) | The connection status of the Genesis client. |
148
144
  | [CredentialData\_2](./foundation-comms.credentialdata_2.md) | Represents user credentials. |
149
- | [FDC3ContextHandler](./foundation-comms.fdc3contexthandler.md) | |
150
- | [FDC3Intents](./foundation-comms.fdc3intents.md) | |
151
145
  | [FieldMetadata](./foundation-comms.fieldmetadata.md) | Field Metadata definition. |
152
146
  | [FilteredDataServerResult](./foundation-comms.filtereddataserverresult.md) | Fitlered result after initial DATASERVER data fetch. |
153
147
  | [GenesisConnectEvents](./foundation-comms.genesisconnectevents.md) | Genesis connect events that can be monitored to invoke resource checking. |
@@ -6,15 +6,9 @@
6
6
 
7
7
  /// <reference types="webappsec-credential-management" />
8
8
 
9
- import { AppIntent } from '@finos/fdc3';
10
9
  import { BehaviorSubject } from 'rxjs';
11
10
  import { default as Bowser_2 } from 'bowser';
12
- import { Channel } from '@finos/fdc3';
13
- import { Context } from '@finos/fdc3';
14
- import { ContextHandler } from '@finos/fdc3';
15
11
  import type { DTOMapper } from '@genesislcap/foundation-utils';
16
- import { IntentResolution } from '@finos/fdc3';
17
- import { Intents } from '@finos/fdc3';
18
12
  import { InterfaceSymbol } from '@microsoft/fast-foundation';
19
13
  import { JSONSchema7 } from 'json-schema';
20
14
  import { JSONSerializer } from '@genesislcap/foundation-utils';
@@ -778,30 +772,6 @@ export class DefaultEntityDatasource<TDTO, TEntity> extends DefaultDatasource im
778
772
  protected updateCache(result: FilteredDataServerResult): void;
779
773
  }
780
774
 
781
- // Warning: (ae-forgotten-export) The symbol "FDC3_2" needs to be exported by the entry point index.d.ts
782
- // Warning: (ae-internal-missing-underscore) The name "DefaultFDC3" should be prefixed with an underscore because the declaration is marked as @internal
783
- //
784
- // @internal
785
- export class DefaultFDC3 implements FDC3_2 {
786
- constructor();
787
- // (undocumented)
788
- addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
789
- // (undocumented)
790
- broadcastOnChannel(channelId: string, context: FDC3Context): Promise<void>;
791
- // (undocumented)
792
- findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
793
- // (undocumented)
794
- findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
795
- // (undocumented)
796
- getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
797
- // (undocumented)
798
- isReady: boolean;
799
- // (undocumented)
800
- joinChannel(channelId: string): Promise<void>;
801
- // (undocumented)
802
- raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
803
- }
804
-
805
775
  // @public
806
776
  export class DefaultFoundationAnalytics implements FoundationAnalytics {
807
777
  constructor(config: {
@@ -1178,33 +1148,6 @@ export const exponentialScheduler: SocketReconnectScheduler;
1178
1148
  // @public
1179
1149
  export const extractFieldDefinitions: (metadata: Metadata) => MetadataDetail[];
1180
1150
 
1181
- // Warning: (ae-internal-missing-underscore) The name "FDC3" should be prefixed with an underscore because the declaration is marked as @internal
1182
- //
1183
- // @internal
1184
- export const FDC3: InterfaceSymbol<FDC3_2>;
1185
-
1186
- // @public (undocumented)
1187
- export interface FDC3AppIntent extends AppIntent {
1188
- }
1189
-
1190
- // @public (undocumented)
1191
- export interface FDC3Channel extends Channel {
1192
- }
1193
-
1194
- // @public (undocumented)
1195
- export interface FDC3Context extends Context {
1196
- }
1197
-
1198
- // @public (undocumented)
1199
- export type FDC3ContextHandler = ContextHandler;
1200
-
1201
- // @public (undocumented)
1202
- export interface FDC3IntentResolution extends IntentResolution {
1203
- }
1204
-
1205
- // @public (undocumented)
1206
- export type FDC3Intents = Intents;
1207
-
1208
1151
  // @public
1209
1152
  export type FieldMetadata = {
1210
1153
  name: string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-comms",
3
3
  "description": "Genesis Foundation UI Comms",
4
- "version": "14.169.0",
4
+ "version": "14.170.0",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -66,22 +66,21 @@
66
66
  "test:debug": "genx test --debug"
67
67
  },
68
68
  "devDependencies": {
69
- "@genesislcap/foundation-testing": "14.169.0",
70
- "@genesislcap/genx": "14.169.0",
71
- "@genesislcap/rollup-builder": "14.169.0",
72
- "@genesislcap/ts-builder": "14.169.0",
73
- "@genesislcap/uvu-playwright-builder": "14.169.0",
74
- "@genesislcap/vite-builder": "14.169.0",
75
- "@genesislcap/webpack-builder": "14.169.0",
69
+ "@genesislcap/foundation-testing": "14.170.0",
70
+ "@genesislcap/genx": "14.170.0",
71
+ "@genesislcap/rollup-builder": "14.170.0",
72
+ "@genesislcap/ts-builder": "14.170.0",
73
+ "@genesislcap/uvu-playwright-builder": "14.170.0",
74
+ "@genesislcap/vite-builder": "14.170.0",
75
+ "@genesislcap/webpack-builder": "14.170.0",
76
76
  "@types/js-cookie": "^3.0.2",
77
77
  "@types/json-schema": "^7.0.11",
78
78
  "@types/webappsec-credential-management": "^0.6.2",
79
79
  "rimraf": "^3.0.2"
80
80
  },
81
81
  "dependencies": {
82
- "@finos/fdc3": "^1.2.0",
83
- "@genesislcap/foundation-logger": "14.169.0",
84
- "@genesislcap/foundation-utils": "14.169.0",
82
+ "@genesislcap/foundation-logger": "14.170.0",
83
+ "@genesislcap/foundation-utils": "14.170.0",
85
84
  "@microsoft/fast-element": "^1.12.0",
86
85
  "@microsoft/fast-foundation": "^2.49.4",
87
86
  "analytics": "^0.8.0",
@@ -100,5 +99,5 @@
100
99
  "publishConfig": {
101
100
  "access": "public"
102
101
  },
103
- "gitHead": "59695045bb3be9f8f42679be27fc88cd911e5136"
102
+ "gitHead": "98a1e02bb120637346bd3e6be6b4c050e63a1347"
104
103
  }
@@ -1,117 +0,0 @@
1
- /**
2
- * See https://fdc3.finos.org/docs/fdc3-intro, and https://github.com/finos/FDC3/tree/master/src/api
3
- */
4
- import { AppIntent, Channel, Context, ContextHandler, Intents, IntentResolution } from '@finos/fdc3';
5
- /**
6
- * @public
7
- */
8
- export type FDC3Intents = Intents;
9
- /**
10
- * @public
11
- */
12
- export type FDC3ContextHandler = ContextHandler;
13
- /**
14
- * @public
15
- */
16
- export interface FDC3AppIntent extends AppIntent {
17
- }
18
- /**
19
- * @public
20
- */
21
- export interface FDC3Context extends Context {
22
- }
23
- /**
24
- * @public
25
- */
26
- export interface FDC3IntentResolution extends IntentResolution {
27
- }
28
- /**
29
- * @public
30
- */
31
- export interface FDC3Channel extends Channel {
32
- }
33
- /**
34
- * The FDC3 API interface.
35
- * @public
36
- */
37
- interface FDC3 {
38
- /**
39
- * Whether the FDC3 API is ready.
40
- * @public
41
- */
42
- isReady: boolean;
43
- /**
44
- * Adds intent listeners for the specified intents.
45
- * @public
46
- * @param listeners - The intent listeners to add.
47
- */
48
- addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
49
- /**
50
- * Finds an app that supports the specified intent.
51
- * @public
52
- * @param intent - The intent to find an app for.
53
- * @param context - The context to use.
54
- * @returns A promise that resolves with the app and its metadata.
55
- */
56
- findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
57
- /**
58
- * Finds all the intents supported by the specified context.
59
- * @public
60
- * @param context - The context to use.
61
- * @returns A promise that resolves with an array of all matching intents and their metadata.
62
- */
63
- findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
64
- /**
65
- * Raises the specified intent with the specified context.
66
- * @public
67
- * @param context - The context to use.
68
- * @param intent - The intent to raise.
69
- * @returns A promise that resolves with the result of the intent resolution.
70
- */
71
- raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
72
- /**
73
- * Joins the specified channel.
74
- * @public
75
- * @param channelId - The ID of the channel to join.
76
- * @returns A promise that resolves when the join is successful.
77
- */
78
- joinChannel(channelId: string): Promise<void>;
79
- /**
80
- * Gets or creates the specified channel.
81
- * @public
82
- * @param channelId - The ID of the channel to get or create.
83
- * @returns A promise that resolves with the channel object.
84
- */
85
- getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
86
- /**
87
- * Broadcasts the specified context on the specified channel.
88
- * @public
89
- * @param channelId - The ID of the channel to broadcast on.
90
- * @param context - The context to broadcast.
91
- * @returns A promise that resolves when the broadcast is successful.
92
- */
93
- broadcastOnChannel(channelId: string, context: FDC3Context): Promise<void>;
94
- }
95
- /**
96
- * The FDC3 implementation.
97
- * @internal
98
- */
99
- export declare class DefaultFDC3 implements FDC3 {
100
- isReady: boolean;
101
- constructor();
102
- private connect;
103
- addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
104
- findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
105
- findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
106
- raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
107
- joinChannel(channelId: string): Promise<void>;
108
- getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
109
- broadcastOnChannel(channelId: string, context: FDC3Context): Promise<void>;
110
- }
111
- /**
112
- * The DI token for the FDC3 interface.
113
- * @internal
114
- */
115
- export declare const FDC3: import("@microsoft/fast-foundation").InterfaceSymbol<FDC3>;
116
- export {};
117
- //# sourceMappingURL=fdc3.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"fdc3.d.ts","sourceRoot":"","sources":["../../../src/fdc3/fdc3.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAEL,SAAS,EACT,OAAO,EACP,OAAO,EACP,cAAc,EAMd,OAAO,EACP,gBAAgB,EAKjB,MAAM,aAAa,CAAC;AAKrB;;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,UAAU,IAAI;IACZ;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;;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;;;;;;OAMG;IACH,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5E;AAED;;;GAGG;AACH,qBAAa,WAAY,YAAW,IAAI;IAE/B,OAAO,UAAS;;YAMT,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;IActF,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK7C,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAKrD,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAKxF;AAED;;;GAGG;AACH,eAAO,MAAM,IAAI,4DAA4D,CAAC"}
@@ -1,2 +0,0 @@
1
- export * from './fdc3';
2
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/fdc3/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC"}
@@ -1,79 +0,0 @@
1
- import { __awaiter, __decorate } from "tslib";
2
- /**
3
- * See https://fdc3.finos.org/docs/fdc3-intro, and https://github.com/finos/FDC3/tree/master/src/api
4
- */
5
- import { addIntentListener, fdc3Ready, findIntent, findIntentsByContext, getOrCreateChannel, getInfo, joinChannel, raiseIntent, raiseIntentForContext, versionIsAtLeast, } from '@finos/fdc3';
6
- import { observable } from '@microsoft/fast-element';
7
- import { DI } from '@microsoft/fast-foundation';
8
- import { logger } from '../utils';
9
- /**
10
- * The FDC3 implementation.
11
- * @internal
12
- */
13
- export class DefaultFDC3 {
14
- constructor() {
15
- this.isReady = false;
16
- this.connect();
17
- }
18
- connect() {
19
- return __awaiter(this, void 0, void 0, function* () {
20
- try {
21
- this.isReady = false;
22
- yield fdc3Ready();
23
- logger.debug('fdc3 connection success');
24
- }
25
- catch (err) {
26
- logger.error('fdc3 connection error', err);
27
- throw err;
28
- }
29
- });
30
- }
31
- addIntentListeners(listeners) {
32
- listeners.forEach((handler, intent) => {
33
- const listener = addIntentListener(intent, handler);
34
- logger.debug(`fdc3 addIntentListener for '${intent}', ${listener}`);
35
- });
36
- }
37
- findIntent(intent, context) {
38
- logger.debug(`fdc3 findIntent '${intent}' '${context}'`);
39
- return findIntent(intent, context);
40
- }
41
- findIntentsByContext(context) {
42
- logger.debug(`fdc3 findIntentsByContext '${context}'`);
43
- return findIntentsByContext(context);
44
- }
45
- raiseIntent(context, intent) {
46
- if (getInfo && versionIsAtLeast(getInfo(), '1.2')) {
47
- logger.debug(`fdc3 raiseIntentForContext '${context}'`);
48
- return raiseIntentForContext(context);
49
- }
50
- if (intent) {
51
- logger.debug(`fdc3 raiseIntent '${intent}' '${context}'`);
52
- return raiseIntent(intent, context);
53
- }
54
- logger.error(`fdc3 unable to raiseIntent using context '${context}' and intent '${intent}'.`);
55
- }
56
- joinChannel(channelId) {
57
- logger.debug(`fdc3 joinChannel '${channelId}'`);
58
- return joinChannel(channelId);
59
- }
60
- getOrCreateChannel(channelId) {
61
- logger.debug(`fdc3 getOrCreateChannel '${channelId}'`);
62
- return getOrCreateChannel(channelId);
63
- }
64
- broadcastOnChannel(channelId, context) {
65
- return __awaiter(this, void 0, void 0, function* () {
66
- const channel = yield this.getOrCreateChannel(channelId);
67
- logger.debug(`fdc3 broadcast '${channelId}' '${context}'`);
68
- channel.broadcast(context);
69
- });
70
- }
71
- }
72
- __decorate([
73
- observable
74
- ], DefaultFDC3.prototype, "isReady", void 0);
75
- /**
76
- * The DI token for the FDC3 interface.
77
- * @internal
78
- */
79
- export const FDC3 = DI.createInterface((x) => x.singleton(DefaultFDC3));
@@ -1 +0,0 @@
1
- export * from './fdc3';
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [FDC3AppIntent](./foundation-comms.fdc3appintent.md)
4
-
5
- ## FDC3AppIntent interface
6
-
7
-
8
- **Signature:**
9
-
10
- ```typescript
11
- export interface FDC3AppIntent extends AppIntent
12
- ```
13
- **Extends:** AppIntent
14
-
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [FDC3Channel](./foundation-comms.fdc3channel.md)
4
-
5
- ## FDC3Channel interface
6
-
7
-
8
- **Signature:**
9
-
10
- ```typescript
11
- export interface FDC3Channel extends Channel
12
- ```
13
- **Extends:** Channel
14
-
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [FDC3Context](./foundation-comms.fdc3context.md)
4
-
5
- ## FDC3Context interface
6
-
7
-
8
- **Signature:**
9
-
10
- ```typescript
11
- export interface FDC3Context extends Context
12
- ```
13
- **Extends:** Context
14
-
@@ -1,12 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [FDC3ContextHandler](./foundation-comms.fdc3contexthandler.md)
4
-
5
- ## FDC3ContextHandler type
6
-
7
-
8
- **Signature:**
9
-
10
- ```typescript
11
- export type FDC3ContextHandler = ContextHandler;
12
- ```
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [FDC3IntentResolution](./foundation-comms.fdc3intentresolution.md)
4
-
5
- ## FDC3IntentResolution interface
6
-
7
-
8
- **Signature:**
9
-
10
- ```typescript
11
- export interface FDC3IntentResolution extends IntentResolution
12
- ```
13
- **Extends:** IntentResolution
14
-
@@ -1,12 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [FDC3Intents](./foundation-comms.fdc3intents.md)
4
-
5
- ## FDC3Intents type
6
-
7
-
8
- **Signature:**
9
-
10
- ```typescript
11
- export type FDC3Intents = Intents;
12
- ```