foundation-comms
Home > @genesislcap/foundation-comms
foundation-comms package
Classes
Class |
Description |
---|---|
Represents an error that occurs during authentication. | |
Represents the current user (i.e. the user that is currently logged in). | |
Default values for a DatasourceConfig | |
The default implementation for the Auth interface. | |
The default implementation for the Connect interface (WS-only). | |
Default ConnectEvents implementation. | |
The default implementation for the CredentialManager interface. | |
The default implementation for the Datasource interface. | |
(ALPHA) Default EntityDatasource DI implementation. | |
The default implementation for the FoundationAnalytics interface. | |
Default GenesisResources implementation. | |
The default implementation of the Http interface. | |
The default implementation for the Connect interface (HTTP-only). | |
(ALPHA) The default implementation for the KVStorage interface. | |
Default MessageBuilder implementation. | |
The default implementation for the MetaCache interface. | |
Default NetworkMonitor implementation. | |
The default implementation for the Session interface. | |
Default Socket implementation. | |
Default SocketStatus implementation. | |
The Socket message handler definition. | |
Observable that wraps a WebSocketSubject and provides an Observable interface for sending and receiving messages. | |
Subject that wraps a WebSocketSubject and provides a Subject interface for sending and receiving messages. |
Enumerations
Enumeration |
Description |
---|---|
The available ypes of authentication. | |
Event Message types | |
Available types for a field metadata. | |
Analytics event types | |
(ALPHA) KV Event Message types | |
(ALPHA) KV Message types | |
General Message codes | |
General Message types | |
Types of Genesis resources. | |
Socket reconnection strategies |
Functions
Function |
Description |
---|---|
Criteria filters to fields. | |
Data server result filter. | |
Datasource event handler mixin for target classes that use or are interested in datasource status changes. | |
Extracts the field definitions from the metadata. | |
Get Connect from the DI container. | |
Get Datasource from the DI container. | |
Gets GenesisResources from the DI container. | |
Gets GenesisResourcesChannel from the DI container. | |
Gets KVStorage from the DI container. | |
Gets NetworkMonitor from the DI container. | |
Gets Socket from the DI container. | |
Gets SocketStatus from the DI container. | |
Check if the message contains an error code. | |
Check if the provided message contains an error and throw an Error if it does | |
Normalise criteria. | |
Generate reconnect interval based on scheduler | |
Converts the field definitions to field metadata. | |
Polls a condition function until it returns true or a timeout is reached. |
Interfaces
Interface |
Description |
---|---|
Auth is the main interface for authenticating with a Genesis Server endpoint. | |
Represents a connection and its capabilities on a remote server Provides methods to send and receive messages, as well as metadata and schema information. | |
Configuration options for the Connect (WS) instance. | |
| |
| |
Represents a system for managing user credentials and authentication tokens. | |
The configuration for the CredentialManager | |
The configuration options for the CredentialManager cookie | |
Datasource interface. | |
DatasourceConfig DI interface. | |
DatasourceMetadata interface. | |
Options that can be passed when initializing a datasource. | |
Data Update definition with details of what data to add, drop, and/or modify. | |
Dataview object | |
(ALPHA) EntityDatasource DI interface. | |
(ALPHA) EntityDatasourceInit interface. | |
Represents an analytics tracking system. | |
GenesisResources DI interface. | |
GenesisResourcesChannel DI interface. | |
GenesisResourcesConfig DI interface. | |
An interface representing an HTTP client that can make GET and POST requests and return a promise with the response data. | |
The options object used when making an HTTP request. | |
A JSON schema cache definition | |
(ALPHA) KeyValue interface. | |
(ALPHA) KeyValueTransfer interface. | |
(ALPHA) Represents a KV (key-value) data storage and its capabilities. Provides methods to set and get items from the KV data storage. | |
(ALPHA) KVStorageConfig DI interface. | |
Represents the result of a user logout operation. | |
A utility class for building different types of messages. | |
A Metadata cache definition | |
MonitoredResourceChecksResult. | |
MonitoredResourceMetadata. | |
| |
NetworkMonitorConfig DI interface. | |
| |
A Serializer interface for serializing and deserializing objects. | |
Represents a session storage and its capabilities. Provides methods to set and get items from the specified storage. | |
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. | |
| |
Represents a User object with associated permissions and profiles. |
Namespaces
Namespace |
Description |
---|---|
Namespace for all Analytics event types | |
Namespace for all Message detail types |
Variables
Variable |
Description |
---|---|
The default separator used for splitting credential parts. | |
DatasourceStatusChanged. | |
The default configuration for connecting to a WS service. | |
The default configuration for the CredentialManager service. | |
The default request options for the CredentialManager service. | |
Default DatasourceConfig DI implementation. | |
Default GenesisResourcesConfig implementation. | |
(ALPHA) The default configuration for the KVStorage service. | |
Default NetworkMonitorConfig DI implementation. | |
Expontential Interval scheduler for reconnect | |
Regular Expression to test valid WebSocket (wss and ws) hosts | |
Linear Interval scheduler for reconnect | |
Logger for the foundation-comms package | |
Default number of reconnect attempts | |
SystemHealthChanged. | |
Types map for FieldTypeEnum. |
Type Aliases
Type Alias |
Description |
---|---|
Union type of all authentication information types. | |
Represents basic authentication information. | |
Represents basic credentials for a user. | |
Parameters for a COMMIT message | |
The connection status of the Genesis client. | |
Represents user credentials. | |
Parameters for a DATA_LOGON messages | |
DatasourceStatus. | |
DatasourceStatusChangedEvent. | |
Field Metadata definition. | |
Fitlered result after initial DATASERVER data fetch. | |
Genesis connect events that can be monitored to invoke resource checking. | |
Represents options for retrieving credentials. | |
Index Detail definition. | |
Represents JWT authentication information. | |
(ALPHA) KVStorage type. | |
(ALPHA) KVValue type. | |
Represents the result of a user login operation. | |
Base Message type for all DETAIL variants | |
Error definition for a message result | |
Union type of MetadataCache and JsonSchemaCache | |
Metadata definition for a given resource. | |
Metadata Detail definition. | |
MonitoredResource. | |
MonitoredResourceChecks. | |
MonitoredResourceDataLogon. | |
Raw result from a DATASERVER data fetch. | |
Represents refresh token authentication information. | |
Represents refresh credentials for a user. | |
Reply Detail definition. | |
Parameters for a REQ_ messages | |
Raw result from a REQUEST_SERVER data fetch. | |
ResourceHealth. | |
Row Data definition. | |
Schema Response definition. | |
Server Row definition. | |
The Socket connection options definition. | |
Socket reconnection options | |
Socket reconnection scheduler | |
Represents SSO authentication information. | |
Represents SSO credentials for a user. | |
The available browser storage types. | |
SystemHealthChangedEvent. | |
SystemHealthStatus. |