@twin.org/node-core 0.0.1-next.9 → 0.0.1

package/docs/changelog.md

@@ -1,5 +1,47 @@
 # @twin.org/node-core - Changelog
 
+## 0.0.1 (2025-07-11)
+
+
+### Features
+
+* add auth admin component ([1661e57](https://github.com/twinfoundation/node/commit/1661e57a699d5cf9ebde333e3cbc3aaea89d7c9c))
+* add extend engine and server methods ([ec09c7e](https://github.com/twinfoundation/node/commit/ec09c7eb882d9f5797f2fd372e96cad1a3716f59))
+* add extend engine and server methods ([0136a6f](https://github.com/twinfoundation/node/commit/0136a6f3f4e1a82b1427ee9618b8a17c79bc7fda))
+* additional run options ([c35e5bb](https://github.com/twinfoundation/node/commit/c35e5bbb8a80fe6a36628d41f64585b3723d9ad7))
+* additional startup logging ([0740293](https://github.com/twinfoundation/node/commit/0740293b366032f2907046603abf587c9c324aff))
+* improve default options and spec ([b538721](https://github.com/twinfoundation/node/commit/b538721902e7f65021d2715148ba59409ccce035))
+* improve error reporting ([fcd39a1](https://github.com/twinfoundation/node/commit/fcd39a18da2a6ce33965a99ca5f2f36f4aba712f))
+* initial commit ([522f1e5](https://github.com/twinfoundation/node/commit/522f1e515348f9b1dd1eeb3170b1249e2b0b5371))
+* migrate env config from engine to node ([5da29b8](https://github.com/twinfoundation/node/commit/5da29b8d714495308320d237a68e84355bba2b47))
+* node app use JavaScript ([14fe08c](https://github.com/twinfoundation/node/commit/14fe08cb760dd885a5dac9056a4d5dbc3d61df64))
+* release to production ([6319a38](https://github.com/twinfoundation/node/commit/6319a38490a2c2809622f8acd170cb92bfa06942))
+* release to production ([4f44403](https://github.com/twinfoundation/node/commit/4f444039832edce8fae562baa7c900ccdc2181da))
+* release to production ([2d96e37](https://github.com/twinfoundation/node/commit/2d96e3737bd9663bc0d1171c2ff2c7f8b2ab01bb))
+* update dependencies ([9d25f16](https://github.com/twinfoundation/node/commit/9d25f16f1d554cd38f3bec28fdf7f8fff892ceaf))
+
+
+### Bug Fixes
+
+* adding a condition to verify if the password exists when bootstrapping ([6030a42](https://github.com/twinfoundation/node/commit/6030a42bdaf581678d96932fd0b809396bf7b8b0))
+* adding a condition to verify if the password exists when bootstrapping ([c66f396](https://github.com/twinfoundation/node/commit/c66f396717394161a7647d1f08b3d87729d96e96))
+* broken docs ([61479fd](https://github.com/twinfoundation/node/commit/61479fd618f766d22c5aafec5277e1a89e22b453))
+* pr comments [#1](https://github.com/twinfoundation/node/issues/1) ([66e795b](https://github.com/twinfoundation/node/commit/66e795b16c372ab131ec1de30085aee90e4dbbd0))
+
+## [0.0.1-next.11](https://github.com/twinfoundation/node/compare/node-core-v0.0.1-next.10...node-core-v0.0.1-next.11) (2025-07-11)
+
+
+### Features
+
+* add auth admin component ([1661e57](https://github.com/twinfoundation/node/commit/1661e57a699d5cf9ebde333e3cbc3aaea89d7c9c))
+
+## [0.0.1-next.10](https://github.com/twinfoundation/node/compare/node-core-v0.0.1-next.9...node-core-v0.0.1-next.10) (2025-07-11)
+
+
+### Features
+
+* migrate env config from engine to node ([5da29b8](https://github.com/twinfoundation/node/commit/5da29b8d714495308320d237a68e84355bba2b47))
+
 ## [0.0.1-next.9](https://github.com/twinfoundation/node/compare/node-core-v0.0.1-next.8...node-core-v0.0.1-next.9) (2025-06-20)
 
 

package/docs/reference/functions/bootstrap.md

@@ -14,13 +14,13 @@ The engine core for the node.
 
 ### context
 
-`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeState`](../interfaces/INodeState.md)\>
+`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
 
 The context for the node.
 
 ### envVars
 
-[`INodeVariables`](../interfaces/INodeVariables.md)
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
 
 The environment variables for the node.
 

package/docs/reference/functions/bootstrapAttestationMethod.md

@@ -14,13 +14,13 @@ The engine core for the node.
 
 ### context
 
-`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeState`](../interfaces/INodeState.md)\>
+`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
 
 The context for the node.
 
 ### envVars
 
-[`INodeVariables`](../interfaces/INodeVariables.md)
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
 
 The environment variables for the node.
 

package/docs/reference/functions/bootstrapAuth.md

@@ -14,13 +14,13 @@ The engine core for the node.
 
 ### context
 
-`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeState`](../interfaces/INodeState.md)\>
+`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
 
 The context for the node.
 
 ### envVars
 
-[`INodeVariables`](../interfaces/INodeVariables.md)
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
 
 The environment variables for the node.
 

package/docs/reference/functions/bootstrapBlobEncryption.md

@@ -14,13 +14,13 @@ The engine core for the node.
 
 ### context
 
-`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeState`](../interfaces/INodeState.md)\>
+`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
 
 The context for the node.
 
 ### envVars
 
-[`INodeVariables`](../interfaces/INodeVariables.md)
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
 
 The environment variables for the node.
 

package/docs/reference/functions/bootstrapImmutableProofMethod.md

@@ -14,13 +14,13 @@ The engine core for the node.
 
 ### context
 
-`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeState`](../interfaces/INodeState.md)\>
+`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
 
 The context for the node.
 
 ### envVars
 
-[`INodeVariables`](../interfaces/INodeVariables.md)
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
 
 The environment variables for the node.
 

package/docs/reference/functions/bootstrapNodeIdentity.md

@@ -14,13 +14,13 @@ The engine core for the node.
 
 ### context
 
-`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeState`](../interfaces/INodeState.md)\>
+`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
 
 The context for the node.
 
 ### envVars
 
-[`INodeVariables`](../interfaces/INodeVariables.md)
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
 
 The environment variables for the node.
 

package/docs/reference/functions/bootstrapNodeUser.md

@@ -14,13 +14,13 @@ The engine core for the node.
 
 ### context
 
-`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeState`](../interfaces/INodeState.md)\>
+`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
 
 The context for the node.
 
 ### envVars
 
-[`INodeVariables`](../interfaces/INodeVariables.md)
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
 
 The environment variables for the node.
 

package/docs/reference/functions/buildConfiguration.md

@@ -0,0 +1,30 @@
+# Function: buildConfiguration()
+
+> **buildConfiguration**(`processEnv`, `options`, `serverInfo`): `Promise`\<\{ `nodeEnvVars`: [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & `object`; `engineServerConfig`: `IEngineServerConfig`; \}\>
+
+Build the configuration for the TWIN Node server.
+
+## Parameters
+
+### processEnv
+
+The environment variables from the process.
+
+### options
+
+[`INodeOptions`](../interfaces/INodeOptions.md)
+
+The options for running the server.
+
+### serverInfo
+
+`IServerInfo`
+
+The server information.
+
+## Returns
+
+`Promise`\<\{ `nodeEnvVars`: [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & `object`; `engineServerConfig`: `IEngineServerConfig`; \}\>
+
+A promise that resolves to the engine server configuration, environment prefix, environment variables,
+and options.

package/docs/reference/functions/buildEngineConfiguration.md

@@ -0,0 +1,19 @@
+# Function: buildEngineConfiguration()
+
+> **buildEngineConfiguration**(`envVars`): `IEngineConfig`
+
+Build the engine core configuration from environment variables.
+
+## Parameters
+
+### envVars
+
+[`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md)
+
+The environment variables.
+
+## Returns
+
+`IEngineConfig`
+
+The config for the core.

package/docs/reference/functions/getFeatures.md

@@ -8,7 +8,7 @@ Get the features that are enabled on the node.
 
 ### env
 
-[`INodeVariables`](../interfaces/INodeVariables.md)
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
 
 The environment variables for the node.
 

package/docs/reference/functions/loadJsonFile.md

@@ -0,0 +1,25 @@
+# Function: loadJsonFile()
+
+> **loadJsonFile**\<`T`\>(`filename`): `Promise`\<`T`\>
+
+Load the JSON file.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### filename
+
+`string`
+
+The filename of the JSON file to load.
+
+## Returns
+
+`Promise`\<`T`\>
+
+The contents of the JSON file or null if it could not be loaded.

package/docs/reference/functions/run.md

@@ -1,14 +1,14 @@
 # Function: run()
 
-> **run**(`options?`): `Promise`\<`void`\>
+> **run**(`nodeOptions?`): `Promise`\<`void`\>
 
 Run the TWIN Node server.
 
 ## Parameters
 
-### options?
+### nodeOptions?
 
-[`IRunOptions`](../interfaces/IRunOptions.md)
+[`INodeOptions`](../interfaces/INodeOptions.md)
 
 Optional configuration options for running the server.
 

package/docs/reference/functions/start.md

@@ -1,61 +1,31 @@
 # Function: start()
 
-> **start**(`serverInfo`, `envVarsPrefix`, `envVars`, `openApiSpecFile?`, `stateStorage?`, `extendConfig?`, `extendEngine?`, `extendEngineServer?`): `Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeState`](../interfaces/INodeState.md)\>; `server`: `EngineServer`; \}\>
+> **start**(`nodeOptions`, `engineServerConfig`, `envVars`): `Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, `IEngineState`\>; `server`: `EngineServer`; \}\>
 
 Start the engine server.
 
 ## Parameters
 
-### serverInfo
+### nodeOptions
 
-`IServerInfo`
+Optional run options for the engine server.
 
-The server information.
+`undefined` | [`INodeOptions`](../interfaces/INodeOptions.md)
 
-### envVarsPrefix
+### engineServerConfig
 
-`string`
+`IEngineServerConfig`
 
-The prefix for the environment variables.
+The configuration for the engine server.
 
 ### envVars
 
-[`INodeVariables`](../interfaces/INodeVariables.md)
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
 
 The environment variables.
 
-### openApiSpecFile?
-
-`string`
-
-Path to the OpenAPI spec file.
-
-### stateStorage?
-
-`IEngineStateStorage`\<`IEngineState`\>
-
-The state storage.
-
-### extendConfig?
-
-(`config`) => `Promise`\<`void`\>
-
-Extends the engine configuration with any additional custom configuration.
-
-### extendEngine?
-
-(`engine`) => `Promise`\<`void`\>
-
-Extends the engine with any additional options.
-
-### extendEngineServer?
-
-(`engineServer`) => `Promise`\<`void`\>
-
-Extends the engine server with any additional options.
-
 ## Returns
 
-`Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeState`](../interfaces/INodeState.md)\>; `server`: `EngineServer`; \}\>
+`Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, `IEngineState`\>; `server`: `EngineServer`; \}\>
 
 The engine server.

package/docs/reference/index.md

@@ -2,9 +2,10 @@
 
 ## Interfaces
 
-- [INodeState](interfaces/INodeState.md)
-- [INodeVariables](interfaces/INodeVariables.md)
-- [IRunOptions](interfaces/IRunOptions.md)
+- [IEngineEnvironmentVariables](interfaces/IEngineEnvironmentVariables.md)
+- [IEngineServerEnvironmentVariables](interfaces/IEngineServerEnvironmentVariables.md)
+- [INodeEnvironmentVariables](interfaces/INodeEnvironmentVariables.md)
+- [INodeOptions](interfaces/INodeOptions.md)
 
 ## Type Aliases
 
@@ -23,9 +24,12 @@
 - [bootstrapImmutableProofMethod](functions/bootstrapImmutableProofMethod.md)
 - [bootstrapBlobEncryption](functions/bootstrapBlobEncryption.md)
 - [bootstrapAuth](functions/bootstrapAuth.md)
+- [buildEngineConfiguration](functions/buildEngineConfiguration.md)
 - [run](functions/run.md)
+- [buildConfiguration](functions/buildConfiguration.md)
 - [start](functions/start.md)
 - [initialiseLocales](functions/initialiseLocales.md)
 - [getExecutionDirectory](functions/getExecutionDirectory.md)
 - [fileExists](functions/fileExists.md)
+- [loadJsonFile](functions/loadJsonFile.md)
 - [getFeatures](functions/getFeatures.md)