@twin.org/node-core 0.0.2-next.9 → 0.0.3-next.10

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -4,7 +4,7 @@ The engine core environment variables.
 
 ## Extended by
 
-- [`INodeEnvironmentVariables`](INodeEnvironmentVariables.md)
+- [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md)
 
 ## Properties
 
@@ -16,6 +16,14 @@ Start the engine in debug mode.
 
 ***
 
+### silent?
+
+> `optional` **silent**: `string`
+
+Start the engine in silent mode.
+
+***
+
 ### storageFileRoot?
 
 > `optional` **storageFileRoot**: `string`
@@ -32,6 +40,22 @@ The name of the state file.
 
 ***
 
+### nodeIdentityEnabled?
+
+> `optional` **nodeIdentityEnabled**: `string`
+
+Does the node have a unique ID, defaults to true.
+
+***
+
+### tenantEnabled?
+
+> `optional` **tenantEnabled**: `string`
+
+Is multi-tenant support enabled, defaults to false.
+
+***
+
 ### 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`
@@ -89,6 +121,14 @@ AWS Dynamo DB secret access key.
 
 ***
 
+### awsDynamodbConnectionTimeoutMs?
+
+> `optional` **awsDynamodbConnectionTimeoutMs**: `string`
+
+AWS Dynamo DB connection timeout.
+
+***
+
 ### azureCosmosdbKey?
 
 > `optional` **azureCosmosdbKey**: `string`
@@ -370,15 +410,6 @@ 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.
-
-***
-
 ### blobStoragePrefix?
 
 > `optional` **blobStoragePrefix**: `string`
@@ -387,11 +418,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 +434,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 +458,14 @@ AWS S3 secret access key.
 
 ***
 
+### awsS3Endpoint?
+
+> `optional` **awsS3Endpoint**: `string`
+
+AWS S3 endpoint.
+
+***
+
 ### azureStorageAccountKey?
 
 > `optional` **azureStorageAccountKey**: `string`
@@ -519,15 +558,7 @@ Hashicorp Vault endpoint.
 
 > `optional` **loggingConnector**: `string`
 
-The type of background task connector, can be a comma separated list: console, entity-storage.
-
-***
-
-### backgroundTaskConnector?
-
-> `optional` **backgroundTaskConnector**: `string`
-
-The type of background task connector: entity-storage.
+The type of logging task connector, can be a comma separated list: console, entity-storage.
 
 ***
 
@@ -547,27 +578,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 +634,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.
 
 ***
 
@@ -627,6 +698,14 @@ The type of identity connector: entity-storage, iota.
 
 ***
 
+### identityWalletAddressIndex?
+
+> `optional` **identityWalletAddressIndex**: `string`
+
+The index of the wallet address to use, defaults to 0.
+
+***
+
 ### identityResolverConnector?
 
 > `optional` **identityResolverConnector**: `string`
@@ -739,6 +818,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 +842,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 +887,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.
 
 ***
 
@@ -872,19 +974,44 @@ Is the federated catalogue enabled, defaults to false.
 
 ***
 
-### federatedCatalogueCacheTtlMs?
+### federatedCatalogueFilters?
+
+> `optional` **federatedCatalogueFilters**: `string`
+
+Federated catalog filters, command separated list of filters to add.
+
+***
+
+### trustEnabled?
+
+> `optional` **trustEnabled**: `string`
+
+Is the trust management enabled, defaults to false.
+
+***
+
+### trustGenerators?
+
+> `optional` **trustGenerators**: `string`
+
+The trust generators to add to the factory, comma separated list.
+
+***
+
+### trustVerifiers?
 
-> `optional` **federatedCatalogueCacheTtlMs**: `number`
+> `optional` **trustVerifiers**: `string`
 
-Federated catalog TTL for the cache.
+The trust verifiers to add to the factory, comma separated list.
 
 ***
 
-### federatedCatalogueClearingHouseApproverList?
+### trustVerificationMethodId?
 
-> `optional` **federatedCatalogueClearingHouseApproverList**: `string`
+> `optional` **trustVerificationMethodId**: `string`
 
-Federated catalog clearing house approver list, stringified array of DIDs.
+The verification method to use for trust identities.
+Defaults to node-authentication-assertion.
 
 ***
 
@@ -896,6 +1023,78 @@ 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.
+
+***
+
+### rightsManagementPolicyInformationSources?
+
+> `optional` **rightsManagementPolicyInformationSources**: `string`
+
+The rights management policy information sources to add to the factory.
+
+***
+
+### rightsManagementPolicyNegotiators?
+
+> `optional` **rightsManagementPolicyNegotiators**: `string`
+
+The rights management policy negotiators sources to add to the factory.
+
+***
+
+### rightsManagementPolicyRequesters?
+
+> `optional` **rightsManagementPolicyRequesters**: `string`
+
+The rights management policy requesters to add to the factory.
+
+***
+
+### rightsManagementPolicyExecutionActions?
+
+> `optional` **rightsManagementPolicyExecutionActions**: `string`
+
+The rights management policy execution actions to add to the factory.
+
+***
+
+### rightsManagementPolicyEnforcementProcessors?
+
+> `optional` **rightsManagementPolicyEnforcementProcessors**: `string`
+
+The rights management policy enforcement processors to add to the factory.
+
+***
+
+### rightsManagementPolicyArbiters?
+
+> `optional` **rightsManagementPolicyArbiters**: `string`
+
+The rights management policy arbiters to add to the factory.
+
+***
+
+### rightsManagementDataAccessHandlers?
+
+> `optional` **rightsManagementDataAccessHandlers**: `string`
+
+The rights management data access handlers to add to the factory.
+
+***
+
+### backgroundTasksEnabled?
+
+> `optional` **backgroundTasksEnabled**: `string`
+
+Are background tasks enabled, defaults to false.
+
+***
+
 ### taskSchedulerEnabled?
 
 > `optional` **taskSchedulerEnabled**: `string`
@@ -912,9 +1111,53 @@ Is the data space connector enabled, defaults to false.
 
 ***
 
-### dataSpaceConnectorApps?
+### 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` **dataSpaceConnectorApps**: `string`
+> `optional` **extensions**: `string`
 
-The application configuration for the data space connector.
-Use the @json: prefix to specify the path to the JSON configuration file.
+A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.