@dhealthdapps/backend

This type is used to interface entities of the accounts collection with mongoose and permits to instanciate objects representing these entities.

e.g. alongside AccountSchema, we also define AccountDocument which is a mixin that comprises of Account and this Documentable class.

In class Queryable, the first generic accepted permits to use documents that are typed with this, to filter results in a documents query.

v0.3.0

This type is used to interface entities of the account_integrations collection with mongoose and permits to instanciate objects representing these entities.

e.g. alongside AccountIntegrationSchema, we also define AccountIntegrationDocument which is a mixin that comprises of AccountIntegration and this Documentable class.

In class Queryable, the first generic accepted permits to use documents that are typed with this, to filter results in a documents query.

v0.3.0

This type is used to interface entities of the account-sessions collection with mongoose and permits to instanciate objects representing these entities.

e.g. alongside AccountSessionSchema, we also define AccountDocument which is a mixin that comprises of AccountSession and this Documentable class.

In class Queryable, the first generic accepted permits to use documents that are typed with this, to filter results in a documents query.

v0.3.2

This type is used to interface entities of the activitydata collection with mongoose and permits to instanciate objects representing these entities.

e.g. alongside ActivityDataSchema, we also define ActivityDataDocument which is a mixin that comprises of ActivityData and this Documentable class.

In class Queryable, the first generic accepted permits to use documents that are typed with this, to filter results in a documents query.

v0.3.0

This type is used to interface entities of the activities collection with mongoose and permits to an instance and objects representing these entities.

e.g. alongside ActivitySchema, we also define ActivityDocument which is a mixin that comprises of Activity and this Documentable class.

In class Queryable, the first generic accepted permits to use documents that are typed with this, to filter results in a documents query.

v0.3.0

COMMON

This type consists of an URL, a host, a port and a flag to enable/disable HTTPS. This type is used to establish a connection to the frontend or the backend apps from the outside of the hosting network ("public internet").

Using the AppConnectionPayload type to configure apps

const myFrontend = {
  url: "http://elevate.dhealth.cloud:8080",
  host: "elevate.dhealth.cloud",
  port: 8080,
  https: false
} as AppConnectionPayload;

DappConfig

v0.3.0

This type is used to interface entities of the operations collection with mongoose and permits to instanciate objects representing these entities.

e.g. alongside AssetSchema, we also define AssetDocument which is a mixin that comprises of Asset and this Documentable class.

In class Queryable, the first generic accepted permits to use documents that are typed with this, to filter results in a documents query.

v0.3.0

COMMON

This interface consists of a set of configuration fields that must be provided to configure a custom asset.

Note that newly implemented assets must be added to this type such that they are correctly understood and configured for the backend runtime endpoints.

AssetsConfig

v0.3.0

This type is used to interface entities of the authChallenges collection with mongoose and permits to create objects representing these entities.

e.g. alongside AuthChallengeSchema, we also define AuthChallengeDocument which is a mixin that comprises of AuthChallenge and this Documentable class.

In class Queryable, the first generic accepted permits to use documents that are typed with this, to filter results in a documents query.

v0.3.0

COMMON

This type consists of a list of dHealth Account Addresses or Public Keys that are used for authentication purposes (registry), as well as an authentication secret which is used for signing access tokens.

Using the AuthParameters type to configure authentication

{
  registries: ["NBLT42KCICXZE2Q7Q4SWW3GWWE3XWPH3KUBBOEY"],
  secret: "ThisIsASecretThatYouShouldNotUseAndThatShouldNotLeak",
  challengeSize: 8,
}

SecurityConfig

v0.3.0

This type is used to interface entities of the operations collection with mongoose and permits to instanciate objects representing these entities.

e.g. alongside BlockSchema, we also define BlockDocument which is a mixin that comprises of Block and this Documentable class.

In class Queryable, the first generic accepted permits to use documents that are typed with this, to filter results in a documents query.

v0.3.2

COMMON

A discoverable asset configuration object. This configuration field consists of a key as listed in BoosterGroup and a configuration object as defined by DiscoverableAssetsMap.

