@twin.org/node-core 0.9.2-next.5 → 0.9.2-next.7
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 +138 -101
- package/dist/es/builders/engineEnvBuilder.js.map +1 -1
- package/dist/es/builders/helper/envHelpers.js +181 -0
- package/dist/es/builders/helper/envHelpers.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/models/IEngineEnvironmentVariables.js.map +1 -1
- package/dist/es/models/engineEnvironmentVariableKeys.js +17 -2
- 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 +1 -1
- package/dist/es/node.js.map +1 -1
- package/dist/types/builders/helper/envHelpers.d.ts +80 -0
- package/dist/types/models/IEngineEnvironmentVariables.d.ts +75 -14
- package/docs/changelog.md +16 -0
- package/docs/reference/interfaces/IEngineEnvironmentVariables.md +161 -19
- package/locales/en.json +1 -0
- package/package.json +11 -4
|
@@ -268,7 +268,7 @@ MySQL host.
|
|
|
268
268
|
|
|
269
269
|
### mySqlPort? {#mysqlport}
|
|
270
270
|
|
|
271
|
-
> `optional` **mySqlPort?**: `
|
|
271
|
+
> `optional` **mySqlPort?**: `string`
|
|
272
272
|
|
|
273
273
|
MySQL port.
|
|
274
274
|
|
|
@@ -308,7 +308,7 @@ MongoDB host.
|
|
|
308
308
|
|
|
309
309
|
### mongoDbPort? {#mongodbport}
|
|
310
310
|
|
|
311
|
-
> `optional` **mongoDbPort?**: `
|
|
311
|
+
> `optional` **mongoDbPort?**: `string`
|
|
312
312
|
|
|
313
313
|
MongoDB port.
|
|
314
314
|
|
|
@@ -348,7 +348,7 @@ PostgreSQl host.
|
|
|
348
348
|
|
|
349
349
|
### postgreSqlPort? {#postgresqlport}
|
|
350
350
|
|
|
351
|
-
> `optional` **postgreSqlPort?**: `
|
|
351
|
+
> `optional` **postgreSqlPort?**: `string`
|
|
352
352
|
|
|
353
353
|
PostgreSQl port.
|
|
354
354
|
|
|
@@ -583,7 +583,7 @@ Hashicorp Vault endpoint.
|
|
|
583
583
|
|
|
584
584
|
> `optional` **loggingConnector?**: `string`
|
|
585
585
|
|
|
586
|
-
The type of logging task connector, can be a comma separated list: console, entity-storage,
|
|
586
|
+
The type of logging task connector, can be a comma separated list: console, entity-storage, open-telemetry, file.
|
|
587
587
|
|
|
588
588
|
***
|
|
589
589
|
|
|
@@ -903,6 +903,54 @@ The mutex timeout in milliseconds for the telemetry connector.
|
|
|
903
903
|
|
|
904
904
|
***
|
|
905
905
|
|
|
906
|
+
### tracingConnector? {#tracingconnector}
|
|
907
|
+
|
|
908
|
+
> `optional` **tracingConnector?**: `string`
|
|
909
|
+
|
|
910
|
+
The type of tracing connector: entity-storage, open-telemetry.
|
|
911
|
+
|
|
912
|
+
***
|
|
913
|
+
|
|
914
|
+
### openTelemetryTracingTracerName? {#opentelemetrytracingtracername}
|
|
915
|
+
|
|
916
|
+
> `optional` **openTelemetryTracingTracerName?**: `string`
|
|
917
|
+
|
|
918
|
+
The name of the Open Telemetry tracer to use, only required if using open-telemetry as tracing connector, defaults to twin-node.
|
|
919
|
+
|
|
920
|
+
***
|
|
921
|
+
|
|
922
|
+
### openTelemetryTracingTracerVersion? {#opentelemetrytracingtracerversion}
|
|
923
|
+
|
|
924
|
+
> `optional` **openTelemetryTracingTracerVersion?**: `string`
|
|
925
|
+
|
|
926
|
+
The version of the Open Telemetry tracing specification to use, only required if using open-telemetry as tracing connector, defaults to 1.0.0.
|
|
927
|
+
|
|
928
|
+
***
|
|
929
|
+
|
|
930
|
+
### openTelemetryTracingEndpoint? {#opentelemetrytracingendpoint}
|
|
931
|
+
|
|
932
|
+
> `optional` **openTelemetryTracingEndpoint?**: `string`
|
|
933
|
+
|
|
934
|
+
The OTLP HTTP endpoint to push spans to, e.g. http://localhost:4318/v1/traces. Required when using open-telemetry as tracing connector.
|
|
935
|
+
|
|
936
|
+
***
|
|
937
|
+
|
|
938
|
+
### openTelemetryTracingProcessor? {#opentelemetrytracingprocessor}
|
|
939
|
+
|
|
940
|
+
> `optional` **openTelemetryTracingProcessor?**: `string`
|
|
941
|
+
|
|
942
|
+
The span processor: batch (default) or simple. Only used when TWIN_TRACING_CONNECTOR=open-telemetry.
|
|
943
|
+
|
|
944
|
+
***
|
|
945
|
+
|
|
946
|
+
### tracingMutexTimeout? {#tracingmutextimeout}
|
|
947
|
+
|
|
948
|
+
> `optional` **tracingMutexTimeout?**: `string`
|
|
949
|
+
|
|
950
|
+
The mutex timeout in milliseconds for the tracing connector.
|
|
951
|
+
|
|
952
|
+
***
|
|
953
|
+
|
|
906
954
|
### faucetConnector? {#faucetconnector}
|
|
907
955
|
|
|
908
956
|
> `optional` **faucetConnector?**: `string`
|
|
@@ -1081,7 +1129,7 @@ The identity verification method id to use with immutable proofs.
|
|
|
1081
1129
|
|
|
1082
1130
|
### immutableProofTaskRetryCount? {#immutableprooftaskretrycount}
|
|
1083
1131
|
|
|
1084
|
-
> `optional` **immutableProofTaskRetryCount?**: `
|
|
1132
|
+
> `optional` **immutableProofTaskRetryCount?**: `string`
|
|
1085
1133
|
|
|
1086
1134
|
The number of times to retry a proof task when it fails, 0 to disable retries.
|
|
1087
1135
|
|
|
@@ -1095,7 +1143,7 @@ The number of times to retry a proof task when it fails, 0 to disable retries.
|
|
|
1095
1143
|
|
|
1096
1144
|
### immutableProofTaskRetryInterval? {#immutableprooftaskretryinterval}
|
|
1097
1145
|
|
|
1098
|
-
> `optional` **immutableProofTaskRetryInterval?**: `
|
|
1146
|
+
> `optional` **immutableProofTaskRetryInterval?**: `string`
|
|
1099
1147
|
|
|
1100
1148
|
The interval in seconds to wait between proof task retries.
|
|
1101
1149
|
|
|
@@ -1109,7 +1157,7 @@ The interval in seconds to wait between proof task retries.
|
|
|
1109
1157
|
|
|
1110
1158
|
### immutableProofTaskFailureRetainFor? {#immutableprooftaskfailureretainfor}
|
|
1111
1159
|
|
|
1112
|
-
> `optional` **immutableProofTaskFailureRetainFor?**: `
|
|
1160
|
+
> `optional` **immutableProofTaskFailureRetainFor?**: `string`
|
|
1113
1161
|
|
|
1114
1162
|
The time in minutes to retain the record of a failed proof task.
|
|
1115
1163
|
Set to -1 to retain failures forever.
|
|
@@ -1122,6 +1170,84 @@ Set to -1 to retain failures forever.
|
|
|
1122
1170
|
|
|
1123
1171
|
***
|
|
1124
1172
|
|
|
1173
|
+
### immutableProofSweepInterval? {#immutableproofsweepinterval}
|
|
1174
|
+
|
|
1175
|
+
> `optional` **immutableProofSweepInterval?**: `string`
|
|
1176
|
+
|
|
1177
|
+
How often in minutes the immutable proof reconciliation sweep runs.
|
|
1178
|
+
|
|
1179
|
+
#### Default
|
|
1180
|
+
|
|
1181
|
+
```ts
|
|
1182
|
+
30
|
|
1183
|
+
```
|
|
1184
|
+
|
|
1185
|
+
***
|
|
1186
|
+
|
|
1187
|
+
### immutableProofSweepStaleThreshold? {#immutableproofsweepstalethreshold}
|
|
1188
|
+
|
|
1189
|
+
> `optional` **immutableProofSweepStaleThreshold?**: `string`
|
|
1190
|
+
|
|
1191
|
+
The minimum age in minutes before a proof with no notarization is considered stuck.
|
|
1192
|
+
|
|
1193
|
+
#### Default
|
|
1194
|
+
|
|
1195
|
+
```ts
|
|
1196
|
+
180
|
|
1197
|
+
```
|
|
1198
|
+
|
|
1199
|
+
***
|
|
1200
|
+
|
|
1201
|
+
### immutableProofSweepMaxAttempts? {#immutableproofsweepmaxattempts}
|
|
1202
|
+
|
|
1203
|
+
> `optional` **immutableProofSweepMaxAttempts?**: `string`
|
|
1204
|
+
|
|
1205
|
+
The number of sweep attempts made before a proof is parked.
|
|
1206
|
+
|
|
1207
|
+
#### Default
|
|
1208
|
+
|
|
1209
|
+
```ts
|
|
1210
|
+
5
|
|
1211
|
+
```
|
|
1212
|
+
|
|
1213
|
+
***
|
|
1214
|
+
|
|
1215
|
+
### immutableProofSweepBatchLimit? {#immutableproofsweepbatchlimit}
|
|
1216
|
+
|
|
1217
|
+
> `optional` **immutableProofSweepBatchLimit?**: `string`
|
|
1218
|
+
|
|
1219
|
+
The maximum number of proofs to re-enqueue per tenant per sweep cycle.
|
|
1220
|
+
|
|
1221
|
+
#### Default
|
|
1222
|
+
|
|
1223
|
+
```ts
|
|
1224
|
+
10
|
|
1225
|
+
```
|
|
1226
|
+
|
|
1227
|
+
***
|
|
1228
|
+
|
|
1229
|
+
### immutableProofSweepBackoff? {#immutableproofsweepbackoff}
|
|
1230
|
+
|
|
1231
|
+
> `optional` **immutableProofSweepBackoff?**: `string`
|
|
1232
|
+
|
|
1233
|
+
The minimum time in minutes between sweep attempts for the same proof.
|
|
1234
|
+
|
|
1235
|
+
#### Default
|
|
1236
|
+
|
|
1237
|
+
```ts
|
|
1238
|
+
60
|
|
1239
|
+
```
|
|
1240
|
+
|
|
1241
|
+
***
|
|
1242
|
+
|
|
1243
|
+
### immutableProofSweepAssumeRetryableBefore? {#immutableproofsweepassumeretryablebefore}
|
|
1244
|
+
|
|
1245
|
+
> `optional` **immutableProofSweepAssumeRetryableBefore?**: `string`
|
|
1246
|
+
|
|
1247
|
+
ISO 8601 date-time used to treat older missing-task proofs as retryable.
|
|
1248
|
+
|
|
1249
|
+
***
|
|
1250
|
+
|
|
1125
1251
|
### attestationConnector? {#attestationconnector}
|
|
1126
1252
|
|
|
1127
1253
|
> `optional` **attestationConnector?**: `string`
|
|
@@ -1392,7 +1518,7 @@ Combined with the public origin to form the `dataAddress.endpoint` sent to PULL
|
|
|
1392
1518
|
and the inbox URL sent to PUSH providers.
|
|
1393
1519
|
|
|
1394
1520
|
This must be the mount-point prefix of the data plane routes, NOT a specific route path.
|
|
1395
|
-
Do NOT append sub-paths such as `/entities` or `/inbox`
|
|
1521
|
+
Do NOT append sub-paths such as `/entities` or `/inbox` - those are appended automatically
|
|
1396
1522
|
by each transfer handler and by the data plane REST client.
|
|
1397
1523
|
|
|
1398
1524
|
REQUIRED if PULL or PUSH transfers are supported.
|
|
@@ -1446,6 +1572,22 @@ progressing it before it is treated as timed out.
|
|
|
1446
1572
|
|
|
1447
1573
|
***
|
|
1448
1574
|
|
|
1575
|
+
### dataspaceProviderTransferIdleTimeout? {#dataspaceprovidertransferidletimeout}
|
|
1576
|
+
|
|
1577
|
+
> `optional` **dataspaceProviderTransferIdleTimeout?**: `string`
|
|
1578
|
+
|
|
1579
|
+
How long in seconds a provider transfer may stay idle before the idle policy marks it as stalled.
|
|
1580
|
+
|
|
1581
|
+
***
|
|
1582
|
+
|
|
1583
|
+
### dataspaceProviderTransferPolicySweepInterval? {#dataspaceprovidertransferpolicysweepinterval}
|
|
1584
|
+
|
|
1585
|
+
> `optional` **dataspaceProviderTransferPolicySweepInterval?**: `string`
|
|
1586
|
+
|
|
1587
|
+
How frequently in seconds the provider idle transfer policy sweep runs.
|
|
1588
|
+
|
|
1589
|
+
***
|
|
1590
|
+
|
|
1449
1591
|
### dataspaceCallbackPath? {#dataspacecallbackpath}
|
|
1450
1592
|
|
|
1451
1593
|
> `optional` **dataspaceCallbackPath?**: `string`
|
|
@@ -1487,6 +1629,14 @@ This allows components that take a long time to initialize to be healthy before
|
|
|
1487
1629
|
|
|
1488
1630
|
***
|
|
1489
1631
|
|
|
1632
|
+
### healthApplicationInterval? {#healthapplicationinterval}
|
|
1633
|
+
|
|
1634
|
+
> `optional` **healthApplicationInterval?**: `string`
|
|
1635
|
+
|
|
1636
|
+
The interval in seconds for running the application health lifecycle (init, application, teardown), defaults to 300.
|
|
1637
|
+
|
|
1638
|
+
***
|
|
1639
|
+
|
|
1490
1640
|
### automationActionTypes? {#automationactiontypes}
|
|
1491
1641
|
|
|
1492
1642
|
> `optional` **automationActionTypes?**: `string`
|
|
@@ -1544,19 +1694,11 @@ The mutex timeout in milliseconds for the logging component.
|
|
|
1544
1694
|
|
|
1545
1695
|
***
|
|
1546
1696
|
|
|
1547
|
-
###
|
|
1548
|
-
|
|
1549
|
-
> `optional` **entityStorageMemoryMutexTimeout?**: `string`
|
|
1550
|
-
|
|
1551
|
-
The mutex timeout in milliseconds for the memory entity storage connector.
|
|
1552
|
-
|
|
1553
|
-
***
|
|
1554
|
-
|
|
1555
|
-
### entityStorageFileMutexTimeout? {#entitystoragefilemutextimeout}
|
|
1697
|
+
### entityStorageMutexTimeout? {#entitystoragemutextimeout}
|
|
1556
1698
|
|
|
1557
|
-
> `optional` **
|
|
1699
|
+
> `optional` **entityStorageMutexTimeout?**: `string`
|
|
1558
1700
|
|
|
1559
|
-
The mutex timeout in milliseconds for the file entity storage
|
|
1701
|
+
The mutex timeout in milliseconds for the memory and file entity storage connectors.
|
|
1560
1702
|
|
|
1561
1703
|
***
|
|
1562
1704
|
|
package/locales/en.json
CHANGED
|
@@ -14,6 +14,7 @@
|
|
|
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
|
"bootstrapDev": {
|
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.7",
|
|
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
|
},
|