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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (195) hide show
  1. package/README.md +1 -1
  2. package/dist/es/builders/engineEnvBuilder.js +1132 -0
  3. package/dist/es/builders/engineEnvBuilder.js.map +1 -0
  4. package/dist/es/builders/engineServerEnvBuilder.js +206 -0
  5. package/dist/es/builders/engineServerEnvBuilder.js.map +1 -0
  6. package/dist/es/builders/extensionsBuilder.js +109 -0
  7. package/dist/es/builders/extensionsBuilder.js.map +1 -0
  8. package/dist/es/cli.js +255 -0
  9. package/dist/es/cli.js.map +1 -0
  10. package/dist/es/commands/bootstrapLegacy.js +175 -0
  11. package/dist/es/commands/bootstrapLegacy.js.map +1 -0
  12. package/dist/es/commands/help.js +85 -0
  13. package/dist/es/commands/help.js.map +1 -0
  14. package/dist/es/commands/identityCreate.js +310 -0
  15. package/dist/es/commands/identityCreate.js.map +1 -0
  16. package/dist/es/commands/identityImports.js +76 -0
  17. package/dist/es/commands/identityImports.js.map +1 -0
  18. package/dist/es/commands/identityVerifiableCredentialCreate.js +140 -0
  19. package/dist/es/commands/identityVerifiableCredentialCreate.js.map +1 -0
  20. package/dist/es/commands/identityVerificationMethodCreate.js +208 -0
  21. package/dist/es/commands/identityVerificationMethodCreate.js.map +1 -0
  22. package/dist/es/commands/identityVerificationMethodImport.js +120 -0
  23. package/dist/es/commands/identityVerificationMethodImport.js.map +1 -0
  24. package/dist/es/commands/nodeSetIdentity.js +51 -0
  25. package/dist/es/commands/nodeSetIdentity.js.map +1 -0
  26. package/dist/es/commands/nodeSetTenant.js +49 -0
  27. package/dist/es/commands/nodeSetTenant.js.map +1 -0
  28. package/dist/es/commands/tenantCreate.js +120 -0
  29. package/dist/es/commands/tenantCreate.js.map +1 -0
  30. package/dist/es/commands/tenantImport.js +78 -0
  31. package/dist/es/commands/tenantImport.js.map +1 -0
  32. package/dist/es/commands/userCreate.js +197 -0
  33. package/dist/es/commands/userCreate.js.map +1 -0
  34. package/dist/es/commands/vaultKeyCreate.js +185 -0
  35. package/dist/es/commands/vaultKeyCreate.js.map +1 -0
  36. package/dist/es/commands/vaultKeyImport.js +98 -0
  37. package/dist/es/commands/vaultKeyImport.js.map +1 -0
  38. package/dist/es/defaults.js +28 -0
  39. package/dist/es/defaults.js.map +1 -0
  40. package/dist/es/index.js +27 -0
  41. package/dist/es/index.js.map +1 -0
  42. package/dist/es/models/ICacheMetadata.js +4 -0
  43. package/dist/es/models/ICacheMetadata.js.map +1 -0
  44. package/dist/es/models/ICliArgs.js +4 -0
  45. package/dist/es/models/ICliArgs.js.map +1 -0
  46. package/dist/es/models/ICliCommand.js +2 -0
  47. package/dist/es/models/ICliCommand.js.map +1 -0
  48. package/dist/es/models/ICliCommandDefinition.js +2 -0
  49. package/dist/es/models/ICliCommandDefinition.js.map +1 -0
  50. package/dist/es/models/ICliCommandDefinitionParam.js +2 -0
  51. package/dist/es/models/ICliCommandDefinitionParam.js.map +1 -0
  52. package/dist/es/models/IEngineEnvironmentVariables.js +4 -0
  53. package/dist/es/models/IEngineEnvironmentVariables.js.map +1 -0
  54. package/dist/es/models/IEngineServerEnvironmentVariables.js +2 -0
  55. package/dist/es/models/IEngineServerEnvironmentVariables.js.map +1 -0
  56. package/dist/es/models/IModuleProtocol.js +2 -0
  57. package/dist/es/models/IModuleProtocol.js.map +1 -0
  58. package/dist/es/models/INodeEngineConfig.js +2 -0
  59. package/dist/es/models/INodeEngineConfig.js.map +1 -0
  60. package/dist/es/models/INodeEngineState.js +2 -0
  61. package/dist/es/models/INodeEngineState.js.map +1 -0
  62. package/dist/es/models/INodeEnvironmentVariables.js +2 -0
  63. package/dist/es/models/INodeEnvironmentVariables.js.map +1 -0
  64. package/dist/es/models/INodeOptions.js +2 -0
  65. package/dist/es/models/INodeOptions.js.map +1 -0
  66. package/dist/es/models/IProtocolHandlerResult.js +4 -0
  67. package/dist/es/models/IProtocolHandlerResult.js.map +1 -0
  68. package/dist/es/models/cliCommandParamType.js +4 -0
  69. package/dist/es/models/cliCommandParamType.js.map +1 -0
  70. package/dist/es/models/moduleProtocol.js +29 -0
  71. package/dist/es/models/moduleProtocol.js.map +1 -0
  72. package/dist/es/models/nodeExtensionMethods.js +2 -0
  73. package/dist/es/models/nodeExtensionMethods.js.map +1 -0
  74. package/dist/es/node.js +285 -0
  75. package/dist/es/node.js.map +1 -0
  76. package/dist/es/start.js +128 -0
  77. package/dist/es/start.js.map +1 -0
  78. package/dist/es/utils.js +397 -0
  79. package/dist/es/utils.js.map +1 -0
  80. package/dist/types/builders/engineEnvBuilder.d.ts +6 -2
  81. package/dist/types/builders/engineServerEnvBuilder.d.ts +7 -3
  82. package/dist/types/builders/extensionsBuilder.d.ts +32 -0
  83. package/dist/types/cli.d.ts +66 -0
  84. package/dist/types/commands/bootstrapLegacy.d.ts +66 -0
  85. package/dist/types/commands/help.d.ts +23 -0
  86. package/dist/types/commands/identityCreate.d.ts +39 -0
  87. package/dist/types/commands/identityImports.d.ts +24 -0
  88. package/dist/types/commands/identityVerifiableCredentialCreate.d.ts +43 -0
  89. package/dist/types/commands/identityVerificationMethodCreate.d.ts +47 -0
  90. package/dist/types/commands/identityVerificationMethodImport.d.ts +31 -0
  91. package/dist/types/commands/nodeSetIdentity.d.ts +22 -0
  92. package/dist/types/commands/nodeSetTenant.d.ts +22 -0
  93. package/dist/types/commands/tenantCreate.d.ts +35 -0
  94. package/dist/types/commands/tenantImport.d.ts +24 -0
  95. package/dist/types/commands/userCreate.d.ts +46 -0
  96. package/dist/types/commands/vaultKeyCreate.d.ts +43 -0
  97. package/dist/types/commands/vaultKeyImport.d.ts +28 -0
  98. package/dist/types/defaults.d.ts +16 -0
  99. package/dist/types/index.d.ts +24 -11
  100. package/dist/types/models/ICacheMetadata.d.ts +17 -0
  101. package/dist/types/models/ICliArgs.d.ts +20 -0
  102. package/dist/types/models/ICliCommand.d.ts +17 -0
  103. package/dist/types/models/ICliCommandDefinition.d.ts +46 -0
  104. package/dist/types/models/ICliCommandDefinitionParam.d.ts +35 -0
  105. package/dist/types/models/IEngineEnvironmentVariables.d.ts +154 -37
  106. package/dist/types/models/IEngineServerEnvironmentVariables.d.ts +12 -3
  107. package/dist/types/models/IModuleProtocol.d.ts +18 -0
  108. package/dist/types/models/INodeEngineConfig.d.ts +6 -0
  109. package/dist/types/models/INodeEngineState.d.ts +14 -0
  110. package/dist/types/models/INodeEnvironmentVariables.d.ts +17 -15
  111. package/dist/types/models/INodeOptions.d.ts +14 -3
  112. package/dist/types/models/IProtocolHandlerResult.d.ts +13 -0
  113. package/dist/types/models/cliCommandParamType.d.ts +4 -0
  114. package/dist/types/models/moduleProtocol.d.ts +29 -0
  115. package/dist/types/models/nodeExtensionMethods.d.ts +27 -0
  116. package/dist/types/node.d.ts +21 -7
  117. package/dist/types/start.d.ts +25 -0
  118. package/dist/types/utils.d.ts +83 -6
  119. package/docs/changelog.md +241 -0
  120. package/docs/detailed-guide.md +129 -0
  121. package/docs/reference/functions/buildConfiguration.md +2 -2
  122. package/docs/reference/functions/buildEngineConfiguration.md +8 -2
  123. package/docs/reference/functions/buildEngineServerConfiguration.md +9 -3
  124. package/docs/reference/functions/constructCliCommand.md +27 -0
  125. package/docs/reference/functions/createModuleImportUrl.md +21 -0
  126. package/docs/reference/functions/directoryExists.md +19 -0
  127. package/docs/reference/functions/executeCommand.md +29 -0
  128. package/docs/reference/functions/extensionsConfiguration.md +25 -0
  129. package/docs/reference/functions/extensionsInitialiseEngine.md +25 -0
  130. package/docs/reference/functions/extensionsInitialiseEngineServer.md +31 -0
  131. package/docs/reference/functions/getEnvDefaults.md +19 -0
  132. package/docs/reference/functions/getExtensionsCacheDir.md +31 -0
  133. package/docs/reference/functions/getFiles.md +19 -0
  134. package/docs/reference/functions/getSubFolders.md +19 -0
  135. package/docs/reference/functions/handleHttpsProtocol.md +49 -0
  136. package/docs/reference/functions/handleNpmProtocol.md +31 -0
  137. package/docs/reference/functions/hashUrl.md +19 -0
  138. package/docs/reference/functions/initCli.md +27 -0
  139. package/docs/reference/functions/isCacheExpired.md +31 -0
  140. package/docs/reference/functions/overrideModuleImport.md +8 -2
  141. package/docs/reference/functions/parseCommandLineArgs.md +19 -0
  142. package/docs/reference/functions/parseModuleProtocol.md +19 -0
  143. package/docs/reference/functions/processEnvOptions.md +27 -0
  144. package/docs/reference/functions/registerCommands.md +9 -0
  145. package/docs/reference/functions/resolvePackageEntryPoint.md +32 -0
  146. package/docs/reference/functions/run.md +9 -3
  147. package/docs/reference/functions/shutdownExtensions.md +25 -0
  148. package/docs/reference/functions/start.md +17 -5
  149. package/docs/reference/functions/substituteEnvOptions.md +25 -0
  150. package/docs/reference/index.md +47 -10
  151. package/docs/reference/interfaces/ICacheMetadata.md +27 -0
  152. package/docs/reference/interfaces/ICliArgs.md +35 -0
  153. package/docs/reference/interfaces/ICliCommand.md +23 -0
  154. package/docs/reference/interfaces/ICliCommandDefinition.md +101 -0
  155. package/docs/reference/interfaces/ICliCommandDefinitionParam.md +65 -0
  156. package/docs/reference/interfaces/IEngineEnvironmentVariables.md +303 -60
  157. package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +1737 -5
  158. package/docs/reference/interfaces/IModuleProtocol.md +27 -0
  159. package/docs/reference/interfaces/INodeEngineConfig.md +7 -0
  160. package/docs/reference/interfaces/INodeEngineState.md +23 -0
  161. package/docs/reference/interfaces/INodeEnvironmentVariables.md +599 -198
  162. package/docs/reference/interfaces/INodeOptions.md +27 -3
  163. package/docs/reference/interfaces/IProtocolHandlerResult.md +19 -0
  164. package/docs/reference/type-aliases/CliCommandParamType.md +5 -0
  165. package/docs/reference/type-aliases/ModuleProtocol.md +5 -0
  166. package/docs/reference/type-aliases/NodeExtensionInitialiseEngineMethod.md +18 -0
  167. package/docs/reference/type-aliases/NodeExtensionInitialiseEngineServerMethod.md +24 -0
  168. package/docs/reference/type-aliases/NodeExtensionInitialiseMethod.md +23 -0
  169. package/docs/reference/type-aliases/NodeExtensionShutdownMethod.md +10 -0
  170. package/docs/reference/variables/ATTESTATION_VERIFICATION_METHOD_ID.md +3 -0
  171. package/docs/reference/variables/AUTH_SIGNING_KEY_ID.md +3 -0
  172. package/docs/reference/variables/BLOB_STORAGE_ENCRYPTION_KEY_ID.md +3 -0
  173. package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_DID.md +3 -0
  174. package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_TENANT.md +3 -0
  175. package/docs/reference/variables/IMMUTABLE_PROOF_VERIFICATION_METHOD_ID.md +3 -0
  176. package/docs/reference/variables/ModuleProtocol.md +37 -0
  177. package/docs/reference/variables/SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID.md +3 -0
  178. package/docs/reference/variables/VC_AUTHENTICATION_VERIFICATION_METHOD_ID.md +3 -0
  179. package/locales/en.json +479 -28
  180. package/package.json +29 -9
  181. package/dist/cjs/index.cjs +0 -1910
  182. package/dist/esm/index.mjs +0 -1870
  183. package/dist/types/bootstrap.d.ts +0 -59
  184. package/dist/types/models/nodeFeatures.d.ts +0 -21
  185. package/dist/types/server.d.ts +0 -17
  186. package/docs/reference/functions/bootstrap.md +0 -29
  187. package/docs/reference/functions/bootstrapAuth.md +0 -35
  188. package/docs/reference/functions/bootstrapBlobEncryption.md +0 -35
  189. package/docs/reference/functions/bootstrapImmutableProofMethod.md +0 -35
  190. package/docs/reference/functions/bootstrapNodeIdentity.md +0 -35
  191. package/docs/reference/functions/bootstrapNodeUser.md +0 -35
  192. package/docs/reference/functions/bootstrapSynchronisedStorage.md +0 -35
  193. package/docs/reference/functions/getFeatures.md +0 -19
  194. package/docs/reference/type-aliases/NodeFeatures.md +0 -5
  195. package/docs/reference/variables/NodeFeatures.md +0 -25
