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

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 (145) hide show
  1. package/dist/es/builders/engineEnvBuilder.js +155 -74
  2. package/dist/es/builders/engineEnvBuilder.js.map +1 -1
  3. package/dist/es/builders/engineServerEnvBuilder.js +24 -15
  4. package/dist/es/builders/engineServerEnvBuilder.js.map +1 -1
  5. package/dist/es/builders/extensionsBuilder.js +26 -17
  6. package/dist/es/builders/extensionsBuilder.js.map +1 -1
  7. package/dist/es/cli.js +255 -0
  8. package/dist/es/cli.js.map +1 -0
  9. package/dist/es/commands/bootstrapLegacy.js +175 -0
  10. package/dist/es/commands/bootstrapLegacy.js.map +1 -0
  11. package/dist/es/commands/help.js +85 -0
  12. package/dist/es/commands/help.js.map +1 -0
  13. package/dist/es/commands/identityCreate.js +310 -0
  14. package/dist/es/commands/identityCreate.js.map +1 -0
  15. package/dist/es/commands/identityImports.js +76 -0
  16. package/dist/es/commands/identityImports.js.map +1 -0
  17. package/dist/es/commands/identityVerifiableCredentialCreate.js +140 -0
  18. package/dist/es/commands/identityVerifiableCredentialCreate.js.map +1 -0
  19. package/dist/es/commands/identityVerificationMethodCreate.js +208 -0
  20. package/dist/es/commands/identityVerificationMethodCreate.js.map +1 -0
  21. package/dist/es/commands/identityVerificationMethodImport.js +120 -0
  22. package/dist/es/commands/identityVerificationMethodImport.js.map +1 -0
  23. package/dist/es/commands/nodeSetIdentity.js +51 -0
  24. package/dist/es/commands/nodeSetIdentity.js.map +1 -0
  25. package/dist/es/commands/nodeSetTenant.js +49 -0
  26. package/dist/es/commands/nodeSetTenant.js.map +1 -0
  27. package/dist/es/commands/tenantCreate.js +120 -0
  28. package/dist/es/commands/tenantCreate.js.map +1 -0
  29. package/dist/es/commands/tenantImport.js +78 -0
  30. package/dist/es/commands/tenantImport.js.map +1 -0
  31. package/dist/es/commands/userCreate.js +197 -0
  32. package/dist/es/commands/userCreate.js.map +1 -0
  33. package/dist/es/commands/vaultKeyCreate.js +185 -0
  34. package/dist/es/commands/vaultKeyCreate.js.map +1 -0
  35. package/dist/es/commands/vaultKeyImport.js +98 -0
  36. package/dist/es/commands/vaultKeyImport.js.map +1 -0
  37. package/dist/es/defaults.js +20 -1
  38. package/dist/es/defaults.js.map +1 -1
  39. package/dist/es/index.js +7 -3
  40. package/dist/es/index.js.map +1 -1
  41. package/dist/es/models/ICliArgs.js +4 -0
  42. package/dist/es/models/ICliArgs.js.map +1 -0
  43. package/dist/es/models/ICliCommand.js +2 -0
  44. package/dist/es/models/ICliCommand.js.map +1 -0
  45. package/dist/es/models/ICliCommandDefinition.js +2 -0
  46. package/dist/es/models/ICliCommandDefinition.js.map +1 -0
  47. package/dist/es/models/ICliCommandDefinitionParam.js +2 -0
  48. package/dist/es/models/ICliCommandDefinitionParam.js.map +1 -0
  49. package/dist/es/models/IEngineEnvironmentVariables.js.map +1 -1
  50. package/dist/es/models/INodeEngineState.js.map +1 -1
  51. package/dist/es/models/INodeEnvironmentVariables.js.map +1 -1
  52. package/dist/es/models/INodeOptions.js.map +1 -1
  53. package/dist/es/models/cliCommandParamType.js +4 -0
  54. package/dist/es/models/cliCommandParamType.js.map +1 -0
  55. package/dist/es/node.js +59 -39
  56. package/dist/es/node.js.map +1 -1
  57. package/dist/es/start.js +128 -0
  58. package/dist/es/start.js.map +1 -0
  59. package/dist/es/utils.js +5 -22
  60. package/dist/es/utils.js.map +1 -1
  61. package/dist/types/builders/engineEnvBuilder.d.ts +4 -1
  62. package/dist/types/builders/engineServerEnvBuilder.d.ts +5 -2
  63. package/dist/types/cli.d.ts +66 -0
  64. package/dist/types/commands/bootstrapLegacy.d.ts +66 -0
  65. package/dist/types/commands/help.d.ts +23 -0
  66. package/dist/types/commands/identityCreate.d.ts +39 -0
  67. package/dist/types/commands/identityImports.d.ts +24 -0
  68. package/dist/types/commands/identityVerifiableCredentialCreate.d.ts +43 -0
  69. package/dist/types/commands/identityVerificationMethodCreate.d.ts +47 -0
  70. package/dist/types/commands/identityVerificationMethodImport.d.ts +31 -0
  71. package/dist/types/commands/nodeSetIdentity.d.ts +22 -0
  72. package/dist/types/commands/nodeSetTenant.d.ts +22 -0
  73. package/dist/types/commands/tenantCreate.d.ts +35 -0
  74. package/dist/types/commands/tenantImport.d.ts +24 -0
  75. package/dist/types/commands/userCreate.d.ts +46 -0
  76. package/dist/types/commands/vaultKeyCreate.d.ts +43 -0
  77. package/dist/types/commands/vaultKeyImport.d.ts +28 -0
  78. package/dist/types/defaults.d.ts +11 -1
  79. package/dist/types/index.d.ts +7 -3
  80. package/dist/types/models/ICliArgs.d.ts +20 -0
  81. package/dist/types/models/ICliCommand.d.ts +17 -0
  82. package/dist/types/models/ICliCommandDefinition.d.ts +46 -0
  83. package/dist/types/models/ICliCommandDefinitionParam.d.ts +35 -0
  84. package/dist/types/models/IEngineEnvironmentVariables.d.ts +51 -42
  85. package/dist/types/models/INodeEngineState.d.ts +0 -8
  86. package/dist/types/models/INodeEnvironmentVariables.d.ts +0 -38
  87. package/dist/types/models/INodeOptions.d.ts +2 -2
  88. package/dist/types/models/cliCommandParamType.d.ts +4 -0
  89. package/dist/types/node.d.ts +8 -4
  90. package/dist/types/{server.d.ts → start.d.ts} +7 -2
  91. package/dist/types/utils.d.ts +2 -9
  92. package/docs/changelog.md +70 -0
  93. package/docs/reference/functions/buildConfiguration.md +3 -3
  94. package/docs/reference/functions/buildEngineConfiguration.md +1 -1
  95. package/docs/reference/functions/buildEngineServerConfiguration.md +3 -3
  96. package/docs/reference/functions/constructCliCommand.md +27 -0
  97. package/docs/reference/functions/executeCommand.md +29 -0
  98. package/docs/reference/functions/getEnvDefaults.md +19 -0
  99. package/docs/reference/functions/getExecutionDirectory.md +9 -1
  100. package/docs/reference/functions/initCli.md +27 -0
  101. package/docs/reference/functions/parseCommandLineArgs.md +19 -0
  102. package/docs/reference/functions/processEnvOptions.md +27 -0
  103. package/docs/reference/functions/registerCommands.md +9 -0
  104. package/docs/reference/functions/run.md +8 -2
  105. package/docs/reference/functions/start.md +10 -4
  106. package/docs/reference/functions/substituteEnvOptions.md +25 -0
  107. package/docs/reference/index.md +15 -12
  108. package/docs/reference/interfaces/ICliArgs.md +35 -0
  109. package/docs/reference/interfaces/ICliCommand.md +23 -0
  110. package/docs/reference/interfaces/ICliCommandDefinition.md +101 -0
  111. package/docs/reference/interfaces/ICliCommandDefinitionParam.md +65 -0
  112. package/docs/reference/interfaces/IEngineEnvironmentVariables.md +90 -65
  113. package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +129 -88
  114. package/docs/reference/interfaces/INodeEngineState.md +0 -16
  115. package/docs/reference/interfaces/INodeEnvironmentVariables.md +129 -172
  116. package/docs/reference/interfaces/INodeOptions.md +2 -2
  117. package/docs/reference/type-aliases/CliCommandParamType.md +5 -0
  118. package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_DID.md +3 -0
  119. package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_TENANT.md +3 -0
  120. package/docs/reference/variables/VC_AUTHENTICATION_VERIFICATION_METHOD_ID.md +1 -1
  121. package/locales/en.json +463 -30
  122. package/package.json +3 -1
  123. package/dist/es/bootstrap.js +0 -374
  124. package/dist/es/bootstrap.js.map +0 -1
  125. package/dist/es/identity.js +0 -169
  126. package/dist/es/identity.js.map +0 -1
  127. package/dist/es/models/nodeFeatures.js +0 -21
  128. package/dist/es/models/nodeFeatures.js.map +0 -1
  129. package/dist/es/server.js +0 -74
  130. package/dist/es/server.js.map +0 -1
  131. package/dist/types/bootstrap.d.ts +0 -76
  132. package/dist/types/identity.d.ts +0 -14
  133. package/dist/types/models/nodeFeatures.d.ts +0 -21
  134. package/docs/reference/functions/bootstrap.md +0 -29
  135. package/docs/reference/functions/bootstrapAuth.md +0 -35
  136. package/docs/reference/functions/bootstrapBlobEncryption.md +0 -35
  137. package/docs/reference/functions/bootstrapContextIdHandlers.md +0 -35
  138. package/docs/reference/functions/bootstrapImmutableProofMethod.md +0 -35
  139. package/docs/reference/functions/bootstrapNodeAdminUser.md +0 -35
  140. package/docs/reference/functions/bootstrapNodeId.md +0 -35
  141. package/docs/reference/functions/bootstrapSynchronisedStorage.md +0 -35
  142. package/docs/reference/functions/bootstrapTenantId.md +0 -35
  143. package/docs/reference/functions/getFeatures.md +0 -19
  144. package/docs/reference/type-aliases/NodeFeatures.md +0 -5
  145. package/docs/reference/variables/NodeFeatures.md +0 -25
