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

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/identityCreate.d.ts

@@ -1,5 +1,6 @@
 import { type CliOutputOptions } from "@twin.org/cli-core";
 import { Command } from "commander";
+import { IdentityConnectorTypes } from "../models/identityConnectorTypes";
 /**
  * Build the identity create command for the CLI.
  * @returns The command.
@@ -9,11 +10,16 @@ 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.connector The connector to perform the operations with.
  * @param opts.node The node URL.
+ * @param opts.network The network to use for connector.
  * @param opts.explorer The explorer URL.
  */
 export declare function actionCommandIdentityCreate(opts: {
     seed: string;
+    connector?: IdentityConnectorTypes;
     node: string;
+    network?: string;
     explorer: string;
+    addressIndex?: string;
 } & CliOutputOptions): Promise<void>;

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

@@ -1,5 +1,6 @@
 import { type CliOutputOptions } from "@twin.org/cli-core";
 import { Command } from "commander";
+import { IdentityConnectorTypes } from "../models/identityConnectorTypes";
 /**
  * Build the identity resolve command for the CLI.
  * @returns The command.
@@ -9,11 +10,15 @@ 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.connector The connector to perform the operations with.
  * @param opts.node The node URL.
+ * @param opts.network The network to use for connector.
  * @param opts.explorer The explorer URL.
  */
 export declare function actionCommandIdentityResolve(opts: {
     did: string;
+    connector?: IdentityConnectorTypes;
     node: string;
+    network?: string;
     explorer: string;
 } & CliOutputOptions): Promise<void>;

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

@@ -1,5 +1,6 @@
 import { type CliOutputOptions } from "@twin.org/cli-core";
 import { Command } from "commander";
+import { IdentityConnectorTypes } from "../models/identityConnectorTypes";
 /**
  * Build the proof create command for the CLI.
  * @returns The command.
@@ -11,11 +12,15 @@ export declare function buildCommandProofCreate(): 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.connector The connector to perform the operations with.
  * @param opts.node The node URL.
+ * @param opts.network The network to use for connector.
  */
 export declare function actionCommandProofCreate(opts: {
     id: string;
     privateKey: string;
-    data: string;
+    documentFilename: string;
+    connector?: IdentityConnectorTypes;
     node: string;
+    network?: string;
 } & CliOutputOptions): Promise<void>;

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

@@ -1,5 +1,6 @@
 import { type CliOutputOptions } from "@twin.org/cli-core";
 import { Command } from "commander";
+import { IdentityConnectorTypes } from "../models/identityConnectorTypes";
 /**
  * Build the proof verify command for the CLI.
  * @returns The command.
@@ -9,15 +10,16 @@ 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.documentFilename The data to verify the proof for.
+ * @param opts.proofFilename The proof value.
+ * @param opts.connector The connector to perform the operations with.
  * @param opts.node The node URL.
+ * @param opts.network The network to use for connector.
  */
 export declare function actionCommandProofVerify(opts: {
-    id: string;
-    data: string;
-    type: string;
-    value: string;
+    documentFilename: string;
+    proofFilename: string;
+    connector?: IdentityConnectorTypes;
     node: string;
+    network?: string;
 } & CliOutputOptions): Promise<void>;

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

@@ -1,5 +1,6 @@
 import { type CliOutputOptions } from "@twin.org/cli-core";
 import { Command } from "commander";
+import { IdentityConnectorTypes } from "../models/identityConnectorTypes";
 /**
  * Build the service add command for the CLI.
  * @returns The command.
@@ -13,6 +14,7 @@ export declare function buildCommandServiceAdd(): Command;
  * @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.connector The connector to perform the operations with.
  * @param opts.node The node URL.
  * @param opts.explorer The explorer URL.
  */
@@ -22,6 +24,8 @@ export declare function actionCommandServiceAdd(opts: {
     id: string;
     type: string;
     endpoint: string;
+    connector?: IdentityConnectorTypes;
     node: string;
+    network?: string;
     explorer: string;
 } & CliOutputOptions): Promise<void>;

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

