@3sixty/api-auth-models 0.0.0-stage → 0.20.0-next.1

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.

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/locales/en.json

@@ -0,0 +1 @@
+{}

package/package.json

@@ -1,6 +1,53 @@
 {
-  "name": "@3sixty/api-auth-models",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/api-auth-models",
+	"version": "0.20.0-next.1",
+	"description": "Contracts for authentication audit and rate limiting.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/api-auth.git",
+		"directory": "packages/api-auth-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/core": "next",
+		"@3sixty/nameof": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		}
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"api",
+		"auth",
+		"audit",
+		"rate",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/api-auth/issues"
+	},
+	"homepage": "https://3sixty.global"
+}