@twin.org/node-core 0.0.1-next.10

package/dist/types/utils.d.ts

@@ -0,0 +1,30 @@
+import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables";
+import { NodeFeatures } from "./models/nodeFeatures";
+/**
+ * Initialise the locales for the application.
+ * @param localesDirectory The directory containing the locales.
+ */
+export declare function initialiseLocales(localesDirectory: string): Promise<void>;
+/**
+ * Get the directory where the application is being executed.
+ * @returns The execution directory.
+ */
+export declare function getExecutionDirectory(): string;
+/**
+ * Does the specified file exist.
+ * @param filename The filename to check for existence.
+ * @returns True if the file exists.
+ */
+export declare function fileExists(filename: string): Promise<boolean>;
+/**
+ * Load the JSON file.
+ * @param filename The filename of the JSON file to load.
+ * @returns The contents of the JSON file or null if it could not be loaded.
+ */
+export declare function loadJsonFile<T>(filename: string): Promise<T>;
+/**
+ * Get the features that are enabled on the node.
+ * @param env The environment variables for the node.
+ * @returns The features that are enabled on the node.
+ */
+export declare function getFeatures(env: INodeEnvironmentVariables): NodeFeatures[];

package/docs/changelog.md

@@ -0,0 +1,76 @@
+# @twin.org/node-core - Changelog
+
+## [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)
+
+
+### Features
+
+* additional startup logging ([0740293](https://github.com/twinfoundation/node/commit/0740293b366032f2907046603abf587c9c324aff))
+
+## [0.0.1-next.8](https://github.com/twinfoundation/node/compare/node-core-v0.0.1-next.7...node-core-v0.0.1-next.8) (2025-06-18)
+
+
+### Features
+
+* improve default options and spec ([b538721](https://github.com/twinfoundation/node/commit/b538721902e7f65021d2715148ba59409ccce035))
+
+## [0.0.1-next.7](https://github.com/twinfoundation/node/compare/node-core-v0.0.1-next.6...node-core-v0.0.1-next.7) (2025-06-17)
+
+
+### 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))
+* pr comments [#1](https://github.com/twinfoundation/node/issues/1) ([66e795b](https://github.com/twinfoundation/node/commit/66e795b16c372ab131ec1de30085aee90e4dbbd0))
+
+## [0.0.1-next.6](https://github.com/twinfoundation/node/compare/node-core-v0.0.1-next.5...node-core-v0.0.1-next.6) (2025-06-12)
+
+### Features
+
+- 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))
+- improve error reporting ([fcd39a1](https://github.com/twinfoundation/node/commit/fcd39a18da2a6ce33965a99ca5f2f36f4aba712f))
+- initial commit ([522f1e5](https://github.com/twinfoundation/node/commit/522f1e515348f9b1dd1eeb3170b1249e2b0b5371))
+- node app use JavaScript ([14fe08c](https://github.com/twinfoundation/node/commit/14fe08cb760dd885a5dac9056a4d5dbc3d61df64))
+- update dependencies ([9d25f16](https://github.com/twinfoundation/node/commit/9d25f16f1d554cd38f3bec28fdf7f8fff892ceaf))
+
+### Bug Fixes
+
+- broken docs ([61479fd](https://github.com/twinfoundation/node/commit/61479fd618f766d22c5aafec5277e1a89e22b453))
+
+## [0.0.1-next.5](https://github.com/twinfoundation/node/compare/node-core-v0.0.1-next.4...node-core-v0.0.1-next.5) (2025-06-12)
+
+### Features
+
+- add extend engine and server methods ([0136a6f](https://github.com/twinfoundation/node/commit/0136a6f3f4e1a82b1427ee9618b8a17c79bc7fda))
+
+## [0.0.1-next.4](https://github.com/twinfoundation/node/compare/node-core-v0.0.1-next.3...node-core-v0.0.1-next.4) (2025-05-27)
+
+### Features
+
+- improve error reporting ([fcd39a1](https://github.com/twinfoundation/node/commit/fcd39a18da2a6ce33965a99ca5f2f36f4aba712f))
+
+### Bug Fixes
+
+- broken docs ([61479fd](https://github.com/twinfoundation/node/commit/61479fd618f766d22c5aafec5277e1a89e22b453))
+
+## [0.0.1-next.3](https://github.com/twinfoundation/node/compare/node-core-v0.0.1-next.2...node-core-v0.0.1-next.3) (2025-05-27)
+
+### Features
+
+- additional run options ([c35e5bb](https://github.com/twinfoundation/node/commit/c35e5bbb8a80fe6a36628d41f64585b3723d9ad7))
+- node app use JavaScript ([14fe08c](https://github.com/twinfoundation/node/commit/14fe08cb760dd885a5dac9056a4d5dbc3d61df64))
+
+## [0.0.1-next.2](https://github.com/twinfoundation/node/compare/node-core-v0.0.1-next.1...node-core-v0.0.1-next.2) (2025-05-27)
+
+### Features
+
+- initial commit ([522f1e5](https://github.com/twinfoundation/node/commit/522f1e515348f9b1dd1eeb3170b1249e2b0b5371))

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/node-core - Examples

package/docs/reference/functions/bootstrap.md

@@ -0,0 +1,29 @@
+# Function: bootstrap()
+
+> **bootstrap**(`engineCore`, `context`, `envVars`): `Promise`\<`void`\>
+
+Bootstrap the application.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`
+
+The engine core for the node.
+
+### context
+
+`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
+
+The context for the node.
+
+### envVars
+
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+
+The environment variables for the node.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/bootstrapAttestationMethod.md

@@ -0,0 +1,35 @@
+# Function: bootstrapAttestationMethod()
+
+> **bootstrapAttestationMethod**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
+
+Bootstrap the attestation verification methods.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`
+
+The engine core for the node.
+
+### context
+
+`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
+
+The context for the node.
+
+### envVars
+
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+
+The environment variables for the node.
+
+### features
+
+[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
+
+The features that are enabled on the node.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/bootstrapAuth.md

@@ -0,0 +1,35 @@
+# Function: bootstrapAuth()
+
+> **bootstrapAuth**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
+
+Bootstrap the JWT signing key.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`
+
+The engine core for the node.
+
+### context
+
+`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
+
+The context for the node.
+
+### envVars
+
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+
+The environment variables for the node.
+
+### features
+
+[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
+
+The features that are enabled on the node.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/bootstrapBlobEncryption.md

@@ -0,0 +1,35 @@
+# Function: bootstrapBlobEncryption()
+
+> **bootstrapBlobEncryption**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
+
+Bootstrap the keys for blob encryption.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`
+
+The engine core for the node.
+
+### context
+
+`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
+
+The context for the node.
+
+### envVars
+
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+
+The environment variables for the node.
+
+### features
+
+[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
+
+The features that are enabled on the node.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/bootstrapImmutableProofMethod.md

@@ -0,0 +1,35 @@
+# Function: bootstrapImmutableProofMethod()
+
+> **bootstrapImmutableProofMethod**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
+
+Bootstrap the immutable proof verification methods.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`
+
+The engine core for the node.
+
+### context
+
+`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
+
+The context for the node.
+
+### envVars
+
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+
+The environment variables for the node.
+
+### features
+
+[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
+
+The features that are enabled on the node.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/bootstrapNodeIdentity.md

@@ -0,0 +1,35 @@
+# Function: bootstrapNodeIdentity()
+
+> **bootstrapNodeIdentity**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
+
+Bootstrap the node creating any necessary resources.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`
+
+The engine core for the node.
+
+### context
+
+`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
+
+The context for the node.
+
+### envVars
+
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+
+The environment variables for the node.
+
+### features
+
+[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
+
+The features that are enabled on the node. The features that are enabled on the node.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/bootstrapNodeUser.md

@@ -0,0 +1,35 @@
+# Function: bootstrapNodeUser()
+
+> **bootstrapNodeUser**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
+
+Bootstrap the user.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`
+
+The engine core for the node.
+
+### context
+
+`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
+
+The context for the node.
+
+### envVars
+
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+
+The environment variables for the node.
+
+### features
+
+[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
+
+The features that are enabled on the node.
+
+## Returns
+
+`Promise`\<`void`\>

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/fileExists.md

@@ -0,0 +1,19 @@
+# Function: fileExists()
+
+> **fileExists**(`filename`): `Promise`\<`boolean`\>
+
+Does the specified file exist.
+
+## Parameters
+
+### filename
+
+`string`
+
+The filename to check for existence.
+
+## Returns
+
+`Promise`\<`boolean`\>
+
+True if the file exists.

package/docs/reference/functions/getExecutionDirectory.md

@@ -0,0 +1,11 @@
+# Function: getExecutionDirectory()
+
+> **getExecutionDirectory**(): `string`
+
+Get the directory where the application is being executed.
+
+## Returns
+
+`string`
+
+The execution directory.

package/docs/reference/functions/getFeatures.md

@@ -0,0 +1,19 @@
+# Function: getFeatures()
+
+> **getFeatures**(`env`): [`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
+
+Get the features that are enabled on the node.
+
+## Parameters
+
+### env
+
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+
+The environment variables for the node.
+
+## Returns
+
+[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
+
+The features that are enabled on the node.

package/docs/reference/functions/initialiseLocales.md

@@ -0,0 +1,17 @@
+# Function: initialiseLocales()
+
+> **initialiseLocales**(`localesDirectory`): `Promise`\<`void`\>
+
+Initialise the locales for the application.
+
+## Parameters
+
+### localesDirectory
+
+`string`
+
+The directory containing the locales.
+
+## Returns
+
+`Promise`\<`void`\>

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

@@ -0,0 +1,19 @@
+# Function: run()
+
+> **run**(`nodeOptions?`): `Promise`\<`void`\>
+
+Run the TWIN Node server.
+
+## Parameters
+
+### nodeOptions?
+
+[`INodeOptions`](../interfaces/INodeOptions.md)
+
+Optional configuration options for running the server.
+
+## Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the server is started.

package/docs/reference/functions/start.md

@@ -0,0 +1,31 @@
+# Function: start()
+
+> **start**(`nodeOptions`, `engineServerConfig`, `envVars`): `Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, `IEngineState`\>; `server`: `EngineServer`; \}\>
+
+Start the engine server.
+
+## Parameters
+
+### nodeOptions
+
+Optional run options for the engine server.
+
+`undefined` | [`INodeOptions`](../interfaces/INodeOptions.md)
+
+### engineServerConfig
+
+`IEngineServerConfig`
+
+The configuration for the engine server.
+
+### envVars
+
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+
+The environment variables.
+
+## Returns
+
+`Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, `IEngineState`\>; `server`: `EngineServer`; \}\>
+
+The engine server.

package/docs/reference/index.md

@@ -0,0 +1,35 @@
+# @twin.org/node-core
+
+## Interfaces
+
+- [IEngineEnvironmentVariables](interfaces/IEngineEnvironmentVariables.md)
+- [IEngineServerEnvironmentVariables](interfaces/IEngineServerEnvironmentVariables.md)
+- [INodeEnvironmentVariables](interfaces/INodeEnvironmentVariables.md)
+- [INodeOptions](interfaces/INodeOptions.md)
+
+## Type Aliases
+
+- [NodeFeatures](type-aliases/NodeFeatures.md)
+
+## Variables
+
+- [NodeFeatures](variables/NodeFeatures.md)
+
+## Functions
+
+- [bootstrap](functions/bootstrap.md)
+- [bootstrapNodeIdentity](functions/bootstrapNodeIdentity.md)
+- [bootstrapNodeUser](functions/bootstrapNodeUser.md)
+- [bootstrapAttestationMethod](functions/bootstrapAttestationMethod.md)
+- [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)