@twin.org/node-core 0.0.3-next.2 → 0.0.3-next.21

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 (151) hide show
  1. package/dist/es/builders/engineEnvBuilder.js +168 -105
  2. package/dist/es/builders/engineEnvBuilder.js.map +1 -1
  3. package/dist/es/builders/engineServerEnvBuilder.js +49 -25
  4. package/dist/es/builders/engineServerEnvBuilder.js.map +1 -1
  5. package/dist/es/cli.js +247 -0
  6. package/dist/es/cli.js.map +1 -0
  7. package/dist/es/commands/bootstrapLegacy.js +183 -0
  8. package/dist/es/commands/bootstrapLegacy.js.map +1 -0
  9. package/dist/es/commands/help.js +85 -0
  10. package/dist/es/commands/help.js.map +1 -0
  11. package/dist/es/commands/identityCreate.js +316 -0
  12. package/dist/es/commands/identityCreate.js.map +1 -0
  13. package/dist/es/commands/identityImports.js +82 -0
  14. package/dist/es/commands/identityImports.js.map +1 -0
  15. package/dist/es/commands/identityVerifiableCredentialCreate.js +146 -0
  16. package/dist/es/commands/identityVerifiableCredentialCreate.js.map +1 -0
  17. package/dist/es/commands/identityVerificationMethodCreate.js +214 -0
  18. package/dist/es/commands/identityVerificationMethodCreate.js.map +1 -0
  19. package/dist/es/commands/identityVerificationMethodImport.js +126 -0
  20. package/dist/es/commands/identityVerificationMethodImport.js.map +1 -0
  21. package/dist/es/commands/nodeSetIdentity.js +64 -0
  22. package/dist/es/commands/nodeSetIdentity.js.map +1 -0
  23. package/dist/es/commands/nodeSetTenant.js +68 -0
  24. package/dist/es/commands/nodeSetTenant.js.map +1 -0
  25. package/dist/es/commands/tenantCreate.js +139 -0
  26. package/dist/es/commands/tenantCreate.js.map +1 -0
  27. package/dist/es/commands/tenantImport.js +97 -0
  28. package/dist/es/commands/tenantImport.js.map +1 -0
  29. package/dist/es/commands/tenantUpdate.js +94 -0
  30. package/dist/es/commands/tenantUpdate.js.map +1 -0
  31. package/dist/es/commands/userCreate.js +212 -0
  32. package/dist/es/commands/userCreate.js.map +1 -0
  33. package/dist/es/commands/userUpdate.js +132 -0
  34. package/dist/es/commands/userUpdate.js.map +1 -0
  35. package/dist/es/commands/vaultKeyCreate.js +191 -0
  36. package/dist/es/commands/vaultKeyCreate.js.map +1 -0
  37. package/dist/es/commands/vaultKeyImport.js +104 -0
  38. package/dist/es/commands/vaultKeyImport.js.map +1 -0
  39. package/dist/es/defaults.js +19 -1
  40. package/dist/es/defaults.js.map +1 -1
  41. package/dist/es/index.js +7 -3
  42. package/dist/es/index.js.map +1 -1
  43. package/dist/es/models/ICliArgs.js +4 -0
  44. package/dist/es/models/ICliArgs.js.map +1 -0
  45. package/dist/es/models/ICliCommand.js +2 -0
  46. package/dist/es/models/ICliCommand.js.map +1 -0
  47. package/dist/es/models/ICliCommandDefinition.js +2 -0
  48. package/dist/es/models/ICliCommandDefinition.js.map +1 -0
  49. package/dist/es/models/ICliCommandDefinitionParam.js +2 -0
  50. package/dist/es/models/ICliCommandDefinitionParam.js.map +1 -0
  51. package/dist/es/models/IEngineEnvironmentVariables.js.map +1 -1
  52. package/dist/es/models/IEngineServerEnvironmentVariables.js.map +1 -1
  53. package/dist/es/models/INodeEngineState.js.map +1 -1
  54. package/dist/es/models/INodeEnvironmentVariables.js.map +1 -1
  55. package/dist/es/models/INodeOptions.js.map +1 -1
  56. package/dist/es/models/cliCommandParamType.js +4 -0
  57. package/dist/es/models/cliCommandParamType.js.map +1 -0
  58. package/dist/es/node.js +78 -41
  59. package/dist/es/node.js.map +1 -1
  60. package/dist/es/start.js +139 -0
  61. package/dist/es/start.js.map +1 -0
  62. package/dist/es/utils.js +11 -21
  63. package/dist/es/utils.js.map +1 -1
  64. package/dist/types/builders/engineEnvBuilder.d.ts +4 -1
  65. package/dist/types/builders/engineServerEnvBuilder.d.ts +5 -2
  66. package/dist/types/cli.d.ts +56 -0
  67. package/dist/types/commands/bootstrapLegacy.d.ts +66 -0
  68. package/dist/types/commands/help.d.ts +23 -0
  69. package/dist/types/commands/identityCreate.d.ts +39 -0
  70. package/dist/types/commands/identityImports.d.ts +24 -0
  71. package/dist/types/commands/identityVerifiableCredentialCreate.d.ts +43 -0
  72. package/dist/types/commands/identityVerificationMethodCreate.d.ts +47 -0
  73. package/dist/types/commands/identityVerificationMethodImport.d.ts +31 -0
  74. package/dist/types/commands/nodeSetIdentity.d.ts +22 -0
  75. package/dist/types/commands/nodeSetTenant.d.ts +22 -0
  76. package/dist/types/commands/tenantCreate.d.ts +38 -0
  77. package/dist/types/commands/tenantImport.d.ts +26 -0
  78. package/dist/types/commands/tenantUpdate.d.ts +26 -0
  79. package/dist/types/commands/userCreate.d.ts +49 -0
  80. package/dist/types/commands/userUpdate.d.ts +38 -0
  81. package/dist/types/commands/vaultKeyCreate.d.ts +43 -0
  82. package/dist/types/commands/vaultKeyImport.d.ts +28 -0
  83. package/dist/types/defaults.d.ts +11 -1
  84. package/dist/types/index.d.ts +7 -3
  85. package/dist/types/models/ICliArgs.d.ts +20 -0
  86. package/dist/types/models/ICliCommand.d.ts +17 -0
  87. package/dist/types/models/ICliCommandDefinition.d.ts +46 -0
  88. package/dist/types/models/ICliCommandDefinitionParam.d.ts +35 -0
  89. package/dist/types/models/IEngineEnvironmentVariables.d.ts +62 -53
  90. package/dist/types/models/IEngineServerEnvironmentVariables.d.ts +4 -0
  91. package/dist/types/models/INodeEngineState.d.ts +0 -8
  92. package/dist/types/models/INodeEnvironmentVariables.d.ts +0 -38
  93. package/dist/types/models/INodeOptions.d.ts +6 -2
  94. package/dist/types/models/cliCommandParamType.d.ts +4 -0
  95. package/dist/types/node.d.ts +8 -4
  96. package/dist/types/{server.d.ts → start.d.ts} +7 -2
  97. package/dist/types/utils.d.ts +6 -8
  98. package/docs/changelog.md +136 -0
  99. package/docs/reference/functions/buildConfiguration.md +3 -3
  100. package/docs/reference/functions/buildEngineConfiguration.md +1 -1
  101. package/docs/reference/functions/buildEngineServerConfiguration.md +3 -3
  102. package/docs/reference/functions/constructCliCommand.md +27 -0
  103. package/docs/reference/functions/executeCommand.md +29 -0
  104. package/docs/reference/functions/getEnvDefaults.md +19 -0
  105. package/docs/reference/functions/getScriptDirectory.md +19 -0
  106. package/docs/reference/functions/parseCommandLineArgs.md +19 -0
  107. package/docs/reference/functions/processEnvOptions.md +27 -0
  108. package/docs/reference/functions/registerCommands.md +9 -0
  109. package/docs/reference/functions/run.md +8 -2
  110. package/docs/reference/functions/start.md +10 -4
  111. package/docs/reference/functions/substituteEnvOptions.md +25 -0
  112. package/docs/reference/index.md +16 -13
  113. package/docs/reference/interfaces/ICliArgs.md +35 -0
  114. package/docs/reference/interfaces/ICliCommand.md +23 -0
  115. package/docs/reference/interfaces/ICliCommandDefinition.md +101 -0
  116. package/docs/reference/interfaces/ICliCommandDefinitionParam.md +65 -0
  117. package/docs/reference/interfaces/IEngineEnvironmentVariables.md +110 -85
  118. package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +166 -117
  119. package/docs/reference/interfaces/INodeEngineState.md +0 -16
  120. package/docs/reference/interfaces/INodeEnvironmentVariables.md +170 -201
  121. package/docs/reference/interfaces/INodeOptions.md +10 -2
  122. package/docs/reference/type-aliases/CliCommandParamType.md +5 -0
  123. package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_DID.md +3 -0
  124. package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_TENANT.md +3 -0
  125. package/docs/reference/variables/TRUST_VERIFICATION_METHOD_ID.md +3 -0
  126. package/locales/en.json +589 -30
  127. package/package.json +3 -1
  128. package/dist/es/bootstrap.js +0 -374
  129. package/dist/es/bootstrap.js.map +0 -1
  130. package/dist/es/identity.js +0 -169
  131. package/dist/es/identity.js.map +0 -1
  132. package/dist/es/models/nodeFeatures.js +0 -21
  133. package/dist/es/models/nodeFeatures.js.map +0 -1
  134. package/dist/es/server.js +0 -78
  135. package/dist/es/server.js.map +0 -1
  136. package/dist/types/bootstrap.d.ts +0 -76
  137. package/dist/types/identity.d.ts +0 -14
  138. package/dist/types/models/nodeFeatures.d.ts +0 -21
  139. package/docs/reference/functions/bootstrap.md +0 -29
  140. package/docs/reference/functions/bootstrapAuth.md +0 -35
  141. package/docs/reference/functions/bootstrapBlobEncryption.md +0 -35
  142. package/docs/reference/functions/bootstrapContextIdHandlers.md +0 -35
  143. package/docs/reference/functions/bootstrapImmutableProofMethod.md +0 -35
  144. package/docs/reference/functions/bootstrapNodeAdminUser.md +0 -35
  145. package/docs/reference/functions/bootstrapNodeId.md +0 -35
  146. package/docs/reference/functions/bootstrapSynchronisedStorage.md +0 -35
  147. package/docs/reference/functions/bootstrapTenantId.md +0 -35
  148. package/docs/reference/functions/getFeatures.md +0 -19
  149. package/docs/reference/type-aliases/NodeFeatures.md +0 -5
  150. package/docs/reference/variables/NodeFeatures.md +0 -25
  151. package/docs/reference/variables/VC_AUTHENTICATION_VERIFICATION_METHOD_ID.md +0 -3
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`
@@ -807,6 +806,18 @@ The type of the default vault connector: entity-storage, hashicorp.
807
806
 
808
807
  ***
809
808
 
809
+ ### vaultPrefix?
810
+
811
+ > `optional` **vaultPrefix**: `string`
812
+
813
+ Prefix to prepend to entries in the vault.
814
+
815
+ #### Inherited from
816
+
817
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`vaultPrefix`](IEngineEnvironmentVariables.md#vaultprefix)
818
+
819
+ ***
820
+
810
821
  ### hashicorpVaultToken?
811
822
 
812
823
  > `optional` **hashicorpVaultToken**: `string`
@@ -843,18 +854,6 @@ The type of logging task connector, can be a comma separated list: console, enti
843
854
 
844
855
  ***
845
856
 
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
857
  ### eventBusConnector?
859
858
 
860
859
  > `optional` **eventBusConnector**: `string`
@@ -1059,6 +1058,18 @@ The type of identity connector: entity-storage, iota.
1059
1058
 
1060
1059
  ***
1061
1060
 
1061
+ ### identityWalletAddressIndex?
1062
+
1063
+ > `optional` **identityWalletAddressIndex**: `string`
1064
+
1065
+ The index of the wallet address to use, defaults to 0.
1066
+
1067
+ #### Inherited from
1068
+
1069
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityWalletAddressIndex`](IEngineEnvironmentVariables.md#identitywalletaddressindex)
1070
+
1071
+ ***
1072
+
1062
1073
  ### identityResolverConnector?
1063
1074
 
1064
1075
  > `optional` **identityResolverConnector**: `string`
@@ -1447,27 +1458,77 @@ Is the federated catalogue enabled, defaults to false.
1447
1458
 
1448
1459
  ***
1449
1460
 
1450
- ### federatedCatalogueCacheTtlMs?
1461
+ ### federatedCatalogueFilters?
1462
+
1463
+ > `optional` **federatedCatalogueFilters**: `string`
1464
+
1465
+ Federated catalog filters, command separated list of filters to add.
1466
+
1467
+ #### Inherited from
1468
+
1469
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueFilters`](IEngineEnvironmentVariables.md#federatedcataloguefilters)
1470
+
1471
+ ***
1472
+
1473
+ ### trustEnabled?
1474
+
1475
+ > `optional` **trustEnabled**: `string`
1476
+
1477
+ Is the trust management enabled, defaults to false.
1478
+
1479
+ #### Inherited from
1480
+
1481
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustEnabled`](IEngineEnvironmentVariables.md#trustenabled)
1482
+
1483
+ ***
1484
+
1485
+ ### trustGenerators?
1486
+
1487
+ > `optional` **trustGenerators**: `string`
1488
+
1489
+ The trust generators to add to the factory, comma separated list.
1490
+
1491
+ #### Inherited from
1492
+
1493
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustGenerators`](IEngineEnvironmentVariables.md#trustgenerators)
1494
+
1495
+ ***
1496
+
1497
+ ### trustVerifiers?
1498
+
1499
+ > `optional` **trustVerifiers**: `string`
1500
+
1501
+ The trust verifiers to add to the factory, comma separated list.
1502
+
1503
+ #### Inherited from
1504
+
1505
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustVerifiers`](IEngineEnvironmentVariables.md#trustverifiers)
1506
+
1507
+ ***
1508
+
1509
+ ### trustVerificationMethodId?
1451
1510
 
1452
- > `optional` **federatedCatalogueCacheTtlMs**: `number`
1511
+ > `optional` **trustVerificationMethodId**: `string`
1453
1512
 
1454
- Federated catalog TTL for the cache.
1513
+ The verification method to use for trust identities.
1514
+ Defaults to trust-assertion.
1455
1515
 
1456
1516
  #### Inherited from
1457
1517
 
1458
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueCacheTtlMs`](IEngineEnvironmentVariables.md#federatedcataloguecachettlms)
1518
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustVerificationMethodId`](IEngineEnvironmentVariables.md#trustverificationmethodid)
1459
1519
 
1460
1520
  ***
1461
1521
 
1462
- ### federatedCatalogueClearingHouseApproverList?
1522
+ ### trustJwtTtlSeconds?
1463
1523
 
1464
- > `optional` **federatedCatalogueClearingHouseApproverList**: `string`
1524
+ > `optional` **trustJwtTtlSeconds**: `string`
1465
1525
 
1466
- Federated catalog clearing house approver list, stringified array of DIDs.
1526
+ The trust time to live for generating JWTs.
1527
+ Defaults to undefined for never expiring.
1467
1528
 
1468
1529
  #### Inherited from
1469
1530
 
1470
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueClearingHouseApproverList`](IEngineEnvironmentVariables.md#federatedcatalogueclearinghouseapproverlist)
1531
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustJwtTtlSeconds`](IEngineEnvironmentVariables.md#trustjwtttlseconds)
1471
1532
 
1472
1533
  ***
1473
1534
 
@@ -1483,106 +1544,111 @@ Is the rights management enabled, defaults to false.
1483
1544
 
1484
1545
  ***
1485
1546
 
1486
- ### rightsManagementBaseCallbackUrl?
1547
+ ### rightsManagementCallbackPath?
1548
+
1549
+ > `optional` **rightsManagementCallbackPath**: `string`
1550
+
1551
+ What is the callback path for rights management negotiations, will be combined with hosting public url e.g. /callback.
1552
+
1553
+ #### Inherited from
1554
+
1555
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementCallbackPath`](IEngineEnvironmentVariables.md#rightsmanagementcallbackpath)
1556
+
1557
+ ***
1558
+
1559
+ ### rightsManagementPolicyInformationSources?
1487
1560
 
1488
- > `optional` **rightsManagementBaseCallbackUrl**: `string`
1561
+ > `optional` **rightsManagementPolicyInformationSources**: `string`
1489
1562
 
1490
- What is the base callback url for rights management negotiations e.g. https://my-node/rights-management.
1563
+ The rights management policy information sources to add to the factory.
1491
1564
 
1492
1565
  #### Inherited from
1493
1566
 
1494
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementBaseCallbackUrl`](IEngineEnvironmentVariables.md#rightsmanagementbasecallbackurl)
1567
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyInformationSources`](IEngineEnvironmentVariables.md#rightsmanagementpolicyinformationsources)
1495
1568
 
1496
1569
  ***
1497
1570
 
1498
- ### rightsManagementInformationSources?
1571
+ ### rightsManagementPolicyNegotiators?
1499
1572
 
1500
- > `optional` **rightsManagementInformationSources**: `string`
1573
+ > `optional` **rightsManagementPolicyNegotiators**: `string`
1501
1574
 
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.
1575
+ The rights management policy negotiators sources to add to the factory.
1504
1576
 
1505
1577
  #### Inherited from
1506
1578
 
1507
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementInformationSources`](IEngineEnvironmentVariables.md#rightsmanagementinformationsources)
1579
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyNegotiators`](IEngineEnvironmentVariables.md#rightsmanagementpolicynegotiators)
1508
1580
 
1509
1581
  ***
1510
1582
 
1511
- ### rightsManagementNegotiators?
1583
+ ### rightsManagementPolicyRequesters?
1512
1584
 
1513
- > `optional` **rightsManagementNegotiators**: `string`
1585
+ > `optional` **rightsManagementPolicyRequesters**: `string`
1514
1586
 
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.
1587
+ The rights management policy requesters to add to the factory.
1517
1588
 
1518
1589
  #### Inherited from
1519
1590
 
1520
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementNegotiators`](IEngineEnvironmentVariables.md#rightsmanagementnegotiators)
1591
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyRequesters`](IEngineEnvironmentVariables.md#rightsmanagementpolicyrequesters)
1521
1592
 
1522
1593
  ***
1523
1594
 
1524
- ### rightsManagementRequesters?
1595
+ ### rightsManagementPolicyExecutionActions?
1525
1596
 
1526
- > `optional` **rightsManagementRequesters**: `string`
1597
+ > `optional` **rightsManagementPolicyExecutionActions**: `string`
1527
1598
 
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.
1599
+ The rights management policy execution actions to add to the factory.
1530
1600
 
1531
1601
  #### Inherited from
1532
1602
 
1533
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementRequesters`](IEngineEnvironmentVariables.md#rightsmanagementrequesters)
1603
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyExecutionActions`](IEngineEnvironmentVariables.md#rightsmanagementpolicyexecutionactions)
1534
1604
 
1535
1605
  ***
1536
1606
 
1537
- ### rightsManagementExecutionActions?
1607
+ ### rightsManagementPolicyEnforcementProcessors?
1538
1608
 
1539
- > `optional` **rightsManagementExecutionActions**: `string`
1609
+ > `optional` **rightsManagementPolicyEnforcementProcessors**: `string`
1540
1610
 
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.
1611
+ The rights management policy enforcement processors to add to the factory.
1543
1612
 
1544
1613
  #### Inherited from
1545
1614
 
1546
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementExecutionActions`](IEngineEnvironmentVariables.md#rightsmanagementexecutionactions)
1615
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyEnforcementProcessors`](IEngineEnvironmentVariables.md#rightsmanagementpolicyenforcementprocessors)
1547
1616
 
1548
1617
  ***
1549
1618
 
1550
- ### rightsManagementEnforcementProcessors?
1619
+ ### rightsManagementPolicyArbiters?
1551
1620
 
1552
- > `optional` **rightsManagementEnforcementProcessors**: `string`
1621
+ > `optional` **rightsManagementPolicyArbiters**: `string`
1553
1622
 
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.
1623
+ The rights management policy arbiters to add to the factory.
1556
1624
 
1557
1625
  #### Inherited from
1558
1626
 
1559
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementEnforcementProcessors`](IEngineEnvironmentVariables.md#rightsmanagementenforcementprocessors)
1627
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyArbiters`](IEngineEnvironmentVariables.md#rightsmanagementpolicyarbiters)
1560
1628
 
1561
1629
  ***
1562
1630
 
1563
- ### rightsManagementArbiters?
1631
+ ### rightsManagementPolicyObligationEnforcers?
1564
1632
 
1565
- > `optional` **rightsManagementArbiters**: `string`
1633
+ > `optional` **rightsManagementPolicyObligationEnforcers**: `string`
1566
1634
 
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.
1635
+ The rights management policy obligation enforcers to add to the factory.
1569
1636
 
1570
1637
  #### Inherited from
1571
1638
 
1572
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementArbiters`](IEngineEnvironmentVariables.md#rightsmanagementarbiters)
1639
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyObligationEnforcers`](IEngineEnvironmentVariables.md#rightsmanagementpolicyobligationenforcers)
1573
1640
 
1574
1641
  ***
1575
1642
 
1576
- ### rightsManagementOffers?
1643
+ ### backgroundTasksEnabled?
1577
1644
 
1578
- > `optional` **rightsManagementOffers**: `string`
1645
+ > `optional` **backgroundTasksEnabled**: `string`
1579
1646
 
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.
1647
+ Are background tasks enabled, defaults to false.
1582
1648
 
1583
1649
  #### Inherited from
1584
1650
 
1585
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementOffers`](IEngineEnvironmentVariables.md#rightsmanagementoffers)
1651
+ [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`backgroundTasksEnabled`](IEngineEnvironmentVariables.md#backgroundtasksenabled)
1586
1652
 
1587
1653
  ***
1588
1654
 
@@ -1646,31 +1712,6 @@ The interval for cleaning up the activity logs.
1646
1712
 
1647
1713
  ***
1648
1714
 
1649
- ### vcAuthenticationEnabled?
1650
-
1651
- > `optional` **vcAuthenticationEnabled**: `string`
1652
-
1653
- Enable verifiable credential authentication for the API.
1654
-
1655
- #### Inherited from
1656
-
1657
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`vcAuthenticationEnabled`](IEngineEnvironmentVariables.md#vcauthenticationenabled)
1658
-
1659
- ***
1660
-
1661
- ### vcAuthenticationVerificationMethodId?
1662
-
1663
- > `optional` **vcAuthenticationVerificationMethodId**: `string`
1664
-
1665
- Verifiable credential assertion for node to node communication.
1666
- Defaults to node-authentication-assertion.
1667
-
1668
- #### Inherited from
1669
-
1670
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`vcAuthenticationVerificationMethodId`](IEngineEnvironmentVariables.md#vcauthenticationverificationmethodid)
1671
-
1672
- ***
1673
-
1674
1715
  ### extensions?
1675
1716
 
1676
1717
  > `optional` **extensions**: `string`
@@ -1731,6 +1772,14 @@ The CORS headers to expose.
1731
1772
 
1732
1773
  ***
1733
1774
 
1775
+ ### publicOrigin?
1776
+
1777
+ > `optional` **publicOrigin**: `string`
1778
+
1779
+ The public origin URL for the API e.g. https://api.example.com:1234
1780
+
1781
+ ***
1782
+
1734
1783
  ### authAdminProcessorType?
1735
1784
 
1736
1785
  > `optional` **authAdminProcessorType**: `string`
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.