@twin.org/identity-models 0.9.2-next.1 → 0.9.2-next.10
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/dist/es/index.js +7 -0
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/IIdentityComponent.js.map +1 -1
- package/dist/es/models/IIdentityConnector.js.map +1 -1
- package/dist/es/models/IIdentityProfileComponent.js.map +1 -1
- package/dist/es/models/api/identity/IIdentityRemoveRequest.js.map +1 -1
- package/dist/es/models/api/identity/IIdentityVerificationMethodRemoveRequest.js.map +1 -1
- package/dist/es/models/api/profile/IIdentityProfileAdminGetRequest.js +4 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminGetRequest.js.map +1 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminListRequest.js +4 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminListRequest.js.map +1 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminListResponse.js +2 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminListResponse.js.map +1 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminRemoveRequest.js +4 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminRemoveRequest.js.map +1 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminUpdateRequest.js +2 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminUpdateRequest.js.map +1 -0
- package/dist/es/models/identitySpanAttributes.js +21 -0
- package/dist/es/models/identitySpanAttributes.js.map +1 -0
- package/dist/es/models/identitySpanNames.js +73 -0
- package/dist/es/models/identitySpanNames.js.map +1 -0
- package/dist/types/index.d.ts +7 -0
- package/dist/types/models/IIdentityComponent.d.ts +10 -2
- package/dist/types/models/IIdentityConnector.d.ts +10 -2
- package/dist/types/models/IIdentityProfileComponent.d.ts +30 -0
- package/dist/types/models/api/identity/IIdentityRemoveRequest.d.ts +9 -0
- package/dist/types/models/api/identity/IIdentityVerificationMethodRemoveRequest.d.ts +9 -0
- package/dist/types/models/api/profile/IIdentityProfileAdminGetRequest.d.ts +27 -0
- package/dist/types/models/api/profile/IIdentityProfileAdminListRequest.d.ts +34 -0
- package/dist/types/models/api/profile/IIdentityProfileAdminListResponse.d.ts +32 -0
- package/dist/types/models/api/profile/IIdentityProfileAdminRemoveRequest.d.ts +14 -0
- package/dist/types/models/api/profile/IIdentityProfileAdminUpdateRequest.d.ts +28 -0
- package/dist/types/models/identitySpanAttributes.d.ts +21 -0
- package/dist/types/models/identitySpanNames.d.ts +73 -0
- package/docs/changelog.md +130 -0
- package/docs/reference/index.md +9 -0
- package/docs/reference/interfaces/IIdentityComponent.md +22 -2
- package/docs/reference/interfaces/IIdentityConnector.md +22 -2
- package/docs/reference/interfaces/IIdentityProfileAdminGetRequest.md +37 -0
- package/docs/reference/interfaces/IIdentityProfileAdminListRequest.md +47 -0
- package/docs/reference/interfaces/IIdentityProfileAdminListResponse.md +23 -0
- package/docs/reference/interfaces/IIdentityProfileAdminRemoveRequest.md +17 -0
- package/docs/reference/interfaces/IIdentityProfileAdminUpdateRequest.md +37 -0
- package/docs/reference/interfaces/IIdentityProfileComponent.md +52 -0
- package/docs/reference/interfaces/IIdentityRemoveRequest.md +14 -0
- package/docs/reference/interfaces/IIdentityVerificationMethodRemoveRequest.md +14 -0
- package/docs/reference/type-aliases/IdentitySpanAttributes.md +5 -0
- package/docs/reference/type-aliases/IdentitySpanNames.md +5 -0
- package/docs/reference/variables/IdentitySpanAttributes.md +25 -0
- package/docs/reference/variables/IdentitySpanNames.md +103 -0
- package/package.json +2 -1
|
@@ -15,3 +15,17 @@ The data for the request.
|
|
|
15
15
|
> **identity**: `string`
|
|
16
16
|
|
|
17
17
|
The identity to remove.
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### query? {#query}
|
|
22
|
+
|
|
23
|
+
> `optional` **query?**: `object`
|
|
24
|
+
|
|
25
|
+
The query parameters.
|
|
26
|
+
|
|
27
|
+
#### removeKeys?
|
|
28
|
+
|
|
29
|
+
> `optional` **removeKeys?**: `string`
|
|
30
|
+
|
|
31
|
+
Also remove any associated private keys from the vault.
|
|
@@ -21,3 +21,17 @@ The identity to remove the verification method from.
|
|
|
21
21
|
> **verificationMethodId**: `string`
|
|
22
22
|
|
|
23
23
|
The verification method to remove.
|
|
24
|
+
|
|
25
|
+
***
|
|
26
|
+
|
|
27
|
+
### query? {#query}
|
|
28
|
+
|
|
29
|
+
> `optional` **query?**: `object`
|
|
30
|
+
|
|
31
|
+
The query parameters.
|
|
32
|
+
|
|
33
|
+
#### removeKeys?
|
|
34
|
+
|
|
35
|
+
> `optional` **removeKeys?**: `string`
|
|
36
|
+
|
|
37
|
+
Also remove any associated private key from the vault.
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Type Alias: IdentitySpanAttributes
|
|
2
|
+
|
|
3
|
+
> **IdentitySpanAttributes** = *typeof* [`IdentitySpanAttributes`](../variables/IdentitySpanAttributes.md)\[keyof *typeof* [`IdentitySpanAttributes`](../variables/IdentitySpanAttributes.md)\]
|
|
4
|
+
|
|
5
|
+
Union type of all identity span attribute key string values.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Variable: IdentitySpanAttributes
|
|
2
|
+
|
|
3
|
+
> `const` **IdentitySpanAttributes**: `object`
|
|
4
|
+
|
|
5
|
+
The span attribute keys for the identity domain.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### Id {#id}
|
|
10
|
+
|
|
11
|
+
> `readonly` **Id**: `"identity.id"` = `"identity.id"`
|
|
12
|
+
|
|
13
|
+
The id of the identity document the operation is for.
|
|
14
|
+
|
|
15
|
+
### VerificationMethodId {#verificationmethodid}
|
|
16
|
+
|
|
17
|
+
> `readonly` **VerificationMethodId**: `"identity.verification-method-id"` = `"identity.verification-method-id"`
|
|
18
|
+
|
|
19
|
+
The id of the verification method the operation is for.
|
|
20
|
+
|
|
21
|
+
### ServiceId {#serviceid}
|
|
22
|
+
|
|
23
|
+
> `readonly` **ServiceId**: `"identity.service-id"` = `"identity.service-id"`
|
|
24
|
+
|
|
25
|
+
The id of the service the operation is for.
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
# Variable: IdentitySpanNames
|
|
2
|
+
|
|
3
|
+
> `const` **IdentitySpanNames**: `object`
|
|
4
|
+
|
|
5
|
+
The span names for the identity domain.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### Create {#create}
|
|
10
|
+
|
|
11
|
+
> `readonly` **Create**: `"identity/create"` = `"identity/create"`
|
|
12
|
+
|
|
13
|
+
Create an identity.
|
|
14
|
+
|
|
15
|
+
### Remove {#remove}
|
|
16
|
+
|
|
17
|
+
> `readonly` **Remove**: `"identity/remove"` = `"identity/remove"`
|
|
18
|
+
|
|
19
|
+
Remove an identity.
|
|
20
|
+
|
|
21
|
+
### VerificationMethodCreate {#verificationmethodcreate}
|
|
22
|
+
|
|
23
|
+
> `readonly` **VerificationMethodCreate**: `"identity/verification-method-create"` = `"identity/verification-method-create"`
|
|
24
|
+
|
|
25
|
+
Create a verification method.
|
|
26
|
+
|
|
27
|
+
### VerificationMethodRemove {#verificationmethodremove}
|
|
28
|
+
|
|
29
|
+
> `readonly` **VerificationMethodRemove**: `"identity/verification-method-remove"` = `"identity/verification-method-remove"`
|
|
30
|
+
|
|
31
|
+
Remove a verification method.
|
|
32
|
+
|
|
33
|
+
### ServiceCreate {#servicecreate}
|
|
34
|
+
|
|
35
|
+
> `readonly` **ServiceCreate**: `"identity/service-create"` = `"identity/service-create"`
|
|
36
|
+
|
|
37
|
+
Create a service.
|
|
38
|
+
|
|
39
|
+
### ServiceRemove {#serviceremove}
|
|
40
|
+
|
|
41
|
+
> `readonly` **ServiceRemove**: `"identity/service-remove"` = `"identity/service-remove"`
|
|
42
|
+
|
|
43
|
+
Remove a service.
|
|
44
|
+
|
|
45
|
+
### AlsoKnownAsAdd {#alsoknownasadd}
|
|
46
|
+
|
|
47
|
+
> `readonly` **AlsoKnownAsAdd**: `"identity/also-known-as-add"` = `"identity/also-known-as-add"`
|
|
48
|
+
|
|
49
|
+
Add an also known as alias.
|
|
50
|
+
|
|
51
|
+
### AlsoKnownAsRemove {#alsoknownasremove}
|
|
52
|
+
|
|
53
|
+
> `readonly` **AlsoKnownAsRemove**: `"identity/also-known-as-remove"` = `"identity/also-known-as-remove"`
|
|
54
|
+
|
|
55
|
+
Remove an also known as alias.
|
|
56
|
+
|
|
57
|
+
### VerifiableCredentialCreate {#verifiablecredentialcreate}
|
|
58
|
+
|
|
59
|
+
> `readonly` **VerifiableCredentialCreate**: `"identity/verifiable-credential-create"` = `"identity/verifiable-credential-create"`
|
|
60
|
+
|
|
61
|
+
Create a verifiable credential.
|
|
62
|
+
|
|
63
|
+
### VerifiableCredentialVerify {#verifiablecredentialverify}
|
|
64
|
+
|
|
65
|
+
> `readonly` **VerifiableCredentialVerify**: `"identity/verifiable-credential-verify"` = `"identity/verifiable-credential-verify"`
|
|
66
|
+
|
|
67
|
+
Verify a verifiable credential.
|
|
68
|
+
|
|
69
|
+
### VerifiableCredentialRevoke {#verifiablecredentialrevoke}
|
|
70
|
+
|
|
71
|
+
> `readonly` **VerifiableCredentialRevoke**: `"identity/verifiable-credential-revoke"` = `"identity/verifiable-credential-revoke"`
|
|
72
|
+
|
|
73
|
+
Revoke a verifiable credential.
|
|
74
|
+
|
|
75
|
+
### VerifiableCredentialUnrevoke {#verifiablecredentialunrevoke}
|
|
76
|
+
|
|
77
|
+
> `readonly` **VerifiableCredentialUnrevoke**: `"identity/verifiable-credential-unrevoke"` = `"identity/verifiable-credential-unrevoke"`
|
|
78
|
+
|
|
79
|
+
Unrevoke a verifiable credential.
|
|
80
|
+
|
|
81
|
+
### VerifiablePresentationCreate {#verifiablepresentationcreate}
|
|
82
|
+
|
|
83
|
+
> `readonly` **VerifiablePresentationCreate**: `"identity/verifiable-presentation-create"` = `"identity/verifiable-presentation-create"`
|
|
84
|
+
|
|
85
|
+
Create a verifiable presentation.
|
|
86
|
+
|
|
87
|
+
### VerifiablePresentationVerify {#verifiablepresentationverify}
|
|
88
|
+
|
|
89
|
+
> `readonly` **VerifiablePresentationVerify**: `"identity/verifiable-presentation-verify"` = `"identity/verifiable-presentation-verify"`
|
|
90
|
+
|
|
91
|
+
Verify a verifiable presentation.
|
|
92
|
+
|
|
93
|
+
### ProofCreate {#proofcreate}
|
|
94
|
+
|
|
95
|
+
> `readonly` **ProofCreate**: `"identity/proof-create"` = `"identity/proof-create"`
|
|
96
|
+
|
|
97
|
+
Create a proof.
|
|
98
|
+
|
|
99
|
+
### ProofVerify {#proofverify}
|
|
100
|
+
|
|
101
|
+
> `readonly` **ProofVerify**: `"identity/proof-verify"` = `"identity/proof-verify"`
|
|
102
|
+
|
|
103
|
+
Verify a proof.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/identity-models",
|
|
3
|
-
"version": "0.9.2-next.
|
|
3
|
+
"version": "0.9.2-next.10",
|
|
4
4
|
"description": "Shared identity models and contracts for consistent data structures across services, connectors, and clients.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -19,6 +19,7 @@
|
|
|
19
19
|
"@twin.org/data-core": "next",
|
|
20
20
|
"@twin.org/data-json-ld": "next",
|
|
21
21
|
"@twin.org/entity": "next",
|
|
22
|
+
"@twin.org/nameof": "next",
|
|
22
23
|
"@twin.org/standards-w3c-did": "next",
|
|
23
24
|
"@twin.org/telemetry-models": "next",
|
|
24
25
|
"@twin.org/web": "next"
|