@twin.org/identity-models 0.0.1-next.19 → 0.0.1-next.20

package/docs/reference/interfaces/IIdentityConnector.md

@@ -16,7 +16,9 @@ Create a new document.
 
 #### Parameters
 
-• **controller**: `string`
+##### controller
+
+`string`
 
 The controller of the identity who can make changes.
 
@@ -36,7 +38,9 @@ Resolve a document from its id.
 
 #### Parameters
 
-• **documentId**: `string`
+##### documentId
+
+`string`
 
 The id of the document to resolve.
 
@@ -60,19 +64,27 @@ Add a verification method to the document in JSON Web key Format.
 
 #### Parameters
 
-• **controller**: `string`
+##### controller
+
+`string`
 
 The controller of the identity who can make changes.
 
-• **documentId**: `string`
+##### documentId
+
+`string`
 
 The id of the document to add the verification method to.
 
-• **verificationMethodType**: `DidVerificationMethodType`
+##### verificationMethodType
+
+`DidVerificationMethodType`
 
 The type of the verification method to add.
 
-• **verificationMethodId?**: `string`
+##### verificationMethodId?
+
+`string`
 
 The id of the verification method, if undefined uses the kid of the generated JWK.
 
@@ -100,11 +112,15 @@ Remove a verification method from the document.
 
 #### Parameters
 
-• **controller**: `string`
+##### controller
+
+`string`
 
 The controller of the identity who can make changes.
 
-• **verificationMethodId**: `string`
+##### verificationMethodId
+
+`string`
 
 The id of the verification method.
 
@@ -132,23 +148,33 @@ Add a service to the document.
 
 #### Parameters
 
-• **controller**: `string`
+##### controller
+
+`string`
 
 The controller of the identity who can make changes.
 
-• **documentId**: `string`
+##### documentId
+
+`string`
 
 The id of the document to add the service to.
 
-• **serviceId**: `string`
+##### serviceId
+
+`string`
 
 The id of the service.
 
-• **serviceType**: `string`
+##### serviceType
+
+`string`
 
 The type of the service.
 
-• **serviceEndpoint**: `string`
+##### serviceEndpoint
+
+`string`
 
 The endpoint for the service.
 
@@ -172,11 +198,15 @@ Remove a service from the document.
 
 #### Parameters
 
-• **controller**: `string`
+##### controller
+
+`string`
 
 The controller of the identity who can make changes.
 
-• **serviceId**: `string`
+##### serviceId
+
+`string`
 
 The id of the service.
 
@@ -194,46 +224,48 @@ NotFoundError if the id can not be resolved.
 
 ### createVerifiableCredential()
 
-> **createVerifiableCredential**(`controller`, `verificationMethodId`, `id`, `credential`, `revocationIndex`?): `Promise`\<`object`\>
+> **createVerifiableCredential**(`controller`, `verificationMethodId`, `id`, `credential`, `revocationIndex`?): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
 
 Create a verifiable credential for a verification method.
 
 #### Parameters
 
-• **controller**: `string`
+##### controller
+
+`string`
 
 The controller of the identity who can make changes.
 
-• **verificationMethodId**: `string`
+##### verificationMethodId
+
+`string`
 
 The verification method id to use.
 
-• **id**: `undefined` \| `string`
+##### id
 
 The id of the credential.
 
-• **credential**: `IJsonLdNodeObject`
+`undefined` | `string`
+
+##### credential
+
+`IJsonLdNodeObject`
 
 The credential to store in the verifiable credential.
 
-• **revocationIndex?**: `number`
+##### revocationIndex?
+
+`number`
 
 The bitmap revocation index of the credential, if undefined will not have revocation status.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
 
 The created verifiable credential and its token.
 
-##### verifiableCredential
-
-> **verifiableCredential**: `IDidVerifiableCredential`
-
-##### jwt
-
-> **jwt**: `string`
-
 #### Throws
 
 NotFoundError if the id can not be resolved.
@@ -242,30 +274,24 @@ NotFoundError if the id can not be resolved.
 
 ### checkVerifiableCredential()
 
-> **checkVerifiableCredential**(`credentialJwt`): `Promise`\<`object`\>
+> **checkVerifiableCredential**(`credentialJwt`): `Promise`\<\{ `revoked`: `boolean`; `verifiableCredential`: `IDidVerifiableCredential`; \}\>
 
 Check a verifiable credential is valid.
 
 #### Parameters
 
