@twin.org/node-core 0.9.2-next.1 → 0.9.2-next.11
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.
- package/dist/es/builders/engineEnvBuilder.js +198 -111
- package/dist/es/builders/engineEnvBuilder.js.map +1 -1
- package/dist/es/builders/engineServerEnvBuilder.js +23 -26
- package/dist/es/builders/engineServerEnvBuilder.js.map +1 -1
- package/dist/es/builders/extensionsBuilder.js +5 -4
- package/dist/es/builders/extensionsBuilder.js.map +1 -1
- package/dist/es/builders/helper/envHelpers.js +174 -0
- package/dist/es/builders/helper/envHelpers.js.map +1 -0
- package/dist/es/cli.js +4 -3
- package/dist/es/cli.js.map +1 -1
- package/dist/es/commands/{bootstrapLegacy.js → bootstrapDev.js} +30 -29
- package/dist/es/commands/bootstrapDev.js.map +1 -0
- package/dist/es/commands/identityCreate.js +4 -26
- package/dist/es/commands/identityCreate.js.map +1 -1
- package/dist/es/commands/identityImports.js +2 -1
- package/dist/es/commands/identityImports.js.map +1 -1
- package/dist/es/commands/userCreate.js +8 -3
- package/dist/es/commands/userCreate.js.map +1 -1
- package/dist/es/commands/userUpdate.js +5 -2
- package/dist/es/commands/userUpdate.js.map +1 -1
- package/dist/es/index.js +1 -1
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/{IBootstrapLegacyEnvironmentVariables.js → IBootstrapDevEnvironmentVariables.js} +1 -1
- package/dist/es/models/IBootstrapDevEnvironmentVariables.js.map +1 -0
- package/dist/es/models/IEngineEnvironmentVariables.js.map +1 -1
- package/dist/es/models/IEnvironmentVariables.js.map +1 -1
- package/dist/es/models/{bootstrapLegacyEnvironmentVariableKeys.js → bootstrapDevEnvironmentVariableKeys.js} +6 -6
- package/dist/es/models/bootstrapDevEnvironmentVariableKeys.js.map +1 -0
- package/dist/es/models/engineEnvironmentVariableKeys.js +50 -4
- package/dist/es/models/engineEnvironmentVariableKeys.js.map +1 -1
- package/dist/es/models/engineServerEnvironmentVariableKeys.js +3 -3
- package/dist/es/models/engineServerEnvironmentVariableKeys.js.map +1 -1
- package/dist/es/models/nodeEnvironmentVariableKeys.js +1 -1
- package/dist/es/models/nodeEnvironmentVariableKeys.js.map +1 -1
- package/dist/es/node.js +6 -10
- package/dist/es/node.js.map +1 -1
- package/dist/es/start.js +3 -2
- package/dist/es/start.js.map +1 -1
- package/dist/types/builders/helper/envHelpers.d.ts +82 -0
- package/dist/types/commands/{bootstrapLegacy.d.ts → bootstrapDev.d.ts} +3 -3
- package/dist/types/index.d.ts +1 -1
- package/dist/types/models/{IBootstrapLegacyEnvironmentVariables.d.ts → IBootstrapDevEnvironmentVariables.d.ts} +2 -2
- package/dist/types/models/IEngineEnvironmentVariables.d.ts +202 -13
- package/dist/types/models/IEnvironmentVariables.d.ts +2 -2
- package/dist/types/models/bootstrapDevEnvironmentVariableKeys.d.ts +4 -0
- package/dist/types/node.d.ts +1 -1
- package/docs/changelog.md +72 -0
- package/docs/reference/functions/buildConfiguration.md +2 -2
- package/docs/reference/functions/buildEngineServerConfiguration.md +1 -1
- package/docs/reference/functions/run.md +1 -1
- package/docs/reference/functions/start.md +1 -1
- package/docs/reference/index.md +1 -1
- package/docs/reference/interfaces/{IBootstrapLegacyEnvironmentVariables.md → IBootstrapDevEnvironmentVariables.md} +2 -2
- package/docs/reference/interfaces/IEngineEnvironmentVariables.md +429 -20
- package/docs/reference/type-aliases/IEnvironmentVariables.md +1 -1
- package/locales/en.json +6 -5
- package/package.json +11 -4
- package/dist/es/commands/bootstrapLegacy.js.map +0 -1
- package/dist/es/models/IBootstrapLegacyEnvironmentVariables.js.map +0 -1
- package/dist/es/models/bootstrapLegacyEnvironmentVariableKeys.js.map +0 -1
- package/dist/types/models/bootstrapLegacyEnvironmentVariableKeys.d.ts +0 -4
|
@@ -258,6 +258,22 @@ ScyllaDB port.
|
|
|
258
258
|
|
|
259
259
|
***
|
|
260
260
|
|
|
261
|
+
### scylladbPoolCoreConnectionsPerHost? {#scylladbpoolcoreconnectionsperhost}
|
|
262
|
+
|
|
263
|
+
> `optional` **scylladbPoolCoreConnectionsPerHost?**: `string`
|
|
264
|
+
|
|
265
|
+
ScyllaDB connection pool: number of connections per local host.
|
|
266
|
+
|
|
267
|
+
***
|
|
268
|
+
|
|
269
|
+
### scylladbPoolMaxRequestsPerConnection? {#scylladbpoolmaxrequestsperconnection}
|
|
270
|
+
|
|
271
|
+
> `optional` **scylladbPoolMaxRequestsPerConnection?**: `string`
|
|
272
|
+
|
|
273
|
+
ScyllaDB connection pool: maximum requests per connection.
|
|
274
|
+
|
|
275
|
+
***
|
|
276
|
+
|
|
261
277
|
### mySqlHost? {#mysqlhost}
|
|
262
278
|
|
|
263
279
|
> `optional` **mySqlHost?**: `string`
|
|
@@ -268,7 +284,7 @@ MySQL host.
|
|
|
268
284
|
|
|
269
285
|
### mySqlPort? {#mysqlport}
|
|
270
286
|
|
|
271
|
-
> `optional` **mySqlPort?**: `
|
|
287
|
+
> `optional` **mySqlPort?**: `string`
|
|
272
288
|
|
|
273
289
|
MySQL port.
|
|
274
290
|
|
|
@@ -298,6 +314,54 @@ MySQL Database.
|
|
|
298
314
|
|
|
299
315
|
***
|
|
300
316
|
|
|
317
|
+
### mySqlPoolConnectionLimit? {#mysqlpoolconnectionlimit}
|
|
318
|
+
|
|
319
|
+
> `optional` **mySqlPoolConnectionLimit?**: `string`
|
|
320
|
+
|
|
321
|
+
MySQL connection pool: maximum number of connections.
|
|
322
|
+
|
|
323
|
+
***
|
|
324
|
+
|
|
325
|
+
### mySqlPoolMaxIdle? {#mysqlpoolmaxidle}
|
|
326
|
+
|
|
327
|
+
> `optional` **mySqlPoolMaxIdle?**: `string`
|
|
328
|
+
|
|
329
|
+
MySQL connection pool: maximum number of idle connections.
|
|
330
|
+
|
|
331
|
+
***
|
|
332
|
+
|
|
333
|
+
### mySqlPoolIdleTimeout? {#mysqlpoolidletimeout}
|
|
334
|
+
|
|
335
|
+
> `optional` **mySqlPoolIdleTimeout?**: `string`
|
|
336
|
+
|
|
337
|
+
MySQL connection pool: milliseconds before an idle connection is removed.
|
|
338
|
+
|
|
339
|
+
***
|
|
340
|
+
|
|
341
|
+
### mySqlPoolEnableKeepAlive? {#mysqlpoolenablekeepalive}
|
|
342
|
+
|
|
343
|
+
> `optional` **mySqlPoolEnableKeepAlive?**: `string`
|
|
344
|
+
|
|
345
|
+
MySQL connection pool: enable TCP keep-alive.
|
|
346
|
+
|
|
347
|
+
***
|
|
348
|
+
|
|
349
|
+
### mySqlPoolWaitForConnections? {#mysqlpoolwaitforconnections}
|
|
350
|
+
|
|
351
|
+
> `optional` **mySqlPoolWaitForConnections?**: `string`
|
|
352
|
+
|
|
353
|
+
MySQL connection pool: wait for a connection when pool is full.
|
|
354
|
+
|
|
355
|
+
***
|
|
356
|
+
|
|
357
|
+
### mySqlPoolQueueLimit? {#mysqlpoolqueuelimit}
|
|
358
|
+
|
|
359
|
+
> `optional` **mySqlPoolQueueLimit?**: `string`
|
|
360
|
+
|
|
361
|
+
MySQL connection pool: maximum queued requests (0 = unlimited).
|
|
362
|
+
|
|
363
|
+
***
|
|
364
|
+
|
|
301
365
|
### mongoDbHost? {#mongodbhost}
|
|
302
366
|
|
|
303
367
|
> `optional` **mongoDbHost?**: `string`
|
|
@@ -308,7 +372,7 @@ MongoDB host.
|
|
|
308
372
|
|
|
309
373
|
### mongoDbPort? {#mongodbport}
|
|
310
374
|
|
|
311
|
-
> `optional` **mongoDbPort?**: `
|
|
375
|
+
> `optional` **mongoDbPort?**: `string`
|
|
312
376
|
|
|
313
377
|
MongoDB port.
|
|
314
378
|
|
|
@@ -338,6 +402,38 @@ MongoDB Database.
|
|
|
338
402
|
|
|
339
403
|
***
|
|
340
404
|
|
|
405
|
+
### mongoDbPoolMaxPoolSize? {#mongodbpoolmaxpoolsize}
|
|
406
|
+
|
|
407
|
+
> `optional` **mongoDbPoolMaxPoolSize?**: `string`
|
|
408
|
+
|
|
409
|
+
MongoDB connection pool: maximum number of connections.
|
|
410
|
+
|
|
411
|
+
***
|
|
412
|
+
|
|
413
|
+
### mongoDbPoolMinPoolSize? {#mongodbpoolminpoolsize}
|
|
414
|
+
|
|
415
|
+
> `optional` **mongoDbPoolMinPoolSize?**: `string`
|
|
416
|
+
|
|
417
|
+
MongoDB connection pool: minimum number of connections to maintain.
|
|
418
|
+
|
|
419
|
+
***
|
|
420
|
+
|
|
421
|
+
### mongoDbPoolMaxIdleTime? {#mongodbpoolmaxidletime}
|
|
422
|
+
|
|
423
|
+
> `optional` **mongoDbPoolMaxIdleTime?**: `string`
|
|
424
|
+
|
|
425
|
+
MongoDB connection pool: milliseconds a connection can remain idle before removal.
|
|
426
|
+
|
|
427
|
+
***
|
|
428
|
+
|
|
429
|
+
### mongoDbPoolWaitQueueTimeout? {#mongodbpoolwaitqueuetimeout}
|
|
430
|
+
|
|
431
|
+
> `optional` **mongoDbPoolWaitQueueTimeout?**: `string`
|
|
432
|
+
|
|
433
|
+
MongoDB connection pool: milliseconds to wait for a connection before throwing.
|
|
434
|
+
|
|
435
|
+
***
|
|
436
|
+
|
|
341
437
|
### postgreSqlHost? {#postgresqlhost}
|
|
342
438
|
|
|
343
439
|
> `optional` **postgreSqlHost?**: `string`
|
|
@@ -348,7 +444,7 @@ PostgreSQl host.
|
|
|
348
444
|
|
|
349
445
|
### postgreSqlPort? {#postgresqlport}
|
|
350
446
|
|
|
351
|
-
> `optional` **postgreSqlPort?**: `
|
|
447
|
+
> `optional` **postgreSqlPort?**: `string`
|
|
352
448
|
|
|
353
449
|
PostgreSQl port.
|
|
354
450
|
|
|
@@ -378,6 +474,38 @@ PostgreSQl Database.
|
|
|
378
474
|
|
|
379
475
|
***
|
|
380
476
|
|
|
477
|
+
### postgreSqlPoolMax? {#postgresqlpoolmax}
|
|
478
|
+
|
|
479
|
+
> `optional` **postgreSqlPoolMax?**: `string`
|
|
480
|
+
|
|
481
|
+
PostgreSQL connection pool: maximum number of connections.
|
|
482
|
+
|
|
483
|
+
***
|
|
484
|
+
|
|
485
|
+
### postgreSqlPoolIdleTimeout? {#postgresqlpoolidletimeout}
|
|
486
|
+
|
|
487
|
+
> `optional` **postgreSqlPoolIdleTimeout?**: `string`
|
|
488
|
+
|
|
489
|
+
PostgreSQL connection pool: seconds a connection can remain idle before being closed.
|
|
490
|
+
|
|
491
|
+
***
|
|
492
|
+
|
|
493
|
+
### postgreSqlPoolConnectTimeout? {#postgresqlpoolconnecttimeout}
|
|
494
|
+
|
|
495
|
+
> `optional` **postgreSqlPoolConnectTimeout?**: `string`
|
|
496
|
+
|
|
497
|
+
PostgreSQL connection pool: seconds to wait when establishing a connection.
|
|
498
|
+
|
|
499
|
+
***
|
|
500
|
+
|
|
501
|
+
### postgreSqlPoolMaxLifetime? {#postgresqlpoolmaxlifetime}
|
|
502
|
+
|
|
503
|
+
> `optional` **postgreSqlPoolMaxLifetime?**: `string`
|
|
504
|
+
|
|
505
|
+
PostgreSQL connection pool: maximum seconds a connection can remain open.
|
|
506
|
+
|
|
507
|
+
***
|
|
508
|
+
|
|
381
509
|
### ipfsBearerToken? {#ipfsbearertoken}
|
|
382
510
|
|
|
383
511
|
> `optional` **ipfsBearerToken?**: `string`
|
|
@@ -583,7 +711,7 @@ Hashicorp Vault endpoint.
|
|
|
583
711
|
|
|
584
712
|
> `optional` **loggingConnector?**: `string`
|
|
585
713
|
|
|
586
|
-
The type of logging task connector, can be a comma separated list: console, entity-storage,
|
|
714
|
+
The type of logging task connector, can be a comma separated list: console, entity-storage, open-telemetry, file.
|
|
587
715
|
|
|
588
716
|
***
|
|
589
717
|
|
|
@@ -895,6 +1023,62 @@ Maximum number of values retained per telemetry metric (count-based history cap)
|
|
|
895
1023
|
|
|
896
1024
|
***
|
|
897
1025
|
|
|
1026
|
+
### telemetryMutexTimeout? {#telemetrymutextimeout}
|
|
1027
|
+
|
|
1028
|
+
> `optional` **telemetryMutexTimeout?**: `string`
|
|
1029
|
+
|
|
1030
|
+
The mutex timeout in milliseconds for the telemetry connector.
|
|
1031
|
+
|
|
1032
|
+
***
|
|
1033
|
+
|
|
1034
|
+
### tracingConnector? {#tracingconnector}
|
|
1035
|
+
|
|
1036
|
+
> `optional` **tracingConnector?**: `string`
|
|
1037
|
+
|
|
1038
|
+
The type of tracing connector: entity-storage, open-telemetry.
|
|
1039
|
+
|
|
1040
|
+
***
|
|
1041
|
+
|
|
1042
|
+
### openTelemetryTracingTracerName? {#opentelemetrytracingtracername}
|
|
1043
|
+
|
|
1044
|
+
> `optional` **openTelemetryTracingTracerName?**: `string`
|
|
1045
|
+
|
|
1046
|
+
The name of the Open Telemetry tracer to use, only required if using open-telemetry as tracing connector, defaults to twin-node.
|
|
1047
|
+
|
|
1048
|
+
***
|
|
1049
|
+
|
|
1050
|
+
### openTelemetryTracingTracerVersion? {#opentelemetrytracingtracerversion}
|
|
1051
|
+
|
|
1052
|
+
> `optional` **openTelemetryTracingTracerVersion?**: `string`
|
|
1053
|
+
|
|
1054
|
+
The version of the Open Telemetry tracing specification to use, only required if using open-telemetry as tracing connector, defaults to 1.0.0.
|
|
1055
|
+
|
|
1056
|
+
***
|
|
1057
|
+
|
|
1058
|
+
### openTelemetryTracingEndpoint? {#opentelemetrytracingendpoint}
|
|
1059
|
+
|
|
1060
|
+
> `optional` **openTelemetryTracingEndpoint?**: `string`
|
|
1061
|
+
|
|
1062
|
+
The OTLP HTTP endpoint to push spans to, e.g. http://localhost:4318/v1/traces. Required when using open-telemetry as tracing connector.
|
|
1063
|
+
|
|
1064
|
+
***
|
|
1065
|
+
|
|
1066
|
+
### openTelemetryTracingProcessor? {#opentelemetrytracingprocessor}
|
|
1067
|
+
|
|
1068
|
+
> `optional` **openTelemetryTracingProcessor?**: `string`
|
|
1069
|
+
|
|
1070
|
+
The span processor: batch (default) or simple. Only used when TWIN_TRACING_CONNECTOR=open-telemetry.
|
|
1071
|
+
|
|
1072
|
+
***
|
|
1073
|
+
|
|
1074
|
+
### tracingMutexTimeout? {#tracingmutextimeout}
|
|
1075
|
+
|
|
1076
|
+
> `optional` **tracingMutexTimeout?**: `string`
|
|
1077
|
+
|
|
1078
|
+
The mutex timeout in milliseconds for the tracing connector.
|
|
1079
|
+
|
|
1080
|
+
***
|
|
1081
|
+
|
|
898
1082
|
### faucetConnector? {#faucetconnector}
|
|
899
1083
|
|
|
900
1084
|
> `optional` **faucetConnector?**: `string`
|
|
@@ -951,14 +1135,46 @@ The index of the wallet address to use, defaults to 0.
|
|
|
951
1135
|
|
|
952
1136
|
***
|
|
953
1137
|
|
|
954
|
-
###
|
|
1138
|
+
### identityDidResolutionCacheTtl? {#identitydidresolutioncachettl}
|
|
955
1139
|
|
|
956
|
-
> `optional` **
|
|
1140
|
+
> `optional` **identityDidResolutionCacheTtl?**: `string`
|
|
957
1141
|
|
|
958
1142
|
The TTL in milliseconds for caching resolved DIDs when using the IOTA identity connector. Omit to use the connector default.
|
|
959
1143
|
|
|
960
1144
|
***
|
|
961
1145
|
|
|
1146
|
+
### identityDidResolutionCacheCapacity? {#identitydidresolutioncachecapacity}
|
|
1147
|
+
|
|
1148
|
+
> `optional` **identityDidResolutionCacheCapacity?**: `string`
|
|
1149
|
+
|
|
1150
|
+
The maximum number of DID documents to hold in the resolution cache. Only used when using the IOTA identity connector and caching is enabled.
|
|
1151
|
+
|
|
1152
|
+
***
|
|
1153
|
+
|
|
1154
|
+
### identityDidResolutionCacheMutexTimeout? {#identitydidresolutioncachemutextimeout}
|
|
1155
|
+
|
|
1156
|
+
> `optional` **identityDidResolutionCacheMutexTimeout?**: `string`
|
|
1157
|
+
|
|
1158
|
+
The mutex timeout in milliseconds for the DID resolution cache. Only used when using the IOTA identity connector and caching is enabled.
|
|
1159
|
+
|
|
1160
|
+
***
|
|
1161
|
+
|
|
1162
|
+
### identityDidResolutionRetries? {#identitydidresolutionretries}
|
|
1163
|
+
|
|
1164
|
+
> `optional` **identityDidResolutionRetries?**: `string`
|
|
1165
|
+
|
|
1166
|
+
The number of times to retry resolving a DID after a write operation (create, update, or delete) to confirm propagation. Only used when using the IOTA identity connector.
|
|
1167
|
+
|
|
1168
|
+
***
|
|
1169
|
+
|
|
1170
|
+
### identityDidResolutionRetryDelay? {#identitydidresolutionretrydelay}
|
|
1171
|
+
|
|
1172
|
+
> `optional` **identityDidResolutionRetryDelay?**: `string`
|
|
1173
|
+
|
|
1174
|
+
The delay in milliseconds between DID resolution retries after a write operation. Only used when using the IOTA identity connector.
|
|
1175
|
+
|
|
1176
|
+
***
|
|
1177
|
+
|
|
962
1178
|
### identityResolverConnector? {#identityresolverconnector}
|
|
963
1179
|
|
|
964
1180
|
> `optional` **identityResolverConnector?**: `string`
|
|
@@ -1071,6 +1287,127 @@ The identity verification method id to use with immutable proofs.
|
|
|
1071
1287
|
|
|
1072
1288
|
***
|
|
1073
1289
|
|
|
1290
|
+
### immutableProofTaskRetryCount? {#immutableprooftaskretrycount}
|
|
1291
|
+
|
|
1292
|
+
> `optional` **immutableProofTaskRetryCount?**: `string`
|
|
1293
|
+
|
|
1294
|
+
The number of times to retry a proof task when it fails, 0 to disable retries.
|
|
1295
|
+
|
|
1296
|
+
#### Default
|
|
1297
|
+
|
|
1298
|
+
```ts
|
|
1299
|
+
5
|
|
1300
|
+
```
|
|
1301
|
+
|
|
1302
|
+
***
|
|
1303
|
+
|
|
1304
|
+
### immutableProofTaskRetryInterval? {#immutableprooftaskretryinterval}
|
|
1305
|
+
|
|
1306
|
+
> `optional` **immutableProofTaskRetryInterval?**: `string`
|
|
1307
|
+
|
|
1308
|
+
The interval in seconds to wait between proof task retries.
|
|
1309
|
+
|
|
1310
|
+
#### Default
|
|
1311
|
+
|
|
1312
|
+
```ts
|
|
1313
|
+
5
|
|
1314
|
+
```
|
|
1315
|
+
|
|
1316
|
+
***
|
|
1317
|
+
|
|
1318
|
+
### immutableProofTaskFailureRetainFor? {#immutableprooftaskfailureretainfor}
|
|
1319
|
+
|
|
1320
|
+
> `optional` **immutableProofTaskFailureRetainFor?**: `string`
|
|
1321
|
+
|
|
1322
|
+
The time in minutes to retain the record of a failed proof task.
|
|
1323
|
+
Set to -1 to retain failures forever.
|
|
1324
|
+
|
|
1325
|
+
#### Default
|
|
1326
|
+
|
|
1327
|
+
```ts
|
|
1328
|
+
10080
|
|
1329
|
+
```
|
|
1330
|
+
|
|
1331
|
+
***
|
|
1332
|
+
|
|
1333
|
+
### immutableProofSweepInterval? {#immutableproofsweepinterval}
|
|
1334
|
+
|
|
1335
|
+
> `optional` **immutableProofSweepInterval?**: `string`
|
|
1336
|
+
|
|
1337
|
+
How often in minutes the immutable proof reconciliation sweep runs.
|
|
1338
|
+
|
|
1339
|
+
#### Default
|
|
1340
|
+
|
|
1341
|
+
```ts
|
|
1342
|
+
30
|
|
1343
|
+
```
|
|
1344
|
+
|
|
1345
|
+
***
|
|
1346
|
+
|
|
1347
|
+
### immutableProofSweepStaleThreshold? {#immutableproofsweepstalethreshold}
|
|
1348
|
+
|
|
1349
|
+
> `optional` **immutableProofSweepStaleThreshold?**: `string`
|
|
1350
|
+
|
|
1351
|
+
The minimum age in minutes before a proof with no notarization is considered stuck.
|
|
1352
|
+
|
|
1353
|
+
#### Default
|
|
1354
|
+
|
|
1355
|
+
```ts
|
|
1356
|
+
180
|
|
1357
|
+
```
|
|
1358
|
+
|
|
1359
|
+
***
|
|
1360
|
+
|
|
1361
|
+
### immutableProofSweepMaxAttempts? {#immutableproofsweepmaxattempts}
|
|
1362
|
+
|
|
1363
|
+
> `optional` **immutableProofSweepMaxAttempts?**: `string`
|
|
1364
|
+
|
|
1365
|
+
The number of sweep attempts made before a proof is parked.
|
|
1366
|
+
|
|
1367
|
+
#### Default
|
|
1368
|
+
|
|
1369
|
+
```ts
|
|
1370
|
+
5
|
|
1371
|
+
```
|
|
1372
|
+
|
|
1373
|
+
***
|
|
1374
|
+
|
|
1375
|
+
### immutableProofSweepBatchLimit? {#immutableproofsweepbatchlimit}
|
|
1376
|
+
|
|
1377
|
+
> `optional` **immutableProofSweepBatchLimit?**: `string`
|
|
1378
|
+
|
|
1379
|
+
The maximum number of proofs to re-enqueue per tenant per sweep cycle.
|
|
1380
|
+
|
|
1381
|
+
#### Default
|
|
1382
|
+
|
|
1383
|
+
```ts
|
|
1384
|
+
10
|
|
1385
|
+
```
|
|
1386
|
+
|
|
1387
|
+
***
|
|
1388
|
+
|
|
1389
|
+
### immutableProofSweepBackoff? {#immutableproofsweepbackoff}
|
|
1390
|
+
|
|
1391
|
+
> `optional` **immutableProofSweepBackoff?**: `string`
|
|
1392
|
+
|
|
1393
|
+
The minimum time in minutes between sweep attempts for the same proof.
|
|
1394
|
+
|
|
1395
|
+
#### Default
|
|
1396
|
+
|
|
1397
|
+
```ts
|
|
1398
|
+
60
|
|
1399
|
+
```
|
|
1400
|
+
|
|
1401
|
+
***
|
|
1402
|
+
|
|
1403
|
+
### immutableProofSweepAssumeRetryableBefore? {#immutableproofsweepassumeretryablebefore}
|
|
1404
|
+
|
|
1405
|
+
> `optional` **immutableProofSweepAssumeRetryableBefore?**: `string`
|
|
1406
|
+
|
|
1407
|
+
ISO 8601 date-time used to treat older missing-task proofs as retryable.
|
|
1408
|
+
|
|
1409
|
+
***
|
|
1410
|
+
|
|
1074
1411
|
### attestationConnector? {#attestationconnector}
|
|
1075
1412
|
|
|
1076
1413
|
> `optional` **attestationConnector?**: `string`
|
|
@@ -1332,6 +1669,62 @@ The interval in seconds for cleaning up the activity logs.
|
|
|
1332
1669
|
|
|
1333
1670
|
***
|
|
1334
1671
|
|
|
1672
|
+
### dataspaceAgreementCacheTtl? {#dataspaceagreementcachettl}
|
|
1673
|
+
|
|
1674
|
+
> `optional` **dataspaceAgreementCacheTtl?**: `string`
|
|
1675
|
+
|
|
1676
|
+
The TTL in milliseconds for the dataspace agreement cache.
|
|
1677
|
+
|
|
1678
|
+
***
|
|
1679
|
+
|
|
1680
|
+
### dataspaceAgreementCacheMutexTimeout? {#dataspaceagreementcachemutextimeout}
|
|
1681
|
+
|
|
1682
|
+
> `optional` **dataspaceAgreementCacheMutexTimeout?**: `string`
|
|
1683
|
+
|
|
1684
|
+
The mutex timeout in milliseconds for the dataspace agreement cache.
|
|
1685
|
+
|
|
1686
|
+
***
|
|
1687
|
+
|
|
1688
|
+
### dataspaceRetryCount? {#dataspaceretrycount}
|
|
1689
|
+
|
|
1690
|
+
> `optional` **dataspaceRetryCount?**: `string`
|
|
1691
|
+
|
|
1692
|
+
The number of times to retry failed data plane tasks.
|
|
1693
|
+
|
|
1694
|
+
***
|
|
1695
|
+
|
|
1696
|
+
### dataspacePushRetryCount? {#dataspacepushretrycount}
|
|
1697
|
+
|
|
1698
|
+
> `optional` **dataspacePushRetryCount?**: `string`
|
|
1699
|
+
|
|
1700
|
+
Maximum HTTP retry attempts per push delivery task execution.
|
|
1701
|
+
|
|
1702
|
+
***
|
|
1703
|
+
|
|
1704
|
+
### dataspacePushRetryBaseDelay? {#dataspacepushretrybasedelay}
|
|
1705
|
+
|
|
1706
|
+
> `optional` **dataspacePushRetryBaseDelay?**: `string`
|
|
1707
|
+
|
|
1708
|
+
Base delay in milliseconds for exponential backoff between push HTTP retries.
|
|
1709
|
+
|
|
1710
|
+
***
|
|
1711
|
+
|
|
1712
|
+
### dataspacePushTimeout? {#dataspacepushtimeout}
|
|
1713
|
+
|
|
1714
|
+
> `optional` **dataspacePushTimeout?**: `string`
|
|
1715
|
+
|
|
1716
|
+
Timeout in milliseconds for each push delivery HTTP POST request.
|
|
1717
|
+
|
|
1718
|
+
***
|
|
1719
|
+
|
|
1720
|
+
### dataspacePushSubscriptionCleanupInterval? {#dataspacepushsubscriptioncleanupinterval}
|
|
1721
|
+
|
|
1722
|
+
> `optional` **dataspacePushSubscriptionCleanupInterval?**: `string`
|
|
1723
|
+
|
|
1724
|
+
Interval in milliseconds between orphaned push subscription cleanup scans.
|
|
1725
|
+
|
|
1726
|
+
***
|
|
1727
|
+
|
|
1335
1728
|
### dataspaceDataPlanePath? {#dataspacedataplanepath}
|
|
1336
1729
|
|
|
1337
1730
|
> `optional` **dataspaceDataPlanePath?**: `string`
|
|
@@ -1341,7 +1734,7 @@ Combined with the public origin to form the `dataAddress.endpoint` sent to PULL
|
|
|
1341
1734
|
and the inbox URL sent to PUSH providers.
|
|
1342
1735
|
|
|
1343
1736
|
This must be the mount-point prefix of the data plane routes, NOT a specific route path.
|
|
1344
|
-
Do NOT append sub-paths such as `/entities` or `/inbox`
|
|
1737
|
+
Do NOT append sub-paths such as `/entities` or `/inbox` - those are appended automatically
|
|
1345
1738
|
by each transfer handler and by the data plane REST client.
|
|
1346
1739
|
|
|
1347
1740
|
REQUIRED if PULL or PUSH transfers are supported.
|
|
@@ -1395,6 +1788,22 @@ progressing it before it is treated as timed out.
|
|
|
1395
1788
|
|
|
1396
1789
|
***
|
|
1397
1790
|
|
|
1791
|
+
### dataspaceProviderTransferIdleTimeout? {#dataspaceprovidertransferidletimeout}
|
|
1792
|
+
|
|
1793
|
+
> `optional` **dataspaceProviderTransferIdleTimeout?**: `string`
|
|
1794
|
+
|
|
1795
|
+
How long in seconds a provider transfer may stay idle before the idle policy marks it as stalled.
|
|
1796
|
+
|
|
1797
|
+
***
|
|
1798
|
+
|
|
1799
|
+
### dataspaceProviderTransferPolicySweepInterval? {#dataspaceprovidertransferpolicysweepinterval}
|
|
1800
|
+
|
|
1801
|
+
> `optional` **dataspaceProviderTransferPolicySweepInterval?**: `string`
|
|
1802
|
+
|
|
1803
|
+
How frequently in seconds the provider idle transfer policy sweep runs.
|
|
1804
|
+
|
|
1805
|
+
***
|
|
1806
|
+
|
|
1398
1807
|
### dataspaceCallbackPath? {#dataspacecallbackpath}
|
|
1399
1808
|
|
|
1400
1809
|
> `optional` **dataspaceCallbackPath?**: `string`
|
|
@@ -1436,6 +1845,14 @@ This allows components that take a long time to initialize to be healthy before
|
|
|
1436
1845
|
|
|
1437
1846
|
***
|
|
1438
1847
|
|
|
1848
|
+
### healthApplicationInterval? {#healthapplicationinterval}
|
|
1849
|
+
|
|
1850
|
+
> `optional` **healthApplicationInterval?**: `string`
|
|
1851
|
+
|
|
1852
|
+
The interval in seconds for running the application health lifecycle (init, application, teardown), defaults to 300.
|
|
1853
|
+
|
|
1854
|
+
***
|
|
1855
|
+
|
|
1439
1856
|
### automationActionTypes? {#automationactiontypes}
|
|
1440
1857
|
|
|
1441
1858
|
> `optional` **automationActionTypes?**: `string`
|
|
@@ -1445,9 +1862,9 @@ values: fetch
|
|
|
1445
1862
|
|
|
1446
1863
|
***
|
|
1447
1864
|
|
|
1448
|
-
###
|
|
1865
|
+
### mutexTimeoutDefault? {#mutextimeoutdefault}
|
|
1449
1866
|
|
|
1450
|
-
> `optional` **
|
|
1867
|
+
> `optional` **mutexTimeoutDefault?**: `string`
|
|
1451
1868
|
|
|
1452
1869
|
The default mutex timeout in milliseconds, used when no component-specific timeout is set, defaults to 5000 if omitted.
|
|
1453
1870
|
|
|
@@ -1493,19 +1910,11 @@ The mutex timeout in milliseconds for the logging component.
|
|
|
1493
1910
|
|
|
1494
1911
|
***
|
|
1495
1912
|
|
|
1496
|
-
###
|
|
1497
|
-
|
|
1498
|
-
> `optional` **entityStorageMemoryMutexTimeout?**: `string`
|
|
1499
|
-
|
|
1500
|
-
The mutex timeout in milliseconds for the memory entity storage connector.
|
|
1501
|
-
|
|
1502
|
-
***
|
|
1503
|
-
|
|
1504
|
-
### entityStorageFileMutexTimeout? {#entitystoragefilemutextimeout}
|
|
1913
|
+
### entityStorageMutexTimeout? {#entitystoragemutextimeout}
|
|
1505
1914
|
|
|
1506
|
-
> `optional` **
|
|
1915
|
+
> `optional` **entityStorageMutexTimeout?**: `string`
|
|
1507
1916
|
|
|
1508
|
-
The mutex timeout in milliseconds for the file entity storage
|
|
1917
|
+
The mutex timeout in milliseconds for the memory and file entity storage connectors.
|
|
1509
1918
|
|
|
1510
1919
|
***
|
|
1511
1920
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Type Alias: IEnvironmentVariables
|
|
2
2
|
|
|
3
|
-
> **IEnvironmentVariables** = [`
|
|
3
|
+
> **IEnvironmentVariables** = [`IBootstrapDevEnvironmentVariables`](../interfaces/IBootstrapDevEnvironmentVariables.md) & [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & [`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md) & [`IEngineServerEnvironmentVariables`](../interfaces/IEngineServerEnvironmentVariables.md)
|
|
4
4
|
|
|
5
5
|
The environment variables.
|
package/locales/en.json
CHANGED
|
@@ -14,10 +14,11 @@
|
|
|
14
14
|
"cliCommandParamMissing": "Parameter \"{param}\" is required for command \"{command}\"",
|
|
15
15
|
"cliCommandParamExtra": "Parameter(s) \"{params}\" are not recognised for command \"{command}\"",
|
|
16
16
|
"cliEnvVarMissing": "Environment variable \"{envVar}\" does not exist",
|
|
17
|
+
"invalidEnvVarValue": "Environment variable \"{key}\" has an invalid value \"{value}\", expected {type} type",
|
|
17
18
|
"unknownEnvVars": "Unknown environment variable properties [{keys}]. Check for typos in variable names, for custom variables use the {prefix}ENV_ALLOW_LIST."
|
|
18
19
|
},
|
|
19
|
-
"
|
|
20
|
-
"noFeaturesEnabled": "No features are enabled
|
|
20
|
+
"bootstrapDev": {
|
|
21
|
+
"noFeaturesEnabled": "No features are enabled, at least one feature must be enabled.",
|
|
21
22
|
"organizationNotSet": "The organisation identity has not been set. Run \"node-org-id-set\"."
|
|
22
23
|
},
|
|
23
24
|
"identityCreate": {
|
|
@@ -129,9 +130,9 @@
|
|
|
129
130
|
"singleTenantOnly": "single-tenant only"
|
|
130
131
|
}
|
|
131
132
|
},
|
|
132
|
-
"bootstrap-
|
|
133
|
-
"description": "Bootstrap
|
|
134
|
-
"example": "bootstrap-
|
|
133
|
+
"bootstrap-dev": {
|
|
134
|
+
"description": "Bootstrap the development environment",
|
|
135
|
+
"example": "bootstrap-dev --load-env=\"./.env.bootstrap-dev\"",
|
|
135
136
|
"params": {
|
|
136
137
|
"env-prefix": {
|
|
137
138
|
"description": "Prefix to use for standard .env files e.g. TWIN_."
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/node-core",
|
|
3
|
-
"version": "0.9.2-next.
|
|
3
|
+
"version": "0.9.2-next.11",
|
|
4
4
|
"description": "TWIN Node Core for serving APIs using the specified configuration",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -14,13 +14,17 @@
|
|
|
14
14
|
"node": ">=24.0.0"
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
+
"@twin.org/api-auth-entity-storage-models": "next",
|
|
17
18
|
"@twin.org/api-auth-entity-storage-service": "next",
|
|
19
|
+
"@twin.org/api-models": "next",
|
|
18
20
|
"@twin.org/api-tenant-processor": "next",
|
|
19
21
|
"@twin.org/cli-core": "next",
|
|
20
22
|
"@twin.org/context": "next",
|
|
21
23
|
"@twin.org/core": "next",
|
|
22
24
|
"@twin.org/crypto": "next",
|
|
23
|
-
"@twin.org/
|
|
25
|
+
"@twin.org/data-json-ld": "next",
|
|
26
|
+
"@twin.org/dlt-account": "next",
|
|
27
|
+
"@twin.org/dlt-iota": "next",
|
|
24
28
|
"@twin.org/engine": "next",
|
|
25
29
|
"@twin.org/engine-core": "next",
|
|
26
30
|
"@twin.org/engine-models": "next",
|
|
@@ -29,16 +33,19 @@
|
|
|
29
33
|
"@twin.org/engine-types": "next",
|
|
30
34
|
"@twin.org/entity": "next",
|
|
31
35
|
"@twin.org/entity-storage-models": "next",
|
|
36
|
+
"@twin.org/identity-connector-entity-storage": "next",
|
|
32
37
|
"@twin.org/identity-models": "next",
|
|
33
38
|
"@twin.org/logging-connector-opentelemetry": "next",
|
|
34
39
|
"@twin.org/modules": "next",
|
|
40
|
+
"@twin.org/nameof": "next",
|
|
35
41
|
"@twin.org/standards-w3c-did": "next",
|
|
36
42
|
"@twin.org/standards-w3c-odrl": "next",
|
|
37
43
|
"@twin.org/telemetry-connector-opentelemetry": "next",
|
|
38
|
-
"@twin.org/
|
|
39
|
-
"@twin.org/trust-models": "next",
|
|
44
|
+
"@twin.org/tracing-connector-opentelemetry": "next",
|
|
40
45
|
"@twin.org/vault-models": "next",
|
|
46
|
+
"@twin.org/wallet-connector-entity-storage": "next",
|
|
41
47
|
"@twin.org/wallet-models": "next",
|
|
48
|
+
"@twin.org/web": "next",
|
|
42
49
|
"dotenv": "17.4.2",
|
|
43
50
|
"schema-dts": "2.0.0"
|
|
44
51
|
},
|