foundation-comms

Home > @genesislcap/foundation-comms

foundation-comms package

Classes

Class	Description
AuthError	Represents an error that occurs during authentication.
CurrentUser	Represents the current user (i.e. the user that is currently logged in).
DatasourceDefaults	Default values for a DatasourceConfig
DefaultAuth	The default implementation for the Auth interface.
DefaultConnect	The default implementation for the Connect interface (WS-only).
DefaultCredentialManager	The default implementation for the CredentialManager interface.
DefaultDatasource	The default implementation for the Datasource interface.
DefaultFoundationAnalytics	The default implementation for the FoundationAnalytics interface.
DefaultHttp	The default implementation of the Http interface.
DefaultHttpConnect	The default implementation for the Connect interface (HTTP-only).
DefaultMetaCache	The default implementation for the MetaCache interface.
DefaultSession	The default implementation for the Session interface.
SocketMessageHandler	The Socket message handler definition.
SocketObservable	Observable that wraps a WebSocketSubject and provides an Observable interface for sending and receiving messages.
SocketSubject	Subject that wraps a WebSocketSubject and provides a Subject interface for sending and receiving messages.

Enumerations

Enumeration	Description
AuthType	The available ypes of authentication.
EventMessageType	Event Message types
FieldTypeEnum	Available types for a field metadata.
FoundationAnalyticsEventType	Analytics event types
MessageCode	General Message codes
MessageType	General Message types
ResourceType	Types of Genesis resources.
SocketReconnectStrategy	Socket reconnection strategies

Functions

Function	Description
criteriaFiltersToFields(filters)	Criteria filters to fields.
dataServerResultFilter(result, rowId)	Data server result filter.
getConnect()	Get Connect from the DI container.
getDatasource()	Get Datasource from the DI container.
normaliseCriteria(criteria, delimiter)	Normalise criteria.
until(conditionFunc, timeoutMs)	Polls a condition function until it returns true or a timeout is reached.

Interfaces

Interface	Description
Auth	Auth is the main interface for authenticating with a Genesis Server endpoint.
Connect	Represents a connection and its capabilities on a remote server Provides methods to send and receive messages, as well as metadata and schema information.
ConnectConfig	Configuration options for the Connect (WS) instance.
CredentialManager	Represents a system for managing user credentials and authentication tokens.
CredentialManagerConfig	The configuration for the CredentialManager
CredentialManagerCookieConfig	The configuration options for the CredentialManager cookie
Datasource	Datasource interface.
DatasourceConfig	The configuration object for a Datasource
DatasourceOptions	Options that can be passed when initializing a datasource.
DataUpdate	Data Update definition with details of what data to add, drop, and/or modify.
Dataview	Dataview object
FDC3AppIntent
FDC3Channel
FDC3Context
FDC3IntentResolution
FoundationAnalytics	Represents an analytics tracking system.
Http	An interface representing an HTTP client that can make GET and POST requests and return a promise with the response data.
HttpConnectConfig	Configuration options for the Connect (HTTP) instance.
HttpPollingConfig	Configuration options for http connection.
HttpRequestInit	The options object used when making an HTTP request.
JsonSchemaCache	A JSON schema cache definition
LogoutResult	Represents the result of a user logout operation.
MessageBuilder	A utility class for building different types of messages.
MetadataCache	A Metadata cache definition
PollingConfiguration	Configuration options for http polling.
Serializer	A Serializer interface for serializing and deserializing objects.
Session	Represents a session storage and its capabilities. Provides methods to set and get items from the specified storage.
Socket	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.
User	Represents a User object with associated permissions and profiles.

Namespaces

Namespace	Description
FoundationAnalyticsEvent	Namespace for all Analytics event types
MessageDetails	Namespace for all Message detail types

Variables

Variable	Description
credentialSeparator	The default separator used for splitting credential parts.
defaultConnectConfig	The default configuration for connecting to a WS service.
defaultCredentialManagerConfig	The default configuration for the CredentialManager service.
defaultCredentialRequestOptions	The default request options for the CredentialManager service.
defaultDatasourceConfig	The default configuration for the Datasource service.
defaultHttpConnectConfig	The default configuration for connecting to an HTTP service.
exponentialScheduler	Expontential Interval scheduler for reconnect
extractFieldDefinitions	Extracts the field definitions from the metadata.
isWebSocketExpression	Regular Expression to test valid WebSocket (wss and ws) hosts
linearScheduler	Linear Interval scheduler for reconnect
logger	Logger for the foundation-comms package
MAX_RECONNECT_ATTEMPTS	Default number of reconnect attempts
messageOrThrow	Check if the provided message contains an error and throw an Error if it does
retryInterval	Generate reconnect interval based on scheduler
toFieldMetadata	Converts the field definitions to field metadata.
TYPES_MAP	Types map for FieldTypeEnum.

Type Aliases

Type Alias	Description
AuthInfo	Union type of all authentication information types.
BasicAuthInfo	Represents basic authentication information.
BasicCredentialsInput	Represents basic credentials for a user.
CommitParams	Parameters for a COMMIT message
ConnectionStatus	The connection status of the Genesis client.
CredentialData_2	Represents user credentials.
FDC3ContextHandler
FDC3Intents
FieldMetadata	Field Metadata definition.
FilteredDataServerResult	Fitlered result after initial DATASERVER data fetch.
GetCredentialOptions	Represents options for retrieving credentials.
IndexDetail	Index Detail definition.
JwtAuthInfo	Represents JWT authentication information.
LoginResult	Represents the result of a user login operation.
Message	Base Message type for all DETAIL variants
MessageError	Error definition for a message result
MetaCache	Union type of MetadataCache and JsonSchemaCache
Metadata	Metadata definition for a given resource.
MetadataDetail	Metadata Detail definition.
RawDataServerResult	Raw result from a DATASERVER data fetch.
RefreshAuthInfo	Represents refresh token authentication information.
RefreshCredentialsInput	Represents refresh credentials for a user.
RequestParams	Parameters for a REQUEST message
RequestServerResult	Raw result from a REQUEST_SERVER data fetch.
RowData	Row Data definition.
SchemaResponse	Schema Response definition.
ServerRow	Server Row definition.
SocketConnectOptions	The Socket connection options definition.
SocketReconnectOptions	Socket reconnection options
SocketReconnectScheduler	Socket reconnection scheduler
SsoAuthInfo	Represents SSO authentication information.
SSOCredentialsInput	Represents SSO credentials for a user.
StorageType	The available browser storage types.