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

package/docs/reference/classes/EntityStorageAuthenticationRateService.md

@@ -1,227 +0,0 @@
-# Class: EntityStorageAuthenticationRateService
-
-Implementation of the authentication rate component using entity storage.
-
-## Implements
-
-- `IAuthenticationRateComponent`
-
-## Constructors
-
-### Constructor
-
-> **new EntityStorageAuthenticationRateService**(`options?`): `EntityStorageAuthenticationRateService`
-
-Create a new instance of EntityStorageAuthenticationRateService.
-
-#### Parameters
-
-##### options?
-
-[`IEntityStorageAuthenticationRateServiceConstructorOptions`](../interfaces/IEntityStorageAuthenticationRateServiceConstructorOptions.md)
-
-The constructor options.
-
-#### Returns
-
-`EntityStorageAuthenticationRateService`
-
-## Properties
-
-### CLASS\_NAME {#class_name}
-
-> `readonly` `static` **CLASS\_NAME**: `string`
-
-Runtime name for the class.
-
-## Methods
-
-### registerAction() {#registeraction}
-
-> **registerAction**(`action`, `config`): `Promise`\<`void`\>
-
-Register or update rate-limit configuration for an action.
-
-#### Parameters
-
-##### action
-
-`string`
-
-The action name.
-
-##### config
-
-`IAuthenticationRateActionConfig`
-
-The action configuration.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-A promise that resolves when the action configuration has been stored.
-
-#### Implementation of
-
-`IAuthenticationRateComponent.registerAction`
-
-***
-
-### 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.
-
-#### Implementation of
-
-`IAuthenticationRateComponent.unregisterAction`
-
-***
-
-### className() {#classname}
-
-> **className**(): `string`
-
-Returns the class name of the component.
-
-#### Returns
-
-`string`
-
-The class name of the component.
-
-#### Implementation of
-
-`IAuthenticationRateComponent.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 periodic cleanup task has been registered.
-
-#### Implementation of
-
-`IAuthenticationRateComponent.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 periodic cleanup task has been removed.
-
-#### Implementation of
-
-`IAuthenticationRateComponent.stop`
-
-***
-
-### 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 rate entry id.
-
-#### Implementation of
-
-`IAuthenticationRateComponent.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.
-
-#### Implementation of
-
-`IAuthenticationRateComponent.clear`

package/docs/reference/functions/authenticationAuditCreate.md

@@ -1,37 +0,0 @@
-# Function: authenticationAuditCreate()
-
-> **authenticationAuditCreate**(`httpRequestContext`, `componentName`, `request`, `baseRouteName`): `Promise`\<`ICreatedResponse`\>
-
-Create an authentication audit entry.
-
-## Parameters
-
-### httpRequestContext
-
-`IHttpRequestContext`
-
-The request context for the API.
-
-### componentName
-
-`string`
-
-The name of the component to use in the routes.
-
-### request
-
-`IAuditCreateRequest`
-
-The request.
-
-### baseRouteName
-
-`string`
-
-The base route name to use for the location header.
-
-## Returns
-
-`Promise`\<`ICreatedResponse`\>
-
-The response object with additional http response properties.

package/docs/reference/functions/authenticationAuditGet.md

@@ -1,31 +0,0 @@
-# Function: authenticationAuditGet()
-
-> **authenticationAuditGet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditGetResponse`\>
-
-Get an authentication audit entry.
-
-## Parameters
-
-### httpRequestContext
-
-`IHttpRequestContext`
-
-The request context for the API.
-
-### componentName
-
-`string`
-
-The name of the component to use in the routes.
-
-### request
-
-`IAuditGetRequest`
-
-The request.
-
-## Returns
-
-`Promise`\<`IAuditGetResponse`\>
-
-The response object with additional http response properties.

package/docs/reference/functions/authenticationAuditQuery.md

