@twin.org/node-core 0.0.3-next.36 → 0.0.3-next.39

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 (44) hide show
  1. package/dist/es/builders/engineEnvBuilder.js +37 -1
  2. package/dist/es/builders/engineEnvBuilder.js.map +1 -1
  3. package/dist/es/builders/engineServerEnvBuilder.js +10 -8
  4. package/dist/es/builders/engineServerEnvBuilder.js.map +1 -1
  5. package/dist/es/builders/extensionsBuilder.js.map +1 -1
  6. package/dist/es/commands/bootstrapLegacy.js +1 -0
  7. package/dist/es/commands/bootstrapLegacy.js.map +1 -1
  8. package/dist/es/commands/userCreate.js +108 -81
  9. package/dist/es/commands/userCreate.js.map +1 -1
  10. package/dist/es/commands/userUpdate.js +66 -44
  11. package/dist/es/commands/userUpdate.js.map +1 -1
  12. package/dist/es/index.js +4 -1
  13. package/dist/es/index.js.map +1 -1
  14. package/dist/es/models/IEngineEnvironmentVariables.js.map +1 -1
  15. package/dist/es/models/nodeExtensionInitialiseEngineMethod.js +2 -0
  16. package/dist/es/models/nodeExtensionInitialiseEngineMethod.js.map +1 -0
  17. package/dist/es/models/nodeExtensionInitialiseEngineServerMethod.js +2 -0
  18. package/dist/es/models/nodeExtensionInitialiseEngineServerMethod.js.map +1 -0
  19. package/dist/es/models/nodeExtensionInitialiseMethod.js +2 -0
  20. package/dist/es/models/nodeExtensionInitialiseMethod.js.map +1 -0
  21. package/dist/es/models/nodeExtensionShutdownMethod.js +4 -0
  22. package/dist/es/models/nodeExtensionShutdownMethod.js.map +1 -0
  23. package/dist/es/node.js +1 -1
  24. package/dist/es/node.js.map +1 -1
  25. package/dist/types/builders/engineEnvBuilder.d.ts +7 -0
  26. package/dist/types/commands/userCreate.d.ts +2 -0
  27. package/dist/types/commands/userUpdate.d.ts +3 -1
  28. package/dist/types/index.d.ts +4 -1
  29. package/dist/types/models/IEngineEnvironmentVariables.d.ts +12 -0
  30. package/dist/types/models/nodeExtensionInitialiseEngineMethod.d.ts +7 -0
  31. package/dist/types/models/nodeExtensionInitialiseEngineServerMethod.d.ts +8 -0
  32. package/dist/types/models/nodeExtensionInitialiseMethod.d.ts +8 -0
  33. package/dist/types/models/nodeExtensionShutdownMethod.d.ts +5 -0
  34. package/docs/changelog.md +114 -0
  35. package/docs/reference/functions/isTelemetryRequired.md +20 -0
  36. package/docs/reference/index.md +2 -1
  37. package/docs/reference/interfaces/IEngineEnvironmentVariables.md +24 -0
  38. package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +36 -0
  39. package/docs/reference/interfaces/INodeEnvironmentVariables.md +36 -0
  40. package/locales/en.json +11 -1
  41. package/package.json +2 -1
  42. package/dist/es/models/nodeExtensionMethods.js +0 -2
  43. package/dist/es/models/nodeExtensionMethods.js.map +0 -1
  44. package/dist/types/models/nodeExtensionMethods.d.ts +0 -27
