@twin.org/identity-cli 0.0.1-next.3

package/dist/types/cli.d.ts

@@ -0,0 +1,13 @@
+import { CLIBase } from "@twin.org/cli-core";
+/**
+ * The main entry point for the CLI.
+ */
+export declare class CLI extends CLIBase {
+    /**
+     * Run the app.
+     * @param argv The process arguments.
+     * @param localesDirectory The directory for the locales, default to relative to the script.
+     * @returns The exit code.
+     */
+    run(argv: string[], localesDirectory?: string): Promise<number>;
+}

package/dist/types/commands/identityCreate.d.ts

@@ -0,0 +1,19 @@
+import { type CliOutputOptions } from "@twin.org/cli-core";
+import { Command } from "commander";
+/**
+ * Build the identity create command for the CLI.
+ * @returns The command.
+ */
+export declare function buildCommandIdentityCreate(): Command;
+/**
+ * Action the identity create command.
+ * @param opts The options for the command.
+ * @param opts.seed The private key for the controller.
+ * @param opts.node The node URL.
+ * @param opts.explorer The explorer URL.
+ */
+export declare function actionCommandIdentityCreate(opts: {
+    seed: string;
+    node: string;
+    explorer: string;
+} & CliOutputOptions): Promise<void>;

package/dist/types/commands/identityResolve.d.ts

@@ -0,0 +1,19 @@
+import { type CliOutputOptions } from "@twin.org/cli-core";
+import { Command } from "commander";
+/**
+ * Build the identity resolve command for the CLI.
+ * @returns The command.
+ */
+export declare function buildCommandIdentityResolve(): Command;
+/**
+ * Action the identity resolve command.
+ * @param opts The options for the command.
+ * @param opts.did The identity to resolve.
+ * @param opts.node The node URL.
+ * @param opts.explorer The explorer URL.
+ */
+export declare function actionCommandIdentityResolve(opts: {
+    did: string;
+    node: string;
+    explorer: string;
+} & CliOutputOptions): Promise<void>;

package/dist/types/commands/proofCreate.d.ts

@@ -0,0 +1,21 @@
+import { type CliOutputOptions } from "@twin.org/cli-core";
+import { Command } from "commander";
+/**
+ * Build the proof create command for the CLI.
+ * @returns The command.
+ */
+export declare function buildCommandProofCreate(): Command;
+/**
+ * Action the proof create command.
+ * @param opts The options for the command.
+ * @param opts.id The id of the verification method to use for the credential.
+ * @param opts.privateKey The private key for the verification method.
+ * @param opts.data The data to create the proof for.
+ * @param opts.node The node URL.
+ */
+export declare function actionCommandProofCreate(opts: {
+    id: string;
+    privateKey: string;
+    data: string;
+    node: string;
+} & CliOutputOptions): Promise<void>;

package/dist/types/commands/proofVerify.d.ts

@@ -0,0 +1,23 @@
+import { type CliOutputOptions } from "@twin.org/cli-core";
+import { Command } from "commander";
+/**
+ * Build the proof verify command for the CLI.
+ * @returns The command.
+ */
+export declare function buildCommandProofVerify(): Command;
+/**
+ * Action the proof verify command.
+ * @param opts The options for the command.
+ * @param opts.id The id of the verification method to use for the credential.
+ * @param opts.data The data to verify the proof for.
+ * @param opts.type The type of the proof.
+ * @param opts.value The proof value.
+ * @param opts.node The node URL.
+ */
+export declare function actionCommandProofVerify(opts: {
+    id: string;
+    data: string;
+    type: string;
+    value: string;
+    node: string;
+} & CliOutputOptions): Promise<void>;

package/dist/types/commands/serviceAdd.d.ts

