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

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -36,31 +36,24 @@ The name of the state file.
 
 > `optional` **entityStorageConnectorType**: `string`
 
-The type of the default entity storage: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, mysql, mongodb, postgresql.
+The type of the entity storage to create, comma separate for more than one connector.
+values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, mysql, mongodb, postgresql
 
 ***
 
-### entityStorageTablePrefix?
+### entityStorageConnectorDefault?
 
-> `optional` **entityStorageTablePrefix**: `string`
+> `optional` **entityStorageConnectorDefault**: `string`
 
-A prefix for all the table in entity-storage, can be empty.
+The default entity storage connector to use, defaults to the first one in the list.
 
 ***
 
-### entityFileEnable?
-
-> `optional` **entityFileEnable**: `string`
-
-Enable the file entity storage connector.
-
-***
-
-### entityMemoryEnable?
+### entityStorageTablePrefix?
 
-> `optional` **entityMemoryEnable**: `string`
+> `optional` **entityStorageTablePrefix**: `string`
 
-Enable the memory entity storage connector.
+A prefix for all the table in entity-storage, can be empty.
 
 ***
 
@@ -192,6 +185,14 @@ ScyllaDB local data center.
 
 ***
 
+### scylladbPort?
+
+> `optional` **scylladbPort**: `string`
+
+ScyllaDB port.
+
+***
+
 ### mySqlHost?
 
 > `optional` **mySqlHost**: `string`
@@ -332,47 +333,57 @@ The url for accessing IPFS API.
 
 > `optional` **blobStorageConnectorType**: `string`
 
-The type of the default blob storage: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
+The type of the entity storage to create, comma separate for more than one connector.
+values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
 
 ***
 
-### blobStorageEnableEncryption?
+### blobStorageConnectorDefault?
 
-> `optional` **blobStorageEnableEncryption**: `string`
+> `optional` **blobStorageConnectorDefault**: `string`
 
-Enable encryption for the blob storage.
+The default blob storage connector to use, defaults to the first one in the list.
 
 ***
 
-### blobStorageEncryptionKey?
+### blobStorageConnectorPublic?
 
-> `optional` **blobStorageEncryptionKey**: `string`
+> `optional` **blobStorageConnectorPublic**: `string`
 
-The encryption key for the blob storage.
+Blog storage connector which has public access.
 
 ***
 
-### blobStoragePrefix?
+### blobStorageEnableEncryption?
 
-> `optional` **blobStoragePrefix**: `string`
+> `optional` **blobStorageEnableEncryption**: `string`
 
-A prefix for all the blobs in blob-storage, can be empty.
+Enable encryption for the blob storage.
 
 ***
 
-### blobFileEnable?
+### blobStorageEncryptionKeyId?
 
-> `optional` **blobFileEnable**: `string`
+> `optional` **blobStorageEncryptionKeyId**: `string`
 
-Enable the file blob storage connector.
+The id of the encryption key for the blob storage.
 
 ***
 
-### blobMemoryEnable?
+### blobStorageSymmetricEncryptionKey?
 
-> `optional` **blobMemoryEnable**: `string`
+> `optional` **blobStorageSymmetricEncryptionKey**: `string`
 
-Enable the memory blob storage connector.
+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`
+
+A prefix for all the blobs in blob-storage, can be empty.
 
 ***
 
@@ -744,6 +755,123 @@ The type of the default data extractor, can be a comma separated list: json-path
 
 ***
 
+### 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 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.
+
+***
+
+### 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`
@@ -768,8 +896,70 @@ Is the rights management enabled, defaults to false.
 
 ***
 
+### rightsManagementNegotiationMethodId?
+
+> `optional` **rightsManagementNegotiationMethodId**: `string`
+
+The rights management verification method id to use when signing/verifying negotiation requests.
+Defaults to policy-negotiation-assertion.
+
+***
+
+### 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.
+
+***
+
+### 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.
+
+***
+
+### 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.
+
+***
+
 ### 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.
+
+***
+
+### dataSpaceConnectorApps?
+
+> `optional` **dataSpaceConnectorApps**: `string`
+
+The application configuration for the data space connector.
+Use the @json: prefix to specify the path to the JSON configuration file.