@twin.org/node-core 0.9.2-next.9 → 0.9.2
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 +154 -83
- package/dist/es/builders/engineEnvBuilder.js.map +1 -1
- package/dist/es/builders/engineServerEnvBuilder.js +50 -14
- 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 +60 -74
- package/dist/es/builders/helper/envHelpers.js.map +1 -1
- package/dist/es/cli.js +2 -1
- package/dist/es/cli.js.map +1 -1
- package/dist/es/commands/bootstrapDev.js +5 -5
- package/dist/es/commands/bootstrapDev.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/models/IEngineEnvironmentVariables.js.map +1 -1
- package/dist/es/models/IEngineServerEnvironmentVariables.js.map +1 -1
- package/dist/es/models/engineEnvironmentVariableKeys.js +11 -0
- package/dist/es/models/engineEnvironmentVariableKeys.js.map +1 -1
- package/dist/es/models/engineServerEnvironmentVariableKeys.js +4 -1
- package/dist/es/models/engineServerEnvironmentVariableKeys.js.map +1 -1
- package/dist/es/node.js +3 -7
- 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/engineEnvBuilder.d.ts +9 -2
- package/dist/types/builders/helper/envHelpers.d.ts +81 -21
- package/dist/types/models/IEngineEnvironmentVariables.d.ts +49 -2
- package/dist/types/models/IEngineServerEnvironmentVariables.d.ts +12 -0
- package/docs/changelog.md +89 -0
- package/docs/reference/functions/{isTelemetryRequired.md → isTelemetryEnabled.md} +3 -3
- package/docs/reference/functions/isTracingEnabled.md +20 -0
- package/docs/reference/index.md +2 -1
- package/docs/reference/interfaces/IEngineEnvironmentVariables.md +108 -2
- package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +24 -0
- package/locales/en.json +1 -0
- package/package.json +34 -33
|
@@ -831,6 +831,14 @@ The number of rotated log files to retain when using the file logging connector,
|
|
|
831
831
|
|
|
832
832
|
***
|
|
833
833
|
|
|
834
|
+
### telemetrySilentComponents? {#telemetrysilentcomponents}
|
|
835
|
+
|
|
836
|
+
> `optional` **telemetrySilentComponents?**: `string`
|
|
837
|
+
|
|
838
|
+
A list of components to exclude from telemetry, can be a comma separated list of component Class names e.g. "ComponentA,ComponentB".
|
|
839
|
+
|
|
840
|
+
***
|
|
841
|
+
|
|
834
842
|
### openTelemetryLoggingLoggerName? {#opentelemetryloggingloggername}
|
|
835
843
|
|
|
836
844
|
> `optional` **openTelemetryLoggingLoggerName?**: `string`
|
|
@@ -963,7 +971,7 @@ The type of messaging push notification connector: entity-storage, aws.
|
|
|
963
971
|
|
|
964
972
|
> `optional` **telemetryConnector?**: `string`
|
|
965
973
|
|
|
966
|
-
The type of telemetry connector: entity-storage.
|
|
974
|
+
The type of telemetry connector, comma-separated for multiple: entity-storage, open-telemetry, silent.
|
|
967
975
|
|
|
968
976
|
***
|
|
969
977
|
|
|
@@ -1023,6 +1031,36 @@ Maximum number of values retained per telemetry metric (count-based history cap)
|
|
|
1023
1031
|
|
|
1024
1032
|
***
|
|
1025
1033
|
|
|
1034
|
+
### telemetryBatchSize? {#telemetrybatchsize}
|
|
1035
|
+
|
|
1036
|
+
> `optional` **telemetryBatchSize?**: `string`
|
|
1037
|
+
|
|
1038
|
+
The batch size for the telemetry connector, set to 1 to disable size-based flushing.
|
|
1039
|
+
|
|
1040
|
+
***
|
|
1041
|
+
|
|
1042
|
+
### telemetryBatchFlushInterval? {#telemetrybatchflushinterval}
|
|
1043
|
+
|
|
1044
|
+
> `optional` **telemetryBatchFlushInterval?**: `string`
|
|
1045
|
+
|
|
1046
|
+
The batch flush interval in seconds for the telemetry connector, how often to flush when using batching, defaults to 5 seconds.
|
|
1047
|
+
|
|
1048
|
+
***
|
|
1049
|
+
|
|
1050
|
+
### telemetryMaxCacheSize? {#telemetrymaxcachesize}
|
|
1051
|
+
|
|
1052
|
+
> `optional` **telemetryMaxCacheSize?**: `string`
|
|
1053
|
+
|
|
1054
|
+
The maximum number of metric values to hold in the write-ahead cache for the telemetry connector. Set to 0 for unlimited.
|
|
1055
|
+
|
|
1056
|
+
#### Default
|
|
1057
|
+
|
|
1058
|
+
```ts
|
|
1059
|
+
1000
|
|
1060
|
+
```
|
|
1061
|
+
|
|
1062
|
+
***
|
|
1063
|
+
|
|
1026
1064
|
### telemetryMutexTimeout? {#telemetrymutextimeout}
|
|
1027
1065
|
|
|
1028
1066
|
> `optional` **telemetryMutexTimeout?**: `string`
|
|
@@ -1031,11 +1069,47 @@ The mutex timeout in milliseconds for the telemetry connector.
|
|
|
1031
1069
|
|
|
1032
1070
|
***
|
|
1033
1071
|
|
|
1072
|
+
### telemetryMetricDefinitionCacheCapacity? {#telemetrymetricdefinitioncachecapacity}
|
|
1073
|
+
|
|
1074
|
+
> `optional` **telemetryMetricDefinitionCacheCapacity?**: `string`
|
|
1075
|
+
|
|
1076
|
+
The maximum number of metric definitions held in the in-memory definition cache for the telemetry connector.
|
|
1077
|
+
|
|
1078
|
+
#### Default
|
|
1079
|
+
|
|
1080
|
+
```ts
|
|
1081
|
+
100
|
|
1082
|
+
```
|
|
1083
|
+
|
|
1084
|
+
***
|
|
1085
|
+
|
|
1086
|
+
### telemetryMetricDefinitionCacheTtiMs? {#telemetrymetricdefinitioncachettims}
|
|
1087
|
+
|
|
1088
|
+
> `optional` **telemetryMetricDefinitionCacheTtiMs?**: `string`
|
|
1089
|
+
|
|
1090
|
+
The time-to-idle in milliseconds for cached metric definitions in the telemetry connector.
|
|
1091
|
+
|
|
1092
|
+
#### Default
|
|
1093
|
+
|
|
1094
|
+
```ts
|
|
1095
|
+
3600000
|
|
1096
|
+
```
|
|
1097
|
+
|
|
1098
|
+
***
|
|
1099
|
+
|
|
1100
|
+
### tracingSilentComponents? {#tracingsilentcomponents}
|
|
1101
|
+
|
|
1102
|
+
> `optional` **tracingSilentComponents?**: `string`
|
|
1103
|
+
|
|
1104
|
+
A list of components to exclude from tracing, can be a comma separated list of component Class names e.g. "ComponentA,ComponentB".
|
|
1105
|
+
|
|
1106
|
+
***
|
|
1107
|
+
|
|
1034
1108
|
### tracingConnector? {#tracingconnector}
|
|
1035
1109
|
|
|
1036
1110
|
> `optional` **tracingConnector?**: `string`
|
|
1037
1111
|
|
|
1038
|
-
The type of tracing connector: entity-storage, open-telemetry.
|
|
1112
|
+
The type of tracing connector, comma-separated for multiple: entity-storage, open-telemetry, silent.
|
|
1039
1113
|
|
|
1040
1114
|
***
|
|
1041
1115
|
|
|
@@ -1159,6 +1233,22 @@ The mutex timeout in milliseconds for the DID resolution cache. Only used when u
|
|
|
1159
1233
|
|
|
1160
1234
|
***
|
|
1161
1235
|
|
|
1236
|
+
### identityDidResolutionRetries? {#identitydidresolutionretries}
|
|
1237
|
+
|
|
1238
|
+
> `optional` **identityDidResolutionRetries?**: `string`
|
|
1239
|
+
|
|
1240
|
+
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.
|
|
1241
|
+
|
|
1242
|
+
***
|
|
1243
|
+
|
|
1244
|
+
### identityDidResolutionRetryDelay? {#identitydidresolutionretrydelay}
|
|
1245
|
+
|
|
1246
|
+
> `optional` **identityDidResolutionRetryDelay?**: `string`
|
|
1247
|
+
|
|
1248
|
+
The delay in milliseconds between DID resolution retries after a write operation. Only used when using the IOTA identity connector.
|
|
1249
|
+
|
|
1250
|
+
***
|
|
1251
|
+
|
|
1162
1252
|
### identityResolverConnector? {#identityresolverconnector}
|
|
1163
1253
|
|
|
1164
1254
|
> `optional` **identityResolverConnector?**: `string`
|
|
@@ -1669,6 +1759,22 @@ The mutex timeout in milliseconds for the dataspace agreement cache.
|
|
|
1669
1759
|
|
|
1670
1760
|
***
|
|
1671
1761
|
|
|
1762
|
+
### dataspaceAgreementUnusedThreshold? {#dataspaceagreementunusedthreshold}
|
|
1763
|
+
|
|
1764
|
+
> `optional` **dataspaceAgreementUnusedThreshold?**: `string`
|
|
1765
|
+
|
|
1766
|
+
The time in milliseconds after which an unused agreement is eligible for removal.
|
|
1767
|
+
|
|
1768
|
+
***
|
|
1769
|
+
|
|
1770
|
+
### dataspaceAgreementSweepInterval? {#dataspaceagreementsweepinterval}
|
|
1771
|
+
|
|
1772
|
+
> `optional` **dataspaceAgreementSweepInterval?**: `string`
|
|
1773
|
+
|
|
1774
|
+
The interval in milliseconds between agreement sweep runs.
|
|
1775
|
+
|
|
1776
|
+
***
|
|
1777
|
+
|
|
1672
1778
|
### dataspaceRetryCount? {#dataspaceretrycount}
|
|
1673
1779
|
|
|
1674
1780
|
> `optional` **dataspaceRetryCount?**: `string`
|
|
@@ -52,6 +52,14 @@ The CORS headers to expose.
|
|
|
52
52
|
|
|
53
53
|
***
|
|
54
54
|
|
|
55
|
+
### httpBodyLimits? {#httpbodylimits}
|
|
56
|
+
|
|
57
|
+
> `optional` **httpBodyLimits?**: `string`
|
|
58
|
+
|
|
59
|
+
Named request body limits in bytes as comma separated name=bytes pairs, e.g. default=2097152,large=26214400.
|
|
60
|
+
|
|
61
|
+
***
|
|
62
|
+
|
|
55
63
|
### publicOrigin? {#publicorigin}
|
|
56
64
|
|
|
57
65
|
> `optional` **publicOrigin?**: `string`
|
|
@@ -121,3 +129,19 @@ Include the full base 64 output in the REST logging output, useful for debugging
|
|
|
121
129
|
> `optional` **routeLoggingObfuscateProperties?**: `string`
|
|
122
130
|
|
|
123
131
|
List of properties to obfuscate in the REST logging output, comma separated.
|
|
132
|
+
|
|
133
|
+
***
|
|
134
|
+
|
|
135
|
+
### routeMetricsExcludePaths? {#routemetricsexcludepaths}
|
|
136
|
+
|
|
137
|
+
> `optional` **routeMetricsExcludePaths?**: `string`
|
|
138
|
+
|
|
139
|
+
Comma-separated list of URL path prefixes excluded from metrics collection.
|
|
140
|
+
|
|
141
|
+
***
|
|
142
|
+
|
|
143
|
+
### routeTracingExcludePaths? {#routetracingexcludepaths}
|
|
144
|
+
|
|
145
|
+
> `optional` **routeTracingExcludePaths?**: `string`
|
|
146
|
+
|
|
147
|
+
Comma-separated list of URL path prefixes excluded from tracing.
|
package/locales/en.json
CHANGED
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
"cliCommandParamExtra": "Parameter(s) \"{params}\" are not recognised for command \"{command}\"",
|
|
16
16
|
"cliEnvVarMissing": "Environment variable \"{envVar}\" does not exist",
|
|
17
17
|
"invalidEnvVarValue": "Environment variable \"{key}\" has an invalid value \"{value}\", expected {type} type",
|
|
18
|
+
"invalidEnvVarPair": "Environment variable \"{key}\" has an invalid entry \"{value}\", expected unique name=integer pairs",
|
|
18
19
|
"unknownEnvVars": "Unknown environment variable properties [{keys}]. Check for typos in variable names, for custom variables use the {prefix}ENV_ALLOW_LIST."
|
|
19
20
|
},
|
|
20
21
|
"bootstrapDev": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/node-core",
|
|
3
|
-
"version": "0.9.2
|
|
3
|
+
"version": "0.9.2",
|
|
4
4
|
"description": "TWIN Node Core for serving APIs using the specified configuration",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -14,38 +14,39 @@
|
|
|
14
14
|
"node": ">=24.0.0"
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@twin.org/api-auth-entity-storage-models": "
|
|
18
|
-
"@twin.org/api-auth-entity-storage-service": "
|
|
19
|
-
"@twin.org/api-models": "
|
|
20
|
-
"@twin.org/api-tenant-processor": "
|
|
21
|
-
"@twin.org/cli-core": "
|
|
22
|
-
"@twin.org/context": "
|
|
23
|
-
"@twin.org/core": "
|
|
24
|
-
"@twin.org/crypto": "
|
|
25
|
-
"@twin.org/data-json-ld": "
|
|
26
|
-
"@twin.org/dlt-account": "
|
|
27
|
-
"@twin.org/dlt-iota": "
|
|
28
|
-
"@twin.org/engine": "
|
|
29
|
-
"@twin.org/engine-core": "
|
|
30
|
-
"@twin.org/engine-models": "
|
|
31
|
-
"@twin.org/engine-server": "
|
|
32
|
-
"@twin.org/engine-server-types": "
|
|
33
|
-
"@twin.org/engine-types": "
|
|
34
|
-
"@twin.org/entity": "
|
|
35
|
-
"@twin.org/entity-storage-models": "
|
|
36
|
-
"@twin.org/identity-connector-entity-storage": "
|
|
37
|
-
"@twin.org/identity-models": "
|
|
38
|
-
"@twin.org/logging-connector-opentelemetry": "
|
|
39
|
-
"@twin.org/modules": "
|
|
40
|
-
"@twin.org/nameof": "
|
|
41
|
-
"@twin.org/standards-w3c-did": "
|
|
42
|
-
"@twin.org/standards-w3c-odrl": "
|
|
43
|
-
"@twin.org/telemetry-connector-opentelemetry": "
|
|
44
|
-
"@twin.org/tracing-connector-opentelemetry": "
|
|
45
|
-
"@twin.org/
|
|
46
|
-
"@twin.org/
|
|
47
|
-
"@twin.org/wallet-
|
|
48
|
-
"@twin.org/
|
|
17
|
+
"@twin.org/api-auth-entity-storage-models": "^0.9.2",
|
|
18
|
+
"@twin.org/api-auth-entity-storage-service": "^0.9.2",
|
|
19
|
+
"@twin.org/api-models": "^0.9.2",
|
|
20
|
+
"@twin.org/api-tenant-processor": "^0.9.2",
|
|
21
|
+
"@twin.org/cli-core": "^0.9.2",
|
|
22
|
+
"@twin.org/context": "^0.9.2",
|
|
23
|
+
"@twin.org/core": "^0.9.2",
|
|
24
|
+
"@twin.org/crypto": "^0.9.2",
|
|
25
|
+
"@twin.org/data-json-ld": "^0.9.2",
|
|
26
|
+
"@twin.org/dlt-account": "^0.9.2",
|
|
27
|
+
"@twin.org/dlt-iota": "^0.9.2",
|
|
28
|
+
"@twin.org/engine": "^0.9.2",
|
|
29
|
+
"@twin.org/engine-core": "^0.9.2",
|
|
30
|
+
"@twin.org/engine-models": "^0.9.2",
|
|
31
|
+
"@twin.org/engine-server": "^0.9.2",
|
|
32
|
+
"@twin.org/engine-server-types": "^0.9.2",
|
|
33
|
+
"@twin.org/engine-types": "^0.9.2",
|
|
34
|
+
"@twin.org/entity": "^0.9.2",
|
|
35
|
+
"@twin.org/entity-storage-models": "^0.9.2",
|
|
36
|
+
"@twin.org/identity-connector-entity-storage": "^0.9.2",
|
|
37
|
+
"@twin.org/identity-models": "^0.9.2",
|
|
38
|
+
"@twin.org/logging-connector-opentelemetry": "^0.9.2",
|
|
39
|
+
"@twin.org/modules": "^0.9.2",
|
|
40
|
+
"@twin.org/nameof": "^0.9.2",
|
|
41
|
+
"@twin.org/standards-w3c-did": "^0.9.2",
|
|
42
|
+
"@twin.org/standards-w3c-odrl": "^0.9.2",
|
|
43
|
+
"@twin.org/telemetry-connector-opentelemetry": "^0.9.2",
|
|
44
|
+
"@twin.org/tracing-connector-opentelemetry": "^0.9.2",
|
|
45
|
+
"@twin.org/tracing-models": "^0.9.2",
|
|
46
|
+
"@twin.org/vault-models": "^0.9.2",
|
|
47
|
+
"@twin.org/wallet-connector-entity-storage": "^0.9.2",
|
|
48
|
+
"@twin.org/wallet-models": "^0.9.2",
|
|
49
|
+
"@twin.org/web": "^0.9.2",
|
|
49
50
|
"dotenv": "17.4.2",
|
|
50
51
|
"schema-dts": "2.0.0"
|
|
51
52
|
},
|