@@ -0,0 +1,27 @@
+import { type CliOutputOptions } from "@twin.org/cli-core";
+import { Command } from "commander";
+/**
+ * Build the service add command for the CLI.
+ * @returns The command.
+ */
+export declare function buildCommandServiceAdd(): Command;
+/**
+ * Action the service add command.
+ * @param opts The options for the command.
+ * @param opts.seed The private key for the controller.
+ * @param opts.did The identity of the document to add to.
+ * @param opts.id The id of the service to add.
+ * @param opts.type The type of the service to add.
+ * @param opts.endpoint The service endpoint.
+ * @param opts.node The node URL.
+ * @param opts.explorer The explorer URL.
+ */
+export declare function actionCommandServiceAdd(opts: {
+    seed: string;
+    did: string;
+    id: string;
+    type: string;
+    endpoint: string;
+    node: string;
+    explorer: string;
+} & CliOutputOptions): Promise<void>;

package/dist/types/commands/serviceRemove.d.ts

@@ -0,0 +1,20 @@
+import { Command } from "commander";
+/**
+ * Build the service remove command for the CLI.
+ * @returns The command.
+ */
+export declare function buildCommandServiceRemove(): Command;
+/**
+ * Action the service remove command.
+ * @param opts The options for the command.
+ * @param opts.seed The private key for the controller.
+ * @param opts.id The id of the service to remove.
+ * @param opts.node The node URL.
+ * @param opts.explorer The explorer URL.
+ */
+export declare function actionCommandServiceRemove(opts: {
+    seed: string;
+    id: string;
+    node: string;
+    explorer: string;
+}): Promise<void>;

package/dist/types/commands/setupCommands.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Setup the vault for use in the CLI commands.
+ */
+export declare function setupVault(): void;

package/dist/types/commands/verifiableCredentialCreate.d.ts

@@ -0,0 +1,29 @@
+import { type CliOutputOptions } from "@twin.org/cli-core";
+import { Command } from "commander";
+/**
+ * Build the verifiable credential create command for the CLI.
+ * @returns The command.
+ */
+export declare function buildCommandVerifiableCredentialCreate(): Command;
+/**
+ * Action the verifiable credential create command.
+ * @param opts The options for the command.
+ * @param opts.id The id of the verification method to use for the credential.
+ * @param opts.privateKey The private key for the verification method.
+ * @param opts.credentialId The id of the credential.
+ * @param opts.types The types for the credential.
+ * @param opts.subjectJson The JSON data for the subject.
+ * @param opts.contexts The contexts for the credential.
+ * @param opts.revocationIndex The revocation index for the credential.
+ * @param opts.node The node URL.
+ */
+export declare function actionCommandVerifiableCredentialCreate(opts: {
+    id: string;
+    privateKey: string;
+    credentialId?: string;
+    types?: string[];
+    subjectJson: string;
+    contexts?: string[];
+    revocationIndex?: string;
+    node: string;
+} & CliOutputOptions): Promise<void>;

package/dist/types/commands/verifiableCredentialRevoke.d.ts

@@ -0,0 +1,20 @@
+import { Command } from "commander";
+/**
+ * Build the verifiable credential revoke command for the CLI.
+ * @returns The command.
+ */
+export declare function buildCommandVerifiableCredentialRevoke(): Command;
+/**
+ * Action the verifiable credential revoke command.
+ * @param opts The options for the command.
+ * @param opts.seed The seed to generate the private key for the controller.
+ * @param opts.did The id of the document to revoke the index.
+ * @param opts.revocationIndex The revocation index for the credential.
+ * @param opts.node The node URL.
+ */
+export declare function actionCommandVerifiableCredentialRevoke(opts: {
+    seed: string;
+    did: string;
+    revocationIndex: string;
+    node: string;
+}): Promise<void>;

package/dist/types/commands/verifiableCredentialUnrevoke.d.ts

@@ -0,0 +1,20 @@
+import { Command } from "commander";
+/**
+ * Build the verifiable credential unrevoke command for the CLI.
+ * @returns The command.
+ */
+export declare function buildCommandVerifiableCredentialUnrevoke(): Command;
+/**
+ * Action the verifiable credential unrevoke command.
+ * @param opts The options for the command.
+ * @param opts.seed The seed to generate the private key for the controller.
+ * @param opts.did The id of the document to unrevoke the index.
+ * @param opts.revocationIndex The revocation index for the credential.
+ * @param opts.node The node URL.
+ */
+export declare function actionCommandVerifiableCredentialUnrevoke(opts: {
+    seed: string;
+    did: string;
+    revocationIndex: string;
+    node: string;
+}): Promise<void>;

