@twin.org/api-auth-entity-storage-service 0.9.1-next.2 → 0.9.1-next.4

package/docs/reference/classes/EntityStorageAuthenticationAuditService.md

@@ -80,6 +80,90 @@ The unique identifier of the created audit entry.
 
 ***
 
+### get() {#get}
+
+> **get**(`id`): `Promise`\<`IAuthenticationAuditEntry`\>
+
+Get an audit entry by id.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The unique identifier of the audit entry.
+
+#### Returns
+
+`Promise`\<`IAuthenticationAuditEntry`\>
+
+The audit entry.
+
+#### Implementation of
+
+`IAuthenticationAuditComponent.get`
+
+***
+
+### update() {#update}
+
+> **update**(`id`, `entry`): `Promise`\<`void`\>
+
+Update an audit entry.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The unique identifier of the audit entry to update.
+
+##### entry
+
+`Partial`\<`Omit`\<`IAuthenticationAuditEntry`, `"id"` \| `"dateCreated"`\>\>
+
+The fields to update on the audit entry.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the audit entry has been updated.
+
+#### Implementation of
+
+`IAuthenticationAuditComponent.update`
+
+***
+
+### remove() {#remove}
+
+> **remove**(`id`): `Promise`\<`void`\>
+
+Remove an audit entry.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The unique identifier of the audit entry to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the audit entry has been removed.
+
+#### Implementation of
+
+`IAuthenticationAuditComponent.remove`
+
+***
+
 ### query() {#query}
 
 > **query**(`options?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IAuthenticationAuditEntry`[]; `cursor?`: `string`; \}\>

package/docs/reference/functions/authenticationAdminCreateUser.md

@@ -1,6 +1,6 @@
 # Function: authenticationAdminCreateUser()
 
-> **authenticationAdminCreateUser**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`ICreatedResponse`\>
+> **authenticationAdminCreateUser**(`httpRequestContext`, `componentName`, `request`, `baseRouteName`): `Promise`\<`ICreatedResponse`\>
 
 Create a new user.
 
@@ -24,6 +24,12 @@ The name of the component to use in the routes.
 
 The request.
 
+### baseRouteName
+
+`string`
+
+The base route name to use for the location header.
+
 ## Returns
 
 `Promise`\<`ICreatedResponse`\>

package/docs/reference/functions/authenticationAuditCreate.md

@@ -1,6 +1,6 @@
 # Function: authenticationAuditCreate()
 
-> **authenticationAuditCreate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`ICreatedResponse`\>
+> **authenticationAuditCreate**(`httpRequestContext`, `componentName`, `request`, `baseRouteName`): `Promise`\<`ICreatedResponse`\>
 
 Create an authentication audit entry.
 
@@ -24,6 +24,12 @@ The name of the component to use in the routes.
 
 The request.
 
+### baseRouteName
+
+`string`
+
+The base route name to use for the location header.
+
 ## Returns
 
 `Promise`\<`ICreatedResponse`\>

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/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/index.md

@@ -44,6 +44,9 @@
 - [authenticationAdminRemoveUser](functions/authenticationAdminRemoveUser.md)
 - [generateRestRoutesAuthenticationAudit](functions/generateRestRoutesAuthenticationAudit.md)
 - [authenticationAuditCreate](functions/authenticationAuditCreate.md)
+- [authenticationAuditGet](functions/authenticationAuditGet.md)
+- [authenticationAuditUpdate](functions/authenticationAuditUpdate.md)
+- [authenticationAuditRemove](functions/authenticationAuditRemove.md)
 - [authenticationAuditQuery](functions/authenticationAuditQuery.md)
 - [generateRestRoutesAuthentication](functions/generateRestRoutesAuthentication.md)
 - [authenticationLogin](functions/authenticationLogin.md)

package/locales/en.json

@@ -21,6 +21,12 @@
 		"passwordHelper": {
 			"currentPasswordMismatch": "The current password is incorrect"
 		},
+		"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."

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-auth-entity-storage-service",
-	"version": "0.9.1-next.2",
+	"version": "0.9.1-next.4",
 	"description": "Authentication service implementation and REST routes backed by entity storage.",
 	"repository": {
 		"type": "git",
@@ -14,9 +14,9 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-auth-entity-storage-models": "0.9.1-next.2",
-		"@twin.org/api-core": "0.9.1-next.2",
-		"@twin.org/api-models": "0.9.1-next.2",
+		"@twin.org/api-auth-entity-storage-models": "0.9.1-next.4",
+		"@twin.org/api-core": "0.9.1-next.4",
+		"@twin.org/api-models": "0.9.1-next.4",
 		"@twin.org/background-task-models": "next",
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",