@@ -1,31 +0,0 @@
-# Function: authenticationAuditQuery()
-
-> **authenticationAuditQuery**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditQueryResponse`\>
-
-Query authentication audit entries.
-
-## Parameters
-
-### httpRequestContext
-
-`IHttpRequestContext`
-
-The request context for the API.
-
-### componentName
-
-`string`
-
-The name of the component to use in the routes.
-
-### request
-
-`IAuditQueryRequest`
-
-The request.
-
-## Returns
-
-`Promise`\<`IAuditQueryResponse`\>
-
-The response object with additional http response properties.

package/docs/reference/functions/authenticationAuditRemove.md

@@ -1,31 +0,0 @@
-# Function: authenticationAuditRemove()
-
-> **authenticationAuditRemove**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
-
-Remove an authentication audit entry.
-
-## Parameters
-
-### httpRequestContext
-
-`IHttpRequestContext`
-
-The request context for the API.
-
-### componentName
-
-`string`
-
-The name of the component to use in the routes.
-
-### request
-
-`IAuditRemoveRequest`
-
-The request.
-
-## Returns
-
-`Promise`\<`INoContentResponse`\>
-
-The response object with additional http response properties.

package/docs/reference/functions/authenticationAuditUpdate.md

@@ -1,31 +0,0 @@
-# Function: authenticationAuditUpdate()
-
-> **authenticationAuditUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
-
-Update an authentication audit entry.
-
-## Parameters
-
-### httpRequestContext
-
-`IHttpRequestContext`
-
-The request context for the API.
-
-### componentName
-
-`string`
-
-The name of the component to use in the routes.
-
-### request
-
-`IAuditUpdateRequest`
-
-The request.
-
-## Returns
-
-`Promise`\<`INoContentResponse`\>
-
-The response object with additional http response properties.

package/docs/reference/functions/generateRestRoutesAuthenticationAudit.md

@@ -1,25 +0,0 @@
-# Function: generateRestRoutesAuthenticationAudit()
-
-> **generateRestRoutesAuthenticationAudit**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
-
-The REST routes for authentication audit.
-
-## 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`\<`any`, `any`\>[]
-
-The generated routes.

package/docs/reference/interfaces/IEntityStorageAuthenticationAuditServiceConfig.md

@@ -1,11 +0,0 @@
-# Interface: IEntityStorageAuthenticationAuditServiceConfig
-
-Config for the EntityStorageAuthenticationAuditService constructor.
-
-## Properties
-
-### ipHashSalt? {#iphashsalt}
-
-> `optional` **ipHashSalt?**: `string`
-
-The server-side salt for hashing IP addresses in audit logs, if configured.

package/docs/reference/interfaces/IEntityStorageAuthenticationAuditServiceConstructorOptions.md

@@ -1,25 +0,0 @@
-# Interface: IEntityStorageAuthenticationAuditServiceConstructorOptions
-
-Options for the EntityStorageAuthenticationAuditService constructor.
-
-## Properties
-
-### authenticationAuditEntryStorageType? {#authenticationauditentrystoragetype}
-
-> `optional` **authenticationAuditEntryStorageType?**: `string`
-
-The entity storage for the audit entries.
-
-#### Default
-
-```ts
-authentication-audit-entry
-```
-
-***
-
-### config? {#config}
-
-> `optional` **config?**: [`IEntityStorageAuthenticationAuditServiceConfig`](IEntityStorageAuthenticationAuditServiceConfig.md)
-
-The configuration for the authentication audit service.

package/docs/reference/interfaces/IEntityStorageAuthenticationRateServiceConfig.md

@@ -1,17 +0,0 @@
-# Interface: IEntityStorageAuthenticationRateServiceConfig
-
-Configuration for the entity storage authentication rate service.
-
-## Properties
-
-### cleanupIntervalMinutes? {#cleanupintervalminutes}
-
-> `optional` **cleanupIntervalMinutes?**: `number`
-
-Interval between cleanup runs in minutes.
-
-#### Default
-
-```ts
-5
-```

package/docs/reference/interfaces/IEntityStorageAuthenticationRateServiceConstructorOptions.md

@@ -1,53 +0,0 @@
-# Interface: IEntityStorageAuthenticationRateServiceConstructorOptions
-
-Options for the EntityStorageAuthenticationRateService constructor.
-
-## Properties
-
-### authenticationRateEntryStorageType? {#authenticationrateentrystoragetype}
-
-> `optional` **authenticationRateEntryStorageType?**: `string`
-
-The entity storage for authentication rate entries.
-
-#### Default
-
-```ts
-authentication-rate-entry
-```
-
-***
-
-### taskSchedulerComponentType? {#taskschedulercomponenttype}
-
-> `optional` **taskSchedulerComponentType?**: `string`
-
-The task scheduler component type.
-
-#### Default
-
-```ts
-task-scheduler
-```
-
-***
-
-### platformComponentType? {#platformcomponenttype}
-
-> `optional` **platformComponentType?**: `string`
-
-The platform component type, used to run the periodic cleanup per tenant.
-
-#### Default
-
-```ts
-platform
-```
-
-***
-
-### config? {#config}
-
-> `optional` **config?**: [`IEntityStorageAuthenticationRateServiceConfig`](IEntityStorageAuthenticationRateServiceConfig.md)
-
-The configuration for the authentication rate service.

package/docs/reference/variables/tagsAuthenticationAudit.md

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