@twin.org/identity-service 0.0.1-next.9 → 0.0.1

package/docs/reference/classes/IdentityService.md

@@ -8,31 +8,29 @@ Class which implements the identity contract.
 
 ## Constructors
 
-### new IdentityService()
+### Constructor
 
-> **new IdentityService**(`options`?): [`IdentityService`](IdentityService.md)
+> **new IdentityService**(`options?`): `IdentityService`
 
 Create a new instance of IdentityService.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The options for the service.
-
-• **options.config?**: [`IIdentityServiceConfig`](../interfaces/IIdentityServiceConfig.md)
+[`IIdentityServiceConstructorOptions`](../interfaces/IIdentityServiceConstructorOptions.md)
 
-The configuration for the service.
+The options for the service.
 
 #### Returns
 
-[`IdentityService`](IdentityService.md)
+`IdentityService`
 
 ## Properties
 
 ### NAMESPACE
 
-> `readonly` `static` **NAMESPACE**: `string` = `"did"`
+> `readonly` `static` **NAMESPACE**: `string` = `"identity"`
 
 The namespace supported by the identity service.
 
@@ -50,24 +48,570 @@ Runtime name for the class.
 
 ## Methods
 
-### resolve()
+### identityCreate()
 
-> **resolve**(`documentId`): `Promise`\<`IDidDocument`\>
+> **identityCreate**(`namespace?`, `controller?`): `Promise`\<`IDidDocument`\>
 
-Resolve an identity.
+Create a new identity.
 
 #### Parameters
 
-• **documentId**: `string`
+##### namespace?
+
+`string`
+
+The namespace of the connector to use for the identity, defaults to service configured namespace.
+
+##### controller?
 
-The id of the document to resolve.
+`string`
+
+The controller of the identity who can make changes.
 
 #### Returns
 
 `Promise`\<`IDidDocument`\>
 