package/dist/types/commands/verifiableCredentialVerify.d.ts

@@ -0,0 +1,17 @@
+import { type CliOutputOptions } from "@twin.org/cli-core";
+import { Command } from "commander";
+/**
+ * Build the verifiable credential verify command for the CLI.
+ * @returns The command.
+ */
+export declare function buildCommandVerifiableCredentialVerify(): Command;
+/**
+ * Action the verifiable credential verify command.
+ * @param opts The options for the command.
+ * @param opts.jwt The JSON web token for the verifiable credential.
+ * @param opts.node The node URL.
+ */
+export declare function actionCommandVerifiableCredentialVerify(opts: {
+    jwt: string;
+    node: string;
+} & CliOutputOptions): Promise<void>;

package/dist/types/commands/verificationMethodAdd.d.ts

@@ -0,0 +1,26 @@
+import { type CliOutputOptions } from "@twin.org/cli-core";
+import { DidVerificationMethodType } from "@twin.org/standards-w3c-did";
+import { Command } from "commander";
+/**
+ * Build the verification method add command for the CLI.
+ * @returns The command.
+ */
+export declare function buildCommandVerificationMethodAdd(): Command;
+/**
+ * Action the verification method add command.
+ * @param opts The options for the command.
+ * @param opts.seed The private key for the controller.
+ * @param opts.did The identity of the document to add to.
+ * @param opts.type The type of the verification method to add.
+ * @param opts.id The id of the verification method to add.
+ * @param opts.node The node URL.
+ * @param opts.explorer The explorer URL.
+ */
+export declare function actionCommandVerificationMethodAdd(opts: {
+    seed: string;
+    did: string;
+    type: DidVerificationMethodType;
+    id?: string;
+    node: string;
+    explorer: string;
+} & CliOutputOptions): Promise<void>;

package/dist/types/commands/verificationMethodRemove.d.ts

@@ -0,0 +1,20 @@
+import { Command } from "commander";
+/**
+ * Build the verification method remove command for the CLI.
+ * @returns The command.
+ */
+export declare function buildCommandVerificationMethodRemove(): Command;
+/**
+ * Action the verification method remove command.
+ * @param opts The options for the command.
+ * @param opts.seed The private key for the controller.
+ * @param opts.id The id of the verification method to remove.
+ * @param opts.node The node URL.
+ * @param opts.explorer The explorer URL.
+ */
+export declare function actionCommandVerificationMethodRemove(opts: {
+    seed: string;
+    id: string;
+    node: string;
+    explorer: string;
+}): Promise<void>;

package/dist/types/index.d.ts