AssetsConfig

v0.3.0

COMMON

This interface consists of a set of configuration fields that must be provided to configure a booster asset.

Note that newly implemented boosters must be added to this type such that they are correctly understood and configured for the backend runtime endpoints.

AssetsConfig

v0.3.0

BroadcastActivityPayoutsCommandOptions

This interface defines arguments that can be passed to this processor command that is implemented in the backend runtime.

Note that it is important that child classes extend this interface with their own specification of arguments.

Additional note relating to this implementation is that the payout preparation command does not need any other command options.

PayoutCommandOptions

v0.4.0

BroadcastBoosterPayoutsCommandOptions

This interface defines arguments that can be passed to this processor command that is implemented in the backend runtime.

Note that it is important that child classes extend this interface with their own specification of arguments.

Additional note relating to this implementation is that the payout preparation command does not need any other command options.

PayoutCommandOptions

v0.4.0

COMMON

This type consists of the security configuration related to the backend runtime API. It sets the valid origins to enable/disable CORS and permits to stop accepting requests from unknown locations ("origins").

Using the CrossOriginParameters type with a wildcard origin

{ origin: "*" }

Using the CrossOriginParameters type with a list of origins

// this allows both localhost and example.com
{ origin: ["http://localhost", "http://example.com"] }

Using the CrossOriginParameters type to disable CORS

// Setting `origin: false` disables CORS
{ origin: false }

// Setting `origin: true` is the equivalent of a wilcard
{ origin: true }

SecurityConfig

v0.3.0

COMMON

This type consists of an URL anda publicKey that are used to establish the connection and query info of the default node.

Using the DefaultNodePayload type to configure nodes

 // by default the URL can contain the schema and port
 const defaultNode = {
   url: "http://dual-02.dhealth.cloud:3000",
   publicKey: "613010BCE1FBF3CE1503DEF3003C76E451EA4DD9205FAD3530BFF7B1D78BC989"
 } as DefaultNodePayload;

NetworkConfig

v0.3.0

COMMON

A discoverable asset configuration object. This configuration field consists of a key as listed in AssetType and a parameters object as defined by AssetParameters.

AssetsConfig

v0.3.0

The HTTP method name, e.g. "GET". This type is used to execute to HTTP requests using the axios dependency.

v0.3.0

COMMON

This type consists of 3 ScoreSchedulerConfig objects:

• daily_score: the score config values for daily statistics aggregation.
• weekly_score: the score config values for weekly statistics aggregation.
• monthly_score: the score config values for monthly statistics aggregation.

StatisticsConfig

v0.3.2

This type is used to interface entities of the system-logs collection with mongoose and permits to instanciate objects representing these entities.

e.g. alongside LogSchema, we also define LogDocument which is a mixin that comprises of Log and this Documentable class.

In class Queryable, the first generic accepted permits to use documents that are typed with this, to filter results in a documents query.

v0.3.2

A type that represents a mongo query operations using the $dec-operator that updates document field values by decrementing it as defined in the specification object. This type is used whenever a $dec operation shall be executed to decrement field values.

v0.3.2

A type that represents a mongo query operations using the $eq-operator that matches documents based of a field value.This type is used whenever a $eq operation shall be executed for filters additionally to query conditions.

v0.3.2

A type that represents a mongo query operations using the $eq-operator that matches documents based of a field value.This type is used whenever a $eq operation shall be executed for filters additionally to query conditions.

v0.3.2

A type that represents a mongo query operations using the $gt-operator that matches documents based of a field value.This type is used whenever a $gt operation shall be executed for filters additionally to query conditions.

v0.4.0

A type that represents a mongo query operations using the $gte-operator that matches documents based of a field value.This type is used whenever a $gte operation shall be executed for filters additionally to query conditions.

v0.4.0

A type that represents a mongo query operations using the $inc-operator that updates document field values by incrementing it as defined in the specification object. This type is used whenever a $inc operation shall be executed to increment field values.

v0.3.2