package/docs/reference/interfaces/IEngineEnvironmentVariables.md CHANGED
@@ -16,6 +16,14 @@ Start the engine in debug mode.
16
16
 
17
17
  ***
18
18
 
19
+ ### silent?
20
+
21
+ > `optional` **silent**: `string`
22
+
23
+ Start the engine in silent mode.
24
+
25
+ ***
26
+
19
27
  ### storageFileRoot?
20
28
 
21
29
  > `optional` **storageFileRoot**: `string`
@@ -32,27 +40,19 @@ The name of the state file.
32
40
 
33
41
  ***
34
42
 
35
- ### tenantEnabled?
43
+ ### nodeIdentityEnabled?
36
44
 
37
- > `optional` **tenantEnabled**: `string`
45
+ > `optional` **nodeIdentityEnabled**: `string`
38
46
 
39
- Is multi-tenant support enabled, defaults to false.
47
+ Does the node have a unique ID, defaults to true.
40
48
 
41
49
  ***
42
50
 
43
- ### tenantId?
44
-
45
- > `optional` **tenantId**: `string`
46
-
47
- A tenant id to use as a default for the node.
48
-
49
- ***
50
-
51
- ### tenantApiKey?
51
+ ### tenantEnabled?
52
52
 
53
- > `optional` **tenantApiKey**: `string`
53
+ > `optional` **tenantEnabled**: `string`
54
54
 
