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

package/dist/types/models/INodeVariables.d.ts

@@ -0,0 +1,29 @@
+import type { IEngineEnvironmentVariables } from "@twin.org/engine";
+import type { IEngineServerEnvironmentVariables } from "@twin.org/engine-server";
+/**
+ * The environment variables for the node.
+ */
+export interface INodeVariables extends IEngineEnvironmentVariables, IEngineServerEnvironmentVariables {
+    /**
+     * The features that are enabled on the node.
+     * @default [NodeFeatures.NodeIdentity]
+     */
+    features?: string;
+    /**
+     * The identity of the node which, if empty and node-identity feature is enabled it will be generated.
+     */
+    identity?: string;
+    /**
+     * The mnemonic for the identity, if empty and node-identity feature is enabled it will be randomly generated.
+     */
+    mnemonic?: string;
+    /**
+     * If the node-user feature is enabled, this will be the name of the user.
+     * @default admin@node
+     */
+    username?: string;
+    /**
+     * If the node-user feature is enabled, this will be the password of the user, if empty it will be randomly generated.
+     */
+    password?: string;
+}

package/dist/types/models/nodeFeatures.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The features that can be enabled on the node.
+ */
+export declare const NodeFeatures: {
+    /**
+     * NodeIdentity - generates an identity for the node if not provided in config.
+     */
+    readonly NodeIdentity: "node-identity";
+    /**
+     * NodeUser - generates a user for the node if not provided in config.
+     */
+    readonly NodeUser: "node-user";
+};
+/**
+ * The features that can be enabled on the node.
+ */
+export type NodeFeatures = (typeof NodeFeatures)[keyof typeof NodeFeatures];

package/dist/types/node.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Run the TWIN Node server.
+ * @param options Optional options for the server.
+ * @param options.serverName Optional name of the server, defaults to "TWIN Node Server".
+ * @param options.serverVersion Optional version of the server, defaults to current version.
+ * @param options.envFilenames Additional environment variable filenames to load, defaults to .env.
+ * @param options.envPrefix Optional prefix for environment variables, defaults to "TWIN_NODE_".
+ * @param options.executionDirectory Optional directory to override the execution location, defaults to process directory.
+ * @param options.localesDirectory Optional directory to override the locales directory, defaults to the locales directory.
+ * @param options.openApiSpecFile Optional path to the OpenAPI spec file, defaults to docs/open-api/spec.json.
+ * @returns A promise that resolves when the server is started.
+ */
+export declare function run(options?: {
+    serverName?: string;
+    serverVersion?: string;
+    envFilenames?: string[];
+    envPrefix?: string;
+    executionDirectory?: string;
+    localesDirectory?: string;
+    openApiSpecFile?: string;
+}): Promise<void>;

package/dist/types/server.d.ts

@@ -0,0 +1,21 @@
+import type { IServerInfo } from "@twin.org/api-models";
+import { Engine } from "@twin.org/engine";
+import { type IEngineStateStorage } from "@twin.org/engine-models";
+import { EngineServer } from "@twin.org/engine-server";
+import type { IEngineServerConfig } from "@twin.org/engine-server-types";
+import { type IEngineConfig } from "@twin.org/engine-types";
+import type { INodeState } from "./models/INodeState";
+import type { INodeVariables } from "./models/INodeVariables";
+/**
+ * Start the engine server.
+ * @param serverInfo The server information.
+ * @param envVars The environment variables.
+ * @param openApiSpecFile Path to the OpenAPI spec file.
+ * @param stateStorage The state storage.
+ * @param extendConfig Extends the engine configuration with any additional custom configuration.
+ * @returns The engine server.
+ */
+export declare function start(serverInfo: IServerInfo, envVars: INodeVariables, openApiSpecFile?: string, stateStorage?: IEngineStateStorage, extendConfig?: (config: IEngineConfig) => Promise<void>): Promise<{
+    engine: Engine<IEngineServerConfig, INodeState>;
+    server: EngineServer;
+} | undefined>;

package/dist/types/utils.d.ts

