@twin.org/identity-service 0.0.1-next.3

package/docs/reference/classes/IdentityProfileService.md

@@ -0,0 +1,255 @@
+# Class: IdentityProfileService\<T, U\>
+
+Class which implements the identity profile contract.
+
+## Type Parameters
+
+• **T** *extends* `IJsonLdDocument` = `IJsonLdDocument`
+
+• **U** *extends* `IJsonLdDocument` = `IJsonLdDocument`
+
+## Implements
+
+- `IIdentityProfileComponent`\<`T`, `U`\>
+
+## Constructors
+
+### new IdentityProfileService()
+
+> **new IdentityProfileService**\<`T`, `U`\>(`options`?): [`IdentityProfileService`](IdentityProfileService.md)\<`T`, `U`\>
+
+Create a new instance of IdentityProfileService.
+
+#### Parameters
+
+• **options?**
+
+The dependencies for the identity profile service.
+
+• **options.profileEntityConnectorType?**: `string`
+
+The storage connector for the profiles, default to "identity-profile".
+
+#### Returns
+
+[`IdentityProfileService`](IdentityProfileService.md)\<`T`, `U`\>
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IIdentityProfileComponent.CLASS_NAME`
+
+## 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.
+
+#### Implementation of
+
+`IIdentityProfileComponent.create`
+
+***
+
+### 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`\>
+
+#### Implementation of
+
+`IIdentityProfileComponent.get`
+
+***
+
+### 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 properties to get for the item, defaults to all.
+
+#### Returns
+
+`Promise`\<`Partial`\<`T`\>\>
+
+The items properties.
+
+#### Implementation of
+
+`IIdentityProfileComponent.getPublic`
+
+***
+
+### 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.
+
+#### Implementation of
+
+`IIdentityProfileComponent.update`
+
+***
+
+### 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.
+
+#### Implementation of
+
+`IIdentityProfileComponent.remove`
+
+***
+
+### list()
+
+> **list**(`publicFilters`?, `publicPropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+
+Get a list of the requested types.
+
+#### 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.
+
+#### Implementation of
+
+`IIdentityProfileComponent.list`

package/docs/reference/classes/IdentityService.md

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

package/docs/reference/functions/generateRestRoutesIdentity.md

@@ -0,0 +1,21 @@
+# Function: generateRestRoutesIdentity()
+
+> **generateRestRoutesIdentity**(`baseRouteName`, `componentName`): `IRestRoute`[]
+
+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`[]
+
+The generated routes.

package/docs/reference/functions/generateRestRoutesIdentityProfile.md

@@ -0,0 +1,21 @@
+# Function: generateRestRoutesIdentityProfile()
+
+> **generateRestRoutesIdentityProfile**(`baseRouteName`, `componentName`): `IRestRoute`[]
+
+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`[]
+
+The generated routes.

package/docs/reference/functions/identitiesList.md

@@ -0,0 +1,25 @@
+# Function: identitiesList()
+
+> **identitiesList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityProfileListResponse`\>
+
+Get the list of organizations.
+
+## 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**: `IIdentityProfileListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityProfileListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityGet.md

@@ -0,0 +1,25 @@
+# Function: identityGet()
+
+> **identityGet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityProfileGetResponse`\>
+
+Get the identity profile.
+
+## 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**: `IIdentityProfileGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityProfileGetResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityGetPublic.md

@@ -0,0 +1,25 @@
+# Function: identityGetPublic()
+
+> **identityGetPublic**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityProfileGetPublicResponse`\>
+
+Get the identity public profile.
+
+## 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**: `IIdentityProfileGetPublicRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityProfileGetPublicResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityProfileCreate.md

@@ -0,0 +1,25 @@
+# Function: identityProfileCreate()
+
+> **identityProfileCreate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Create an identity profile.
+
+## 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**: `IIdentityProfileCreateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityProfileRemove.md

@@ -0,0 +1,25 @@
+# Function: identityProfileRemove()
+
+> **identityProfileRemove**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Remove an identity profile.
+
+## 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**: `INoContentRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityProfileUpdate.md

@@ -0,0 +1,25 @@
+# Function: identityProfileUpdate()
+
+> **identityProfileUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Update an identity profile.
+
+## 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**: `IIdentityProfileUpdateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityResolve.md

@@ -0,0 +1,25 @@
+# Function: identityResolve()
+
+> **identityResolve**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityResolveResponse`\>
+
+Resolve an identity.
+
+## 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**: `IIdentityResolveRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityResolveResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -0,0 +1,28 @@
+# @twin.org/identity-service
+
+## Classes
+
+- [IdentityProfileService](classes/IdentityProfileService.md)
+- [IdentityService](classes/IdentityService.md)
+
+## Interfaces
+
+- [IIdentityServiceConfig](interfaces/IIdentityServiceConfig.md)
+
+## Variables
+
+- [tagsIdentityProfile](variables/tagsIdentityProfile.md)
+- [tagsIdentity](variables/tagsIdentity.md)
+- [restEntryPoints](variables/restEntryPoints.md)
+
+## Functions
+
+- [generateRestRoutesIdentityProfile](functions/generateRestRoutesIdentityProfile.md)
+- [identityProfileCreate](functions/identityProfileCreate.md)
+- [identityGet](functions/identityGet.md)
+- [identityGetPublic](functions/identityGetPublic.md)
+- [identityProfileUpdate](functions/identityProfileUpdate.md)
+- [identityProfileRemove](functions/identityProfileRemove.md)
+- [identitiesList](functions/identitiesList.md)
+- [generateRestRoutesIdentity](functions/generateRestRoutesIdentity.md)
+- [identityResolve](functions/identityResolve.md)

package/docs/reference/interfaces/IIdentityServiceConfig.md

@@ -0,0 +1,11 @@
+# Interface: IIdentityServiceConfig
+
+Configuration for the Identity Service.
+
+## Properties
+
+### defaultNamespace?
+
+> `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/variables/restEntryPoints.md

@@ -0,0 +1,3 @@
+# Variable: restEntryPoints
+
+> `const` **restEntryPoints**: `IRestRouteEntryPoint`[]

package/docs/reference/variables/tagsIdentity.md

@@ -0,0 +1,5 @@
+# Variable: tagsIdentity
+
+> `const` **tagsIdentity**: `ITag`[]
+
+The tag to associate with the routes.

package/docs/reference/variables/tagsIdentityProfile.md

@@ -0,0 +1,5 @@
+# Variable: tagsIdentityProfile
+
+> `const` **tagsIdentityProfile**: `ITag`[]
+
+The tag to associate with the routes.

package/locales/en.json

@@ -0,0 +1,22 @@
+{
+	"error": {
+		"identityService": {
+			"noConnectors": "There are no connectors registered with the identity factory",
+			"resolveFailed": "Resolving the identity failed",
+			"namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the identity service \"{namespace}\""
+		},
+		"identityProfileConnectorService": {
+			"noConnectors": "There are no connectors registered with the identity profile factory"
+		},
+		"identityProfileService": {
+			"alreadyExists": "The identity profile already exists for the identity \"{existingId}\"",
+			"createFailed": "Creating the identity profile failed \"{identity}\"",
+			"getFailed": "Getting the identity profile failed",
+			"getPublicFailed": "Getting the public identity profile failed",
+			"updateFailed": "Updating the identity profile failed \"{identity}\"",
+			"notFound": "The identity profile could not be found \"{notFoundId}\"",
+			"removeFailed": "Removing the identity profile failed \"{identity}\"",
+			"listFailed": "Failed listing identities"
+		}
+	}
+}