@twin.org/node-core 0.0.2-next.16 → 0.0.2-next.17

package/docs/reference/interfaces/INodeEnvironmentVariables.md

@@ -81,6 +81,18 @@ A prefix for all the table in entity-storage, can be empty.
 
 ***
 
+### awsDynamodbAuthMode?
+
+> `optional` **awsDynamodbAuthMode**: `string`
+
+AWS DynamoDB auth mode, either credentials or pod.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbAuthMode`](IEngineServerEnvironmentVariables.md#awsdynamodbauthmode)
+
+***
+
 ### awsDynamodbAccessKeyId?
 
 > `optional` **awsDynamodbAccessKeyId**: `string`
@@ -575,15 +587,15 @@ A prefix for all the blobs in blob-storage, can be empty.
 
 ***
 
-### awsS3AccessKeyId?
+### awsS3Region?
 
-> `optional` **awsS3AccessKeyId**: `string`
+> `optional` **awsS3Region**: `string`
 
-AWS S3 access key id.
+AWS S3 region.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3AccessKeyId`](IEngineServerEnvironmentVariables.md#awss3accesskeyid)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3Region`](IEngineServerEnvironmentVariables.md#awss3region)
 
 ***
 
@@ -599,27 +611,27 @@ AWS S3 bucket name.
 
 ***
 
-### awsS3Endpoint?
+### awsS3AuthMode?
 
-> `optional` **awsS3Endpoint**: `string`
+> `optional` **awsS3AuthMode**: `string`
 
-AWS S3 endpoint.
+AWS S3 auth mode, either credentials or pod, defaults to credentials.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3Endpoint`](IEngineServerEnvironmentVariables.md#awss3endpoint)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3AuthMode`](IEngineServerEnvironmentVariables.md#awss3authmode)
 
 ***
 
-### awsS3Region?
+### awsS3AccessKeyId?
 
-> `optional` **awsS3Region**: `string`
+> `optional` **awsS3AccessKeyId**: `string`
 
-AWS S3 region.
+AWS S3 access key id.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3Region`](IEngineServerEnvironmentVariables.md#awss3region)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3AccessKeyId`](IEngineServerEnvironmentVariables.md#awss3accesskeyid)
 
 ***
 
@@ -635,6 +647,18 @@ AWS S3 secret access key.
 
 ***
 
+### awsS3Endpoint?
+
+> `optional` **awsS3Endpoint**: `string`
+
+AWS S3 endpoint.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3Endpoint`](IEngineServerEnvironmentVariables.md#awss3endpoint)
+
+***
+
 ### azureStorageAccountKey?
 
 > `optional` **azureStorageAccountKey**: `string`
@@ -840,39 +864,51 @@ Use the @json: prefix to specify the path to the JSON file.
 
 ***
 
-### awsSesSecretAccessKey?
+### awsSesRegion?
 
-> `optional` **awsSesSecretAccessKey**: `string`
+> `optional` **awsSesRegion**: `string`
 
-AWS SES secret access key.
+AWS SES region.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesSecretAccessKey`](IEngineServerEnvironmentVariables.md#awssessecretaccesskey)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesRegion`](IEngineServerEnvironmentVariables.md#awssesregion)
 
 ***
 
-### awsSesAccessKeyId?
+### awsSesAuthMode?
 
-> `optional` **awsSesAccessKeyId**: `string`
+> `optional` **awsSesAuthMode**: `string`
 
-AWS SES access key id.
+AWS SES auth mode, either credentials or pod, defaults to credentials.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesAccessKeyId`](IEngineServerEnvironmentVariables.md#awssesaccesskeyid)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesAuthMode`](IEngineServerEnvironmentVariables.md#awssesauthmode)
 
 ***
 
-### awsSesRegion?
+### awsSesSecretAccessKey?
 
-> `optional` **awsSesRegion**: `string`
+> `optional` **awsSesSecretAccessKey**: `string`
 
-AWS SES region.
+AWS SES secret access key.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesRegion`](IEngineServerEnvironmentVariables.md#awssesregion)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesSecretAccessKey`](IEngineServerEnvironmentVariables.md#awssessecretaccesskey)
+
+***
+
+### awsSesAccessKeyId?
+
+> `optional` **awsSesAccessKeyId**: `string`
+
+AWS SES access key id.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesAccessKeyId`](IEngineServerEnvironmentVariables.md#awssesaccesskeyid)
 
 ***
 
@@ -1265,7 +1301,7 @@ Url which points to the api for a trusted synchronised storage node, not require
 > `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
 
 The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
-This only required if using a custom verifiable storage item, otherwise it will default the the network name.
+This only required if using a custom verifiable storage item, otherwise it will default to the network name.
 
 #### Inherited from
 
@@ -1547,16 +1583,39 @@ Is the data space connector enabled, defaults to false.
 
 ***
 
-### dataSpaceConnectorApps?
+### dataSpaceConnectorRetainActivityLogsFor?
 
-> `optional` **dataSpaceConnectorApps**: `string`
+> `optional` **dataSpaceConnectorRetainActivityLogsFor**: `string`
 
-The application configuration for the data space connector.
-Use the @json: prefix to specify the path to the JSON configuration file.
+The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
+
+#### Default
+
+```ts
+10
+```
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataSpaceConnectorApps`](IEngineServerEnvironmentVariables.md#dataspaceconnectorapps)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataSpaceConnectorRetainActivityLogsFor`](IEngineServerEnvironmentVariables.md#dataspaceconnectorretainactivitylogsfor)
+
+***
+
+### dataSpaceConnectorActivityLogsCleanUpInterval?
+
+> `optional` **dataSpaceConnectorActivityLogsCleanUpInterval**: `string`
+
+The interval for cleaning up the activity logs.
+
+#### Default
+
+```ts
+60
+```
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataSpaceConnectorActivityLogsCleanUpInterval`](IEngineServerEnvironmentVariables.md#dataspaceconnectoractivitylogscleanupinterval)
 
 ***
 
@@ -1585,6 +1644,18 @@ Defaults to node-authentication-assertion.
 
 ***
 
+### extensions?
+
+> `optional` **extensions**: `string`
+
+A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`extensions`](IEngineServerEnvironmentVariables.md#extensions)
+
+***
+
 ### port?
 
 > `optional` **port**: `string`

package/docs/reference/interfaces/INodeOptions.md

@@ -113,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/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/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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/node-core",
-	"version": "0.0.2-next.16",
+	"version": "0.0.2-next.17",
 	"description": "TWIN Node Core for serving APIs using the specified configuration",
 	"repository": {
 		"type": "git",
@@ -52,5 +52,16 @@
 		"dist/types",
 		"locales",
 		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"node",
+		"core",
+		"foundation",
+		"utilities"
 	]
 }