@twin.org/node-core 0.0.2-next.15 → 0.0.2-next.17

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -57,6 +57,14 @@ A prefix for all the table in entity-storage, can be empty.
 
 ***
 
+### awsDynamodbAuthMode?
+
+> `optional` **awsDynamodbAuthMode**: `string`
+
+AWS DynamoDB auth mode, either credentials or pod.
+
+***
+
 ### awsDynamodbAccessKeyId?
 
 > `optional` **awsDynamodbAccessKeyId**: `string`
@@ -387,11 +395,11 @@ A prefix for all the blobs in blob-storage, can be empty.
 
 ***
 
-### awsS3AccessKeyId?
+### awsS3Region?
 
-> `optional` **awsS3AccessKeyId**: `string`
+> `optional` **awsS3Region**: `string`
 
-AWS S3 access key id.
+AWS S3 region.
 
 ***
 
@@ -403,19 +411,19 @@ AWS S3 bucket name.
 
 ***
 
-### awsS3Endpoint?
+### awsS3AuthMode?
 
-> `optional` **awsS3Endpoint**: `string`
+> `optional` **awsS3AuthMode**: `string`
 
-AWS S3 endpoint.
+AWS S3 auth mode, either credentials or pod, defaults to credentials.
 
 ***
 
-### awsS3Region?
+### awsS3AccessKeyId?
 
-> `optional` **awsS3Region**: `string`
+> `optional` **awsS3AccessKeyId**: `string`
 
-AWS S3 region.
+AWS S3 access key id.
 
 ***
 
@@ -427,6 +435,14 @@ AWS S3 secret access key.
 
 ***
 
+### awsS3Endpoint?
+
+> `optional` **awsS3Endpoint**: `string`
+
+AWS S3 endpoint.
+
+***
+
 ### azureStorageAccountKey?
 
 > `optional` **azureStorageAccountKey**: `string`
@@ -547,27 +563,60 @@ The type of event bus component: service.
 
 ***
 
-### messagingEmailConnector?
+### messagingEnabled?
 
-> `optional` **messagingEmailConnector**: `string`
+> `optional` **messagingEnabled**: `string`
 
-The type of messaging email connector: entity-storage, aws.
+Are the messaging components enabled, defaults to false.
 
 ***
 
-### messagingSmsConnector?
+### messagingTemplates?
 
-> `optional` **messagingSmsConnector**: `string`
+> `optional` **messagingTemplates**: `string`
 
-The type of messaging sms connector: entity-storage, aws.
+An initial set of templates for the messages.
+Use the @json: prefix to specify the path to the JSON file.
 
 ***
 
-### messagingPushNotificationConnector?
+### awsSesRegion?
 
-> `optional` **messagingPushNotificationConnector**: `string`
+> `optional` **awsSesRegion**: `string`
 
-The type of messaging push notification connector: entity-storage, aws.
+AWS SES region.
+
+***
+
+### awsSesAuthMode?
+
+> `optional` **awsSesAuthMode**: `string`
+
+AWS SES auth mode, either credentials or pod, defaults to credentials.
+
+***
+
+### awsSesSecretAccessKey?
+
+> `optional` **awsSesSecretAccessKey**: `string`
+
+AWS SES secret access key.
+
+***
+
+### awsSesAccessKeyId?
+
+> `optional` **awsSesAccessKeyId**: `string`
+
+AWS SES access key id.
+
+***
+
+### awsSesEndpoint?
+
+> `optional` **awsSesEndpoint**: `string`
+
+AWS SES endpoint.
 
 ***
 
@@ -579,11 +628,27 @@ The applications for the push notifications JSON stringified array of IAwsApplic
 
 ***
 
-### messagingComponent?
+### messagingEmailConnector?
 
-> `optional` **messagingComponent**: `string`
+> `optional` **messagingEmailConnector**: `string`
 
-The type of messaging component: service.
+The type of messaging email connector: entity-storage, aws.
+
+***
+
+### messagingSmsConnector?
+
+> `optional` **messagingSmsConnector**: `string`
+
+The type of messaging sms connector: entity-storage, aws.
+
+***
+
+### messagingPushNotificationConnector?
+
+> `optional` **messagingPushNotificationConnector**: `string`
+
+The type of messaging push notification connector: entity-storage, aws.
 
 ***
 
