@twin.org/api-auth-entity-storage-models 0.0.3-next.4 → 0.0.3-next.41

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

@@ -0,0 +1,39 @@
+# Interface: IAuthenticationUser
+
+Contract definition for authentication user.
+
+## Extended by
+
+- [`IAuthenticationUserSecure`](IAuthenticationUserSecure.md)
+
+## Properties
+
+### email {#email}
+
+> **email**: `string`
+
+The user e-mail address.
+
+***
+
+### userIdentity {#useridentity}
+
+> **userIdentity**: `string`
+
+The user identity.
+
+***
+
+### organizationIdentity {#organizationidentity}
+
+> **organizationIdentity**: `string`
+
+The users organization.
+
+***
+
+### scope {#scope}
+
+> **scope**: `string`[]
+
+The scope assigned to the user, comma separated.

package/docs/reference/interfaces/IAuthenticationUserSecure.md

@@ -0,0 +1,79 @@
+# Interface: IAuthenticationUserSecure
+
+Contract definition for authentication user.
+
+## Extends
+
+- [`IAuthenticationUser`](IAuthenticationUser.md)
+
+## Properties
+
+### email {#email}
+
+> **email**: `string`
+
+The user e-mail address.
+
+#### Inherited from
+
+[`IAuthenticationUser`](IAuthenticationUser.md).[`email`](IAuthenticationUser.md#email)
+
+***
+
+### userIdentity {#useridentity}
+
+> **userIdentity**: `string`
+
+The user identity.
+
+#### Inherited from
+
+[`IAuthenticationUser`](IAuthenticationUser.md).[`userIdentity`](IAuthenticationUser.md#useridentity)
+
+***
+
+### organizationIdentity {#organizationidentity}
+
+> **organizationIdentity**: `string`
+
+The users organization.
+
+#### Inherited from
+
+[`IAuthenticationUser`](IAuthenticationUser.md).[`organizationIdentity`](IAuthenticationUser.md#organizationidentity)
+
+***
+
+### scope {#scope}
+
+> **scope**: `string`[]
+
+The scope assigned to the user, comma separated.
+
+#### Inherited from
+
+[`IAuthenticationUser`](IAuthenticationUser.md).[`scope`](IAuthenticationUser.md#scope)
+
+***
+
+### password {#password}
+
+> **password**: `string`
+
+The encrypted password for the user.
+
+***
+
+### salt {#salt}
+
+> **salt**: `string`
+
+The salt for the password.
+
+***
+
+### tenantId {#tenantid}
+
+> **tenantId**: `string`
+
+The tenant ID associated with the user, optional in single tenant contexts.

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,17 +4,25 @@ Response from a login on the server.
 
 ## Properties
 
-### body
+### headers? {#headers}
 
-> **body**: `object`
+> `optional` **headers?**: `object`
 
-The login response details.
+Response headers.
+
+#### set-cookie?
+
+> `optional` **set-cookie?**: `string`
 
-#### token?
+The cookie containing the auth token.
 
-> `optional` **token**: `string`
+***
 
-The access token, if it uses a mechanism with public access.
+### body {#body}
+
+> **body**: `object`
+
+The login response details.
 
 #### expiry
 

package/docs/reference/interfaces/ILogoutRequest.md

@@ -4,14 +4,14 @@ Perform a logout on the auth token.
 
 ## Properties
 
-### query?
+### body? {#body}
 
-> `optional` **query**: `object`
+> `optional` **body?**: `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?
+### body? {#body}
 
-> `optional` **query**: `object`
+> `optional` **body?**: `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,17 +4,25 @@ Response from a refresh on the auth token.
 
 ## Properties
 
-### body
+### headers? {#headers}
 
-> **body**: `object`
+> `optional` **headers?**: `object`
 
-The refresh token details.
+Response headers.
+
+#### set-cookie?
+
+> `optional` **set-cookie?**: `string`
 
-#### token?
+The cookie containing the auth token.
 
-> `optional` **token**: `string`
+***
 
-The refreshed token, if it uses a mechanism with public access.
+### body {#body}
+
+> **body**: `object`
+
+The refresh token details.
 
 #### expiry
 

package/docs/reference/interfaces/IUpdatePasswordRequest.md

@@ -1,24 +1,10 @@
 # Interface: IUpdatePasswordRequest
 
-Update a users password.
+Update the current user's password.
 
 ## Properties
 
-### pathParams
-
-> **pathParams**: `object`
-
-The path parameters for the request.
-
-#### email
-
-> **email**: `string`
-
-The user email.
-
-***
-
-### body
+### body {#body}
 
 > **body**: `object`
 

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

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

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

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/api-auth-entity-storage-models",
-	"version": "0.0.3-next.4",
-	"description": "Models which define the structure of the Auth Entity Storage contracts.",
+	"version": "0.0.3-next.41",
+	"description": "Contracts for authentication flows and admin user management with entity storage.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/api.git",
+		"url": "git+https://github.com/iotaledger/twin-api.git",
 		"directory": "packages/api-auth-entity-storage-models"
 	},
 	"author": "martyn.janes@iota.org",
@@ -49,7 +49,7 @@
 		"schemas"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/api/issues"
+		"url": "git+https://github.com/iotaledger/twin-api/issues"
 	},
 	"homepage": "https://twindev.org"
 }