@twin.org/api-auth-entity-storage-models 0.0.3-next.21 → 0.0.3-next.23

package/docs/reference/interfaces/IAuditQueryRequest.md

@@ -0,0 +1,65 @@
+# Interface: IAuditQueryRequest
+
+Query authentication audit entries.
+
+## Properties
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+The query parameters for the request.
+
+#### actorId?
+
+> `optional` **actorId?**: `string`
+
+The actor identifier to filter by.
+
+#### organizationId?
+
+> `optional` **organizationId?**: `string`
+
+The organization identifier to filter by.
+
+#### tenantId?
+
+> `optional` **tenantId?**: `string`
+
+The tenant identifier to filter by.
+
+#### nodeId?
+
+> `optional` **nodeId?**: `string`
+
+The node identifier to filter by.
+
+#### event?
+
+> `optional` **event?**: `string`
+
+The event to filter by.
+
+#### startDate?
+
+> `optional` **startDate?**: `string`
+
+The inclusive start date for filtering, in ISO 8601 format.
+
+#### endDate?
+
+> `optional` **endDate?**: `string`
+
+The inclusive end date for filtering, in ISO 8601 format.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+The pagination cursor.
+
+#### limit?
+
+> `optional` **limit?**: `string`
+
+The maximum number of results to return.

package/docs/reference/interfaces/IAuditQueryResponse.md

@@ -0,0 +1,23 @@
+# Interface: IAuditQueryResponse
+
+Response from querying authentication audit entries.
+
+## Properties
+
+### body {#body}
+
+> **body**: `object`
+
+The response body.
+
+#### entries
+
+> **entries**: [`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md)[]
+
+The returned audit entries.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+The cursor to retrieve the next page, if any.

package/docs/reference/interfaces/IAuthenticationAdminComponent.md

@@ -8,7 +8,7 @@ Contract definition for authentication admin component.
 
 ## Methods
 
-### create()
+### create() {#create}
 
 > **create**(`user`): `Promise`\<`void`\>
 
@@ -30,7 +30,7 @@ Nothing.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`user`): `Promise`\<`void`\>
 
@@ -52,7 +52,7 @@ Nothing.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`email`): `Promise`\<`Omit`\<[`IAuthenticationUser`](IAuthenticationUser.md), `"salt"` \| `"password"`\>\>
 
@@ -74,7 +74,7 @@ The user details.
 
 ***
 
-### getByIdentity()
+### getByIdentity() {#getbyidentity}
 
 > **getByIdentity**(`identity`): `Promise`\<`Omit`\<[`IAuthenticationUser`](IAuthenticationUser.md), `"salt"` \| `"password"`\>\>
 
@@ -96,7 +96,7 @@ The user details.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`email`): `Promise`\<`void`\>
 
@@ -118,7 +118,7 @@ Nothing.
 
 ***
 
-### updatePassword()
+### updatePassword() {#updatepassword}
 
 > **updatePassword**(`email`, `newPassword`, `currentPassword?`): `Promise`\<`void`\>
 

package/docs/reference/interfaces/IAuthenticationAuditComponent.md

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

@@ -8,7 +8,7 @@ Contract definition for authentication component.
 
 ## Methods
 
-### login()
+### login() {#login}
 
 > **login**(`email`, `password`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
 
@@ -36,7 +36,7 @@ The authentication token for the user, if it uses a mechanism with public access
 
 ***
 
-### logout()
+### logout() {#logout}
 
 > **logout**(`token?`): `Promise`\<`void`\>
 
@@ -58,7 +58,7 @@ Nothing.
 
 ***
 
-### refresh()
+### refresh() {#refresh}
 
 > **refresh**(`token?`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
 
@@ -80,7 +80,7 @@ The refreshed token, if it uses a mechanism with public access.
 
 ***
 
-### updatePassword()
+### updatePassword() {#updatepassword}
 
 > **updatePassword**(`currentPassword`, `newPassword`): `Promise`\<`void`\>
 

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`\>
+
+Nothing.
+
+#### 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`\>
+
+Nothing.
+
+#### 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`\>
+
+Nothing.
+
+***
+
+### unregisterAction() {#unregisteraction}
+
+> **unregisterAction**(`action`): `Promise`\<`void`\>
+
+Unregister rate-limit configuration for an action.
+
+#### Parameters
+
+##### action
+
+`string`
+
+The action name.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### 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`\>
+
+Nothing.

package/docs/reference/interfaces/IAuthenticationUser.md

@@ -4,7 +4,7 @@ Contract definition for authentication user.
 
 ## Properties
 
-### email
+### email {#email}
 
 > **email**: `string`
 
@@ -12,7 +12,7 @@ The user e-mail address.
 
 ***
 
-### password
+### password {#password}
 
 > **password**: `string`
 
@@ -20,7 +20,7 @@ The encrypted password for the user.
 
 ***
 
-### salt
+### salt {#salt}
 
 > **salt**: `string`
 
@@ -28,7 +28,7 @@ The salt for the password.
 
 ***
 
-### userIdentity
+### userIdentity {#useridentity}
 
 > **userIdentity**: `string`
 
@@ -36,7 +36,7 @@ The user identity.
 
 ***
 
-### organizationIdentity
+### organizationIdentity {#organizationidentity}
 
 > **organizationIdentity**: `string`
 
@@ -44,7 +44,7 @@ The users organization.
 
 ***
 
-### scope
+### scope {#scope}
 
 > **scope**: `string`[]
 

package/docs/reference/interfaces/ILoginRequest.md

@@ -4,7 +4,7 @@ Perform a login on the server.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/ILoginResponse.md

@@ -4,21 +4,21 @@ Response from a login on the server.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 Response headers.
 
 #### set-cookie?
 
-> `optional` **set-cookie**: `string`
+> `optional` **set-cookie?**: `string`
 
 The cookie containing the auth token.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/ILogoutRequest.md

@@ -4,14 +4,14 @@ Perform a logout on the auth token.
 
 ## Properties
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The logout token details.
 
 #### token?
 
-> `optional` **token**: `string`
+> `optional` **token?**: `string`
 
 The token to logout, if it uses a mechanism with public access.

package/docs/reference/interfaces/IRefreshTokenRequest.md

@@ -4,14 +4,14 @@ Perform a refresh of the auth token.
 
 ## Properties
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The refresh token details.
 
 #### token?
 
-> `optional` **token**: `string`
+> `optional` **token?**: `string`
 
 The token to refresh, if it uses a mechanism with public access.

package/docs/reference/interfaces/IRefreshTokenResponse.md

@@ -4,21 +4,21 @@ Response from a refresh on the auth token.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 Response headers.
 
 #### set-cookie?
 
-> `optional` **set-cookie**: `string`
+> `optional` **set-cookie?**: `string`
 
 The cookie containing the auth token.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/IUpdatePasswordRequest.md

@@ -4,7 +4,7 @@ Update the current user's password.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`