@twin.org/identity-cli 0.0.3-next.2 → 0.0.3-next.20

package/docs/reference/classes/CLI.md

@@ -22,7 +22,7 @@ The main entry point for the CLI.
 
 ## Methods
 
-### run()
+### run() {#run}
 
 > **run**(`argv`, `localesDirectory?`, `options?`): `Promise`\<`number`\>
 

package/docs/reference/functions/actionCommandVerifiablePresentationCreate.md

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

package/docs/reference/functions/actionCommandVerifiablePresentationVerify.md

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

package/docs/reference/functions/buildCommandVerifiablePresentationCreate.md

@@ -0,0 +1,11 @@
+# Function: buildCommandVerifiablePresentationCreate()
+
+> **buildCommandVerifiablePresentationCreate**(): `Command`
+
+Build the verifiable presentation create command for the CLI.
+
+## Returns
+
+`Command`
+
+The command.

package/docs/reference/functions/buildCommandVerifiablePresentationVerify.md

@@ -0,0 +1,11 @@
+# Function: buildCommandVerifiablePresentationVerify()
+
+> **buildCommandVerifiablePresentationVerify**(): `Command`
+
+Build the verifiable presentation verify command for the CLI.
+
+## Returns
+
+`Command`
+
+The command.

package/docs/reference/index.md

@@ -39,6 +39,10 @@
 - [actionCommandVerifiableCredentialUnrevoke](functions/actionCommandVerifiableCredentialUnrevoke.md)
 - [buildCommandVerifiableCredentialVerify](functions/buildCommandVerifiableCredentialVerify.md)
 - [actionCommandVerifiableCredentialVerify](functions/actionCommandVerifiableCredentialVerify.md)
+- [buildCommandVerifiablePresentationCreate](functions/buildCommandVerifiablePresentationCreate.md)
+- [actionCommandVerifiablePresentationCreate](functions/actionCommandVerifiablePresentationCreate.md)
+- [buildCommandVerifiablePresentationVerify](functions/buildCommandVerifiablePresentationVerify.md)
+- [actionCommandVerifiablePresentationVerify](functions/actionCommandVerifiablePresentationVerify.md)
 - [buildCommandVerificationMethodAdd](functions/buildCommandVerificationMethodAdd.md)
 - [actionCommandVerificationMethodAdd](functions/actionCommandVerificationMethodAdd.md)
 - [buildCommandVerificationMethodRemove](functions/buildCommandVerificationMethodRemove.md)

package/docs/reference/variables/IdentityConnectorTypes.md

@@ -6,7 +6,7 @@ The identity connector types.
 
 ## Type Declaration
 
-### Iota
+### Iota {#iota}
 
 > `readonly` **Iota**: `"iota"` = `"iota"`
 

package/docs/reference/variables/IdentityResolverConnectorTypes.md

@@ -6,7 +6,7 @@ The identity resolver connector types.
 
 ## Type Declaration
 
-### Iota
+### Iota {#iota}
 
 > `readonly` **Iota**: `"iota"` = `"iota"`
 

package/docs/{examples.md → usage.md}

@@ -1,4 +1,6 @@
-# @twin.org/identity-cli - Examples
+# Identity CLI Usage
+
+Use this output to check available commands quickly before running identity workflows from your terminal.
 
 ## Running
 
@@ -15,7 +17,7 @@ or run directly using NPX:
 npx "@twin.org/identity-cli"
 ```
 
-Output
+## Help
 
 ```shell
 🌍 TWIN Identity v1.0.0
@@ -47,13 +49,7 @@ Commands:
   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
+## identity-create --help
 
 ```shell
 🌍 TWIN Identity v1.0.0
@@ -75,13 +71,19 @@ Options:
   -h, --help                 display help for command
 ```
 
+## Example
+
+```shell
+twin-identity identity-resolve --load-env config.env identity.env --did !DID --json did-document.json
+```
+
 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 wallet address must have sufficient funds to store the identity. The seed and the funds can be generated using the `mnemonic` and `faucet` commands.
+Use this command to create a new DID. The wallet 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
@@ -90,7 +92,7 @@ twin-identity mnemonic --env wallet.env
 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
