@twin.org/node-core 0.9.4-next.5 → 0.9.4
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 +369 -470
- package/dist/es/builders/engineEnvBuilder.js.map +1 -1
- package/dist/es/builders/engineServerEnvBuilder.js +2 -5
- package/dist/es/builders/engineServerEnvBuilder.js.map +1 -1
- package/dist/es/builders/helper/envHelpers.js +0 -39
- package/dist/es/builders/helper/envHelpers.js.map +1 -1
- package/dist/es/cli.js +1 -1
- package/dist/es/cli.js.map +1 -1
- package/dist/es/commands/bootstrapDev.js +3 -3
- package/dist/es/commands/bootstrapDev.js.map +1 -1
- package/dist/es/commands/help.js +1 -1
- package/dist/es/commands/help.js.map +1 -1
- package/dist/es/commands/identityCreate.js +2 -2
- package/dist/es/commands/identityCreate.js.map +1 -1
- package/dist/es/commands/identityVerificationMethodCreate.js +2 -2
- package/dist/es/commands/identityVerificationMethodCreate.js.map +1 -1
- package/dist/es/commands/userCreate.js +1 -1
- package/dist/es/commands/userCreate.js.map +1 -1
- package/dist/es/commands/vaultKeyCreate.js +1 -1
- package/dist/es/commands/vaultKeyCreate.js.map +1 -1
- package/dist/es/commands/vaultKeyImport.js +1 -1
- package/dist/es/commands/vaultKeyImport.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 +3 -14
- package/dist/es/models/engineEnvironmentVariableKeys.js.map +1 -1
- package/dist/es/models/engineServerEnvironmentVariableKeys.js +0 -1
- package/dist/es/models/engineServerEnvironmentVariableKeys.js.map +1 -1
- package/dist/es/node.js +21 -40
- package/dist/es/node.js.map +1 -1
- package/dist/types/builders/engineEnvBuilder.d.ts +0 -7
- package/dist/types/builders/helper/envHelpers.d.ts +0 -30
- package/dist/types/models/IEngineEnvironmentVariables.d.ts +12 -48
- package/dist/types/models/IEngineServerEnvironmentVariables.d.ts +0 -4
- package/docs/changelog.md +24 -180
- package/docs/reference/index.md +0 -1
- package/docs/reference/interfaces/IEngineEnvironmentVariables.md +21 -93
- package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +0 -8
- package/locales/en.json +1 -3
- package/package.json +34 -34
- package/dist/es/models/deprecatedEnvironmentVariableKeys.js +0 -16
- package/dist/es/models/deprecatedEnvironmentVariableKeys.js.map +0 -1
- package/dist/types/models/deprecatedEnvironmentVariableKeys.d.ts +0 -7
- package/docs/reference/functions/isMailboxEnabled.md +0 -20
|
@@ -887,11 +887,11 @@ The type of event bus component: service.
|
|
|
887
887
|
|
|
888
888
|
***
|
|
889
889
|
|
|
890
|
-
###
|
|
890
|
+
### messagingEnabled? {#messagingenabled}
|
|
891
891
|
|
|
892
|
-
> `optional` **
|
|
892
|
+
> `optional` **messagingEnabled?**: `string`
|
|
893
893
|
|
|
894
|
-
|
|
894
|
+
Are the messaging components enabled, defaults to false.
|
|
895
895
|
|
|
896
896
|
***
|
|
897
897
|
|
|
@@ -947,47 +947,7 @@ The applications for the push notifications reference a separate json with @json
|
|
|
947
947
|
|
|
948
948
|
> `optional` **messagingEmailConnector?**: `string`
|
|
949
949
|
|
|
950
|
-
The type of messaging email connector: entity-storage, aws
|
|
951
|
-
|
|
952
|
-
***
|
|
953
|
-
|
|
954
|
-
### smtpHost? {#smtphost}
|
|
955
|
-
|
|
956
|
-
> `optional` **smtpHost?**: `string`
|
|
957
|
-
|
|
958
|
-
SMTP server hostname or IP address.
|
|
959
|
-
|
|
960
|
-
***
|
|
961
|
-
|
|
962
|
-
### smtpPort? {#smtpport}
|
|
963
|
-
|
|
964
|
-
> `optional` **smtpPort?**: `string`
|
|
965
|
-
|
|
966
|
-
SMTP server port, defaults to 587.
|
|
967
|
-
|
|
968
|
-
***
|
|
969
|
-
|
|
970
|
-
### smtpSecure? {#smtpsecure}
|
|
971
|
-
|
|
972
|
-
> `optional` **smtpSecure?**: `string`
|
|
973
|
-
|
|
974
|
-
Whether the SMTP connector uses TLS.
|
|
975
|
-
|
|
976
|
-
***
|
|
977
|
-
|
|
978
|
-
### smtpUsername? {#smtpusername}
|
|
979
|
-
|
|
980
|
-
> `optional` **smtpUsername?**: `string`
|
|
981
|
-
|
|
982
|
-
SMTP authentication username.
|
|
983
|
-
|
|
984
|
-
***
|
|
985
|
-
|
|
986
|
-
### smtpPassword? {#smtppassword}
|
|
987
|
-
|
|
988
|
-
> `optional` **smtpPassword?**: `string`
|
|
989
|
-
|
|
990
|
-
SMTP authentication password.
|
|
950
|
+
The type of messaging email connector: entity-storage, aws.
|
|
991
951
|
|
|
992
952
|
***
|
|
993
953
|
|
|
@@ -1149,7 +1109,7 @@ A list of components to exclude from tracing, can be a comma separated list of c
|
|
|
1149
1109
|
|
|
1150
1110
|
> `optional` **tracingConnector?**: `string`
|
|
1151
1111
|
|
|
1152
|
-
The type of tracing connector, comma-separated for multiple: entity-storage, open-telemetry,
|
|
1112
|
+
The type of tracing connector, comma-separated for multiple: entity-storage, open-telemetry, silent.
|
|
1153
1113
|
|
|
1154
1114
|
***
|
|
1155
1115
|
|
|
@@ -1538,6 +1498,14 @@ The identity verification method id to use with attestation.
|
|
|
1538
1498
|
|
|
1539
1499
|
***
|
|
1540
1500
|
|
|
1501
|
+
### dataProcessingEnabled? {#dataprocessingenabled}
|
|
1502
|
+
|
|
1503
|
+
> `optional` **dataProcessingEnabled?**: `string`
|
|
1504
|
+
|
|
1505
|
+
Is the data processing enabled, defaults to false.
|
|
1506
|
+
|
|
1507
|
+
***
|
|
1508
|
+
|
|
1541
1509
|
### dataConverterConnectors? {#dataconverterconnectors}
|
|
1542
1510
|
|
|
1543
1511
|
> `optional` **dataConverterConnectors?**: `string`
|
|
@@ -1975,54 +1943,6 @@ The interval in seconds for running the application health lifecycle (init, appl
|
|
|
1975
1943
|
|
|
1976
1944
|
***
|
|
1977
1945
|
|
|
1978
|
-
### backgroundTaskMaxSystemWorkerCount? {#backgroundtaskmaxsystemworkercount}
|
|
1979
|
-
|
|
1980
|
-
> `optional` **backgroundTaskMaxSystemWorkerCount?**: `string`
|
|
1981
|
-
|
|
1982
|
-
The maximum number of workers to use for processing background tasks, defaults to twice the number of CPU cores.
|
|
1983
|
-
|
|
1984
|
-
***
|
|
1985
|
-
|
|
1986
|
-
### backgroundTaskInterval? {#backgroundtaskinterval}
|
|
1987
|
-
|
|
1988
|
-
> `optional` **backgroundTaskInterval?**: `string`
|
|
1989
|
-
|
|
1990
|
-
The interval in milliseconds to leave between background tasks, defaults to 100.
|
|
1991
|
-
|
|
1992
|
-
***
|
|
1993
|
-
|
|
1994
|
-
### backgroundTaskRetryInterval? {#backgroundtaskretryinterval}
|
|
1995
|
-
|
|
1996
|
-
> `optional` **backgroundTaskRetryInterval?**: `string`
|
|
1997
|
-
|
|
1998
|
-
The interval in milliseconds to leave between background task retries, defaults to 5000.
|
|
1999
|
-
|
|
2000
|
-
***
|
|
2001
|
-
|
|
2002
|
-
### backgroundTaskCleanupInterval? {#backgroundtaskcleanupinterval}
|
|
2003
|
-
|
|
2004
|
-
> `optional` **backgroundTaskCleanupInterval?**: `string`
|
|
2005
|
-
|
|
2006
|
-
The interval in milliseconds between sweeps removing retained background tasks, defaults to 120000.
|
|
2007
|
-
|
|
2008
|
-
***
|
|
2009
|
-
|
|
2010
|
-
### backgroundTaskWorkerShutdownTimeout? {#backgroundtaskworkershutdowntimeout}
|
|
2011
|
-
|
|
2012
|
-
> `optional` **backgroundTaskWorkerShutdownTimeout?**: `string`
|
|
2013
|
-
|
|
2014
|
-
The time in milliseconds to wait for each handler's workers to shut down before terminating them, defaults to 5000.
|
|
2015
|
-
|
|
2016
|
-
***
|
|
2017
|
-
|
|
2018
|
-
### backgroundTaskMaxDispatchCount? {#backgroundtaskmaxdispatchcount}
|
|
2019
|
-
|
|
2020
|
-
> `optional` **backgroundTaskMaxDispatchCount?**: `string`
|
|
2021
|
-
|
|
2022
|
-
The maximum dispatches of a background task attempt before it is failed as interrupted, defaults to 3, set to -1 for no limit.
|
|
2023
|
-
|
|
2024
|
-
***
|
|
2025
|
-
|
|
2026
1946
|
### automationActionTypes? {#automationactiontypes}
|
|
2027
1947
|
|
|
2028
1948
|
> `optional` **automationActionTypes?**: `string`
|
|
@@ -2072,6 +1992,14 @@ The mutex timeout in milliseconds for the document management component.
|
|
|
2072
1992
|
|
|
2073
1993
|
***
|
|
2074
1994
|
|
|
1995
|
+
### loggingMutexTimeout? {#loggingmutextimeout}
|
|
1996
|
+
|
|
1997
|
+
> `optional` **loggingMutexTimeout?**: `string`
|
|
1998
|
+
|
|
1999
|
+
The mutex timeout in milliseconds for the logging component.
|
|
2000
|
+
|
|
2001
|
+
***
|
|
2002
|
+
|
|
2075
2003
|
### entityStorageMutexTimeout? {#entitystoragemutextimeout}
|
|
2076
2004
|
|
|
2077
2005
|
> `optional` **entityStorageMutexTimeout?**: `string`
|
|
@@ -68,14 +68,6 @@ The public origin URL for the API e.g. https://api.example.com:1234
|
|
|
68
68
|
|
|
69
69
|
***
|
|
70
70
|
|
|
71
|
-
### fastifyPluginTimeout? {#fastifyplugintimeout}
|
|
72
|
-
|
|
73
|
-
> `optional` **fastifyPluginTimeout?**: `string`
|
|
74
|
-
|
|
75
|
-
The time in milliseconds Fastify waits for a plugin to load before failing, defaults to 30000.
|
|
76
|
-
|
|
77
|
-
***
|
|
78
|
-
|
|
79
71
|
### authAdminProcessorType? {#authadminprocessortype}
|
|
80
72
|
|
|
81
73
|
> `optional` **authAdminProcessorType?**: `string`
|
package/locales/en.json
CHANGED
|
@@ -98,9 +98,7 @@
|
|
|
98
98
|
},
|
|
99
99
|
"warn": {
|
|
100
100
|
"node": {
|
|
101
|
-
"unknownEnvVars": "Unknown environment variable properties [{keys}], they will be ignored. Check for typos in variable names, for custom variables use the {prefix}ENV_ALLOW_LIST."
|
|
102
|
-
"deprecatedEnvVar": "The environment variable \"{key}\" is deprecated and no longer has any effect, please use {replacements} instead. This variable will be removed in a future release.",
|
|
103
|
-
"deprecatedEnvVarNoReplacement": "The environment variable \"{key}\" is deprecated and no longer has any effect. This variable will be removed in a future release."
|
|
101
|
+
"unknownEnvVars": "Unknown environment variable properties [{keys}], they will be ignored. Check for typos in variable names, for custom variables use the {prefix}ENV_ALLOW_LIST."
|
|
104
102
|
}
|
|
105
103
|
},
|
|
106
104
|
"node": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/node-core",
|
|
3
|
-
"version": "0.9.4
|
|
3
|
+
"version": "0.9.4",
|
|
4
4
|
"description": "TWIN Node Core for serving APIs using the specified configuration",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -14,39 +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/tracing-models": "
|
|
46
|
-
"@twin.org/vault-models": "
|
|
47
|
-
"@twin.org/wallet-connector-entity-storage": "
|
|
48
|
-
"@twin.org/wallet-models": "
|
|
49
|
-
"@twin.org/web": "
|
|
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",
|
|
50
50
|
"dotenv": "17.4.2",
|
|
51
51
|
"schema-dts": "2.0.0"
|
|
52
52
|
},
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
// Copyright 2026 IOTA Stiftung.
|
|
2
|
-
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
-
/**
|
|
4
|
-
* The camelCase property names which are no longer used, mapped to the keys which replace them.
|
|
5
|
-
* They are still recognised so an existing configuration does not fail validation, but each one
|
|
6
|
-
* reports a deprecation warning and has no effect on the engine configuration.
|
|
7
|
-
* An empty array is a key which has been withdrawn with nothing to replace it.
|
|
8
|
-
*/
|
|
9
|
-
export const DEPRECATED_ENVIRONMENT_VARIABLE_KEYS = new Map([
|
|
10
|
-
[
|
|
11
|
-
"messagingEnabled",
|
|
12
|
-
["messagingEmailConnector", "messagingSmsConnector", "messagingPushNotificationConnector"]
|
|
13
|
-
],
|
|
14
|
-
["dataProcessingEnabled", ["dataConverterConnectors", "dataExtractorConnectors"]]
|
|
15
|
-
]);
|
|
16
|
-
//# sourceMappingURL=deprecatedEnvironmentVariableKeys.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"deprecatedEnvironmentVariableKeys.js","sourceRoot":"","sources":["../../../src/models/deprecatedEnvironmentVariableKeys.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAA2C,IAAI,GAAG,CAClG;IACC;QACC,kBAAkB;QAClB,CAAC,yBAAyB,EAAE,uBAAuB,EAAE,oCAAoC,CAAC;KAC1F;IACD,CAAC,uBAAuB,EAAE,CAAC,yBAAyB,EAAE,yBAAyB,CAAC,CAAC;CACjF,CACD,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The camelCase property names which are no longer used, mapped to the keys which replace them.\n * They are still recognised so an existing configuration does not fail validation, but each one\n * reports a deprecation warning and has no effect on the engine configuration.\n * An empty array is a key which has been withdrawn with nothing to replace it.\n */\nexport const DEPRECATED_ENVIRONMENT_VARIABLE_KEYS: ReadonlyMap<string, readonly string[]> = new Map(\n\t[\n\t\t[\n\t\t\t\"messagingEnabled\",\n\t\t\t[\"messagingEmailConnector\", \"messagingSmsConnector\", \"messagingPushNotificationConnector\"]\n\t\t],\n\t\t[\"dataProcessingEnabled\", [\"dataConverterConnectors\", \"dataExtractorConnectors\"]]\n\t]\n);\n"]}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* The camelCase property names which are no longer used, mapped to the keys which replace them.
|
|
3
|
-
* They are still recognised so an existing configuration does not fail validation, but each one
|
|
4
|
-
* reports a deprecation warning and has no effect on the engine configuration.
|
|
5
|
-
* An empty array is a key which has been withdrawn with nothing to replace it.
|
|
6
|
-
*/
|
|
7
|
-
export declare const DEPRECATED_ENVIRONMENT_VARIABLE_KEYS: ReadonlyMap<string, readonly string[]>;
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# Function: isMailboxEnabled()
|
|
2
|
-
|
|
3
|
-
> **isMailboxEnabled**(`envVars`): `boolean`
|
|
4
|
-
|
|
5
|
-
Checks if the mailbox subsystem is enabled.
|
|
6
|
-
Returns true when any component that depends on the mailbox subsystem is enabled.
|
|
7
|
-
|
|
8
|
-
## Parameters
|
|
9
|
-
|
|
10
|
-
### envVars
|
|
11
|
-
|
|
12
|
-
[`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md)
|
|
13
|
-
|
|
14
|
-
The environment variables.
|
|
15
|
-
|
|
16
|
-
## Returns
|
|
17
|
-
|
|
18
|
-
`boolean`
|
|
19
|
-
|
|
20
|
-
True if mailbox is enabled.
|