55
- A tenant api key to use as a default for the node.
55
+ Is multi-tenant support enabled, defaults to false.
56
56
 
57
57
  ***
58
58
 
@@ -121,6 +121,14 @@ AWS Dynamo DB secret access key.
121
121
 
122
122
  ***
123
123
 
124
+ ### awsDynamodbConnectionTimeoutMs?
125
+
126
+ > `optional` **awsDynamodbConnectionTimeoutMs**: `string`
127
+
128
+ AWS Dynamo DB connection timeout.
129
+
130
+ ***
131
+
124
132
  ### azureCosmosdbKey?
125
133
 
126
134
  > `optional` **azureCosmosdbKey**: `string`
@@ -402,15 +410,6 @@ The id of the encryption key for the blob storage.
402
410
 
403
411
  ***
404
412
 
405
- ### blobStorageSymmetricEncryptionKey?
406
-
407
- > `optional` **blobStorageSymmetricEncryptionKey**: `string`
408
-
409
- A symmetric encryption key for the blob storage, should be ChaCha20Poly1305 in base64 format.
410
- If encryption is enabled but a key is not provided one will be generated.
411
-
412
- ***
413
-
414
413
  ### blobStoragePrefix?
415
414
 
416
415
  > `optional` **blobStoragePrefix**: `string`
@@ -563,14 +562,6 @@ The type of logging task connector, can be a comma separated list: console, enti
563
562
 
564
563
  ***
565
564
 
566
- ### backgroundTaskConnector?
567
-
568
- > `optional` **backgroundTaskConnector**: `string`
569
-
570
- The type of background task connector: entity-storage.
571
-
572
- ***
573
-
574
565
  ### eventBusConnector?
575
566
 
576
567
  > `optional` **eventBusConnector**: `string`