@@ -2,11 +2,1727 @@
2
2
 
3
3
  The engine server environment variables.
4
4
 
5
+ ## Extends
6
+
7
+ - [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md)
8
+
5
9
  ## Extended by
6
10
 
7
- - [`INodeEnvironmentVariables`](INodeEnvironmentVariables.md)
11
+ - [`INodeEnvironmentVariables`](INodeEnvironmentVariables.md)
12
+
13
+ ## Properties
14
+
15
+ ### debug?
16
+
17
+ > `optional` **debug**: `string`
18
+
19
+ Start the engine in debug mode.
20
+
21
+ #### Inherited from
22
+
23
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`debug`](IEngineEnvironmentVariables.md#debug)
24
+
25
+ ***
26
+
27
+ ### silent?
28
+
29
+ > `optional` **silent**: `string`
30
+
31
+ Start the engine in silent mode.
32
+
33
+ #### Inherited from
34
+
35
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`silent`](IEngineEnvironmentVariables.md#silent)
36
+
37
+ ***
38
+
39
+ ### storageFileRoot?
40
+
41
+ > `optional` **storageFileRoot**: `string`
42
+
43
+ The root directory for storing items like state file.
44
+
45
+ #### Inherited from
46
+
47
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`storageFileRoot`](IEngineEnvironmentVariables.md#storagefileroot)
48
+
49
+ ***
50
+
51
+ ### stateFilename?
52
+
53
+ > `optional` **stateFilename**: `string`
54
+
55
+ The name of the state file.
56
+
57
+ #### Inherited from
58
+
59
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`stateFilename`](IEngineEnvironmentVariables.md#statefilename)
60
+
61
+ ***
62
+
63
+ ### nodeIdentityEnabled?
64
+
65
+ > `optional` **nodeIdentityEnabled**: `string`
66
+
67
+ Does the node have a unique ID, defaults to true.
68
+
69
+ #### Inherited from
70
+
71
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`nodeIdentityEnabled`](IEngineEnvironmentVariables.md#nodeidentityenabled)
72
+
73
+ ***
74
+
75
+ ### tenantEnabled?
76
+
77
+ > `optional` **tenantEnabled**: `string`
78
+
79
+ Is multi-tenant support enabled, defaults to false.
80
+
81
+ #### Inherited from
82
+
83
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`tenantEnabled`](IEngineEnvironmentVariables.md#tenantenabled)
84
+
85
+ ***
86
+
87
+ ### entityStorageConnectorType?
88
+
89
+ > `optional` **entityStorageConnectorType**: `string`
90
+
91
+ The type of the entity storage to create, comma separate for more than one connector.
92
+ values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, mysql, mongodb, postgresql
93
+
94
+ #### Inherited from
95
+
96
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageConnectorType`](IEngineEnvironmentVariables.md#entitystorageconnectortype)
97
+
98
+ ***
99
+
100
+ ### entityStorageConnectorDefault?
101
+
102
+ > `optional` **entityStorageConnectorDefault**: `string`
103
+
104
+ The default entity storage connector to use, defaults to the first one in the list.
105
+
106
+ #### Inherited from
107
+
108
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageConnectorDefault`](IEngineEnvironmentVariables.md#entitystorageconnectordefault)
109
+
110
+ ***
111
+
112
+ ### entityStorageTablePrefix?
113
+
114
+ > `optional` **entityStorageTablePrefix**: `string`
115
+
116
+ A prefix for all the table in entity-storage, can be empty.
117
+
118
+ #### Inherited from
119
+
120
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageTablePrefix`](IEngineEnvironmentVariables.md#entitystoragetableprefix)
121
+
122
+ ***
123
+
124
+ ### awsDynamodbAuthMode?
125
+
126
+ > `optional` **awsDynamodbAuthMode**: `string`
127
+
128
+ AWS DynamoDB auth mode, either credentials or pod.
129
+
130
+ #### Inherited from
131
+
132
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbAuthMode`](IEngineEnvironmentVariables.md#awsdynamodbauthmode)
133
+
134
+ ***
135
+
136
+ ### awsDynamodbAccessKeyId?
137
+
138
+ > `optional` **awsDynamodbAccessKeyId**: `string`
139
+
140
+ AWS Dynamo DB access key id.
141
+
142
+ #### Inherited from
143
+
144
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbAccessKeyId`](IEngineEnvironmentVariables.md#awsdynamodbaccesskeyid)
145
+
146
+ ***
147
+
148
+ ### awsDynamodbEndpoint?
149
+
150
+ > `optional` **awsDynamodbEndpoint**: `string`
151
+
152
+ AWS Dynamo DB Endpoint if running local instance.
153
+
154
+ #### Inherited from
155
+
156
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbEndpoint`](IEngineEnvironmentVariables.md#awsdynamodbendpoint)
157
+
158
+ ***
159
+
160
+ ### awsDynamodbRegion?
161
+
162
+ > `optional` **awsDynamodbRegion**: `string`
163
+
164
+ AWS Dynamo DB region.
165
+
166
+ #### Inherited from
167
+
168
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbRegion`](IEngineEnvironmentVariables.md#awsdynamodbregion)
169
+
170
+ ***
171
+
172
+ ### awsDynamodbSecretAccessKey?
173
+
174
+ > `optional` **awsDynamodbSecretAccessKey**: `string`
175
+
176
+ AWS Dynamo DB secret access key.
177
+
178
+ #### Inherited from
179
+
180
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbSecretAccessKey`](IEngineEnvironmentVariables.md#awsdynamodbsecretaccesskey)
181
+
182
+ ***
183
+
184
+ ### awsDynamodbConnectionTimeoutMs?
185
+
186
+ > `optional` **awsDynamodbConnectionTimeoutMs**: `string`
187
+
188
+ AWS Dynamo DB connection timeout.
189
+
190
+ #### Inherited from
191
+
192
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbConnectionTimeoutMs`](IEngineEnvironmentVariables.md#awsdynamodbconnectiontimeoutms)
193
+
194
+ ***
195
+
196
+ ### azureCosmosdbKey?
197
+
198
+ > `optional` **azureCosmosdbKey**: `string`
199
+
200
+ Azure Cosmos DB key.
201
+
202
+ #### Inherited from
203
+
204
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureCosmosdbKey`](IEngineEnvironmentVariables.md#azurecosmosdbkey)
205
+
206
+ ***
207
+
208
+ ### azureCosmosdbContainerId?
209
+
210
+ > `optional` **azureCosmosdbContainerId**: `string`
211
+
212
+ Azure Cosmos DB container id.
213
+
214
+ #### Inherited from
215
+
216
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureCosmosdbContainerId`](IEngineEnvironmentVariables.md#azurecosmosdbcontainerid)
217
+
218
+ ***
219
+
220
+ ### azureCosmosdbDatabaseId?
221
+
222
+ > `optional` **azureCosmosdbDatabaseId**: `string`
223
+
224
+ Azure Cosmos DB database id.
225
+
226
+ #### Inherited from
227
+
228
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureCosmosdbDatabaseId`](IEngineEnvironmentVariables.md#azurecosmosdbdatabaseid)
229
+
230
+ ***
231
+
232
+ ### azureCosmosdbEndpoint?
233
+
234
+ > `optional` **azureCosmosdbEndpoint**: `string`
235
+
236
+ Azure Cosmos DB endpoint.
237
+
238
+ #### Inherited from
239
+
240
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureCosmosdbEndpoint`](IEngineEnvironmentVariables.md#azurecosmosdbendpoint)
241
+
242
+ ***
243
+
244
+ ### gcpFirestoreCollectionName?
245
+
246
+ > `optional` **gcpFirestoreCollectionName**: `string`
247
+
248
+ GCP Firestore collection name.
249
+
250
+ #### Inherited from
251
+
252
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreCollectionName`](IEngineEnvironmentVariables.md#gcpfirestorecollectionname)
253
+
254
+ ***
255
+
256
+ ### gcpFirestoreCredentials?
257
+
258
+ > `optional` **gcpFirestoreCredentials**: `string`
259
+
260
+ GCP Firestore credentials.
261
+
262
+ #### Inherited from
263
+
264
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreCredentials`](IEngineEnvironmentVariables.md#gcpfirestorecredentials)
265
+
266
+ ***
267
+
268
+ ### gcpFirestoreDatabaseId?
269
+
270
+ > `optional` **gcpFirestoreDatabaseId**: `string`
271
+
272
+ GCP Firestore database id.
273
+
274
+ #### Inherited from
275
+
276
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreDatabaseId`](IEngineEnvironmentVariables.md#gcpfirestoredatabaseid)
277
+
278
+ ***
279
+
280
+ ### gcpFirestoreApiEndpoint?
281
+
282
+ > `optional` **gcpFirestoreApiEndpoint**: `string`
283
+
284
+ GCP Firestore endpoint.
285
+
286
+ #### Inherited from
287
+
288
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreApiEndpoint`](IEngineEnvironmentVariables.md#gcpfirestoreapiendpoint)
289
+
290
+ ***
291
+
292
+ ### gcpFirestoreProjectId?
293
+
294
+ > `optional` **gcpFirestoreProjectId**: `string`
295
+
296
+ GCP Firestore project id.
297
+
298
+ #### Inherited from
299
+
300
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreProjectId`](IEngineEnvironmentVariables.md#gcpfirestoreprojectid)
301
+
302
+ ***
303
+
304
+ ### scylladbHosts?
305
+
306
+ > `optional` **scylladbHosts**: `string`
307
+
308
+ ScyllaDB hosts as comma separated string.
309
+
310
+ #### Inherited from
311
+
312
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbHosts`](IEngineEnvironmentVariables.md#scylladbhosts)
313
+
314
+ ***
315
+
316
+ ### scylladbKeyspace?
317
+
318
+ > `optional` **scylladbKeyspace**: `string`
319
+
320
+ ScyllaDB keyspace.
321
+
322
+ #### Inherited from
323
+
324
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbKeyspace`](IEngineEnvironmentVariables.md#scylladbkeyspace)
325
+
326
+ ***
327
+
328
+ ### scylladbLocalDataCenter?
329
+
330
+ > `optional` **scylladbLocalDataCenter**: `string`
331
+
332
+ ScyllaDB local data center.
333
+
334
+ #### Inherited from
335
+
336
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbLocalDataCenter`](IEngineEnvironmentVariables.md#scylladblocaldatacenter)
337
+
338
+ ***
339
+
340
+ ### scylladbPort?
341
+
342
+ > `optional` **scylladbPort**: `string`
343
+
344
+ ScyllaDB port.
345
+
346
+ #### Inherited from
347
+
348
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbPort`](IEngineEnvironmentVariables.md#scylladbport)
349
+
350
+ ***
351
+
352
+ ### mySqlHost?
353
+
354
+ > `optional` **mySqlHost**: `string`
355
+
356
+ MySQL host.
357
+
358
+ #### Inherited from
359
+
360
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlHost`](IEngineEnvironmentVariables.md#mysqlhost)
361
+
362
+ ***
363
+
364
+ ### mySqlPort?
365
+
366
+ > `optional` **mySqlPort**: `number`
367
+
368
+ MySQL port.
369
+
370
+ #### Inherited from
371
+
372
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlPort`](IEngineEnvironmentVariables.md#mysqlport)
373
+
374
+ ***
375
+
376
+ ### mySqlUser?
377
+
378
+ > `optional` **mySqlUser**: `string`
379
+
380
+ MySQL username.
381
+
382
+ #### Inherited from
383
+
384
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlUser`](IEngineEnvironmentVariables.md#mysqluser)
385
+
386
+ ***
387
+
388
+ ### mySqlPassword?
389
+
390
+ > `optional` **mySqlPassword**: `string`
391
+
392
+ MySQL password.
393
+
394
+ #### Inherited from
395
+
396
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlPassword`](IEngineEnvironmentVariables.md#mysqlpassword)
397
+
398
+ ***
399
+
400
+ ### mySqlDatabase?
401
+
402
+ > `optional` **mySqlDatabase**: `string`
403
+
404
+ MySQL Database.
405
+
406
+ #### Inherited from
407
+
408
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlDatabase`](IEngineEnvironmentVariables.md#mysqldatabase)
409
+
410
+ ***
411
+
412
+ ### mongoDbHost?
413
+
414
+ > `optional` **mongoDbHost**: `string`
415
+
416
+ MongoDB host.
417
+
418
+ #### Inherited from
419
+
420
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbHost`](IEngineEnvironmentVariables.md#mongodbhost)
421
+
422
+ ***
423
+
424
+ ### mongoDbPort?
425
+
426
+ > `optional` **mongoDbPort**: `number`
427
+
428
+ MongoDB port.
429
+
430
+ #### Inherited from
431
+
432
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbPort`](IEngineEnvironmentVariables.md#mongodbport)
433
+
434
+ ***
435
+
436
+ ### mongoDbUser?
437
+
438
+ > `optional` **mongoDbUser**: `string`
439
+
440
+ MongoDB username.
441
+
442
+ #### Inherited from
443
+
444
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbUser`](IEngineEnvironmentVariables.md#mongodbuser)
445
+
446
+ ***
447
+
448
+ ### mongoDbPassword?
449
+
450
+ > `optional` **mongoDbPassword**: `string`
451
+
452
+ MongoDB password.
453
+
454
+ #### Inherited from
455
+
456
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbPassword`](IEngineEnvironmentVariables.md#mongodbpassword)
457
+
458
+ ***
459
+
460
+ ### mongoDbDatabase?
461
+
462
+ > `optional` **mongoDbDatabase**: `string`
463
+
464
+ MongoDB Database.
465
+
466
+ #### Inherited from
467
+
468
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbDatabase`](IEngineEnvironmentVariables.md#mongodbdatabase)
469
+
470
+ ***
471
+
472
+ ### postgreSqlHost?
473
+
474
+ > `optional` **postgreSqlHost**: `string`
475
+
476
+ PostgreSQl host.
477
+
478
+ #### Inherited from
479
+
480
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlHost`](IEngineEnvironmentVariables.md#postgresqlhost)
481
+
482
+ ***
483
+
484
+ ### postgreSqlPort?
485
+
486
+ > `optional` **postgreSqlPort**: `number`
487
+
488
+ PostgreSQl port.
489
+
490
+ #### Inherited from
491
+
492
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlPort`](IEngineEnvironmentVariables.md#postgresqlport)
493
+
494
+ ***
495
+
496
+ ### postgreSqlUser?
497
+
498
+ > `optional` **postgreSqlUser**: `string`
499
+
500
+ PostgreSQl username.
501
+
502
+ #### Inherited from
503
+
504
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlUser`](IEngineEnvironmentVariables.md#postgresqluser)
505
+
506
+ ***
507
+
508
+ ### postgreSqlPassword?
509
+
510
+ > `optional` **postgreSqlPassword**: `string`
511
+
512
+ PostgreSQl password.
513
+
514
+ #### Inherited from
515
+
516
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlPassword`](IEngineEnvironmentVariables.md#postgresqlpassword)
517
+
518
+ ***
519
+
520
+ ### postgreSqlDatabase?
521
+
522
+ > `optional` **postgreSqlDatabase**: `string`
523
+
524
+ PostgreSQl Database.
525
+
526
+ #### Inherited from
527
+
528
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlDatabase`](IEngineEnvironmentVariables.md#postgresqldatabase)
529
+
530
+ ***
531
+
532
+ ### ipfsBearerToken?
533
+
534
+ > `optional` **ipfsBearerToken**: `string`
535
+
536
+ The security token for accessing IPFS API.
537
+
538
+ #### Inherited from
539
+
540
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`ipfsBearerToken`](IEngineEnvironmentVariables.md#ipfsbearertoken)
541
+
542
+ ***
543
+
544
+ ### ipfsApiUrl?
545
+
546
+ > `optional` **ipfsApiUrl**: `string`
547
+
548
+ The url for accessing IPFS API.
549
+
550
+ #### Inherited from
551
+
552
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`ipfsApiUrl`](IEngineEnvironmentVariables.md#ipfsapiurl)
553
+
554
+ ***
555
+
556
+ ### blobStorageConnectorType?
557
+
558
+ > `optional` **blobStorageConnectorType**: `string`
559
+
560
+ The type of the entity storage to create, comma separate for more than one connector.
561
+ values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
562
+
563
+ #### Inherited from
564
+
565
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorType`](IEngineEnvironmentVariables.md#blobstorageconnectortype)
566
+
567
+ ***
568
+
569
+ ### blobStorageConnectorDefault?
570
+
571
+ > `optional` **blobStorageConnectorDefault**: `string`
572
+
573
+ The default blob storage connector to use, defaults to the first one in the list.
574
+
575
+ #### Inherited from
576
+
577
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorDefault`](IEngineEnvironmentVariables.md#blobstorageconnectordefault)
578
+
579
+ ***
580
+
581
+ ### blobStorageConnectorPublic?
582
+
583
+ > `optional` **blobStorageConnectorPublic**: `string`
584
+
585
+ Blog storage connector which has public access.
586
+
587
+ #### Inherited from
588
+
589
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorPublic`](IEngineEnvironmentVariables.md#blobstorageconnectorpublic)
590
+
591
+ ***
592
+
593
+ ### blobStorageEnableEncryption?
594
+
595
+ > `optional` **blobStorageEnableEncryption**: `string`
596
+
597
+ Enable encryption for the blob storage.
598
+
599
+ #### Inherited from
600
+
601
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageEnableEncryption`](IEngineEnvironmentVariables.md#blobstorageenableencryption)
602
+
603
+ ***
604
+
605
+ ### blobStorageEncryptionKeyId?
606
+
607
+ > `optional` **blobStorageEncryptionKeyId**: `string`
608
+
609
+ The id of the encryption key for the blob storage.
610
+
611
+ #### Inherited from
612
+
613
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageEncryptionKeyId`](IEngineEnvironmentVariables.md#blobstorageencryptionkeyid)
614
+
615
+ ***
616
+
617
+ ### blobStoragePrefix?
618
+
619
+ > `optional` **blobStoragePrefix**: `string`
620
+
621
+ A prefix for all the blobs in blob-storage, can be empty.
622
+
623
+ #### Inherited from
624
+
625
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStoragePrefix`](IEngineEnvironmentVariables.md#blobstorageprefix)
626
+
627
+ ***
628
+
629
+ ### awsS3Region?
630
+
631
+ > `optional` **awsS3Region**: `string`
632
+
633
+ AWS S3 region.
634
+
635
+ #### Inherited from
636
+
637
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Region`](IEngineEnvironmentVariables.md#awss3region)
638
+
639
+ ***
640
+
641
+ ### awsS3BucketName?
642
+
643
+ > `optional` **awsS3BucketName**: `string`
644
+
645
+ AWS S3 bucket name.
646
+
647
+ #### Inherited from
648
+
649
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3BucketName`](IEngineEnvironmentVariables.md#awss3bucketname)
650
+
651
+ ***
652
+
653
+ ### awsS3AuthMode?
654
+
655
+ > `optional` **awsS3AuthMode**: `string`
656
+
657
+ AWS S3 auth mode, either credentials or pod, defaults to credentials.
658
+
659
+ #### Inherited from
660
+
661
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3AuthMode`](IEngineEnvironmentVariables.md#awss3authmode)
662
+
663
+ ***
664
+
665
+ ### awsS3AccessKeyId?
666
+
667
+ > `optional` **awsS3AccessKeyId**: `string`
668
+
669
+ AWS S3 access key id.
670
+
671
+ #### Inherited from
672
+
673
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3AccessKeyId`](IEngineEnvironmentVariables.md#awss3accesskeyid)
674
+
675
+ ***
676
+
677
+ ### awsS3SecretAccessKey?
678
+
679
+ > `optional` **awsS3SecretAccessKey**: `string`
680
+
681
+ AWS S3 secret access key.
682
+
683
+ #### Inherited from
684
+
685
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3SecretAccessKey`](IEngineEnvironmentVariables.md#awss3secretaccesskey)
686
+
687
+ ***
688
+
689
+ ### awsS3Endpoint?
690
+
691
+ > `optional` **awsS3Endpoint**: `string`
692
+
693
+ AWS S3 endpoint.
694
+
695
+ #### Inherited from
696
+
697
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Endpoint`](IEngineEnvironmentVariables.md#awss3endpoint)
698
+
699
+ ***
700
+
701
+ ### azureStorageAccountKey?
702
+
703
+ > `optional` **azureStorageAccountKey**: `string`
704
+
705
+ Azure Storage account key.
706
+
707
+ #### Inherited from
708
+
709
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureStorageAccountKey`](IEngineEnvironmentVariables.md#azurestorageaccountkey)
710
+
711
+ ***
712
+
713
+ ### azureStorageAccountName?
714
+
715
+ > `optional` **azureStorageAccountName**: `string`
716
+
717
+ Azure Storage account name.
718
+
719
+ #### Inherited from
720
+
721
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureStorageAccountName`](IEngineEnvironmentVariables.md#azurestorageaccountname)
722
+
723
+ ***
724
+
725
+ ### azureStorageContainerName?
726
+
727
+ > `optional` **azureStorageContainerName**: `string`
728
+
729
+ Azure Storage container.
730
+
731
+ #### Inherited from
732
+
733
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureStorageContainerName`](IEngineEnvironmentVariables.md#azurestoragecontainername)
734
+
735
+ ***
736
+
737
+ ### azureStorageEndpoint?
738
+
739
+ > `optional` **azureStorageEndpoint**: `string`
740
+
741
+ Azure Storage endpoint.
742
+
743
+ #### Inherited from
744
+
745
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureStorageEndpoint`](IEngineEnvironmentVariables.md#azurestorageendpoint)
746
+
747
+ ***
748
+
749
+ ### gcpStorageBucketName?
750
+
751
+ > `optional` **gcpStorageBucketName**: `string`
752
+
753
+ GCP Storage bucket.
754
+
755
+ #### Inherited from
756
+
757
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpStorageBucketName`](IEngineEnvironmentVariables.md#gcpstoragebucketname)
758
+
759
+ ***
760
+
761
+ ### gcpStorageCredentials?
762
+
763
+ > `optional` **gcpStorageCredentials**: `string`
764
+
765
+ GCP Storage credentials.
766
+
767
+ #### Inherited from
768
+
769
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpStorageCredentials`](IEngineEnvironmentVariables.md#gcpstoragecredentials)
770
+
771
+ ***
772
+
773
+ ### gcpStorageEndpoint?
774
+
775
+ > `optional` **gcpStorageEndpoint**: `string`
776
+
777
+ GCP Storage endpoint.
778
+
779
+ #### Inherited from
780
+
781
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpStorageEndpoint`](IEngineEnvironmentVariables.md#gcpstorageendpoint)
782
+
783
+ ***
784
+
785
+ ### gcpStorageProjectId?
786
+
787
+ > `optional` **gcpStorageProjectId**: `string`
788
+
789
+ GCP Storage project id.
790
+
791
+ #### Inherited from
792
+
793
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpStorageProjectId`](IEngineEnvironmentVariables.md#gcpstorageprojectid)
794
+
795
+ ***
796
+
797
+ ### vaultConnector?
798
+
799
+ > `optional` **vaultConnector**: `string`
800
+
801
+ The type of the default vault connector: entity-storage, hashicorp.
802
+
803
+ #### Inherited from
804
+
805
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`vaultConnector`](IEngineEnvironmentVariables.md#vaultconnector)
806
+
807
+ ***
808
+
809
+ ### hashicorpVaultToken?
810
+
811
+ > `optional` **hashicorpVaultToken**: `string`
812
+
813
+ Hashicorp Vault token.
814
+
815
+ #### Inherited from
816
+
817
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`hashicorpVaultToken`](IEngineEnvironmentVariables.md#hashicorpvaulttoken)
818
+
819
+ ***
820
+
821
+ ### hashicorpVaultEndpoint?
822
+
823
+ > `optional` **hashicorpVaultEndpoint**: `string`
824
+
825
+ Hashicorp Vault endpoint.
826
+
827
+ #### Inherited from
828
+
829
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`hashicorpVaultEndpoint`](IEngineEnvironmentVariables.md#hashicorpvaultendpoint)
830
+
831
+ ***
832
+
833
+ ### loggingConnector?
834
+
835
+ > `optional` **loggingConnector**: `string`
836
+
837
+ The type of logging task connector, can be a comma separated list: console, entity-storage.
838
+
839
+ #### Inherited from
840
+
841
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`loggingConnector`](IEngineEnvironmentVariables.md#loggingconnector)
842
+
843
+ ***
844
+
845
+ ### eventBusConnector?
846
+
847
+ > `optional` **eventBusConnector**: `string`
848
+
849
+ The type of event bus connector: local.
850
+
851
+ #### Inherited from
852
+
853
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`eventBusConnector`](IEngineEnvironmentVariables.md#eventbusconnector)
854
+
855
+ ***
856
+
857
+ ### eventBusComponent?
858
+
859
+ > `optional` **eventBusComponent**: `string`
860
+
861
+ The type of event bus component: service.
862
+
863
+ #### Inherited from
864
+
865
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`eventBusComponent`](IEngineEnvironmentVariables.md#eventbuscomponent)
866
+
867
+ ***
868
+
869
+ ### messagingEnabled?
870
+
871
+ > `optional` **messagingEnabled**: `string`
872
+
873
+ Are the messaging components enabled, defaults to false.
874
+
875
+ #### Inherited from
876
+
877
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingEnabled`](IEngineEnvironmentVariables.md#messagingenabled)
878
+
879
+ ***
880
+
881
+ ### awsSesRegion?
882
+
883
+ > `optional` **awsSesRegion**: `string`
884
+
885
+ AWS SES region.
886
+
887
+ #### Inherited from
888
+
889
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesRegion`](IEngineEnvironmentVariables.md#awssesregion)
890
+
891
+ ***
892
+
893
+ ### awsSesAuthMode?
894
+
895
+ > `optional` **awsSesAuthMode**: `string`
896
+
897
+ AWS SES auth mode, either credentials or pod, defaults to credentials.
898
+
899
+ #### Inherited from
900
+
901
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesAuthMode`](IEngineEnvironmentVariables.md#awssesauthmode)
902
+
903
+ ***
904
+
905
+ ### awsSesSecretAccessKey?
906
+
907
+ > `optional` **awsSesSecretAccessKey**: `string`
908
+
909
+ AWS SES secret access key.
910
+
911
+ #### Inherited from
912
+
913
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesSecretAccessKey`](IEngineEnvironmentVariables.md#awssessecretaccesskey)
914
+
915
+ ***
916
+
917
+ ### awsSesAccessKeyId?
918
+
919
+ > `optional` **awsSesAccessKeyId**: `string`
920
+
921
+ AWS SES access key id.
922
+
923
+ #### Inherited from
924
+
925
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesAccessKeyId`](IEngineEnvironmentVariables.md#awssesaccesskeyid)
926
+
927
+ ***
928
+
929
+ ### awsSesEndpoint?
930
+
931
+ > `optional` **awsSesEndpoint**: `string`
932
+
933
+ AWS SES endpoint.
934
+
935
+ #### Inherited from
936
+
937
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesEndpoint`](IEngineEnvironmentVariables.md#awssesendpoint)
938
+
939
+ ***
940
+
941
+ ### awsMessagingPushNotificationApplications?
942
+
943
+ > `optional` **awsMessagingPushNotificationApplications**: `string`
944
+
945
+ The applications for the push notifications JSON stringified array of IAwsApplicationSettings.
946
+
947
+ #### Inherited from
948
+
949
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsMessagingPushNotificationApplications`](IEngineEnvironmentVariables.md#awsmessagingpushnotificationapplications)
950
+
951
+ ***
952
+
953
+ ### messagingEmailConnector?
954
+
955
+ > `optional` **messagingEmailConnector**: `string`
956
+
957
+ The type of messaging email connector: entity-storage, aws.
958
+
959
+ #### Inherited from
960
+
961
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingEmailConnector`](IEngineEnvironmentVariables.md#messagingemailconnector)
962
+
963
+ ***
964
+
965
+ ### messagingSmsConnector?
966
+
967
+ > `optional` **messagingSmsConnector**: `string`
968
+
969
+ The type of messaging sms connector: entity-storage, aws.
970
+
971
+ #### Inherited from
972
+
973
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingSmsConnector`](IEngineEnvironmentVariables.md#messagingsmsconnector)
974
+
975
+ ***
976
+
977
+ ### messagingPushNotificationConnector?
978
+
979
+ > `optional` **messagingPushNotificationConnector**: `string`
980
+
981
+ The type of messaging push notification connector: entity-storage, aws.
982
+
983
+ #### Inherited from
984
+
985
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingPushNotificationConnector`](IEngineEnvironmentVariables.md#messagingpushnotificationconnector)
986
+
987
+ ***
988
+
989
+ ### telemetryConnector?
990
+
991
+ > `optional` **telemetryConnector**: `string`
992
+
993
+ The type of telemetry connector: entity-storage.
994
+
995
+ #### Inherited from
996
+
997
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`telemetryConnector`](IEngineEnvironmentVariables.md#telemetryconnector)
998
+
999
+ ***
1000
+
1001
+ ### faucetConnector?
1002
+
1003
+ > `optional` **faucetConnector**: `string`
1004
+
1005
+ The type of faucet connector: entity-storage, iota.
1006
+
1007
+ #### Inherited from
1008
+
1009
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`faucetConnector`](IEngineEnvironmentVariables.md#faucetconnector)
1010
+
1011
+ ***
1012
+
1013
+ ### walletConnector?
1014
+
1015
+ > `optional` **walletConnector**: `string`
1016
+
1017
+ The type of wallet connector: entity-storage, iota.
1018
+
1019
+ #### Inherited from
1020
+
1021
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`walletConnector`](IEngineEnvironmentVariables.md#walletconnector)
1022
+
1023
+ ***
1024
+
1025
+ ### nftConnector?
1026
+
1027
+ > `optional` **nftConnector**: `string`
1028
+
1029
+ The type of NFT connector: entity-storage, iota.
1030
+
1031
+ #### Inherited from
1032
+
1033
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`nftConnector`](IEngineEnvironmentVariables.md#nftconnector)
1034
+
1035
+ ***
1036
+
1037
+ ### identityConnector?
1038
+
1039
+ > `optional` **identityConnector**: `string`
1040
+
1041
+ The type of identity connector: entity-storage, iota.
1042
+
1043
+ #### Inherited from
1044
+
1045
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityConnector`](IEngineEnvironmentVariables.md#identityconnector)
1046
+
1047
+ ***
1048
+
1049
+ ### identityWalletAddressIndex?
1050
+
1051
+ > `optional` **identityWalletAddressIndex**: `string`
1052
+
1053
+ The index of the wallet address to use, defaults to 0.
1054
+
1055
+ #### Inherited from
1056
+
1057
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityWalletAddressIndex`](IEngineEnvironmentVariables.md#identitywalletaddressindex)
1058
+
1059
+ ***
1060
+
1061
+ ### identityResolverConnector?
1062
+
1063
+ > `optional` **identityResolverConnector**: `string`
1064
+
1065
+ The type of identity resolver connector: entity-storage, iota.
1066
+
1067
+ #### Inherited from
1068
+
1069
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityResolverConnector`](IEngineEnvironmentVariables.md#identityresolverconnector)
1070
+
1071
+ ***
1072
+
1073
+ ### verifiableStorageConnector?
1074
+
1075
+ > `optional` **verifiableStorageConnector**: `string`
1076
+
1077
+ The type of verifiable storage connector: entity-storage, iota.
1078
+
1079
+ #### Inherited from
1080
+
1081
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`verifiableStorageConnector`](IEngineEnvironmentVariables.md#verifiablestorageconnector)
1082
+
1083
+ ***
1084
+
1085
+ ### iotaFaucetEndpoint?
1086
+
1087
+ > `optional` **iotaFaucetEndpoint**: `string`
1088
+
1089
+ IOTA Faucet Endpoint.
1090
+
1091
+ #### Inherited from
1092
+
1093
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaFaucetEndpoint`](IEngineEnvironmentVariables.md#iotafaucetendpoint)
1094
+
1095
+ ***
1096
+
1097
+ ### iotaNodeEndpoint?
1098
+
1099
+ > `optional` **iotaNodeEndpoint**: `string`
1100
+
1101
+ IOTA Node Endpoint.
1102
+
1103
+ #### Inherited from
1104
+
1105
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaNodeEndpoint`](IEngineEnvironmentVariables.md#iotanodeendpoint)
1106
+
1107
+ ***
1108
+
1109
+ ### iotaNetwork?
1110
+
1111
+ > `optional` **iotaNetwork**: `string`
1112
+
1113
+ IOTA network.
1114
+
1115
+ #### Inherited from
1116
+
1117
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaNetwork`](IEngineEnvironmentVariables.md#iotanetwork)
1118
+
1119
+ ***
1120
+
1121
+ ### iotaCoinType?
1122
+
1123
+ > `optional` **iotaCoinType**: `string`
1124
+
1125
+ IOTA coin type.
1126
+
1127
+ #### Inherited from
1128
+
1129
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaCoinType`](IEngineEnvironmentVariables.md#iotacointype)
1130
+
1131
+ ***
1132
+
1133
+ ### iotaExplorerEndpoint?
1134
+
1135
+ > `optional` **iotaExplorerEndpoint**: `string`
1136
+
1137
+ IOTA Explorer Endpoint.
1138
+
1139
+ #### Inherited from
1140
+
1141
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaExplorerEndpoint`](IEngineEnvironmentVariables.md#iotaexplorerendpoint)
1142
+
1143
+ ***
1144
+
1145
+ ### iotaGasStationEndpoint?
1146
+
1147
+ > `optional` **iotaGasStationEndpoint**: `string`
1148
+
1149
+ IOTA Gas Station Endpoint.
1150
+
1151
+ #### Inherited from
1152
+
1153
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaGasStationEndpoint`](IEngineEnvironmentVariables.md#iotagasstationendpoint)
1154
+
1155
+ ***
1156
+
1157
+ ### iotaGasStationAuthToken?
1158
+
1159
+ > `optional` **iotaGasStationAuthToken**: `string`
1160
+
1161
+ IOTA Gas Station Authentication Token.
1162
+
1163
+ #### Inherited from
1164
+
1165
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaGasStationAuthToken`](IEngineEnvironmentVariables.md#iotagasstationauthtoken)
1166
+
1167
+ ***
1168
+
1169
+ ### universalResolverEndpoint?
1170
+
1171
+ > `optional` **universalResolverEndpoint**: `string`
1172
+
1173
+ Universal Resolver Endpoint.
1174
+
1175
+ #### Inherited from
1176
+
1177
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`universalResolverEndpoint`](IEngineEnvironmentVariables.md#universalresolverendpoint)
1178
+
1179
+ ***
1180
+
1181
+ ### identityProfileConnector?
1182
+
1183
+ > `optional` **identityProfileConnector**: `string`
1184
+
1185
+ The type of identity profile connector: entity-storage.
1186
+
1187
+ #### Inherited from
1188
+
1189
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityProfileConnector`](IEngineEnvironmentVariables.md#identityprofileconnector)
1190
+
1191
+ ***
1192
+
1193
+ ### immutableProofVerificationMethodId?
1194
+
1195
+ > `optional` **immutableProofVerificationMethodId**: `string`
1196
+
1197
+ The identity verification method id to use with immutable proofs.
1198
+
1199
+ #### Inherited from
1200
+
1201
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`immutableProofVerificationMethodId`](IEngineEnvironmentVariables.md#immutableproofverificationmethodid)
1202
+
1203
+ ***
1204
+
1205
+ ### attestationConnector?
1206
+
1207
+ > `optional` **attestationConnector**: `string`
1208
+
1209
+ The type of attestation connector: entity-storage, iota.
1210
+
1211
+ #### Inherited from
1212
+
1213
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`attestationConnector`](IEngineEnvironmentVariables.md#attestationconnector)
1214
+
1215
+ ***
1216
+
1217
+ ### attestationVerificationMethodId?
1218
+
1219
+ > `optional` **attestationVerificationMethodId**: `string`
1220
+
1221
+ The identity verification method id to use with attestation.
1222
+
1223
+ #### Inherited from
1224
+
1225
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`attestationVerificationMethodId`](IEngineEnvironmentVariables.md#attestationverificationmethodid)
1226
+
1227
+ ***
1228
+
1229
+ ### dataProcessingEnabled?
1230
+
1231
+ > `optional` **dataProcessingEnabled**: `string`
1232
+
1233
+ Is the data processing enabled, defaults to false.
1234
+
1235
+ #### Inherited from
1236
+
1237
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataProcessingEnabled`](IEngineEnvironmentVariables.md#dataprocessingenabled)
1238
+
1239
+ ***
1240
+
1241
+ ### dataConverterConnectors?
1242
+
1243
+ > `optional` **dataConverterConnectors**: `string`
1244
+
1245
+ The type of the default data converters, can be a comma separated list: json, xml.
1246
+
1247
+ #### Inherited from
1248
+
1249
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataConverterConnectors`](IEngineEnvironmentVariables.md#dataconverterconnectors)
1250
+
1251
+ ***
1252
+
1253
+ ### dataExtractorConnectors?
1254
+
1255
+ > `optional` **dataExtractorConnectors**: `string`
1256
+
1257
+ The type of the default data extractor, can be a comma separated list: json-path.
1258
+
1259
+ #### Inherited from
1260
+
1261
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataExtractorConnectors`](IEngineEnvironmentVariables.md#dataextractorconnectors)
1262
+
1263
+ ***
1264
+
1265
+ ### auditableItemGraphEnabled?
1266
+
1267
+ > `optional` **auditableItemGraphEnabled**: `string`
1268
+
1269
+ Is the auditable item graph enabled, defaults to false.
1270
+
1271
+ #### Inherited from
1272
+
1273
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`auditableItemGraphEnabled`](IEngineEnvironmentVariables.md#auditableitemgraphenabled)
1274
+
1275
+ ***
1276
+
1277
+ ### auditableItemStreamEnabled?
1278
+
1279
+ > `optional` **auditableItemStreamEnabled**: `string`
1280
+
1281
+ Is the auditable item stream enabled, defaults to false.
1282
+
1283
+ #### Inherited from
1284
+
1285
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`auditableItemStreamEnabled`](IEngineEnvironmentVariables.md#auditableitemstreamenabled)
8
1286
 
9
- ## Properties
1287
+ ***
1288
+
1289
+ ### documentManagementEnabled?
1290
+
1291
+ > `optional` **documentManagementEnabled**: `string`
1292
+
1293
+ Is the document management enabled, defaults to false.
1294
+
1295
+ #### Inherited from
1296
+
1297
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`documentManagementEnabled`](IEngineEnvironmentVariables.md#documentmanagementenabled)
1298
+
1299
+ ***
1300
+
1301
+ ### synchronisedStorageEnabled?
1302
+
1303
+ > `optional` **synchronisedStorageEnabled**: `string`
1304
+
1305
+ Is the synchronised storage enabled, defaults to false.
1306
+
1307
+ #### Inherited from
1308
+
1309
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageEnabled`](IEngineEnvironmentVariables.md#synchronisedstorageenabled)
1310
+
1311
+ ***
1312
+
1313
+ ### synchronisedStorageTrustedUrl?
1314
+
1315
+ > `optional` **synchronisedStorageTrustedUrl**: `string`
1316
+
1317
+ Url which points to the api for a trusted synchronised storage node, not required if this is a trusted node.
1318
+
1319
+ #### Inherited from
1320
+
1321
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageTrustedUrl`](IEngineEnvironmentVariables.md#synchronisedstoragetrustedurl)
1322
+
1323
+ ***
1324
+
1325
+ ### synchronisedStorageVerifiableStorageKeyId?
1326
+
1327
+ > `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
1328
+
1329
+ The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
1330
+ This only required if using a custom verifiable storage item, otherwise it will default to the network name.
1331
+
1332
+ #### Inherited from
1333
+
1334
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageVerifiableStorageKeyId`](IEngineEnvironmentVariables.md#synchronisedstorageverifiablestoragekeyid)
1335
+
1336
+ ***
1337
+
1338
+ ### synchronisedStorageBlobStorageEncryptionKeyId?
1339
+
1340
+ > `optional` **synchronisedStorageBlobStorageEncryptionKeyId**: `string`
1341
+
1342
+ The key from the vault which is used to encrypt the synchronised storage blobs.
1343
+ Only required for trusted nodes, as regular nodes will request from the trusted nodes.
1344
+ Defaults to synchronised-storage-blob-encryption
1345
+
1346
+ #### Inherited from
1347
+
1348
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageBlobStorageEncryptionKeyId`](IEngineEnvironmentVariables.md#synchronisedstorageblobstorageencryptionkeyid)
1349
+
1350
+ ***
1351
+
1352
+ ### synchronisedStorageBlobStorageKey?
1353
+
1354
+ > `optional` **synchronisedStorageBlobStorageKey**: `string`
1355
+
1356
+ The key used for blob encryption, should be ChaCha20Poly1305 encoded as base64.
1357
+ Only required for trusted nodes, as regular nodes will not write encrypted data.
1358
+
1359
+ #### Inherited from
1360
+
1361
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageBlobStorageKey`](IEngineEnvironmentVariables.md#synchronisedstorageblobstoragekey)
1362
+
1363
+ ***
1364
+
1365
+ ### synchronisedStorageEntityUpdateIntervalMinutes?
1366
+
1367
+ > `optional` **synchronisedStorageEntityUpdateIntervalMinutes**: `string`
1368
+
1369
+ How often to check for entity updates in minutes.
1370
+
1371
+ #### Default
1372
+
1373
+ ```ts
1374
+ 5
1375
+ ```
1376
+
1377
+ #### Inherited from
1378
+
1379
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageEntityUpdateIntervalMinutes`](IEngineEnvironmentVariables.md#synchronisedstorageentityupdateintervalminutes)
1380
+
1381
+ ***
1382
+
1383
+ ### synchronisedStorageConsolidationIntervalMinutes?
1384
+
1385
+ > `optional` **synchronisedStorageConsolidationIntervalMinutes**: `string`
1386
+
1387
+ Interval to perform consolidation of changesets, only used if this is a trusted node.
1388
+
1389
+ #### Default
1390
+
1391
+ ```ts
1392
+ 60
1393
+ ```
1394
+
1395
+ #### Inherited from
1396
+
1397
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageConsolidationIntervalMinutes`](IEngineEnvironmentVariables.md#synchronisedstorageconsolidationintervalminutes)
1398
+
1399
+ ***
1400
+
1401
+ ### synchronisedStorageConsolidationBatchSize?
1402
+
1403
+ > `optional` **synchronisedStorageConsolidationBatchSize**: `string`
1404
+
1405
+ The number of entities to process in a single consolidation batch, only used if this is a trusted node.
1406
+
1407
+ #### Default
1408
+
1409
+ ```ts
1410
+ 1000
1411
+ ```
1412
+
1413
+ #### Inherited from
1414
+
1415
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageConsolidationBatchSize`](IEngineEnvironmentVariables.md#synchronisedstorageconsolidationbatchsize)
1416
+
1417
+ ***
1418
+
1419
+ ### synchronisedStorageMaxConsolidations?
1420
+
1421
+ > `optional` **synchronisedStorageMaxConsolidations**: `string`
1422
+
1423
+ The maximum number of consolidations to keep in storage, only used if this is a trusted node.
1424
+
1425
+ #### Default
1426
+
1427
+ ```ts
1428
+ 5
1429
+ ```
1430
+
1431
+ #### Inherited from
1432
+
1433
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageMaxConsolidations`](IEngineEnvironmentVariables.md#synchronisedstoragemaxconsolidations)
1434
+
1435
+ ***
1436
+
1437
+ ### federatedCatalogueEnabled?
1438
+
1439
+ > `optional` **federatedCatalogueEnabled**: `string`
1440
+
1441
+ Is the federated catalogue enabled, defaults to false.
1442
+
1443
+ #### Inherited from
1444
+
1445
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueEnabled`](IEngineEnvironmentVariables.md#federatedcatalogueenabled)
1446
+
1447
+ ***
1448
+
1449
+ ### federatedCatalogueFilters?
1450
+
1451
+ > `optional` **federatedCatalogueFilters**: `string`
1452
+
1453
+ Federated catalog filters, command separated list of filters to add.
1454
+
1455
+ #### Inherited from
1456
+
1457
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueFilters`](IEngineEnvironmentVariables.md#federatedcataloguefilters)
1458
+
1459
+ ***
1460
+
1461
+ ### trustEnabled?
1462
+
1463
+ > `optional` **trustEnabled**: `string`
1464
+
1465
+ Is the trust management enabled, defaults to false.
1466
+
1467
+ #### Inherited from
1468
+
1469
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustEnabled`](IEngineEnvironmentVariables.md#trustenabled)
1470
+
1471
+ ***
1472
+
1473
+ ### trustGenerators?
1474
+
1475
+ > `optional` **trustGenerators**: `string`
1476
+
1477
+ The trust generators to add to the factory, comma separated list.
1478
+
1479
+ #### Inherited from
1480
+
1481
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustGenerators`](IEngineEnvironmentVariables.md#trustgenerators)
1482
+
1483
+ ***
1484
+
1485
+ ### trustVerifiers?
1486
+
1487
+ > `optional` **trustVerifiers**: `string`
1488
+
1489
+ The trust verifiers to add to the factory, comma separated list.
1490
+
1491
+ #### Inherited from
1492
+
1493
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustVerifiers`](IEngineEnvironmentVariables.md#trustverifiers)
1494
+
1495
+ ***
1496
+
1497
+ ### trustVerificationMethodId?
1498
+
1499
+ > `optional` **trustVerificationMethodId**: `string`
1500
+
1501
+ The verification method to use for trust identities.
1502
+ Defaults to node-authentication-assertion.
1503
+
1504
+ #### Inherited from
1505
+
1506
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustVerificationMethodId`](IEngineEnvironmentVariables.md#trustverificationmethodid)
1507
+
1508
+ ***
1509
+
1510
+ ### rightsManagementEnabled?
1511
+
1512
+ > `optional` **rightsManagementEnabled**: `string`
1513
+
1514
+ Is the rights management enabled, defaults to false.
1515
+
1516
+ #### Inherited from
1517
+
1518
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementEnabled`](IEngineEnvironmentVariables.md#rightsmanagementenabled)
1519
+
1520
+ ***
1521
+
1522
+ ### rightsManagementBaseCallbackUrl?
1523
+
1524
+ > `optional` **rightsManagementBaseCallbackUrl**: `string`
1525
+
1526
+ What is the base callback url for rights management negotiations e.g. https://my-node/rights-management.
1527
+
1528
+ #### Inherited from
1529
+
1530
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementBaseCallbackUrl`](IEngineEnvironmentVariables.md#rightsmanagementbasecallbackurl)
1531
+
1532
+ ***
1533
+
1534
+ ### rightsManagementPolicyInformationSources?
1535
+
1536
+ > `optional` **rightsManagementPolicyInformationSources**: `string`
1537
+
1538
+ The rights management policy information sources to add to the factory.
1539
+
1540
+ #### Inherited from
1541
+
1542
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyInformationSources`](IEngineEnvironmentVariables.md#rightsmanagementpolicyinformationsources)
1543
+
1544
+ ***
1545
+
1546
+ ### rightsManagementPolicyNegotiators?
1547
+
1548
+ > `optional` **rightsManagementPolicyNegotiators**: `string`
1549
+
1550
+ The rights management policy negotiators sources to add to the factory.
1551
+
1552
+ #### Inherited from
1553
+
1554
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyNegotiators`](IEngineEnvironmentVariables.md#rightsmanagementpolicynegotiators)
1555
+
1556
+ ***
1557
+
1558
+ ### rightsManagementPolicyRequesters?
1559
+
1560
+ > `optional` **rightsManagementPolicyRequesters**: `string`
1561
+
1562
+ The rights management policy requesters to add to the factory.
1563
+
1564
+ #### Inherited from
1565
+
1566
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyRequesters`](IEngineEnvironmentVariables.md#rightsmanagementpolicyrequesters)
1567
+
1568
+ ***
1569
+
1570
+ ### rightsManagementPolicyExecutionActions?
1571
+
1572
+ > `optional` **rightsManagementPolicyExecutionActions**: `string`
1573
+
1574
+ The rights management policy execution actions to add to the factory.
1575
+
1576
+ #### Inherited from
1577
+
1578
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyExecutionActions`](IEngineEnvironmentVariables.md#rightsmanagementpolicyexecutionactions)
1579
+
1580
+ ***
1581
+
1582
+ ### rightsManagementPolicyEnforcementProcessors?
1583
+
1584
+ > `optional` **rightsManagementPolicyEnforcementProcessors**: `string`
1585
+
1586
+ The rights management policy enforcement processors to add to the factory.
1587
+
1588
+ #### Inherited from
1589
+
1590
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyEnforcementProcessors`](IEngineEnvironmentVariables.md#rightsmanagementpolicyenforcementprocessors)
1591
+
1592
+ ***
1593
+
1594
+ ### rightsManagementPolicyArbiters?
1595
+
1596
+ > `optional` **rightsManagementPolicyArbiters**: `string`
1597
+
1598
+ The rights management policy arbiters to add to the factory.
1599
+
1600
+ #### Inherited from
1601
+
1602
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyArbiters`](IEngineEnvironmentVariables.md#rightsmanagementpolicyarbiters)
1603
+
1604
+ ***
1605
+
1606
+ ### rightsManagementDataAccessHandlers?
1607
+
1608
+ > `optional` **rightsManagementDataAccessHandlers**: `string`
1609
+
1610
+ The rights management data access handlers to add to the factory.
1611
+
1612
+ #### Inherited from
1613
+
1614
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementDataAccessHandlers`](IEngineEnvironmentVariables.md#rightsmanagementdataaccesshandlers)
1615
+
1616
+ ***
1617
+
1618
+ ### backgroundTasksEnabled?
1619
+
1620
+ > `optional` **backgroundTasksEnabled**: `string`
1621
+
1622
+ Are background tasks enabled, defaults to false.
1623
+
1624
+ #### Inherited from
1625
+
1626
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`backgroundTasksEnabled`](IEngineEnvironmentVariables.md#backgroundtasksenabled)
1627
+
1628
+ ***
1629
+
1630
+ ### taskSchedulerEnabled?
1631
+
1632
+ > `optional` **taskSchedulerEnabled**: `string`
1633
+
1634
+ Is the task scheduler enabled, defaults to false.
1635
+
1636
+ #### Inherited from
1637
+
1638
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`taskSchedulerEnabled`](IEngineEnvironmentVariables.md#taskschedulerenabled)
1639
+
1640
+ ***
1641
+
1642
+ ### dataSpaceConnectorEnabled?
1643
+
1644
+ > `optional` **dataSpaceConnectorEnabled**: `string`
1645
+
1646
+ Is the data space connector enabled, defaults to false.
1647
+
1648
+ #### Inherited from
1649
+
1650
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorEnabled`](IEngineEnvironmentVariables.md#dataspaceconnectorenabled)
1651
+
1652
+ ***
1653
+
1654
+ ### dataSpaceConnectorRetainActivityLogsFor?
1655
+
1656
+ > `optional` **dataSpaceConnectorRetainActivityLogsFor**: `string`
1657
+
1658
+ The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
1659
+
1660
+ #### Default
1661
+
1662
+ ```ts
1663
+ 10
1664
+ ```
1665
+
1666
+ #### Inherited from
1667
+
1668
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorRetainActivityLogsFor`](IEngineEnvironmentVariables.md#dataspaceconnectorretainactivitylogsfor)
1669
+
1670
+ ***
1671
+
1672
+ ### dataSpaceConnectorActivityLogsCleanUpInterval?
1673
+
1674
+ > `optional` **dataSpaceConnectorActivityLogsCleanUpInterval**: `string`
1675
+
1676
+ The interval for cleaning up the activity logs.
1677
+
1678
+ #### Default
1679
+
1680
+ ```ts
1681
+ 60
1682
+ ```
1683
+
1684
+ #### Inherited from
1685
+
1686
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorActivityLogsCleanUpInterval`](IEngineEnvironmentVariables.md#dataspaceconnectoractivitylogscleanupinterval)
1687
+
1688
+ ***
1689
+
1690
+ ### vcAuthenticationEnabled?
1691
+
1692
+ > `optional` **vcAuthenticationEnabled**: `string`
1693
+
1694
+ Enable verifiable credential authentication for the API.
1695
+
1696
+ #### Inherited from
1697
+
1698
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`vcAuthenticationEnabled`](IEngineEnvironmentVariables.md#vcauthenticationenabled)
1699
+
1700
+ ***
1701
+
1702
+ ### vcAuthenticationVerificationMethodId?
1703
+
1704
+ > `optional` **vcAuthenticationVerificationMethodId**: `string`
1705
+
1706
+ Verifiable credential assertion for node to node communication.
1707
+ Defaults to node-authentication-assertion.
1708
+
1709
+ #### Inherited from
1710
+
1711
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`vcAuthenticationVerificationMethodId`](IEngineEnvironmentVariables.md#vcauthenticationverificationmethodid)
1712
+
1713
+ ***
1714
+
1715
+ ### extensions?
1716
+
1717
+ > `optional` **extensions**: `string`
1718
+
1719
+ A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
1720
+
1721
+ #### Inherited from
1722
+
1723
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`extensions`](IEngineEnvironmentVariables.md#extensions)
1724
+
1725
+ ***
10
1726
 
11
1727
  ### port?
12
1728
 
@@ -88,8 +1804,24 @@ Additional MIME type processors to include, comma separated.
88
1804
 
89
1805
  ***
90
1806
 
91
- ### disableNodeIdentity?
1807
+ ### routeLoggingIncludeBody?
1808
+
1809
+ > `optional` **routeLoggingIncludeBody**: `string`
1810
+
1811
+ Include the body in the REST logging output, useful for debugging.
1812
+
1813
+ ***
1814
+
1815
+ ### routeLoggingFullBase64?
1816
+
1817
+ > `optional` **routeLoggingFullBase64**: `string`
1818
+
1819
+ Include the full base 64 output in the REST logging output, useful for debugging.
1820
+
1821
+ ***
1822
+
1823
+ ### routeLoggingObfuscateProperties?
92
1824
 
93
- > `optional` **disableNodeIdentity**: `string`
1825
+ > `optional` **routeLoggingObfuscateProperties**: `string`
94
1826
 
95
- Disable Node Identity route processors.
1827
+ List of properties to obfuscate in the REST logging output, comma separated.