@twin.org/node-core 0.9.2-next.8 → 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.
Files changed (38) hide show
  1. package/dist/es/builders/engineEnvBuilder.js +182 -87
  2. package/dist/es/builders/engineEnvBuilder.js.map +1 -1
  3. package/dist/es/builders/engineServerEnvBuilder.js +50 -14
  4. package/dist/es/builders/engineServerEnvBuilder.js.map +1 -1
  5. package/dist/es/builders/extensionsBuilder.js +5 -4
  6. package/dist/es/builders/extensionsBuilder.js.map +1 -1
  7. package/dist/es/builders/helper/envHelpers.js +60 -82
  8. package/dist/es/builders/helper/envHelpers.js.map +1 -1
  9. package/dist/es/cli.js +2 -1
  10. package/dist/es/cli.js.map +1 -1
  11. package/dist/es/commands/bootstrapDev.js +5 -5
  12. package/dist/es/commands/bootstrapDev.js.map +1 -1
  13. package/dist/es/commands/userCreate.js +8 -3
  14. package/dist/es/commands/userCreate.js.map +1 -1
  15. package/dist/es/commands/userUpdate.js +5 -2
  16. package/dist/es/commands/userUpdate.js.map +1 -1
  17. package/dist/es/models/IEngineEnvironmentVariables.js.map +1 -1
  18. package/dist/es/models/IEngineServerEnvironmentVariables.js.map +1 -1
  19. package/dist/es/models/engineEnvironmentVariableKeys.js +27 -0
  20. package/dist/es/models/engineEnvironmentVariableKeys.js.map +1 -1
  21. package/dist/es/models/engineServerEnvironmentVariableKeys.js +4 -1
  22. package/dist/es/models/engineServerEnvironmentVariableKeys.js.map +1 -1
  23. package/dist/es/node.js +3 -7
  24. package/dist/es/node.js.map +1 -1
  25. package/dist/es/start.js +3 -2
  26. package/dist/es/start.js.map +1 -1
  27. package/dist/types/builders/engineEnvBuilder.d.ts +9 -2
  28. package/dist/types/builders/helper/envHelpers.d.ts +83 -22
  29. package/dist/types/models/IEngineEnvironmentVariables.d.ts +113 -2
  30. package/dist/types/models/IEngineServerEnvironmentVariables.d.ts +12 -0
  31. package/docs/changelog.md +96 -0
  32. package/docs/reference/functions/{isTelemetryRequired.md → isTelemetryEnabled.md} +3 -3
  33. package/docs/reference/functions/isTracingEnabled.md +20 -0
  34. package/docs/reference/index.md +2 -1
  35. package/docs/reference/interfaces/IEngineEnvironmentVariables.md +236 -2
  36. package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +24 -0
  37. package/locales/en.json +1 -0
  38. package/package.json +34 -33
@@ -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`
@@ -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`
@@ -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`
@@ -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`
@@ -703,6 +831,14 @@ The number of rotated log files to retain when using the file logging connector,
703
831
 
704
832
  ***
705
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
+
706
842
  ### openTelemetryLoggingLoggerName? {#opentelemetryloggingloggername}
707
843
 
708
844
  > `optional` **openTelemetryLoggingLoggerName?**: `string`
@@ -835,7 +971,7 @@ The type of messaging push notification connector: entity-storage, aws.
835
971
 
836
972
  > `optional` **telemetryConnector?**: `string`
837
973
 
838
- The type of telemetry connector: entity-storage.
974
+ The type of telemetry connector, comma-separated for multiple: entity-storage, open-telemetry, silent.
839
975
 
840
976
  ***
841
977
 
@@ -895,6 +1031,36 @@ Maximum number of values retained per telemetry metric (count-based history cap)
895
1031
 
896
1032
  ***
897
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
+
898
1064
  ### telemetryMutexTimeout? {#telemetrymutextimeout}
899
1065
 
900
1066
  > `optional` **telemetryMutexTimeout?**: `string`
@@ -903,11 +1069,47 @@ The mutex timeout in milliseconds for the telemetry connector.
903
1069
 
904
1070
  ***
905
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
+
906
1108
  ### tracingConnector? {#tracingconnector}
907
1109
 
908
1110
  > `optional` **tracingConnector?**: `string`
909
1111
 
910
- The type of tracing connector: entity-storage, open-telemetry.
1112
+ The type of tracing connector, comma-separated for multiple: entity-storage, open-telemetry, silent.
911
1113
 
912
1114
  ***
913
1115
 
@@ -1031,6 +1233,22 @@ The mutex timeout in milliseconds for the DID resolution cache. Only used when u
1031
1233
 
1032
1234
  ***
1033
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
+
1034
1252
  ### identityResolverConnector? {#identityresolverconnector}
1035
1253
 
1036
1254
  > `optional` **identityResolverConnector?**: `string`
@@ -1541,6 +1759,22 @@ The mutex timeout in milliseconds for the dataspace agreement cache.
1541
1759
 
1542
1760
  ***
1543
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
+
1544
1778
  ### dataspaceRetryCount? {#dataspaceretrycount}
1545
1779
 
1546
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-next.8",
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": "next",
18
- "@twin.org/api-auth-entity-storage-service": "next",
19
- "@twin.org/api-models": "next",
20
- "@twin.org/api-tenant-processor": "next",
21
- "@twin.org/cli-core": "next",
22
- "@twin.org/context": "next",
23
- "@twin.org/core": "next",
24
- "@twin.org/crypto": "next",
25
- "@twin.org/data-json-ld": "next",
26
- "@twin.org/dlt-account": "next",
27
- "@twin.org/dlt-iota": "next",
28
- "@twin.org/engine": "next",
29
- "@twin.org/engine-core": "next",
30
- "@twin.org/engine-models": "next",
31
- "@twin.org/engine-server": "next",
32
- "@twin.org/engine-server-types": "next",
33
- "@twin.org/engine-types": "next",
34
- "@twin.org/entity": "next",
35
- "@twin.org/entity-storage-models": "next",
36
- "@twin.org/identity-connector-entity-storage": "next",
37
- "@twin.org/identity-models": "next",
38
- "@twin.org/logging-connector-opentelemetry": "next",
39
- "@twin.org/modules": "next",
40
- "@twin.org/nameof": "next",
41
- "@twin.org/standards-w3c-did": "next",
42
- "@twin.org/standards-w3c-odrl": "next",
43
- "@twin.org/telemetry-connector-opentelemetry": "next",
44
- "@twin.org/tracing-connector-opentelemetry": "next",
45
- "@twin.org/vault-models": "next",
46
- "@twin.org/wallet-connector-entity-storage": "next",
47
- "@twin.org/wallet-models": "next",
48
- "@twin.org/web": "next",
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
  },