A type that represents a mongo query operations using the $lt-operator that matches documents based of a field value.This type is used whenever a $lt operation shall be executed for filters additionally to query conditions.

v0.4.0

A type that represents a mongo query operations using the $lte-operator that matches documents based of a field value.This type is used whenever a $lte operation shall be executed for filters additionally to query conditions.

v0.4.0

A type that represents a mongo query operations using the $ne-operator that matches documents based of a field value.This type is used whenever a $eq operation shall be executed for filters additionally to query conditions.

v0.3.2

A type that represents a mongo query operations using the $set-operator that updates document field values. This type is used whenever a $set operation shall be executed to create or update individual field values.

v0.3.2

A type that represents a mongo routine used for preparing the result set that will be aggregated. This type notably configures the pagination of an individual mongo query and possible enables the $count routine with the corresponding field name in the result set.

v0.3.2

A type that represents a mongo pipeline stage that uses the $match operator. This type is used whenever a search query shall be executed for any type of query conditions.

v0.3.2

A type that represents a mongo routine used for preparing an update (or creation) of new field values.

v0.3.2

A type that represents mongo query conditions individually and is used to perform safe database queries with typed conditions.

v0.3.2

A type that consists of a container for multiple mongo query conditions that are typed using MongoQueryConditionValue and used to perform safe queries using typed conditions.

v0.3.2

A type that represents data about pagination, offset and limit for mongo database queries.

v0.3.2

A type that represents mongo query operations individually and is used to perform safe database queries with typed operations.

Mongo operations that are currently supported include:

• $eq: This operation consists of matching documents by equality of a field value.
• $ne: This operation consists of matching documents for which a field is not null.
• $exists: This operation consists of matching documents for which a field exists and is not null.
• $set: This operation consists of setting field values on matching documents.
• $inc: This operation consists of incrementing a field value on matching documents.
• $dec: This operation consists of decrementing a field value on matching documents.
• $gt: This operation consists of matching documents for which a field value is greater than the provided filter.
• $gte: This operation consists of matching documents for which a field value is greater than or equal the provided filter.
• $lt: This operation consists of matching documents for which a field value is less than the provided filter.
• $lte: This operation consists of matching documents for which a field value is less than or equal the provided filter.
  
  

Using the MongoOperationEqual operator

// performs a "non-null" query on field `fieldName`
{ "fieldName": { $ne: null } }

v0.3.2

A type that represents mongo query operations raw specification and is used to perform safe database query with added typed operations.

v0.3.2

A type that represents mongo query conditions individually and is used to perform safe database queries with typed conditions.

v0.3.2

A type that consists of a container for multiple mongo query operations, e.g. $ne or $eq that are typed using MongoQueryOperation and used to perform safe queries using typed operations.

v0.3.2

A type that represents mongo query pipelines. A pipeline typically consists of one or more mongo routines that impact the result set that the query execution will return.

v0.3.2

A type that represents mongo query pipeline stages. A pipeline stage consists of one mongo routines that impacts the result set that a query execution will return.

v0.3.2

A type that consists of a container for multiple mongo result values that are typed using MongoQueryResultValue and used to type the result set of a mongo query.

v0.3.2

A type that represents mongo result values individually and is used to type the result set when a mongo query is executed with the $set operator.

v0.3.2

A type that represents a union pipeline used for preparing the result set that will be aggregated. This type notably configures the collection name of an individual union group.

Note that the _id field is obligatory in the union group, as well as the coll - collection name - and the query pipeline stages

v0.3.2

A type that represents a mongo routine using the $count operator. This type is used whenever a $count routine shall be executed i.e. when the result set contains an aggregated total number of entries.

v0.3.2

A type that represents a mongo routine using the $in operator. This type is used whenever a $in routine shall be executed for number- or string-typed query conditions.

v0.3.2

A type that represents a mongo routine using the $regex operator. This type is used whenever a $regex condition shall be executed.

v0.3.2

This type encapsulates parameters that can be used when connecting to a dHealth Network node. Configuring the connection object (repository factory) permits to avoid extra node requests to be issued before connection can be established.