@@ -0,0 +1,13 @@
+export * from "./cli";
+export * from "./commands/identityCreate";
+export * from "./commands/identityResolve";
+export * from "./commands/proofCreate";
+export * from "./commands/proofVerify";
+export * from "./commands/serviceAdd";
+export * from "./commands/serviceRemove";
+export * from "./commands/verifiableCredentialCreate";
+export * from "./commands/verifiableCredentialRevoke";
+export * from "./commands/verifiableCredentialUnrevoke";
+export * from "./commands/verifiableCredentialVerify";
+export * from "./commands/verificationMethodAdd";
+export * from "./commands/verificationMethodRemove";

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/identity-cli - Changelog
+
+## v0.0.1-next.3
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1,210 @@
+# @twin.org/identity-cli - Examples
+
+## Command Line Tool
+
+First install the tool with the following script.
+
+```shell
+npm install @twin.org/identity-cli
+```
+
+Running the tool with no commands will provide help for all the commands. By issuing the following command you should see the result.
+
+```shell
+twin-identity
+```
+
+Output
+
+```shell
+🌍 TWIN Identity v1.0.0
+
+Usage: twin-identity [command]
+
+Options:
+  -V, --version                             output the version number
+  --lang <lang>                             The language to display the output in. (default: "en")
+  --load-env [env...]                       Load the env files to initialise any environment variables.
+  -h, --help                                display help for command
+
+Commands:
+  mnemonic [options]                        Create a mnemonic.
+  address [options]                         Create bech32 addresses and keys from the seed.
+  faucet [options]                          Request funds from the faucet.
+  transfer [options]                        Transfer funds from one address to another.
+  identity-create [options]                 Create a Decentralized Identifier (DID).
+  identity-resolve [options]                Resolve a Decentralized Identifier (DID).
+  verification-method-add [options]         Add a verification method to a DID.
+  verification-method-remove [options]      Remove a verification method from a DID.
+  service-add [options]                     Add a service to a DID.
+  service-remove [options]                  Remove a service from a DID.
+  verifiable-credential-create [options]    Create a verifiable credential.
+  verifiable-credential-verify [options]    Verify a verifiable credential.
+  verifiable-credential-revoke [options]    Revoke a verifiable credential.
+  verifiable-credential-unrevoke [options]  Unrevoke a verifiable credential.
+  proof-create [options]                    Create a proof for some data using a verification method.
+  proof-verify [options]                    Verify a proof for some data using a verification method.
+```
+
+You can get further detail on the sub commands by using the help option for the individual commands.
+
+```shell
+twin-identity identity-create --help
+```
+
+Output
+
+```shell
+🌍 TWIN Identity v1.0.0
+
+Usage: twin-identity identity-create [options]
+
+Creates a Decentralized Identifier (DID).
+
+Options:
+  --seed <seed>              The seed for the controller address in hex or base64 used to create the DID, or start with ! to read environment variable.
+  --controller <controller>  The address which controls the identity in bech32 format, or start with ! to read environment variable.
+  --no-console               Hides the output in the console.
+  --json <filename>          Creates a JSON file containing the output.
+  --merge-json               If the JSON file already exists merge the data instead of overwriting.
+  --env <filename>           Creates an env file containing the output.
+  --merge-env                If the env file already exists merge the data instead of overwriting.
+  --node <url>               The url for the node endpoint, or an environment variable name containing the url. (default: "!NODE_URL")
+  --explorer <url>           The url for the explorer endpoint, or an environment variable name containing the url. (default: "!EXPLORER_URL")
+  -h, --help                 display help for command
+```
+
+The commands `mnemonic`, `address`, `faucet` and `transfer` are described in more detail in the examples for `crypto-cli` and `wallet-cli`.
+
+## Command
+
+### identity-create
+
+Use this command to create a new DID, the controller address must have sufficient funds to store the identity. The seed and the funds can be generated using the `mnemonic` and `faucet` commands.
+
+```shell
+# Generate a seed and mnemonic and store it in the env file
+twin-identity mnemonic --env wallet.env
+# Generate an address and store it in the env file
+twin-identity address --load-env wallet.env --hrp tst --seed !SEED --count 4 --env wallet.env --merge-env
+```
+
+To run this on the IOTA testnet you will need an env file with the following settings. Store the following config as config.env
+
+```shell
+NODE_URL="https://api.testnet.iotaledger.net"
+FAUCET_URL="https://faucet.testnet.iotaledger.net/api/enqueue"
+EXPLORER_URL="https://explorer.iota.org/iota-testnet/"
+```
+
+To then request some funds and generate the identity you can issue the following commands:
+
+```shell
+# Fund the controller address from the faucet loading the config and wallet env files
+twin-identity faucet --load-env config.env wallet.env --address !ADDRESS_0_BECH32
+# Create an identity
+twin-identity identity-create --load-env config.env wallet.env --seed !SEED --controller !ADDRESS_0_BECH32 --env identity.env
+```
+
+### identity-resolve
+
+The identity resolve will lookup and identity by DID to check it exists and return the DID document.
+
+```shell
+twin-identity identity-resolve --load-env config.env identity.env --did !DID --json did-document.json
+```
+
+### verification-method-add
+
+This command will add a verification method to a DID document.
+
+```shell
+twin-identity verification-method-add --load-env config.env wallet.env identity.env --seed !SEED --did !DID --type verificationMethod --env verification-method.env
+```
+
+### verification-method-remove
+
+This command will remove a verification method from a DID document.
+
+```shell
+twin-identity verification-method-remove --load-env config.env wallet.env identity.env verification-method.env --seed !SEED  --id !DID_VERIFICATION_METHOD_ID
+```
+
+### service-add
+
+This command will add a service to a DID document.
+
+```shell
+twin-identity service-add --load-env config.env wallet.env identity.env --seed !SEED --did !DID --id linked-domain --type LinkedDomains --endpoint https://www.twindev.org --env service.env
+```
+
+### service-remove
+
+This command will remove a service from the DID document.
+
+```shell
+twin-identity service-remove --load-env config.env wallet.env identity.env service.env --seed !SEED --did !DID --id !DID_SERVICE_ID
+```
+
+## verifiable-credential-create
+
+This command will generate a verifiable credential using the specified verification method. You will need to supply the data as a json file
+
+```json
+{
+  "name": "Alice",
+  "degreeName": "Bachelor of Science and Arts"
+}
+```
+
+```shell
+twin-identity verifiable-credential-create --load-env config.env verification-method.env --id !DID_VERIFICATION_METHOD_ID --private-key !DID_VERIFICATION_METHOD_PRIVATE_KEY --credential-id https://example.edu/credentials/3732 --types UniversityDegreeCredential --subject-json subject.json --env vc.env --revocation-index 0
+```
+
+This will output the verifiable credential as a JSON Web Token e.g.
+
+```shell
+eyJraWQiOiJkaWQ6aW90YTp0c3Q6MHgxZTQ3YWQ0MjY4YWI5ZWNhNTFkYTkwNmRkNzE4MDIxZmJkNGYyZGUxYmU5NjA4NmRjMTMzZDQ0MmIwYjk3MzIyI2V5em9GMHFEUmtSQ0FlU1Rmdjd6WWFQNU00U2c2TkJLQUZ6eElhQVBTQzAiLCJ0eXAiOiJKV1QiLCJhbGciOiJFZERTQSJ9.eyJpc3MiOiJkaWQ6aW90YTp0c3Q6MHgxZTQ3YWQ0MjY4YWI5ZWNhNTFkYTkwNmRkNzE4MDIxZmJkNGYyZGUxYmU5NjA4NmRjMTMzZDQ0MmIwYjk3MzIyIiwibmJmIjoxNzE4MTk3NDA5LCJqdGkiOiJodHRwczovL2V4YW1wbGUuZWR1L2NyZWRlbnRpYWxzLzM3MzIiLCJ2YyI6eyJAY29udGV4dCI6Imh0dHBzOi8vd3d3LnczLm9yZy8yMDE4L2NyZWRlbnRpYWxzL3YxIiwidHlwZSI6WyJWZXJpZmlhYmxlQ3JlZGVudGlhbCIsIlVuaXZlcnNpdHlEZWdyZWVDcmVkZW50aWFsIl0sImNyZWRlbnRpYWxTdWJqZWN0Ijp7ImRlZ3JlZU5hbWUiOiJCYWNoZWxvciBvZiBTY2llbmNlIGFuZCBBcnRzIiwibmFtZSI6IkFsaWNlIn0sImNyZWRlbnRpYWxTdGF0dXMiOnsiaWQiOiJkaWQ6aW90YTp0c3Q6MHgxZTQ3YWQ0MjY4YWI5ZWNhNTFkYTkwNmRkNzE4MDIxZmJkNGYyZGUxYmU5NjA4NmRjMTMzZDQ0MmIwYjk3MzIyI3Jldm9jYXRpb24iLCJ0eXBlIjoiUmV2b2NhdGlvbkJpdG1hcDIwMjIiLCJyZXZvY2F0aW9uQml0bWFwSW5kZXgiOiIwIn19fQ.O3tMQ1UdGSI2qv9ia3xiT1yTmvpnJKd749POMSy42-SWTWN99HyYr5SEVIDj5cLdCORRP3Se4O7wxPe7_tfmCw
+```
+
+## verifiable-credential-verify
+
+You can verify a verifiable credential stored as a JWT using this command.
+
+```shell
+twin-identity verifiable-credential-verify --load-env config.env vc.env --jwt !DID_VERIFIABLE_CREDENTIAL_JWT
+```
+
+## verifiable-credential-revoke
+
+You can revoke a verifiable credential by revoking the index on the generating document.
+
+```shell
+twin-identity verifiable-credential-revoke --load-env config.env wallet.env identity.env --seed !SEED --did !DID --revocation-index 5
+```
+
+## verifiable-credential-unrevoke
+
+You can unrevoke a verifiable credential by revoking the index on the generating document.
+
+```shell
+twin-identity verifiable-credential-unrevoke --load-env config.env wallet.env identity.env --seed !SEED --did !DID --revocation-index 5
+```
+
+## proof-create
+
+This command will generate a proof using the specified verification method.
+
+```shell
+twin-identity proof-create --load-env config.env verification-method.env --id !DID_VERIFICATION_METHOD_ID --private-key !DID_VERIFICATION_METHOD_PRIVATE_KEY --data aGVsbG8gd29ybGQ=
+```
+
+This will output the proof as a set of data containing the type and a value in base64.
+
+## proof-verify
+
+This command will verify a proof using the specified verification method.
+
+```shell
+twin-identity proof-verify --load-env config.env verification-method.env --id !DID_VERIFICATION_METHOD_ID --data aGVsbG8gd29ybGQ= --type Ed25519 --value lrPdZ+Gfgc8w/ha2YU7hil8s+gykFHAdmIEdJdraWeRkkb8nHHF1PLKs4gGPXCT1mqBIwiwOgz5V0JKIg00UDg==
+```

