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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/dist/cjs/index.cjs +182 -53
  2. package/dist/esm/index.mjs +173 -54
  3. package/dist/types/builders/engineServerEnvBuilder.d.ts +1 -1
  4. package/dist/types/builders/extensionsBuilder.d.ts +31 -0
  5. package/dist/types/defaults.d.ts +6 -0
  6. package/dist/types/index.d.ts +4 -0
  7. package/dist/types/models/IEngineEnvironmentVariables.d.ts +35 -14
  8. package/dist/types/models/INodeEngineConfig.d.ts +6 -0
  9. package/dist/types/models/INodeOptions.d.ts +2 -1
  10. package/dist/types/models/nodeExtensionMethods.d.ts +22 -0
  11. package/dist/types/node.d.ts +2 -2
  12. package/dist/types/server.d.ts +4 -2
  13. package/docs/changelog.md +8 -0
  14. package/docs/reference/functions/buildConfiguration.md +2 -2
  15. package/docs/reference/functions/buildEngineServerConfiguration.md +1 -1
  16. package/docs/reference/functions/extensionsConfiguration.md +25 -0
  17. package/docs/reference/functions/extensionsInitialiseEngine.md +25 -0
  18. package/docs/reference/functions/extensionsInitialiseEngineServer.md +31 -0
  19. package/docs/reference/functions/shutdownExtensions.md +19 -0
  20. package/docs/reference/functions/start.md +4 -4
  21. package/docs/reference/index.md +14 -0
  22. package/docs/reference/interfaces/IEngineEnvironmentVariables.md +73 -22
  23. package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +101 -30
  24. package/docs/reference/interfaces/INodeEngineConfig.md +7 -0
  25. package/docs/reference/interfaces/INodeEnvironmentVariables.md +101 -30
  26. package/docs/reference/interfaces/INodeOptions.md +6 -2
  27. package/docs/reference/type-aliases/NodeExtensionInitialiseEngineMethod.md +18 -0
  28. package/docs/reference/type-aliases/NodeExtensionInitialiseEngineServerMethod.md +24 -0
  29. package/docs/reference/type-aliases/NodeExtensionInitialiseMethod.md +23 -0
  30. package/docs/reference/variables/ATTESTATION_VERIFICATION_METHOD_ID.md +3 -0
  31. package/docs/reference/variables/AUTH_SIGNING_KEY_ID.md +3 -0
  32. package/docs/reference/variables/BLOB_STORAGE_ENCRYPTION_KEY_ID.md +3 -0
  33. package/docs/reference/variables/IMMUTABLE_PROOF_VERIFICATION_METHOD_ID.md +3 -0
  34. package/docs/reference/variables/SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID.md +3 -0
  35. package/docs/reference/variables/VC_AUTHENTICATION_VERIFICATION_METHOD_ID.md +3 -0
  36. package/package.json +12 -1
@@ -0,0 +1,22 @@
1
+ import type { IEngineCore, IEngineServer } from "@twin.org/engine-models";
2
+ import type { INodeEngineConfig } from "./INodeEngineConfig";
3
+ import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables";
4
+ /**
5
+ * The type for the initialise method of an extension module.
6
+ * @param envVars The environment variables for the node.
7
+ * @param nodeEngineConfig The node engine config.
8
+ */
9
+ export type NodeExtensionInitialiseMethod = (envVars: INodeEnvironmentVariables, nodeEngineConfig: INodeEngineConfig) => Promise<void>;
10
+ /**
11
+ * The type for the initialise engine method of an extension module.
12
+ * This is called when the engine has been constructed but not yet started.
13
+ * @param engineCore The engine core instance.
14
+ */
15
+ export type NodeExtensionInitialiseEngineMethod = (engineCore: IEngineCore) => Promise<void>;
16
+ /**
17
+ * The type for the initialise engine server method of an extension module.
18
+ * This is called when the engine server has been constructed but not yet started.
19
+ * @param engineCore The engine core instance.
20
+ * @param engineServer The engine server instance.
21
+ */
22
+ export type NodeExtensionInitialiseEngineServerMethod = (engineCore: IEngineCore, engineServer: IEngineServer) => Promise<void>;
@@ -1,5 +1,5 @@
1
1
  import type { IServerInfo } from "@twin.org/api-models";
