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

package/docs/reference/interfaces/INodeEnvironmentVariables.md

@@ -20,63 +20,63 @@ Start the engine in debug mode.
 
 ***
 
-### storageFileRoot?
+### silent?
 
-> `optional` **storageFileRoot**: `string`
+> `optional` **silent**: `string`
 
-The root directory for storing items like state file.
+Start the engine in silent mode.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`storageFileRoot`](IEngineServerEnvironmentVariables.md#storagefileroot)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`silent`](IEngineServerEnvironmentVariables.md#silent)
 
 ***
 
-### stateFilename?
+### storageFileRoot?
 
-> `optional` **stateFilename**: `string`
+> `optional` **storageFileRoot**: `string`
 
-The name of the state file.
+The root directory for storing items like state file.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`stateFilename`](IEngineServerEnvironmentVariables.md#statefilename)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`storageFileRoot`](IEngineServerEnvironmentVariables.md#storagefileroot)
 
 ***
 
-### tenantEnabled?
+### stateFilename?
 
-> `optional` **tenantEnabled**: `string`
+> `optional` **stateFilename**: `string`
 
-Is multi-tenant support enabled, defaults to false.
+The name of the state file.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`tenantEnabled`](IEngineServerEnvironmentVariables.md#tenantenabled)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`stateFilename`](IEngineServerEnvironmentVariables.md#statefilename)
 
 ***
 
-### tenantId?
+### nodeIdentityEnabled?
 
-> `optional` **tenantId**: `string`
+> `optional` **nodeIdentityEnabled**: `string`
 
-A tenant id to use as a default for the node.
+Does the node have a unique ID, defaults to true.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`tenantId`](IEngineServerEnvironmentVariables.md#tenantid)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`nodeIdentityEnabled`](IEngineServerEnvironmentVariables.md#nodeidentityenabled)
 
 ***
 
-### tenantApiKey?
+### tenantEnabled?
 
-> `optional` **tenantApiKey**: `string`
+> `optional` **tenantEnabled**: `string`
 
-A tenant api key to use as a default for the node.
+Is multi-tenant support enabled, defaults to false.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`tenantApiKey`](IEngineServerEnvironmentVariables.md#tenantapikey)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`tenantEnabled`](IEngineServerEnvironmentVariables.md#tenantenabled)
 
 ***
 
@@ -177,6 +177,18 @@ AWS Dynamo DB secret access key.
 
 ***
 
+### awsDynamodbConnectionTimeoutMs?
+
+> `optional` **awsDynamodbConnectionTimeoutMs**: `string`
+
+AWS Dynamo DB connection timeout.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbConnectionTimeoutMs`](IEngineServerEnvironmentVariables.md#awsdynamodbconnectiontimeoutms)
+
+***
+
 ### azureCosmosdbKey?
 
 > `optional` **azureCosmosdbKey**: `string`
@@ -598,19 +610,6 @@ The id of the encryption key for the blob storage.
 
 ***
 
-### blobStorageSymmetricEncryptionKey?
-
-> `optional` **blobStorageSymmetricEncryptionKey**: `string`
-
-A symmetric encryption key for the blob storage, should be ChaCha20Poly1305 in base64 format.
-If encryption is enabled but a key is not provided one will be generated.
-
-#### Inherited from
-
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageSymmetricEncryptionKey`](IEngineServerEnvironmentVariables.md#blobstoragesymmetricencryptionkey)
-
-***
-
 ### blobStoragePrefix?
 
 > `optional` **blobStoragePrefix**: `string`
@@ -803,6 +802,18 @@ The type of the default vault connector: entity-storage, hashicorp.
 
 ***
 
+### vaultPrefix?
+
+> `optional` **vaultPrefix**: `string`
+
+Prefix to prepend to entries in the vault.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`vaultPrefix`](IEngineServerEnvironmentVariables.md#vaultprefix)
+
+***
+
 ### hashicorpVaultToken?
 
 > `optional` **hashicorpVaultToken**: `string`
@@ -839,18 +850,6 @@ The type of logging task connector, can be a comma separated list: console, enti
 
 ***
 
-### backgroundTaskConnector?
-
-> `optional` **backgroundTaskConnector**: `string`
-
-The type of background task connector: entity-storage.
-
-#### Inherited from
-
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`backgroundTaskConnector`](IEngineServerEnvironmentVariables.md#backgroundtaskconnector)
-
-***
-
 ### eventBusConnector?
 
 > `optional` **eventBusConnector**: `string`
@@ -1055,6 +1054,18 @@ The type of identity connector: entity-storage, iota.
 
 ***
 
+### identityWalletAddressIndex?
+
+> `optional` **identityWalletAddressIndex**: `string`
+
+The index of the wallet address to use, defaults to 0.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`identityWalletAddressIndex`](IEngineServerEnvironmentVariables.md#identitywalletaddressindex)
+
+***
+
 ### identityResolverConnector?
 
 > `optional` **identityResolverConnector**: `string`
@@ -1443,27 +1454,77 @@ Is the federated catalogue enabled, defaults to false.
 
 ***
 
-### federatedCatalogueCacheTtlMs?
+### federatedCatalogueFilters?
+
+> `optional` **federatedCatalogueFilters**: `string`
+
+Federated catalog filters, command separated list of filters to add.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`federatedCatalogueFilters`](IEngineServerEnvironmentVariables.md#federatedcataloguefilters)
+
+***
+
+### trustEnabled?
+
+> `optional` **trustEnabled**: `string`
+
+Is the trust management enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`trustEnabled`](IEngineServerEnvironmentVariables.md#trustenabled)
+
+***
+
+### trustGenerators?
 
-> `optional` **federatedCatalogueCacheTtlMs**: `number`
+> `optional` **trustGenerators**: `string`
 
-Federated catalog TTL for the cache.
+The trust generators to add to the factory, comma separated list.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`federatedCatalogueCacheTtlMs`](IEngineServerEnvironmentVariables.md#federatedcataloguecachettlms)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`trustGenerators`](IEngineServerEnvironmentVariables.md#trustgenerators)
 
 ***
 
-### federatedCatalogueClearingHouseApproverList?
+### trustVerifiers?
 
-> `optional` **federatedCatalogueClearingHouseApproverList**: `string`
+> `optional` **trustVerifiers**: `string`
 
-Federated catalog clearing house approver list, stringified array of DIDs.
+The trust verifiers to add to the factory, comma separated list.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`federatedCatalogueClearingHouseApproverList`](IEngineServerEnvironmentVariables.md#federatedcatalogueclearinghouseapproverlist)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`trustVerifiers`](IEngineServerEnvironmentVariables.md#trustverifiers)
+
+***
+
+### trustVerificationMethodId?
+
+> `optional` **trustVerificationMethodId**: `string`
+
+The verification method to use for trust identities.
+Defaults to trust-assertion.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`trustVerificationMethodId`](IEngineServerEnvironmentVariables.md#trustverificationmethodid)
+
+***
+
+### trustJwtTtlSeconds?
+
+> `optional` **trustJwtTtlSeconds**: `string`
+
+The trust time to live for generating JWTs.
+Defaults to undefined for never expiring.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`trustJwtTtlSeconds`](IEngineServerEnvironmentVariables.md#trustjwtttlseconds)
 
 ***
 
@@ -1479,106 +1540,111 @@ Is the rights management enabled, defaults to false.
 
 ***
 
-### rightsManagementBaseCallbackUrl?
+### rightsManagementCallbackPath?
+
+> `optional` **rightsManagementCallbackPath**: `string`
+
+What is the callback path for rights management negotiations, will be combined with hosting public url e.g. /callback.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementCallbackPath`](IEngineServerEnvironmentVariables.md#rightsmanagementcallbackpath)
+
+***
+
+### rightsManagementPolicyInformationSources?
 
-> `optional` **rightsManagementBaseCallbackUrl**: `string`
+> `optional` **rightsManagementPolicyInformationSources**: `string`
 
-What is the base callback url for rights management negotiations e.g. https://my-node/rights-management.
+The rights management policy information sources to add to the factory.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementBaseCallbackUrl`](IEngineServerEnvironmentVariables.md#rightsmanagementbasecallbackurl)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementPolicyInformationSources`](IEngineServerEnvironmentVariables.md#rightsmanagementpolicyinformationsources)
 
 ***
 
-### rightsManagementInformationSources?
+### rightsManagementPolicyNegotiators?
 
-> `optional` **rightsManagementInformationSources**: `string`
+> `optional` **rightsManagementPolicyNegotiators**: `string`
 
-The rights management configuration which includes the information sources modules to load.
-Use the @json: prefix to specify the path to the JSON configuration file.
+The rights management policy negotiators sources to add to the factory.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementInformationSources`](IEngineServerEnvironmentVariables.md#rightsmanagementinformationsources)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementPolicyNegotiators`](IEngineServerEnvironmentVariables.md#rightsmanagementpolicynegotiators)
 
 ***
 
-### rightsManagementNegotiators?
+### rightsManagementPolicyRequesters?
 
-> `optional` **rightsManagementNegotiators**: `string`
+> `optional` **rightsManagementPolicyRequesters**: `string`
 
-The rights management configuration which includes the negotiator modules to load.
-Use the @json: prefix to specify the path to the JSON configuration file.
+The rights management policy requesters to add to the factory.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementNegotiators`](IEngineServerEnvironmentVariables.md#rightsmanagementnegotiators)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementPolicyRequesters`](IEngineServerEnvironmentVariables.md#rightsmanagementpolicyrequesters)
 
 ***
 
-### rightsManagementRequesters?
+### rightsManagementPolicyExecutionActions?
 
-> `optional` **rightsManagementRequesters**: `string`
+> `optional` **rightsManagementPolicyExecutionActions**: `string`
 
-The rights management configuration which includes the requester modules to load.
-Use the @json: prefix to specify the path to the JSON configuration file.
+The rights management policy execution actions to add to the factory.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementRequesters`](IEngineServerEnvironmentVariables.md#rightsmanagementrequesters)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementPolicyExecutionActions`](IEngineServerEnvironmentVariables.md#rightsmanagementpolicyexecutionactions)
 
 ***
 
-### rightsManagementExecutionActions?
+### rightsManagementPolicyEnforcementProcessors?
 
-> `optional` **rightsManagementExecutionActions**: `string`
+> `optional` **rightsManagementPolicyEnforcementProcessors**: `string`
 
-The rights management configuration which includes the execution actions modules to load.
-Use the @json: prefix to specify the path to the JSON configuration file.
+The rights management policy enforcement processors to add to the factory.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementExecutionActions`](IEngineServerEnvironmentVariables.md#rightsmanagementexecutionactions)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementPolicyEnforcementProcessors`](IEngineServerEnvironmentVariables.md#rightsmanagementpolicyenforcementprocessors)
 
 ***
 
-### rightsManagementEnforcementProcessors?
+### rightsManagementPolicyArbiters?
 
-> `optional` **rightsManagementEnforcementProcessors**: `string`
+> `optional` **rightsManagementPolicyArbiters**: `string`
 
-The rights management configuration which includes the enforcement processor modules to load.
-Use the @json: prefix to specify the path to the JSON configuration file.
+The rights management policy arbiters to add to the factory.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementEnforcementProcessors`](IEngineServerEnvironmentVariables.md#rightsmanagementenforcementprocessors)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementPolicyArbiters`](IEngineServerEnvironmentVariables.md#rightsmanagementpolicyarbiters)
 
 ***
 
-### rightsManagementArbiters?
+### rightsManagementPolicyObligationEnforcers?
 
-> `optional` **rightsManagementArbiters**: `string`
+> `optional` **rightsManagementPolicyObligationEnforcers**: `string`
 
-The rights management configuration which includes the arbiter modules to load.
-Use the @json: prefix to specify the path to the JSON configuration file.
+The rights management policy obligation enforcers to add to the factory.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementArbiters`](IEngineServerEnvironmentVariables.md#rightsmanagementarbiters)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementPolicyObligationEnforcers`](IEngineServerEnvironmentVariables.md#rightsmanagementpolicyobligationenforcers)
 
 ***
 
-### rightsManagementOffers?
+### backgroundTasksEnabled?
 
-> `optional` **rightsManagementOffers**: `string`
+> `optional` **backgroundTasksEnabled**: `string`
 
-The rights management configuration which includes the offer modules to load.
-Use the @json: prefix to specify the path to the JSON configuration file.
+Are background tasks enabled, defaults to false.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementOffers`](IEngineServerEnvironmentVariables.md#rightsmanagementoffers)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`backgroundTasksEnabled`](IEngineServerEnvironmentVariables.md#backgroundtasksenabled)
 
 ***
 
@@ -1642,31 +1708,6 @@ The interval for cleaning up the activity logs.
 
 ***
 
-### vcAuthenticationEnabled?
-
-> `optional` **vcAuthenticationEnabled**: `string`
-
-Enable verifiable credential authentication for the API.
-
-#### Inherited from
-
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`vcAuthenticationEnabled`](IEngineServerEnvironmentVariables.md#vcauthenticationenabled)
-
-***
-
-### vcAuthenticationVerificationMethodId?
-
-> `optional` **vcAuthenticationVerificationMethodId**: `string`
-
-Verifiable credential assertion for node to node communication.
-Defaults to node-authentication-assertion.
-
-#### Inherited from
-
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`vcAuthenticationVerificationMethodId`](IEngineServerEnvironmentVariables.md#vcauthenticationverificationmethodid)
-
-***
-
 ### extensions?
 
 > `optional` **extensions**: `string`
@@ -1751,6 +1792,18 @@ The CORS headers to expose.
 
 ***
 
+### publicOrigin?
+
+> `optional` **publicOrigin**: `string`
+
+The public origin URL for the API e.g. https://api.example.com:1234
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`publicOrigin`](IEngineServerEnvironmentVariables.md#publicorigin)
+
+***
+
 ### authAdminProcessorType?
 
 > `optional` **authAdminProcessorType**: `string`
@@ -1835,90 +1888,6 @@ List of properties to obfuscate in the REST logging output, comma separated.
 
 ***
 
-### features?
-
-> `optional` **features**: `string`
-
-The features that are enabled on the node.
-
-#### Default
-
-```ts
-[]
-```
-
-***
-
-### nodeIdentity?
-
-> `optional` **nodeIdentity**: `string`
-
-The identity of the node which, if empty and node-identity feature is enabled it will be generated.
-
-***
-
-### nodeMnemonic?
-
-> `optional` **nodeMnemonic**: `string`
-
-The mnemonic for the identity, if empty and node-identity feature is enabled it will be randomly generated.
-
-***
-
-### organizationIdentity?
-
-> `optional` **organizationIdentity**: `string`
-
-If the node-admin-user feature is enabled, this will be the organization of the user, if one is not provided it will be generated
-
-***
-
-### organizationMnemonic?
-
-> `optional` **organizationMnemonic**: `string`
-
-The mnemonic for the organization, if empty and node-admin-user feature is enabled it will be randomly generated.
-
-***
-
-### adminUserIdentity?
-
-> `optional` **adminUserIdentity**: `string`
-
-If the node-admin-user feature is enabled, this will be the identity of the user, if one is not provided it will be generated
-
-***
-
-### adminUserMnemonic?
-
-> `optional` **adminUserMnemonic**: `string`
-
-The mnemonic for the admin user, if empty and node-admin-user feature is enabled it will be randomly generated.
-
-***
-
-### adminUserName?
-
-> `optional` **adminUserName**: `string`
-
-If the node-admin-user feature is enabled, this will be the name of the user.
-
-#### Default
-
-```ts
-admin@node
-```
-
-***
-
-### adminUserPassword?
-
-> `optional` **adminUserPassword**: `string`
-
-If the node-admin-user feature is enabled, this will be the password of the user, if empty it will be randomly generated.
-
-***
-
 ### extensionsMaxSizeMb?
 
 > `optional` **extensionsMaxSizeMb**: `number`

package/docs/reference/interfaces/INodeOptions.md

@@ -8,12 +8,12 @@ The options when running the node.
 
 > `optional` **serverName**: `string`
 
-The name of the server, defaults to "TWIN Node Server".
+The name of the server, defaults to "TWIN Node".
 
 #### Default
 
 ```ts
-"TWIN Node Server"
+"TWIN Node"
 ```
 
 ***
@@ -73,6 +73,14 @@ This will be merged with any configuration loaded from the environment variables
 
 ***
 
+### scriptDirectory?
+
+> `optional` **scriptDirectory**: `string`
+
+The directory to override the script location, defaults to location of index.js.
+
+***
+
 ### executionDirectory?
 
 > `optional` **executionDirectory**: `string`

package/docs/reference/type-aliases/CliCommandParamType.md

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

package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_DID.md

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

package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_TENANT.md

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

package/docs/reference/variables/TRUST_VERIFICATION_METHOD_ID.md

@@ -0,0 +1,3 @@
+# Variable: TRUST\_VERIFICATION\_METHOD\_ID
+
+> `const` **TRUST\_VERIFICATION\_METHOD\_ID**: `"trust-assertion"` = `"trust-assertion"`