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

package/locales/en.json

@@ -0,0 +1,336 @@
+{
+	"error": {
+		"commands": {
+			"verifiable-credential-create": {
+				"subjectJsonFileNotFound": "The subject JSON file was not found."
+			}
+		}
+	},
+	"commands": {
+		"identity-create": {
+			"summary": "Create a Decentralized Identifier (DID).",
+			"description": "Creates a Decentralized Identifier (DID).",
+			"options": {
+				"seed": {
+					"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."
+				}
+			},
+			"progress": {
+				"creatingIdentity": "Creating identity"
+			},
+			"labels": {
+				"identity": "Identity"
+			}
+		},
+		"identity-resolve": {
+			"summary": "Resolve a Decentralized Identifier (DID).",
+			"description": "Resolve a Decentralized Identifier (DID).",
+			"options": {
+				"did": {
+					"param": "--did '<'did'>'",
+					"description": "The identifier to resolve, or start with ! to read environment variable."
+				}
+			},
+			"progress": {
+				"resolvingIdentity": "Resolving identity"
+			},
+			"labels": {
+				"didDocument": "DID Document"
+			}
+		},
+		"verification-method-add": {
+			"summary": "Add a verification method to a DID.",
+			"description": "Add a verification method 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 verification method to, or start with ! to read environment variable."
+				},
+				"type": {
+					"param": "--type '<'type'>'",
+					"description": "The type of verification method to add."
+				},
+				"id": {
+					"param": "--id '<'id'>'",
+					"description": "The optional id of verification method to add, if not provided one will be generated."
+				}
+			},
+			"progress": {
+				"addingVerificationMethod": "Adding Verification Method"
+			},
+			"labels": {
+				"verificationMethodType": "Verification Method Type",
+				"verificationMethodId": "Verification Method Id",
+				"privateKey": "Private Key",
+				"publicKey": "Public Key"
+			}
+		},
+		"verification-method-remove": {
+			"summary": "Remove a verification method from a DID.",
+			"description": "Remove a verification method 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 verification method from, or start with ! to read environment variable."
+				},
+				"id": {
+					"param": "--id '<'id'>'",
+					"description": "The id of verification method to remove."
+				}
+			},
+			"progress": {
+				"removingVerificationMethod": "Removing Verification Method"
+			},
+			"labels": {
+				"verificationMethodId": "Verification Method Id"
+			}
+		},
+		"service-add": {
+			"summary": "Add a service to a DID.",
+			"description": "Add a service 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 service to, or start with ! to read environment variable."
+				},
+				"id": {
+					"param": "--id '<'id'>'",
+					"description": "The id of service to add, if not provided one will be generated."
+				},
+				"type": {
+					"param": "--type '<'type'>'",
+					"description": "The type of service to add."
+				},
+				"endpoint": {
+					"param": "--endpoint '<'endpoint'>'",
+					"description": "The service endpoint to add."
+				}
+			},
+			"progress": {
+				"addingService": "Adding Service"
+			},
+			"labels": {
+				"serviceId": "Service Id",
+				"serviceType": "Service Type",
+				"serviceEndpoint": "Service Endpoint"
+			}
+		},
+		"service-remove": {
+			"summary": "Remove a service from a DID.",
+			"description": "Remove a service 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."
+				},
+				"id": {
+					"param": "--id '<'id'>'",
+					"description": "The id of service to remove."
+				}
+			},
+			"progress": {
+				"removingService": "Removing Service"
+			},
+			"labels": {
+				"serviceId": "Service Id"
+			}
+		},
+		"verifiable-credential-create": {
+			"summary": "Create a verifiable credential.",
+			"description": "Create a verifiable credential.",
+			"options": {
+				"id": {
+					"param": "--id '<'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."
+				},
+				"credential-id": {
+					"param": "--credential-id '<'credential-id'>'",
+					"description": "The credential id which uniquely identifies the credential."
+				},
+				"types": {
+					"param": "--types [types...]",
+					"description": "The list of types to include in the verifiable credential."
+				},
+				"subject-json": {
+					"param": "--subject-json '<'subject-json'>'",
+					"description": "A JSON file to read which includes the data for the verifiable credential."
+				},
+				"contexts": {
+					"param": "--contexts [contexts...]",
+					"description": "The list of contexts to include in the verifiable credential."
+				},
+				"revocation-index": {
+					"param": "--revocation-index '<'revocation-index'>'",
+					"description": "The revocation index in the issuing document to use if revoking the credential."
+				}
+			},
+			"progress": {
+				"creatingVerifiableCredential": "Creating Verifiable Credential",
+				"loadingSubjectData": "Loading Subject Data"
+			},
+			"labels": {
+				"verificationMethodId": "Verification Method Id",
+				"credentialId": "Credential Id",
+				"types": "Types",
+				"contexts": "Contexts",
+				"subjectJson": "Subject JSON",
+				"revocationIndex": "Revocation Index",
+				"verifiableCredential": "Verifiable Credential"
+			}
+		},
+		"verifiable-credential-verify": {
+			"summary": "Verify a verifiable credential.",
+			"description": "Verify a verifiable credential.",
+			"options": {
+				"jwt": {
+					"param": "--jwt '<'jwt'>'",
+					"description": "The verifiable credential as a JSON web token to verify, or start with ! to read environment variable."
+				}
+			},
+			"progress": {
+				"verifyingCredential": "Verifying Credential"
+			},
+			"labels": {
+				"jwt": "JWT",
+				"isVerified": "Is Verified",
+				"isRevoked": "Is Revoked"
+			}
+		},
+		"verifiable-credential-revoke": {
+			"summary": "Revoke a verifiable credential.",
+			"description": "Revoke a verifiable credential.",
+			"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 did of the document to revoke the index from, or start with ! to read environment variable."
+				},
+				"revocation-index": {
+					"param": "--revocation-index '<'revocation-index'>'",
+					"description": "The revocation index of the credential revoke."
+				}
+			},
+			"progress": {
+				"revokingCredential": "Revoking Credential Index"
+			},
+			"labels": {
+				"revocationIndex": "Revocation Index"
+			}
+		},
+		"verifiable-credential-unrevoke": {
+			"summary": "Unrevoke a verifiable credential.",
+			"description": "Unrevoke a verifiable credential.",
+			"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 did of the document to unrevoke the index from, or start with ! to read environment variable."
+				},
+				"revocation-index": {
+					"param": "--revocation-index '<'revocation-index'>'",
+					"description": "The revocation index of the credential unrevoke."
+				}
+			},
+			"progress": {
+				"unrevokingCredential": "Unrevoking Credential Index"
+			},
+			"labels": {
+				"revocationIndex": "Revocation Index"
+			}
+		},
+		"proof-create": {
+			"summary": "Create a proof for some data using a verification method.",
+			"description": "Create a proof for some data using a verification method.",
+			"options": {
+				"id": {
+					"param": "--id '<'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."
+				},
+				"data": {
+					"param": "--data '<'data'>'",
+					"description": "The base64 or hex encoded data to create the proof for, or start with ! to read environment variable."
+				}
+			},
+			"progress": {
+				"creatingProof": "Creating Proof"
+			},
+			"labels": {
+				"verificationMethodId": "Verification Method Id",
+				"type": "Proof Type",
+				"value": "Proof Value"
+			}
+		},
+		"proof-verify": {
+			"summary": "Verify a proof for some data using a verification method.",
+			"description": "Verify a proof for some data using a verification method.",
+			"options": {
+				"id": {
+					"param": "--id '<'id'>'",
+					"description": "The full verification method id including did, or start with ! to read environment variable."
+				},
+				"data": {
+					"param": "--data '<'data'>'",
+					"description": "The base64 or hex encoded data to verify the proof for, or start with ! to read environment variable."
+				},
+				"type": {
+					"param": "--type '<'type'>'",
+					"description": "The type of the proof, or start with ! to read environment variable."
+				},
+				"value": {
+					"param": "--value '<'value'>'",
+					"description": "The base64 or hex encoded data to use for verifying the proof, or start with ! to read environment variable."
+				}
+			},
+			"progress": {
+				"verifyingProof": "Verifying Proof"
+			},
+			"labels": {
+				"verificationMethodId": "Verification Method Id",
+				"type": "Proof Type",
+				"value": "Proof Value",
+				"isVerified": "Is Verified"
+			}
+		},
+		"common": {
+			"options": {
+				"node": {
+					"param": "--node '<'url'>'",
+					"description": "The url for the node endpoint, or an environment variable name containing the url."
+				}
+			},
+			"labels": {
+				"did": "DID",
+				"node": "Node",
+				"explorer": "Explorer",
+				"explore": "Explore"
+			}
+		}
+	}
+}

