@3sixty/api-auth-entity-storage-models 0.0.0-stage → 0.20.0-next.0

package/docs/reference/interfaces/IAuthenticationAdminComponent.md

@@ -0,0 +1,151 @@
+# Interface: IAuthenticationAdminComponent
+
+Contract definition for authentication admin component.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### create() {#create}
+
+> **create**(`user`): `Promise`\<`void`\>
+
+Create a login for the user.
+
+#### Parameters
+
+##### user
+
+[`IAuthenticationUser`](IAuthenticationUser.md) & `object`
+
+The user to create.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the user account has been created.
+
+***
+
+### update() {#update}
+
+> **update**(`user`): `Promise`\<`void`\>
+
+Update a login for the user.
+
+#### Parameters
+
+##### user
+
+`Partial`\<[`IAuthenticationUser`](IAuthenticationUser.md)\>
+
+The user to update.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the user account has been updated.
+
+***
+
+### get() {#get}
+
+> **get**(`email`): `Promise`\<[`IAuthenticationUser`](IAuthenticationUser.md)\>
+
+Get a user by email.
+
+#### Parameters
+
+##### email
+
+`string`
+
+The email address of the user to get.
+
+#### Returns
+
+`Promise`\<[`IAuthenticationUser`](IAuthenticationUser.md)\>
+
+The user details.
+
+***
+
+### getByIdentity() {#getbyidentity}
+
+> **getByIdentity**(`identity`): `Promise`\<[`IAuthenticationUser`](IAuthenticationUser.md)\>
+
+Get a user by identity.
+
+#### Parameters
+
+##### identity
+
+`string`
+
+The identity of the user to get.
+
+#### Returns
+
+`Promise`\<[`IAuthenticationUser`](IAuthenticationUser.md)\>
+
+The user details.
+
+***
+
+### remove() {#remove}
+
+> **remove**(`email`): `Promise`\<`void`\>
+
+Remove a 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.
+
+***
+
+### 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.

package/docs/reference/interfaces/IAuthenticationAuditComponent.md

