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

package/dist/cjs/index.cjs

@@ -557,8 +557,6 @@ function buildCommandVerifiableCredentialCreate() {
         .requiredOption(core.I18n.formatMessage("commands.verifiable-credential-create.options.id.param"), core.I18n.formatMessage("commands.verifiable-credential-create.options.id.description"))
         .requiredOption(core.I18n.formatMessage("commands.verifiable-credential-create.options.private-key.param"), core.I18n.formatMessage("commands.verifiable-credential-create.options.private-key.description"))
         .option(core.I18n.formatMessage("commands.verifiable-credential-create.options.credential-id.param"), core.I18n.formatMessage("commands.verifiable-credential-create.options.credential-id.description"))
-        .option(core.I18n.formatMessage("commands.verifiable-credential-create.options.types.param"), core.I18n.formatMessage("commands.verifiable-credential-create.options.types.description"))
-        .option(core.I18n.formatMessage("commands.verifiable-credential-create.options.contexts.param"), core.I18n.formatMessage("commands.verifiable-credential-create.options.contexts.description"))
         .requiredOption(core.I18n.formatMessage("commands.verifiable-credential-create.options.subject-json.param"), core.I18n.formatMessage("commands.verifiable-credential-create.options.subject-json.description"))
         .option(core.I18n.formatMessage("commands.verifiable-credential-create.options.revocation-index.param"), core.I18n.formatMessage("commands.verifiable-credential-create.options.revocation-index.description"));
     cliCore.CLIOptions.output(command, {
@@ -579,35 +577,19 @@ function buildCommandVerifiableCredentialCreate() {
  * @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.
  */
 async function actionCommandVerifiableCredentialCreate(opts) {
-    if (!core.Is.undefined(opts.types)) {
-        core.Guards.arrayValue("commands", "types", opts.types);
-    }
-    if (!core.Is.undefined(opts.contexts)) {
-        core.Guards.arrayValue("commands", "contexts", opts.contexts);
-    }
     const id = cliCore.CLIParam.stringValue("id", opts.id);
     const privateKey = cliCore.CLIParam.hexBase64("private-key", opts.privateKey);
     const credentialId = cliCore.CLIParam.stringValue("credential-id", opts.credentialId);
-    const types = opts.types;
-    const contexts = opts.contexts;
     const subjectJson = path.resolve(cliCore.CLIParam.stringValue("subject-json", opts.subjectJson));
     const revocationIndex = core.Coerce.number(opts.revocationIndex);
     const nodeEndpoint = cliCore.CLIParam.url("node", opts.node);
     cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.verifiable-credential-create.labels.verificationMethodId"), id);
     cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.verifiable-credential-create.labels.credentialId"), credentialId);
-    if (core.Is.arrayValue(types)) {
-        cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.verifiable-credential-create.labels.types"), types.join(","));
-    }
-    if (core.Is.arrayValue(contexts)) {
-        cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.verifiable-credential-create.labels.contexts"), contexts.join(","));
-    }
     cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.verifiable-credential-create.labels.subjectJson"), subjectJson);
     cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.verifiable-credential-create.labels.revocationIndex"), revocationIndex);
     cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.common.labels.node"), nodeEndpoint);
@@ -642,7 +624,7 @@ async function actionCommandVerifiableCredentialCreate(opts) {
     cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.verifiable-credential-create.progress.creatingVerifiableCredential"));
     cliCore.CLIDisplay.break();
     cliCore.CLIDisplay.spinnerStart();
-    const verifiableCredential = await iotaIdentityConnector.createVerifiableCredential(localIdentity, id, credentialId, types, jsonData, contexts, revocationIndex);
+    const verifiableCredential = await iotaIdentityConnector.createVerifiableCredential(localIdentity, id, credentialId, jsonData, revocationIndex);
     cliCore.CLIDisplay.spinnerStop();
     if (opts.console) {
         cliCore.CLIDisplay.section(core.I18n.formatMessage("commands.verifiable-credential-create.labels.verifiableCredential"));
@@ -1072,15 +1054,18 @@ class CLI extends cliCore.CLIBase {
      * Run the app.
      * @param argv The process arguments.
      * @param localesDirectory The directory for the locales, default to relative to the script.
+     * @param options Additional options for the CLI.
+     * @param options.overrideOutputWidth The override output width.
      * @returns The exit code.
      */
-    async run(argv, localesDirectory) {
+    async run(argv, localesDirectory, options) {
         return this.execute({
             title: "TWIN Identity",
             appName: "twin-identity",
             version: "0.0.3-next.18",
             icon: "🌍",
-            supportsEnvFiles: true
+            supportsEnvFiles: true,
+            overrideOutputWidth: options?.overrideOutputWidth
         }, localesDirectory ?? path.join(path.dirname(node_url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)))), "../locales"), argv);
     }
     /**

package/dist/esm/index.mjs

@@ -3,7 +3,7 @@ import { fileURLToPath } from 'node:url';
 import { CLIOptions, CLIParam, CLIDisplay, CLIUtils, CLIBase } from '@twin.org/cli-core';
 import { buildCommandMnemonic, buildCommandAddress } from '@twin.org/crypto-cli';
 import { buildCommandFaucet, buildCommandTransfer } from '@twin.org/wallet-cli';
-import { I18n, Converter, Is, StringHelper, Guards, Coerce, GeneralError } from '@twin.org/core';
+import { I18n, Converter, Is, StringHelper, Coerce, GeneralError } from '@twin.org/core';
 import { IotaIdentityConnector, IotaIdentityUtils } from '@twin.org/identity-connector-iota';
 import { VaultConnectorFactory, VaultKeyType } from '@twin.org/vault-models';
 import { IotaWalletConnector } from '@twin.org/wallet-connector-iota';
@@ -554,8 +554,6 @@ function buildCommandVerifiableCredentialCreate() {
         .requiredOption(I18n.formatMessage("commands.verifiable-credential-create.options.id.param"), I18n.formatMessage("commands.verifiable-credential-create.options.id.description"))
         .requiredOption(I18n.formatMessage("commands.verifiable-credential-create.options.private-key.param"), I18n.formatMessage("commands.verifiable-credential-create.options.private-key.description"))
         .option(I18n.formatMessage("commands.verifiable-credential-create.options.credential-id.param"), I18n.formatMessage("commands.verifiable-credential-create.options.credential-id.description"))
-        .option(I18n.formatMessage("commands.verifiable-credential-create.options.types.param"), I18n.formatMessage("commands.verifiable-credential-create.options.types.description"))
-        .option(I18n.formatMessage("commands.verifiable-credential-create.options.contexts.param"), I18n.formatMessage("commands.verifiable-credential-create.options.contexts.description"))
         .requiredOption(I18n.formatMessage("commands.verifiable-credential-create.options.subject-json.param"), I18n.formatMessage("commands.verifiable-credential-create.options.subject-json.description"))
         .option(I18n.formatMessage("commands.verifiable-credential-create.options.revocation-index.param"), I18n.formatMessage("commands.verifiable-credential-create.options.revocation-index.description"));
     CLIOptions.output(command, {
@@ -576,35 +574,19 @@ function buildCommandVerifiableCredentialCreate() {
  * @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.
  */
 async function actionCommandVerifiableCredentialCreate(opts) {
-    if (!Is.undefined(opts.types)) {
-        Guards.arrayValue("commands", "types", opts.types);
-    }
-    if (!Is.undefined(opts.contexts)) {
-        Guards.arrayValue("commands", "contexts", opts.contexts);
-    }
     const id = CLIParam.stringValue("id", opts.id);
     const privateKey = CLIParam.hexBase64("private-key", opts.privateKey);
     const credentialId = CLIParam.stringValue("credential-id", opts.credentialId);
-    const types = opts.types;
-    const contexts = opts.contexts;
     const subjectJson = path.resolve(CLIParam.stringValue("subject-json", opts.subjectJson));
     const revocationIndex = Coerce.number(opts.revocationIndex);
     const nodeEndpoint = CLIParam.url("node", opts.node);
     CLIDisplay.value(I18n.formatMessage("commands.verifiable-credential-create.labels.verificationMethodId"), id);
     CLIDisplay.value(I18n.formatMessage("commands.verifiable-credential-create.labels.credentialId"), credentialId);
-    if (Is.arrayValue(types)) {
-        CLIDisplay.value(I18n.formatMessage("commands.verifiable-credential-create.labels.types"), types.join(","));
-    }
-    if (Is.arrayValue(contexts)) {
-        CLIDisplay.value(I18n.formatMessage("commands.verifiable-credential-create.labels.contexts"), contexts.join(","));
-    }
     CLIDisplay.value(I18n.formatMessage("commands.verifiable-credential-create.labels.subjectJson"), subjectJson);
     CLIDisplay.value(I18n.formatMessage("commands.verifiable-credential-create.labels.revocationIndex"), revocationIndex);
     CLIDisplay.value(I18n.formatMessage("commands.common.labels.node"), nodeEndpoint);
@@ -639,7 +621,7 @@ async function actionCommandVerifiableCredentialCreate(opts) {
     CLIDisplay.task(I18n.formatMessage("commands.verifiable-credential-create.progress.creatingVerifiableCredential"));
     CLIDisplay.break();
     CLIDisplay.spinnerStart();
-    const verifiableCredential = await iotaIdentityConnector.createVerifiableCredential(localIdentity, id, credentialId, types, jsonData, contexts, revocationIndex);
+    const verifiableCredential = await iotaIdentityConnector.createVerifiableCredential(localIdentity, id, credentialId, jsonData, revocationIndex);
     CLIDisplay.spinnerStop();
     if (opts.console) {
         CLIDisplay.section(I18n.formatMessage("commands.verifiable-credential-create.labels.verifiableCredential"));
@@ -1069,15 +1051,18 @@ 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.
+     * @param options Additional options for the CLI.
+     * @param options.overrideOutputWidth The override output width.
      * @returns The exit code.
      */
-    async run(argv, localesDirectory) {
+    async run(argv, localesDirectory, options) {
         return this.execute({
             title: "TWIN Identity",
             appName: "twin-identity",
             version: "0.0.3-next.18",
             icon: "🌍",
-            supportsEnvFiles: true
+            supportsEnvFiles: true,
+            overrideOutputWidth: options?.overrideOutputWidth
         }, localesDirectory ?? path.join(path.dirname(fileURLToPath(import.meta.url)), "../locales"), argv);
     }
     /**

package/dist/locales/en.json

@@ -389,17 +389,9 @@
           "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."
+          "description": "A JSON-LD file to read which includes the data for the verifiable credential."
         },
         "revocation-index": {
           "param": "--revocation-index '<'revocation-index'>'",
@@ -413,8 +405,6 @@
       "labels": {
         "verificationMethodId": "Verification Method Id",
         "credentialId": "Credential Id",
-        "types": "Types",
-        "contexts": "Contexts",
         "subjectJson": "Subject JSON",
         "revocationIndex": "Revocation Index",
         "verifiableCredential": "Verifiable Credential"
@@ -586,6 +576,10 @@
         "env": {
           "param": "--env '<'filename'>'",
           "description": "Creates an env file containing the mnemonic and seed."
+        },
+        "env-prefix": {
+          "param": "--env-prefix '<'prefix'>'",
+          "description": "Prefixes the env variables with the value."
         }
       },
       "progress": {
@@ -594,7 +588,8 @@
       },
       "labels": {
         "mnemonic": "Mnemonic",
-        "seed": "Seed"
+        "seed": "Seed",
+        "envPrefix": "Env Prefix"
       }
     },
     "address": {
@@ -763,6 +758,14 @@
       }
     }
   },
+  "jsonLdProcessor": {
+    "compact": "The JSON-LD compaction failed",
+    "expand": "The JSON-LD expansion failed",
+    "invalidUrl": "The JSON-LD processing failed to retrieve from the following url \"{url}\""
+  },
+  "errorMessages": {
+    "fetch": "Fetch"
+  },
   "identityRole": {
     "organization": "Organization",
     "user": "User",
@@ -773,12 +776,5 @@
     "rejected": "Rejected",
     "issued": "Issued",
     "revoked": "Revoked"
-  },
-  "errorMessages": {
-    "fetch": "Fetch"
-  },
-  "jsonLdHelper": {
-    "compact": "The JSON-LD compaction failed",
-    "expand": "The JSON-LD expansion failed"
   }
 }

package/dist/types/cli.d.ts

@@ -7,7 +7,11 @@ 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.
+     * @param options Additional options for the CLI.
+     * @param options.overrideOutputWidth The override output width.
      * @returns The exit code.
      */
-    run(argv: string[], localesDirectory?: string): Promise<number>;
+    run(argv: string[], localesDirectory?: string, options?: {
+        overrideOutputWidth?: number;
+    }): Promise<number>;
 }

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

@@ -11,9 +11,7 @@ export declare function buildCommandVerifiableCredentialCreate(): 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.
  */
@@ -21,9 +19,7 @@ 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/docs/changelog.md

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

package/docs/examples.md

@@ -1,17 +1,18 @@
 # @twin.org/identity-cli - Examples
 
-## Command Line Tool
+## Running
 
-First install the tool with the following script.
+To install and run the CLI locally use the following commands:
 
 ```shell
-npm install @twin.org/identity-cli
+npm install @twin.org/identity-cli -g
+twin-identity
 ```
 
-Running the tool with no commands will provide help for all the commands. By issuing the following command you should see the result.
+or run directly using NPX:
 
 ```shell
-twin-identity
+npx "@twin.org/identity-cli"
 ```
 
 Output

package/docs/reference/classes/CLI.md

@@ -24,7 +24,7 @@ The main entry point for the CLI.
 
 ### run()
 
-> **run**(`argv`, `localesDirectory`?): `Promise`\<`number`\>
+> **run**(`argv`, `localesDirectory`?, `options`?): `Promise`\<`number`\>
 
 Run the app.
 
@@ -38,6 +38,14 @@ The process arguments.
 
 The directory for the locales, default to relative to the script.
 
+• **options?**
+
+Additional options for the CLI.
+
+• **options.overrideOutputWidth?**: `number`
+
+The override output width.
+
 #### Returns
 
 `Promise`\<`number`\>

package/locales/en.json

@@ -164,17 +164,9 @@
 					"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."
+					"description": "A JSON-LD file to read which includes the data for the verifiable credential."
 				},
 				"revocation-index": {
 					"param": "--revocation-index '<'revocation-index'>'",
@@ -188,8 +180,6 @@
 			"labels": {
 				"verificationMethodId": "Verification Method Id",
 				"credentialId": "Credential Id",
-				"types": "Types",
-				"contexts": "Contexts",
 				"subjectJson": "Subject JSON",
 				"revocationIndex": "Revocation Index",
 				"verifiableCredential": "Verifiable Credential"

package/package.json

@@ -1,11 +1,11 @@
 {
 	"name": "@twin.org/identity-cli",
-	"version": "0.0.1-next.3",
+	"version": "0.0.1-next.6",
 	"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"
+		"directory": "apps/identity-cli"
 	},
 	"author": "martyn.janes@iota.org",
 	"license": "Apache-2.0",
@@ -13,29 +13,17 @@
 	"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": {
+		"@iota/sdk-wasm": "1.1.3",
+		"@twin.org/cli-core": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
-		"@twin.org/cli-core": "next",
 		"@twin.org/crypto-cli": "next",
+		"@twin.org/data-json-ld": "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/identity-connector-iota": "0.0.1-next.6",
+		"@twin.org/identity-models": "0.0.1-next.6",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next",
 		"@twin.org/vault-connector-entity-storage": "next",
@@ -43,24 +31,8 @@
 		"@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",