-The resolved document.
+The created identity document.
+
+#### Implementation of
+
+`IIdentityComponent.identityCreate`
+
+***
+
+### identityRemove()
+
+> **identityRemove**(`identity`, `controller?`): `Promise`\<`void`\>
+
+Remove an identity.
+
+#### Parameters
+
+##### identity
+
+`string`
+
+The id of the document to remove.
+
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IIdentityComponent.identityRemove`
+
+***
+
+### verificationMethodCreate()
+
+> **verificationMethodCreate**(`identity`, `verificationMethodType`, `verificationMethodId?`, `controller?`): `Promise`\<`IDidDocumentVerificationMethod`\>
+
+Add a verification method to the document in JSON Web key Format.
+
+#### Parameters
+
+##### identity
+
+`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.
+
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
+#### 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.
+
+#### Implementation of
+
+`IIdentityComponent.verificationMethodCreate`
+
+***
+
+### verificationMethodRemove()
+
+> **verificationMethodRemove**(`verificationMethodId`, `controller?`): `Promise`\<`void`\>
+
+Remove a verification method from the document.
+
+#### Parameters
+
+##### verificationMethodId
+
+`string`
+
+The id of the verification method.
+
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+#### Throws
+
+NotSupportedError if the platform does not support multiple revocable keys.
+
+#### Implementation of
+
+`IIdentityComponent.verificationMethodRemove`
+
+***
+
+### serviceCreate()
+
+> **serviceCreate**(`identity`, `serviceId`, `serviceType`, `serviceEndpoint`, `controller?`): `Promise`\<`IDidService`\>
+
+Add a service to the document.
+
+#### Parameters
+
+##### identity
+
+`string`
+
+The id of the document to add the service to.
+
+##### serviceId
+
+`string`
+
+The id of the service.
+
+##### serviceType
+
+The type of the service.
+
+`string` | `string`[]
+
+##### serviceEndpoint
+
+The endpoint for the service.
+
+`string` | `string`[]
+
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
+#### Returns
+
+`Promise`\<`IDidService`\>
+
+The service.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+#### Implementation of
+
+`IIdentityComponent.serviceCreate`
+
+***
+
+### serviceRemove()
+
+> **serviceRemove**(`serviceId`, `controller?`): `Promise`\<`void`\>
+
+Remove a service from the document.
+
+#### Parameters
+
+##### serviceId
+
+`string`
+
+The id of the service.
+
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+#### Implementation of
+
+`IIdentityComponent.serviceRemove`
+
+***
+
+### verifiableCredentialCreate()
+
+> **verifiableCredentialCreate**(`verificationMethodId`, `id`, `subject`, `revocationIndex?`, `controller?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
+
+Create a verifiable credential for a verification method.
+
+#### Parameters
+
+##### verificationMethodId
+
+`string`
+
+The verification method id to use.
+
+##### id
+
+The id of the credential.
+
+`undefined` | `string`
+
+##### subject
+
+`IJsonLdNodeObject`
+
+The credential subject to store in the verifiable credential.
+
+##### revocationIndex?
+
+`number`
+
+The bitmap revocation index of the credential, if undefined will not have revocation status.
+
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
+#### Returns
+
+`Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
+
+The created verifiable credential and its token.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+#### Implementation of
+
+`IIdentityComponent.verifiableCredentialCreate`
+
+***
+
+### verifiableCredentialVerify()
+
+> **verifiableCredentialVerify**(`credentialJwt`): `Promise`\<\{ `revoked`: `boolean`; `verifiableCredential?`: `IDidVerifiableCredential`; \}\>
+
+Verify a verifiable credential is valid.
+
+#### Parameters
+
+##### credentialJwt
+
+`string`
+
+The credential to verify.
+
+#### Returns
+
+`Promise`\<\{ `revoked`: `boolean`; `verifiableCredential?`: `IDidVerifiableCredential`; \}\>
+
+The credential stored in the jwt and the revocation status.
+
+#### Implementation of
+
+`IIdentityComponent.verifiableCredentialVerify`
+
+***
+
+### verifiableCredentialRevoke()
+
+> **verifiableCredentialRevoke**(`issuerIdentity`, `credentialIndex`, `controller?`): `Promise`\<`void`\>
+
+Revoke verifiable credential.
+
+#### Parameters
+
+##### issuerIdentity
+
+`string`
+
+The id of the document to update the revocation list for.
+
+##### credentialIndex
+
+`number`
+
+The revocation bitmap index revoke.
+
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IIdentityComponent.verifiableCredentialRevoke`
+
+***
+
+### verifiableCredentialUnrevoke()
+
+> **verifiableCredentialUnrevoke**(`issuerIdentity`, `credentialIndex`, `controller?`): `Promise`\<`void`\>
+
+Unrevoke verifiable credential.
+
+#### Parameters
+
+##### issuerIdentity
+
+`string`
+
+The id of the document to update the revocation list for.
+
+##### credentialIndex
+
+`number`
+
+The revocation bitmap index to un revoke.
+
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IIdentityComponent.verifiableCredentialUnrevoke`
+
+***
+
+### verifiablePresentationCreate()
+
+> **verifiablePresentationCreate**(`verificationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes?`, `controller?`): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
+
+Create a verifiable presentation from the supplied verifiable credentials.
+
+#### Parameters
+
+##### verificationMethodId
+
+`string`
+
+The method to associate with the presentation.
+
+##### presentationId
+
+The id of the presentation.
+
+`undefined` | `string`
+
+##### contexts
+
+The contexts for the data stored in the verifiable credential.
+
+`undefined` | `IJsonLdContextDefinitionRoot`
+
+##### types
+
+The types for the data stored in the verifiable credential.
+
+`undefined` | `string` | `string`[]
+
+##### verifiableCredentials
+
+(`string` \| `IDidVerifiableCredential`)[]
+
+The credentials to use for creating the presentation in jwt format.
+
+##### expiresInMinutes?
+
+`number`
+
+The time in minutes for the presentation to expire.
+
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
+#### Returns
+
+`Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
+
+The created verifiable presentation and its token.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+#### Implementation of
+
+`IIdentityComponent.verifiablePresentationCreate`
+
+***
+
+### verifiablePresentationVerify()
+
+> **verifiablePresentationVerify**(`presentationJwt`): `Promise`\<\{ `revoked`: `boolean`; `verifiablePresentation?`: `IDidVerifiablePresentation`; `issuers?`: `IDidDocument`[]; \}\>
+
+Verify a verifiable presentation is valid.
+
+#### Parameters
+
+##### presentationJwt
+
+`string`
+
+The presentation to verify.
+
+#### Returns
+
+`Promise`\<\{ `revoked`: `boolean`; `verifiablePresentation?`: `IDidVerifiablePresentation`; `issuers?`: `IDidDocument`[]; \}\>
+
+The presentation stored in the jwt and the revocation status.
+
+#### Implementation of
+
+`IIdentityComponent.verifiablePresentationVerify`
+
+***
+
+### proofCreate()
+
+> **proofCreate**(`verificationMethodId`, `proofType`, `unsecureDocument`, `controller?`): `Promise`\<`IProof`\>
+
+Create a proof for a document with the specified verification method.
+
+#### Parameters
+
+##### verificationMethodId
+
+`string`
+
+The verification method id to use.
+
+##### proofType
+
+`ProofTypes`
+
+The type of proof to create.
+
+##### unsecureDocument
+
+`IJsonLdNodeObject`
+
+The unsecure document to create the proof for.
+
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
+#### Returns
+
+`Promise`\<`IProof`\>
+
+The proof.
+
+#### Implementation of
+
+`IIdentityComponent.proofCreate`
+
+***
+
+### proofVerify()
+
+> **proofVerify**(`document`, `proof`): `Promise`\<`boolean`\>
+
+Verify proof for a document with the specified verification method.
+
+#### Parameters
+
+##### document
+
+`IJsonLdNodeObject`
+
+The document to verify.
+
+##### proof
+
+`IProof`
+
+The proof to verify.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the proof is verified.
 
 #### Implementation of
 
-`IIdentityComponent.resolve`
+`IIdentityComponent.proofVerify`

package/docs/reference/functions/generateRestRoutesIdentity.md

@@ -1,21 +1,25 @@
 # Function: generateRestRoutesIdentity()
 
-> **generateRestRoutesIdentity**(`baseRouteName`, `componentName`): `IRestRoute`[]
+> **generateRestRoutesIdentity**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
 
 The REST routes for identity.
 
 ## Parameters
 
-• **baseRouteName**: `string`
+### baseRouteName
+
+`string`
 
 Prefix to prepend to the paths.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes stored in the ComponentFactory.
 
 ## Returns
 
-`IRestRoute`[]
+`IRestRoute`\<`any`, `any`\>[]
 
 The generated routes.

package/docs/reference/functions/generateRestRoutesIdentityProfile.md

@@ -1,21 +1,25 @@
 # Function: generateRestRoutesIdentityProfile()
 
-> **generateRestRoutesIdentityProfile**(`baseRouteName`, `componentName`): `IRestRoute`[]
+> **generateRestRoutesIdentityProfile**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
 
 The REST routes for identity.
 
 ## Parameters
 
-• **baseRouteName**: `string`
+### baseRouteName
+
+`string`
 
 Prefix to prepend to the paths.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes stored in the ComponentFactory.
 
 ## Returns
 
-`IRestRoute`[]
+`IRestRoute`\<`any`, `any`\>[]
 
 The generated routes.

package/docs/reference/functions/generateRestRoutesIdentityResolver.md

@@ -0,0 +1,25 @@
+# Function: generateRestRoutesIdentityResolver()
+
+> **generateRestRoutesIdentityResolver**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
+
+The REST routes for identity.
+
+## Parameters
+
+### baseRouteName
+
+`string`
+
+Prefix to prepend to the paths.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+## Returns
+
+`IRestRoute`\<`any`, `any`\>[]
+
+The generated routes.

package/docs/reference/functions/identitiesList.md

@@ -6,15 +6,21 @@ Get the list of organizations.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes stored in the ComponentFactory.
 
-• **request**: `IIdentityProfileListRequest`
+### request
+
+`IIdentityProfileListRequest`
 
 The request.