@twin.org/node-core 0.0.2-next.8 → 0.0.3-next.1

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -4,7 +4,7 @@ The engine core environment variables.
 
 ## Extended by
 
-- [`INodeEnvironmentVariables`](INodeEnvironmentVariables.md)
+- [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md)
 
 ## Properties
 
@@ -32,6 +32,30 @@ The name of the state file.
 
 ***
 
+### tenantEnabled?
+
+> `optional` **tenantEnabled**: `string`
+
+Is multi-tenant support enabled, defaults to false.
+
+***
+
+### tenantId?
+
+> `optional` **tenantId**: `string`
+
+A tenant id to use as a default for the node.
+
+***
+
+### tenantApiKey?
+
+> `optional` **tenantApiKey**: `string`
+
+A tenant api key to use as a default for the node.
+
+***
+
 ### entityStorageConnectorType?
 
 > `optional` **entityStorageConnectorType**: `string`
@@ -57,6 +81,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 +419,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 +435,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 +459,14 @@ AWS S3 secret access key.
 
 ***
 
+### awsS3Endpoint?
+
+> `optional` **awsS3Endpoint**: `string`
+
+AWS S3 endpoint.
+
+***
+
 ### azureStorageAccountKey?
 
 > `optional` **azureStorageAccountKey**: `string`
@@ -519,7 +559,7 @@ Hashicorp Vault endpoint.
 
 > `optional` **loggingConnector**: `string`
 
-The type of background task connector, can be a comma separated list: console, entity-storage.
+The type of logging task connector, can be a comma separated list: console, entity-storage.
 
 ***
 
@@ -547,27 +587,51 @@ 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?
+### awsSesRegion?
 
-> `optional` **messagingSmsConnector**: `string`
+> `optional` **awsSesRegion**: `string`
 
-The type of messaging sms connector: entity-storage, aws.
+AWS SES region.
 
 ***
 
-### messagingPushNotificationConnector?
+### awsSesAuthMode?
 
-> `optional` **messagingPushNotificationConnector**: `string`
+> `optional` **awsSesAuthMode**: `string`
 
-The type of messaging push notification connector: entity-storage, aws.
+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 +643,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.
 
 ***
 
@@ -739,6 +819,14 @@ The identity verification method id to use with attestation.
 
 ***
 
+### dataProcessingEnabled?
+
+> `optional` **dataProcessingEnabled**: `string`
+
+Is the data processing enabled, defaults to false.
+
+***
+
 ### dataConverterConnectors?
 
 > `optional` **dataConverterConnectors**: `string`
@@ -755,6 +843,30 @@ The type of the default data extractor, can be a comma separated list: json-path
 
 ***
 
+### auditableItemGraphEnabled?
+
+> `optional` **auditableItemGraphEnabled**: `string`
+
+Is the auditable item graph enabled, defaults to false.
+
+***
+
+### auditableItemStreamEnabled?
+
+> `optional` **auditableItemStreamEnabled**: `string`
+
+Is the auditable item stream enabled, defaults to false.
+
+***
+
+### documentManagementEnabled?
+
+> `optional` **documentManagementEnabled**: `string`
+
+Is the document management enabled, defaults to false.
+
+***
+
 ### synchronisedStorageEnabled?
 
 > `optional` **synchronisedStorageEnabled**: `string`
@@ -776,16 +888,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.
-
-***
-
-### synchronisedStorageVerificationMethodId?
-
-> `optional` **synchronisedStorageVerificationMethodId**: `string`
-
-The identity verification method id to use with synchronised storage for signing/verifying changesets.
-Defaults to synchronised-storage-assertion.
+This only required if using a custom verifiable storage item, otherwise it will default to the network name.
 
 ***
 
@@ -896,6 +999,77 @@ Is the rights management enabled, defaults to false.
 
 ***
 
+### rightsManagementBaseCallbackUrl?
+
+> `optional` **rightsManagementBaseCallbackUrl**: `string`
+
+What is the base callback url for rights management negotiations e.g. https://my-node/rights-management.
+
+***
+
+### rightsManagementInformationSources?
+
+> `optional` **rightsManagementInformationSources**: `string`
+
+The rights management configuration which includes the information sources modules to load.
+Use the @json: prefix to specify the path to the JSON configuration file.
+
+***
+
+### rightsManagementNegotiators?
+
+> `optional` **rightsManagementNegotiators**: `string`
+
+The rights management configuration which includes the negotiator modules to load.
+Use the @json: prefix to specify the path to the JSON configuration file.
+
+***
+
+### rightsManagementRequesters?
+
+> `optional` **rightsManagementRequesters**: `string`
+
+The rights management configuration which includes the requester modules to load.
+Use the @json: prefix to specify the path to the JSON configuration file.
+
+***
+
+### rightsManagementExecutionActions?
+
+> `optional` **rightsManagementExecutionActions**: `string`
+
+The rights management configuration which includes the execution actions modules to load.
+Use the @json: prefix to specify the path to the JSON configuration file.
+
+***
+
+### rightsManagementEnforcementProcessors?
+
+> `optional` **rightsManagementEnforcementProcessors**: `string`
+
+The rights management configuration which includes the enforcement processor modules to load.
+Use the @json: prefix to specify the path to the JSON configuration file.
+
+***
+
+### rightsManagementArbiters?
+
+> `optional` **rightsManagementArbiters**: `string`
+
+The rights management configuration which includes the arbiter modules to load.
+Use the @json: prefix to specify the path to the JSON configuration file.
+
+***
+
+### rightsManagementOffers?
+
+> `optional` **rightsManagementOffers**: `string`
+
+The rights management configuration which includes the offer modules to load.
+Use the @json: prefix to specify the path to the JSON configuration file.
+
+***
+
 ### taskSchedulerEnabled?
 
 > `optional` **taskSchedulerEnabled**: `string`
@@ -912,9 +1086,53 @@ 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
+```
+
+***
+
+### vcAuthenticationEnabled?
+
+> `optional` **vcAuthenticationEnabled**: `string`
+
+Enable verifiable credential authentication for the API.
+
+***
+
+### vcAuthenticationVerificationMethodId?
+
+> `optional` **vcAuthenticationVerificationMethodId**: `string`
+
+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.