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

package/docs/reference/functions/getExecutionDirectory.md

@@ -1,9 +1,17 @@
 # Function: getExecutionDirectory()
 
-> **getExecutionDirectory**(): `string`
+> **getExecutionDirectory**(`args?`): `string`
 
 Get the directory where the application is being executed.
 
+## Parameters
+
+### args?
+
+`string`[]
+
+The command line arguments.
+
 ## Returns
 
 `string`

package/docs/reference/functions/initCli.md

@@ -0,0 +1,27 @@
+# Function: initCli()
+
+> **initCli**(`processEnv`, `args?`): [`ICliCommand`](../interfaces/ICliCommand.md) \| `undefined`
+
+Initialise the CLI.
+
+## Parameters
+
+### processEnv
+
+The environment variables from the process.
+
+### args?
+
+`string`[]
+
+The command line arguments.
+
+## Returns
+
+[`ICliCommand`](../interfaces/ICliCommand.md) \| `undefined`
+
+The constructed CLI command if there is one.
+
+## Throws
+
+GeneralError if the command is missing or invalid.

package/docs/reference/functions/parseCommandLineArgs.md

@@ -0,0 +1,19 @@
+# Function: parseCommandLineArgs()
+
+> **parseCommandLineArgs**(`args?`): [`ICliArgs`](../interfaces/ICliArgs.md)
+
+Parse command line arguments.
+
+## Parameters
+
+### args?
+
+`string`[]
+
+The command line arguments.
+
+## Returns
+
+[`ICliArgs`](../interfaces/ICliArgs.md)
+
+The parsed command line arguments.

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,8 +1,8 @@
 # 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.
+Run the TWIN Node.
 
 ## Parameters
 
@@ -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.