@@ -0,0 +1,8 @@
1
+ import type { IEngineCore, IEngineServer } from "@twin.org/engine-models";
2
+ /**
3
+ * The type for the initialise engine server method of an extension module.
4
+ * This is called when the engine server has been constructed but not yet started.
5
+ * @param engineCore The engine core instance.
6
+ * @param engineServer The engine server instance.
7
+ */
8
+ export type NodeExtensionInitialiseEngineServerMethod = (engineCore: IEngineCore, engineServer: IEngineServer) => Promise<void>;
@@ -0,0 +1,8 @@
1
+ import type { INodeEngineConfig } from "./INodeEngineConfig.js";
2
+ import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables.js";
3
+ /**
4
+ * The type for the initialise method of an extension module.
5
+ * @param envVars The environment variables for the node.
6
+ * @param nodeEngineConfig The node engine config.
7
+ */
8
+ export type NodeExtensionInitialiseMethod = (envVars: INodeEnvironmentVariables, nodeEngineConfig: INodeEngineConfig) => Promise<void>;
@@ -0,0 +1,5 @@
1
+ /**
2
+ * The type for the shutdown method of an extension module.
3
+ * This is called when the engine is shutting down.
4
+ */
5
+ export type NodeExtensionShutdownMethod = () => Promise<void>;
package/docs/changelog.md CHANGED
@@ -1,5 +1,119 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.0.3-next.39](https://github.com/iotaledger/twin-node/compare/node-core-v0.0.3-next.38...node-core-v0.0.3-next.39) (2026-05-21)
4
+
5
+
6
+ ### Features
7
+
8
+ * tenant-id in user create and update ([#148](https://github.com/iotaledger/twin-node/issues/148)) ([1143e30](https://github.com/iotaledger/twin-node/commit/1143e30fb0d2056d113367d0c5ea251f07695da1))
9
+
10
+ ## [0.0.3-next.38](https://github.com/iotaledger/twin-node/compare/node-core-v0.0.3-next.37...node-core-v0.0.3-next.38) (2026-05-20)
11
+
12
+
13
+ ### Features
14
+
15
+ * add auth admin component ([1661e57](https://github.com/iotaledger/twin-node/commit/1661e57a699d5cf9ebde333e3cbc3aaea89d7c9c))
16
+ * add automation ([cfc63b4](https://github.com/iotaledger/twin-node/commit/cfc63b465c139280f696877df21d54dc6a065a7e))
17
+ * add CLI commands and remove automated bootstrap code ([#69](https://github.com/iotaledger/twin-node/issues/69)) ([6e40933](https://github.com/iotaledger/twin-node/commit/6e40933d8bb820b380e1074fc88feeedca0ef7d9))
18
+ * add context id features ([#53](https://github.com/iotaledger/twin-node/issues/53)) ([827adf5](https://github.com/iotaledger/twin-node/commit/827adf52cb87fca53cec52b27e67f7a9dba2c088))
19
+ * add data space connector ([5a57087](https://github.com/iotaledger/twin-node/commit/5a57087d938265d3a4a812ff7c83d130ea4e103c))
20
+ * add data space connector ([f7a3644](https://github.com/iotaledger/twin-node/commit/f7a364477ec664e333e5ad018795acec6ee61edc))
21
+ * add data space connector ([157e8b0](https://github.com/iotaledger/twin-node/commit/157e8b0a76e3a8a63c1991924f7f963eb83e27ae))
22
+ * add extend engine and server methods ([ec09c7e](https://github.com/iotaledger/twin-node/commit/ec09c7eb882d9f5797f2fd372e96cad1a3716f59))
23
+ * add extend engine and server methods ([0136a6f](https://github.com/iotaledger/twin-node/commit/0136a6f3f4e1a82b1427ee9618b8a17c79bc7fda))
24
+ * add extensions support ([476d5a8](https://github.com/iotaledger/twin-node/commit/476d5a864026a2f78e5b02bc9eb81359777a4a45))
25
+ * add isDefault flag to logging connectors ([358e839](https://github.com/iotaledger/twin-node/commit/358e8394819dab9832d3a9ebfac74b897b7d5f40))
26
+ * add missing export ([e8eb621](https://github.com/iotaledger/twin-node/commit/e8eb6213937a202520b164a9970a891004122b61))
27
+ * add module cache and improve resolution ([482be05](https://github.com/iotaledger/twin-node/commit/482be056c37a598033250ea8a7288a33cf3470b4))
28
+ * add module override for better local import resolution ([ba00d17](https://github.com/iotaledger/twin-node/commit/ba00d17beea0a9a1851c89ad7c6a33256051c818))
29
+ * add notarization ([#121](https://github.com/iotaledger/twin-node/issues/121)) ([b2a11df](https://github.com/iotaledger/twin-node/commit/b2a11df92c7b5026f73f08a018c0586ebe008e92))
30
+ * add obligation enforcers and multi instance support ([#89](https://github.com/iotaledger/twin-node/issues/89)) ([d81af99](https://github.com/iotaledger/twin-node/commit/d81af99b8c4db6e9a1370b7065bf6d9d222c71ed))
31
+ * add rights management ([78fba62](https://github.com/iotaledger/twin-node/commit/78fba62f82afdbe615d55dd90eca8ee70ea62fc0))
32
+ * add rights management components ([0fc6293](https://github.com/iotaledger/twin-node/commit/0fc629332db24494bd73003625c7bf3f939a2597))
33
+ * add support for dynamodb connection timeout ([63051b0](https://github.com/iotaledger/twin-node/commit/63051b0d22138079115dfac921e7f0c45eaad34e))
34
+ * add synchronised storage config ([e315869](https://github.com/iotaledger/twin-node/commit/e315869adbffcd7fe5d3ce151dd35f662f6134a9))
35
+ * add trust and rights management plugin support ([cdeb504](https://github.com/iotaledger/twin-node/commit/cdeb504ee5986a347466162b9afa781645b4a54c))
36
+ * add trust ttl ([#73](https://github.com/iotaledger/twin-node/issues/73)) ([911cee7](https://github.com/iotaledger/twin-node/commit/911cee771bba490143bb1574ca8360f7cf8baa1a))
37
+ * add validate-locales ([1a19dcb](https://github.com/iotaledger/twin-node/commit/1a19dcb005c2f0e3103e290db28c48a3464094cb))
38
+ * add vault prefix configuration ([#75](https://github.com/iotaledger/twin-node/issues/75)) ([1d4afb1](https://github.com/iotaledger/twin-node/commit/1d4afb1b1a8aa60795898eeb9e7f5153c279527d))
39
+ * adding npm and https protocols to load extensions ([#45](https://github.com/iotaledger/twin-node/issues/45)) ([33940b7](https://github.com/iotaledger/twin-node/commit/33940b7e771a0c5af32c18d442deb26a8631fd02))
40
+ * additional options for enabling components ([e13d772](https://github.com/iotaledger/twin-node/commit/e13d7721a0dd7143d456fff246622cbe63dbd0f1))
41
+ * additional route logging env vars ([7152c88](https://github.com/iotaledger/twin-node/commit/7152c887c3ba76778e2d9e68ba57198b8d81d802))
42
+ * additional run options ([c35e5bb](https://github.com/iotaledger/twin-node/commit/c35e5bbb8a80fe6a36628d41f64585b3723d9ad7))
43
+ * additional startup logging ([0740293](https://github.com/iotaledger/twin-node/commit/0740293b366032f2907046603abf587c9c324aff))
44
+ * additional stop interlock ([b3a2757](https://github.com/iotaledger/twin-node/commit/b3a2757325af0e7b258a9f97f1b52e86087e6301))
45
+ * align node module with dataspace rename and control plane integ… ([#95](https://github.com/iotaledger/twin-node/issues/95)) ([8129868](https://github.com/iotaledger/twin-node/commit/812986886fb5d779dd380956c4e6cc47c2d73530))
46
+ * authentication services ([#118](https://github.com/iotaledger/twin-node/issues/118)) ([311a7f8](https://github.com/iotaledger/twin-node/commit/311a7f882db1e50a83e94d2dae32fefc68debb47))
47
+ * bootstrap legacy skip ([469d950](https://github.com/iotaledger/twin-node/commit/469d9505bd0497c271ba291641f63786200cb548))
48
+ * cache the npm root to increase startup speed ([f10ea9e](https://github.com/iotaledger/twin-node/commit/f10ea9e22cc202f320df5fb21507b886c1f7345b))
49
+ * custom REST paths ([#99](https://github.com/iotaledger/twin-node/issues/99)) ([dcab1b2](https://github.com/iotaledger/twin-node/commit/dcab1b2b23c13b4c9f39c3c1c67284f56e732bd1))
50
+ * don't override existing env vars with env files ([ebccac2](https://github.com/iotaledger/twin-node/commit/ebccac297c3156076f17c246a8abd994f8f20e61))
51
+ * env var simplification ([460b0f2](https://github.com/iotaledger/twin-node/commit/460b0f20a73cb482f7443af502f261d5f9d01759))
52
+ * env-prefix option and user-update cli command ([#83](https://github.com/iotaledger/twin-node/issues/83)) ([fc48efa](https://github.com/iotaledger/twin-node/commit/fc48efa7ad72173def048170c3afb5eeb9f1b292))
53
+ * eslint migration to flat config ([080db74](https://github.com/iotaledger/twin-node/commit/080db746390230f78725d214bc957da2efee9eb1))
54
+ * first metrics in the core and app for testing ([#139](https://github.com/iotaledger/twin-node/issues/139)) ([abe17bb](https://github.com/iotaledger/twin-node/commit/abe17bb9a6261dcb7fd46253221182fbb1dc2259))
55
+ * health and url transformer ([#131](https://github.com/iotaledger/twin-node/issues/131)) ([3658903](https://github.com/iotaledger/twin-node/commit/36589036b9bea120880fc395b0d123a89032cf40))
56
+ * improve bootstrapping and shutdown behaviour ([#66](https://github.com/iotaledger/twin-node/issues/66)) ([65b3452](https://github.com/iotaledger/twin-node/commit/65b345240334bfff48b52e136cc486cd7ac7f290))
57
+ * improve default options and spec ([b538721](https://github.com/iotaledger/twin-node/commit/b538721902e7f65021d2715148ba59409ccce035))
58
+ * improve error handling for extensions and logging ([bd84fde](https://github.com/iotaledger/twin-node/commit/bd84fde67e5a9db6ac66730397992401ca52e88c))
59
+ * improve error reporting ([fcd39a1](https://github.com/iotaledger/twin-node/commit/fcd39a18da2a6ce33965a99ca5f2f36f4aba712f))
60
+ * improve node logging ([63d6ea6](https://github.com/iotaledger/twin-node/commit/63d6ea661c2c76985d98addb8d905ad6f0c7f164))
61
+ * improve node logging ([c25b9c6](https://github.com/iotaledger/twin-node/commit/c25b9c6779bdb76f341df072c39b4c2fae4565a3))
62
+ * initial commit ([522f1e5](https://github.com/iotaledger/twin-node/commit/522f1e515348f9b1dd1eeb3170b1249e2b0b5371))
63
+ * migrate env config from engine to node ([5da29b8](https://github.com/iotaledger/twin-node/commit/5da29b8d714495308320d237a68e84355bba2b47))
64
+ * multi-tenant env wiring, trust auto-enable, tenant-token vault key, engine-driven callbackPath ([#128](https://github.com/iotaledger/twin-node/issues/128)) ([0de4d35](https://github.com/iotaledger/twin-node/commit/0de4d356fb2f825afae5469005d475700f510ee4))
65
+ * node app use JavaScript ([14fe08c](https://github.com/iotaledger/twin-node/commit/14fe08cb760dd885a5dac9056a4d5dbc3d61df64))
66
+ * remove dap and darp ([36c3ffb](https://github.com/iotaledger/twin-node/commit/36c3ffb31af65a0e3025859dab675efeee043155))
67
+ * remove unused properties ([d8344b5](https://github.com/iotaledger/twin-node/commit/d8344b5aee5dc1c8104d75fad5093097f6530168))
68
+ * separate script directory from exec directory ([f6bb4db](https://github.com/iotaledger/twin-node/commit/f6bb4dbea1f1e200e0640fa154c6997ef99c99b4))
69
+ * support multiple entity and blob storage connectors ([a489f79](https://github.com/iotaledger/twin-node/commit/a489f7907544aef5708d5111e9f72985e1377bae))
70
+ * support public origin and hosting service ([#77](https://github.com/iotaledger/twin-node/issues/77)) ([3b9039f](https://github.com/iotaledger/twin-node/commit/3b9039fcba7f7038c06f8fd6a5ccc9fdbbf535b3))
71
+ * typescript 6 update ([ce2e3ca](https://github.com/iotaledger/twin-node/commit/ce2e3ca5219587709f7b9cf6c65909b48fba11b5))
72
+ * update background tasks and add fedcat filters ([1fd297e](https://github.com/iotaledger/twin-node/commit/1fd297e29f60b5bb3909638b68e326c5b0e2d77d))
73
+ * update context usage ([2215440](https://github.com/iotaledger/twin-node/commit/2215440801dea3955885b6579ad9b98b7a5d87ea))
74
+ * update dependencies ([aab05b5](https://github.com/iotaledger/twin-node/commit/aab05b552152a208a504fb9a080603f1990d4f79))
75
+ * update dependencies ([6cb3d3a](https://github.com/iotaledger/twin-node/commit/6cb3d3a63f7b976f80074ddecfba034b7e92f919))
76
+ * update dependencies ([9d25f16](https://github.com/iotaledger/twin-node/commit/9d25f16f1d554cd38f3bec28fdf7f8fff892ceaf))
77
+ * update engine ([a40b377](https://github.com/iotaledger/twin-node/commit/a40b37726c3b61c6bb40265ec0006d1071ffac7e))
78
+ * update engine ([4b438e2](https://github.com/iotaledger/twin-node/commit/4b438e22c27d784ee6cc964b7cb4401e9699ab16))
79
+ * update engine dependency ([db290df](https://github.com/iotaledger/twin-node/commit/db290df3b18374f7d86da575c6048657b98c355b))
80
+ * update engine dependency ([3494c31](https://github.com/iotaledger/twin-node/commit/3494c3144fd5ce6d3a9f2936c7890ab36795aeaa))
81
+ * update for livez endpoint ([9fc2e6a](https://github.com/iotaledger/twin-node/commit/9fc2e6ade38b3ec9591399a633d02b1e5fe07910))
82
+ * update framework components ([4bee2b9](https://github.com/iotaledger/twin-node/commit/4bee2b9d3651df09b8550a9ed226be1b46031854))
83
+ * update framework core ([8bd769a](https://github.com/iotaledger/twin-node/commit/8bd769a4451f5f1f6be3f115a5e94eeb05bce7f1))
84
+ * update order of logging ([2161938](https://github.com/iotaledger/twin-node/commit/2161938c969b18e4678459a69090287e5ccdb404))
85
+ * update order of logging ([b295f31](https://github.com/iotaledger/twin-node/commit/b295f315f7c5b611d229d9e5314d414da05828b9))
86
+ * update rights management ([5c992c6](https://github.com/iotaledger/twin-node/commit/5c992c6b0d72f3eeaa39ee267e096d9a3f477f4e))
87
+ * update rights management components ([176a0d6](https://github.com/iotaledger/twin-node/commit/176a0d611f88360fc845ae233b26ee0b43d7cb23))
88
+ * update rights management dependencies ([97ad02e](https://github.com/iotaledger/twin-node/commit/97ad02e4b74cfe5e722f74da2fc2229bbf004c0a))
89
+ * update to latest engine ([00d4974](https://github.com/iotaledger/twin-node/commit/00d4974f9cfb02bf48505cfb4af4a7aba1df4b3d))
90
+ * update to latest engine config ([347386c](https://github.com/iotaledger/twin-node/commit/347386c0609e717dc20c456ad2264c83df793c59))
91
+ * updated context id features ([ef7be07](https://github.com/iotaledger/twin-node/commit/ef7be07d44dccdeacf10f90cb4ffde0303faa6fa))
92
+ * updating linting ([feacd17](https://github.com/iotaledger/twin-node/commit/feacd178bb025bcd29a0ae6e4b8e79f23a989169))
93
+ * use features instead of disableNodeIdentity ([2e6109b](https://github.com/iotaledger/twin-node/commit/2e6109bd1de825e0f5396fc120d99ad7b3929852))
94
+
95
+
96
+ ### Bug Fixes
97
+
98
+ * adding a condition to verify if the password exists when bootstrapping ([6030a42](https://github.com/iotaledger/twin-node/commit/6030a42bdaf581678d96932fd0b809396bf7b8b0))
99
+ * adding a condition to verify if the password exists when bootstrapping ([c66f396](https://github.com/iotaledger/twin-node/commit/c66f396717394161a7647d1f08b3d87729d96e96))
100
+ * bootstrap legacy fails on second run ([c0a4e6d](https://github.com/iotaledger/twin-node/commit/c0a4e6d6f8d1bf385412a22fed2a0974e219abaa))
101
+ * bootstrap vault key skip logic ([#112](https://github.com/iotaledger/twin-node/issues/112)) ([4084368](https://github.com/iotaledger/twin-node/commit/4084368f0762c3a1b8e214ac30f5545297c88ea6))
102
+ * broken docs ([61479fd](https://github.com/iotaledger/twin-node/commit/61479fd618f766d22c5aafec5277e1a89e22b453))
103
+ * improve calculation of execution directory ([106d65d](https://github.com/iotaledger/twin-node/commit/106d65d7ad5524e2e147b681d68f9476c024cfaa))
104
+ * only register DID context keys when nodeIdentityEnabled is true ([#140](https://github.com/iotaledger/twin-node/issues/140)) ([21f1c10](https://github.com/iotaledger/twin-node/commit/21f1c107adbd715518414f7255ead970b809b4b3))
105
+ * org identity verification methods ([18f158b](https://github.com/iotaledger/twin-node/commit/18f158b2f63930e20e94437c17ed43421771a458))
106
+ * pr comments [#1](https://github.com/iotaledger/twin-node/issues/1) ([66e795b](https://github.com/iotaledger/twin-node/commit/66e795b16c372ab131ec1de30085aee90e4dbbd0))
107
+ * synchronised storage construction ([#102](https://github.com/iotaledger/twin-node/issues/102)) ([58b61e9](https://github.com/iotaledger/twin-node/commit/58b61e9a67f499a35bea17e5d2dc6a1efc2cb893))
108
+ * test with latest dependencies ([91123b7](https://github.com/iotaledger/twin-node/commit/91123b71d0e7b51700a5d5452b2a0c9fc5c5256e))
109
+
110
+ ## [0.0.3-next.37](https://github.com/iotaledger/twin-node/compare/node-core-v0.0.3-next.36...node-core-v0.0.3-next.37) (2026-05-19)
111
+
112
+
113
+ ### Bug Fixes
114
+
115
+ * only register DID context keys when nodeIdentityEnabled is true ([#140](https://github.com/iotaledger/twin-node/issues/140)) ([21f1c10](https://github.com/iotaledger/twin-node/commit/21f1c107adbd715518414f7255ead970b809b4b3))
116
+
3
117
  ## [0.0.3-next.36](https://github.com/iotaledger/twin-node/compare/node-core-v0.0.3-next.35...node-core-v0.0.3-next.36) (2026-05-12)
4
118
 
5
119
 
@@ -0,0 +1,20 @@
1
+ # Function: isTelemetryRequired()
2
+
3
+ > **isTelemetryRequired**(`envVars`): `boolean`
4
+
5
+ Checks if the telemetry subsystem is required.
6
+ Returns true when any component that depends on the telemetry 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 telemetry is enabled.
@@ -20,9 +20,9 @@
20
20
 
21
21
  - [CliCommandParamType](type-aliases/CliCommandParamType.md)
22
22
  - [ModuleProtocol](type-aliases/ModuleProtocol.md)
23
- - [NodeExtensionInitialiseMethod](type-aliases/NodeExtensionInitialiseMethod.md)
24
23
  - [NodeExtensionInitialiseEngineMethod](type-aliases/NodeExtensionInitialiseEngineMethod.md)
25
24
  - [NodeExtensionInitialiseEngineServerMethod](type-aliases/NodeExtensionInitialiseEngineServerMethod.md)
25
+ - [NodeExtensionInitialiseMethod](type-aliases/NodeExtensionInitialiseMethod.md)
26
26
  - [NodeExtensionShutdownMethod](type-aliases/NodeExtensionShutdownMethod.md)
27
27
 
28
28
  ## Variables
@@ -49,6 +49,7 @@
49
49
  - [isRightsManagementRequired](functions/isRightsManagementRequired.md)
50
50
  - [isTaskSchedulerRequired](functions/isTaskSchedulerRequired.md)
51
51
  - [isAutomationRequired](functions/isAutomationRequired.md)
52
+ - [isTelemetryRequired](functions/isTelemetryRequired.md)
52
53
  - [buildEngineServerConfiguration](functions/buildEngineServerConfiguration.md)
53
54
  - [isAuthEntityStorageRequired](functions/isAuthEntityStorageRequired.md)
54
55
  - [extensionsConfiguration](functions/extensionsConfiguration.md)
@@ -706,6 +706,30 @@ The port to use for the Open Telemetry Prometheus metrics server, only required
706
706
 
707
707
  ***
708
708
 
709
+ ### telemetryMetricsCollectorIntervalSeconds? {#telemetrymetricscollectorintervalseconds}
710
+
711
+ > `optional` **telemetryMetricsCollectorIntervalSeconds?**: `string`
712
+
713
+ Polling interval in seconds for the telemetry metrics collector. Defaults to 60.
714
+
715
+ ***
716
+
717
+ ### telemetryMetricsProducers? {#telemetrymetricsproducers}
718
+
719
+ > `optional` **telemetryMetricsProducers?**: `string`
720
+
721
+ The type of telemetry metrics producers, can be a comma separated list: system, process.
722
+
723
+ ***
724
+
725
+ ### telemetryMetricsProducerMaxHistory? {#telemetrymetricsproducermaxhistory}
726
+
727
+ > `optional` **telemetryMetricsProducerMaxHistory?**: `string`
728
+
729
+ Maximum number of values retained per telemetry metric (count-based history cap). Defaults to 1440.
730
+
731
+ ***
732
+
709
733
  ### faucetConnector? {#faucetconnector}
710
734
 
711
735
  > `optional` **faucetConnector?**: `string`
@@ -1058,6 +1058,42 @@ The port to use for the Open Telemetry Prometheus metrics server, only required
1058
1058
 
1059
1059
  ***
1060
1060
 
1061
+ ### telemetryMetricsCollectorIntervalSeconds? {#telemetrymetricscollectorintervalseconds}
1062
+
1063
+ > `optional` **telemetryMetricsCollectorIntervalSeconds?**: `string`
1064
+
1065
+ Polling interval in seconds for the telemetry metrics collector. Defaults to 60.
1066
+
1067
+ #### Inherited from
1068
+
1069
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`telemetryMetricsCollectorIntervalSeconds`](IEngineEnvironmentVariables.md#telemetrymetricscollectorintervalseconds)
1070
+
1071
+ ***
1072
+
1073
+ ### telemetryMetricsProducers? {#telemetrymetricsproducers}
1074
+
1075
+ > `optional` **telemetryMetricsProducers?**: `string`
1076
+
1077
+ The type of telemetry metrics producers, can be a comma separated list: system, process.
1078
+
1079
+ #### Inherited from
1080
+
1081
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`telemetryMetricsProducers`](IEngineEnvironmentVariables.md#telemetrymetricsproducers)
1082
+
1083
+ ***
1084
+
1085
+ ### telemetryMetricsProducerMaxHistory? {#telemetrymetricsproducermaxhistory}
1086
+
1087
+ > `optional` **telemetryMetricsProducerMaxHistory?**: `string`
1088
+
1089
+ Maximum number of values retained per telemetry metric (count-based history cap). Defaults to 1440.
1090
+
1091
+ #### Inherited from
1092
+
1093
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`telemetryMetricsProducerMaxHistory`](IEngineEnvironmentVariables.md#telemetrymetricsproducermaxhistory)
1094
+
1095
+ ***
1096
+
1061
1097
  ### faucetConnector? {#faucetconnector}
1062
1098
 
1063
1099
  > `optional` **faucetConnector?**: `string`
@@ -1054,6 +1054,42 @@ The port to use for the Open Telemetry Prometheus metrics server, only required
1054
1054
 
1055
1055
  ***
1056
1056
 
1057
+ ### telemetryMetricsCollectorIntervalSeconds? {#telemetrymetricscollectorintervalseconds}
1058
+
1059
+ > `optional` **telemetryMetricsCollectorIntervalSeconds?**: `string`
1060
+
1061
+ Polling interval in seconds for the telemetry metrics collector. Defaults to 60.
1062
+
1063
+ #### Inherited from
1064
+
1065
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`telemetryMetricsCollectorIntervalSeconds`](IEngineServerEnvironmentVariables.md#telemetrymetricscollectorintervalseconds)
1066
+
1067
+ ***
1068
+
1069
+ ### telemetryMetricsProducers? {#telemetrymetricsproducers}
1070
+
1071
+ > `optional` **telemetryMetricsProducers?**: `string`
1072
+
1073
+ The type of telemetry metrics producers, can be a comma separated list: system, process.
1074
+
1075
+ #### Inherited from
1076
+
1077
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`telemetryMetricsProducers`](IEngineServerEnvironmentVariables.md#telemetrymetricsproducers)
1078
+
1079
+ ***
1080
+
1081
+ ### telemetryMetricsProducerMaxHistory? {#telemetrymetricsproducermaxhistory}
1082
+
1083
+ > `optional` **telemetryMetricsProducerMaxHistory?**: `string`
1084
+
1085
+ Maximum number of values retained per telemetry metric (count-based history cap). Defaults to 1440.
1086
+
1087
+ #### Inherited from
1088
+
1089
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`telemetryMetricsProducerMaxHistory`](IEngineServerEnvironmentVariables.md#telemetrymetricsproducermaxhistory)
1090
+
1091
+ ***
1092
+
1057
1093
  ### faucetConnector? {#faucetconnector}
1058
1094
 
1059
1095
  > `optional` **faucetConnector?**: `string`
package/locales/en.json CHANGED
@@ -42,7 +42,11 @@
42
42
  },
43
43
  "userCreate": {
44
44
  "passwordTooShort": "The password provided is too short, it must be at least {minLength} characters long.",
45
- "userAlreadyExists": "The user with ID already exists and overwriteMode is set to \"error\"."
45
+ "userAlreadyExists": "The user with ID already exists and overwriteMode is set to \"error\".",
46
+ "tenantIdRequired": "The tenant ID is required when multi-tenancy is enabled."
47
+ },
48
+ "userUpdate": {
49
+ "tenantIdRequired": "The tenant ID is required when multi-tenancy is enabled."
46
50
  },
47
51
  "vaultKeyCreate": {
48
52
  "vaultKeyAlreadyExists": "The vault key with ID already exists and overwriteMode is set to \"error\"."
@@ -457,6 +461,9 @@
457
461
  "organization-identity": {
458
462
  "description": "The organization DID to associate the user with."
459
463
  },
464
+ "tenant-id": {
465
+ "description": "The tenant ID to associate the user with."
466
+ },
460
467
  "email": {
461
468
  "description": "The email address of the user."
462
469
  },
@@ -512,6 +519,9 @@
512
519
  "organization-identity": {
513
520
  "description": "The organization DID to associate the user with."
514
521
  },
522
+ "tenant-id": {
523
+ "description": "The tenant ID to associate the user with."
524
+ },
515
525
  "email": {
516
526
  "description": "The email address of the user."
517
527
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/node-core",
3
- "version": "0.0.3-next.36",
3
+ "version": "0.0.3-next.39",
4
4
  "description": "TWIN Node Core for serving APIs using the specified configuration",
5
5
  "repository": {
6
6
  "type": "git",
@@ -35,6 +35,7 @@
35
35
  "@twin.org/standards-w3c-did": "next",
36
36
  "@twin.org/standards-w3c-odrl": "next",
37
37
  "@twin.org/telemetry-connector-opentelemetry": "next",
38
+ "@twin.org/telemetry-models": "next",
38
39
  "@twin.org/trust-models": "next",
39
40
  "@twin.org/vault-models": "next",
40
41
  "@twin.org/wallet-models": "next",
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=nodeExtensionMethods.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"nodeExtensionMethods.js","sourceRoot":"","sources":["../../../src/models/nodeExtensionMethods.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IEngineCore, IEngineServer } from \"@twin.org/engine-models\";\nimport type { INodeEngineConfig } from \"./INodeEngineConfig.js\";\nimport type { INodeEnvironmentVariables } from \"./INodeEnvironmentVariables.js\";\n\n/**\n * The type for the initialise method of an extension module.\n * @param envVars The environment variables for the node.\n * @param nodeEngineConfig The node engine config.\n */\nexport type NodeExtensionInitialiseMethod = (\n\tenvVars: INodeEnvironmentVariables,\n\tnodeEngineConfig: INodeEngineConfig\n) => Promise<void>;\n\n/**\n * The type for the initialise engine method of an extension module.\n * This is called when the engine has been constructed but not yet started.\n * @param engineCore The engine core instance.\n */\nexport type NodeExtensionInitialiseEngineMethod = (engineCore: IEngineCore) => Promise<void>;\n\n/**\n * The type for the initialise engine server method of an extension module.\n * This is called when the engine server has been constructed but not yet started.\n * @param engineCore The engine core instance.\n * @param engineServer The engine server instance.\n */\nexport type NodeExtensionInitialiseEngineServerMethod = (\n\tengineCore: IEngineCore,\n\tengineServer: IEngineServer\n) => Promise<void>;\n\n/**\n * The type for the shutdown method of an extension module.\n * This is called when the engine is shutting down.\n */\nexport type NodeExtensionShutdownMethod = () => Promise<void>;\n"]}
@@ -1,27 +0,0 @@
1
- import type { IEngineCore, IEngineServer } from "@twin.org/engine-models";
2
- import type { INodeEngineConfig } from "./INodeEngineConfig.js";
3
- import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables.js";
4
- /**
5
- * The type for the initialise method of an extension module.
6
- * @param envVars The environment variables for the node.
7
- * @param nodeEngineConfig The node engine config.
8
- */
9
- export type NodeExtensionInitialiseMethod = (envVars: INodeEnvironmentVariables, nodeEngineConfig: INodeEngineConfig) => Promise<void>;
10
- /**
11
- * The type for the initialise engine method of an extension module.
12
- * This is called when the engine has been constructed but not yet started.
13
- * @param engineCore The engine core instance.
14
- */
15
- export type NodeExtensionInitialiseEngineMethod = (engineCore: IEngineCore) => Promise<void>;
16
- /**
17
- * The type for the initialise engine server method of an extension module.
18
- * This is called when the engine server has been constructed but not yet started.
19
- * @param engineCore The engine core instance.
20
- * @param engineServer The engine server instance.
21
- */
22
- export type NodeExtensionInitialiseEngineServerMethod = (engineCore: IEngineCore, engineServer: IEngineServer) => Promise<void>;
23
- /**
24
- * The type for the shutdown method of an extension module.
25
- * This is called when the engine is shutting down.
26
- */
27
- export type NodeExtensionShutdownMethod = () => Promise<void>;