2
- import type { IEngineServerConfig } from "@twin.org/engine-server-types";
2
+ import type { INodeEngineConfig } from "./models/INodeEngineConfig";
3
3
  import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables";
4
4
  import type { INodeOptions } from "./models/INodeOptions";
5
5
  /**
@@ -22,7 +22,7 @@ export declare function buildConfiguration(processEnv: {
22
22
  nodeEnvVars: INodeEnvironmentVariables & {
23
23
  [id: string]: string | unknown;
24
24
  };
25
- engineServerConfig: IEngineServerConfig;
25
+ nodeEngineConfig: INodeEngineConfig;
26
26
  }>;
27
27
  /**
28
28
  * Override module imports to use local files where possible.
@@ -2,16 +2,18 @@ import { Engine } from "@twin.org/engine";
2
2
  import { type IEngineState } from "@twin.org/engine-models";
3
3
  import { EngineServer } from "@twin.org/engine-server";
4
4
  import type { IEngineServerConfig } from "@twin.org/engine-server-types";
5
+ import type { INodeEngineConfig } from "./models/INodeEngineConfig";
5
6
  import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables";
6
7
  import type { INodeOptions } from "./models/INodeOptions";
7
8
  /**
8
9
  * Start the engine server.
9
10
  * @param nodeOptions Optional run options for the engine server.
10
- * @param engineServerConfig The configuration for the engine server.
11
+ * @param nodeEngineConfig The configuration for the engine server.
11
12
  * @param envVars The environment variables.
12
13
  * @returns The engine server.
13
14
  */