@@ -707,6 +698,14 @@ The type of identity connector: entity-storage, iota.
707
698
 
708
699
  ***
709
700
 
701
+ ### identityWalletAddressIndex?
702
+
703
+ > `optional` **identityWalletAddressIndex**: `string`
704
+
705
+ The index of the wallet address to use, defaults to 0.
706
+
707
+ ***
708
+
710
709
  ### identityResolverConnector?
711
710
 
712
711
  > `optional` **identityResolverConnector**: `string`
@@ -975,19 +974,44 @@ Is the federated catalogue enabled, defaults to false.
975
974
 
976
975
  ***
977
976
 
978
- ### federatedCatalogueCacheTtlMs?
977
+ ### federatedCatalogueFilters?
978
+
979
+ > `optional` **federatedCatalogueFilters**: `string`
980
+
981
+ Federated catalog filters, command separated list of filters to add.
982
+
983
+ ***
984
+
985
+ ### trustEnabled?
986
+
987
+ > `optional` **trustEnabled**: `string`
988
+
989
+ Is the trust management enabled, defaults to false.
990
+
991
+ ***
992
+
993
+ ### trustGenerators?
994
+
995
+ > `optional` **trustGenerators**: `string`
996
+
997
+ The trust generators to add to the factory, comma separated list.
998
+
999
+ ***
1000
+
1001
+ ### trustVerifiers?
979
1002
 
980
- > `optional` **federatedCatalogueCacheTtlMs**: `number`
1003
+ > `optional` **trustVerifiers**: `string`
981
1004
 
982
- Federated catalog TTL for the cache.
1005
+ The trust verifiers to add to the factory, comma separated list.
983
1006
 
984
1007
  ***
985
1008
 
986
- ### federatedCatalogueClearingHouseApproverList?
1009
+ ### trustVerificationMethodId?
987
1010
 
988
- > `optional` **federatedCatalogueClearingHouseApproverList**: `string`
1011
+ > `optional` **trustVerificationMethodId**: `string`
989
1012
 
990
- Federated catalog clearing house approver list, stringified array of DIDs.
1013
+ The verification method to use for trust identities.
1014
+ Defaults to node-authentication-assertion.
991
1015
 
992
1016
  ***
993
1017
 
@@ -1007,66 +1031,67 @@ What is the base callback url for rights management negotiations e.g. https://my
1007
1031
 
1008
1032
  ***
1009
1033
 
1010
- ### rightsManagementInformationSources?
1034
+ ### rightsManagementPolicyInformationSources?
1035
+
1036
+ > `optional` **rightsManagementPolicyInformationSources**: `string`
1037
+
1038
+ The rights management policy information sources to add to the factory.
1039
+
1040
+ ***
1041
+
1042
+ ### rightsManagementPolicyNegotiators?
1011
1043
 
1012
- > `optional` **rightsManagementInformationSources**: `string`
1044
+ > `optional` **rightsManagementPolicyNegotiators**: `string`
1013
1045
 
1014
- The rights management configuration which includes the information sources modules to load.
1015
- Use the @json: prefix to specify the path to the JSON configuration file.
1046
+ The rights management policy negotiators sources to add to the factory.
1016
1047
 
1017
1048
  ***
1018
1049
 
1019
- ### rightsManagementNegotiators?
1050
+ ### rightsManagementPolicyRequesters?
1020
1051
 
1021
- > `optional` **rightsManagementNegotiators**: `string`
1052
+ > `optional` **rightsManagementPolicyRequesters**: `string`
1022
1053
 
1023
- The rights management configuration which includes the negotiator modules to load.
1024
- Use the @json: prefix to specify the path to the JSON configuration file.
1054
+ The rights management policy requesters to add to the factory.
1025
1055
 
1026
1056
  ***
1027
1057
 
1028
- ### rightsManagementRequesters?
1058
+ ### rightsManagementPolicyExecutionActions?
1029
1059
 
1030
- > `optional` **rightsManagementRequesters**: `string`
1060
+ > `optional` **rightsManagementPolicyExecutionActions**: `string`
1031
1061
 
1032
- The rights management configuration which includes the requester modules to load.
1033
- Use the @json: prefix to specify the path to the JSON configuration file.
1062
+ The rights management policy execution actions to add to the factory.
1034
1063
 
1035
1064
  ***
1036
1065
 
1037
- ### rightsManagementExecutionActions?
1066
+ ### rightsManagementPolicyEnforcementProcessors?
1038
1067
 