@@ -1,4 +1,5 @@
 import { Command } from "commander";
+import { IdentityConnectorTypes } from "../models/identityConnectorTypes";
 /**
  * Build the service remove command for the CLI.
  * @returns The command.
@@ -9,12 +10,16 @@ export declare function buildCommandServiceRemove(): 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.connector The connector to perform the operations with.
  * @param opts.node The node URL.
+ * @param opts.network The network to use for connector.
  * @param opts.explorer The explorer URL.
  */
 export declare function actionCommandServiceRemove(opts: {
     seed: string;
     id: string;
+    connector?: IdentityConnectorTypes;
     node: string;
+    network?: string;
     explorer: string;
 }): Promise<void>;

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

@@ -1,4 +1,22 @@
+import type { IIdentityConnector } from "@twin.org/identity-models";
+import { IdentityConnectorTypes } from "../models/identityConnectorTypes";
 /**
  * Setup the vault for use in the CLI commands.
  */
 export declare function setupVault(): void;
+/**
+ * Setup the identity connector for use in the CLI commands.
+ * @param options The options for the identity connector.
+ * @param options.nodeEndpoint The node endpoint.
+ * @param options.network The network.
+ * @param options.addressIndex The wallet index.
+ * @param options.vaultSeedId The vault seed ID.
+ * @param connector The connector to use.
+ * @returns The identity connector.
+ */
+export declare function setupIdentityConnector(options: {
+    nodeEndpoint: string;
+    network?: string;
+    addressIndex?: number;
+    vaultSeedId?: string;
+}, connector?: IdentityConnectorTypes): IIdentityConnector;

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

@@ -1,5 +1,6 @@
 import { type CliOutputOptions } from "@twin.org/cli-core";
 import { Command } from "commander";
+import { IdentityConnectorTypes } from "../models/identityConnectorTypes";
 /**
  * Build the verifiable credential create command for the CLI.
  * @returns The command.
@@ -11,19 +12,18 @@ 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.connector The connector to perform the operations with.
  * @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;
+    connector?: IdentityConnectorTypes;
     node: string;
+    network?: string;
 } & CliOutputOptions): Promise<void>;

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

@@ -1,4 +1,5 @@
 import { Command } from "commander";
+import { IdentityConnectorTypes } from "../models/identityConnectorTypes";
 /**
  * Build the verifiable credential revoke command for the CLI.
  * @returns The command.
@@ -10,11 +11,15 @@ export declare function buildCommandVerifiableCredentialRevoke(): 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.connector The connector to perform the operations with.
  * @param opts.node The node URL.
+ * @param opts.network The network to use for connector.
  */
 export declare function actionCommandVerifiableCredentialRevoke(opts: {
     seed: string;
     did: string;
     revocationIndex: string;
+    connector?: IdentityConnectorTypes;
     node: string;
+    network?: string;
 }): Promise<void>;

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

@@ -1,4 +1,5 @@
 import { Command } from "commander";
+import { IdentityConnectorTypes } from "../models/identityConnectorTypes";
 /**
  * Build the verifiable credential unrevoke command for the CLI.
  * @returns The command.
@@ -10,11 +11,15 @@ export declare function buildCommandVerifiableCredentialUnrevoke(): 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.connector The connector to perform the operations with.
  * @param opts.node The node URL.
+ * @param opts.network The network to use for connector.
  */
 export declare function actionCommandVerifiableCredentialUnrevoke(opts: {
     seed: string;
     did: string;
     revocationIndex: string;
+    connector?: IdentityConnectorTypes;
     node: string;
+    network?: string;
 }): Promise<void>;

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

@@ -1,5 +1,6 @@
 import { type CliOutputOptions } from "@twin.org/cli-core";
 import { Command } from "commander";