-• **credentialJwt**: `string`
+##### credentialJwt
+
+`string`
 
 The credential to verify.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `revoked`: `boolean`; `verifiableCredential`: `IDidVerifiableCredential`; \}\>
 
 The credential stored in the jwt and the revocation status.
 
-##### revoked
-
-> **revoked**: `boolean`
-
-##### verifiableCredential?
-
-> `optional` **verifiableCredential**: `IDidVerifiableCredential`
-
 ***
 
 ### revokeVerifiableCredentials()
@@ -276,15 +302,21 @@ Revoke verifiable credential(s).
 
 #### Parameters
 
-• **controller**: `string`
+##### controller
+
+`string`
 
 The controller of the identity who can make changes.
 
-• **issuerDocumentId**: `string`
+##### issuerDocumentId
+
+`string`
 
 The id of the document to update the revocation list for.
 
-• **credentialIndices**: `number`[]
+##### credentialIndices
+
+`number`[]
 
 The revocation bitmap index or indices to revoke.
 
@@ -304,15 +336,21 @@ Unrevoke verifiable credential(s).
 
 #### Parameters
 
-• **controller**: `string`
+##### controller
+
+`string`
 
 The controller of the identity who can make changes.
 
-• **issuerDocumentId**: `string`
+##### issuerDocumentId
+
+`string`
 
 The id of the document to update the revocation list for.
 
-• **credentialIndices**: `number`[]
+##### credentialIndices
+
+`number`[]
 
 The revocation bitmap index or indices to un revoke.
 
@@ -326,54 +364,60 @@ Nothing.
 
 ### createVerifiablePresentation()
 
-> **createVerifiablePresentation**(`controller`, `presentationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes`?): `Promise`\<`object`\>
+> **createVerifiablePresentation**(`controller`, `presentationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes`?): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
 
 Create a verifiable presentation from the supplied verifiable credentials.
 
 #### Parameters
 
-• **controller**: `string`
+##### controller
+
+`string`
 
 The controller of the identity who can make changes.
 
-• **presentationMethodId**: `string`
+##### presentationMethodId
+
+`string`
 
 The method to associate with the presentation.
 
-• **presentationId**: `undefined` \| `string`
+##### presentationId
 
 The id of the presentation.
 
-• **contexts**: `undefined` \| `IJsonLdContextDefinitionRoot`
+`undefined` | `string`
+
+##### contexts
 
 The contexts for the data stored in the verifiable credential.
 
-• **types**: `undefined` \| `string` \| `string`[]
+`undefined` | `IJsonLdContextDefinitionRoot`
+
+##### types
 
 The types for the data stored in the verifiable credential.
 
-• **verifiableCredentials**: (`string` \| `IDidVerifiableCredential`)[]
+`undefined` | `string` | `string`[]
+
+##### verifiableCredentials
+
+(`string` \| `IDidVerifiableCredential`)[]
 
 The credentials to use for creating the presentation in jwt format.
 
-• **expiresInMinutes?**: `number`
+##### expiresInMinutes?
+
+`number`
 
 The time in minutes for the presentation to expire.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
 
 The created verifiable presentation and its token.
 
-##### verifiablePresentation
-
-> **verifiablePresentation**: `IDidVerifiablePresentation`
-
-##### jwt
-
-> **jwt**: `string`
-
 #### Throws
 
 NotFoundError if the id can not be resolved.
@@ -382,34 +426,24 @@ NotFoundError if the id can not be resolved.
 
 ### checkVerifiablePresentation()
 
-> **checkVerifiablePresentation**(`presentationJwt`): `Promise`\<`object`\>
+> **checkVerifiablePresentation**(`presentationJwt`): `Promise`\<\{ `revoked`: `boolean`; `verifiablePresentation`: `IDidVerifiablePresentation`; `issuers`: `IDidDocument`[]; \}\>
 
 Check a verifiable presentation is valid.
 
 #### Parameters
 
-• **presentationJwt**: `string`
+##### presentationJwt
+
+`string`
 
 The presentation to verify.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `revoked`: `boolean`; `verifiablePresentation`: `IDidVerifiablePresentation`; `issuers`: `IDidDocument`[]; \}\>
 
 The presentation stored in the jwt and the revocation status.
 
-##### revoked
-
-> **revoked**: `boolean`
-
-##### verifiablePresentation?
-
-> `optional` **verifiablePresentation**: `IDidVerifiablePresentation`
-
-##### issuers?
-
-> `optional` **issuers**: `IDidDocument`[]
-
 ***
 
 ### createProof()