1039
- > `optional` **rightsManagementExecutionActions**: `string`
1068
+ > `optional` **rightsManagementPolicyEnforcementProcessors**: `string`
1040
1069
 
1041
- The rights management configuration which includes the execution actions modules to load.
1042
- Use the @json: prefix to specify the path to the JSON configuration file.
1070
+ The rights management policy enforcement processors to add to the factory.
1043
1071
 
1044
1072
  ***
1045
1073
 
1046
- ### rightsManagementEnforcementProcessors?
1074
+ ### rightsManagementPolicyArbiters?
1047
1075
 
1048
- > `optional` **rightsManagementEnforcementProcessors**: `string`
1076
+ > `optional` **rightsManagementPolicyArbiters**: `string`
1049
1077
 
1050
- The rights management configuration which includes the enforcement processor modules to load.
1051
- Use the @json: prefix to specify the path to the JSON configuration file.
1078
+ The rights management policy arbiters to add to the factory.
1052
1079
 
1053
1080
  ***
1054
1081
 
1055
- ### rightsManagementArbiters?
1082
+ ### rightsManagementDataAccessHandlers?
1056
1083
 
1057
- > `optional` **rightsManagementArbiters**: `string`
1084
+ > `optional` **rightsManagementDataAccessHandlers**: `string`
1058
1085
 
1059
- The rights management configuration which includes the arbiter modules to load.
1060
- Use the @json: prefix to specify the path to the JSON configuration file.
1086
+ The rights management data access handlers to add to the factory.
1061
1087
 
1062
1088
  ***
1063
1089
 
1064
- ### rightsManagementOffers?
1090
+ ### backgroundTasksEnabled?
1065
1091
 
1066
- > `optional` **rightsManagementOffers**: `string`
1092
+ > `optional` **backgroundTasksEnabled**: `string`
1067
1093
 
1068
- The rights management configuration which includes the offer modules to load.
1069
- Use the @json: prefix to specify the path to the JSON configuration file.
1094
+ Are background tasks enabled, defaults to false.
1070
1095
 
1071
1096
  ***
1072
1097
 
package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md CHANGED
@@ -24,63 +24,63 @@ Start the engine in debug mode.
24
24
 
25
25
  ***
26
26
 
27
- ### storageFileRoot?
27
+ ### silent?
28
28
 
29
- > `optional` **storageFileRoot**: `string`
29
+ > `optional` **silent**: `string`
30
30
 
31
- The root directory for storing items like state file.
31
+ Start the engine in silent mode.
32
32
 
33
33
  #### Inherited from
34
34
 