@@ -0,0 +1,175 @@
+# Interface: IAuthenticationAuditComponent
+
+Contract definition for authentication audit component.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### create() {#create}
+
+> **create**(`entry`): `Promise`\<`string`\>
+
+Create a new audit entry.
+
+#### Parameters
+
+##### entry
+
+`Omit`\<[`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md), `"id"` \| `"dateCreated"`\>
+
+The audit entry to be logged.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The unique identifier of the created audit entry.
+
+***
+
+### get() {#get}
+
+> **get**(`id`): `Promise`\<[`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md)\>
+
+Get an audit entry by id.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The unique identifier of the audit entry.
+
+#### Returns
+
+`Promise`\<[`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md)\>
+
+The audit entry.
+
+***
+
+### update() {#update}
+
+> **update**(`id`, `entry`): `Promise`\<`void`\>
+
+Update an audit entry.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The unique identifier of the audit entry to update.
+
+##### entry
+
+`Partial`\<`Omit`\<[`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md), `"id"` \| `"dateCreated"`\>\>
+
+The fields to update on the audit entry.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the audit entry has been updated.
+
+***
+
+### remove() {#remove}
+
+> **remove**(`id`): `Promise`\<`void`\>
+
+Remove an audit entry.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The unique identifier of the audit entry to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the audit entry has been removed.
+
+***
+
+### query() {#query}
+
+> **query**(`options?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: [`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md)[]; `cursor?`: `string`; \}\>
+
+Query the audit entries.
+
+#### Parameters
+
+##### options?
+
+The query options.
+
+###### actorId?
+
+`string`
+
+The actor identifier to filter the audit entries, optional.
+
+###### organizationId?
+
+`string`
+
+The organization identifier to filter the audit entries, optional.
+
+###### tenantId?
+
+`string`
+
+The tenant identifier to filter the audit entries, optional.
+
+###### nodeId?
+
+`string`
+
+The node identifier to filter the audit entries, optional.
+
+###### event?
+
+`string`
+
+The audit event to filter the audit entries, optional.
+
+###### startDate?
+
+`string`
+
+The start date to filter the audit entries, optional.
+
+###### endDate?
+
+`string`
+
+The end date to filter the audit entries, optional.
+
+##### cursor?
+
+`string`
+
+The cursor for pagination.
+
+##### limit?
+
+`number`
+
+The maximum number of entries to return.
+
+#### Returns
+
+`Promise`\<\{ `entries`: [`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md)[]; `cursor?`: `string`; \}\>
+
+The audit entries.

package/docs/reference/interfaces/IAuthenticationAuditEntry.md

@@ -0,0 +1,91 @@
+# Interface: IAuthenticationAuditEntry
+
+Contract definition for authentication audit entry.
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The unique identifier for the audit entry.
+
+***
+
+### event {#event}
+
+> **event**: `string`
+
+The audit event that occurred.
+
+***
+
+### dateCreated {#datecreated}
+
+> **dateCreated**: `string`
+
+The timestamp of the audit entry in ISO 8601 format.
+
+***
+
+### actorId? {#actorid}
+
+> `optional` **actorId?**: `string`
+
+The actor identifier, could be e-mail, username, or other unique identifier.
+
+***
+
+### nodeId? {#nodeid}
+
+> `optional` **nodeId?**: `string`
+
+The node identifier associated with the audit entry, if applicable.
+
+***
+
+### organizationId? {#organizationid}
+
+> `optional` **organizationId?**: `string`
+
+The organization identifier associated with the audit entry, if applicable.
+
+***
+
+### tenantId? {#tenantid}
+
+> `optional` **tenantId?**: `string`
+
+The tenant identifier associated with the audit entry, if applicable.
+
+***
+
+### ipAddressHashes? {#ipaddresshashes}
+
+> `optional` **ipAddressHashes?**: `string`[]
+
+The hashed IP addresses of the client.
+
+***
+
+### userAgent? {#useragent}
+
+> `optional` **userAgent?**: `string`
+
+The user agent string of the client.
+
+***
+
+### correlationId? {#correlationid}
+
+> `optional` **correlationId?**: `string`
+
+The correlation ID for request tracing.
+
+***
+
+### data? {#data}
+
+> `optional` **data?**: `unknown`
+
+Additional data related to the audit entry, such as IP address, user agent, etc.

package/docs/reference/interfaces/IAuthenticationComponent.md

@@ -0,0 +1,107 @@
+# Interface: IAuthenticationComponent
+
+Contract definition for authentication component.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### login() {#login}
+
+> **login**(`email`, `password`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
+
+Perform a login for the user.
+
+#### Parameters
+
+##### email
+
+`string`
+
+The email address for the user.
+
+##### password
+
+`string`
+
+The password for the user.
+
+#### Returns
+
+`Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
+
+The authentication token for the user, if it uses a mechanism with public access.
+
+***
+
+### logout() {#logout}
+
+> **logout**(`token?`): `Promise`\<`void`\>
+
+Logout the current user.
+
+#### Parameters
+
+##### token?
+
+`string`
+
+The token to logout, if it uses a mechanism with public access.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the logout has been completed.
+
+***
+
+### refresh() {#refresh}
+
+> **refresh**(`token?`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
+
+Refresh the token.
+
+#### Parameters
+
+##### token?
+
+`string`
+
+The token to refresh, if it uses a mechanism with public access.
+
+#### Returns
+
+`Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
+
+The refreshed token, if it uses a mechanism with public access.
+
+***
+
+### updatePassword() {#updatepassword}
+
+> **updatePassword**(`currentPassword`, `newPassword`): `Promise`\<`void`\>
+
+Update the user's password.
+
+#### Parameters
+
+##### currentPassword
+
+`string`
+
+The current password for the user.
+
+##### newPassword
+
+`string`
+
+The new password for the user.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the password has been updated.

package/docs/reference/interfaces/IAuthenticationRateActionConfig.md

@@ -0,0 +1,19 @@
+# Interface: IAuthenticationRateActionConfig
+
+Configuration for an authentication rate limited action.
+
+## Properties
+
+### maxAttempts {#maxattempts}
+
+> **maxAttempts**: `number`
+
+Maximum number of failed attempts allowed per window.
+
+***
+
+### windowMinutes {#windowminutes}
+
+> **windowMinutes**: `number`
+
+Rate limit window duration in minutes.

package/docs/reference/interfaces/IAuthenticationRateComponent.md

@@ -0,0 +1,165 @@
+# Interface: IAuthenticationRateComponent
+
+Contract definition for authentication rate component.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### 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 service has been started.
+
+#### Overrides
+
+`IComponent.start`
+
+***
+
+### stop() {#stop}
+
+> **stop**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The component needs to be stopped when the node is closed.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the service has been stopped.
+
+#### Overrides
+
+`IComponent.stop`
+
+***
+
+### registerAction() {#registeraction}
+
+> **registerAction**(`action`, `config`): `Promise`\<`void`\>
+
+Register or update rate-limit configuration for an action.
+
+#### Parameters
+
+##### action
+
+`string`
+
+The action name.
+
+##### config
+
+[`IAuthenticationRateActionConfig`](IAuthenticationRateActionConfig.md)
+
+The action configuration.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the action configuration has been stored.
+
+***
+
+### unregisterAction() {#unregisteraction}
+
+> **unregisterAction**(`action`): `Promise`\<`void`\>
+
+Unregister rate-limit configuration for an action.
+
+#### Parameters
+
+##### action
+
+`string`
+
+The action name.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the action configuration has been removed.
+
+***
+
+### check() {#check}
+
+> **check**(`action`, `identifier`): `Promise`\<`string`\>
+
+Check the authentication rate for a given action and identifier.
+
+#### Parameters
+
+##### action
+
+`string`
+
+The action to be checked.
+
+##### identifier
+
+`string`
+
+The identifier to be checked.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The result of the rate check.
+
+***
+
+### clear() {#clear}
+
+> **clear**(`action`, `identifier`): `Promise`\<`void`\>
+
+Clear the authentication rate entry for the given action and identifier.
+
+#### Parameters
+
+##### action
+
+`string`
+
+The action to clear.
+
+##### identifier
+
+`string`
+
+The identifier to clear.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the rate entry has been removed.