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

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -0,0 +1,775 @@
+# Interface: IEngineEnvironmentVariables
+
+The engine core environment variables.
+
+## Extended by
+
+- [`INodeEnvironmentVariables`](INodeEnvironmentVariables.md)
+
+## Properties
+
+### debug?
+
+> `optional` **debug**: `string`
+
+Start the engine in debug mode.
+
+***
+
+### storageFileRoot?
+
+> `optional` **storageFileRoot**: `string`
+
+The root directory for storing items like state file.
+
+***
+
+### stateFilename?
+
+> `optional` **stateFilename**: `string`
+
+The name of the state file.
+
+***
+
+### entityStorageConnectorType?
+
+> `optional` **entityStorageConnectorType**: `string`
+
+The type of the default entity storage: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, mysql, mongodb, postgresql.
+
+***
+
+### entityStorageTablePrefix?
+
+> `optional` **entityStorageTablePrefix**: `string`
+
+A prefix for all the table in entity-storage, can be empty.
+
+***
+
+### entityFileEnable?
+
+> `optional` **entityFileEnable**: `string`
+
+Enable the file entity storage connector.
+
+***
+
+### entityMemoryEnable?
+
+> `optional` **entityMemoryEnable**: `string`
+
+Enable the memory entity storage connector.
+
+***
+
+### awsDynamodbAccessKeyId?
+
+> `optional` **awsDynamodbAccessKeyId**: `string`
+
+AWS Dynamo DB access key id.
+
+***
+
+### awsDynamodbEndpoint?
+
+> `optional` **awsDynamodbEndpoint**: `string`
+
+AWS Dynamo DB Endpoint if running local instance.
+
+***
+
+### awsDynamodbRegion?
+
+> `optional` **awsDynamodbRegion**: `string`
+
+AWS Dynamo DB region.
+
+***
+
+### awsDynamodbSecretAccessKey?
+
+> `optional` **awsDynamodbSecretAccessKey**: `string`
+
+AWS Dynamo DB secret access key.
+
+***
+
+### azureCosmosdbKey?
+
+> `optional` **azureCosmosdbKey**: `string`
+
+Azure Cosmos DB key.
+
+***
+
+### azureCosmosdbContainerId?
+
+> `optional` **azureCosmosdbContainerId**: `string`
+
+Azure Cosmos DB container id.
+
+***
+
+### azureCosmosdbDatabaseId?
+
+> `optional` **azureCosmosdbDatabaseId**: `string`
+
+Azure Cosmos DB database id.
+
+***
+
+### azureCosmosdbEndpoint?
+
+> `optional` **azureCosmosdbEndpoint**: `string`
+
+Azure Cosmos DB endpoint.
+
+***
+
+### gcpFirestoreCollectionName?
+
+> `optional` **gcpFirestoreCollectionName**: `string`
+
+GCP Firestore collection name.
+
+***
+
+### gcpFirestoreCredentials?
+
+> `optional` **gcpFirestoreCredentials**: `string`
+
+GCP Firestore credentials.
+
+***
+
+### gcpFirestoreDatabaseId?
+
+> `optional` **gcpFirestoreDatabaseId**: `string`
+
+GCP Firestore database id.
+
+***
+
+### gcpFirestoreApiEndpoint?
+
+> `optional` **gcpFirestoreApiEndpoint**: `string`
+
+GCP Firestore endpoint.
+
+***
+
+### gcpFirestoreProjectId?
+
+> `optional` **gcpFirestoreProjectId**: `string`
+
+GCP Firestore project id.
+
+***
+
+### scylladbHosts?
+
+> `optional` **scylladbHosts**: `string`
+
+ScyllaDB hosts as comma separated string.
+
+***
+
+### scylladbKeyspace?
+
+> `optional` **scylladbKeyspace**: `string`
+
+ScyllaDB keyspace.
+
+***
+
+### scylladbLocalDataCenter?
+
+> `optional` **scylladbLocalDataCenter**: `string`
+
+ScyllaDB local data center.
+
+***
+
+### mySqlHost?
+
+> `optional` **mySqlHost**: `string`
+
+MySQL host.
+
+***
+
+### mySqlPort?
+
+> `optional` **mySqlPort**: `number`
+
+MySQL port.
+
+***
+
+### mySqlUser?
+
+> `optional` **mySqlUser**: `string`
+
+MySQL username.
+
+***
+
+### mySqlPassword?
+
+> `optional` **mySqlPassword**: `string`
+
+MySQL password.
+
+***
+
+### mySqlDatabase?
+
+> `optional` **mySqlDatabase**: `string`
+
+MySQL Database.
+
+***
+
+### mongoDbHost?
+
+> `optional` **mongoDbHost**: `string`
+
+MongoDB host.
+
+***
+
+### mongoDbPort?
+
+> `optional` **mongoDbPort**: `number`
+
+MongoDB port.
+
+***
+
+### mongoDbUser?
+
+> `optional` **mongoDbUser**: `string`
+
+MongoDB username.
+
+***
+
+### mongoDbPassword?
+
+> `optional` **mongoDbPassword**: `string`
+
+MongoDB password.
+
+***
+
+### mongoDbDatabase?
+
+> `optional` **mongoDbDatabase**: `string`
+
+MongoDB Database.
+
+***
+
+### postgreSqlHost?
+
+> `optional` **postgreSqlHost**: `string`
+
+PostgreSQl host.
+
+***
+
+### postgreSqlPort?
+
+> `optional` **postgreSqlPort**: `number`
+
+PostgreSQl port.
+
+***
+
+### postgreSqlUser?
+
+> `optional` **postgreSqlUser**: `string`
+
+PostgreSQl username.
+
+***
+
+### postgreSqlPassword?
+
+> `optional` **postgreSqlPassword**: `string`
+
+PostgreSQl password.
+
+***
+
+### postgreSqlDatabase?
+
+> `optional` **postgreSqlDatabase**: `string`
+
+PostgreSQl Database.
+
+***
+
+### ipfsBearerToken?
+
+> `optional` **ipfsBearerToken**: `string`
+
+The security token for accessing IPFS API.
+
+***
+
+### ipfsApiUrl?
+
+> `optional` **ipfsApiUrl**: `string`
+
+The url for accessing IPFS API.
+
+***
+
+### blobStorageConnectorType?
+
+> `optional` **blobStorageConnectorType**: `string`
+
+The type of the default blob storage: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
+
+***
+
+### blobStorageEnableEncryption?
+
+> `optional` **blobStorageEnableEncryption**: `string`
+
+Enable encryption for the blob storage.
+
+***
+
+### blobStorageEncryptionKey?
+
+> `optional` **blobStorageEncryptionKey**: `string`
+
+The encryption key for the blob storage.
+
+***
+
+### blobStoragePrefix?
+
+> `optional` **blobStoragePrefix**: `string`
+
+A prefix for all the blobs in blob-storage, can be empty.
+
+***
+
+### blobFileEnable?
+
+> `optional` **blobFileEnable**: `string`
+
+Enable the file blob storage connector.
+
+***
+
+### blobMemoryEnable?
+
+> `optional` **blobMemoryEnable**: `string`
+
+Enable the memory blob storage connector.
+
+***
+
+### awsS3AccessKeyId?
+
+> `optional` **awsS3AccessKeyId**: `string`
+
+AWS S3 access key id.
+
+***
+
+### awsS3BucketName?
+
+> `optional` **awsS3BucketName**: `string`
+
+AWS S3 bucket name.
+
+***
+
+### awsS3Endpoint?
+
+> `optional` **awsS3Endpoint**: `string`
+
+AWS S3 endpoint.
+
+***
+
+### awsS3Region?
+
+> `optional` **awsS3Region**: `string`
+
+AWS S3 region.
+
+***
+
+### awsS3SecretAccessKey?
+
+> `optional` **awsS3SecretAccessKey**: `string`
+
+AWS S3 secret access key.
+
+***
+
+### azureStorageAccountKey?
+
+> `optional` **azureStorageAccountKey**: `string`
+
+Azure Storage account key.
+
+***
+
+### azureStorageAccountName?
+
+> `optional` **azureStorageAccountName**: `string`
+
+Azure Storage account name.
+
+***
+
+### azureStorageContainerName?
+
+> `optional` **azureStorageContainerName**: `string`
+
+Azure Storage container.
+
+***
+
+### azureStorageEndpoint?
+
+> `optional` **azureStorageEndpoint**: `string`
+
+Azure Storage endpoint.
+
+***
+
+### gcpStorageBucketName?
+
+> `optional` **gcpStorageBucketName**: `string`
+
+GCP Storage bucket.
+
+***
+
+### gcpStorageCredentials?
+
+> `optional` **gcpStorageCredentials**: `string`
+
+GCP Storage credentials.
+
+***
+
+### gcpStorageEndpoint?
+
+> `optional` **gcpStorageEndpoint**: `string`
+
+GCP Storage endpoint.
+
+***
+
+### gcpStorageProjectId?
+
+> `optional` **gcpStorageProjectId**: `string`
+
+GCP Storage project id.
+
+***
+
+### vaultConnector?
+
+> `optional` **vaultConnector**: `string`
+
+The type of the default vault connector: entity-storage, hashicorp.
+
+***
+
+### hashicorpVaultToken?
+
+> `optional` **hashicorpVaultToken**: `string`
+
+Hashicorp Vault token.
+
+***
+
+### hashicorpVaultEndpoint?
+
+> `optional` **hashicorpVaultEndpoint**: `string`
+
+Hashicorp Vault endpoint.
+
+***
+
+### loggingConnector?
+
+> `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.
+
+***
+
+### eventBusConnector?
+
+> `optional` **eventBusConnector**: `string`
+
+The type of event bus connector: local.
+
+***
+
+### eventBusComponent?
+
+> `optional` **eventBusComponent**: `string`
+
+The type of event bus component: service.
+
+***
+
+### messagingEmailConnector?
+
+> `optional` **messagingEmailConnector**: `string`
+
+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.
+
+***
+
+### awsMessagingPushNotificationApplications?
+
+> `optional` **awsMessagingPushNotificationApplications**: `string`
+
+The applications for the push notifications JSON stringified array of IAwsApplicationSettings.
+
+***
+
+### messagingComponent?
+
+> `optional` **messagingComponent**: `string`
+
+The type of messaging component: service.
+
+***
+
+### telemetryConnector?
+
+> `optional` **telemetryConnector**: `string`
+
+The type of telemetry connector: entity-storage.
+
+***
+
+### faucetConnector?
+
+> `optional` **faucetConnector**: `string`
+
+The type of faucet connector: entity-storage, iota.
+
+***
+
+### walletConnector?
+
+> `optional` **walletConnector**: `string`
+
+The type of wallet connector: entity-storage, iota.
+
+***
+
+### nftConnector?
+
+> `optional` **nftConnector**: `string`
+
+The type of NFT connector: entity-storage, iota.
+
+***
+
+### identityConnector?
+
+> `optional` **identityConnector**: `string`
+
+The type of identity connector: entity-storage, iota.
+
+***
+
+### identityResolverConnector?
+
+> `optional` **identityResolverConnector**: `string`
+
+The type of identity resolver connector: entity-storage, iota.
+
+***
+
+### verifiableStorageConnector?
+
+> `optional` **verifiableStorageConnector**: `string`
+
+The type of verifiable storage connector: entity-storage, iota.
+
+***
+
+### iotaFaucetEndpoint?
+
+> `optional` **iotaFaucetEndpoint**: `string`
+
+IOTA Faucet Endpoint.
+
+***
+
+### iotaNodeEndpoint?
+
+> `optional` **iotaNodeEndpoint**: `string`
+
+IOTA Node Endpoint.
+
+***
+
+### iotaNetwork?
+
+> `optional` **iotaNetwork**: `string`
+
+IOTA network.
+
+***
+
+### iotaCoinType?
+
+> `optional` **iotaCoinType**: `string`
+
+IOTA coin type.
+
+***
+
+### iotaExplorerEndpoint?
+
+> `optional` **iotaExplorerEndpoint**: `string`
+
+IOTA Explorer Endpoint.
+
+***
+
+### iotaGasStationEndpoint?
+
+> `optional` **iotaGasStationEndpoint**: `string`
+
+IOTA Gas Station Endpoint.
+
+***
+
+### iotaGasStationAuthToken?
+
+> `optional` **iotaGasStationAuthToken**: `string`
+
+IOTA Gas Station Authentication Token.
+
+***
+
+### universalResolverEndpoint?
+
+> `optional` **universalResolverEndpoint**: `string`
+
+Universal Resolver Endpoint.
+
+***
+
+### identityProfileConnector?
+
+> `optional` **identityProfileConnector**: `string`
+
+The type of identity profile connector: entity-storage.
+
+***
+
+### immutableProofVerificationMethodId?
+
+> `optional` **immutableProofVerificationMethodId**: `string`
+
+The identity verification method id to use with immutable proofs.
+
+***
+
+### attestationConnector?
+
+> `optional` **attestationConnector**: `string`
+
+The type of attestation connector: entity-storage, iota.
+
+***
+
+### attestationVerificationMethodId?
+
+> `optional` **attestationVerificationMethodId**: `string`
+
+The identity verification method id to use with attestation.
+
+***
+
+### dataConverterConnectors?
+
+> `optional` **dataConverterConnectors**: `string`
+
+The type of the default data converters, can be a comma separated list: json, xml.
+
+***
+
+### dataExtractorConnectors?
+
+> `optional` **dataExtractorConnectors**: `string`
+
+The type of the default data extractor, can be a comma separated list: json-path.
+
+***
+
+### federatedCatalogueCacheTtlMs?
+
+> `optional` **federatedCatalogueCacheTtlMs**: `number`
+
+Federated catalog TTL for the cache.
+
+***
+
+### federatedCatalogueClearingHouseApproverList?
+
+> `optional` **federatedCatalogueClearingHouseApproverList**: `string`
+
+Federated catalog clearing house approver list, stringified array of DIDs.
+
+***
+
+### rightsManagementEnabled?
+
+> `optional` **rightsManagementEnabled**: `string`
+
+Is the rights management enabled, defaults to false.
+
+***
+
+### taskSchedulerEnabled?
+
+> `optional` **taskSchedulerEnabled**: `string`
+
+Is the task scheduler enabled, defaults to true.