35
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`storageFileRoot`](IEngineEnvironmentVariables.md#storagefileroot)
35
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`silent`](IEngineEnvironmentVariables.md#silent)
36
36
 
37
37
  ***
38
38
 
39
- ### stateFilename?
39
+ ### storageFileRoot?
40
40
 
41
- > `optional` **stateFilename**: `string`
41
+ > `optional` **storageFileRoot**: `string`
42
42
 
43
- The name of the state file.
43
+ The root directory for storing items like state file.
44
44
 
45
45
  #### Inherited from
46
46
 
47
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`stateFilename`](IEngineEnvironmentVariables.md#statefilename)
47
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`storageFileRoot`](IEngineEnvironmentVariables.md#storagefileroot)
48
48
 
49
49
  ***
50
50
 
51
- ### tenantEnabled?
51
+ ### stateFilename?
52
52
 
53
- > `optional` **tenantEnabled**: `string`
53
+ > `optional` **stateFilename**: `string`
54
54
 
55
- Is multi-tenant support enabled, defaults to false.
55
+ The name of the state file.
56
56
 
57
57
  #### Inherited from
58
58
 
59
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`tenantEnabled`](IEngineEnvironmentVariables.md#tenantenabled)
59
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`stateFilename`](IEngineEnvironmentVariables.md#statefilename)
60
60
 
61
61
  ***
62
62
 
63
- ### tenantId?
63
+ ### nodeIdentityEnabled?
64
64
 
65
- > `optional` **tenantId**: `string`
65
+ > `optional` **nodeIdentityEnabled**: `string`
66
66
 
67
- A tenant id to use as a default for the node.
67
+ Does the node have a unique ID, defaults to true.
68
68
 
69
69
  #### Inherited from
70
70
 
71
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`tenantId`](IEngineEnvironmentVariables.md#tenantid)
71
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`nodeIdentityEnabled`](IEngineEnvironmentVariables.md#nodeidentityenabled)
72
72
 
73
73
  ***
74
74
 
75
- ### tenantApiKey?
75
+ ### tenantEnabled?
76
76
 
77
- > `optional` **tenantApiKey**: `string`
77
+ > `optional` **tenantEnabled**: `string`
78
78
 
79
- A tenant api key to use as a default for the node.
79
+ Is multi-tenant support enabled, defaults to false.
80
80
 
81
81
  #### Inherited from
82
82
 
83
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`tenantApiKey`](IEngineEnvironmentVariables.md#tenantapikey)
83
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`tenantEnabled`](IEngineEnvironmentVariables.md#tenantenabled)
84
84
 
85
85
  ***
86
86
 
@@ -181,6 +181,18 @@ AWS Dynamo DB secret access key.
181
181
 
182
182
  ***
183
183
 
184
+ ### awsDynamodbConnectionTimeoutMs?
185
+
186
+ > `optional` **awsDynamodbConnectionTimeoutMs**: `string`
187
+
188
+ AWS Dynamo DB connection timeout.
189
+
190
+ #### Inherited from
191
+
192
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbConnectionTimeoutMs`](IEngineEnvironmentVariables.md#awsdynamodbconnectiontimeoutms)
193
+
194
+ ***
195
+
184
196
  ### azureCosmosdbKey?
185
197
 
186
198
  > `optional` **azureCosmosdbKey**: `string`
@@ -602,19 +614,6 @@ The id of the encryption key for the blob storage.
602
614
 
603
615
  ***
604
616
 
605
- ### blobStorageSymmetricEncryptionKey?
606
-
607
- > `optional` **blobStorageSymmetricEncryptionKey**: `string`
608
-
609
- A symmetric encryption key for the blob storage, should be ChaCha20Poly1305 in base64 format.
610
- If encryption is enabled but a key is not provided one will be generated.
611
-
612
- #### Inherited from
613
-
614
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageSymmetricEncryptionKey`](IEngineEnvironmentVariables.md#blobstoragesymmetricencryptionkey)
615
-
616
- ***
617
-
618
617
  ### blobStoragePrefix?
619
618
 
620
619
  > `optional` **blobStoragePrefix**: `string`
@@ -843,18 +842,6 @@ The type of logging task connector, can be a comma separated list: console, enti
843
842
 
844
843
  ***
845
844
 
846
- ### backgroundTaskConnector?
847
-
848
- > `optional` **backgroundTaskConnector**: `string`
849
-
850
- The type of background task connector: entity-storage.
851
-
852
- #### Inherited from
853
-
854
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`backgroundTaskConnector`](IEngineEnvironmentVariables.md#backgroundtaskconnector)
855
-
856
- ***
857
-
858
845
  ### eventBusConnector?
859
846
 
860
847
  > `optional` **eventBusConnector**: `string`
@@ -1059,6 +1046,18 @@ The type of identity connector: entity-storage, iota.
1059
1046
 
1060
1047
  ***
1061
1048
 
1049
+ ### identityWalletAddressIndex?
1050
+
1051
+ > `optional` **identityWalletAddressIndex**: `string`
1052
+
1053
+ The index of the wallet address to use, defaults to 0.
1054
+
1055
+ #### Inherited from
1056
+
1057
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityWalletAddressIndex`](IEngineEnvironmentVariables.md#identitywalletaddressindex)
1058
+
1059
+ ***
1060
+
1062
1061
  ### identityResolverConnector?
1063
1062
 
1064
1063
  > `optional` **identityResolverConnector**: `string`
@@ -1447,27 +1446,64 @@ Is the federated catalogue enabled, defaults to false.
1447
1446
 
1448
1447
  ***
1449
1448
 
1450
- ### federatedCatalogueCacheTtlMs?
1449
+ ### federatedCatalogueFilters?
1450
+
1451
+ > `optional` **federatedCatalogueFilters**: `string`
1452
+
1453
+ Federated catalog filters, command separated list of filters to add.
1454
+
1455
+ #### Inherited from
1456
+
1457
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueFilters`](IEngineEnvironmentVariables.md#federatedcataloguefilters)
1458
+
1459
+ ***
1460
+
1461
+ ### trustEnabled?
1462
+
1463
+ > `optional` **trustEnabled**: `string`
1464
+
1465
+ Is the trust management enabled, defaults to false.
1466
+
1467
+ #### Inherited from
1468
+
1469
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustEnabled`](IEngineEnvironmentVariables.md#trustenabled)
1470
+
1471
+ ***
1472
+
1473
+ ### trustGenerators?
1474
+
1475
+ > `optional` **trustGenerators**: `string`
1476
+
1477
+ The trust generators to add to the factory, comma separated list.
1478
+
1479
+ #### Inherited from
1480
+
1481
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustGenerators`](IEngineEnvironmentVariables.md#trustgenerators)
1482
+
1483
+ ***
1484
+
1485
+ ### trustVerifiers?
1451
1486
 
1452
- > `optional` **federatedCatalogueCacheTtlMs**: `number`
1487
+ > `optional` **trustVerifiers**: `string`
1453
1488
 
1454
- Federated catalog TTL for the cache.
1489
+ The trust verifiers to add to the factory, comma separated list.
1455
1490
 
1456
1491
  #### Inherited from
1457
1492
 
1458
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueCacheTtlMs`](IEngineEnvironmentVariables.md#federatedcataloguecachettlms)
1493
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustVerifiers`](IEngineEnvironmentVariables.md#trustverifiers)
1459
1494
 
1460
1495
  ***
1461
1496
 
1462
- ### federatedCatalogueClearingHouseApproverList?
1497
+ ### trustVerificationMethodId?
1463
1498
 
1464
- > `optional` **federatedCatalogueClearingHouseApproverList**: `string`
1499
+ > `optional` **trustVerificationMethodId**: `string`
1465
1500
 
1466
- Federated catalog clearing house approver list, stringified array of DIDs.
1501
+ The verification method to use for trust identities.
1502
+ Defaults to node-authentication-assertion.
1467
1503
 
1468
1504
  #### Inherited from
1469
1505
 
1470
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueClearingHouseApproverList`](IEngineEnvironmentVariables.md#federatedcatalogueclearinghouseapproverlist)
1506
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustVerificationMethodId`](IEngineEnvironmentVariables.md#trustverificationmethodid)
1471
1507
 
1472
1508
  ***
1473
1509
 
@@ -1495,94 +1531,99 @@ What is the base callback url for rights management negotiations e.g. https://my
1495
1531
 
1496
1532
  ***
1497
1533
 
1498
- ### rightsManagementInformationSources?
1534
+ ### rightsManagementPolicyInformationSources?
1535
+
1536
+ > `optional` **rightsManagementPolicyInformationSources**: `string`
1537
+
1538
+ The rights management policy information sources to add to the factory.
1539
+
1540
+ #### Inherited from
1541
+
1542
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyInformationSources`](IEngineEnvironmentVariables.md#rightsmanagementpolicyinformationsources)
1543
+
1544
+ ***
1545
+
1546
+ ### rightsManagementPolicyNegotiators?
1499
1547
 
1500
- > `optional` **rightsManagementInformationSources**: `string`
1548
+ > `optional` **rightsManagementPolicyNegotiators**: `string`
1501
1549
 
1502
- The rights management configuration which includes the information sources modules to load.
1503
- Use the @json: prefix to specify the path to the JSON configuration file.
1550
+ The rights management policy negotiators sources to add to the factory.
1504
1551
 
1505
1552
  #### Inherited from
1506
1553
 
1507
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementInformationSources`](IEngineEnvironmentVariables.md#rightsmanagementinformationsources)
1554
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyNegotiators`](IEngineEnvironmentVariables.md#rightsmanagementpolicynegotiators)
1508
1555
 
1509
1556
  ***
1510
1557
 
1511
- ### rightsManagementNegotiators?
1558
+ ### rightsManagementPolicyRequesters?
1512
1559
 
1513
- > `optional` **rightsManagementNegotiators**: `string`
1560
+ > `optional` **rightsManagementPolicyRequesters**: `string`
1514
1561
 
1515
- The rights management configuration which includes the negotiator modules to load.
1516
- Use the @json: prefix to specify the path to the JSON configuration file.
1562
+ The rights management policy requesters to add to the factory.
1517
1563
 
1518
1564
  #### Inherited from
1519
1565
 
1520
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementNegotiators`](IEngineEnvironmentVariables.md#rightsmanagementnegotiators)
1566
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyRequesters`](IEngineEnvironmentVariables.md#rightsmanagementpolicyrequesters)
1521
1567
 
1522
1568
  ***
1523
1569
 
1524
- ### rightsManagementRequesters?
1570
+ ### rightsManagementPolicyExecutionActions?
1525
1571
 
1526
- > `optional` **rightsManagementRequesters**: `string`
1572
+ > `optional` **rightsManagementPolicyExecutionActions**: `string`
1527
1573
 
1528
- The rights management configuration which includes the requester modules to load.
1529
- Use the @json: prefix to specify the path to the JSON configuration file.
1574
+ The rights management policy execution actions to add to the factory.
1530
1575
 
1531
1576
  #### Inherited from
1532
1577
 
1533
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementRequesters`](IEngineEnvironmentVariables.md#rightsmanagementrequesters)
1578
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyExecutionActions`](IEngineEnvironmentVariables.md#rightsmanagementpolicyexecutionactions)
1534
1579
 
1535
1580
  ***
1536
1581
 
1537
- ### rightsManagementExecutionActions?
1582
+ ### rightsManagementPolicyEnforcementProcessors?
1538
1583
 
1539
- > `optional` **rightsManagementExecutionActions**: `string`
1584
+ > `optional` **rightsManagementPolicyEnforcementProcessors**: `string`
1540
1585
 
1541
- The rights management configuration which includes the execution actions modules to load.
1542
- Use the @json: prefix to specify the path to the JSON configuration file.
1586
+ The rights management policy enforcement processors to add to the factory.
1543
1587
 
1544
1588
  #### Inherited from
1545
1589
 
1546
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementExecutionActions`](IEngineEnvironmentVariables.md#rightsmanagementexecutionactions)
1590
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyEnforcementProcessors`](IEngineEnvironmentVariables.md#rightsmanagementpolicyenforcementprocessors)
1547
1591
 
1548
1592
  ***
1549
1593
 
1550
- ### rightsManagementEnforcementProcessors?
1594
+ ### rightsManagementPolicyArbiters?
1551
1595
 
1552
- > `optional` **rightsManagementEnforcementProcessors**: `string`
1596
+ > `optional` **rightsManagementPolicyArbiters**: `string`
1553
1597
 
1554
- The rights management configuration which includes the enforcement processor modules to load.
1555
- Use the @json: prefix to specify the path to the JSON configuration file.
1598
+ The rights management policy arbiters to add to the factory.
1556
1599
 
1557
1600
  #### Inherited from
1558
1601
 
1559
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementEnforcementProcessors`](IEngineEnvironmentVariables.md#rightsmanagementenforcementprocessors)
1602
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyArbiters`](IEngineEnvironmentVariables.md#rightsmanagementpolicyarbiters)
1560
1603
 
1561
1604
  ***
1562
1605
 
1563
- ### rightsManagementArbiters?
1606
+ ### rightsManagementDataAccessHandlers?
1564
1607
 
1565
- > `optional` **rightsManagementArbiters**: `string`
1608
+ > `optional` **rightsManagementDataAccessHandlers**: `string`
1566
1609
 
1567
- The rights management configuration which includes the arbiter modules to load.
1568
- Use the @json: prefix to specify the path to the JSON configuration file.
1610
+ The rights management data access handlers to add to the factory.
1569
1611
 
1570
1612
  #### Inherited from
1571
1613
 
1572
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementArbiters`](IEngineEnvironmentVariables.md#rightsmanagementarbiters)
1614
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementDataAccessHandlers`](IEngineEnvironmentVariables.md#rightsmanagementdataaccesshandlers)
1573
1615
 
1574
1616
  ***
1575
1617
 
1576
- ### rightsManagementOffers?
1618
+ ### backgroundTasksEnabled?
1577
1619
 
1578
- > `optional` **rightsManagementOffers**: `string`
1620
+ > `optional` **backgroundTasksEnabled**: `string`
1579
1621
 
1580
- The rights management configuration which includes the offer modules to load.
1581
- Use the @json: prefix to specify the path to the JSON configuration file.
1622
+ Are background tasks enabled, defaults to false.
1582
1623
 
1583
1624
  #### Inherited from
1584
1625
 
1585
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementOffers`](IEngineEnvironmentVariables.md#rightsmanagementoffers)
1626
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`backgroundTasksEnabled`](IEngineEnvironmentVariables.md#backgroundtasksenabled)
1586
1627
 
1587
1628
  ***
1588
1629
 
package/docs/reference/interfaces/INodeEngineState.md CHANGED
@@ -21,19 +21,3 @@ The identity for the node.
21
21
  > `optional` **nodeTenantId**: `string`
22
22
 
23
23
  The tenant id for the node.
24
-
25
- ***
26
-
27
- ### nodeOrganizationId?
28
-
29
- > `optional` **nodeOrganizationId**: `string`
30
-
31
- The identity for the organization.
32
-
33
- ***
34
-
35
- ### nodeAdminUserId?
36
-
37
- > `optional` **nodeAdminUserId**: `string`
38
-
39
- The identity for the admin user.