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

package/docs/reference/functions/processEnvOptions.md

@@ -0,0 +1,27 @@
+# Function: processEnvOptions()
+
+> **processEnvOptions**(`processEnv`, `options`): `void`
+
+Load the env files and process the options.
+
+## Parameters
+
+### processEnv
+
+The environment variables from the process.
+
+### options
+
+`object`[]
+
+The options.
+
+## Returns
+
+`void`
+
+The processed parameters.
+
+## Throws
+
+GeneralError if an env file has errors.

package/docs/reference/functions/registerCommands.md

@@ -0,0 +1,9 @@
+# Function: registerCommands()
+
+> **registerCommands**(): `void`
+
+Register available CLI commands.
+
+## Returns
+
+`void`

package/docs/reference/functions/run.md

@@ -1,6 +1,6 @@
 # Function: run()
 
-> **run**(`nodeOptions?`): `Promise`\<\{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \} \| `undefined`\>
+> **run**(`nodeOptions?`, `args?`): `Promise`\<\{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \} \| `undefined`\>
 
 Run the TWIN Node server.
 
@@ -12,6 +12,12 @@ Run the TWIN Node server.
 
 Optional configuration options for running the server.
 
+### args?
+
+`string`[]
+
+Optional command line arguments.
+
 ## Returns
 
 `Promise`\<\{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \} \| `undefined`\>

package/docs/reference/functions/start.md

@@ -1,6 +1,6 @@
 # Function: start()
 
-> **start**(`nodeOptions`, `nodeEngineConfig`, `envVars`, `contextIdKeys?`): `Promise`\<\{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \} \| `undefined`\>
+> **start**(`nodeOptions`, `nodeEngineConfig`, `envVars`, `cliCommand?`, `availableContextIdKeys?`): `Promise`\<\{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \} \| `undefined`\>
 
 Start the engine server.
 
@@ -24,11 +24,17 @@ The configuration for the engine server.
 
 The environment variables.
 
-### contextIdKeys?
+### cliCommand?
 
-`string`[]
+[`ICliCommand`](../interfaces/ICliCommand.md)
 
-The context ID keys.
+The constructed CLI command (optional).
+
+### availableContextIdKeys?
+
+`object`[]
+
+The context ID keys available for operation.
 
 ## Returns
 

package/docs/reference/functions/substituteEnvOptions.md

@@ -0,0 +1,25 @@
+# Function: substituteEnvOptions()
+
+> **substituteEnvOptions**(`processEnv`, `options`): `void`
+
+Process options and replace any env variables with their values.
+
+## Parameters
+
+### processEnv
+
+The environment variables from the process.
+
+### options
+
+`object`[]
+
+The options.
+
+## Returns
+
+`void`
+
+## Throws
+
+GeneralError if an env variable is missing.

package/docs/reference/index.md

@@ -3,6 +3,10 @@
 ## Interfaces
 
 - [ICacheMetadata](interfaces/ICacheMetadata.md)
+- [ICliArgs](interfaces/ICliArgs.md)
+- [ICliCommand](interfaces/ICliCommand.md)
+- [ICliCommandDefinition](interfaces/ICliCommandDefinition.md)
+- [ICliCommandDefinitionParam](interfaces/ICliCommandDefinitionParam.md)
 - [IEngineEnvironmentVariables](interfaces/IEngineEnvironmentVariables.md)
 - [IEngineServerEnvironmentVariables](interfaces/IEngineServerEnvironmentVariables.md)
 - [IModuleProtocol](interfaces/IModuleProtocol.md)
@@ -14,12 +18,12 @@
 
 ## Type Aliases
 
