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

package/docs/reference/interfaces/{IRunOptions.md → INodeOptions.md}

@@ -1,4 +1,4 @@
-# Interface: IRunOptions
+# Interface: INodeOptions
 
 The options when running the node.
 
@@ -42,6 +42,25 @@ The prefix for environment variables, defaults to "TWIN_NODE_".
 
 ***
 
+### configFilenames?
+
+> `optional` **configFilenames**: `string`[]
+
+A list of JSON files to load as configuration files.
+The files will be loaded in the order they are provided, and the last one will
+override any previous values.
+
+***
+
+### config?
+
+> `optional` **config**: `IEngineConfig`
+
+Provides the ability to have some initial custom configuration for the engine.
+This will be merged with any configuration loaded from the environment variables.
+
+***
+
 ### executionDirectory?
 
 > `optional` **executionDirectory**: `string`
@@ -66,6 +85,24 @@ The path to the OpenAPI spec file, defaults to docs/open-api/spec.json.
 
 ***
 
+### extendEnvVars()?
+
+> `optional` **extendEnvVars**: (`envVars`) => `Promise`\<`void`\>
+
+Method to extend the engine environment variables with any additional custom configuration.
+
+#### Parameters
+
+##### envVars
+
+[`INodeEnvironmentVariables`](INodeEnvironmentVariables.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
 ### extendConfig()?
 
 > `optional` **extendConfig**: (`config`) => `Promise`\<`void`\>

package/locales/en.json

@@ -1,7 +1,6 @@
 {
 	"error": {
 		"node": {
-			"noEnvVars": "There are no environment variables starting \"{prefix}\" the server will not start without them, please set them in the shell or create a .env file",
 			"storageFileRootNotSet": "{storageFileRoot} is not set, the server will not start without it, please set it in the shell or create a .env file"
 		}
 	},
@@ -13,20 +12,21 @@
 		"fundingWallet": "Funding wallet \"{address}\"",
 		"fundedWallet": "Wallet already funded",
 		"generatingNodeIdentity": "Generating node identity",
-		"existingNodeIdentity": "Node identity already exists",
+		"existingNodeIdentity": "Node identity already exists \"{identity}\"",
+		"createdNodeIdentity": "Node identity created \"{identity}\"",
 		"identityExplorer": "Identity explorer \"{url}\"",
-		"creatingNodeUser": "Creating node user",
-		"existingNodeUser": "Node user already exists",
-		"creatingAuthKey": "Creating authentication key",
-		"existingAuthKey": "Authentication key already exists",
-		"addingAttestation": "Adding attestation verification method",
-		"existingAttestation": "Attestation verification method already exists",
-		"addingImmutableProof": "Adding immutable proof verification method",
-		"existingImmutableProof": "Immutable proof verification method already exists",
-		"creatingBlobEncryptionKey": "Creating blob encryption key",
-		"existingBlobEncryptionKey": "Blob encryption key already exists",
-		"creatingUserProfile": "Creating user profile",
-		"existingUserProfile": "User profile already exists",
+		"creatingNodeUser": "Creating node user \"{email}\"",
+		"existingNodeUser": "Node user already exists \"{email}\"",
+		"creatingAuthKey": "Creating authentication key \"{keyName}\"",
+		"existingAuthKey": "Authentication key already exists \"{keyName}\"",
+		"addingAttestation": "Adding attestation verification method \"{methodId}\"",
+		"existingAttestation": "Attestation verification method already exists \"{methodId}\"",
+		"addingImmutableProof": "Adding immutable proof verification method \"{methodId}\"",
+		"existingImmutableProof": "Immutable proof verification method already exists \"{methodId}\"",
+		"creatingBlobEncryptionKey": "Creating blob encryption key \"{keyName}\"",
+		"existingBlobEncryptionKey": "Blob encryption key already exists \"{keyName}\"",
+		"creatingUserProfile": "Creating user profile \"{identity}\"",
+		"existingUserProfile": "User profile already exists \"{identity}\"",
 		"nodeIdentity": "Node identity \"{identity}\"",
 		"nodeAdminUserEmail": "Node Admin User Email \"{email}\"",
 		"nodeAdminUserPassword": "Node Admin User Password \"{password}\""

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/node-core",
-	"version": "0.0.1-next.8",
+	"version": "0.0.1",
 	"description": "TWIN Node Core for serving APIs using the specified configuration",
 	"repository": {
 		"type": "git",
@@ -14,20 +14,20 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-auth-entity-storage-service": "next",
-		"@twin.org/core": "next",
-		"@twin.org/crypto": "next",
-		"@twin.org/engine": "next",
-		"@twin.org/engine-core": "next",
-		"@twin.org/engine-models": "next",
-		"@twin.org/engine-server": "next",
-		"@twin.org/engine-server-types": "next",
-		"@twin.org/engine-types": "next",
-		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "next",
-		"@twin.org/identity-models": "next",
-		"@twin.org/vault-models": "next",
-		"@twin.org/wallet-models": "next",
+		"@twin.org/api-auth-entity-storage-service": "^0.0.2-next.1",
+		"@twin.org/core": "^0.0.1",
+		"@twin.org/crypto": "^0.0.1",
+		"@twin.org/engine": "^0.0.2-next.1",
+		"@twin.org/engine-core": "^0.0.2-next.1",
+		"@twin.org/engine-models": "^0.0.2-next.1",
+		"@twin.org/engine-server": "^0.0.2-next.1",
+		"@twin.org/engine-server-types": "^0.0.2-next.1",
+		"@twin.org/engine-types": "^0.0.2-next.1",
+		"@twin.org/entity": "^0.0.1",
+		"@twin.org/entity-storage-models": "^0.0.1",
+		"@twin.org/identity-models": "^0.0.1",
+		"@twin.org/vault-models": "^0.0.1",
+		"@twin.org/wallet-models": "^0.0.1",
 		"dotenv": "16.5.0",
 		"schema-dts": "1.1.5"
 	},

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

@@ -1,10 +0,0 @@
-import type { IEngineState } from "@twin.org/engine-models";
-/**
- * The state for the node.
- */
-export interface INodeState extends IEngineState {
-    /**
-     * List of addresses for the node.
-     */
-    addresses?: string[];
-}

package/docs/reference/interfaces/INodeState.md

@@ -1,15 +0,0 @@
-# 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

@@ -1,59 +0,0 @@
-# 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.