+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.devnet.iota.cafe"
@@ -111,7 +113,7 @@ twin-identity identity-create --load-env config.env wallet.env --seed !SEED --en
 
 ### identity-resolve
 
-The identity resolve will lookup and identity by DID to check it exists and return the DID document.
+The identity resolve command looks up an 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
@@ -119,7 +121,7 @@ twin-identity identity-resolve --load-env config.env identity.env --did !DID --j
 
 ### verification-method-add
 
-This command will add a verification method to a DID document.
+This command adds 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
@@ -127,7 +129,7 @@ twin-identity verification-method-add --load-env config.env wallet.env identity.
 
 ### verification-method-remove
 
-This command will remove a verification method from a DID document.
+This command removes 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
@@ -135,15 +137,15 @@ twin-identity verification-method-remove --load-env config.env wallet.env identi
 
 ### service-add
 
-This command will add a service to a DID document.
+This command adds 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
+twin-identity service-add --load-env config.env wallet.env identity.env --seed !SEED --did !DID --id linked-domain --type LinkedDomains --endpoint https://example.org --env service.env
 ```
 
 ### service-remove
 
-This command will remove a service from the DID document.
+This command removes 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
@@ -151,7 +153,7 @@ twin-identity service-remove --load-env config.env wallet.env identity.env servi
 
 ## 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
+This command generates a verifiable credential using the specified verification method. You will need to supply the data as a json file.
 
 ```json
 {
@@ -164,11 +166,7 @@ This command will generate a verifiable credential using the specified verificat
 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
-```
+This command outputs the verifiable credential as a JSON Web Token.
 
 ## verifiable-credential-verify
 
@@ -196,17 +194,15 @@ twin-identity verifiable-credential-unrevoke --load-env config.env wallet.env id
 
 ## proof-create
 
-This command will generate a proof using the specified verification method.
+This command generates 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 --document-filename unsecured.json --json data-proof.json
 ```
 
-This will output the proof.
-
 ## proof-verify
 
-This command will verify a proof for a document.
+This command verifies a proof for a document.
 
 ```shell
 twin-identity proof-verify --load-env config.env verification-method.env --id !DID_VERIFICATION_METHOD_ID --document-filename unsecured.json --proof-filename data-proof.json

package/locales/en.json

@@ -1,6 +1,18 @@
 {
 	"error": {
 		"commands": {
+			"verifiable-presentation-create": {
+				"noCredentialsProvided": "Either --jwt or --json-ld must be provided with at least one credential.",
+				"jsonLdFileNotFound": "The JSON-LD credential file was not found."
+			},
+			"verifiable-credential-verify": {
+				"noCredentialProvided": "Either --jwt or --json-ld must be provided.",
+				"jsonLdFileNotFound": "The JSON-LD file was not found."
+			},
+			"verifiable-presentation-verify": {
+				"noPresentationProvided": "Either --jwt or --json-ld must be provided.",
+				"jsonLdFileNotFound": "The JSON-LD file was not found."
+			},
 			"verifiable-credential-create": {
 				"subjectJsonFileNotFound": "The subject JSON file was not found."
 			},
@@ -22,6 +34,10 @@
 					"param": "--seed '<'seed'>'",
 					"description": "The seed for the controller address in hex or base64 used to create the DID, or start with ! to read environment variable."
 				},
+				"controller": {
+					"param": "--controller '<'controller'>'",
+					"description": "The controller for the DID, or start with ! to read environment variable."
+				},
 				"addressIndex": {
 					"param": "--address-index '<'index'>'",
 					"description": "The address index to use for the creation."
@@ -82,6 +98,8 @@
 			"labels": {
 				"verificationMethodType": "Verification Method Type",
 				"verificationMethodId": "Verification Method Id",
+				"privateKeyBase64Url": "Private Key Base64 Url",
+				"publicKeyBase64Url": "Public Key Base64 Url",
 				"privateKeyBase64": "Private Key Base64",
 				"publicKeyBase64": "Public Key Base64",
 				"privateKeyHex": "Private Key Hex",
@@ -179,12 +197,77 @@
 				"addressIndex": "Address Index"
 			}
 		},
+		"verifiable-presentation-create": {
+			"summary": "Create a verifiable presentation.",
+			"description": "Create a verifiable presentation.",
+			"options": {
+				"verification-method-id": {
+					"param": "--verification-method-id '<'verification-method-id'>'",
+					"description": "The full verification method id including did, or start with ! to read environment variable."
+				},
+				"private-key": {
+					"param": "--private-key '<'private-key'>'",
+					"description": "The private key for the verification method id, in either hex or base64 form, or start with ! to read environment variable."
+				},
+				"presentation-id": {
+					"param": "--presentation-id '<'presentation-id'>'",
+					"description": "The presentation id which uniquely identifies the presentation."
+				},
+				"jwt": {
+					"param": "--jwt '<'jwt'>'",
+					"description": "Comma-separated list of verifiable credential JWTs to include in the presentation, or start with ! to read environment variable."
+				},
+				"json-ld": {
+					"param": "--json-ld '<'json-ld'>'",
+					"description": "Comma-separated list of JSON-LD filenames containing verifiable credentials to include in the presentation."
+				},
+				"expiration-date": {
+					"param": "--expiration-date '<'ISO Date'>'",
+					"description": "The expiration date for the presentation."
+				}
+			},
+			"progress": {
+				"creatingVerifiablePresentation": "Creating Verifiable Presentation",
+				"loadingCredentialData": "Loading Credential Data"
+			},
+			"labels": {
+				"verificationMethodId": "Verification Method Id",
+				"presentationId": "Presentation Id",
+				"jwt": "JWT Credentials",
+				"jsonLd": "JSON-LD Credentials",
+				"verifiablePresentation": "Verifiable Presentation",
+				"expirationDate": "Expiration Date"
+			}
+		},
+		"verifiable-presentation-verify": {
+			"summary": "Verify a verifiable presentation.",
+			"description": "Verify a verifiable presentation.",
+			"options": {
+				"jwt": {
+					"param": "--jwt '<'jwt'>'",
+					"description": "The verifiable presentation as a JSON web token to verify, or start with ! to read environment variable."
+				},
+				"json-ld": {
+					"param": "--json-ld '<'json-ld'>'",
+					"description": "A JSON-LD file containing the verifiable presentation to verify."
+				}
+			},
+			"progress": {
+				"verifyingPresentation": "Verifying Presentation"
+			},
+			"labels": {
+				"jwt": "JWT",
+				"jsonLd": "JSON-LD",
+				"isVerified": "Is Verified",
+				"isRevoked": "Is Revoked"
+			}
+		},
 		"verifiable-credential-create": {
 			"summary": "Create a verifiable credential.",
 			"description": "Create a verifiable credential.",
 			"options": {
-				"id": {
-					"param": "--id '<'id'>'",
+				"verification-method-id": {
+					"param": "--verification-method-id '<'verification-method-id'>'",
 					"description": "The full verification method id including did, or start with ! to read environment variable."
 				},
 				"private-key": {
@@ -203,9 +286,9 @@
 					"param": "--revocation-index '<'revocation-index'>'",
 					"description": "The revocation index in the issuing document to use if revoking the credential."
 				},
-				"addressIndex": {
-					"param": "--address-index '<'index'>'",
-					"description": "The address index to use for the identity controller."
+				"expiration-date": {
+					"param": "--expiration-date '<'ISO Date'>'",
+					"description": "The expiration date for the credential."
 				}
 			},
 			"progress": {
@@ -218,7 +301,7 @@
 				"subjectJson": "Subject JSON",
 				"revocationIndex": "Revocation Index",
 				"verifiableCredential": "Verifiable Credential",
-				"addressIndex": "Address Index"
+				"expirationDate": "Expiration Date"
 			}
 		},
 		"verifiable-credential-verify": {
@@ -228,6 +311,10 @@
 				"jwt": {
 					"param": "--jwt '<'jwt'>'",
 					"description": "The verifiable credential as a JSON web token to verify, or start with ! to read environment variable."
+				},
+				"json-ld": {
+					"param": "--json-ld '<'json-ld'>'",
+					"description": "A JSON-LD file containing the verifiable credential to verify."
 				}
 			},
 			"progress": {
@@ -235,6 +322,7 @@
 			},
 			"labels": {
 				"jwt": "JWT",
+				"jsonLd": "JSON-LD",
 				"isVerified": "Is Verified",
 				"isRevoked": "Is Revoked"
 			}
@@ -312,10 +400,6 @@
 				"document-filename": {
 					"param": "--document-filename '<'document-filename'>'",
 					"description": "The filename of a JSON-LD document to create the proof for."
-				},
-				"addressIndex": {
-					"param": "--address-index '<'index'>'",
-					"description": "The address index to use for the identity controller."
 				}
 			},
 			"progress": {
@@ -323,8 +407,7 @@
 			},
 			"labels": {
 				"documentFilename": "Document Filename",
-				"verificationMethodId": "Verification Method Id",
-				"addressIndex": "Address Index"
+				"verificationMethodId": "Verification Method Id"
 			}
 		},
 		"proof-verify": {
@@ -349,6 +432,64 @@
 				"isVerified": "Is Verified"
 			}
 		},
+		"also-known-as-add": {
+			"summary": "Add an alias (alsoKnownAs) to a DID.",
+			"description": "Add an alias (alsoKnownAs) to a DID.",
+			"options": {
+				"seed": {
+					"param": "--seed '<'seed'>'",
+					"description": "The seed for the private key for the controller address of the document in hex or base64, or start with ! to read environment variable."
+				},
+				"did": {
+					"param": "--did '<'did'>'",
+					"description": "The identifier to add the alias to, or start with ! to read environment variable."
+				},
+				"alias": {
+					"param": "--alias '<'alias'>'",
+					"description": "The alias (alsoKnownAs) value to add."
+				},
+				"addressIndex": {
+					"param": "--address-index '<'index'>'",
+					"description": "The address index to use for the identity controller."
+				}
+			},
+			"progress": {
+				"addingAlsoKnownAs": "Adding Alias (alsoKnownAs)"
+			},
+			"labels": {
+				"alias": "Alias (alsoKnownAs)",
+				"addressIndex": "Address Index"
+			}
+		},
+		"also-known-as-remove": {
+			"summary": "Remove an alias (alsoKnownAs) from a DID.",
+			"description": "Remove an alias (alsoKnownAs) from a DID.",
+			"options": {
+				"seed": {
+					"param": "--seed '<'seed'>'",
+					"description": "The seed for the private key for the controller address of the document in hex or base64, or start with ! to read environment variable."
+				},
+				"did": {
+					"param": "--did '<'did'>'",
+					"description": "The identifier to remove the alias from, or start with ! to read environment variable."
+				},
+				"alias": {
+					"param": "--alias '<'alias'>'",
+					"description": "The alias (alsoKnownAs) value to remove."
+				},
+				"addressIndex": {
+					"param": "--address-index '<'index'>'",
+					"description": "The address index to use for the identity controller."
+				}
+			},
+			"progress": {
+				"removingAlsoKnownAs": "Removing Alias (alsoKnownAs)"
+			},
+			"labels": {
+				"alias": "Alias (alsoKnownAs)",
+				"addressIndex": "Address Index"
+			}
+		},
 		"common": {
 			"options": {
 				"connector": {

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/identity-cli",
-	"version": "0.0.3-next.2",
-	"description": "A command line interface for interacting with the identity connectors",
+	"version": "0.0.3-next.20",
+	"description": "Command line tool for running identity workflows in local development and automation pipelines.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/identity.git",
@@ -21,8 +21,8 @@
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-connector-memory": "next",
-		"@twin.org/identity-connector-iota": "0.0.3-next.2",
-		"@twin.org/identity-models": "0.0.3-next.2",
+		"@twin.org/identity-connector-iota": "0.0.3-next.20",
+		"@twin.org/identity-models": "0.0.3-next.20",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next",
 		"@twin.org/vault-connector-entity-storage": "next",
@@ -31,7 +31,7 @@
 		"@twin.org/wallet-connector-iota": "next",
 		"@twin.org/wallet-models": "next",
 		"@twin.org/web": "next",
-		"commander": "14.0.2"
+		"commander": "14.0.3"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",