@twin.org/identity-models 0.0.1-next.10

package/docs/reference/interfaces/IIdentityConnector.md

@@ -0,0 +1,495 @@
+# Interface: IIdentityConnector
+
+Interface describing an identity connector.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### createDocument()
+
+> **createDocument**(`controller`): `Promise`\<`IDidDocument`\>
+
+Create a new document.
+
+#### Parameters
+
+• **controller**: `string`
+
+The controller of the identity who can make changes.
+
+#### Returns
+
+`Promise`\<`IDidDocument`\>
+
+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.
+
+***
+
+### addVerificationMethod()
+
+> **addVerificationMethod**(`controller`, `documentId`, `verificationMethodType`, `verificationMethodId`?): `Promise`\<`IDidDocumentVerificationMethod`\>
+
+Add a verification method to the document in JSON Web key Format.
+
+#### Parameters
+
+• **controller**: `string`
+
+The controller of the identity who can make changes.
+
+• **documentId**: `string`
+
+The id of the document to add the verification method to.
+
+• **verificationMethodType**: `DidVerificationMethodType`
+
+The type of the verification method to add.
+
+• **verificationMethodId?**: `string`
+
+The id of the verification method, if undefined uses the kid of the generated JWK.
+
+#### Returns
+
+`Promise`\<`IDidDocumentVerificationMethod`\>
+
+The verification method.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+#### Throws
+
+NotSupportedError if the platform does not support multiple keys.
+
+***
+
+### removeVerificationMethod()
+
+> **removeVerificationMethod**(`controller`, `verificationMethodId`): `Promise`\<`void`\>
+
+Remove a verification method from the document.
+
+#### Parameters
+
+• **controller**: `string`
+
+The controller of the identity who can make changes.
+
+• **verificationMethodId**: `string`
+
+The id of the verification method.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+#### Throws
+
+NotSupportedError if the platform does not support multiple revocable keys.
+
+***
+
+### addService()
+
+> **addService**(`controller`, `documentId`, `serviceId`, `serviceType`, `serviceEndpoint`): `Promise`\<`IDidService`\>
+
+Add a service to the document.
+
+#### Parameters
+
+• **controller**: `string`
+
+The controller of the identity who can make changes.
+
+• **documentId**: `string`
+
+The id of the document to add the service to.
+
+• **serviceId**: `string`
+
+The id of the service.
+
+• **serviceType**: `string`
+
+The type of the service.
+
+• **serviceEndpoint**: `string`
+
+The endpoint for the service.
+
+#### Returns
+
+`Promise`\<`IDidService`\>
+
+The service.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+***
+
+### removeService()
+
+> **removeService**(`controller`, `serviceId`): `Promise`\<`void`\>
+
+Remove a service from the document.
+
+#### Parameters
+
+• **controller**: `string`
+
+The controller of the identity who can make changes.
+
+• **serviceId**: `string`
+
+The id of the service.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+***
+
+### createVerifiableCredential()
+
+> **createVerifiableCredential**\<`T`\>(`controller`, `verificationMethodId`, `id`, `credential`, `revocationIndex`?): `Promise`\<`object`\>
+
+Create a verifiable credential for a verification method.
+
+#### Type Parameters
+
+• **T** *extends* `IJsonLdObject` = `IJsonLdObject`
+
+#### Parameters
+
+• **controller**: `string`
+
+The controller of the identity who can make changes.
+
+• **verificationMethodId**: `string`
+
+The verification method id to use.
+
+• **id**: `undefined` \| `string`
+
+The id of the credential.
+
+• **credential**: `T`
+
+The credential to store in the verifiable credential.
+
+• **revocationIndex?**: `number`
+
+The bitmap revocation index of the credential, if undefined will not have revocation status.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The created verifiable credential and its token.
+
+##### verifiableCredential
+
+> **verifiableCredential**: `IDidVerifiableCredential`\<`T`\>
+
+##### jwt
+
+> **jwt**: `string`
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+***
+
+### checkVerifiableCredential()
+
+> **checkVerifiableCredential**\<`T`\>(`credentialJwt`): `Promise`\<`object`\>
+
+Check a verifiable credential is valid.
+
+#### Type Parameters
+
+• **T** *extends* `IJsonLdObject` = `IJsonLdObject`
+
+#### Parameters
+
+• **credentialJwt**: `string`
+
+The credential to verify.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The credential stored in the jwt and the revocation status.
+
+##### revoked
+
+> **revoked**: `boolean`
+
+##### verifiableCredential?
+
+> `optional` **verifiableCredential**: `IDidVerifiableCredential`\<`T`\>
+
+***
+
+### revokeVerifiableCredentials()
+
+> **revokeVerifiableCredentials**(`controller`, `issuerDocumentId`, `credentialIndices`): `Promise`\<`void`\>
+
+Revoke verifiable credential(s).
+
+#### Parameters
+
+• **controller**: `string`
+
+The controller of the identity who can make changes.
+
+• **issuerDocumentId**: `string`
+
+The id of the document to update the revocation list for.
+
+• **credentialIndices**: `number`[]
+
+The revocation bitmap index or indices to revoke.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### unrevokeVerifiableCredentials()
+
+> **unrevokeVerifiableCredentials**(`controller`, `issuerDocumentId`, `credentialIndices`): `Promise`\<`void`\>
+
+Unrevoke verifiable credential(s).
+
+#### Parameters
+
+• **controller**: `string`
+
+The controller of the identity who can make changes.
+
+• **issuerDocumentId**: `string`
+
+The id of the document to update the revocation list for.
+
+• **credentialIndices**: `number`[]
+
+The revocation bitmap index or indices to un revoke.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### createVerifiablePresentation()
+
+> **createVerifiablePresentation**\<`T`\>(`controller`, `presentationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes`?): `Promise`\<`object`\>
+
+Create a verifiable presentation from the supplied verifiable credentials.
+
+#### Type Parameters
+
+• **T** *extends* `IJsonLdObject` = `IJsonLdObject`
+
+#### Parameters
+
+• **controller**: `string`
+
+The controller of the identity who can make changes.
+
+• **presentationMethodId**: `string`
+
+The method to associate with the presentation.
+
+• **presentationId**: `undefined` \| `string`
+
+The id of the presentation.
+
+• **contexts**: `undefined` \| `IJsonLdContextDefinitionRoot`
+
+The contexts for the data stored in the verifiable credential.
+
+• **types**: `undefined` \| `string` \| `string`[]
+
+The types for the data stored in the verifiable credential.
+
+• **verifiableCredentials**: (`string` \| `IDidVerifiableCredential`\<`T`\>)[]
+
+The credentials to use for creating the presentation in jwt format.
+
+• **expiresInMinutes?**: `number`
+
+The time in minutes for the presentation to expire.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The created verifiable presentation and its token.
+
+##### verifiablePresentation
+
+> **verifiablePresentation**: `IDidVerifiablePresentation`\<`T`\>
+
+##### jwt
+
+> **jwt**: `string`
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+***
+
+### checkVerifiablePresentation()
+
+> **checkVerifiablePresentation**\<`T`\>(`presentationJwt`): `Promise`\<`object`\>
+
+Check a verifiable presentation is valid.
+
+#### Type Parameters
+
+• **T** *extends* `IJsonLdObject` = `IJsonLdObject`
+
+#### Parameters
+
+• **presentationJwt**: `string`
+
+The presentation to verify.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The presentation stored in the jwt and the revocation status.
+
+##### revoked
+
+> **revoked**: `boolean`
+
+##### verifiablePresentation?
+
+> `optional` **verifiablePresentation**: `IDidVerifiablePresentation`\<`T`\>
+
+##### issuers?
+
+> `optional` **issuers**: `IDidDocument`[]
+
+***
+
+### createProof()
+
+> **createProof**(`controller`, `verificationMethodId`, `bytes`): `Promise`\<`object`\>
+
+Create a proof for arbitrary data with the specified verification method.
+
+#### Parameters
+
+• **controller**: `string`
+
+The controller of the identity who can make changes.
+
+• **verificationMethodId**: `string`
+
+The verification method id to use.
+
+• **bytes**: `Uint8Array`
+
+The data bytes to sign.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The proof signature type and value.
+
+##### type
+
+> **type**: `string`
+
+##### value
+
+> **value**: `Uint8Array`
+
+***
+
+### verifyProof()
+
+> **verifyProof**(`verificationMethodId`, `bytes`, `signatureType`, `signatureValue`): `Promise`\<`boolean`\>
+
+Verify proof for arbitrary data with the specified verification method.
+
+#### Parameters
+
+• **verificationMethodId**: `string`
+
+The verification method id to use.
+
+• **bytes**: `Uint8Array`
+
+The data bytes to verify.
+
+• **signatureType**: `string`
+
+The type of the signature for the proof.
+
+• **signatureValue**: `Uint8Array`
+
+The value of the signature for the proof.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the signature is valid.