@@ -0,0 +1,24 @@
+import type { INodeVariables } from "./models/INodeVariables";
+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>;
+/**
+ * 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: INodeVariables): NodeFeatures[];

package/docs/changelog.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## [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/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`, [`INodeState`](../interfaces/INodeState.md)\>
+
+The context for the node.
+
+### envVars
+
+[`INodeVariables`](../interfaces/INodeVariables.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`, [`INodeState`](../interfaces/INodeState.md)\>
+
+The context for the node.
+
+### envVars
+
+[`INodeVariables`](../interfaces/INodeVariables.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`, [`INodeState`](../interfaces/INodeState.md)\>
+
+The context for the node.
+
+### envVars
+
+[`INodeVariables`](../interfaces/INodeVariables.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`, [`INodeState`](../interfaces/INodeState.md)\>
+
+The context for the node.
+
+### envVars
+
+[`INodeVariables`](../interfaces/INodeVariables.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`, [`INodeState`](../interfaces/INodeState.md)\>
+
+The context for the node.
+
+### envVars
+
+[`INodeVariables`](../interfaces/INodeVariables.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`, [`INodeState`](../interfaces/INodeState.md)\>
+
+The context for the node.
+
+### envVars
+
+[`INodeVariables`](../interfaces/INodeVariables.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`, [`INodeState`](../interfaces/INodeState.md)\>
+
+The context for the node.
+
+### envVars
+
+[`INodeVariables`](../interfaces/INodeVariables.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/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
+
+[`INodeVariables`](../interfaces/INodeVariables.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/run.md

@@ -0,0 +1,59 @@
+# Function: run()
+
+> **run**(`options?`): `Promise`\<`void`\>
+
+Run the TWIN Node server.
+
+## Parameters
+
+### options?
+
+Optional options for the server.
+
+#### serverName?
+
+`string`
+
+Optional name of the server, defaults to "TWIN Node Server".
+
+#### serverVersion?
+
+`string`
+
+Optional version of the server, defaults to current version.
+
+#### envFilenames?
+
+`string`[]
+
+Additional environment variable filenames to load, defaults to .env.
+
+#### envPrefix?
+
+`string`
+
+Optional prefix for environment variables, defaults to "TWIN_NODE_".
+
+#### executionDirectory?
+
+`string`
+
+Optional directory to override the execution location, defaults to process directory.
+
+#### localesDirectory?
+
+`string`
+
+Optional directory to override the locales directory, defaults to the locales directory.
+
+#### openApiSpecFile?
+
+`string`
+
+Optional path to the OpenAPI spec file, defaults to docs/open-api/spec.json.
+
+## Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the server is started.

package/docs/reference/functions/start.md

@@ -0,0 +1,43 @@
+# Function: start()
+
+> **start**(`serverInfo`, `envVars`, `openApiSpecFile?`, `stateStorage?`, `extendConfig?`): `Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeState`](../interfaces/INodeState.md)\>; `server`: `EngineServer`; \}\>
+
+Start the engine server.
+
+## Parameters
+
+### serverInfo
+
+`IServerInfo`
+
+The server information.
+
+### envVars
+
+[`INodeVariables`](../interfaces/INodeVariables.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.
+
+## Returns
+
+`Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeState`](../interfaces/INodeState.md)\>; `server`: `EngineServer`; \}\>
+
+The engine server.

package/docs/reference/index.md

@@ -0,0 +1,30 @@
+# @twin.org/node-core
+
+## Interfaces
+
+- [INodeState](interfaces/INodeState.md)
+- [INodeVariables](interfaces/INodeVariables.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)
+- [run](functions/run.md)
+- [start](functions/start.md)
+- [initialiseLocales](functions/initialiseLocales.md)
+- [getExecutionDirectory](functions/getExecutionDirectory.md)
+- [fileExists](functions/fileExists.md)
+- [getFeatures](functions/getFeatures.md)

package/docs/reference/interfaces/INodeState.md

@@ -0,0 +1,15 @@
+# Interface: INodeState
+
+The state for the node.
+
+## Extends
+
+- `IEngineState`
+
+## Properties
+
+### addresses?
+
+> `optional` **addresses**: `string`[]
+
+List of addresses for the node.

package/docs/reference/interfaces/INodeVariables.md

@@ -0,0 +1,59 @@
+# Interface: INodeVariables
+
+The environment variables for the node.
+
+## Extends
+
+- `IEngineEnvironmentVariables`.`IEngineServerEnvironmentVariables`
+
+## Properties
+
+### features?
+
+> `optional` **features**: `string`
+
+The features that are enabled on the node.
+
+#### Default
+
+```ts
+[NodeFeatures.NodeIdentity]
+```
+
+***
+
+### identity?
+
+> `optional` **identity**: `string`
+
+The identity of the node which, if empty and node-identity feature is enabled it will be generated.
+
+***
+
+### mnemonic?
+
+> `optional` **mnemonic**: `string`
+
+The mnemonic for the identity, if empty and node-identity feature is enabled it will be randomly generated.
+
+***
+
+### username?
+
+> `optional` **username**: `string`
+
+If the node-user feature is enabled, this will be the name of the user.
+
+#### Default
+
+```ts
+admin@node
+```
+
+***
+
+### password?
+
+> `optional` **password**: `string`
+
+If the node-user feature is enabled, this will be the password of the user, if empty it will be randomly generated.

package/docs/reference/type-aliases/NodeFeatures.md

@@ -0,0 +1,5 @@
+# Type Alias: NodeFeatures
+
+> **NodeFeatures** = *typeof* [`NodeFeatures`](../variables/NodeFeatures.md)\[keyof *typeof* [`NodeFeatures`](../variables/NodeFeatures.md)\]
+
+The features that can be enabled on the node.

package/docs/reference/variables/NodeFeatures.md

@@ -0,0 +1,19 @@
+# Variable: NodeFeatures
+
+> `const` **NodeFeatures**: `object`
+
+The features that can be enabled on the node.
+
+## Type declaration
+
+### NodeIdentity
+
+> `readonly` **NodeIdentity**: `"node-identity"` = `"node-identity"`
+
+NodeIdentity - generates an identity for the node if not provided in config.
+
+### NodeUser
+
+> `readonly` **NodeUser**: `"node-user"` = `"node-user"`
+
+NodeUser - generates a user for the node if not provided in config.