@genesislcap/foundation-comms 14.167.3-alpha-b40d1e5.0 → 14.167.3-alpha-69ba23f.0
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/dts/auth/auth.d.ts.map +1 -1
- package/dist/dts/connect/connect.d.ts +1 -11
- package/dist/dts/connect/connect.d.ts.map +1 -1
- package/dist/dts/connect/http.connect.d.ts +0 -1
- package/dist/dts/connect/http.connect.d.ts.map +1 -1
- package/dist/dts/connect/index.d.ts +0 -2
- package/dist/dts/connect/index.d.ts.map +1 -1
- package/dist/dts/connect/message.d.ts +0 -51
- package/dist/dts/connect/message.d.ts.map +1 -1
- package/dist/dts/connect/socket.d.ts +8 -72
- package/dist/dts/connect/socket.d.ts.map +1 -1
- package/dist/dts/datasource/datasource.d.ts +0 -9
- package/dist/dts/datasource/datasource.d.ts.map +1 -1
- package/dist/dts/fdc3/fdc3.d.ts +1 -17
- package/dist/dts/fdc3/fdc3.d.ts.map +1 -1
- package/dist/dts/index.d.ts +0 -1
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/dts/testing/mocks/connect/connect.d.ts +0 -1
- package/dist/dts/testing/mocks/connect/connect.d.ts.map +1 -1
- package/dist/dts/testing/mocks/connect/socket.d.ts +1 -5
- package/dist/dts/testing/mocks/connect/socket.d.ts.map +1 -1
- package/dist/dts/testing/mocks/datasource/datasource.d.ts +0 -1
- package/dist/dts/testing/mocks/datasource/datasource.d.ts.map +1 -1
- package/dist/dts/user/user.d.ts +0 -15
- package/dist/dts/user/user.d.ts.map +1 -1
- package/dist/esm/auth/auth.js +2 -5
- package/dist/esm/connect/connect.js +8 -30
- package/dist/esm/connect/http.connect.js +0 -6
- package/dist/esm/connect/index.js +0 -2
- package/dist/esm/connect/message.js +4 -25
- package/dist/esm/connect/socket.js +44 -113
- package/dist/esm/datasource/datasource.js +8 -18
- package/dist/esm/fdc3/fdc3.js +4 -4
- package/dist/esm/index.js +0 -1
- package/dist/esm/testing/mocks/connect/connect.js +0 -3
- package/dist/esm/testing/mocks/connect/socket.js +1 -1
- package/dist/esm/testing/mocks/datasource/datasource.js +0 -1
- package/dist/esm/user/user.js +1 -22
- package/dist/foundation-comms.api.json +6567 -13112
- package/dist/foundation-comms.d.ts +13 -841
- package/docs/api/foundation-comms.connect.md +0 -1
- package/docs/api/foundation-comms.currentuser.md +0 -2
- package/docs/api/foundation-comms.datasource.md +0 -1
- package/docs/api/foundation-comms.defaultconnect._constructor_.md +1 -2
- package/docs/api/foundation-comms.defaultconnect.md +1 -2
- package/docs/api/foundation-comms.defaultdatasource.md +0 -1
- package/docs/api/foundation-comms.defaulthttpconnect.md +0 -1
- package/docs/api/foundation-comms.md +0 -39
- package/docs/api/foundation-comms.messagebuilder.md +0 -1
- package/docs/api/foundation-comms.messagetype.md +0 -2
- package/docs/api/foundation-comms.socket.hasvalidsession.md +11 -0
- package/docs/api/foundation-comms.socket.isconnected.md +11 -0
- package/docs/api/{foundation-comms.socketstatus.isconnectedsubject.md → foundation-comms.socket.isconnectedsubject.md} +2 -2
- package/docs/api/foundation-comms.socket.isreconnecting.md +11 -0
- package/docs/api/foundation-comms.socket.md +11 -3
- package/docs/api/foundation-comms.socket.sendforstream.md +1 -2
- package/docs/api/foundation-comms.user.md +0 -2
- package/docs/api-report.md +16 -520
- package/package.json +11 -13
- package/dist/dts/connect/connect.events.d.ts +0 -173
- package/dist/dts/connect/connect.events.d.ts.map +0 -1
- package/dist/dts/connect/socket.status.d.ts +0 -79
- package/dist/dts/connect/socket.status.d.ts.map +0 -1
- package/dist/dts/networkMonitor/config.d.ts +0 -56
- package/dist/dts/networkMonitor/config.d.ts.map +0 -1
- package/dist/dts/networkMonitor/index.d.ts +0 -4
- package/dist/dts/networkMonitor/index.d.ts.map +0 -1
- package/dist/dts/networkMonitor/service.d.ts +0 -193
- package/dist/dts/networkMonitor/service.d.ts.map +0 -1
- package/dist/dts/networkMonitor/types.d.ts +0 -133
- package/dist/dts/networkMonitor/types.d.ts.map +0 -1
- package/dist/esm/connect/connect.events.js +0 -113
- package/dist/esm/connect/socket.status.js +0 -119
- package/dist/esm/networkMonitor/config.js +0 -46
- package/dist/esm/networkMonitor/index.js +0 -3
- package/dist/esm/networkMonitor/service.js +0 -432
- package/dist/esm/networkMonitor/types.js +0 -5
- package/docs/api/foundation-comms.commitevent.md +0 -14
- package/docs/api/foundation-comms.commiteventdetail.md +0 -17
- package/docs/api/foundation-comms.commiteventtype.md +0 -12
- package/docs/api/foundation-comms.connect.getmorecolumns.md +0 -26
- package/docs/api/foundation-comms.connectevents.addcommitlistener.md +0 -24
- package/docs/api/foundation-comms.connectevents.addmetadatalistener.md +0 -24
- package/docs/api/foundation-comms.connectevents.addstreamlistener.md +0 -25
- package/docs/api/foundation-comms.connectevents.md +0 -22
- package/docs/api/foundation-comms.connecteventsemitter.md +0 -24
- package/docs/api/foundation-comms.connecteventsemitter.oncommitevent.md +0 -25
- package/docs/api/foundation-comms.connecteventsemitter.onmetadataevent.md +0 -26
- package/docs/api/foundation-comms.connecteventsemitter.onstreamcompleteevent.md +0 -24
- package/docs/api/foundation-comms.connecteventsemitter.onstreamevent.md +0 -27
- package/docs/api/foundation-comms.currentuser.set.md +0 -22
- package/docs/api/foundation-comms.currentuser.unset.md +0 -15
- package/docs/api/foundation-comms.datasource.destroy.md +0 -17
- package/docs/api/foundation-comms.defaultconnect.getmorecolumns.md +0 -22
- package/docs/api/foundation-comms.defaultconnectevents.addcommitlistener.md +0 -24
- package/docs/api/foundation-comms.defaultconnectevents.addmetadatalistener.md +0 -24
- package/docs/api/foundation-comms.defaultconnectevents.addstreamlistener.md +0 -25
- package/docs/api/foundation-comms.defaultconnectevents.md +0 -27
- package/docs/api/foundation-comms.defaultconnectevents.oncommitevent.md +0 -25
- package/docs/api/foundation-comms.defaultconnectevents.onmetadataevent.md +0 -26
- package/docs/api/foundation-comms.defaultconnectevents.onstreamcompleteevent.md +0 -24
- package/docs/api/foundation-comms.defaultconnectevents.onstreamevent.md +0 -27
- package/docs/api/foundation-comms.defaultdatasource.destroy.md +0 -17
- package/docs/api/foundation-comms.defaulthttpconnect.getmorecolumns.md +0 -22
- package/docs/api/foundation-comms.defaultmessagebuilder._constructor_.md +0 -21
- package/docs/api/foundation-comms.defaultmessagebuilder.createchangepasswordmessage.md +0 -24
- package/docs/api/foundation-comms.defaultmessagebuilder.createcommitmessage.md +0 -23
- package/docs/api/foundation-comms.defaultmessagebuilder.createdatalogoffmessage.md +0 -22
- package/docs/api/foundation-comms.defaultmessagebuilder.createdatalogonmessage.md +0 -23
- package/docs/api/foundation-comms.defaultmessagebuilder.createforgotpasswordmessage.md +0 -24
- package/docs/api/foundation-comms.defaultmessagebuilder.createforgotpasswordtokenmessage.md +0 -25
- package/docs/api/foundation-comms.defaultmessagebuilder.createhttpheadersfrommessage.md +0 -23
- package/docs/api/foundation-comms.defaultmessagebuilder.createloginmessage.md +0 -22
- package/docs/api/foundation-comms.defaultmessagebuilder.createlogoutmessage.md +0 -22
- package/docs/api/foundation-comms.defaultmessagebuilder.createmetarequestmessage.md +0 -23
- package/docs/api/foundation-comms.defaultmessagebuilder.createmorecolumnsmessage.md +0 -22
- package/docs/api/foundation-comms.defaultmessagebuilder.createmorerowsmessage.md +0 -22
- package/docs/api/foundation-comms.defaultmessagebuilder.createrefreshtokenmessage.md +0 -15
- package/docs/api/foundation-comms.defaultmessagebuilder.createrequestmessage.md +0 -23
- package/docs/api/foundation-comms.defaultmessagebuilder.createresourcesmessage.md +0 -22
- package/docs/api/foundation-comms.defaultmessagebuilder.md +0 -41
- package/docs/api/foundation-comms.defaultnetworkmonitor.addresource.md +0 -23
- package/docs/api/foundation-comms.defaultnetworkmonitor.create.md +0 -16
- package/docs/api/foundation-comms.defaultnetworkmonitor.destroy.md +0 -16
- package/docs/api/foundation-comms.defaultnetworkmonitor.md +0 -31
- package/docs/api/foundation-comms.defaultnetworkmonitor.removeresource.md +0 -22
- package/docs/api/foundation-comms.defaultnetworkmonitor.runallchecks.md +0 -11
- package/docs/api/foundation-comms.defaultnetworkmonitor.status.md +0 -12
- package/docs/api/foundation-comms.defaultnetworkmonitorconfig.md +0 -13
- package/docs/api/foundation-comms.defaultsocket._constructor_.md +0 -24
- package/docs/api/foundation-comms.defaultsocket.connect.md +0 -24
- package/docs/api/foundation-comms.defaultsocket.hasvalidsession.md +0 -13
- package/docs/api/foundation-comms.defaultsocket.isconfigured.md +0 -11
- package/docs/api/foundation-comms.defaultsocket.isconnected.md +0 -11
- package/docs/api/foundation-comms.defaultsocket.isconnectedsubject.md +0 -11
- package/docs/api/foundation-comms.defaultsocket.isconnecting.md +0 -11
- package/docs/api/foundation-comms.defaultsocket.isdisconnected.md +0 -11
- package/docs/api/foundation-comms.defaultsocket.isdisconnectedbyserver.md +0 -11
- package/docs/api/foundation-comms.defaultsocket.isreconnecting.md +0 -11
- package/docs/api/foundation-comms.defaultsocket.md +0 -44
- package/docs/api/foundation-comms.defaultsocket.reset.md +0 -15
- package/docs/api/foundation-comms.defaultsocket.send.md +0 -23
- package/docs/api/foundation-comms.defaultsocket.sendforstream.md +0 -25
- package/docs/api/foundation-comms.defaultsocket.socketmessages.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.closedclean.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.closedcode.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.closedreason.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.hasvalidsession.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.isconfigured.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.isconnected.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.isconnectedchanged.md +0 -15
- package/docs/api/foundation-comms.defaultsocketstatus.isconnectedsubject.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.isconnecting.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.isdisconnected.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.isdisconnectedbyserver.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.isreconnecting.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.isreconnectingchanged.md +0 -15
- package/docs/api/foundation-comms.defaultsocketstatus.md +0 -42
- package/docs/api/foundation-comms.defaultsocketstatus.onclose.md +0 -22
- package/docs/api/foundation-comms.defaultsocketstatus.reconnectionlimitreached.md +0 -11
- package/docs/api/foundation-comms.defaultsocketstatus.resetclosedstate.md +0 -15
- package/docs/api/foundation-comms.defaultsocketstatus.serialize.md +0 -15
- package/docs/api/foundation-comms.genesisconnectevents.md +0 -18
- package/docs/api/foundation-comms.getnetworkmonitor.md +0 -30
- package/docs/api/foundation-comms.getsocket.md +0 -30
- package/docs/api/foundation-comms.getsocketstatus.md +0 -30
- package/docs/api/foundation-comms.messagebuilder.createmorecolumnsmessage.md +0 -30
- package/docs/api/foundation-comms.messagehaserrorcode.md +0 -13
- package/docs/api/foundation-comms.metadataevent.md +0 -14
- package/docs/api/foundation-comms.metadataeventdetail.md +0 -18
- package/docs/api/foundation-comms.metadataeventtype.md +0 -12
- package/docs/api/foundation-comms.monitoredresource.md +0 -15
- package/docs/api/foundation-comms.monitoredresourcechecks.md +0 -15
- package/docs/api/foundation-comms.monitoredresourcechecksresult.isconnected.md +0 -11
- package/docs/api/foundation-comms.monitoredresourcechecksresult.lastmessage.md +0 -11
- package/docs/api/foundation-comms.monitoredresourcechecksresult.lastupdated.md +0 -11
- package/docs/api/foundation-comms.monitoredresourcechecksresult.md +0 -23
- package/docs/api/foundation-comms.monitoredresourcechecksresult.timeout.md +0 -11
- package/docs/api/foundation-comms.monitoredresourcedatalogon.md +0 -15
- package/docs/api/foundation-comms.monitoredresourcemetadata.md +0 -15
- package/docs/api/foundation-comms.networklogger.md +0 -12
- package/docs/api/foundation-comms.networkmonitor.addresource.md +0 -23
- package/docs/api/foundation-comms.networkmonitor.create.md +0 -15
- package/docs/api/foundation-comms.networkmonitor.destroy.md +0 -15
- package/docs/api/foundation-comms.networkmonitor.md +0 -34
- package/docs/api/foundation-comms.networkmonitor.removeresource.md +0 -22
- package/docs/api/foundation-comms.networkmonitor.runallchecks.md +0 -23
- package/docs/api/foundation-comms.networkmonitor.status.md +0 -11
- package/docs/api/foundation-comms.networkmonitorconfig.checkinterval.md +0 -13
- package/docs/api/foundation-comms.networkmonitorconfig.checktimeout.md +0 -13
- package/docs/api/foundation-comms.networkmonitorconfig.documentevents.md +0 -13
- package/docs/api/foundation-comms.networkmonitorconfig.eventemitter.md +0 -13
- package/docs/api/foundation-comms.networkmonitorconfig.genesisconnectevents.md +0 -13
- package/docs/api/foundation-comms.networkmonitorconfig.md +0 -27
- package/docs/api/foundation-comms.networkmonitorconfig.resourcechecks.md +0 -13
- package/docs/api/foundation-comms.networkmonitorconfig.resourcedatalogon.md +0 -18
- package/docs/api/foundation-comms.networkmonitorconfig.windowevents.md +0 -13
- package/docs/api/foundation-comms.resourcehealth.md +0 -19
- package/docs/api/foundation-comms.serializedsocketstatus.closedclean.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.closedcode.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.closedreason.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.hasvalidsession.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.isconfigured.md +0 -13
- package/docs/api/foundation-comms.serializedsocketstatus.isconnected.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.isconnecting.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.isdisconnected.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.isdisconnectedbyserver.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.isreconnecting.md +0 -11
- package/docs/api/foundation-comms.serializedsocketstatus.md +0 -30
- package/docs/api/foundation-comms.serializedsocketstatus.reconnectionlimitreached.md +0 -11
- package/docs/api/foundation-comms.socketstatus.md +0 -28
- package/docs/api/foundation-comms.socketstatus.onclose.md +0 -22
- package/docs/api/foundation-comms.socketstatus.serialize.md +0 -15
- package/docs/api/foundation-comms.streamcompleteevent.md +0 -14
- package/docs/api/foundation-comms.streamcompleteeventtype.md +0 -12
- package/docs/api/foundation-comms.streamevent.md +0 -14
- package/docs/api/foundation-comms.streameventdetail.md +0 -19
- package/docs/api/foundation-comms.streameventfunctions.md +0 -19
- package/docs/api/foundation-comms.streameventtype.md +0 -12
- package/docs/api/foundation-comms.systemhealthchanged.md +0 -13
- package/docs/api/foundation-comms.systemhealthchangedevent.md +0 -15
- package/docs/api/foundation-comms.systemhealthstatus.md +0 -29
- package/docs/api/foundation-comms.user.set.md +0 -22
- package/docs/api/foundation-comms.user.unset.md +0 -15
@@ -32,7 +32,6 @@ export interface Connect
|
|
32
32
|
| [getAvailableResources(params)](./foundation-comms.connect.getavailableresources.md) | Sends a request to the server to get available resources. |
|
33
33
|
| [getJSONSchema(resourceName)](./foundation-comms.connect.getjsonschema.md) | Retrieves the JSON schema for the specified resource. |
|
34
34
|
| [getMetadata(resourceName, useCache)](./foundation-comms.connect.getmetadata.md) | Retrieves the metadata for the specified resource. |
|
35
|
-
| [getMoreColumns(sourceRef)](./foundation-comms.connect.getmorecolumns.md) | Requests additional columns for the specified source reference. |
|
36
35
|
| [getMoreRows(sourceRef)](./foundation-comms.connect.getmorerows.md) | Requests additional rows of data for the specified source reference. |
|
37
36
|
| [request(resourceName, params)](./foundation-comms.connect.request.md) | Sends a request to the server to retrieve data or perform an action. |
|
38
37
|
| [snapshot(resourceName, params)](./foundation-comms.connect.snapshot.md) | Retrieves a snapshot of data for the specified resource. |
|
@@ -34,6 +34,4 @@ export declare class CurrentUser implements User
|
|
34
34
|
| [hasAdminProfile()](./foundation-comms.currentuser.hasadminprofile.md) | | |
|
35
35
|
| [hasPermission(permission)](./foundation-comms.currentuser.haspermission.md) | | |
|
36
36
|
| [hasProfile(profile)](./foundation-comms.currentuser.hasprofile.md) | | |
|
37
|
-
| [set(options)](./foundation-comms.currentuser.set.md) | | |
|
38
|
-
| [unset()](./foundation-comms.currentuser.unset.md) | | |
|
39
37
|
|
@@ -36,7 +36,6 @@ The public interface available on the injected store fragment.
|
|
36
36
|
| [dataHandler(data)?](./foundation-comms.datasource.datahandler.md) | _(Optional)_ Handles the specified data and returns it. |
|
37
37
|
| [deinit()](./foundation-comms.datasource.deinit.md) | Deinitializes the datasource. |
|
38
38
|
| [deleteItem(itemId)?](./foundation-comms.datasource.deleteitem.md) | _(Optional)_ Deletes an item with the given ID from the datasource. |
|
39
|
-
| [destroy()](./foundation-comms.datasource.destroy.md) | Destroy the datasource. |
|
40
39
|
| [dropView(view)?](./foundation-comms.datasource.dropview.md) | _(Optional)_ Removes the specified dataview from the datasource. |
|
41
40
|
| [getMetadata(resourceName)?](./foundation-comms.datasource.getmetadata.md) | _(Optional)_ Fetches metadata for the specified resource name. |
|
42
41
|
| [init(options, fetchMeta)](./foundation-comms.datasource.init.md) | Initializes the datasource with the given options and fetches metadata if specified. |
|
@@ -9,7 +9,7 @@ Constructs a new instance of the `DefaultConnect` class
|
|
9
9
|
**Signature:**
|
10
10
|
|
11
11
|
```typescript
|
12
|
-
constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache,
|
12
|
+
constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, config?: ConnectConfig);
|
13
13
|
```
|
14
14
|
|
15
15
|
## Parameters
|
@@ -19,6 +19,5 @@ constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache
|
|
19
19
|
| socket | [Socket](./foundation-comms.socket.md) | |
|
20
20
|
| messageBuilder | [MessageBuilder](./foundation-comms.messagebuilder.md) | |
|
21
21
|
| metaCache | [MetaCache](./foundation-comms.metacache.md) | |
|
22
|
-
| events | [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md) | |
|
23
22
|
| config | [ConnectConfig](./foundation-comms.connectconfig.md) | _(Optional)_ |
|
24
23
|
|
@@ -17,7 +17,7 @@ export declare class DefaultConnect implements Connect
|
|
17
17
|
|
18
18
|
| Constructor | Modifiers | Description |
|
19
19
|
| --- | --- | --- |
|
20
|
-
| [(constructor)(socket, messageBuilder, metaCache,
|
20
|
+
| [(constructor)(socket, messageBuilder, metaCache, config)](./foundation-comms.defaultconnect._constructor_.md) | | Constructs a new instance of the <code>DefaultConnect</code> class |
|
21
21
|
|
22
22
|
## Properties
|
23
23
|
|
@@ -40,7 +40,6 @@ export declare class DefaultConnect implements Connect
|
|
40
40
|
| [getAvailableResources(params)](./foundation-comms.defaultconnect.getavailableresources.md) | | |
|
41
41
|
| [getJSONSchema(resourceName, useCache)](./foundation-comms.defaultconnect.getjsonschema.md) | | |
|
42
42
|
| [getMetadata(resourceName, useCache)](./foundation-comms.defaultconnect.getmetadata.md) | | |
|
43
|
-
| [getMoreColumns(sourceRef)](./foundation-comms.defaultconnect.getmorecolumns.md) | | |
|
44
43
|
| [getMoreRows(sourceRef)](./foundation-comms.defaultconnect.getmorerows.md) | | |
|
45
44
|
| [httpMode()](./foundation-comms.defaultconnect.httpmode.md) | | |
|
46
45
|
| [request(resourceName, params)](./foundation-comms.defaultconnect.request.md) | | |
|
@@ -43,7 +43,6 @@ export declare class DefaultDatasource implements Datasource
|
|
43
43
|
| Method | Modifiers | Description |
|
44
44
|
| --- | --- | --- |
|
45
45
|
| [deinit()](./foundation-comms.defaultdatasource.deinit.md) | | |
|
46
|
-
| [destroy()](./foundation-comms.defaultdatasource.destroy.md) | | Destroy the datasource. |
|
47
46
|
| [init(options, fetchMeta)](./foundation-comms.defaultdatasource.init.md) | | |
|
48
47
|
| [snapshot()](./foundation-comms.defaultdatasource.snapshot.md) | | |
|
49
48
|
| [snapshotFiltered(rowId)](./foundation-comms.defaultdatasource.snapshotfiltered.md) | | |
|
@@ -41,7 +41,6 @@ export declare class DefaultHttpConnect implements Connect
|
|
41
41
|
| [getAvailableResources(params)](./foundation-comms.defaulthttpconnect.getavailableresources.md) | | |
|
42
42
|
| [getJSONSchema(resourceName)](./foundation-comms.defaulthttpconnect.getjsonschema.md) | | |
|
43
43
|
| [getMetadata(resourceName, useCache)](./foundation-comms.defaulthttpconnect.getmetadata.md) | | |
|
44
|
-
| [getMoreColumns(sourceRef)](./foundation-comms.defaulthttpconnect.getmorecolumns.md) | | |
|
45
44
|
| [getMoreRows(sourceRef)](./foundation-comms.defaulthttpconnect.getmorerows.md) | | |
|
46
45
|
| [httpMode()](./foundation-comms.defaulthttpconnect.httpmode.md) | | |
|
47
46
|
| [request(resourceName, params)](./foundation-comms.defaulthttpconnect.request.md) | | |
|
@@ -13,18 +13,13 @@
|
|
13
13
|
| [DatasourceDefaults](./foundation-comms.datasourcedefaults.md) | Default values for a DatasourceConfig |
|
14
14
|
| [DefaultAuth](./foundation-comms.defaultauth.md) | The default implementation for the Auth interface. |
|
15
15
|
| [DefaultConnect](./foundation-comms.defaultconnect.md) | The default implementation for the Connect interface (WS-only). |
|
16
|
-
| [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) | Default ConnectEvents implementation. |
|
17
16
|
| [DefaultCredentialManager](./foundation-comms.defaultcredentialmanager.md) | The default implementation for the CredentialManager interface. |
|
18
17
|
| [DefaultDatasource](./foundation-comms.defaultdatasource.md) | The default implementation for the Datasource interface. |
|
19
18
|
| [DefaultFoundationAnalytics](./foundation-comms.defaultfoundationanalytics.md) | The default implementation for the FoundationAnalytics interface. |
|
20
19
|
| [DefaultHttp](./foundation-comms.defaulthttp.md) | The default implementation of the Http interface. |
|
21
20
|
| [DefaultHttpConnect](./foundation-comms.defaulthttpconnect.md) | The default implementation for the Connect interface (HTTP-only). |
|
22
|
-
| [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) | Default MessageBuilder implementation. |
|
23
21
|
| [DefaultMetaCache](./foundation-comms.defaultmetacache.md) | The default implementation for the MetaCache interface. |
|
24
|
-
| [DefaultNetworkMonitor](./foundation-comms.defaultnetworkmonitor.md) | Default NetworkMonitor implementation. |
|
25
22
|
| [DefaultSession](./foundation-comms.defaultsession.md) | The default implementation for the Session interface. |
|
26
|
-
| [DefaultSocket](./foundation-comms.defaultsocket.md) | Default Socket implementation. |
|
27
|
-
| [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) | Default SocketStatus implementation. |
|
28
23
|
| [SocketMessageHandler](./foundation-comms.socketmessagehandler.md) | The Socket message handler definition. |
|
29
24
|
| [SocketObservable](./foundation-comms.socketobservable.md) | Observable that wraps a WebSocketSubject and provides an Observable interface for sending and receiving messages. |
|
30
25
|
| [SocketSubject](./foundation-comms.socketsubject.md) | Subject that wraps a WebSocketSubject and provides a Subject interface for sending and receiving messages. |
|
@@ -50,9 +45,6 @@
|
|
50
45
|
| [dataServerResultFilter(result, rowId)](./foundation-comms.dataserverresultfilter.md) | Data server result filter. |
|
51
46
|
| [getConnect()](./foundation-comms.getconnect.md) | Get Connect from the DI container. |
|
52
47
|
| [getDatasource()](./foundation-comms.getdatasource.md) | Get Datasource from the DI container. |
|
53
|
-
| [getNetworkMonitor()](./foundation-comms.getnetworkmonitor.md) | Gets NetworkMonitor from the DI container. |
|
54
|
-
| [getSocket()](./foundation-comms.getsocket.md) | Gets Socket from the DI container. |
|
55
|
-
| [getSocketStatus()](./foundation-comms.getsocketstatus.md) | Gets SocketStatus from the DI container. |
|
56
48
|
| [normaliseCriteria(criteria, delimiter)](./foundation-comms.normalisecriteria.md) | Normalise criteria. |
|
57
49
|
| [until(conditionFunc, timeoutMs)](./foundation-comms.until.md) | Polls a condition function until it returns true or a timeout is reached. |
|
58
50
|
|
@@ -63,8 +55,6 @@
|
|
63
55
|
| [Auth](./foundation-comms.auth.md) | Auth is the main interface for authenticating with a Genesis Server endpoint. |
|
64
56
|
| [Connect](./foundation-comms.connect.md) | Represents a connection and its capabilities on a remote server Provides methods to send and receive messages, as well as metadata and schema information. |
|
65
57
|
| [ConnectConfig](./foundation-comms.connectconfig.md) | Configuration options for the Connect (WS) instance. |
|
66
|
-
| [ConnectEvents](./foundation-comms.connectevents.md) | <code>ConnectEvents</code> provide hooks to respond to specific connect events. |
|
67
|
-
| [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md) | <code>ConnectEventsEmitter</code> provide event emitting hooks to Connect. |
|
68
58
|
| [CredentialManager](./foundation-comms.credentialmanager.md) | Represents a system for managing user credentials and authentication tokens. |
|
69
59
|
| [CredentialManagerConfig](./foundation-comms.credentialmanagerconfig.md) | The configuration for the CredentialManager |
|
70
60
|
| [CredentialManagerCookieConfig](./foundation-comms.credentialmanagercookieconfig.md) | The configuration options for the CredentialManager cookie |
|
@@ -86,16 +76,10 @@
|
|
86
76
|
| [LogoutResult](./foundation-comms.logoutresult.md) | Represents the result of a user logout operation. |
|
87
77
|
| [MessageBuilder](./foundation-comms.messagebuilder.md) | A utility class for building different types of messages. |
|
88
78
|
| [MetadataCache](./foundation-comms.metadatacache.md) | A Metadata cache definition |
|
89
|
-
| [MonitoredResourceChecksResult](./foundation-comms.monitoredresourcechecksresult.md) | MonitoredResourceChecksResult. |
|
90
|
-
| [MonitoredResourceMetadata](./foundation-comms.monitoredresourcemetadata.md) | MonitoredResourceMetadata. |
|
91
|
-
| [NetworkMonitor](./foundation-comms.networkmonitor.md) | <code>NetworkMonitor</code> monitors network and resource availability and health. |
|
92
|
-
| [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) | NetworkMonitorConfig DI interface. |
|
93
79
|
| [PollingConfiguration](./foundation-comms.pollingconfiguration.md) | Configuration options for http polling. |
|
94
|
-
| [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) | <code>SerializedSocketStatus</code> provides the serialize state of the web socket. |
|
95
80
|
| [Serializer](./foundation-comms.serializer.md) | A Serializer interface for serializing and deserializing objects. |
|
96
81
|
| [Session](./foundation-comms.session.md) | Represents a session storage and its capabilities. Provides methods to set and get items from the specified storage. |
|
97
82
|
| [Socket](./foundation-comms.socket.md) | Represents a WebSocket used to establish a communication channel between client and a Genesis server. Provides methods for socket connection, sending and receiving WS messages. |
|
98
|
-
| [SocketStatus](./foundation-comms.socketstatus.md) | <code>SocketStatus</code> provides the state of the web socket. |
|
99
83
|
| [User](./foundation-comms.user.md) | Represents a User object with associated permissions and profiles. |
|
100
84
|
|
101
85
|
## Namespaces
|
@@ -109,28 +93,20 @@
|
|
109
93
|
|
110
94
|
| Variable | Description |
|
111
95
|
| --- | --- |
|
112
|
-
| [CommitEventType](./foundation-comms.commiteventtype.md) | |
|
113
96
|
| [credentialSeparator](./foundation-comms.credentialseparator.md) | The default separator used for splitting credential parts. |
|
114
97
|
| [defaultConnectConfig](./foundation-comms.defaultconnectconfig.md) | The default configuration for connecting to a WS service. |
|
115
98
|
| [defaultCredentialManagerConfig](./foundation-comms.defaultcredentialmanagerconfig.md) | The default configuration for the CredentialManager service. |
|
116
99
|
| [defaultCredentialRequestOptions](./foundation-comms.defaultcredentialrequestoptions.md) | The default request options for the CredentialManager service. |
|
117
100
|
| [defaultDatasourceConfig](./foundation-comms.defaultdatasourceconfig.md) | The default configuration for the Datasource service. |
|
118
101
|
| [defaultHttpConnectConfig](./foundation-comms.defaulthttpconnectconfig.md) | The default configuration for connecting to an HTTP service. |
|
119
|
-
| [defaultNetworkMonitorConfig](./foundation-comms.defaultnetworkmonitorconfig.md) | Default NetworkMonitorConfig DI implementation. |
|
120
102
|
| [exponentialScheduler](./foundation-comms.exponentialscheduler.md) | Expontential Interval scheduler for reconnect |
|
121
103
|
| [extractFieldDefinitions](./foundation-comms.extractfielddefinitions.md) | Extracts the field definitions from the metadata. |
|
122
104
|
| [isWebSocketExpression](./foundation-comms.iswebsocketexpression.md) | Regular Expression to test valid WebSocket (wss and ws) hosts |
|
123
105
|
| [linearScheduler](./foundation-comms.linearscheduler.md) | Linear Interval scheduler for reconnect |
|
124
106
|
| [logger](./foundation-comms.logger.md) | Logger for the foundation-comms package |
|
125
107
|
| [MAX\_RECONNECT\_ATTEMPTS](./foundation-comms.max_reconnect_attempts.md) | Default number of reconnect attempts |
|
126
|
-
| [messageHasErrorCode](./foundation-comms.messagehaserrorcode.md) | Check if the message contains an error code. |
|
127
108
|
| [messageOrThrow](./foundation-comms.messageorthrow.md) | Check if the provided message contains an error and throw an Error if it does |
|
128
|
-
| [MetadataEventType](./foundation-comms.metadataeventtype.md) | |
|
129
|
-
| [networkLogger](./foundation-comms.networklogger.md) | |
|
130
109
|
| [retryInterval](./foundation-comms.retryinterval.md) | Generate reconnect interval based on scheduler |
|
131
|
-
| [StreamCompleteEventType](./foundation-comms.streamcompleteeventtype.md) | |
|
132
|
-
| [StreamEventType](./foundation-comms.streameventtype.md) | |
|
133
|
-
| [SystemHealthChanged](./foundation-comms.systemhealthchanged.md) | SystemHealthChanged. |
|
134
110
|
| [toFieldMetadata](./foundation-comms.tofieldmetadata.md) | Converts the field definitions to field metadata. |
|
135
111
|
| [TYPES\_MAP](./foundation-comms.types_map.md) | Types map for FieldTypeEnum. |
|
136
112
|
|
@@ -141,8 +117,6 @@
|
|
141
117
|
| [AuthInfo](./foundation-comms.authinfo.md) | Union type of all authentication information types. |
|
142
118
|
| [BasicAuthInfo](./foundation-comms.basicauthinfo.md) | Represents basic authentication information. |
|
143
119
|
| [BasicCredentialsInput](./foundation-comms.basiccredentialsinput.md) | Represents basic credentials for a user. |
|
144
|
-
| [CommitEvent](./foundation-comms.commitevent.md) | |
|
145
|
-
| [CommitEventDetail](./foundation-comms.commiteventdetail.md) | |
|
146
120
|
| [CommitParams](./foundation-comms.commitparams.md) | Parameters for a COMMIT message |
|
147
121
|
| [ConnectionStatus](./foundation-comms.connectionstatus.md) | The connection status of the Genesis client. |
|
148
122
|
| [CredentialData\_2](./foundation-comms.credentialdata_2.md) | Represents user credentials. |
|
@@ -150,7 +124,6 @@
|
|
150
124
|
| [FDC3Intents](./foundation-comms.fdc3intents.md) | |
|
151
125
|
| [FieldMetadata](./foundation-comms.fieldmetadata.md) | Field Metadata definition. |
|
152
126
|
| [FilteredDataServerResult](./foundation-comms.filtereddataserverresult.md) | Fitlered result after initial DATASERVER data fetch. |
|
153
|
-
| [GenesisConnectEvents](./foundation-comms.genesisconnectevents.md) | Genesis connect events that can be monitored to invoke resource checking. |
|
154
127
|
| [GetCredentialOptions](./foundation-comms.getcredentialoptions.md) | Represents options for retrieving credentials. |
|
155
128
|
| [IndexDetail](./foundation-comms.indexdetail.md) | Index Detail definition. |
|
156
129
|
| [JwtAuthInfo](./foundation-comms.jwtauthinfo.md) | Represents JWT authentication information. |
|
@@ -160,17 +133,11 @@
|
|
160
133
|
| [MetaCache](./foundation-comms.metacache.md) | Union type of MetadataCache and JsonSchemaCache |
|
161
134
|
| [Metadata](./foundation-comms.metadata.md) | Metadata definition for a given resource. |
|
162
135
|
| [MetadataDetail](./foundation-comms.metadatadetail.md) | Metadata Detail definition. |
|
163
|
-
| [MetadataEvent](./foundation-comms.metadataevent.md) | |
|
164
|
-
| [MetadataEventDetail](./foundation-comms.metadataeventdetail.md) | |
|
165
|
-
| [MonitoredResource](./foundation-comms.monitoredresource.md) | MonitoredResource. |
|
166
|
-
| [MonitoredResourceChecks](./foundation-comms.monitoredresourcechecks.md) | MonitoredResourceChecks. |
|
167
|
-
| [MonitoredResourceDataLogon](./foundation-comms.monitoredresourcedatalogon.md) | MonitoredResourceDataLogon. |
|
168
136
|
| [RawDataServerResult](./foundation-comms.rawdataserverresult.md) | Raw result from a DATASERVER data fetch. |
|
169
137
|
| [RefreshAuthInfo](./foundation-comms.refreshauthinfo.md) | Represents refresh token authentication information. |
|
170
138
|
| [RefreshCredentialsInput](./foundation-comms.refreshcredentialsinput.md) | Represents refresh credentials for a user. |
|
171
139
|
| [RequestParams](./foundation-comms.requestparams.md) | Parameters for a REQUEST message |
|
172
140
|
| [RequestServerResult](./foundation-comms.requestserverresult.md) | Raw result from a REQUEST\_SERVER data fetch. |
|
173
|
-
| [ResourceHealth](./foundation-comms.resourcehealth.md) | ResourceHealth. |
|
174
141
|
| [RowData](./foundation-comms.rowdata.md) | Row Data definition. |
|
175
142
|
| [SchemaResponse](./foundation-comms.schemaresponse.md) | Schema Response definition. |
|
176
143
|
| [ServerRow](./foundation-comms.serverrow.md) | Server Row definition. |
|
@@ -180,10 +147,4 @@
|
|
180
147
|
| [SsoAuthInfo](./foundation-comms.ssoauthinfo.md) | Represents SSO authentication information. |
|
181
148
|
| [SSOCredentialsInput](./foundation-comms.ssocredentialsinput.md) | Represents SSO credentials for a user. |
|
182
149
|
| [StorageType](./foundation-comms.storagetype.md) | The available browser storage types. |
|
183
|
-
| [StreamCompleteEvent](./foundation-comms.streamcompleteevent.md) | |
|
184
|
-
| [StreamEvent](./foundation-comms.streamevent.md) | |
|
185
|
-
| [StreamEventDetail](./foundation-comms.streameventdetail.md) | |
|
186
|
-
| [StreamEventFunctions](./foundation-comms.streameventfunctions.md) | |
|
187
|
-
| [SystemHealthChangedEvent](./foundation-comms.systemhealthchangedevent.md) | SystemHealthChangedEvent. |
|
188
|
-
| [SystemHealthStatus](./foundation-comms.systemhealthstatus.md) | SystemHealthStatus. |
|
189
150
|
|
@@ -26,7 +26,6 @@ export interface MessageBuilder
|
|
26
26
|
| [createLoginMessage(credentials)](./foundation-comms.messagebuilder.createloginmessage.md) | Creates a login message. |
|
27
27
|
| [createLogoutMessage(loginResult)](./foundation-comms.messagebuilder.createlogoutmessage.md) | Creates a logout message. |
|
28
28
|
| [createMetaRequestMessage(resourceName, messageType)](./foundation-comms.messagebuilder.createmetarequestmessage.md) | Creates a metadata fetch message. |
|
29
|
-
| [createMoreColumnsMessage(sourceRef)](./foundation-comms.messagebuilder.createmorecolumnsmessage.md) | Creates a message to request more columns. |
|
30
29
|
| [createMoreRowsMessage(sourceRef)](./foundation-comms.messagebuilder.createmorerowsmessage.md) | Creates a message to request more rows. |
|
31
30
|
| [createRefreshTokenMessage()](./foundation-comms.messagebuilder.createrefreshtokenmessage.md) | Creates an auth message specific for token refresh. |
|
32
31
|
| [createRequestMessage(resourceName, params)](./foundation-comms.messagebuilder.createrequestmessage.md) | Creates a request message. |
|
@@ -24,8 +24,6 @@ export declare enum MessageType
|
|
24
24
|
| LOGON\_NACK | <code>"LOGON_NACK"</code> | |
|
25
25
|
| LOGOUT\_ACK | <code>"LOGOUT_ACK"</code> | |
|
26
26
|
| LOGOUT\_NACK | <code>"LOGOUT_NACK"</code> | |
|
27
|
-
| MORE\_COLUMNS | <code>"MORE_COLUMNS"</code> | |
|
28
|
-
| MORE\_COLUMNS\_ACK | <code>"MORE_COLUMNS_ACK"</code> | |
|
29
27
|
| MORE\_ROWS | <code>"MORE_ROWS"</code> | |
|
30
28
|
| MSG\_ACK | <code>"MSG_ACK"</code> | |
|
31
29
|
| MSG\_NACK | <code>"MSG_NACK"</code> | |
|
@@ -0,0 +1,11 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [Socket](./foundation-comms.socket.md) > [hasValidSession](./foundation-comms.socket.hasvalidsession.md)
|
4
|
+
|
5
|
+
## Socket.hasValidSession property
|
6
|
+
|
7
|
+
**Signature:**
|
8
|
+
|
9
|
+
```typescript
|
10
|
+
hasValidSession: boolean;
|
11
|
+
```
|
@@ -0,0 +1,11 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [Socket](./foundation-comms.socket.md) > [isConnected](./foundation-comms.socket.isconnected.md)
|
4
|
+
|
5
|
+
## Socket.isConnected property
|
6
|
+
|
7
|
+
**Signature:**
|
8
|
+
|
9
|
+
```typescript
|
10
|
+
isConnected: boolean;
|
11
|
+
```
|
@@ -1,8 +1,8 @@
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
2
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [Socket](./foundation-comms.socket.md) > [isConnectedSubject](./foundation-comms.socket.isconnectedsubject.md)
|
4
4
|
|
5
|
-
##
|
5
|
+
## Socket.isConnectedSubject property
|
6
6
|
|
7
7
|
**Signature:**
|
8
8
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [Socket](./foundation-comms.socket.md) > [isReconnecting](./foundation-comms.socket.isreconnecting.md)
|
4
|
+
|
5
|
+
## Socket.isReconnecting property
|
6
|
+
|
7
|
+
**Signature:**
|
8
|
+
|
9
|
+
```typescript
|
10
|
+
isReconnecting: boolean;
|
11
|
+
```
|
@@ -9,9 +9,17 @@ Represents a WebSocket used to establish a communication channel between client
|
|
9
9
|
**Signature:**
|
10
10
|
|
11
11
|
```typescript
|
12
|
-
export interface Socket
|
12
|
+
export interface Socket
|
13
13
|
```
|
14
|
-
|
14
|
+
|
15
|
+
## Properties
|
16
|
+
|
17
|
+
| Property | Modifiers | Type | Description |
|
18
|
+
| --- | --- | --- | --- |
|
19
|
+
| [hasValidSession](./foundation-comms.socket.hasvalidsession.md) | | boolean | |
|
20
|
+
| [isConnected](./foundation-comms.socket.isconnected.md) | | boolean | |
|
21
|
+
| [isConnectedSubject](./foundation-comms.socket.isconnectedsubject.md) | | BehaviorSubject<boolean> | |
|
22
|
+
| [isReconnecting](./foundation-comms.socket.isreconnecting.md) | | boolean | |
|
15
23
|
|
16
24
|
## Methods
|
17
25
|
|
@@ -20,6 +28,6 @@ export interface Socket extends Omit<SocketStatus, 'serialize' | 'onClose' | 're
|
|
20
28
|
| [connect(host, options, reconnectOptions)](./foundation-comms.socket.connect.md) | |
|
21
29
|
| [reset()](./foundation-comms.socket.reset.md) | Disconnects the socket and clears all subscriptions |
|
22
30
|
| [send(message, needsHandling)](./foundation-comms.socket.send.md) | |
|
23
|
-
| [sendForStream(message, onMessage, onError
|
31
|
+
| [sendForStream(message, onMessage, onError)](./foundation-comms.socket.sendforstream.md) | |
|
24
32
|
| [socketMessages()](./foundation-comms.socket.socketmessages.md) | |
|
25
33
|
|
@@ -7,7 +7,7 @@
|
|
7
7
|
**Signature:**
|
8
8
|
|
9
9
|
```typescript
|
10
|
-
sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Function
|
10
|
+
sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Function): Observable<Message>;
|
11
11
|
```
|
12
12
|
|
13
13
|
## Parameters
|
@@ -17,7 +17,6 @@ sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Functi
|
|
17
17
|
| message | [Message](./foundation-comms.message.md)<!-- --><T \| any> | |
|
18
18
|
| onMessage | Function | |
|
19
19
|
| onError | Function | |
|
20
|
-
| onComplete | Function | _(Optional)_ |
|
21
20
|
|
22
21
|
**Returns:**
|
23
22
|
|
@@ -20,6 +20,4 @@ export interface User extends UserOptions
|
|
20
20
|
| [hasAdminProfile()](./foundation-comms.user.hasadminprofile.md) | |
|
21
21
|
| [hasPermission(permission)](./foundation-comms.user.haspermission.md) | |
|
22
22
|
| [hasProfile(profile)](./foundation-comms.user.hasprofile.md) | |
|
23
|
-
| [set(options)](./foundation-comms.user.set.md) | |
|
24
|
-
| [unset()](./foundation-comms.user.unset.md) | |
|
25
23
|
|