+import { IdentityConnectorTypes } from "../models/identityConnectorTypes";
 /**
  * Build the verifiable credential verify command for the CLI.
  * @returns The command.
@@ -9,9 +10,12 @@ 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.connector The connector to perform the operations with.
  * @param opts.node The node URL.
  */
 export declare function actionCommandVerifiableCredentialVerify(opts: {
     jwt: string;
+    connector?: IdentityConnectorTypes;
     node: string;
+    network?: string;
 } & CliOutputOptions): Promise<void>;

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

@@ -1,6 +1,7 @@
 import { type CliOutputOptions } from "@twin.org/cli-core";
 import { DidVerificationMethodType } from "@twin.org/standards-w3c-did";
 import { Command } from "commander";
+import { IdentityConnectorTypes } from "../models/identityConnectorTypes";
 /**
  * Build the verification method add command for the CLI.
  * @returns The command.
@@ -13,6 +14,7 @@ export declare function buildCommandVerificationMethodAdd(): Command;
  * @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.connector The connector to perform the operations with.
  * @param opts.node The node URL.
  * @param opts.explorer The explorer URL.
  */
@@ -21,6 +23,8 @@ export declare function actionCommandVerificationMethodAdd(opts: {
     did: string;
     type: DidVerificationMethodType;
     id?: string;
+    connector?: IdentityConnectorTypes;
     node: string;
+    network?: string;
     explorer: string;
 } & CliOutputOptions): Promise<void>;

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

@@ -1,4 +1,5 @@
 import { Command } from "commander";
+import { IdentityConnectorTypes } from "../models/identityConnectorTypes";
 /**
  * Build the verification method remove command for the CLI.
  * @returns The command.
@@ -9,12 +10,16 @@ export declare function buildCommandVerificationMethodRemove(): 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.connector The connector to perform the operations with.
  * @param opts.node The node URL.
  * @param opts.explorer The explorer URL.
+ * @param opts.network The network to use for connector.
  */
 export declare function actionCommandVerificationMethodRemove(opts: {
     seed: string;
     id: string;
+    connector?: IdentityConnectorTypes;
     node: string;
+    network?: string;
     explorer: string;
 }): Promise<void>;

package/dist/types/index.d.ts

@@ -5,9 +5,11 @@ export * from "./commands/proofCreate";
 export * from "./commands/proofVerify";
 export * from "./commands/serviceAdd";
 export * from "./commands/serviceRemove";
+export * from "./commands/setupCommands";
 export * from "./commands/verifiableCredentialCreate";
 export * from "./commands/verifiableCredentialRevoke";
 export * from "./commands/verifiableCredentialUnrevoke";
 export * from "./commands/verifiableCredentialVerify";
 export * from "./commands/verificationMethodAdd";
 export * from "./commands/verificationMethodRemove";
+export * from "./models/identityConnectorTypes";

package/dist/types/models/identityConnectorTypes.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The identity connector types.
+ */
+export declare const IdentityConnectorTypes: {
+    /**
+     * IOTA.
+     */
+    readonly Iota: "iota";
+    /**
+     * IOTA Stardust.
+     */
+    readonly IotaStardust: "iota-stardust";
+};
+/**
+ * The identity connector types.
+ */
+export type IdentityConnectorTypes = (typeof IdentityConnectorTypes)[keyof typeof IdentityConnectorTypes];

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/identity-cli - Changelog
 
-## v0.0.1-next.3
+## v0.0.1-next.32
 
 - 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
@@ -63,7 +64,7 @@ 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.
+  --address-index <index>    The address index to use for the creation. (default: "0")
   --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.
@@ -80,7 +81,7 @@ The commands `mnemonic`, `address`, `faucet` and `transfer` are described in mor
 
 ### 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.
+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
@@ -100,10 +101,10 @@ 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
+# Fund the wallet address from the faucet loading the config and wallet env files
+twin-identity faucet --load-env config.env wallet.env --address !ADDRESS_0
 # Create an identity