+- [CliCommandParamType](type-aliases/CliCommandParamType.md)
 - [ModuleProtocol](type-aliases/ModuleProtocol.md)
 - [NodeExtensionInitialiseMethod](type-aliases/NodeExtensionInitialiseMethod.md)
 - [NodeExtensionInitialiseEngineMethod](type-aliases/NodeExtensionInitialiseEngineMethod.md)
 - [NodeExtensionInitialiseEngineServerMethod](type-aliases/NodeExtensionInitialiseEngineServerMethod.md)
 - [NodeExtensionShutdownMethod](type-aliases/NodeExtensionShutdownMethod.md)
-- [NodeFeatures](type-aliases/NodeFeatures.md)
 
 ## Variables
 
@@ -29,26 +33,26 @@
 - [SYNCHRONISED\_STORAGE\_BLOB\_STORAGE\_ENCRYPTION\_KEY\_ID](variables/SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID.md)
 - [VC\_AUTHENTICATION\_VERIFICATION\_METHOD\_ID](variables/VC_AUTHENTICATION_VERIFICATION_METHOD_ID.md)
 - [AUTH\_SIGNING\_KEY\_ID](variables/AUTH_SIGNING_KEY_ID.md)
+- [CONTEXT\_ID\_HANDLER\_FEATURE\_DID](variables/CONTEXT_ID_HANDLER_FEATURE_DID.md)
+- [CONTEXT\_ID\_HANDLER\_FEATURE\_TENANT](variables/CONTEXT_ID_HANDLER_FEATURE_TENANT.md)
 - [ModuleProtocol](variables/ModuleProtocol.md)
-- [NodeFeatures](variables/NodeFeatures.md)
 
 ## Functions
 
-- [bootstrap](functions/bootstrap.md)
-- [bootstrapContextIdHandlers](functions/bootstrapContextIdHandlers.md)
-- [bootstrapNodeId](functions/bootstrapNodeId.md)
-- [bootstrapTenantId](functions/bootstrapTenantId.md)
-- [bootstrapNodeAdminUser](functions/bootstrapNodeAdminUser.md)
-- [bootstrapImmutableProofMethod](functions/bootstrapImmutableProofMethod.md)
-- [bootstrapBlobEncryption](functions/bootstrapBlobEncryption.md)
-- [bootstrapAuth](functions/bootstrapAuth.md)
-- [bootstrapSynchronisedStorage](functions/bootstrapSynchronisedStorage.md)
 - [buildEngineConfiguration](functions/buildEngineConfiguration.md)
 - [buildEngineServerConfiguration](functions/buildEngineServerConfiguration.md)
 - [extensionsConfiguration](functions/extensionsConfiguration.md)
 - [extensionsInitialiseEngine](functions/extensionsInitialiseEngine.md)
 - [extensionsInitialiseEngineServer](functions/extensionsInitialiseEngineServer.md)
 - [shutdownExtensions](functions/shutdownExtensions.md)
+- [initCli](functions/initCli.md)
+- [parseCommandLineArgs](functions/parseCommandLineArgs.md)
+- [constructCliCommand](functions/constructCliCommand.md)
+- [executeCommand](functions/executeCommand.md)
+- [processEnvOptions](functions/processEnvOptions.md)
+- [substituteEnvOptions](functions/substituteEnvOptions.md)
+- [registerCommands](functions/registerCommands.md)
+- [getEnvDefaults](functions/getEnvDefaults.md)
 - [run](functions/run.md)
 - [buildConfiguration](functions/buildConfiguration.md)
 - [overrideModuleImport](functions/overrideModuleImport.md)
@@ -61,7 +65,6 @@
 - [getFiles](functions/getFiles.md)
 - [loadTextFile](functions/loadTextFile.md)
 - [loadJsonFile](functions/loadJsonFile.md)
-- [getFeatures](functions/getFeatures.md)
 - [parseModuleProtocol](functions/parseModuleProtocol.md)
 - [hashUrl](functions/hashUrl.md)
 - [getExtensionsCacheDir](functions/getExtensionsCacheDir.md)

package/docs/reference/interfaces/ICliArgs.md

