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

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

@@ -2,7 +2,12 @@
 
 ## Interfaces
 
+- [IBootstrapLegacyEnvironmentVariables](interfaces/IBootstrapLegacyEnvironmentVariables.md)
 - [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,55 +19,62 @@
 
 ## Type Aliases
 
+- [IEnvironmentVariables](type-aliases/IEnvironmentVariables.md)
+- [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)
+- [NodeExtensionInitialiseMethod](type-aliases/NodeExtensionInitialiseMethod.md)
 - [NodeExtensionShutdownMethod](type-aliases/NodeExtensionShutdownMethod.md)
-- [NodeFeatures](type-aliases/NodeFeatures.md)
 
 ## Variables
 
 - [ATTESTATION\_VERIFICATION\_METHOD\_ID](variables/ATTESTATION_VERIFICATION_METHOD_ID.md)
 - [IMMUTABLE\_PROOF\_VERIFICATION\_METHOD\_ID](variables/IMMUTABLE_PROOF_VERIFICATION_METHOD_ID.md)
 - [BLOB\_STORAGE\_ENCRYPTION\_KEY\_ID](variables/BLOB_STORAGE_ENCRYPTION_KEY_ID.md)
-- [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)
+- [TRUST\_VERIFICATION\_METHOD\_ID](variables/TRUST_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)
-- [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)
+- [isTrustRequired](functions/isTrustRequired.md)
+- [isBackgroundTasksRequired](functions/isBackgroundTasksRequired.md)
+- [isImmutableProofRequired](functions/isImmutableProofRequired.md)
+- [isFederatedCatalogueRequired](functions/isFederatedCatalogueRequired.md)
+- [isRightsManagementRequired](functions/isRightsManagementRequired.md)
+- [isTaskSchedulerRequired](functions/isTaskSchedulerRequired.md)
+- [isAutomationRequired](functions/isAutomationRequired.md)
+- [isTelemetryRequired](functions/isTelemetryRequired.md)
 - [buildEngineServerConfiguration](functions/buildEngineServerConfiguration.md)
+- [isAuthEntityStorageRequired](functions/isAuthEntityStorageRequired.md)
 - [extensionsConfiguration](functions/extensionsConfiguration.md)
 - [extensionsInitialiseEngine](functions/extensionsInitialiseEngine.md)
 - [extensionsInitialiseEngineServer](functions/extensionsInitialiseEngineServer.md)
 - [shutdownExtensions](functions/shutdownExtensions.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)
 - [start](functions/start.md)
 - [initialiseLocales](functions/initialiseLocales.md)
 - [getExecutionDirectory](functions/getExecutionDirectory.md)
+- [getScriptDirectory](functions/getScriptDirectory.md)
 - [fileExists](functions/fileExists.md)
 - [directoryExists](functions/directoryExists.md)
 - [getSubFolders](functions/getSubFolders.md)
 - [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/IBootstrapLegacyEnvironmentVariables.md

@@ -0,0 +1,117 @@
+# Interface: IBootstrapLegacyEnvironmentVariables
+
+The environment variables for the bootstrap legacy.
+
+## Properties
+
+### features? {#features}
+
+> `optional` **features?**: `string`
+
+The features that are enabled on the node.
+
+#### Default
+
+```ts
+[]
+```
+
+***
+
+### nodeIdentity? {#nodeidentity}
+
+> `optional` **nodeIdentity?**: `string`
+
+The identity of the node which, if empty and node-identity feature is enabled it will be generated.
+
+***
+
+### nodeMnemonic? {#nodemnemonic}
+
+> `optional` **nodeMnemonic?**: `string`
+
+The mnemonic for the node identity, if empty it will be randomly generated.
+
+***
+
+### tenantId? {#tenantid}
+
+> `optional` **tenantId?**: `string`
+
+A tenant id to use as a default for the node.
+
+***
+
+### tenantApiKey? {#tenantapikey}
+
+> `optional` **tenantApiKey?**: `string`
+
+A tenant api key to use as a default for the node.
+
+***
+
+### organizationIdentity? {#organizationidentity}
+
+> `optional` **organizationIdentity?**: `string`
+
+The organisation identity. If not provided it will be generated.
+
+***
+
+### organizationMnemonic? {#organizationmnemonic}
+
+> `optional` **organizationMnemonic?**: `string`
+
+The mnemonic for the organisation identity, if empty it will be randomly generated.
+
+***
+
+### adminUserIdentity? {#adminuseridentity}
+
+> `optional` **adminUserIdentity?**: `string`
+
+If the admin-user feature is enabled, this will be the identity of the user. If not provided it will be generated.
+
+***
+
+### adminUserMnemonic? {#adminusermnemonic}
+
+> `optional` **adminUserMnemonic?**: `string`
+
+The mnemonic for the admin user, if empty it will be randomly generated.
+
+***
+
+### adminUserName? {#adminusername}
+
+> `optional` **adminUserName?**: `string`
+
+If the admin-user feature is enabled, this will be the name of the user.
+
+#### Default
+
+```ts
+admin@node
+```
+
+***
+
+### adminUserPassword? {#adminuserpassword}
+
+> `optional` **adminUserPassword?**: `string`
+
+If the admin-user feature is enabled, this will be the password of the user. If empty it will be randomly generated.
+
+***
+
+### adminUserScope? {#adminuserscope}
+
+> `optional` **adminUserScope?**: `string`
+
+If the admin-user feature is enabled, this is a comma-separated list of scopes for the user.
+
+#### Default
+
+```ts
+tenant-admin,user-admin (when tenant enabled) or user-admin (when tenant disabled)
+```

package/docs/reference/interfaces/ICacheMetadata.md

@@ -4,7 +4,7 @@ Metadata for cached HTTPS extensions.
 
 ## Properties
 
-### downloadedAt
+### downloadedAt {#downloadedat}
 
 > **downloadedAt**: `number`
 
@@ -12,7 +12,7 @@ Timestamp when the file was downloaded.
 
 ***
 
-### url
+### url {#url}
 
 > **url**: `string`
 
@@ -20,7 +20,7 @@ Original URL of the cached file.
 
 ***
 
-### size
+### size {#size}
 
 > **size**: `number`
 

package/docs/reference/interfaces/ICliArgs.md

@@ -0,0 +1,35 @@
+# Interface: ICliArgs
+
+Parsed command line arguments passed to the CLI.
+
+## Properties
+
+### nodePath? {#nodepath}
+
+> `optional` **nodePath?**: `string`
+
+The path of the node executable.
+
+***
+
+### scriptPath? {#scriptpath}
+
+> `optional` **scriptPath?**: `string`
+
+The path of the script to execute.
+
+***
+
+### options? {#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
+
+A resolved CLI command ready for execution, pairing a definition with its populated parameters.
+
+## Properties
+
+### definition {#definition}
+
+> **definition**: [`ICliCommandDefinition`](ICliCommandDefinition.md)
+
+The command to execute.
+
+***
+
+### params {#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
+
+Static definition of a CLI command including its name, parameters, and execution action.
+
+## Properties
+
+### command {#command}
+
+> **command**: `string`
+
+The command name.
+
+***
+
+### description {#description}
+
+> **description**: `string`
+
+The command description.
+
+***
+
+### example {#example}
+
+> **example**: `string`
+
+An example invocation string shown in help output.
+
+***
+
+### params {#params}
+
+> **params**: [`ICliCommandDefinitionParam`](ICliCommandDefinitionParam.md)[]
+
+The params available for the command.
+
+***
+
+### action {#action}
+
+> **action**: (`engineCore`, `envVars`, `params`) => `Promise`\<`unknown`\>
+
+The method to execute for the command.
+
+#### Parameters
+
+##### engineCore
+
+`IEngineCore`
+
+##### envVars
+
+[`IEnvironmentVariables`](../type-aliases/IEnvironmentVariables.md)
+
+##### params
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+***
+
+### requiresEngineStarted? {#requiresenginestarted}
+
+> `optional` **requiresEngineStarted?**: `boolean`
+
+Indicates whether the engine needs to be started before executing the command.
+
+#### Default
+
+```ts
+true
+```
+
+***
+
+### requiresNodeIdentity? {#requiresnodeidentity}
+
+> `optional` **requiresNodeIdentity?**: `boolean`
+
+Indicates whether the engine needs the node identity to be set if configured to use.
+
+#### Default
+
+```ts
+true
+```
+
+***
+
+### requiresOrgIdentity? {#requiresorgidentity}
+
+> `optional` **requiresOrgIdentity?**: `boolean`
+
+Indicates whether the engine needs the organization identity to be set.
+
+#### Default
+
+```ts
+true
+```

package/docs/reference/interfaces/ICliCommandDefinitionParam.md

@@ -0,0 +1,65 @@
+# Interface: ICliCommandDefinitionParam
+
+Definition of a single parameter accepted by a CLI command.
+
+## Properties
+
+### key {#key}
+
+> **key**: `string`
+
+The param key.
+
+***
+
+### type {#type}
+
+> **type**: `"string"` \| `"number"` \| `"boolean"`
+
+The param type.
+
+***
+
+### options? {#options}
+
+> `optional` **options?**: `string`[]
+
+Possible options for the param.
+
+***
+
+### extendedType? {#extendedtype}
+
+> `optional` **extendedType?**: `string`
+
+The extended type e.g. hex etc.
+
+***
+
+### required? {#required}
+
+> `optional` **required?**: `boolean`
+
+Whether the param is required.
+
+#### Default
+
+```ts
+true
+```
+
+***
+
+### defaultValue? {#defaultvalue}
+
+> `optional` **defaultValue?**: [`CliCommandParamType`](../type-aliases/CliCommandParamType.md)
+
+The default value of the param.
+
+***
+
+### description {#description}
+
+> **description**: `string`
+
+The param description.