package/package.json

@@ -0,0 +1,86 @@
+{
+	"name": "@twin.org/identity-cli",
+	"version": "0.0.1-next.3",
+	"description": "A command line interface for interacting with the identity connectors",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/identity.git",
+		"directory": "packages/identity-cli"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"scripts": {
+		"clean": "rimraf dist coverage",
+		"build": "tspc",
+		"merge-locales": "merge-locales",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
+		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
+		"bundle": "npm run bundle:esm && npm run bundle:cjs",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs": "npm run docs:clean && npm run docs:generate",
+		"dist": "npm run clean && npm run build && npm run merge-locales && npm run test && npm run bundle && npm run docs"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/crypto": "next",
+		"@twin.org/cli-core": "next",
+		"@twin.org/crypto-cli": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/entity-storage-connector-memory": "next",
+		"@twin.org/identity-models": "0.0.1-next.3",
+		"@twin.org/identity-connector-iota": "0.0.1-next.3",
+		"@twin.org/nameof": "next",
+		"@twin.org/standards-w3c-did": "next",
+		"@twin.org/vault-connector-entity-storage": "next",
+		"@twin.org/vault-models": "next",
+		"@twin.org/wallet-cli": "next",
+		"@twin.org/wallet-connector-iota": "next",
+		"@twin.org/wallet-models": "next",
+		"@iota/sdk-wasm": "1.1.3",
+		"commander": "12.1.0"
+	},
+	"devDependencies": {
+		"@twin.org/merge-locales": "next",
+		"@twin.org/nameof-transformer": "next",
+		"@types/node": "22.5.5",
+		"@vitest/coverage-v8": "2.1.1",
+		"copyfiles": "2.4.1",
+		"rimraf": "6.0.1",
+		"rollup": "4.22.0",
+		"rollup-plugin-typescript2": "0.36.0",
+		"ts-patch": "3.2.1",
+		"typedoc": "0.26.7",
+		"typedoc-plugin-markdown": "4.2.7",
+		"typescript": "5.6.2",
+		"vitest": "2.1.1"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		}
+	},
+	"files": [
+		"bin",
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"dist/locales",
+		"locales",
+		"docs"
+	],
+	"bin": {
+		"twin-identity": "bin/index.js"
+	}
+}