@@ -420,15 +454,21 @@ Create a proof for arbitrary data with the specified verification method.
 
 #### Parameters
 
-• **controller**: `string`
+##### controller
+
+`string`
 
 The controller of the identity who can make changes.
 
-• **verificationMethodId**: `string`
+##### verificationMethodId
+
+`string`
 
 The verification method id to use.
 
-• **bytes**: `Uint8Array`
+##### bytes
+
+`Uint8Array`
 
 The data bytes to sign.
 
@@ -448,11 +488,15 @@ Verify proof for arbitrary data with the specified verification method.
 
 #### Parameters
 
-• **bytes**: `Uint8Array`
+##### bytes
+
+`Uint8Array`
 
 The data bytes to verify.
 
-• **proof**: `IDidProof`
+##### proof
+
+`IDidProof`
 
 The proof to verify.
 

package/docs/reference/interfaces/IIdentityProfileComponent.md

@@ -22,15 +22,21 @@ Create the profile properties for an identity.
 
 #### Parameters
 
-• **publicProfile?**: `T`
+##### publicProfile?
+
+`T`
 
 The public profile data as JSON-LD.
 
-• **privateProfile?**: `U`
+##### privateProfile?
+
+`U`
 
 The private profile data as JSON-LD.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the profile operation on.
 
@@ -44,42 +50,36 @@ Nothing.
 
 ### get()
 
-> **get**(`publicPropertyNames`?, `privatePropertyNames`?, `identity`?): `Promise`\<`object`\>
+> **get**(`publicPropertyNames`?, `privatePropertyNames`?, `identity`?): `Promise`\<\{ `identity`: `string`; `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>
 
 Get the profile properties for an identity.
 
 #### Parameters
 
-• **publicPropertyNames?**: keyof `T`[]
+##### publicPropertyNames?
+
+keyof `T`[]
 
 The public properties to get for the profile, defaults to all.
 
-• **privatePropertyNames?**: keyof `U`[]
+##### privatePropertyNames?
+
+keyof `U`[]
 
 The private properties to get for the profile, defaults to all.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the profile operation on.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `identity`: `string`; `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>
 
 The items identity and the properties.
 
-##### identity
-
-> **identity**: `string`
-
-##### publicProfile?
-
-> `optional` **publicProfile**: `Partial`\<`T`\>
-
-##### privateProfile?
-
-> `optional` **privateProfile**: `Partial`\<`U`\>
-
 ***
 
 ### getPublic()
@@ -90,11 +90,15 @@ Get the public profile properties for an identity.
 
 #### Parameters
 
-• **identity**: `string`
+##### identity
+
+`string`
 
 The identity to perform the profile operation on.
 
-• **propertyNames?**: keyof `T`[]
+##### propertyNames?
+
+keyof `T`[]
 
 The public properties to get for the profile, defaults to all.
 
@@ -114,15 +118,21 @@ Update the profile properties of an identity.
 
 #### Parameters
 
-• **publicProfile?**: `T`
+##### publicProfile?
+
+`T`
 
 The public profile data as JSON-LD.
 
-• **privateProfile?**: `U`
+##### privateProfile?
+
+`U`
 
 The private profile data as JSON-LD.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the profile operation on.
 
@@ -142,7 +152,9 @@ Delete the profile for an identity.
 
 #### Parameters
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the profile operation on.
 
@@ -156,42 +168,38 @@ Nothing.
 
 ### list()
 
-> **list**(`publicFilters`?, `publicPropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **list**(`publicFilters`?, `publicPropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<\{ `items`: `object`[]; `cursor`: `string`; \}\>
 
 Get a list of the requested identities.
 
 #### Parameters
 
-• **publicFilters?**: `object`[]
+##### publicFilters?
+
+`object`[]
 
 The filters to apply to the identities public profiles.
 
-• **publicPropertyNames?**: keyof `T`[]
+##### publicPropertyNames?
+
+keyof `T`[]
 
 The public properties to get for the profile, defaults to all.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor for paged requests.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The maximum number of items in a page.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `items`: `object`[]; `cursor`: `string`; \}\>
 
 The list of items and cursor for paging.
-
-##### items
-
-> **items**: `object`[]
-
-The identities.
-
-##### cursor?
-
-> `optional` **cursor**: `string`
-
-An optional cursor, when defined can be used to call find to get more entities.