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

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 (52) hide show
  1. package/dist/cjs/index.cjs +864 -391
  2. package/dist/esm/index.mjs +852 -394
  3. package/dist/types/bootstrap.d.ts +9 -9
  4. package/dist/types/builders/engineEnvBuilder.d.ts +1 -1
  5. package/dist/types/builders/engineServerEnvBuilder.d.ts +3 -2
  6. package/dist/types/builders/extensionsBuilder.d.ts +32 -0
  7. package/dist/types/defaults.d.ts +6 -0
  8. package/dist/types/index.d.ts +4 -0
  9. package/dist/types/models/IEngineEnvironmentVariables.d.ts +188 -24
  10. package/dist/types/models/IEngineServerEnvironmentVariables.d.ts +12 -3
  11. package/dist/types/models/INodeEngineConfig.d.ts +6 -0
  12. package/dist/types/models/INodeEnvironmentVariables.d.ts +1 -2
  13. package/dist/types/models/INodeOptions.d.ts +6 -1
  14. package/dist/types/models/nodeExtensionMethods.d.ts +27 -0
  15. package/dist/types/models/nodeFeatures.d.ts +4 -0
  16. package/dist/types/node.d.ts +7 -2
  17. package/dist/types/server.d.ts +4 -2
  18. package/dist/types/utils.d.ts +24 -0
  19. package/docs/changelog.md +138 -0
  20. package/docs/reference/functions/{bootstrapAttestationMethod.md → bootstrapSynchronisedStorage.md} +3 -3
  21. package/docs/reference/functions/buildConfiguration.md +2 -2
  22. package/docs/reference/functions/buildEngineConfiguration.md +2 -2
  23. package/docs/reference/functions/buildEngineServerConfiguration.md +9 -3
  24. package/docs/reference/functions/directoryExists.md +19 -0
  25. package/docs/reference/functions/extensionsConfiguration.md +25 -0
  26. package/docs/reference/functions/extensionsInitialiseEngine.md +25 -0
  27. package/docs/reference/functions/extensionsInitialiseEngineServer.md +31 -0
  28. package/docs/reference/functions/getFiles.md +19 -0
  29. package/docs/reference/functions/getSubFolders.md +19 -0
  30. package/docs/reference/functions/loadTextFile.md +19 -0
  31. package/docs/reference/functions/overrideModuleImport.md +17 -0
  32. package/docs/reference/functions/shutdownExtensions.md +25 -0
  33. package/docs/reference/functions/start.md +4 -4
  34. package/docs/reference/index.md +21 -1
  35. package/docs/reference/interfaces/IEngineEnvironmentVariables.md +374 -36
  36. package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +1673 -5
  37. package/docs/reference/interfaces/INodeEngineConfig.md +7 -0
  38. package/docs/reference/interfaces/INodeEnvironmentVariables.md +643 -137
  39. package/docs/reference/interfaces/INodeOptions.md +14 -2
  40. package/docs/reference/type-aliases/NodeExtensionInitialiseEngineMethod.md +18 -0
  41. package/docs/reference/type-aliases/NodeExtensionInitialiseEngineServerMethod.md +24 -0
  42. package/docs/reference/type-aliases/NodeExtensionInitialiseMethod.md +23 -0
  43. package/docs/reference/type-aliases/NodeExtensionShutdownMethod.md +10 -0
  44. package/docs/reference/variables/ATTESTATION_VERIFICATION_METHOD_ID.md +3 -0
  45. package/docs/reference/variables/AUTH_SIGNING_KEY_ID.md +3 -0
  46. package/docs/reference/variables/BLOB_STORAGE_ENCRYPTION_KEY_ID.md +3 -0
  47. package/docs/reference/variables/IMMUTABLE_PROOF_VERIFICATION_METHOD_ID.md +3 -0
  48. package/docs/reference/variables/NodeFeatures.md +7 -1
  49. package/docs/reference/variables/SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID.md +3 -0
  50. package/docs/reference/variables/VC_AUTHENTICATION_VERIFICATION_METHOD_ID.md +3 -0
  51. package/locales/en.json +15 -7
  52. package/package.json +18 -2
package/docs/reference/interfaces/INodeEnvironmentVariables.md CHANGED
@@ -4,7 +4,7 @@ The environment variables for the node.
4
4
 
5
5
  ## Extends
6
6
 
7
- - [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md)
7
+ - [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md)
8
8
 
9
9
  ## Properties
10
10
 
@@ -16,7 +16,7 @@ Start the engine in debug mode.
16
16
 
17
17
  #### Inherited from
18
18
 
