@twin.org/identity-service 0.0.3-next.2 → 0.0.3-next.21

package/docs/reference/classes/IdentityProfileService.md

@@ -38,7 +38,7 @@ The dependencies for the identity profile service.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -46,7 +46,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -64,7 +64,7 @@ The class name of the component.
 
 ***
 
-### create()
+### create() {#create}
 
 > **create**(`publicProfile?`, `privateProfile?`, `identity?`): `Promise`\<`void`\>
 
@@ -102,7 +102,7 @@ Nothing.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`publicPropertyNames?`, `privatePropertyNames?`, `identity?`): `Promise`\<\{ `identity`: `string`; `publicProfile?`: `Partial`\<`T`\>; `privateProfile?`: `Partial`\<`U`\>; \}\>
 
@@ -140,7 +140,7 @@ The items identity and the properties.
 
 ***
 
-### getPublic()
+### getPublic() {#getpublic}
 
 > **getPublic**(`identity`, `propertyNames?`): `Promise`\<`Partial`\<`T`\>\>
 
@@ -172,7 +172,7 @@ The items properties.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`publicProfile?`, `privateProfile?`, `identity?`): `Promise`\<`void`\>
 
@@ -210,7 +210,7 @@ Nothing.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`identity?`): `Promise`\<`void`\>
 
@@ -236,7 +236,7 @@ Nothing.
 
 ***
 