-twin-identity identity-create --load-env config.env wallet.env --seed !SEED --controller !ADDRESS_0_BECH32 --env identity.env
+twin-identity identity-create --load-env config.env wallet.env --seed !SEED --env identity.env
 ```
 
 ### identity-resolve
@@ -196,15 +197,15 @@ twin-identity verifiable-credential-unrevoke --load-env config.env wallet.env id
 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=
+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 as a set of data containing the type and a value in base64.
+This will output the proof.
 
 ## proof-verify
 
-This command will verify a proof using the specified verification method.
+This command will verify a proof for a document.
 
 ```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==
+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/docs/reference/classes/CLI.md

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

package/docs/reference/functions/actionCommandIdentityCreate.md

@@ -6,7 +6,9 @@ Action the identity create command.
 
 ## Parameters
 
-• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
+### opts
+
+`object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
 
 The options for the command.
 

package/docs/reference/functions/actionCommandIdentityResolve.md

@@ -6,7 +6,9 @@ Action the identity resolve command.
 
 ## Parameters
 
-• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
+### opts
+
+`object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
 
 The options for the command.
 

package/docs/reference/functions/actionCommandProofCreate.md

@@ -6,7 +6,9 @@ Action the proof create command.
 
 ## Parameters
 
-• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
+### opts
+
+`object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
 
 The options for the command.
 

package/docs/reference/functions/actionCommandProofVerify.md

@@ -6,7 +6,9 @@ Action the proof verify command.
 
 ## Parameters
 
-• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
+### opts
+
+`object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
 
 The options for the command.
 

package/docs/reference/functions/actionCommandServiceAdd.md

@@ -6,7 +6,9 @@ Action the service add command.
 
 ## Parameters
 
-• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
+### opts
+
+`object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
 
 The options for the command.
 

package/docs/reference/functions/actionCommandServiceRemove.md

@@ -6,23 +6,43 @@ Action the service remove command.
 
 ## Parameters
 
-• **opts**
+### opts
 
 The options for the command.
 
-• **opts.seed**: `string`
+#### seed
+
+`string`
 
 The private key for the controller.
 
-• **opts.id**: `string`
+#### id
+
+`string`
 
 The id of the service to remove.
 
-• **opts.node**: `string`
+#### connector?
+
+[`IdentityConnectorTypes`](../type-aliases/IdentityConnectorTypes.md)
+
+The connector to perform the operations with.
+
+#### node
+
+`string`
 
 The node URL.
 
-• **opts.explorer**: `string`
+#### network?
+
+`string`
+
+The network to use for connector.
+
+#### explorer
+
+`string`
 
 The explorer URL.
 

package/docs/reference/functions/actionCommandVerifiableCredentialCreate.md

@@ -6,7 +6,9 @@ Action the verifiable credential create command.
 
 ## Parameters
 
-• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
+### opts
+
+`object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
 
 The options for the command.
 

package/docs/reference/functions/actionCommandVerifiableCredentialRevoke.md

@@ -6,26 +6,46 @@ Action the verifiable credential revoke command.
 
 ## Parameters
 
-• **opts**
+### opts
 
 The options for the command.
 
-• **opts.seed**: `string`
+#### seed
+
+`string`
 
 The seed to generate the private key for the controller.
 
-• **opts.did**: `string`
+#### did
+
+`string`
 
 The id of the document to revoke the index.
 
-• **opts.revocationIndex**: `string`
+#### revocationIndex
+
+`string`
 
 The revocation index for the credential.
 
-• **opts.node**: `string`
+#### connector?
+
+[`IdentityConnectorTypes`](../type-aliases/IdentityConnectorTypes.md)
+
+The connector to perform the operations with.
+
+#### node
+
+`string`
 
 The node URL.
 
+#### network?
+
+`string`
+
+The network to use for connector.
+
 ## Returns
 
 `Promise`\<`void`\>