@twin.org/identity-cli 0.0.1-next.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +21 -0
- package/bin/index.js +10 -0
- package/dist/cjs/index.cjs +1137 -0
- package/dist/esm/index.mjs +1110 -0
- package/dist/locales/en.json +784 -0
- package/dist/types/cli.d.ts +13 -0
- package/dist/types/commands/identityCreate.d.ts +19 -0
- package/dist/types/commands/identityResolve.d.ts +19 -0
- package/dist/types/commands/proofCreate.d.ts +21 -0
- package/dist/types/commands/proofVerify.d.ts +23 -0
- package/dist/types/commands/serviceAdd.d.ts +27 -0
- package/dist/types/commands/serviceRemove.d.ts +20 -0
- package/dist/types/commands/setupCommands.d.ts +4 -0
- package/dist/types/commands/verifiableCredentialCreate.d.ts +29 -0
- package/dist/types/commands/verifiableCredentialRevoke.d.ts +20 -0
- package/dist/types/commands/verifiableCredentialUnrevoke.d.ts +20 -0
- package/dist/types/commands/verifiableCredentialVerify.d.ts +17 -0
- package/dist/types/commands/verificationMethodAdd.d.ts +26 -0
- package/dist/types/commands/verificationMethodRemove.d.ts +20 -0
- package/dist/types/index.d.ts +13 -0
- package/docs/changelog.md +5 -0
- package/docs/examples.md +210 -0
- package/docs/reference/classes/CLI.md +45 -0
- package/docs/reference/functions/actionCommandIdentityCreate.md +15 -0
- package/docs/reference/functions/actionCommandIdentityResolve.md +15 -0
- package/docs/reference/functions/actionCommandProofCreate.md +15 -0
- package/docs/reference/functions/actionCommandProofVerify.md +15 -0
- package/docs/reference/functions/actionCommandServiceAdd.md +15 -0
- package/docs/reference/functions/actionCommandServiceRemove.md +31 -0
- package/docs/reference/functions/actionCommandVerifiableCredentialCreate.md +15 -0
- package/docs/reference/functions/actionCommandVerifiableCredentialRevoke.md +31 -0
- package/docs/reference/functions/actionCommandVerifiableCredentialUnrevoke.md +31 -0
- package/docs/reference/functions/actionCommandVerifiableCredentialVerify.md +15 -0
- package/docs/reference/functions/actionCommandVerificationMethodAdd.md +15 -0
- package/docs/reference/functions/actionCommandVerificationMethodRemove.md +31 -0
- package/docs/reference/functions/buildCommandIdentityCreate.md +11 -0
- package/docs/reference/functions/buildCommandIdentityResolve.md +11 -0
- package/docs/reference/functions/buildCommandProofCreate.md +11 -0
- package/docs/reference/functions/buildCommandProofVerify.md +11 -0
- package/docs/reference/functions/buildCommandServiceAdd.md +11 -0
- package/docs/reference/functions/buildCommandServiceRemove.md +11 -0
- package/docs/reference/functions/buildCommandVerifiableCredentialCreate.md +11 -0
- package/docs/reference/functions/buildCommandVerifiableCredentialRevoke.md +11 -0
- package/docs/reference/functions/buildCommandVerifiableCredentialUnrevoke.md +11 -0
- package/docs/reference/functions/buildCommandVerifiableCredentialVerify.md +11 -0
- package/docs/reference/functions/buildCommandVerificationMethodAdd.md +11 -0
- package/docs/reference/functions/buildCommandVerificationMethodRemove.md +11 -0
- package/docs/reference/index.md +32 -0
- package/locales/en.json +336 -0
- package/package.json +86 -0
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Function: actionCommandServiceRemove()
|
|
2
|
+
|
|
3
|
+
> **actionCommandServiceRemove**(`opts`): `Promise`\<`void`\>
|
|
4
|
+
|
|
5
|
+
Action the service remove command.
|
|
6
|
+
|
|
7
|
+
## Parameters
|
|
8
|
+
|
|
9
|
+
• **opts**
|
|
10
|
+
|
|
11
|
+
The options for the command.
|
|
12
|
+
|
|
13
|
+
• **opts.seed**: `string`
|
|
14
|
+
|
|
15
|
+
The private key for the controller.
|
|
16
|
+
|
|
17
|
+
• **opts.id**: `string`
|
|
18
|
+
|
|
19
|
+
The id of the service to remove.
|
|
20
|
+
|
|
21
|
+
• **opts.node**: `string`
|
|
22
|
+
|
|
23
|
+
The node URL.
|
|
24
|
+
|
|
25
|
+
• **opts.explorer**: `string`
|
|
26
|
+
|
|
27
|
+
The explorer URL.
|
|
28
|
+
|
|
29
|
+
## Returns
|
|
30
|
+
|
|
31
|
+
`Promise`\<`void`\>
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Function: actionCommandVerifiableCredentialCreate()
|
|
2
|
+
|
|
3
|
+
> **actionCommandVerifiableCredentialCreate**(`opts`): `Promise`\<`void`\>
|
|
4
|
+
|
|
5
|
+
Action the verifiable credential create command.
|
|
6
|
+
|
|
7
|
+
## Parameters
|
|
8
|
+
|
|
9
|
+
• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
|
|
10
|
+
|
|
11
|
+
The options for the command.
|
|
12
|
+
|
|
13
|
+
## Returns
|
|
14
|
+
|
|
15
|
+
`Promise`\<`void`\>
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Function: actionCommandVerifiableCredentialRevoke()
|
|
2
|
+
|
|
3
|
+
> **actionCommandVerifiableCredentialRevoke**(`opts`): `Promise`\<`void`\>
|
|
4
|
+
|
|
5
|
+
Action the verifiable credential revoke command.
|
|
6
|
+
|
|
7
|
+
## Parameters
|
|
8
|
+
|
|
9
|
+
• **opts**
|
|
10
|
+
|
|
11
|
+
The options for the command.
|
|
12
|
+
|
|
13
|
+
• **opts.seed**: `string`
|
|
14
|
+
|
|
15
|
+
The seed to generate the private key for the controller.
|
|
16
|
+
|
|
17
|
+
• **opts.did**: `string`
|
|
18
|
+
|
|
19
|
+
The id of the document to revoke the index.
|
|
20
|
+
|
|
21
|
+
• **opts.revocationIndex**: `string`
|
|
22
|
+
|
|
23
|
+
The revocation index for the credential.
|
|
24
|
+
|
|
25
|
+
• **opts.node**: `string`
|
|
26
|
+
|
|
27
|
+
The node URL.
|
|
28
|
+
|
|
29
|
+
## Returns
|
|
30
|
+
|
|
31
|
+
`Promise`\<`void`\>
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Function: actionCommandVerifiableCredentialUnrevoke()
|
|
2
|
+
|
|
3
|
+
> **actionCommandVerifiableCredentialUnrevoke**(`opts`): `Promise`\<`void`\>
|
|
4
|
+
|
|
5
|
+
Action the verifiable credential unrevoke command.
|
|
6
|
+
|
|
7
|
+
## Parameters
|
|
8
|
+
|
|
9
|
+
• **opts**
|
|
10
|
+
|
|
11
|
+
The options for the command.
|
|
12
|
+
|
|
13
|
+
• **opts.seed**: `string`
|
|
14
|
+
|
|
15
|
+
The seed to generate the private key for the controller.
|
|
16
|
+
|
|
17
|
+
• **opts.did**: `string`
|
|
18
|
+
|
|
19
|
+
The id of the document to unrevoke the index.
|
|
20
|
+
|
|
21
|
+
• **opts.revocationIndex**: `string`
|
|
22
|
+
|
|
23
|
+
The revocation index for the credential.
|
|
24
|
+
|
|
25
|
+
• **opts.node**: `string`
|
|
26
|
+
|
|
27
|
+
The node URL.
|
|
28
|
+
|
|
29
|
+
## Returns
|
|
30
|
+
|
|
31
|
+
`Promise`\<`void`\>
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Function: actionCommandVerifiableCredentialVerify()
|
|
2
|
+
|
|
3
|
+
> **actionCommandVerifiableCredentialVerify**(`opts`): `Promise`\<`void`\>
|
|
4
|
+
|
|
5
|
+
Action the verifiable credential verify command.
|
|
6
|
+
|
|
7
|
+
## Parameters
|
|
8
|
+
|
|
9
|
+
• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
|
|
10
|
+
|
|
11
|
+
The options for the command.
|
|
12
|
+
|
|
13
|
+
## Returns
|
|
14
|
+
|
|
15
|
+
`Promise`\<`void`\>
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Function: actionCommandVerificationMethodAdd()
|
|
2
|
+
|
|
3
|
+
> **actionCommandVerificationMethodAdd**(`opts`): `Promise`\<`void`\>
|
|
4
|
+
|
|
5
|
+
Action the verification method add command.
|
|
6
|
+
|
|
7
|
+
## Parameters
|
|
8
|
+
|
|
9
|
+
• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
|
|
10
|
+
|
|
11
|
+
The options for the command.
|
|
12
|
+
|
|
13
|
+
## Returns
|
|
14
|
+
|
|
15
|
+
`Promise`\<`void`\>
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Function: actionCommandVerificationMethodRemove()
|
|
2
|
+
|
|
3
|
+
> **actionCommandVerificationMethodRemove**(`opts`): `Promise`\<`void`\>
|
|
4
|
+
|
|
5
|
+
Action the verification method remove command.
|
|
6
|
+
|
|
7
|
+
## Parameters
|
|
8
|
+
|
|
9
|
+
• **opts**
|
|
10
|
+
|
|
11
|
+
The options for the command.
|
|
12
|
+
|
|
13
|
+
• **opts.seed**: `string`
|
|
14
|
+
|
|
15
|
+
The private key for the controller.
|
|
16
|
+
|
|
17
|
+
• **opts.id**: `string`
|
|
18
|
+
|
|
19
|
+
The id of the verification method to remove.
|
|
20
|
+
|
|
21
|
+
• **opts.node**: `string`
|
|
22
|
+
|
|
23
|
+
The node URL.
|
|
24
|
+
|
|
25
|
+
• **opts.explorer**: `string`
|
|
26
|
+
|
|
27
|
+
The explorer URL.
|
|
28
|
+
|
|
29
|
+
## Returns
|
|
30
|
+
|
|
31
|
+
`Promise`\<`void`\>
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# @twin.org/identity-cli
|
|
2
|
+
|
|
3
|
+
## Classes
|
|
4
|
+
|
|
5
|
+
- [CLI](classes/CLI.md)
|
|
6
|
+
|
|
7
|
+
## Functions
|
|
8
|
+
|
|
9
|
+
- [buildCommandIdentityCreate](functions/buildCommandIdentityCreate.md)
|
|
10
|
+
- [actionCommandIdentityCreate](functions/actionCommandIdentityCreate.md)
|
|
11
|
+
- [buildCommandIdentityResolve](functions/buildCommandIdentityResolve.md)
|
|
12
|
+
- [actionCommandIdentityResolve](functions/actionCommandIdentityResolve.md)
|
|
13
|
+
- [buildCommandProofCreate](functions/buildCommandProofCreate.md)
|
|
14
|
+
- [actionCommandProofCreate](functions/actionCommandProofCreate.md)
|
|
15
|
+
- [buildCommandProofVerify](functions/buildCommandProofVerify.md)
|
|
16
|
+
- [actionCommandProofVerify](functions/actionCommandProofVerify.md)
|
|
17
|
+
- [buildCommandServiceAdd](functions/buildCommandServiceAdd.md)
|
|
18
|
+
- [actionCommandServiceAdd](functions/actionCommandServiceAdd.md)
|
|
19
|
+
- [buildCommandServiceRemove](functions/buildCommandServiceRemove.md)
|
|
20
|
+
- [actionCommandServiceRemove](functions/actionCommandServiceRemove.md)
|
|
21
|
+
- [buildCommandVerifiableCredentialCreate](functions/buildCommandVerifiableCredentialCreate.md)
|
|
22
|
+
- [actionCommandVerifiableCredentialCreate](functions/actionCommandVerifiableCredentialCreate.md)
|
|
23
|
+
- [buildCommandVerifiableCredentialRevoke](functions/buildCommandVerifiableCredentialRevoke.md)
|
|
24
|
+
- [actionCommandVerifiableCredentialRevoke](functions/actionCommandVerifiableCredentialRevoke.md)
|
|
25
|
+
- [buildCommandVerifiableCredentialUnrevoke](functions/buildCommandVerifiableCredentialUnrevoke.md)
|
|
26
|
+
- [actionCommandVerifiableCredentialUnrevoke](functions/actionCommandVerifiableCredentialUnrevoke.md)
|
|
27
|
+
- [buildCommandVerifiableCredentialVerify](functions/buildCommandVerifiableCredentialVerify.md)
|
|
28
|
+
- [actionCommandVerifiableCredentialVerify](functions/actionCommandVerifiableCredentialVerify.md)
|
|
29
|
+
- [buildCommandVerificationMethodAdd](functions/buildCommandVerificationMethodAdd.md)
|
|
30
|
+
- [actionCommandVerificationMethodAdd](functions/actionCommandVerificationMethodAdd.md)
|
|
31
|
+
- [buildCommandVerificationMethodRemove](functions/buildCommandVerificationMethodRemove.md)
|
|
32
|
+
- [actionCommandVerificationMethodRemove](functions/actionCommandVerificationMethodRemove.md)
|