Example network connection payload object for dHealth Network

 import { Currency } from "@dhealth/sdk";

 const networkConnectionPayload = {
   nodePublicKey: "5172C98BD61DF32F447C501DE8090A9D7096F9E71975D788D67F7A82B8C04EFA",
   generationHash: "ED5761EA890A096C50D3F50B7C2F0CCB4B84AFC9EA870F381E84DDE36D04EF16",
   epochAdjustment: "1616978397",
   networkIdentifier: 104,
   networkCurrencies: {
     new Currency({
       mosaicId: new MosaicId("39E0C49FA322A459"),
       divisibility: 6,
       transferable: true,
       supplyMutable: false,
       restrictable: false,
     }),
     new Currency({
       mosaicId: new MosaicId("39E0C49FA322A459"),
       divisibility: 6,
       transferable: true,
       supplyMutable: false,
       restrictable: false,
     });
   }
 } as NetworkConnectionPayload;

v0.1.0

COMMON

This type consists of network parameters that are necessary when trying to establish connection to an operating node of dHealth Network.

Important network connection parameters include the network type, which can be MAIN_NET (104) or TEST_NET (152), a network identifier that is used as a security against transaction replays, and some other network related fields like it's starting epoch (UTC timestamp).

Example network configuration object for dHealth Network

{
  namespaceName: "dhealth.dhp",
  mosaicId: "39E0C49FA322A459",
  namespaceId: "9D8930CDBB417337",
  divisibility: 6,
  networkIdentifier: 104,
  epochAdjustment: 1616978397,
  generationHash: "ED5761EA890A096C50D3F50B7C2F0CCB4B84AFC9EA870F381E84DDE36D04EF16"
}

NetworkConfig

v0.3.0

COMMON

This type consists of an URL and an optional port that are used to establish the connection with an operating dHealth Network Node. Typically, this node connection payload refers to a node by its URL with scheme, domain name and port.

Using the NodeConnectionPayload type to configure nodes

// by default the URL can contain the schema and port
const myNode1 = { url: "http://dual-02.dhealth.cloud:3000" } as NodeConnectionPayload;

// or also, the port can be split in a separate field
const myNode2 = { url: "http://dual-02.dhealth.cloud", port: 3000 } as NodeConnectionPayload;

NetworkConfig

v0.3.0

OAUTH

This interface consists of a set of configuration fields that must be provided to configure a custom OAuth provider.

Note that newly implemented OAuth provider must be added to this type such that they are correctly understood and configured for the backend runtime endpoints (/oauth).

OAuthConfig

v0.3.0

OAUTH

An OAuth Providers configuration object. This configuration field consists of a key as listed in {@link ProviderType} and a parameters object as defined by {@link ProviderParameters}.

OAuthConfig

v0.3.0

This type is used to interface entities of the operations collection with mongoose and permits to instanciate objects representing these entities.

e.g. alongside OperationSchema, we also define OperationDocument which is a mixin that comprises of Operation and this Documentable class.

In class Queryable, the first generic accepted permits to use documents that are typed with this, to filter results in a documents query.

v0.3.0

COMMON

This type consists of operation parameters that are necessary when processing high-level information from data that is communicated using dHealth Network Transactions. The query field is passed as a mongo filter query for relevant subjects.

Example operation configuration object

{
  contract: "elevate:auth"
  label: "Session|Sessions",
  query: {
    sourceAddress: "NDAPPH6ZGD4D6LBWFLGFZUT2KQ5OLBLU32K3HNY"
  }
}

ProcessorConfig

v0.3.0

This type is used to interface entities of the payouts collection with mongoose and permits to create an instance and objects representing these entities.

e.g. alongside PayoutSchema, we also define PayoutDocument which is a mixin that comprises of Payout and this Documentable class.

In class Queryable, the first generic accepted permits to use documents that are typed with this, to filter results in a documents query.

v0.4.0

PrepareActivityPayoutsCommandOptions

This interface defines arguments that can be passed to this processor command that is implemented in the backend runtime.

Note that it is important that child classes extend this interface with their own specification of arguments.

