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

package/docs/reference/interfaces/INodeOptions.md

@@ -0,0 +1,165 @@
+# Interface: INodeOptions
+
+The options when running the node.
+
+## Properties
+
+### serverName?
+
+> `optional` **serverName**: `string`
+
+The name of the server, defaults to "TWIN Node Server".
+
+#### Default
+
+```ts
+"TWIN Node Server"
+```
+
+***
+
+### serverVersion?
+
+> `optional` **serverVersion**: `string`
+
+The version of the server, defaults to the current version.
+
+***
+
+### envFilenames?
+
+> `optional` **envFilenames**: `string`[]
+
+Additional environment variable filenames to load, defaults to .env.
+
+***
+
+### envPrefix?
+
+> `optional` **envPrefix**: `string`
+
+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`
+
+The directory to override the execution location, defaults to process directory.
+
+***
+
+### localesDirectory?
+
+> `optional` **localesDirectory**: `string`
+
+The directory to override the locales directory, defaults to the locales directory.
+
+***
+
+### openApiSpecFile?
+
+> `optional` **openApiSpecFile**: `string`
+
+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`\>
+
+Method to extend the engine configuration with any additional custom configuration.
+
+#### Parameters
+
+##### config
+
+`IEngineConfig`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### extendEngine()?
+
+> `optional` **extendEngine**: (`engine`) => `Promise`\<`void`\>
+
+Method to extend the engine with any additional options.
+
+#### Parameters
+
+##### engine
+
+`IEngineCore`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### extendEngineServer()?
+
+> `optional` **extendEngineServer**: (`engineServer`) => `Promise`\<`void`\>
+
+Method to extend the engine server with any additional options.
+
+#### Parameters
+
+##### engineServer
+
+`IEngineServer`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### stateStorage?
+
+> `optional` **stateStorage**: `IEngineStateStorage`\<`IEngineState`\>
+
+The state storage to use for the engine.
+If not provided, a default file-based state storage will be used.

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.

package/locales/en.json

@@ -0,0 +1,34 @@
+{
+	"error": {
+		"node": {
+			"storageFileRootNotSet": "{storageFileRoot} is not set, the server will not start without it, please set it in the shell or create a .env file"
+		}
+	},
+	"node": {
+		"terminateSignal": "Server terminating",
+		"generatingMnemonic": "Generating mnemonic \"{mnemonic}\"",
+		"storingMnemonic": "Storing mnemonic",
+		"existingMnemonic": "Mnemonic already exists",
+		"fundingWallet": "Funding wallet \"{address}\"",
+		"fundedWallet": "Wallet already funded",
+		"generatingNodeIdentity": "Generating node identity",
+		"existingNodeIdentity": "Node identity already exists \"{identity}\"",
+		"createdNodeIdentity": "Node identity created \"{identity}\"",
+		"identityExplorer": "Identity explorer \"{url}\"",
+		"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

@@ -0,0 +1,52 @@
+{
+	"name": "@twin.org/node-core",
+	"version": "0.0.1-next.10",
+	"description": "TWIN Node Core for serving APIs using the specified configuration",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/node.git",
+		"directory": "packages/node-core"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"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",
+		"dotenv": "16.5.0",
+		"schema-dts": "1.1.5"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}