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

package/docs/reference/functions/authenticationAuditCreate.md

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

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

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

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

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

@@ -0,0 +1,25 @@
+# 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/functions/initSchema.md

@@ -0,0 +1,9 @@
+# Function: initSchema()
+
+> **initSchema**(): `void`
+
+Initialize the schema for the authentication audit and rate services.
+
+## Returns
+
+`void`

package/docs/reference/index.md

@@ -0,0 +1,33 @@
+# @3sixty/api-auth-service
+
+## Classes
+
+- [AuthenticationAuditEntry](classes/AuthenticationAuditEntry.md)
+- [AuthenticationRateEntry](classes/AuthenticationRateEntry.md)
+- [TenantOverrideProcessor](classes/TenantOverrideProcessor.md)
+- [EntityStorageAuthenticationAuditService](classes/EntityStorageAuthenticationAuditService.md)
+- [EntityStorageAuthenticationRateService](classes/EntityStorageAuthenticationRateService.md)
+
+## Interfaces
+
+- [IEntityStorageAuthenticationAuditServiceConfig](interfaces/IEntityStorageAuthenticationAuditServiceConfig.md)
+- [IEntityStorageAuthenticationAuditServiceConstructorOptions](interfaces/IEntityStorageAuthenticationAuditServiceConstructorOptions.md)
+- [IEntityStorageAuthenticationRateServiceConfig](interfaces/IEntityStorageAuthenticationRateServiceConfig.md)
+- [IEntityStorageAuthenticationRateServiceConstructorOptions](interfaces/IEntityStorageAuthenticationRateServiceConstructorOptions.md)
+- [ITenantOverrideProcessorConfig](interfaces/ITenantOverrideProcessorConfig.md)
+- [ITenantOverrideProcessorConstructorOptions](interfaces/ITenantOverrideProcessorConstructorOptions.md)
+
+## Variables
+
+- [restEntryPoints](variables/restEntryPoints.md)
+- [tagsAuthenticationAudit](variables/tagsAuthenticationAudit.md)
+
+## Functions
+
+- [generateRestRoutesAuthenticationAudit](functions/generateRestRoutesAuthenticationAudit.md)
+- [authenticationAuditCreate](functions/authenticationAuditCreate.md)
+- [authenticationAuditGet](functions/authenticationAuditGet.md)
+- [authenticationAuditUpdate](functions/authenticationAuditUpdate.md)
+- [authenticationAuditRemove](functions/authenticationAuditRemove.md)
+- [authenticationAuditQuery](functions/authenticationAuditQuery.md)
+- [initSchema](functions/initSchema.md)

package/docs/reference/interfaces/IEntityStorageAuthenticationAuditServiceConfig.md

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

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

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

@@ -0,0 +1,53 @@
+# 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/interfaces/ITenantOverrideProcessorConfig.md

@@ -0,0 +1,39 @@
+# Interface: ITenantOverrideProcessorConfig
+
+Configuration for the TenantOverrideProcessor.
+
+## Properties
+
+### includeErrorStack? {#includeerrorstack}
+
+> `optional` **includeErrorStack?**: `boolean`
+
+Include the stack with errors.
+
+***
+
+### escalatedPrivilegeRole? {#escalatedprivilegerole}
+
+> `optional` **escalatedPrivilegeRole?**: `string`
+
+The role value that grants escalated privilege for cross-tenant access.
+
+#### Default
+
+```ts
+global-admin
+```
+
+***
+
+### authorizationModelId? {#authorizationmodelid}
+
+> `optional` **authorizationModelId?**: `string`
+
+The authorization model ID to use for REST requests.
+
+#### Default
+
+```ts
+system
+```

package/docs/reference/interfaces/ITenantOverrideProcessorConstructorOptions.md

@@ -0,0 +1,39 @@
+# Interface: ITenantOverrideProcessorConstructorOptions
+
+Options for the TenantOverrideProcessor constructor.
+
+## Properties
+
+### tenantAdminComponentType? {#tenantadmincomponenttype}
+
+> `optional` **tenantAdminComponentType?**: `string`
+
+The tenant admin component type.
+
+#### Default
+
+```ts
+tenant-admin
+```
+
+***
+
+### authorizationComponentType? {#authorizationcomponenttype}
+
+> `optional` **authorizationComponentType?**: `string`
+
+The authorization component type.
+
+#### Default
+
+```ts
+authorization
+```
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`ITenantOverrideProcessorConfig`](ITenantOverrideProcessorConfig.md)
+
+Configuration for the processor.

package/docs/reference/variables/restEntryPoints.md

@@ -0,0 +1,5 @@
+# Variable: restEntryPoints
+
+> `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
+
+REST entry points for the authentication audit service.

package/docs/reference/variables/tagsAuthenticationAudit.md

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

package/locales/en.json

@@ -0,0 +1,22 @@
+{
+	"error": {
+		"entityStorageAuthenticationAuditService": {
+			"auditEntryNotFound": "The audit entry with the specified identifier could not be found \"{notFoundId}\"",
+			"getAuditEntryFailed": "Getting the audit entry failed",
+			"updateAuditEntryFailed": "Updating the audit entry failed",
+			"removeAuditEntryFailed": "Removing the audit entry failed"
+		},
+		"entityStorageAuthenticationRateService": {
+			"actionConfigMissing": "No rate-limit configuration exists for action \"{action}\".",
+			"rateLimitExceeded": "The rate limit for action \"{action}\" has been exceeded. Retry after {retryAfterSeconds} seconds."
+		},
+		"validation": {
+			"saltEntropyTooLow": "Salt must have at least 8 unique characters for sufficient entropy."
+		},
+		"tenantOverrideProcessor": {
+			"insufficientRoleForTenantOverride": "Caller does not hold the required role for tenant override.",
+			"missingUserIdForTenantOverride": "Missing user id for tenant override.",
+			"tenantNotFound": "Tenant \"{notFoundId}\" not found."
+		}
+	}
+}

package/package.json

@@ -1,6 +1,63 @@
 {
-  "name": "@3sixty/api-auth-service",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/api-auth-service",
+	"version": "0.20.0-next.1",
+	"description": "Authentication audit and rate limiting services, tenant override processing and audit REST routes backed by entity storage.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/api-auth.git",
+		"directory": "packages/api-auth-service"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/api-auth-models": "0.20.0-next.1",
+		"@3sixty/api-models": "next",
+		"@3sixty/authorization-models": "next",
+		"@3sixty/background-task-models": "next",
+		"@3sixty/context": "next",
+		"@3sixty/core": "next",
+		"@3sixty/crypto": "next",
+		"@3sixty/entity": "next",
+		"@3sixty/entity-storage-models": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/web": "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",
+		"entity",
+		"storage",
+		"persistence",
+		"database",
+		"service",
+		"microservice",
+		"business-logic"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/api-auth/issues"
+	},
+	"homepage": "https://3sixty.global"
+}