@@ -0,0 +1,35 @@
+# Interface: ICliArgs
+
+Command to execute in the CLI.
+
+## Properties
+
+### nodePath?
+
+> `optional` **nodePath**: `string`
+
+The path of the node executable.
+
+***
+
+### scriptPath?
+
+> `optional` **scriptPath**: `string`
+
+The path of the script to execute.
+
+***
+
+### options?
+
+> `optional` **options**: `object`[]
+
+The command line options.
+
+#### key
+
+> **key**: `string`
+
+#### value
+
+> **value**: `string`

package/docs/reference/interfaces/ICliCommand.md

@@ -0,0 +1,23 @@
+# Interface: ICliCommand
+
+Command to execute in the CLI.
+
+## Properties
+
+### definition
+
+> **definition**: [`ICliCommandDefinition`](ICliCommandDefinition.md)
+
+The command to execute.
+
+***
+
+### params
+
+> **params**: `object`
+
+The params to execute the command with.
+
+#### Index Signature
+
+\[`id`: `string`\]: [`CliCommandParamType`](../type-aliases/CliCommandParamType.md)

package/docs/reference/interfaces/ICliCommandDefinition.md

@@ -0,0 +1,101 @@
+# Interface: ICliCommandDefinition
+
+Command to execute in the CLI.
+
+## Properties
+
+### command
+
+> **command**: `string`
+
+The command name.
+
+***
+
+### description
+
+> **description**: `string`
+
+The command description.
+
+***
+
+### example
+
+> **example**: `string`
+
+The example.
+
+***
+
+### params
+
+> **params**: [`ICliCommandDefinitionParam`](ICliCommandDefinitionParam.md)[]
+
+The params available for the command.
+
+***
+
+### action()
+
+> **action**: (`engineCore`, `envVars`, `params`) => `Promise`\<`unknown`\>
+
+The method to execute for the command.
+
+#### Parameters
+
+##### engineCore
+
+`IEngineCore`
+
+##### envVars
+
+[`INodeEnvironmentVariables`](INodeEnvironmentVariables.md)
+
+##### params
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+***
+
+### requiresEngineStarted?
+
+> `optional` **requiresEngineStarted**: `boolean`
+
+Indicates whether the engine needs to be started before executing the command.
+
+#### Default
+
+```ts
+true
+```
+
+***
+
+### requiresNodeIdentity?
+
+> `optional` **requiresNodeIdentity**: `boolean`
+
+Indicates whether the engine needs the node identity to be set if configured to use.
+
+#### Default
+
+```ts
+true
+```
+
+***
+
+### requiresTenantId?
+
+> `optional` **requiresTenantId**: `boolean`
+
+Indicates whether the engine needs the tenant id to be set if configured to use.
+
+#### Default
+
+```ts
+true
+```

package/docs/reference/interfaces/ICliCommandDefinitionParam.md

@@ -0,0 +1,65 @@
+# Interface: ICliCommandDefinitionParam
+
+Command param to execute in the CLI.
+
+## Properties
+
+### key
+
+> **key**: `string`
+
+The param key.
+
+***
+
+### type
+
+> **type**: `"string"` \| `"number"` \| `"boolean"`
+
+The param type.
+
+***
+
+### options?
+
+> `optional` **options**: `string`[]
+
+Possible options for the param.
+
+***
+
+### extendedType?
+
+> `optional` **extendedType**: `string`
+
+The extended type e.g. hex etc.
+
+***
+
+### required?
+
+> `optional` **required**: `boolean`
+
+Whether the param is required.
+
+#### Default
+
+```ts
+true
+```
+
+***
+
+### defaultValue?
+
+> `optional` **defaultValue**: [`CliCommandParamType`](../type-aliases/CliCommandParamType.md)
+
+The default value of the param.
+
+***
+
+### description
+
+> **description**: `string`
+
+The param description.

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -16,6 +16,14 @@ Start the engine in debug mode.
 
 ***
 
