@twin.org/identity-connector-entity-storage 0.0.1-next.19 → 0.0.1-next.21

package/docs/reference/classes/EntityStorageIdentityConnector.md

@@ -16,17 +16,11 @@ Create a new instance of EntityStorageIdentityConnector.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The dependencies for the identity connector.
+[`IEntityStorageIdentityConnectorConstructorOptions`](../interfaces/IEntityStorageIdentityConnectorConstructorOptions.md)
 
-• **options.didDocumentEntityStorageType?**: `string`
-
-The entity storage for the did documents, defaults to "identity-document".
-
-• **options.vaultConnectorType?**: `string`
-
-The vault for the private keys, defaults to "vault".
+The options for the identity connector.
 
 #### Returns
 
@@ -62,7 +56,9 @@ Create a new document.
 
 #### Parameters
 
-• **controller**: `string`
+##### controller
+
+`string`
 
 The controller of the identity who can make changes.
 
@@ -78,34 +74,6 @@ The created document.
 
 ***
 
-### resolveDocument()
-
-> **resolveDocument**(`documentId`): `Promise`\<`IDidDocument`\>
-
-Resolve a document from its id.
-
-#### Parameters
-
-• **documentId**: `string`
-
-The id of the document to resolve.
-
-#### Returns
-
-`Promise`\<`IDidDocument`\>
-
-The resolved document.
-
-#### Throws
-
-NotFoundError if the id can not be resolved.
-
-#### Implementation of
-
-`IIdentityConnector.resolveDocument`
-
-***
-
 ### addVerificationMethod()
 
 > **addVerificationMethod**(`controller`, `documentId`, `verificationMethodType`, `verificationMethodId`?): `Promise`\<`IDidDocumentVerificationMethod`\>
@@ -114,19 +82,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.
 
@@ -158,11 +134,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.
 
@@ -194,23 +174,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.
 
@@ -238,11 +228,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.
 
@@ -264,46 +258,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.
@@ -316,30 +312,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`
-
 #### Implementation of
 
 `IIdentityConnector.checkVerifiableCredential`
@@ -354,15 +344,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.
 
@@ -386,15 +382,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.
 
@@ -412,54 +414,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.
@@ -472,34 +480,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`[]
-
 #### Implementation of
 
 `IIdentityConnector.checkVerifiablePresentation`
@@ -514,15 +512,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.
 
@@ -546,11 +550,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/classes/EntityStorageIdentityProfileConnector.md

@@ -18,17 +18,15 @@ Class which implements the identity profile connector contract.
 
 > **new EntityStorageIdentityProfileConnector**\<`T`, `U`\>(`options`?): [`EntityStorageIdentityProfileConnector`](EntityStorageIdentityProfileConnector.md)\<`T`, `U`\>
 
-Create a new instance of Identity.
+Create a new instance of EntityStorageIdentityProfileConnector.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The dependencies for the identity service.
+[`IEntityStorageIdentityProfileConnectorConstructorOptions`](../interfaces/IEntityStorageIdentityProfileConnectorConstructorOptions.md)
 
-• **options.profileEntityStorageType?**: `string`
-
-The storage connector for the profiles, default to "identity-profile".
+The options for the identity service.
 
 #### Returns
 
@@ -64,15 +62,21 @@ Create the profile properties for an identity.
 
 #### Parameters
 
-• **identity**: `string`
+##### identity
+
+`string`
 
 The identity of the profile to create.
 
-• **publicProfile?**: `T`
+##### publicProfile?
+
+`T`
 
 The public profile data.
 
-• **privateProfile?**: `U`
+##### privateProfile?
+
+`U`
 
 The private profile data.
 
@@ -90,38 +94,36 @@ Nothing.
 
 ### get()
 
-> **get**(`identity`, `publicPropertyNames`?, `privatePropertyNames`?): `Promise`\<`object`\>
+> **get**(`identity`, `publicPropertyNames`?, `privatePropertyNames`?): `Promise`\<\{ `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>
 
 Get the profile properties for an identity.
 
 #### Parameters
 
-• **identity**: `string`
+##### identity
+
+`string`
 
 The identity of the item to get.
 
-• **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.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>
 
 The items properties.
 
-##### publicProfile
-
-> **publicProfile**: `Partial`\<`T`\>
-
-##### privateProfile
-
-> **privateProfile**: `Partial`\<`U`\>
-
 #### Implementation of
 
 `IIdentityProfileConnector.get`
@@ -136,15 +138,21 @@ Update the profile properties of an identity.
 
 #### Parameters
 
-• **identity**: `string`
+##### identity
+
+`string`
 
 The identity to update.
 
-• **publicProfile?**: `T`
+##### publicProfile?
+
+`T`
 
 The public profile data.
 
-• **privateProfile?**: `U`
+##### privateProfile?
+
+`U`
 
 The private profile data.
 
@@ -168,7 +176,9 @@ Delete the profile for an identity.
 
 #### Parameters
 
-• **identity**: `string`
+##### identity
+
+`string`
 
 The identity to delete.
 
@@ -186,54 +196,54 @@ Nothing.
 
 ### list()
 
-> **list**(`publicFilters`?, `privateFilters`?, `publicPropertyNames`?, `privatePropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **list**(`publicFilters`?, `privateFilters`?, `publicPropertyNames`?, `privatePropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<\{ `items`: `object`[]; `cursor`: `string`; \}\>
 
 Get a list of the requested types.
 
 #### Parameters
 
-• **publicFilters?**: `object`[]
+##### publicFilters?
+
+`object`[]
 
 The filters to apply to the identities public profiles.
 
-• **privateFilters?**: `object`[]
+##### privateFilters?
+
+`object`[]
 
 The filters to apply to the identities private profiles.
 
-• **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.
 
-• **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.
-
 #### Implementation of
 
 `IIdentityProfileConnector.list`