@twin.org/api-auth-entity-storage-service 0.0.1-next.9 → 0.0.2-next.1

package/docs/reference/classes/EntityStorageAuthenticationAdminService.md

@@ -0,0 +1,149 @@
+# Class: EntityStorageAuthenticationAdminService
+
+Implementation of the authentication component using entity storage.
+
+## Implements
+
+- `IAuthenticationAdminComponent`
+
+## Constructors
+
+### Constructor
+
+> **new EntityStorageAuthenticationAdminService**(`options?`): `EntityStorageAuthenticationAdminService`
+
+Create a new instance of EntityStorageAuthentication.
+
+#### Parameters
+
+##### options?
+
+[`IEntityStorageAuthenticationAdminServiceConstructorOptions`](../interfaces/IEntityStorageAuthenticationAdminServiceConstructorOptions.md)
+
+The dependencies for the identity connector.
+
+#### Returns
+
+`EntityStorageAuthenticationAdminService`
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"authentication-admin-entity-storage"`
+
+The namespace supported by the authentication service.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IAuthenticationAdminComponent.CLASS_NAME`
+
+## Methods
+
+### create()
+
+> **create**(`email`, `password`, `identity`): `Promise`\<`void`\>
+
+Create a login for the user.
+
+#### Parameters
+
+##### email
+
+`string`
+
+The email address for the user.
+
+##### password
+
+`string`
+
+The password for the user.
+
+##### identity
+
+`string`
+
+The DID to associate with the account.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IAuthenticationAdminComponent.create`
+
+***
+
+### remove()
+
+> **remove**(`email`): `Promise`\<`void`\>
+
+Remove the current user.
+
+#### Parameters
+
+##### email
+
+`string`
+
+The email address of the user to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IAuthenticationAdminComponent.remove`
+
+***
+
+### updatePassword()
+
+> **updatePassword**(`email`, `newPassword`, `currentPassword?`): `Promise`\<`void`\>
+
+Update the user's password.
+
+#### Parameters
+
+##### email
+
+`string`
+
+The email address of the user to update.
+
+##### newPassword
+
+`string`
+
+The new password for the user.
+
+##### currentPassword?
+
+`string`
+
+The current password, optional, if supplied will check against existing.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IAuthenticationAdminComponent.updatePassword`

package/docs/reference/classes/EntityStorageAuthenticationService.md

@@ -8,35 +8,33 @@ Implementation of the authentication component using entity storage.
 
 ## Constructors
 
-### new EntityStorageAuthenticationService()
+### Constructor
 
-> **new EntityStorageAuthenticationService**(`options`?): [`EntityStorageAuthenticationService`](EntityStorageAuthenticationService.md)
+> **new EntityStorageAuthenticationService**(`options?`): `EntityStorageAuthenticationService`
 
 Create a new instance of EntityStorageAuthentication.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The dependencies for the identity connector.
-
-• **options.userEntityStorageType?**: `string`
+[`IEntityStorageAuthenticationServiceConstructorOptions`](../interfaces/IEntityStorageAuthenticationServiceConstructorOptions.md)
 
-The entity storage for the users, defaults to "authentication-user".
+The dependencies for the identity connector.
 
-• **options.vaultConnectorType?**: `string`
+#### Returns
 
-The vault for the private keys, defaults to "vault".
+`EntityStorageAuthenticationService`
 
-• **options.config?**: [`IEntityStorageAuthenticationServiceConfig`](../interfaces/IEntityStorageAuthenticationServiceConfig.md)
+## Properties
 
-The configuration for the authentication.
+### NAMESPACE
 
-#### Returns
+> `readonly` `static` **NAMESPACE**: `string` = `"authentication-entity-storage"`
 
-[`EntityStorageAuthenticationService`](EntityStorageAuthenticationService.md)
+The namespace supported by the authentication service.
 
-## Properties
+***
 
 ### CLASS\_NAME
 
@@ -52,17 +50,21 @@ Runtime name for the class.
 
 ### start()
 
-> **start**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\>
+> **start**(`nodeIdentity`, `nodeLoggingConnectorType?`): `Promise`\<`void`\>
 
 The service needs to be started when the application is initialized.
 
 #### Parameters
 
-• **nodeIdentity**: `string`
+##### nodeIdentity
+
+`string`
 
 The identity of the node.
 
-• **nodeLoggingConnectorType?**: `string`
+##### nodeLoggingConnectorType?
+
+`string`
 
 The node logging connector type, defaults to "node-logging".
 
@@ -80,34 +82,30 @@ Nothing.
 
 ### login()
 
-> **login**(`email`, `password`): `Promise`\<`object`\>
+> **login**(`email`, `password`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
 
 Perform a login for the user.
 
 #### Parameters
 
-• **email**: `string`
+##### email
+
+`string`
 
 The email address for the user.
 
-• **password**: `string`
+##### password
+
+`string`
 
 The password for the user.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
 
 The authentication token for the user, if it uses a mechanism with public access.
 
-##### token?
-
-> `optional` **token**: `string`
-
-##### expiry
-
-> **expiry**: `number`
-
 #### Implementation of
 
 `IAuthenticationComponent.login`
@@ -116,13 +114,15 @@ The authentication token for the user, if it uses a mechanism with public access
 
 ### logout()
 
-> **logout**(`token`?): `Promise`\<`void`\>
+> **logout**(`token?`): `Promise`\<`void`\>
 
 Logout the current user.
 
 #### Parameters
 
-• **token?**: `string`
+##### token?
+
+`string`
 
 The token to logout, if it uses a mechanism with public access.
 
@@ -140,30 +140,62 @@ Nothing.
 
 ### refresh()
 
-> **refresh**(`token`?): `Promise`\<`object`\>
+> **refresh**(`token?`): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
 
 Refresh the token.
 
 #### Parameters
 
-• **token?**: `string`
+##### token?
+
+`string`
 
 The token to refresh, if it uses a mechanism with public access.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
 
 The refreshed token, if it uses a mechanism with public access.
 
-##### token
+#### Implementation of
+
+`IAuthenticationComponent.refresh`
+
+***
+
+### updatePassword()
+
+> **updatePassword**(`email`, `currentPassword`, `newPassword`): `Promise`\<`void`\>
+
+Update the user's password.
+
+#### Parameters
+
+##### email
+
+`string`
 
-> **token**: `string`
+The email address of the user to update.
 
-##### expiry
+##### currentPassword
 
-> **expiry**: `number`
+`string`
+
+The current password for the user.
+
+##### newPassword
+
+`string`
+
+The new password for the user.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
 
 #### Implementation of
 
-`IAuthenticationComponent.refresh`
+`IAuthenticationComponent.updatePassword`

package/docs/reference/classes/PasswordHelper.md

@@ -4,13 +4,13 @@ Helper class for password operations.
 
 ## Constructors
 
-### new PasswordHelper()
+### Constructor
 
-> **new PasswordHelper**(): [`PasswordHelper`](PasswordHelper.md)
+> **new PasswordHelper**(): `PasswordHelper`
 
 #### Returns
 
-[`PasswordHelper`](PasswordHelper.md)
+`PasswordHelper`
 
 ## Methods
 
@@ -22,11 +22,15 @@ Hash the password for the user.
 
 #### Parameters
 
-• **passwordBytes**: `Uint8Array`
+##### passwordBytes
+
+`Uint8Array`
 
 The password bytes.
 
-• **saltBytes**: `Uint8Array`
+##### saltBytes
+
+`Uint8Array`
 
 The salt bytes.
 

package/docs/reference/classes/TokenHelper.md

@@ -4,90 +4,88 @@ Helper class for token operations.
 
 ## Constructors
 
-### new TokenHelper()
+### Constructor
 
-> **new TokenHelper**(): [`TokenHelper`](TokenHelper.md)
+> **new TokenHelper**(): `TokenHelper`
 
 #### Returns
 
-[`TokenHelper`](TokenHelper.md)
+`TokenHelper`
 
 ## Methods
 
 ### createToken()
 
-> `static` **createToken**(`vaultConnector`, `signingKeyName`, `subject`, `ttlMinutes`): `Promise`\<`object`\>
+> `static` **createToken**(`vaultConnector`, `signingKeyName`, `subject`, `ttlMinutes`): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
 
 Create a new token.
 
 #### Parameters
 
-• **vaultConnector**: `IVaultConnector`
+##### vaultConnector
+
+`IVaultConnector`
 
 The vault connector.
 
-• **signingKeyName**: `string`
+##### signingKeyName
+
+`string`
 
 The signing key name.
 
-• **subject**: `string`
+##### subject
+
+`string`
 
 The subject for the token.
 
-• **ttlMinutes**: `number`
+##### ttlMinutes
+
+`number`
 
 The time to live for the token in minutes.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
 
 The new token and its expiry date.
 
-##### token
-
-> **token**: `string`
-
-##### expiry
-
-> **expiry**: `number`
-
 ***
 
 ### verify()
 
-> `static` **verify**(`vaultConnector`, `signingKeyName`, `token`): `Promise`\<`object`\>
+> `static` **verify**(`vaultConnector`, `signingKeyName`, `token`): `Promise`\<\{ `header`: `IJwtHeader`; `payload`: `IJwtPayload`; \}\>
 
 Verify the token.
 
 #### Parameters
 
-• **vaultConnector**: `IVaultConnector`
+##### vaultConnector
+
+`IVaultConnector`
 
 The vault connector.
 
-• **signingKeyName**: `string`
+##### signingKeyName
+
+`string`
 
 The signing key name.
 
-• **token**: `undefined` \| `string`
+##### token
 
 The token to verify.
 
+`undefined` | `string`
+
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `header`: `IJwtHeader`; `payload`: `IJwtPayload`; \}\>
 
 The verified details.
 
-##### header
-
-> **header**: `IJwtHeader`
-
-##### payload
-
-> **payload**: `IJwtPayload`
-
 #### Throws
 
 UnauthorizedError if the token is missing, invalid or expired.
@@ -96,22 +94,26 @@ UnauthorizedError if the token is missing, invalid or expired.
 
 ### extractTokenFromHeaders()
 
-> `static` **extractTokenFromHeaders**(`headers`?, `cookieName`?): `undefined` \| `object`
+> `static` **extractTokenFromHeaders**(`headers?`, `cookieName?`): `undefined` \| \{ `token`: `string`; `location`: `"authorization"` \| `"cookie"`; \}
 
 Extract the auth token from the headers, either from the authorization header or the cookie header.
 
 #### Parameters
 
-• **headers?**: `IHttpHeaders`
+##### headers?
+
+`IHttpHeaders`
 
 The headers to extract the token from.
 
-• **cookieName?**: `string`
+##### cookieName?
+
+`string`
 
 The name of the cookie to extract the token from.
 
 #### Returns
 
-`undefined` \| `object`
+`undefined` \| \{ `token`: `string`; `location`: `"authorization"` \| `"cookie"`; \}
 
 The token if found.

package/docs/reference/functions/authenticationLogin.md

@@ -6,15 +6,21 @@ Login to the server.
 
 ## 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.
 
-• **request**: `ILoginRequest`
+### request
+
+`ILoginRequest`
 
 The request.
 

package/docs/reference/functions/authenticationLogout.md

@@ -6,15 +6,21 @@ Logout from the server.
 
 ## 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.
 
-• **request**: `ILogoutRequest`
+### request
+
+`ILogoutRequest`
 
 The request.
 

package/docs/reference/functions/authenticationRefreshToken.md

@@ -6,15 +6,21 @@ Refresh the login token.
 
 ## 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.
 
-• **request**: `IRefreshTokenRequest`
+### request
+
+`IRefreshTokenRequest`
 
 The request.
 

package/docs/reference/functions/authenticationUpdatePassword.md

@@ -0,0 +1,31 @@
+# Function: authenticationUpdatePassword()
+
+> **authenticationUpdatePassword**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Update the user's password.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IUpdatePasswordRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/generateRestRoutesAuthentication.md

@@ -1,21 +1,25 @@
 # Function: generateRestRoutesAuthentication()
 
-> **generateRestRoutesAuthentication**(`baseRouteName`, `componentName`): `IRestRoute`[]
+> **generateRestRoutesAuthentication**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
 
 The REST routes for authentication.
 
 ## 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/index.md

@@ -4,6 +4,7 @@
 
 - [AuthenticationUser](classes/AuthenticationUser.md)
 - [AuthHeaderProcessor](classes/AuthHeaderProcessor.md)
+- [EntityStorageAuthenticationAdminService](classes/EntityStorageAuthenticationAdminService.md)
 - [EntityStorageAuthenticationService](classes/EntityStorageAuthenticationService.md)
 - [PasswordHelper](classes/PasswordHelper.md)
 - [TokenHelper](classes/TokenHelper.md)
@@ -11,7 +12,11 @@
 ## Interfaces
 
 - [IAuthHeaderProcessorConfig](interfaces/IAuthHeaderProcessorConfig.md)
+- [IAuthHeaderProcessorConstructorOptions](interfaces/IAuthHeaderProcessorConstructorOptions.md)
+- [IEntityStorageAuthenticationAdminServiceConfig](interfaces/IEntityStorageAuthenticationAdminServiceConfig.md)
+- [IEntityStorageAuthenticationAdminServiceConstructorOptions](interfaces/IEntityStorageAuthenticationAdminServiceConstructorOptions.md)
 - [IEntityStorageAuthenticationServiceConfig](interfaces/IEntityStorageAuthenticationServiceConfig.md)
+- [IEntityStorageAuthenticationServiceConstructorOptions](interfaces/IEntityStorageAuthenticationServiceConstructorOptions.md)
 
 ## Variables
 
@@ -24,4 +29,5 @@
 - [authenticationLogin](functions/authenticationLogin.md)
 - [authenticationLogout](functions/authenticationLogout.md)
 - [authenticationRefreshToken](functions/authenticationRefreshToken.md)
+- [authenticationUpdatePassword](functions/authenticationUpdatePassword.md)
 - [initSchema](functions/initSchema.md)