Additional note relating to this implementation is that the payout preparation command does not need any other command options.

PayoutCommandOptions

v0.4.0

PrepareBoost10PayoutsCommandOptions

This interface defines arguments that can be passed to this processor command that is implemented in the backend runtime.

Note that it is important that child classes extend this interface with their own specification of arguments.

Additional note relating to this implementation is that the payout preparation command does not need any other command options.

PayoutCommandOptions

v0.4.0

PrepareBoost15PayoutsCommandOptions

This interface defines arguments that can be passed to this processor command that is implemented in the backend runtime.

Note that it is important that child classes extend this interface with their own specification of arguments.

Additional note relating to this implementation is that the payout preparation command does not need any other command options.

PayoutCommandOptions

v0.4.0

PrepareBoost5PayoutsCommandOptions

This interface defines arguments that can be passed to this processor command that is implemented in the backend runtime.

Note that it is important that child classes extend this interface with their own specification of arguments.

Additional note relating to this implementation is that the payout preparation command does not need any other command options.

PayoutCommandOptions

v0.4.0

PrepareBoosterPayoutsCommandOptions

This interface defines arguments that can be passed to this processor command that is implemented in the backend runtime.

Note that it is important that child classes extend this interface with their own specification of arguments.

Additional note relating to this implementation is that the payout preparation command does not need any other command options.

PayoutCommandOptions

v0.4.0

PreparePayoutsCommandOptions

This interface defines arguments that can be passed to this processor command that is implemented in the backend runtime.

Note that it is important that child classes extend this interface with their own specification of arguments.

Additional note relating to this implementation is that the payout preparation command does not need any other command options.

PayoutCommandOptions

v0.4.0

ReferralBoosterParameters

v0.6.0

COMMON

This enumeration contains the configurable scopes for the runtime. Any newly added scope must be added here as well to make sure, and in case it's necessary, that the scope can be enabled through the configuration of the backend runtime.

v0.1.0

COMMON

This type consists of:

• A period format type e.g. "D", "W", "M" for daily, weekly & monthly.
• A collection name - of which schedulers will use to aggregate statistics from.
• A fields array - which the schedulers will use to sum up for score.

StatisticsConfig

v0.3.2

Query configuration object that is intended to separate Mongo query configuration from sorting and pagination (cursor) logic using native types.

This class may be used to create custom search queries that can be executed againt a running Mongo service.

v0.1.0

COMMON

App share configuration object.

SocialPlatformsMap

v0.3.0

A type that represents data about the state of a module or scheduler.

v0.1.0

This type is used to interface entities of the states collection with mongoose and permits to instanciate objects representing these entities.

e.g. alongside StateSchema, we also define StateDocument which is a mixin that comprises of State and this Documentable class.

In class Queryable, the first generic accepted permits to use documents that are typed with this, to filter results in a documents query.

v0.3.0

This type defines a type that is used for the column with name data in Statistics.

v0.5.0

This type is used to interface entities of the statistics collection with mongoose and permits to instanciate objects representing these entities.

e.g. alongside StatisticsSchema, we also define StatisticsDocument which is a mixin that comprises of Statistics and this Documentable class.

In class Queryable, the first generic accepted permits to use documents that are typed with this, to filter results in a documents query.

v0.3.2

This type is used to interface entities of the transactions collection with mongoose and permits to instanciate objects representing these entities.

e.g. alongside TransactionSchema, we also define TransactionDocument which is a mixin that comprises of Transaction and this Documentable class.

In class Queryable, the first generic accepted permits to use documents that are typed with this, to filter results in a documents query.

v0.3.0

A type that represents data that is largely typed and thereby unsafe. This type is used internally before type-casting the mongo query conditions using MongoQueryConditions.

v0.3.2

A type that represents data that is largely typed and thereby unsafe, formatted into a query condition format. This type is used internally before type-casting the mongo query conditions using MongoQueryConditions.

v0.3.2

Contains a labelled map of connected websocket clients. The value always contains a connected Socket instance that is used to interact with UDP datagram sockets.

v0.6.0