+### silent?
+
+> `optional` **silent**: `string`
+
+Start the engine in silent mode.
+
+***
+
 ### storageFileRoot?
 
 > `optional` **storageFileRoot**: `string`
@@ -32,27 +40,19 @@ The name of the state file.
 
 ***
 
-### tenantEnabled?
+### nodeIdentityEnabled?
 
-> `optional` **tenantEnabled**: `string`
+> `optional` **nodeIdentityEnabled**: `string`
 
-Is multi-tenant support enabled, defaults to false.
+Does the node have a unique ID, defaults to true.
 
 ***
 
-### tenantId?
-
-> `optional` **tenantId**: `string`
-
-A tenant id to use as a default for the node.
-
-***
-
-### 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.
 
 ***
 
@@ -121,6 +121,14 @@ AWS Dynamo DB secret access key.
 
 ***
 
+### awsDynamodbConnectionTimeoutMs?
+
+> `optional` **awsDynamodbConnectionTimeoutMs**: `string`
+
+AWS Dynamo DB connection timeout.
+
+***
+
 ### azureCosmosdbKey?
 
 > `optional` **azureCosmosdbKey**: `string`
@@ -402,15 +410,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.
-
-***
-
 ### blobStoragePrefix?
 
 > `optional` **blobStoragePrefix**: `string`
@@ -563,14 +562,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.
-
-***
-
 ### eventBusConnector?
 
 > `optional` **eventBusConnector**: `string`
@@ -707,6 +698,14 @@ The type of identity connector: entity-storage, iota.
 
 ***
 
+### identityWalletAddressIndex?
+
+> `optional` **identityWalletAddressIndex**: `string`
+
+The index of the wallet address to use, defaults to 0.
+
+***
+
 ### identityResolverConnector?
 
 > `optional` **identityResolverConnector**: `string`
@@ -975,19 +974,44 @@ Is the federated catalogue enabled, defaults to false.
 
 ***
 
-### federatedCatalogueCacheTtlMs?
+### federatedCatalogueFilters?
+
+> `optional` **federatedCatalogueFilters**: `string`
+
+Federated catalog filters, command separated list of filters to add.
+
+***
+
+### trustEnabled?
+
+> `optional` **trustEnabled**: `string`
+
+Is the trust management enabled, defaults to false.
+
+***
+
+### trustGenerators?
+
+> `optional` **trustGenerators**: `string`
+
+The trust generators to add to the factory, comma separated list.
+
+***
+
+### trustVerifiers?
 
-> `optional` **federatedCatalogueCacheTtlMs**: `number`
+> `optional` **trustVerifiers**: `string`
 
-Federated catalog TTL for the cache.
+The trust verifiers to add to the factory, comma separated list.
 
 ***
 
-### federatedCatalogueClearingHouseApproverList?
+### trustVerificationMethodId?
 
-> `optional` **federatedCatalogueClearingHouseApproverList**: `string`
+> `optional` **trustVerificationMethodId**: `string`
 
-Federated catalog clearing house approver list, stringified array of DIDs.
+The verification method to use for trust identities.
+Defaults to node-authentication-assertion.
 
 ***
 
@@ -1007,66 +1031,67 @@ What is the base callback url for rights management negotiations e.g. https://my
 
 ***
 
-### rightsManagementInformationSources?
+### rightsManagementPolicyInformationSources?
+
+> `optional` **rightsManagementPolicyInformationSources**: `string`
+
+The rights management policy information sources to add to the factory.
+
+***
+
+### 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.
 
 ***
 
-### 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.
 
 ***
 
-### 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.
 
 ***
 
-### 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.
 
 ***
 
-### 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.
 
 ***
 
-### rightsManagementArbiters?
+### rightsManagementDataAccessHandlers?
 
-> `optional` **rightsManagementArbiters**: `string`
+> `optional` **rightsManagementDataAccessHandlers**: `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 data access handlers to add to the factory.
 
 ***
 
-### 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.
 
 ***