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

package/docs/reference/interfaces/IAuthenticationAuditComponent.md

@@ -1,175 +0,0 @@
-# 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

@@ -1,91 +0,0 @@
-# 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/IAuthenticationRateActionConfig.md

@@ -1,19 +0,0 @@
-# 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

@@ -1,165 +0,0 @@
-# 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.

package/docs/reference/type-aliases/AuthAuditEvent.md

@@ -1,5 +0,0 @@
-# Type Alias: AuthAuditEvent
-
-> **AuthAuditEvent** = *typeof* [`AuthAuditEvent`](../variables/AuthAuditEvent.md)\[keyof *typeof* [`AuthAuditEvent`](../variables/AuthAuditEvent.md)\]
-
-Supported authentication audit event values.

package/docs/reference/variables/AuthAuditEvent.md

@@ -1,67 +0,0 @@
-# Variable: AuthAuditEvent
-
-> `const` **AuthAuditEvent**: `object`
-
-Supported authentication audit events.
-
-## Type Declaration
-
-### LoginSuccess {#loginsuccess}
-
-> `readonly` **LoginSuccess**: `"login-success"` = `"login-success"`
-
-Login success.
-
-### LoginFailure {#loginfailure}
-
-> `readonly` **LoginFailure**: `"login-failure"` = `"login-failure"`
-
-Login failure.
-
-### Logout {#logout}
-
-> `readonly` **Logout**: `"logout"` = `"logout"`
-
-Logout.
-
-### TokenRefreshed {#tokenrefreshed}
-
-> `readonly` **TokenRefreshed**: `"token-refreshed"` = `"token-refreshed"`
-
-Token refreshed.
-
-### AccountCreated {#accountcreated}
-
-> `readonly` **AccountCreated**: `"account-created"` = `"account-created"`
-
-Account created.
-
-### AccountDeleted {#accountdeleted}
-
-> `readonly` **AccountDeleted**: `"account-deleted"` = `"account-deleted"`
-
-Account deleted.
-
-### AccountUpdated {#accountupdated}
-
-> `readonly` **AccountUpdated**: `"account-updated"` = `"account-updated"`
-
-Account updated.
-
-### AccountLocked {#accountlocked}
-
-> `readonly` **AccountLocked**: `"account-locked"` = `"account-locked"`
-
-Account locked.
-
-### AccountUnlocked {#accountunlocked}
-
-> `readonly` **AccountUnlocked**: `"account-unlocked"` = `"account-unlocked"`
-
-Account unlocked.
-
-### PasswordChanged {#passwordchanged}
-
-> `readonly` **PasswordChanged**: `"password-changed"` = `"password-changed"`
-
-Password changed.