package/docs/reference/classes/CLI.md

@@ -0,0 +1,45 @@
+# Class: CLI
+
+The main entry point for the CLI.
+
+## Extends
+
+- `CLIBase`
+
+## Constructors
+
+### new CLI()
+
+> **new CLI**(): [`CLI`](CLI.md)
+
+#### Returns
+
+[`CLI`](CLI.md)
+
+#### Inherited from
+
+`CLIBase.constructor`
+
+## Methods
+
+### run()
+
+> **run**(`argv`, `localesDirectory`?): `Promise`\<`number`\>
+
+Run the app.
+
+#### Parameters
+
+• **argv**: `string`[]
+
+The process arguments.
+
+• **localesDirectory?**: `string`
+
+The directory for the locales, default to relative to the script.
+
+#### Returns
+
+`Promise`\<`number`\>
+
+The exit code.

package/docs/reference/functions/actionCommandIdentityCreate.md

@@ -0,0 +1,15 @@
+# Function: actionCommandIdentityCreate()
+
+> **actionCommandIdentityCreate**(`opts`): `Promise`\<`void`\>
+
+Action the identity create command.
+
+## Parameters
+
+• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
+
+The options for the command.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/actionCommandIdentityResolve.md

@@ -0,0 +1,15 @@
+# Function: actionCommandIdentityResolve()
+
+> **actionCommandIdentityResolve**(`opts`): `Promise`\<`void`\>
+
+Action the identity resolve command.
+
+## Parameters
+
+• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
+
+The options for the command.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/actionCommandProofCreate.md

@@ -0,0 +1,15 @@
+# Function: actionCommandProofCreate()
+
+> **actionCommandProofCreate**(`opts`): `Promise`\<`void`\>
+
+Action the proof create command.
+
+## Parameters
+
+• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
+
+The options for the command.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/actionCommandProofVerify.md

@@ -0,0 +1,15 @@
+# Function: actionCommandProofVerify()
+
+> **actionCommandProofVerify**(`opts`): `Promise`\<`void`\>
+
+Action the proof verify command.
+
+## Parameters
+
+• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
+
+The options for the command.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/actionCommandServiceAdd.md

@@ -0,0 +1,15 @@
+# Function: actionCommandServiceAdd()
+
+> **actionCommandServiceAdd**(`opts`): `Promise`\<`void`\>
+
+Action the service add command.
+
+## Parameters
+
+• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
+
+The options for the command.
+
+## Returns
+
+`Promise`\<`void`\>