package/docs/reference/interfaces/IIdentityProfileComponent.md

@@ -0,0 +1,197 @@
+# Interface: IIdentityProfileComponent\<T, U\>
+
+Interface describing a contract which provides profile operations.
+
+## Extends
+
+- `IComponent`
+
+## Type Parameters
+
+• **T** *extends* `IJsonLdDocument` = `IJsonLdDocument`
+
+• **U** *extends* `IJsonLdDocument` = `IJsonLdDocument`
+
+## Methods
+
+### create()
+
+> **create**(`publicProfile`?, `privateProfile`?, `identity`?): `Promise`\<`void`\>
+
+Create the profile properties for an identity.
+
+#### Parameters
+
+• **publicProfile?**: `T`
+
+The public profile data as JSON-LD.
+
+• **privateProfile?**: `U`
+
+The private profile data as JSON-LD.
+
+• **identity?**: `string`
+
+The identity to perform the profile operation on.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### get()
+
+> **get**(`publicPropertyNames`?, `privatePropertyNames`?, `identity`?): `Promise`\<`object`\>
+
+Get the profile properties for an identity.
+
+#### Parameters
+
+• **publicPropertyNames?**: keyof `T`[]
+
+The public properties to get for the profile, defaults to all.
+
+• **privatePropertyNames?**: keyof `U`[]
+
+The private properties to get for the profile, defaults to all.
+
+• **identity?**: `string`
+
+The identity to perform the profile operation on.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The items identity and the properties.
+
+##### identity
+
+> **identity**: `string`
+
+##### publicProfile?
+
+> `optional` **publicProfile**: `Partial`\<`T`\>
+
+##### privateProfile?
+
+> `optional` **privateProfile**: `Partial`\<`U`\>
+
+***
+
+### getPublic()
+
+> **getPublic**(`identity`, `propertyNames`?): `Promise`\<`Partial`\<`T`\>\>
+
+Get the public profile properties for an identity.
+
+#### Parameters
+
+• **identity**: `string`
+
+The identity to perform the profile operation on.
+
+• **propertyNames?**: keyof `T`[]
+
+The public properties to get for the profile, defaults to all.
+
+#### Returns
+
+`Promise`\<`Partial`\<`T`\>\>
+
+The items properties.
+
+***
+
+### update()
+
+> **update**(`publicProfile`?, `privateProfile`?, `identity`?): `Promise`\<`void`\>
+
+Update the profile properties of an identity.
+
+#### Parameters
+
+• **publicProfile?**: `T`
+
+The public profile data as JSON-LD.
+
+• **privateProfile?**: `U`
+
+The private profile data as JSON-LD.
+
+• **identity?**: `string`
+
+The identity to perform the profile operation on.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### remove()
+
+> **remove**(`identity`?): `Promise`\<`void`\>
+
+Delete the profile for an identity.
+
+#### Parameters
+
+• **identity?**: `string`
+
+The identity to perform the profile operation on.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### list()
+
+> **list**(`publicFilters`?, `publicPropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+
+Get a list of the requested identities.
+
+#### Parameters
+
+• **publicFilters?**: `object`[]
+
+The filters to apply to the identities public profiles.
+
+• **publicPropertyNames?**: keyof `T`[]
+
+The public properties to get for the profile, defaults to all.
+
+• **cursor?**: `string`
+
+The cursor for paged requests.
+
+• **pageSize?**: `number`
+
+The maximum number of items in a page.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+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.