@twin.org/node-core 0.0.2-next.2 → 0.0.2-next.21

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -4,7 +4,7 @@ The engine core environment variables.
 
 ## Extended by
 
-- [`INodeEnvironmentVariables`](INodeEnvironmentVariables.md)
+- [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md)
 
 ## Properties
 
@@ -49,19 +49,19 @@ The default entity storage connector to use, defaults to the first one in the li
 
 ***
 
-### entityStorageConnectorDecentralised?
+### entityStorageTablePrefix?
 
-> `optional` **entityStorageConnectorDecentralised**: `string`
+> `optional` **entityStorageTablePrefix**: `string`
 
-Entity storage connector for decentralized storage
+A prefix for all the table in entity-storage, can be empty.
 
 ***
 
-### entityStorageTablePrefix?
+### awsDynamodbAuthMode?
 
-> `optional` **entityStorageTablePrefix**: `string`
+> `optional` **awsDynamodbAuthMode**: `string`
 
-A prefix for all the table in entity-storage, can be empty.
+AWS DynamoDB auth mode, either credentials or pod.
 
 ***
 
@@ -354,11 +354,11 @@ The default blob storage connector to use, defaults to the first one in the list
 
 ***
 
-### blobStorageConnectorDecentralised?
+### blobStorageConnectorPublic?
 
-> `optional` **blobStorageConnectorDecentralised**: `string`
+> `optional` **blobStorageConnectorPublic**: `string`
 
-Blog storage connector for decentralized storage
+Blog storage connector which has public access.
 
 ***
 
@@ -370,11 +370,20 @@ Enable encryption for the blob storage.
 
 ***
 
-### blobStorageEncryptionKey?
+### blobStorageEncryptionKeyId?
 
-> `optional` **blobStorageEncryptionKey**: `string`
+> `optional` **blobStorageEncryptionKeyId**: `string`
 
-The encryption key for the blob storage.
+The id of the encryption key for the blob storage.
+
+***
+
+### blobStorageSymmetricEncryptionKey?
+
+> `optional` **blobStorageSymmetricEncryptionKey**: `string`
+
+A symmetric encryption key for the blob storage, should be ChaCha20Poly1305 in base64 format.
+If encryption is enabled but a key is not provided one will be generated.
 
 ***
 
@@ -386,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.
 
 ***
 
@@ -402,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.
 
 ***
 
@@ -426,6 +435,14 @@ AWS S3 secret access key.
 
 ***
 
+### awsS3Endpoint?
+
+> `optional` **awsS3Endpoint**: `string`
+
+AWS S3 endpoint.
+
+***
+
 ### azureStorageAccountKey?
 
 > `optional` **azureStorageAccountKey**: `string`
@@ -518,7 +535,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.
 
 ***
 
@@ -546,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.
 
 ***
 
@@ -578,11 +628,27 @@ The applications for the push notifications JSON stringified array of IAwsApplic
 
 ***
 
-### messagingComponent?
+### messagingEmailConnector?
+
+> `optional` **messagingEmailConnector**: `string`
 
-> `optional` **messagingComponent**: `string`
+The type of messaging email connector: entity-storage, aws.
 
-The type of messaging component: service.
+***
+
+### 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.
 
 ***
 
@@ -738,6 +804,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`
@@ -754,6 +828,138 @@ 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`
+
+Is the synchronised storage enabled, defaults to false.
+
+***
+
+### synchronisedStorageTrustedUrl?
+
+> `optional` **synchronisedStorageTrustedUrl**: `string`
+
+Url which points to the api for a trusted synchronised storage node, not required if this is a trusted node.
+
+***
+
+### synchronisedStorageVerifiableStorageKeyId?
+
+> `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 to the network name.
+
+***
+
+### synchronisedStorageBlobStorageEncryptionKeyId?
+
+> `optional` **synchronisedStorageBlobStorageEncryptionKeyId**: `string`
+
+The key from the vault which is used to encrypt the synchronised storage blobs.
+Only required for trusted nodes, as regular nodes will request from the trusted nodes.
+Defaults to synchronised-storage-blob-encryption
+
+***
+
+### synchronisedStorageBlobStorageKey?
+
+> `optional` **synchronisedStorageBlobStorageKey**: `string`
+
+The key used for blob encryption, should be ChaCha20Poly1305 encoded as base64.
+Only required for trusted nodes, as regular nodes will not write encrypted data.
+
+***
+
+### synchronisedStorageEntityUpdateIntervalMinutes?
+
+> `optional` **synchronisedStorageEntityUpdateIntervalMinutes**: `string`
+
+How often to check for entity updates in minutes.
+
+#### Default
+
+```ts
+5
+```
+
+***
+
+### synchronisedStorageConsolidationIntervalMinutes?
+
+> `optional` **synchronisedStorageConsolidationIntervalMinutes**: `string`
+
+Interval to perform consolidation of changesets, only used if this is a trusted node.
+
+#### Default
+
+```ts
+60
+```
+
+***
+
+### synchronisedStorageConsolidationBatchSize?
+
+> `optional` **synchronisedStorageConsolidationBatchSize**: `string`
+
+The number of entities to process in a single consolidation batch, only used if this is a trusted node.
+
+#### Default
+
+```ts
+1000
+```
+
+***
+
+### synchronisedStorageMaxConsolidations?
+
+> `optional` **synchronisedStorageMaxConsolidations**: `string`
+
+The maximum number of consolidations to keep in storage, only used if this is a trusted node.
+
+#### Default
+
+```ts
+5
+```
+
+***
+
+### federatedCatalogueEnabled?
+
+> `optional` **federatedCatalogueEnabled**: `string`
+
+Is the federated catalogue enabled, defaults to false.
+
+***
+
 ### federatedCatalogueCacheTtlMs?
 
 > `optional` **federatedCatalogueCacheTtlMs**: `number`
@@ -778,8 +984,140 @@ 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`
 
-Is the task scheduler enabled, defaults to true.
+Is the task scheduler enabled, defaults to false.
+
+***
+
+### dataSpaceConnectorEnabled?
+
+> `optional` **dataSpaceConnectorEnabled**: `string`
+
+Is the data space connector enabled, defaults to false.
+
+***
+
+### dataSpaceConnectorRetainActivityLogsFor?
+
+> `optional` **dataSpaceConnectorRetainActivityLogsFor**: `string`
+
+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.