@twin.org/node-core 0.0.2-next.2 → 0.0.2-next.20

package/docs/reference/interfaces/INodeOptions.md

@@ -85,6 +85,14 @@ The path to the OpenAPI spec file, defaults to docs/open-api/spec.json.
 
 ***
 
+### favIconFile?
+
+> `optional` **favIconFile**: `string`
+
+The path to the favicon, defaults to static/favicon.png.
+
+***
+
 ### extendEnvVars()?
 
 > `optional` **extendEnvVars**: (`envVars`) => `Promise`\<`void`\>
@@ -105,15 +113,19 @@ Method to extend the engine environment variables with any additional custom con
 
 ### extendConfig()?
 
-> `optional` **extendConfig**: (`config`) => `Promise`\<`void`\>
+> `optional` **extendConfig**: (`envVars`, `config`) => `Promise`\<`void`\>
 
 Method to extend the engine configuration with any additional custom configuration.
 
 #### Parameters
 
+##### envVars
+
+[`INodeEnvironmentVariables`](INodeEnvironmentVariables.md)
+
 ##### config
 
-`IEngineConfig`
+[`INodeEngineConfig`](INodeEngineConfig.md)
 
 #### Returns
 

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

@@ -0,0 +1,18 @@
+# Type Alias: NodeExtensionInitialiseEngineMethod()
+
+> **NodeExtensionInitialiseEngineMethod** = (`engineCore`) => `Promise`\<`void`\>
+
+The type for the initialise engine method of an extension module.
+This is called when the engine has been constructed but not yet started.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`
+
+The engine core instance.
+
+## Returns
+
+`Promise`\<`void`\>

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

@@ -0,0 +1,24 @@
+# Type Alias: NodeExtensionInitialiseEngineServerMethod()
+
+> **NodeExtensionInitialiseEngineServerMethod** = (`engineCore`, `engineServer`) => `Promise`\<`void`\>
+
+The type for the initialise engine server method of an extension module.
+This is called when the engine server has been constructed but not yet started.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`
+
+The engine core instance.
+
+### engineServer
+
+`IEngineServer`
+
+The engine server instance.
+
+## Returns
+
+`Promise`\<`void`\>

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

@@ -0,0 +1,23 @@
+# Type Alias: NodeExtensionInitialiseMethod()
+
+> **NodeExtensionInitialiseMethod** = (`envVars`, `nodeEngineConfig`) => `Promise`\<`void`\>
+
+The type for the initialise method of an extension module.
+
+## Parameters
+
+### envVars
+
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+
+The environment variables for the node.
+
+### nodeEngineConfig
+
+[`INodeEngineConfig`](../interfaces/INodeEngineConfig.md)
+
+The node engine config.
+
+## Returns
+
+`Promise`\<`void`\>

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

@@ -0,0 +1,10 @@
+# Type Alias: NodeExtensionShutdownMethod()
+
+> **NodeExtensionShutdownMethod** = () => `Promise`\<`void`\>
+
+The type for the shutdown method of an extension module.
+This is called when the engine is shutting down.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/variables/ATTESTATION_VERIFICATION_METHOD_ID.md

@@ -0,0 +1,3 @@
+# Variable: ATTESTATION\_VERIFICATION\_METHOD\_ID
+
+> `const` **ATTESTATION\_VERIFICATION\_METHOD\_ID**: `"attestation-assertion"` = `"attestation-assertion"`

package/docs/reference/variables/AUTH_SIGNING_KEY_ID.md

@@ -0,0 +1,3 @@
+# Variable: AUTH\_SIGNING\_KEY\_ID
+
+> `const` **AUTH\_SIGNING\_KEY\_ID**: `"auth-signing"` = `"auth-signing"`

package/docs/reference/variables/BLOB_STORAGE_ENCRYPTION_KEY_ID.md

@@ -0,0 +1,3 @@
+# Variable: BLOB\_STORAGE\_ENCRYPTION\_KEY\_ID
+
+> `const` **BLOB\_STORAGE\_ENCRYPTION\_KEY\_ID**: `"blob-encryption"` = `"blob-encryption"`

package/docs/reference/variables/IMMUTABLE_PROOF_VERIFICATION_METHOD_ID.md

@@ -0,0 +1,3 @@
+# Variable: IMMUTABLE\_PROOF\_VERIFICATION\_METHOD\_ID
+
+> `const` **IMMUTABLE\_PROOF\_VERIFICATION\_METHOD\_ID**: `"immutable-proof-assertion"` = `"immutable-proof-assertion"`

