@twin.org/node-core 0.0.2-next.9 → 0.0.3-next.1

package/docs/reference/interfaces/INodeOptions.md

@@ -26,6 +26,18 @@ The version of the server, defaults to the current version.
 
 ***
 
+### envVars?
+
+> `optional` **envVars**: `object`
+
+Additional environment variables to set.
+
+#### Index Signature
+
+\[`key`: `string`\]: `string`
+
+***
+
 ### envFilenames?
 
 > `optional` **envFilenames**: `string`[]
@@ -38,7 +50,7 @@ Additional environment variable filenames to load, defaults to .env.
 
 > `optional` **envPrefix**: `string`
 
-The prefix for environment variables, defaults to "TWIN_NODE_".
+The prefix for environment variables, defaults to "TWIN_".
 
 ***
 
@@ -113,15 +125,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
 
@@ -171,3 +187,11 @@ Method to extend the engine server with any additional options.
 
 The state storage to use for the engine.
 If not provided, a default file-based state storage will be used.
+
+***
+
+### disableProcessExitOnFailure?
+
+> `optional` **disableProcessExitOnFailure**: `boolean`
+
+Disables process.exit calls on fatal errors and throws instead.

package/docs/reference/interfaces/IProtocolHandlerResult.md

@@ -0,0 +1,19 @@
+# Interface: IProtocolHandlerResult
+
+The result from a protocol handler.
+
+## Properties
+
+### resolvedPath
+
+> **resolvedPath**: `string`
+
+The resolved path to the module file.
+
+***
+
+### cached
+
+> **cached**: `boolean`
+
+Whether the module was cached.

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

@@ -0,0 +1,5 @@
+# Type Alias: ModuleProtocol
+
+> **ModuleProtocol** = *typeof* [`ModuleProtocol`](../variables/ModuleProtocol.md)\[keyof *typeof* [`ModuleProtocol`](../variables/ModuleProtocol.md)\]
+
+The protocol type for a module.

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

@@ -0,0 +1,37 @@
+# Variable: ModuleProtocol
+
+> `const` **ModuleProtocol**: `object`
+
+The protocol types for modules.
+
+## Type Declaration
+
+### Local
+
+> `readonly` **Local**: `"local"` = `"local"`
+
+Local module (starts with . or / or file://).
+
+### Npm
+
+> `readonly` **Npm**: `"npm"` = `"npm"`
+
+NPM package (starts with npm:).
+
+### Https
+
+> `readonly` **Https**: `"https"` = `"https"`
+
+HTTPS URL (starts with https://).
+
+### Http
+
+> `readonly` **Http**: `"http"` = `"http"`
+
+HTTP URL (starts with http://).
+
+### Default
+
+> `readonly` **Default**: `"default"` = `"default"`
+
+Default/standard module resolution.

package/docs/reference/variables/NodeFeatures.md

@@ -6,20 +6,20 @@ The features that can be enabled on the node.
 
 ## Type Declaration
 
-### NodeIdentity
+### NodeId
 
-> `readonly` **NodeIdentity**: `"node-identity"` = `"node-identity"`
+> `readonly` **NodeId**: `"node-identity"` = `"node-identity"`
 
-NodeIdentity - generates an identity for the node if not provided in config.
+NodeId - generates an identity for the node if not provided in config.
 
-### NodeUser
+### NodeAdminUser
 
-> `readonly` **NodeUser**: `"node-user"` = `"node-user"`
+> `readonly` **NodeAdminUser**: `"node-admin-user"` = `"node-admin-user"`
 
-NodeUser - generates a user for the node if not provided in config.
+NodeAdminUser - generates an admin 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.
+NodeWallet - generates wallets for any identities that need them.

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,22 +1,27 @@
 {
 	"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}\"",
+			"insecureProtocol": "Cannot load extension from insecure protocol: {protocol}. Only HTTPS is allowed for remote extensions.",
+			"extensionDownloadFailed": "Failed to download extension from {url}",
+			"extensionNpmInstallFailed": "Failed to install npm extension: {package}",
+			"extensionSizeLimitExceeded": "Extension download size exceeds limit: {size} bytes > {limit} bytes"
 		}
 	},
 	"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}\"",
+		"processingIdentity": "Processing identity of type \"{identityType}\"",
+		"generatingIdentity": "Generating identity of type \"{identityType}\"",
+		"existingIdentity": "Identity already exists \"{identity}\"",
+		"createdIdentity": "Identity created \"{identity}\"",
 		"identityExplorer": "Identity explorer \"{url}\"",
-		"creatingNodeUser": "Creating node user \"{email}\"",
-		"existingNodeUser": "Node user already exists \"{email}\"",
+		"creatingUser": "Creating user \"{email}\"",
+		"existingUser": "User already exists \"{email}\"",
 		"creatingAuthKey": "Creating authentication key \"{keyName}\"",
 		"existingAuthKey": "Authentication key already exists \"{keyName}\"",
 		"addingVerificationMethod": "Adding {title} verification method \"{methodId}\"",
@@ -29,8 +34,21 @@
 		"existingSynchronisedStorageBlobEncryptionKey": "Synchronised storage blob encryption key already exists \"{keyName}\"",
 		"creatingUserProfile": "Creating user profile \"{identity}\"",
 		"existingUserProfile": "User profile already exists \"{identity}\"",
-		"nodeIdentity": "Node identity \"{identity}\"",
+		"nodeId": "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",
+		"extensionSecurityWarning": "SECURITY WARNING: Loading extension from external URL: {url}",
+		"extensionNpmInstalling": "Installing npm extension",
+		"extensionHttpsDownloading": "Downloading HTTPS extension",
+		"extensionCacheExpired": "Cache expired for extension: {url}",
+		"extensionForceRefresh": "Force refresh enabled for extension: {url}",
+		"createdTenantId": "Created tenant id \"{identity}\" with api key \"{apiKey}\"",
+		"existingTenantId": "Existing tenant id \"{identity}\""
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/node-core",
-	"version": "0.0.2-next.9",
+	"version": "0.0.3-next.1",
 	"description": "TWIN Node Core for serving APIs using the specified configuration",
 	"repository": {
 		"type": "git",
@@ -15,6 +15,9 @@
 	},
 	"dependencies": {
 		"@twin.org/api-auth-entity-storage-service": "next",
+		"@twin.org/api-tenant-processor": "next",
+		"@twin.org/cli-core": "next",
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/data-space-connector-models": "next",
@@ -28,27 +31,42 @@
 		"@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.1",
+		"dotenv": "17.2.3",
 		"schema-dts": "1.1.5"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"node",
+		"core",
+		"foundation",
+		"utilities"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/node/issues"
+	},
+	"homepage": "https://twindev.org"
 }