14
- export declare function start(nodeOptions: INodeOptions | undefined, engineServerConfig: IEngineServerConfig, envVars: INodeEnvironmentVariables): Promise<{
15
+ export declare function start(nodeOptions: INodeOptions | undefined, nodeEngineConfig: INodeEngineConfig, envVars: INodeEnvironmentVariables): Promise<{
15
16
  engine: Engine<IEngineServerConfig, IEngineState>;
16
17
  server: EngineServer;
18
+ shutdown: () => Promise<void>;
17
19
  } | undefined>;
package/docs/changelog.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # @twin.org/node-core - Changelog
2
2
 
3
+ ## [0.0.2-next.17](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.16...node-core-v0.0.2-next.17) (2025-10-02)
4
+
5
+
6
+ ### Features
7
+
8
+ * add extensions support ([476d5a8](https://github.com/twinfoundation/node/commit/476d5a864026a2f78e5b02bc9eb81359777a4a45))
9
+ * updating linting ([feacd17](https://github.com/twinfoundation/node/commit/feacd178bb025bcd29a0ae6e4b8e79f23a989169))
10
+
3
11
  ## [0.0.2-next.16](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.15...node-core-v0.0.2-next.16) (2025-09-29)
4
12
 
5
13
 
@@ -1,6 +1,6 @@
1
1
  # Function: buildConfiguration()
2
2
 
3
- > **buildConfiguration**(`processEnv`, `options`, `serverInfo`): `Promise`\<\{ `nodeEnvVars`: [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & `object`; `engineServerConfig`: `IEngineServerConfig`; \}\>
3
+ > **buildConfiguration**(`processEnv`, `options`, `serverInfo`): `Promise`\<\{ `nodeEnvVars`: [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & `object`; `nodeEngineConfig`: [`INodeEngineConfig`](../interfaces/INodeEngineConfig.md); \}\>
4
4
 
5
5
  Build the configuration for the TWIN Node server.
6
6
 
@@ -24,7 +24,7 @@ The server information.
24
24
 
25
25
  ## Returns
26
26
 
27
- `Promise`\<\{ `nodeEnvVars`: [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & `object`; `engineServerConfig`: `IEngineServerConfig`; \}\>
27
+ `Promise`\<\{ `nodeEnvVars`: [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & `object`; `nodeEngineConfig`: [`INodeEngineConfig`](../interfaces/INodeEngineConfig.md); \}\>
28
28
 
29
29
  A promise that resolves to the engine server configuration, environment prefix, environment variables,
30
30
  and options.
@@ -40,4 +40,4 @@ The path to the favicon.
40
40
 
41
41
  `Promise`\<`IEngineServerConfig`\>
42
42
 
43
- The the config for the core and the server.
43
+ The config for the core and the server.
@@ -0,0 +1,25 @@
1
+ # Function: extensionsConfiguration()
2
+
3
+ > **extensionsConfiguration**(`envVars`, `nodeEngineConfig`): `Promise`\<[`INodeEngineConfig`](../interfaces/INodeEngineConfig.md)\>
4
+
5
+ Handles the configuration of the extensions.
6
+
7
+ ## Parameters
8
+
9
+ ### envVars
10
+
11
+ [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
12
+
13
+ The environment variables for the node.
14
+
15
+ ### nodeEngineConfig
16
+
17
+ [`INodeEngineConfig`](../interfaces/INodeEngineConfig.md)
18
+
19
+ The node engine config.
20
+
21
+ ## Returns
22
+
23
+ `Promise`\<[`INodeEngineConfig`](../interfaces/INodeEngineConfig.md)\>
24
+
25
+ The config for the core and the server.
@@ -0,0 +1,25 @@
1
+ # Function: extensionsInitialiseEngine()
2
+
3
+ > **extensionsInitialiseEngine**(`envVars`, `engineCore`): `Promise`\<`void`\>
4
+
5
+ Handles the initialisation of the extensions when the engine has been constructed.
6
+
7
+ ## Parameters
8
+
9
+ ### envVars
10
+
11
+ [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
12
+
13
+ The environment variables for the node.
14
+
15
+ ### engineCore
16
+
17
+ `IEngineCore`
18
+
19
+ The engine core instance.
20
+
21
+ ## Returns
22
+
23
+ `Promise`\<`void`\>
24
+
25
+ Nothing.
@@ -0,0 +1,31 @@
1
+ # Function: extensionsInitialiseEngineServer()
2
+
3
+ > **extensionsInitialiseEngineServer**(`envVars`, `engineCore`, `engineServer`): `Promise`\<`void`\>
4
+
5
+ Handles the initialisation of the extensions when the engine server has been constructed.
6
+
7
+ ## Parameters
8
+
9
+ ### envVars
10
+
11
+ [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
12
+
13
+ The environment variables for the node.
14
+
15
+ ### engineCore
16
+
17
+ `IEngineCore`
18
+
19
+ The engine core instance.
20
+
21
+ ### engineServer
22
+
23
+ `IEngineServer`
24
+
25
+ The engine server instance.
26
+
27
+ ## Returns
28
+
29
+ `Promise`\<`void`\>
30
+
31
+ Nothing.
@@ -0,0 +1,19 @@
1
+ # Function: shutdownExtensions()
2
+
3
+ > **shutdownExtensions**(`envVars`): `Promise`\<`void`\>
4
+
5
+ Handles the shutdown of the extensions.
6
+
7
+ ## Parameters
8
+
9
+ ### envVars
10
+
11
+ [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
12
+
13
+ The environment variables for the node.
14
+
15
+ ## Returns
16
+
17
+ `Promise`\<`void`\>
18
+
19
+ Nothing.
@@ -1,6 +1,6 @@
1
1
  # Function: start()
2
2
 
3
- > **start**(`nodeOptions`, `engineServerConfig`, `envVars`): `Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, `IEngineState`\>; `server`: `EngineServer`; \}\>
3
+ > **start**(`nodeOptions`, `nodeEngineConfig`, `envVars`): `Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, `IEngineState`\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \}\>
4
4
 
5
5
  Start the engine server.
6
6
 
@@ -12,9 +12,9 @@ Optional run options for the engine server.
12
12
 
13
13
  `undefined` | [`INodeOptions`](../interfaces/INodeOptions.md)
14
14
 
15
- ### engineServerConfig
15
+ ### nodeEngineConfig
16
16
 
17
- `IEngineServerConfig`
17
+ [`INodeEngineConfig`](../interfaces/INodeEngineConfig.md)
18
18
 
19
19
  The configuration for the engine server.
20
20
 
@@ -26,6 +26,6 @@ The environment variables.
26
26
 
27
27
  ## Returns
28
28
 
29
- `Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, `IEngineState`\>; `server`: `EngineServer`; \}\>
29
+ `Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, `IEngineState`\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \}\>
30
30
 
31
31
  The engine server.
@@ -4,15 +4,25 @@
4
4
 
5
5
  - [IEngineEnvironmentVariables](interfaces/IEngineEnvironmentVariables.md)
6
6
  - [IEngineServerEnvironmentVariables](interfaces/IEngineServerEnvironmentVariables.md)
7
+ - [INodeEngineConfig](interfaces/INodeEngineConfig.md)
7
8
  - [INodeEnvironmentVariables](interfaces/INodeEnvironmentVariables.md)
8
9
  - [INodeOptions](interfaces/INodeOptions.md)
9
10
 
10
11
  ## Type Aliases
11
12
 
13
+ - [NodeExtensionInitialiseMethod](type-aliases/NodeExtensionInitialiseMethod.md)
14
+ - [NodeExtensionInitialiseEngineMethod](type-aliases/NodeExtensionInitialiseEngineMethod.md)
15
+ - [NodeExtensionInitialiseEngineServerMethod](type-aliases/NodeExtensionInitialiseEngineServerMethod.md)
12
16
  - [NodeFeatures](type-aliases/NodeFeatures.md)
13
17
 
14
18
  ## Variables
15
19
 
20
+ - [ATTESTATION\_VERIFICATION\_METHOD\_ID](variables/ATTESTATION_VERIFICATION_METHOD_ID.md)
21
+ - [IMMUTABLE\_PROOF\_VERIFICATION\_METHOD\_ID](variables/IMMUTABLE_PROOF_VERIFICATION_METHOD_ID.md)
22
+ - [BLOB\_STORAGE\_ENCRYPTION\_KEY\_ID](variables/BLOB_STORAGE_ENCRYPTION_KEY_ID.md)
23
+ - [SYNCHRONISED\_STORAGE\_BLOB\_STORAGE\_ENCRYPTION\_KEY\_ID](variables/SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID.md)
24
+ - [VC\_AUTHENTICATION\_VERIFICATION\_METHOD\_ID](variables/VC_AUTHENTICATION_VERIFICATION_METHOD_ID.md)
25
+ - [AUTH\_SIGNING\_KEY\_ID](variables/AUTH_SIGNING_KEY_ID.md)
16
26
  - [NodeFeatures](variables/NodeFeatures.md)
17
27
 
18
28
  ## Functions
@@ -26,6 +36,10 @@
26
36
  - [bootstrapSynchronisedStorage](functions/bootstrapSynchronisedStorage.md)
27
37
  - [buildEngineConfiguration](functions/buildEngineConfiguration.md)
28
38
  - [buildEngineServerConfiguration](functions/buildEngineServerConfiguration.md)
39
+ - [extensionsConfiguration](functions/extensionsConfiguration.md)
40
+ - [extensionsInitialiseEngine](functions/extensionsInitialiseEngine.md)
41
+ - [extensionsInitialiseEngineServer](functions/extensionsInitialiseEngineServer.md)
42
+ - [shutdownExtensions](functions/shutdownExtensions.md)
29
43
  - [run](functions/run.md)
30
44
  - [buildConfiguration](functions/buildConfiguration.md)
31
45
  - [overrideModuleImport](functions/overrideModuleImport.md)
@@ -57,6 +57,14 @@ A prefix for all the table in entity-storage, can be empty.
57
57
 
58
58
  ***
59
59
 
60
+ ### awsDynamodbAuthMode?
61
+
62
+ > `optional` **awsDynamodbAuthMode**: `string`
63
+
64
+ AWS DynamoDB auth mode, either credentials or pod.
65
+
66
+ ***
67
+
60
68
  ### awsDynamodbAccessKeyId?
61
69
 
62
70
  > `optional` **awsDynamodbAccessKeyId**: `string`
@@ -387,11 +395,11 @@ A prefix for all the blobs in blob-storage, can be empty.
387
395
 
388
396
  ***
389
397
 
390
- ### awsS3AccessKeyId?
398
+ ### awsS3Region?
391
399
 
392
- > `optional` **awsS3AccessKeyId**: `string`
400
+ > `optional` **awsS3Region**: `string`
393
401
 
394
- AWS S3 access key id.
402
+ AWS S3 region.
395
403
 
396
404
  ***
397
405
 
@@ -403,19 +411,19 @@ AWS S3 bucket name.
403
411
 
404
412
  ***
405
413
 
406
- ### awsS3Endpoint?
414
+ ### awsS3AuthMode?
407
415
 
408
- > `optional` **awsS3Endpoint**: `string`
416
+ > `optional` **awsS3AuthMode**: `string`
409
417
 
410
- AWS S3 endpoint.
418
+ AWS S3 auth mode, either credentials or pod, defaults to credentials.
411
419
 
412
420
  ***
413
421
 
414
- ### awsS3Region?
422
+ ### awsS3AccessKeyId?
415
423
 
416
- > `optional` **awsS3Region**: `string`
424
+ > `optional` **awsS3AccessKeyId**: `string`
417
425
 
418
- AWS S3 region.
426
+ AWS S3 access key id.
419
427
 
420
428
  ***
421
429
 
@@ -427,6 +435,14 @@ AWS S3 secret access key.
427
435
 
428
436
  ***
429
437
 
438
+ ### awsS3Endpoint?
439
+
440
+ > `optional` **awsS3Endpoint**: `string`
441
+
442
+ AWS S3 endpoint.
443
+
444
+ ***
445
+
430
446
  ### azureStorageAccountKey?
431
447
 
432
448
  > `optional` **azureStorageAccountKey**: `string`
@@ -564,6 +580,22 @@ Use the @json: prefix to specify the path to the JSON file.
564
580
 
565
581
  ***
566
582
 
583
+ ### awsSesRegion?
584
+
585
+ > `optional` **awsSesRegion**: `string`
586
+
587
+ AWS SES region.
588
+
589
+ ***
590
+
591
+ ### awsSesAuthMode?
592
+
593
+ > `optional` **awsSesAuthMode**: `string`
594
+
595
+ AWS SES auth mode, either credentials or pod, defaults to credentials.
596
+
597
+ ***
598
+
567
599
  ### awsSesSecretAccessKey?
568
600
 
569
601
  > `optional` **awsSesSecretAccessKey**: `string`
@@ -580,14 +612,6 @@ AWS SES access key id.
580
612
 
581
613
  ***
582
614
 
583
- ### awsSesRegion?
584
-
585
- > `optional` **awsSesRegion**: `string`
586
-
587
- AWS SES region.
588
-
589
- ***
590
-
591
615
  ### awsSesEndpoint?
592
616
 
593
617
  > `optional` **awsSesEndpoint**: `string`
@@ -849,7 +873,7 @@ Url which points to the api for a trusted synchronised storage node, not require
849
873
  > `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
850
874
 
851
875
  The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
852
- This only required if using a custom verifiable storage item, otherwise it will default the the network name.
876
+ This only required if using a custom verifiable storage item, otherwise it will default to the network name.
853
877
 
854
878
  ***
855
879
 
@@ -1047,12 +1071,31 @@ Is the data space connector enabled, defaults to false.
1047
1071
 
1048
1072
  ***
1049
1073
 
1050
- ### dataSpaceConnectorApps?
1074
+ ### dataSpaceConnectorRetainActivityLogsFor?
1051
1075
 
1052
- > `optional` **dataSpaceConnectorApps**: `string`
1076
+ > `optional` **dataSpaceConnectorRetainActivityLogsFor**: `string`
1053
1077
 
1054
- The application configuration for the data space connector.
1055
- Use the @json: prefix to specify the path to the JSON configuration file.
1078
+ The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
1079
+
1080
+ #### Default
1081
+
1082
+ ```ts
1083
+ 10
1084
+ ```
1085
+
1086
+ ***
1087
+
1088
+ ### dataSpaceConnectorActivityLogsCleanUpInterval?
1089
+
1090
+ > `optional` **dataSpaceConnectorActivityLogsCleanUpInterval**: `string`
1091
+
1092
+ The interval for cleaning up the activity logs.
1093
+
1094
+ #### Default
1095
+
1096
+ ```ts
1097
+ 60
1098
+ ```
1056
1099
 
1057
1100
  ***
1058
1101
 
@@ -1070,3 +1113,11 @@ Enable verifiable credential authentication for the API.
1070
1113
 
1071
1114
  Verifiable credential assertion for node to node communication.
1072
1115
  Defaults to node-authentication-assertion.
1116
+
1117
+ ***
1118
+
1119
+ ### extensions?
1120
+
1121
+ > `optional` **extensions**: `string`
1122
+
1123
+ A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
@@ -85,6 +85,18 @@ A prefix for all the table in entity-storage, can be empty.
85
85
 
86
86
  ***
87
87
 
88
+ ### awsDynamodbAuthMode?
89
+
90
+ > `optional` **awsDynamodbAuthMode**: `string`
91
+
92
+ AWS DynamoDB auth mode, either credentials or pod.
93
+
94
+ #### Inherited from
95
+
96
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbAuthMode`](IEngineEnvironmentVariables.md#awsdynamodbauthmode)
97
+
98
+ ***
99
+
88
100
  ### awsDynamodbAccessKeyId?
89
101
 
90
102
  > `optional` **awsDynamodbAccessKeyId**: `string`
@@ -579,15 +591,15 @@ A prefix for all the blobs in blob-storage, can be empty.
579
591
 
580
592
  ***
581
593
 
582
- ### awsS3AccessKeyId?
594
+ ### awsS3Region?
583
595
 
584
- > `optional` **awsS3AccessKeyId**: `string`
596
+ > `optional` **awsS3Region**: `string`
585
597
 
586
- AWS S3 access key id.
598
+ AWS S3 region.
587
599
 
588
600
  #### Inherited from
589
601
 
590
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3AccessKeyId`](IEngineEnvironmentVariables.md#awss3accesskeyid)
602
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Region`](IEngineEnvironmentVariables.md#awss3region)
591
603
 
592
604
  ***
593
605
 
@@ -603,27 +615,27 @@ AWS S3 bucket name.
603
615
 
604
616
  ***
605
617
 
606
- ### awsS3Endpoint?
618
+ ### awsS3AuthMode?
607
619
 
608
- > `optional` **awsS3Endpoint**: `string`
620
+ > `optional` **awsS3AuthMode**: `string`
609
621
 
610
- AWS S3 endpoint.
622
+ AWS S3 auth mode, either credentials or pod, defaults to credentials.
611
623
 
612
624
  #### Inherited from
613
625
 
614
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Endpoint`](IEngineEnvironmentVariables.md#awss3endpoint)
626
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3AuthMode`](IEngineEnvironmentVariables.md#awss3authmode)
615
627
 
616
628
  ***
617
629
 
618
- ### awsS3Region?
630
+ ### awsS3AccessKeyId?
619
631
 
620
- > `optional` **awsS3Region**: `string`
632
+ > `optional` **awsS3AccessKeyId**: `string`
621
633
 
622
- AWS S3 region.
634
+ AWS S3 access key id.
623
635
 
624
636
  #### Inherited from
625
637
 
626
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Region`](IEngineEnvironmentVariables.md#awss3region)
638
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3AccessKeyId`](IEngineEnvironmentVariables.md#awss3accesskeyid)
627
639
 
628
640
  ***
629
641
 
@@ -639,6 +651,18 @@ AWS S3 secret access key.
639
651
 
640
652
  ***
641
653
 
654
+ ### awsS3Endpoint?
655
+
656
+ > `optional` **awsS3Endpoint**: `string`
657
+
658
+ AWS S3 endpoint.
659
+
660
+ #### Inherited from
661
+
662
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Endpoint`](IEngineEnvironmentVariables.md#awss3endpoint)
663
+
664
+ ***
665
+
642
666
  ### azureStorageAccountKey?
643
667
 
644
668
  > `optional` **azureStorageAccountKey**: `string`
@@ -844,39 +868,51 @@ Use the @json: prefix to specify the path to the JSON file.
844
868
 
845
869
  ***
846
870
 
847
- ### awsSesSecretAccessKey?
871
+ ### awsSesRegion?
848
872
 
849
- > `optional` **awsSesSecretAccessKey**: `string`
873
+ > `optional` **awsSesRegion**: `string`
850
874
 
851
- AWS SES secret access key.
875
+ AWS SES region.
852
876
 
853
877
  #### Inherited from
854
878
 
855
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesSecretAccessKey`](IEngineEnvironmentVariables.md#awssessecretaccesskey)
879
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesRegion`](IEngineEnvironmentVariables.md#awssesregion)
856
880
 
857
881
  ***
858
882
 
859
- ### awsSesAccessKeyId?
883
+ ### awsSesAuthMode?
860
884
 
861
- > `optional` **awsSesAccessKeyId**: `string`
885
+ > `optional` **awsSesAuthMode**: `string`
862
886
 
863
- AWS SES access key id.
887
+ AWS SES auth mode, either credentials or pod, defaults to credentials.
864
888
 
865
889
  #### Inherited from
866
890
 
867
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesAccessKeyId`](IEngineEnvironmentVariables.md#awssesaccesskeyid)
891
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesAuthMode`](IEngineEnvironmentVariables.md#awssesauthmode)
868
892
 
869
893
  ***
870
894
 
871
- ### awsSesRegion?
895
+ ### awsSesSecretAccessKey?
872
896
 
873
- > `optional` **awsSesRegion**: `string`
897
+ > `optional` **awsSesSecretAccessKey**: `string`
874
898
 
875
- AWS SES region.
899
+ AWS SES secret access key.
876
900
 
877
901
  #### Inherited from
878
902
 
879
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesRegion`](IEngineEnvironmentVariables.md#awssesregion)
903
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesSecretAccessKey`](IEngineEnvironmentVariables.md#awssessecretaccesskey)
904
+
905
+ ***
906
+
907
+ ### awsSesAccessKeyId?
908
+
909
+ > `optional` **awsSesAccessKeyId**: `string`
910
+
911
+ AWS SES access key id.
912
+
913
+ #### Inherited from
914
+
915
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesAccessKeyId`](IEngineEnvironmentVariables.md#awssesaccesskeyid)
880
916
 
881
917
  ***
882
918
 
@@ -1269,7 +1305,7 @@ Url which points to the api for a trusted synchronised storage node, not require
1269
1305
  > `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
1270
1306
 
1271
1307
  The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
1272
- This only required if using a custom verifiable storage item, otherwise it will default the the network name.
1308
+ This only required if using a custom verifiable storage item, otherwise it will default to the network name.
1273
1309
 
1274
1310
  #### Inherited from
1275
1311
 
@@ -1551,16 +1587,39 @@ Is the data space connector enabled, defaults to false.
1551
1587
 
1552
1588
  ***
1553
1589
 
1554
- ### dataSpaceConnectorApps?
1590
+ ### dataSpaceConnectorRetainActivityLogsFor?
1555
1591
 
1556
- > `optional` **dataSpaceConnectorApps**: `string`
1592
+ > `optional` **dataSpaceConnectorRetainActivityLogsFor**: `string`
1557
1593
 
1558
- The application configuration for the data space connector.
1559
- Use the @json: prefix to specify the path to the JSON configuration file.
1594
+ The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
1595
+
1596
+ #### Default
1597
+
1598
+ ```ts
1599
+ 10
1600
+ ```
1560
1601
 
1561
1602
  #### Inherited from
1562
1603
 
1563
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorApps`](IEngineEnvironmentVariables.md#dataspaceconnectorapps)
1604
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorRetainActivityLogsFor`](IEngineEnvironmentVariables.md#dataspaceconnectorretainactivitylogsfor)
1605
+
1606
+ ***
1607
+
1608
+ ### dataSpaceConnectorActivityLogsCleanUpInterval?
1609
+
1610
+ > `optional` **dataSpaceConnectorActivityLogsCleanUpInterval**: `string`
1611
+
1612
+ The interval for cleaning up the activity logs.
1613
+
1614
+ #### Default
1615
+
1616
+ ```ts
1617
+ 60
1618
+ ```
1619
+
1620
+ #### Inherited from
1621
+
1622
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorActivityLogsCleanUpInterval`](IEngineEnvironmentVariables.md#dataspaceconnectoractivitylogscleanupinterval)
1564
1623
 
1565
1624
  ***
1566
1625
 
@@ -1589,6 +1648,18 @@ Defaults to node-authentication-assertion.
1589
1648
 
1590
1649
  ***
1591
1650
 
1651
+ ### extensions?
1652
+
1653
+ > `optional` **extensions**: `string`
1654
+
1655
+ A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
1656
+
1657
+ #### Inherited from
1658
+
1659
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`extensions`](IEngineEnvironmentVariables.md#extensions)
1660
+
1661
+ ***
1662
+
1592
1663
  ### port?
1593
1664
 
1594
1665
  > `optional` **port**: `string`
@@ -0,0 +1,7 @@
1
+ # Interface: INodeEngineConfig
2
+
3
+ The config for the node.
4
+
5
+ ## Extends
6
+
7
+ - `IEngineServerConfig`