@3sixty/api-auth-entity-storage-service 0.0.0-stage → 0.20.0-next.1

package/docs/reference/classes/AuthHeaderProcessor.md

@@ -0,0 +1,197 @@
+# Class: AuthHeaderProcessor
+
+Handle a JWT token in the authorization header or cookies and validate it to populate request context identity.
+
+## Implements
+
+- `IBaseRouteProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new AuthHeaderProcessor**(`options?`): `AuthHeaderProcessor`
+
+Create a new instance of AuthHeaderProcessor.
+
+#### Parameters
+
+##### options?
+
+[`IAuthHeaderProcessorConstructorOptions`](../interfaces/IAuthHeaderProcessorConstructorOptions.md)
+
+Options for the processor.
+
+#### Returns
+
+`AuthHeaderProcessor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IBaseRouteProcessor.className`
+
+***
+
+### start() {#start}
+
+> **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The service needs to be started when the application is initialized.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the node identity and organization ID have been cached.
+
+#### Implementation of
+
+`IBaseRouteProcessor.start`
+
+***
+
+### stop() {#stop}
+
+> **stop**(): `Promise`\<`void`\>
+
+Stop the processor and release the token cache.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the processor has stopped.
+
+#### Implementation of
+
+`IBaseRouteProcessor.stop`
+
+***
+
+### pre() {#pre}
+
+> **pre**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The incoming request.
+
+##### response
+
+`IHttpResponse`
+
+The outgoing response.
+
+##### route
+
+`IBaseRoute` \| `undefined`
+
+The route to process.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the JWT has been verified and the context populated, or an error response set.
+
+#### Implementation of
+
+`IBaseRouteProcessor.pre`
+
+***
+
+### post() {#post}
+
+> **post**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
+
+Post process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The incoming request.
+
+##### response
+
+`IHttpResponse`
+
+The outgoing response.
+
+##### route
+
+`IBaseRoute` \| `undefined`
+
+The route to process.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the Set-Cookie header has been applied to the response if required.
+
+#### Implementation of
+
+`IBaseRouteProcessor.post`

package/docs/reference/classes/AuthenticationUser.md

@@ -0,0 +1,61 @@
+# Class: AuthenticationUser
+
+Class defining the storage for user login credentials.
+
+## Constructors
+
+### Constructor
+
+> **new AuthenticationUser**(): `AuthenticationUser`
+
+#### Returns
+
+`AuthenticationUser`
+
+## Properties
+
+### email {#email}
+
+> **email**: `string`
+
+The user e-mail address.
+
+***
+
+### password {#password}
+
+> **password**: `string`
+
+The encrypted password for the user.
+
+***
+
+### salt {#salt}
+
+> **salt**: `string`
+
+The salt for the password.
+
+***
+
+### identity {#identity}
+
+> **identity**: `string`
+
+The user identity.
+
+***
+
+### organization {#organization}
+
+> **organization**: `string`
+
+The users organization.
+
+***
+
+### passwordVersion? {#passwordversion}
+
+> `optional` **passwordVersion?**: `number`
+
+The password version counter, incremented on every password change to invalidate existing tokens.

package/docs/reference/classes/AuthenticationUserV0.md

@@ -0,0 +1,69 @@
+# Class: AuthenticationUserV0
+
+Class defining the storage for user login credentials.
+
+## Constructors
+
+### Constructor
+
+> **new AuthenticationUserV0**(): `AuthenticationUserV0`
+
+#### Returns
+
+`AuthenticationUserV0`
+
+## Properties
+
+### email {#email}
+
+> **email**: `string`
+
+The user e-mail address.
+
+***
+
+### password {#password}
+
+> **password**: `string`
+
+The encrypted password for the user.
+
+***
+
+### salt {#salt}
+
+> **salt**: `string`
+
+The salt for the password.
+
+***
+
+### identity {#identity}
+
+> **identity**: `string`
+
+The user identity.
+
+***
+
+### organization {#organization}
+
+> **organization**: `string`
+
+The users organization.
+
+***
+
+### scope {#scope}
+
+> **scope**: `string`
+
+The scope assigned to the user, comma separated.
+
+***
+
+### passwordVersion? {#passwordversion}
+
+> `optional` **passwordVersion?**: `number`
+
+The password version counter, incremented on every password change to invalidate existing tokens.

package/docs/reference/classes/EntityStorageAuthenticationAdminService.md

@@ -0,0 +1,237 @@
+# 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
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+***
+
+### DEFAULT\_ESCALATED\_PRIVILEGE\_ROLE {#default_escalated_privilege_role}
+
+> `readonly` `static` **DEFAULT\_ESCALATED\_PRIVILEGE\_ROLE**: `string` = `"global-admin"`
+
+The default role that grants escalated privilege.
+
+***
+
+### DEFAULT\_AUTHORIZATION\_MODEL\_ID {#default_authorization_model_id}
+
+> `readonly` `static` **DEFAULT\_AUTHORIZATION\_MODEL\_ID**: `string` = `"system"`
+
+The default authorization model ID used to look up roles.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IAuthenticationAdminComponent.className`
+
+***
+
+### create() {#create}
+
+> **create**(`user`): `Promise`\<`void`\>
+
+Create a login for the user.
+
+#### Parameters
+
+##### user
+
+`IAuthenticationUser` & `object`
+
+The user to create.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the user account has been created and the audit entry recorded.
+
+#### Implementation of
+
+`IAuthenticationAdminComponent.create`
+
+***
+
+### update() {#update}
+
+> **update**(`user`): `Promise`\<`void`\>
+
+Update a login for the user.
+
+#### Parameters
+
+##### user
+
+`Partial`\<`IAuthenticationUser`\>
+
+The user to update.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the user account has been updated and the audit entry recorded.
+
+#### Implementation of
+
+`IAuthenticationAdminComponent.update`
+
+***
+
+### get() {#get}
+
+> **get**(`email`): `Promise`\<`IAuthenticationUser`\>
+
+Get a user by email.
+
+#### Parameters
+
+##### email
+
+`string`
+
+The email address of the user to get.
+
+#### Returns
+
+`Promise`\<`IAuthenticationUser`\>
+
+The user details.
+
+#### Implementation of
+
+`IAuthenticationAdminComponent.get`
+
+***
+
+### getByIdentity() {#getbyidentity}
+
+> **getByIdentity**(`identity`): `Promise`\<`IAuthenticationUser`\>
+
+Get a user by identity.
+
+#### Parameters
+
+##### identity
+
+`string`
+
+The identity of the user to get.
+
+#### Returns
+
+`Promise`\<`IAuthenticationUser`\>
+
+The user details.
+
+#### Implementation of
+
+`IAuthenticationAdminComponent.getByIdentity`
+
+***
+
+### remove() {#remove}
+
+> **remove**(`email`): `Promise`\<`void`\>
+
+Remove the current user.
+
+#### Parameters
+
+##### email
+
+`string`
+
+The email address of the user to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the user account has been removed and the audit entry recorded.
+
+#### Implementation of
+
+`IAuthenticationAdminComponent.remove`
+
+***
+
+### updatePassword() {#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`\>
+
+A promise that resolves when the password has been updated.
+
+#### Implementation of
+
+`IAuthenticationAdminComponent.updatePassword`