package/docs/reference/variables/NodeFeatures.md

@@ -4,7 +4,7 @@
 
 The features that can be enabled on the node.
 
-## Type declaration
+## Type Declaration
 
 ### NodeIdentity
 
@@ -17,3 +17,9 @@ NodeIdentity - generates an identity for the node if not provided in config.
 > `readonly` **NodeUser**: `"node-user"` = `"node-user"`
 
 NodeUser - generates a user for the node if not provided in config.
+
+### NodeWallet
+
+> `readonly` **NodeWallet**: `"node-wallet"` = `"node-wallet"`
+
+NodeWallet - generates a wallet for the node and funds it when there is a faucet available.

package/docs/reference/variables/SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID.md

@@ -0,0 +1,3 @@
+# Variable: SYNCHRONISED\_STORAGE\_BLOB\_STORAGE\_ENCRYPTION\_KEY\_ID
+
+> `const` **SYNCHRONISED\_STORAGE\_BLOB\_STORAGE\_ENCRYPTION\_KEY\_ID**: `"synchronised-storage-blob-encryption"` = `"synchronised-storage-blob-encryption"`

package/docs/reference/variables/VC_AUTHENTICATION_VERIFICATION_METHOD_ID.md

@@ -0,0 +1,3 @@
+# Variable: VC\_AUTHENTICATION\_VERIFICATION\_METHOD\_ID
+
+> `const` **VC\_AUTHENTICATION\_VERIFICATION\_METHOD\_ID**: `"node-authentication-assertion"` = `"node-authentication-assertion"`

package/locales/en.json

@@ -1,7 +1,8 @@
 {
 	"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"
+			"storageFileRootNotSet": "{storageFileRoot} is not set, the server will not start without it, please set it in the shell or create a .env file",
+			"extensionLoadingError": "Failed to load extension \"{extension}\""
 		}
 	},
 	"node": {
@@ -19,16 +20,24 @@
 		"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}\"",
+		"addingVerificationMethod": "Adding {title} verification method \"{methodId}\"",
+		"existingVerificationMethod": "Verification method for {title} already exists \"{methodId}\"",
+		"addingBlobEncryptionKey": "Adding blob encryption key \"{keyName}\"",
 		"creatingBlobEncryptionKey": "Creating blob encryption key \"{keyName}\"",
+		"createdBlobEncryptionKey": "Created blob encryption key \"{keyName}\" with value \"{keyValue}\"",
 		"existingBlobEncryptionKey": "Blob encryption key already exists \"{keyName}\"",
+		"addingSynchronisedStorageBlobEncryptionKey": "Adding synchronised storage blob encryption key \"{keyName}\"",
+		"existingSynchronisedStorageBlobEncryptionKey": "Synchronised storage 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}\""
+		"nodeAdminUserPassword": "Node Admin User Password \"{password}\"",
+		"extensionLoading": "Loading Extension",
+		"extensionInitialisingEngine": "Initialising engine for extension \"{extension}\"",
+		"extensionInitialisingEngineServer": "Initialising engine server for extension \"{extension}\"",
+		"extensionShutdown": "Shutdown extension \"{extension}\"",
+		"extendingEngine": "Extending Engine",
+		"extendingEngineServer": "Extending Engine Server"
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/node-core",
-	"version": "0.0.2-next.2",
+	"version": "0.0.2-next.20",
 	"description": "TWIN Node Core for serving APIs using the specified configuration",
 	"repository": {
 		"type": "git",
@@ -15,8 +15,10 @@
 	},
 	"dependencies": {
 		"@twin.org/api-auth-entity-storage-service": "next",
+		"@twin.org/cli-core": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
+		"@twin.org/data-space-connector-models": "next",
 		"@twin.org/engine": "next",
 		"@twin.org/engine-core": "next",
 		"@twin.org/engine-models": "next",
@@ -26,9 +28,12 @@
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/identity-models": "next",
+		"@twin.org/modules": "next",
+		"@twin.org/rights-management-rest-client": "next",
+		"@twin.org/standards-w3c-odrl": "next",
 		"@twin.org/vault-models": "next",
 		"@twin.org/wallet-models": "next",
-		"dotenv": "17.2.0",
+		"dotenv": "17.2.2",
 		"schema-dts": "1.1.5"
 	},
 	"main": "./dist/cjs/index.cjs",
@@ -48,5 +53,16 @@
 		"dist/types",
 		"locales",
 		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"node",
+		"core",
+		"foundation",
+		"utilities"
 	]
 }