@twin.org/identity-models 0.0.1-next.8 → 0.0.1

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.
 
@@ -28,51 +30,63 @@ The created document.
 
 ***
 
-### resolveDocument()
+### removeDocument()
 
-> **resolveDocument**(`documentId`): `Promise`\<`IDidDocument`\>
+> **removeDocument**(`controller`, `documentId`): `Promise`\<`void`\>
 
-Resolve a document from its id.
+Remove a document.
 
 #### Parameters
 
-• **documentId**: `string`
+##### controller
 
-The id of the document to resolve.
+`string`
 
-#### Returns
+The controller of the identity who can make changes.
 
-`Promise`\<`IDidDocument`\>
+##### documentId
 
-The resolved document.
+`string`
 
-#### Throws
+The id of the document to remove.
 
-NotFoundError if the id can not be resolved.
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
 
 ***
 
 ### addVerificationMethod()
 
-> **addVerificationMethod**(`controller`, `documentId`, `verificationMethodType`, `verificationMethodId`?): `Promise`\<`IDidDocumentVerificationMethod`\>
+> **addVerificationMethod**(`controller`, `documentId`, `verificationMethodType`, `verificationMethodId?`): `Promise`\<`IDidDocumentVerificationMethod`\>
 
 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 +114,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,26 +150,36 @@ 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
 
 The type of the service.
 
-• **serviceEndpoint**: `string`
+`string` | `string`[]
+
+##### serviceEndpoint
 
 The endpoint for the service.
 
+`string` | `string`[]
+
 #### Returns
 
 `Promise`\<`IDidService`\>
@@ -172,11 +200,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,49 +226,47 @@ NotFoundError if the id can not be resolved.
 
 ### createVerifiableCredential()
 
-> **createVerifiableCredential**\<`T`\>(`controller`, `verificationMethodId`, `id`, `credential`, `revocationIndex`?): `Promise`\<`object`\>
+> **createVerifiableCredential**(`controller`, `verificationMethodId`, `id`, `subject`, `revocationIndex?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
 
 Create a verifiable credential for a verification method.
 
-#### Type Parameters
-
-• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
-
 #### 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**: `T`
+`undefined` | `string`
 
-The credential to store in the verifiable credential.
+##### subject
 
-• **revocationIndex?**: `number`
+`IJsonLdNodeObject`
 
-The bitmap revocation index of the credential, if undefined will not have revocation status.
+The credential subject to store in the verifiable credential.
 
-#### Returns
+##### revocationIndex?
 
-`Promise`\<`object`\>
+`number`
 
-The created verifiable credential and its token.
-
-##### verifiableCredential
+The bitmap revocation index of the credential, if undefined will not have revocation status.
 
-> **verifiableCredential**: `IDidVerifiableCredential`\<`T`\>
+#### Returns
 
-##### jwt
+`Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
 
-> **jwt**: `string`
+The created verifiable credential and its token.
 
 #### Throws
 
@@ -246,34 +276,24 @@ NotFoundError if the id can not be resolved.
 
 ### checkVerifiableCredential()
 
-> **checkVerifiableCredential**\<`T`\>(`credentialJwt`): `Promise`\<`object`\>
+> **checkVerifiableCredential**(`credentialJwt`): `Promise`\<\{ `revoked`: `boolean`; `verifiableCredential?`: `IDidVerifiableCredential`; \}\>
 
 Check a verifiable credential is valid.
 
-#### Type Parameters
-
-• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
-
 #### 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`\<`T`\>
-
 ***
 
 ### revokeVerifiableCredentials()
@@ -284,15 +304,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.
 
@@ -312,15 +338,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.
 
@@ -334,58 +366,60 @@ Nothing.
 
 ### createVerifiablePresentation()
 
-> **createVerifiablePresentation**\<`T`\>(`controller`, `presentationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes`?): `Promise`\<`object`\>
+> **createVerifiablePresentation**(`controller`, `verificationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes?`): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
 
 Create a verifiable presentation from the supplied verifiable credentials.
 
-#### Type Parameters
-
-• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
-
 #### Parameters
 
-• **controller**: `string`
+##### controller
+
+`string`
 
 The controller of the identity who can make changes.
 
-• **presentationMethodId**: `string`
+##### verificationMethodId
+
+`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`\<`T`\>)[]
+`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`\<`T`\>
-
-##### jwt
-
-> **jwt**: `string`
-
 #### Throws
 
 NotFoundError if the id can not be resolved.
@@ -394,102 +428,88 @@ NotFoundError if the id can not be resolved.
 
 ### checkVerifiablePresentation()
 
-> **checkVerifiablePresentation**\<`T`\>(`presentationJwt`): `Promise`\<`object`\>
+> **checkVerifiablePresentation**(`presentationJwt`): `Promise`\<\{ `revoked`: `boolean`; `verifiablePresentation?`: `IDidVerifiablePresentation`; `issuers?`: `IDidDocument`[]; \}\>
 
 Check a verifiable presentation is valid.
 
-#### Type Parameters
-
-• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
-
 #### 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`\<`T`\>
-
-##### issuers?
-
-> `optional` **issuers**: `IDidDocument`[]
-
 ***
 
 ### createProof()
 
-> **createProof**(`controller`, `verificationMethodId`, `bytes`): `Promise`\<`object`\>
+> **createProof**(`controller`, `verificationMethodId`, `proofType`, `unsecureDocument`): `Promise`\<`IProof`\>
 
 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`
+##### proofType
 
-The data bytes to sign.
+`ProofTypes`
 
-#### Returns
+The type of proof to create.
 
-`Promise`\<`object`\>
+##### unsecureDocument
 
-The proof signature type and value.
+`IJsonLdNodeObject`
 
-##### type
+The unsecure document to create the proof for.
 
-> **type**: `string`
+#### Returns
 
-##### value
+`Promise`\<`IProof`\>
 
-> **value**: `Uint8Array`
+The proof.
 
 ***
 
 ### verifyProof()
 
-> **verifyProof**(`verificationMethodId`, `bytes`, `signatureType`, `signatureValue`): `Promise`\<`boolean`\>
+> **verifyProof**(`document`, `proof`): `Promise`\<`boolean`\>
 
 Verify proof for arbitrary data with the specified verification method.
 
 #### Parameters
 
-• **verificationMethodId**: `string`
-
-The verification method id to use.
-
-• **bytes**: `Uint8Array`
+##### document
 
-The data bytes to verify.
+`IJsonLdNodeObject`
 
-• **signatureType**: `string`
+The document to verify.
 
-The type of the signature for the proof.
+##### proof
 
-• **signatureValue**: `Uint8Array`
+`IProof`
 
-The value of the signature for the proof.
+The proof to verify.
 
 #### Returns
 
 `Promise`\<`boolean`\>
 
-True if the signature is valid.
+True if the proof is verified.

package/docs/reference/interfaces/IIdentityCreateRequest.md

@@ -0,0 +1,17 @@
+# Interface: IIdentityCreateRequest
+
+Request to create an identity.
+
+## Properties
+
+### body?
+
+> `optional` **body**: `object`
+
+The data for the request.
+
+#### namespace?
+
+> `optional` **namespace**: `string`
+
+The optional namespace to create the identity in.

package/docs/reference/interfaces/IIdentityCreateResponse.md

@@ -0,0 +1,11 @@
+# Interface: IIdentityCreateResponse
+
+Response to creating an identity.
+
+## Properties
+
+### body
+
+> **body**: `IDidDocument`
+
+The response payload.