-### list()
+### list() {#list}
 
 > **list**(`publicFilters?`, `publicPropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
 

package/docs/reference/classes/IdentityResolverService.md

@@ -28,7 +28,7 @@ The options for the service.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -36,7 +36,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -54,7 +54,7 @@ The class name of the component.
 
 ***
 
-### identityResolve()
+### identityResolve() {#identityresolve}
 
 > **identityResolve**(`identity`): `Promise`\<`IDidDocument`\>
 

package/docs/reference/classes/IdentityService.md

@@ -28,7 +28,7 @@ The options for the service.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -36,7 +36,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -54,7 +54,7 @@ The class name of the component.
 
 ***
 
-### identityCreate()
+### identityCreate() {#identitycreate}
 
 > **identityCreate**(`namespace?`, `controller?`): `Promise`\<`IDidDocument`\>
 
@@ -86,7 +86,7 @@ The created identity document.
 
 ***
 
-### identityRemove()
+### identityRemove() {#identityremove}
 
 > **identityRemove**(`identity`, `controller?`): `Promise`\<`void`\>
 
@@ -118,7 +118,7 @@ Nothing.
 
 ***
 
-### verificationMethodCreate()
+### verificationMethodCreate() {#verificationmethodcreate}
 
 > **verificationMethodCreate**(`identity`, `verificationMethodType`, `verificationMethodId?`, `controller?`): `Promise`\<`IDidDocumentVerificationMethod`\>
 
@@ -170,7 +170,7 @@ NotSupportedError if the platform does not support multiple keys.
 
 ***
 
-### verificationMethodRemove()
+### verificationMethodRemove() {#verificationmethodremove}
 
 > **verificationMethodRemove**(`verificationMethodId`, `controller?`): `Promise`\<`void`\>
 
@@ -210,7 +210,7 @@ NotSupportedError if the platform does not support multiple revocable keys.
 
 ***
 
-### serviceCreate()
+### serviceCreate() {#servicecreate}
 
 > **serviceCreate**(`identity`, `serviceId`, `serviceType`, `serviceEndpoint`, `controller?`): `Promise`\<`IDidService`\>
 
@@ -232,15 +232,15 @@ The id of the service.
 
 ##### serviceType
 
-The type of the service.
+`string` \| `string`[]
 
-`string` | `string`[]
+The type of the service.
 
 ##### serviceEndpoint
 
-The endpoint for the service.
+`string` \| `string`[]
 
-`string` | `string`[]
+The endpoint for the service.
 
 ##### controller?
 
@@ -264,7 +264,7 @@ NotFoundError if the id can not be resolved.
 
 ***
 
-### serviceRemove()
+### serviceRemove() {#serviceremove}
 
 > **serviceRemove**(`serviceId`, `controller?`): `Promise`\<`void`\>
 
@@ -300,7 +300,101 @@ NotFoundError if the id can not be resolved.
 
 ***
 
-### verifiableCredentialCreate()
+### alsoKnownAsAdd() {#alsoknownasadd}
+
+> **alsoKnownAsAdd**(`documentId`, `alias`, `controller?`): `Promise`\<`void`\>
+
+Add an alias to the alsoKnownAs property on the document.
+If the alias is already present the operation is a no-op.
+
+#### Parameters
+
+##### documentId
+
+`string`
+
+The id of the document to update.
+
+##### alias
+
+`string`
+
+The alias to add. Must be a Url or Urn (typically another DID).
+
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Throws
+
+GeneralError if the alias is not a Url or Urn.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+#### Implementation of
+
+`IIdentityComponent.alsoKnownAsAdd`
+
+***
+
+### alsoKnownAsRemove() {#alsoknownasremove}
+
+> **alsoKnownAsRemove**(`documentId`, `alias`, `controller?`): `Promise`\<`void`\>
+
+Remove an alias from the alsoKnownAs property on the document.
+If the alias is not present the operation is a no-op.
+
+#### Parameters
+
+##### documentId
+
+`string`
+
+The id of the document to update.
+
+##### alias
+
+`string`
+
+The alias to remove. Must be a Url or Urn.
+
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Throws
+
+GeneralError if the alias is not a Url or Urn.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+#### Implementation of
+
+`IIdentityComponent.alsoKnownAsRemove`
+
+***
+
+### verifiableCredentialCreate() {#verifiablecredentialcreate}
 
 > **verifiableCredentialCreate**(`verificationMethodId`, `id`, `subject`, `options?`, `controller?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
 
@@ -316,9 +410,9 @@ The verification method id to use.
 
 ##### id
 
-The id of the credential.
+`string` \| `undefined`
 
-`string` | `undefined`
+The id of the credential.
 
 ##### subject
 
@@ -364,17 +458,17 @@ NotFoundError if the id can not be resolved.
 
 ***
 
-### verifiableCredentialVerify()
+### verifiableCredentialVerify() {#verifiablecredentialverify}
 
-> **verifiableCredentialVerify**(`credentialJwt`): `Promise`\<\{ `revoked`: `boolean`; `verifiableCredential?`: `IDidVerifiableCredential`; \}\>
+> **verifiableCredentialVerify**(`credential`): `Promise`\<\{ `revoked`: `boolean`; `verifiableCredential?`: `IDidVerifiableCredential`; \}\>
 
 Verify a verifiable credential is valid.
 
 #### Parameters
 
-##### credentialJwt
+##### credential
 
-`string`
+`string` \| `IDidVerifiableCredential`
 
 The credential to verify.
 
@@ -390,7 +484,7 @@ The credential stored in the jwt and the revocation status.
 
 ***
 
-### verifiableCredentialRevoke()
+### verifiableCredentialRevoke() {#verifiablecredentialrevoke}
 
 > **verifiableCredentialRevoke**(`issuerIdentity`, `credentialIndex`, `controller?`): `Promise`\<`void`\>
 
@@ -428,7 +522,7 @@ Nothing.
 
 ***
 
-### verifiableCredentialUnrevoke()
+### verifiableCredentialUnrevoke() {#verifiablecredentialunrevoke}
 
 > **verifiableCredentialUnrevoke**(`issuerIdentity`, `credentialIndex`, `controller?`): `Promise`\<`void`\>
 
@@ -466,9 +560,9 @@ Nothing.
 
 ***
 
-### verifiablePresentationCreate()
+### verifiablePresentationCreate() {#verifiablepresentationcreate}
 
-> **verifiablePresentationCreate**(`verificationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes?`, `controller?`): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
+> **verifiablePresentationCreate**(`verificationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `options?`, `controller?`): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
 
 Create a verifiable presentation from the supplied verifiable credentials.
 
@@ -482,21 +576,21 @@ The method to associate with the presentation.
 
 ##### presentationId
 
-The id of the presentation.
+`string` \| `undefined`
 
-`string` | `undefined`
+The id of the presentation.
 
 ##### contexts
 
-The contexts for the data stored in the verifiable credential.
+`IJsonLdContextDefinitionRoot` \| `undefined`
 
-`IJsonLdContextDefinitionRoot` | `undefined`
+The contexts for the data stored in the verifiable credential.
 
 ##### types
 
-The types for the data stored in the verifiable credential.
+`string` \| `string`[] \| `undefined`
 
-`string` | `string`[] | `undefined`
+The types for the data stored in the verifiable credential.
 
 ##### verifiableCredentials
 
@@ -504,11 +598,15 @@ The types for the data stored in the verifiable credential.
 
 The credentials to use for creating the presentation in jwt format.
 
-##### expiresInMinutes?
+##### options?
 
-`number`
+Additional options for creating the verifiable presentation.
 
-The time in minutes for the presentation to expire.
+###### expirationDate?
+
+`Date`
+
+The date the verifiable presentation is valid until.
 
 ##### controller?
 
@@ -532,17 +630,17 @@ NotFoundError if the id can not be resolved.
 
 ***
 
-### verifiablePresentationVerify()
+### verifiablePresentationVerify() {#verifiablepresentationverify}
 
-> **verifiablePresentationVerify**(`presentationJwt`): `Promise`\<\{ `revoked`: `boolean`; `verifiablePresentation?`: `IDidVerifiablePresentation`; `issuers?`: `IDidDocument`[]; \}\>
+> **verifiablePresentationVerify**(`presentation`): `Promise`\<\{ `revoked`: `boolean`; `verifiablePresentation?`: `IDidVerifiablePresentation`; `issuers?`: `IDidDocument`[]; \}\>
 
 Verify a verifiable presentation is valid.
 
 #### Parameters
 
-##### presentationJwt
+##### presentation
 
-`string`
+`string` \| `IDidVerifiablePresentation`
 
 The presentation to verify.
 
@@ -558,7 +656,7 @@ The presentation stored in the jwt and the revocation status.
 
 ***
 
-### proofCreate()
+### proofCreate() {#proofcreate}
 
 > **proofCreate**(`verificationMethodId`, `proofType`, `unsecureDocument`, `controller?`): `Promise`\<`IProof`\>
 
@@ -602,7 +700,7 @@ The proof.
 
 ***
 
-### proofVerify()
+### proofVerify() {#proofverify}
 
 > **proofVerify**(`document`, `proof`): `Promise`\<`boolean`\>
 

package/docs/reference/functions/identityAlsoKnownAsCreate.md

@@ -0,0 +1,31 @@
+# Function: identityAlsoKnownAsCreate()
+
+> **identityAlsoKnownAsCreate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Create an identity alias.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityAlsoKnownAsCreateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityAlsoKnownAsRemove.md

@@ -0,0 +1,31 @@
+# Function: identityAlsoKnownAsRemove()
+
+> **identityAlsoKnownAsRemove**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Remove an identity alias.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityAlsoKnownAsRemoveRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityVerifiableCredentialVerifyDocument.md

@@ -0,0 +1,31 @@
+# Function: identityVerifiableCredentialVerifyDocument()
+
+> **identityVerifiableCredentialVerifyDocument**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityVerifiableCredentialVerifyResponse`\>
+
+Verify a verifiable credential document.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityVerifiableCredentialVerifyDocumentRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityVerifiableCredentialVerifyResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityVerifiablePresentationVerifyDocument.md

@@ -0,0 +1,31 @@
+# Function: identityVerifiablePresentationVerifyDocument()
+
+> **identityVerifiablePresentationVerifyDocument**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityVerifiablePresentationVerifyResponse`\>
+
+Verify a verifiable presentation document.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityVerifiablePresentationVerifyDocumentRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityVerifiablePresentationVerifyResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -39,11 +39,15 @@
 - [identityVerificationMethodRemove](functions/identityVerificationMethodRemove.md)
 - [identityServiceCreate](functions/identityServiceCreate.md)
 - [identityServiceRemove](functions/identityServiceRemove.md)
+- [identityAlsoKnownAsCreate](functions/identityAlsoKnownAsCreate.md)
+- [identityAlsoKnownAsRemove](functions/identityAlsoKnownAsRemove.md)
 - [identityVerifiableCredentialCreate](functions/identityVerifiableCredentialCreate.md)
 - [identityVerifiableCredentialVerify](functions/identityVerifiableCredentialVerify.md)
+- [identityVerifiableCredentialVerifyDocument](functions/identityVerifiableCredentialVerifyDocument.md)
 - [identityVerifiableCredentialRevoke](functions/identityVerifiableCredentialRevoke.md)
 - [identityVerifiableCredentialUnrevoke](functions/identityVerifiableCredentialUnrevoke.md)
 - [identityVerifiablePresentationCreate](functions/identityVerifiablePresentationCreate.md)
 - [identityVerifiablePresentationVerify](functions/identityVerifiablePresentationVerify.md)
+- [identityVerifiablePresentationVerifyDocument](functions/identityVerifiablePresentationVerifyDocument.md)
 - [identityProofCreate](functions/identityProofCreate.md)
 - [identityProofVerify](functions/identityProofVerify.md)

package/docs/reference/interfaces/IIdentityProfileServiceConstructorOptions.md

@@ -4,9 +4,9 @@ Options for the identity profile service constructor.
 
 ## Properties
 
-### profileEntityConnectorType?
+### profileEntityConnectorType? {#profileentityconnectortype}
 
-> `optional` **profileEntityConnectorType**: `string`
+> `optional` **profileEntityConnectorType?**: `string`
 
 The storage connector for the profiles.
 

package/docs/reference/interfaces/IIdentityResolverServiceConfig.md

@@ -4,8 +4,8 @@ Configuration for the Identity Resolver Service.
 
 ## Properties
 
-### defaultNamespace?
+### defaultNamespace? {#defaultnamespace}
 
-> `optional` **defaultNamespace**: `string`
+> `optional` **defaultNamespace?**: `string`
 
 What is the default connector to use for Identity. If not provided the first connector from the factory will be used.

package/docs/reference/interfaces/IIdentityResolverServiceConstructorOptions.md

@@ -4,9 +4,9 @@ Options for the identity resolver service constructor.
 
 ## Properties
 
-### fallbackResolverConnectorType?
+### fallbackResolverConnectorType? {#fallbackresolverconnectortype}
 
-> `optional` **fallbackResolverConnectorType**: `string`
+> `optional` **fallbackResolverConnectorType?**: `string`
 
 Fallback connector type to use if the namespace connector is not available.
 
@@ -18,8 +18,8 @@ universal
 
 ***
 
-### config?
+### config? {#config}
 
-> `optional` **config**: [`IIdentityResolverServiceConfig`](IIdentityResolverServiceConfig.md)
+> `optional` **config?**: [`IIdentityResolverServiceConfig`](IIdentityResolverServiceConfig.md)
 
 The configuration for the identity service.

package/docs/reference/interfaces/IIdentityServiceConfig.md

@@ -4,8 +4,8 @@ Configuration for the Identity Service.
 
 ## Properties
 
-### defaultNamespace?
+### defaultNamespace? {#defaultnamespace}
 
-> `optional` **defaultNamespace**: `string`
+> `optional` **defaultNamespace?**: `string`
 
 What is the default connector to use for Identity. If not provided the first connector from the factory will be used.

package/docs/reference/interfaces/IIdentityServiceConstructorOptions.md

@@ -4,8 +4,8 @@ Options for the identity service constructor.
 
 ## Properties
 
-### config?
+### config? {#config}
 
-> `optional` **config**: [`IIdentityServiceConfig`](IIdentityServiceConfig.md)
+> `optional` **config?**: [`IIdentityServiceConfig`](IIdentityServiceConfig.md)
 
 The configuration for the identity service.

package/locales/en.json

@@ -11,6 +11,8 @@
 			"verificationMethodRemoveFailed": "Removing the verification method failed \"{verificationMethodId}\"",
 			"serviceCreateFailed": "Creating the service failed for identity \"{identity}\", service \"{serviceId}\"",
 			"serviceRemoveFailed": "Removing the service failed \"{serviceId}\"",
+			"alsoKnownAsAddFailed": "Adding to the alsoKnownAs property failed for identity \"{identity}\"",
+			"alsoKnownAsRemoveFailed": "Removing from the alsoKnownAs property failed for identity \"{identity}\"",
 			"verifiableCredentialCreateFailed": "Creating the verifiable credential failed for method \"{verificationMethodId}\"",
 			"verifiableCredentialVerifyFailed": "Verifying the verifiable credential failed",
 			"verifiableCredentialRevokeFailed": "Revoking the verifiable credential failed for document \"{issuerIdentity}\" with index \"{credentialIndex}\"",