19
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`debug`](IEngineEnvironmentVariables.md#debug)
19
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`debug`](IEngineServerEnvironmentVariables.md#debug)
20
20
 
21
21
  ***
22
22
 
@@ -28,7 +28,7 @@ The root directory for storing items like state file.
28
28
 
29
29
  #### Inherited from
30
30
 
31
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`storageFileRoot`](IEngineEnvironmentVariables.md#storagefileroot)
31
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`storageFileRoot`](IEngineServerEnvironmentVariables.md#storagefileroot)
32
32
 
33
33
  ***
34
34
 
@@ -40,7 +40,7 @@ The name of the state file.
40
40
 
41
41
  #### Inherited from
42
42
 
43
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`stateFilename`](IEngineEnvironmentVariables.md#statefilename)
43
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`stateFilename`](IEngineServerEnvironmentVariables.md#statefilename)
44
44
 
45
45
  ***
46
46
 
@@ -53,7 +53,7 @@ values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, m
53
53
 
54
54
  #### Inherited from
55
55
 
56
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageConnectorType`](IEngineEnvironmentVariables.md#entitystorageconnectortype)
56
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`entityStorageConnectorType`](IEngineServerEnvironmentVariables.md#entitystorageconnectortype)
57
57
 
58
58
  ***
59
59
 
@@ -65,31 +65,31 @@ The default entity storage connector to use, defaults to the first one in the li
65
65
 
66
66
  #### Inherited from
67
67
 
68
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageConnectorDefault`](IEngineEnvironmentVariables.md#entitystorageconnectordefault)
68
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`entityStorageConnectorDefault`](IEngineServerEnvironmentVariables.md#entitystorageconnectordefault)
69
69
 
70
70
  ***
71
71
 
72
- ### entityStorageConnectorDecentralised?
72
+ ### entityStorageTablePrefix?
73
73
 
74
- > `optional` **entityStorageConnectorDecentralised**: `string`
74
+ > `optional` **entityStorageTablePrefix**: `string`
75
75
 
76
- Entity storage connector for decentralized storage
76
+ A prefix for all the table in entity-storage, can be empty.
77
77
 
78
78
  #### Inherited from
79
79
 
80
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageConnectorDecentralised`](IEngineEnvironmentVariables.md#entitystorageconnectordecentralised)
80
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`entityStorageTablePrefix`](IEngineServerEnvironmentVariables.md#entitystoragetableprefix)
81
81
 
82
82
  ***
83
83
 
84
- ### entityStorageTablePrefix?
84
+ ### awsDynamodbAuthMode?
85
85
 
86
- > `optional` **entityStorageTablePrefix**: `string`
86
+ > `optional` **awsDynamodbAuthMode**: `string`
87
87
 
88
- A prefix for all the table in entity-storage, can be empty.
88
+ AWS DynamoDB auth mode, either credentials or pod.
89
89
 
90
90
  #### Inherited from
91
91
 
92
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageTablePrefix`](IEngineEnvironmentVariables.md#entitystoragetableprefix)
92
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbAuthMode`](IEngineServerEnvironmentVariables.md#awsdynamodbauthmode)
93
93
 
94
94
  ***
95
95
 
@@ -101,7 +101,7 @@ AWS Dynamo DB access key id.
101
101
 
102
102
  #### Inherited from
103
103
 
104
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbAccessKeyId`](IEngineEnvironmentVariables.md#awsdynamodbaccesskeyid)
104
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbAccessKeyId`](IEngineServerEnvironmentVariables.md#awsdynamodbaccesskeyid)
105
105
 
106
106
  ***
107
107
 
@@ -113,7 +113,7 @@ AWS Dynamo DB Endpoint if running local instance.
113
113
 
114
114
  #### Inherited from
115
115
 
116
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbEndpoint`](IEngineEnvironmentVariables.md#awsdynamodbendpoint)
116
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbEndpoint`](IEngineServerEnvironmentVariables.md#awsdynamodbendpoint)
117
117
 
118
118
  ***
119
119
 
@@ -125,7 +125,7 @@ AWS Dynamo DB region.
125
125
 
126
126
  #### Inherited from
127
127
 
128
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbRegion`](IEngineEnvironmentVariables.md#awsdynamodbregion)
128
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbRegion`](IEngineServerEnvironmentVariables.md#awsdynamodbregion)
129
129
 
130
130
  ***
131
131
 
@@ -137,7 +137,7 @@ AWS Dynamo DB secret access key.
137
137
 
138
138
  #### Inherited from
139
139
 
140
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbSecretAccessKey`](IEngineEnvironmentVariables.md#awsdynamodbsecretaccesskey)
140
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbSecretAccessKey`](IEngineServerEnvironmentVariables.md#awsdynamodbsecretaccesskey)
141
141
 
142
142
  ***
143
143
 
@@ -149,7 +149,7 @@ Azure Cosmos DB key.
149
149
 
150
150
  #### Inherited from
151
151
 
152
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureCosmosdbKey`](IEngineEnvironmentVariables.md#azurecosmosdbkey)
152
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureCosmosdbKey`](IEngineServerEnvironmentVariables.md#azurecosmosdbkey)
153
153
 
154
154
  ***
155
155
 
@@ -161,7 +161,7 @@ Azure Cosmos DB container id.
161
161
 
162
162
  #### Inherited from
163
163
 
164
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureCosmosdbContainerId`](IEngineEnvironmentVariables.md#azurecosmosdbcontainerid)
164
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureCosmosdbContainerId`](IEngineServerEnvironmentVariables.md#azurecosmosdbcontainerid)
165
165
 
166
166
  ***
167
167
 
@@ -173,7 +173,7 @@ Azure Cosmos DB database id.
173
173
 
174
174
  #### Inherited from
175
175
 
176
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureCosmosdbDatabaseId`](IEngineEnvironmentVariables.md#azurecosmosdbdatabaseid)
176
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureCosmosdbDatabaseId`](IEngineServerEnvironmentVariables.md#azurecosmosdbdatabaseid)
177
177
 
178
178
  ***
179
179
 
@@ -185,7 +185,7 @@ Azure Cosmos DB endpoint.
185
185
 
186
186
  #### Inherited from
187
187
 
188
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureCosmosdbEndpoint`](IEngineEnvironmentVariables.md#azurecosmosdbendpoint)
188
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureCosmosdbEndpoint`](IEngineServerEnvironmentVariables.md#azurecosmosdbendpoint)
189
189
 
190
190
  ***
191
191
 
@@ -197,7 +197,7 @@ GCP Firestore collection name.
197
197
 
198
198
  #### Inherited from
199
199
 
200
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreCollectionName`](IEngineEnvironmentVariables.md#gcpfirestorecollectionname)
200
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreCollectionName`](IEngineServerEnvironmentVariables.md#gcpfirestorecollectionname)
201
201
 
202
202
  ***
203
203
 
@@ -209,7 +209,7 @@ GCP Firestore credentials.
209
209
 
210
210
  #### Inherited from
211
211
 
212
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreCredentials`](IEngineEnvironmentVariables.md#gcpfirestorecredentials)
212
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreCredentials`](IEngineServerEnvironmentVariables.md#gcpfirestorecredentials)
213
213
 
214
214
  ***
215
215
 
@@ -221,7 +221,7 @@ GCP Firestore database id.
221
221
 
222
222
  #### Inherited from
223
223
 
224
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreDatabaseId`](IEngineEnvironmentVariables.md#gcpfirestoredatabaseid)
224
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreDatabaseId`](IEngineServerEnvironmentVariables.md#gcpfirestoredatabaseid)
225
225
 
226
226
  ***
227
227
 
@@ -233,7 +233,7 @@ GCP Firestore endpoint.
233
233
 
234
234
  #### Inherited from
235
235
 
236
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreApiEndpoint`](IEngineEnvironmentVariables.md#gcpfirestoreapiendpoint)
236
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreApiEndpoint`](IEngineServerEnvironmentVariables.md#gcpfirestoreapiendpoint)
237
237
 
238
238
  ***
239
239
 
@@ -245,7 +245,7 @@ GCP Firestore project id.
245
245
 
246
246
  #### Inherited from
247
247
 
248
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreProjectId`](IEngineEnvironmentVariables.md#gcpfirestoreprojectid)
248
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreProjectId`](IEngineServerEnvironmentVariables.md#gcpfirestoreprojectid)
249
249
 
250
250
  ***
251
251
 
@@ -257,7 +257,7 @@ ScyllaDB hosts as comma separated string.
257
257
 
258
258
  #### Inherited from
259
259
 
260
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbHosts`](IEngineEnvironmentVariables.md#scylladbhosts)
260
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`scylladbHosts`](IEngineServerEnvironmentVariables.md#scylladbhosts)
261
261
 
262
262
  ***
263
263
 
@@ -269,7 +269,7 @@ ScyllaDB keyspace.
269
269
 
270
270
  #### Inherited from
271
271
 
272
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbKeyspace`](IEngineEnvironmentVariables.md#scylladbkeyspace)
272
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`scylladbKeyspace`](IEngineServerEnvironmentVariables.md#scylladbkeyspace)
273
273
 
274
274
  ***
275
275
 
@@ -281,7 +281,7 @@ ScyllaDB local data center.
281
281
 
282
282
  #### Inherited from
283
283
 
284
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbLocalDataCenter`](IEngineEnvironmentVariables.md#scylladblocaldatacenter)
284
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`scylladbLocalDataCenter`](IEngineServerEnvironmentVariables.md#scylladblocaldatacenter)
285
285
 
286
286
  ***
287
287
 
@@ -293,7 +293,7 @@ ScyllaDB port.
293
293
 
294
294
  #### Inherited from
295
295
 
296
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbPort`](IEngineEnvironmentVariables.md#scylladbport)
296
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`scylladbPort`](IEngineServerEnvironmentVariables.md#scylladbport)
297
297
 
298
298
  ***
299
299
 
@@ -305,7 +305,7 @@ MySQL host.
305
305
 
306
306
  #### Inherited from
307
307
 
308
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlHost`](IEngineEnvironmentVariables.md#mysqlhost)
308
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlHost`](IEngineServerEnvironmentVariables.md#mysqlhost)
309
309
 
310
310
  ***
311
311
 
@@ -317,7 +317,7 @@ MySQL port.
317
317
 
318
318
  #### Inherited from
319
319
 
320
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlPort`](IEngineEnvironmentVariables.md#mysqlport)
320
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlPort`](IEngineServerEnvironmentVariables.md#mysqlport)
321
321
 
322
322
  ***
323
323
 
@@ -329,7 +329,7 @@ MySQL username.
329
329
 
330
330
  #### Inherited from
331
331
 
332
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlUser`](IEngineEnvironmentVariables.md#mysqluser)
332
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlUser`](IEngineServerEnvironmentVariables.md#mysqluser)
333
333
 
334
334
  ***
335
335
 
@@ -341,7 +341,7 @@ MySQL password.
341
341
 
342
342
  #### Inherited from
343
343
 
344
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlPassword`](IEngineEnvironmentVariables.md#mysqlpassword)
344
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlPassword`](IEngineServerEnvironmentVariables.md#mysqlpassword)
345
345
 
346
346
  ***
347
347
 
@@ -353,7 +353,7 @@ MySQL Database.
353
353
 
354
354
  #### Inherited from
355
355
 
356
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlDatabase`](IEngineEnvironmentVariables.md#mysqldatabase)
356
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlDatabase`](IEngineServerEnvironmentVariables.md#mysqldatabase)
357
357
 
358
358
  ***
359
359
 
@@ -365,7 +365,7 @@ MongoDB host.
365
365
 
366
366
  #### Inherited from
367
367
 
368
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbHost`](IEngineEnvironmentVariables.md#mongodbhost)
368
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbHost`](IEngineServerEnvironmentVariables.md#mongodbhost)
369
369
 
370
370
  ***
371
371
 
@@ -377,7 +377,7 @@ MongoDB port.
377
377
 
378
378
  #### Inherited from
379
379
 
380
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbPort`](IEngineEnvironmentVariables.md#mongodbport)
380
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbPort`](IEngineServerEnvironmentVariables.md#mongodbport)
381
381
 
382
382
  ***
383
383
 
@@ -389,7 +389,7 @@ MongoDB username.
389
389
 
390
390
  #### Inherited from
391
391
 
392
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbUser`](IEngineEnvironmentVariables.md#mongodbuser)
392
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbUser`](IEngineServerEnvironmentVariables.md#mongodbuser)
393
393
 
394
394
  ***
395
395
 
@@ -401,7 +401,7 @@ MongoDB password.
401
401
 
402
402
  #### Inherited from
403
403
 
404
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbPassword`](IEngineEnvironmentVariables.md#mongodbpassword)
404
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbPassword`](IEngineServerEnvironmentVariables.md#mongodbpassword)
405
405
 
406
406
  ***
407
407
 
@@ -413,7 +413,7 @@ MongoDB Database.
413
413
 
414
414
  #### Inherited from
415
415
 
416
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbDatabase`](IEngineEnvironmentVariables.md#mongodbdatabase)
416
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbDatabase`](IEngineServerEnvironmentVariables.md#mongodbdatabase)
417
417
 
418
418
  ***
419
419
 
@@ -425,7 +425,7 @@ PostgreSQl host.
425
425
 
426
426
  #### Inherited from
427
427
 
428
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlHost`](IEngineEnvironmentVariables.md#postgresqlhost)
428
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlHost`](IEngineServerEnvironmentVariables.md#postgresqlhost)
429
429
 
430
430
  ***
431
431
 
@@ -437,7 +437,7 @@ PostgreSQl port.
437
437
 
438
438
  #### Inherited from
439
439
 
440
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlPort`](IEngineEnvironmentVariables.md#postgresqlport)
440
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlPort`](IEngineServerEnvironmentVariables.md#postgresqlport)
441
441
 
442
442
  ***
443
443
 
@@ -449,7 +449,7 @@ PostgreSQl username.
449
449
 
450
450
  #### Inherited from
451
451
 
452
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlUser`](IEngineEnvironmentVariables.md#postgresqluser)
452
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlUser`](IEngineServerEnvironmentVariables.md#postgresqluser)
453
453
 
454
454
  ***
455
455
 
@@ -461,7 +461,7 @@ PostgreSQl password.
461
461
 
462
462
  #### Inherited from
463
463
 
464
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlPassword`](IEngineEnvironmentVariables.md#postgresqlpassword)
464
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlPassword`](IEngineServerEnvironmentVariables.md#postgresqlpassword)
465
465
 
466
466
  ***
467
467
 
@@ -473,7 +473,7 @@ PostgreSQl Database.
473
473
 
474
474
  #### Inherited from
475
475
 
476
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlDatabase`](IEngineEnvironmentVariables.md#postgresqldatabase)
476
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlDatabase`](IEngineServerEnvironmentVariables.md#postgresqldatabase)
477
477
 
478
478
  ***
479
479
 
@@ -485,7 +485,7 @@ The security token for accessing IPFS API.
485
485
 
486
486
  #### Inherited from
487
487
 
488
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`ipfsBearerToken`](IEngineEnvironmentVariables.md#ipfsbearertoken)
488
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`ipfsBearerToken`](IEngineServerEnvironmentVariables.md#ipfsbearertoken)
489
489
 
490
490
  ***
491
491
 
@@ -497,7 +497,7 @@ The url for accessing IPFS API.
497
497
 
498
498
  #### Inherited from
499
499
 
500
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`ipfsApiUrl`](IEngineEnvironmentVariables.md#ipfsapiurl)
500
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`ipfsApiUrl`](IEngineServerEnvironmentVariables.md#ipfsapiurl)
501
501
 
502
502
  ***
503
503
 
@@ -510,7 +510,7 @@ values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
510
510
 
511
511
  #### Inherited from
512
512
 
513
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorType`](IEngineEnvironmentVariables.md#blobstorageconnectortype)
513
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageConnectorType`](IEngineServerEnvironmentVariables.md#blobstorageconnectortype)
514
514
 
515
515
  ***
516
516
 
@@ -522,19 +522,19 @@ The default blob storage connector to use, defaults to the first one in the list
522
522
 
523
523
  #### Inherited from
524
524
 
525
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorDefault`](IEngineEnvironmentVariables.md#blobstorageconnectordefault)
525
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageConnectorDefault`](IEngineServerEnvironmentVariables.md#blobstorageconnectordefault)
526
526
 
527
527
  ***
528
528
 
529
- ### blobStorageConnectorDecentralised?
529
+ ### blobStorageConnectorPublic?
530
530
 
531
- > `optional` **blobStorageConnectorDecentralised**: `string`
531
+ > `optional` **blobStorageConnectorPublic**: `string`
532
532
 
533
- Blog storage connector for decentralized storage
533
+ Blog storage connector which has public access.
534
534
 
535
535
  #### Inherited from
536
536
 
537
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorDecentralised`](IEngineEnvironmentVariables.md#blobstorageconnectordecentralised)
537
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageConnectorPublic`](IEngineServerEnvironmentVariables.md#blobstorageconnectorpublic)
538
538
 
539
539
  ***
540
540
 
@@ -546,19 +546,32 @@ Enable encryption for the blob storage.
546
546
 
547
547
  #### Inherited from
548
548
 
549
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageEnableEncryption`](IEngineEnvironmentVariables.md#blobstorageenableencryption)
549
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageEnableEncryption`](IEngineServerEnvironmentVariables.md#blobstorageenableencryption)
550
+
551
+ ***
552
+
553
+ ### blobStorageEncryptionKeyId?
554
+
555
+ > `optional` **blobStorageEncryptionKeyId**: `string`
556
+
557
+ The id of the encryption key for the blob storage.
558
+
559
+ #### Inherited from
560
+
561
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageEncryptionKeyId`](IEngineServerEnvironmentVariables.md#blobstorageencryptionkeyid)
550
562
 
551
563
  ***
552
564
 
553
- ### blobStorageEncryptionKey?
565
+ ### blobStorageSymmetricEncryptionKey?
554
566
 
555
- > `optional` **blobStorageEncryptionKey**: `string`
567
+ > `optional` **blobStorageSymmetricEncryptionKey**: `string`
556
568
 
557
- The encryption key for the blob storage.
569
+ A symmetric encryption key for the blob storage, should be ChaCha20Poly1305 in base64 format.
570
+ If encryption is enabled but a key is not provided one will be generated.
558
571
 
559
572
  #### Inherited from
560
573
 
561
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageEncryptionKey`](IEngineEnvironmentVariables.md#blobstorageencryptionkey)
574
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageSymmetricEncryptionKey`](IEngineServerEnvironmentVariables.md#blobstoragesymmetricencryptionkey)
562
575
 
563
576
  ***
564
577
 
@@ -570,19 +583,19 @@ A prefix for all the blobs in blob-storage, can be empty.
570
583
 
571
584
  #### Inherited from
572
585
 
573
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStoragePrefix`](IEngineEnvironmentVariables.md#blobstorageprefix)
586
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStoragePrefix`](IEngineServerEnvironmentVariables.md#blobstorageprefix)
574
587
 
575
588
  ***
576
589
 
577
- ### awsS3AccessKeyId?
590
+ ### awsS3Region?
578
591
 
579
- > `optional` **awsS3AccessKeyId**: `string`
592
+ > `optional` **awsS3Region**: `string`
580
593
 
581
- AWS S3 access key id.
594
+ AWS S3 region.
582
595
 
583
596
  #### Inherited from
584
597
 
585
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3AccessKeyId`](IEngineEnvironmentVariables.md#awss3accesskeyid)
598
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3Region`](IEngineServerEnvironmentVariables.md#awss3region)
586
599
 
587
600
  ***
588
601
 
@@ -594,31 +607,31 @@ AWS S3 bucket name.
594
607
 
595
608
  #### Inherited from
596
609
 
597
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3BucketName`](IEngineEnvironmentVariables.md#awss3bucketname)
610
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3BucketName`](IEngineServerEnvironmentVariables.md#awss3bucketname)
598
611
 
599
612
  ***
600
613
 
601
- ### awsS3Endpoint?
614
+ ### awsS3AuthMode?
602
615
 
603
- > `optional` **awsS3Endpoint**: `string`
616
+ > `optional` **awsS3AuthMode**: `string`
604
617
 
605
- AWS S3 endpoint.
618
+ AWS S3 auth mode, either credentials or pod, defaults to credentials.
606
619
 
607
620
  #### Inherited from
608
621
 
609
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Endpoint`](IEngineEnvironmentVariables.md#awss3endpoint)
622
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3AuthMode`](IEngineServerEnvironmentVariables.md#awss3authmode)
610
623
 
611
624
  ***
612
625
 
613
- ### awsS3Region?
626
+ ### awsS3AccessKeyId?
614
627
 
615
- > `optional` **awsS3Region**: `string`
628
+ > `optional` **awsS3AccessKeyId**: `string`
616
629
 
617
- AWS S3 region.
630
+ AWS S3 access key id.
618
631
 
619
632
  #### Inherited from
620
633
 
621
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Region`](IEngineEnvironmentVariables.md#awss3region)
634
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3AccessKeyId`](IEngineServerEnvironmentVariables.md#awss3accesskeyid)
622
635
 
623
636
  ***
624
637
 
@@ -630,7 +643,19 @@ AWS S3 secret access key.
630
643
 
631
644
  #### Inherited from
632
645
 
633
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3SecretAccessKey`](IEngineEnvironmentVariables.md#awss3secretaccesskey)
646
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3SecretAccessKey`](IEngineServerEnvironmentVariables.md#awss3secretaccesskey)
647
+
648
+ ***
649
+
650
+ ### awsS3Endpoint?
651
+
652
+ > `optional` **awsS3Endpoint**: `string`
653
+
654
+ AWS S3 endpoint.
655
+
656
+ #### Inherited from
657
+
658
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3Endpoint`](IEngineServerEnvironmentVariables.md#awss3endpoint)
634
659
 
635
660
  ***
636
661
 
@@ -642,7 +667,7 @@ Azure Storage account key.
642
667
 
643
668
  #### Inherited from
644
669
 
645
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureStorageAccountKey`](IEngineEnvironmentVariables.md#azurestorageaccountkey)
670
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureStorageAccountKey`](IEngineServerEnvironmentVariables.md#azurestorageaccountkey)
646
671
 
647
672
  ***
648
673
 
@@ -654,7 +679,7 @@ Azure Storage account name.
654
679
 
655
680
  #### Inherited from
656
681
 
657
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureStorageAccountName`](IEngineEnvironmentVariables.md#azurestorageaccountname)
682
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureStorageAccountName`](IEngineServerEnvironmentVariables.md#azurestorageaccountname)
658
683
 
659
684
  ***
660
685
 
@@ -666,7 +691,7 @@ Azure Storage container.
666
691
 
667
692
  #### Inherited from
668
693
 
669
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureStorageContainerName`](IEngineEnvironmentVariables.md#azurestoragecontainername)
694
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureStorageContainerName`](IEngineServerEnvironmentVariables.md#azurestoragecontainername)
670
695
 
671
696
  ***
672
697
 
@@ -678,7 +703,7 @@ Azure Storage endpoint.
678
703
 
679
704
  #### Inherited from
680
705
 
681
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureStorageEndpoint`](IEngineEnvironmentVariables.md#azurestorageendpoint)
706
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureStorageEndpoint`](IEngineServerEnvironmentVariables.md#azurestorageendpoint)
682
707
 
683
708
  ***
684
709
 
@@ -690,7 +715,7 @@ GCP Storage bucket.
690
715
 
691
716
  #### Inherited from
692
717
 
693
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpStorageBucketName`](IEngineEnvironmentVariables.md#gcpstoragebucketname)
718
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpStorageBucketName`](IEngineServerEnvironmentVariables.md#gcpstoragebucketname)
694
719
 
695
720
  ***
696
721
 
@@ -702,7 +727,7 @@ GCP Storage credentials.
702
727
 
703
728
  #### Inherited from
704
729
 
705
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpStorageCredentials`](IEngineEnvironmentVariables.md#gcpstoragecredentials)
730
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpStorageCredentials`](IEngineServerEnvironmentVariables.md#gcpstoragecredentials)
706
731
 
707
732
  ***
708
733
 
@@ -714,7 +739,7 @@ GCP Storage endpoint.
714
739
 
715
740
  #### Inherited from
716
741
 
717
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpStorageEndpoint`](IEngineEnvironmentVariables.md#gcpstorageendpoint)
742
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpStorageEndpoint`](IEngineServerEnvironmentVariables.md#gcpstorageendpoint)
718
743
 
719
744
  ***
720
745
 
@@ -726,7 +751,7 @@ GCP Storage project id.
726
751
 
727
752
  #### Inherited from
728
753
 
729
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpStorageProjectId`](IEngineEnvironmentVariables.md#gcpstorageprojectid)
754
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpStorageProjectId`](IEngineServerEnvironmentVariables.md#gcpstorageprojectid)
730
755
 
731
756
  ***
732
757
 
@@ -738,7 +763,7 @@ The type of the default vault connector: entity-storage, hashicorp.
738
763
 
739
764
  #### Inherited from
740
765
 
741
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`vaultConnector`](IEngineEnvironmentVariables.md#vaultconnector)
766
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`vaultConnector`](IEngineServerEnvironmentVariables.md#vaultconnector)
742
767
 
743
768
  ***
744
769
 
@@ -750,7 +775,7 @@ Hashicorp Vault token.
750
775
 
751
776
  #### Inherited from
752
777
 
753
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`hashicorpVaultToken`](IEngineEnvironmentVariables.md#hashicorpvaulttoken)
778
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`hashicorpVaultToken`](IEngineServerEnvironmentVariables.md#hashicorpvaulttoken)
754
779
 
755
780
  ***
756
781
 
@@ -762,7 +787,7 @@ Hashicorp Vault endpoint.
762
787
 
763
788
  #### Inherited from
764
789
 
765
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`hashicorpVaultEndpoint`](IEngineEnvironmentVariables.md#hashicorpvaultendpoint)
790
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`hashicorpVaultEndpoint`](IEngineServerEnvironmentVariables.md#hashicorpvaultendpoint)
766
791
 
767
792
  ***
768
793
 
@@ -770,11 +795,11 @@ Hashicorp Vault endpoint.
770
795
 
771
796
  > `optional` **loggingConnector**: `string`
772
797
 
773
- The type of background task connector, can be a comma separated list: console, entity-storage.
798
+ The type of logging task connector, can be a comma separated list: console, entity-storage.
774
799
 
775
800
  #### Inherited from
776
801
 
777
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`loggingConnector`](IEngineEnvironmentVariables.md#loggingconnector)
802
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`loggingConnector`](IEngineServerEnvironmentVariables.md#loggingconnector)
778
803
 
779
804
  ***
780
805
 
@@ -786,7 +811,7 @@ The type of background task connector: entity-storage.
786
811
 
787
812
  #### Inherited from
788
813
 
789
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`backgroundTaskConnector`](IEngineEnvironmentVariables.md#backgroundtaskconnector)
814
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`backgroundTaskConnector`](IEngineServerEnvironmentVariables.md#backgroundtaskconnector)
790
815
 
791
816
  ***
792
817
 
@@ -798,7 +823,7 @@ The type of event bus connector: local.
798
823
 
799
824
  #### Inherited from
800
825
 
801
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`eventBusConnector`](IEngineEnvironmentVariables.md#eventbusconnector)
826
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`eventBusConnector`](IEngineServerEnvironmentVariables.md#eventbusconnector)
802
827
 
803
828
  ***
804
829
 
@@ -810,43 +835,92 @@ The type of event bus component: service.
810
835
 
811
836
  #### Inherited from
812
837
 
813
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`eventBusComponent`](IEngineEnvironmentVariables.md#eventbuscomponent)
838
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`eventBusComponent`](IEngineServerEnvironmentVariables.md#eventbuscomponent)
814
839
 
815
840
  ***
816
841
 
817
- ### messagingEmailConnector?
842
+ ### messagingEnabled?
818
843
 
819
- > `optional` **messagingEmailConnector**: `string`
844
+ > `optional` **messagingEnabled**: `string`
820
845
 
821
- The type of messaging email connector: entity-storage, aws.
846
+ Are the messaging components enabled, defaults to false.
822
847
 
823
848
  #### Inherited from
824
849
 
825
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingEmailConnector`](IEngineEnvironmentVariables.md#messagingemailconnector)
850
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingEnabled`](IEngineServerEnvironmentVariables.md#messagingenabled)
826
851
 
827
852
  ***
828
853
 
829
- ### messagingSmsConnector?
854
+ ### messagingTemplates?
830
855
 
831
- > `optional` **messagingSmsConnector**: `string`
856
+ > `optional` **messagingTemplates**: `string`
832
857
 
833
- The type of messaging sms connector: entity-storage, aws.
858
+ An initial set of templates for the messages.
859
+ Use the @json: prefix to specify the path to the JSON file.
834
860
 
835
861
  #### Inherited from
836
862
 
837
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingSmsConnector`](IEngineEnvironmentVariables.md#messagingsmsconnector)
863
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingTemplates`](IEngineServerEnvironmentVariables.md#messagingtemplates)
838
864
 
839
865
  ***
840
866
 
841
- ### messagingPushNotificationConnector?
867
+ ### awsSesRegion?
842
868
 
843
- > `optional` **messagingPushNotificationConnector**: `string`
869
+ > `optional` **awsSesRegion**: `string`
844
870
 
845
- The type of messaging push notification connector: entity-storage, aws.
871
+ AWS SES region.
872
+
873
+ #### Inherited from
874
+
875
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesRegion`](IEngineServerEnvironmentVariables.md#awssesregion)
876
+
877
+ ***
878
+
879
+ ### awsSesAuthMode?
880
+
881
+ > `optional` **awsSesAuthMode**: `string`
882
+
883
+ AWS SES auth mode, either credentials or pod, defaults to credentials.
884
+
885
+ #### Inherited from
886
+
887
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesAuthMode`](IEngineServerEnvironmentVariables.md#awssesauthmode)
888
+
889
+ ***
890
+
891
+ ### awsSesSecretAccessKey?
892
+
893
+ > `optional` **awsSesSecretAccessKey**: `string`
894
+
895
+ AWS SES secret access key.
846
896
 
847
897
  #### Inherited from
848
898
 
849
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingPushNotificationConnector`](IEngineEnvironmentVariables.md#messagingpushnotificationconnector)
899
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesSecretAccessKey`](IEngineServerEnvironmentVariables.md#awssessecretaccesskey)
900
+
901
+ ***
902
+
903
+ ### awsSesAccessKeyId?
904
+
905
+ > `optional` **awsSesAccessKeyId**: `string`
906
+
907
+ AWS SES access key id.
908
+
909
+ #### Inherited from
910
+
911
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesAccessKeyId`](IEngineServerEnvironmentVariables.md#awssesaccesskeyid)
912
+
913
+ ***
914
+
915
+ ### awsSesEndpoint?
916
+
917
+ > `optional` **awsSesEndpoint**: `string`
918
+
919
+ AWS SES endpoint.
920
+
921
+ #### Inherited from
922
+
923
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesEndpoint`](IEngineServerEnvironmentVariables.md#awssesendpoint)
850
924
 
851
925
  ***
852
926
 
@@ -858,19 +932,43 @@ The applications for the push notifications JSON stringified array of IAwsApplic
858
932
 
859
933
  #### Inherited from
860
934
 
861
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsMessagingPushNotificationApplications`](IEngineEnvironmentVariables.md#awsmessagingpushnotificationapplications)
935
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsMessagingPushNotificationApplications`](IEngineServerEnvironmentVariables.md#awsmessagingpushnotificationapplications)
936
+
937
+ ***
938
+
939
+ ### messagingEmailConnector?
940
+
941
+ > `optional` **messagingEmailConnector**: `string`
942
+
943
+ The type of messaging email connector: entity-storage, aws.
944
+
945
+ #### Inherited from
946
+
947
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingEmailConnector`](IEngineServerEnvironmentVariables.md#messagingemailconnector)
948
+
949
+ ***
950
+
951
+ ### messagingSmsConnector?
952
+
953
+ > `optional` **messagingSmsConnector**: `string`
954
+
955
+ The type of messaging sms connector: entity-storage, aws.
956
+
957
+ #### Inherited from
958
+
959
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingSmsConnector`](IEngineServerEnvironmentVariables.md#messagingsmsconnector)
862
960
 
863
961
  ***
864
962
 
865
- ### messagingComponent?
963
+ ### messagingPushNotificationConnector?
866
964
 
867
- > `optional` **messagingComponent**: `string`
965
+ > `optional` **messagingPushNotificationConnector**: `string`
868
966
 
869
- The type of messaging component: service.
967
+ The type of messaging push notification connector: entity-storage, aws.
870
968
 
871
969
  #### Inherited from
872
970
 
873
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingComponent`](IEngineEnvironmentVariables.md#messagingcomponent)
971
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingPushNotificationConnector`](IEngineServerEnvironmentVariables.md#messagingpushnotificationconnector)
874
972
 
875
973
  ***
876
974
 
@@ -882,7 +980,7 @@ The type of telemetry connector: entity-storage.
882
980
 
883
981
  #### Inherited from
884
982
 
885
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`telemetryConnector`](IEngineEnvironmentVariables.md#telemetryconnector)
983
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`telemetryConnector`](IEngineServerEnvironmentVariables.md#telemetryconnector)
886
984
 
887
985
  ***
888
986
 
@@ -894,7 +992,7 @@ The type of faucet connector: entity-storage, iota.
894
992
 
895
993
  #### Inherited from
896
994
 
897
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`faucetConnector`](IEngineEnvironmentVariables.md#faucetconnector)
995
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`faucetConnector`](IEngineServerEnvironmentVariables.md#faucetconnector)
898
996
 
899
997
  ***
900
998
 
@@ -906,7 +1004,7 @@ The type of wallet connector: entity-storage, iota.
906
1004
 
907
1005
  #### Inherited from
908
1006
 
909
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`walletConnector`](IEngineEnvironmentVariables.md#walletconnector)
1007
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`walletConnector`](IEngineServerEnvironmentVariables.md#walletconnector)
910
1008
 
911
1009
  ***
912
1010
 
@@ -918,7 +1016,7 @@ The type of NFT connector: entity-storage, iota.
918
1016
 
919
1017
  #### Inherited from
920
1018
 
921
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`nftConnector`](IEngineEnvironmentVariables.md#nftconnector)
1019
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`nftConnector`](IEngineServerEnvironmentVariables.md#nftconnector)
922
1020
 
923
1021
  ***
924
1022
 
@@ -930,7 +1028,7 @@ The type of identity connector: entity-storage, iota.
930
1028
 
931
1029
  #### Inherited from
932
1030
 
933
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityConnector`](IEngineEnvironmentVariables.md#identityconnector)
1031
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`identityConnector`](IEngineServerEnvironmentVariables.md#identityconnector)
934
1032
 
935
1033
  ***
936
1034
 
@@ -942,7 +1040,7 @@ The type of identity resolver connector: entity-storage, iota.
942
1040
 
943
1041
  #### Inherited from
944
1042
 
945
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityResolverConnector`](IEngineEnvironmentVariables.md#identityresolverconnector)
1043
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`identityResolverConnector`](IEngineServerEnvironmentVariables.md#identityresolverconnector)
946
1044
 
947
1045
  ***
948
1046
 
@@ -954,7 +1052,7 @@ The type of verifiable storage connector: entity-storage, iota.
954
1052
 
955
1053
  #### Inherited from
956
1054
 
957
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`verifiableStorageConnector`](IEngineEnvironmentVariables.md#verifiablestorageconnector)
1055
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`verifiableStorageConnector`](IEngineServerEnvironmentVariables.md#verifiablestorageconnector)
958
1056
 
959
1057
  ***
960
1058
 
@@ -966,7 +1064,7 @@ IOTA Faucet Endpoint.
966
1064
 
967
1065
  #### Inherited from
968
1066
 
969
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaFaucetEndpoint`](IEngineEnvironmentVariables.md#iotafaucetendpoint)
1067
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaFaucetEndpoint`](IEngineServerEnvironmentVariables.md#iotafaucetendpoint)
970
1068
 
971
1069
  ***
972
1070
 
@@ -978,7 +1076,7 @@ IOTA Node Endpoint.
978
1076
 
979
1077
  #### Inherited from
980
1078
 
981
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaNodeEndpoint`](IEngineEnvironmentVariables.md#iotanodeendpoint)
1079
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaNodeEndpoint`](IEngineServerEnvironmentVariables.md#iotanodeendpoint)
982
1080
 
983
1081
  ***
984
1082
 
@@ -990,7 +1088,7 @@ IOTA network.
990
1088
 
991
1089
  #### Inherited from
992
1090
 
993
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaNetwork`](IEngineEnvironmentVariables.md#iotanetwork)
1091
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaNetwork`](IEngineServerEnvironmentVariables.md#iotanetwork)
994
1092
 
995
1093
  ***
996
1094
 
@@ -1002,7 +1100,7 @@ IOTA coin type.
1002
1100
 
1003
1101
  #### Inherited from
1004
1102
 
1005
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaCoinType`](IEngineEnvironmentVariables.md#iotacointype)
1103
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaCoinType`](IEngineServerEnvironmentVariables.md#iotacointype)
1006
1104
 
1007
1105
  ***
1008
1106
 
@@ -1014,7 +1112,7 @@ IOTA Explorer Endpoint.
1014
1112
 
1015
1113
  #### Inherited from
1016
1114
 
1017
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaExplorerEndpoint`](IEngineEnvironmentVariables.md#iotaexplorerendpoint)
1115
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaExplorerEndpoint`](IEngineServerEnvironmentVariables.md#iotaexplorerendpoint)
1018
1116
 
1019
1117
  ***
1020
1118
 
@@ -1026,7 +1124,7 @@ IOTA Gas Station Endpoint.
1026
1124
 
1027
1125
  #### Inherited from
1028
1126
 
1029
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaGasStationEndpoint`](IEngineEnvironmentVariables.md#iotagasstationendpoint)
1127
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaGasStationEndpoint`](IEngineServerEnvironmentVariables.md#iotagasstationendpoint)
1030
1128
 
1031
1129
  ***
1032
1130
 
@@ -1038,7 +1136,7 @@ IOTA Gas Station Authentication Token.
1038
1136
 
1039
1137
  #### Inherited from
1040
1138
 
1041
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaGasStationAuthToken`](IEngineEnvironmentVariables.md#iotagasstationauthtoken)
1139
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaGasStationAuthToken`](IEngineServerEnvironmentVariables.md#iotagasstationauthtoken)
1042
1140
 
1043
1141
  ***
1044
1142
 
@@ -1050,7 +1148,7 @@ Universal Resolver Endpoint.
1050
1148
 
1051
1149
  #### Inherited from
1052
1150
 
1053
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`universalResolverEndpoint`](IEngineEnvironmentVariables.md#universalresolverendpoint)
1151
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`universalResolverEndpoint`](IEngineServerEnvironmentVariables.md#universalresolverendpoint)
1054
1152
 
1055
1153
  ***
1056
1154
 
@@ -1062,7 +1160,7 @@ The type of identity profile connector: entity-storage.
1062
1160
 
1063
1161
  #### Inherited from
1064
1162
 
1065
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityProfileConnector`](IEngineEnvironmentVariables.md#identityprofileconnector)
1163
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`identityProfileConnector`](IEngineServerEnvironmentVariables.md#identityprofileconnector)
1066
1164
 
1067
1165
  ***
1068
1166
 
@@ -1074,7 +1172,7 @@ The identity verification method id to use with immutable proofs.
1074
1172
 
1075
1173
  #### Inherited from
1076
1174
 
1077
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`immutableProofVerificationMethodId`](IEngineEnvironmentVariables.md#immutableproofverificationmethodid)
1175
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`immutableProofVerificationMethodId`](IEngineServerEnvironmentVariables.md#immutableproofverificationmethodid)
1078
1176
 
1079
1177
  ***
1080
1178
 
@@ -1086,7 +1184,7 @@ The type of attestation connector: entity-storage, iota.
1086
1184
 
1087
1185
  #### Inherited from
1088
1186
 
1089
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`attestationConnector`](IEngineEnvironmentVariables.md#attestationconnector)
1187
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`attestationConnector`](IEngineServerEnvironmentVariables.md#attestationconnector)
1090
1188
 
1091
1189
  ***
1092
1190
 
@@ -1098,7 +1196,19 @@ The identity verification method id to use with attestation.
1098
1196
 
1099
1197
  #### Inherited from
1100
1198
 
1101
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`attestationVerificationMethodId`](IEngineEnvironmentVariables.md#attestationverificationmethodid)
1199
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`attestationVerificationMethodId`](IEngineServerEnvironmentVariables.md#attestationverificationmethodid)
1200
+
1201
+ ***
1202
+
1203
+ ### dataProcessingEnabled?
1204
+
1205
+ > `optional` **dataProcessingEnabled**: `string`
1206
+
1207
+ Is the data processing enabled, defaults to false.
1208
+
1209
+ #### Inherited from
1210
+
1211
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataProcessingEnabled`](IEngineServerEnvironmentVariables.md#dataprocessingenabled)
1102
1212
 
1103
1213
  ***
1104
1214
 
@@ -1110,7 +1220,7 @@ The type of the default data converters, can be a comma separated list: json, xm
1110
1220
 
1111
1221
  #### Inherited from
1112
1222
 
1113
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataConverterConnectors`](IEngineEnvironmentVariables.md#dataconverterconnectors)
1223
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataConverterConnectors`](IEngineServerEnvironmentVariables.md#dataconverterconnectors)
1114
1224
 
1115
1225
  ***
1116
1226
 
@@ -1122,7 +1232,191 @@ The type of the default data extractor, can be a comma separated list: json-path
1122
1232
 
1123
1233
  #### Inherited from
1124
1234
 
1125
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataExtractorConnectors`](IEngineEnvironmentVariables.md#dataextractorconnectors)
1235
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataExtractorConnectors`](IEngineServerEnvironmentVariables.md#dataextractorconnectors)
1236
+
1237
+ ***
1238
+
1239
+ ### auditableItemGraphEnabled?
1240
+
1241
+ > `optional` **auditableItemGraphEnabled**: `string`
1242
+
1243
+ Is the auditable item graph enabled, defaults to false.
1244
+
1245
+ #### Inherited from
1246
+
1247
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`auditableItemGraphEnabled`](IEngineServerEnvironmentVariables.md#auditableitemgraphenabled)
1248
+
1249
+ ***
1250
+
1251
+ ### auditableItemStreamEnabled?
1252
+
1253
+ > `optional` **auditableItemStreamEnabled**: `string`
1254
+
1255
+ Is the auditable item stream enabled, defaults to false.
1256
+
1257
+ #### Inherited from
1258
+
1259
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`auditableItemStreamEnabled`](IEngineServerEnvironmentVariables.md#auditableitemstreamenabled)
1260
+
1261
+ ***
1262
+
1263
+ ### documentManagementEnabled?
1264
+
1265
+ > `optional` **documentManagementEnabled**: `string`
1266
+
1267
+ Is the document management enabled, defaults to false.
1268
+
1269
+ #### Inherited from
1270
+
1271
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`documentManagementEnabled`](IEngineServerEnvironmentVariables.md#documentmanagementenabled)
1272
+
1273
+ ***
1274
+
1275
+ ### synchronisedStorageEnabled?
1276
+
1277
+ > `optional` **synchronisedStorageEnabled**: `string`
1278
+
1279
+ Is the synchronised storage enabled, defaults to false.
1280
+
1281
+ #### Inherited from
1282
+
1283
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageEnabled`](IEngineServerEnvironmentVariables.md#synchronisedstorageenabled)
1284
+
1285
+ ***
1286
+
1287
+ ### synchronisedStorageTrustedUrl?
1288
+
1289
+ > `optional` **synchronisedStorageTrustedUrl**: `string`
1290
+
1291
+ Url which points to the api for a trusted synchronised storage node, not required if this is a trusted node.
1292
+
1293
+ #### Inherited from
1294
+
1295
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageTrustedUrl`](IEngineServerEnvironmentVariables.md#synchronisedstoragetrustedurl)
1296
+
1297
+ ***
1298
+
1299
+ ### synchronisedStorageVerifiableStorageKeyId?
1300
+
1301
+ > `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
1302
+
1303
+ The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
1304
+ This only required if using a custom verifiable storage item, otherwise it will default to the network name.
1305
+
1306
+ #### Inherited from
1307
+
1308
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageVerifiableStorageKeyId`](IEngineServerEnvironmentVariables.md#synchronisedstorageverifiablestoragekeyid)
1309
+
1310
+ ***
1311
+
1312
+ ### synchronisedStorageBlobStorageEncryptionKeyId?
1313
+
1314
+ > `optional` **synchronisedStorageBlobStorageEncryptionKeyId**: `string`
1315
+
1316
+ The key from the vault which is used to encrypt the synchronised storage blobs.
1317
+ Only required for trusted nodes, as regular nodes will request from the trusted nodes.
1318
+ Defaults to synchronised-storage-blob-encryption
1319
+
1320
+ #### Inherited from
1321
+
1322
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageBlobStorageEncryptionKeyId`](IEngineServerEnvironmentVariables.md#synchronisedstorageblobstorageencryptionkeyid)
1323
+
1324
+ ***
1325
+
1326
+ ### synchronisedStorageBlobStorageKey?
1327
+
1328
+ > `optional` **synchronisedStorageBlobStorageKey**: `string`
1329
+
1330
+ The key used for blob encryption, should be ChaCha20Poly1305 encoded as base64.
1331
+ Only required for trusted nodes, as regular nodes will not write encrypted data.
1332
+
1333
+ #### Inherited from
1334
+
1335
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageBlobStorageKey`](IEngineServerEnvironmentVariables.md#synchronisedstorageblobstoragekey)
1336
+
1337
+ ***
1338
+
1339
+ ### synchronisedStorageEntityUpdateIntervalMinutes?
1340
+
1341
+ > `optional` **synchronisedStorageEntityUpdateIntervalMinutes**: `string`
1342
+
1343
+ How often to check for entity updates in minutes.
1344
+
1345
+ #### Default
1346
+
1347
+ ```ts
1348
+ 5
1349
+ ```
1350
+
1351
+ #### Inherited from
1352
+
1353
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageEntityUpdateIntervalMinutes`](IEngineServerEnvironmentVariables.md#synchronisedstorageentityupdateintervalminutes)
1354
+
1355
+ ***
1356
+
1357
+ ### synchronisedStorageConsolidationIntervalMinutes?
1358
+
1359
+ > `optional` **synchronisedStorageConsolidationIntervalMinutes**: `string`
1360
+
1361
+ Interval to perform consolidation of changesets, only used if this is a trusted node.
1362
+
1363
+ #### Default
1364
+
1365
+ ```ts
1366
+ 60
1367
+ ```
1368
+
1369
+ #### Inherited from
1370
+
1371
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageConsolidationIntervalMinutes`](IEngineServerEnvironmentVariables.md#synchronisedstorageconsolidationintervalminutes)
1372
+
1373
+ ***
1374
+
1375
+ ### synchronisedStorageConsolidationBatchSize?
1376
+
1377
+ > `optional` **synchronisedStorageConsolidationBatchSize**: `string`
1378
+
1379
+ The number of entities to process in a single consolidation batch, only used if this is a trusted node.
1380
+
1381
+ #### Default
1382
+
1383
+ ```ts
1384
+ 1000
1385
+ ```
1386
+
1387
+ #### Inherited from
1388
+
1389
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageConsolidationBatchSize`](IEngineServerEnvironmentVariables.md#synchronisedstorageconsolidationbatchsize)
1390
+
1391
+ ***
1392
+
1393
+ ### synchronisedStorageMaxConsolidations?
1394
+
1395
+ > `optional` **synchronisedStorageMaxConsolidations**: `string`
1396
+
1397
+ The maximum number of consolidations to keep in storage, only used if this is a trusted node.
1398
+
1399
+ #### Default
1400
+
1401
+ ```ts
1402
+ 5
1403
+ ```
1404
+
1405
+ #### Inherited from
1406
+
1407
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageMaxConsolidations`](IEngineServerEnvironmentVariables.md#synchronisedstoragemaxconsolidations)
1408
+
1409
+ ***
1410
+
1411
+ ### federatedCatalogueEnabled?
1412
+
1413
+ > `optional` **federatedCatalogueEnabled**: `string`
1414
+
1415
+ Is the federated catalogue enabled, defaults to false.
1416
+
1417
+ #### Inherited from
1418
+
1419
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`federatedCatalogueEnabled`](IEngineServerEnvironmentVariables.md#federatedcatalogueenabled)
1126
1420
 
1127
1421
  ***
1128
1422
 
@@ -1134,7 +1428,7 @@ Federated catalog TTL for the cache.
1134
1428
 
1135
1429
  #### Inherited from
1136
1430
 
1137
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueCacheTtlMs`](IEngineEnvironmentVariables.md#federatedcataloguecachettlms)
1431
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`federatedCatalogueCacheTtlMs`](IEngineServerEnvironmentVariables.md#federatedcataloguecachettlms)
1138
1432
 
1139
1433
  ***
1140
1434
 
@@ -1146,7 +1440,7 @@ Federated catalog clearing house approver list, stringified array of DIDs.
1146
1440
 
1147
1441
  #### Inherited from
1148
1442
 
1149
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueClearingHouseApproverList`](IEngineEnvironmentVariables.md#federatedcatalogueclearinghouseapproverlist)
1443
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`federatedCatalogueClearingHouseApproverList`](IEngineServerEnvironmentVariables.md#federatedcatalogueclearinghouseapproverlist)
1150
1444
 
1151
1445
  ***
1152
1446
 
@@ -1158,7 +1452,110 @@ Is the rights management enabled, defaults to false.
1158
1452
 
1159
1453
  #### Inherited from
1160
1454
 
1161
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementEnabled`](IEngineEnvironmentVariables.md#rightsmanagementenabled)
1455
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementEnabled`](IEngineServerEnvironmentVariables.md#rightsmanagementenabled)
1456
+
1457
+ ***
1458
+
1459
+ ### rightsManagementBaseCallbackUrl?
1460
+
1461
+ > `optional` **rightsManagementBaseCallbackUrl**: `string`
1462
+
1463
+ What is the base callback url for rights management negotiations e.g. https://my-node/rights-management.
1464
+
1465
+ #### Inherited from
1466
+
1467
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementBaseCallbackUrl`](IEngineServerEnvironmentVariables.md#rightsmanagementbasecallbackurl)
1468
+
1469
+ ***
1470
+
1471
+ ### rightsManagementInformationSources?
1472
+
1473
+ > `optional` **rightsManagementInformationSources**: `string`
1474
+
1475
+ The rights management configuration which includes the information sources modules to load.
1476
+ Use the @json: prefix to specify the path to the JSON configuration file.
1477
+
1478
+ #### Inherited from
1479
+
1480
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementInformationSources`](IEngineServerEnvironmentVariables.md#rightsmanagementinformationsources)
1481
+
1482
+ ***
1483
+
1484
+ ### rightsManagementNegotiators?
1485
+
1486
+ > `optional` **rightsManagementNegotiators**: `string`
1487
+
1488
+ The rights management configuration which includes the negotiator modules to load.
1489
+ Use the @json: prefix to specify the path to the JSON configuration file.
1490
+
1491
+ #### Inherited from
1492
+
1493
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementNegotiators`](IEngineServerEnvironmentVariables.md#rightsmanagementnegotiators)
1494
+
1495
+ ***
1496
+
1497
+ ### rightsManagementRequesters?
1498
+
1499
+ > `optional` **rightsManagementRequesters**: `string`
1500
+
1501
+ The rights management configuration which includes the requester modules to load.
1502
+ Use the @json: prefix to specify the path to the JSON configuration file.
1503
+
1504
+ #### Inherited from
1505
+
1506
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementRequesters`](IEngineServerEnvironmentVariables.md#rightsmanagementrequesters)
1507
+
1508
+ ***
1509
+
1510
+ ### rightsManagementExecutionActions?
1511
+
1512
+ > `optional` **rightsManagementExecutionActions**: `string`
1513
+
1514
+ The rights management configuration which includes the execution actions modules to load.
1515
+ Use the @json: prefix to specify the path to the JSON configuration file.
1516
+
1517
+ #### Inherited from
1518
+
1519
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementExecutionActions`](IEngineServerEnvironmentVariables.md#rightsmanagementexecutionactions)
1520
+
1521
+ ***
1522
+
1523
+ ### rightsManagementEnforcementProcessors?
1524
+
1525
+ > `optional` **rightsManagementEnforcementProcessors**: `string`
1526
+
1527
+ The rights management configuration which includes the enforcement processor modules to load.
1528
+ Use the @json: prefix to specify the path to the JSON configuration file.
1529
+
1530
+ #### Inherited from
1531
+
1532
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementEnforcementProcessors`](IEngineServerEnvironmentVariables.md#rightsmanagementenforcementprocessors)
1533
+
1534
+ ***
1535
+
1536
+ ### rightsManagementArbiters?
1537
+
1538
+ > `optional` **rightsManagementArbiters**: `string`
1539
+
1540
+ The rights management configuration which includes the arbiter modules to load.
1541
+ Use the @json: prefix to specify the path to the JSON configuration file.
1542
+
1543
+ #### Inherited from
1544
+
1545
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementArbiters`](IEngineServerEnvironmentVariables.md#rightsmanagementarbiters)
1546
+
1547
+ ***
1548
+
1549
+ ### rightsManagementOffers?
1550
+
1551
+ > `optional` **rightsManagementOffers**: `string`
1552
+
1553
+ The rights management configuration which includes the offer modules to load.
1554
+ Use the @json: prefix to specify the path to the JSON configuration file.
1555
+
1556
+ #### Inherited from
1557
+
1558
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementOffers`](IEngineServerEnvironmentVariables.md#rightsmanagementoffers)
1162
1559
 
1163
1560
  ***
1164
1561
 
@@ -1166,11 +1563,96 @@ Is the rights management enabled, defaults to false.
1166
1563
 
1167
1564
  > `optional` **taskSchedulerEnabled**: `string`
1168
1565
 
1169
- Is the task scheduler enabled, defaults to true.
1566
+ Is the task scheduler enabled, defaults to false.
1567
+
1568
+ #### Inherited from
1569
+
1570
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`taskSchedulerEnabled`](IEngineServerEnvironmentVariables.md#taskschedulerenabled)
1571
+
1572
+ ***
1573
+
1574
+ ### dataSpaceConnectorEnabled?
1575
+
1576
+ > `optional` **dataSpaceConnectorEnabled**: `string`
1577
+
1578
+ Is the data space connector enabled, defaults to false.
1579
+
1580
+ #### Inherited from
1581
+
1582
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataSpaceConnectorEnabled`](IEngineServerEnvironmentVariables.md#dataspaceconnectorenabled)
1583
+
1584
+ ***
1585
+
1586
+ ### dataSpaceConnectorRetainActivityLogsFor?
1587
+
1588
+ > `optional` **dataSpaceConnectorRetainActivityLogsFor**: `string`
1589
+
1590
+ The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
1591
+
1592
+ #### Default
1593
+
1594
+ ```ts
1595
+ 10
1596
+ ```
1597
+
1598
+ #### Inherited from
1599
+
1600
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataSpaceConnectorRetainActivityLogsFor`](IEngineServerEnvironmentVariables.md#dataspaceconnectorretainactivitylogsfor)
1601
+
1602
+ ***
1603
+
1604
+ ### dataSpaceConnectorActivityLogsCleanUpInterval?
1605
+
1606
+ > `optional` **dataSpaceConnectorActivityLogsCleanUpInterval**: `string`
1607
+
1608
+ The interval for cleaning up the activity logs.
1609
+
1610
+ #### Default
1611
+
1612
+ ```ts
1613
+ 60
1614
+ ```
1615
+
1616
+ #### Inherited from
1617
+
1618
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataSpaceConnectorActivityLogsCleanUpInterval`](IEngineServerEnvironmentVariables.md#dataspaceconnectoractivitylogscleanupinterval)
1619
+
1620
+ ***
1621
+
1622
+ ### vcAuthenticationEnabled?
1623
+
1624
+ > `optional` **vcAuthenticationEnabled**: `string`
1625
+
1626
+ Enable verifiable credential authentication for the API.
1627
+
1628
+ #### Inherited from
1629
+
1630
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`vcAuthenticationEnabled`](IEngineServerEnvironmentVariables.md#vcauthenticationenabled)
1631
+
1632
+ ***
1633
+
1634
+ ### vcAuthenticationVerificationMethodId?
1635
+
1636
+ > `optional` **vcAuthenticationVerificationMethodId**: `string`
1637
+
1638
+ Verifiable credential assertion for node to node communication.
1639
+ Defaults to node-authentication-assertion.
1170
1640
 
1171
1641
  #### Inherited from
1172
1642
 
1173
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`taskSchedulerEnabled`](IEngineEnvironmentVariables.md#taskschedulerenabled)
1643
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`vcAuthenticationVerificationMethodId`](IEngineServerEnvironmentVariables.md#vcauthenticationverificationmethodid)
1644
+
1645
+ ***
1646
+
1647
+ ### extensions?
1648
+
1649
+ > `optional` **extensions**: `string`
1650
+
1651
+ A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
1652
+
1653
+ #### Inherited from
1654
+
1655
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`extensions`](IEngineServerEnvironmentVariables.md#extensions)
1174
1656
 
1175
1657
  ***
1176
1658
 
@@ -1294,15 +1776,39 @@ Additional MIME type processors to include, comma separated.
1294
1776
 
1295
1777
  ***
1296
1778
 
1297
- ### disableNodeIdentity?
1779
+ ### routeLoggingIncludeBody?
1780
+
1781
+ > `optional` **routeLoggingIncludeBody**: `string`
1782
+
1783
+ Include the body in the REST logging output, useful for debugging.
1784
+
1785
+ #### Inherited from
1786
+
1787
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`routeLoggingIncludeBody`](IEngineServerEnvironmentVariables.md#routeloggingincludebody)
1788
+
1789
+ ***
1790
+
1791
+ ### routeLoggingFullBase64?
1792
+
1793
+ > `optional` **routeLoggingFullBase64**: `string`
1794
+
1795
+ Include the full base 64 output in the REST logging output, useful for debugging.
1796
+
1797
+ #### Inherited from
1798
+
1799
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`routeLoggingFullBase64`](IEngineServerEnvironmentVariables.md#routeloggingfullbase64)
1800
+
1801
+ ***
1802
+
1803
+ ### routeLoggingObfuscateProperties?
1298
1804
 
1299
- > `optional` **disableNodeIdentity**: `string`
1805
+ > `optional` **routeLoggingObfuscateProperties**: `string`
1300
1806
 
1301
- Disable Node Identity route processors.
1807
+ List of properties to obfuscate in the REST logging output, comma separated.
1302
1808
 
1303
1809
  #### Inherited from
1304
1810
 
1305
- [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`disableNodeIdentity`](IEngineServerEnvironmentVariables.md#disablenodeidentity)
1811
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`routeLoggingObfuscateProperties`](IEngineServerEnvironmentVariables.md#routeloggingobfuscateproperties)
1306
1812
 
1307
1813
  ***
1308
1814