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

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

@@ -0,0 +1,5 @@
+# Type Alias: CliCommandParamType
+
+> **CliCommandParamType** = `string` \| `number` \| `boolean`
+
+Type for the properties in commands.

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

@@ -0,0 +1,3 @@
+# Variable: CONTEXT\_ID\_HANDLER\_FEATURE\_DID
+
+> `const` **CONTEXT\_ID\_HANDLER\_FEATURE\_DID**: `"did"` = `"did"`

package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_TENANT.md

@@ -0,0 +1,3 @@
+# Variable: CONTEXT\_ID\_HANDLER\_FEATURE\_TENANT
+
+> `const` **CONTEXT\_ID\_HANDLER\_FEATURE\_TENANT**: `"tenant"` = `"tenant"`

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/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**: `"vc-authentication-assertion"` = `"vc-authentication-assertion"`