@@ -808,7 +873,7 @@ Url which points to the api for a trusted synchronised storage node, not require
 > `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
 
 The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
-This only required if using a custom verifiable storage item, otherwise it will default the the network name.
+This only required if using a custom verifiable storage item, otherwise it will default to the network name.
 
 ***
 
@@ -1006,12 +1071,31 @@ Is the data space connector enabled, defaults to false.
 
 ***
 
-### dataSpaceConnectorApps?
+### dataSpaceConnectorRetainActivityLogsFor?
 
-> `optional` **dataSpaceConnectorApps**: `string`
+> `optional` **dataSpaceConnectorRetainActivityLogsFor**: `string`
 
-The application configuration for the data space connector.
-Use the @json: prefix to specify the path to the JSON configuration file.
+The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
+
+#### Default
+
+```ts
+10
+```
+
+***
+
+### dataSpaceConnectorActivityLogsCleanUpInterval?
+
+> `optional` **dataSpaceConnectorActivityLogsCleanUpInterval**: `string`
+
+The interval for cleaning up the activity logs.
+
+#### Default
+
+```ts
+60
+```
 
 ***
 
@@ -1029,3 +1113,11 @@ Enable verifiable credential authentication for the API.
 
 Verifiable credential assertion for node to node communication.
 Defaults to node-authentication-assertion.
+
+***
+
+### extensions?
+
+> `optional` **extensions**: `string`
+
+A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.

package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md

@@ -85,6 +85,18 @@ A prefix for all the table in entity-storage, can be empty.
 
 ***
 
+### awsDynamodbAuthMode?
+
+> `optional` **awsDynamodbAuthMode**: `string`
+
+AWS DynamoDB auth mode, either credentials or pod.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbAuthMode`](IEngineEnvironmentVariables.md#awsdynamodbauthmode)
+
+***
+
 ### awsDynamodbAccessKeyId?
 
 > `optional` **awsDynamodbAccessKeyId**: `string`
@@ -579,15 +591,15 @@ A prefix for all the blobs in blob-storage, can be empty.
 
 ***
 
-### awsS3AccessKeyId?
+### awsS3Region?
 
-> `optional` **awsS3AccessKeyId**: `string`
+> `optional` **awsS3Region**: `string`
 
-AWS S3 access key id.
+AWS S3 region.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3AccessKeyId`](IEngineEnvironmentVariables.md#awss3accesskeyid)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Region`](IEngineEnvironmentVariables.md#awss3region)
 
 ***
 
@@ -603,27 +615,27 @@ AWS S3 bucket name.
 
 ***
 
-### awsS3Endpoint?
+### awsS3AuthMode?
 
-> `optional` **awsS3Endpoint**: `string`
+> `optional` **awsS3AuthMode**: `string`
 
-AWS S3 endpoint.
+AWS S3 auth mode, either credentials or pod, defaults to credentials.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Endpoint`](IEngineEnvironmentVariables.md#awss3endpoint)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3AuthMode`](IEngineEnvironmentVariables.md#awss3authmode)
 
 ***
 
-### awsS3Region?
+### awsS3AccessKeyId?
 
-> `optional` **awsS3Region**: `string`
+> `optional` **awsS3AccessKeyId**: `string`
 
-AWS S3 region.
+AWS S3 access key id.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Region`](IEngineEnvironmentVariables.md#awss3region)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3AccessKeyId`](IEngineEnvironmentVariables.md#awss3accesskeyid)
 
 ***
 
@@ -639,6 +651,18 @@ AWS S3 secret access key.
 
 ***
 
+### awsS3Endpoint?
+
+> `optional` **awsS3Endpoint**: `string`
+
+AWS S3 endpoint.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Endpoint`](IEngineEnvironmentVariables.md#awss3endpoint)
+
+***
+
 ### azureStorageAccountKey?
 
 > `optional` **azureStorageAccountKey**: `string`
@@ -819,39 +843,88 @@ The type of event bus component: service.
 
 ***
 
-### messagingEmailConnector?
+### messagingEnabled?
 
-> `optional` **messagingEmailConnector**: `string`
+> `optional` **messagingEnabled**: `string`
 
-The type of messaging email connector: entity-storage, aws.
+Are the messaging components enabled, defaults to false.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingEmailConnector`](IEngineEnvironmentVariables.md#messagingemailconnector)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingEnabled`](IEngineEnvironmentVariables.md#messagingenabled)
 
 ***
 
-### messagingSmsConnector?
+### messagingTemplates?
 
-> `optional` **messagingSmsConnector**: `string`
+> `optional` **messagingTemplates**: `string`
 
-The type of messaging sms connector: entity-storage, aws.
+An initial set of templates for the messages.
+Use the @json: prefix to specify the path to the JSON file.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingSmsConnector`](IEngineEnvironmentVariables.md#messagingsmsconnector)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingTemplates`](IEngineEnvironmentVariables.md#messagingtemplates)
 
 ***
 
-### messagingPushNotificationConnector?
+### awsSesRegion?
 
-> `optional` **messagingPushNotificationConnector**: `string`
+> `optional` **awsSesRegion**: `string`
 
-The type of messaging push notification connector: entity-storage, aws.
+AWS SES region.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingPushNotificationConnector`](IEngineEnvironmentVariables.md#messagingpushnotificationconnector)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesRegion`](IEngineEnvironmentVariables.md#awssesregion)
+
+***
+
+### awsSesAuthMode?
+
+> `optional` **awsSesAuthMode**: `string`
+
+AWS SES auth mode, either credentials or pod, defaults to credentials.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesAuthMode`](IEngineEnvironmentVariables.md#awssesauthmode)
+
+***
+
+### awsSesSecretAccessKey?
+
+> `optional` **awsSesSecretAccessKey**: `string`
+
+AWS SES secret access key.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesSecretAccessKey`](IEngineEnvironmentVariables.md#awssessecretaccesskey)
+
+***
+
+### awsSesAccessKeyId?
+
+> `optional` **awsSesAccessKeyId**: `string`
+
+AWS SES access key id.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesAccessKeyId`](IEngineEnvironmentVariables.md#awssesaccesskeyid)
+
+***
+
+### awsSesEndpoint?
+
+> `optional` **awsSesEndpoint**: `string`
+
+AWS SES endpoint.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesEndpoint`](IEngineEnvironmentVariables.md#awssesendpoint)
 
 ***
 
@@ -867,15 +940,39 @@ The applications for the push notifications JSON stringified array of IAwsApplic
 
 ***
 
-### messagingComponent?
+### messagingEmailConnector?
+
+> `optional` **messagingEmailConnector**: `string`
+
+The type of messaging email connector: entity-storage, aws.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingEmailConnector`](IEngineEnvironmentVariables.md#messagingemailconnector)
+
+***
+
+### messagingSmsConnector?
+
+> `optional` **messagingSmsConnector**: `string`
+
+The type of messaging sms connector: entity-storage, aws.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingSmsConnector`](IEngineEnvironmentVariables.md#messagingsmsconnector)
+
+***
+
+### messagingPushNotificationConnector?
 
-> `optional` **messagingComponent**: `string`
+> `optional` **messagingPushNotificationConnector**: `string`
 
-The type of messaging component: service.
+The type of messaging push notification connector: entity-storage, aws.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingComponent`](IEngineEnvironmentVariables.md#messagingcomponent)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingPushNotificationConnector`](IEngineEnvironmentVariables.md#messagingpushnotificationconnector)
 
 ***
 
@@ -1208,7 +1305,7 @@ Url which points to the api for a trusted synchronised storage node, not require
 > `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
 
 The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
-This only required if using a custom verifiable storage item, otherwise it will default the the network name.
+This only required if using a custom verifiable storage item, otherwise it will default to the network name.
 
 #### Inherited from
 
@@ -1490,16 +1587,39 @@ Is the data space connector enabled, defaults to false.
 
 ***
 
-### dataSpaceConnectorApps?
+### dataSpaceConnectorRetainActivityLogsFor?
 
-> `optional` **dataSpaceConnectorApps**: `string`
+> `optional` **dataSpaceConnectorRetainActivityLogsFor**: `string`
 
-The application configuration for the data space connector.
-Use the @json: prefix to specify the path to the JSON configuration file.
+The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
+
+#### Default
+
+```ts
+10
+```
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorApps`](IEngineEnvironmentVariables.md#dataspaceconnectorapps)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorRetainActivityLogsFor`](IEngineEnvironmentVariables.md#dataspaceconnectorretainactivitylogsfor)
+
+***
+
+### dataSpaceConnectorActivityLogsCleanUpInterval?
+
+> `optional` **dataSpaceConnectorActivityLogsCleanUpInterval**: `string`
+
+The interval for cleaning up the activity logs.
+
+#### Default
+
+```ts
+60
+```
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorActivityLogsCleanUpInterval`](IEngineEnvironmentVariables.md#dataspaceconnectoractivitylogscleanupinterval)
 
 ***
 
@@ -1528,6 +1648,18 @@ Defaults to node-authentication-assertion.
 
 ***
 
+### extensions?
+
+> `optional` **extensions**: `string`
+
+A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`extensions`](IEngineEnvironmentVariables.md#extensions)
+
+***
+
 ### port?
 
 > `optional` **port**: `string`

package/docs/reference/interfaces/INodeEngineConfig.md

@@ -0,0 +1,7 @@
+# Interface: INodeEngineConfig
+
+The config for the node.
+
+## Extends
+
+- `IEngineServerConfig`