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

package/docs/reference/classes/IdentityProfileService.md

@@ -4,9 +4,13 @@ Class which implements the identity profile contract.
 
 ## Type Parameters
 
-• **T** *extends* `IJsonLdDocument` = `IJsonLdDocument`
+### T
 
-• **U** *extends* `IJsonLdDocument` = `IJsonLdDocument`
+`T` *extends* `IJsonLdDocument` = `IJsonLdDocument`
+
+### U
+
+`U` *extends* `IJsonLdDocument` = `IJsonLdDocument`
 
 ## Implements
 
@@ -14,28 +18,34 @@ Class which implements the identity profile contract.
 
 ## Constructors
 
-### new IdentityProfileService()
+### Constructor
 
-> **new IdentityProfileService**\<`T`, `U`\>(`options`?): [`IdentityProfileService`](IdentityProfileService.md)\<`T`, `U`\>
+> **new IdentityProfileService**\<`T`, `U`\>(`options?`): `IdentityProfileService`\<`T`, `U`\>
 
 Create a new instance of IdentityProfileService.
 
 #### Parameters
 
-• **options?**
-
-The dependencies for the identity profile service.
+##### options?
 
-• **options.profileEntityConnectorType?**: `string`
+[`IIdentityProfileServiceConstructorOptions`](../interfaces/IIdentityProfileServiceConstructorOptions.md)
 
-The storage connector for the profiles, default to "identity-profile".
+The dependencies for the identity profile service.
 
 #### Returns
 
-[`IdentityProfileService`](IdentityProfileService.md)\<`T`, `U`\>
+`IdentityProfileService`\<`T`, `U`\>
 
 ## Properties
 
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"identity-profile"`
+
+The namespace supported by the identity profile service.
+
+***
+
 ### CLASS\_NAME
 
 > `readonly` **CLASS\_NAME**: `string`
@@ -50,21 +60,27 @@ Runtime name for the class.
 
 ### create()
 
-> **create**(`publicProfile`?, `privateProfile`?, `identity`?): `Promise`\<`void`\>
+> **create**(`publicProfile?`, `privateProfile?`, `identity?`): `Promise`\<`void`\>
 
 Create the profile properties for an identity.
 
 #### Parameters
 
-• **publicProfile?**: `T`
+##### publicProfile?
+
+`T`
 
 The public profile data as JSON-LD.
 
-• **privateProfile?**: `U`
+##### privateProfile?
+
+`U`
 
 The private profile data as JSON-LD.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the profile operation on.
 
@@ -82,42 +98,36 @@ Nothing.
 
 ### get()
 
-> **get**(`publicPropertyNames`?, `privatePropertyNames`?, `identity`?): `Promise`\<`object`\>
+> **get**(`publicPropertyNames?`, `privatePropertyNames?`, `identity?`): `Promise`\<\{ `identity`: `string`; `publicProfile?`: `Partial`\<`T`\>; `privateProfile?`: `Partial`\<`U`\>; \}\>
 
 Get the profile properties for an identity.
 
 #### Parameters
 
-• **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.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the profile operation on.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `identity`: `string`; `publicProfile?`: `Partial`\<`T`\>; `privateProfile?`: `Partial`\<`U`\>; \}\>
 
 The items identity and the properties.
 
-##### identity
-
-> **identity**: `string`
-
-##### publicProfile?
-
-> `optional` **publicProfile**: `Partial`\<`T`\>
-
-##### privateProfile?
-
-> `optional` **privateProfile**: `Partial`\<`U`\>
-
 #### Implementation of
 
 `IIdentityProfileComponent.get`
@@ -126,17 +136,21 @@ The items identity and the properties.
 
 ### getPublic()
 
-> **getPublic**(`identity`, `propertyNames`?): `Promise`\<`Partial`\<`T`\>\>
+> **getPublic**(`identity`, `propertyNames?`): `Promise`\<`Partial`\<`T`\>\>
 
 Get the public profile properties for an identity.
 
 #### Parameters
 
-• **identity**: `string`
+##### identity
+
+`string`
 
 The identity to perform the profile operation on.
 
-• **propertyNames?**: keyof `T`[]
+##### propertyNames?
+
+keyof `T`[]
 
 The properties to get for the item, defaults to all.
 
@@ -154,21 +168,27 @@ The items properties.
 
 ### update()
 
-> **update**(`publicProfile`?, `privateProfile`?, `identity`?): `Promise`\<`void`\>
+> **update**(`publicProfile?`, `privateProfile?`, `identity?`): `Promise`\<`void`\>
 
 Update the profile properties of an identity.
 
 #### Parameters
 
-• **publicProfile?**: `T`
+##### publicProfile?
+
+`T`
 
 The public profile data as JSON-LD.
 
-• **privateProfile?**: `U`
+##### privateProfile?
+
+`U`
 
 The private profile data as JSON-LD.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the profile operation on.
 
@@ -186,13 +206,15 @@ Nothing.
 
 ### remove()
 
-> **remove**(`identity`?): `Promise`\<`void`\>
+> **remove**(`identity?`): `Promise`\<`void`\>
 
 Delete the profile for an identity.
 
 #### Parameters
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the profile operation on.
 
@@ -210,46 +232,42 @@ Nothing.
 
 ### list()
 
-> **list**(`publicFilters`?, `publicPropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **list**(`publicFilters?`, `publicPropertyNames?`, `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.
 
-• **publicPropertyNames?**: keyof `T`[]
+##### publicPropertyNames?
+
+keyof `T`[]
 
 The public 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
 
 `IIdentityProfileComponent.list`

package/docs/reference/classes/IdentityResolverService.md

@@ -0,0 +1,73 @@
+# Class: IdentityResolverService
+
+Class which implements the identity resolver contract.
+
+## Implements
+
+- `IIdentityResolverComponent`
+
+## Constructors
+
+### Constructor
+
+> **new IdentityResolverService**(`options?`): `IdentityResolverService`
+
+Create a new instance of IdentityResolverService.
+
+#### Parameters
+
+##### options?
+
+[`IIdentityResolverServiceConstructorOptions`](../interfaces/IIdentityResolverServiceConstructorOptions.md)
+
+The options for the service.
+
+#### Returns
+
+`IdentityResolverService`
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"identity-resolver"`
+
+The namespace supported by the identity service.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IIdentityResolverComponent.CLASS_NAME`
+
+## Methods
+
+### identityResolve()
+
+> **identityResolve**(`identity`): `Promise`\<`IDidDocument`\>
+
+Resolve an identity.
+
+#### Parameters
+
+##### identity
+
+`string`
+
+The id of the document to resolve.
+
+#### Returns
+
+`Promise`\<`IDidDocument`\>
+
+The resolved document.
+
+#### Implementation of
+
+`IIdentityResolverComponent.identityResolve`